rsync 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,8 @@
 # Rsync
 
 [![Build Status](https://travis-ci.org/jbussdieker/ruby-rsync.png?branch=master)](https://travis-ci.org/jbussdieker/ruby-rsync)
+[![Code Climate](https://codeclimate.com/github/jbussdieker/ruby-rsync.png)](https://codeclimate.com/github/jbussdieker/ruby-rsync)
+[![Gem Version](https://badge.fury.io/rb/rsync.png)](http://badge.fury.io/rb/rsync)
 
 Ruby/Rsync is a Ruby library that can syncronize files between remote hosts by wrapping a call to the rsync binary.
 

data/lib/rsync.rb

@@ -2,8 +2,12 @@ require "rsync/version"
 require "rsync/command"
 require "rsync/result"
 
+# The main interface to rsync
 module Rsync
-  def self.command(args = [], &block)
+  # Creates and runs an rsync {Command} and return the {Result}
+  # @return {Result}
+  # @yield {Result}
+  def self.command(args, &block)
     output = Command.new(args).run
     exitcode = $?
     result = Result.new(output, exitcode)

data/lib/rsync/change.rb

@@ -1,146 +1,185 @@
 module Rsync
+  # Provides details about changes made to a specific file.
+  #
+  # Change Flags:
+  #
+  #  :no_change
+  #  :identical
+  #  :new
+  #  :unknown
+  #  :changed
   class Change
-    include Enumerable
-
-    def initialize(raw)
-      @raw = raw
+    def initialize(data)
+      @data = data
     end
 
-    def each(&block)
-      @raw.split("\n").each do |line|
-        #if line =~ /^([<>ch.*][fdLDS][ .+\?cstTpoguax]{9}) (.*)$/
-        if line =~ /^([<>ch.\*].{10}) (.*)$/
-          detail = Detail.new(line)
-          yield(detail) if detail.changed?
-        end
-      end
+    # The filename associated with this change.
+    # @return [String]
+    def filename
+      @data[12..-1]
     end
 
-    class Detail
-      def initialize(raw)
-        @raw = raw
-      end
-
-      def filename
-        @raw[12..-1]
+    # Whether the file was changed or not.
+    # @return [Boolean]
+    def changed?
+      if update_type == :message
+        return true
+      elsif update_type == :recv
+        return true
       end
+      false
+    end
 
-      def changed?
-        if update_type == :message
-          return true
-        elsif update_type == :recv
-          return true
+    # Simple description of the change.
+    # @return [String]
+    def summary
+      if update_type == :message
+        message
+      elsif update_type == :recv and @data[2,9] == "+++++++++"
+        "creating"
+      elsif update_type == :recv
+        "updating"
+      else
+        changes = []
+        #[:checksum, :size, :timestamp, :permissions, :owner, :group, :acl].each do |prop|
+        [:checksum, :size, :permissions, :owner, :group, :acl].each do |prop|
+          changes << prop if send(prop) == :changed
         end
-        false
+        changes.join(", ")
       end
+    end
 
-      def summary
-        if update_type == :message
-          message
-        elsif update_type == :recv and @raw[2,9] == "+++++++++"
-          "creating"
-        elsif update_type == :recv
-          "updating"
-        else
-          changes = []
-          #[:checksum, :size, :timestamp, :permissions, :owner, :group, :acl].each do |prop|
-          [:checksum, :size, :permissions, :owner, :group, :acl].each do |prop|
-            changes << prop if send(prop) == :changed
-          end
-          changes.join(", ")
-        end
-      end
+    # @!group Change Flags
 
-      def message
-        @raw[1..10].strip
-      end
+    # The change, if any, to the checksum of the file.
+    # @return [Symbol]
+    def checksum
+      attribute_prop(2)
+    end
 
-      def raw_update_type
-        @raw[0,1]
-      end
+    # The change, if any, to the size of the file.
+    # @return [Symbol]
+    def size
+      attribute_prop(3)
+    end
 
-      def raw_file_type
-        @raw[1,1]
-      end
+    # The change, if any, to the timestamp of the file.
+    # @return [Symbol]
+    def timestamp
+      attribute_prop(4)
+    end
 
-      def attribute_prop(index)
-        case @raw[index,1]
-          when '.'
-            :no_change
-          when ' '
-            :identical
-          when '+'
-            :new
-          when '?'
-            :unknown
-          else
-            :changed
-        end
-      end
+    # The change, if any, to the file permissions.
+    # @return [Symbol]
+    def permissions
+      attribute_prop(5)
+    end
 
-      def checksum
-        attribute_prop(2)
-      end
+    # The change, if any, to the owner of the file.
+    # @return [Symbol]
+    def owner
+      attribute_prop(6)
+    end
 
-      def size
-        attribute_prop(3)
-      end
+    # The change, if any, to the group of the file.
+    # @return [Symbol]
+    def group
+      attribute_prop(7)
+    end
 
-      def timestamp
-        attribute_prop(4)
-      end
+    # The change, if any, to the file ACL.
+    # @return [Symbol]
+    def acl
+      attribute_prop(9)
+    end
 
-      def permissions
-        attribute_prop(5)
-      end
+    # The change, if any, to the file's extended attributes.
+    # @return [Symbol]
+    def ext_attr
+      attribute_prop(10)
+    end
 
-      def owner
-        attribute_prop(6)
+    # @!endgroup
+
+    # The type of update made to the file.
+    #
+    #  :sent
+    #  :recv
+    #  :change
+    #  :hard_link
+    #  :no_update
+    #  :message
+    #
+    # @return [Symbol]
+    def update_type
+      case raw_update_type
+        when '<'
+          :sent
+        when '>'
+          :recv
+        when 'c'
+          :change
+        when 'h'
+          :hard_link
+        when '.'
+          :no_update
+        when '*'
+          :message
       end
+    end
 
-      def group
-        attribute_prop(7)
+    # The type of file.
+    #
+    #  :file
+    #  :directory
+    #  :symlink
+    #  :device
+    #  :special
+    #
+    # @return [Symbol]
+    def file_type
+      case raw_file_type
+        when 'f'
+          :file
+        when 'd'
+          :directory
+        when 'L'
+          :symlink
+        when 'D'
+          :device
+        when 'S'
+          :special
       end
+    end
 
-      def acl
-        attribute_prop(9)
-      end
+private
 
-      def ext_attr
-        attribute_prop(10)
-      end
+    def message
+      @data[1..10].strip
+    end
 
-      def update_type
-        case raw_update_type
-          when '<'
-            :sent
-          when '>'
-            :recv
-          when 'c'
-            :change
-          when 'h'
-            :hard_link
-          when '.'
-            :no_update
-          when '*'
-            :message
-        end
-      end
+    def raw_update_type
+      @data[0,1]
+    end
 
-      def file_type
-        case raw_file_type
-          when 'f'
-            :file
-          when 'd'
-            :directory
-          when 'L'
-            :symlink
-          when 'D'
-            :device
-          when 'S'
-            :special
-        end
+    def raw_file_type
+      @data[1,1]
+    end
+
+    def attribute_prop(index)
+      case @data[index,1]
+        when '.'
+          :no_change
+        when ' '
+          :identical
+        when '+'
+          :new
+        when '?'
+          :unknown
+        else
+          :changed
       end
     end
+
   end
 end

data/lib/rsync/command.rb

@@ -1,13 +1,19 @@
 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
+    #
+    # @return {Result}
     def run
       run_command("rsync --itemize-changes #{@args}")
     end
 
+private
+
     def run_command(cmd, &block)
       if block_given?
         IO.popen("#{cmd} 2>&1", &block)

data/lib/rsync/result.rb

@@ -1,16 +1,22 @@
 require 'rsync/change'
 
 module Rsync
+  # The result of a sync.
   class Result
+    # @!visibility private
     def initialize(raw, exitcode)
       @raw = raw
       @exitcode = exitcode
     end
 
+    # Whether the rsync job was run without errors.
+    # @return Boolean
     def success?
       @exitcode.to_i == 0
     end
 
+    # The error message based on exit code.
+    # @return String
     def error
       case @exitcode.exitstatus
         when 0 
@@ -58,8 +64,19 @@ module Rsync
       end
     end
 
+    # List of changes made during this run.
+    #
+    # @return {Array<Change>}
     def changes
-      Change.new(@raw)
+      list = []
+      @raw.split("\n").each do |line|
+        #if line =~ /^([<>ch.*][fdLDS][ .+\?cstTpoguax]{9}) (.*)$/
+        if line =~ /^([<>ch.\*].{10}) (.*)$/
+          detail = Change.new(line)
+          list << detail if detail.changed?
+        end
+      end
+      list
     end
   end
 end

data/lib/rsync/version.rb

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

data/spec/rsync/change_spec.rb

@@ -1,42 +1,36 @@
 require 'rsync/change'
 
 describe Rsync::Change do
-  it "should handle example" do
-    Rsync::Change.new(".f          blah2.txt")
-  end
-end
-
-describe Rsync::Change::Detail do
   it "should handle filename" do
-    Rsync::Change::Detail.new("            filename").filename.should eql("filename")
+    Rsync::Change.new("            filename").filename.should eql("filename")
   end
 
   it "should handle message type" do
-    Rsync::Change::Detail.new("*deleting  ").message.should eql("deleting")
+    Rsync::Change.new("*deleting  ").summary.should eql("deleting")
   end
 
   it "should handle update types" do
-    Rsync::Change::Detail.new("<          ").update_type.should eql(:sent)
-    Rsync::Change::Detail.new(">          ").update_type.should eql(:recv)
-    Rsync::Change::Detail.new("c          ").update_type.should eql(:change)
-    Rsync::Change::Detail.new("h          ").update_type.should eql(:hard_link)
-    Rsync::Change::Detail.new(".          ").update_type.should eql(:no_update)
-    Rsync::Change::Detail.new("*          ").update_type.should eql(:message)
+    Rsync::Change.new("<          ").update_type.should eql(:sent)
+    Rsync::Change.new(">          ").update_type.should eql(:recv)
+    Rsync::Change.new("c          ").update_type.should eql(:change)
+    Rsync::Change.new("h          ").update_type.should eql(:hard_link)
+    Rsync::Change.new(".          ").update_type.should eql(:no_update)
+    Rsync::Change.new("*          ").update_type.should eql(:message)
   end
 
   it "should handle file types" do
-    Rsync::Change::Detail.new(" f         ").file_type.should eql(:file)
-    Rsync::Change::Detail.new(" d         ").file_type.should eql(:directory)
-    Rsync::Change::Detail.new(" L         ").file_type.should eql(:symlink)
-    Rsync::Change::Detail.new(" D         ").file_type.should eql(:device)
-    Rsync::Change::Detail.new(" S         ").file_type.should eql(:special)
+    Rsync::Change.new(" f         ").file_type.should eql(:file)
+    Rsync::Change.new(" d         ").file_type.should eql(:directory)
+    Rsync::Change.new(" L         ").file_type.should eql(:symlink)
+    Rsync::Change.new(" D         ").file_type.should eql(:device)
+    Rsync::Change.new(" S         ").file_type.should eql(:special)
   end
 
   it "should handle checksum info" do
-    Rsync::Change::Detail.new("  c        ").checksum.should eql(:changed)
-    Rsync::Change::Detail.new("  .        ").checksum.should eql(:no_change)
-    Rsync::Change::Detail.new("           ").checksum.should eql(:identical)
-    Rsync::Change::Detail.new("  +        ").checksum.should eql(:new)
-    Rsync::Change::Detail.new("  ?        ").checksum.should eql(:unknown)
+    Rsync::Change.new("  c        ").checksum.should eql(:changed)
+    Rsync::Change.new("  .        ").checksum.should eql(:no_change)
+    Rsync::Change.new("           ").checksum.should eql(:identical)
+    Rsync::Change.new("  +        ").checksum.should eql(:new)
+    Rsync::Change.new("  ?        ").checksum.should eql(:unknown)
   end
 end

metadata

@@ -1,75 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rsync
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.0.2
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Joshua Bussdieker
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-07-23 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-07-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &7909780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *7909780
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &7909000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *7909000
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &7908040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *7908040
 description: 
-email: 
+email:
 - jbussdieker@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -84,37 +65,31 @@ files:
 - rsync.gemspec
 - spec/rsync/change_spec.rb
 homepage: http://github.com/jbussdieker/ruby-rsync
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: Ruby/Rsync is a Ruby library that can syncronize files between remote hosts by wrapping a call to the rsync binary.
-test_files: 
+summary: Ruby/Rsync is a Ruby library that can syncronize files between remote hosts
+  by wrapping a call to the rsync binary.
+test_files:
 - spec/rsync/change_spec.rb
+has_rdoc: