imap-backup 14.4.1 → 14.4.4

data/lib/imap/backup/serializer/permission_checker.rb

@@ -4,9 +4,6 @@ module Imap; end
 
 module Imap::Backup
   class Serializer::PermissionChecker
-    attr_reader :filename
-    attr_reader :limit
-
     def initialize(filename:, limit:)
       @filename = filename
       @limit = limit
@@ -26,5 +23,10 @@ module Imap::Backup
       )
       raise message
     end
+
+    private
+
+    attr_reader :filename
+    attr_reader :limit
   end
 end

data/lib/imap/backup/serializer/transaction.rb

@@ -2,7 +2,6 @@ module Imap; end
 
 module Imap::Backup
   class Serializer::Transaction
-    attr_reader :owner
     attr_reader :data
 
     def initialize(owner:)
@@ -33,5 +32,9 @@ module Imap::Backup
     def fail_outside_transaction!(method)
       raise "#{owner.class}##{method} can only be called inside a transaction" if !in_transaction?
     end
+
+    private
+
+    attr_reader :owner
   end
 end

data/lib/imap/backup/serializer/unused_name_finder.rb

@@ -4,8 +4,6 @@ module Imap; end
 
 module Imap::Backup
   class Serializer::UnusedNameFinder
-    attr_reader :serializer
-
     def initialize(serializer:)
       @serializer = serializer
     end
@@ -25,5 +23,9 @@ module Imap::Backup
 
       folder
     end
+
+    private
+
+    attr_reader :serializer
   end
 end

data/lib/imap/backup/serializer/version2_migrator.rb

@@ -6,8 +6,6 @@ module Imap; end
 
 module Imap::Backup
   class Serializer::Version2Migrator
-    attr_reader :folder_path
-
     def initialize(folder_path)
       @folder_path = folder_path
     end
@@ -39,6 +37,8 @@ module Imap::Backup
 
     private
 
+    attr_reader :folder_path
+
     def imap_pathname
       "#{folder_path}.imap"
     end

data/lib/imap/backup/serializer.rb

@@ -35,6 +35,11 @@ module Imap::Backup
       @validated = nil
     end
 
+    # Calls the supplied block.
+    # This method is present so that this class implements the same
+    # interface as {DelayedMetadataSerializer}
+    #
+    # @return [void]
     def transaction(&block)
       block.call
     end

data/lib/imap/backup/setup/account/header.rb

@@ -9,9 +9,6 @@ module Imap::Backup
   class Setup::Account; end
 
   class Setup::Account::Header
-    attr_reader :account
-    attr_reader :menu
-
     def initialize(menu:, account:)
       @menu = menu
       @account = account
@@ -41,6 +38,9 @@ module Imap::Backup
 
     private
 
+    attr_reader :account
+    attr_reader :menu
+
     def modified_flag
       account.modified? ? "*" : ""
     end

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

@@ -2,7 +2,7 @@ require "imap/backup/setup/account/header"
 require "imap/backup/setup/asker"
 require "imap/backup/setup/backup_path"
 require "imap/backup/setup/connection_tester"
-require "imap/backup/setup/email"
+require "imap/backup/setup/email_changer"
 require "imap/backup/setup/folder_chooser"
 
 module Imap; end
@@ -11,10 +11,6 @@ module Imap::Backup
   class Setup; end
 
   class Setup::Account
-    attr_reader :account
-    attr_reader :config
-    attr_reader :highline
-
     def initialize(config, account, highline)
       @account = account
       @config = config
@@ -36,6 +32,10 @@ module Imap::Backup
 
     private
 
+    attr_reader :account
+    attr_reader :config
+    attr_reader :highline
+
     def create_menu
       highline.choose do |menu|
         header menu
@@ -62,7 +62,7 @@ module Imap::Backup
 
     def modify_email(menu)
       menu.choice("modify email") do
-        Setup::Email.new(account: account, config: config).run
+        Setup::EmailChanger.new(account: account, config: config).run
       end
     end
 

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

@@ -4,10 +4,6 @@ module Imap::Backup
   class Setup; end
 
   class Setup::Asker
