imap-backup 4.0.5 → 4.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6eebcf60acbb2e97a007e5da03c63fb7c32e24413397f28d3ec9f94154b8def5
-  data.tar.gz: 5f81961b55811c8c9fadabf2def11e1e00ab8572fd844f44b8fda371aa190bbb
+  metadata.gz: 7b543b8f8b913b95b68c9ad9532143c375d90b468b0977982faa3522c0d3932b
+  data.tar.gz: '0939b42c8dad41d14212a18444d94c209ce025646683faded89b9808e6181416'
 SHA512:
-  metadata.gz: 6ebb0d93413c0911487235584837f76f6409d66cc06a64ad9e7db7ec0a4ccca2694b9be363e02922bbf1c981d944a9772e6705190ad92b461252d7b57bf1e4b0
-  data.tar.gz: 6f29640122bf11c098050476e60caa073ebb868a0859624d6e7b74df435e85a1d6ebbcf964840058c6978a42d16034d86341741caead66d99722554ffc2ca4a3
+  metadata.gz: 52f9058554faa9a3d31bef3cb7254408032cdddee98293ea5f7c8ef108d3187b564b7fd71a18bdb1b31829b46ed22bdd51626704f82e98d88076bd4cec887d44
+  data.tar.gz: 186036e2f11ed8e0ae578ab44d73b2b4c1f89bf9c65eedc66a143b4d1b861adacba1d954190d566c399cc79184ba3645ebb53a3341ee82a03ad9b5d5d7fa777d

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

@@ -4,25 +4,17 @@ require "imap/backup/client/default"
 require "retry_on_error"
 
 module Imap::Backup
-  module Account; end
+  class Account; end
 
   class Account::Connection
     include RetryOnError
 
     LOGIN_RETRY_CLASSES = [EOFError, Errno::ECONNRESET, SocketError].freeze
 
-    attr_reader :connection_options
-    attr_reader :local_path
-    attr_reader :password
-    attr_reader :username
-
-    def initialize(options)
-      @username = options[:username]
-      @password = options[:password]
-      @local_path = options[:local_path]
-      @config_folders = options[:folders]
-      @server = options[:server]
-      @connection_options = options[:connection_options] || {}
+    attr_reader :account
+
+    def initialize(account)
+      @account = account
       @folders = nil
       create_account_folder
     end
@@ -33,7 +25,7 @@ module Imap::Backup
           folders = client.list
 
           if folders.empty?
-            message = "Unable to get folder list for account #{username}"
+            message = "Unable to get folder list for account #{account.username}"
             Imap::Backup.logger.info message
             raise message
           end
@@ -45,13 +37,13 @@ module Imap::Backup
     def status
       backup_folders.map do |backup_folder|
         f = Account::Folder.new(self, backup_folder[:name])
-        s = Serializer::Mbox.new(local_path, backup_folder[:name])
+        s = Serializer::Mbox.new(account.local_path, backup_folder[:name])
         {name: backup_folder[:name], local: s.uids, remote: f.uids}
       end
     end
 
     def run_backup
-      Imap::Backup.logger.debug "Running backup of account: #{username}"
+      Imap::Backup.logger.debug "Running backup of account: #{account.username}"
       # start the connection so we get logging messages in the right order
       client
       each_folder do |folder, serializer|
@@ -71,11 +63,11 @@ module Imap::Backup
     def local_folders
       return enum_for(:local_folders) if !block_given?
 
-      glob = File.join(local_path, "**", "*.imap")
-      base = Pathname.new(local_path)
+      glob = File.join(account.local_path, "**", "*.imap")
+      base = Pathname.new(account.local_path)
       Pathname.glob(glob) do |path|
         name = path.relative_path_from(base).to_s[0..-6]
-        serializer = Serializer::Mbox.new(local_path, name)
+        serializer = Serializer::Mbox.new(account.local_path, name)
         folder = Account::Folder.new(self, name)
         yield serializer, folder
       end
@@ -109,15 +101,15 @@ module Imap::Backup
             else
               Client::Default.new(server, options)
             end
-          Imap::Backup.logger.debug "Logging in: #{username}/#{masked_password}"
-          client.login(username, password)
+          Imap::Backup.logger.debug "Logging in: #{account.username}/#{masked_password}"
+          client.login(account.username, account.password)
           Imap::Backup.logger.debug "Login complete"
           client
         end
     end
 
     def server
-      @server ||= provider.host
+      @server ||= account.server || provider.host
     end
 
     private
@@ -125,7 +117,7 @@ module Imap::Backup
     def each_folder
       backup_folders.each do |backup_folder|
         folder = Account::Folder.new(self, backup_folder[:name])
