rbrsync 0.0.4 → 0.0.5

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rbrsync.gemspec
 gemspec
+
+group :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    rbrsync (1.0.0)
-      open4 (= 1.3.0)
+    rbrsync (0.0.4)
+      posix-spawn (~> 0.3.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.2)
-    open4 (1.3.0)
+    posix-spawn (0.3.6)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
       rspec-expectations (~> 2.13.0)

data/lib/rbrsync/rbrsync.rb

@@ -1,4 +1,4 @@
-require 'open4'
+require 'posix-spawn'
 
 module RbRsync
   class RbRsync
@@ -9,7 +9,16 @@ module RbRsync
 
       self.from = from
       self.to = to
-      self.rsync = "rsync"
+    end
+
+    class << self
+      def rsync_binary
+        @rsync_binary ||=
+          ENV['PATH'].split(':').
+            map  { |p| File.join(p, 'rsync') }.
+            find { |p| File.exist?(p) }
+      end
+      attr_writer :rsync_binary
     end
 
 =begin
@@ -215,7 +224,6 @@ module RbRsync
       end
     end
 
-    attr_accessor :rsync # the path to rsync
     attr_accessor :from_host, :from_user, :from_path
     attr_accessor :to_host, :to_user, :to_path
 
@@ -233,20 +241,13 @@ module RbRsync
       Negator.new self
     end
 
-    # returns the rsync command that would be executed
-    def command
-      build_command.join ' '
-    end
-
     # perform the sync
     def go!
       raise ArgumentError.new("a source and destination must be specified") if to.nil? || from.nil?
 
-      status = Open4.popen4(command) do |pid, stdin, stdout, stderr|
-        puts stderr.read if stderr
-      end
-
+      POSIX::Spawn::Child.new(*build_command)
     end
+    alias_method :run!, :go!
 
     def self.boolean_methods
       @@boolean_methods
@@ -254,25 +255,49 @@ module RbRsync
 
   protected
     def build_command
-      cmd = ['rsync']
+      argv = []
+      argv << RbRsync.rsync_binary
+
+      argv.concat(options_to_argv(@options))
 
-      @options.each_pair do |flag, value|
-        next if value.nil?
+      argv << from
+      argv << to
 
-        if value.is_a? Array
-          value.each do |v|
-            cmd << "--#{flag}='#{v}'"
+      argv
+    end
+
+    # Transform a ruby-style options hash to command-line arguments sutiable for
+    # use with Kernel::exec. No shell escaping is performed.
+    #
+    # Returns an Array of String option arguments.
+    def options_to_argv(options)
+      argv = []
+      options.each do |key, val|
+        if key.to_s.size == 1
+          if val == true
+            argv << "-#{key}"
+          elsif val == false
+            # ignore
+          else
+            [val].flatten.each do |val|
+              argv << "-#{key}"
+              argv << "'#{shell_escape(val)}'"
+            end
           end
         else
-          cmd << "--#{flag}"
+          if val == true
+            argv << "--#{key.to_s.tr('_', '-')}"
+          elsif val == false
+            # ignore
+          else
+            [val].flatten.each do |val|
+              argv << "--#{key.to_s.tr('_', '-')}='#{shell_escape(val)}'"
+            end
+            
+          end
         end
       end
-      
-
-      cmd << from
-      cmd << to
-
-      cmd
+      argv
     end
 
     def build_path user, host, path
@@ -284,5 +309,9 @@ module RbRsync
         nil
       end
     end
+
+    def shell_escape(str)
+      str.to_s.gsub("'", "'\\\\''")
+    end
   end
 end

data/lib/rbrsync/version.rb

@@ -1,3 +1,3 @@
 module RbRsync
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/rbrsync.gemspec

@@ -17,5 +17,5 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_dependency 'open4', ['1.3.0']
+  s.add_dependency "posix-spawn", "~> 0.3.6"
 end

data/spec/fixtures/from/file-1.txt

@@ -0,0 +1 @@
+Some File

data/spec/fixtures/from/main/file-2.txt

