sup 0.6 → 0.7

data/doc/Philosophy.txt

@@ -1,69 +0,0 @@
-Should an email client have a philosophy? For many people, email is
-one of our primary means of communication, and email archives are an
-integral part of our long-term memory. Something so important ought to
-warrant a little thought.
-
-Here's Sup's philosophy.
-
-Using "traditional" email clients today is increasingly problematic.
-Anyone who's on a high-traffic mailing list knows this. My ruby-talk
-folder is 430 megs and Mutt sits there for 60 seconds while it opens
-it. Keeping up with the all the new traffic is impossible, even with
-Mutt's excellent threading features, simply because there's so much of
-it. A single thread can span several pages in the folder index view
-alone! And Mutt is probably the fastest, most mailing-list aware email
-client out there. God help me if I try and use Thunderbird.
-
-The problem with traditional clients like Mutt is that they deal with
-individual pieces of email. This places a high mental cost on the user
-for each incoming email, by forcing them to ask: Should I keep this
-email, or delete it? If I keep it, where should I file it? I've spent
-the last 10 years of my life laboriously hand-filing every email
-message I received and feeling a mild sense of panic every time an
-email was both "from Mom" and "about school". The massive amounts of
-email that many people receive, and the cheap cost of storage, have
-made these questions both more costly and less useful to answer.
-
-Contrast that with using Gmail. As a long-time Mutt user, I was blown
-away when I first saw someone use Gmail. They treated their email
-differently from how I ever had. They never filed email and they never
-deleted it. They relied on an immediate, global, full-text search, and
-thread-level tagging, to do everything I'd ever done with Mutt, but
-with a trivial cost to the user at message receipt time.
-
-From Gmail I learned that making certain operations quantitatively
-easier (namely, search) resulted in a qualitative improvement in
-usage. I also learned how thread-centrism was advantageous over
-message-centrism when message volume was high: most of the time, a
-message and its context deserve the same treatment. I think it's to
-the Gmail designers' credit that they started with a somewhat ad-hoc
-idea (hey, we're really good at search engines, so maybe we can build
-an email client on top of one) and managed to build something that was
-actually better than everything else out there. At least, that's how I
-imagine in happened. Maybe they knew what they were doing from the
-start.
-
-Unfortunately, there's a lot to Gmail I can't tolerate (top posting,
-HTML mail, one-level threads, and ads come to mind, never mind the
-fact that it's not FOSS). Thus Sup was born.
-
-Sup is based on the following principles, which I stole directly from
-Gmail:
-
-- An immediately accessible and fast search capability over the entire
-  email archive eliminates most of the need for folders, and most of
-  the necessity of deleting email.
-
-- Labels eliminate what little need for folders search doesn't cover.
-
-- A thread-centric approach to the UI is much more in line with how
-  people operate than dealing with individual messages is. In the vast
-  majority of cases, a message and its context should be subject to
-  the same treatment.
-
-Sup is also based on many ideas from mutt and Emacs and vi, having to
-do with the fantastic productivity of a console- and keyboard-based
-application, the usefulness of multiple buffers, the necessity of
-handling multiple email accounts, etc. But those are just details!
-
-Try it and let me know what you think.

data/test/test_mbox_parsing.rb

@@ -1,114 +0,0 @@
-#!/usr/bin/ruby
-
-require 'test/unit'
-require 'sup'
-require 'stringio'
-
-include Redwood
-
-class TestMessage < Test::Unit::TestCase
-  def setup
-  end
-
-  def teardown
-  end
-
-  def test_normal_headers
-    h = MBox.read_header StringIO.new(<<EOS)
-From: Bob <bob@bob.com>
-To: Sally <sally@sally.com>
-EOS
-
-    assert_equal "Bob <bob@bob.com>", h["From"]
-    assert_equal "Sally <sally@sally.com>", h["To"]
-    assert_nil h["Message-Id"]
-  end
-
-  ## this is shitty behavior in retrospect, but it's built in now.
-  def test_message_id_stripping
-    h = MBox.read_header StringIO.new("Message-Id: <one@bob.com>\n")
-    assert_equal "one@bob.com", h["Message-Id"]
-
-    h = MBox.read_header StringIO.new("Message-Id: one@bob.com\n")
-    assert_equal "one@bob.com", h["Message-Id"]
-  end
-
-  def test_multiline
-    h = MBox.read_header StringIO.new(<<EOS)
-From: Bob <bob@bob.com>
-Subject: one two three
-  four five six
-To: Sally <sally@sally.com>
-References: seven
-  eight
-Seven: Eight
-EOS
-
-    assert_equal "one two three four five six", h["Subject"]
-    assert_equal "Sally <sally@sally.com>", h["To"]
-    assert_equal "seven eight", h["References"]
-  end
-
-  def test_ignore_spacing
-    variants = [
-      "Subject:one two  three   end\n",
-      "Subject:    one two  three   end\n",
-      "Subject:   one two  three   end    \n",
-    ]
-    variants.each do |s|
-      h = MBox.read_header StringIO.new(s)
-      assert_equal "one two  three   end", h["Subject"]
-    end
-  end
-
-  def test_message_id_ignore_spacing
-    variants = [
-      "Message-Id:     <one@bob.com>       \n",
-      "Message-Id:      one@bob.com        \n",
-      "Message-Id:<one@bob.com>       \n",
-      "Message-Id:one@bob.com       \n",
-    ]
-    variants.each do |s|
-      h = MBox.read_header StringIO.new(s)
-      assert_equal "one@bob.com", h["Message-Id"]
-    end
-  end
-
-  def test_ignore_empty_lines
-    variants = [
-      "",
-      "Message-Id:       \n",
-      "Message-Id:\n",
-    ]
-    variants.each do |s|
-      h = MBox.read_header StringIO.new(s)
-      assert_nil h["Message-Id"]
-    end
-  end
-
-  def test_detect_end_of_headers
-    h = MBox.read_header StringIO.new(<<EOS)
-From: Bob <bob@bob.com>
-
-To: a dear friend
-EOS
-  assert_equal "Bob <bob@bob.com>", h["From"]
-  assert_nil h["To"]
-
-  h = MBox.read_header StringIO.new(<<EOS)
-From: Bob <bob@bob.com>
-\r
-To: a dear friend
-EOS
-  assert_equal "Bob <bob@bob.com>", h["From"]
-  assert_nil h["To"]
-
-  h = MBox.read_header StringIO.new(<<EOS)
-From: Bob <bob@bob.com>
-\r\n\r
-To: a dear friend
-EOS
-  assert_equal "Bob <bob@bob.com>", h["From"]
-  assert_nil h["To"]
-  end
-end

data/test/test_message.rb

@@ -1,441 +0,0 @@
-#!/usr/bin/ruby
-
-require 'test/unit'
-require 'sup'
-require 'stringio'
-
-require 'dummy_source'
-
-# override File.exists? to make it work with StringIO for testing.
-# FIXME: do aliasing to avoid breaking this when sup moves from
-# File.exists? to File.exist?
-
-class File
-
-  def File.exists? file
-    # puts "fake File::exists?"
-
-    if file.is_a?(StringIO)
-      return false
-    end
-    # use the different function
-    File.exist?(file)
-  end
-
-end
-
-module Redwood
-
-class TestMessage < Test::Unit::TestCase
-  
-  def setup
-    person_file = StringIO.new("")
-    # this is a singleton
-    if not PersonManager.instantiated?
-      @person_manager = PersonManager.new(person_file)
-    end
-  end
-  
-  def teardown
-  end
-
-  def test_simple_message
-
-    message = <<EOS
-Return-path: <fake_sender@example.invalid>
-Envelope-to: fake_receiver@localhost
-Delivery-date: Sun, 09 Dec 2007 21:48:19 +0200
-Received: from fake_sender by localhost.localdomain with local (Exim 4.67)
-      (envelope-from <fake_sender@example.invalid>)
-      id 1J1S8R-0006lA-MJ
-      for fake_receiver@localhost; Sun, 09 Dec 2007 21:48:19 +0200
-Date: Sun, 9 Dec 2007 21:48:19 +0200
-Mailing-List: contact example-help@example.invalid; run by ezmlm
-Precedence: bulk
-List-Id: <example.list-id.example.invalid>
-List-Post: <mailto:example@example.invalid>
-List-Help: <mailto:example-help@example.invalid>
-List-Unsubscribe: <mailto:example-unsubscribe@example.invalid>
-List-Subscribe: <mailto:example-subscribe@example.invalid>
-Delivered-To: mailing list example@example.invalid
-Delivered-To: moderator for example@example.invalid
-From: Fake Sender <fake_sender@example.invalid>
-To: Fake Receiver <fake_receiver@localhost>
-Subject: Re: Test message subject
-Message-ID: <20071209194819.GA25972@example.invalid>
-References: <E1J1Rvb-0006k2-CE@localhost.localdomain>
-MIME-Version: 1.0
-Content-Type: text/plain; charset=us-ascii
-Content-Disposition: inline
-In-Reply-To: <E1J1Rvb-0006k2-CE@localhost.localdomain>
-User-Agent: Sup/0.3
-
-Test message!
-EOS
-
-    source = DummySource.new("sup-test://test_simple_message")
-    source.messages = [ message ]
-    source_info = 0
-
-    sup_message = Message.new( {:source => source, :source_info => source_info } )
-
-    # see how well parsing the header went
-
-    to = sup_message.to
-    # "to" is an Array containing person items
-
-    # there should be only one item
-    assert_equal(1, to.length)
-
-    # sup doesn't do capitalized letters in email addresses
-    assert_equal("fake_receiver@localhost", to[0].email)
-    assert_equal("Fake Receiver", to[0].name)
-
-    from = sup_message.from
-    # "from" is just a simple person item 
-
-    assert_equal("fake_sender@example.invalid", from.email)
-    assert_equal("Fake Sender", from.name)
-    
-    subj = sup_message.subj
-    assert_equal("Re: Test message subject", subj)
-    
-    list_subscribe = sup_message.list_subscribe
-    assert_equal("<mailto:example-subscribe@example.invalid>", list_subscribe)
-
-    list_unsubscribe = sup_message.list_unsubscribe
-    assert_equal("<mailto:example-unsubscribe@example.invalid>", list_unsubscribe)
-    
-    list_address = sup_message.list_address
-    assert_equal("example@example.invalid", list_address.email)
-    assert_equal("example", list_address.name)
-    
-    date = sup_message.date
-    assert_equal(Time.parse("Sun, 9 Dec 2007 21:48:19 +0200"), date)
-    
-    id = sup_message.id
-    assert_equal("20071209194819.GA25972@example.invalid", id)
-
-    refs = sup_message.refs
-    assert_equal(1, refs.length)
-    assert_equal("E1J1Rvb-0006k2-CE@localhost.localdomain", refs[0])
-    
-    replytos = sup_message.replytos
-    assert_equal(1, replytos.length)
-    assert_equal("E1J1Rvb-0006k2-CE@localhost.localdomain", replytos[0])
-    
-    cc = sup_message.cc
-    # there are no ccs
-    assert_equal(0, cc.length)
-    
-    bcc = sup_message.bcc
-    # there are no bccs
-    assert_equal(0, bcc.length)
-    
-    recipient_email = sup_message.recipient_email
-    assert_equal("fake_receiver@localhost", recipient_email)
-
-    message_source = sup_message.source
-    assert_equal(message_source, source)
-    
-    message_source_info = sup_message.source_info
-    assert_equal(message_source_info, source_info)
-    
-    # read the message body chunks
-
-    chunks = sup_message.load_from_source!
-
-    # there should be only one chunk
-    assert_equal(1, chunks.length)
-
-    lines = chunks[0].lines
-
-    # there should be only one line
-    assert_equal(1, lines.length)
-
-    assert_equal("Test message!", lines[0])
-
-  end
-
-  def test_multipart_message
-
-    message = <<EOS
-From fake_receiver@localhost Sun Dec 09 22:33:37 +0200 2007
-Subject: Re: Test message subject
-From: Fake Receiver <fake_receiver@localhost>
-To: Fake Sender <fake_sender@example.invalid>
-References: <E1J1Rvb-0006k2-CE@localhost.localdomain> <20071209194819.GA25972example.invalid>
-In-Reply-To: <20071209194819.GA25972example.invalid>
-Date: Sun, 09 Dec 2007 22:33:37 +0200
-Message-Id: <1197232243-sup-2663example.invalid>
-User-Agent: Sup/0.3
-Content-Type: multipart/mixed; boundary="=-1197232418-506707-26079-6122-2-="
-MIME-Version: 1.0
-
-
---=-1197232418-506707-26079-6122-2-=
-Content-Type: text/plain; charset=utf-8
-Content-Disposition: inline
-
-Excerpts from Fake Sender's message of Sun Dec 09 21:48:19 +0200 2007:
-> Test message!
-
-Thanks for the message!
---=-1197232418-506707-26079-6122-2-=
-Content-Disposition: attachment; filename="HACKING"
-Content-Type: application/octet-stream; name="HACKING"
-Content-Transfer-Encoding: base64
-
-UnVubmluZyBTdXAgbG9jYWxseQotLS0tLS0tLS0tLS0tLS0tLS0tCkludm9r
-ZSBpdCBsaWtlIHRoaXM6CgpydWJ5IC1JIGxpYiAtdyBiaW4vc3VwCgpZb3Un
-bGwgaGF2ZSB0byBpbnN0YWxsIGFsbCBnZW1zIG1lbnRpb25lZCBpbiB0aGUg
-UmFrZWZpbGUgKGxvb2sgZm9yIHRoZSBsaW5lCnNldHRpbmcgcC5leHRyYV9k
-ZXBzKS4gSWYgeW91J3JlIG9uIGEgRGViaWFuIG9yIERlYmlhbi1iYXNlZCBz
-eXN0ZW0gKGUuZy4KVWJ1bnR1KSwgeW91J2xsIGhhdmUgdG8gbWFrZSBzdXJl
-IHlvdSBoYXZlIGEgY29tcGxldGUgUnVieSBpbnN0YWxsYXRpb24sCmVzcGVj
-aWFsbHkgbGlic3NsLXJ1YnkuCgpDb2Rpbmcgc3RhbmRhcmRzCi0tLS0tLS0t
-LS0tLS0tLS0KCi0gRG9uJ3Qgd3JhcCBjb2RlIHVubGVzcyBpdCByZWFsbHkg
-YmVuZWZpdHMgZnJvbSBpdC4gVGhlIGRheXMgb2YKICA4MC1jb2x1bW4gZGlz
-cGxheXMgYXJlIGxvbmcgb3Zlci4gQnV0IGRvIHdyYXAgY29tbWVudHMgYW5k
-IG90aGVyCiAgdGV4dCBhdCB3aGF0ZXZlciBFbWFjcyBtZXRhLVEgZG9lcy4K
-LSBJIGxpa2UgcG9ldHJ5IG1vZGUuCi0gVXNlIHt9IGZvciBvbmUtbGluZXIg
-YmxvY2tzIGFuZCBkby9lbmQgZm9yIG11bHRpLWxpbmUgYmxvY2tzLgoK
-
---=-1197232418-506707-26079-6122-2-=
-Content-Disposition: attachment; filename="Manifest.txt"
-Content-Type: text/plain; name="Manifest.txt"
-Content-Transfer-Encoding: quoted-printable
-
-HACKING
-History.txt
-LICENSE
-Manifest.txt
-README.txt
-Rakefile
-bin/sup
-bin/sup-add
-bin/sup-config
-bin/sup-dump
-bin/sup-recover-sources
-bin/sup-sync
-bin/sup-sync-back
-
---=-1197232418-506707-26079-6122-2-=--
-EOS
-    source = DummySource.new("sup-test://test_multipart_message")
-    source.messages = [ message ]
-    source_info = 0
-
-    sup_message = Message.new( {:source => source, :source_info => source_info } )
-    
-    # read the message body chunks
-
-    chunks = sup_message.load_from_source!
-
-    # this time there should be four chunks: first the quoted part of
-    # the message, then the non-quoted part, then the two attachments
-    assert_equal(4, chunks.length)
-
-    assert_equal(chunks[0].class, Redwood::Chunk::Quote)
-    assert_equal(chunks[1].class, Redwood::Chunk::Text)
-    assert_equal(chunks[2].class, Redwood::Chunk::Attachment)
-    assert_equal(chunks[3].class, Redwood::Chunk::Attachment)
-
-    # further testing of chunks will happen in test_message_chunks.rb
-    # (possibly not yet implemented)
-
-  end
-  
-  def test_broken_message_1
-
-    # an example of a broken message, missing "to" and "from" fields
-
-    message = <<EOS
-Return-path: <fake_sender@example.invalid>
-Envelope-to: fake_receiver@localhost
-Delivery-date: Sun, 09 Dec 2007 21:48:19 +0200
-Received: from fake_sender by localhost.localdomain with local (Exim 4.67)
-      (envelope-from <fake_sender@example.invalid>)
-      id 1J1S8R-0006lA-MJ
-      for fake_receiver@localhost; Sun, 09 Dec 2007 21:48:19 +0200
-Date: Sun, 9 Dec 2007 21:48:19 +0200
-Subject: Re: Test message subject
-Message-ID: <20071209194819.GA25972@example.invalid>
-References: <E1J1Rvb-0006k2-CE@localhost.localdomain>
-MIME-Version: 1.0
-Content-Type: text/plain; charset=us-ascii
-Content-Disposition: inline
-In-Reply-To: <E1J1Rvb-0006k2-CE@localhost.localdomain>
-User-Agent: Sup/0.3
-
-Test message!
-EOS
-    
-    source = DummySource.new("sup-test://test_broken_message_1")
-    source.messages = [ message ]
-    source_info = 0
-
-    sup_message = Message.new( {:source => source, :source_info => source_info } )
-    
-    to = sup_message.to
-
-    # there should no items, since the message doesn't have any
-    # recipients -- still not nil
-    assert_equal(0, to.length)
-
-    # from will have bogus values
-    from = sup_message.from
-    # very basic email address check
-    assert_match(/\w+@\w+\.\w{2,4}/, from.email)
-    assert_not_nil(from.name)
-
-  end
-  
-  def test_broken_message_2
-
-    # an example of a broken message, no body at all
-
-    message = <<EOS
-Return-path: <fake_sender@example.invalid>
-From: Fake Sender <fake_sender@example.invalid>
-To: Fake Receiver <fake_receiver@localhost>
-Envelope-to: fake_receiver@localhost
-Delivery-date: Sun, 09 Dec 2007 21:48:19 +0200
-Received: from fake_sender by localhost.localdomain with local (Exim 4.67)
-      (envelope-from <fake_sender@example.invalid>)
-      id 1J1S8R-0006lA-MJ
-      for fake_receiver@localhost; Sun, 09 Dec 2007 21:48:19 +0200
-Date: Sun, 9 Dec 2007 21:48:19 +0200
-Subject: Re: Test message subject
-Message-ID: <20071209194819.GA25972@example.invalid>
-References: <E1J1Rvb-0006k2-CE@localhost.localdomain>
-MIME-Version: 1.0
-Content-Type: text/plain; charset=us-ascii
-Content-Disposition: inline
-In-Reply-To: <E1J1Rvb-0006k2-CE@localhost.localdomain>
-User-Agent: Sup/0.3
-EOS
-    
-    source = DummySource.new("sup-test://test_broken_message_1")
-    source.messages = [ message ]
-    source_info = 0
-
-    sup_message = Message.new( {:source => source, :source_info => source_info } )
-    
-    # read the message body chunks: no errors should reach this level
-
-    chunks = nil
-
-    assert_nothing_raised() do
-      chunks = sup_message.load_from_source!
-    end
-
-    # the chunks list should be empty
-
-    assert_equal(0, chunks.length)
-
-  end
-  
-  def test_multipart_message_2
-
-    message = <<EOS
-Return-path: <vim-mac-return-3938-fake_receiver=localhost@vim.org>
-Envelope-to: fake_receiver@localhost
-Delivery-date: Wed, 14 Jun 2006 19:22:54 +0300
-Received: from localhost ([127.0.0.1] helo=localhost.localdomain)
-	by localhost.localdomain with esmtp (Exim 4.60)
-	(envelope-from <vim-mac-return-3938-fake_receiver=localhost@vim.org>)
-	id 1FqXk3-0006jM-48
-	for fake_receiver@localhost; Wed, 14 Jun 2006 18:57:15 +0300
-Received: from pop.gmail.com
-	by localhost.localdomain with POP3 (fetchmail-6.3.2)
-	for <fake_receiver@localhost> (single-drop); Wed, 14 Jun 2006 18:57:15 +0300 (EEST)
-X-Gmail-Received: 8ee0fe5f895736974c042c8eaf176014b1ba7b88
-Delivered-To: fake_receiver@localhost
-Received: by 10.49.8.16 with SMTP id l16cs11327nfi;
-        Sun, 26 Mar 2006 19:31:56 -0800 (PST)
-Received: by 10.66.224.8 with SMTP id w8mr2172862ugg;
-        Sun, 26 Mar 2006 19:31:56 -0800 (PST)
-Received: from foobar.math.fu-berlin.de (foobar.math.fu-berlin.de [160.45.45.151])
-        by mx.gmail.com with SMTP id j3si553645ugd.2006.03.26.19.31.56;
-        Sun, 26 Mar 2006 19:31:56 -0800 (PST)
-Received-SPF: neutral (gmail.com: 160.45.45.151 is neither permitted nor denied by best guess record for domain of vim-mac-return-3938-fake_receiver=localhost@vim.org)
-Message-Id: <44275cac.74a494f1.315a.ffff825cSMTPIN_ADDED@mx.gmail.com>
-Received: (qmail 24265 invoked by uid 200); 27 Mar 2006 02:32:39 -0000
-Mailing-List: contact vim-mac-help@vim.org; run by ezmlm
-Precedence: bulk
-Delivered-To: mailing list vim-mac@vim.org
-Received: (qmail 7913 invoked from network); 26 Mar 2006 23:37:34 -0000
-Received: from cpe-138-217-96-243.vic.bigpond.net.au (HELO vim.org) (138.217.96.243)
-  by foobar.math.fu-berlin.de with SMTP; 26 Mar 2006 23:37:34 -0000
-From: fake_sender@example.invalid
-To: vim-mac@vim.org
-Subject: Mail Delivery (failure vim-mac@vim.org)
-Date: Mon, 27 Mar 2006 10:29:39 +1000
-MIME-Version: 1.0
-Content-Type: multipart/related;
-	type="multipart/alternative";
-	boundary="----=_NextPart_000_001B_01C0CA80.6B015D10"
-X-Priority: 3
-X-MSMail-Priority: Normal
-
-------=_NextPart_000_001B_01C0CA80.6B015D10
-Content-Type: multipart/alternative;
-	boundary="----=_NextPart_001_001C_01C0CA80.6B015D10"
-
-------=_NextPart_001_001C_01C0CA80.6B015D10
-Content-Type: text/plain;
-	charset="iso-8859-1"
-Content-Transfer-Encoding: quoted-printable
-
-------=_NextPart_001_001C_01C0CA80.6B015D10
-Content-Type: text/html;
-	charset="iso-8859-1"
-Content-Transfer-Encoding: quoted-printable
-
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
-<HTML><HEAD>
-<META content=3D"text/html; charset=3Diso-8859-1" =
-http-equiv=3DContent-Type>
-<META content=3D"MSHTML 5.00.2920.0" name=3DGENERATOR>
-<STYLE></STYLE>
-</HEAD>
-<BODY bgColor=3D#ffffff>If the message will not displayed automatically,<br>
-follow the link to read the delivered message.<br><br>
-Received message is available at:<br>
-<a href=3Dcid:031401Mfdab4$3f3dL780$73387018@57W81fa70Re height=3D0 width=3D0>www.vim.org/inbox/vim-mac/read.php?sessionid-18559</a>
-<iframe
-src=3Dcid:031401Mfdab4$3f3dL780$73387018@57W81fa70Re height=3D0 width=3D0></iframe> 
-<DIV>&nbsp;</DIV></BODY></HTML>
-
-------=_NextPart_001_001C_01C0CA80.6B015D10--
-
-------=_NextPart_000_001B_01C0CA80.6B015D10--
-
-
-EOS
-    source = DummySource.new("sup-test://test_multipart_message_2")
-    source.messages = [ message ]
-    source_info = 0
-
-    sup_message = Message.new( {:source => source, :source_info => source_info } )
-    
-    # read the message body chunks
-
-    assert_nothing_raised() do
-      chunks = sup_message.load_from_source!
-    end
-
-  end
-  
-  # TODO: test different error cases, malformed messages etc.
-
-  # TODO: test different quoting styles, see that they are all divided
-  # to chunks properly
-
-end
-
-end
-
-# vim:noai:ts=2:sw=2:
-