ruby_clone 1.0.0

data/lib/ruby_clone/rsync.rb

@@ -0,0 +1,94 @@
+require 'pty'
+
+module RubyClone
+
+  class RSync
+
+    attr_writer :dry_run
+
+    def initialize(output)
+      @configurations = { options: '-Cavh --stats --progress', show_command: true, show_output: true }
+      @exclude_patterns = []
+      @include_patterns = []
+      @output = output
+      @profiles = {}
+    end
+
+    def profiles=(profile)
+      @profiles[profile.name] = profile
+      @last_profile = profile
+    end
+
+    def last_profile
+      @last_profile
+    end
+
+    def update_configurations(configurations)
+      @configurations.merge! configurations
+    end
+
+    def exclude_pattern=(path)
+      @exclude_patterns << path
+    end
+
+    def include_pattern=(path)
+      @include_patterns << path
+    end
+
+    def rsync_command(profile_name)
+      profile = @profiles[profile_name.to_s]
+
+      if profile
+        raise SyntaxError, "Empty Profile not allowed for profile #{profile} with no 'from folder'" unless profile.from_folder
+        raise SyntaxError, "Empty Profile not allowed for profile #{profile} with no 'to folder'" unless profile.to_folder
+
+        create_rsync_command profile
+      else
+        raise ArgumentError, "Profile #{profile_name} not found"
+      end
+    end
+
+    def run(profile_name)
+      command = rsync_command(profile_name)
+      @output.puts "\n#{command}\n\n" if @configurations[:show_command]
+
+      pty = @pty || PTY
+
+      pty.spawn(command) do |r, w, pid|
+        r.each { |line| print line } if @configurations[:show_output]
+      end
+
+      profile = @profiles[profile_name.to_s]
+      profile.to_folder.delete_files
+    end
+
+   private
+
+    def create_rsync_command(profile)
+      command = "rsync #{@configurations[:options]} "
+
+      command << "-n " if @dry_run
+
+      command << @include_patterns.map { |e| "--include=#{e}" }.join(" ") + " "
+      command << @exclude_patterns.map { |e| "--exclude=#{e}" }.join(" ")
+
+      command << " #{profile.from_folder.to_command}"
+      command << " #{profile.to_folder.to_command}"
+      command << " #{create_ssh_command(profile)}"
+
+      command << " #{profile.from_folder} #{profile.to_folder}"
+      command.gsub(/\s+/, " ")
+    end
+
+    def create_ssh_command(profile)
+      from_folder = profile.from_folder
+      to_folder = profile.to_folder
+
+      if from_folder.ssh? && to_folder.ssh?
+        raise SyntaxError, 'The source and destination cannot both be remote.'
+      elsif from_folder.ssh? || to_folder.ssh?
+        "-e ssh"
+      end
+    end
+  end
+end

data/lib/ruby_clone/version.rb

@@ -0,0 +1,3 @@
+module RubyClone
+  VERSION = "1.0.0"
+end

data/lib/ruby_clone.rb

@@ -0,0 +1,11 @@
+require "ruby_clone/version"
+
+require 'ruby_clone/backup_utils'
+
+require 'ruby_clone/rsync'
+
+require 'ruby_clone/dsl'
+
+require 'ruby_clone/profile'
+
+require 'ruby_clone/options'

data/ruby_clone.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ruby_clone/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Frederico Benevides"]
+  gem.email         = ["fredbene@gmail.com"]
+  gem.description   = %q{Ruby clone is a command line tool to work with Rsync using DSL!}
+  gem.summary       = %q{Ruby_clone is high level script of Rsync. Use Ruby DSL to work with RSync! }
+  gem.homepage      = "http://github.com/fredericobenevides/ruby_clone"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ruby_clone"
+  gem.require_paths = ["lib"]
+  gem.version       = RubyClone::VERSION
+
+  gem.add_development_dependency "guard", "~> 1.3.2"
+  gem.add_development_dependency "guard-rspec", "~> 1.2.1"
+  gem.add_development_dependency "rspec", "~> 2.11.0"
+end

data/spec/ruby_clone/backup_utils_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+module RubyClone
+
+  describe BackupUtils do
+
+    describe "Deleting files" do
+
+      before(:each) do
+        @ruby_clone_suffix = '_rbcl'
+
+        @paths = [ "/my_path/sub_path1/file1#{@ruby_clone_suffix}_20120921",
+                   "/my_path/sub_path1/file1#{@ruby_clone_suffix}_20120922",
+                   "/my_path/sub_path1/file1#{@ruby_clone_suffix}_20120923",
+
+                   "/my_path/sub_path1/file2#{@ruby_clone_suffix}_20120922",
+                   "/my_path/sub_path2/file1#{@ruby_clone_suffix}_20120922",
+                   "/my_path/sub_path2/file2#{@ruby_clone_suffix}_20120923"]
+
+        File.stub(:exists?).with(any_args()).and_return(true)
+
+        FileTest.stub(:file?).with(any_args()).and_return false
+        FileTest.stub(:file?).with(@paths[0]).and_return true
+        FileTest.stub(:file?).with(@paths[1]).and_return true
+        FileTest.stub(:file?).with(@paths[2]).and_return true
+        FileTest.stub(:file?).with(@paths[3]).and_return true
+        FileTest.stub(:file?).with(@paths[4]).and_return true
+        FileTest.stub(:file?).with(@paths[5]).and_return true
+
+        Find.stub(:find).and_yield('/my_path').and_yield('/my_path/sub_path1')
+                        .and_yield(@paths[0]).and_yield(@paths[1]).and_yield(@paths[2]).and_yield(@paths[3])
+                        .and_yield('/my_path/sub_path2')
+                        .and_yield(@paths[4]).and_yield(@paths[5])
+
+      end
+
+      describe "valid" do
+
+        it "should create a hash with [path_files_without_suffix, path_files] that points to the files with same name" do
+          paths = BackupUtils.find_files_with_same_name '/my_path', @ruby_clone_suffix
+
+          paths.should == { '/my_path/sub_path1/file1' => [@paths[0], @paths[1], @paths[2]],
+                            '/my_path/sub_path1/file2' => [@paths[3]],
+                            '/my_path/sub_path2/file1' => [@paths[4]],
+                            '/my_path/sub_path2/file2' => [@paths[5]] }
+        end
+
+        it "should delete old files with same name but different 'suffix' when passed the limit" do
+          FileUtils.should_receive(:remove_entry).with(@paths[0])
+          FileUtils.should_receive(:remove_entry).with(@paths[1])
+          FileUtils.should_not_receive(:remove_entry).with(@paths[2])
+
+          BackupUtils.delete_files('/my_path', @ruby_clone_suffix, 1)
+        end
+
+      end
+
+      describe "invalid" do
+
+        it "should not delete files with path that doesn't exist" do
+          File.stub(:exists?).with(any_args()).and_return(false)
+          Find.should_not_receive(:find)
+
+          BackupUtils.delete_files('/my_path', @ruby_clone_suffix, 5)
+        end
+
+        it "should not delete files with same name but different 'suffix' when it didn't pass the limit" do
+          FileUtils.should_not_receive(:remove_entry)
+          BackupUtils.delete_files('/my_path', @ruby_clone_suffix, 5)
+        end
+
+        it "should not delete files with same name but different 'suffix' when the found files is on the limit" do
+          FileUtils.should_not_receive(:remove_entry)
+          BackupUtils.delete_files('/my_path', @ruby_clone_suffix, 3)
+        end
+
+      end
+
+    end
+
+  end
+end

data/spec/ruby_clone/dsl_spec.rb

@@ -0,0 +1,259 @@
+require 'spec_helper'
+
+module RubyClone
+
+  describe "DSL" do
+
+    before(:all) do
+      class DummyClass
+      end
+      DummyClass.extend RubyClone::DSL
+
+      @rsync_options = '-Cavh --stats --progress'
+      @rsync_command = "rsync #{@rsync_options}"
+      @folders = "/from_folder /to_folder"
+    end
+
+    before(:each) do
+      @rsync = DummyClass.rsync_new_instance
+    end
+
+    describe "Creating a Profile" do
+
+      describe "valid" do
+
+        it "should create the following command 'rsync -Cav --stats /from_folder /to_folder'" do
+          DummyClass.profile('backup1') do
+            DummyClass.from('/from_folder')
+            DummyClass.to('/to_folder')
+          end
+
+          @rsync.rsync_command('backup1').should == "#{@rsync_command} #{@folders}"
+        end
+
+      end
+
+      describe "invalid" do
+
+        it "should raise SyntaxError with message 'Empty Profile not allowed' for profile with no block" do
+          lambda do
+            DummyClass.profile('backup')
+          end.should raise_error(SyntaxError, 'Empty Profile not allowed')
+        end
+
+        it "should raise SyntaxError with message 'Empty Profile not allowed' for empty block" do
+          lambda do
+            DummyClass.profile('backup') { }
+          end.should raise_error(SyntaxError, 'Empty Profile not allowed')
+        end
+      end
+    end
+
+    describe "#config" do
+
+      it "should as default have a default configurations" do
+
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder')
+        end
+
+        @rsync.instance_eval { @configurations }.should == { options: @rsync_options, show_command: true, show_output: true }
+      end
+
+      it "should change the default configurations when the config has new values" do
+        DummyClass.config options: '-Cav', show_command: false, show_output: false
+
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder')
+        end
+
+        @rsync.instance_eval { @configurations }.should == { options: '-Cav', show_command: false, show_output: false }
+      end
+    end
+
+    describe "#from" do
+
+      it "should create exclude paths just for the profile 'backup1' if exclude DSL is not on the top" do
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder') do
+            DummyClass.exclude_pattern '/exclude_pattern1'
+          end
+          DummyClass.to('/to_folder')
+        end
+
+        DummyClass.profile('backup2') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder')
+        end
+
+        @rsync.rsync_command('backup1').should == "#{@rsync_command} --exclude=/exclude_pattern1 #{@folders}"
+        @rsync.rsync_command('backup2').should == "#{@rsync_command} #{@folders}"
+      end
+
+      it "should create include just for the profile 'backup1' if include_pattern DSL is set up only in the profile" do
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder') do
+            DummyClass.include_pattern '/include_pattern1'
+          end
+          DummyClass.to('/to_folder')
+        end
+
+        DummyClass.profile('backup2') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder')
+        end
+
+        @rsync.rsync_command('backup1').should == "#{@rsync_command} --include=/include_pattern1 #{@folders}"
+        @rsync.rsync_command('backup2').should == "#{@rsync_command} #{@folders}"
+      end
+
+      it "should have the following options '-e ssh user@server:/from_folder /to_folder' when is ssh" do
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder', ssh: "user@server")
+          DummyClass.to('/to_folder')
+        end
+
+        @rsync.rsync_command('backup1').should == "#{@rsync_command} -e ssh user@server:/from_folder /to_folder"
+      end
+    end
+
+    describe "#to" do
+
+      it "should have '--delete' when options 'delete' is set up" do
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder', delete: true)
+        end
+
+        @rsync.rsync_command('backup1').should == "#{@rsync_command} --delete #{@folders}"
+      end
+
+      it "should have '--delete-excluded' when options 'delete_excluded' is set up" do
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder', delete_excluded: true)
+        end
+
+        @rsync.rsync_command('backup1').should == "#{@rsync_command} --delete-excluded #{@folders}"
+      end
+    end
+
+    describe "#exclude" do
+
+      it "should create exclude paths for all profiles if exclude DSL is on the top" do
+        DummyClass.exclude_pattern '/exclude_top_path'
+
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder')
+        end
+
+        DummyClass.profile('backup2') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder')
+        end
+
+        @rsync.rsync_command('backup1').should == "#{@rsync_command} --exclude=/exclude_top_path #{@folders}"
+        @rsync.rsync_command('backup2').should == "#{@rsync_command} --exclude=/exclude_top_path #{@folders}"
+      end
+
+      it "should include the exclude path from the top and profile if exclude DSL are set up in the top and in profile" do
+        DummyClass.exclude_pattern 'exclude_top_path'
+
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder') do
+            DummyClass.exclude_pattern'/exclude_pattern1'
+          end
+          DummyClass.to('/to_folder')
+        end
+
+        DummyClass.profile('backup2') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder')
+        end
+
+        @rsync.rsync_command('backup1').should == "#{@rsync_command} --exclude=exclude_top_path --exclude=/exclude_pattern1 #{@folders}"
+        @rsync.rsync_command('backup2').should == "#{@rsync_command} --exclude=exclude_top_path #{@folders}"
+      end
+
+    end
+
+    describe "#include_pattern" do
+
+      it "should create include for all profiles if include_pattern DSL is on the top" do
+        DummyClass.include_pattern '/include_top_path'
+
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder')
+        end
+
+        DummyClass.profile('backup2') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder')
+        end
+
+        @rsync.rsync_command('backup1').should == "#{@rsync_command} --include=/include_top_path #{@folders}"
+        @rsync.rsync_command('backup2').should == "#{@rsync_command} --include=/include_top_path #{@folders}"
+      end
+
+      it "should create the include on the top and in profile if include_pattern DSL are set up in the top and in profile" do
+        DummyClass.include_pattern '/include_top_path'
+
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder') do
+            DummyClass.include_pattern '/include_pattern1'
+          end
+          DummyClass.to('/to_folder')
+        end
+
+        DummyClass.profile('backup2') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder')
+        end
+
+        @rsync.rsync_command('backup1').should == "#{@rsync_command} --include=/include_top_path --include=/include_pattern1 #{@folders}"
+        @rsync.rsync_command('backup2').should == "#{@rsync_command} --include=/include_top_path #{@folders}"
+      end
+
+    end
+
+    describe "#backup" do
+
+      it "should include the backup commands when the backup is set up" do
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder') do
+            DummyClass.backup('/backup_folder')
+          end
+        end
+
+        @rsync.rsync_command('backup1').should =~ /#{@rsync_command} -b --suffix=_rbcl_\d{8} --backup-dir=\/backup_folder #{@folders}/
+      end
+
+      it "should include the suffix when the option suffix: is set up" do
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder') do
+            DummyClass.backup('/backup_folder', suffix: '_my_suffix')
+          end
+        end
+
+        @rsync.rsync_command('backup1').should == "#{@rsync_command} -b --suffix=_rbcl_my_suffix --backup-dir=/backup_folder #{@folders}"
+      end
+
+      it "should not include any suffix if the option disable_suffix is true" do
+        DummyClass.profile('backup1') do
+          DummyClass.from('/from_folder')
+          DummyClass.to('/to_folder') do
+            DummyClass.backup('/backup_folder', suffix: '_my_suffix', disable_suffix: true)
+          end
+        end
+
+        @rsync.rsync_command('backup1').should == "#{@rsync_command} -b --backup-dir=/backup_folder #{@folders}"
+      end
+    end
+  end
+end

