siba 0.5.6 → 0.5.7

data/lib/siba/plugins/archive/tar/init.rb

@@ -7,10 +7,10 @@ module Siba::Archive
     DefaultCompression = "gzip"
     CompressionTypes = ["gzip", "bzip2", "none"]
 
-    class Init 
+    class Init
       include Siba::LoggerPlug
 
-      attr_accessor :archive 
+      attr_accessor :archive
 
       def initialize(options)
         options = options
@@ -31,7 +31,7 @@ module Siba::Archive
       # No return value is expected.
       def restore(path_to_archive, to_dir)
         logger.info "Extracting 'tar' archive, compression: '#{archive.compression}'"
-        @archive.extract path_to_archive, to_dir 
+        @archive.extract path_to_archive, to_dir
       end
     end
   end

data/lib/siba/plugins/destination/dir/dest_dir.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 module Siba::Destination
-  module Dir 
+  module Dir
     class DestDir
       include Siba::FilePlug
       include Siba::LoggerPlug
@@ -19,9 +19,9 @@ module Siba::Destination
             raise Siba::Error, "Backup file '#{path_to_backup}' does not exist"
           end
           unless siba_file.file_directory? dir
-            raise Siba::Error, "Destination directory '#{dir}' does not exist" 
+            raise Siba::Error, "Destination directory '#{dir}' does not exist"
           end
-          siba_file.file_utils_cp(path_to_backup, dir) 
+          siba_file.file_utils_cp(path_to_backup, dir)
         end
       end
 
@@ -36,7 +36,7 @@ module Siba::Destination
           siba_file.file_utils_cp path_to_backup, to_dir
         end
       end
-      
+
       def test_dir_access
         siba_file.run_this "test dir access" do
           # create dest dir
@@ -48,7 +48,7 @@ module Siba::Destination
           end
 
           # copy a test file to dest dir
-          begin          
+          begin
             test_file = Siba::TestFiles.prepare_test_file "destination_dir", dir
             raise "Can not find the test file." unless siba_file.file_file? test_file
             siba_file.file_utils_remove_entry_secure test_file
@@ -66,7 +66,7 @@ module Siba::Destination
         siba_file.run_this do
           Siba::FileHelper.entries(dir).select do |f|
             f =~ /^#{backup_name}/
-          end.map do |f| 
+          end.map do |f|
             mtime = siba_file.file_mtime File.join dir, f
             [f, mtime]
           end
@@ -74,4 +74,4 @@ module Siba::Destination
       end
     end
   end
-end 
+end

data/lib/siba/plugins/destination/dir/init.rb

@@ -3,8 +3,8 @@
 require 'siba/plugins/destination/dir/dest_dir'
 
 module Siba::Destination
-  module Dir 
-    class Init 
+  module Dir
+    class Init
       attr_accessor :dest_dir
 
       def initialize(options)

data/lib/siba/plugins/encryption/gpg/encryption.rb

@@ -2,11 +2,11 @@
 
 module Siba::Encryption
   module Gpg
-    class Encryption 
+    class Encryption
       include Siba::LoggerPlug
       include Siba::FilePlug
 
-      DEFAULT_CIPHER = "AES256"      
+      DEFAULT_CIPHER = "AES256"
 
       attr_accessor :passphrase, :cipher
 
@@ -21,7 +21,7 @@ module Siba::Encryption
         path_to_encrypted_backup = "#{path_to_archive}.gpg"
         siba_file.run_this("encrypt") do
           if siba_file.file_file? path_to_encrypted_backup
-            raise Siba::Error, "Encrypted file #{path_to_encrypted_backup} already exists" 
+            raise Siba::Error, "Encrypted file #{path_to_encrypted_backup} already exists"
           end
           passphare_for_command = passphrase.gsub('"','\\"')
           gpg_homedir = Siba::TestFiles.mkdir_in_tmp_dir "gpg-homedir"
@@ -29,17 +29,17 @@ module Siba::Encryption
           command = command_without_password.gsub "****", passphare_for_command
           siba_file.run_shell command, "failed to encrypt: #{command_without_password}"
           unless siba_file.file_file? path_to_encrypted_backup
