gmail-britta 0.1.6 → 0.1.7

data/test/test_gmail-britta.rb

@@ -1,3 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require 'bundler/setup'
 require 'minitest/unit'
 require 'nokogiri'
@@ -6,15 +9,6 @@ require 'minitest/autorun'
 require 'gmail-britta'
 
 describe GmailBritta do
-  def simple_filterset
-    fs = GmailBritta.filterset() do
-      filter {
-        has %w{to:asf@boinkor.net}
-        label 'ohai'
-      }.archive_unless_directed
-    end
-  end
-
   def dom(filterset)
     text = filterset.generate
     #puts text
@@ -29,33 +23,267 @@ describe GmailBritta do
   end
 
   it "runs" do
-    filters = simple_filterset.generate
+    fs = GmailBritta.filterset() do
+      filter {
+          has 'to:asf@boinkor.net'
+          label 'ohai'
+      }
+    end
+    filters = fs.generate
     assert(filters, "Should generate something")
     assert(filters.is_a?(String), "Generated filters should be a string")
   end
 
-  it "generates xml" do
-    filters = dom(simple_filterset)
+  it "generates 'label' properties" do
+    fs = GmailBritta.filterset() do
+      filter {
+          has 'to:asf@boinkor.net'
+          label 'ohai'
+      }
+    end
 
-    assert_equal(2, filters.xpath('/a:feed/a:entry',ns).length, "Should have exactly one filter entry")
-    assert_equal(5, filters.xpath('/a:feed/a:entry/apps:property',ns).length, "Should have two properties")
+    filters = dom(fs)
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@name="label"]',ns).length, "Should have exactly one 'label' property")
+  end
+
+  it "also generates 'smartLabelToApply' properties" do
+    groups = {
+      'forums' => :group,
+      'Forums' => :group,
+      'notifications' => :notification,
+      'Notifications' => :notification,
+      'updates' => :notification,
+      'Updates' => :notification,
+      'promotions' => :promo,
+      'Promotions' => :promo,
+      'social' => :social,
+      'Social' => :social
+    }
+
+    groups.each do |key, value|
+      fs = GmailBritta.filterset() do
+        filter {
+          has 'to:asf@boinkor.net'
+          label 'ohai'
+          smart_label key
+        }
+      end
+
+      filters = dom(fs)
+      assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@name="label"]',ns).length, "Should have exactly one 'label' property")
+
+      smart_labels = filters.xpath('/a:feed/a:entry/apps:property[@name="smartLabelToApply"]',ns)
+      assert_equal(1, smart_labels.length, "Should have exactly one 'smartLabelToApply' property")
+      smart_label_value = smart_labels.first['value']
+      assert_equal("^smartlabel_#{value}", smart_label_value, "Should use the smartlabel_ value")
+    end
+
+    err = assert_raises RuntimeError do
+      fs = GmailBritta.filterset() do
+        filter {
+          has 'to:asf@boinkor.net'
+          label 'ohai'
+          smart_label 'Foobar'
+        }
+      end
+      dom(fs)
+    end
+    assert_equal('invalid category "Foobar"', err.message)
+  end
+
+  it "generates simple 'has' condition xml" do
+    filters = dom(
+      GmailBritta.filterset() do
+        filter {
+          has %w{to:asf@boinkor.net}
+          label 'ohai'
+          archive
+        }
+      end
+    )
+
+    assert_equal(1, filters.xpath('/a:feed/a:entry',ns).length, "Should have exactly one filter entry")
+    assert_equal(3, filters.xpath('/a:feed/a:entry/apps:property',ns).length, "Should have two properties")
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@name="label"]',ns).length, "Should have exactly one 'label' property")
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@name="shouldArchive"]',ns).length, "Should have exactly one 'shouldArchive' property")
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@name="hasTheWord"]',ns).length, "Should have exactly one 'has' property")
+  end
+
+  it "generates simple 'has_not' condition xml" do
+    filters = dom(
+      GmailBritta.filterset() do
+        filter {
+          has_not %w{to:asf@boinkor.net}
+          label 'ohai'
+          archive
+        }
+      end
+    )
+
+    assert_equal(1, filters.xpath('/a:feed/a:entry',ns).length, "Should have exactly one filter entry")
+    assert_equal(3, filters.xpath('/a:feed/a:entry/apps:property',ns).length, "Should have two properties")
     assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@name="label"]',ns).length, "Should have exactly one 'label' property")
     assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@name="shouldArchive"]',ns).length, "Should have exactly one 'shouldArchive' property")
-    assert_equal(2, filters.xpath('/a:feed/a:entry/apps:property[@name="hasTheWord"]',ns).length, "Should have exactly one 'has' property")
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@name="doesNotHaveTheWord"]',ns).length, "Should have exactly one 'has_not' property")
   end
 
-  describe "issues" do
-    it "doesn't fail issue #4 - correctly-parenthesised nested ANDs" do
+  it "generates simple 'from' condition xml" do
+    filters = dom(
+      GmailBritta.filterset() do
+        filter {
+          from %w{asf@boinkor.net}
+          label 'ohai'
+        }
+      end
+    )
+
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@name="from"]',ns).length, "Should have exactly one 'from' property")
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@value="asf@boinkor.net"]',ns).length, "Should have exactly one 'from' value")
+  end
+
+  it "generates an error for multiple accessors" do
+    err = assert_raises RuntimeError do
+      GmailBritta.filterset() do
+        filter {
+          from %w{asf@boinkor.net}
+          from %w{asf@boinkor.net}
+          label 'ohai'
+        }
+      end
+    end
+    assert_equal('Only one use of from is permitted per filter', err.message)
+  end
+
+  it "generates an error for multiple boolean accessors" do
+    err = assert_raises RuntimeError do
+      GmailBritta.filterset() do
+        filter {
+          from %w{asf@boinkor.net}
+          archive
+          archive
+        }
+      end
+    end
+    assert_equal('Only one use of archive is permitted per filter', err.message)
+  end
+
+  it "generates multiple 'from' condition xml" do
+    filters = dom(
+      GmailBritta.filterset() do
+        filter {
+          from ['asf@boinkor.net', 'abc@boinkor.net']
+          label 'ohai'
+        }
+      end
+    )
+
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@name="from"]',ns).length, "Should have exactly one 'from' property")
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@value="asf@boinkor.net abc@boinkor.net"]',ns).length, "Should have both addresses in 'from' property")
+  end
+
+  it "uses .otherwise for single 'from' condition" do
+    filters = dom(
+      GmailBritta.filterset() do
+        filter {
+          from %w{asf@boinkor.net}
+          label 'ohai'
+        }.otherwise {
+          label 'bai'
+        }
+      end
+    )
+
+    assert_equal(2, filters.xpath('/a:feed/a:entry/apps:property[@name="from"]',ns).length, "Should have two 'from' properties")
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@value="asf@boinkor.net"]',ns).length, "Should have the address positively exactly once")
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@value="-asf@boinkor.net"]',ns).length, "Should have the address negatively exactly once")
+  end
+
+  it "uses .also for single 'to' condition" do
+    filters = dom(
+      GmailBritta.filterset() do
+        filter {
+          from %w{from@boinkor.net}
+          label 'ohai'
+        }.also {
+          to %w{to@boinkor.net}
+        }
+      end
+    )
+
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@name="from"][@value="from@boinkor.net"]',ns).length, "Should have the from address")
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@name="to"][@value="to@boinkor.net"]',ns).length, "Should have the to address")
+  end
+
+  it "understands me" do
+    fs = GmailBritta.filterset(:me => ['thisisme@my-private.org', 'this-is-me@bigco.example.com']) do
+      filter {
+        to_me = me.map {|address| "to:#{address}"}
+        has [{:or => to_me}]
+      }
+    end
+    filters = dom(fs)
+
+    filter_text = filters.xpath('/a:feed/a:entry/apps:property[@name="hasTheWord"]',ns).first['value']
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@name="hasTheWord"]',ns).length, "Should have exactly one 'has' property")
+    assert_equal('(to:thisisme@my-private.org OR to:this-is-me@bigco.example.com)', filter_text, "Should have exactly one 'has' property")
+  end
+
+  it "doesn't fail issue #4 - correctly-parenthesised nested ANDs" do
+    fs = GmailBritta.filterset do
+      filter {
+        has :or => [['subject:whee', 'from:zot@spammer.com'], 'from:bob@bob.com', 'from:foo@foo.com']
+        label 'yay'
+      }
+    end
+    filters = dom(fs)
+
+    filter_text = filters.xpath('/a:feed/a:entry/apps:property[@name="hasTheWord"]',ns).first['value']
+    assert_equal('(subject:whee from:zot@spammer.com) OR from:bob@bob.com OR from:foo@foo.com', filter_text)
+  end
+
+  it "uses .otherwise for multiple 'from' condition" do
+    filters = dom(
+      GmailBritta.filterset() do
+        filter {
+          from ['asf@boinkor.net', 'abc@boinkor.net']
+          label 'ohai'
+        }.otherwise {
+          label 'bai'
+        }
+      end
+    )
+
+    assert_equal(2, filters.xpath('/a:feed/a:entry/apps:property[@name="from"]',ns).length, "Should have two 'from' properties")
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@value="asf@boinkor.net abc@boinkor.net"]',ns).length, "Should have both addresses positively in one 'from' property")
+    assert_equal(1, filters.xpath('/a:feed/a:entry/apps:property[@value="-asf@boinkor.net -abc@boinkor.net"]',ns).length, "Should have both addresses negated in one 'from' property")
+  end
+
+  describe "subject" do
+    it "works with single subject" do
       fs = GmailBritta.filterset do
         filter {
-          has :or => [['subject:whee', 'from:zot@spammer.com'], 'from:bob@bob.com', 'from:foo@foo.com']
-          label 'yay'
+          subject 'SPAM: '
+          label 'important'
         }
       end
+
+      filters = dom(fs)
+
+      filter_text = filters.xpath('//apps:property[@name="subject"]', ns).first['value']
+      assert_equal('SPAM: ', filter_text)
+    end
+
+    it "works with hash of subjects" do
+      fs = GmailBritta.filterset do
+        filter {
+          subject :or => ['SPAM', 'HAM']
+        }
+      end
+
       filters = dom(fs)
 
-      filter_text = filters.xpath('/a:feed/a:entry/apps:property[@name="hasTheWord"]',ns).first['value']
-      assert_equal('(subject:whee from:zot@spammer.com) OR from:bob@bob.com OR from:foo@foo.com', filter_text)
+      filter_text = filters.xpath('//apps:property[@name="subject"]', ns).first['value']
+      assert_equal('SPAM OR HAM', filter_text)
     end
   end
 end

metadata

@@ -1,110 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: gmail-britta
 version: !ruby/object:Gem::Version
-  version: 0.1.6
-  prerelease: 
+  version: 0.1.7
 platform: ruby
 authors:
 - Andreas Fuchs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-26 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: This gem helps create large (>50) gmail filter chains by writing xml
@@ -116,14 +103,15 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .document
-- .travis.yml
-- .yardopts
+- ".document"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- THANKS.md
 - TODO.org
 - VERSION
 - examples/Gemfile
@@ -132,6 +120,7 @@ files:
 - examples/asf.rb
 - gmail-britta.gemspec
 - lib/gmail-britta.rb
+- lib/gmail-britta/chaining_filter.rb
 - lib/gmail-britta/filter.rb
 - lib/gmail-britta/filter_set.rb
 - lib/gmail-britta/single_write_accessors.rb
@@ -139,29 +128,25 @@ files:
 homepage: http://github.com/antifuchs/gmail-britta
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4216942302698371957
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Create complex gmail filtersets with a ruby DSL.
 test_files: []