rsync 0.0.2 → 0.0.3

data/README.md

@@ -8,9 +8,17 @@ Ruby/Rsync is a Ruby library that can syncronize files between remote hosts by w
 
 ## Usage
 
+Minimal example
+
+    require "rsync"
+
+    result = Rsync.run("/path/to/src", "/path/to/dest")
+
+Complete example
+
     require "rsync"
 
-    Rsync.command(["/path/to/source", "/path/to/destination"]) do |result|
+    Rsync.run("/path/to/src", "/path/to/dest") do |result|
       if result.success?
         result.changes.each do |change|
           puts "#{change.filename} (#{change.summary})"

data/lib/rsync.rb

@@ -5,12 +5,13 @@ require "rsync/result"
 # The main interface to rsync
 module Rsync
   # Creates and runs an rsync {Command} and return the {Result}
+  # @param source {String}
+  # @param destination {String}
+  # @param args {Array}
   # @return {Result}
   # @yield {Result}
-  def self.command(args, &block)
-    output = Command.new(args).run
-    exitcode = $?
-    result = Result.new(output, exitcode)
+  def self.run(source, destination, args = [], &block)
+    result = Command.run(source, destination, args)
     yield(result) if block_given?
     result
   end

data/lib/rsync/command.rb

@@ -1,20 +1,18 @@
 module Rsync
   # An rsync command to be run
   class Command
-    def initialize(args)
-      @args = args.join(" ")
-    end
-
     # Runs the rsync job and returns the results
     #
+    # @param args {Array}
     # @return {Result}
-    def run
-      run_command("rsync --itemize-changes #{@args}")
+    def self.run(*args)
+      output = run_command("rsync --itemize-changes #{args.join(" ")}")
+      Result.new(output, $?.exitstatus)
     end
 
 private
 
-    def run_command(cmd, &block)
+    def self.run_command(cmd, &block)
       if block_given?
         IO.popen("#{cmd} 2>&1", &block)
       else

data/lib/rsync/result.rb

@@ -10,15 +10,15 @@ module Rsync
     end
 
     # Whether the rsync job was run without errors.
-    # @return Boolean
+    # @return {Boolean}
     def success?
       @exitcode.to_i == 0
     end
 
     # The error message based on exit code.
-    # @return String
+    # @return {String}
     def error
-      case @exitcode.exitstatus
+      case @exitcode.to_i
         when 0 
           "Success"
         when 1
@@ -68,10 +68,16 @@ module Rsync
     #
     # @return {Array<Change>}
     def changes
+      change_list
+    end
+
+private
+
+    def change_list
       list = []
       @raw.split("\n").each do |line|
         #if line =~ /^([<>ch.*][fdLDS][ .+\?cstTpoguax]{9}) (.*)$/
-        if line =~ /^([<>ch.\*].{10}) (.*)$/
+        if line =~ /^([<>ch\.\*].{10}) (.*)$/
           detail = Change.new(line)
           list << detail if detail.changed?
         end

data/lib/rsync/version.rb

@@ -1,4 +1,4 @@
 module Rsync
   # Project version
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/rsync/command_spec.rb

@@ -0,0 +1,7 @@
+require 'rsync/command'
+
+describe Rsync::Command do
+  it "should work" do
+    Rsync::Command.run("/path/to/src/", "/path/to/dest", "-a").should be_kind_of(Rsync::Result)
+  end
+end

data/spec/rsync/result_spec.rb

@@ -0,0 +1,24 @@
+require 'rsync/result'
+
+describe Rsync::Result do
+  it "should handle basic example" do
+    result = Rsync::Result.new("", 0)
+    result.changes.should eql([])
+    result.error.should eql("Success")
+    result.success?.should eql(true)
+  end
+
+  it "should handle basic example with changes" do
+    result = Rsync::Result.new(">f......... filename\n", 0)
+    result.changes.length.should eql(1)
+    result.error.should eql("Success")
+    result.success?.should eql(true)
+  end
+
+  it "should handle syntax error" do
+    result = Rsync::Result.new("", 1)
+    result.changes.should eql([])
+    result.error.should eql("Syntax or usage error")
+    result.success?.should eql(false)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsync
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-07-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &7909780 !ruby/object:Gem::Requirement
+  requirement: &13436720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *7909780
+  version_requirements: *13436720
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &7909000 !ruby/object:Gem::Requirement
+  requirement: &13435920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7909000
+  version_requirements: *13435920
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &7908040 !ruby/object:Gem::Requirement
+  requirement: &13434940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7908040
+  version_requirements: *13434940
 description: 
 email:
 - jbussdieker@gmail.com
@@ -64,6 +64,8 @@ files:
 - lib/rsync/version.rb
 - rsync.gemspec
 - spec/rsync/change_spec.rb
+- spec/rsync/command_spec.rb
+- spec/rsync/result_spec.rb
 homepage: http://github.com/jbussdieker/ruby-rsync
 licenses:
 - MIT
@@ -92,4 +94,6 @@ summary: Ruby/Rsync is a Ruby library that can syncronize files between remote h
   by wrapping a call to the rsync binary.
 test_files:
 - spec/rsync/change_spec.rb
+- spec/rsync/command_spec.rb
+- spec/rsync/result_spec.rb
 has_rdoc: