backup 3.0.20 → 3.0.21

data/lib/backup/compressor/base.rb

@@ -6,11 +6,23 @@ module Backup
       include Backup::CLI::Helpers
       include Backup::Configuration::Helpers
 
+      def initialize
+        load_defaults!
+      end
+
+      private
+
+      ##
+      # Return the encryptor name, with Backup namespace removed
+      def compressor_name
+        self.class.to_s.sub('Backup::', '')
+      end
+
       ##
       # Logs a message to the console and log file to inform
-      # the client that Backup is compressing the archive
+      # the client that Backup is using the compressor
       def log!
-        Logger.message "#{ self.class } started compressing the archive."
+        Logger.message "Using #{ compressor_name } for compression."
       end
     end
   end

data/lib/backup/compressor/bzip2.rb

@@ -7,12 +7,12 @@ module Backup
       ##
       # Tells Backup::Compressor::Bzip2 to compress
       # better (-9) rather than faster when set to true
-      attr_writer :best
+      attr_accessor :best
 
       ##
       # Tells Backup::Compressor::Bzip2 to compress
       # faster (-1) rather than better when set to true
-      attr_writer :fast
+      attr_accessor :fast
 
       ##
       # Creates a new instance of Backup::Compressor::Bzip2 and
@@ -21,7 +21,7 @@ module Backup
       # and lower block sizes don't make things significantly faster
       # (according to official bzip2 docs)
       def initialize(&block)
-        load_defaults!
+        super
 
         @best ||= false
         @fast ||= false
@@ -30,33 +30,19 @@ module Backup
       end
 
       ##
-      # Performs the compression of the packages backup file
-      def perform!
+      # Yields to the block the compressor command with options
+      # and it's filename extension.
+      def compress_with
         log!
-        run("#{ utility(:bzip2) } #{ options } '#{ Backup::Model.file }'")
-        Backup::Model.extension += '.bz2'
+        yield "#{ utility(:bzip2) }#{ options }", '.bz2'
       end
 
-    private
+      private
 
       ##
-      # Combines the provided options and returns a bzip2 options string
+      # Returns the option syntax for compressing
       def options
-        (best + fast).join("\s")
-      end
-
-      ##
-      # Returns the bzip2 option syntax for compressing
-      # setting @best to true is redundant, as bzip2 compresses best by default
-      def best
-        return ['--best'] if @best; []
-      end
-
-      ##
-      # Returns the bzip2 option syntax for compressing
-      # (not significantly) faster when @fast is set to true
-      def fast
-        return ['--fast'] if @fast; []
+        " #{ '--best ' if @best }#{ '--fast' if @fast }".rstrip
       end
 
     end

data/lib/backup/compressor/gzip.rb

@@ -7,18 +7,18 @@ module Backup
       ##
       # Tells Backup::Compressor::Gzip to compress
       # better rather than faster when set to true
-      attr_writer :best
+      attr_accessor :best
 
       ##
       # Tells Backup::Compressor::Gzip to compress
       # faster rather than better when set to true
-      attr_writer :fast
+      attr_accessor :fast
 
       ##
       # Creates a new instance of Backup::Compressor::Gzip and
       # configures it to either compress faster or better
       def initialize(&block)
-        load_defaults!
+        super
 
         @best ||= false
         @fast ||= false
@@ -27,33 +27,19 @@ module Backup
       end
 
       ##
-      # Performs the compression of the packages backup file
-      def perform!
+      # Yields to the block the compressor command with options
+      # and it's filename extension.
+      def compress_with
         log!
-        run("#{ utility(:gzip) } #{ options } '#{ Backup::Model.file }'")
-        Backup::Model.extension += '.gz'
+        yield "#{ utility(:gzip) }#{ options }", '.gz'
       end
 
-    private
-
-      ##
-      # Combines the provided options and returns a gzip options string
-      def options
-        (best + fast).join("\s")
-      end
+      private
 
       ##
       # Returns the gzip option syntax for compressing
-      # better when @best is set to true
-      def best
-        return ['--best'] if @best; []
-      end
-
-      ##
-      # Returns the gzip option syntax for compressing
-      # faster when @fast is set to true
-      def fast
-        return ['--fast'] if @fast; []
+      def options
+        " #{ '--best ' if @best }#{ '--fast' if @fast }".rstrip
       end
 
     end

data/lib/backup/compressor/lzma.rb

@@ -7,12 +7,12 @@ module Backup
       ##
       # Tells Backup::Compressor::Lzma to compress
       # better (-9) rather than faster when set to true
-      attr_writer :best
+      attr_accessor :best
 
       ##
       # Tells Backup::Compressor::Lzma to compress
       # faster (-1) rather than better when set to true
-      attr_writer :fast
+      attr_accessor :fast
 
       ##
       # Creates a new instance of Backup::Compressor::Lzma and
@@ -21,7 +21,7 @@ module Backup
       # and lower block sizes don't make things significantly faster
       # (according to official bzip2 docs)
       def initialize(&block)
-        load_defaults!
+        super
 
         @best ||= false
         @fast ||= false
@@ -30,34 +30,21 @@ module Backup
       end
 
       ##
-      # Performs the compression of the packages backup file
-      def perform!
+      # Yields to the block the compressor command with options
+      # and it's filename extension.
+      def compress_with
         log!
-        run("#{ utility(:lzma) } #{ options } '#{ Backup::Model.file }'")
-        Backup::Model.extension += '.lzma'
+        yield "#{ utility(:lzma) }#{ options }", '.lzma'
       end
 
-    private
+      private
 
       ##
-      # Combines the provided options and returns a bzip2 options string
+      # Returns the option syntax for compressing
       def options
-        (best + fast).join("\s")
+        " #{ '--best ' if @best }#{ '--fast' if @fast }".rstrip
       end
 
-      ##
-      # Returns the lzma option syntax for compressing
-      # setting @best to true is redundant, as lzma compresses best by default
-      def best
-        return ['--best'] if @best; []
-      end
-
-      ##
-      # Returns the lzma option syntax for compressing
-      # (not significantly) faster when @fast is set to true
-      def fast
-        return ['--fast'] if @fast; []
-      end
     end
   end
 end

data/lib/backup/compressor/pbzip2.rb

@@ -7,17 +7,17 @@ module Backup
       ##
       # Tells Backup::Compressor::Pbzip2 to compress
       # better (-9) rather than faster when set to true
-      attr_writer :best
+      attr_accessor :best
 
       ##
       # Tells Backup::Compressor::Pbzip2 to compress
       # faster (-1) rather than better when set to true
-      attr_writer :fast
+      attr_accessor :fast
 
       ##
       # Tells Backup::Compressor::Pbzip2 how many processors
       # use, by default autodetect is used
-      attr_writer :processors
+      attr_accessor :processors
 
       ##
       # Creates a new instance of Backup::Compressor::Pbzip2 and
@@ -26,51 +26,31 @@ module Backup
       # and lower block sizes don't make things significantly faster
       # (according to official bzip2 docs)
       def initialize(&block)
-        load_defaults!
+        super
 
         @best       ||= false
         @fast       ||= false
-        @processors ||= nil
+        @processors ||= false
 
         instance_eval(&block) if block_given?
       end
 
       ##
-      # Performs the compression of the packages backup file
-      def perform!
+      # Yields to the block the compressor command with options
+      # and it's filename extension.
+      def compress_with
         log!
-        run("#{ utility(:pbzip2) } #{ options } '#{ Backup::Model.file }'")
-        Backup::Model.extension += '.bz2'
+        yield "#{ utility(:pbzip2) }#{ options }", '.bz2'
       end
 
-    private
+      private
 
       ##
-      # Combines the provided options and returns a pbzip2 options string
+      # Returns the gzip option syntax for compressing
       def options
-        (best + fast + processors).join("\s")
+        " #{ '--best ' if @best }#{ '--fast ' if @fast }#{ "-p#{@processors}" if @processors }".rstrip
       end
 
-      ##
-      # Returns the pbzip2 option syntax for compressing
-      # setting @best to true is redundant, as pbzip2 compresses best by default
-      def best
-        return ['--best'] if @best; []
-      end
-
-      ##
-      # Returns the pbzip2 option syntax for compressing
-      # (not significantly) faster when @fast is set to true
-      def fast
-        return ['--fast'] if @fast; []
-      end
-
-      ##
-      # Returns the pbzip2 option syntax for compressing
-      # using given count of cpus
-      def processors
-        return ['-p' + @processors.to_s] if @processors; []
-      end
     end
   end
 end

data/lib/backup/config.rb

@@ -0,0 +1,171 @@
+# 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', 'Pbzip2', 'Lzma'],
+            # Encryptors
+            ['OpenSSL', 'GPG'],
+            # Syncers
+            ['S3', { 'RSync' => ['Push', 'Pull', 'Local'] }],
+            # Notifiers
+            ['Mail', 'Twitter', 'Campfire', 'Presently', 'Prowl', 'Hipchat']
+          ]
+        )
+      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