guard-remote-sync 0.0.2 → 0.0.3

data/README.md

@@ -1,12 +1,35 @@
-guard-remote-sync
-============
+#Guard::RemoteSync [![Build Status](https://secure.travis-ci.org/pmcjury/guard-remote-sync.png)](http://travis-ci.org/pmcjury/guard-remote-sync)
+
+## Install
+
+Please be sure to have [Guard](https://github.com/guard/guard) installed before continuing.
+
+Please be sure to have the rsync command in your path.
+
+It's recommended that you set up a ssh key if you're going to do remote syncing. 
+Alterantively your can use a password file as per rsync default option --password-file=FILE, the drawback with this is you might commit your information to the repo, and that ain't no good.
+Lastly, you can just type in your password everytime, but that's too much work. Add a ssh key! 
+
+Install the gem:
 
-**Usage**
 ```
-bundle exec guard
+$ gem install guard-remote-sync
 ```
 
-**Example Guardfile**
+Add guard definition to your Guardfile by running this command:
+
+```
+$ guard init rspec
+```
+
+## Usage
+
+Please read [Guard usage doc](https://github.com/guard/guard#readme)
+
+## Guardfile
+
+### Any directory you need to rsync
+
 ```ruby
 guard 'remote-sync',
         :source => ".", 
@@ -20,3 +43,77 @@ guard 'remote-sync',
   watch(%r{^.+\.(js|xml|php|class|config)$})
 end
 ```
+Please read [Guard doc](https://github.com/guard/guard#readme) for more information about the Guardfile DSL.
+
+## Options
+
+### There are only two required options
+
+```ruby
+guard 'remote-sync', :source => '.', :destination => './tmp' do
+        # ...
+end
+```
+
+### Syncing to a remote machine required additional options
+```ruby
+guard 'remote-sync', 
+        :source => "."                      # the directory to start the remote sync guard in
+        :destination => '/export/home/user' # the directory to sync to
+        :user => "someone"                  # the user to user ex: {USER}@somehost.com
+        :remote_address => 'company.com'    # the remote address ip or url
+        do
+                # ...
+end
+```
+
+### Using your own rsync command. This bypasses all validations, etc.
+```ruby
+guard 'remote-sync', :cli_options => 'rsync -Carv . user@company.com:/export/home/user' do
+        # ...
+end
+```
+
+### List of available options:
+
+Most of these options are human readable and correspond to rsync's options. Long options are used wherever
+possible to be more verbose
+
+```ruby
+:source => nil                      # the source directory to start in
+:destination => nil                 # the directory to sync to
+:user => nil                        # the user to use if remote syncing to another machine
+:remote_address => nil              # the remote address to the other machine ip|url
+:ssh => false                       # see rsync options : "$ man rsync"
+:cli_options => nil                 # used if you want to pass your own rsyn command
+:archive => true                    # see rsync options : "$ man rsync"
+:recursive => true                  # see rsync options : "$ man rsync"
+:verbose => true                    # see rsync options : "$ man rsync"
+:delete => true                     # see rsync options : "$ man rsync"
+:include => nil                     # see rsync options : "$ man rsync"
+:include_from => nil                # see rsync options : "$ man rsync"
+:exclude => nil                     # see rsync options : "$ man rsync"
+:exclude_from => ".rsync-filter"    # see rsync options : "$ man rsync"
+:progress => true                   # see rsync options : "$ man rsync"
+:sync_on_start => false             # rsycn when the guard starts instead of waiting for a watcher to trigger guard
+:dry_run => false                   # see rsync options : "$ man rsync"
+:cvs_exclude => true                # see rsync options : "$ man rsync"
+:password_file => nil               # see rsync options : "$ man rsync"
+:timeout => 10                      # see rsync options : "$ man rsync"
+```
+
+Development
+-----------
+
+* Source hosted at [GitHub](https://github.com/pmcjury/guard-remote-sync)
+* Report issues/Questions/Feature requests on [GitHub Issues](https://github.com/pmcjury/guard-remote-sync/issues)
+
+Testing
+-------
+
+Please run `bundle exec rake spec` to test the source
+
+Author
+------
+
+[Patrick H. McJury](https://github.com/pmcjury)

data/lib/guard/remote-sync.rb

@@ -33,7 +33,8 @@ module Guard
           :sync_on_start => false,
           :dry_run => false,
           :cvs_exclude => true,
-          :password_file => nil
+          :password_file => nil,
+          :timeout => 10
       }.merge(options)
 
       @source = Source.new(options[:source])
@@ -48,7 +49,11 @@ module Guard
       throw([:task_has_failed], "Guard::RemoteSync options invalid") unless options_valid?
       UI.info "Guard::RemoteSync started in source directory '#{File.expand_path @source.directory}'"
       Notifier.notify("Guard::RemoteSync is running in directory #{File.expand_path @source.directory}", notifier_options)
-      @command.sync if options[:sync_on_start] && @command.test
+      if @command.test
+        @command.sync if options[:sync_on_start]
+      else
+        throw([:task_has_failed], "Guard::RemoteSync rsync failed, please check your configurations, directories, permissions, and maybe even your ssh details ( set up a public key possibly )")
+      end
 
     end
 

data/lib/guard/remote-sync/command.rb

@@ -4,6 +4,26 @@ module Guard
 
       attr_accessor :command, :source, :destination
 
+      CLEAR = "\e[0m"
+      # The start of an ANSI bold sequence.
+      BOLD = "\e[1m"
+      # Set the terminal's foreground ANSI color to black.
+      BLACK = "\e[30m"
+      # Set the terminal's foreground ANSI color to red.
+      RED = "\e[31m"
+      # Set the terminal's foreground ANSI color to green.
+      GREEN = "\e[32m"
+      # Set the terminal's foreground ANSI color to yellow.
+      YELLOW = "\e[33m"
+      # Set the terminal's foreground ANSI color to blue.
+      BLUE = "\e[34m"
+      # Set the terminal's foreground ANSI color to magenta.
+      MAGENTA = "\e[35m"
+      # Set the terminal's foreground ANSI color to cyan.
+      CYAN = "\e[36m"
+      # Set the terminal's foreground ANSI color to white.
+      WHITE = "\e[37m"
+
       def initialize(source, destination, options = {})
         @options = options
         @source = source
@@ -13,28 +33,47 @@ module Guard
 
       def sync
         UI.info "Guard::RemoteSync `#{@command}`"
-        r = `#{@command}`
-        UI.info "Guard::RemoteSync Status : \n #{r}" if @options[:verbose]
+        run_command @command
       end
 
       def test
+        $stderr.puts("\r\e[0m")
+        $stderr.puts "#{BOLD}Testing rsync with a dry run and stats. Verifying the results...#{CLEAR}"
+        opts = @options
         @options[:dry_run] = true
+        @options[:stats] = true
         test_command = build_command
-        @options[:dry_run] = false
-        $stdout.sync = true
-        `#{test_command}`
-        $stdout.sync = false
-        $?.exitstatus
+        @options = opts
+        result = run_command test_command, {:suppress_output => false}
+        $stderr.puts("\r\e[0m")
+        result.to_i == 0
       end
 
       private
 
+      def run_command(cmd, opts = {})
+        options = {:color => CYAN, :suppress_output => false}.merge(opts)
+        $stderr.puts "\r\e[0m" unless options[:suppress_output]
+        exit_value = nil
+        Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+          stdout.read.split("\n").each do |line|
+            $stderr.puts "\t#{options[:color]}#{line}#{CLEAR}" unless options[:suppress_output]
+          end
+          stderr.read.split("\n").each do |line|
+            $stderr.puts "\t#{BOLD}#{RED}ERROR:#{line}#{CLEAR}"
+          end
+          exit_value = wait_thr.value.to_s.split.last
+        end
+        $stderr.puts "\t#{BOLD}#{YELLOW}Result Code #{exit_value}#{CLEAR}"
+        exit_value
+      end
+
       def build_command
         unless @options[:cli_options].nil?
-          UI.info "':cli' option was given so ignoring all other options, and outputting as is..."
+          UI.debug "Guard::RemoteSync ':cli' option was given so ignoring all other options, and outputting as is..." if @options[:verbose]
           command = "#{rsync_command} #{@options[:cli_options]}"
         else
-          UI.debug "building rsync options from specified options"
+          UI.debug "Guard::RemoteSync building rsync options from specified options" if @options[:verbose]
           @command_options = build_options
           @remote_options = check_remote_options
           destination = @remote_options.nil? ? "#{@destination.directory}" : "#{@remote_options}:#{@destination.directory}"
@@ -56,7 +95,7 @@ module Guard
           value = check_boolean_option(o)
           opts.concat "#{value} " unless value.nil?
         end
-        [:include, :include_from, :exclude, :exclude_from, :password_file].each do |o|
+        [:include, :include_from, :exclude, :exclude_from, :password_file, :timeout].each do |o|
           value = check_nil_option(o)
           opts.concat "#{value} " unless value.nil?
         end

data/lib/guard/remote-sync/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module RemoteSyncVersion
-      VERSION = "0.0.2"
+      VERSION = "0.0.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-remote-sync
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: