imap-backup 15.0.1 → 15.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3504dad0e3f788bcfa95b38065e0ff4035239886461689c478a2e991f5e06cf9
-  data.tar.gz: 7d1151b5fb25f2d84ae2013f8f9f74fee7f998ca36b29333bf44151e52726376
+  metadata.gz: de4f5bfc1260430435d380fd3fa6c315efad4ef503b0429bce041615d3ae2e10
+  data.tar.gz: 3c1541e30cb01d1ecd6da9372e79b8e8c71f119eee5a11770bef76b90e89e037
 SHA512:
-  metadata.gz: 3ec40ec413bd6bedce02d4c823ae1654c06585223532d1260bf01fe4ef0e8ba6e0b8c25c7adf0d2b39f8ff29c5199251d07fb9234a75a3ac50856075c91ccc52
-  data.tar.gz: d31020db8b37295d8d7209758161ce4fe5d16869a6976f3538e12b2d7a74f3cb363328d0dcd79ce665a2b113cf7f6289794ee328ded6e8a73cb544c4d0897428
+  metadata.gz: 25aa565a7860560958b59c5f88f67b470128405acc15fc67fe3683152d0ea9c63d8787287f006249a22b26a88d92425bed653254126ef92259ea85022b33efcb
+  data.tar.gz: 54d8df69cef34dcafd3ba97f63f202b0f00e2306f8e12c4ea7329dfae5028e42e9a4050630fae2d03131048aa3c70e90ee7bb8a49a1388084bd136ad3e0ce973

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

@@ -32,7 +32,7 @@ module Imap::Backup
     # @yieldparam serializer [Serializer] the folder's serializer
     # @yieldparam folder [Account::Folder] the online folder
     # @return [Enumerator, void]
-    def each
+    def each(&block)
       return enum_for(:each) if !block_given?
 
       glob = File.join(source_local_path, "**", "*.imap")
@@ -40,7 +40,7 @@ module Imap::Backup
         name = source_folder_name(path)
         serializer = Serializer.new(source_local_path, name)
         folder = destination_folder_for_path(name)
-        yield serializer, folder
+        block.call(serializer, folder)
       end
     end
 

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

@@ -1,5 +1,6 @@
 require "thor"
 
+require "imap/backup/cli/options"
 require "imap/backup/configuration"
 require "imap/backup/configuration_not_found"
 
@@ -11,67 +12,8 @@ module Imap::Backup
   # Provides helper methods for CLI classes
   module CLI::Helpers
     def self.included(base)
