siba 0.4.3

data/lib/siba/test_files.rb

@@ -0,0 +1,76 @@
+# encoding: UTF-8
+
+module Siba::TestFiles
+  class << self
+    include Siba::FilePlug
+    def test_files_dir
+      siba_file.file_expand_path("../test_files/", __FILE__)
+    end
+
+    def test_file
+      File.join test_files_dir, "a_file"
+    end    
+
+    def test_dir
+      File.join test_files_dir, "files_and_dirs"
+    end    
+
+    def prepare_test_dir(dest_dir_name_part, tmp_dir=nil)
+      tmp_dir ||= Siba.tmp_dir
+      dest_dir = File.join(tmp_dir,"#{dest_dir_name_part}#{random_suffix}")
+      siba_file.file_utils_mkpath tmp_dir unless siba_file.file_directory? tmp_dir
+      siba_file.file_utils_cp_r test_dir, dest_dir
+      dest_dir
+    end
+    
+    def prepare_test_file(dest_file_name_part, tmp_dir=nil)
+      tmp_dir ||= Siba.tmp_dir
+      dest_file = File.join(tmp_dir,"#{dest_file_name_part}#{random_suffix}")
+      siba_file.file_utils_mkpath tmp_dir unless siba_file.file_directory? tmp_dir
+      siba_file.file_utils_cp test_file, dest_file
+      dest_file
+    end
+
+    def generate_path(dest_file_name_part, tmp_dir=nil)
+      tmp_dir ||= Siba.tmp_dir
+      File.join(tmp_dir,"#{dest_file_name_part}#{random_suffix}")
+    end  
+
+    def mkdir_in_tmp_dir(prefix, tmp_dir=nil)
+      tmp_dir ||= Siba.tmp_dir
+      dir = "#{prefix}#{random_suffix}"
+      dir_path = File.join(tmp_dir, dir)
+      siba_file.file_utils_mkpath dir_path
+      dir_path
+    end
+
+    def prepare_options_text(src_yml_path, replace_data)
+      replace_prefix = "#_replace_"
+      options_text = Siba::FileHelper.read src_yml_path
+      replace_data.each_pair do |key, value|
+        str_to_replace = "#{replace_prefix}#{key.to_s}"
+        raise "YML does not contain #{str_to_replace} text" unless options_text.include? str_to_replace
+        options_text.gsub! str_to_replace, value
+      end
+
+      raise "Test YML still has unreplaced text" if options_text.include? "#{replace_prefix}"
+      options_text
+    end
+
+    def prepare_options(src_yml_path, replace_data)
+      YAML.load prepare_options_text(src_yml_path, replace_data)
+    end
+
+    def prepare_yml(src_yml_path, replace_data, tmp_dir=nil)
+      tmp_dir ||= Siba.tmp_dir
+      options_text = prepare_options_text src_yml_path, replace_data
+      dest_file = File.join tmp_dir,"#{File.basename(src_yml_path,".yml")}#{random_suffix}.yml"
+      siba_file.file_open(dest_file, "w") { |f| f.write options_text }
+      dest_file
+    end
+
+    def random_suffix
+      "-#{Siba::SecurityHelper.alphanumeric_password(8,true)}"
+    end
+  end
+end

data/lib/siba/test_files/a_file

@@ -0,0 +1 @@
+This is a standalone file

data/lib/siba/test_files/files_and_dirs/.hidden

@@ -0,0 +1 @@
+This is a hidden file

data/lib/siba/test_files/files_and_dirs/.hidden_dir/file10

@@ -0,0 +1 @@
+This is a file in a hidden dir

data/lib/siba/test_files/files_and_dirs/File With Spaces

@@ -0,0 +1 @@
+This file name has spaces and capital characters

data/lib/siba/test_files/files_and_dirs/dir1/file10

@@ -0,0 +1 @@
+This is file in a dir

data/lib/siba/test_files/files_and_dirs/dir1/sub-dir/file111.txt

@@ -0,0 +1 @@
+This is a file in a sub dir

data/lib/siba/test_files/files_and_dirs/file1

@@ -0,0 +1 @@
+This is file 1

data/lib/siba/test_files/files_and_dirs/file2.txt

@@ -0,0 +1 @@
+This is file 2

data/lib/siba/tmp_dir.rb

