backup 3.0.23 → 3.0.24

data/lib/backup/cli/utility.rb

@@ -187,9 +187,10 @@ module Backup
       ##
       # [Dependencies]
       # Returns a list of Backup's dependencies
-      desc 'dependencies', 'Display the list of dependencies for Backup, or install them through Backup.'
+      desc 'dependencies', 'Display the list of dependencies for Backup, check the installation status, or install them through Backup.'
       method_option :install, :type => :string
       method_option :list,    :type => :boolean
+      method_option :installed, :type => :string
       def dependencies
         unless options.any?
           puts
@@ -198,6 +199,9 @@ module Backup
           puts
           puts "To install one of these dependencies (with the correct version), run:\n\n"
           puts "  backup dependencies --install <name>"
+          puts
+          puts "To check if a dependency is already installed, run:\n\n"
+          puts "  backup dependencies --installed <name>"
           exit
         end
 
@@ -220,6 +224,10 @@ module Backup
           puts "Please wait..\n\n"
           puts %x[gem install #{options[:install]} -v '#{Backup::Dependency.all[options[:install]][:version]}']
         end
+        
+        if options[:installed]
+          puts %x[gem list -i -v '#{Backup::Dependency.all[options[:installed]][:version]}' #{options[:installed]}]
+        end
       end
 
       ##

data/lib/backup/compressor/base.rb

@@ -6,14 +6,17 @@ module Backup
       include Backup::CLI::Helpers
       include Backup::Configuration::Helpers
 
-      def initialize
-        load_defaults!
+      ##
+      # Yields to the block the compressor command and filename extension.
+      def compress_with
+        log!
+        yield @cmd, @ext
       end
 
       private
 
       ##
-      # Return the encryptor name, with Backup namespace removed
+      # Return the compressor name, with Backup namespace removed
       def compressor_name
         self.class.to_s.sub('Backup::', '')
       end
@@ -22,8 +25,11 @@ module Backup
       # Logs a message to the console and log file to inform
       # the client that Backup is using the compressor
       def log!
-        Logger.message "Using #{ compressor_name } for compression."
+        Logger.message "Using #{ compressor_name } for compression.\n" +
+          "  Command: '#{ @cmd }'\n" +
+          "  Ext: '#{ @ext }'"
       end
+
     end
   end
 end

data/lib/backup/compressor/bzip2.rb

@@ -5,44 +5,40 @@ module Backup
     class Bzip2 < Base
 
       ##
-      # Tells Backup::Compressor::Bzip2 to compress
-      # better (-9) rather than faster when set to true
-      attr_accessor :best
+      # Specify the level of compression to use.
+      #
+      # Values should be a single digit from 1 to 9.
+      # Note that setting the level to either extreme may or may not
+      # give the desired result. Be sure to check the documentation
+      # for the compressor being used.
+      #
+      # The default `level` is 9.
+      attr_accessor :level
+
+      attr_deprecate :fast, :version => '3.0.24',
+                     :replacement => :level,
+                     :value => lambda {|val| val ? 1 : nil }
+      attr_deprecate :best, :version => '3.0.24',
+                     :replacement => :level,
+                     :value => lambda {|val| val ? 9 : nil }
 
       ##
-      # Tells Backup::Compressor::Bzip2 to compress
-      # faster (-1) rather than better when set to true
-      attr_accessor :fast
-
-      ##
-      # Creates a new instance of Backup::Compressor::Bzip2 and
-      # configures it to either compress faster or better
-      # bzip2 compresses by default with -9 (best compression)
-      # and lower block sizes don't make things significantly faster
-      # (according to official bzip2 docs)
+      # Creates a new instance of Backup::Compressor::Bzip2
       def initialize(&block)
-        super
+        load_defaults!
 
-        @best ||= false
-        @fast ||= false
+        @level ||= false
 
         instance_eval(&block) if block_given?
-      end
 
-      ##
-      # Yields to the block the compressor command with options
-      # and it's filename extension.
-      def compress_with
-        log!
-        yield "#{ utility(:bzip2) }#{ options }", '.bz2'
+        @cmd = "#{ utility(:bzip2) }#{ options }"
+        @ext = '.bz2'
       end
 
       private
 
-      ##
-      # Returns the option syntax for compressing
       def options
-        " #{ '--best ' if @best }#{ '--fast' if @fast }".rstrip
+        " -#{ @level }" if @level
       end
 
     end

data/lib/backup/compressor/custom.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+module Backup
+  module Compressor
+    class Custom < Base
+
+      ##
+      # Specify the system command to invoke a compressor,
+      # including any command-line arguments.
+      # e.g. @compressor.command = 'pbzip2 -p2 -4'
+      #
+      # The data to be compressed will be piped to the command's STDIN,
+      # and it should write the compressed data to STDOUT.
+      # i.e. `cat file.tar | %command% > file.tar.%extension%`
+      attr_accessor :command
+
+      ##
+      # File extension to append to the compressed file's filename.
+      # e.g. @compressor.extension = '.bz2'
+      attr_accessor :extension
+
+      ##
+      # Initializes a new custom compressor.
+      def initialize(&block)
+        load_defaults!
+
+        instance_eval(&block) if block_given?
+
+        @cmd = set_cmd
+        @ext = set_ext
+      end
+
+      private
+
+      ##
+      # Return the command line using the full path.
+      # Ensures the command exists and is executable.
+      def set_cmd
+        parts = @command.to_s.split(' ')
+        parts[0] = utility(parts[0])
+        parts.join(' ')
+      end
+
+      ##
+      # Return the extension given without whitespace.
+      # If extension was not set, return an empty string
+      def set_ext
+        @extension.to_s.strip
+      end
+
+    end
+  end
+end

data/lib/backup/compressor/gzip.rb

@@ -5,41 +5,40 @@ module Backup
     class Gzip < Base
 
       ##
-      # Tells Backup::Compressor::Gzip to compress
-      # better rather than faster when set to true
-      attr_accessor :best
+      # Specify the level of compression to use.
+      #
+      # Values should be a single digit from 1 to 9.
+      # Note that setting the level to either extreme may or may not
+      # give the desired result. Be sure to check the documentation
+      # for the compressor being used.
+      #
+      # The default `level` is 6.
+      attr_accessor :level
+
+      attr_deprecate :fast, :version => '3.0.24',
+                     :replacement => :level,
+                     :value => lambda {|val| val ? 1 : nil }
+      attr_deprecate :best, :version => '3.0.24',
+                     :replacement => :level,
+                     :value => lambda {|val| val ? 9 : nil }
 
       ##
-      # Tells Backup::Compressor::Gzip to compress
-      # faster rather than better when set to true
-      attr_accessor :fast
-
-      ##
-      # Creates a new instance of Backup::Compressor::Gzip and
-      # configures it to either compress faster or better
+      # Creates a new instance of Backup::Compressor::Gzip
       def initialize(&block)
-        super
+        load_defaults!
 
-        @best ||= false
-        @fast ||= false
+        @level ||= false
 
         instance_eval(&block) if block_given?
-      end
 
-      ##
-      # Yields to the block the compressor command with options
-      # and it's filename extension.
-      def compress_with
-        log!
-        yield "#{ utility(:gzip) }#{ options }", '.gz'
+        @cmd = "#{ utility(:gzip) }#{ options }"
+        @ext = '.gz'
       end
 
       private
 
-      ##
-      # Returns the gzip option syntax for compressing
       def options
-        " #{ '--best ' if @best }#{ '--fast' if @fast }".rstrip
+        " -#{ @level }" if @level
       end
 
     end

data/lib/backup/compressor/lzma.rb

@@ -15,34 +15,36 @@ module Backup
       attr_accessor :fast
 
       ##
-      # Creates a new instance of Backup::Compressor::Lzma and
-      # configures it to either compress faster or better
-      # Lzma compresses by default with -9 (best compression)
-      # and lower block sizes don't make things significantly faster
-      # (according to official bzip2 docs)
+      # Creates a new instance of Backup::Compressor::Lzma
       def initialize(&block)
-        super
+        load_defaults!
 
         @best ||= false
         @fast ||= false
 
         instance_eval(&block) if block_given?
+
+        @cmd = "#{ utility(:lzma) }#{ options }"
+        @ext = '.lzma'
       end
 
+
       ##
-      # Yields to the block the compressor command with options
-      # and it's filename extension.
+      # Yields to the block the compressor command and filename extension.
       def compress_with
-        log!
-        yield "#{ utility(:lzma) }#{ options }", '.lzma'
+        Backup::Logger.warn(
+          "[DEPRECATION WARNING]\n" +
+          "  Compressor::Lzma is being deprecated as of backup v.3.0.24\n" +
+          "  and will soon be removed. Please see the Compressors wiki page at\n" +
+          "  https://github.com/meskyanichi/backup/wiki/Compressors"
+        )
+        super
       end
 
       private
 
-      ##
-      # Returns the option syntax for compressing
       def options
-        " #{ '--best ' if @best }#{ '--fast' if @fast }".rstrip
+        (' --best' if @best) || (' --fast' if @fast)
       end
 
     end

data/lib/backup/compressor/pbzip2.rb

@@ -5,50 +5,53 @@ module Backup
     class Pbzip2 < Base
 
       ##
-      # Tells Backup::Compressor::Pbzip2 to compress
+      # Tells Backup::Compressor::Lzma to compress
       # better (-9) rather than faster when set to true
       attr_accessor :best
 
       ##
-      # Tells Backup::Compressor::Pbzip2 to compress
+      # Tells Backup::Compressor::Lzma to compress
       # faster (-1) rather than better when set to true
       attr_accessor :fast
 
       ##
-      # Tells Backup::Compressor::Pbzip2 how many processors
-      # use, by default autodetect is used
+      # Tells Backup::Compressor::Pbzip2 how many processors to use.
+      # Autodetects the number of active CPUs by default.
       attr_accessor :processors
 
       ##
-      # Creates a new instance of Backup::Compressor::Pbzip2 and
-      # configures it to either compress faster or better
-      # bzip2 compresses by default with -9 (best compression)
-      # and lower block sizes don't make things significantly faster
-      # (according to official bzip2 docs)
+      # Creates a new instance of Backup::Compressor::Pbzip2
       def initialize(&block)
-        super
+        load_defaults!
 
         @best       ||= false
         @fast       ||= false
         @processors ||= false
 
         instance_eval(&block) if block_given?
+
+        @cmd = "#{ utility(:pbzip2) }#{ options }"
+        @ext = '.bz2'
       end
 
       ##
-      # Yields to the block the compressor command with options
-      # and it's filename extension.
+      # Yields to the block the compressor command and filename extension.
       def compress_with
-        log!
-        yield "#{ utility(:pbzip2) }#{ options }", '.bz2'
+        Backup::Logger.warn(
+          "[DEPRECATION WARNING]\n" +
+          "  Compressor::Pbzip2 is being deprecated as of backup v.3.0.24\n" +
+          "  and will soon be removed. Please see the Compressors wiki page at\n" +
+          "  https://github.com/meskyanichi/backup/wiki/Compressors"
+        )
+        super
       end
 
       private
 
-      ##
-      # Returns the gzip option syntax for compressing
       def options
-        " #{ '--best ' if @best }#{ '--fast ' if @fast }#{ "-p#{@processors}" if @processors }".rstrip
+        level = (' --best' if @best) || (' --fast' if @fast)
+        cpus  = " -p#{ @processors }" if @processors
+        "#{ level }#{ cpus }"
       end
 
     end

data/lib/backup/config.rb

@@ -107,13 +107,16 @@ module Backup
             ['S3', 'CloudFiles', 'Ninefold', 'Dropbox', 'FTP',
             'SFTP', 'SCP', 'RSync', 'Local'],
             # Compressors
-            ['Gzip', 'Bzip2', 'Pbzip2', 'Lzma'],
+            ['Gzip', 'Bzip2', 'Custom', 'Pbzip2', 'Lzma'],
             # Encryptors
             ['OpenSSL', 'GPG'],
             # Syncers
-            ['Rackspace', 'S3', { 'RSync' => ['Push', 'Pull', 'Local'] }],
+            [
+              { 'Cloud' => ['CloudFiles', 'S3'] },
+              { 'RSync' => ['Push', 'Pull', 'Local'] }
+            ],
             # Notifiers
-            ['Mail', 'Twitter', 'Campfire', 'Presently', 'Prowl', 'Hipchat']
+            ['Mail', 'Twitter', 'Campfire', 'Prowl', 'Hipchat']
           ]
         )
       end