-        serializer = Serializer::Mbox.new(local_path, backup_folder[:name])
+        serializer = Serializer::Mbox.new(account.local_path, backup_folder[:name])
         yield folder, serializer
       end
     end
@@ -142,7 +134,7 @@ module Imap::Backup
           Imap::Backup.logger.debug(
             "Backup '#{old_name}' renamed and restored to '#{new_name}'"
           )
-          new_serializer = Serializer::Mbox.new(local_path, new_name)
+          new_serializer = Serializer::Mbox.new(account.local_path, new_name)
           new_folder = Account::Folder.new(self, new_name)
           new_folder.create
           new_serializer.force_uid_validity(new_folder.uid_validity)
@@ -159,21 +151,21 @@ module Imap::Backup
 
     def create_account_folder
       Utils.make_folder(
-        File.dirname(local_path),
-        File.basename(local_path),
+        File.dirname(account.local_path),
+        File.basename(account.local_path),
         Serializer::DIRECTORY_PERMISSIONS
       )
     end
 
     def masked_password
-      password.gsub(/./, "x")
+      account.password.gsub(/./, "x")
     end
 
     def backup_folders
       @backup_folders ||=
         begin
-          if @config_folders&.any?
-            @config_folders
+          if account.folders&.any?
+            account.folders
           else
             folders.map { |name| {name: name} }
           end
@@ -181,11 +173,11 @@ module Imap::Backup
     end
 
     def provider
-      @provider ||= Email::Provider.for_address(username)
+      @provider ||= Email::Provider.for_address(account.username)
     end
 
     def provider_options
-      provider.options.merge(connection_options)
+      provider.options.merge(account.connection_options || {})
     end
   end
 end

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

@@ -3,7 +3,7 @@ require "forwardable"
 require "retry_on_error"
 
 module Imap::Backup
-  module Account; end
+  class Account; end
 
   class FolderNotFound < StandardError; end
 

data/lib/imap/backup/account.rb

@@ -83,14 +83,9 @@ module Imap::Backup
     def update(field, value)
       if changes[field]
         change = changes[field]
-        if change[:from] == value
-          changes.delete(field)
-        else
-          set_field!(field, value)
-        end
-      else
-        set_field!(field, value)
+        changes.delete(field) if change[:from] == value
       end
+      set_field!(field, value)
     end
 
     def set_field!(field, value)

data/lib/imap/backup/cli/helpers.rb

@@ -7,7 +7,7 @@ module Imap::Backup::CLI::Helpers
 
   def account(email)
     connections = Imap::Backup::Configuration::List.new
-    account = connections.accounts.find { |a| a[:username] == email }
+    account = connections.accounts.find { |a| a.username == email }
     raise "#{email} is not a configured account" if !account
 
     account

data/lib/imap/backup/cli/local.rb

@@ -6,7 +6,7 @@ module Imap::Backup
     desc "accounts", "List locally backed-up accounts"
     def accounts
       connections = Imap::Backup::Configuration::List.new
-      connections.accounts.each { |a| Kernel.puts a[:username] }
+      connections.accounts.each { |a| Kernel.puts a.username }
     end
 
     desc "folders EMAIL", "List account folders"

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

@@ -22,9 +22,10 @@ module Imap::Backup
         header menu
         modify_email menu
         modify_password menu
-        modify_server menu
         modify_backup_path menu
         choose_folders menu
+        modify_server menu
+        modify_connection_options menu
         test_connection menu
         delete_account menu
         menu.choice("return to main menu") { throw :done }
@@ -33,13 +34,20 @@ module Imap::Backup
     end
 
     def header(menu)
-      menu.header = <<-HEADER.gsub(/^\s{8}/m, "")
+      connection_options =
+        if account.connection_options
+          escaped =
+            JSON.generate(account.connection_options).
+            gsub('"', '\"')
+          "\n  connection options: #{escaped}"
+        end
+      menu.header = <<~HEADER
         Account:
-          email:    #{account[:username]}
-          server:   #{account[:server]}
-          path:     #{account[:local_path]}
-          folders:  #{folders.map { |f| f[:name] }.join(', ')}
+          email:    #{account.username}
           password: #{masked_password}
+          path:     #{account.local_path}
+          folders:  #{folders.map { |f| f[:name] }.join(', ')}
+          server:   #{account.server}#{connection_options}
       HEADER
     end
 
@@ -48,20 +56,20 @@ module Imap::Backup
         username = Configuration::Asker.email(username)
         Kernel.puts "username: #{username}"
         other_accounts = store.accounts.reject { |a| a == account }
