backup 4.3.0 → 5.0.0.beta.3

data/lib/backup/cleaner.rb

@@ -1,11 +1,8 @@
-# encoding: utf-8
-
 module Backup
   module Cleaner
     class Error < Backup::Error; end
 
     class << self
-
       ##
       # Logs warnings if any temporary files still exist
       # from the last time this model/trigger was run,
@@ -17,7 +14,7 @@ module Backup
         if File.exist?(packaging_folder)
           messages << <<-EOS
             The temporary packaging folder still exists!
-            '#{ packaging_folder }'
+            '#{packaging_folder}'
             It will now be removed.
           EOS
           FileUtils.rm_rf(packaging_folder)
@@ -27,23 +24,23 @@ module Backup
         unless package_files.empty?
           # the chances of the packaging folder AND
           # the package files existing are practically nil
-          messages << ('-' * 74) unless messages.empty?
+          messages << ("-" * 74) unless messages.empty?
 
           messages << <<-EOS
-            The temporary backup folder '#{ Config.tmp_path }'
+            The temporary backup folder '#{Config.tmp_path}'
             appears to contain the package files from the previous backup!
-            #{ package_files.join("\n") }
+            #{package_files.join("\n")}
             These files will now be removed.
           EOS
-          package_files.each {|file| FileUtils.rm_f(file) }
+          package_files.each { |file| FileUtils.rm_f(file) }
         end
 
         unless messages.empty?
           Logger.warn Error.new(<<-EOS)
             Cleanup Warning
-            #{ messages.join("\n") }
+            #{messages.join("\n")}
             Please check the log for messages and/or your notifications
-            concerning this backup: '#{ model.label } (#{ model.trigger })'
+            concerning this backup: '#{model.label} (#{model.trigger})'
             The temporary files which had to be removed should not have existed.
           EOS
         end
@@ -76,7 +73,7 @@ module Backup
         if File.exist?(packaging_folder)
           messages << <<-EOS
             The temporary packaging folder still exists!
-            '#{ packaging_folder }'
+            '#{packaging_folder}'
             This folder may contain completed Archives and/or Database backups.
           EOS
         end
@@ -85,21 +82,21 @@ module Backup
         unless package_files.empty?
           # the chances of the packaging folder AND
           # the package files existing are practically nil
-          messages << ('-' * 74) unless messages.empty?
+          messages << ("-" * 74) unless messages.empty?
 
           messages << <<-EOS
-            The temporary backup folder '#{ Config.tmp_path }'
+            The temporary backup folder '#{Config.tmp_path}'
             appears to contain the backup files which were to be stored:
-            #{ package_files.join("\n") }
+            #{package_files.join("\n")}
           EOS
         end
 
         unless messages.empty?
           Logger.warn Error.new(<<-EOS)
             Cleanup Warning
-            #{ messages.join("\n") }
+            #{messages.join("\n")}
             Make sure you check these files before the next scheduled backup for
-            '#{ model.label } (#{ model.trigger })'
+            '#{model.label} (#{model.trigger})'
             These files will be removed at that time!
           EOS
         end
@@ -108,9 +105,8 @@ module Backup
       private
 
       def package_files_for(trigger)
-        Dir[File.join(Config.tmp_path,"#{ trigger }.tar{,[.-]*}")]
+        Dir[File.join(Config.tmp_path, "#{trigger}.tar{,[.-]*}")]
       end
-
     end
   end
 end

data/lib/backup/cli.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 ##
 # Build the Backup Command Line Interface using Thor
 module Backup
@@ -27,9 +25,9 @@ module Backup
     #
     # If the --check option is given, `backup check` will be run
     # and no triggers will be performed.
-    desc 'perform', "Performs the backup for the specified trigger(s)."
+    desc "perform", "Performs the backup for the specified trigger(s)."
 
-    long_desc <<-EOS.gsub(/^ +/, '')
+    long_desc <<-EOS.gsub(/^ +/, "")
       Performs the backup for the specified trigger(s).
 
       You may perform multiple backups by providing multiple triggers,
@@ -51,65 +49,65 @@ module Backup
     EOS
 
     method_option :trigger,
