backup-agoddard 3.0.27

data/lib/backup/compressor/lzma.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+module Backup
+  module Compressor
+    class Lzma < Base
+
+      ##
+      # Tells Backup::Compressor::Lzma to compress
+      # better (-9) rather than faster when set to true
+      attr_accessor :best
+
+      ##
+      # Tells Backup::Compressor::Lzma to compress
+      # faster (-1) rather than better when set to true
+      attr_accessor :fast
+
+      ##
+      # Creates a new instance of Backup::Compressor::Lzma
+      def initialize(&block)
+        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 and filename extension.
+      def compress_with
+        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
+
+      def options
+        (' --best' if @best) || (' --fast' if @fast)
+      end
+
+    end
+  end
+end

data/lib/backup/compressor/pbzip2.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+module Backup
+  module Compressor
+    class Pbzip2 < Base
+
+      ##
+      # Tells Backup::Compressor::Lzma to compress
+      # better (-9) rather than faster when set to true
+      attr_accessor :best
+
+      ##
+      # 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 to use.
+      # Autodetects the number of active CPUs by default.
+      attr_accessor :processors
+
+      ##
+      # Creates a new instance of Backup::Compressor::Pbzip2
+      def initialize(&block)
+        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 and filename extension.
+      def compress_with
+        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
+
+      def options
+        level = (' --best' if @best) || (' --fast' if @fast)
+        cpus  = " -p#{ @processors }" if @processors
+        "#{ level }#{ cpus }"
+      end
+
+    end
+  end
+end

data/lib/backup/config.rb

@@ -0,0 +1,174 @@
+# encoding: utf-8
+
+module Backup
+  module Config
+    DEFAULTS = {
+      :config_file  => 'config.rb',
+      :data_path    => 'data',
+      :log_path     => 'log',
+      :cache_path   => '.cache',
+      :tmp_path     => '.tmp'
+    }
+
+    class << self
+      attr_reader :user, :root_path, :config_file,
+                  :data_path, :log_path, :cache_path, :tmp_path
+
+      ##
+      # Setup required paths based on the given options
+      def update(options = {})
+        root_path = options[:root_path].to_s.strip
+        new_root = root_path.empty? ? false : set_root_path(root_path)
+
+        DEFAULTS.each do |name, ending|
+          set_path_variable(name, options[name], ending, new_root)
+        end
+      end
+
+      ##
+      # Tries to find and load the configuration file
+      def load_config!
+        unless File.exist?(@config_file)
+          raise Errors::Config::NotFoundError,
+              "Could not find configuration file: '#{@config_file}'."
+        end
+
+        module_eval(File.read(@config_file), @config_file)
+      end
+
+      private
+
+      ##
+      # Sets the @root_path to the given +path+ and returns it.
+      # Raises an error if the given +path+ does not exist.
+      def set_root_path(path)
+        # allows #reset! to set the default @root_path,
+        # then use #update to set all other paths,
+        # without requiring that @root_path exist.
+        return @root_path if path == @root_path
+
+        path = File.expand_path(path)
+        unless File.directory?(path)
+          raise Errors::Config::NotFoundError, <<-EOS
+            Root Path Not Found
+            When specifying a --root-path, the path must exist.
+            Path was: #{ path }
+          EOS
+        end
+        @root_path = path
+      end
+
+      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
+        new_path = false
+        if path.empty?
+          new_path = File.join(root_path, ending) if root_path
+        else
+          new_path = File.expand_path(path)
+          unless path == new_path
+            new_path = File.join(root_path, path) if root_path
+          end
+        end
+        instance_variable_set(:"@#{name}", new_path) if new_path
+      end
+
+      ##
+      # Set default values for accessors
+      def reset!
+        @user      = ENV['USER'] || Etc.getpwuid.name
+        @root_path = File.join(File.expand_path(ENV['HOME'] || ''), 'Backup')
+        update(:root_path => @root_path)
+      end
+
+      ##
+      # List the available database, storage, syncer, compressor, encryptor
+      # and notifier constants. These are used to dynamically define these
+      # constant names inside Backup::Config to provide a nicer configuration
+      # file DSL syntax to the users. Adding existing constants to the arrays
+      # below will enable the user to use a constant instead of a string.
+      # Nested namespaces are represented using Hashs. Deep nesting supported.
+      #
+      # Example, instead of:
+      #  database "MySQL" do |mysql|
+      #  sync_with "RSync::Local" do |rsync|
+      #
+      # You can do:
+      #  database MySQL do |mysql|
+      #  sync_with RSync::Local do |rsync|
+      #
+      def add_dsl_constants!
+        create_modules(
+          self,
+          [ # Databases
+            ['MySQL', 'PostgreSQL', 'MongoDB', 'Redis', 'Riak'],
+            # Storages
+            ['S3', 'CloudFiles', 'Ninefold', 'Dropbox', 'FTP',
+            'SFTP', 'SCP', 'RSync', 'Local'],
+            # Compressors
+            ['Gzip', 'Bzip2', 'Custom', 'Pbzip2', 'Lzma'],
+            # Encryptors
+            ['OpenSSL', 'GPG'],
+            # Syncers
+            [
+              { 'Cloud' => ['CloudFiles', 'S3'] },
+              { 'RSync' => ['Push', 'Pull', 'Local'] }
+            ],
+            # Notifiers
+            ['Mail', 'Twitter', 'Campfire', 'Prowl', 'Hipchat', 'Pushover']
+          ]
+        )
+      end
+
+      def create_modules(scope, names)
+        names.flatten.each do |name|
+          if name.is_a?(Hash)
+            name.each do |key, val|
+              create_modules(get_or_create_empty_module(scope, key), [val])
+            end
+          else
+            get_or_create_empty_module(scope, name)
+          end
+        end
+      end
+
+      def get_or_create_empty_module(scope, const)
+        if scope.const_defined?(const)
+          scope.const_get(const)
+        else
+          scope.const_set(const, Module.new)
+        end
+      end
+    end
+
+    ##
+    # Add the DSL constants and set default values for accessors when loaded.
+    add_dsl_constants!
+    reset!
+  end
+
+  ##
+  # Warn user of deprecated Backup::CONFIG_FILE constant reference
+  # in older config.rb files and return the proper Config.config_file value.
+  class << self
+    def const_missing(const)
+      if const.to_s == 'CONFIG_FILE'
+        Logger.warn Errors::ConfigError.new(<<-EOS)
+          Configuration File Upgrade Needed
+          Your configuration file, located at #{ Config.config_file }
+          needs to be upgraded for this version of Backup.
+          The reference to 'Backup::CONFIG_FILE' in your current config.rb file
+          has been deprecated and needs to be replaced with 'Config.config_file'.
+          You may update this reference in your config.rb manually,
+          or generate a new config.rb using 'backup generate:config'.
+          * Note: if you have global configuration defaults set in config.rb,
+          be sure to transfer them to your new config.rb, should you choose
+          to generate a new config.rb file.
+        EOS
+        return Config.config_file
+      end
+      super
+    end
+  end
+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

@@ -0,0 +1,130 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Helpers
+
+      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
+
+        def deprecations
+          @deprecations ||= {}
+        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]
+          Logger.warn Backup::Errors::ConfigurationError.new <<-EOS
+            [DEPRECATION WARNING]
+            #{ msg }
+          EOS
+        end
+
+        protected
+
+        ##
+        # Method to deprecate an attribute.
+        #
+        # :version
+        #   Must be set to the backup version which will first
+        #   introduce the deprecation.
+        #
+        # :action
+        #   If set, this Proc will be called with a reference to the
+        #   class instance and the value set on the deprecated accessor.
+        #   e.g. deprecation[:action].call(klass, value)
+        #   This should perform whatever action is neccessary, such as
+        #   transferring the value to a new accessor.
+        #
+        # :message
+        #   If set, this will be appended to #log_deprecation_warning
+        #
+        # Note that this replaces the `attr_accessor` method, or other
+        # method previously used to set the accessor being deprecated.
+        # #method_missing will handle any calls to `name=`.
+        #
+        def attr_deprecate(name, args = {})
+          deprecations[name] = {
+            :version => nil,
+            :message => nil,
+            :action => nil
+          }.merge(args)
+        end
+
+      end # ClassMethods
+
+      private
+
+      ##
+      # 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
+
+      ##
+      # Check missing methods for deprecated attribute accessors.
+      #
+      # If a value is set on an accessor that has been deprecated
+      # using #attr_deprecate, a warning will be issued and any
+      # :action (Proc) specified will be called with a reference to
+      # the class instance and the value set on the deprecated accessor.
+      # See #attr_deprecate and #log_deprecation_warning
+      #
+      # 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)
+          deprecation[:action].call(self, args[0]) if deprecation[:action]
+        else
+          super
+        end
+      end
+
+    end
+  end
+end