backup 4.4.1 → 5.0.0.beta.3

data/lib/backup/compressor/gzip.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Compressor
     class Gzip < Base
@@ -35,8 +33,8 @@ module Backup
       # Determine if +--rsyncable+ is supported and cache the result.
       def self.has_rsyncable?
         return @has_rsyncable unless @has_rsyncable.nil?
-        cmd = "#{ utility(:gzip) } --rsyncable --version >/dev/null 2>&1; echo $?"
-        @has_rsyncable = %x[#{ cmd }].chomp == '0'
+        cmd = "#{utility(:gzip)} --rsyncable --version >/dev/null 2>&1; echo $?"
+        @has_rsyncable = `#{cmd}`.chomp == "0"
       end
 
       ##
@@ -49,26 +47,27 @@ module Backup
 
         instance_eval(&block) if block_given?
 
-        @cmd = "#{ utility(:gzip) }#{ options }"
-        @ext = '.gz'
+        @cmd = "#{utility(:gzip)}#{options}"
+        @ext = ".gz"
       end
 
       private
 
       def options
-        opts = ''
-        opts << " -#{ @level }" if @level
-        if self.class.has_rsyncable?
-          opts << ' --rsyncable'
-        else
-          Logger.warn Error.new(<<-EOS)
-            'rsyncable' option ignored.
-            Your system's 'gzip' does not support the `--rsyncable` option.
-          EOS
-        end if @rsyncable
+        opts = ""
+        opts << " -#{@level}" if @level
+        if @rsyncable
+          if self.class.has_rsyncable?
+            opts << " --rsyncable"
+          else
+            Logger.warn Error.new(<<-EOS)
+              'rsyncable' option ignored.
+              Your system's 'gzip' does not support the `--rsyncable` option.
+            EOS
+          end
+        end
         opts
       end
-
     end
   end
 end

data/lib/backup/config/dsl.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Config
     # Context for loading user config.rb and model files.
@@ -27,23 +25,23 @@ module Backup
           create_modules(
             DSL,
             [ # Databases
-              ['MySQL', 'PostgreSQL', 'MongoDB', 'Redis', 'Riak', 'OpenLDAP', 'SQLite'],
+              ["MySQL", "PostgreSQL", "MongoDB", "Redis", "Riak", "OpenLDAP", "SQLite"],
               # Storages
-              ['S3', 'CloudFiles', 'Ninefold', 'Dropbox', 'FTP',
-              'SFTP', 'SCP', 'RSync', 'Local', 'Qiniu'],
+              ["S3", "CloudFiles", "Dropbox", "FTP",
+               "SFTP", "SCP", "RSync", "Local", "Qiniu"],
               # Compressors
-              ['Gzip', 'Bzip2', 'Custom', 'Pbzip2', 'Lzma'],
+              ["Gzip", "Bzip2", "Custom"],
               # Encryptors
-              ['OpenSSL', 'GPG'],
+              ["OpenSSL", "GPG"],
               # Syncers
               [
-                { 'Cloud' => ['CloudFiles', 'S3'] },
-                { 'RSync' => ['Push', 'Pull', 'Local'] }
+                { "Cloud" => ["CloudFiles", "S3"] },
+                { "RSync" => ["Push", "Pull", "Local"] }
               ],
               # Notifiers
-              ['Mail', 'Twitter', 'Campfire', 'Prowl',
-              'Hipchat', 'PagerDuty', 'Pushover', 'HttpPost', 'Nagios',
-              'Slack', 'FlowDock', 'Zabbix', 'Ses', 'DataDog', 'Command']
+              ["Mail", "Twitter", "Campfire", "Prowl",
+               "Hipchat", "PagerDuty", "Pushover", "HttpPost", "Nagios",
+               "Slack", "FlowDock", "Zabbix", "Ses", "DataDog", "Command"]
             ]
           )
         end
@@ -69,7 +67,7 @@ module Backup
         end
       end
 
-      add_dsl_constants  # add constants on load
+      add_dsl_constants # add constants on load
 
       attr_reader :_config_options
 
@@ -79,25 +77,26 @@ module Backup
 
       # Allow users to set command line path options in config.rb
       [:root_path, :data_path, :tmp_path].each do |name|
-        define_method name, lambda {|path| _config_options[name] = path }
+        define_method name do |path|
+          _config_options[name] = path
+        end
       end
 
       # Allows users to create preconfigured models.
       def preconfigure(name, &block)
         unless name.is_a?(String) && name =~ /^[A-Z]/
-          raise Error, "Preconfigured model names must be given as a string " +
+          raise Error, "Preconfigured model names must be given as a string " \
                         "and start with a capital letter."
         end
 
         if DSL.const_defined?(name)
-          raise Error, "'#{ name }' is already in use " +
+          raise Error, "'#{name}' is already in use " \
                         "and can not be used for a preconfigured model."
         end
 
         DSL.const_set(name, Class.new(Model))
         DSL.const_get(name).preconfigure(&block)
       end
-
     end
   end
 end

data/lib/backup/config/helpers.rb

@@ -1,16 +1,13 @@
-# encoding: utf-8
-require 'ostruct'
+require "ostruct"
 
 module Backup
   module Config
     module Helpers
-
       def self.included(klass)
         klass.extend ClassMethods
       end
 
       module ClassMethods
-
         def defaults
           @defaults ||= Config::Defaults.new
 
@@ -31,12 +28,12 @@ module Backup
         end
 
         def log_deprecation_warning(name, deprecation)
-          msg = "#{ self }##{ name } has been deprecated as of " +
-              "backup v.#{ deprecation[:version] }"
-          msg << "\n#{ deprecation[:message] }" if deprecation[:message]
+          msg = "#{self}##{name} has been deprecated as of " \
+              "backup v.#{deprecation[:version]}"
+          msg << "\n#{deprecation[:message]}" if deprecation[:message]
           Logger.warn Config::Error.new(<<-EOS)
             [DEPRECATION WARNING]
-            #{ msg }
+            #{msg}
           EOS
         end
 
@@ -65,12 +62,11 @@ module Backup
         #
         def attr_deprecate(name, args = {})
           deprecations[name] = {
-            :version => nil,
-            :message => nil,
-            :action => nil
+            version: nil,
+            message: nil,
+            action: nil
           }.merge(args)
         end
-
       end # ClassMethods
 
       private
@@ -107,10 +103,10 @@ module Backup
       #
       def method_missing(name, *args)
         deprecation = nil
-        if method = name.to_s.chomp!('=')
+        if method = name.to_s.chomp!("=")
           if (len = args.count) != 1
             raise ArgumentError,
-              "wrong number of arguments (#{ len } for 1)", caller(1)
+              "wrong number of arguments (#{len} for 1)", caller(1)
           end
           deprecation = self.class.deprecations[method.to_sym]
         end
@@ -122,7 +118,6 @@ module Backup
           super
         end
       end
-
     end # Helpers
 
     # Store for pre-configured defaults.
@@ -138,6 +133,5 @@ module Backup
         @table.clear
       end
     end
-
   end
 end

data/lib/backup/config.rb

@@ -1,15 +1,14 @@
-# encoding: utf-8
-require 'backup/config/dsl'
-require 'backup/config/helpers'
+require "backup/config/dsl"
+require "backup/config/helpers"
 
 module Backup
   module Config
     class Error < Backup::Error; end
 
     DEFAULTS = {
-      :config_file  => 'config.rb',
-      :data_path    => '.data',
-      :tmp_path     => '.tmp'
+      config_file: "config.rb",
+      data_path: ".data",
+      tmp_path: ".tmp"
     }
 
     class << self
@@ -19,20 +18,20 @@ module Backup
 
       # Loads the user's +config.rb+ and all model files.
       def load(options = {})
-        update(options)  # from the command line
+        update(options) # from the command line
 
         unless File.exist?(config_file)
           raise Error, "Could not find configuration file: '#{config_file}'."
         end
 
         config = File.read(config_file)
-        version = Backup::VERSION.split('.').first
+        version = Backup::VERSION.split(".").first
         unless config =~ /^# Backup v#{ version }\.x Configuration$/
           raise Error, <<-EOS
             Invalid Configuration File
-            The configuration file at '#{ config_file }'
-            does not appear to be a Backup v#{ version }.x configuration file.
-            If you have upgraded to v#{ version }.x from a previous version,
+            The configuration file at '#{config_file}'
+            does not appear to be a Backup v#{version}.x configuration file.
+            If you have upgraded to v#{version}.x from a previous version,
             you need to upgrade your configuration file.
             Please see the instructions for upgrading in the Backup documentation.
           EOS
@@ -44,7 +43,7 @@ module Backup
         update(dsl._config_options)  # from config.rb
         update(options)              # command line takes precedence
 
-        Dir[File.join(File.dirname(config_file), 'models', '*.rb')].each do |model|
+        Dir[File.join(File.dirname(config_file), "models", "*.rb")].each do |model|
           dsl.instance_eval(File.read(model), model)
         end
       end
@@ -79,7 +78,7 @@ module Backup
           raise Error, <<-EOS
             Root Path Not Found
             When specifying a --root-path, the path must exist.
-            Path was: #{ path }
+            Path was: #{path}
           EOS
         end
         @root_path = path
@@ -88,7 +87,7 @@ module Backup
       def set_path_variable(name, path, ending, root_path)
         # strip any trailing '/' in case the user supplied this as part of
         # an absolute path, so we can match it against File.expand_path()
-        path = path.to_s.sub(/\/\s*$/, '').lstrip
+        path = path.to_s.sub(/\/\s*$/, "").lstrip
         new_path = false
         # If no path is given, the variable will not be set/updated
         # unless a root_path was given. In which case the value will
@@ -108,12 +107,12 @@ module Backup
       end
 
       def reset!
-        @user      = ENV['USER'] || Etc.getpwuid.name
-        @root_path = File.join(File.expand_path(ENV['HOME'] || ''), 'Backup')
-        update(:root_path => @root_path)
+        @user      = ENV["USER"] || Etc.getpwuid.name
+        @root_path = File.join(File.expand_path(ENV["HOME"] || ""), "Backup")
+        update(root_path: @root_path)
       end
     end
 
-    reset!  # set defaults on load
+    reset! # set defaults on load
   end
 end

data/lib/backup/database/base.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Database
     class Error < Backup::Error; end
@@ -16,8 +14,8 @@ module Backup
       # the model.
       def initialize(model, database_id = nil)
         @model = model
-        @database_id = database_id.to_s.gsub(/\W/, '_') if database_id
-        @dump_path = File.join(Config.tmp_path, model.trigger, 'databases')
+        @database_id = database_id.to_s.gsub(/\W/, "_") if database_id
+        @dump_path = File.join(Config.tmp_path, model.trigger, "databases")
         load_defaults!
       end
 
@@ -45,11 +43,13 @@ module Backup
       # Model#initialize calls this method *after* all defined databases have
       # been initialized so `backup check` can report these warnings.
       def dump_filename
-        @dump_filename ||= begin
-          unless database_id
-            if model.databases.select {|d| d.class == self.class }.count > 1
-              sleep 1; @database_id = Time.now.to_i.to_s[-5, 5]
-              Logger.warn Error.new(<<-EOS)
+        @dump_filename ||=
+          begin
+            unless database_id
+              if model.databases.select { |d| d.class == self.class }.count > 1
+                sleep 1
+                @database_id = Time.now.to_i.to_s[-5, 5]
+                Logger.warn Error.new(<<-EOS)
                 Database Identifier Missing
                 When multiple Databases are configured in a single Backup Model
                 that have the same class (MySQL, PostgreSQL, etc.), the optional
@@ -58,27 +58,28 @@ module Backup
                 This will result in an output file in your final backup package like:
                 databases/MySQL-database_id.sql
 
-                Backup has auto-generated an identifier (#{ database_id }) for this
+                Backup has auto-generated an identifier (#{database_id}) for this
                 database dump and will now continue.
-              EOS
+                EOS
+              end
             end
-          end
 
-          self.class.name.split('::').last + (database_id ? "-#{ database_id }" : '')
-        end
+            self.class.name.split("::").last + (database_id ? "-#{database_id}" : "")
+          end
       end
 
       def database_name
-        @database_name ||= self.class.to_s.sub('Backup::', '') +
-            (database_id ? " (#{ database_id })" : '')
+        @database_name ||= self.class.to_s.sub("Backup::", "") +
+          (database_id ? " (#{database_id})" : "")
       end
 
       def log!(action)
-        msg = case action
-              when :started then 'Started...'
-              when :finished then 'Finished!'
-              end
-        Logger.info "#{ database_name } #{ msg }"
+        msg =
+          case action
+          when :started then "Started..."
+          when :finished then "Finished!"
+          end
+        Logger.info "#{database_name} #{msg}"
       end
     end
   end

data/lib/backup/database/mongodb.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Database
     class MongoDB < Base
@@ -60,7 +58,6 @@ module Backup
         lock_database if @lock
         dump!
         package!
-
       ensure
         unlock_database if @lock
       end
@@ -78,7 +75,7 @@ module Backup
           run(mongodump)
         else
           collections.each do |collection|
-            run("#{ mongodump } --collection='#{ collection }'")
+            run("#{mongodump} --collection='#{collection}'")
           end
         end
       end
@@ -92,25 +89,27 @@ module Backup
       # If successful, +dump_packaging_path+ is removed.
       def package!
         pipeline = Pipeline.new
-        dump_ext = 'tar'
+        dump_ext = "tar"
 
-        pipeline << "#{ utility(:tar) } -cf - " +
-            "-C '#{ dump_path }' '#{ dump_filename }'"
+        pipeline << "#{utility(:tar)} -cf - " \
+            "-C '#{dump_path}' '#{dump_filename}'"
 
-        model.compressor.compress_with do |command, ext|
-          pipeline << command
-          dump_ext << ext
-        end if model.compressor
+        if model.compressor
+          model.compressor.compress_with do |command, ext|
+            pipeline << command
+            dump_ext << ext
+          end
+        end
 
-        pipeline << "#{ utility(:cat) } > " +
-            "'#{ File.join(dump_path, dump_filename) }.#{ dump_ext }'"
+        pipeline << "#{utility(:cat)} > " \
+          "'#{File.join(dump_path, dump_filename)}.#{dump_ext}'"
 
         pipeline.run
         if pipeline.success?
           FileUtils.rm_rf dump_packaging_path
           log!(:finished)
         else
-          raise Error, "Dump Failed!\n" + pipeline.error_messages
+          raise Error, "Dump Failed!\n#{pipeline.error_messages}"
         end
       end
 
@@ -119,69 +118,69 @@ module Backup
       end
 
       def mongodump
-        "#{ utility(:mongodump) } #{ name_option } #{ credential_options } " +
-        "#{ connectivity_options } #{ ipv6_option } #{ oplog_option } " +
-        "#{ user_options } --out='#{ dump_packaging_path }'"
+        "#{utility(:mongodump)} #{name_option} #{credential_options} " \
+          "#{connectivity_options} #{ipv6_option} #{oplog_option} " \
+          "#{user_options} --out='#{dump_packaging_path}'"
       end
 
       def name_option
-        "--db='#{ name }'" if name
+        return unless name
+        "--db='#{name}'"
       end
 
       def credential_options
         opts = []
-        opts << "--username='#{ username }'" if username
-        opts << "--password='#{ password }'" if password
-        opts << "--authenticationDatabase='#{ authdb }'" if authdb
-        opts.join(' ')
+        opts << "--username='#{username}'" if username
+        opts << "--password='#{password}'" if password
+        opts << "--authenticationDatabase='#{authdb}'" if authdb
+        opts.join(" ")
       end
 
       def connectivity_options
         opts = []
-        opts << "--host='#{ host }'" if host
-        opts << "--port='#{ port }'" if port
-        opts.join(' ')
+        opts << "--host='#{host}'" if host
+        opts << "--port='#{port}'" if port
+        opts.join(" ")
       end
 
       def ipv6_option
-        '--ipv6' if ipv6
+        "--ipv6" if ipv6
       end
 
       def oplog_option
-        '--oplog' if oplog
+        "--oplog" if oplog
       end
 
       def user_options
-        Array(additional_options).join(' ')
+        Array(additional_options).join(" ")
       end
 
       def lock_database
-        lock_command = <<-EOS.gsub(/^ +/, '')
+        lock_command = <<-EOS.gsub(/^ +/, "")
           echo 'use admin
           db.setProfilingLevel(0)
-          db.fsyncLock()' | #{ mongo_shell }
+          db.fsyncLock()' | #{mongo_shell}
         EOS
 
         run(lock_command)
       end
 
       def unlock_database
-        unlock_command = <<-EOS.gsub(/^ +/, '')
+        unlock_command = <<-EOS.gsub(/^ +/, "")
           echo 'use admin
-          db.fsyncUnlock()' | #{ mongo_shell }
+          db.fsyncUnlock()' | #{mongo_shell}
         EOS
 
         run(unlock_command)
       end
 
       def mongo_shell
-        cmd = "#{ utility(:mongo) } #{ connectivity_options }".rstrip
-        cmd << " #{ credential_options }".rstrip
-        cmd << " #{ ipv6_option }".rstrip
-        cmd << " '#{ name }'" if name
+        cmd = "#{utility(:mongo)} #{connectivity_options}".rstrip
+        cmd << " #{credential_options}".rstrip
+        cmd << " #{ipv6_option}".rstrip
+        cmd << " '#{name}'" if name
         cmd
       end
-
     end
   end
 end