imap-backup 2.0.0 → 2.1.0

data/spec/unit/email/provider_spec.rb

@@ -1,5 +1,3 @@
-require "spec_helper"
-
 describe Email::Provider do
   describe ".for_address" do
     context "known providers" do

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

@@ -1,5 +1,3 @@
-require "spec_helper"
-
 describe Imap::Backup::Account::Connection do
   def self.backup_folder
     "backup_folder"
@@ -9,6 +7,8 @@ describe Imap::Backup::Account::Connection do
     {name: backup_folder}
   end
 
+  subject { described_class.new(options) }
+
   let(:imap) do
     instance_double(Net::IMAP, login: nil, disconnect: nil)
   end
@@ -18,7 +18,7 @@ describe Imap::Backup::Account::Connection do
       username: username,
       password: "password",
       local_path: local_path,
-      folders: backup_folders,
+      folders: backup_folders
     }
   end
   let(:local_path) { "local_path" }
@@ -48,8 +48,6 @@ describe Imap::Backup::Account::Connection do
     allow(Imap::Backup::Utils).to receive(:make_folder)
   end
 
-  subject { described_class.new(options) }
-
   shared_examples "connects to IMAP" do
     it "sets up the IMAP connection" do
       expect(Net::IMAP).to have_received(:new)
@@ -78,10 +76,10 @@ describe Imap::Backup::Account::Connection do
   end
 
   describe "#imap" do
-    before { @result = subject.imap }
+    let!(:result) { subject.imap }
 
     it "returns the IMAP connection" do
-      expect(@result).to eq(imap)
+      expect(result).to eq(imap)
     end
 
     include_examples "connects to IMAP"
@@ -108,7 +106,7 @@ describe Imap::Backup::Account::Connection do
       allow(Imap::Backup::Serializer::Mbox).to receive(:new) { serializer }
     end
 
-    it "should return the names of folders" do
+    it "returns the names of folders" do
       expect(subject.status[0][:name]).to eq(self.class.backup_folder)
     end
 
@@ -116,7 +114,7 @@ describe Imap::Backup::Account::Connection do
       expect(subject.status[0][:local]).to eq([local_uid])
     end
 
-    it "should retrieve the available uids" do
+    it "retrieves the available uids" do
       expect(subject.status[0][:remote]).to eq([remote_uid])
     end
   end
@@ -126,9 +124,11 @@ describe Imap::Backup::Account::Connection do
       instance_double(
         Imap::Backup::Account::Folder,
         name: "folder",
+        exist?: exists,
         uid_validity: uid_validity
       )
     end
+    let(:exists) { true }
     let(:uid_validity) { 123 }
     let(:downloader) { instance_double(Imap::Backup::Downloader, run: nil) }
 
@@ -143,13 +143,20 @@ describe Imap::Backup::Account::Connection do
           with(subject, self.class.backup_folder).and_return(folder)
         allow(Imap::Backup::Serializer::Mbox).to receive(:new).
           with(local_path, self.class.backup_folder).and_return(serializer)
+        subject.run_backup
       end
 
-      before { subject.run_backup }
-
       it "runs the downloader" do
         expect(downloader).to have_received(:run)
       end
+
+      context "when a folder does not exist" do
+        let(:exists) { false }
+
+        it "does not run the downloader" do
+          expect(downloader).to_not have_received(:run)
+        end
+      end
     end
 
     context "without supplied backup_folders" do

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

@@ -1,6 +1,8 @@
-require "spec_helper"
+# rubocop:disable RSpec/PredicateMatcher
 
 describe Imap::Backup::Account::Folder do
+  subject { described_class.new(connection, "my_folder") }
+
   let(:imap) do
     instance_double(
       Net::IMAP,
@@ -10,21 +12,19 @@ describe Imap::Backup::Account::Folder do
       responses: responses
     )
   end
-  let(:connection) { double("Imap::Backup::Account::Connection", imap: imap) }
-  let(:missing_mailbox_data) do
-    double("Data", text: "Unknown Mailbox: my_folder")
+  let(:connection) do
+    instance_double(Imap::Backup::Account::Connection, imap: imap)
   end
-  let(:missing_mailbox_response) do
-    double("Response", data: missing_mailbox_data)
+  let(:missing_mailbox_data) do
+    OpenStruct.new(text: "Unknown Mailbox: my_folder")
   end
+  let(:missing_mailbox_response) { OpenStruct.new(data: missing_mailbox_data) }
   let(:missing_mailbox_error) do
     Net::IMAP::NoResponseError.new(missing_mailbox_response)
   end
   let(:responses) { [] }
   let(:append_response) { nil }
 
-  subject { described_class.new(connection, "my_folder") }
-
   context "#uids" do
     let(:uids) { [5678, 123] }
 
