backup 4.4.1 → 5.0.0.beta.1

data/lib/backup/encryptor/open_ssl.rb

@@ -1,9 +1,6 @@
-# encoding: utf-8
-
 module Backup
   module Encryptor
     class OpenSSL < Base
-
       ##
       # The password that'll be used to encrypt the backup. This
       # password will be required to decrypt the backup later on.
@@ -42,7 +39,7 @@ module Backup
       # so that any clean-up may be performed after the yield.
       def encrypt_with
         log!
-        yield "#{ utility(:openssl) } #{ options }", '.enc'
+        yield "#{utility(:openssl)} #{options}", ".enc"
       end
 
       private
@@ -59,19 +56,19 @@ module Backup
       # Always sets a password option, if even no password is given,
       # but will prefer the password_file option if both are given.
       def options
-        opts = ['aes-256-cbc']
-        opts << '-base64' if @base64
-        opts << '-salt'   if @salt
+        opts = ["aes-256-cbc"]
+        opts << "-base64" if @base64
+        opts << "-salt"   if @salt
 
-        if @password_file.to_s.empty?
-          opts << "-k #{Shellwords.escape(@password)}"
-        else
-          opts << "-pass file:#{@password_file}"
-        end
+        opts <<
+          if @password_file.to_s.empty?
+            "-k #{Shellwords.escape(@password)}"
+          else
+            "-pass file:#{@password_file}"
+          end
 
-        opts.join(' ')
+        opts.join(" ")
       end
-
     end
   end
 end

data/lib/backup/errors.rb

@@ -1,29 +1,25 @@
-# encoding: utf-8
-
 module Backup
-
   # Provides cascading errors with formatted messages.
   # See the specs for details.
   module NestedExceptions
-
     def self.included(klass)
-      klass.extend Module.new {
+      klass.extend(Module.new do
         def wrap(wrapped_exception, msg = nil)
           new(msg, wrapped_exception)
         end
-      }
+      end)
     end
 
     def initialize(obj = nil, wrapped_exception = nil)
       @wrapped_exception = wrapped_exception
-      msg = (obj.respond_to?(:to_str) ? obj.to_str : obj.to_s).
-            gsub(/^ */, '  ').strip
-      msg = clean_name(self.class.name) + (msg.empty? ? '' : ": #{ msg }")
+      msg = (obj.respond_to?(:to_str) ? obj.to_str : obj.to_s)
+        .gsub(/^ */, "  ").strip
+      msg = clean_name(self.class.name) + (msg.empty? ? "" : ": #{msg}")
 
       if wrapped_exception
         msg << "\n--- Wrapped Exception ---\n"
         class_name = clean_name(wrapped_exception.class.name)
-        msg << class_name + ': ' unless
+        msg << class_name + ": " unless
             wrapped_exception.message.start_with? class_name
         msg << wrapped_exception.message
       end
@@ -43,9 +39,8 @@ module Backup
     private
 
     def clean_name(name)
-      name.sub(/^Backup::/, '')
+      name.sub(/^Backup::/, "")
     end
-
   end
 
   class Error < StandardError

data/lib/backup/logger.rb

@@ -1,13 +1,10 @@
-# encoding: utf-8
-
-require 'backup/logger/console'
-require 'backup/logger/logfile'
-require 'backup/logger/syslog'
-require 'backup/logger/fog_adapter'
+require "backup/logger/console"
+require "backup/logger/logfile"
+require "backup/logger/syslog"
+require "backup/logger/fog_adapter"
 
 module Backup
   class Logger
-
     class Config
       class Logger < Struct.new(:class, :options)
         def enabled?
@@ -44,22 +41,22 @@ module Backup
       #   [YYYY/MM/DD HH:MM:SS][level] message line text
       def formatted_lines
         timestamp = time.strftime("%Y/%m/%d %H:%M:%S")
-        lines.map {|line| "[#{ timestamp }][#{ level }] #{ line }" }
+        lines.map { |line| "[#{timestamp}][#{level}] #{line}" }
       end
 
       def matches?(ignores)
         text = lines.join("\n")
-        ignores.any? {|obj|
+        ignores.any? do |obj|
           obj.is_a?(Regexp) ? text.match(obj) : text.include?(obj)
-        }
+        end
       end
     end
 
     class << self
       extend Forwardable
       def_delegators :logger,
-          :start!, :abort!, :info, :warn, :error,
-          :messages, :has_warnings?, :has_errors?
+        :start!, :abort!, :info, :warn, :error,
+        :messages, :has_warnings?, :has_errors?
 
       ##
       # Allows the Logger to be configured.
@@ -137,9 +134,9 @@ module Backup
     # Sends a message to the Logger using the specified log level.
     # +obj+ may be any Object that responds to #to_s (i.e. an Exception)
     [:info, :warn, :error].each do |level|