data/spec/ruby_clone/options_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'stringio'
+
+module RubyClone
+
+  describe Options do
+
+    before(:each) do
+      @output = StringIO.new
+      @options = Options.new(@output)
+    end
+
+    describe "Help messages" do
+
+      it "should show if ARGV is empty" do
+        opts = @options.parse([])
+        opts.on.to_s.should =~ /-h, --help\s+This message.*/
+      end
+
+      it "should show if ARGV have the option '-h'" do
+       @options.parse(%w[-h])
+
+        @output.seek 0
+        @output.read.should =~ /-h, --help\s+This message.*/
+      end
+
+      it "should not show if ARGV have another option that exists and is not '-h'" do
+        @options.parse(%w[-b /my_file])
+
+        @output.seek 0
+        @output.read.should_not =~ /-h, --help\s+This message.*/
+      end
+
+      it "should have the banner with message 'Usage: ruby_clone [options] profile'" do
+        opts = @options.parse([])
+        opts.banner.should == 'Usage: ruby_clone [options] profile'
+      end
+    end
+
+    describe "Backup file" do
+
+      it "should as default the backup file path be '~/.ruby_clone'" do
+        @options.parse(%w[backup_profile])
+        @options.configurations[:backup_file].should == '~/.ruby_clone'
+      end
+
+      it "should set a new backup file location with the options is '-b'" do
+        @options.parse(%w[-b /my_file backup_profile])
+        @options.configurations[:backup_file].should == '/my_file'
+      end
+    end
+
+    it "should set dry-run mode when the option is '-d'" do
+      @options.parse(%w[-d])
+      @options.configurations[:dry_run].should be_true
+    end
+
+  end
+
+end