backup 3.11.0 → 4.0.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90a0ce4d50fcbf5dbc1ff35c6ceb182757b5b1ca
-  data.tar.gz: e6cd5b21bed38cd91d97dad2489d38107e33a387
+  metadata.gz: d0de2d8ea6ab6e4fe90e28b7044b2fcf35d615ca
+  data.tar.gz: 0f484316e417073db7987f67a46b283e4cd90ab9
 SHA512:
-  metadata.gz: dfec691ea4ad54ed847451247fbc26d8f476360075becea60416249a22805740284c18c5d5e6e16333dfa344402dd607feaf0d9b147b1763ff3ad580051d165c
-  data.tar.gz: d0b6389c651ef00d14833b03830864b90e1c71cdae7dbc17bb6f308d58c4b03c68c716e32c58048a24e442a1ddfcd9087ec801a2b827a9632bdeb18af6965d75
+  metadata.gz: 76b53d8880bfdfd5d292f1ef42ee7c55abd25d548332c9b22e2006b7e1e56c1982986ad4caab35130949d67c73435351199a46c8fbfec7ffebea651df5fdfff2
+  data.tar.gz: 8ae5bc1f0bd537aad0eef034da5c0ebe65fd87a7ff8cc2e7963a07eb93c5b7715823d23d96338892ffe4895d6d2376c326487716bb96a2541da78ce59ae87603

data/README.md

@@ -1,4 +1,4 @@
-Backup v3.x
+Backup v4.x
 ===========
 
 Backup is a system utility for Linux and Mac OS X, distributed as a RubyGem, that allows you to easily perform backup
@@ -12,8 +12,8 @@ was built with modularity, extensibility and simplicity in mind.
 **Copyright (c) 2009-2014 [Michael van Rooijen][] ( [@meskyanichi][] )**  
 Released under the **MIT** [License](LICENSE.md).
 
-[Installation]:  http://meskyanichi.github.io/backup/v3/installation
-[Release Notes]: http://meskyanichi.github.io/backup/v3/release-notes
-[Documentation]: http://meskyanichi.github.io/backup/v3
+[Installation]:  http://meskyanichi.github.io/backup/v4/installation
+[Release Notes]: http://meskyanichi.github.io/backup/v4/release-notes
+[Documentation]: http://meskyanichi.github.io/backup/v4
 [Michael van Rooijen]: http://michaelvanrooijen.com
 [@meskyanichi]: http://twitter.com/#!/meskyanichi

data/lib/backup.rb

@@ -85,8 +85,6 @@ module Backup
     autoload :Gzip,   File.join(COMPRESSOR_PATH, 'gzip')
     autoload :Bzip2,  File.join(COMPRESSOR_PATH, 'bzip2')
     autoload :Custom, File.join(COMPRESSOR_PATH, 'custom')
-    autoload :Pbzip2, File.join(COMPRESSOR_PATH, 'pbzip2')
-    autoload :Lzma,   File.join(COMPRESSOR_PATH, 'lzma')
   end
 
   ##
@@ -120,10 +118,9 @@ module Backup
     archive
     binder
     cleaner
+    model
     config
     cli
-    configuration
-    model
     package
     packager
     pipeline

data/lib/backup/archive.rb

@@ -4,7 +4,7 @@ module Backup
   class Archive
     class Error < Backup::Error; end
 
-    include Backup::Utilities::Helpers
+    include Utilities::Helpers
     attr_reader :name, :options
 
     ##

data/lib/backup/cli.rb

@@ -11,8 +11,8 @@ module Backup
     # [Perform]
     #
     # The only required option is the --trigger [-t].
-    # If --config-file, --data-path, --cache-path, --tmp-path aren't specified
-    # they will fallback to defaults defined in Backup::Config.
+    # If --config-file, --data-path, --tmp-path or --log-path
+    # aren't specified they will fallback to defaults.
     # If --root-path is given, it will be used as the base path for our defaults,
     # as well as the base path for any option specified as a relative path.
     # Any option given as an absolute path will be used "as-is".
@@ -41,8 +41,8 @@ module Backup
 
       To use the current directory, use: `--root-path .`
 
-      Relative paths given for --config-file, --data-path, --log-path,
-      --cache-path and --tmp-path will be relative to --root-path.
+      Relative paths given for --config-file, --data-path, --tmp-path,
+      and --log-path will be relative to --root-path.
 
       Console log output may be forced using --no-quiet.
 
@@ -80,11 +80,6 @@ module Backup
                   :default  => '',
                   :desc     => "Path to store Backup's log file."
 
-    method_option :cache_path,
-                  :type     => :string,
-                  :default  => '',
-                  :desc     => "Path to store Dropbox's cached authorization."
-
     method_option :tmp_path,
                   :type     => :string,
                   :default  => '',
@@ -130,13 +125,8 @@ module Backup
           syslog.enabled    = opts[:syslog]
         end
 
-        # Update Config variables
-        # (config_file, root_path, data_path, cache_path, tmp_path)
-        Config.update(options)
-
-        # Load the user's +config.rb+ file (and all their Models).
-        # May update Logger (and Config) options.
-        Config.load_config!
+        # Load the user's +config.rb+ file and all their Models
+        Config.load(options)
 
         # Identify all Models to be run for the given +triggers+.
         triggers = options[:trigger].split(',').map(&:strip)
@@ -226,8 +216,7 @@ module Backup
 
     def check
       begin
-        Config.update(options)
-        Config.load_config!
+        Config.load(options)
       rescue Exception => err
         Logger.error Error.wrap(err)
       end
@@ -255,13 +244,15 @@ module Backup
     long_desc <<-EOS.gsub(/^ +/, '')
       Generates a Backup model file.
 
-      '--config-path' is the path to the *directory* where 'config.rb' is located.
+      If your configuration file is not in the default location at
+      #{ Config.config_file }
+      you must specify it's location using '--config-file'.
+      If no configuration file exists at this location, one will be created.
 
       The model file will be created as '<config_path>/models/<trigger>.rb'
-
-      The default location would be:
-
-      #{ Config.root_path }/models/
+      Your model file will be created in a 'models/' sub-directory
+      where your config file is located. The default location would be:
+      #{ Config.root_path }/models/<trigger>.rb
     EOS
 
     method_option :trigger,
@@ -270,120 +261,73 @@ module Backup
                   :type     => :string,
                   :desc     => 'Trigger name for the Backup model'
 
-    method_option :config_path,
+    method_option :config_file,
                   :type     => :string,
-                  :desc     => 'Path to your Backup configuration directory'
+                  :desc     => 'Path to your Backup configuration file'
 
     # options with their available values
-    %w{ databases storages syncers
-        encryptors compressors notifiers }.map(&:to_sym).each do |name|
-      path = File.join(Backup::TEMPLATE_PATH, 'cli', name.to_s[0..-2])
-      method_option name, :type => :string, :desc =>
-          "(#{Dir[path + '/*'].sort.map {|p| File.basename(p) }.join(', ')})"
+    %w{ databases storages syncers encryptor compressor notifiers }.each do |name|
+      path = File.join(Backup::TEMPLATE_PATH, 'cli', name)
+      opts = Dir[path + '/*'].sort.map {|p| File.basename(p) }.join(', ')
+      method_option name, :type => :string, :desc => "(#{ opts })"
     end
 
     method_option :archives,
                   :type     => :boolean,
                   :desc     => 'Model will include tar archives.'
+
     method_option :splitter,
                   :type     => :boolean,
-                  :default  => true,
-                  :desc     => "Use `--no-splitter` to disable"
-
-    define_method "generate:model" do
-      opts = options.merge(
-        :trigger      =>  options[:trigger].gsub(/\W/, '_'),
-        :config_path  =>  options[:config_path] ?
-                          File.expand_path(options[:config_path]) : nil
-      )
-      config_path    = opts[:config_path] || Config.root_path
-      models_path    = File.join(config_path, "models")
-      config         = File.join(config_path, "config.rb")
-      model          = File.join(models_path, "#{opts[:trigger]}.rb")
-
-      if File.file?(config_path)
-        abort('--config-path should be a directory, not a file.')
-      end
+                  :default  => false,
+                  :desc     => 'Add Splitter to the model'
 
-      FileUtils.mkdir_p(models_path)
-      if Helpers.overwrite?(model)
-        File.open(model, 'w') do |file|
-          file.write(
-            Backup::Template.new({:options => opts}).result("cli/model.erb")
-          )
-        end
-        puts "Generated model file: '#{ model }'."
+    define_method 'generate:model' do
+      opts = options.merge(:trigger => options[:trigger].gsub(/\W/, '_'))
+      config_file = opts[:config_file] ?
+                    File.expand_path(opts.delete(:config_file)) : Config.config_file
+      models_path = File.join(File.dirname(config_file), 'models')
+      model_file  = File.join(models_path, "#{ opts[:trigger] }.rb")
+
+      unless File.exist?(config_file)
+        invoke 'generate:config', [], :config_file => config_file
       end
 
-      unless File.exist?(config)
-        File.open(config, "w") do |file|
-          file.write(Backup::Template.new.result("cli/config"))
+      FileUtils.mkdir_p(models_path)
+      if Helpers.overwrite?(model_file)
+        File.open(model_file, 'w') do |file|
+          file.write(Backup::Template.new({:options => opts}).result('cli/model'))
         end
-        puts "Generated configuration file: '#{ config }'."
+        puts "Generated model file: '#{ model_file }'."
       end
     end
 
     ##
     # [Generate:Config]
     # Generates the main configuration file
-    desc 'generate:config', 'Generates the main Backup bootstrap/configuration file'
+    desc 'generate:config', 'Generates the main Backup configuration file'
 
     long_desc <<-EOS.gsub(/^ +/, '')
-      Path to your Backup configuration directory.
+      Path to the Backup configuration file to generate.
 
-      Default path would be:
+      Defaults to:
 
-      #{ Config.root_path }
+      #{ Config.config_file }
     EOS
 
-    method_option :config_path,
+    method_option :config_file,
                   :type => :string,
-                  :desc => 'Path to your Backup configuration directory.'
+                  :desc => 'Path to the Backup configuration file to generate.'
 
     define_method 'generate:config' do
-      config_path = options[:config_path] ?
-          File.expand_path(options[:config_path]) : Config.root_path
-      config = File.join(config_path, "config.rb")
-
-      FileUtils.mkdir_p(config_path)
-      if Helpers.overwrite?(config)
-        File.open(config, "w") do |file|
-          file.write(Backup::Template.new.result("cli/config"))
-        end
-        puts "Generated configuration file: '#{ config }'."
-      end
-    end
+      config_file = options[:config_file] ?
+          File.expand_path(options[:config_file]) : Config.config_file
 
-    ##
-    # [Decrypt]
-    # Shorthand for decrypting encrypted files
-    desc 'decrypt', 'Decrypts encrypted files'
-    method_option :encryptor,     :type => :string,  :required => true
-    method_option :in,            :type => :string,  :required => true
-    method_option :out,           :type => :string,  :required => true
-    method_option :base64,        :type => :boolean, :default  => false
-    method_option :password_file, :type => :string,  :default  => ''
-    method_option :salt,          :type => :boolean, :default  => false
-
-    def decrypt
-      case options[:encryptor].downcase
-      when 'openssl'
-        base64   = options[:base64] ? '-base64' : ''
-        password = options[:password_file].empty? ? '' :
-            "-pass file:#{ options[:password_file] }"
-        salt     = options[:salt] ? '-salt' : ''
-
-        Helpers.exec!(
-          "openssl aes-256-cbc -d #{ base64 } #{ password } #{ salt } " +
-          "-in '#{ options[:in] }' -out '#{ options[:out] }'"
-        )
-      when 'gpg'
-        Helpers.exec!(
-          "gpg -o '#{ options[:out] }' -d '#{ options[:in] }'"
-        )
-      else
-        puts "Unknown encryptor: #{ options[:encryptor] }"
-        puts "Use either 'openssl' or 'gpg'."
+      FileUtils.mkdir_p(File.dirname(config_file))
+      if Helpers.overwrite?(config_file)
+        File.open(config_file, 'w') do |file|
+          file.write(Backup::Template.new.result('cli/config'))
+        end
+        puts "Generated configuration file: '#{ config_file }'."
       end
     end
 

data/lib/backup/compressor/base.rb

@@ -3,8 +3,8 @@
 module Backup
   module Compressor
     class Base
-      include Backup::Utilities::Helpers
-      include Backup::Configuration::Helpers
+      include Utilities::Helpers
+      include Config::Helpers
 
       ##
       # Yields to the block the compressor command and filename extension.

data/lib/backup/compressor/bzip2.rb

@@ -15,17 +15,6 @@ module Backup
       # The default `level` is 9.
       attr_accessor :level
 
-      attr_deprecate :fast, :version => '3.0.24',
-                     :message => 'Use Bzip2#level instead.',
-                     :action => lambda {|klass, val|
-                       klass.level = 1 if val
-                     }
-      attr_deprecate :best, :version => '3.0.24',
-                     :message => 'Use Bzip2#level instead.',
-                     :action => lambda {|klass, val|
-                       klass.level = 9 if val
-                     }
-
       ##
       # Creates a new instance of Backup::Compressor::Bzip2
       def initialize(&block)

data/lib/backup/compressor/gzip.rb

@@ -17,17 +17,6 @@ module Backup
       # The default `level` is 6.
       attr_accessor :level
 
-      attr_deprecate :fast, :version => '3.0.24',
-                     :message => 'Use Gzip#level instead.',
-                     :action => lambda {|klass, val|
-                       klass.level = 1 if val
-                     }
-      attr_deprecate :best, :version => '3.0.24',
-                     :message => 'Use Gzip#level instead.',
-                     :action => lambda {|klass, val|
-                       klass.level = 9 if val
-                     }
-
       ##
       # Use the `--rsyncable` option with `gzip`.
       #

data/lib/backup/config.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+require 'backup/config/dsl'
+require 'backup/config/helpers'
 
 module Backup
   module Config
@@ -6,52 +8,45 @@ module Backup
 
     DEFAULTS = {
       :config_file  => 'config.rb',
-      :data_path    => 'data',
-      :cache_path   => '.cache',
+      :data_path    => '.data',
       :tmp_path     => '.tmp'
     }
 
     class << self
-      include Backup::Utilities::Helpers
+      include Utilities::Helpers
 
-      attr_reader :user, :root_path, :config_file,
-                  :data_path, :cache_path, :tmp_path
+      attr_reader :user, :root_path, :config_file, :data_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)
+      # Loads the user's +config.rb+ and all model files.
+      def load(options = {})
+        update(options)  # from the command line
 
-        DEFAULTS.each do |name, ending|
-          set_path_variable(name, options[name], ending, new_root)
+        unless File.exist?(config_file)
+          raise Error, "Could not find configuration file: '#{config_file}'."
         end
-      end
 
-      ##
-      # Tries to find and load the configuration file
-      def load_config!
-        unless File.exist?(@config_file)
-          raise Error, "Could not find configuration file: '#{@config_file}'."
+        config = File.read(config_file)
+        version = Backup::VERSION.split('.').first
+        unless config =~ /^# Backup v#{ version }\.x Configuration$/
+          raise Error, <<-EOS
+            Invalid Configuration File
+            The configuration file at '#{ config_file }'
+            does not appear to be a Backup v#{ version }.x configuration file.
+            If you have upgraded to v#{ version }.x from a previous version,
+            you need to upgrade your configuration file.
+            Please see the instructions for upgrading in the Backup documentation.
+          EOS
         end
 
-        module_eval(File.read(@config_file), @config_file)
-      end
+        dsl = DSL.new
+        dsl.instance_eval(config, config_file)
 
-      # 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 " +
-                       " and start with a capital letter."
-        end
+        update(dsl._config_options)  # from config.rb
+        update(options)              # command line takes precedence
 
-        if Backup.const_defined?(name)
-          raise Error, "'#{ name }' is already in use " +
-                        "and can not be used for a preconfigured model."
+        Dir[File.join(File.dirname(config_file), 'models', '*.rb')].each do |model|
+          dsl.instance_eval(File.read(model), model)
         end
-
-        Backup.const_set(name, Class.new(Model))
-        Backup.const_get(name).preconfigure(&block)
       end
 
       def hostname
@@ -60,7 +55,17 @@ module Backup
 
       private
 
-      ##
+      # If :root_path is set in the options, all paths will be updated.
+      # Otherwise, only the paths given will be updated.
+      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
+
       # 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)
@@ -85,9 +90,15 @@ module Backup
         # an absolute path, so we can match it against File.expand_path()
         path = path.to_s.sub(/\/\s*$/, '').lstrip
         new_path = false
+        # If no path is given, the variable will not be set/updated
+        # unless a root_path was given. In which case the value will
+        # be updated with our default ending.
         if path.empty?
           new_path = File.join(root_path, ending) if root_path
         else
+          # When a path is given, the variable will be set/updated.
+          # If the path is relative, it will be joined with root_path (if given),
+          # or expanded relative to PWD.
           new_path = File.expand_path(path)
           unless path == new_path
             new_path = File.join(root_path, path) if root_path
@@ -96,102 +107,13 @@ module Backup
         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', 'HttpPost', 'Nagios']
-          ]
-        )
-      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 Error.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
+    reset!  # set defaults on load
   end
 end