-    EMAIL_MATCHER = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]+$/i.freeze
-
-    attr_reader :highline
-
     def initialize(highline)
       @highline = highline
     end
@@ -40,5 +36,11 @@ module Imap::Backup
     def self.password
       new(Setup.highline).password
     end
+
+    private
+
+    EMAIL_MATCHER = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]+$/i.freeze
+
+    attr_reader :highline
   end
 end

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

@@ -4,9 +4,6 @@ module Imap::Backup
   class Setup; end
 
   class Setup::BackupPath
-    attr_reader :account
-    attr_reader :config
-
     def initialize(account:, config:)
       @account = account
       @config = config
@@ -15,7 +12,6 @@ module Imap::Backup
     def run
       account.local_path = highline.ask("backup directory: ") do |q|
         q.default  = account.local_path
-        q.readline = true
         q.validate = ->(path) { path_modification_validator(path) }
         q.responses[:not_valid] = "Choose a different directory "
       end
@@ -23,6 +19,9 @@ module Imap::Backup
 
     private
 
+    attr_reader :account
+    attr_reader :config
+
     def highline
       Setup.highline
     end

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

@@ -6,8 +6,6 @@ module Imap::Backup
   class Setup; end
 
   class Setup::ConnectionTester
-    attr_reader :account
-
     def initialize(account)
       @account = account
     end
@@ -20,5 +18,9 @@ module Imap::Backup
     rescue StandardError => e
       "Unexpected error: #{e}"
     end
+
+    private
+
+    attr_reader :account
   end
 end

data/lib/imap/backup/setup/{email.rb → email_changer.rb}

@@ -6,10 +6,7 @@ module Imap; end
 module Imap::Backup
   class Setup; end
 
-  class Setup::Email
-    attr_reader :account
-    attr_reader :config
-
+  class Setup::EmailChanger
     def initialize(account:, config:)
       @account = account
       @config = config
@@ -34,6 +31,9 @@ module Imap::Backup
 
     private
 
+    attr_reader :account
+    attr_reader :config
+
     def default_server(username)
       provider = Email::Provider.for_address(username)
 

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

@@ -6,8 +6,6 @@ module Imap::Backup
   class Setup; end
 
   class Setup::FolderChooser
-    attr_reader :account
-
     def initialize(account)
       @account = account
     end
@@ -36,6 +34,8 @@ module Imap::Backup
 
     private
 
+    attr_reader :account
+
     def show_menu
       highline.choose do |menu|
         menu.header = <<~MENU.chomp

data/lib/imap/backup/setup/global_options/download_strategy_chooser.rb

@@ -6,8 +6,6 @@ class Imap::Backup::Setup; end
 
 class Imap::Backup::Setup::GlobalOptions
   class DownloadStrategyChooser
-    attr_reader :config
-
     def initialize(config:)
       @config = config
     end
@@ -23,6 +21,8 @@ class Imap::Backup::Setup::GlobalOptions
 
     private
 
+    attr_reader :config
+
     def create_menu
       strategies = Imap::Backup::Configuration::DOWNLOAD_STRATEGIES
       highline.choose do |menu|

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

@@ -7,8 +7,6 @@ module Imap::Backup
   class Setup; end
 
   class Setup::GlobalOptions
-    attr_reader :config
-
     def initialize(config:)
       @config = config
     end
@@ -24,6 +22,8 @@ module Imap::Backup
 
     private
 
+    attr_reader :config
+
     def show_menu
       highline.choose do |menu|
         menu.header = <<~MENU.chomp

data/lib/imap/backup/setup.rb

@@ -16,8 +16,6 @@ module Imap::Backup
     end
     self.highline = HighLine.new
 
-    attr_accessor :config
-
     def initialize(config:)
       @config = config
     end
@@ -33,6 +31,8 @@ module Imap::Backup
 
     private
 
+    attr_accessor :config
+
     def show_menu
       self.class.highline.choose do |menu|
         menu.header = <<~MENU.chomp

data/lib/imap/backup/text/sanitizer.rb

@@ -8,8 +8,6 @@ module Imap::Backup
   class Text::Sanitizer
     extend Forwardable
 
