sup_tag 0.1.2 → 0.2.1

data/README.markdown

@@ -6,37 +6,102 @@ A gem to make tagging messages in sup cleaner.
 Usage
 =====
 
-This currently supports two methods to add tags, tag and archive. Tag adds tags
-but does not remove the inbox tag. Archive will add a tag and remove the inbox
-tag.
+Messages are tagged using by either the tag or archive block. The tag block will
+add the labels while archive adds labels and removes the inbox tag. Each block
+consists of methods of the message to call, what they should match against and
+the tags to add if the messages match. Tags must always be a symbol, while the
+queries may be either strings or regular expressions. It's easiest to see with 
+an example:
 
-Example
--------
-
-My before-add-message.rb looks like:
+    tag do
+        from 'blake', :self
+    end
 
-    require 'sup_tag'
-    require 'sup_tag/extensions/object'
+This would tag any message from 'blake' with self. If no tag is provided then
+the given queries are converted to strings and used as labels. For example:
 
-    # Tag messages
     tag do
-        from /jnls.cust.serv@oxfordjournals.org/i, :oxford
-        from /some_email/i, :tag1, :tag2
+        from /blake/i
+    end
+
+Here if a message is from 'blake' the message would be tagged as 'blake'. It is
+possible to use several queries in one rule as well.
+
+    archive do
+        from /blake/, /sweeney/, :self
+    end
+
+This would archive any message where the from matches both 'blake' and
+'sweeney' as self and the inbox tag would be removed. If the self tag had not
+been provided then the message would have been tagged as both 'blake' and
+'sweeney'. Tag and archive blocks may have many rules. For example:
+
+    tag
+        from /blake/, :self
+        subj /sup-talk/i
+    end
+
+Here messages from 'blake' are marked as self, while messages with 'sup-talk' in
+the subject line are marked as sup talk.
+
+If you wish to tag against several different fields then simply use a multi
+block. A multi block will require that all rules in the block hit in order to
+tag. 
+
+    tag
+        multi :ann, 'ruby-talk'.to_sym do
+            recipients /ruby-talk/
+            subj /ANN/
+        end
     end
 
-    # Archive messages
+This would tag any messages going to 'ruby-talk' with 'ANN' in the subject line.
+If tags are provided to the rules in the multi block they will be ignored. 
+
+There are some other probably less useful options. It is possible to archive a
+message directly without adding any tags. To do this provide a nil as the tag. 
+
     archive do
-        subj /sup-talk/i # Tag messages with sup-talk in subject as sup-talk
+        from /Boring/i, nil
     end
 
-This tags messages from jnls as oxford and leaves them in my inbox. Messages
-from some\_email are given tag1, tag2. Messages from sup-talk are given the
-sup-talk label and the inbox label is removed.
+This will archive any message from 'Boring' without adding any tags.
+
+Example
+-------
+
+My before-add-message.rb looks something like:
+
+    require 'sup_tag'
+    require "sup_tag/extensions/object"
+
+    archive do
+      subj /sup-talk/i
+      subj /MongoMapper/i, :MM
+      subj /easyb-users/i, :easyb
+      recipients /ruby-talk/i
+      recipients /vim(_|-)mac/i, :vim
+      recipients /buildr.apache.org/i, :buildr
+
+      multi :ann do
+        recipients /ruby-talk/i
+        subj /ANN/i
+      end
+    end
 
+    tag do
+      subj /BIOL\.1010/, :ta
+      subj /BIOL\.5870/, :ta
+      from /Mbuthia/, :ta
+      subj /Nucl. Acids Res/, :nar
+      subj /Database Table of Contents/, :biodb
+      from /rna@faseb.org/i, :rna
+      from /jnls.cust.serv@oxfordjournals.org/, :oxford
+    end
 
 Note on Patches/Pull Requests
 =============================
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.1

data/lib/sup_tag.rb

@@ -6,6 +6,7 @@ class SupTag
   # @param [Redwood::Message] message A Message to tag.
   def initialize(message)
     @message = message
