imap-backup 14.4.0 → 14.4.3

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

@@ -14,8 +14,6 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
-    MAX_SUBJECT = 60
-
     desc "accounts", "List locally backed-up accounts"
     config_option
     format_option
@@ -122,69 +120,72 @@ module Imap::Backup
       end
     end
 
-    no_commands do
-      def list_emails_as_json(serializer)
-        emails = serializer.each_message.map do |message|
-          {
-            uid: message.uid,
-            date: message.date.to_s,
-            subject: message.subject || ""
-          }
-        end
-        Kernel.puts emails.to_json
-      end
-
-      def list_emails_as_text(serializer)
-        Kernel.puts format(
-          "%-10<uid>s  %-#{MAX_SUBJECT}<subject>s - %<date>s",
-          {uid: "UID", subject: "Subject", date: "Date"}
-        )
-        Kernel.puts "-" * (12 + MAX_SUBJECT + 28)
+    private
 
-        serializer.each_message.map do |message|
-          list_message_as_text message
-        end
-      end
+    MAX_SUBJECT = 60
 
-      def list_message_as_text(message)
-        m = {
+    def list_emails_as_json(serializer)
+      emails = serializer.each_message.map do |message|
+        {
           uid: message.uid,
           date: message.date.to_s,
           subject: message.subject || ""
         }
-        if m[:subject].length > MAX_SUBJECT
-          Kernel.puts format("% 10<uid>u: %.#{MAX_SUBJECT - 3}<subject>s... - %<date>s", m)
-        else
-          Kernel.puts format("% 10<uid>u: %-#{MAX_SUBJECT}<subject>s - %<date>s", m)
-        end
       end
+      Kernel.puts emails.to_json
+    end
 
-      def show_emails_as_json(serializer, uids)
-        emails = serializer.each_message(uids).map do |m|
-          m.to_h.tap { |h| h[:body] = m.body }
-        end
-        Kernel.puts emails.to_json
+    def list_emails_as_text(serializer)
+      Kernel.puts format(
+        "%-10<uid>s  %-#{MAX_SUBJECT}<subject>s - %<date>s",
+        {uid: "UID", subject: "Subject", date: "Date"}
+      )
+      Kernel.puts "-" * (12 + MAX_SUBJECT + 28)
+
+      serializer.each_message.map do |message|
+        list_message_as_text message
+      end
+    end
+
+    def list_message_as_text(message)
+      m = {
+        uid: message.uid,
+        date: message.date.to_s,
+        subject: message.subject || ""
+      }
+      if m[:subject].length > MAX_SUBJECT
+        Kernel.puts format("% 10<uid>u: %.#{MAX_SUBJECT - 3}<subject>s... - %<date>s", m)
+      else
+        Kernel.puts format("% 10<uid>u: %-#{MAX_SUBJECT}<subject>s - %<date>s", m)
       end
+    end
 
-      def show_emails_as_text(serializer, uids)
-        serializer.each_message(uids).each do |message|
-          if uids.count > 1
-            Kernel.puts <<~HEADER
-              #{'-' * 80}
-              #{format('| UID: %-71s |', message.uid)}
-              #{'-' * 80}
-            HEADER
-          end
-          Kernel.puts message.body
+    def show_emails_as_json(serializer, uids)
+      emails = serializer.each_message(uids).map do |m|
+        m.to_h.tap { |h| h[:body] = m.body }
+      end
+      Kernel.puts emails.to_json
+    end
+
+    def show_emails_as_text(serializer, uids)
+      serializer.each_message(uids).each do |message|
+        if uids.count > 1
+          Kernel.puts <<~HEADER
+            #{'-' * 80}
+            #{format('| UID: %-71s |', message.uid)}
+            #{'-' * 80}
+          HEADER
         end
+        Kernel.puts message.body
       end
+    end
 
-      def config
-        @config ||= begin
+    def config
+      @config ||=
+        begin
           non_logging_options = Logger.setup_logging(options)
           load_config(**non_logging_options)
         end
-      end
     end
   end
 end

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

@@ -68,63 +68,63 @@ module Imap::Backup
       end
     end
 
-    no_commands do
-      def folder_names(email)
-        config = load_config(**options)
-        account = account(config, email)
+    private
 
-        account.client.list
-      end
+    def folder_names(email)
+      config = load_config(**options)
+      account = account(config, email)
 
-      def json_format_names(names)
-        list = names.map do |name|
-          {name: name}
-        end
-        Kernel.puts list.to_json
-      end
+      account.client.list
+    end
 
-      def list_names(names)
-        names.each do |name|
-          Kernel.puts %("#{name}")
-        end
+    def json_format_names(names)
+      list = names.map do |name|
+        {name: name}
       end
+      Kernel.puts list.to_json
+    end
 
-      def json_format_namespaces(namespaces)
-        list = {
-          personal: namespace_info(namespaces.personal.first),
-          other: namespace_info(namespaces.other.first),
-          shared: namespace_info(namespaces.shared.first)
-        }
-        Kernel.puts list.to_json
+    def list_names(names)
+      names.each do |name|
+        Kernel.puts %("#{name}")
       end
+    end
 
-      def list_namespaces(namespaces)
-        Kernel.puts format(
-          "%-10<name>s %-10<prefix>s %<delim>s",
-          {name: "Name", prefix: "Prefix", delim: "Delimiter"}
-        )
-        list_namespace namespaces, :personal
-        list_namespace namespaces, :other
-        list_namespace namespaces, :shared
-      end
+    def json_format_namespaces(namespaces)
+      list = {
+        personal: namespace_info(namespaces.personal.first),
+        other: namespace_info(namespaces.other.first),
+        shared: namespace_info(namespaces.shared.first)
+      }
+      Kernel.puts list.to_json
+    end
+
+    def list_namespaces(namespaces)
+      Kernel.puts format(
+        "%-10<name>s %-10<prefix>s %<delim>s",
+        {name: "Name", prefix: "Prefix", delim: "Delimiter"}
+      )
+      list_namespace namespaces, :personal
+      list_namespace namespaces, :other
+      list_namespace namespaces, :shared
+    end
 
-      def list_namespace(namespaces, name)
-        info = namespace_info(namespaces.send(name).first, quote: true)
-        if info
-          Kernel.puts format("%-10<name>s %-10<prefix>s %<delim>s", name: name, **info)
-        else
-          Kernel.puts format("%-10<name>s (Not defined)", name: name)
-        end
+    def list_namespace(namespaces, name)
+      info = namespace_info(namespaces.send(name).first, quote: true)
+      if info
+        Kernel.puts format("%-10<name>s %-10<prefix>s %<delim>s", name: name, **info)
+      else
+        Kernel.puts format("%-10<name>s (Not defined)", name: name)
       end
+    end
 
-      def namespace_info(namespace, quote: false)
-        return nil if !namespace
+    def namespace_info(namespace, quote: false)
+      return nil if !namespace
 
-        {
-          prefix: quote ? namespace.prefix.to_json : namespace.prefix,
-          delim: quote ? namespace.delim.to_json : namespace.delim
-        }
-      end
+      {
+        prefix: quote ? namespace.prefix.to_json : namespace.prefix,
+        delim: quote ? namespace.delim.to_json : namespace.delim
+      }
     end
   end
 end

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

@@ -12,9 +12,6 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
-    attr_reader :email
-    attr_reader :options
-
     def initialize(email = nil, options)
       super([])
       @email = email
@@ -42,5 +39,10 @@ module Imap::Backup
         end
       end
     end
+
+    private
+
+    attr_reader :email
+    attr_reader :options
   end
 end

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

@@ -12,8 +12,6 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
-    attr_reader :options
-
     def initialize(options)
       super([])
       @options = options
@@ -25,5 +23,9 @@ module Imap::Backup
         Setup.new(config: config).run
       end
     end
+
+    private
+
+    attr_reader :options
   end
 end

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

@@ -11,9 +11,6 @@ module Imap::Backup
   class CLI::Single < Thor; end
 
   class CLI::Single::Backup
-    attr_reader :options
-    attr_reader :password
-
     def initialize(options)
       @options = options
       @password = nil
@@ -40,6 +37,9 @@ module Imap::Backup
 
     private
 
+    attr_reader :options
+    attr_reader :password
+
     def process_options!
       if !email
         raise Thor::RequiredArgumentMissingError,

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

@@ -8,17 +8,6 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
-    TEXT_COLUMNS = [
-      {name: :folder, width: 20, alignment: :left},
-      {name: :remote, width: 8, alignment: :right},
-      {name: :both, width: 8, alignment: :right},
-      {name: :local, width: 8, alignment: :right}
-    ].freeze
-    ALIGNMENT_FORMAT_SYMBOL = {left: "-", right: " "}.freeze
-
-    attr_reader :email
-    attr_reader :options
-
     def initialize(email, options)
       super([])
       @email = email
@@ -34,56 +23,69 @@ module Imap::Backup
           format_text stats
         end
       end
+    end
 
-      def stats
-        Logger.logger.debug("[Stats] loading configuration")
-        config = load_config(**options)
-        account = account(config, email)
-
-        backup_folders = Account::BackupFolders.new(
-          client: account.client, account: account
-        )
-        backup_folders.map do |folder|
-          next if !folder.exist?
-
-          serializer = Serializer.new(account.local_path, folder.name)
-          local_uids = serializer.uids
-          Logger.logger.debug("[Stats] fetching email list for '#{folder.name}'")
-          remote_uids = folder.uids
-          {
-            folder: folder.name,
-            remote: (remote_uids - local_uids).count,
-            both: (serializer.uids & folder.uids).count,
-            local: (local_uids - remote_uids).count
-          }
-        end.compact
-      end
+    private
+
+    TEXT_COLUMNS = [
+      {name: :folder, width: 20, alignment: :left},
+      {name: :remote, width: 8, alignment: :right},
+      {name: :both, width: 8, alignment: :right},
+      {name: :local, width: 8, alignment: :right}
+    ].freeze
+    ALIGNMENT_FORMAT_SYMBOL = {left: "-", right: " "}.freeze
 
-      def format_text(stats)
-        Kernel.puts text_header
+    attr_reader :email
+    attr_reader :options
 
-        stats.each do |stat|
-          columns = TEXT_COLUMNS.map do |column|
-            symbol = ALIGNMENT_FORMAT_SYMBOL[column[:alignment]]
-            count = stat[column[:name]]
-            format("%#{symbol}#{column[:width]}s", count)
-          end.join("|")
+    def stats
+      Logger.logger.debug("[Stats] loading configuration")
+      config = load_config(**options)
+      account = account(config, email)
 
-          Kernel.puts columns
-        end
-      end
+      backup_folders = Account::BackupFolders.new(
+        client: account.client, account: account
+      )
+      backup_folders.map do |folder|
+        next if !folder.exist?
 
-      def text_header
-        titles = TEXT_COLUMNS.map do |column|
-          format("%-#{column[:width]}s", column[:name])
-        end.join("|")
+        serializer = Serializer.new(account.local_path, folder.name)
+        local_uids = serializer.uids
+        Logger.logger.debug("[Stats] fetching email list for '#{folder.name}'")
+        remote_uids = folder.uids
+        {
+          folder: folder.name,
+          remote: (remote_uids - local_uids).count,
+          both: (serializer.uids & folder.uids).count,
+          local: (local_uids - remote_uids).count
+        }
+      end.compact
+    end
+
+    def format_text(stats)
+      Kernel.puts text_header
 
-        underline = TEXT_COLUMNS.map do |column|
-          "-" * column[:width]
+      stats.each do |stat|
+        columns = TEXT_COLUMNS.map do |column|
+          symbol = ALIGNMENT_FORMAT_SYMBOL[column[:alignment]]
+          count = stat[column[:name]]
+          format("%#{symbol}#{column[:width]}s", count)
         end.join("|")
 
-        "#{titles}\n#{underline}"
+        Kernel.puts columns
       end
     end
+
+    def text_header
+      titles = TEXT_COLUMNS.map do |column|
+        format("%-#{column[:width]}s", column[:name])
+      end.join("|")
+
+      underline = TEXT_COLUMNS.map do |column|
+        "-" * column[:width]
+      end.join("|")
+
+      "#{titles}\n#{underline}"
+    end
   end
 end

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

@@ -14,18 +14,6 @@ module Imap::Backup
 
     ACTIONS = %i(migrate mirror).freeze
 
-    attr_reader :action
-    attr_accessor :automatic_namespaces
-    attr_accessor :config_path
-    attr_accessor :destination_delimiter
-    attr_reader :destination_email
-    attr_accessor :destination_prefix
-    attr_reader :options
-    attr_accessor :reset
-    attr_accessor :source_delimiter
-    attr_reader :source_email
-    attr_accessor :source_prefix
-
     def initialize(action, source_email, destination_email, options)
       super([])
       @action = action
@@ -57,108 +45,120 @@ module Imap::Backup
           end
         end
       end
+    end
 
-      def process_options!
-        self.automatic_namespaces = options[:automatic_namespaces] || false
-        self.config_path = options[:config]
-        self.destination_delimiter = options[:destination_delimiter]
-        self.destination_prefix = options[:destination_prefix]
-        self.source_delimiter = options[:source_delimiter]
-        self.source_prefix = options[:source_prefix]
-        self.reset = options[:reset] || false
-        check_accounts!
-        choose_prefixes_and_delimiters!
-      end
+    private
 
-      def check_accounts!
-        if destination_email == source_email
-          raise "Source and destination accounts cannot be the same!"
-        end
+    attr_reader :action
+    attr_accessor :automatic_namespaces
+    attr_accessor :config_path
+    attr_accessor :destination_delimiter
+    attr_reader :destination_email
+    attr_accessor :destination_prefix
+    attr_reader :options
+    attr_accessor :reset
+    attr_accessor :source_delimiter
+    attr_reader :source_email
+    attr_accessor :source_prefix
 
-        raise "Account '#{destination_email}' does not exist" if !destination_account
+    def process_options!
+      self.automatic_namespaces = options[:automatic_namespaces] || false
+      self.config_path = options[:config]
+      self.destination_delimiter = options[:destination_delimiter]
+      self.destination_prefix = options[:destination_prefix]
+      self.source_delimiter = options[:source_delimiter]
+      self.source_prefix = options[:source_prefix]
+      self.reset = options[:reset] || false
+      check_accounts!
+      choose_prefixes_and_delimiters!
+    end
 
-        raise "Account '#{source_email}' does not exist" if !source_account
+    def check_accounts!
+      if destination_email == source_email
+        raise "Source and destination accounts cannot be the same!"
       end
 
-      def choose_prefixes_and_delimiters!
-        if automatic_namespaces
-          ensure_no_prefix_or_delimiter_parameters!
-          query_servers_for_settings
-        else
-          add_prefix_and_delimiter_defaults
-        end
-      end
+      raise "Account '#{destination_email}' does not exist" if !destination_account
 
-      def ensure_no_prefix_or_delimiter_parameters!
-        if destination_delimiter
-          raise "--automatic-namespaces is incompatible with --destination-delimiter"
-        end
-        if destination_prefix
-          raise "--automatic-namespaces is incompatible with --destination-prefix"
-        end
-        raise "--automatic-namespaces is incompatible with --source-delimiter" if source_delimiter
-        raise "--automatic-namespaces is incompatible with --source-prefix" if source_prefix
-      end
+      raise "Account '#{source_email}' does not exist" if !source_account
+    end
 
-      def query_servers_for_settings
-        self.destination_prefix, self.destination_delimiter = account_settings(destination_account)
-        self.source_prefix, self.source_delimiter = account_settings(source_account)
+    def choose_prefixes_and_delimiters!
+      if automatic_namespaces
+        ensure_no_prefix_or_delimiter_parameters!
+        query_servers_for_settings
+      else
+        add_prefix_and_delimiter_defaults
       end
+    end
 
-      def account_settings(account)
-        namespaces = account.client.namespace
-        personal = namespaces.personal.first
-        [personal.prefix, personal.delim]
+    def ensure_no_prefix_or_delimiter_parameters!
+      if destination_delimiter
+        raise "--automatic-namespaces is incompatible with --destination-delimiter"
       end
+      raise "--automatic-namespaces is incompatible with --destination-prefix" if destination_prefix
+      raise "--automatic-namespaces is incompatible with --source-delimiter" if source_delimiter
+      raise "--automatic-namespaces is incompatible with --source-prefix" if source_prefix
+    end
 
-      def add_prefix_and_delimiter_defaults
-        self.destination_delimiter ||= "/"
-        self.destination_prefix ||= ""
-        self.source_delimiter ||= "/"
-        self.source_prefix ||= ""
-      end
+    def query_servers_for_settings
+      self.destination_prefix, self.destination_delimiter = account_settings(destination_account)
+      self.source_prefix, self.source_delimiter = account_settings(source_account)
+    end
 
-      def prepare_mirror
-        warn_if_source_account_is_not_in_mirror_mode
+    def account_settings(account)
+      namespaces = account.client.namespace
+      personal = namespaces.personal.first
+      [personal.prefix, personal.delim]
+    end
 
-        CLI::Backup.new(config: config_path, accounts: source_email).run
-      end
+    def add_prefix_and_delimiter_defaults
+      self.destination_delimiter ||= "/"
+      self.destination_prefix ||= ""
+      self.source_delimiter ||= "/"
+      self.source_prefix ||= ""
+    end
 
-      def warn_if_source_account_is_not_in_mirror_mode
-        return if source_account.mirror_mode
+    def prepare_mirror
+      warn_if_source_account_is_not_in_mirror_mode
 
-        message =
-          "The account '#{source_account.username}' " \
-          "is not set up to make mirror backups"
-        Logger.logger.warn message
-      end
+      CLI::Backup.new(config: config_path, accounts: source_email).run
+    end
 
-      def config
-        @config ||= load_config(config: config_path)
-      end
+    def warn_if_source_account_is_not_in_mirror_mode
+      return if source_account.mirror_mode
 
-      def enumerator_options
-        {
-          destination: destination_account,
-          destination_delimiter: destination_delimiter,
-          destination_prefix: destination_prefix,
-          source: source_account,
-          source_delimiter: source_delimiter,
-          source_prefix: source_prefix
-        }
-      end
+      message =
+        "The account '#{source_account.username}' " \
+        "is not set up to make mirror backups"
+      Logger.logger.warn message
+    end
 
-      def folders
-        CLI::FolderEnumerator.new(**enumerator_options)
-      end
+    def config
+      @config ||= load_config(config: config_path)
+    end
 
-      def destination_account
-        config.accounts.find { |a| a.username == destination_email }
-      end
+    def enumerator_options
+      {
+        destination: destination_account,
+        destination_delimiter: destination_delimiter,
+        destination_prefix: destination_prefix,
+        source: source_account,
+        source_delimiter: source_delimiter,
+        source_prefix: source_prefix
+      }
+    end
 
-      def source_account
-        config.accounts.find { |a| a.username == source_email }
-      end
+    def folders
+      CLI::FolderEnumerator.new(**enumerator_options)
+    end
+
+    def destination_account
+      config.accounts.find { |a| a.username == destination_email }
+    end
+
+    def source_account
+      config.accounts.find { |a| a.username == source_email }
     end
   end
 end