-        others = other_accounts.map { |a| a[:username] }
+        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
+          account.username = username
           # rubocop:disable Style/IfUnlessModifier
-          if account[:server].nil? || (account[:server] == "")
-            account[:server] = default_server(username)
+          default = default_server(username)
+          if default && (account.server.nil? || (account.server == ""))
+            account.server = default
           end
           # rubocop:enable Style/IfUnlessModifier
-          account[:modified] = true
         end
       end
     end
@@ -70,30 +78,31 @@ module Imap::Backup
       menu.choice("modify password") do
         password = Configuration::Asker.password
 
-        if !password.nil?
-          account[:password] = password
-          account[:modified] = true
-        end
+        account.password = password if !password.nil?
       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
+        account.server = server if !server.nil?
+      end
+    end
+
+    def modify_connection_options(menu)
+      menu.choice("modify connection options") do
+        connection_options = highline.ask("connections options (as JSON): ")
+        account.connection_options = connection_options if !connection_options.nil?
       end
     end
 
     def path_modification_validator(path)
       same = store.accounts.find do |a|
-        a[:username] != account[:username] && a[:local_path] == path
+        a.username != account.username && a.local_path == path
       end
       if same
         Kernel.puts "The path '#{path}' is used to backup " \
-          "the account '#{same[:username]}'"
+          "the account '#{same.username}'"
         false
       else
         true
@@ -102,11 +111,10 @@ module Imap::Backup
 
     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) }
+        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
 
@@ -127,21 +135,21 @@ module Imap::Backup
     def delete_account(menu)
       menu.choice("delete") do
         if highline.agree("Are you sure? (y/n) ")
-          account[:delete] = true
+          account.mark_for_deletion!
           throw :done
         end
       end
     end
 
     def folders
-      account[:folders] || []
+      account.folders || []
     end
 
     def masked_password
-      if (account[:password] == "") || account[:password].nil?
+      if (account.password == "") || account.password.nil?
         "(unset)"
       else
-        account[:password].gsub(/./, "x")
+        account.password.gsub(/./, "x")
       end
     end
 

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

@@ -53,7 +53,7 @@ module Imap::Backup
     end
 
     def selected?(folder_name)
-      config_folders = account[:folders]
+      config_folders = account.folders
       return false if config_folders.nil?
 
       config_folders.find { |f| f[:name] == folder_name }
@@ -62,7 +62,7 @@ module Imap::Backup
     def remove_missing
       removed = []
       config_folders = []
-      account[:folders].each do |f|
+      account.folders.each do |f|
         found = imap_folders.find { |folder| folder == f[:name] }
         if found
           config_folders << f
@@ -73,8 +73,7 @@ module Imap::Backup
 
       return if removed.empty?
 
-      account[:folders] = config_folders
-      account[:modified] = true
+      account.folders = config_folders
 
       Kernel.puts <<~MESSAGE
         The following folders have been removed: #{removed.join(', ')}
@@ -85,12 +84,11 @@ module Imap::Backup
 
     def toggle_selection(folder_name)
       if selected?(folder_name)
-        changed = account[:folders].reject! { |f| f[:name] == folder_name }
-        account[:modified] = true if changed
+        new_list = account.folders.select { |f| f[:name] != folder_name }
+        account.folders = new_list
       else
-        account[:folders] ||= []
-        account[:folders] << {name: folder_name}
-        account[:modified] = true
+        existing = account.folders || []
+        account.folders = existing + [{name: folder_name}]
       end
     end
 

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

@@ -1,5 +1,7 @@
 require "highline"
 
+require "imap/backup/account"
+
 module Imap::Backup
   module Configuration; end
 
@@ -39,12 +41,12 @@ module Imap::Backup
 
     def account_items(menu)
       config.accounts.each do |account|
-        next if account[:delete]
+        next if account.marked_for_deletion?
 
-        item = account[:username].clone
-        item << " *" if account[:modified]
+        item = account.username.clone
+        item << " *" if account.modified?
         menu.choice(item) do
-          edit_account account[:username]
+          edit_account account.username
         end
       end
     end
@@ -70,19 +72,19 @@ module Imap::Backup
     end
 
     def default_account_config(username)
-      {
+      ::Imap::Backup::Account.new(
         username: username,
         password: "",
         local_path: File.join(config.path, username.tr("@", "_")),
         folders: []
-      }.tap do |c|
+      ).tap do |a|
         server = Email::Provider.for_address(username)
-        c[:server] = server.host if server.host
+        a.server = server.host if server.host
       end
     end
 
     def edit_account(username)
-      account = config.accounts.find { |a| a[:username] == username }
+      account = config.accounts.find { |a| a.username == username }
       if account.nil?
         account = default_account_config(username)
         config.accounts << account

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