-                  :aliases  => ['-t', '--triggers'],
-                  :required => true,
-                  :type     => :string,
-                  :desc     => "Triggers to perform. e.g. 'trigger_a,trigger_b'"
+      aliases: ["-t", "--triggers"],
+      required: true,
+      type: :string,
+      desc: "Triggers to perform. e.g. 'trigger_a,trigger_b'"
 
     method_option :config_file,
-                  :aliases  => '-c',
-                  :type     => :string,
-                  :default  => '',
-                  :desc     => 'Path to your config.rb file.'
+      aliases: "-c",
+      type: :string,
+      default: "",
+      desc: "Path to your config.rb file."
 
     method_option :root_path,
-                  :aliases  => '-r',
-                  :type     => :string,
-                  :default  => '',
-                  :desc     => 'Root path to base all relative path on.'
+      aliases: "-r",
+      type: :string,
+      default: "",
+      desc: "Root path to base all relative path on."
 
     method_option :data_path,
-                  :aliases  => '-d',
-                  :type     => :string,
-                  :default  => '',
-                  :desc     => 'Path to store storage cycling data.'
+      aliases: "-d",
+      type: :string,
+      default: "",
+      desc: "Path to store storage cycling data."
 
     method_option :log_path,
-                  :aliases  => '-l',
-                  :type     => :string,
-                  :default  => '',
-                  :desc     => "Path to store Backup's log file."
+      aliases: "-l",
+      type: :string,
+      default: "",
+      desc: "Path to store Backup's log file."
 
     method_option :tmp_path,
-                  :type     => :string,
-                  :default  => '',
-                  :desc     => 'Path to store temporary data during the backup.'
+      type: :string,
+      default: "",
+      desc: "Path to store temporary data during the backup."
 
     # Note that :quiet, :syslog and :logfile are specified as :string types,
     # so the --no-<option> usage will set the value to nil instead of false.
     method_option :quiet,
-                  :aliases  => '-q',
-                  :type     => :string,
-                  :default  => false,
-                  :banner   => '',
-                  :desc     => 'Disable console log output.'
+      aliases: "-q",
+      type: :boolean,
+      default: false,
+      banner: "",
+      desc: "Disable console log output."
 
     method_option :syslog,
-                  :type     => :string,
-                  :default  => false,
-                  :banner   => '',
-                  :desc     => 'Enable logging to syslog.'
+      type: :boolean,
+      default: false,
+      banner: "",
+      desc: "Enable logging to syslog."
 
     method_option :logfile,
-                  :type     => :string,
-                  :default  => true,
-                  :banner   => '',
-                  :desc     => "Enable Backup's log file."
+      type: :boolean,
+      default: true,
+      banner: "",
+      desc: "Enable Backup's log file."
 
     method_option :check,
-                  :type     => :boolean,
-                  :default  => false,
-                  :desc     => 'Check configuration for errors or warnings.'
+      type: :boolean,
+      default: false,
+      desc: "Check configuration for errors or warnings."
 
     def perform
       check if options[:check] # this will exit()
@@ -119,27 +117,28 @@ module Backup
         # Set logger options
         opts = options
         Logger.configure do
-          console.quiet     = opts[:quiet]
-          logfile.enabled   = opts[:logfile]
-          logfile.log_path  = opts[:log_path]
-          syslog.enabled    = opts[:syslog]
+          console.quiet    = opts[:quiet]
+          logfile.enabled  = opts[:logfile]
+          logfile.log_path = opts[:log_path]
+          syslog.enabled   = opts[:syslog]
         end
 
         # Load the user's +config.rb+ file and all their Models
         Config.load(options)
 
         # Identify all Models to be run for the given +triggers+.
-        triggers = options[:trigger].split(',').map(&:strip)
-        models = triggers.map {|trigger|
+        triggers = options[:trigger].split(",").map(&:strip)
+        models = triggers.uniq.flat_map do |trigger|
           Model.find_by_trigger(trigger)
-        }.flatten.uniq
+        end
 
-        raise Error, "No Models found for trigger(s) " +
-            "'#{ triggers.join(',') }'." if models.empty?
+        if models.empty?
+          raise Error, "No Models found for trigger(s) " \
+            "'#{triggers.join(",")}'."
+        end
 
         # Finalize Logger and begin real-time logging.
         Logger.start!
-
       rescue Exception => err
         Logger.error Error.wrap(err)
         unless Helpers.is_backup_error? err
@@ -148,7 +147,7 @@ module Backup
         # Logger configuration will be ignored
         # and messages will be output to the console only.
         Logger.abort!
-        exit(3)
+        exit 3
       end
 
       until models.empty?
@@ -164,7 +163,7 @@ module Backup
             Logger.info Error.new(<<-EOS)
               Backup will now continue...
               The following triggers will now be processed:
-              (#{ models.map {|m| m.trigger }.join(', ') })
+              (#{models.map(&:trigger).join(", ")})
             EOS
           end
         when 3
@@ -173,7 +172,7 @@ module Backup
             Logger.error FatalError.new(<<-EOS)
               Backup will now exit.
               The following triggers will not be processed:
-              (#{ models.map {|m| m.trigger }.join(', ') })
+              (#{models.map(&:trigger).join(", ")})
             EOS
           end
         end
@@ -203,19 +202,19 @@ module Backup
     #
     # If successful, this method with exit(0).
     # If there are Errors or Warnings, it will exit(1).
-    desc 'check', 'Check for configuration errors or warnings'
+    desc "check", "Check for configuration errors or warnings"
 
-    long_desc <<-EOS.gsub(/^ +/, '')
+    long_desc <<-EOS.gsub(/^ +/, "")
       Loads your 'config.rb' file and all models and reports any
       errors or warnings with your configuration, including missing
       dependencies and the use of any deprecated settings.
     EOS
 
     method_option :config_file,
-                  :aliases  => '-c',
-                  :type     => :string,
-                  :default  => '',
-                  :desc     => "Path to your config.rb file."
+      aliases: "-c",
+      type: :string,
+      default: "",
+      desc: "Path to your config.rb file."
 
     def check
       begin
@@ -228,10 +227,10 @@ module Backup
       end
 
       if Logger.has_warnings? || Logger.has_errors?
-        Logger.error 'Configuration Check Failed.'
+        Logger.error "Configuration Check Failed."
         exit_code = 1
       else
-        Logger.info 'Configuration Check Succeeded.'
+        Logger.info "Configuration Check Succeeded."
         exit_code = 0
       end
 
@@ -245,130 +244,127 @@ module Backup
     # For example:
     #   $ backup generate:model --trigger my_backup --databases='mongodb'
     # will generate a pre-populated model with a base MongoDB setup
-    desc 'generate:model', "Generates a Backup model file."
+    desc "generate:model", "Generates a Backup model file."
 
-    long_desc <<-EOS.gsub(/^ +/, '')
+    long_desc <<-EOS.gsub(/^ +/, "")
       Generates a Backup model file.
 
       If your configuration file is not in the default location at
-      #{ Config.config_file }
+      #{Config.config_file}
       you must specify it's location using '--config-file'.
       If no configuration file exists at this location, one will be created.
 
       The model file will be created as '<config_path>/models/<trigger>.rb'
       Your model file will be created in a 'models/' sub-directory
       where your config file is located. The default location would be:
-      #{ Config.root_path }/models/<trigger>.rb
+      #{Config.root_path}/models/<trigger>.rb
     EOS
 
     method_option :trigger,
-                  :aliases  => '-t',
-                  :required => true,
-                  :type     => :string,
-                  :desc     => 'Trigger name for the Backup model'
+      aliases: "-t",
+      required: true,
+      type: :string,
+      desc: "Trigger name for the Backup model"
 
     method_option :config_file,
-                  :type     => :string,
-                  :desc     => 'Path to your Backup configuration file'
+      type: :string,
+      desc: "Path to your Backup configuration file"
 
     # options with their available values
-    %w{ databases storages syncers encryptor compressor notifiers }.each do |name|
-      path = File.join(Backup::TEMPLATE_PATH, 'cli', name)
-      opts = Dir[path + '/*'].sort.map {|p| File.basename(p) }.join(', ')
-      method_option name, :type => :string, :desc => "(#{ opts })"
+    %w[databases storages syncers encryptor compressor notifiers].each do |name|
+      path = File.join(Backup::TEMPLATE_PATH, "cli", name)
+      opts = Dir[path + "/*"].sort.map { |p| File.basename(p) }.join(", ")
+      method_option name, type: :string, desc: "(#{opts})"
     end
 
     method_option :archives,
-                  :type     => :boolean,
-                  :desc     => 'Model will include tar archives.'
+      type: :boolean,
+      desc: "Model will include tar archives."
 
     method_option :splitter,
-                  :type     => :boolean,
-                  :default  => false,
-                  :desc     => 'Add Splitter to the model'
+      type: :boolean,
+      default: false,
+      desc: "Add Splitter to the model"
 
-    define_method 'generate:model' do
-      opts = options.merge(:trigger => options[:trigger].gsub(/\W/, '_'))
+    define_method "generate:model" do
+      opts = options.merge(trigger: options[:trigger].gsub(/\W/, "_"))
       config_file = opts[:config_file] ?
                     File.expand_path(opts.delete(:config_file)) : Config.config_file
-      models_path = File.join(File.dirname(config_file), 'models')
-      model_file  = File.join(models_path, "#{ opts[:trigger] }.rb")
+      models_path = File.join(File.dirname(config_file), "models")
+      model_file  = File.join(models_path, "#{opts[:trigger]}.rb")
 
       unless File.exist?(config_file)
-        invoke 'generate:config', [], :config_file => config_file
+        invoke "generate:config", [], config_file: config_file
       end
 
       FileUtils.mkdir_p(models_path)
       if Helpers.overwrite?(model_file)
-        File.open(model_file, 'w') do |file|
-          file.write(Backup::Template.new({:options => opts}).result('cli/model'))
+        File.open(model_file, "w") do |file|
+          file.write(Backup::Template.new(options: opts).result("cli/model"))
         end
-        puts "Generated model file: '#{ model_file }'."
+        puts "Generated model file: '#{model_file}'."
       end
     end
 
     ##
     # [Generate:Config]
     # Generates the main configuration file
-    desc 'generate:config', 'Generates the main Backup configuration file'
+    desc "generate:config", "Generates the main Backup configuration file"
 
-    long_desc <<-EOS.gsub(/^ +/, '')
+    long_desc <<-EOS.gsub(/^ +/, "")
       Path to the Backup configuration file to generate.
 
       Defaults to:
 
-      #{ Config.config_file }
+      #{Config.config_file}
     EOS
 
     method_option :config_file,
-                  :type => :string,
-                  :desc => 'Path to the Backup configuration file to generate.'
+      type: :string,
+      desc: "Path to the Backup configuration file to generate."
 
-    define_method 'generate:config' do
+    define_method "generate:config" do
       config_file = options[:config_file] ?
           File.expand_path(options[:config_file]) : Config.config_file
 
       FileUtils.mkdir_p(File.dirname(config_file))
       if Helpers.overwrite?(config_file)
-        File.open(config_file, 'w') do |file|
-          file.write(Backup::Template.new.result('cli/config'))
+        File.open(config_file, "w") do |file|
+          file.write(Backup::Template.new.result("cli/config"))
         end
-        puts "Generated configuration file: '#{ config_file }'."
+        puts "Generated configuration file: '#{config_file}'."
       end
     end
 
     ##
     # [Version]
     # Returns the current version of the Backup gem
-    map '-v' => :version
-    desc 'version', 'Display installed Backup version'
+    map "-v" => :version
+    desc "version", "Display installed Backup version"
     def version
-      puts "Backup #{ Backup::VERSION }"
+      puts "Backup #{Backup::VERSION}"
     end
 
     # This is to avoid Thor's warnings when stubbing methods on the Thor class.
     module Helpers
       class << self
-
         def overwrite?(path)
           return true unless File.exist?(path)
 
-          $stderr.print "A file already exists at '#{ path }'.\n" +
+          $stderr.print "A file already exists at '#{path}'.\n" \
                         "Do you want to overwrite? [y/n] "
           /^[Yy]/ =~ $stdin.gets
         end
 
         def exec!(cmd)
-          puts "Launching: #{ cmd }"
+          puts "Launching: #{cmd}"
           exec(cmd)
         end
 
         def is_backup_error?(error)
           error.class.ancestors.include? Backup::Error
         end
-
       end
     end
-
   end
 end