imap-backup 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5903e540e8d72a63c70ee1f8f5799710bdef2ffaac58bc6bac617942da6e6da
-  data.tar.gz: d4ad4a77a5a7d86146768a889f697f281c344ca5e4db6f29fc792a0894b2fedd
+  metadata.gz: 78c6ccd7ca7a6f60ae02c24c76c121470372ffbadf268eb6f52b8f6eac633e6d
+  data.tar.gz: d5da356a60a6046301c2e66a990f24948c3dc63f6c7f757ca3da43f62772468d
 SHA512:
-  metadata.gz: fff913ad0270445d6783430d39672e9abe34a67d20546ad03db5ec0c8c6179c5f98524a83546d6e1790b1550284902bf0a161c998a82301ddbbbfb33d845a708
-  data.tar.gz: d0c64c701e183d1bb01b28af7577c237a5ec0d26607ed1856e1c2b6748efe48479c0f71b502db83a8e68c22faab220372541b16edf5d3e5b7ad0af86e933460e
+  metadata.gz: 82fc5680a656d79012690e7da5038f0b8e56b1c5b14168142c222cb2c336bf44c0ec5570fbed8c50b2b2c2ea445ec17bed286d452795aa0c692d61c71d497274
+  data.tar.gz: 7eda772c5b9815dfbbe679981a0a281cecd7e3cc970c95345437d35ddc01b40f5fedb25eabef043271bdd7cfc7084bf7caad6bbd037f5926fabee0d23958252a

data/.rspec

@@ -1,3 +1,2 @@
 --color
 --require spec_helper
---tag ~docker

data/.rubocop.yml

@@ -1,4 +1,6 @@
-inherit_from: https://gitlab.com/snippets/1744945/raw
+inherit_from:
+  - https://gitlab.com/snippets/1744945/raw
+  - .rubocop_todo.yml
 
 AllCops:
   TargetRubyVersion: 2.3
@@ -8,7 +10,8 @@ AllCops:
     Enabled: true
 
 RSpec/ContextWording:
-  Enabled: false
+  Exclude:
+    - "spec/features/**/*"
 RSpec/NestedGroups:
   Max: 4
 RSpec/ReturnFromStub:

data/.rubocop_todo.yml

@@ -0,0 +1,24 @@
+# Offense count: 8
+Metrics/AbcSize:
+  Max: 29
+
+# Offense count: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 133
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 154
+
+# Offense count: 11
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 25
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 136

data/.travis.yml

@@ -1,13 +1,25 @@
 language: ruby
+
+services:
+  - docker
+
 rvm:
   - 2.3
   - 2.4
   - 2.5
   - 2.6
+  - jruby-19mode
+
 branches:
   only:
     - master
+
 before_install:
   - gem update --system
   - gem update bundler
-script: "bundle exec rspec --tag ~docker"
+
+script:
+  - docker pull antespi/docker-imap-devel:latest
+  - docker run -d --env MAIL_ADDRESS=address@example.org --env MAIL_PASS=pass --env MAILNAME=example.org --publish 8993:993 antespi/docker-imap-devel:latest
+  - sleep 10
+  - bundle exec rake

data/README.md

@@ -46,12 +46,13 @@ specific folders.
 
 ## Configuration file
 
-`setup` creates ~/.imap-backup directory and configuration file. E.g.:
+`setup` creates the file `~/.imap-backup/config.json`
+
+E.g.:
 
 ```json
 {
-  "accounts":
-  [
+  "accounts": [
     {
       "username": "my.user@gmail.com",
       "password": "secret",
@@ -70,8 +71,7 @@ It connects to GMail by default, but you can also specify a server:
 
 ```json
 {
-  "accounts":
-  [
+  "accounts": [
     {
       "username": "my.user@gmail.com",
       "password": "secret",
@@ -96,8 +96,7 @@ Specifically, if you are using a self-signed certificate and get SSL errors, e.g
 
 ```json
 {
-  "accounts":
-  [
+  "accounts": [
     {
       "username": "my.user@gmail.com",
       "password": "secret",
@@ -194,9 +193,6 @@ $ imap-backup status
 
 # Similar Software
 
-* https://github.com/thefloweringash/gmail-imap-backup
-* https://github.com/mleonhard/imapbackup
-* https://github.com/rgrove/larch - copies between IMAP servers
 * https://github.com/OfflineIMAP/offlineimap
 
 # Testing
@@ -217,18 +213,10 @@ docker run \
   antespi/docker-imap-devel:latest
 ```
 
-Currently, the integration tests with Docker are excluded from the CI run.
+To exclude Docker-based tests:
 
-To run **just** the Docker-based tests:
-
-```
-rspec -t docker
-```
-
-To run **all** specs, including the integration tests, do the following:
-
-```
-rspec -O .rspec-all
+```sh
+$ rspec --tag ~docker
 ```
 
 ## Contributing

data/Rakefile

@@ -1,8 +1,12 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-
-task default: :spec
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new do |t|
   t.pattern = "spec/**/*_spec.rb"
 end
+
+RuboCop::RakeTask.new
+
+task default: :spec
+task default: :rubocop

data/imap-backup.gemspec

@@ -29,7 +29,11 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "rake"
 
   gem.add_development_dependency "codeclimate-test-reporter", "~> 0.4.8"
-  gem.add_development_dependency "pry-byebug"
+  if RUBY_ENGINE == "jruby"
+    gem.add_development_dependency "pry-debugger-jruby"
+  else
+    gem.add_development_dependency "pry-byebug"
+  end
   gem.add_development_dependency "rspec", ">= 3.0.0"
   gem.add_development_dependency "rubocop-rspec"
   gem.add_development_dependency "simplecov"

data/lib/email/mboxrd/message.rb

@@ -41,13 +41,17 @@ module Email::Mboxrd
       @parsed ||= Mail.new(supplied_body)
     end
 
-    def best_from
-      if parsed.from.is_a?(Enumerable)
-        parsed.from.each do |addr|
-          return addr if addr
+    def from
+      @from ||=
+        begin
+          from = best_from.dup
+          from << " " + asctime if asctime != ""
+          from
         end
-      end
+    end
 
+    def best_from
+      return first_from if first_from
       return parsed.sender if parsed.sender
       return parsed.envelope_from if parsed.envelope_from
       return parsed.return_path if parsed.return_path
@@ -55,13 +59,10 @@ module Email::Mboxrd
       ""
     end
 
-    def from
-      @from ||=
-        begin
-          from = best_from.dup
-          from << " " + asctime if asctime != ""
-          from
-        end
+    def first_from
+      return nil if !parsed.from.is_a?(Enumerable)
+
+      parsed.from.find { |from| from }
     end
 
     def mboxrd_body

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

@@ -48,8 +48,9 @@ module Imap::Backup
       imap
       each_folder do |folder, serializer|
         next if !folder.exist?
+
         Imap::Backup.logger.debug "[#{folder.name}] running backup"
-        serializer.set_uid_validity(folder.uid_validity)
+        serializer.apply_uid_validity(folder.uid_validity)
         Downloader.new(folder, serializer).run
       end
     end
@@ -58,7 +59,7 @@ module Imap::Backup
       local_folders do |serializer, folder|
         exists = folder.exist?
         if exists
-          new_name = serializer.set_uid_validity(folder.uid_validity)
+          new_name = serializer.apply_uid_validity(folder.uid_validity)
           old_name = serializer.folder
           if new_name
             Imap::Backup.logger.debug(

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

@@ -61,6 +61,8 @@ module Imap::Backup
 
       fetch_data_item = fetch_data_items[0]
       attributes = fetch_data_item.attr
+      return nil if !attributes.key?("RFC822")
+
       attributes["RFC822"].force_encoding("utf-8")
       attributes
     rescue FolderNotFound

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
@@ -51,7 +51,9 @@ module Imap::Backup
         others = other_accounts.map { |a| a[:username] }
         Kernel.puts "others: #{others.inspect}"
         if others.include?(username)
-          Kernel.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
-            Kernel.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

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

@@ -1,7 +1,7 @@
 module Imap::Backup
   module Configuration; end
 
-  class Configuration::Asker < Struct.new(:highline)
+  Configuration::Asker = Struct.new(:highline) do
     EMAIL_MATCHER = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]+$/i.freeze
 
     def initialize(highline)

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

@@ -10,31 +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
 
@@ -73,18 +58,47 @@ 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) !=
+      if Utils.mode(full_path) !=
          Serializer::DIRECTORY_PERMISSIONS
         FileUtils.chmod Serializer::DIRECTORY_PERMISSIONS, full_path
       end

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

@@ -0,0 +1,31 @@
+module Imap::Backup
+  class Serializer::MboxEnumerator
+    attr_reader :mbox_pathname
+
+    def initialize(mbox_pathname)
+      @mbox_pathname = mbox_pathname
+    end
+
+    def each
+      return enum_for(:each) if !block_given?
+
+      File.open(mbox_pathname) do |f|
+        lines = []
+
+        loop do
+          line = f.gets
+          break if !line
+
+          if line.start_with?("From ")
+            yield lines.join if lines.count.positive?
+            lines = [line]
+          else
+            lines << line
+          end
+        end
+
+        yield lines.join if lines.count.positive?
+      end
+    end
+  end
+end