@@ -1,11 +1,14 @@
 require "json"
 require "os"
 
+require "imap/backup/account"
+
 module Imap::Backup
   module Configuration; end
 
   class Configuration::Store
     CONFIGURATION_DIRECTORY = File.expand_path("~/.imap-backup")
+    VERSION = "2.0"
 
     attr_reader :pathname
 
@@ -19,6 +22,7 @@ module Imap::Backup
 
     def initialize(pathname = self.class.default_pathname)
       @pathname = pathname
+      @debug = nil
     end
 
     def path
@@ -26,53 +30,71 @@ module Imap::Backup
     end
 
     def save
+      ensure_loaded!
       FileUtils.mkdir(path) if !File.directory?(path)
       make_private(path) if !windows?
       remove_modified_flags
       remove_deleted_accounts
-      File.open(pathname, "w") { |f| f.write(JSON.pretty_generate(data)) }
+      save_data = {
+        version: VERSION,
+        accounts: accounts.map(&:to_h),
+        debug: debug?
+      }
+      File.open(pathname, "w") { |f| f.write(JSON.pretty_generate(save_data)) }
       FileUtils.chmod(0o600, pathname) if !windows?
     end
 
     def accounts
-      data[:accounts]
+      @accounts ||= begin
+        ensure_loaded!
+        data[:accounts].map { |data| Account.new(data) }
+      end
     end
 
     def modified?
-      accounts.any? { |a| a[:modified] || a[:delete] }
+      ensure_loaded!
+      accounts.any? { |a| a.modified? || a.marked_for_deletion? }
     end
 
     def debug?
-      data[:debug]
+      ensure_loaded!
+      @debug
     end
 
     def debug=(value)
-      data[:debug] = [true, false].include?(value) ? value : false
+      ensure_loaded!
+      @debug = [true, false].include?(value) ? value : false
     end
 
     private
 
+    def ensure_loaded!
+      return true if @data
+
+      data
+      @debug = data.key?(:debug) ? data[:debug] == true : false
+      true
+    end
+
     def data
       @data ||=
         begin
           if File.exist?(pathname)
             Utils.check_permissions(pathname, 0o600) if !windows?
             contents = File.read(pathname)
-            data = JSON.parse(contents, symbolize_names: true)
+            JSON.parse(contents, symbolize_names: true)
           else
-            data = {accounts: []}
+            {accounts: []}
           end
-          data[:debug] = data.key?(:debug) ? data[:debug] == true : false
-          data
         end
     end
 
     def remove_modified_flags
-      accounts.each { |a| a.delete(:modified) }
+      accounts.each { |a| a.clear_changes! }
     end
 
     def remove_deleted_accounts
-      accounts.reject! { |a| a[:delete] }
+      accounts.reject! { |a| a.marked_for_deletion? }
     end
 
     def make_private(path)

data/lib/imap/backup/version.rb

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

data/spec/features/support/shared/connection_context.rb

@@ -2,11 +2,13 @@ shared_context "imap-backup connection" do
   let(:local_backup_path) { Dir.mktmpdir(nil, "tmp") }
   let(:default_connection) { fixture("connection") }
   let(:backup_folders) { nil }
