imap-backup 2.0.0 → 2.1.0

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

@@ -52,6 +52,7 @@ module Imap::Backup
 
     def data
       return @data if @data
+
       if File.exist?(pathname)
         Utils.check_permissions pathname, 0o600
         contents = File.read(pathname)
@@ -73,12 +74,8 @@ module Imap::Backup
     end
 
     def mkdir_private(path)
-      if !File.directory?(path)
-        FileUtils.mkdir path
-      end
-      if Utils::mode(path) != 0o700
-        FileUtils.chmod 0o700, path
-      end
+      FileUtils.mkdir(path) if !File.directory?(path)
+      FileUtils.chmod(0o700, path) if Utils.mode(path) != 0o700
     end
   end
 end

data/lib/imap/backup/downloader.rb

@@ -4,22 +4,23 @@ module Imap::Backup
     attr_reader :serializer
 
     def initialize(folder, serializer)
-      @folder, @serializer = folder, serializer
+      @folder = folder
+      @serializer = serializer
     end
 
     def run
       uids = folder.uids - serializer.uids
-      Imap::Backup.logger.debug "[#{folder.name}] #{uids.count} new messages"
-      uids.each do |uid|
+      count = uids.count
+      Imap::Backup.logger.debug "[#{folder.name}] #{count} new messages"
+      uids.each.with_index do |uid, i|
         message = folder.fetch(uid)
+        log_prefix = "[#{folder.name}] uid: #{uid} (#{i + 1}/#{count}) -"
         if message.nil?
-          Imap::Backup.logger.debug(
-            "[#{folder.name}] #{uid} - not available - skipped"
-          )
+          Imap::Backup.logger.debug("#{log_prefix} not available - skipped")
           next
         end
         Imap::Backup.logger.debug(
-          "[#{folder.name}] #{uid} - #{message['RFC822'].size} bytes"
+          "#{log_prefix} #{message['RFC822'].size} bytes"
         )
         serializer.save(uid, message)
       end

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

@@ -27,6 +27,7 @@ module Imap::Backup
           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
@@ -84,7 +85,7 @@ module Imap::Backup
       end
 
       if Imap::Backup::Utils.mode(full_path) !=
-          Serializer::DIRECTORY_PERMISSIONS
+         Serializer::DIRECTORY_PERMISSIONS
         FileUtils.chmod Serializer::DIRECTORY_PERMISSIONS, full_path
       end
     end

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

@@ -42,6 +42,7 @@ module Imap::Backup
     def add(uid, message)
       do_load if !loaded
       raise "Can't add messages without uid_validity" if !uid_validity
+
       uid = uid.to_i
       if uids.include?(uid)
         Imap::Backup.logger.debug(
@@ -58,7 +59,7 @@ module Imap::Backup
         mbox.write mboxrd_message.to_serialized
         @uids << uid
         write_imap_file
-      rescue => e
+      rescue StandardError => e
         message = <<-ERROR.gsub(/^\s*/m, "")
           [#{folder}] failed to save message #{uid}:
           #{body}. #{e}:
@@ -66,7 +67,7 @@ module Imap::Backup
         ERROR
         Imap::Backup.logger.warn message
       ensure
-        mbox.close if mbox
+        mbox&.close
       end
     end
 
@@ -74,12 +75,14 @@ module Imap::Backup
       do_load if !loaded
       message_index = uids.find_index(uid)
       return nil if message_index.nil?
+
       load_nth(message_index)
     end
 
     def update_uid(old, new)
       index = uids.find_index(old.to_i)
       return if index.nil?
+
       uids[index] = new.to_i
       write_imap_file
     end
@@ -128,7 +131,7 @@ module Imap::Backup
         return nil
       end
 
-      return nil if !imap_data.has_key?(:uids)
+      return nil if !imap_data.key?(:uids)
       return nil if !imap_data[:uids].is_a?(Array)
 
       imap_data
@@ -137,12 +140,14 @@ module Imap::Backup
     def imap_ok?
       return false if !exist?
       return false if !imap_looks_like_json?
+
       true
     end
 
     def load_nth(index)
       each_mbox_message.with_index do |raw, i|
         next unless i == index
+
         return Email::Mboxrd::Message.from_serialized(raw)
       end
       nil
@@ -153,21 +158,24 @@ module Imap::Backup
         File.open(mbox_pathname) do |f|
           lines = []
 
-          while line = f.gets
+          loop do
+            line = f.gets
+            break if !line
             if line.start_with?("From ")
-              e.yield lines.join if lines.count > 0
+              e.yield lines.join if lines.count.positive?
               lines = [line]
             else
               lines << line
             end
           end
-          e.yield lines.join if lines.count > 0
+          e.yield lines.join if lines.count.positive?
         end
       end
     end
 
     def imap_looks_like_json?
       return false unless imap_exist?
+
       content = File.read(imap_pathname)
       content.start_with?("{")
     end

data/lib/imap/backup/uploader.rb

@@ -12,6 +12,7 @@ module Imap::Backup
       missing_uids.each do |uid|
         message = serializer.load(uid)
         next if message.nil?
+
         new_uid = folder.append(message)
         serializer.update_uid(uid, new_uid)
       end

data/lib/imap/backup/utils.rb

@@ -5,15 +5,16 @@ module Imap::Backup
     def self.check_permissions(filename, limit)
       actual = mode(filename)
       return nil if actual.nil?
+
       mask = ~limit & 0o777
-      if actual & mask != 0
-        message = format(
-          "Permissions on '%<filename>s' " \
-            "should be 0%<limit>o, not 0%<actual>o",
-          filename: filename, limit: limit, actual: actual
-        )
-        raise message
-      end
+      return if (actual & mask).zero?
+
+      message = format(
+        "Permissions on '%<filename>s' " \
+          "should be 0%<limit>o, not 0%<actual>o",
+        filename: filename, limit: limit, actual: actual
+      )
+      raise message
     end
 
     def self.mode(filename)
@@ -25,7 +26,8 @@ module Imap::Backup
 
     def self.make_folder(base_path, path, permissions)
       parts = path.split("/")
-      return if parts.size == 0
+      return if parts.empty?
+
       full_path = File.join(base_path, path)
       FileUtils.mkdir_p full_path
       path = base_path

data/lib/imap/backup/version.rb

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

data/spec/features/backup_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe "backup", type: :feature, docker: true do
   let(:folder) { "my-stuff" }
   let(:email1) { send_email folder, msg1 }
   let(:email2) { send_email folder, msg2 }
-  let!(:pre) { }
+  let!(:pre) {}
   let!(:setup) do
     server_create_folder folder
     email1
@@ -29,7 +29,7 @@ RSpec.describe "backup", type: :feature, docker: true do
     expect(mbox_content(folder)).to eq(messages_as_mbox)
   end
 
-  context "IMAP metadata" do
+  describe "IMAP metadata" do
     let(:imap_metadata) { imap_parsed(folder) }
     let(:folder_uids) { server_uids(folder) }
 
@@ -52,14 +52,15 @@ RSpec.describe "backup", type: :feature, docker: true do
     context "when uid_validity does not match" do
       let(:new_name) { "NEWNAME" }
       let(:email3) { send_email folder, msg3 }
+      let(:original_folder_uid_validity) { server_uid_validity(folder) }
       let!(:pre) do
         server_create_folder folder
         email3
-        @original_folder_uid_validity = server_uid_validity(folder)
+        original_folder_uid_validity
         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.to_s }
 
       after do
         server_delete_folder new_name
@@ -81,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.to_s + ".1"
           expect(mbox_content(renamed)).to eq(message_as_mbox_entry(msg3))
         end
       end

data/spec/features/support/backup_directory.rb

@@ -3,12 +3,12 @@ module BackupDirectoryHelpers
     from = fixture("connection")[:username]
     subject = options[:subject]
     body = options[:body]
-    body_and_headers = <<-EOT
-From: #{from}
-Subject: #{subject}
+    body_and_headers = <<~BODY
+      From: #{from}
+      Subject: #{subject}
 
-#{body}
-    EOT
+      #{body}
+    BODY
 
     "From #{from}\n#{body_and_headers}\n"
   end

data/spec/features/support/email_server.rb

@@ -1,6 +1,6 @@
 module EmailServerHelpers
-  REQUESTED_ATTRIBUTES = ["RFC822", "FLAGS", "INTERNALDATE"]
-  DEFAULT_EMAIL = "address@example.org"
+  REQUESTED_ATTRIBUTES = %w(RFC822 FLAGS INTERNALDATE).freeze
+  DEFAULT_EMAIL = "address@example.org".freeze
 
   def send_email(folder, options)
     message = message_as_server_message(options)
@@ -11,13 +11,14 @@ module EmailServerHelpers
     from = options[:from] || DEFAULT_EMAIL
     subject = options[:subject]
     body = options[:body]
-    message = <<-EOT.gsub("\n", "\r\n")
-From: #{from}
-Subject: #{subject}
 
-#{body}
+    <<~MESSAGE.gsub("\n", "\r\n")
+      From: #{from}
+      Subject: #{subject}
 
-    EOT
+      #{body}
+
+    MESSAGE
   end
 
   def server_messages(folder)
@@ -32,8 +33,10 @@ Subject: #{subject}
 
   def server_fetch_email(folder, uid)
     examine folder
+
     fetch_data_items = imap.uid_fetch([uid.to_i], REQUESTED_ATTRIBUTES)
     return nil if fetch_data_items.nil?
+
     fetch_data_item = fetch_data_items[0]
     attributes = fetch_data_item.attr
     attributes["RFC822"].force_encoding("utf-8")
@@ -43,7 +46,7 @@ Subject: #{subject}
   def delete_emails(folder)
     imap.select(folder)
     uids = imap.uid_search(["ALL"]).sort
-    imap.store(1 .. uids.size, "+FLAGS", [:Deleted])
+    imap.store(1..uids.size, "+FLAGS", [:Deleted])
     imap.expunge
   end
 

data/spec/features/support/shared/connection_context.rb

@@ -3,10 +3,10 @@ shared_context "imap-backup connection" do
   let(:default_connection) { fixture("connection") }
   let(:backup_folders) { nil }
   let(:connection_options) do
-    default_connection.merge({
+    default_connection.merge(
       local_path: local_backup_path,
       folders: backup_folders
-    })
+    )
   end
   let(:connection) { Imap::Backup::Account::Connection.new(connection_options) }
 end

data/spec/support/fixtures.rb

@@ -2,5 +2,5 @@ def fixture(name)
   spec_root = File.expand_path("..", File.dirname(__FILE__))
   fixture_path = File.join(spec_root, "fixtures", name + ".yml")
   fixture = File.read(fixture_path)
-  YAML.load(fixture)
+  YAML.safe_load(fixture, permitted_classes: [Symbol])
 end

data/spec/support/higline_test_helpers.rb

@@ -1,6 +1,6 @@
 module HighLineTestHelpers
   def prepare_highline
-    @input = double("stdin", eof?: false, gets: "q\n")
+    @input = instance_double(IO, eof?: false, gets: "q\n")
     @output = StringIO.new
     Imap::Backup::Configuration::Setup.highline = HighLine.new(@input, @output)
     [@input, @output]

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

@@ -1,73 +1,82 @@
-require "spec_helper"
-
-msg_no_from = %Q|Delivered-To: you@example.com
-From: example <www.example.com>
-To: FirstName LastName <you@example.com>
-Subject: Re: no subject|
-
-msg_bad_from = %Q|Delivered-To: you@example.com
-from: "FirstName LastName (TEXT)" <"TEXT*" <no-reply@example.com>>
-To: FirstName LastName <you@example.com>
-Subject: Re: no subject|
-
-msg_no_from_but_return_path = %Q|Delivered-To: you@example.com
-From: example <www.example.com>
-To: FirstName LastName <you@example.com>
-Return-Path: <me@example.com>
-Subject: Re: no subject|
-
-msg_no_from_but_sender = %Q|Delivered-To: you@example.com
-To: FirstName LastName <you@example.com>
-Subject: Re: no subject
-Sender: FistName LastName <me@example.com>|
+msg_no_from = <<~NO_FROM
+  Delivered-To: you@example.com
+  From: example <www.example.com>
+  To: FirstName LastName <you@example.com>
+  Subject: Re: no subject
+NO_FROM
+
+msg_bad_from = <<~BAD_FROM
+  Delivered-To: you@example.com
+  from: "FirstName LastName (TEXT)" <"TEXT*" <no-reply@example.com>>
+  To: FirstName LastName <you@example.com>
+  Subject: Re: no subject
+BAD_FROM
+
+msg_no_from_but_return_path = <<~RETURN_PATH
+  Delivered-To: you@example.com
+  From: example <www.example.com>
+  To: FirstName LastName <you@example.com>
+  Return-Path: <me@example.com>
+  Subject: Re: no subject
+RETURN_PATH
+
+msg_no_from_but_sender = <<~NOT_SENDER
+  Delivered-To: you@example.com
+  To: FirstName LastName <you@example.com>
+  Subject: Re: no subject
+  Sender: FistName LastName <me@example.com>
+NOT_SENDER
 
 describe Email::Mboxrd::Message do
+  subject { described_class.new(message_body) }
+
   let(:from) { "me@example.com" }
   let(:date) { DateTime.new(2012, 12, 13, 18, 23, 45) }
   let(:message_body) do
-    double("Body", clone: cloned_message_body, force_encoding: nil)
+    instance_double(String, clone: cloned_message_body, force_encoding: nil)
   end
   let(:cloned_message_body) do
     "Foo\nBar\nFrom at the beginning of the line\n>>From quoted"
   end
   let(:msg_good) do
-    %Q|Delivered-To: you@example.com
-From: Foo <foo@example.com>
-To: FirstName LastName <you@example.com>
-Date: #{date.rfc822}
-Subject: Re: no subject|
+    <<~GOOD
+      Delivered-To: you@example.com
+      From: Foo <foo@example.com>
+      To: FirstName LastName <you@example.com>
+      Date: #{date.rfc822}
+      Subject: Re: no subject
+    GOOD
   end
 
   let(:msg_bad_date) do
-    %Q|Delivered-To: you@example.com
-From: Foo <foo@example.com>
-To: FirstName LastName <you@example.com>
-Date: Mon,5 May 2014 08:97:99 GMT
-Subject: Re: no subject|
+    <<~BAD
+      Delivered-To: you@example.com
+      From: Foo <foo@example.com>
+      To: FirstName LastName <you@example.com>
+      Date: Mon,5 May 2014 08:97:99 GMT
+      Subject: Re: no subject
+    BAD
   end
 
-  subject { described_class.new(message_body) }
-
   describe ".from_serialized" do
     let(:serialized_message) { "From foo@a.com\n#{imap_message}" }
     let(:imap_message) { "Delivered-To: me@example.com\nFrom Me\n" }
-
-    before { @result = described_class.from_serialized(serialized_message) }
+    let!(:result) { described_class.from_serialized(serialized_message) }
 
     it "returns the message" do
-      expect(@result).to be_a(described_class)
+      expect(result).to be_a(described_class)
     end
 
     it "removes one level of > before From" do
-      expect(@result.supplied_body).to eq(imap_message)
+      expect(result.supplied_body).to eq(imap_message)
     end
   end
 
   context "#to_serialized" do
-    let(:mail) { double("Mail", from: [from], date: date) }
+    let(:mail) { instance_double(Mail::Message, from: [from], date: date) }
 
     before do
-      allow(Mail).to receive(:new).with(cloned_message_body).and_return(mail)
+      allow(Mail).to receive(:new).with(cloned_message_body) { mail }
     end
 
     it "does not modify the message" do
@@ -113,7 +122,7 @@ Subject: Re: no subject|
       end
     end
 
-    context "when original message 'from' is a string but not well-formed address" do
+    context "when original message 'from' is not a well-formed address" do
       let(:message_body) { msg_bad_from }
 
       it "'from' is empty string" do