imap-backup 11.0.0 → 11.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1392301e243a9affe750a9361f14622228879596b8cb0a29e4944dd91af52d44
-  data.tar.gz: d85f59f5387d5f3c5ac1f6ce97a4a2e5a685ca675b02be3982c914774485d5fc
+  metadata.gz: fce713a5edcf2115c1f8636cfe7b6521aae0403a9bb79dfaf05b484363dbb7ad
+  data.tar.gz: 68544128dba3ade90077683c14d454596a514368cb40a46094934ec94220a606
 SHA512:
-  metadata.gz: ef636f637cf6ab48a173439e6d4c908fa7bf0b8a171a7ba60a80b83062e95d30aafba0e52a4647b5c74b23a40b7504132803ad4ddc57907e3b08298e11b9a26c
-  data.tar.gz: 1274d7462c5e302bd1ea84529b12d74e6cc0ebe47ba6d755e2f23cdb5829dfde6fdde858c2640abea5f6f13eab8e5867334e82f5e4b7649ae41385a49f5706ca
+  metadata.gz: f5b467457df7840d8cf69cc4ace9758cfc2b38242acdb3f4c75a9dd0327c996995aa0986f649725c57e8b058ad0be4d386d9760720a20d505c3154e2a82aa59c
+  data.tar.gz: 3dd8a7f189e0d313e487b63fd64d7c57a647d384360e4128f2787cb7673f1db35a05ffb4853603e7bafbe17537a1b309a43a825180a910e45abc202630283eb9

data/lib/email/mboxrd/message.rb

@@ -28,7 +28,9 @@ module Email::Mboxrd
     end
 
     def to_serialized
-      "From #{from}\n" + mboxrd_body
+      from_line = "From #{from}\n"
+      body = mboxrd_body.dup.force_encoding(Encoding::UTF_8)
+      from_line + body
     end
 
     def date

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

@@ -1,10 +1,7 @@
+require "imap/backup/account/backup_folders"
+require "imap/backup/account/folder_backup"
 require "imap/backup/account/folder_ensurer"
 require "imap/backup/account/local_only_folder_deleter"
-require "imap/backup/account/serialized_folders"
-require "imap/backup/serializer/delayed_metadata_serializer"
-require "imap/backup/downloader"
-require "imap/backup/flag_refresher"
-require "imap/backup/local_only_message_deleter"
 
 module Imap; end
 
@@ -27,66 +24,15 @@ module Imap::Backup
 
       Account::FolderEnsurer.new(account: account).run
       Account::LocalOnlyFolderDeleter.new(account: account).run if account.mirror_mode
-      each_folder do |folder, serializer|
-        begin
-          next if !folder.exist?
-        rescue Encoding::UndefinedConversionError
-          message = "Skipping backup for '#{folder.name}' " \
-                    "as it is not UTF-7 encoded correctly"
-          Logger.logger.info message
-          next
-        end
-
-        Logger.logger.debug "[#{folder.name}] running backup"
-
-        serializer.apply_uid_validity(folder.uid_validity)
-
-        download_serializer =
-          case account.download_strategy
-          when "direct"
-            serializer
-          when "delay_metadata"
-            Serializer::DelayedMetadataSerializer.new(serializer: serializer)
-          else
-            raise "Unknown download strategy '#{account.download_strategy}'"
-          end
-
-        downloader = Downloader.new(
-          folder,
-          download_serializer,
-          multi_fetch_size: account.multi_fetch_size,
-          reset_seen_flags_after_fetch: account.reset_seen_flags_after_fetch
-        )
-        # rubocop:disable Lint/RescueException
-        download_serializer.transaction do
-          downloader.run
-        rescue Exception => e
-          message = <<~ERROR
-            #{self.class} error #{e}
-            #{e.backtrace.join("\n")}
-          ERROR
-          Logger.logger.error message
-          download_serializer.rollback
-          raise e
-        end
-        # rubocop:enable Lint/RescueException
-        if account.mirror_mode
-          Logger.logger.info "Mirror mode - Deleting messages only present locally"
-          LocalOnlyMessageDeleter.new(folder, serializer).run
-        end
-        FlagRefresher.new(folder, serializer).run if account.mirror_mode || refresh
-      end
-    end
-
-    private
-
-    def each_folder
       backup_folders = Account::BackupFolders.new(
         client: account.client, account: account
       )
+      if backup_folders.none?
+        Logger.logger.warn "Account #{account.username}: No folders found to backup"
+        return
+      end
       backup_folders.each do |folder|
-        serializer = Serializer.new(account.local_path, folder.name)
-        yield folder, serializer
+        Account::FolderBackup.new(account: account, folder: folder, refresh: refresh).run
       end
     end
   end

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

@@ -4,6 +4,8 @@ module Imap::Backup
   class Account; end
 
   class Account::BackupFolders
+    include Enumerable
+
     attr_reader :account
     attr_reader :client
 

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

@@ -0,0 +1,85 @@
+require "imap/backup/serializer/delayed_metadata_serializer"
+require "imap/backup/downloader"
+require "imap/backup/flag_refresher"
+require "imap/backup/local_only_message_deleter"
+
+module Imap; end
+
+module Imap::Backup
+  class Account; end
+
+  class Account::FolderBackup
+    attr_reader :account
+    attr_reader :folder
+    attr_reader :refresh
+
+    def initialize(account:, folder:, refresh: false)
+      @account = account
+      @folder = folder
+      @refresh = refresh
+    end
+
+    def run
+      folder_ok = folder_ok?
+      return if !folder_ok
+
+      Logger.logger.debug "[#{folder.name}] running backup"
+
+      serializer.apply_uid_validity(folder.uid_validity)
+
+      download_serializer.transaction do
+        downloader.run
+      end
+
+      clean_up
+    end
+
+    private
+
+    def folder_ok?
+      begin
+        return false if !folder.exist?
+      rescue Encoding::UndefinedConversionError
+        message = "Skipping backup for '#{folder.name}' " \
+                  "as it is not UTF-7 encoded correctly"
+        Logger.logger.info message
+        return false
+      end
+
+      true
+    end
+
+    def clean_up
+      if account.mirror_mode
+        Logger.logger.info "Mirror mode - Deleting messages only present locally"
+        LocalOnlyMessageDeleter.new(folder, serializer).run
+      end
+      FlagRefresher.new(folder, serializer).run if account.mirror_mode || refresh
+    end
+
+    def downloader
+      @downloader ||= Downloader.new(
+        folder,
+        download_serializer,
+        multi_fetch_size: account.multi_fetch_size,
+        reset_seen_flags_after_fetch: account.reset_seen_flags_after_fetch
+      )
+    end
+
+    def download_serializer
+      @download_serializer ||=
+        case account.download_strategy
+        when "direct"
+          serializer
+        when "delay_metadata"
+          Serializer::DelayedMetadataSerializer.new(serializer: serializer)
+        else
+          raise "Unknown download strategy '#{account.download_strategy}'"
+        end
+    end
+
+    def serializer
+      @serializer ||= Serializer.new(account.local_path, folder.name)
+    end
+  end
+end

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

@@ -19,7 +19,12 @@ module Imap::Backup
       def run
         config = load_config(**options)
         exit_code = nil
-        requested_accounts(config).each do |account|
+        accounts = requested_accounts(config)
+        if accounts.none?
+          Logger.logger.warn "No matching accounts found to backup"
+          return
+        end
+        accounts.each do |account|
           backup = Account::Backup.new(account: account, refresh: refresh)
           backup.run
         rescue StandardError => e

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

@@ -0,0 +1,62 @@
+module Imap; end
+
+module Imap::Backup
+  class CLI; end
+  class CLI::Local < Thor; end
+
+  class CLI::Local::Check
+    include CLI::Helpers
+
+    attr_reader :options
+
+    def initialize(options)
+      @options = options
+    end
+
+    def run
+      results = requested_accounts(config).map do |account|
+        serialized_folders = Account::SerializedFolders.new(account: account)
+        folder_results = serialized_folders.map do |serializer, _folder|
+          serializer.check_integrity!
+          {name: serializer.folder, result: "OK"}
+        rescue Serializer::FolderIntegrityError => e
+          message = e.to_s
+          if options[:delete_corrupt]
+            serializer.delete
+            message << " and has been deleted"
+          end
+
+          {
+            name: serializer.folder,
+            result: message
+          }
+        end
+        {account: account.username, folders: folder_results}
+      end
+
+      case options[:format]
+      when "json"
+        print_check_results_as_json(results)
+      else
+        print_check_results_as_text(results)
+      end
+    end
+
+    def print_check_results_as_json(results)
+      Kernel.puts results.to_json
+    end
+
+    def print_check_results_as_text(results)
+      results.each do |account_results|
+        Kernel.puts "Account: #{account_results[:account]}"
+        account_results[:folders].each do |folder_results|
+          Kernel.puts "\t#{folder_results[:name]}: #{folder_results[:result]}"
+        end
+      end
+    end
+
+    def config
+      @config ||= load_config(**options)
+    end
+  end
+end

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

@@ -1,3 +1,6 @@
+require "imap/backup/account/serialized_folders"
+require "imap/backup/cli/local/check"
+
 module Imap; end
 
 module Imap::Backup
@@ -38,32 +41,8 @@ module Imap::Backup
     quiet_option
     verbose_option
     def check
