use "Message-ID" capitalization consistently
authorEric Wong <e@80x24.org>
Tue, 8 Apr 2014 01:44:32 +0000 (01:44 +0000)
committerEric Wong <e@80x24.org>
Tue, 8 Apr 2014 01:44:32 +0000 (01:44 +0000)
Technically it's case-insensitive; but "ID" is short for
"identifier" or "identification", and not a fish or a part
of a person's psyche.

Documentation/ssoma_repository.txt
lib/Ssoma/Extractor.pm
t/all.t
t/extractor.t
t/remover.t

index 45795ea88ad61237f4eb814e77ade59d3249993e..7458bbeef4da40a350bcdd71d29457b28e923442 100644 (file)
@@ -7,36 +7,36 @@ ssoma_repository - repository and tree description for ssoma
 # DESCRIPTION
 
 ssoma uses a git repository to store each email as a git blob.  The tree
-filename of the blob is based on the SHA1 hexdigest of the Message-Id
+filename of the blob is based on the SHA1 hexdigest of the Message-ID
 header.  A commit is made for each message delivered.  The commit SHA-1
 identifier is used by ssoma clients to track synchronization state.
 
 # PATHNAMES IN TREES
 
-A Message-Id may be extremely long and also contain slashes, so using
+A Message-ID may be extremely long and also contain slashes, so using
 them as a path name is challenging.  Instead we use the SHA-1 hexdigest
-of the Message-Id (including the "<" and ">") to generate a path name.
-Leading and trailing white space in the Message-Id header is ignored
+of the Message-ID (including the "<" and ">") to generate a path name.
+Leading and trailing white space in the Message-ID header is ignored
 for hashing.
 
-A message with Message-Id of: <20131106023245.GA20224@dcvr.yhbt.net>
+A message with Message-ID of: <20131106023245.GA20224@dcvr.yhbt.net>
 
 Would be stored as: 21/4527ce3741f50bb9afa65e7c5003c8a8ddc4b1
 
 Thus it is easy to look up the contents of a message matching a given
-a Message-Id.
+a Message-ID.
 
 # CONFLICTS
 
-Message-Id is a unique-enough identifier for practical purposes, but
+Message-ID is a unique-enough identifier for practical purposes, but
 they may still conflict (especially in case of malicious clients and
-timing issues).  In the case of identical Message-Id and different
+timing issues).  In the case of identical Message-ID and different
 messages, the blob shall become a tree with multiple messages.
-Likewise, if there is a (rare) SHA-1 conflict on different Message-Id
-headers, the tree will contain each message (with different Message-Id
+Likewise, if there is a (rare) SHA-1 conflict on different Message-ID
+headers, the tree will contain each message (with different Message-ID
 headers).
 
-Thus the blobs for conflicting Message-Ids will be the SHA-1 hexdigest
+Thus the blobs for conflicting Message-IDs will be the SHA-1 hexdigest
 of the Subject header and raw body (no extra whitespace delimiting the
 two).
 
@@ -60,7 +60,7 @@ for all non-atomic operations.
 ssoma-mda handles all steps once invoked.
 
 2. Mail transport agent invokes ssoma-mda
-3. reads message via stdin, extracting Message-Id
+3. reads message via stdin, extracting Message-ID
 4. acquires fcntl lock on $GIT_DIR/ssoma.lock
 5. creates or updates the blob of associated 2/38 SHA-1 path
 6. updates the index and commits
index f2ad7521ff293067cf6bc761902158dba349e40b..8f053779baba0f29b1a30d9431a71b87ed2043b0 100644 (file)
@@ -142,7 +142,7 @@ sub midextract {
                # leaving <> out of Message-IDs on the command-line is
                # common and practical since it frees the user from
                # quoting/escaping in most cases, so do not require
-               # Message-Ids have <> around themh
+               # Message-IDs have <> around them
                if ($message_id =~ /\A<.+>\z/) { # rare
                        $self->_midextract($message_id, $mbox);
                } else { # common
diff --git a/t/all.t b/t/all.t
index bd71713ceaf89a38bba8510a1fdba9eab3816036..9698c8e57c3deef80fc323de95be336e7f04c8b6 100644 (file)
--- a/t/all.t
+++ b/t/all.t
@@ -27,7 +27,7 @@ ok(-x $cli, "$cli is executable");
        my $simple = Email::Simple->new(<<'EOF');
 From: me@example.com
 To: u@example.com
-Message-Id: <666@example.com>
+Message-ID: <666@example.com>
 Subject: zzz
 
 OMFG
@@ -79,7 +79,7 @@ EOF
        my $simple = Email::Simple->new(<<'EOF');
 From: moi@example.com
 To: you@example.com
-Message-Id: <666666@example.com>
+Message-ID: <666666@example.com>
 Subject: xxx
 
 OMFG
@@ -117,7 +117,7 @@ EOF
        my @full = `$cli cat \\<666\@example.com\\>`;
        my $from = shift @full;
        like($from, qr/^From /, "ssoma cat mbox has From_ line");
-       is(scalar grep(/^Message-Id: <666\@example\.com>/, @full), 1,
+       is(scalar grep(/^Message-ID: <666\@example\.com>/, @full), 1,
           "correct message returned from ssoma cat");
        my @lazy = `$cli cat 666\@example.com`;
        $from = shift @lazy;
@@ -131,7 +131,7 @@ EOF
        my @full = `$cli cat \\<666\@example.com\\> $tmp/input.git`;
        my $from = shift @full;
        like($from, qr/^From /, "ssoma cat mbox has From_ line");
-       is(scalar grep(/^Message-Id: <666\@example\.com>/, @full), 1,
+       is(scalar grep(/^Message-ID: <666\@example\.com>/, @full), 1,
           "correct message returned from ssoma cat");
 }
 
@@ -141,7 +141,7 @@ EOF
        my $dup = Email::Simple->new(<<'EOF');
 From: me@example.com
 To: u@example.com
-Message-Id: <666@example.com>
+Message-ID: <666@example.com>
 Subject: duplicate
 
 EOF
@@ -159,7 +159,7 @@ EOF
        is(system(@cmd), 0, "sync $name with ssoma(1)");
 
        my @both = `$cli cat \\<666\@example.com\\>`;
-       is(scalar grep(/^Message-Id: <666\@example\.com>/, @both), 2,
+       is(scalar grep(/^Message-ID: <666\@example\.com>/, @both), 2,
           "correct messages returned from ssoma cat");
        is(scalar grep(/^From /, @both), 2,
           "From_ line from both messages returned from ssoma cat");
@@ -178,7 +178,7 @@ EOF
        my $simple = Email::Simple->new(<<'EOF');
 From: me@example.com
 To: u@example.com
-Message-Id: <666@example.com>
+Message-ID: <666@example.com>
 Subject: zzz
 
 OMFG
@@ -201,7 +201,7 @@ EOF
        my $simple = Email::Simple->new(<<'EOF');
 From: moi@example.com
 To: you@example.com
-Message-Id: <666666@example.com>
+Message-ID: <666666@example.com>
 Subject: xxx
 
 OMFG
index 62a5571da4b51d6c6bd27d5352c50ff18fff5e7b..c517d73be3a75a54e1f5f285ae92974889d07fdc 100644 (file)
@@ -23,7 +23,7 @@ my $mda = Ssoma::MDA->new($mdagit);
 my $email = Email::Simple->new(<<'EOF');
 From: U <u@example.com>
 To: Me <me@example.com>
-Message-Id: <666@example.com>
+Message-ID: <666@example.com>
 Subject: :o
 
 HIHI
@@ -87,7 +87,7 @@ my $check_last = sub {
 my $another = Email::Simple->new(<<'EOF');
 From: U <u@example.com>
 To: Me <me@example.com>
-Message-Id: <666666@example.com>
+Message-ID: <666666@example.com>
 Subject: byebye
 
 *yawn*
@@ -136,7 +136,7 @@ $mda->deliver($another);
 my $conflict = Email::Simple->new(<<'EOF');
 From: U <u@example.com>
 To: Me <me@example.com>
-Message-Id: <666666@example.com>
+Message-ID: <666666@example.com>
 Subject: BYE
 
 *YAWN*
@@ -181,7 +181,7 @@ $mda->deliver($conflict);
        my @lines = <$fh>;
        my @subjects = grep /^Subject:/, @lines;
        my @from = grep /^From:/, @lines;
-       my @mid = grep /^Message-Id:/i, @lines;
+       my @mid = grep /^Message-ID:/i, @lines;
        is(scalar @subjects, 3, "3 subjects in dump");
        is(scalar @mid, 3, "3 message-ids in dump");
        is(scalar @from, 3, "3 From: lines in dump");
index 6fa833bd804b304d4c1b5fc0e9aa506fd7fed4a2..1d74c026f84b1fb2254564944824ab1043a859ec 100644 (file)
@@ -23,7 +23,7 @@ my @tree;
        my $email = Email::Simple->new(<<'EOF');
 From: me@example.com
 To: u@example.com
-Message-Id: <666@example.com>
+Message-ID: <666@example.com>
 Subject: zzz
 
 OMFG