data/lib/backup/configuration.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+%w[helpers store].each do |file|
+  require File.expand_path("../configuration/#{file}", __FILE__)
+end
+
+# Temporary measure for deprecating the use of Configuration
+# namespaced classes for setting pre-configured defaults.
+module Backup
+  module Configuration
+    extend self
+
+    ##
+    # Pass calls on to the proper class and log a warning
+    def defaults(&block)
+      klass = eval(self.to_s.sub('Configuration::', ''))
+      Logger.warn Errors::ConfigurationError.new <<-EOS
+        [DEPRECATION WARNING]
+        #{ self }.defaults is being deprecated.
+        To set pre-configured defaults for #{ klass }, use:
+        #{ klass }.defaults
+      EOS
+      klass.defaults(&block)
+    end
+
+    private
+
+    def const_missing(const)
+      const_set(const, Module.new { extend Configuration })
+    end
+
+  end
+end

data/lib/backup/configuration/helpers.rb

@@ -4,47 +4,133 @@ module Backup
   module Configuration
     module Helpers
 
-      ##
-      # Finds all the object's getter methods and checks the global
-      # configuration for these methods, if they respond then they will
-      # assign the object's attribute(s) to that particular global configuration's attribute
-      def load_defaults!
-        module_names  = self.class.name.split('::')[1..-1]
-        configuration = Backup::Configuration
-        module_names.each do |module_name|
-          configuration = configuration.const_get(module_name)
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+
+        ##
+        # Returns or yields the Configuration::Store
+        # for storing pre-configured defaults for the class.
+        def defaults
+          @configuration ||= Configuration::Store.new
+
+          if block_given?
+            yield @configuration
+          else
+            @configuration
+          end
+        end
+
+        ##
+        # Used only within the specs
+        def clear_defaults!
+          defaults.reset!
         end
 
