imap-backup 13.3.0 → 13.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52be0d33c65e865c04931e81821a563e8203a001a951b8ec6624f0fded2180aa
-  data.tar.gz: 2fece56b157329aa6e8cd0bc73d66d5ec3c3923f126822977910dc904d955a1a
+  metadata.gz: b20d641221d0ad7716b1d5a52f28c80929197d4d22bcfdaab574061f5ba7640a
+  data.tar.gz: 3c6ae086014f6ec6568eb9c226e17928877f1d972898bd3ec0e139ba09983cfb
 SHA512:
-  metadata.gz: 26c0c0434bf7743a3ce9b8b6c0f24b05b14682f4e52fcacf4813cec7a913df720f6413a066b25db810e04d4e18411cfbd79119430f37785186b3013757a2e76d
-  data.tar.gz: 3f250c3272221488bb8b9c08b1f68198a1a6b3f45bd75c31ccc6b2284c0e2130d65bcd91783c6c85b65b4e1bbdbe09378a1ff15e595f8ab3ae016d2faeb53aee
+  metadata.gz: c85149c357c98f822dfe057e096094613f47f2ce31c039757798641145b158550b8ca43cd3e261fa655b769c850ddc08a8a333aaca24193d3c18c1392d4fd526
+  data.tar.gz: fdf5867043ad025ee8080f968f4d0c11df8b4fd2fd95c31bc2f68c34e0b79865a4ae5e7b700876185356c0f03aba9719bcd5cfe68cb1380a56a144b393f0d101

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

@@ -24,7 +24,7 @@ module Imap::Backup
       configured =
         case
         when account.folders&.any?
-          account.folders.map { |af| af[:name] }
+          account.folders
         when account.folder_blacklist
           []
         else

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

@@ -1,6 +1,8 @@
 require "forwardable"
+require "logger"
 require "net/imap"
 
+require "imap/backup/logger"
 require "retry_on_error"
 
 module Imap; end
@@ -31,12 +33,19 @@ module Imap::Backup
     end
 
     def exist?
+      previous_level = Imap::Backup::Logger.logger.level
+      previous_debug = Net::IMAP.debug
+      Imap::Backup::Logger.logger.level = ::Logger::Severity::UNKNOWN
+      Net::IMAP.debug = false
       retry_on_error(errors: EXAMINE_RETRY_CLASSES) do
         examine
       end
       true
     rescue FolderNotFound
       false
+    ensure
+      Imap::Backup::Logger.logger.level = previous_level
+      Net::IMAP.debug = previous_debug
     end
 
     def create
@@ -68,7 +77,7 @@ module Imap::Backup
         'This is caused by `@responses["SEARCH"] being unset/undefined. ' \
         "Among others, Apple Mail servers send empty responses when " \
         "folders are empty, causing this error."
-      Logger.logger.warn message
+      Imap::Backup::Logger.logger.warn message
       []
     end
 
@@ -150,7 +159,8 @@ module Imap::Backup
     def examine
       client.examine(utf7_encoded_name)
     rescue Net::IMAP::NoResponseError
-      Logger.logger.warn "Folder '#{name}' does not exist on server"
+      Imap::Backup::Logger.logger.warn "Folder '#{name}' does not exist on server"
+      Imap::Backup::Logger.logger.warn caller.join("\n")
       raise FolderNotFound, "Folder '#{name}' does not exist on server"
     end
 

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

@@ -1,6 +1,7 @@
 require "thor"
 
 require "imap/backup/configuration"
+require "imap/backup/configuration_not_found"
 
 module Imap; end
 
@@ -50,8 +51,13 @@ module Imap::Backup
           method_option(
             "verbose",
             type: :boolean,
-            desc: "increase the amount of logging",
-            aliases: ["-v"]
+            desc:
+              "increase the amount of logging. " \
+              "Without this option, the program gives minimal output. " \
+              "Using this option once gives more detailed output. " \
+              "Whereas, using this option twice also shows all IMAP network calls",
+            aliases: ["-v"],
+            repeatable: true
           )
         end
       end

data/lib/imap/backup/cli.rb

@@ -1,6 +1,7 @@
 require "thor"
 
 require "imap/backup/logger"
+require "imap/backup/version"
 
 module Imap; end
 
@@ -19,8 +20,6 @@ module Imap::Backup
 
     include Helpers
 
-    VERSION_ARGUMENTS = %w(-v --version).freeze
-
     NAMESPACE_CONFIGURATION_DESCRIPTION = <<~DESC.freeze
       Some IMAP servers use namespaces (i.e. prefixes like "INBOX"),
       while others, while others concatenate the names of subfolders
@@ -44,9 +43,8 @@ module Imap::Backup
 
     default_task :backup
 
-    def self.start(*args)
-      version_argument = ARGV & VERSION_ARGUMENTS
-      if version_argument.any?
+    def self.start(args)
+      if args.include?("--version")
         new.version
         exit 0
       end
@@ -171,6 +169,10 @@ module Imap::Backup
       a new file is created alongside the normal backup files (.imap and .mbox)
       This file has a '.mirror' extension. This file contains a mapping of
       the known UIDs on the source account to those on the destination account.
+
+      Some configuration may be necessary, as follows:
+
+      #{NAMESPACE_CONFIGURATION_DESCRIPTION}
     DESC
     config_option
     quiet_option

data/lib/imap/backup/configuration.rb

