imap-backup 5.2.0 → 6.0.0.rc2

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

@@ -11,10 +11,11 @@ describe Imap::Backup::Setup::Account do
       Imap::Backup::Account,
       username: existing_email,
       password: existing_password,
-      server: current_server,
-      connection_options: nil,
       local_path: "/backup/path",
       folders: [{name: "my_folder"}],
+      multi_fetch_size: multi_fetch_size,
+      server: current_server,
+      connection_options: connection_options,
       modified?: false
     )
   end
@@ -28,10 +29,12 @@ describe Imap::Backup::Setup::Account do
   let(:accounts) { [account, account1] }
   let(:existing_email) { "user@example.com" }
   let(:new_email) { "foo@example.com" }
-  let(:current_server) { "imap.example.com" }
   let(:existing_password) { "password" }
   let(:other_email) { "other@example.com" }
   let(:other_existing_path) { "/other/existing/path" }
+  let(:multi_fetch_size) { 1 }
+  let(:current_server) { "imap.example.com" }
+  let(:connection_options) { nil }
 
   let(:highline) { HIGHLINE }
   let(:config) { CONFIG }
@@ -99,9 +102,11 @@ describe Imap::Backup::Setup::Account do
       [
         "modify email",
         "modify password",
-        "modify server",
         "modify backup path",
         "choose backup folders",
+        "modify multi-fetch size (number of emails to fetch at a time)",
+        "modify server",
+        "modify connection options",
         "test connection",
         "delete",
         "(q) return to main menu",
@@ -136,7 +141,23 @@ describe Imap::Backup::Setup::Account do
         before { subject.run }
 
         it "indicates that a password is not set" do
-          expect(menu.header).to include("password   (unset)")
+          expect(menu.header).to match(/^password\s+\(unset\)/)
+        end
+      end
+
+      context "with multi_fetch_size" do
+        let(:multi_fetch_size) { 4 }
+
+        it "shows the size" do
+          expect(menu.header).to match(/^multi-fetch\s+4/)
+        end
+      end
+
+      context "with connection_options" do
+        let(:connection_options) { {some: "option"} }
+
+        it "shows the options" do
+          expect(menu.header).to match(/^connection options\s+'{"some":"option"}'/)
         end
       end
     end
@@ -240,23 +261,6 @@ describe Imap::Backup::Setup::Account do
       end
     end
 
-    describe "choosing 'modify server'" do
-      let(:server) { "server" }
-
-      before do
-        allow(account).to receive(:"server=")
-        allow(highline).to receive(:ask).with("server: ") { server }
-
-        subject.run
-
-        menu.choices["modify server"].call
-      end
-
-      it "updates the server" do
-        expect(account).to have_received(:"server=").with(server)
-      end
-    end
-
     describe "choosing 'modify backup path'" do
       let(:new_backup_path) { "/new/path" }
 
@@ -311,6 +315,97 @@ describe Imap::Backup::Setup::Account do
       end
     end
 
+    describe "choosing 'modify multi-fetch size'" do
+      let(:supplied) { "10" }
+
+      before do
+        allow(account).to receive(:multi_fetch_size=)
+        allow(highline).to receive(:ask).with("size: ") { supplied }
+
+        subject.run
+        menu.choices[
+          "modify multi-fetch size (number of emails to fetch at a time)"
+        ].call
+      end
+
+      it "sets the multi-fetch size" do
+        expect(account).to have_received(:multi_fetch_size=).with(10)
+      end
+
+      context "when the supplied value is not a number" do
+        let(:supplied) { "wrong!" }
+
+        it "does nothing" do
+          expect(account).to_not have_received(:multi_fetch_size=)
+        end
+      end
+
+      context "when the supplied value is not a positive number" do
+        let(:supplied) { "0" }
+
+        it "does nothing" do
+          expect(account).to_not have_received(:multi_fetch_size=)
+        end
+      end
+    end
+
+    describe "choosing 'modify server'" do
+      let(:server) { "server" }
+
+      before do
+        allow(account).to receive(:"server=")
+        allow(highline).to receive(:ask).with("server: ") { server }
+
+        subject.run
+
+        menu.choices["modify server"].call
+      end
+
+      it "updates the server" do
+        expect(account).to have_received(:"server=").with(server)
+      end
+    end
+
+    describe "choosing 'modify connection options'" do
+      context "when the JSON is well formed" do
+        let(:json) { "{}" }
+
+        before do
+          allow(highline).to receive(:ask).with("connections options (as JSON): ") { json }
+          allow(account).to receive(:"connection_options=")
+
+          subject.run
+
+          menu.choices["modify connection options"].call
+        end
+
+        it "updates the connection options" do
+          expect(account).to have_received(:"connection_options=").with(json)
+        end
+      end
+
+      context "when the JSON is malformed" do
+        before do
+          allow(highline).to receive(:ask).with("connections options (as JSON): ") { "xx" }
+          allow(account).to receive(:"connection_options=").and_raise(JSON::ParserError)
+          allow(highline).to receive(:ask).with("Press a key ")
+
+          subject.run
+
+          menu.choices["modify connection options"].call
+        end
+
+        it "does not fail" do
+          subject.run
+        end
+
+        it "reports the problem" do
+          expect(Kernel).to have_received(:puts).
+            with(/Malformed/)
+        end
+      end
+    end
+
     describe "choosing 'test connection'" do
       let(:connection_tester) do
         instance_double(
@@ -336,7 +431,7 @@ describe Imap::Backup::Setup::Account do
       let(:confirmed) { true }
 
       before do
-        allow(account).to receive(:mark_for_deletion!)
+        allow(account).to receive(:mark_for_deletion)
         allow(highline).to receive(:agree) { confirmed }
         subject.run
         catch :done do
@@ -350,7 +445,7 @@ describe Imap::Backup::Setup::Account do
 
       context "when the user confirms deletion" do
         it "flags the account to be deleted" do
-          expect(account).to have_received(:mark_for_deletion!)
+          expect(account).to have_received(:mark_for_deletion)
         end
       end
 
@@ -358,7 +453,7 @@ describe Imap::Backup::Setup::Account do
         let(:confirmed) { false }
 
         it "doesn't flag the account to be deleted" do
-          expect(account).to_not have_received(:mark_for_deletion!)
+          expect(account).to_not have_received(:mark_for_deletion)
         end
       end
     end

data/spec/unit/imap/backup/setup/helpers_spec.rb

@@ -0,0 +1,15 @@
+module Imap::Backup
+  RSpec.describe Setup::Helpers do
+    describe "#title_prefix" do
+      it "is a string" do
+        expect(subject.title_prefix).to eq("imap-backup –")
+      end
+    end
+
+    describe "#version" do
+      it "is a version string" do
+        expect(subject.version).to match(/\A\d+\.\d+\.\d+(\.\w+)?\z/)
+      end
+    end
+  end
+end

data/spec/unit/imap/backup/thunderbird/mailbox_exporter_spec.rb

@@ -0,0 +1,116 @@
+module Imap::Backup
+  describe Thunderbird::MailboxExporter do
+    subject { described_class.new("email", serializer, "profile", **args) }
+
+    let(:args) { {} }
+    let(:serializer) do
+      instance_double(
+        Serializer,
+        folder: "folder",
+        mbox_pathname: "mbox_pathname"
+      )
+    end
+    let(:local_folder) do
+      instance_double(
+        Thunderbird::LocalFolder,
+        exists?: local_folder_exists,
+        full_path: "full_path",
+        msf_exists?: msf_exists,
+        msf_path: "msf_path",
+        path: "path",
+        set_up: set_up_result
+      )
+    end
+    let(:local_folder_exists) { false }
+    let(:msf_exists) { false }
+    let(:set_up_result) { true }
+    let(:file) { instance_double(File, write: nil) }
+    let(:enumerator) { instance_double(Serializer::MboxEnumerator) }
+
+    before do
+      allow(File).to receive(:open).with("full_path", "w").and_yield(file)
+      allow(File).to receive(:unlink)
+      allow(Thunderbird::LocalFolder).to receive(:new) { local_folder }
+      allow(Serializer::MboxEnumerator).to receive(:new) { enumerator }
+      allow(enumerator).to receive(:each) { ["message"].enum_for(:each) }
+      allow(Email::Mboxrd::Message).to receive(:clean_serialized) { "cleaned" }
+      allow(Kernel).to receive(:puts)
+    end
+
+    describe "#run" do
+      let!(:result) { subject.run }
+
+      context "when the destination folder cannot be set up" do
+        let(:set_up_result) { false }
+
+        it "doesn't copy the mailbox" do
+          expect(file).to_not have_received(:write)
+        end
+
+        it "returns false" do
+          expect(result).to be false
+        end
+      end
+
+      context "when the .msf file exists" do
+        let(:msf_exists) { true }
+
+        context "when 'force' is set" do
+          let(:args) { {force: true} }
+
+          it "deletes the file" do
+            expect(File).to have_received(:unlink).with("msf_path")
+          end
+        end
+
+        context "when 'force' isn't set" do
+          it "doesn't copy the mailbox" do
+            expect(file).to_not have_received(:write)
+          end
+
+          it "returns false" do
+            expect(result).to be false
+          end
+        end
+      end
+
+      context "when the destination mailbox exists" do
+        let(:local_folder_exists) { true }
+
+        context "when 'force' is set" do
+          let(:args) { {force: true} }
+
+          it "writes the message" do
+            expect(file).to have_received(:write)
+          end
+
+          it "returns true" do
+            expect(result).to be true
+          end
+        end
+
+        context "when 'force' isn't set" do
+          it "doesn't copy the mailbox" do
+            expect(file).to_not have_received(:write)
+          end
+
+          it "returns false" do
+            expect(result).to be false
+          end
+        end
+      end
+
+      it "adds a 'From' line" do
+        expect(file).to have_received(:write).with(/From - \w+ \w+ \d+ \d+:\d+:\d+/)
+      end
+
+      it "writes the cleaned message" do
+        expect(file).to have_received(:write).with(/cleaned/)
+      end
+
+      it "returns true" do
+        expect(result).to be true
+      end
+    end
+  end
+end

data/spec/unit/imap/backup/uploader_spec.rb

@@ -8,7 +8,7 @@ describe Imap::Backup::Uploader do
   end
   let(:serializer) do
     instance_double(
-      Imap::Backup::Serializer::Mbox,
+      Imap::Backup::Serializer,
       uids: [1, 2],
       update_uid: nil
     )

data/spec/unit/retry_on_error_spec.rb

@@ -0,0 +1,34 @@
+class Retrier
+  class FooError < StandardError; end
+
+  include RetryOnError
+
+  def do_stuff(errors:, limit:)
+    calls = 0
+
+    retry_on_error(errors: errors, limit: limit) do
+      calls += 1
+      raise FooError if calls < 3
+
+      42
+    end
+  end
+end
+
+RSpec.describe RetryOnError do
+  describe "#retry_on_error" do
+    subject { Retrier.new }
+
+    it "retries" do
+      expect(subject.do_stuff(errors: [Retrier::FooError], limit: 3)).to eq(42)
+    end
+
+    context "when the block fails more than the limit" do
+      it "fails" do
+        expect do
+          subject.do_stuff(errors: [Retrier::FooError], limit: 1)
+        end.to raise_error(Retrier::FooError)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 6.0.0.rc2
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -211,9 +211,10 @@ files:
 - lib/imap/backup/migrator.rb
 - lib/imap/backup/sanitizer.rb
 - lib/imap/backup/serializer.rb
+- lib/imap/backup/serializer/directory.rb
+- lib/imap/backup/serializer/imap.rb
 - lib/imap/backup/serializer/mbox.rb
 - lib/imap/backup/serializer/mbox_enumerator.rb
-- lib/imap/backup/serializer/mbox_store.rb
 - lib/imap/backup/setup.rb
 - lib/imap/backup/setup/account.rb
 - lib/imap/backup/setup/asker.rb
@@ -256,25 +257,39 @@ files:
 - spec/unit/email/provider_spec.rb
 - spec/unit/imap/backup/account/connection_spec.rb
 - spec/unit/imap/backup/account/folder_spec.rb
+- spec/unit/imap/backup/account_spec.rb
 - spec/unit/imap/backup/cli/accounts_spec.rb
+- spec/unit/imap/backup/cli/backup_spec.rb
+- spec/unit/imap/backup/cli/folders_spec.rb
 - spec/unit/imap/backup/cli/helpers_spec.rb
 - spec/unit/imap/backup/cli/local_spec.rb
+- spec/unit/imap/backup/cli/migrate_spec.rb
+- spec/unit/imap/backup/cli/restore_spec.rb
+- spec/unit/imap/backup/cli/setup_spec.rb
 - spec/unit/imap/backup/cli/utils_spec.rb
+- spec/unit/imap/backup/cli_spec.rb
+- spec/unit/imap/backup/client/apple_mail_spec.rb
 - spec/unit/imap/backup/client/default_spec.rb
 - spec/unit/imap/backup/configuration_spec.rb
 - spec/unit/imap/backup/downloader_spec.rb
 - spec/unit/imap/backup/logger_spec.rb
 - spec/unit/imap/backup/migrator_spec.rb
+- spec/unit/imap/backup/sanitizer_spec.rb
+- spec/unit/imap/backup/serializer/directory_spec.rb
+- spec/unit/imap/backup/serializer/imap_spec.rb
 - spec/unit/imap/backup/serializer/mbox_enumerator_spec.rb
 - spec/unit/imap/backup/serializer/mbox_spec.rb
-- spec/unit/imap/backup/serializer/mbox_store_spec.rb
+- spec/unit/imap/backup/serializer_spec.rb
 - spec/unit/imap/backup/setup/account_spec.rb
 - spec/unit/imap/backup/setup/asker_spec.rb
 - spec/unit/imap/backup/setup/connection_tester_spec.rb
 - spec/unit/imap/backup/setup/folder_chooser_spec.rb
+- spec/unit/imap/backup/setup/helpers_spec.rb
 - spec/unit/imap/backup/setup_spec.rb
+- spec/unit/imap/backup/thunderbird/mailbox_exporter_spec.rb
 - spec/unit/imap/backup/uploader_spec.rb
 - spec/unit/imap/backup/utils_spec.rb
+- spec/unit/retry_on_error_spec.rb
 homepage: https://github.com/joeyates/imap-backup
 licenses:
 - MIT
@@ -290,9 +305,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.6
 signing_key:
@@ -300,18 +315,27 @@ specification_version: 4
 summary: Backup GMail (or other IMAP) accounts to disk
 test_files:
 - spec/spec_helper.rb
+- spec/unit/imap/backup/account_spec.rb
+- spec/unit/imap/backup/serializer/imap_spec.rb
+- spec/unit/imap/backup/serializer/directory_spec.rb
 - spec/unit/imap/backup/serializer/mbox_spec.rb
-- spec/unit/imap/backup/serializer/mbox_store_spec.rb
 - spec/unit/imap/backup/serializer/mbox_enumerator_spec.rb
+- spec/unit/imap/backup/cli_spec.rb
 - spec/unit/imap/backup/setup_spec.rb
 - spec/unit/imap/backup/logger_spec.rb
 - spec/unit/imap/backup/configuration_spec.rb
 - spec/unit/imap/backup/setup/account_spec.rb
 - spec/unit/imap/backup/setup/connection_tester_spec.rb
 - spec/unit/imap/backup/setup/asker_spec.rb
+- spec/unit/imap/backup/setup/helpers_spec.rb
 - spec/unit/imap/backup/setup/folder_chooser_spec.rb
+- spec/unit/imap/backup/cli/folders_spec.rb
+- spec/unit/imap/backup/cli/setup_spec.rb
+- spec/unit/imap/backup/cli/backup_spec.rb
+- spec/unit/imap/backup/cli/restore_spec.rb
 - spec/unit/imap/backup/cli/helpers_spec.rb
 - spec/unit/imap/backup/cli/accounts_spec.rb
+- spec/unit/imap/backup/cli/migrate_spec.rb
 - spec/unit/imap/backup/cli/utils_spec.rb
 - spec/unit/imap/backup/cli/local_spec.rb
 - spec/unit/imap/backup/downloader_spec.rb
@@ -320,7 +344,12 @@ test_files:
 - spec/unit/imap/backup/account/folder_spec.rb
 - spec/unit/imap/backup/account/connection_spec.rb
 - spec/unit/imap/backup/utils_spec.rb
+- spec/unit/imap/backup/serializer_spec.rb
 - spec/unit/imap/backup/client/default_spec.rb
+- spec/unit/imap/backup/client/apple_mail_spec.rb
+- spec/unit/imap/backup/thunderbird/mailbox_exporter_spec.rb
+- spec/unit/imap/backup/sanitizer_spec.rb
+- spec/unit/retry_on_error_spec.rb
 - spec/unit/email/mboxrd/message_spec.rb
 - spec/unit/email/provider/gmail_spec.rb
 - spec/unit/email/provider/apple_mail_spec.rb