imap-backup 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8906735c8b5c51afa006d3ee2148b117bce3e0a5b094c2b88d7cdbef171d7fde
-  data.tar.gz: '0619af030f4254e7e25c6d4eeebfd22e0b4cf0bd40d4bee0dba804c2b43d9caf'
+  metadata.gz: 726ef170419a3bcdc1a39517cdd81640ca0674f5d5f5452f8bc97ef819d74031
+  data.tar.gz: 8fc24ed36537a68899a45e22afa3fcf1dee90c27e8432853c2d88e5b4d5c5325
 SHA512:
-  metadata.gz: 67ba2f2a24977da26b3bfe77c5840f7d6c9ff8f564956b8fe4ee430dca78ac4b03c15961c3ec152d359656ccfcc709e9a5ebc499504ce6e0678d841379b682cd
-  data.tar.gz: 6b7bc88c99139bd54b0c4c05ece78c8cb5e79fedeee89577037e76e84d7a4134312335543dd68d0f177e39e431314ff53e343dc3781305d7f02dc4f6d733c5d9
+  metadata.gz: e2b59fa22614c634169104d75ad6214a0d8c788da712a8c3545281e98666b4d23b17e1a10cc1744fcf615966bd63616daa3241f7e932d2af4d10fd4508391583
+  data.tar.gz: 9e73290e3684aadc443f449f870c7ed8d23506408439bb69dc41b57613e8e439e32a4017f8dbfaf462ea5dac5fd029a0d4691c861600d4aaeeaff290e94e9215

data/.rubocop.yml

@@ -1,9 +1,8 @@
 inherit_from:
-  - https://gitlab.com/snippets/1744945/raw
+  - https://raw.githubusercontent.com/leanpanda-com/rubocop/0.89.1/rubocop-rspec.yml
   - .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
   Exclude:
     - "bin/stubs/*"
   DisplayCopNames:

data/.rubocop_todo.yml

@@ -1,24 +1,58 @@
-# Offense count: 8
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-09-24 16:30:54 UTC using RuboCop version 0.89.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 10
+# Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
   Max: 29
 
 # Offense count: 2
-# Configuration parameters: CountComments, ExcludedMethods.
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
   Max: 133
 
 # Offense count: 2
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 154
+  Max: 167
 
-# Offense count: 11
-# Configuration parameters: CountComments, ExcludedMethods.
+# Offense count: 14
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
 Metrics/MethodLength:
   Max: 25
 
-# Offense count: 1
-# Configuration parameters: CountComments.
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
   Max: 136
+
+# Offense count: 181
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 19
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/GlobalStdStream:
+  Exclude:
+    - 'lib/imap/backup.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'bin/imap-backup'
+    - 'lib/email/mboxrd/message.rb'
+    - 'lib/imap/backup/configuration/account.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantRegexpEscape:
+  Exclude:
+    - 'spec/features/backup_spec.rb'

data/.travis.yml

@@ -4,10 +4,10 @@ services:
   - docker
 
 rvm:
-  - 2.3
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
   - jruby-19mode
 
 branches:

data/bin/imap-backup

@@ -79,7 +79,7 @@ when "folders"
       warn "Unable to list account folders"
       exit 1
     end
-    folders.each { |f| puts "\t" + f.name }
+    folders.each { |f| puts "\t#{f.name}" }
   end
 when "restore"
   configuration.each_connection(&:restore)

data/imap-backup.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^spec/})
   gem.require_paths = ["lib"]
-  gem.required_ruby_version = [">= 2.3.0"]
+  gem.required_ruby_version = [">= 2.4.0"]
   gem.version = Imap::Backup::VERSION
 
   gem.post_install_message = <<-MESSAGE.gsub(/^\s{4}/m, "")

data/lib/email/mboxrd/message.rb

@@ -21,7 +21,7 @@ module Email::Mboxrd
     end
 
     def to_serialized
-      "From " + from + "\n" + mboxrd_body
+      "From #{from}\n" + mboxrd_body
     end
 
     def date
@@ -44,7 +44,7 @@ module Email::Mboxrd
       @from ||=
         begin
           from = best_from.dup
-          from << " " + asctime if asctime != ""
+          from << " #{asctime}" if asctime != ""
           from
         end
     end

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

@@ -35,6 +35,10 @@ module Imap::Backup
       store.load(uid)
     end
 
+    def each_message(uids)
+      store.each_message(uids)
+    end
+
     def save(uid, message)
       store.add(uid, message)
     end

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

@@ -81,6 +81,22 @@ module Imap::Backup
       load_nth(message_index)
     end
 
+    def each_message(required_uids)
+      return enum_for(:each_message, required_uids) if !block_given?
+
+      indexes = required_uids.each.with_object({}) do |uid, acc|
+        index = uids.find_index(uid)
+        acc[index] = uid if index
+      end
+      enumerator = Serializer::MboxEnumerator.new(mbox_pathname)
+      enumerator.each.with_index do |raw, i|
+        uid = indexes[i]
+        next if !uid
+
+        yield uid, Email::Mboxrd::Message.from_serialized(raw)
+      end
+    end
+
     def update_uid(old, new)
       index = uids.find_index(old.to_i)
       return if index.nil?
