gmail-britta 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,35 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    git (1.2.5)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rcov (1.0.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.1.1)
+      shoulda-context (~> 1.0)
+      shoulda-matchers (~> 1.2)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.3.0)
+      activesupport (>= 3.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.0)
+  jeweler (~> 1.8.4)
+  rcov
+  rdoc (~> 3.12)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Andreas Fuchs
+
+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.rdoc

@@ -0,0 +1,20 @@
+= gmail-britta
+
+This gem assists in writing complex gmail filters. You probably have a
+lot of questions, and I'm sorry this README currently answers so few
+of them )-:
+
+== Contributing to gmail-britta
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Andreas Fuchs. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "gmail-britta"
+  gem.homepage = "http://github.com/antifuchs/gmail-britta"
+  gem.license = "MIT"
+  gem.summary = %Q{Create complex gmail filtersets with a ruby DSL.}
+  gem.description = %Q{This gem helps create large (>50) gmail filter chains by writing xml compatible with gmail's "import/export filters" feature.} #'
+  gem.email = "asf@boinkor.net"
+  gem.authors = ["Andreas Fuchs"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gmail-britta #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/gmail-britta.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "gmail-britta"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andreas Fuchs"]
+  s.date = "2012-09-10"
+  s.description = "This gem helps create large (>50) gmail filter chains by writing xml compatible with gmail's \"import/export filters\" feature."
+  s.email = "asf@boinkor.net"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "gmail-britta.gemspec",
+    "lib/gmail-britta.rb"
+  ]
+  s.homepage = "http://github.com/antifuchs/gmail-britta"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Create complex gmail filtersets with a ruby DSL."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/gmail-britta.rb

@@ -0,0 +1,262 @@
+#!/usr/bin/env ruby
+
+# Google mail exclusive filter generator
+# Docs: http://groups.google.com/group/gmail-labs-help-filter-import-export/browse_thread/thread/518a7b1634f20cdb#
+#       http://code.google.com/googleapps/domain/email_settings/developers_guide_protocol.html#GA_email_filter_main
+
+require 'rubygems'
+require 'time'
+gem 'haml'
+require 'haml'
+require 'logger'
+
+$log = Logger.new(STDERR)
+$log.level = Logger::DEBUG
+
+module SingleWriteAccessors
+  module ClassMethods
+    def ivar_name(name)
+      "@#{name}".intern
+    end
+
+    def single_write_accessors
+      @single_write_accessors ||= {}
+    end
+
+    def single_write_accessor(name, gmail_name, &block)
+      single_write_accessors[name] = gmail_name
+      ivar_name = self.ivar_name(name)
+      define_method(name) do |words|
+        if instance_variable_get(ivar_name)
+          raise "Only one use of #{name} is permitted per filter"
+        end
+        instance_variable_set(ivar_name, words)
+      end
+      define_method("get_#{name}") do
+        instance_variable_get(ivar_name)
+      end
+      if block_given?
+        define_method("output_#{name}") do
+          instance_variable_get(ivar_name) && block.call(instance_variable_get(ivar_name))
+        end
+      else
+        define_method("output_#{name}") do
+          instance_variable_get(ivar_name)
+        end
+      end
+    end
+
+    def single_write_boolean_accessor(name, gmail_name)
+      single_write_accessors[name] = gmail_name
+      ivar_name = self.ivar_name(name)
+      define_method(name) do |*args|
+        value = args.length > 0 ? args[0] : true
+        if instance_variable_get(ivar_name)
+          raise "Only one use of #{name} is permitted per filter"
+        end
+        instance_variable_set(ivar_name, value)
+      end
+      define_method("get_#{name}") do
+        instance_variable_get(ivar_name)
+      end
+      define_method("output_#{name}") do
+        instance_variable_get(ivar_name)
+      end
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+end
+
+class GmailBritta
+  def initialize(opts={})
+    @filters = []
+    @me = opts[:me] || 'me'
+  end
+
+  attr_accessor :filters
+  attr_accessor :me
+
+  def self.filterset(opts={}, &block)
+    (britta = GmailBritta.new(opts)).rules(&block)
+    britta
+  end
+
+  def rules(&block)
+    Delegate.new(self).perform(&block)
+  end
+
+  class Delegate
+    def initialize(britta)
+      @britta = britta
+      @filter = nil
+    end
+
+    def filter(&block)
+      Filter.new(@britta).perform(&block)
+    end
+
+    def perform(&block)
+      instance_eval(&block)
+    end
+  end
+
+  class Filter
+    include SingleWriteAccessors
+    single_write_accessor :has, 'hasTheWord' do |list|
+      emit_filter_spec(list)
+    end
+    single_write_accessor :has_not, 'doesNotHaveTheWord' do |list|
+      emit_filter_spec(list)
+    end
+    single_write_boolean_accessor :archive, 'shouldArchive'
+    single_write_boolean_accessor :delete_it, 'shouldTrash'
+    single_write_boolean_accessor :mark_read, 'shouldMarkAsRead'
+    single_write_boolean_accessor :mark_important, 'shouldAlwaysMarkAsImportant'
+    single_write_boolean_accessor :mark_unimportant, 'shouldNeverMarkAsImportant'
+    single_write_boolean_accessor :star, 'shouldStar'
+    single_write_boolean_accessor :never_spam, 'shouldNeverSpam'
+    single_write_accessor :label, 'label'
+    single_write_accessor :forward_to, 'forwardTo'
+
+    def generate_xml
+      engine = Haml::Engine.new(<<-ATOM)
+%entry
+  %category{:term => 'filter'}
+  %title Mail Filter
+  %content
+  - self.class.single_write_accessors.keys.each do |name|
+    - gmail_name = self.class.single_write_accessors[name]
+    - if value = self.send("output_\#{name}".intern)
+      %apps:property{:name => gmail_name, :value => value.to_s}
+ATOM
+      engine.render(self)
+    end
+
+    def self.emit_filter_spec(filter, infix=' ')
+      str = ''
+      case filter
+      when String
+        str << filter
+      when Hash
+        filter.keys.each do |key|
+          case key
+          when :or
+              str << '('
+            str << emit_filter_spec(filter[key], ' OR ')
+            str << ')'
+          when :not
+              str << '-('
+            str << emit_filter_spec(filter[key], ' ')
+            str << ')'
+          end
+        end
+      when Array
+        str << filter.map {|elt| emit_filter_spec(elt, ' ')}.join(infix)
+      end
+      $log.debug " Filter spec #{filter.inspect} + #{infix.inspect} => #{str.inspect}"
+      str
+    end
+
+    def me
+      @britta.me
+    end
+
+    def initialize(britta)
+      @britta=britta
+    end
+
+    def log_definition
+      $log.debug  "Filter: #{self}"
+      Filter.single_write_accessors.each do |name|
+        val = instance_variable_get(Filter.ivar_name(name))
+        $log.debug "  #{name}: #{val}" if val
+      end
+      self
+    end
+
+    def perform(&block)
+      instance_eval(&block)
+      @britta.filters << self
+      self
+    end
+
+    def merge_negated_criteria(filter)
+      old_has_not = Marshal.load(Marshal.dump((filter.get_has_not || []).reject { |elt|
+            @has.member?(elt)
+          }))
+      old_has = Marshal.load( Marshal.dump((filter.get_has || []).reject { |elt|
+            @has.member?(elt)
+          }))
+      $log.debug("  M: oh  #{old_has.inspect}")
+      $log.debug("  M: ohn #{old_has_not.inspect}")
+
+      @has_not ||= []
+      @has_not += case
+                  when old_has_not.first.is_a?(Hash) && old_has_not.first[:or]
+                    old_has_not.first[:or] += old_has
+                    old_has_not
+                  when old_has_not.length > 0
+                    [{:or => old_has_not + old_has}]
+                  else
+                    old_has
+                  end
+      $log.debug("  M: h #{@has.inspect}")
+      $log.debug("  M: nhn #{@has_not.inspect}")
+    end
+
+    def otherwise(&block)
+      filter = Filter.new(@britta).perform(&block)
+      filter.merge_negated_criteria(self)
+      filter.log_definition
+      filter
+    end
+
+    def merge_positive_criteria(filter)
+      new_has = (@has || []) + (filter.get_has || [])
+      new_has_not = (@has_not || []) + (filter.get_has_not || [])
+      @has = new_has
+      @has_not = new_has_not
+    end
+
+    def also(&block)
+      filter = Filter.new(@britta).perform(&block)
+      filter.merge_positive_criteria(self)
+      filter.log_definition
+      filter
+    end
+
+    def archive_unless_directed(options={})
+      mark_as_read=options[:mark_read]
+      tos=(options[:to] || me).to_a
+      filter = Filter.new(@britta).perform do
+        has_not [{:or => tos.map {|to| "to:#{to}"}}]
+        archive
+        if mark_as_read
+          mark_read
+        end
+      end
+      filter.merge_positive_criteria(self)
+      filter.log_definition
+      self
+    end
+  end
+
+  def generate
+    engine = Haml::Engine.new(<<-ATOM)
+!!! XML
+%feed{:xmlns => 'http://www.w3.org/2005/Atom', 'xmlns:apps' => 'http://schemas.google.com/apps/2006'}
+  %title Mail Filters
+  %id tag:mail.google.com,2008:filters:
+  %updated #{Time.now.utc.iso8601}
+  %author
+    %name Andreas Fuchs
+    %email asf@boinkor.net
+  - filters.each do |filter|
+    != filter.generate_xml
+ATOM
+    engine.render(self)
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification 
+name: gmail-britta
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andreas Fuchs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: shoulda
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  version_requirements: *id002
+  name: rdoc
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  version_requirements: *id003
+  name: bundler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 1
+        - 8
+        - 4
+        version: 1.8.4
+  version_requirements: *id004
+  name: jeweler
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
+  name: rcov
+  prerelease: false
+  type: :development
+description: This gem helps create large (>50) gmail filter chains by writing xml compatible with gmail's "import/export filters" feature.
+email: asf@boinkor.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- gmail-britta.gemspec
+- lib/gmail-britta.rb
+homepage: http://github.com/antifuchs/gmail-britta
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Create complex gmail filtersets with a ruby DSL.
+test_files: []
+