@@ -0,0 +1,8 @@
+An alpaca (Vicugna pacos) is a domesticated species of South American camelid. It resembles a small llama in appearance.
+Alpacas are kept in herds that graze on the level heights of the Andes of southern Peru, northern Bolivia, Ecuador,
+ and northern Chile at an altitude of 3,500 m (11,500 ft) to 5,000 m (16,000 ft) above sea level, throughout the year.
+Alpacas are considerably smaller than llamas, and unlike llamas, they were not bred to be beasts of burden, but were
+ bred specifically for their fiber. Alpaca fiber is used for making knitted and woven items, similar to wool. These
+ items include blankets, sweaters, hats, gloves, scarves, a wide variety of textiles and ponchos in South America,
+ and sweaters, socks, coats and bedding in other parts of the world. The fiber comes in more than 52 natural colors
+ as classified in Peru, 12 as classified in Australia and 16 as classified in the United States.

data/spec/rbrsync_spec.rb

@@ -2,10 +2,27 @@ require 'spec_helper'
 require 'rbrsync'
 
 describe RbRsync do
+
+  before do
+    @fixtures = File.expand_path(File.join(File.dirname(__FILE__), "fixtures"))
+  end
+
   before :each do
     @rsync = RbRsync::RbRsync.new
   end
 
+  it "should find path to rsync binary" do
+    RbRsync::RbRsync.rsync_binary.should == `which rsync`.strip
+  end
+
+  it "should be able to set the path rsync binary" do
+    rsync_binary = RbRsync::RbRsync.rsync_binary
+    RbRsync::RbRsync.rsync_binary = '/test/git'
+    RbRsync::RbRsync.rsync_binary.should == '/test/git'
+    RbRsync::RbRsync.rsync_binary = rsync_binary
+    RbRsync::RbRsync.rsync_binary.should == rsync_binary
+  end
+
   it "should not have the archive flag set when archive! is not called" do
     @rsync.archive.should be_nil
   end
@@ -52,7 +69,7 @@ describe RbRsync do
     @rsync.archive.should be_true
     @rsync.fuzzy.should be_true
   end
-  
+
   it "should allow underscores as dashes" do
     @rsync.human_readable!
     @rsync.human_readable.should be_true
@@ -127,57 +144,64 @@ describe RbRsync do
   end
 
   describe "command method" do
-    def command_should_have_only command, from, to, *flags
+    def command_should_have_only from, to, *flags
+      argv = @rsync.send(:build_command)
+
       flags.each do |flag|
-        command.should include flag
+        argv.should include flag
       end
 
-      command.should =~ /^rsync/
-      command.should =~ %r{#{from} #{to}$}
-
-      command.gsub!(/^rsync/, '')
-      command.gsub!(%r{#{from} #{to}$}, '')
+      argv.shift.should eq(RbRsync::RbRsync.rsync_binary)
+      argv.pop.should eq(to)
+      argv.pop.should eq(from)
 
-      flags.each do |flag|
-        command.sub! flag, ''
+      argv = argv.drop_while do |a|
+        flags.include?(a) 
       end
 
-      # with all the flags, the rsync command and the source and destination values stripped, there shouldn't be anything else
-      command.strip.should == ""
+      # with all the flags, the rsync command and the source and destination values dropped, there shouldn't be anything else
+      argv.size.should eq(0)
     end
-    
+
     it "should set the --archive flag when archive! is used" do
       @rsync.archive!
       @rsync.from = "/home/me/"
       @rsync.to = "user@host.com:/home/user"
-      
-      @rsync.command.should == "rsync --archive /home/me/ user@host.com:/home/user"
+
+      command_should_have_only "/home/me/", "user@host.com:/home/user", "--archive"
     end
-    
+
     it "should set the --human-readable flag when human_readable! is used" do
       @rsync.human_readable!
       @rsync.from = "/home/me/"
       @rsync.to = "user@host.com:/home/user"
-      
-      @rsync.command.should == "rsync --human-readable /home/me/ user@host.com:/home/user"
+
+      command_should_have_only "/home/me/", "user@host.com:/home/user", "--human-readable"
     end
-    
+
     it "should set the --archive and --exclude flags when archive! and exclude= are used" do
       @rsync.archive!
       @rsync.exclude = "*~"
       @rsync.from = "/home/me/"
       @rsync.to = "user@host.com:/home/user"
 
-      command_should_have_only @rsync.command, "/home/me/", "user@host.com:/home/user", "--exclude='*~'", "--archive"
+      command_should_have_only "/home/me/", "user@host.com:/home/user", "--exclude='*~'", "--archive"
     end
     it "should set --exclude twice when exclude= is called with an array" do
       @rsync.exclude = ['*~', '/*']
       @rsync.from = "/home/me/"
       @rsync.to = "user@host.com:/home/user"
 
-      command_should_have_only @rsync.command, "/home/me/", "user@host.com:/home/user", "--exclude='*~'", "--exclude='/*'"
+      command_should_have_only "/home/me/", "user@host.com:/home/user", "--exclude='*~'", "--exclude='/*'"
+    end
+
+    it "should correctly escape argument values" do
+      @rsync.log_file = 'rsync.log'
+      @rsync.log_file_format = "'\\'%t '%f' with %b ''"
+      @rsync.from = "/home"
+      @rsync.to = "/home/user"
+      command_should_have_only "/home", "/home/user", "--log-file='rsync.log'", %q[--log-file-format=''\''\'\''%t '\''%f'\'' with %b '\'''\''']
     end
-    
   end
 
   describe "constructor" do
@@ -204,4 +228,28 @@ describe RbRsync do
       @rsync.send(:build_command).should include "--archive"
     end
   end
+
+  describe 'shell_escape' do
+    it "should escape ' and ;" do
+      @rsync.send(:shell_escape, "'some \\'quoted 'string 'with a ''").should == %q['\''some \'\''quoted '\''string '\''with a '\'''\'']
+    end
+  end
+
+  describe "go!" do
+    it "should match rsync output" do
+      @rsync.from = File.join(@fixtures, "from")
+      @rsync.to = File.join(@fixtures, "to")
+      @rsync.recursive!
+      @rsync.verbose!
+      process = @rsync.go!
+
+      process.status.success?.should be_true
+      process.out.should match(/total size is .*  speedup is .*/)
+    end
+  end
+  
+  after do
+    # Cleanup
+    system "rm -rf #{File.join(@fixtures, 'to', '*')}"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbrsync
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,27 +13,26 @@ cert_chain: []
 date: 2013-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: open4
+  name: posix-spawn
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 0.3.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 0.3.6
 description: A thin Ruby wrapper around rsync
 email:
 - caleb.land@gmail.com
 - koen@fetch.nl
-executables:
-- rbrsync
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -47,16 +46,18 @@ files:
 - README.md
 - README.rdoc
 - Rakefile
-- bin/rbrsync
 - lib/rbrsync.rb
 - lib/rbrsync/negator.rb
 - lib/rbrsync/option.rb
 - lib/rbrsync/rbrsync.rb
 - lib/rbrsync/version.rb
 - rbrsync.gemspec
+- spec/fixtures/from/file-1.txt
+- spec/fixtures/from/main/alpaca.jpg
+- spec/fixtures/from/main/file-2.txt
+- spec/fixtures/to/.gitkeep
 - spec/rbrsync_spec.rb
 - spec/spec_helper.rb
-- test/test_rbsync.rb
 homepage: http://www.github.com/koenpunt/rbrsync
 licenses: []
 post_install_message: 
@@ -82,6 +83,9 @@ signing_key:
 specification_version: 3
 summary: A thin Ruby wrapper around rsync
 test_files:
+- spec/fixtures/from/file-1.txt
+- spec/fixtures/from/main/alpaca.jpg
+- spec/fixtures/from/main/file-2.txt
+- spec/fixtures/to/.gitkeep
 - spec/rbrsync_spec.rb
 - spec/spec_helper.rb
-- test/test_rbsync.rb

data/bin/rbrsync

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-
-require File.expand_path(
-    File.join(File.dirname(__FILE__), %w[.. lib rbsync]))
-
-# Put your code here