-      results = requested_accounts(config).map do |account|
-        serialized_folders = Account::SerializedFolders.new(account: account)
-        folder_results = serialized_folders.map do |serializer, _folder|
-          serializer.check_integrity!
-          {name: serializer.folder, result: "OK"}
-        rescue Serializer::FolderIntegrityError => e
-          message = e.to_s
-          if options[:delete_corrupt]
-            serializer.delete
-            message << " and has been deleted"
-          end
-
-          {
-            name: serializer.folder,
-            result: message
-          }
-        end
-        {account: account.username, folders: folder_results}
-      end
-
-      case options[:format]
-      when "json"
-        print_check_results_as_json(results)
-      else
-        print_check_results_as_text(results)
-      end
+      non_logging_options = Imap::Backup::Logger.setup_logging(options)
+      Check.new(non_logging_options).run
     end
 
     desc "folders EMAIL", "List backed up folders"
@@ -138,19 +117,6 @@ module Imap::Backup
     end
 
     no_commands do
-      def print_check_results_as_json(results)
-        Kernel.puts results.to_json
-      end
-
-      def print_check_results_as_text(results)
-        results.each do |account_results|
-          Kernel.puts "Account: #{account_results[:account]}"
-          account_results[:folders].each do |folder_results|
-            Kernel.puts "\t#{folder_results[:name]}: #{folder_results[:result]}"
-          end
-        end
-      end
-
       def list_emails_as_json(serializer)
         emails = serializer.each_message.map do |message|
           {

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

@@ -20,23 +20,13 @@ module Imap::Backup
     def transaction(&block)
       tsx.fail_in_transaction!(:transaction, message: "nested transactions are not supported")
 
-      # rubocop:disable Lint/RescueException
       tsx.begin({metadata: []}) do
         mbox.transaction do
           block.call
 
           commit
-        rescue Exception => e
-          message = <<~ERROR
-            #{self.class} error #{e}
-            #{e.backtrace.join("\n")}
-          ERROR
-          Logger.logger.error message
-          mbox.rollback
-          raise e
         end
       end
-      # rubocop:enable Lint/RescueException
     end
 
     def append(uid, message, flags)
@@ -56,6 +46,7 @@ module Imap::Backup
           imap.append m[:uid], m[:length], flags: m[:flags]
         end
       rescue Exception => e
+        Logger.logger.error "#{self.class} handling #{e.class}"
         imap.rollback
         raise e
       end

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

@@ -31,6 +31,7 @@ module Imap::Backup
 
         save_internal(version: version, uid_validity: uid_validity, messages: messages) if tsx.data
       rescue Exception => e
+        Logger.logger.error "#{self.class} handling #{e.class}"
         rollback
         raise e
       end

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

@@ -15,26 +15,22 @@ module Imap::Backup
     def transaction(&block)
       tsx.fail_in_transaction!(:transaction, message: "nested transactions are not supported")
 
-      # rubocop:disable Lint/RescueException
       tsx.begin({savepoint: {length: length}}) do
         block.call
-      rescue Exception => e
-        message = <<~ERROR
-          #{self.class} error #{e}
-          #{e.backtrace.join("\n")}
-        ERROR
-        Logger.logger.error message
+      rescue StandardError => e
+        rollback
+        raise e
+      rescue SignalException => e
+        Logger.logger.error "#{self.class} handling #{e.class}"
         rollback
         raise e
       end
-      # rubocop:enable Lint/RescueException
     end
 
     def rollback
       tsx.fail_outside_transaction!(:rollback)
 
       rewind(tsx.data[:savepoint][:length])
-      tsx.clear
     end
 
     def valid?

data/lib/imap/backup/serializer.rb

@@ -37,9 +37,6 @@ module Imap::Backup
       block.call
     end
 
-    def rollback
-    end
-
     # Returns true if there are existing, valid files
     # false otherwise (in which case any existing files are deleted)
     def validate!

data/lib/imap/backup/version.rb

@@ -2,8 +2,8 @@ module Imap; end
 
 module Imap::Backup
   MAJOR    = 11
-  MINOR    = 0
+  MINOR    = 1
   REVISION = 0
-  PRE      = nil
+  PRE      = "rc1".freeze
   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: 11.0.0
+  version: 11.1.0.rc1
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-25 00:00:00.000000000 Z
+date: 2023-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -236,6 +236,7 @@ files:
 - lib/imap/backup/account/backup_folders.rb
 - lib/imap/backup/account/client_factory.rb
 - lib/imap/backup/account/folder.rb
+- lib/imap/backup/account/folder_backup.rb
 - lib/imap/backup/account/folder_ensurer.rb
 - lib/imap/backup/account/local_only_folder_deleter.rb
 - lib/imap/backup/account/restore.rb
@@ -245,6 +246,7 @@ files:
 - lib/imap/backup/cli/folder_enumerator.rb
 - lib/imap/backup/cli/helpers.rb
 - lib/imap/backup/cli/local.rb
+- lib/imap/backup/cli/local/check.rb
 - lib/imap/backup/cli/migrate.rb
 - lib/imap/backup/cli/mirror.rb
 - lib/imap/backup/cli/remote.rb
@@ -310,9 +312,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.7
 signing_key: