imap-backup 4.0.4 → 4.1.1

data/spec/unit/imap/backup/{configuration/setup_spec.rb → setup_spec.rb}

@@ -1,23 +1,46 @@
-describe Imap::Backup::Configuration::Setup do
+describe Imap::Backup::Setup do
   include HighLineTestHelpers
 
   subject { described_class.new }
 
-  let(:normal) { {username: "account@example.com"} }
-  let(:accounts) { [normal] }
+  let(:normal_account) do
+    instance_double(
+      Imap::Backup::Account,
+      username: "account@example.com",
+      marked_for_deletion?: false,
+      modified?: false
+    )
+  end
+  let(:modified_account) do
+    instance_double(
+      Imap::Backup::Account,
+      username: "modified@example.com",
+      marked_for_deletion?: false,
+      modified?: true
+    )
+  end
+  let(:deleted_account) do
+    instance_double(
+      Imap::Backup::Account,
+      username: "delete@example.com",
+      marked_for_deletion?: true,
+      modified?: false
+    )
+  end
+  let(:accounts) { [normal_account] }
   let(:store) do
     instance_double(
-      Imap::Backup::Configuration::Store,
+      Imap::Backup::Configuration,
       "accounts": accounts,
       "path": "/base/path",
       "save": nil,
       "debug?": debug,
       "debug=": nil,
-      "modified?": modified
+      "modified?": config_modified
     )
   end
   let(:debug) { false }
-  let(:modified) { false }
+  let(:config_modified) { false }
   let!(:highline_streams) { prepare_highline }
   let(:input) { highline_streams[0] }
   let(:output) { highline_streams[1] }
@@ -33,39 +56,48 @@ describe Imap::Backup::Configuration::Setup do
 
   describe "#run" do
     before do
-      allow(Imap::Backup::Configuration::Store).to receive(:new) { store }
-      allow(Imap::Backup).to receive(:setup_logging)
+      allow(Imap::Backup::Configuration).to receive(:new) { store }
+      allow(Imap::Backup::Logger).to receive(:setup_logging)
       allow(input).to receive(:eof?) { false }
-      allow(input).to receive(:gets) { "exit\n" }
+      allow(input).to receive(:gets) { "q\n" }
       allow(Kernel).to receive(:system)
     end
 
     describe "main menu" do
-      before { subject.run }
+      context "when changes have not been made" do
+        before { subject.run }
 
-      ["add account", "save and exit", "exit without saving"].each do |choice|
-        it "includes #{choice}" do
-          expect(output.string).to include(choice)
+        ["add account", "quit"].each do |choice|
+          it "includes #{choice}" do
+            expect(output.string).to include(choice)
+          end
         end
       end
-    end
 
-    it "clears the screen" do
-      expect(Kernel).to receive(:system).with("clear")
+      context "when changes have been made" do
+        let(:config_modified) { true }
 
-      subject.run
+        before do
+          allow(input).to receive(:gets) { "exit\n" }
+          subject.run
+        end
+
+        ["save and exit", "exit without saving"].each do |choice|
+          it "includes '#{choice}'" do
+            expect(output.string).to include(choice)
+          end
+        end
+      end
     end
 
-    it "updates logging status" do
-      expect(Imap::Backup).to receive(:setup_logging)
+    it "clears the screen" do
+      expect(Kernel).to receive(:system).with("clear")
 
       subject.run
     end
 
     describe "listing" do
-      let(:accounts) { [normal, modified, deleted] }
-      let(:modified) { {username: "modified@example.com", modified: true} }
-      let(:deleted) { {username: "deleted@example.com", delete: true} }
+      let(:accounts) { [normal_account, modified_account, deleted_account] }
 
       before { subject.run }
 
@@ -90,15 +122,16 @@ describe Imap::Backup::Configuration::Setup do
 
     context "when editing accounts" do
       let(:account) do
-        instance_double(Imap::Backup::Configuration::Account, run: nil)
+        instance_double(Imap::Backup::Setup::Account, run: nil)
       end
+      let(:config_modified) { true }
 
       before do
         allow(input).to receive(:gets).and_return("1\n", "exit\n")
-        allow(Imap::Backup::Configuration::Asker).to receive(:email).
+        allow(Imap::Backup::Setup::Asker).to receive(:email).
           with(no_args) { "new@example.com" }
-        allow(Imap::Backup::Configuration::Account).to receive(:new).
-          with(store, normal, anything) { account }
+        allow(Imap::Backup::Setup::Account).to receive(:new).
+          with(store, normal_account, anything) { account }
       end
 
       it "edits the account" do
@@ -118,35 +151,36 @@ describe Imap::Backup::Configuration::Setup do
         }
       end
       let(:account) do
-        instance_double(Imap::Backup::Configuration::Account, run: nil)
+        instance_double(Imap::Backup::Setup::Account, run: nil)
       end
+      let(:config_modified) { true }
       let(:added_email) { "new@example.com" }
       let(:local_path) { "/base/path/new_example.com" }
 
       before do
         allow(input).to receive(:gets).and_return("add\n", "exit\n")
-        allow(Imap::Backup::Configuration::Asker).to receive(:email).
+        allow(Imap::Backup::Setup::Asker).to receive(:email).
           with(no_args) { added_email }
-        allow(Imap::Backup::Configuration::Account).to receive(:new).
+        allow(Imap::Backup::Setup::Account).to receive(:new).
           with(store, anything, anything) { account }
 
         subject.run
       end
 
       it "sets username" do
-        expect(accounts[1][:username]).to eq(added_email)
+        expect(accounts[1].username).to eq(added_email)
       end
 
       it "sets blank password" do
-        expect(accounts[1][:password]).to eq("")
+        expect(accounts[1].password).to eq("")
       end
 
       it "sets local_path" do
-        expect(accounts[1][:local_path]).to eq(local_path)
+        expect(accounts[1].local_path).to eq(local_path)
       end
 
       it "sets folders" do
-        expect(accounts[1][:folders]).to eq([])
+        expect(accounts[1].folders).to eq([])
       end
 
       context "when the account is a GMail account" do
@@ -154,17 +188,19 @@ describe Imap::Backup::Configuration::Setup do
         let(:local_path) { "/base/path/new_gmail.com" }
 
         it "sets the server" do
-          expect(accounts[1][:server]).to eq(gmail_imap_server)
+          expect(accounts[1].server).to eq(gmail_imap_server)
         end
       end
 
       it "doesn't flag the unedited account as modified" do
-        expect(accounts[1][:modified]).to be_nil
+        expect(accounts[1].modified?).to be_falsey
       end
     end
 
     describe "logging" do
       context "when debug logging is disabled" do
+        let(:config_modified) { true }
+
         before do
           allow(input).to receive(:gets).and_return("start\n", "exit\n")
         end
@@ -183,7 +219,7 @@ describe Imap::Backup::Configuration::Setup do
           end
 
           it "updates logging status" do
-            expect(Imap::Backup).to receive(:setup_logging).twice
+            expect(Imap::Backup::Logger).to receive(:setup_logging)
 
             subject.run
           end
@@ -192,6 +228,7 @@ describe Imap::Backup::Configuration::Setup do
 
       context "when debug logging is enabled" do
         let(:debug) { true }
+        let(:config_modified) { true }
 
         before do
           allow(input).to receive(:gets).and_return("stop\n", "exit\n")
@@ -215,7 +252,7 @@ describe Imap::Backup::Configuration::Setup do
           end
 
           it "updates logging status" do
-            expect(Imap::Backup).to receive(:setup_logging).twice
+            expect(Imap::Backup::Logger).to receive(:setup_logging)
 
             subject.run
           end
@@ -224,6 +261,8 @@ describe Imap::Backup::Configuration::Setup do
     end
 
     context "when 'save' is selected" do
+      let(:config_modified) { true }
+
       before do
         allow(input).to receive(:gets) { "save\n" }
       end
@@ -241,6 +280,8 @@ describe Imap::Backup::Configuration::Setup do
     end
 
     context "when 'exit without saving' is selected" do
+      let(:config_modified) { true }
+
       before do
         allow(input).to receive(:gets) { "exit\n" }
       end
@@ -250,22 +291,10 @@ describe Imap::Backup::Configuration::Setup do
         subject.run
       end
 
-      context "when the configuration is modified" do
-        let(:modified) { true }
+      it "doesn't save the configuration" do
+        expect(store).to_not receive(:save)
 
-        it "doesn't save the configuration" do
-          expect(store).to_not receive(:save)
-
-          subject.run
-        end
-      end
-
-      context "when the configuration isn't modified" do
-        it "doesn't save the configuration" do
-          expect(store).to_not receive(:save)
-
-          subject.run
-        end
+        subject.run
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 4.0.4
+  version: 4.1.1
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -182,13 +182,16 @@ files:
 - lib/email/mboxrd/message.rb
 - lib/email/provider.rb
 - lib/email/provider/apple_mail.rb
-- lib/email/provider/default.rb
+- lib/email/provider/base.rb
 - lib/email/provider/fastmail.rb
 - lib/email/provider/gmail.rb
+- lib/email/provider/unknown.rb
 - lib/imap/backup.rb
+- lib/imap/backup/account.rb
 - lib/imap/backup/account/connection.rb
 - lib/imap/backup/account/folder.rb
 - lib/imap/backup/cli.rb
+- lib/imap/backup/cli/accounts.rb
 - lib/imap/backup/cli/backup.rb
 - lib/imap/backup/cli/folders.rb
 - lib/imap/backup/cli/helpers.rb
@@ -199,18 +202,20 @@ files:
 - lib/imap/backup/cli/utils.rb
 - lib/imap/backup/client/apple_mail.rb
 - lib/imap/backup/client/default.rb
-- lib/imap/backup/configuration/account.rb
-- lib/imap/backup/configuration/asker.rb
-- lib/imap/backup/configuration/connection_tester.rb
-- lib/imap/backup/configuration/folder_chooser.rb
-- lib/imap/backup/configuration/list.rb
-- lib/imap/backup/configuration/setup.rb
-- lib/imap/backup/configuration/store.rb
+- lib/imap/backup/configuration.rb
 - lib/imap/backup/downloader.rb
+- lib/imap/backup/logger.rb
+- lib/imap/backup/sanitizer.rb
 - lib/imap/backup/serializer.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
+- lib/imap/backup/setup/connection_tester.rb
+- lib/imap/backup/setup/folder_chooser.rb
+- lib/imap/backup/setup/helpers.rb
 - lib/imap/backup/thunderbird/mailbox_exporter.rb
 - lib/imap/backup/uploader.rb
 - lib/imap/backup/utils.rb
@@ -235,33 +240,32 @@ files:
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
 - spec/support/higline_test_helpers.rb
-- spec/support/shared_examples/account_flagging.rb
 - spec/support/silence_logging.rb
 - spec/unit/email/mboxrd/message_spec.rb
 - spec/unit/email/provider/apple_mail_spec.rb
-- spec/unit/email/provider/default_spec.rb
+- spec/unit/email/provider/base_spec.rb
 - spec/unit/email/provider/fastmail_spec.rb
 - spec/unit/email/provider/gmail_spec.rb
 - 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/cli/accounts_spec.rb
 - spec/unit/imap/backup/cli/local_spec.rb
 - spec/unit/imap/backup/cli/utils_spec.rb
 - spec/unit/imap/backup/client/default_spec.rb
-- spec/unit/imap/backup/configuration/account_spec.rb
-- spec/unit/imap/backup/configuration/asker_spec.rb
-- spec/unit/imap/backup/configuration/connection_tester_spec.rb
-- spec/unit/imap/backup/configuration/folder_chooser_spec.rb
-- spec/unit/imap/backup/configuration/list_spec.rb
-- spec/unit/imap/backup/configuration/setup_spec.rb
-- spec/unit/imap/backup/configuration/store_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/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/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_spec.rb
 - spec/unit/imap/backup/uploader_spec.rb
 - spec/unit/imap/backup/utils_spec.rb
-- spec/unit/imap/backup_spec.rb
 homepage: https://github.com/joeyates/imap-backup
 licenses:
 - MIT
@@ -281,47 +285,46 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Backup GMail (or other IMAP) accounts to disk
 test_files:
-- spec/spec_helper.rb
-- spec/fixtures/connection.yml
+- spec/features/helper.rb
+- spec/features/support/backup_directory.rb
+- spec/features/support/shared/message_fixtures.rb
+- spec/features/support/shared/connection_context.rb
+- spec/features/support/email_server.rb
+- spec/features/restore_spec.rb
+- spec/features/backup_spec.rb
+- spec/support/higline_test_helpers.rb
+- spec/support/fixtures.rb
+- spec/support/silence_logging.rb
+- spec/gather_rspec_coverage.rb
 - spec/unit/email/provider/gmail_spec.rb