-            raise siba::error, "failed to find encrypted backup file: #{command_without_password}" 
+            raise siba::error, "failed to find encrypted backup file: #{command_without_password}"
           end
         end
-        path_to_encrypted_backup 
+        path_to_encrypted_backup
       end
 
       def decrypt(path_to_encrypted_file, path_to_decrypted_file=nil)
         path_to_decrypted_file = path_to_encrypted_file.gsub /\.gpg$/, "" if path_to_decrypted_file.nil?
         siba_file.run_this("decrypt") do
           if siba_file.file_file? path_to_decrypted_file
-            raise Siba::Error, "Decrypted file #{path_to_decrypted_file} already exists" 
+            raise Siba::Error, "Decrypted file #{path_to_decrypted_file} already exists"
           end
           passphare_for_command = passphrase.gsub('"','\\"')
           gpg_homedir = Siba::TestFiles.mkdir_in_tmp_dir "gpg-homedir"
@@ -47,7 +47,7 @@ module Siba::Encryption
           command = command_without_password.gsub "****", passphare_for_command
           siba_file.run_shell command, "failed to decrypt: #{command_without_password}"
           unless siba_file.file_file? path_to_decrypted_file
-            raise siba::error, "failed to find decrypted backup file: #{command_without_password}" 
+            raise siba::error, "failed to find decrypted backup file: #{command_without_password}"
           end
         end
         path_to_decrypted_file
@@ -99,14 +99,14 @@ module Siba::Encryption
             else
               cipher.upcase!
             end
-            
+
             raise Siba::CheckError, "'#{cipher}' cipher is not supported.
 #{supported_ciphers_msg}" unless supported_ciphers.include?(cipher)
           end
           cipher
         end
 
-        def get_cipher_names          
+        def get_cipher_names
           output = siba_file.run_shell "gpg --version"
           cipher_names = parse_cipher_names output
           raise Siba::Error, "Failed to get the list of supported ciphers" if cipher_names.empty?
@@ -117,7 +117,7 @@ module Siba::Encryption
           scan = version.scan /Cipher:(.*?)\n\w+:/m
           scan = version.scan /Cipher:(.*)/m if scan.size == 0
           if scan.size == 0 || !scan[0].is_a?(Array) || scan[0].size == 0 || !scan[0][0].is_a?(String)
-            raise "Failed to parse gpg version information" 
+            raise "Failed to parse gpg version information"
           end
           scan = scan[0][0]
           scan.gsub!(/ |\n/, "")

data/lib/siba/plugins/encryption/gpg/init.rb

@@ -14,7 +14,7 @@ module Siba::Encryption
         passphrase = Siba::SibaCheck.options_string(options, "passphrase")
         cipher = Siba::SibaCheck.options_string(options, "cipher", true)
         @encryption = Siba::Encryption::Gpg::Encryption.new passphrase, cipher
-      end     
+      end
 
       # Encrypt backup archive file (path_to_archive) and put it to dest_dir.
       # Return the name of encrypted file. It must begin with archive name

data/lib/siba/plugins/installed_plugins.rb

@@ -9,10 +9,10 @@ module Siba
 
       def installed?(category, type)
         types = all_installed[category]
-        return false if types.nil? 
+        return false if types.nil?
         types.include? type
       end
-      
+
       def all_installed
         @installed ||= find_installed
       end
@@ -25,7 +25,7 @@ module Siba
           path = type_dir category, type
           unless siba_file.file_directory? path
             path = Siba::GemHelper.gem_path gem_name(category, type)
-            path = File.join path, "lib", gem_name(category, type) 
+            path = File.join path, "lib", gem_name(category, type)
           end
           unless siba_file.file_directory? path
             raise Siba::Error, "Failed to get path to plugin #{plugin_category_and_type(category, type)}"
@@ -43,18 +43,22 @@ module Siba
       end
 
       def gem_name(category, type)
