ruby_clone 1.0.0

data/spec/ruby_clone/profile_spec.rb

@@ -0,0 +1,222 @@
+require 'spec_helper'
+
+module RubyClone
+
+  describe FromFolder do
+
+    describe "#ssh?" do
+
+      it "should return true if it has the option ssh set up" do
+        from_folder = FromFolder.new('/from_folder', ssh: 'user@server')
+        from_folder.ssh?.should be_true
+      end
+
+      it "should return false if it doesn't have the option ssh set up" do
+        from_folder = FromFolder.new('/from_folder')
+        from_folder.ssh?.should be_false
+      end
+    end
+
+    describe "#to_command" do
+
+      it "should as default return empty string" do
+        from_folder = FromFolder.new('/from_folder')
+        from_folder.to_command.should be_empty
+      end
+
+      it "should return '--exclude=/exclude_path1 --exclude=/exclude_path2' when exclude_paths are added" do
+        from_folder = FromFolder.new('/from_folder')
+        from_folder.exclude_pattern = '/exclude_pattern1'
+        from_folder.exclude_pattern = '/exclude_pattern2'
+
+        from_folder.to_command.should == '--exclude=/exclude_pattern1 --exclude=/exclude_pattern2'
+      end
+
+      it "should return '--include=/include_path1 --include=/include_path2' when include_paths are added" do
+        from_folder = FromFolder.new('/from_folder')
+        from_folder.include_pattern = '/include_pattern1'
+        from_folder.include_pattern = '/include_pattern2'
+
+        from_folder.to_command.should == '--include=/include_pattern1 --include=/include_pattern2'
+      end
+
+      it "should have --include before --exclude" do
+        from_folder = FromFolder.new('/from_folder')
+        from_folder.include_pattern = '/include_pattern'
+        from_folder.exclude_pattern = '/exclude_pattern'
+
+        from_folder.to_command.should == '--include=/include_pattern --exclude=/exclude_pattern'
+      end
+    end
+
+    describe "#to_s" do
+
+      it "should return just the path name if ssh is not set up" do
+        from_folder = FromFolder.new('/from_folder')
+        from_folder.to_s.should == '/from_folder'
+      end
+
+      it "should return just the path name if ssh is set up" do
+        from_folder = FromFolder.new('/from_folder', ssh: 'user@server')
+        from_folder.to_s.should == 'user@server:/from_folder'
+      end
+    end
+  end
+
+  describe ToFolder do
+
+    describe "#delete_files" do
+
+      it "should call BackupUtils#delete_files if @backup exist" do
+        backup = double(:backup_backup)
+        backup.should_receive(:delete_files)
+
+        to_folder = ToFolder.new('/to_folder/')
+        to_folder.instance_eval { @backup = backup }
+
+        to_folder.delete_files
+      end
+
+      it "should not call BackupUtils#delete_files if @backup doesn't exist" do
+        backup = double(:backup_backup)
+        backup.should_not_receive(:delete_files)
+
+        to_folder = ToFolder.new('/to_folder/')
+        to_folder.delete_files
+      end
+
+    end
+
+    describe "#ssh?" do
+
+      it "should return true if it has the option ssh set up" do
+        to_folder = ToFolder.new('/to_folder', ssh: 'user@server')
+        to_folder.ssh?.should be_true
+      end
+
+      it "should return false if it doesn't have the option ssh set up" do
+        to_folder = ToFolder.new('/to_folder')
+        to_folder.ssh?.should be_false
+      end
+    end
+
+    describe "#to_command" do
+
+      it "should as default return empty string" do
+        to_folder = ToFolder.new('/to_folder/')
+        to_folder.to_command.should be_empty
+      end
+
+      it "should return '--delete' when the options delete is true" do
+        to_folder = ToFolder.new('/to_folder/', delete: true)
+        to_folder.to_command.should == "--delete"
+      end
+
+      it "should return '--delete-excluded' when the options delete_excluded is true" do
+        to_folder = ToFolder.new('/to_folder/', delete_excluded: true)
+        to_folder.to_command.should == "--delete-excluded"
+      end
+
+      describe "Backup association" do
+
+        it "should call the backup#to_command when it's associated" do
+          to_folder = ToFolder.new('/to_folder/', delete: true)
+
+          backup = double(:backup)
+          to_folder.backup = backup
+
+          backup.should_receive(:to_command).and_return('backup called')
+          to_folder.to_command
+        end
+
+      end
+    end
+
+    describe "#to_s" do
+
+      it "should return just the path name if ssh is not set up" do
+        to_folder = ToFolder.new('/to_folder')
+        to_folder.to_s.should == '/to_folder'
+      end
+
+      it "should return just the path name if ssh is set up" do
+        to_folder = ToFolder.new('/to_folder', ssh: 'user@server')
+        to_folder.to_s.should == 'user@server:/to_folder'
+      end
+    end
+  end
+
+  describe Backup do
+
+    describe "options" do
+
+      it "should have an empty suffix" do
+        backup = Backup.new("/backup")
+        backup.instance_eval { @options[:suffix] }.should be_false
+      end
+
+      it "should have disable_suffix as false" do
+        backup = Backup.new("/backup")
+        backup.instance_eval { @options[:disable_suffix] }.should be_false
+      end
+
+      it "should have 5 as limit" do
+        backup = Backup.new("/backup")
+        backup.instance_eval { @options[:limit] }.should == 5
+      end
+
+      it "should keep the defaults value with only one options is changed " do
+        backup = Backup.new("/backup", suffix: "_my_suffix")
+
+        options = backup.instance_eval { @options }
+        options[:disable_suffix].should be_false
+        options[:limit].should == 5
+        options[:suffix].should == '_my_suffix'
+      end
+    end
+
+    describe "#delete_files" do
+
+      it "should call BackupUtils#delete_files" do
+        BackupUtils.should_receive(:delete_files).with('/backup', "_rbcl", 5)
+
+        backup = Backup.new("/backup")
+        backup.delete_files
+      end
+
+      it "should call with 10 as limit if limit is set up with 10" do
+        BackupUtils.should_receive(:delete_files).with('/backup', "_rbcl", 10)
+
+        backup = Backup.new("/backup", limit: 10)
+        backup.delete_files
+      end
+
+      it "should not call it if the limit options is :unlimited " do
+        BackupUtils.should_not_receive(:delete_files)
+
+        backup = Backup.new("/backup", limit: :unlimited)
+        backup.delete_files
+      end
+    end
+
+    describe "#to_command" do
+
+      it "should as default create the command '-b --suffix=rbcl_Date --backup-dir=/backup' with the ruby_clone suffix and the Date" do
+        backup = Backup.new("/backup")
+        backup.instance_eval { @time = '20120923'}
+        backup.to_command.should == "-b --suffix=_rbcl_20120923 --backup-dir=/backup"
+      end
+
+      it "should not override the default ruby_clone suffix when using suffix option" do
+        backup = Backup.new("/backup", suffix: "_my_suffix")
+        backup.to_command.should == "-b --suffix=_rbcl_my_suffix --backup-dir=/backup"
+      end
+
+      it "should not create any suffix if the disable_suffix is true" do
+        backup = Backup.new("/backup", suffix: "_my_suffix", disable_suffix: true)
+        backup.to_command.should == "-b --backup-dir=/backup"
+      end
+    end
+
+  end
+end

data/spec/ruby_clone/rsync_spec.rb

@@ -0,0 +1,309 @@
+require 'spec_helper'
+require 'stringio'
+
+class FakerPTY
+  class << self
+      attr_accessor :r, :w, :pid
+
+      def spawn(command, &block)
+        block.call @r, @w, @pid
+      end
+    end
+end
+
+module RubyClone
+
+  describe RSync do
+
+    before(:each) do
+      @from_folder = FromFolder.new "/from_folder"
+      @to_folder = ToFolder.new "/to_folder"
+
+      @profile = Profile.new 'test_profile'
+      @profile.from_folder = @from_folder
+      @profile.to_folder = @to_folder
+
+      @output = StringIO.new
+      @rsync = RSync.new(@output)
+      @rsync.profiles = @profile
+
+      @rsync_options = '-Cavh --stats --progress'
+      @rsync_command = "rsync #{@rsync_options}"
+      @folders = "/from_folder /to_folder"
+    end
+
+    describe "#configurations" do
+
+      it "should as default have '-Cav --stats' in options" do
+        @rsync.instance_eval { @configurations[:options] }.should == "#{@rsync_options}"
+      end
+
+      it "should as default have 'true' in show_command" do
+        @rsync.instance_eval { @configurations[:show_command] }.should be_true
+      end
+
+      it "should as default have 'true' in show_output" do
+        @rsync.instance_eval { @configurations[:show_output] }.should be_true
+      end
+    end
+
+    describe "#rsync_command" do
+
+      describe "profile invalid" do
+
+        it "should raise ArgumentError when trying to run a profile that doesn't exist" do
+          lambda do
+            @rsync.run 'my_profile'
+          end.should raise_error(ArgumentError, "Profile my_profile not found")
+        end
+
+        it "should raise SyntaxError with message 'Empty Profile not allowed for profile no_from_folder with no 'from folder''" do
+          lambda do
+            profile = Profile.new 'no_from_folder'
+            profile.to_folder = @to_folder
+            @rsync.profiles = profile
+
+            @rsync.run 'no_from_folder'
+          end.should raise_error(SyntaxError, "Empty Profile not allowed for profile no_from_folder with no 'from folder'")
+        end
+
+        it "should raise SyntaxError with message 'Empty Profile not allowed for profile no_to_folder with no 'to folder''" do
+          lambda do
+            profile = Profile.new 'no_to_folder'
+            profile.from_folder = @from_folder
+            @rsync.profiles = profile
+
+            @rsync.run 'no_to_folder'
+          end.should raise_error(SyntaxError, "Empty Profile not allowed for profile no_to_folder with no 'to folder'")
+        end
+      end
+
+      it "should as default create the command 'rsync -Cav --stats /from_folder /to_folder'" do
+        command = @rsync.rsync_command "test_profile"
+        command.should == "#{@rsync_command} #{@folders}"
+      end
+
+      describe "appending commands" do
+
+        it "should create with '--exclude=/exclude_path1 --exclude=/exclude_path2' options when set up the excluded path" do
+          @rsync.exclude_pattern = '/exclude_pattern1'
+          @rsync.exclude_pattern = '/exclude_pattern2'
+
+          command = @rsync.rsync_command "test_profile"
+          command.should == "#{@rsync_command} --exclude=/exclude_pattern1 --exclude=/exclude_pattern2 #{@folders}"
+        end
+
+        it "should create with '--include' when set up the include pattern" do
+          @rsync.include_pattern = '/include_pattern1'
+          @rsync.include_pattern = '/include_pattern2'
+
+          command = @rsync.rsync_command "test_profile"
+          command.should == "#{@rsync_command} --include=/include_pattern1 --include=/include_pattern2 #{@folders}"
+        end
+
+        it "should have --include before the --exclude" do
+          @rsync.exclude_pattern = '/exclude_pattern'
+          @rsync.include_pattern = '/include_pattern'
+
+          command = @rsync.rsync_command "test_profile"
+          command.should == "#{@rsync_command} --include=/include_pattern --exclude=/exclude_pattern #{@folders}"
+        end
+
+        describe "FromFolder association" do
+
+          it "should appends the commands from 'from_folder#to_commands'" do
+            @rsync.exclude_pattern = '/exclude_pattern1'
+            @rsync.exclude_pattern = '/exclude_pattern2'
+
+            from_folder = double(:from_folder).as_null_object
+            from_folder.stub(:ssh?).and_return false
+            from_folder.stub(:to_s).and_return '/from_folder'
+            from_folder.should_receive(:to_command).and_return('from_folder#to_command')
+
+            @profile.from_folder = from_folder
+
+            command = @rsync.rsync_command "test_profile"
+            command.should == "#{@rsync_command} --exclude=/exclude_pattern1 --exclude=/exclude_pattern2 from_folder#to_command #{@folders}"
+          end
+        end
+
+        describe "ToFolder association" do
+
+          it "should call to_folder#to_commands" do
+            @rsync.exclude_pattern = '/exclude_pattern1'
+            @rsync.exclude_pattern = '/exclude_pattern2'
+
+            to_folder = double(:to_folder).as_null_object
+            to_folder.stub(:ssh?).and_return false
+            to_folder.stub(:to_s).and_return '/to_folder'
+            to_folder.should_receive(:to_command).and_return('to_folder#to_command')
+
+            @profile.to_folder = to_folder
+
+            command = @rsync.rsync_command "test_profile"
+            command.should == "#{@rsync_command} --exclude=/exclude_pattern1 --exclude=/exclude_pattern2 to_folder#to_command #{@folders}"
+          end
+
+        end
+      end
+
+      describe "using ssh" do
+
+        it "should have the ssh in the rsync command when FromFolder is using ssh" do
+          from_folder = FromFolder.new "/from_folder", ssh: "user@server"
+          @profile.from_folder = from_folder
+
+          command = @rsync.rsync_command "test_profile"
+          command.should == "#{@rsync_command} -e ssh user@server:/from_folder /to_folder"
+        end
+
+        it "should have the ssh in the rsync command when ToFolder is using ssh" do
+          to_folder = ToFolder.new "/to_folder", ssh: "user@server"
+          @profile.to_folder = to_folder
+
+          command = @rsync.rsync_command "test_profile"
+          command.should == "#{@rsync_command} -e ssh /from_folder user@server:/to_folder"
+        end
+
+        it "should raise SyntaxError if the source and destination is ssh" do
+          lambda do
+            from_folder = FromFolder.new "/from_folder", ssh: "user@server"
+            @profile.from_folder = from_folder
+
+            to_folder = ToFolder.new "/to_folder", ssh: "user@server"
+            @profile.to_folder = to_folder
+
+            @rsync.rsync_command "test_profile"
+          end.should raise_error(SyntaxError, 'The source and destination cannot both be remote.')
+        end
+      end
+    end
+
+    describe "#last_profile" do
+
+      it "should return the last profile added" do
+        @rsync.last_profile.should == @profile
+
+        other_profile = Profile.new 'other_profile'
+
+        @rsync.profiles = other_profile
+        @rsync.last_profile.should == other_profile
+      end
+    end
+
+    describe "#run" do
+
+
+      before(:each) do
+        @rsync.instance_eval { @pty = FakerPTY }
+
+        FakerPTY.methods(false).grep(/(.*)=$/) do
+          double_object = double($1)
+          FakerPTY.send "#{$1}=", double_object
+        end
+
+        FakerPTY.r.stub(:each).and_yield(nil)
+      end
+
+      describe "profile of string type" do
+
+        before(:each) do
+          profile = Profile.new 'profile_string'
+          profile.from_folder = @from_folder
+          profile.to_folder = @to_folder
+
+          @rsync.profiles = profile
+        end
+
+        it "should run using profile as string" do
+          @rsync.run 'profile_string'
+        end
+
+        it "should run using profile as symbol" do
+          @rsync.run :profile_string
+        end
+      end
+
+      describe "profile of symbol type" do
+
+        before(:each) do
+          profile = Profile.new :profile_symbol
+          profile.from_folder = @from_folder
+          profile.to_folder = @to_folder
+
+          @rsync.profiles = profile
+        end
+
+        it "should run using profile as string" do
+          @rsync.run 'profile_symbol'
+        end
+
+        it "should run using profile as symbol" do
+          @rsync.run :profile_symbol
+        end
+
+      end
+
+      describe "changing configurations" do
+
+        it "should change the rsync options when configurations has 'optionas' as '-a'" do
+          @rsync.update_configurations options: "-a"
+          @rsync.run 'test_profile'
+
+          @output.seek 0
+          @output.read.should == "\nrsync -a #{@folders}\n\n"
+        end
+
+        it "should as default show the rsync command in console" do
+          @rsync.run 'test_profile'
+
+          @output.seek 0
+          @output.read.should == "\n#{@rsync_command} #{@folders}\n\n"
+        end
+
+        it "should not print the rsync command in console when configurations has 'show_command' as false" do
+          @rsync.update_configurations show_command: false
+          @rsync.run 'test_profile'
+
+          @output.seek 0
+          @output.read.should == ""
+        end
+
+        it "should as default output the rsync results in console" do
+          FakerPTY.r.should_receive(:each)
+
+          @rsync.run 'test_profile'
+
+          @output.seek 0
+          @output.read.should == "\n#{@rsync_command} #{@folders}\n\n"
+        end
+
+        it "should not output the rsync results in console when configurations has 'show_output' as false" do
+          FakerPTY.r.should_not_receive(:each)
+
+          @rsync.update_configurations show_output: false
+          @rsync.run 'test_profile'
+
+          @output.seek 0
+          @output.read.should == "\n#{@rsync_command} #{@folders}\n\n"
+        end
+      end
+
+      it "should not run when it's in dry-run mode" do
+        @rsync.dry_run = true
+
+        @rsync.run 'test_profile'
+
+        @output.seek 0
+        @output.read.should == "\n#{@rsync_command} -n #{@folders}\n\n"
+      end
+
+      it "should call profile#to_folder#delete_files" do
+        @to_folder.should_receive(:delete_files)
+
+        @rsync.run 'test_profile'
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'ruby_clone'

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: ruby_clone
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Frederico Benevides
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70295966492060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: *70295966492060
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70295966491280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: *70295966491280
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70295966490740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: *70295966490740
+description: Ruby clone is a command line tool to work with Rsync using DSL!
+email:
+- fredbene@gmail.com
+executables:
+- ruby_clone
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ruby_clone
+- lib/ruby_clone.rb
+- lib/ruby_clone/backup_utils.rb
+- lib/ruby_clone/dsl.rb
+- lib/ruby_clone/options.rb
+- lib/ruby_clone/profile.rb
+- lib/ruby_clone/rsync.rb
+- lib/ruby_clone/version.rb
+- ruby_clone.gemspec
+- spec/ruby_clone/backup_utils_spec.rb
+- spec/ruby_clone/dsl_spec.rb
+- spec/ruby_clone/options_spec.rb
+- spec/ruby_clone/profile_spec.rb
+- spec/ruby_clone/rsync_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/fredericobenevides/ruby_clone
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Ruby_clone is high level script of Rsync. Use Ruby DSL to work with RSync!
+test_files:
+- spec/ruby_clone/backup_utils_spec.rb
+- spec/ruby_clone/dsl_spec.rb
+- spec/ruby_clone/options_spec.rb
+- spec/ruby_clone/profile_spec.rb
+- spec/ruby_clone/rsync_spec.rb
+- spec/spec_helper.rb