+    @add = true
   end
 
   # Remove the given tags from the message.
@@ -23,9 +24,8 @@ class SupTag
   # @param [Block] block Block to add tags.
   # @return [Array] Tags on the message.
   def archive(&block)
-    @match = false
-    cloaker(&block).bind(self).call
-    remove(:inbox) if @match
+    tag(&block)
+    remove(:inbox) if @labels
     return @message.labels
   end
 
@@ -34,8 +34,27 @@ class SupTag
   # @param [Block] Block for adding tags.
   # @return [Array] The tags on the message.
   def tag(&block)
+    @labels = nil
     cloaker(&block).bind(self).call
-    @message.labels
+    @labels.each { |l| @message.add_label(l) } if @labels
+    return @message.labels
+  end
+
+  # Test queries across several feilds to add tags.
+  #
+  # @param [Symbol, Array] labels Labels to add.
+  # @param [Block] Block for adding tags.
+  # @return [Array] The tags on the message
+  def multi(*labels, &block)
+    @multi = true
+    @add = false
+    cloaker(&block).bind(self).call
+    @add = true
+    if @multi
+      @labels.concat(labels)
+      @match = true
+    end
+    return @message.labels
   end
 
   # Instance eval for blocks stolen from Trollop. Orignally from:
@@ -54,21 +73,52 @@ class SupTag
     end
   end
 
+  # Override to include methods from messages.
   def respond_to?(method, include_private = false)
     return @message.respond_to?(method) || super
   end
 
-  def method_missing(method, *args)
+  # Override method missing to allow for matching the results of
+  # a method on message against some queries.
+  def method_missing(method, *args, &block)
     super if !respond_to?(method)
-
-    match = args.shift
-    match_string = (match.is_a?(Regexp) ? match.source : match.to_s)
-    tags = (args.empty? ? [match_string.downcase] : args).compact
-    query = @message.send(method)
-    if (!query.is_a?(Array) && query.to_s.match(match)) ||
-      (query.is_a?(Array) && query.any? { |q| q.to_s.match(match) } )
-      @match = true
-      tags.map { |t| @message.add_label(t) }
+    parts = split_args(args)
+    queries = parts.first
+    results = Array(@message.send(method))
+    count = match_args(results, queries)
+    if count.size == queries.size
+      @labels ||= []
+      @multi &= true
+      @labels.concat(parts.last.compact) if @add
+    else
+      @multi = false
     end
   end
+
+  private
+    # Split the arguments into labels and queries.
+    #
+    # @param [Array] arguments Arguments to split.
+    def split_args(arguments)
+      parts = arguments.partition { |e| !e.is_a?(Symbol) && e }
+
+      # Generate labels if none given
+      if parts[1].empty?
+        parts[1] = parts[0].map do |part|
+          (part.is_a?(Regexp) ? part.source : part.to_s).downcase
+        end
+      end
+
+      return parts
+    end
+
+    # Match the results against the queries and count how many match.
+    #
+    # @param [Array] results Results to check.
+    # @param [Array] queries Queries to look for.
+    def match_args(results, queries)
+      queries.map do |query|
+        (results.any? { |r| r.to_s.match(query) } ? 1 : nil)
+      end.compact
+    end
 end

data/lib/sup_tag/extensions/Object.rb

@@ -1,3 +1,4 @@
+require 'sup_tag/extensions/binding'
 # Modify Object to support tag and archive methods.
 
 class Object
@@ -25,6 +26,6 @@ class Object
   # @param [Block] A Block to generate the tagger object with.
   # @return [SupTag] A SupTag object.
   def get_tagger(&block)
-    return SupTag.new(eval("lambda { message }", block.binding).call)
+    return SupTag.new(block.binding[:message])
   end
 end

data/lib/sup_tag/extensions/binding.rb

@@ -0,0 +1,12 @@
+# Modify Binding to extract value.
+
+class Binding
+
+  # Get the value of a variable of method in this binding.
+  #
+  # @param [Symbol, String] name Object to get value of.
+  # @return [Object] The value.
+  def [](name)
+    return eval("lambda { #{name.to_s} }", self).call
+  end
+end

data/spec/spec_helper.rb

@@ -1,10 +1,10 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'sup_tag'
+require 'sup_tag/extensions/object'
+require 'sup_tag/extensions/binding'
 require "rubygems"
 require "sup"
-require 'spec'
-require 'spec/autorun'
 require 'stringio'
 require 'rmail'
 require 'uri'

data/spec/sup_tag/extensions/binding_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe 'Binding' do
+  context '[]' do
+    it 'can get the value of a variable' do
+      @message = 'hi'
+      binding[:@message].should == 'hi'
+    end
+    it 'can get the value of a method' do
+      def bob
+        return 'jones'
+      end
+      binding['bob'].should == 'jones'
+    end
+  end
+end

data/spec/{object_spec.rb → sup_tag/extensions/object_spec.rb}

@@ -1,5 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'sup_tag/extensions/object'
+require 'spec_helper'
 
 describe 'Object' do
   before do

data/spec/{sup_tag_spec.rb → sup_tag/sup_tag_spec.rb}

@@ -1,6 +1,11 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe "SupTag" do
+  before do
+    @mess = get_short_message
+    @tagger = SupTag.new(@mess)
+  end
+
   context 'respond_to' do
     it 'responds to taggable methods' do
       [ :from, :subj, :to, :replyto ].each do |meth|
@@ -10,11 +15,6 @@ describe "SupTag" do
   end
 
   context 'tags' do
-    before do
-      @mess = get_short_message
-      @tagger = SupTag.new(@mess)
-    end
-
     context 'removing tags' do
       it 'can remove a given tag' do
         @mess.add_label(:t)
@@ -84,6 +84,51 @@ describe "SupTag" do
         end
         @mess.labels.should == Set[:old]
       end
+      it 'can tag using several criteria at once' do
+        @tagger.tag do
+          date /2/, /7/, :self
+        end
+        @mess.labels.should == Set[:self]
+      end
+      it 'requires all criteria to match' do
+        @tagger.tag do
+          date /2/, /blake/, :me
+        end
+        @mess.labels.should == Set.new
+      end
+      it 'uses all requirements as the labels if none given' do
+        @tagger.tag do
+          date /2/, /7/
+        end
+        @mess.labels.should == Set['2'.to_sym, '7'.to_sym]
+      end
+      it 'can use a multi tag block to specify requirements on several results' do
+        @tagger.tag do
+          multi :bob do
+            subj /test/i
+            date /2/
+          end
+        end
+        @mess.labels.should == Set[:bob]
+      end
+      it 'requires that all queries in the multi block match to tag' do
+        @tagger.tag do
+          multi :bob do
+            subj /test/i
+            date '-1'
+          end
+        end
+        @mess.labels.should == Set[]
+      end
+      it 'can add several tags with a multi block' do
+        @tagger.tag do
+          multi :jo, :bob do
+            subj /test/i
+            date /2/
+          end
+        end
+        @mess.labels.should == Set[:jo, :bob]
+      end
     end
 
     context 'adding tags' do
@@ -144,6 +189,15 @@ describe "SupTag" do
       end
       @mess.labels.should == Set[]
     end
+    it 'will archive if all querires in a multi block hit' do
+      @tagger.archive do
+        multi :me do
+          subj /Test/
+          date '2'
+        end
+      end
+      @mess.labels.should == Set[:me]
+    end
   end
 
   context 'archiving' do
@@ -180,5 +234,68 @@ describe "SupTag" do
       end
       @mess.labels.should == Set[:me]
     end