-        getter_methods.each do |attribute|
-          if configuration.respond_to?(attribute)
-            self.send("#{attribute}=", configuration.send(attribute))
+        def deprecations
+          @deprecations ||= {}
+        end
+
+        def log_deprecation_warning(name, deprecation)
+          msg = "#{ self }.#{ name } has been deprecated as of " +
+              "backup v.#{ deprecation[:version] }"
+          if replacement = deprecation[:replacement]
+            msg << "\nThis setting has been replaced with:\n" +
+                "#{ self }.#{ replacement }"
           end
+          Logger.warn Backup::Errors::ConfigurationError.new <<-EOS
+            [DEPRECATION WARNING]
+            #{ msg }
+          EOS
         end
-      end
 
-      ##
-      # Clears all the defaults that may have been set by the user
-      def clear_defaults!
-        setter_methods.each do |method|
-          self.send(method, nil)
+        protected
+
+        ##
+        # Method to deprecate an attribute.
+        #
+        # :version should be set to the backup version which will first
+        #   introduce the deprecation.
+        # :replacement may be set to another attr_accessor name to set
+        #   the value for instead of the deprecated accessor
+        # :value may be used to specify the value set on :replacement.
+        #   If :value is nil, the value set on the deprecated accessor
+        #   will be used to set the value for the :replacement.
+        #   If :value is a lambda, it will be passed the value the user
+        #   set on the deprecated accessor, and should return the value
+        #   to be set on the :replacement.
+        #   Therefore, to cause the replacement accessor not to be set,
+        #   use the lambda form to return nil. This is only way to specify
+        #   a :replacement without transferring a value.
+        #   e.g. :replacement => :new_attr, :value => Proc.new {}
+        def attr_deprecate(name, args = {})
+          deprecations[name] = {
+            :version => nil,
+            :replacement => nil,
+            :value => nil
+          }.merge(args)
         end
