imap.rb 0.4.9 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b062efdc696b59573e564f135485c3e987a8a8078b36e87783537cbcd040712a
-  data.tar.gz: 150f927c8023ed6cbbb1b58fa5b863620ba2043ec71058c52f36a75c817e9e0a
+  metadata.gz: 8be67e0de4db977ee6ba474e7355fadae929bd267132fd867d64f96caa3c7a19
+  data.tar.gz: e930fe80e9f8cffac1837670688e22f8826ce50391a36b5f5cc8474f0c89e9fb
 SHA512:
-  metadata.gz: c979d4b09d86154e500454440396443d9db9ee8134603ea5d432ed093e46bc3a54fa33aaa24667302dc540566e8863c6d50c22c112c87ee91a1b224c7a4d567c
-  data.tar.gz: 4e91af7317d63811a9ec9dff17ff14130926bf101d4631e6fbfa5069501c12e90b1af0fa28efa315a6a1dc52b823b012e89f14e6d7dbdec3b8b7fe1fa44e3bff
+  metadata.gz: 3b8f36bc1285a4f379624038e387cd70e825c07b617f07a60ebd5ba11ee62a775126eb1a0263107739bea073b44b2d2cc86c4c3f05a5533eb8ea848f5f11b0f0
+  data.tar.gz: 36f1969380582aef53570369140fdffddd920fabc04a157faca0accd49f38286f8563934b3db3c049e0769074d355339cc234ccfe65fa63f53d8a61eebc096fa

data/CHANGELOG

@@ -2,6 +2,16 @@
 
 ## 20260917
 
+0.5.0: + OR and NOT to the criteria, and HEADER given its field
+
+1. + Imap::Search#any_of: or: [{from: 'a@x'}, {to: 'b@y'}]. OR takes two keys and no more, so three or more nest, OR OR a b c, as the server reads them. Each side is a criteria hash of its own and may nest further.
+2. + Imap::Search#none_of: not: {subject: 'Payday'}. NOT takes one key, so several are negated apiece, NOT a NOT b.
+3. ~ Imap::Search#to_imap_search_keys: OR and NOT read before the operator tests, being neither general nor boolean.
+4. HEADER wanted no change: an array value already flattens to ['HEADER', field, value], which nothing said and nothing tested. It is tested now.
+5. + tests for each, and for OR mixed with the plain keys.
+6. ~ Imap::VERSION: /0.4.9/0.5.0/
+
+
 0.4.9: + imap.rb.gemspec, so that the gem resolves under both names.
 
 1. + imap.rb.gemspec: the same code published as imap.rb, which is how gems are named here: 21 carry the suffix and imap is one of the few which do not. rubygems has no notion of an alias, so the two are separate gems which must be kept at the same version by hand.

data/lib/Imap/Search.rb

@@ -123,6 +123,10 @@ class Imap
       criteria.inject([]) do |m, kv|
         key, value = kv.first.to_s.upcase, kv.last
         case
+        when key == 'OR'
+          m << any_of(value)
+        when key == 'NOT'
+          m << none_of(value)
         when general_operator?(key)
           m << general_to_imap_search_key(key, value)
         when boolean_operator?(key)
@@ -133,6 +137,17 @@ class Imap
       end.flatten
     end
 
+    # OR takes two keys and no more, so three criteria nest: OR OR a b c.  Each
+    # is a criteria hash of its own, so either side may nest further.
+    def any_of(criteria_hashes)
+      criteria_hashes.collect{|criteria_hash| Search.new(nil, criteria_hash).to_imap_search_keys}.inject{|m, keys| ['OR'] + m + keys}
+    end
+
+    # NOT takes one key, so each criterion is negated on its own: NOT a NOT b.
+    def none_of(criteria_hash)
+      criteria_hash.inject([]){|m, kv| m + ['NOT'] + Search.new(nil, Hash[*kv]).to_imap_search_keys}
+    end
+
     def general_to_imap_search_key(key, value)
       value.is_a?(Negated) ? ['NOT', key, value.value] : [key, value]
     end

data/lib/Imap/VERSION.rb

@@ -1,3 +1,3 @@
 class Imap
-  VERSION = '0.4.9'
+  VERSION = '0.5.0'
 end

data/test/Imap/Search_test.rb

@@ -44,6 +44,34 @@ describe Imap::Search do
     end
   end
 
+  describe 'OR, NOT and HEADER' do
+    def keys(criteria) = Imap::Search.new(client, criteria).to_imap_search_keys
+
+    it 'takes two criteria hashes for OR' do
+      _(keys(or: [{from: 'a@x'}, {to: 'b@y'}])).must_equal ['OR', 'FROM', 'a@x', 'TO', 'b@y']
+    end
+
+    it 'nests OR where there are more than two, it taking only two' do
+      _(keys(or: [{from: 'a@x'}, {to: 'b@y'}, {cc: 'c@z'}])).must_equal ['OR', 'OR', 'FROM', 'a@x', 'TO', 'b@y', 'CC', 'c@z']
+    end
+
+    it 'negates a criterion for NOT' do
+      _(keys(not: {subject: 'Payday'})).must_equal ['NOT', 'SUBJECT', 'Payday']
+    end
+
+    it 'negates each on its own where NOT carries more than one, it taking only one' do
+      _(keys(not: {subject: 'Payday', seen: true})).must_equal ['NOT', 'SUBJECT', 'Payday', 'NOT', 'SEEN']
+    end
+
+    it 'takes a field and a value for HEADER' do
+      _(keys(header: ['List-Id', 'announce'])).must_equal ['HEADER', 'List-Id', 'announce']
+    end
+
+    it 'mixes with the plain keys' do
+      _(keys(since: '1-Sep-2026', or: [{from: 'a@x'}, {to: 'b@y'}])).must_equal ['SINCE', '1-Sep-2026', 'OR', 'FROM', 'a@x', 'TO', 'b@y']
+    end
+  end
+
   describe 'the chaining interface' do
     it 'names the keys in lower case' do
       _(Imap::Search.new(client).from('x@y.com').criteria).must_equal({FROM: 'x@y.com'})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imap.rb
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.0
 platform: ruby
 authors:
 - thoran