-    attr_reader :output
-
     delegate puts: :output
     delegate write: :output
 
@@ -39,6 +37,8 @@ module Imap::Backup
 
     private
 
+    attr_reader :output
+
     def sanitize(text)
       # Hide password in Net::IMAP debug output
       text.gsub(

data/lib/imap/backup/thunderbird/mailbox_exporter.rb

@@ -5,14 +5,9 @@ require "imap/backup/logger"
 module Imap; end
 
 module Imap::Backup
-  class Thunderbird::MailboxExporter
-    EXPORT_PREFIX = "imap-backup".freeze
-
-    attr_reader :email
-    attr_reader :serializer
-    attr_reader :profile
-    attr_reader :force
+  class Thunderbird; end
 
+  class Thunderbird::MailboxExporter
     def initialize(email, serializer, profile, force: false)
       @email = email
       @serializer = serializer
@@ -48,6 +43,13 @@ module Imap::Backup
 
     private
 
+    EXPORT_PREFIX = "imap-backup".freeze
+
+    attr_reader :email
+    attr_reader :serializer
+    attr_reader :profile
+    attr_reader :force
+
     def profile_set_up
       File.exist?(profile.local_folders_path)
     end
@@ -95,7 +97,7 @@ module Imap::Backup
       @local_folder ||= begin
         top_level_folders = [EXPORT_PREFIX, email]
         prefixed_folder_path = File.join(top_level_folders, serializer.folder)
-        Thunderbird::LocalFolder.new(profile, prefixed_folder_path)
+        ::Thunderbird::LocalFolder.new(profile, prefixed_folder_path)
       end
     end
 

data/lib/imap/backup/uploader.rb

@@ -6,9 +6,6 @@ module Imap; end
 
 module Imap::Backup
   class Uploader
-    attr_reader :folder
-    attr_reader :serializer
-
     def initialize(folder, serializer)
       @folder = folder
       @serializer = serializer
@@ -32,6 +29,9 @@ module Imap::Backup
 
     private
 
+    attr_reader :folder
+    attr_reader :serializer
+
     def upload_message(message, index)
       return if message.nil?
 

data/lib/imap/backup/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 14.4.1
+  version: 14.4.4
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2023-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -133,6 +133,7 @@ files:
 - LICENSE
 - README.md
 - bin/imap-backup
+- docs/api.md
 - docs/delimiters-and-prefixes.md
 - docs/development.md
 - docs/migrate-server-keep-address.md
@@ -162,7 +163,6 @@ files:
 - lib/imap/backup/cli/stats.rb
 - lib/imap/backup/cli/transfer.rb
 - lib/imap/backup/cli/utils.rb
-- lib/imap/backup/cli_coverage.rb
 - lib/imap/backup/client/apple_mail.rb
 - lib/imap/backup/client/automatic_login_wrapper.rb
 - lib/imap/backup/client/default.rb
@@ -206,7 +206,7 @@ files:
 - lib/imap/backup/setup/asker.rb
 - lib/imap/backup/setup/backup_path.rb
 - lib/imap/backup/setup/connection_tester.rb
-- lib/imap/backup/setup/email.rb
+- lib/imap/backup/setup/email_changer.rb
 - lib/imap/backup/setup/folder_chooser.rb
 - lib/imap/backup/setup/global_options.rb
 - lib/imap/backup/setup/global_options/download_strategy_chooser.rb

data/lib/imap/backup/cli_coverage.rb

@@ -1,21 +0,0 @@
-module Imap; end
-
-module Imap::Backup
-  class CliCoverage
-    def self.conditionally_activate
-      return if !ENV.key?("COVERAGE")
-
-      # Collect coverage separately
-      ENV["SIMPLECOV_COMMAND_NAME"] = "#{ENV.fetch('COVERAGE')} #{ARGV.join(' ')} coverage"
-      require "simplecov"
-
-      # Silence output
-      SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter
-      SimpleCov.print_error_status = false
-
-      # Ensure SimpleCov doesn't filter out all out code
-      project_root = File.expand_path("..", __dir__)
-      SimpleCov.root project_root
-    end
-  end
-end