imap-backup 2.1.0 → 2.1.1

data/lib/imap/backup/serializer/mbox_store.rb

@@ -1,6 +1,7 @@
 require "json"
 
 require "email/mboxrd/message"
+require "imap/backup/serializer/mbox_enumerator"
 
 module Imap::Backup
   class Serializer::MboxStore
@@ -71,8 +72,9 @@ module Imap::Backup
       end
     end
 
-    def load(uid)
+    def load(uid_maybe_string)
       do_load if !loaded
+      uid = uid_maybe_string.to_i
       message_index = uids.find_index(uid)
       return nil if message_index.nil?
 
@@ -103,16 +105,12 @@ module Imap::Backup
       @folder = new_name
     end
 
-    def relative_path
-      File.dirname(folder)
-    end
-
     private
 
     def do_load
       data = imap_data
       if data
-        @uids = data[:uids].map(&:to_i).sort
+        @uids = data[:uids].map(&:to_i)
         @uid_validity = data[:uid_validity]
         @loaded = true
       else
@@ -145,7 +143,8 @@ module Imap::Backup
     end
 
     def load_nth(index)
-      each_mbox_message.with_index do |raw, i|
+      enumerator = Serializer::MboxEnumerator.new(mbox_pathname)
+      enumerator.each.with_index do |raw, i|
         next unless i == index
 
         return Email::Mboxrd::Message.from_serialized(raw)
@@ -153,26 +152,6 @@ module Imap::Backup
       nil
     end
 
-    def each_mbox_message
-      Enumerator.new do |e|
-        File.open(mbox_pathname) do |f|
-          lines = []
-
-          loop do
-            line = f.gets
-            break if !line
-            if line.start_with?("From ")
-              e.yield lines.join if lines.count.positive?
-              lines = [line]
-            else
-              lines << line
-            end
-          end
-          e.yield lines.join if lines.count.positive?
-        end
-      end
-    end
-
     def imap_looks_like_json?
       return false unless imap_exist?
 

data/lib/imap/backup/version.rb

@@ -3,6 +3,6 @@ module Imap; end
 module Imap::Backup
   MAJOR    = 2
   MINOR    = 1
-  REVISION = 0
+  REVISION = 1
   VERSION  = [MAJOR, MINOR, REVISION].compact.map(&:to_s).join(".")
 end

data/spec/features/support/email_server.rb

@@ -85,6 +85,9 @@ module EmailServerHelpers
   def server_delete_folder(folder)
     imap.delete folder
     imap.disconnect
+  rescue StandardError => e
+    puts e.to_s
+  ensure
     @imap = nil
   end
 

data/spec/support/fixtures.rb

@@ -2,5 +2,5 @@ def fixture(name)
   spec_root = File.expand_path("..", File.dirname(__FILE__))
   fixture_path = File.join(spec_root, "fixtures", name + ".yml")
   fixture = File.read(fixture_path)
-  YAML.safe_load(fixture, permitted_classes: [Symbol])
+  YAML.safe_load(fixture, [Symbol])
 end

data/spec/unit/email/mboxrd/message_spec.rb

@@ -72,7 +72,7 @@ describe Email::Mboxrd::Message do
     end
   end
 
-  context "#to_serialized" do
+  describe "#to_serialized" do
     let(:mail) { instance_double(Mail::Message, from: [from], date: date) }
 
     before do
@@ -107,7 +107,7 @@ describe Email::Mboxrd::Message do
     end
   end
 
-  context "#from" do
+  describe "From" do
     before do
       # call original for these tests because we want to test the behaviour of
       # class-under-test given different behaviour of the Mail parser
@@ -148,7 +148,7 @@ describe Email::Mboxrd::Message do
     end
   end
 
-  context "#date" do
+  describe "#date" do
     let(:message_body) { msg_good }
 
     it "returns the date" do
@@ -163,4 +163,21 @@ describe Email::Mboxrd::Message do
       end
     end
   end
+
+  describe "#imap_body" do
+    let(:message_body) { "Ciao" }
+
+    it "returns the supplied body" do
+      expect(subject.imap_body).to eq(message_body)
+    end
+
+    context "when newlines are not IMAP standard" do
+      let(:message_body) { "Ciao\nHello" }
+      let(:corrected) { "Ciao\r\nHello" }
+
+      it "corrects them" do
+        expect(subject.imap_body).to eq(corrected)
+      end
+    end
+  end
 end

data/spec/unit/email/provider_spec.rb

@@ -1,6 +1,6 @@
 describe Email::Provider do
   describe ".for_address" do
-    context "known providers" do
+    context "with known providers" do
       [
         ["gmail.com", :gmail],
         ["fastmail.fm", :fastmail]

data/spec/unit/imap/backup/account/connection_spec.rb

@@ -33,7 +33,7 @@ describe Imap::Backup::Account::Connection do
       Imap::Backup::Serializer::Mbox,
       folder: serialized_folder,
       force_uid_validity: nil,
-      set_uid_validity: new_uid_validity,
+      apply_uid_validity: new_uid_validity,
       uids: [local_uid]
     )
   end
@@ -58,7 +58,7 @@ describe Imap::Backup::Account::Connection do
     end
   end
 
-  context "#initialize" do
+  describe "#initialize" do
     [
       [:username, "username@gmail.com"],
       [:local_path, "local_path"],
@@ -85,7 +85,7 @@ describe Imap::Backup::Account::Connection do
     include_examples "connects to IMAP"
   end
 
-  context "#folders" do
+  describe "#folders" do
     let(:imap_folders) do
       [instance_double(Net::IMAP::MailboxList)]
     end
@@ -95,7 +95,7 @@ describe Imap::Backup::Account::Connection do
     end
   end
 
-  context "#status" do
+  describe "#status" do
     let(:folder) do
       instance_double(Imap::Backup::Account::Folder, uids: [remote_uid])
     end
@@ -119,7 +119,7 @@ describe Imap::Backup::Account::Connection do
     end
   end
 
-  context "#run_backup" do
+  describe "#run_backup" do
     let(:folder) do
       instance_double(
         Imap::Backup::Account::Folder,
@@ -202,7 +202,7 @@ describe Imap::Backup::Account::Connection do
     end
   end
 
-  context "#restore" do
+  describe "#restore" do
     let(:folder) do
       instance_double(
         Imap::Backup::Account::Folder,
@@ -253,7 +253,8 @@ describe Imap::Backup::Account::Connection do
     end
 
     it "sets local uid validity" do
-      expect(serializer).to have_received(:set_uid_validity).with(uid_validity)
+      expect(serializer).
+        to have_received(:apply_uid_validity).with(uid_validity)
     end
 
     context "when folders exist" do
@@ -297,7 +298,7 @@ describe Imap::Backup::Account::Connection do
     end
   end
 
-  context "#reconnect" do
+  describe "#reconnect" do
     before { subject.reconnect }
 
     it "disconnects from the server" do
@@ -311,7 +312,7 @@ describe Imap::Backup::Account::Connection do
     end
   end
 
-  context "#disconnect" do
+  describe "#disconnect" do
     before { subject.disconnect }
 
     it "disconnects from the server" do

data/spec/unit/imap/backup/account/folder_spec.rb

@@ -25,7 +25,7 @@ describe Imap::Backup::Account::Folder do
   let(:responses) { [] }
   let(:append_response) { nil }
 
-  context "#uids" do
+  describe "#uids" do
     let(:uids) { [5678, 123] }
 
     before { allow(imap).to receive(:uid_search).and_return(uids) }
@@ -45,7 +45,7 @@ describe Imap::Backup::Account::Folder do
     end
   end
 
-  context "#fetch" do
+  describe "#fetch" do
     let(:message_body) { instance_double(String, force_encoding: nil) }
     let(:attributes) { {"RFC822" => message_body, "other" => "xxx"} }
     let(:fetch_data_item) do
@@ -58,7 +58,7 @@ describe Imap::Backup::Account::Folder do
       expect(subject.fetch(123)).to eq(attributes)
     end
 
-    context "if the server responds with nothing" do
+    context "when the server responds with nothing" do
       before { allow(imap).to receive(:uid_fetch) { nil } }
 
       it "is nil" do
@@ -66,7 +66,7 @@ describe Imap::Backup::Account::Folder do
       end
     end
 
-    context "if the mailbox doesn't exist" do
+    context "when the mailbox doesn't exist" do
       before do
         allow(imap).to receive(:examine).and_raise(missing_mailbox_error)
       end
@@ -76,6 +76,14 @@ describe Imap::Backup::Account::Folder do
       end
     end
 
+    context "when the response doesn't have RFC822" do
+      let(:attributes) { {} }
+
+      it "is nil" do
+        expect(subject.fetch(123)).to be_nil
+      end
+    end
+
     it "sets the encoding on the message" do
       subject.fetch(123)
 
@@ -83,13 +91,13 @@ describe Imap::Backup::Account::Folder do
     end
   end
 
-  context "#folder"  do
+  describe "#folder" do
     it "is the name" do
       expect(subject.folder).to eq("my_folder")
     end
   end
 
-  context "#exist?" do
+  describe "#exist?" do
     context "when the folder exists" do
       it "is true" do
         expect(subject.exist?).to be_truthy
@@ -107,7 +115,7 @@ describe Imap::Backup::Account::Folder do
     end
   end
 
-  context "#create" do
+  describe "#create" do
     context "when the folder exists" do
       before { subject.create }
 
@@ -128,7 +136,7 @@ describe Imap::Backup::Account::Folder do
     end
   end
 
-  context "#uid_validity" do
+  describe "#uid_validity" do
     let(:responses) { {"UIDVALIDITY" => ["x", "uid validity"]} }
 
     it "is returned" do
@@ -148,14 +156,15 @@ describe Imap::Backup::Account::Folder do
     end
   end
 
-  context "#append" do
+  describe "#append" do
     let(:message) do
       instance_double(
         Email::Mboxrd::Message,
         imap_body: "imap body",
-        date: Time.now
+        date: message_date
       )
     end
+    let(:message_date) { Time.new(2010, 10, 10, 9, 15, 22, 0) }
     let(:append_response) do
       OpenStruct.new(data: OpenStruct.new(code: OpenStruct.new(data: "1 2")))
     end
@@ -169,6 +178,11 @@ describe Imap::Backup::Account::Folder do
       expect(imap).to have_received(:append)
     end
 
+    it "sets the date and time" do
+      expect(imap).to have_received(:append).
+        with(anything, anything, anything, message_date)
+    end
+
     it "returns the new uid" do
       expect(result).to eq(2)
     end

data/spec/unit/imap/backup/configuration/account_spec.rb

@@ -18,7 +18,7 @@ describe Imap::Backup::Configuration::Account do
     end
   end
 
-  context "#initialize" do
+  describe "#initialize" do
     subject { described_class.new(store, account, highline) }
 
     let(:store) { "store" }
@@ -32,7 +32,7 @@ describe Imap::Backup::Configuration::Account do
     end
   end
 
-  context "#run" do
+  describe "#run" do
     subject { described_class.new(store, account, highline) }
 
     let(:highline) { instance_double(HighLine) }
@@ -72,21 +72,21 @@ describe Imap::Backup::Configuration::Account do
       end
     end
 
-    context "preparation" do
+    describe "preparation" do
       before { subject.run }
 
       it "clears the screen" do
         expect(Kernel).to have_received(:system).with("clear")
       end
 
-      context "menu" do
+      describe "menu" do
         it "shows the menu" do
           expect(highline).to have_received(:choose)
         end
       end
     end
 
-    context "menu" do
+    describe "menu" do
       [
         "modify email",
         "modify password",
@@ -106,7 +106,7 @@ describe Imap::Backup::Configuration::Account do
       end
     end
 
-    context "account details" do
+    describe "account details" do
       [
         ["email", /email:\s+user@example.com/],
         ["server", /server:\s+imap.example.com/],
@@ -132,7 +132,7 @@ describe Imap::Backup::Configuration::Account do
       end
     end
 
-    context "email" do
+    describe "email" do
       before do
         allow(Imap::Backup::Configuration::Asker).
           to receive(:email) { new_email }
@@ -140,7 +140,7 @@ describe Imap::Backup::Configuration::Account do
         menu.choices["modify email"].call
       end
 
-      context "if the server is blank" do
+      context "when the server is blank" do
         [
           ["GMail", "foo@gmail.com", "imap.gmail.com"],
           ["Fastmail", "bar@fastmail.fm", "imap.fastmail.com"],
@@ -166,9 +166,24 @@ describe Imap::Backup::Configuration::Account do
             end
           end
         end
+
+        context "when the domain is unrecognized" do
+          let(:existing_server) { nil }
+          let(:provider) do
+            instance_double(Email::Provider, provider: :default)
+          end
+
+          before do
+            allow(Email::Provider).to receive(:for_address) { provider }
+          end
+
+          it "does not set a default server" do
+            expect(account[:server]).to be_nil
+          end
+        end
       end
 
-      context "the email is new" do
+      context "when the email is new" do
         it "modifies the email address" do
           expect(account[:username]).to eq(new_email)
         end
@@ -176,7 +191,7 @@ describe Imap::Backup::Configuration::Account do
         include_examples "it flags the account as modified"
       end
 
-      context "the email already exists" do
+      context "when the email already exists" do
         let(:new_email) { other_email }
 
         it "indicates the error" do
@@ -192,7 +207,7 @@ describe Imap::Backup::Configuration::Account do
       end
     end
 
-    context "password" do
+    describe "password" do
       let(:new_password) { "new_password" }
 
       before do
@@ -202,7 +217,7 @@ describe Imap::Backup::Configuration::Account do
         menu.choices["modify password"].call
       end
 
-      context "if the user enters a password" do
+      context "when the user enters a password" do
         it "updates the password" do
           expect(account[:password]).to eq(new_password)
         end
@@ -210,7 +225,7 @@ describe Imap::Backup::Configuration::Account do
         include_examples "it flags the account as modified"
       end
 
-      context "if the user cancels" do
+      context "when the user cancels" do
         let(:new_password) { nil }
 
         it "does nothing" do
@@ -221,7 +236,7 @@ describe Imap::Backup::Configuration::Account do
       end
     end
 
-    context "server" do
+    describe "server" do
       let(:server) { "server" }
 
       before do
@@ -237,7 +252,7 @@ describe Imap::Backup::Configuration::Account do
       include_examples "it flags the account as modified"
     end
 
-    context "backup_path" do
+    describe "backup_path" do
       let(:new_backup_path) { "/new/path" }
 
       before do
@@ -256,16 +271,26 @@ describe Imap::Backup::Configuration::Account do
         expect(account[:local_path]).to eq(new_backup_path)
       end
 
-      it "validates that the path is not used by other backups" do
-        # rubocop:disable RSpec/InstanceVariable
-        expect(@validator.call(other_existing_path)).to be_falsey
-        # rubocop:enable RSpec/InstanceVariable
+      context "when the path is not used by other backups" do
+        it "is accepts it" do
+          # rubocop:disable RSpec/InstanceVariable
+          expect(@validator.call("/unknown/path")).to be_truthy
+          # rubocop:enable RSpec/InstanceVariable
+        end
+      end
+
+      context "when the path is used by other backups" do
+        it "fails validation" do
+          # rubocop:disable RSpec/InstanceVariable
+          expect(@validator.call(other_existing_path)).to be_falsey
+          # rubocop:enable RSpec/InstanceVariable
+        end
       end
 
       include_examples "it flags the account as modified"
     end
 
-    context "folders" do
+    describe "folders" do
       let(:chooser) do
         instance_double(Imap::Backup::Configuration::FolderChooser, run: nil)
       end
@@ -282,7 +307,7 @@ describe Imap::Backup::Configuration::Account do
       end
     end
 
-    context "connection test" do
+    describe "connection test" do
       before do
         allow(Imap::Backup::Configuration::ConnectionTester).
           to receive(:test).and_return("All fine")
@@ -297,7 +322,7 @@ describe Imap::Backup::Configuration::Account do
       end
     end
 
-    context "deletion" do
+    describe "deletion" do
       let(:confirmed) { true }
 
       before do