@@ -46,7 +46,7 @@ describe Imap::Backup::Account::Folder do
   end
 
   context "#fetch" do
-    let(:message_body) { double("the body", force_encoding: nil) }
+    let(:message_body) { instance_double(String, force_encoding: nil) }
     let(:attributes) { {"RFC822" => message_body, "other" => "xxx"} }
     let(:fetch_data_item) do
       instance_double(Net::IMAP::FetchData, attr: attributes)
@@ -134,6 +134,18 @@ describe Imap::Backup::Account::Folder do
     it "is returned" do
       expect(subject.uid_validity).to eq("uid validity")
     end
+
+    context "when the folder doesn't exist" do
+      before do
+        allow(imap).to receive(:examine).and_raise(missing_mailbox_error)
+      end
+
+      it "raises an error" do
+        expect do
+          subject.uid_validity
+        end.to raise_error(Imap::Backup::FolderNotFound)
+      end
+    end
   end
 
   context "#append" do
@@ -144,12 +156,12 @@ describe Imap::Backup::Account::Folder do
         date: Time.now
       )
     end
-    let(:append_response) { "response" }
+    let(:append_response) do
+      OpenStruct.new(data: OpenStruct.new(code: OpenStruct.new(data: "1 2")))
+    end
     let(:result) { subject.append(message) }
 
     before do
-      allow(append_response).
-        to receive_message_chain("data.code.data") { "1 2" }
       result
     end
 
@@ -166,3 +178,5 @@ describe Imap::Backup::Account::Folder do
     end
   end
 end
+
+# rubocop:enable RSpec/PredicateMatcher

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

@@ -1,4 +1,4 @@
-require "spec_helper"
+# rubocop:disable RSpec/NestedGroups
 
 describe Imap::Backup::Configuration::Account do
   class MockHighlineMenu
@@ -19,12 +19,12 @@ describe Imap::Backup::Configuration::Account do
   end
 
   context "#initialize" do
+    subject { described_class.new(store, account, highline) }
+
     let(:store) { "store" }
     let(:account) { "account" }
     let(:highline) { "highline" }
 
-    subject { described_class.new(store, account, highline) }
-
     [:store, :account, :highline].each do |param|
       it "expects #{param}" do
         expect(subject.send(param)).to eq(send(param))
@@ -33,10 +33,12 @@ describe Imap::Backup::Configuration::Account do
   end
 
   context "#run" do
-    let(:highline) { double("Highline") }
+    subject { described_class.new(store, account, highline) }
+
+    let(:highline) { instance_double(HighLine) }
     let(:menu) { MockHighlineMenu.new }
     let(:store) do
-      double("Imap::Backup::Configuration::Store", accounts: accounts)
+      instance_double(Imap::Backup::Configuration::Store, accounts: accounts)
     end
     let(:accounts) { [account, account1] }
     let(:account) do
@@ -45,13 +47,13 @@ describe Imap::Backup::Configuration::Account do
         server: existing_server,
         local_path: "/backup/path",
         folders: [{name: "my_folder"}],
-        password: existing_password,
+        password: existing_password
       }
     end
     let(:account1) do
       {
         username: other_email,
-        local_path: other_existing_path,
+        local_path: other_existing_path
       }
     end
     let(:existing_email) { "user@example.com" }
@@ -62,21 +64,19 @@ describe Imap::Backup::Configuration::Account do
     let(:other_existing_path) { "/other/existing/path" }
 
     before do
-      allow(subject).to receive(:system).and_return(nil)
-      allow(subject).to receive(:puts).and_return(nil)
+      allow(Kernel).to receive(:system)
+      allow(Kernel).to receive(:puts)
       allow(highline).to receive(:choose) do |&block|
         block.call(menu)
         throw :done
       end
     end
 
-    subject { described_class.new(store, account, highline) }
-
     context "preparation" do
       before { subject.run }
 
       it "clears the screen" do
-        expect(subject).to have_received(:system).with("clear")
+        expect(Kernel).to have_received(:system).with("clear")
       end
 
       context "menu" do
@@ -96,7 +96,7 @@ describe Imap::Backup::Configuration::Account do
         "test connection",
         "delete",
         "return to main menu",
-        "quit", # TODO: quit is hidden
+        "quit" # TODO: quit is hidden
       ].each do |item|
         before { subject.run }
 
@@ -180,7 +180,7 @@ describe Imap::Backup::Configuration::Account do
         let(:new_email) { other_email }
 
         it "indicates the error" do
-          expect(subject).to have_received(:puts).
+          expect(Kernel).to have_received(:puts).
             with("There is already an account set up with that email address")
         end
 
@@ -226,9 +226,6 @@ describe Imap::Backup::Configuration::Account do
 
       before do
         allow(highline).to receive(:ask).with("server: ").and_return(server)