@@ -0,0 +1,94 @@
+# encoding: UTF-8
+
+module Siba
+  class TmpDir
+    include Siba::FilePlug
+    include Siba::LoggerPlug
+    TmpDirPrefix = "siba-"
+
+    def initialize
+      @tmp_dir = nil
+    end
+
+    def get
+      @tmp_dir ||= create
+    end
+
+    def cleanup
+      siba_file.file_utils_remove_entry_secure @tmp_dir unless @tmp_dir.nil?
+      @tmp_dir = nil
+    end
+
+    class << self
+      include Siba::FilePlug
+      include Siba::LoggerPlug
+      def test_access
+        siba_file.run_this "test access" do
+          begin
+            tmp_dir_obj = TmpDir.new
+            test_dir = tmp_dir_obj.get
+            raise unless siba_file.file_directory? test_dir
+            tmp_dir_obj.cleanup
+          rescue Exception
+            logger.error %q{Can not create temporary directory. 
+Please make sure you have write permissions to the system temporary folder. 
+You can also specify the alternative location for temporary folder in options:
+
+settings:
+  tmp_dir: ~/your_tmp_dir
+}
+            raise
+          end
+          logger.debug "Access to temporary directory verified"
+        end
+      end
+    end
+
+  protected
+
+    def create
+      siba_file.run_this "create tmp dir" do
+        tmp_dir_from_settings = Siba.settings && Siba.settings["tmp_dir"]
+        tmp_path = nil
+        if tmp_dir_from_settings.nil?
+          tmp_path = siba_file.dir_mktmpdir TmpDirPrefix 
+        else
+          tmp_path = File.join(siba_file.file_expand_path(tmp_dir_from_settings),
+                                  "#{TmpDirPrefix}#{Siba::TestFiles.random_suffix}")
+          siba_file.file_utils_mkpath tmp_path
+        end
+        tmp_path
+      end
+    end
+  end
+  
+  module TmpDirPlug
+    include Siba::FilePlug
+    include Siba::LoggerPlug
+
+    def tmp_dir
+      if tmp_dir_clean?
+        @tmp_dir_obj = TmpDir.new
+        @tmp_dir = @tmp_dir_obj.get
+      end
+      @tmp_dir
+    end
+
+    def cleanup_tmp_dir
+      unless @tmp_dir_obj.nil?
+        logger.debug "Removing temporary files" if Siba::LoggerPlug.opened?
+        siba_file.file_utils_cd Siba.current_dir
+        @tmp_dir_obj.cleanup
+        @tmp_dir_obj = nil
+      end
+      @tmp_dir = nil unless @tmp_dir.nil?
+    rescue Exception => ex
+      logger.fatal "Failed to remove temporary files" if Siba::LoggerPlug.opened?
+      raise
+    end
+
+    def tmp_dir_clean?
+      @tmp_dir.nil?
+    end
+  end
+end

data/lib/siba/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+module Siba
+  VERSION = "0.4.3"
+end

data/scaffolds/archive.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+module Siba::C6y
+  module Demo                 
+    class Init                 
+      include Siba::FilePlug
+      include Siba::LoggerPlug
+
+      def initialize(options)
+## init_example.rb ##
+      end                      
+
+      # Archive the contents of sources_dir and put it to dest_dir.
+      # Return the archive file name. It must start with dest_file_name
+      # and its ending must not vary with time.
+      def backup(sources_dir, dest_dir, dest_file_name)
+## examples.rb ##
+      end
+
+      # Extract contents of archive file (path_to_archive) to_dir
+      # No return value is expected.
+      def restore(path_to_archive, to_dir)
+      end
+    end
+  end
+end

data/scaffolds/destination.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+module Siba::C6y
+  module Demo                 
+    class Init                 
+      include Siba::FilePlug
+      include Siba::LoggerPlug
+
+      def initialize(options)
+## init_example.rb ##
+      end                      
+
+      # Put backup file (path_to_backup_file) to destination
+      # No return value is expected
+      def backup(path_to_backup_file) 
+## examples.rb ##
+      end
+    end
+  end
+end

data/scaffolds/encryption.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+module Siba::C6y
+  module Demo                 
+    class Init                 
+      include Siba::FilePlug
+      include Siba::LoggerPlug
+
+      def initialize(options)
+## init_example.rb ##
+      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
+      # and its ending must always be the same.
+      def backup(path_to_archive, dest_dir)
+## examples.rb ##
+      end
+
+      # Decrypt backup file (path_to_backup) to_dir.
+      # Return the name of decrypted file.
+      def restore(path_to_backup, to_dir)
+      end
+    end
+  end
+end

