backup 4.4.1 → 5.0.0.beta.1

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/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

data/lib/backup/database/mysql.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   module Database
     class MySQL < Base
@@ -78,71 +76,73 @@ module Backup
         super
 
         pipeline = Pipeline.new
-        dump_ext = sql_backup? ? 'sql' : 'tar'
+        dump_ext = sql_backup? ? "sql" : "tar"
 
         pipeline << sudo_option(sql_backup? ? mysqldump : innobackupex)
 
-        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?
           log!(:finished)
         else
-          raise Error, "Dump Failed!\n" + pipeline.error_messages
+          raise Error, "Dump Failed!\n#{pipeline.error_messages}"
         end
       end
 
       private
 
       def mysqldump
-        "#{ utility(:mysqldump) } #{ user_options } #{ credential_options } " +
-        "#{ connectivity_options } #{ name_option } " +
-        "#{ tables_to_dump } #{ tables_to_skip }"
+        "#{utility(:mysqldump)} #{user_options} #{credential_options} " \
+          "#{connectivity_options} #{name_option} " \
+          "#{tables_to_dump} #{tables_to_skip}"
       end
 
       def credential_options
         opts = []
-        opts << "--user=#{ Shellwords.escape(username) }" if username
-        opts << "--password=#{ Shellwords.escape(password) }" if password
-        opts.join(' ')
+        opts << "--user=#{Shellwords.escape(username)}" if username
+        opts << "--password=#{Shellwords.escape(password)}" if password
+        opts.join(" ")
       end
 
       def connectivity_options
-        return "--socket='#{ socket }'" if socket
+        return "--socket='#{socket}'" if socket
 
         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 user_options
-        Array(additional_options).join(' ')
+        Array(additional_options).join(" ")
       end
 
       def user_prepare_options
-        Array(prepare_options).join(' ')
+        Array(prepare_options).join(" ")
       end
 
       def name_option
-        dump_all? ? '--all-databases' : name
+        dump_all? ? "--all-databases" : name
       end
 
       def tables_to_dump
-        Array(only_tables).join(' ') unless dump_all?
+        Array(only_tables).join(" ") unless dump_all?
       end
 
       def tables_to_skip
         Array(skip_tables).map do |table|
-          table = (dump_all? || table['.']) ? table : "#{ name }.#{ table }"
-          "--ignore-table='#{ table }'"
-        end.join(' ')
+          table = dump_all? || table["."] ? table : "#{name}.#{table}"
+          "--ignore-table='#{table}'"
+        end.join(" ")
       end
 
       def dump_all?
@@ -155,28 +155,28 @@ module Backup
 
       def innobackupex
         # Creation phase
-        "#{ utility(:innobackupex) } #{ credential_options } " +
-        "#{ connectivity_options } #{ user_options } " +
-        "--no-timestamp #{ temp_dir } #{ quiet_option } && " +
-        innobackupex_prepare +
-        # Move files to tar-ed stream on stdout
-        "#{ utility(:tar) } --remove-files -cf -  " +
-        "-C #{ File.dirname(temp_dir) } #{ File.basename(temp_dir) }"
+        "#{utility(:innobackupex)} #{credential_options} " \
+          "#{connectivity_options} #{user_options} " \
+          "--no-timestamp #{temp_dir} #{quiet_option} && " +
+          innobackupex_prepare +
+          # Move files to tar-ed stream on stdout
+          "#{utility(:tar)} --remove-files -cf -  " \
+          "-C #{File.dirname(temp_dir)} #{File.basename(temp_dir)}"
       end
 
       def innobackupex_prepare
         return "" unless @prepare_backup
         # Log applying phase (prepare for restore)
-        "#{ utility(:innobackupex) } --apply-log #{ temp_dir } " +
-        "#{ user_prepare_options }  #{ quiet_option } && "
+        "#{utility(:innobackupex)} --apply-log #{temp_dir} " \
+          "#{user_prepare_options}  #{quiet_option} && "
       end
 
       def sudo_option(command_block)
         return command_block unless sudo_user
 
-        "sudo -s -u #{ sudo_user } -- <<END_OF_SUDO\n" +
-        "#{command_block}\n" +
-        "END_OF_SUDO\n"
+        "sudo -s -u #{sudo_user} -- <<END_OF_SUDO\n" \
+          "#{command_block}\n" \
+          "END_OF_SUDO\n"
       end
 
       def quiet_option
@@ -184,9 +184,8 @@ module Backup
       end
 
       def temp_dir
-        File.join(dump_path, dump_filename + ".bkpdir")
+        File.join(dump_path, "#{dump_filename}.bkpdir")
       end
-
     end
   end
 end