-      end
-
-      before do
         subject.run
         menu.choices["modify server"].call
       end
@@ -247,7 +244,7 @@ describe Imap::Backup::Configuration::Account do
         @validator = nil
         allow(
           Imap::Backup::Configuration::Asker
-        ).to receive(:backup_path) do |path, validator|
+        ).to receive(:backup_path) do |_path, validator|
           @validator = validator
           new_backup_path
         end
@@ -260,14 +257,18 @@ describe Imap::Backup::Configuration::Account do
       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
       end
 
       include_examples "it flags the account as modified"
     end
 
     context "folders" do
-      let(:chooser) { double(run: nil) }
+      let(:chooser) do
+        instance_double(Imap::Backup::Configuration::FolderChooser, run: nil)
+      end
 
       before do
         allow(Imap::Backup::Configuration::FolderChooser).
@@ -323,3 +324,5 @@ describe Imap::Backup::Configuration::Account do
     end
   end
 end
+
+# rubocop:enable RSpec/NestedGroups

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

@@ -1,34 +1,34 @@
-require "spec_helper"
+# rubocop:disable Metrics/ModuleLength
 
 module Imap::Backup
   describe Configuration::Asker do
+    subject { described_class.new(highline) }
+
     let(:highline) { double }
     let(:query) do
-      double(
-        "Query",
-        :default= => nil,
-        :readline= => nil,
-        :validate= => nil,
-        :responses => {},
-        :echo= => nil
+      instance_double(
+        HighLine::Question,
+        "default=": nil,
+        "readline=": nil,
+        "validate=": nil,
+        "responses": {},
+        "echo=": nil
       )
     end
     let(:answer) { "foo" }
 
     before do
-      allow(Configuration::Setup).to receive(:highline).and_return(highline)
+      allow(Configuration::Setup).to receive(:highline) { highline }
       allow(highline).to receive(:ask) do |&b|
         b.call query
         answer
       end
     end
 
-    subject { described_class.new(highline) }
-
     [
       [:email, [], "email address"],
       [:password, [], "password"],
-      [:backup_path, ["x", "y"], "backup directory"]
+      [:backup_path, %w(x y), "backup directory"]
     ].each do |method, params, prompt|
       context ".#{method}" do
         it "asks for input" do
@@ -58,39 +58,35 @@ module Imap::Backup
     context "#email" do
       let(:email) { "email@example.com" }
       let(:answer) { email }
+      let(:result) { subject.email }
 
-      before do
-        @result = subject.email
-      end
+      before { result }
 
       it "asks for an email" do
         expect(highline).to have_received(:ask).with(/email/)
       end
 
       it "returns the address" do
-        expect(@result).to eq(email)
+        expect(result).to eq(email)
       end
     end
 
     context "#password" do
       let(:password1) { "password" }
       let(:password2) { "password" }
-      let(:answers) { [answer1, answer2] }
-      let(:answer1) { true }
-      let(:answer2) { false }
+      let(:answers) { [true, false] }
+      let(:result) { subject.password }
 
       before do
-        @i = 0
-        allow(highline).to receive(:ask).
-          with("password: ").and_return(password1)
-        allow(highline).to receive(:ask).
-          with("repeat password: ").and_return(password2)
+        i = 0
+        allow(highline).to receive(:ask).with("password: ") { password1 }
+        allow(highline).to receive(:ask).with("repeat password: ") { password2 }
         allow(highline).to receive(:agree) do
-          answer = answers[@i]
-          @i += 1
+          answer = answers[i]
+          i += 1
           answer
         end
-        @result = subject.password
+        result
       end
 
       it "asks for a password" do
@@ -102,7 +98,7 @@ module Imap::Backup
       end
 
       it "returns the password" do
-        expect(@result).to eq(password1)
+        expect(result).to eq(password1)
       end
 
       context "different answers" do
@@ -110,7 +106,7 @@ module Imap::Backup
 
         it "asks to continue" do
           expect(highline).to have_received(:agree).
-            at_least(1).times.with(/Continue\?/)
+            at_least(:once).with(/Continue\?/)
         end
       end
     end
@@ -118,13 +114,14 @@ module Imap::Backup
     context "#backup_path" do
       let(:path) { "/path" }
       let(:answer) { path }
+      let(:result) { subject.backup_path("", //) }
 
       before do
         allow(highline).to receive(:ask) do |&b|
           b.call query
           path
         end
-        @result = subject.backup_path("", //)
+        result
       end
 
       it "asks for a directory" do
@@ -132,8 +129,10 @@ module Imap::Backup
       end
 
       it "returns the path" do
-        expect(@result).to eq(path)
+        expect(result).to eq(path)
       end
     end
   end
 end
+
+# rubocop:enable Metrics/ModuleLength