data/scaffolds/project/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp

data/scaffolds/project/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in siba-destination-demo.gemspec
+gemspec

data/scaffolds/project/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile           
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest', :notify=>false do
+  watch(%r|^test/unit/(.*\/)*test_(.*)\.rb|)
+  watch(%r|^lib/siba-c6y-demo/(.*\/)*([^/]+)\.rb|) do |m| 
+    "test/unit/#{m[1]}test_#{m[2]}.rb" unless m[2][0] == '.' 
+  end
+end

data/scaffolds/project/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) <year> <name>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/scaffolds/project/README.md

@@ -0,0 +1,33 @@
+# Developing a SIBA plugin
+
+Follow four simple steps to develop a SIBA extension plugin.
+
+## 1. Generate project skeleton
+
+Generate an empty project for a plugin gem:
+
+        $ siba scaffold CATEGORY plugin-name
+
+where CATEGORY can be: source, archive, encryption or destination. 
+
+## 2. Change `init.rb` file
+
+After the project is generated, add your code to init.rb file located in lib/your-plugin-dir. It already has all necessay methods with instructions and examples.
+
+## 3. Change `options.yml`
+
+Add your plugin options to `options.yml`. It is located in the same directory as `init.rb`. This file is used for `siba generate` command.
+
+## 4. Publish
+
+Publish your plugin gem. If you want your plugin to be shown to users by `siba list` and `siba generate` commands, please add its description to /lib/siba/plugins/plugins.yml file in SIBA project on github and issue a pull request.
+
+## Testing
+
+The project contains test files with examples. Two types of tests are used: unit and integration. In unit tests file system, shell and other time consuming operations are not performed.
+
+To run unit tests:
+        rake
+
+To run integration tests
+        rake test:i9n

data/scaffolds/project/Rakefile

@@ -0,0 +1,28 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'        
+
+namespace "test" do
+  desc "Run all unit tests"    
+  Rake::TestTask.new("unit") do |t|     
+    t.pattern = "test/unit/**/test*.rb"
+    t.libs << 'test'           
+  end
+
+  desc "Run all integration tests"
+  Rake::TestTask.new("integration") do |t|     
+    t.pattern = "test/integration/**/i9n_*.rb"
+    t.libs << 'test'           
+  end
+
+  desc "Run all integration tests"
+  task :i9n => ["test:integration"] do 
+  end
+end
+
+desc "Run all unit tests"
+task :test => ["test:unit"] do
+end
+
+desc "Run tests"               
+task :default => "test:unit"
+

data/scaffolds/project/lib/siba-c6y-demo.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+require "siba-c6y-demo/version"
+require "siba-c6y-demo/init"
+
+module Siba
+  module C6y
+    module Demo
+    end
+  end
+end

data/scaffolds/project/lib/siba-c6y-demo/options.yml

@@ -0,0 +1,2 @@
+# A skeleton for the plugin options
+# It is used by 'siba generate' command

data/scaffolds/project/lib/siba-c6y-demo/version.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+
+module Siba
+  module C6y
+    module Demo
+      VERSION = "0.0.1"
+    end
+  end
+end

data/scaffolds/project/siba-c6y-demo.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "siba-c6y-demo/version"
+
+Gem::Specification.new do |s|
+  s.name        = "siba-c6y-demo"
+  s.version     = Siba::C6y::Demo::VERSION
+  s.authors     = ["TODO: Write your name"]
+  s.email       = ["TOD0: your@email.com"]
+  s.homepage    = ""
+  s.summary     = %q{TODO: Write a gem summary}
+  s.description = %q{TODO: Write a gem description}
+
+  s.rubyforge_project = "siba-c6y-demo"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_runtime_dependency     'siba', '~>siba_version'
+
+  s.add_development_dependency  'minitest', '~>2.10'
+  s.add_development_dependency  'rake', '~>0.9'
+  s.add_development_dependency  'guard-minitest', '~>0.4'
+end

data/scaffolds/project/test/helper/require_integration.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+require 'siba/helpers/test/require'
+SibaTest.init_integration      
+