-      base.class_eval do
-        def self.accounts_option
-          method_option(
-            "accounts",
-            type: :string,
-            desc: "a comma-separated list of accounts (defaults to all configured accounts)",
-            aliases: ["-a"]
-          )
-        end
-
-        def self.config_option
-          method_option(
-            "config",
-            type: :string,
-            desc: "supply the configuration file path (default: ~/.imap-backup/config.json)",
-            aliases: ["-c"]
-          )
-        end
-
-        def self.format_option
-          method_option(
-            "format",
-            type: :string,
-            desc: "the output type, 'text' for plain text or 'json'",
-            aliases: ["-f"]
-          )
-        end
-
-        def self.quiet_option
-          method_option(
-            "quiet",
-            type: :boolean,
-            desc: "silence all output",
-            aliases: ["-q"]
-          )
-        end
-
-        def self.refresh_option
-          method_option(
-            "refresh",
-            type: :boolean,
-            desc: "in the default 'keep all emails' mode, " \
-                  "updates flags for messages that are already downloaded",
-            aliases: ["-r"]
-          )
-        end
-
-        def self.verbose_option
-          method_option(
-            "verbose",
-            type: :boolean,
-            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
+      options = CLI::Options.new(base: base)
+      options.define_options
     end
 
     # Processes command-line parameters
@@ -81,7 +23,7 @@ module Imap::Backup
     def options
       @symbolized_options ||= # rubocop:disable Naming/MemoizedInstanceVariableName
         begin
-          options = super()
+          options = super
           options.each.with_object({}) do |(k, v), acc|
             key =
               if k.is_a?(String)

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

@@ -0,0 +1,74 @@
+require "thor"
+
+module Imap; end
+
+module Imap::Backup
+  class CLI < Thor; end
+
+  # Defines option methods for CLI classes
+  class CLI::Options
+    attr_reader :base
+
+    # Options common to many commands
+    OPTIONS = [
+      {
+        name: "accounts",
+        parameters: {
+          type: :string, aliases: ["-a"],
+          desc: "a comma-separated list of accounts (defaults to all configured accounts)"
+        }
+      },
+      {
+        name: "config",
+        parameters: {
+          type: :string, aliases: ["-c"],
+          desc: "supply the configuration file path (default: ~/.imap-backup/config.json)"
+        }
+      },
+      {
+        name: "format",
+        parameters: {
+          type: :string, desc: "the output type, 'text' for plain text or 'json'", aliases: ["-f"]
+        }
+      },
+      {
+        name: "quiet",
+        parameters: {
+          type: :boolean, desc: "silence all output", aliases: ["-q"]
+        }
+      },
+      {
+        name: "refresh",
+        parameters: {
+          type: :boolean, aliases: ["-r"],
+          desc: "in the default 'keep all emails' mode, " \
+                "updates flags for messages that are already downloaded"
+        }
+      },
+      {
+        name: "verbose",
+        parameters: {
+          type: :boolean, aliases: ["-v"], repeatable: true,
+          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"
+        }
+      }
+    ].freeze
+
+    def initialize(base:)
+      @base = base
+    end
+
+    def define_options
+      OPTIONS.each do |option|
+        base.singleton_class.class_eval do
+          define_method("#{option[:name]}_option") do
+            method_option(option[:name], **option[:parameters])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/imap/backup/flag_refresher.rb

@@ -28,6 +28,13 @@ module Imap::Backup
 
     def refresh_block(uids)
       uids_and_flags = folder.fetch_multi(uids, ["FLAGS"])
+      if !uids_and_flags
+        Logger.logger.debug(
+          "[#{folder.name}] failed to fetch flags for #{uids} - " \
+          "cannot refresh flags"
+        )
+        return
+      end
       uids_and_flags.each do |uid_and_flags|
         uid = uid_and_flags[:uid]
         flags = uid_and_flags[:flags]

data/lib/imap/backup/logger.rb

@@ -51,11 +51,11 @@ module Imap::Backup
     # Wraps a block, filtering output to standard error,
     # hidng passwords and outputs the results to standard out
     # @return [void]
-    def self.sanitize_stderr
+    def self.sanitize_stderr(&block)
       sanitizer = Text::Sanitizer.new($stdout)
       previous_stderr = $stderr
       $stderr = sanitizer
-      yield
+      block.call
     ensure
       sanitizer.flush
       $stderr = previous_stderr

data/lib/imap/backup/retry_on_error.rb

@@ -13,9 +13,9 @@ module Imap::Backup
     # @param on_error [Proc] a block to call when an error occurs
     # @raise any error ocurring more than `limit` times
     # @return the result of any successful completion of the block
-    def retry_on_error(errors:, limit: 10, on_error: nil)
+    def retry_on_error(errors:, limit: 10, on_error: nil, &block)
       tries ||= 1
-      yield
+      block.call
     rescue *errors => e
       if tries < limit
         message = "#{e}, attempt #{tries} of #{limit}"

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

@@ -14,14 +14,14 @@ module Imap::Backup
     # @param uids [Array<Integer>] the message UIDs of the messages to iterate over
     # @yieldparam message [Serializer::Message]
     # @return [void]
-    def run(uids:)
+    def run(uids:, &block)
       uids.each do |uid_maybe_string|
         uid = uid_maybe_string.to_i
         message = imap.get(uid)
 
         next if !message
 
-        yield message
+        block.call(message)
       end
     end
 

data/lib/imap/backup/version.rb

@@ -6,7 +6,7 @@ module Imap::Backup
   # @private
   MINOR    = 0
   # @private
-  REVISION = 1
+  REVISION = 2
   # @private
   PRE      = nil
   # The application version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 15.0.1
+  version: 15.0.2
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2024-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -153,6 +153,7 @@ files:
 - lib/imap/backup/cli/helpers.rb
 - lib/imap/backup/cli/local.rb
 - lib/imap/backup/cli/local/check.rb
+- lib/imap/backup/cli/options.rb
 - lib/imap/backup/cli/remote.rb
 - lib/imap/backup/cli/restore.rb
 - lib/imap/backup/cli/setup.rb