sortah 0.5.0 → 0.5.1

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+##11/02/11
+
+- fixed the "sortah hangs when redirecting to another router" bug
+  - this required changing cleanroom to be a normal Object subclass, instead of
+    a BasicObject subclass, I need to investigate re-adding certain methods to
+    Object so that the throw/catch machinery will be in place for BasicObject
+- made bin/sortah more verbose

data/FUTURE_PLANS.md

@@ -1,5 +1,64 @@
 #Ideas
 
+- nested destinations --- overhaul of destinations
+
+two things, first, change the way destinations are defined, eg:
+
+    maildir "/path/to/root/mail/dir/" do
+      destination :personal do
+        dir "gmail/"
+        type :maildir
+
+        destination :contact do
+          dir "contacts/" 
+          type :maildir
+
+          destination :joe
+          destination :jenn
+          destination :tim
+
+        end
+
+        destination :mailing_lists do
+          type :mbox
+          #... snip ...
+        end
+      end
+
+      #... snip ...
+
+      abs :bitbucket, "/dev/null"
+
+      proxy :search_index do
+        #code to inject into search index
+      end
+
+      #... snip ...
+    end
+
+This would make defining destinations a bit nicer, in addition to providing a
+way for multi-type mailboxen. 
+
+- 'scaffold' functionality
+
+should build all the scaffolding described by the destinations given in the
+sortah configuration
+
+- 'resource' type
+
+A resource is some block of code which returns an object which is cached, like
+lenses, a router, lens, or resource may depend on other resources. Resources
+differ from lenses in that they are not bound to an email, and -- in the event
+of multiple incoming emails, are executed only once across the whole session
+
+- speed
+
+it's pretty slow, as it stands, could definitely use some speed up. Major
+improvement would be a sortah server, which could run persistently, so that
+starting/stopping a ruby vm wouldn't be necessary. Also, parallizing sortah 
+would be nice, potential for that could be batch execution or the server idea
+from above.
+
 - proxy destinations
 
 Difficulty: middling

data/KNOWN_BUGS.md

@@ -9,4 +9,6 @@ if you do
 
     sortah.sort(email).metadata#blahblah
 
+--------
 
+if you try to metaprogram routers or w/e, it doesn't actually define them.

data/bin/sortah

@@ -17,6 +17,7 @@ email = Mail.new do
   body ARGF.read
 end
 
+puts "Loading sortah rc" if opts[:verbose]
 load File.expand_path(opts[:rc])
 
 dest = sortah.sort(email).full_destination

data/lib/sortah/cleanroom.rb

@@ -4,15 +4,13 @@ module Sortah
   end
   
   
-  class CleanRoom < BasicObject
+  class CleanRoom < Object
     def self.sort(email, context)
       new(email, context).sort
     end
 
     def sort
-      until @pointer.is_a?(Destination) do
-        run!(@pointer) rescue FinishedExecution
-      end 
+      catch(:finished_execution) { run!(@pointer) } until @pointer.is_a?(Destination)
       self
     end
 
@@ -35,7 +33,7 @@ module Sortah
 
     def send_to(dest)
       @pointer = @__context__.routers[dest] || @__context__.destinations[dest]
-      throw FinishedExecution
+      throw :finished_execution 
     end
 
     def initialize(email, context)

data/lib/sortah/version.rb

@@ -1,3 +1,3 @@
 module Sortah
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/spec/fixtures/semantic_acceptance/contact.rb

@@ -0,0 +1,99 @@
+require 'yaml'
+require 'sortah'
+
+class Contact 
+  def want?(email)
+    @emails.include?(email.sender) ||
+    email.from.any? { |me| is?(me) }
+  end
+  
+  def build_destination(prefix)
+    local_dest = @destination #this gets around a weirdness -- the ivar doesn't end up in the right scope 
+                              #otherwise
+    sortah { destination local_dest, "#{prefix}/#{local_dest}/new/" }
+  end
+
+  def is?(contact)
+    case contact
+    when Contact
+      @emails.any? { |e| contact.is? e }
+    when String
+      @emails.include? contact
+    else 
+      raise "Tried to compare a contact to something that wasn't an email address or contact object"
+    end
+  end
+
+  def <<(email)
+    @emails << email
+    update_in_contacts
+  end
+
+  attr_reader :destination
+
+  def initialize(emails, destination, path = '~/.sortah/contacts.yml')
+    @emails = emails
+    @destination = destination
+    @path = path
+    register_with_contacts
+  end
+
+  def register_with_contacts
+    Contacts(@path).add_contact(self)
+  end
+
+  def update_in_contacts
+    Contacts(@path).update(self)
+  end
+end
+
+class Contacts
+  def build_destinations(prefix)
+    @contacts.map { |c| c.build_destination(prefix) } 
+  end
+
+  def destination_for(email)
+    find(email).first.destination
+  end
+
+  def want?(email)
+    @contacts.any? { |c| c.want? email } 
+  end
+
+  def find(email)
+    @contacts.select { |c| c.want? email } 
+  end
+
+  def add_contact(c)
+    @contacts << c
+  end
+
+  def update(c)
+    @contacts = @contacts.delete_if { |k| k.is? c } #compares by email
+    add_contact(c)
+  end
+
+  def save
+    File.open(@path, 'w') { |f| f << @contacts.to_yaml } 
+  end
+
+  private
+
+  def load_contacts
+    @contacts = []
+    @contacts = YAML.load(File.read(@path)) if File.exists?(@path)
+  end
+
+  def initialize(path = nil)
+    if path
+      @path = File.expand_path(path)
+    else
+      @path = "#{ENV["HOME"]}/.sortah/contacts.yml"
+    end
+    load_contacts
+  end
+end
+
+def Contacts(path = nil)
+  Contacts.new(path)
+end

data/spec/fixtures/semantic_acceptance/contacts.yml

@@ -0,0 +1,10 @@
+--- 
+- !ruby/object:Contact 
+  destination: joe 
+  emails: 
+  - jfredett@place.com
+  - joe@other_place.com
+- !ruby/object:Contact 
+  destination: sarah 
+  emails: 
+  - sfredett@somewhere.com

data/spec/fixtures/semantic_acceptance/coworkers.yml

@@ -0,0 +1,4 @@
+- !ruby/object:Contact 
+  destination: brian
+  emails: 
+    - brian@work.com

data/spec/fixtures/semantic_acceptance/rc

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+#^^ just to make syntax highlighting stick
+
+require './spec/fixtures/semantic_acceptance/contact.rb'
+
+#destinations and maildir
+sortah do
+  maildir "/Users/jfredett/.mutt/mail/"
+
+  $contacts = {}
+  $contacts[:work]     = Contacts("./spec/fixtures/semantic_acceptance/coworkers.yml")
+  $contacts[:personal] = Contacts("./spec/fixtures/semantic_acceptance/contacts.yml")
+
+  $contacts[:work].build_destinations(:work)
+  $contacts[:personal].build_destinations(:personal)
+
+  destination :unknown, 'new/'
+  destination :unknown_personal, 'personal/unknown/new'
+  destination :unknown_work, 'work/unknown/new'
+  destination :unknown_coworker, 'work/coworkers/unknown/new'
+end
+
+#routers
+sortah do 
+  router :personal do
+    contact = $contacts[:personal]
+    send_to contact.destination_for(email) if contact.want? email
+    send_to :unknown_personal 
+  end
+
+  router :work do
+    contact = $contacts[:work]
+    send_to contact.destination_for(email) if contact.want? email
+    send_to :unknown_work 
+  end
+
+  router do
+    send_to :personal if email.to.any? { |r| r =~ /jfredett@place.com/ }
+    send_to :work if email.to.any? { |r| r =~ /joe@work.com/ } 
+    send_to :unknown
+  end
+
+end

data/spec/parser_spec.rb

@@ -15,6 +15,7 @@ describe Sortah::Parser do
         sortah.should_not be_nil
       end
 
+
       it "should parse defined 'simple' destinations"  do
         expect {
           sortah do
@@ -230,15 +231,30 @@ describe Sortah::Parser do
         sortah.maildir.should == "/home/user/.mail/personal"
       end
 
+      it "should pass over a nested #sortah block" do
+        expect { 
+          sortah do
+            sortah do
+              destination :foo, "foo/"
+
+              sortah do
+              end
+            end
+          end 
+        }.should_not raise_error
+        sortah.destinations[:foo].should == 'foo/'
+      end
     end
 
     #acceptance criteria
     it "should parse an example sortah file, which contains all of the language elements" do
       expect { 
         sortah do
-          destination :place, "somewhere"
-          destination :devnull, :abs => "/dev/null"
-          destination :bitbucket, :devnull
+          sortah do
+            destination :place, "somewhere"
+            destination :devnull, :abs => "/dev/null"
+            destination :bitbucket, :devnull
+          end
 
           lens :random_value do
             rand

data/spec/semantic_spec.rb

@@ -18,45 +18,46 @@ def basic_sortah_definition
 end
 
 describe Sortah do
-  context "when sorting an email" do
-    before :all do
-      Mail.defaults do
-        delivery_method :test
-      end
+  before :all do
+    Mail.defaults do
+      delivery_method :test
+    end
 
-      @email = Mail.new do
-        to 'testa@example.com'
-        from 'chuck@nope.com'
-        subject "Taximerdizin'"
-        body <<-TXT
-          OJAI VALLEY TAXIDERMY
+    @email = Mail.new do
+      to 'testa@example.com'
+      from 'chuck@nope.com'
+      subject "Taximerdizin'"
+      body <<-TXT
+        OJAI VALLEY TAXIDERMY
 
-          BET YOU THOUGHT THIS EMAIL WAS REAL
+        BET YOU THOUGHT THIS EMAIL WAS REAL
 
-          NOPE. CHUCK TESTA
-        TXT
-      end
-
-      @reply_email = Mail.new do
-        to 'chuck@nope.com'
-        from 'jgf@somewhere.com'
-        subject "Re: Taximerdizin'"
-        reply_to 'chuck@nope.com'
-        body <<-TXT
-        > OJAI VALLEY TAXIDERMY
-        >
-        > BET YOU THOUGHT THIS EMAIL WAS REAL
-        >
-        > NOPE. CHUCK TESTA
-
-        Do you taxidermize pets? 
-        TXT
-      end
+        NOPE. CHUCK TESTA
+      TXT
     end
 
-    before :each do
-      Sortah::Parser.clear!
+    @reply_email = Mail.new do
+      to 'chuck@nope.com'
+      from 'jgf@somewhere.com'
+      subject "Re: Taximerdizin'"
+      reply_to 'chuck@nope.com'
+      body <<-TXT
+      > OJAI VALLEY TAXIDERMY
+      >
+      > BET YOU THOUGHT THIS EMAIL WAS REAL
+      >
+      > NOPE. CHUCK TESTA
+
+      Do you taxidermize pets? 
+      TXT
     end
+  end
+
+  before :each do
+    Sortah::Parser.clear!
+  end
+
+  context "when sorting an email" do
 
     it "should provide a way to sort a single email" do
       sortah.should respond_to :sort
@@ -111,6 +112,44 @@ describe Sortah do
         sortah.sort(@reply_email).destination.should == "bar/"
       end
 
+      it "should defer to a second router using the more idiomatic ruby syntax" do
+        sortah do
+          destination :foo, "foo/"
+          destination :bar, "bar/"
+          
+          router do
+            send_to :foo if email.from.any? { |sender| sender =~ /chuck/ }
+            send_to :secondary_router
+          end
+
+          router :secondary_router do
+            send_to :bar
+          end
+        end
+        sortah.sort(@email).destination.should == "foo/"
+        sortah.sort(@reply_email).destination.should == "bar/"
+      end
+
+      it "should allow me to set local variables in a router block" do
+        sortah do
+          destination :foo, "foo/"
+          destination :bar, "bar/"
+          
+          router do
+            senders = email.from
+
+            send_to :foo if senders.any? { |sender| sender =~ /chuck/ }
+            send_to :secondary_router
+          end
+
+          router :secondary_router do
+            send_to :bar
+          end
+        end
+        sortah.sort(@email).destination.should == "foo/"
+        sortah.sort(@reply_email).destination.should == "bar/"
+      end
+      
       it "should run dependent lenses for the root router" do
         sortah do
           destination :foo, "foo/"
@@ -305,6 +344,32 @@ describe Sortah do
           
         end
       end
+
+    end
+
+  end
+
+  describe "acceptance" do
+    it "should be able to parse and sort using a real live example sortah definition" do
+    
+      sortah do
+        load './spec/fixtures/semantic_acceptance/rc'
+      end
+
+      personal_email = Mail.new do
+        To 'jfredett@place.com'
+        From 'sfredett@somewhere.com'
+      end
+      work_email = Mail.new do
+        To 'joe@work.com'
+        From 'brian@work.com'
+        Subject 'You get a raise, you brilliant bastard.'
+        #shuttup, I can dream.
+      end
+
+      sortah.sort(@email).destination.should == 'new/'
+      sortah.sort(personal_email).destination.should == 'personal/sarah/new/'
+      sortah.sort(work_email).destination.should == 'work/brian/new/'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sortah
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-25 00:00:00.000000000Z
+date: 2011-11-02 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
-  requirement: &2153551920 !ruby/object:Gem::Requirement
+  requirement: &2164841700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153551920
+  version_requirements: *2164841700
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &2153551480 !ruby/object:Gem::Requirement
+  requirement: &2164841260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153551480
+  version_requirements: *2164841260
 description: ! "\n    Sortah provides a simple, declarative internal DSL for sorting
   \n    your email. It provides an executable which may serve as an external\n    mail
   delivery agent for such programs as `getmail`. Finally, since\n    your sorting
@@ -50,6 +50,7 @@ files:
 - .gitignore
 - .rvmrc
 - .travis.yml
+- CHANGELOG.md
 - CONTRIBUTION.md
 - FUTURE_PLANS.md
 - Gemfile
@@ -78,6 +79,10 @@ files:
 - spec/destination_spec.rb
 - spec/email_spec.rb
 - spec/fixtures/rc
+- spec/fixtures/semantic_acceptance/contact.rb
+- spec/fixtures/semantic_acceptance/contacts.yml
+- spec/fixtures/semantic_acceptance/coworkers.yml
+- spec/fixtures/semantic_acceptance/rc
 - spec/parser_spec.rb
 - spec/semantic_spec.rb
 - spec/sortah_handler_spec.rb
@@ -111,6 +116,10 @@ test_files:
 - spec/destination_spec.rb
 - spec/email_spec.rb
 - spec/fixtures/rc
+- spec/fixtures/semantic_acceptance/contact.rb
+- spec/fixtures/semantic_acceptance/contacts.yml
+- spec/fixtures/semantic_acceptance/coworkers.yml
+- spec/fixtures/semantic_acceptance/rc
 - spec/parser_spec.rb
 - spec/semantic_spec.rb
 - spec/sortah_handler_spec.rb