-      end
+
+      end # ClassMethods
 
       private
 
       ##
-      # Returns an Array of the setter methods (as String)
-      def setter_methods
-        methods.map do |method|
-          method = method.to_s
-          method if method =~ /^\w(\w|\d|\_)+\=$/ and method != 'taguri='
-        end.compact
+      # Sets any pre-configured default values.
+      # If a default value was set for an invalid accessor,
+      # this will raise a NameError.
+      def load_defaults!
+        configuration = self.class.defaults
+        configuration._attributes.each do |name|
+          send(:"#{ name }=", configuration.send(name))
+        end
       end
 
       ##
-      # Returns an Array of getter methods (as String)
-      def getter_methods
-        setter_methods.map {|method| method.sub('=','') }
+      # Check missing methods for deprecations
+      #
+      # Note that OpenStruct (used for setting defaults) does not allow
+      # multiple arguments when assigning values for members.
+      # So, we won't allow it here either, even though an attr_accessor
+      # will accept and convert them into an Array. Therefore, setting
+      # an option value using multiple values, whether as a default or
+      # directly on the class' accessor, should not be supported.
+      # i.e. if an option will accept being set as an Array, then it
+      # should be explicitly set as such. e.g. option = [val1, val2]
+      def method_missing(name, *args)
+        deprecation = nil
+        if method = name.to_s.chomp!('=')
+          if (len = args.count) != 1
+            raise ArgumentError,
+              "wrong number of arguments (#{ len } for 1)", caller(1)
+          end
+          deprecation = self.class.deprecations[method.to_sym]
+        end
+
+        if deprecation
+          self.class.log_deprecation_warning(method, deprecation)
+          if replacement = deprecation[:replacement]
+            value =
+              case deprecation[:value]
+              when nil
+                args[0]
+              when Proc
+                deprecation[:value].call(args[0])
+              else
+                deprecation[:value]
+              end
+            unless value.nil?
+              Logger.warn(
+                "#{ self.class }.#{ replacement } is being set to '#{ value }'"
+              )
+              send(:"#{ replacement }=", value)
+            end
+          end
+        else
+          super
+        end
       end
 
     end