imap 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2adce3df9c03ab185866e212c6d4ed2ffb2de37ca288eb5ad4f7b9e6e92f68a
-  data.tar.gz: 602536188fecb058c39c18cfee25b46eace80f3676548afd06f4734979e6c7b1
+  metadata.gz: cf1e1e584ce9151c1729d359ab2ba2ac68b75c3d06a3fd15ef7512defa491c12
+  data.tar.gz: 0f07df5b9ae03d1421e5a243655fdfe56237ee2c1a9fc7597cacc3599f6db0a2
 SHA512:
-  metadata.gz: a8d445f3dfd17c1ad074b38c544fc5620a0c045f20ef7e00c273bda6df3fcc633d9fefce4fad6f30648896a7356049d612a89789a528f1d8be83b3f9098d2d13
-  data.tar.gz: 218c50db53fc39640409531ced34a1f89ba0adb3297e22a3db14cdd868da00b1e2ab58a655dca2047f706322e89f84411e65be89d7b2f41a68837f1ccfe6b351
+  metadata.gz: 696700ed822fd7d2af94fa66d07dd81dced92892a8437d64c53ac4ed94e27df3a9846374cb148deee2225bcc8250745e394bb151ed2029839bfbbc68a250faf0
+  data.tar.gz: 5c3786b4fa23995246292616675a0d2aa394c0827cb2114caee990de8992d971506f44fee5acc533ca17960b7504b239f0fcf52657f5414ad4ec9d2de1b8bf6f

data/CHANGELOG

@@ -1,5 +1,19 @@
 # imap/CHANGELOG
 
+## 20261014
+
+0.12.0: ~ Imap::Message: + #mailbox, and a select before every fetch and store. A sequence number is valid only inside the SELECT which issued it, so a message whose body was read after another mailbox had been selected read that other mailbox instead, and said nothing about it.
+
+1. + Imap::Message#mailbox, taken from the client at construction, so .search and .for hand back messages which know where they came from.
+2. + Imap::Message#select_mailbox: selects back where the client has moved on since.
+3. ~ Imap::Message#fetch_data, #mark_as_seen: select_mailbox first. #body, #source and a flag store all reached the server by sequence number and none of them checked.
+4. ~ Imap::Message#initialize: + mailbox, defaulting to the client's current one, so a message built by hand is guarded too.
+5. ~ test/Imap_test.rb --> test/imap_test.rb, the file it tests being lib/imap.rb. git mv declines a destination differing only in case, so it went by way of a third name.
+6. ~ CHANGELOG: 0.4.4's second item said test_all.rb "required './Imap_test' for a file named imap_test.rb". It required './Imap_test' for test/Imap_test.rb, which matched, and the clause is struck. What remains of that item, that test_all.rb never loaded test/Imap/VERSION_test.rb, holds.
+7. + 4 tests: that a message knows its mailbox, that a fetch selects back, that a flag store selects back, and that neither selects where the client is already there. The two which select back fail with the guard removed.
+8. ~ Imap::VERSION: /0.11.0/0.12.0/
+
+
 ## 20260919
 
 0.11.0: ~ README.md: rewritten for the surface as it now stands; ~ the gemspecs: /['minitest', '~> 5.0']/'minitest'/, /['rake', '~> 13.0']/'rake'/. The README documented 0.4, five minors back, and the minitest line permitted only versions the suite no longer runs on.
@@ -118,7 +132,7 @@
 0.4.4: + Rakefile, - test/test_all.rb
 
 1. + Rakefile: Rake::TestTask over FileList['test/**/*_test.rb'], with libs for lib and test, and warning = true. The minimal form nine of the gems here use rather than the fuller one five use: the :spec alias and the :version task belong to the minority, and a :version task reading VERSION.rb would not have caught 0.4.1, where require 'imap' left Imap::VERSION undefined while VERSION.rb sat there defining it. rake has been a development dependency since 0.4.0 with nothing here to run.
-2. - test/test_all.rb: a second entry point which the Rakefile's FileList makes redundant, and which had drifted from the files on disk in two ways: it never loaded test/Imap/VERSION_test.rb, added in 0.4.2, so it ran 42 tests where there are 44; and it required './Imap_test' for a file named imap_test.rb, which resolved only because the filesystem is case insensitive and would not have on Linux. A glob cannot drift.
+2. - test/test_all.rb: a second entry point which the Rakefile's FileList makes redundant, and which had drifted from the files on disk: it never loaded test/Imap/VERSION_test.rb, added in 0.4.2, so it ran 42 tests where there are 44. A glob cannot drift.
 3. ~ test/Imap/Message_test.rb: must_match(/Mock body/) for must_match /Mock body/, the ambiguous / which warning = true reports and which is the only warning the suite raises.
 4. ~ imap.gemspec: + 'Rakefile' to spec.files.
 5. ~ Imap::VERSION: /0.4.3/0.4.4/

data/lib/Imap/Message.rb

@@ -14,6 +14,7 @@
 # 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
+# 13. Imap::Message.new(message_id, imap_client).mailbox
 
 require 'time'
 
@@ -71,6 +72,7 @@ class Imap
 
     attr_accessor :imap_client
     attr_accessor :message_id
+    attr_reader :mailbox
 
     def uid
       data.uid
@@ -148,16 +150,25 @@ class Imap
     end
 
     def mark_as_seen
+      select_mailbox
       imap_client.imap.store(@message_id, '+FLAGS', [:Seen])
     end
     alias_method :mark_as_read, :mark_as_seen
 
     private
 
-    def initialize(message_id = nil, imap_client = nil, data = nil)
+    def initialize(message_id = nil, imap_client = nil, data = nil, mailbox = nil)
       @message_id = message_id
       @imap_client = imap_client
       @data = data
+      @mailbox = mailbox || (imap_client && imap_client.mailbox)
+    end
+
+    # A sequence number means nothing outside the mailbox which issued it, so
+    # anything fetched after another mailbox was selected has to select back.
+    def select_mailbox
+      return unless mailbox && imap_client && imap_client.mailbox != mailbox
+      imap_client.mailbox = mailbox
     end
 
     # The Net::IMAP::FetchData itself rather than its attr hash, since it reads
@@ -218,6 +229,7 @@ class Imap
     end
 
     def fetch_data(*fetch_attributes)
+      select_mailbox
       @fetch_data = imap_client.imap.fetch(message_id, [*fetch_attributes])
     end
   end

data/lib/Imap/VERSION.rb

@@ -1,3 +1,3 @@
 class Imap
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

data/test/Imap/Message_test.rb

@@ -237,6 +237,34 @@ describe Imap::Message do
     end
   end
 
+  describe '#mailbox' do
+    it 'knows the mailbox it was built in' do
+      _(Imap::Message.for(client, [1]).first.mailbox).must_equal 'INBOX'
+    end
+
+    it 'selects back before fetching, where the client has moved on since' do
+      message = Imap::Message.for(client, [1]).first
+      client.mailbox = 'Archive/2026'
+      message.body
+      _(client.mailbox).must_equal 'INBOX'
+      _(client.imap.selects.last).must_equal 'INBOX'
+    end
+
+    it 'selects back before storing a flag' do
+      message = Imap::Message.for(client, [1]).first
+      client.mailbox = 'Archive/2026'
+      message.mark_as_seen
+      _(client.imap.selects.last).must_equal 'INBOX'
+    end
+
+    it 'does not select where the client is already there' do
+      message = Imap::Message.for(client, [1]).first
+      before = (client.imap.selects || []).length
+      message.body
+      _((client.imap.selects || []).length).must_equal before
+    end
+  end
+
   describe '#urls' do
     it 'extracts http URLs from body' do
       imap_message.stub(:body, 'Check out http://example.com and https://test.com') do

data/test/test_helper.rb

@@ -20,9 +20,12 @@ class MockIMAP
     @password = password
   end
 
+  attr_reader :selects
+
   def select(mailbox)
     @select_called = true
     @selected_mailbox = mailbox
+    (@selects ||= []) << mailbox
   end
 
   def search(criteria)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imap
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - thoran
@@ -85,7 +85,7 @@ files:
 - test/Imap/Message_test.rb
 - test/Imap/Search_test.rb
 - test/Imap/VERSION_test.rb
-- test/Imap_test.rb
+- test/imap_test.rb
 - test/test_helper.rb
 homepage: https://github.com/thoran/imap
 licenses:
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.20
+rubygems_version: 4.0.22
 specification_version: 4
 summary: IMAP for Ruby made easy.
 test_files: []