-      define_method level, lambda {|obj|
+      define_method level do |obj|
         MUTEX.synchronize { log(obj, level) }
-      }
+      end
     end
 
     ##
@@ -169,7 +166,7 @@ module Backup
         @loggers << logger.class.new(logger.options) if logger.enabled?
       end
       messages.each do |message|
-        @loggers.each {|logger| logger.log(message) }
+        @loggers.each { |logger| logger.log(message) }
       end
     end
 
@@ -187,13 +184,14 @@ module Backup
     def log(obj, level)
       message = Message.new(Time.now.utc, level, obj.to_s.split("\n"))
 
-      message.level = :info if message.level == :warn &&
-          message.matches?(@config.ignores)
+      if message.level == :warn && message.matches?(@config.ignores)
+        message.level = :info
+      end
       @has_warnings ||= message.level == :warn
       @has_errors   ||= message.level == :error
 
       messages << message
-      @loggers.each {|logger| logger.log(message) }
+      @loggers.each { |logger| logger.log(message) }
     end
   end
 end

data/lib/backup/logger/console.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   class Logger
     class Console
@@ -30,22 +28,21 @@ module Backup
       end
 
       COLORS = {
-        :info   => "\e[32m%s\e[0m", # green
-        :warn   => "\e[33m%s\e[0m", # yellow
-        :error  => "\e[31m%s\e[0m"  # red
+        info: "\e[32m%s\e[0m", # green
+        warn: "\e[33m%s\e[0m", # yellow
+        error: "\e[31m%s\e[0m" # red
       }
 
-      def initialize(options = nil)
+      def initialize(_options = nil)
         $stdout.sync = $stderr.sync = true
       end
 
       def log(message)
         io = message.level == :info ? $stdout : $stderr
         lines = message.formatted_lines
-        lines.map! {|line| COLORS[message.level] % line } if io.tty?
+        lines.map! { |line| COLORS[message.level] % line } if io.tty?
         io.puts lines
       end
-
     end
   end
 end

data/lib/backup/logger/fog_adapter.rb

@@ -1,14 +1,11 @@
-# encoding: utf-8
-
 # require only the logger
-require 'formatador'
-require 'fog/core/logger'
+require "formatador"
+require "fog/core/logger"
 
 module Backup
   class Logger
     module FogAdapter
       class << self
-
         # Logged as :info so these won't generate warnings.
         # This is mostly to keep STDOUT clean and to provide
         # supplemental messages for our own warnings.
@@ -20,7 +17,6 @@ module Backup
         def tty?
           false
         end
-
       end
     end
   end

data/lib/backup/logger/logfile.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   class Logger
     class Logfile
@@ -60,7 +58,7 @@ module Backup
 
         def initialize
           @enabled = true
-          @log_path = ''
+          @log_path = ""
           @max_bytes = 500_000
         end
 
@@ -84,7 +82,7 @@ module Backup
       end
 
       def log(message)
-        File.open(@logfile, 'a') {|f| f.puts message.formatted_lines }
+        File.open(@logfile, "a") { |f| f.puts message.formatted_lines }
       end
 
       private
@@ -95,17 +93,17 @@ module Backup
       def setup_logfile
         # 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 = @options.log_path.chomp('/')
+        path = @options.log_path.chomp("/")
         if path.empty?
-          path = File.join(Backup::Config.root_path, 'log')
+          path = File.join(Backup::Config.root_path, "log")
         elsif path != File.expand_path(path)
           path = File.join(Backup::Config.root_path, path)
         end
         FileUtils.mkdir_p(path)
-        log_file = @options.log_file || 'backup.log'
+        log_file = @options.log_file || "backup.log"
         path = File.join(path, log_file)
         if File.exist?(path) && !File.writable?(path)
-          raise Error, "Log File at '#{ path }' is not writable"
+          raise Error, "Log File at '#{path}' is not writable"
         end
         path
       end
@@ -116,16 +114,16 @@ module Backup
         return unless File.exist?(@logfile)
 
         if File.stat(@logfile).size > @options.max_bytes
-          FileUtils.cp(@logfile, @logfile + '~')
-          File.open(@logfile + '~', 'r') do |io_in|
-            File.open(@logfile, 'w') do |io_out|
+          FileUtils.cp(@logfile, @logfile + "~")
+          File.open(@logfile + "~", "r") do |io_in|
+            File.open(@logfile, "w") do |io_out|
               io_in.seek(-@options.max_bytes, IO::SEEK_END) && io_in.gets
               while line = io_in.gets
                 io_out.puts line
               end
             end
           end
-          FileUtils.rm_f(@logfile + '~')
+          FileUtils.rm_f(@logfile + "~")
         end
       end
     end

data/lib/backup/logger/syslog.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Backup
   class Logger
     class Syslog