-        "#{GEM_PREFIX}#{category}-#{type}" 
+        "#{GEM_PREFIX}#{category}-#{type}"
       end
 
       def plugin_category_and_type(category, type)
         "#{category}#{type.nil? ? "" : '-' + type}"
       end
 
+      def install_gem_message(category, type)
+        "'#{type}' plugin is not installed.\nRun 'gem install #{gem_name(category, type)}' to install it and try again."
+      end
+
     private
 
       def find_installed
         installed = {}
-        Siba::GemHelper.all_local_gems.map{|a| a.name}.each do |item| 
+        Siba::GemHelper.all_local_gems.map{|a| a.name}.each do |item|
           Siba::Plugins::CATEGORIES.each do |category|
             installed[category] ||= []
             gem_prefix_full = /^#{GEM_PREFIX}#{category}-/
@@ -68,7 +72,7 @@ module Siba
           }.select{|dir| File.file?(File.join(dir,"init.rb")) }
             .map{|directory| File.basename(directory)}
         end
- 
+
         installed
       end
 

data/lib/siba/plugins/plugin_loader.rb

@@ -8,7 +8,7 @@ module Siba
     InitClassName = "Init"
 
     def self.loader
-      @loader ||= PluginLoader.new 
+      @loader ||= PluginLoader.new
     end
 
     def load(category, type, options)
@@ -22,7 +22,7 @@ module Siba
       @type=type
       @options = options
       logger.debug "Loading #{plugin_category_and_type} plugin"
-      
+
       require_plugin
       plugin_module = get_plugin_module
       plugin_type_module = get_plugin_type_module plugin_module
@@ -40,9 +40,10 @@ module Siba
       else
         gem_name = Siba::InstalledPlugins.gem_name category, type
         begin
-          Gem::Specification.find_by_name(gem_name) 
+          Gem::Specification.find_by_name(gem_name)
         rescue Gem::LoadError
-          raise PluginLoadError, "Unknown type '#{type}' for '#{category}' plugin. #{available_types_msg}"
+          error_msg = Siba::InstalledPlugins.install_gem_message(category, type)
+          raise PluginLoadError, error_msg
         end
         require gem_name
       end
@@ -52,7 +53,7 @@ module Siba
       plugin_module_name = "#{category.capitalize}"
       Siba.const_get(plugin_module_name)
     rescue Exception
-      raise PluginLoadError, "Failed to load #{plugin_category_and_type} plugin: module 'Siba::#{plugin_module_name}' is undefined." 
+      raise PluginLoadError, "Failed to load #{plugin_category_and_type} plugin: module 'Siba::#{plugin_module_name}' is undefined."
     end
 
     def get_plugin_type_module(plugin_module)

data/lib/siba/plugins/source/files/files.rb

@@ -20,7 +20,7 @@ module Siba::Source
             file = files_to_include[i]
             file = siba_file.file_expand_path file
             next if ignored? file
-            
+
             is_file = siba_file.file_file? file
             unless is_file || siba_file.file_directory?(file)
               logger.error "Source file or directory does not exist: #{file}"
@@ -28,7 +28,7 @@ module Siba::Source
             end
 
             path_to_subdir = Files.sub_dir_name i+1, size_digits, is_file, file, dest_dir
-            siba_file.file_utils_mkpath path_to_subdir 
+            siba_file.file_utils_mkpath path_to_subdir
 
             logger.debug file
             if is_file
@@ -79,7 +79,7 @@ module Siba::Source
 
       def restore_file(path_to_backup_dir, entry_name_to_restore, path_to_source)
         backup_dir_entries = Siba::FileHelper.entries path_to_backup_dir
-        if backup_dir_entries.size != 1 
+        if backup_dir_entries.size != 1
           logger.error "Failed to restore file: #{entry_name_to_restore}"
           return
         end
@@ -105,7 +105,7 @@ module Siba::Source
       def copy_file(file, dest_dir)
         siba_file.run_this "copy file" do
           return if ignored? file
-          siba_file.file_utils_cp(file, dest_dir) 
+          siba_file.file_utils_cp(file, dest_dir)
         end
       end
 
@@ -121,13 +121,13 @@ module Siba::Source
           Siba::FileHelper.entries(dir).each do |entry|
             entry = File.join dir, entry
             if siba_file.file_file? entry
-              copy_file entry, dest_dir 
+              copy_file entry, dest_dir
             elsif  siba_file.file_directory? entry
               copy_dir entry, dest_dir, true if include_subdirs
             else
               logger.error "Failed to backup: #{entry}."
             end
-          end 
+          end
         end
       end
 
@@ -147,7 +147,7 @@ module Siba::Source
           file.strip!
           pattern.strip!
           basename = File.basename(file)
-          
+
           return File.fnmatch(pattern, basename, File::FNM_CASEFOLD) || # match basename against pattern
             File.fnmatch(pattern, file, File::FNM_CASEFOLD) # match whole path against pattern
         end

data/lib/siba/plugins/source/files/init.rb

@@ -4,7 +4,7 @@ require 'siba/plugins/source/files/files'
 
 module Siba::Source
   module Files
-    class Init 
+    class Init
       include Siba::LoggerPlug
       attr_accessor :files
 
@@ -22,7 +22,7 @@ module Siba::Source
         @files.backup dest_dir
       end
 
-      # Restore source files and dirs from_dir 
+      # Restore source files and dirs from_dir
       # No return value is expected
       def restore(from_dir)
         logger.info "Restoring files"

data/lib/siba/restore.rb

@@ -23,9 +23,9 @@ private
       Siba.current_dir = File.dirname path_to_options_yml
       Siba.settings = options["settings"] || {}
       Siba.backup_name = File.basename path_to_options_yml, ".yml"
-      TmpDir.test_access 
+      TmpDir.test_access
       tasks = SibaTasks.new options, path_to_options_yml, !current_source
-      file_name = get_backup_choice tasks 
+      file_name = get_backup_choice tasks
       unless file_name.nil?
         if user_wants_to_proceed?
           tasks.restore file_name
@@ -35,7 +35,7 @@ private
         end
       end
       Siba.cleanup_tmp_dir
-    rescue Exception => e 
+    rescue Exception => e
       logger.fatal e
       logger.log_exception e, true
     end
@@ -81,7 +81,7 @@ private
 
         if (i+rows) <= list.size
           num2 = "#{(i+rows).to_s.rjust(2)}."
-          str2 = list[i+rows-1][2] 
+          str2 = list[i+rows-1][2]
           column2 = "#{num2} #{str2}"
         end
         siba_kernel.puts " #{column1}#{column2}"
@@ -114,7 +114,7 @@ Type 'yes' if you want to proceed:
           return list[number-1][0]
         else
           siba_kernel.printf msg
-        end 
+        end
       end
     end
 

data/lib/siba/scaffold.rb

@@ -7,7 +7,7 @@ module Siba
     attr_accessor :category, :name, :name_camelized
     CATEGORY_REPLACE_TEXT = "c6y"
     NAME_REPLACE_TEXT = "demo"
-    
+
     def initialize(category, name)
       @category = category
       unless Siba::Plugins.valid_category? category
@@ -34,13 +34,13 @@ module Siba
         logger.debug "Scaffolding started"
         dest_dir = File.join dest_dir, name
         if siba_file.file_directory?(dest_dir) || siba_file.file_file?(dest_dir)
-          raise Siba::Error, "Directory already exists #{dest_dir}." 
+          raise Siba::Error, "Directory already exists #{dest_dir}."
         end
 
         logger.debug "Checking if GIT is installed"
         raise Siba::Error, "Please install GIT first" unless siba_file.shell_ok? "git help"
         scaffolds_dir = siba_file.file_expand_path "../../../scaffolds", __FILE__
-        
+
         logger.debug "Creating a tmp dir"
         dest_tmp_dir = Siba::TestFiles.mkdir_in_tmp_dir "scaffold"
 
@@ -50,18 +50,18 @@ module Siba
           raise Siba::Error, "Scaffold project dir does not exist '#{project_dir}'"
         end
         siba_file.file_utils_cp_r File.join(project_dir,"."), dest_tmp_dir