+    it 'archives if all queries hit' do
+      @tagger.archive do
+        subj /t/, /e/, :hi
+      end
+      @mess.labels.should == Set[:hi]
+    end
+    it 'will not archive if all queries do not hit' do
+      @tagger.archive do
+        subj /t/, /J/, :hi
+      end
+      @mess.labels.should == Set[:inbox]
+    end
+  end
+
+  context 'complex tests' do
+    it 'can properly tag a block with many rules' do
+      @tagger.tag do
+        subj /something/
+        from /BAD/
+        subj /test/i, :bob, :other
+        to /WHO/
+      end
+      @mess.labels.should == Set[:bob, :other]
+    end
+    it 'can properly tag a block with a multi block' do
+      @tagger.tag do
+        subj /something/
+        from /BAD/
+        subj /test/i, :bob, :other
+        to /WHO/
+        multi :ann do
+          subj /test/i
+          from /Sender/i
+        end
+        to /Bob/
+      end
+      @mess.labels.should == Set[:bob, :other, :ann]
+    end
+    it 'can properly archive with a block of many rules' do
+      @mess.add_label(:inbox)
+      @tagger.archive do
+        subj /something/
+        from /BAD/
+        subj /test/i, :bob, :other
+        to /WHO/
+      end
+      @mess.labels.should == Set[:bob, :other]
+    end
+    it 'can properly archive a block with a multiblock rule' do
+      @mess.add_label(:inbox)
+      @tagger.archive do
+        subj /something/
+        from /BAD/
+        subj /test/i, :bob, :other
+        to /WHO/
+        multi :ann do
+          subj /test/i
+          from /Sender/i
+        end
+        to /Bob/
+      end
+      @mess.labels.should == Set[:bob, :other, :ann]
+    end
   end
 end

data/sup_tag.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sup_tag}
-  s.version = "0.1.2"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Blake Sweeney"]
-  s.date = %q{2010-10-19}
+  s.date = %q{2010-11-08}
   s.description = %q{SupTag lets you clean up the before-add-hook script by providing a clean DSL}
   s.email = %q{blakes.85@gmail.com}
   s.extra_rdoc_files = [
@@ -25,11 +25,13 @@ Gem::Specification.new do |s|
      "VERSION",
      "lib/sup_tag.rb",
      "lib/sup_tag/extensions/Object.rb",
+     "lib/sup_tag/extensions/binding.rb",
      "spec/dummy_source.rb",
-     "spec/object_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
-     "spec/sup_tag_spec.rb",
+     "spec/sup_tag/extensions/binding_spec.rb",
+     "spec/sup_tag/extensions/object_spec.rb",
+     "spec/sup_tag/sup_tag_spec.rb",
      "sup_tag.gemspec"
   ]
   s.homepage = %q{http://github.com/blakesweeney/sup_tag}
@@ -39,9 +41,10 @@ Gem::Specification.new do |s|
   s.summary = %q{Make tagging messages in sup pretty}
   s.test_files = [
     "spec/dummy_source.rb",
-     "spec/object_spec.rb",
      "spec/spec_helper.rb",
-     "spec/sup_tag_spec.rb"
+     "spec/sup_tag/extensions/binding_spec.rb",
+     "spec/sup_tag/extensions/object_spec.rb",
+     "spec/sup_tag/sup_tag_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Blake Sweeney
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-19 00:00:00 -04:00
+date: 2010-11-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,11 +74,13 @@ files:
 - VERSION
 - lib/sup_tag.rb
 - lib/sup_tag/extensions/Object.rb
+- lib/sup_tag/extensions/binding.rb
 - spec/dummy_source.rb
-- spec/object_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/sup_tag_spec.rb
+- spec/sup_tag/extensions/binding_spec.rb
+- spec/sup_tag/extensions/object_spec.rb
+- spec/sup_tag/sup_tag_spec.rb
 - sup_tag.gemspec
 has_rdoc: true
 homepage: http://github.com/blakesweeney/sup_tag
@@ -112,6 +114,7 @@ specification_version: 3
 summary: Make tagging messages in sup pretty
 test_files: 
 - spec/dummy_source.rb
-- spec/object_spec.rb
 - spec/spec_helper.rb
-- spec/sup_tag_spec.rb
+- spec/sup_tag/extensions/binding_spec.rb
+- spec/sup_tag/extensions/object_spec.rb
+- spec/sup_tag/sup_tag_spec.rb