@@ -98,8 +114,8 @@ module Imap::Backup
     end
 
     def rename(new_name)
-      new_mbox_pathname = absolute_path(new_name + ".mbox")
-      new_imap_pathname = absolute_path(new_name + ".imap")
+      new_mbox_pathname = absolute_path("#{new_name}.mbox")
+      new_imap_pathname = absolute_path("#{new_name}.imap")
       File.rename(mbox_pathname, new_mbox_pathname)
       File.rename(imap_pathname, new_imap_pathname)
       @folder = new_name
@@ -191,11 +207,11 @@ module Imap::Backup
     end
 
     def mbox_pathname
-      absolute_path(folder + ".mbox")
+      absolute_path("#{folder}.mbox")
     end
 
     def imap_pathname
-      absolute_path(folder + ".imap")
+      absolute_path("#{folder}.imap")
     end
   end
 end

data/lib/imap/backup/uploader.rb

@@ -13,8 +13,7 @@ module Imap::Backup
       return if count.zero?
 
       Imap::Backup.logger.debug "[#{folder.name}] #{count} to restore"
-      missing_uids.each.with_index do |uid, i|
-        message = serializer.load(uid)
+      serializer.each_message(missing_uids).with_index do |(uid, message), i|
         next if message.nil?
 
         log_prefix = "[#{folder.name}] uid: #{uid} (#{i + 1}/#{count}) -"

data/lib/imap/backup/version.rb

@@ -3,6 +3,6 @@ module Imap; end
 module Imap::Backup
   MAJOR    = 2
   MINOR    = 2
-  REVISION = 1
+  REVISION = 2
   VERSION  = [MAJOR, MINOR, REVISION].compact.map(&:to_s).join(".")
 end

data/spec/features/backup_spec.rb

@@ -60,7 +60,7 @@ RSpec.describe "backup", type: :feature, docker: true do
         connection.run_backup
         server_rename_folder folder, new_name
       end
-      let(:renamed_folder) { folder + "." + original_folder_uid_validity.to_s }
+      let(:renamed_folder) { "#{folder}.#{original_folder_uid_validity}" }
 
       after do
         server_delete_folder new_name
@@ -82,7 +82,7 @@ RSpec.describe "backup", type: :feature, docker: true do
         end
 
         it "moves the old backup to a uniquely named directory" do
-          renamed = folder + "." + original_folder_uid_validity.to_s + ".1"
+          renamed = "#{folder}.#{original_folder_uid_validity}.1"
           expect(mbox_content(renamed)).to eq(message_as_mbox_entry(msg3))
         end
       end

data/spec/features/helper.rb

@@ -1,2 +1,2 @@
 support_glob = File.expand_path("support/**/*.rb", __dir__)
-Dir[support_glob].each { |f| require f }
+Dir[support_glob].sort.each { |f| require f }

data/spec/features/support/backup_directory.rb

@@ -26,11 +26,11 @@ module BackupDirectoryHelpers
   end
 
   def mbox_path(name)
-    File.join(local_backup_path, name + ".mbox")
+    File.join(local_backup_path, "#{name}.mbox")
   end
 
   def imap_path(name)
-    File.join(local_backup_path, name + ".imap")
+    File.join(local_backup_path, "#{name}.imap")
   end
 
   def imap_content(name)

data/spec/spec_helper.rb

@@ -7,7 +7,7 @@ spec_path = File.dirname(__FILE__)
 $LOAD_PATH << File.expand_path("../lib", spec_path)
 
 support_glob = File.join(spec_path, "support", "**", "*.rb")
-Dir[support_glob].each { |f| require f }
+Dir[support_glob].sort.each { |f| require f }
 
 require "simplecov"
 SimpleCov.start do

data/spec/support/fixtures.rb

@@ -1,6 +1,6 @@
 def fixture(name)
   spec_root = File.expand_path("..", File.dirname(__FILE__))
-  fixture_path = File.join(spec_root, "fixtures", name + ".yml")
+  fixture_path = File.join(spec_root, "fixtures", "#{name}.yml")
   fixture = File.read(fixture_path)
   YAML.safe_load(fixture, [Symbol])
 end

data/spec/unit/email/mboxrd/message_spec.rb

@@ -129,7 +129,7 @@ describe Email::Mboxrd::Message do
       let(:message_body) { msg_no_from_but_return_path }
 
       it "'return path' is used as 'from'" do
-        expect(subject.to_serialized).to start_with("From " + from + "\n")
+        expect(subject.to_serialized).to start_with("From #{from}\n")
       end
     end
 
@@ -137,7 +137,7 @@ describe Email::Mboxrd::Message do
       let(:message_body) { msg_no_from_but_sender }
 
       it "Sender is used as 'from'" do
-        expect(subject.to_serialized).to start_with("From " + from + "\n")
+        expect(subject.to_serialized).to start_with("From #{from}\n")
       end
     end
   end

data/spec/unit/email/provider_spec.rb

@@ -1,4 +1,6 @@
 describe Email::Provider do
+  subject { described_class.new(:gmail) }
+
   describe ".for_address" do
     context "with known providers" do
       [
@@ -20,8 +22,6 @@ describe Email::Provider do
     end
   end
 
-  subject { described_class.new(:gmail) }
-
   describe "#options" do
     it "returns options" do
       expect(subject.options).to be_a(Hash)

data/spec/unit/imap/backup/serializer/mbox_spec.rb

@@ -182,6 +182,14 @@ describe Imap::Backup::Serializer::Mbox do
     end
   end
 
+  describe "#each_message" do
+    it "calls the store" do
+      expect(store).to receive(:each_message).with([1])
+
+      subject.each_message([1])
+    end
+  end
+
   describe "#save" do
     it "calls the store" do
       expect(store).to receive(:add).with("foo", "bar")

data/spec/unit/imap/backup/serializer/mbox_store_spec.rb

@@ -4,10 +4,10 @@ describe Imap::Backup::Serializer::MboxStore do
   let(:base_path) { "/base/path" }
   let(:folder) { "the/folder" }
   let(:folder_path) { File.join(base_path, folder) }
-  let(:imap_pathname) { folder_path + ".imap" }
+  let(:imap_pathname) { "#{folder_path}.imap" }
   let(:imap_exists) { true }
   let(:imap_file) { instance_double(File, write: nil, close: nil) }
-  let(:mbox_pathname) { folder_path + ".mbox" }
+  let(:mbox_pathname) { "#{folder_path}.mbox" }
   let(:mbox_exists) { true }
   let(:mbox_file) { instance_double(File, write: nil, close: nil) }
   let(:uids) { [3, 2, 1] }
@@ -208,6 +208,47 @@ describe Imap::Backup::Serializer::MboxStore do
     end
   end
 
+  describe "#each_message" do
+    let(:enumerator) do
+      instance_double(Imap::Backup::Serializer::MboxEnumerator)
+    end
+    let(:enumeration) { instance_double(Enumerator) }
+
+    before do
+      allow(Imap::Backup::Serializer::MboxEnumerator).
+        to receive(:new) { enumerator }
+      allow(enumerator).to receive(:each) { enumeration }
+      allow(enumeration).
+        to receive(:with_index).
+        and_yield("", 0).
+        and_yield("", 1).
+        and_yield("ciao", 2)
+    end
+
+    it "yields messages" do
+      expect { |b| subject.each_message([1], &b) }.
+        to yield_successive_args([1, instance_of(Email::Mboxrd::Message)])
+    end
+
+    it "yields the requested message uid" do
+      subject.each_message([1]) do |uid, _message|
+        expect(uid).to eq(1)
+      end
+    end
+
+    it "yields the requested message" do
+      subject.each_message([1]) do |_uid, message|
+        expect(message.supplied_body).to eq("ciao")
+      end
+    end
+
+    context "without a block" do
+      it "returns an Enumerator" do
+        expect(subject.each_message([1])).to be_a(Enumerator)
+      end
+    end
+  end
+
   describe "#update_uid" do
     let(:old_uid) { "2" }
     let(:updated_imap_content) do
@@ -258,8 +299,8 @@ describe Imap::Backup::Serializer::MboxStore do
   describe "#rename" do
     let(:new_name) { "new_name" }
     let(:new_folder_path) { File.join(base_path, new_name) }
-    let(:new_imap_name) { new_folder_path + ".imap" }
-    let(:new_mbox_name) { new_folder_path + ".mbox" }
+    let(:new_imap_name) { "#{new_folder_path}.imap" }
+    let(:new_mbox_name) { "#{new_folder_path}.mbox" }
 
     before do
       allow(File).to receive(:rename).and_call_original

data/spec/unit/imap/backup/uploader_spec.rb

@@ -20,10 +20,13 @@ describe Imap::Backup::Uploader do
     instance_double(Email::Mboxrd::Message, supplied_body: "existing message")
   end
 
+  def message_enumerator
+    yield [1, missing_message]
+  end
+
   describe "#run" do
     before do
-      allow(serializer).to receive(:load).with(1) { missing_message }
-      allow(serializer).to receive(:load).with(2) { existing_message }
+      allow(serializer).to receive(:each_message).and_return(enum_for(:message_enumerator))
     end
 
     context "with messages that are missing" do

data/spec/unit/imap/backup/utils_spec.rb

@@ -12,6 +12,7 @@ describe Imap::Backup::Utils do
   describe ".check_permissions" do
     let(:requested) { 0o345 }
 
+    # rubocop:disable RSpec/EmptyExampleGroup
     context "with existing files" do
       [
         [0o100, "less than the limit", true],
@@ -36,6 +37,7 @@ describe Imap::Backup::Utils do
         end
       end
     end
+    # rubocop:enable RSpec/EmptyExampleGroup
 
     context "with non-existent files" do
       let(:exists) { false }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-26 00:00:00.000000000 Z
+date: 2020-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -212,14 +212,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Backup GMail (or other IMAP) accounts to disk