sup_tag 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.rvmrc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Blake Sweeney
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,52 @@
+Sup Tag
+========
+
+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.
+
+Example
+-------
+
+My before-add-message.rb looks like:
+
+    require 'sup_tag'
+    require 'sup_tag/extensions/object'
+
+    # Tag messages
+    tag do
+        from /jnls.cust.serv@oxfordjournals.org/i, :oxford
+        from /some_email/i, :tag1, :tag2
+    end
+
+    # Archive messages
+    archive do
+        subj /sup-talk/i # Tag messages with sup-talk in subject as sup-talk
+    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.
+
+
+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
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a 
+  commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+=========
+
+Copyright (c) 2010 Blake Sweeney. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sup_tag"
+    gem.summary = %Q{Make tagging messages in sup pretty}
+    gem.description = %Q{SupTag lets you clean up the before-add-hook script by providing a clean DSL}
+    gem.email = "blakes.85@gmail.com"
+    gem.homepage = "http://github.com/blakesweeney/sup_tag"
+    gem.authors = ["Blake Sweeney"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "sup", ">= 0.11"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/lib/sup_tag/extensions/Object.rb

@@ -0,0 +1,30 @@
+# Modify Object to support tag and archive methods.
+
+class Object
+
+  # Tag messages using the given block.
+  #
+  # @param [Block] block Block to tag with.
+  # @return [Set] The Set of tags on the message.
+  def tag(&block)
+    tagger = get_tagger(&block)
+    tagger.tag(&block)
+  end
+
+  # Archive messages using the given block.
+  #
+  # @param [Block] A block to use to tag.
+  # @return [Set] The Set of tags on the message.
+  def archive(&block)
+    tagger = get_tagger(&block)
+    tagger.archive(&block)
+  end
+
+  # Get the SupTag object for the given block.
+  #
+  # @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)
+  end
+end

data/lib/sup_tag.rb

@@ -0,0 +1,74 @@
+# Class to make tagging simple.
+class SupTag
+
+  # Create a new SupTag.
+  #
+  # @param [Redwood::Message] message A Message to tag.
+  def initialize(message)
+    @message = message
+  end
+
+  # Remove the given tags from the message.
+  #
+  # @param [Symbol, Array] tags Tags to remove.
+  # @return [Array] The tags on the message.
+  def remove(tags)
+    Array(tags).each { |t| @message.remove_label(t) }
+    return @message.labels
+  end
+
+  # Archive a message. This adds the matching tags and removes the
+  # inbox tag.
+  #
+  # @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
+    return @message.labels
+  end
+
+  # Tag a message.
+  #
+  # @param [Block] Block for adding tags.
+  # @return [Array] The tags on the message.
+  def tag(&block)
+    cloaker(&block).bind(self).call
+    @message.labels
+  end
+
+  # Instance eval for blocks stolen from Trollop. Orignally from:
+  # http://redhanded.hobix.com/inspect/aBlockCostume.html, which now
+  # seems to be down.
+  #
+  # @param [Block] b A block to bind.
+  # @return [Block] The given block bound so it will eval in this
+  # instance context.
+  def cloaker(&b)
+    (class << self; self; end).class_eval do
+      define_method :cloaker_, &b
+      meth = instance_method :cloaker_
+      remove_method :cloaker_
+      meth
+    end
+  end
+
+  def respond_to?(method, include_private = false)
+    return @message.respond_to?(method) || super
+  end
+
+  def method_missing(method, *args)
+    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) }
+    end
+  end
+end

data/spec/dummy_source.rb

@@ -0,0 +1,55 @@
+require "sup"
+require 'stringio'
+require 'rmail'
+require 'uri'
+require 'set'
+
+module Redwood
+  class DummySource < Source
+
+    attr_accessor :messages
+
+    def initialize uri, last_date=nil, usual=true, archived=false, id=nil, labels=[]
+      super uri, last_date, usual, archived, id
+      @messages = nil
+    end
+
+    def start_offset
+      0
+    end
+
+    def end_offset
+      # should contain the number of test messages -1
+      return @messages ? @messages.length - 1 : 0
+    end
+
+    def load_header offset
+      Source.parse_raw_email_header StringIO.new(raw_header(offset))
+    end
+    
+    def load_message offset
+      RMail::Parser.read raw_message(offset)
+    end
+    
+    def raw_header offset
+      ret = ""
+      f = StringIO.new(@messages[offset])
+      until f.eof? || (l = f.gets) =~ /^$/
+        ret += l
+      end
+      ret
+    end
+    
+    def raw_message offset
+      @messages[offset]
+    end
+    
+    def each_raw_message_line offset
+      ret = ""
+      f = StringIO.new(@messages[offset])
+      until f.eof?
+        yield f.gets
+      end
+    end
+  end
+end

data/spec/object_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'sup_tag/extensions/object'
+
+describe 'Object' do
+  before do
+    def message
+      get_short_message
+    end
+  end
+  context 'tagger' do
+    it 'can make the tagger' do
+      (get_tagger { 'a' }).should_not be_nil
+    end
+  end
+
+  context 'tagging' do
+    it 'can tag a message' do
+      tags = tag do
+        subj /test/i
+      end
+      tags.should == Set[:test]
+    end
+    it 'can archive messages' do
+      def message
+        m = get_short_message
+        m.add_label(:inbox)
+        return m
+      end
+      tags = archive do
+        subj /test/i, :bob
+      end
+      tags.should == Set[:bob]
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format nested

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'sup_tag'
+require "rubygems"
+require "sup"
+require 'spec'
+require 'spec/autorun'
+require 'stringio'
+require 'rmail'
+require 'uri'
+require 'set'
+require 'dummy_source'
+
+SHORT_STR =<<-EOM
+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>
+CC: Fake Person <fake_person@someplace>
+BCC: Important Person <person@important>
+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!
+EOM
+
+# Simple method to get a short message
+def get_short_message
+  source = Redwood::DummySource.new("sup-test://test_simple_message")
+  source.messages = [ SHORT_STR ]
+  source_info = 0
+  mess = Redwood::Message.new( {:source => source, :source_info => source_info } )
+  mess.load_from_source!
+  return mess
+end

data/spec/sup_tag_spec.rb

@@ -0,0 +1,184 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "SupTag" do
+  context 'respond_to' do
+    it 'responds to taggable methods' do
+      [ :from, :subj, :to, :replyto ].each do |meth|
+        SupTag.new(get_short_message).respond_to?(meth).should be_true
+      end
+    end
+  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)
+        @tagger.remove(:t)
+        @mess.labels.to_a.should == []
+      end
+      it 'can remove many tags' do
+        @mess.add_label(:t)
+        @mess.add_label(:t2)
+        @tagger.remove([:t, :t2])
+        @mess.labels.to_a.should == []
+      end
+    end
+
+    context 'tagging methods' do
+      it 'can tag using from name' do
+        @tagger.tag do
+          from /Fake Sender/i, :test
+        end
+        @mess.labels.to_a.should == [ :test ]
+      end
+      it 'can tag using from email' do
+        @tagger.tag do
+          from /example.invalid/i, :test
+        end
+        @mess.labels.to_a.should == [ :test ]
+      end
+      it 'can tag using to' do
+        @tagger.tag do
+          to /Fake/i, :test
+        end
+        @mess.labels.to_a.should == [ :test ]
+      end
+      it 'can tag using to email' do
+        @tagger.tag do
+          to /@localhost/, :test
+        end
+        @mess.labels.to_a.should == [ :test ]
+      end
+      it 'can tag using subj' do
+        @tagger.tag do
+          subj /Test/, :test
+        end
+        @mess.labels.to_a.should == [ :test ]
+      end
+      it 'can tag using cc' do
+        @tagger.tag do
+          cc /@someplace/, :test
+        end
+        @mess.labels.to_a.should == [ :test ]
+      end
+      it 'can tag using bcc' do
+        @tagger.tag do
+          bcc /@important/, :test
+        end
+        @mess.labels.to_a.should == [ :test ]
+      end
+      it 'can tag using recipients' do
+        @tagger.tag do
+          recipients /@important/, :test
+        end
+        @mess.labels.to_a.should == [ :test ]
+      end
+      it 'can tag using date' do
+        @tagger.tag do
+          date /2007/, :old
+        end
+        @mess.labels.should == Set[:old]
+      end
+    end
+
+    context 'adding tags' do
+      it 'can tag using a regexp' do
+        @tagger.tag do
+          subj /Test/, :test
+        end
+        @mess.labels.to_a.should == [ :test ]
+      end
+      it 'can tag using a string' do
+        @tagger.tag do
+          subj 'Test', :test
+        end
+        @mess.labels.to_a.should == [ :test ]
+      end
+      it 'can tag if the method returns an array' do
+        @tagger.tag do
+          to 'Fake', :test
+        end
+        @mess.labels.should == Set[:test]
+      end
+      it 'does not remove any tags' do
+        @mess.add_label :a
+        @mess.add_label :c
+        @tagger.tag do
+          subj 'Test', :test
+        end
+        @mess.labels.should == Set[ :a, :c, :test ]
+      end
+      it 'uses all tags given' do
+        @tagger.tag do
+          subj 'Test', :test, :a, :c
+        end
+        @mess.labels.should == Set[ :a, :c, :test ]
+      end
+      it 'will set the tag to the given downcased string if no tag given' do
+        @tagger.tag do
+          subj 'Test'
+        end
+        @mess.labels.should == Set[ :test ]
+      end
+      it 'will set the tag to the given regexp source if no tag given' do
+        @tagger.tag do
+          subj /Test/i
+        end
+        @mess.labels.should == Set[ :test ]
+      end
+      it 'will not add a nil tag' do
+        @tagger.tag do
+          subj /Test/i, nil
+        end
+        @mess.labels.should == Set[ ]
+      end
+    end
+    it 'does not tag if there is no match' do
+      @tagger.archive do
+        subj /AWESOME/, :me
+      end
+      @mess.labels.should == Set[]
+    end
+  end
+
+  context 'archiving' do
+    before do
+      @mess = get_short_message
+      @mess.add_label(:inbox)
+      @tagger = SupTag.new(@mess)
+    end
+    it 'will add a given tag' do
+      @tagger.archive do
+        subj /Test/i, :test
+      end
+      @mess.labels.should == Set[:test]
+    end
+    it 'removes the inbox tag' do
+      @tagger.archive do
+        subj /Test/i, nil
+      end
+      @mess.labels.should == Set[]
+    end
+    it 'does not remove the inbox tag if there is no match' do
+      @tagger.archive do
+        subj /AWESOME/, :me
+        to /other/, :bob
+        from /you/, :joe
+      end
+      @mess.labels.should == Set[:inbox]
+    end
+    it 'removes the inbox tag if any of the rules match' do
+      @tagger.archive do
+        subj /AWESOME/, :me
+        subj /test/i, :me
+        to /people/, :people
+      end
+      @mess.labels.should == Set[:me]
+    end
+  end
+end

data/sup_tag.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sup_tag}
+  s.version = "0.1.2"
+
+  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.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 = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/sup_tag.rb",
+     "lib/sup_tag/extensions/Object.rb",
+     "spec/dummy_source.rb",
+     "spec/object_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/sup_tag_spec.rb",
+     "sup_tag.gemspec"
+  ]
+  s.homepage = %q{http://github.com/blakesweeney/sup_tag}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  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"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<sup>, [">= 0.11"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<sup>, [">= 0.11"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<sup>, [">= 0.11"])
+  end
+end
+

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: sup_tag
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Blake Sweeney
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-19 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sup
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 11
+        version: "0.11"
+  type: :development
+  version_requirements: *id003
+description: SupTag lets you clean up the before-add-hook script by providing a clean DSL
+email: blakes.85@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/sup_tag.rb
+- lib/sup_tag/extensions/Object.rb
+- spec/dummy_source.rb
+- spec/object_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/sup_tag_spec.rb
+- sup_tag.gemspec
+has_rdoc: true
+homepage: http://github.com/blakesweeney/sup_tag
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+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