imap-backup 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 334bd1417efce8e604aedbe1878d09bf2c79fce40c8efd3d2d70f2fa66a261bc
-  data.tar.gz: e217a9925ea2a8afeb7d3d26d72e644bbb58a0012c06b6f2b01c4595d24c2ae6
+  metadata.gz: f5903e540e8d72a63c70ee1f8f5799710bdef2ffaac58bc6bac617942da6e6da
+  data.tar.gz: d4ad4a77a5a7d86146768a889f697f281c344ca5e4db6f29fc792a0894b2fedd
 SHA512:
-  metadata.gz: b374fe448bf88411f2681c7c07159f34c06ed8c537f1dc8c18b41c60ca7c690693d0b1c672e7a31e85d38c0b50afbc9e1004344359273ef17f0ca148909a095f
-  data.tar.gz: 9be2593d7b380bd0c3d1af1a85a79d9a3662de74d078d0564fff08884c336325f1bb33c08f10582e48e0728178d80cc6a8633a26782641ee66861ca313eec9cc
+  metadata.gz: fff913ad0270445d6783430d39672e9abe34a67d20546ad03db5ec0c8c6179c5f98524a83546d6e1790b1550284902bf0a161c998a82301ddbbbfb33d845a708
+  data.tar.gz: d0c64c701e183d1bb01b28af7577c237a5ec0d26607ed1856e1c2b6748efe48479c0f71b502db83a8e68c22faab220372541b16edf5d3e5b7ad0af86e933460e

data/.rspec-all

@@ -1,2 +1,4 @@
 --color
+--format documentation
+--order random
 --require spec_helper

data/.rubocop.yml

@@ -1,8 +1,17 @@
 inherit_from: https://gitlab.com/snippets/1744945/raw
 
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.3
   Exclude:
     - "bin/stubs/*"
   DisplayCopNames:
     Enabled: true
+
+RSpec/ContextWording:
+  Enabled: false
+RSpec/NestedGroups:
+  Max: 4
+RSpec/ReturnFromStub:
+  Enabled: false
+Style/EmptyCaseCondition:
+  Enabled: false

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
 branches:
   only:
     - master

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://secure.travis-ci.org/joeyates/imap-backup.png)][Continuous Integration]
+[![Build Status](https://secure.travis-ci.org/joeyates/imap-backup.svg)][Continuous Integration]
 [![Source Analysis](https://codeclimate.com/github/joeyates/imap-backup/badges/gpa.svg)](https://codeclimate.com/github/joeyates/imap-backup)
 [![Test Coverage](https://codeclimate.com/github/joeyates/imap-backup/badges/coverage.svg)](https://codeclimate.com/github/joeyates/imap-backup/coverage)
 

data/Rakefile

@@ -1,4 +1,3 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/bin/imap-backup

@@ -46,9 +46,7 @@ parser = OptionParser.new do |opts|
 end
 parser.parse!
 
-if ARGV.size > 0
-  options[:command] = ARGV.shift
-end
+options[:command] = ARGV.shift if !ARGV.empty?
 
 if KNOWN_COMMANDS.find { |c| c[:name] == options[:command] }.nil?
   raise "Unknown command '#{options[:command]}'"
@@ -72,9 +70,7 @@ case options[:command]
 when "setup"
   Imap::Backup::Configuration::Setup.new.run
 when "backup"
-  configuration.each_connection do |connection|
-    connection.run_backup
-  end
+  configuration.each_connection(&:run_backup)
 when "folders"
   configuration.each_connection do |connection|
     puts connection.username
@@ -86,9 +82,7 @@ when "folders"
     folders.each { |f| puts "\t" + f.name }
   end
 when "restore"
-  configuration.each_connection do |connection|
-    connection.restore
-  end
+  configuration.each_connection(&:restore)
 when "status"
   configuration.each_connection do |connection|
     puts connection.username

data/imap-backup.gemspec

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift(File.expand_path("../lib", __FILE__))
+$LOAD_PATH.unshift(File.expand_path("lib", __dir__))
 require "imap/backup/version"
 
 Gem::Specification.new do |gem|
@@ -9,12 +9,12 @@ Gem::Specification.new do |gem|
   gem.email         = ["joe.g.yates@gmail.com"]
   gem.homepage      = "https://github.com/joeyates/imap-backup"
 
-  gem.files         = `git ls-files`.split($\)
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   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.2.0"]
-  gem.version       = Imap::Backup::VERSION
+  gem.required_ruby_version = [">= 2.3.0"]
+  gem.version = Imap::Backup::VERSION
 
   gem.post_install_message = <<-MESSAGE.gsub(/^\s{4}/m, "")
     Note that, when upgrading #{gem.name} from version 1.x to 2.x,
@@ -24,9 +24,9 @@ Gem::Specification.new do |gem|
     **deleted** and a full new backup created.
   MESSAGE
 
-  gem.add_runtime_dependency "rake"
   gem.add_runtime_dependency "highline"
   gem.add_runtime_dependency "mail"
+  gem.add_runtime_dependency "rake"
 
   gem.add_development_dependency "codeclimate-test-reporter", "~> 0.4.8"
   gem.add_development_dependency "pry-byebug"

data/lib/email/mboxrd/message.rb

@@ -27,7 +27,7 @@ module Email::Mboxrd
 
     def date
       parsed.date
-    rescue
+    rescue StandardError
       nil
     end
 
@@ -52,7 +52,7 @@ module Email::Mboxrd
       return parsed.envelope_from if parsed.envelope_from
       return parsed.return_path if parsed.return_path
 
-      return ""
+      ""
     end
 
     def from

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

@@ -10,7 +10,8 @@ module Imap::Backup
     attr_reader :username
 
     def initialize(options)
-      @username, @password = options[:username], options[:password]
+      @username = options[:username]
+      @password = options[:password]
       @local_path = options[:local_path]
       @backup_folders = options[:folders]
       @server = options[:server]
@@ -46,6 +47,7 @@ module Imap::Backup
       # start the connection so we get logging messages in the right order
       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)
         Downloader.new(folder, serializer).run
@@ -59,7 +61,9 @@ module Imap::Backup
           new_name = serializer.set_uid_validity(folder.uid_validity)
           old_name = serializer.folder
           if new_name
-            Imap::Backup.logger.debug "Backup '#{old_name}' renamed and restored to '#{new_name}'"
+            Imap::Backup.logger.debug(
+              "Backup '#{old_name}' renamed and restored to '#{new_name}'"
+            )
             new_serializer = Serializer::Mbox.new(local_path, new_name)
             new_folder = Account::Folder.new(self, new_name)
             new_folder.create
@@ -87,6 +91,7 @@ module Imap::Backup
 
     def imap
       return @imap unless @imap.nil?
+
       options = provider_options
       Imap::Backup.logger.debug(
         "Creating IMAP instance: #{server}, options: #{options.inspect}"
@@ -121,7 +126,8 @@ module Imap::Backup
     end
 
     def backup_folders
-      return @backup_folders if @backup_folders && (@backup_folders.size > 0)
+      return @backup_folders if @backup_folders && !@backup_folders.empty?
+
       (folders || []).map { |f| {name: f.name} }
     end
 
@@ -143,6 +149,7 @@ module Imap::Backup
     def server
       return @server if @server
       return nil if provider.nil?
+
       @server = provider.host
     end
 
@@ -156,6 +163,7 @@ module Imap::Backup
     # in the reference.
     def provider_root
       return @provider_root if @provider_root
+
       root_info = imap.list("", "")[0]
       @provider_root = root_info.name
     end

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

@@ -3,10 +3,12 @@ require "forwardable"
 module Imap::Backup
   module Account; end
 
+  class FolderNotFound < StandardError; end
+
   class Account::Folder
     extend Forwardable
 
-    REQUESTED_ATTRIBUTES = ["RFC822", "FLAGS", "INTERNALDATE"].freeze
+    REQUESTED_ATTRIBUTES = %w[RFC822 FLAGS INTERNALDATE].freeze
 
     attr_reader :connection
     attr_reader :name
@@ -27,12 +29,13 @@ module Imap::Backup
     def exist?
       examine
       true
-    rescue Net::IMAP::NoResponseError => e
+    rescue FolderNotFound
       false
     end
 
     def create
       return if exist?
+
       imap.create(name)
     end
 
@@ -47,8 +50,7 @@ module Imap::Backup
     def uids
       examine
       imap.uid_search(["ALL"]).sort
-    rescue Net::IMAP::NoResponseError
-      Imap::Backup.logger.warn "Folder '#{name}' does not exist"
+    rescue FolderNotFound
       []
     end
 
@@ -56,12 +58,12 @@ module Imap::Backup
       examine
       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")
       attributes
-    rescue Net::IMAP::NoResponseError
-      Imap::Backup.logger.warn "Folder '#{name}' does not exist"
+    rescue FolderNotFound
       nil
     end
 
@@ -76,6 +78,9 @@ module Imap::Backup
 
     def examine
       imap.examine(name)
+    rescue Net::IMAP::NoResponseError
+      Imap::Backup.logger.warn "Folder '#{name}' does not exist"
+      raise FolderNotFound, "Folder '#{name}' does not exist"
     end
 
     def extract_uid(response)

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

@@ -9,7 +9,7 @@ module Imap::Backup
     def run
       catch :done do
         loop do
-          system("clear")
+          Kernel.system("clear")
           create_menu
         end
       end
@@ -46,12 +46,12 @@ module Imap::Backup
     def modify_email(menu)
       menu.choice("modify email") do
         username = Configuration::Asker.email(username)
-        puts "username: #{username}"
+        Kernel.puts "username: #{username}"
         other_accounts = store.accounts.reject { |a| a == account }
         others = other_accounts.map { |a| a[:username] }
-        puts "others: #{others.inspect}"
+        Kernel.puts "others: #{others.inspect}"
         if others.include?(username)
-          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] == "")
@@ -89,7 +89,7 @@ module Imap::Backup
             a[:username] != account[:username] && a[:local_path] == p
           end
           if same
-            puts "The path '#{p}' is used to backup " \
+            Kernel.puts "The path '#{p}' is used to backup " \
               "the account '#{same[:username]}'"
             false
           else
@@ -112,7 +112,7 @@ module Imap::Backup
     def test_connection(menu)
       menu.choice("test connection") do
         result = Configuration::ConnectionTester.test(account)
-        puts result
+        Kernel.puts result
         highline.ask "Press a key "
       end
     end
@@ -141,7 +141,7 @@ module Imap::Backup
     def default_server(username)
       provider = Email::Provider.for_address(username)
       if provider.provider == :default
-        puts "Can't decide provider for email address '#{username}'"
+        Kernel.puts "Can't decide provider for email address '#{username}'"
         return nil
       end
       provider.host

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

@@ -2,7 +2,7 @@ module Imap::Backup
   module Configuration; end
 
   class Configuration::Asker < Struct.new(:highline)
-    EMAIL_MATCHER = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]+$/i
+    EMAIL_MATCHER = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]+$/i.freeze
 
     def initialize(highline)
       super
@@ -24,6 +24,7 @@ module Imap::Backup
         return nil if !highline.agree(
           "the password and confirmation did not match.\nContinue? (y/n) "
         )
+
         return self.password
       end
       password

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

@@ -7,7 +7,7 @@ module Imap::Backup
       "Connection successful"
     rescue Net::IMAP::NoResponseError
       "No response"
-    rescue Exception => e
+    rescue StandardError => e
       "Unexpected error: #{e}"
     end
   end

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

@@ -21,9 +21,11 @@ module Imap::Backup
         return
       end
 
+      remove_missing
+
       catch :done do
         loop do
-          system("clear")
+          Kernel.system("clear")
           show_menu
         end
       end
@@ -44,21 +46,46 @@ module Imap::Backup
     def add_folders(menu)
       folders.each do |folder|
         name = folder.name
-        mark = is_selected?(name) ? "+" : "-"
+        mark = selected?(name) ? "+" : "-"
         menu.choice("#{mark} #{name}") do
           toggle_selection name
         end
       end
     end
 
-    def is_selected?(folder_name)
+    def selected?(folder_name)
       backup_folders = account[:folders]
       return false if backup_folders.nil?
+
       backup_folders.find { |f| f[:name] == folder_name }
     end
 
+    def remove_missing
+      removed = []
+      backup_folders = []
+      account[:folders].each do |f|
+        found = folders.find { |folder| folder.name == f[:name] }
+        if found
+          backup_folders << f
+        else
+          removed << f[:name]
+        end
+      end
+
+      return if removed.empty?
+
+      account[:folders] = backup_folders
+      account[:modified] = true
+
+      Kernel.puts <<~MESSAGE
+        The following folders have been removed: #{removed.join(', ')}
+      MESSAGE
+
+      highline.ask "Press a key "
+    end
+
     def toggle_selection(folder_name)
-      if is_selected?(folder_name)
+      if selected?(folder_name)
         changed = account[:folders].reject! { |f| f[:name] == folder_name }
         account[:modified] = true if changed
       else
@@ -70,7 +97,7 @@ module Imap::Backup
 
     def connection
       @connection ||= Account::Connection.new(account)
-    rescue
+    rescue StandardError
       nil
     end
 

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

@@ -10,6 +10,7 @@ module Imap::Backup
 
     def setup_logging
       return if !config_exists?
+
       Imap::Backup.setup_logging config
     end
 
@@ -25,6 +26,7 @@ module Imap::Backup
 
     def config
       return @config if @config
+
       if !config_exists?
         path = Configuration::Store.default_pathname
         raise ConfigurationNotFound, "Configuration file '#{path}' not found"

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

@@ -13,7 +13,7 @@ module Imap::Backup
       Imap::Backup.setup_logging config
       catch :done do
         loop do
-          system("clear")
+          Kernel.system("clear")
           show_menu
         end
       end
@@ -40,6 +40,7 @@ module Imap::Backup
     def account_items(menu)
       config.accounts.each do |account|
         next if account[:delete]
+
         item = account[:username].clone
         item << " *" if account[:modified]
         menu.choice(item) do