imap-backup 2.0.0 → 2.2.2

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

@@ -3,10 +3,12 @@ require "forwardable"
 module Imap::Backup
   module Account; end
 
+  class FolderNotFound < StandardError; end
+
   class Account::Folder
     extend Forwardable
 
-    REQUESTED_ATTRIBUTES = ["RFC822", "FLAGS", "INTERNALDATE"].freeze
+    REQUESTED_ATTRIBUTES = %w[RFC822 FLAGS INTERNALDATE].freeze
 
     attr_reader :connection
     attr_reader :name
@@ -27,12 +29,13 @@ module Imap::Backup
     def exist?
       examine
       true
-    rescue Net::IMAP::NoResponseError => e
+    rescue FolderNotFound
       false
     end
 
     def create
       return if exist?
+
       imap.create(name)
     end
 
@@ -47,8 +50,17 @@ module Imap::Backup
     def uids
       examine
       imap.uid_search(["ALL"]).sort
-    rescue Net::IMAP::NoResponseError
-      Imap::Backup.logger.warn "Folder '#{name}' does not exist"
+    rescue FolderNotFound
+      []
+    rescue NoMethodError
+      message = <<~MESSAGE
+        Folder '#{name}' caused NoMethodError
+        probably
+        `undefined method `[]' for nil:NilClass (NoMethodError)`
+        in `search_internal` in stdlib net/imap.rb.
+        This is caused by `@responses["SEARCH"] being unset/undefined
+      MESSAGE
+      Imap::Backup.logger.warn message
       []
     end
 
@@ -56,12 +68,13 @@ module Imap::Backup
       examine
       fetch_data_items = imap.uid_fetch([uid.to_i], REQUESTED_ATTRIBUTES)
       return nil if fetch_data_items.nil?
+
       fetch_data_item = fetch_data_items[0]
       attributes = fetch_data_item.attr
-      attributes["RFC822"].force_encoding("utf-8")
+      return nil if !attributes.key?("RFC822")
+
       attributes
-    rescue Net::IMAP::NoResponseError
-      Imap::Backup.logger.warn "Folder '#{name}' does not exist"
+    rescue FolderNotFound
       nil
     end
 
@@ -76,6 +89,9 @@ module Imap::Backup
 
     def examine
       imap.examine(name)
+    rescue Net::IMAP::NoResponseError
+      Imap::Backup.logger.warn "Folder '#{name}' does not exist"
+      raise FolderNotFound, "Folder '#{name}' does not exist"
     end
 
     def extract_uid(response)

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

@@ -1,7 +1,7 @@
 module Imap::Backup
   module Configuration; end
 
-  class Configuration::Account < Struct.new(:store, :account, :highline)
+  Configuration::Account = Struct.new(:store, :account, :highline) do
     def initialize(store, account, highline)
       super
     end
@@ -9,7 +9,7 @@ module Imap::Backup
     def run
       catch :done do
         loop do
-          system("clear")
+          Kernel.system("clear")
           create_menu
         end
       end
@@ -46,12 +46,14 @@ module Imap::Backup
     def modify_email(menu)
       menu.choice("modify email") do
         username = Configuration::Asker.email(username)
-        puts "username: #{username}"
+        Kernel.puts "username: #{username}"
         other_accounts = store.accounts.reject { |a| a == account }
         others = other_accounts.map { |a| a[:username] }
-        puts "others: #{others.inspect}"
+        Kernel.puts "others: #{others.inspect}"
         if others.include?(username)
-          puts "There is already an account set up with that email address"
+          Kernel.puts(
+            "There is already an account set up with that email address"
+          )
         else
           account[:username] = username
           if account[:server].nil? || (account[:server] == "")
@@ -82,23 +84,25 @@ module Imap::Backup
       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
-        validator = ->(p) do
-          same = store.accounts.find do |a|
-            a[:username] != account[:username] && a[:local_path] == p
-          end
-          if same
-            puts "The path '#{p}' is used to backup " \
-              "the account '#{same[:username]}'"
-            false
-          else
-            true
-          end
-        end
         existing = account[:local_path].clone
-        account[:local_path] =
-          Configuration::Asker.backup_path(account[:local_path], validator)
+        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
@@ -112,7 +116,7 @@ module Imap::Backup
     def test_connection(menu)
       menu.choice("test connection") do
         result = Configuration::ConnectionTester.test(account)
-        puts result
+        Kernel.puts result
         highline.ask "Press a key "
       end
     end
@@ -141,7 +145,7 @@ module Imap::Backup
     def default_server(username)
       provider = Email::Provider.for_address(username)
       if provider.provider == :default
-        puts "Can't decide provider for email address '#{username}'"
+        Kernel.puts "Can't decide provider for email address '#{username}'"
         return nil
       end
       provider.host

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

@@ -1,8 +1,8 @@
 module Imap::Backup
   module Configuration; end
 
-  class Configuration::Asker < Struct.new(:highline)
-    EMAIL_MATCHER = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]+$/i
+  Configuration::Asker = Struct.new(:highline) do
+    EMAIL_MATCHER = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]+$/i.freeze
 
     def initialize(highline)
       super
@@ -24,6 +24,7 @@ module Imap::Backup
         return nil if !highline.agree(
           "the password and confirmation did not match.\nContinue? (y/n) "
         )
+
         return self.password
       end
       password

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

@@ -7,7 +7,7 @@ module Imap::Backup
       "Connection successful"
     rescue Net::IMAP::NoResponseError
       "No response"
-    rescue Exception => e
+    rescue StandardError => e
       "Unexpected error: #{e}"
     end
   end

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

@@ -21,9 +21,11 @@ module Imap::Backup
         return
       end
 
+      remove_missing
+
       catch :done do
         loop do
-          system("clear")
+          Kernel.system("clear")
           show_menu
         end
       end
@@ -44,21 +46,46 @@ module Imap::Backup
     def add_folders(menu)
       folders.each do |folder|
         name = folder.name
-        mark = is_selected?(name) ? "+" : "-"
+        mark = selected?(name) ? "+" : "-"
         menu.choice("#{mark} #{name}") do
           toggle_selection name
         end
       end
     end
 
-    def is_selected?(folder_name)
+    def selected?(folder_name)
       backup_folders = account[:folders]
       return false if backup_folders.nil?
+
       backup_folders.find { |f| f[:name] == folder_name }
     end
 
+    def remove_missing
+      removed = []
+      backup_folders = []
+      account[:folders].each do |f|
+        found = folders.find { |folder| folder.name == f[:name] }
+        if found
+          backup_folders << f
+        else
+          removed << f[:name]
+        end
+      end
+
+      return if removed.empty?
+
+      account[:folders] = backup_folders
+      account[:modified] = true
+
+      Kernel.puts <<~MESSAGE
+        The following folders have been removed: #{removed.join(', ')}
+      MESSAGE
+
+      highline.ask "Press a key "
+    end
+
     def toggle_selection(folder_name)
-      if is_selected?(folder_name)
+      if selected?(folder_name)
         changed = account[:folders].reject! { |f| f[:name] == folder_name }
         account[:modified] = true if changed
       else
@@ -70,7 +97,7 @@ module Imap::Backup
 
     def connection
       @connection ||= Account::Connection.new(account)
-    rescue
+    rescue StandardError
       nil
     end
 

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

@@ -10,6 +10,7 @@ module Imap::Backup
 
     def setup_logging
       return if !config_exists?
+
       Imap::Backup.setup_logging config
     end
 
@@ -25,6 +26,7 @@ module Imap::Backup
 
     def config
       return @config if @config
+
       if !config_exists?
         path = Configuration::Store.default_pathname
         raise ConfigurationNotFound, "Configuration file '#{path}' not found"

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

@@ -13,7 +13,7 @@ module Imap::Backup
       Imap::Backup.setup_logging config
       catch :done do
         loop do
-          system("clear")
+          Kernel.system("clear")
           show_menu
         end
       end
@@ -40,6 +40,7 @@ module Imap::Backup
     def account_items(menu)
       config.accounts.each do |account|
         next if account[:delete]
+
         item = account[:username].clone
         item << " *" if account[:modified]
         menu.choice(item) do

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

@@ -52,6 +52,7 @@ module Imap::Backup
 
     def data
       return @data if @data
+
       if File.exist?(pathname)
         Utils.check_permissions pathname, 0o600
         contents = File.read(pathname)
@@ -73,12 +74,8 @@ module Imap::Backup
     end
 
     def mkdir_private(path)
-      if !File.directory?(path)
-        FileUtils.mkdir path
-      end
-      if Utils::mode(path) != 0o700
-        FileUtils.chmod 0o700, path
-      end
+      FileUtils.mkdir(path) if !File.directory?(path)
+      FileUtils.chmod(0o700, path) if Utils.mode(path) != 0o700
     end
   end
 end

data/lib/imap/backup/downloader.rb

@@ -4,22 +4,23 @@ module Imap::Backup
     attr_reader :serializer
 
     def initialize(folder, serializer)
-      @folder, @serializer = folder, serializer
+      @folder = folder
+      @serializer = serializer
     end
 
     def run
       uids = folder.uids - serializer.uids
-      Imap::Backup.logger.debug "[#{folder.name}] #{uids.count} new messages"
-      uids.each do |uid|
+      count = uids.count
+      Imap::Backup.logger.debug "[#{folder.name}] #{count} new messages"
+      uids.each.with_index do |uid, i|
         message = folder.fetch(uid)
+        log_prefix = "[#{folder.name}] uid: #{uid} (#{i + 1}/#{count}) -"
         if message.nil?
-          Imap::Backup.logger.debug(
-            "[#{folder.name}] #{uid} - not available - skipped"
-          )
+          Imap::Backup.logger.debug("#{log_prefix} not available - skipped")
           next
         end
         Imap::Backup.logger.debug(
-          "[#{folder.name}] #{uid} - #{message['RFC822'].size} bytes"
+          "#{log_prefix} #{message['RFC822'].size} bytes"
         )
         serializer.save(uid, message)
       end

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

@@ -10,30 +10,16 @@ module Imap::Backup
       @folder = folder
     end
 
-    def set_uid_validity(value)
-      existing_uid_validity = store.uid_validity
+    def apply_uid_validity(value)
       case
-      when existing_uid_validity.nil?
+      when store.uid_validity.nil?
         store.uid_validity = value
         nil
-      when existing_uid_validity == value
+      when store.uid_validity == value
         # NOOP
         nil
       else
-        digit = nil
-        new_name = nil
-        loop do
-          extra = digit ? ".#{digit}" : ""
-          new_name = "#{folder}.#{existing_uid_validity}#{extra}"
-          test_store = Serializer::MboxStore.new(path, new_name)
-          break if !test_store.exist?
-          digit ||= 0
-          digit += 1
-        end
-        store.rename new_name
-        @store = nil
-        store.uid_validity = value
-        new_name
+        apply_new_uid_validity value
       end
     end
 
@@ -49,6 +35,10 @@ module Imap::Backup
       store.load(uid)
     end
 
+    def each_message(uids)
+      store.each_message(uids)
+    end
+
     def save(uid, message)
       store.add(uid, message)
     end
@@ -72,19 +62,48 @@ module Imap::Backup
         end
     end
 
-    def create_containing_directory
-      relative_path = File.dirname(folder)
-      containing_directory = File.join(path, relative_path)
-      full_path = File.expand_path(containing_directory)
+    def apply_new_uid_validity(value)
+      digit = 0
+      new_name = nil
+      loop do
+        extra = digit.zero? ? "" : ".#{digit}"
+        new_name = "#{folder}.#{store.uid_validity}#{extra}"
+        test_store = Serializer::MboxStore.new(path, new_name)
+        break if !test_store.exist?
 
+        digit += 1
+      end
+      rename_store new_name, value
+    end
+
+    def rename_store(new_name, value)
+      store.rename new_name
+      @store = nil
+      store.uid_validity = value
+      new_name
+    end
+
+    def relative_path
+      File.dirname(folder)
+    end
+
+    def containing_directory
+      File.join(path, relative_path)
+    end
+
+    def full_path
+      File.expand_path(containing_directory)
+    end
+
+    def create_containing_directory
       if !File.directory?(full_path)
-        Imap::Backup::Utils.make_folder(
+        Utils.make_folder(
           path, relative_path, Serializer::DIRECTORY_PERMISSIONS
         )
       end
 
-      if Imap::Backup::Utils.mode(full_path) !=
-          Serializer::DIRECTORY_PERMISSIONS
+      if Utils.mode(full_path) !=
+         Serializer::DIRECTORY_PERMISSIONS
         FileUtils.chmod Serializer::DIRECTORY_PERMISSIONS, full_path
       end
     end