@@ -81,7 +79,7 @@ module Backup
 
         def initialize
           @enabled = false
-          @ident = 'backup'
+          @ident = "backup"
           @options = ::Syslog::LOG_PID
           @facility = ::Syslog::LOG_LOCAL0
           @info = ::Syslog::LOG_INFO
@@ -108,7 +106,7 @@ module Backup
       def log(message)
         level = @options.send(message.level)
         ::Syslog.open(@options.ident, @options.options, @options.facility) do |s|
-          message.lines.each {|line| s.log(level, '%s', line) }
+          message.lines.each { |line| s.log(level, "%s", line) }
         end
       end
     end

data/lib/backup/model.rb

@@ -1,10 +1,20 @@
-# encoding: utf-8
-
 module Backup
   class Model
     class Error < Backup::Error; end
     class FatalError < Backup::FatalError; end
 
+    DEPRECATED_MODULES = %w[
+      Campfire
+      CloudFiles
+      FTP
+      Nagios
+      OpenLDAP
+      Prowl
+      Riak
+      Twitter
+      Zabbix
+    ].freeze
+
     class << self
       ##
       # The Backup::Model.all class method keeps track of all the models
@@ -18,11 +28,11 @@ module Backup
       # Return an Array of Models matching the given +trigger+.
       def find_by_trigger(trigger)
         trigger = trigger.to_s
-        if trigger.include?('*')
+        if trigger.include?("*")
           regex = /^#{ trigger.gsub('*', '(.*)') }$/
-          all.select {|model| regex =~ model.trigger }
+          all.select { |model| regex =~ model.trigger }
         else
-          all.select {|model| trigger == model.trigger }
+          all.select { |model| trigger == model.trigger }
         end
       end
 
@@ -128,7 +138,7 @@ module Backup
 
       # trigger all defined databases to generate their #dump_filename
       # so warnings may be logged if `backup perform --check` is used
-      databases.each {|db| db.send(:dump_filename) }
+      databases.each { |db| db.send(:dump_filename) }
 
       Model.all << self
     end
@@ -142,26 +152,48 @@ module Backup
     ##
     # Adds an Database. Multiple Databases may be added to the model.
     def database(name, database_id = nil, &block)
-      @databases << get_class_from_scope(Database, name).
-          new(self, database_id, &block)
+      dsl_name = dsl_const_name(name)
+      if deprecated_module? dsl_name
+        Logger.warn "The Backup database \"#{dsl_name}\" is " \
+          "scheduled to be deprecated. If you're using this feature, " \
+          "please see: https://github.com/backup/backup/issues/851"
+      end
+      @databases << get_class_from_scope(Database, name)
+        .new(self, database_id, &block)
     end
 
     ##
     # Adds an Storage. Multiple Storages may be added to the model.
     def store_with(name, storage_id = nil, &block)
-      @storages << get_class_from_scope(Storage, name).
-          new(self, storage_id, &block)
+      dsl_name = dsl_const_name(name)
+      if deprecated_module? dsl_name
+        Logger.warn "The Backup storage \"#{dsl_name}\" is " \
+          "scheduled to be deprecated. If you're using this feature, " \
+          "please see: https://github.com/backup/backup/issues/851"
+      end
+      @storages << get_class_from_scope(Storage, name)
+        .new(self, storage_id, &block)
     end
 
     ##
     # Adds an Syncer. Multiple Syncers may be added to the model.
     def sync_with(name, syncer_id = nil, &block)
+      dsl_name = dsl_const_name(name)
+      Logger.warn "The Backup syncer \"#{dsl_name}\" is " \
+        "scheduled to be deprecated. If you're using this feature, " \
+        "please see: https://github.com/backup/backup/issues/851"
       @syncers << get_class_from_scope(Syncer, name).new(syncer_id, &block)
     end
 
     ##
     # Adds an Notifier. Multiple Notifiers may be added to the model.
     def notify_by(name, &block)
+      dsl_name = dsl_const_name(name)
+      if deprecated_module? dsl_name
+        Logger.warn "The Backup notifier \"#{dsl_name}\" is " \
+          "scheduled to be deprecated. If you're using this feature, " \
+          "please see: https://github.com/backup/backup/issues/851"
+      end
       @notifiers << get_class_from_scope(Notifier, name).new(self, &block)
     end
 
@@ -270,14 +302,11 @@ module Backup
       end
 
       syncers.each(&:perform!)
-
     rescue Interrupt
       @interrupted = true
       raise
-
     rescue Exception => err
       @exception = err
-
     ensure
       unless @interrupted
         set_exit_status
@@ -296,14 +325,22 @@ module Backup
 
     private
 
+    def dsl_const_name(name)
+      name.to_s.sub "Backup::Config::DSL::", ""
+    end
+
+    def deprecated_module?(name)
+      DEPRECATED_MODULES.include? name
+    end
+
     ##
     # Returns an array of procedures that will be performed if any
     # Archives or Databases are configured for the model.
     def procedures
       return [] unless databases.any? || archives.any?
 
-      [lambda { prepare! }, databases, archives,
-       lambda { package! }, lambda { store! }, lambda { clean! }]
+      [-> { prepare! }, databases, archives,
+       -> { package! }, -> { store! }, -> { clean! }]
     end
 
     ##
@@ -341,8 +378,8 @@ module Backup
 
       if first_exception
         other_exceptions.each do |exception|
-         Logger.error exception.to_s
-         Logger.error exception.backtrace.join('\n')
+          Logger.error exception.to_s
+          Logger.error exception.backtrace.join('\n')
         end
         raise first_exception
       else
@@ -375,8 +412,8 @@ module Backup
     #
     def get_class_from_scope(scope, name)
       klass = scope
-      name = name.to_s.sub(/^Backup::Config::DSL::/, '')
-      name.split('::').each do |chunk|
+      name = name.to_s.sub(/^Backup::Config::DSL::/, "")
+      name.split("::").each do |chunk|
         klass = klass.const_get(chunk)
       end
       klass
@@ -385,11 +422,12 @@ module Backup
     ##
     # Sets or updates the model's #exit_status.
     def set_exit_status
-      @exit_status = if exception
-        exception.is_a?(StandardError) ? 2 : 3
-      else
-        Logger.has_warnings? ? 1 : 0
-      end
+      @exit_status =
+        if exception
+          exception.is_a?(StandardError) ? 2 : 3
+        else
+          Logger.has_warnings? ? 1 : 0
+        end
     end
 
     ##
@@ -401,14 +439,13 @@ module Backup
     def before_hook
       return unless before
 
-      Logger.info 'Before Hook Starting...'
+      Logger.info "Before Hook Starting..."
       before.call
-      Logger.info 'Before Hook Finished.'
-
+      Logger.info "Before Hook Finished."
     rescue Exception => err
       @before_hook_failed = true
       ex = err.is_a?(StandardError) ? Error : FatalError
-      raise ex.wrap(err, 'Before Hook Failed!')
+      raise ex.wrap(err, "Before Hook Failed!")
     end
 
     ##
@@ -418,16 +455,15 @@ module Backup
     def after_hook
       return unless after && !@before_hook_failed
 
-      Logger.info 'After Hook Starting...'
+      Logger.info "After Hook Starting..."
       after.call(exit_status)
-      Logger.info 'After Hook Finished.'
+      Logger.info "After Hook Finished."
 
       set_exit_status # in case hook logged warnings
-
     rescue Exception => err
       fatal = !err.is_a?(StandardError)
       ex = fatal ? FatalError : Error
-      Logger.error ex.wrap(err, 'After Hook Failed!')
+      Logger.error ex.wrap(err, "After Hook Failed!")
       # upgrade exit_status if needed
       (@exit_status = fatal ? 3 : 2) unless exit_status == 3
     end
@@ -440,24 +476,24 @@ module Backup
     def log!(action)
       case action
       when :started
-        Logger.info "Performing Backup for '#{ label } (#{ trigger })'!\n" +
-            "[ backup #{ VERSION } : #{ RUBY_DESCRIPTION } ]"
+        Logger.info "Performing Backup for '#{label} (#{trigger})'!\n" \
+            "[ backup #{VERSION} : #{RUBY_DESCRIPTION} ]"
 
       when :finished
         if exit_status > 1
           ex = exit_status == 2 ? Error : FatalError
-          err = ex.wrap(exception, "Backup for #{ label } (#{ trigger }) Failed!")
+          err = ex.wrap(exception, "Backup for #{label} (#{trigger}) Failed!")
           Logger.error err
           Logger.error "\nBacktrace:\n\s\s" + err.backtrace.join("\n\s\s") + "\n\n"
 
           Cleaner.warnings(self)
         else
-          msg = "Backup for '#{ label } (#{ trigger })' "
+          msg = "Backup for '#{label} (#{trigger})' "
           if exit_status == 1
-            msg << "Completed Successfully (with Warnings) in #{ duration }"
+            msg << "Completed Successfully (with Warnings) in #{duration}"
             Logger.warn msg
           else
-            msg << "Completed Successfully in #{ duration }"
+            msg << "Completed Successfully in #{duration}"
             Logger.info msg
           end
         end
@@ -472,8 +508,7 @@ module Backup
       remainder = duration - (hours * 3600)
       minutes   = remainder / 60
       seconds   = remainder - (minutes * 60)
-      '%02d:%02d:%02d' % [hours, minutes, seconds]
+      sprintf "%02d:%02d:%02d", hours, minutes, seconds
     end
-
   end
 end