-- spec/unit/email/provider/apple_mail_spec.rb
-- spec/unit/email/provider/default_spec.rb
 - spec/unit/email/provider/fastmail_spec.rb
-- spec/unit/email/provider_spec.rb
+- spec/unit/email/provider/base_spec.rb
+- spec/unit/email/provider/apple_mail_spec.rb
 - spec/unit/email/mboxrd/message_spec.rb
-- spec/unit/imap/backup_spec.rb
+- spec/unit/email/provider_spec.rb
 - spec/unit/imap/backup/cli/utils_spec.rb
+- spec/unit/imap/backup/cli/accounts_spec.rb
 - spec/unit/imap/backup/cli/local_spec.rb
+- spec/unit/imap/backup/setup/account_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/asker_spec.rb
+- spec/unit/imap/backup/uploader_spec.rb
 - spec/unit/imap/backup/utils_spec.rb
-- spec/unit/imap/backup/client/default_spec.rb
+- spec/unit/imap/backup/configuration_spec.rb
+- spec/unit/imap/backup/setup_spec.rb
+- spec/unit/imap/backup/logger_spec.rb
+- spec/unit/imap/backup/serializer/mbox_store_spec.rb
+- spec/unit/imap/backup/serializer/mbox_enumerator_spec.rb
+- spec/unit/imap/backup/serializer/mbox_spec.rb
 - spec/unit/imap/backup/downloader_spec.rb
-- spec/unit/imap/backup/configuration/store_spec.rb
-- spec/unit/imap/backup/configuration/connection_tester_spec.rb
-- spec/unit/imap/backup/configuration/asker_spec.rb
-- spec/unit/imap/backup/configuration/setup_spec.rb
-- spec/unit/imap/backup/configuration/folder_chooser_spec.rb
-- spec/unit/imap/backup/configuration/account_spec.rb
-- spec/unit/imap/backup/configuration/list_spec.rb
 - spec/unit/imap/backup/account/folder_spec.rb
 - spec/unit/imap/backup/account/connection_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/uploader_spec.rb
-- spec/support/fixtures.rb
-- spec/support/shared_examples/account_flagging.rb
-- spec/support/higline_test_helpers.rb
-- spec/support/silence_logging.rb
-- spec/gather_rspec_coverage.rb
-- spec/features/backup_spec.rb
-- spec/features/helper.rb
-- spec/features/support/backup_directory.rb
-- spec/features/support/shared/message_fixtures.rb
-- spec/features/support/shared/connection_context.rb
-- spec/features/support/email_server.rb
-- spec/features/restore_spec.rb
+- spec/unit/imap/backup/client/default_spec.rb
+- spec/spec_helper.rb
+- spec/fixtures/connection.yml

data/lib/imap/backup/configuration/account.rb