@@ -11,7 +11,8 @@ module Imap; end
 module Imap::Backup
   class Configuration
     CONFIGURATION_DIRECTORY = File.expand_path("~/.imap-backup")
-    VERSION = "2.1".freeze
+    VERSION_2_1 = "2.1".freeze
+    VERSION = "2.2".freeze
     DEFAULT_STRATEGY = "delay_metadata".freeze
     DOWNLOAD_STRATEGIES = [
       {key: "direct", description: "write straight to disk"},
@@ -81,7 +82,7 @@ module Imap::Backup
       inject_global_attributes(accounts)
     end
 
-    def download_strategy_modified
+    def download_strategy_modified?
       ensure_loaded!
 
       @download_strategy_modified
@@ -90,7 +91,7 @@ module Imap::Backup
     def modified?
       ensure_loaded!
 
-      return true if download_strategy_modified
+      return true if download_strategy_modified?
 
       accounts.any? { |a| a.modified? || a.marked_for_deletion? }
     end
@@ -121,12 +122,30 @@ module Imap::Backup
             else
               DEFAULT_STRATEGY
             end
-          data
+          if data[:version] == VERSION_2_1
+            dehashify_folders(data)
+          else
+            data
+          end
         else
           {accounts: [], download_strategy: DEFAULT_STRATEGY}
         end
     end
 
+    def dehashify_folders(data)
+      data[:version] = VERSION
+
+      data[:accounts].each do |account|
+        next if !account.key?(:folders)
+
+        folders = account[:folders]
+        names = folders.map { |f| f[:name] }
+        account[:folders] = names
+      end
+
+      data
+    end
+
     def remove_modified_flags
       @download_strategy_modified = false
       accounts.each(&:clear_changes)

data/lib/imap/backup/downloader.rb

@@ -1,3 +1,5 @@
+require "net/imap"
+
 module Imap; end
 
 module Imap::Backup

data/lib/imap/backup/logger.rb

@@ -16,19 +16,20 @@ module Imap::Backup
     def self.setup_logging(options = {})
       copy = options.clone
       quiet = copy.delete(:quiet)
-      verbose = copy.delete(:verbose)
+      verbose = copy.delete(:verbose) || []
+      verbose_count = count(verbose)
       level =
         case
         when quiet
           ::Logger::Severity::UNKNOWN
-        when verbose
+        when verbose_count >= 2
           ::Logger::Severity::DEBUG
         else
           ::Logger::Severity::INFO
         end
       logger.level = level
-      debug = level == ::Logger::Severity::DEBUG
-      Net::IMAP.debug = debug
+
+      Net::IMAP.debug = (verbose_count >= 3)
 
       copy
     end
@@ -43,6 +44,10 @@ module Imap::Backup
       $stderr = previous_stderr
     end
 
+    def self.count(verbose)
+      verbose.reduce(1) { |acc, v| acc + (v ? 1 : -1) }
+    end
+
     attr_reader :logger
 
     def initialize

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

@@ -78,7 +78,7 @@ module Imap::Backup
       list =
         case
         when items.any?
-          items.map { |f| f[:name] }.join(", ")
+          items.join(", ")
         when !account.folder_blacklist
           "(all folders)"
         else

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

@@ -1,3 +1,5 @@
+require "net/imap"
+
 module Imap; end
 
 module Imap::Backup

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

@@ -63,18 +63,18 @@ module Imap::Backup
       config_folders = account.folders
       return false if config_folders.nil?
 
-      config_folders.find { |f| f[:name] == folder_name }
+      config_folders.find { |f| f == folder_name }
     end
 
     def remove_missing
       removed = []
       config_folders = []
       account.folders.each do |f|
-        found = folder_names.find { |folder| folder == f[:name] }
+        found = folder_names.find { |folder| folder == f }
         if found
           config_folders << f
         else
-          removed << f[:name]
+          removed << f
         end
       end
 
@@ -91,11 +91,11 @@ module Imap::Backup
 
     def toggle_selection(folder_name)
       if selected?(folder_name)
-        new_list = account.folders.reject { |f| f[:name] == folder_name }
+        new_list = account.folders.reject { |f| f == folder_name }
         account.folders = new_list
       else
         existing = account.folders || []
-        account.folders = existing + [{name: folder_name}]
+        account.folders = existing << folder_name
       end
     end
 

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

@@ -42,7 +42,7 @@ module Imap::Backup
     def change_download_strategy(menu)
       strategies = Imap::Backup::Configuration::DOWNLOAD_STRATEGIES
       current = strategies.find { |s| s[:key] == config.download_strategy }
-      changed = config.download_strategy_modified ? " *" : ""
+      changed = config.download_strategy_modified? ? " *" : ""
       menu.choice("change download strategy (currently: '#{current[:description]}')#{changed}") do
         DownloadStrategyChooser.new(config: config).run
       end

data/lib/imap/backup/setup.rb

@@ -76,7 +76,7 @@ module Imap::Backup
     end
 
     def modify_global_options(menu)
-      changed = config.modified? ? " *" : ""
+      changed = config.download_strategy_modified? ? " *" : ""
       menu.choice("modify global options#{changed}") do
         GlobalOptions.new(config: config).run
       end

data/lib/imap/backup/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 13.3.0
+  version: 13.4.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-06 00:00:00.000000000 Z
+date: 2023-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline