imap-backup 11.0.1 → 11.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12d5752520f0b47c240fe8bc3ac7e600bea9229804c9f2c22c2b5c5218818e79
-  data.tar.gz: 67da4a6a56f0914ad18f44340c52b759d0a5a74a70f32aafd0bb0600fd34c4e9
+  metadata.gz: fce713a5edcf2115c1f8636cfe7b6521aae0403a9bb79dfaf05b484363dbb7ad
+  data.tar.gz: 68544128dba3ade90077683c14d454596a514368cb40a46094934ec94220a606
 SHA512:
-  metadata.gz: 0ab9fe8ce61dcfe6efcbf77415eab8bc6fb4813f10cf4b7f33f7378ac00977a5bb106086e201168bfb8117be3957c7aa9b4bdb513255ab0100fa8b7064f3b2b8
-  data.tar.gz: 14f878065e0603ca18d298f6d209ad1df51d9814487c11fee7ab31b05212a29ad162052831fc95b848abf65ec1ef4152d263f8ae4478e21e6873f2d509c13fb8
+  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
 
@@ -35,58 +32,8 @@ module Imap::Backup
         return
       end
       backup_folders.each do |folder|
-        backup_folder folder
+        Account::FolderBackup.new(account: account, folder: folder, refresh: refresh).run
       end
     end
-
-    private
-
-    def backup_folder(folder)
-      serializer = Serializer.new(account.local_path, folder.name)
-      begin
-        return 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
-      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
-      )
-      download_serializer.transaction do
-        downloader.run
-      rescue StandardError => e
-        message = <<~ERROR
-          #{self.class} error #{e}
-          #{e.backtrace.join("\n")}
-        ERROR
-        Logger.logger.error message
-        raise e
-      end
-      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
 end

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/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/mbox.rb

@@ -18,11 +18,6 @@ module Imap::Backup
       tsx.begin({savepoint: {length: length}}) do
         block.call
       rescue StandardError => e
-        message = <<~ERROR
-          #{self.class} error #{e}
-          #{e.backtrace.join("\n")}
-        ERROR
-        Logger.logger.error message
         rollback
         raise e
       rescue SignalException => e

data/lib/imap/backup/version.rb

@@ -2,8 +2,8 @@ module Imap; end
 
 module Imap::Backup
   MAJOR    = 11
-  MINOR    = 0
-  REVISION = 1
-  PRE      = nil
+  MINOR    = 1
+  REVISION = 0
+  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.1
+  version: 11.1.0.rc1
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-01 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: