imap.rb 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9f5b0c607f3b3e66d7284613916d45c077de9a0e97f50f960fa8e63fd7b5586
-  data.tar.gz: 4529940cbd85a56bfbd4ef9d472536234852cd4cabf6349f90763644905ab953
+  metadata.gz: 45cf03dcb336e9795a5ef5339e6ac0c6e3b2f5e79014f3462684f39f79aae98f
+  data.tar.gz: e204d83b456b966f0f9a9c3a55acfb492564da65a2b2be22d8c27326104ba755
 SHA512:
-  metadata.gz: 7279ae1bb4fd2456fa2acf57cad565a0af28d2be5795e1e6bf9924b2b9f6583acf2e4a71735944c8bf3f3dc56d403d3abba5943eb87ea15054f12c718665bab9
-  data.tar.gz: 060c6a1b974e983979130cf62d03e0630ef548b64b9e80a522c6064c031126385de84f762cb1a158fd50b03711902f1430038b8aa0b3f63864c7dc4e85366548
+  metadata.gz: 20938befdd15cc9da7f5679b0043facbdbc0d3a69b04f93a0100c43b4314b6832ecfed375484d1429221ee60703dfc94ac3abdd1f4ff40060ed528828187fcf4
+  data.tar.gz: e467e3aed0b2b09cc86e175a1b3f940e37922232e4efb97998c5dc7a959b5a3f9b8f012bb1a8ff6505d7dff83f488e418c5e7d8670fe5b4db7333991ff683d77

data/CHANGELOG

@@ -2,6 +2,13 @@
 
 ## 20260917
 
+0.8.0: + Imap::Message.for, the fetch without the search, and a class a program can subclass.
+
+1. + Imap::Message.for(imap_client, message_ids): the batched fetch on its own, .search now being the search and then this. A program which builds its own search keys had no way in: .search couples the two, so search-mail had 159 lines of its own Hit reimplementing the fetch beside it.
+2. ~ Imap::Message.for: builds with new rather than Imap::Message.new, so that a subclass is handed back its own kind. A program which wants a message of its own, with a mailbox or a decoded body upon it, subclasses rather than starts again.
+3. + 4 tests: that .for builds for ids searched elsewhere, that it fetches once, that it is empty where nothing was found, and that a subclass gets itself back.
+4. ~ Imap::VERSION: /0.7.0/0.8.0/
+
 0.7.0: ~ Imap::Message: + #uid, #flags, #seen?, #size, #received_at, #sent_at, #cc, #from_address, #from_domain, #attachment?, #attachment_filenames, #source, .decode; + Imap#mailboxes
 
 1. + Imap::Message#uid, #flags, #seen?, #size, #received_at, #sent_at, #cc, #from_address, #from_domain, #attachment?, #attachment_filenames, #source. Everything a search had to go around the gem to Net::IMAP for.

data/lib/Imap/Message.rb

@@ -3,16 +3,17 @@
 
 # Usage:
 # 1. Imap::Message.search(imap_client, {from: 'noreply@example.com'})
-# 2. Imap::Message.new(message_id, imap_client)
-# 3. Imap::Message.new(message_id, imap_client).body
-# 4. Imap::Message.new(message_id, imap_client).urls
-# 5. Imap::Message.new(message_id, imap_client).mark_as_read
-# 6. Imap::Message.new(message_id, imap_client).subject
-# 7. Imap::Message.new(message_id, imap_client).from
-# 8. Imap::Message.new(message_id, imap_client).to
-# 9. Imap::Message.new(message_id, imap_client).received_at
-# 10. Imap::Message.new(message_id, imap_client).attachment_filenames
-# 11. Imap::Message.new(message_id, imap_client).source
+# 2. Imap::Message.for(imap_client, imap_client.imap.search(['ALL']))
+# 3. Imap::Message.new(message_id, imap_client)
+# 4. Imap::Message.new(message_id, imap_client).body
+# 5. Imap::Message.new(message_id, imap_client).urls
+# 6. Imap::Message.new(message_id, imap_client).mark_as_read
+# 7. Imap::Message.new(message_id, imap_client).subject
+# 8. Imap::Message.new(message_id, imap_client).from
+# 9. Imap::Message.new(message_id, imap_client).to
+# 10. Imap::Message.new(message_id, imap_client).received_at
+# 11. Imap::Message.new(message_id, imap_client).attachment_filenames
+# 12. Imap::Message.new(message_id, imap_client).source
 
 require 'time'
 
@@ -29,18 +30,23 @@ class Imap
 
     class << self
 
+      def search(imap_client, **search_criteria)
+        self.for(imap_client, Imap::Search.new(imap_client, search_criteria).message_ids)
+      end
+      alias_method :find, :search
+
       # One fetch for a slice of messages rather than one per attribute per
       # message.  A hundred messages cost a round trip apiece for the subject and
       # another apiece for the from; they cost one for the hundred now.
-      def search(imap_client, **search_criteria)
-        message_ids = Imap::Search.new(imap_client, search_criteria).message_ids
+      #
+      # new and not Imap::Message.new, so that a subclass gets its own kind back.
+      def for(imap_client, message_ids)
         message_ids.each_slice(SLICE).flat_map do |slice|
           imap_client.imap.fetch(slice, FETCH_ATTRIBUTES).collect do |data|
-            Imap::Message.new(data.seqno, imap_client, data)
+            new(data.seqno, imap_client, data)
           end
         end
       end
-      alias_method :find, :search
 
       # RFC 2047: =?charset?B?base64?= and =?charset?Q?quoted-printable?=, which
       # headers carry wherever the subject or a name is not ASCII.

data/lib/Imap/VERSION.rb

@@ -1,3 +1,3 @@
 class Imap
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/test/Imap/Message_test.rb

@@ -30,6 +30,29 @@ describe Imap::Message do
     end
   end
 
+  describe '.for' do
+    it 'builds messages for ids the caller searched for itself' do
+      messages = Imap::Message.for(client, [1, 2, 3])
+      _(messages.size).must_equal 3
+      _(messages.first).must_be_instance_of Imap::Message
+      _(messages.first.subject).must_match(/Mock Subject/)
+    end
+
+    it 'fetches once for the whole slice' do
+      Imap::Message.for(client, [1, 2, 3])
+      _(client.imap.fetch_count).must_equal 1
+    end
+
+    it 'is empty where nothing was found' do
+      _(Imap::Message.for(client, [])).must_equal []
+    end
+
+    it 'gives a subclass back its own kind' do
+      hit = Class.new(Imap::Message)
+      _(hit.for(client, [1]).first).must_be_instance_of hit
+    end
+  end
+
   describe 'the batched fetch' do
     it 'fetches once for the whole slice rather than once per message' do
       messages = Imap::Message.search(client, from: 'test@example.com')

metadata

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