imap-backup 2.1.0 → 2.1.1

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

@@ -1,5 +1,3 @@
-# rubocop:disable Metrics/ModuleLength
-
 module Imap::Backup
   describe Configuration::Asker do
     subject { described_class.new(highline) }
@@ -43,7 +41,7 @@ module Imap::Backup
       end
     end
 
-    context "#initialize" do
+    describe "#initialize" do
       it "requires 1 parameter" do
         expect do
           described_class.new
@@ -55,7 +53,7 @@ module Imap::Backup
       end
     end
 
-    context "#email" do
+    describe "#email" do
       let(:email) { "email@example.com" }
       let(:answer) { email }
       let(:result) { subject.email }
@@ -71,7 +69,7 @@ module Imap::Backup
       end
     end
 
-    context "#password" do
+    describe "#password" do
       let(:password1) { "password" }
       let(:password2) { "password" }
       let(:answers) { [true, false] }
@@ -101,7 +99,7 @@ module Imap::Backup
         expect(result).to eq(password1)
       end
 
-      context "different answers" do
+      context "with different answers" do
         let(:password2) { "secret" }
 
         it "asks to continue" do
@@ -111,7 +109,7 @@ module Imap::Backup
       end
     end
 
-    context "#backup_path" do
+    describe "#backup_path" do
       let(:path) { "/path" }
       let(:answer) { path }
       let(:result) { subject.backup_path("", //) }
@@ -134,5 +132,3 @@ module Imap::Backup
     end
   end
 end
-
-# rubocop:enable Metrics/ModuleLength

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

@@ -1,5 +1,5 @@
 describe Imap::Backup::Configuration::ConnectionTester do
-  context ".test" do
+  describe ".test" do
     let(:connection) do
       instance_double(Imap::Backup::Account::Connection, imap: nil)
     end
@@ -9,7 +9,7 @@ describe Imap::Backup::Configuration::ConnectionTester do
       allow(Imap::Backup::Account::Connection).to receive(:new) { connection }
     end
 
-    context "call" do
+    describe "call" do
       before { result }
 
       it "tries to connect" do
@@ -17,7 +17,7 @@ describe Imap::Backup::Configuration::ConnectionTester do
       end
     end
 
-    context "success" do
+    describe "success" do
       before { result }
 
       it "returns success" do
@@ -25,13 +25,13 @@ describe Imap::Backup::Configuration::ConnectionTester do
       end
     end
 
-    context "failure" do
+    describe "failure" do
       before do
         allow(connection).to receive(:imap).and_raise(error)
         result
       end
 
-      context "no connection" do
+      context "with no connection" do
         let(:error) do
           data = OpenStruct.new(text: "bar")
           response = OpenStruct.new(data: data)
@@ -43,7 +43,7 @@ describe Imap::Backup::Configuration::ConnectionTester do
         end
       end
 
-      context "other" do
+      context "when caused by other errors" do
         let(:error) { "Error" }
 
         it "returns error" do

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

@@ -1,7 +1,7 @@
 describe Imap::Backup::Configuration::FolderChooser do
   include HighLineTestHelpers
 
-  context "#run" do
+  describe "#run" do
     subject { described_class.new(account) }
 
     let(:connection) do
@@ -21,7 +21,7 @@ describe Imap::Backup::Configuration::FolderChooser do
       allow(Imap::Backup.logger).to receive(:warn)
     end
 
-    context "display" do
+    describe "display" do
       before { subject.run }
 
       it "clears the screen" do
@@ -33,7 +33,7 @@ describe Imap::Backup::Configuration::FolderChooser do
       end
     end
 
-    context "folder listing" do
+    describe "folder listing" do
       let(:account) { {folders: [{name: "my_folder"}]} }
       let(:remote_folders) do
         # this one is already backed up:
@@ -46,7 +46,7 @@ describe Imap::Backup::Configuration::FolderChooser do
         [folder1, folder2]
       end
 
-      context "display" do
+      describe "display" do
         before { subject.run }
 
         it "shows folders which are being backed up" do
@@ -58,7 +58,7 @@ describe Imap::Backup::Configuration::FolderChooser do
         end
       end
 
-      context "adding folders" do
+      context "when adding folders" do
         before do
           allow(input).to receive(:gets).and_return("2\n", "q\n")
 
@@ -72,7 +72,7 @@ describe Imap::Backup::Configuration::FolderChooser do
         include_examples "it flags the account as modified"
       end
 
-      context "removing folders" do
+      context "when removing folders" do
         before do
           allow(input).to receive(:gets).and_return("1\n", "q\n")
 

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

@@ -28,7 +28,30 @@ describe Imap::Backup::Configuration::List do
       to receive(:new).with(accounts[1]) { connection2 }
   end
 
-  context "#each_connection" do
+  describe "#setup_logging" do
+    let(:config_exists) { true }
+
+    before do
+      allow(Imap::Backup::Configuration::Store).
+        to receive(:exist?) { config_exists }
+      allow(Imap::Backup).to receive(:setup_logging)
+      subject.setup_logging
+    end
+
+    it "sets global logging level" do
+      expect(Imap::Backup).to have_received(:setup_logging).with(store)
+    end
+
+    context "without a config" do
+      let(:config_exists) { false }
+
+      it "does nothing" do
+        expect(Imap::Backup).to_not have_received(:setup_logging).with(store)
+      end
+    end
+  end
+
+  describe "#each_connection" do
     specify "calls the block with each account's connection" do
       connections = []
 

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

@@ -3,7 +3,7 @@
 describe Imap::Backup::Configuration::Setup do
   include HighLineTestHelpers
 
-  context "#initialize" do
+  describe "#initialize" do
     context "without a config file" do
       it "works" do
         described_class.new
@@ -11,7 +11,7 @@ describe Imap::Backup::Configuration::Setup do
     end
   end
 
-  context "#run" do
+  describe "#run" do
     subject { described_class.new }
 
     let(:normal) { {username: "account@example.com"} }
@@ -41,7 +41,7 @@ describe Imap::Backup::Configuration::Setup do
       allow(Kernel).to receive(:system)
     end
 
-    context "main menu" do
+    describe "main menu" do
       before { subject.run }
 
       %w(add\ account save\ and\ exit exit\ without\ saving).each do |choice|
@@ -63,33 +63,53 @@ describe Imap::Backup::Configuration::Setup do
       expect(Imap::Backup).to have_received(:setup_logging)
     end
 
-    context "listing" do
+    describe "listing" do
       let(:accounts) { [normal, modified, deleted] }
       let(:modified) { {username: "modified@example.com", modified: true} }
       let(:deleted) { {username: "deleted@example.com", delete: true} }
 
       before { subject.run }
 
-      context "normal accounts" do
+      describe "normal accounts" do
         it "are listed" do
           expect(output.string).to match(/account@example.com/)
         end
       end
 
-      context "modified accounts" do
+      describe "modified accounts" do
         it "are flagged" do
           expect(output.string).to match(/modified@example.com \*/)
         end
       end
 
-      context "deleted accounts" do
+      describe "deleted accounts" do
         it "are hidden" do
           expect(output.string).to_not match(/delete@example.com/)
         end
       end
     end
 
-    context "adding accounts" do
+    context "when editing accounts" do
+      let(:account) do
+        instance_double(Imap::Backup::Configuration::Account, run: nil)
+      end
+
+      before do
+        allow(input).to receive(:gets).and_return("1\n", "exit\n")
+        allow(Imap::Backup::Configuration::Asker).to receive(:email).
+          with(no_args).and_return("new@example.com")
+        allow(Imap::Backup::Configuration::Account).to receive(:new).
+          with(store, normal, anything).and_return(account)
+
+        subject.run
+      end
+
+      it "edits the account" do
+        expect(account).to have_received(:run)
+      end
+    end
+
+    context "when adding accounts" do
       let(:blank_account) do
         {
           username: "new@example.com",
@@ -121,7 +141,7 @@ describe Imap::Backup::Configuration::Setup do
       end
     end
 
-    context "logging" do
+    describe "logging" do
       context "when debug logging is disabled" do
         before do
           allow(input).to receive(:gets).and_return("start\n", "exit\n")

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

@@ -47,7 +47,7 @@ describe Imap::Backup::Configuration::Store do
   end
 
   describe "#modified?" do
-    context "'with accounts flagged 'modified'" do
+    context "with accounts flagged 'modified'" do
       let(:accounts) { [{name: "foo", modified: true}] }
 
       it "is true" do
@@ -55,7 +55,7 @@ describe Imap::Backup::Configuration::Store do
       end
     end
 
-    context "'with accounts flagged 'delete'" do
+    context "with accounts flagged 'delete'" do
       let(:accounts) { [{name: "foo", delete: true}] }
 
       it "is true" do
@@ -139,7 +139,7 @@ describe Imap::Backup::Configuration::Store do
     before do
       allow(FileUtils).to receive(:mkdir)
       allow(FileUtils).to receive(:chmod)
-      allow(File).to receive(:open).with(file_path, "w") { |&b| b.call file }
+      allow(File).to receive(:open).with(file_path, "w").and_yield(file)
       allow(JSON).to receive(:pretty_generate).and_return("JSON output")
     end
 
@@ -194,7 +194,7 @@ describe Imap::Backup::Configuration::Store do
       end
     end
 
-    context "if the configuration file is missing" do
+    context "when the configuration file is missing" do
       let(:file_exists) { false }
 
       it "doesn't fail" do
@@ -204,7 +204,7 @@ describe Imap::Backup::Configuration::Store do
       end
     end
 
-    context "if the config file permissions are too lax" do
+    context "when the config file permissions are too lax" do
       let(:file_exists) { true }
 
       before do

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

@@ -23,23 +23,21 @@ describe Imap::Backup::Downloader do
       subject.run
     end
 
-    context "#run" do
-      context "fetched messages" do
-        it "are saved" do
-          expect(serializer).to have_received(:save).with("111", message)
-        end
+    context "with fetched messages" do
+      it "are saved" do
+        expect(serializer).to have_received(:save).with("111", message)
       end
+    end
 
-      context "messages which are already present" do
-        specify "are skipped" do
-          expect(serializer).to_not have_received(:save).with("222", anything)
-        end
+    context "with messages which are already present" do
+      specify "are skipped" do
+        expect(serializer).to_not have_received(:save).with("222", anything)
       end
+    end
 
-      context "failed fetches" do
-        specify "are skipped" do
-          expect(serializer).to_not have_received(:save).with("333", anything)
-        end
+    context "with failed fetches" do
+      specify "are skipped" do
+        expect(serializer).to_not have_received(:save).with("333", anything)
       end
     end
   end

data/spec/unit/imap/backup/serializer/mbox_enumerator_spec.rb

@@ -0,0 +1,40 @@
+require "imap/backup/serializer/mbox_enumerator"
+
+describe Imap::Backup::Serializer::MboxEnumerator do
+  subject { described_class.new(mbox_pathname) }
+
+  let(:mbox_pathname) { "/mbox/pathname" }
+  let(:mbox_file) { instance_double(File) }
+  let(:lines) { message1 + message2 + [nil] }
+  let(:message1) do
+    [
+      "From Frida\r\n",
+      "Hello\r\n"
+    ]
+  end
+  let(:message2) do
+    [
+      "From John\r\n",
+      "Hi\r\n"
+    ]
+  end
+
+  before do
+    allow(File).to receive(:open).and_call_original
+    allow(File).to receive(:open).with(mbox_pathname).and_yield(mbox_file)
+    allow(mbox_file).to receive(:gets).and_return(*lines)
+  end
+
+  describe "#each" do
+    it "yields messages" do
+      expect { |b| subject.each(&b) }.
+        to yield_successive_args(message1.join, message2.join)
+    end
+
+    context "without a block" do
+      it "returns an Enumerator" do
+        expect(subject.each).to be_a(Enumerator)
+      end
+    end
+  end
+end

data/spec/unit/imap/backup/serializer/mbox_spec.rb

@@ -9,7 +9,8 @@ describe Imap::Backup::Serializer::Mbox do
       rename: nil,
       uids: nil,
       uid_validity: existing_uid_validity,
-      "uid_validity=": nil
+      "uid_validity=": nil,
+      update_uid: nil
     )
   end
   let(:imap_folder) { "folder" }
@@ -26,10 +27,10 @@ describe Imap::Backup::Serializer::Mbox do
     allow(Imap::Backup::Serializer::MboxStore).to receive(:new) { store }
   end
 
-  context "containing directory" do
+  describe "folder path" do
     before { subject.uids }
 
-    context "when the IMAP folder has multiple elements" do
+    context "when it has multiple elements" do
       let(:imap_folder) { "folder/path" }
 
       context "when the containing directory is missing" do
@@ -42,7 +43,7 @@ describe Imap::Backup::Serializer::Mbox do
       end
     end
 
-    context "when the containing directory permissons are incorrect" do
+    context "when permissions are incorrect" do
       let(:permissions) { 0o777 }
 
       it "corrects them" do
@@ -51,13 +52,13 @@ describe Imap::Backup::Serializer::Mbox do
       end
     end
 
-    context "when the containing directory permissons are correct" do
+    context "when permissons are correct" do
       it "does nothing" do
         expect(FileUtils).to_not have_received(:chmod)
       end
     end
 
-    context "when the containing directory exists" do
+    context "when it exists" do
       it "is not created" do
         expect(Imap::Backup::Utils).to_not have_received(:make_folder).
           with(base_path, File.dirname(imap_folder), 0o700)
@@ -65,24 +66,8 @@ describe Imap::Backup::Serializer::Mbox do
     end
   end
 
-  context "#uids" do
-    it "calls the store" do
-      subject.uids
-
-      expect(store).to have_received(:uids)
-    end
-  end
-
-  context "#save" do
-    it "calls the store" do
-      subject.save("foo", "bar")
-
-      expect(store).to have_received(:add)
-    end
-  end
-
-  context "#set_uid_validity" do
-    let(:result) { subject.set_uid_validity("aaa") }
+  describe "#apply_uid_validity" do
+    let(:result) { subject.apply_uid_validity("aaa") }
 
     context "when the existing uid validity is unset" do
       let!(:result) { super() }
@@ -158,4 +143,58 @@ describe Imap::Backup::Serializer::Mbox do
       end
     end
   end
+
+  describe "#force_uid_validity" do
+    before { subject.force_uid_validity("66") }
+
+    it "sets the uid_validity" do
+      expect(store).to have_received(:uid_validity=).with("66")
+    end
+  end
+
+  describe "#uids" do
+    it "calls the store" do
+      subject.uids
+
+      expect(store).to have_received(:uids)
+    end
+  end
+
+  describe "#load" do
+    let(:result) { subject.load("66") }
+
+    before { allow(store).to receive(:load).with("66") { "xxx" } }
+
+    it "returns the value loaded by the store" do
+      expect(result).to eq("xxx")
+    end
+  end
+
+  describe "#save" do
+    before { subject.save("foo", "bar") }
+
+    it "calls the store" do
+      expect(store).to have_received(:add).with("foo", "bar")
+    end
+  end
+
+  describe "#rename" do
+    before { subject.rename("foo") }
+
+    it "calls the store" do
+      expect(store).to have_received(:rename).with("foo")
+    end
+
+    it "updates the folder name" do
+      expect(subject.folder).to eq("foo")
+    end
+  end
+
+  describe "#update_uid" do
+    before { subject.update_uid("foo", "bar") }
+
+    it "calls the store" do
+      expect(store).to have_received(:update_uid).with("foo", "bar")
+    end
+  end
 end