-        
+
         logger.debug "Copying init file"
         init_file = File.join scaffolds_dir, "#{category}.rb"
         unless siba_file.file_file? init_file
           raise Siba::Error, "Scaffold init file does not exist '#{init_file}'"
         end
-        init_dir = File.join dest_tmp_dir, "lib", "siba-#{CATEGORY_REPLACE_TEXT}-demo"  
+        init_dir = File.join dest_tmp_dir, "lib", "siba-#{CATEGORY_REPLACE_TEXT}-demo"
         unless siba_file.file_directory? init_dir
           raise Siba::Error, "Source dir does not exist '#{init_dir}'"
         end
         init_file_dest = File.join init_dir,"init.rb"
-        siba_file.file_utils_cp init_file, init_file_dest 
+        siba_file.file_utils_cp init_file, init_file_dest
         unless siba_file.file_file? init_file_dest
           raise Siba::Error, "Filed to create init file '#{init_file_dest}'"
         end
@@ -73,20 +73,20 @@ module Siba
         replace_siba_version dest_tmp_dir
 
         logger.debug "Setting gem category and name in file names and contents"
-        replace_category_and_name dest_tmp_dir        
+        replace_category_and_name dest_tmp_dir
 
         gitify dest_tmp_dir
-       
+
         logger.debug "Copying the project to destination"
         siba_file.file_utils_mkpath dest_dir
         siba_file.file_utils_cp_r File.join(dest_tmp_dir,"."), dest_dir
 
-        
+
         logger.info "Project created in #{dest_dir}"
         logger.info "There is a README file with instructions there"
         logger.show_finish_message = false
       end
-    rescue Exception => e 
+    rescue Exception => e
       logger.fatal e
       logger.log_exception e, true
     end
@@ -95,7 +95,7 @@ module Siba
       Siba::FileHelper.entries(dir).each do |entry|
         entry_path = replace_path dir, entry
         if siba_file.file_directory? entry_path
-          replace_category_and_name entry_path 
+          replace_category_and_name entry_path
         else
           replace_file_contents entry_path
         end
@@ -104,8 +104,8 @@ module Siba
 
     def replace_path(dir, entry)
       entry_path = File.join dir, entry
-      entry_after = entry.gsub CATEGORY_REPLACE_TEXT, category 
-      entry_after = entry_after.gsub NAME_REPLACE_TEXT, name 
+      entry_after = entry.gsub CATEGORY_REPLACE_TEXT, category
+      entry_after = entry_after.gsub NAME_REPLACE_TEXT, name
       if entry_after != entry
         entry_path_after = File.join(dir, entry_after)
         siba_file.file_utils_mv entry_path, entry_path_after
@@ -117,10 +117,10 @@ module Siba
     def replace_file_contents(path_to_file)
       return unless siba_file.file_file? path_to_file
       Siba::FileHelper.change_file(path_to_file) do |file_text|
-        file_text.gsub! CATEGORY_REPLACE_TEXT, category 
+        file_text.gsub! CATEGORY_REPLACE_TEXT, category
         file_text.gsub! CATEGORY_REPLACE_TEXT.capitalize, category.capitalize
-        file_text.gsub! NAME_REPLACE_TEXT, name 
-        file_text.gsub! NAME_REPLACE_TEXT.capitalize, name_camelized 
+        file_text.gsub! NAME_REPLACE_TEXT, name
+        file_text.gsub! NAME_REPLACE_TEXT.capitalize, name_camelized
         file_text
       end
     end
@@ -138,7 +138,7 @@ module Siba
       raise Siba::Error, "Can not find gemspec file #{path_to_gemspec}" unless siba_file.file_file? path_to_gemspec
       Siba::FileHelper.change_file(path_to_gemspec) do |file_text|
         version = Siba::VERSION.split('.')[0..-2].join('.')
-        file_text.gsub "siba_version", version 
+        file_text.gsub "siba_version", version
       end
     end