-  let(:connection_options) do
-    default_connection.merge(
-      local_path: local_backup_path,
-      folders: backup_folders
+  let(:account) do
+    Imap::Backup::Account.new(
+      default_connection.merge(
+        local_path: local_backup_path,
+        folders: backup_folders
+      )
     )
   end
-  let(:connection) { Imap::Backup::Account::Connection.new(connection_options) }
+  let(:connection) { Imap::Backup::Account::Connection.new(account) }
 end

data/spec/unit/email/provider/base_spec.rb

@@ -1,4 +1,4 @@
-describe Email::Provider::Default do
+describe Email::Provider::Base do
   describe "#options" do
     it "returns options" do
       expect(subject.options).to be_a(Hash)

data/spec/unit/email/provider_spec.rb

@@ -17,10 +17,10 @@ describe Email::Provider do
     end
 
     context "with unknown providers" do
-      it "returns a default provider" do
+      it "returns the Unknown provider" do
         result = described_class.for_address("foo@unknown.com")
 
-        expect(result).to be_a(Email::Provider::Default)
+        expect(result).to be_a(Email::Provider::Unknown)
       end
     end
   end

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

@@ -12,7 +12,7 @@ describe Imap::Backup::Account::Connection do
   SERVER = "imap.example.com".freeze
   USERNAME = "username@example.com".freeze
 
-  subject { described_class.new(options) }
+  subject { described_class.new(account) }
 
   let(:client) do
     instance_double(
@@ -20,14 +20,16 @@ describe Imap::Backup::Account::Connection do
     )
   end
   let(:imap_folders) { [] }
-  let(:options) do
-    {
+  let(:account) do
+    instance_double(
+      Imap::Backup::Account,
       username: USERNAME,
       password: PASSWORD,
       local_path: LOCAL_PATH,
       folders: config_folders,
-      server: server
-    }
+      server: server,
+      connection_options: nil
+    )
   end
   let(:config_folders) { [FOLDER_CONFIG] }
   let(:root_info) do
@@ -59,21 +61,10 @@ describe Imap::Backup::Account::Connection do
   end
 
   describe "#initialize" do
-    [
-      [:username, USERNAME],
-      [:password, PASSWORD],
-      [:local_path, LOCAL_PATH],
-      [:server, SERVER]
-    ].each do |attr, expected|
-      it "expects #{attr}" do
-        expect(subject.public_send(attr)).to eq(expected)
-      end
-    end
-
     it "creates the path" do
       expect(Imap::Backup::Utils).to receive(:make_folder)
 
-      subject.username
+      subject
     end
   end
 

data/spec/unit/imap/backup/cli/local_spec.rb

@@ -1,8 +1,15 @@
 describe Imap::Backup::CLI::Local do
   let(:list) do
-    instance_double(Imap::Backup::Configuration::List, accounts: accounts)
+    instance_double(Imap::Backup::Configuration::List, accounts: [account])
+  end
+  let(:account) do
+    instance_double(
+      Imap::Backup::Account,
+      username: email,
+      marked_for_deletion?: false,
+      modified?: false
+    )
   end
-  let(:accounts) { [{username: email}] }
   let(:connection) do
     instance_double(
       Imap::Backup::Account::Connection,

data/spec/unit/imap/backup/cli/utils_spec.rb

@@ -1,50 +1,52 @@
-describe Imap::Backup::CLI::Utils do
-  let(:list) do
-    instance_double(Imap::Backup::Configuration::List, accounts: accounts)
-  end
-  let(:accounts) { [{username: email}] }
-  let(:connection) do
-    instance_double(
-      Imap::Backup::Account::Connection,
-      local_folders: local_folders
-    )
-  end
-  let(:local_folders) { [[serializer, folder]] }
-  let(:folder) do
-    instance_double(
-      Imap::Backup::Account::Folder,
-      exist?: true,
-      name: "name",
-      uid_validity: "uid_validity",
-      uids: %w(123 456)
-    )
-  end
-  let(:serializer) do
-    instance_double(
-      Imap::Backup::Serializer::Mbox,
-      uids: %w(123 789),
-      apply_uid_validity: nil,
-      save: nil
-    )
-  end
-  let(:email) { "foo@example.com" }
+module Imap::Backup
+  describe CLI::Utils do
+    let(:list) do
+      instance_double(Configuration::List, accounts: [account])
+    end
+    let(:account) { instance_double(Account, username: email) }
+    let(:connection) do
+      instance_double(
+        Account::Connection,
+        local_folders: local_folders
+      )
+    end
+    let(:local_folders) { [[serializer, folder]] }
+    let(:folder) do
+      instance_double(
+        Account::Folder,
+        exist?: true,
+        name: "name",
+        uid_validity: "uid_validity",
+        uids: %w(123 456)
+      )
+    end
+    let(:serializer) do
+      instance_double(
+        Serializer::Mbox,
+        uids: %w(123 789),
+        apply_uid_validity: nil,
+        save: nil
+      )
+    end
+    let(:email) { "foo@example.com" }
 
-  before do
-    allow(Imap::Backup::Configuration::List).to receive(:new) { list }
-    allow(Imap::Backup::Account::Connection).to receive(:new) { connection }
-  end
+    before do
+      allow(Configuration::List).to receive(:new) { list }
+      allow(Account::Connection).to receive(:new) { connection }
+    end
 
-  describe "ignore_history" do
-    it "ensures the local UID validity matches the server" do
-      subject.ignore_history(email)
+    describe "ignore_history" do
+      it "ensures the local UID validity matches the server" do
+        subject.ignore_history(email)
 
-      expect(serializer).to have_received(:apply_uid_validity).with("uid_validity")
-    end
+        expect(serializer).to have_received(:apply_uid_validity).with("uid_validity")
+      end
 
-    it "fills the local folder with fake emails" do
-      subject.ignore_history(email)
+      it "fills the local folder with fake emails" do
+        subject.ignore_history(email)
 
-      expect(serializer).to have_received(:save).with("456", /From: fake@email.com/)
+        expect(serializer).to have_received(:save).with("456", /From: fake@email.com/)
+      end
     end
   end
 end

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

@@ -6,7 +6,32 @@ describe Imap::Backup::Configuration::Account do
 
   subject { described_class.new(store, account, highline) }
 
-  let(:account) { ACCOUNT }
+  let(:account) do
+    instance_double(
+      Imap::Backup::Account,
+      username: existing_email,
+      password: existing_password,
+      server: current_server,
+      connection_options: nil,
+      local_path: "/backup/path",
+      folders: [{name: "my_folder"}]
+    )
+  end
+  let(:account1) do
+    instance_double(
+      Imap::Backup::Account,
+      username: other_email,
+      local_path: other_existing_path
+    )
+  end
+  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(:highline) { HIGHLINE }
   let(:store) { STORE }
 
@@ -43,28 +68,6 @@ describe Imap::Backup::Configuration::Account do
     let(:store) do
       instance_double(Imap::Backup::Configuration::Store, accounts: accounts)
     end
-    let(:accounts) { [account, account1] }
-    let(:account) do
-      {
-        username: existing_email,
-        server: current_server,
-        local_path: "/backup/path",
-        folders: [{name: "my_folder"}],
-        password: existing_password
-      }
-    end
-    let(:account1) do
-      {
-        username: other_email,
-        local_path: other_existing_path
-      }
-    end
-    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" }
 
     before do
       allow(Kernel).to receive(:system)
@@ -139,6 +142,8 @@ describe Imap::Backup::Configuration::Account do
 
     describe "choosing 'modify email'" do
       before do
+        allow(account).to receive(:"username=")
+        allow(account).to receive(:"server=")
         allow(Imap::Backup::Configuration::Asker).
           to receive(:email) { new_email }
         subject.run
@@ -158,7 +163,7 @@ describe Imap::Backup::Configuration::Account do
               let(:current_server) { nil }
 
               it "sets a default server" do
-                expect(account[:server]).to eq(expected)
+                expect(account).to have_received(:"server=").with(expected)
               end
             end
 
@@ -166,7 +171,7 @@ describe Imap::Backup::Configuration::Account do
               let(:current_server) { "" }
 
               it "sets a default server" do
-                expect(account[:server]).to eq(expected)
+                expect(account).to have_received(:"server=").with(expected)
               end
             end
           end
@@ -183,17 +188,15 @@ describe Imap::Backup::Configuration::Account do
           end
 
           it "does not set a default server" do
-            expect(account[:server]).to be_nil
+            expect(account).to_not have_received(:"server=")
           end
         end
       end
 
       context "when the email is new" do
         it "modifies the email address" do
-          expect(account[:username]).to eq(new_email)
+          expect(account).to have_received(:"username=").with(new_email)
         end
-
-        include_examples "it flags the account as modified"
       end
 
       context "when the email already exists" do
@@ -205,10 +208,8 @@ describe Imap::Backup::Configuration::Account do
         end
 
         it "doesn't set the email" do
-          expect(account[:username]).to eq(existing_email)
+          expect(account.username).to eq(existing_email)
         end
-
-        include_examples "it doesn't flag the account as modified"
       end
     end
 
@@ -216,6 +217,7 @@ describe Imap::Backup::Configuration::Account do
       let(:new_password) { "new_password" }
 
       before do
+        allow(account).to receive(:"password=")
         allow(Imap::Backup::Configuration::Asker).
           to receive(:password) { new_password }
         subject.run
@@ -224,20 +226,16 @@ describe Imap::Backup::Configuration::Account do
 
       context "when the user enters a password" do
         it "updates the password" do
-          expect(account[:password]).to eq(new_password)
+          expect(account).to have_received(:"password=").with(new_password)
         end
-
-        include_examples "it flags the account as modified"
       end
 
       context "when the user cancels" do
         let(:new_password) { nil }
 
         it "does nothing" do
-          expect(account[:password]).to eq(existing_password)
+          expect(account.password).to eq(existing_password)
         end
-
-        include_examples "it doesn't flag the account as modified"
       end
     end
 
@@ -245,6 +243,7 @@ describe Imap::Backup::Configuration::Account do
       let(:server) { "server" }
 
       before do
+        allow(account).to receive(:"server=")
         allow(highline).to receive(:ask).with("server: ") { server }
 
         subject.run
@@ -253,16 +252,15 @@ describe Imap::Backup::Configuration::Account do
       end
 
       it "updates the server" do
-        expect(account[:server]).to eq(server)
+        expect(account).to have_received(:"server=").with(server)
       end
-
-      include_examples "it flags the account as modified"
     end
 
     describe "choosing 'modify backup path'" do
       let(:new_backup_path) { "/new/path" }
 
       before do
+        allow(account).to receive(:"local_path=")
         @validator = nil
         allow(
           Imap::Backup::Configuration::Asker
@@ -275,7 +273,7 @@ describe Imap::Backup::Configuration::Account do
       end
 
       it "updates the path" do
-        expect(account[:local_path]).to eq(new_backup_path)
+        expect(account).to have_received(:"local_path=").with(new_backup_path)
       end
 
       context "when the path is not used by other backups" do
@@ -293,8 +291,6 @@ describe Imap::Backup::Configuration::Account do
           # rubocop:enable RSpec/InstanceVariable
         end
       end
-
-      include_examples "it flags the account as modified"
     end
 
     describe "choosing 'choose backup folders'" do
@@ -333,6 +329,7 @@ describe Imap::Backup::Configuration::Account do
       let(:confirmed) { true }
 
       before do
+        allow(account).to receive(:mark_for_deletion!)
         allow(highline).to receive(:agree) { confirmed }
         subject.run
         catch :done do
@@ -345,13 +342,17 @@ describe Imap::Backup::Configuration::Account do
       end
 
       context "when the user confirms deletion" do
-        include_examples "it flags the account to be deleted"
+        it "flags the account to be deleted" do
+          expect(account).to have_received(:mark_for_deletion!)
+        end
       end
 
       context "without confirmation" do
         let(:confirmed) { false }
 
-        include_examples "it doesn't flag the account to be deleted"
+        it "doesn't flag the account to be deleted" do
+          expect(account).to_not have_received(:mark_for_deletion!)
+        end
       end
     end
   end

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

@@ -9,7 +9,14 @@ describe Imap::Backup::Configuration::FolderChooser do
         Imap::Backup::Account::Connection, folders: connection_folders
       )
     end
-    let(:account) { {folders: []} }
+    let(:account) do
+      instance_double(
+        Imap::Backup::Account,
+        folders: account_folders,
+        "folders=": nil
+      )
+    end
+    let(:account_folders) { [] }
     let(:connection_folders) { [] }
     let!(:highline_streams) { prepare_highline }
     let(:input) { highline_streams[0] }
@@ -36,7 +43,7 @@ describe Imap::Backup::Configuration::FolderChooser do
     end
 
     describe "folder listing" do
-      let(:account) { {folders: [{name: "my_folder"}]} }
+      let(:account_folders) { [{name: "my_folder"}]}
       let(:connection_folders) do
         # N.B. my_folder is already backed up
         %w(my_folder another_folder)
@@ -62,10 +69,9 @@ describe Imap::Backup::Configuration::FolderChooser do
         end
 
         specify "are added to the account" do
-          expect(account[:folders]).to include(name: "another_folder")
+          expect(account).to have_received(:"folders=").
+            with([{name: "my_folder"}, {name: "another_folder"}])
         end
-
-        include_examples "it flags the account as modified"
       end
 
       context "when removing folders" do
@@ -76,22 +82,16 @@ describe Imap::Backup::Configuration::FolderChooser do
         end
 
         specify "are removed from the account" do
-          expect(account[:folders]).to_not include(name: "my_folder")
+          expect(account).to have_received(:"folders=").with([])
         end
-
-        include_examples "it flags the account as modified"
       end
     end
 
     context "with missing remote folders" do
-      let(:account) do
-        {folders: [{name: "on_server"}, {name: "not_on_server"}]}
-      end
-      let(:connection_folders) do
-        [
-          instance_double(Imap::Backup::Account::Folder, name: "on_server")
-        ]
+      let(:account_folders) do
+        [{name: "on_server"}, {name: "not_on_server"}]
       end
+      let(:connection_folders) { ["on_server"] }
 
       before do
         allow(Kernel).to receive(:puts)
@@ -99,10 +99,9 @@ describe Imap::Backup::Configuration::FolderChooser do
       end
 
       specify "are removed from the account" do
-        expect(account[:folders]).to_not include(name: "not_on_server")
+        expect(account).to have_received(:"folders=").
+          with([{name: "on_server"}])
       end
-
-      include_examples "it flags the account as modified"
     end
 
     context "when folders are not available" do

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

@@ -3,8 +3,31 @@ describe Imap::Backup::Configuration::Setup do
 
   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,
@@ -63,9 +86,7 @@ describe Imap::Backup::Configuration::Setup do
     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 }
 
@@ -98,7 +119,7 @@ describe Imap::Backup::Configuration::Setup do
         allow(Imap::Backup::Configuration::Asker).to receive(:email).
           with(no_args) { "new@example.com" }
         allow(Imap::Backup::Configuration::Account).to receive(:new).
-          with(store, normal, anything) { account }
+          with(store, normal_account, anything) { account }
       end
 
       it "edits the account" do
@@ -134,19 +155,19 @@ describe Imap::Backup::Configuration::Setup do
       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,12 +175,12 @@ 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
 

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

@@ -8,10 +8,12 @@ describe Imap::Backup::Configuration::Store do
   let(:file_path) { File.join(directory, "/config.json") }
   let(:file_exists) { true }
   let(:directory_exists) { true }
-  let(:data) { {debug: debug, accounts: accounts} }
   let(:debug) { true }
-  let(:accounts) { [] }
   let(:configuration) { data.to_json }
+  let(:data) { {debug: debug, accounts: accounts.map(&:to_h)} }
+  let(:accounts) { [account1, account2] }
+  let(:account1) { Imap::Backup::Account.new({username: "username1"}) }
+  let(:account2) { Imap::Backup::Account.new({username: "username2"}) }
 
   before do
     stub_const(
@@ -48,8 +50,8 @@ describe Imap::Backup::Configuration::Store do
   end
 
   describe "#modified?" do
-    context "with accounts flagged 'modified'" do
-      let(:accounts) { [{name: "foo", modified: true}] }
+    context "with modified accounts" do
+      before { subject.accounts[0].username = "changed" }
 
       it "is true" do
         expect(subject.modified?).to be_truthy
@@ -57,7 +59,7 @@ describe Imap::Backup::Configuration::Store do
     end
 
     context "with accounts flagged 'delete'" do
-      let(:accounts) { [{name: "foo", delete: true}] }
+      before { subject.accounts[0].mark_for_deletion! }
 
       it "is true" do
         expect(subject.modified?).to be_truthy
@@ -65,8 +67,6 @@ describe Imap::Backup::Configuration::Store do
     end
 
     context "without accounts flagged 'modified'" do
-      let(:accounts) { [{name: "foo"}] }
-
       it "is false" do
         expect(subject.modified?).to be_falsey
       end
@@ -156,19 +156,14 @@ describe Imap::Backup::Configuration::Store do
       subject.save
     end
 
-    context "when accounts are modified" do
-      let(:accounts) { [{name: "foo", modified: true}] }
-
-      before { subject.save }
-
-      it "skips the 'modified' flag" do
-        expected = Marshal.load(Marshal.dump(data))
-        expected[:accounts][0].delete(:modified)
+    it "uses the Account#to_h method" do
+      allow(subject.accounts[0]).to receive(:to_h) { "Account1" }
+      allow(subject.accounts[1]).to receive(:to_h) { "Account2" }
 
-        expect(JSON).to receive(:pretty_generate).with(expected)
+      expect(JSON).to receive(:pretty_generate).
+        with(hash_including({accounts: ["Account1", "Account2"]}))
 
-        subject.save
-      end
+      subject.save
     end
 
     context "when accounts are to be deleted" do
@@ -179,11 +174,15 @@ describe Imap::Backup::Configuration::Store do
         ]
       end
 
-      it "does not save them" do
-        expected = Marshal.load(Marshal.dump(data))
-        expected[:accounts].pop
+      before do
+        allow(subject.accounts[0]).to receive(:to_h) { "Account1" }
+        allow(subject.accounts[1]).to receive(:to_h) { "Account2" }
+        subject.accounts[0].mark_for_deletion!
+      end
 
-        expect(JSON).to receive(:pretty_generate).with(expected)
+      it "does not save them" do
+        expect(JSON).to receive(:pretty_generate).
+          with(hash_including({accounts: ["Account2"]}))
 
         subject.save
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 4.0.5
+  version: 4.0.6
 platform: ruby
 authors:
 - Joe Yates
@@ -237,7 +237,6 @@ 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
@@ -316,7 +315,6 @@ test_files:
 - 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

data/spec/support/shared_examples/account_flagging.rb

@@ -1,23 +0,0 @@
-shared_examples "it flags the account as modified" do
-  it "flags that the account has changed" do
-    expect(account[:modified]).to be_truthy
-  end
-end
-
-shared_examples "it doesn't flag the account as modified" do
-  it "does not flag that the account has changed" do
-    expect(account[:modified]).to be_falsey
-  end
-end
-
-shared_examples "it flags the account to be deleted" do
-  it "flags that the account is to be deleted" do
-    expect(account[:delete]).to be_truthy
-  end
-end
-
-shared_examples "it doesn't flag the account to be deleted" do
-  it "does not flags that the account is to be deleted" do
-    expect(account[:delete]).to be_falsey
-  end
-end