@@ -1,159 +0,0 @@
-module Imap::Backup
-  module Configuration; end
-
-  Configuration::Account = Struct.new(:store, :account, :highline) do
-    def initialize(store, account, highline)
-      super
-    end
-
-    def run
-      catch :done do
-        loop do
-          Kernel.system("clear")
-          create_menu
-        end
-      end
-    end
-
-    private
-
-    def create_menu
-      highline.choose do |menu|
-        header menu
-        modify_email menu
-        modify_password menu
-        modify_server menu
-        modify_backup_path menu
-        choose_folders menu
-        test_connection menu
-        delete_account menu
-        menu.choice("return to main menu") { throw :done }
-        menu.hidden("quit") { throw :done }
-      end
-    end
-
-    def header(menu)
-      menu.header = <<-HEADER.gsub(/^\s{8}/m, "")
-        Account:
-          email:    #{account[:username]}
-          server:   #{account[:server]}
-          path:     #{account[:local_path]}
-          folders:  #{folders.map { |f| f[:name] }.join(', ')}
-          password: #{masked_password}
-      HEADER
-    end
-
-    def modify_email(menu)
-      menu.choice("modify email") do
-        username = Configuration::Asker.email(username)
-        Kernel.puts "username: #{username}"
-        other_accounts = store.accounts.reject { |a| a == account }
-        others = other_accounts.map { |a| a[:username] }
-        Kernel.puts "others: #{others.inspect}"
-        if others.include?(username)
-          Kernel.puts(
-            "There is already an account set up with that email address"
-          )
-        else
-          account[:username] = username
-          # rubocop:disable Style/IfUnlessModifier
-          if account[:server].nil? || (account[:server] == "")
-            account[:server] = default_server(username)
-          end
-          # rubocop:enable Style/IfUnlessModifier
-          account[:modified] = true
-        end
-      end
-    end
-
-    def modify_password(menu)
-      menu.choice("modify password") do
-        password = Configuration::Asker.password
-
-        if !password.nil?
-          account[:password] = password
-          account[:modified] = true
-        end
-      end
-    end
-
-    def modify_server(menu)
-      menu.choice("modify server") do
-        server = highline.ask("server: ")
-        if !server.nil?
-          account[:server] = server
-          account[:modified] = true
-        end
-      end
-    end
-
-    def path_modification_validator(path)
-      same = store.accounts.find do |a|
-        a[:username] != account[:username] && a[:local_path] == path
-      end
-      if same
-        Kernel.puts "The path '#{path}' is used to backup " \
-          "the account '#{same[:username]}'"
-        false
-      else
-        true
-      end
-    end
-
-    def modify_backup_path(menu)
-      menu.choice("modify backup path") do
-        existing = account[:local_path].clone
-        account[:local_path] = Configuration::Asker.backup_path(
-          account[:local_path], ->(path) { path_modification_validator(path) }
-        )
-        account[:modified] = true if existing != account[:local_path]
-      end
-    end
-
-    def choose_folders(menu)
-      menu.choice("choose backup folders") do
-        Configuration::FolderChooser.new(account).run
-      end
-    end
-
-    def test_connection(menu)
-      menu.choice("test connection") do
-        result = Configuration::ConnectionTester.test(account)
-        Kernel.puts result
-        highline.ask "Press a key "
-      end
-    end
-
-    def delete_account(menu)
-      menu.choice("delete") do
-        if highline.agree("Are you sure? (y/n) ")
-          account[:delete] = true
-          throw :done
-        end
-      end
-    end
-
-    def folders
-      account[:folders] || []
-    end
-
-    def masked_password
-      if (account[:password] == "") || account[:password].nil?
-        "(unset)"
-      else
-        account[:password].gsub(/./, "x")
-      end
-    end
-
-    def default_server(username)
-      provider = Email::Provider.for_address(username)
-
-      if provider.is_a?(Email::Provider::Default)
-        Kernel.puts "Can't decide provider for email address '#{username}'"
-        return nil
-      end
-
-      provider.host
-    end
-  end
-end

data/lib/imap/backup/configuration/connection_tester.rb

@@ -1,14 +0,0 @@
-module Imap::Backup
-  module Configuration; end
-
-  module Configuration::ConnectionTester
-    def self.test(account)
-      Account::Connection.new(account).client
-      "Connection successful"
-    rescue Net::IMAP::NoResponseError
-      "No response"
-    rescue StandardError => e
-      "Unexpected error: #{e}"
-    end
-  end
-end

data/lib/imap/backup/configuration/list.rb

@@ -1,53 +0,0 @@
-module Imap::Backup
-  module Configuration; end
-
-  class Configuration::List
-    attr_reader :required_accounts
-
-    def initialize(required_accounts = [])
-      @required_accounts = required_accounts
-    end
-
-    def setup_logging
-      return if !config_exists?
-
-      Imap::Backup.setup_logging config
-      Net::IMAP.debug = config.debug?
-    end
-
-    def each_connection
-      accounts.each do |account|
-        connection = Account::Connection.new(account)
-        yield connection
-        connection.disconnect
-      end
-    end
-
-    def accounts
-      @accounts ||=
-        if required_accounts.empty?
-          config.accounts
-        else
-          config.accounts.select do |account|
-            required_accounts.include?(account[:username])
-          end
-        end
-    end
-
-    private
-
-    def config
-      return @config if @config
-
-      if !config_exists?
-        path = Configuration::Store.default_pathname
-        raise ConfigurationNotFound, "Configuration file '#{path}' not found"
-      end
-      @config = Configuration::Store.new
-    end
-
-    def config_exists?
-      Configuration::Store.exist?
-    end
-  end
-end