guard-rsync 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Kristofor Selden
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,56 @@
+Guard::Rsync
+===========
+
+Rsync guard allows to automatically sync directories when source file
+changes.
+
+Focus of this guard task is to sync directories while excluding
+autogenerated files and their sources.
+
+Install
+-------
+
+Please be sure to have [Guard](https://github.com/guard/guard) installed before continue.
+
+Install the gem:
+
+    $ gem install guard-rsync
+
+Add it to your Gemfile (inside development group):
+
+``` ruby
+gem 'guard-rsync'
+```
+
+Usage
+-----
+
+Please read [Guard usage doc](https://github.com/guard/guard#readme)
+
+Guardfile
+---------
+
+The following example pairs the coffeescript guard with a rsync guard.
+
+``` ruby
+group(:build_my_app) do
+  guard('rsync', {
+    :input => 'apps_src/my_app',
+    :output => 'apps',
+    :excludes => {
+      /(.+)\.coffee$/ => (lambda {|m| "#{m[1]}.js"})
+    },
+    :run_group_on_start => true
+  }) do
+    watch(%r{^apps_src/my_app/(.+\.(?!coffee)(.*)|[^.]+)$})
+  end
+
+  guard 'coffeescript', :input => 'apps_src/my_app', :output => 'apps/my_app'
+end
+```
+
+Author
+------
+
+[Kristofor Selden](https://github.com/kselden)
+

data/lib/guard/rsync.rb

@@ -0,0 +1,95 @@
+require 'guard'
+require 'guard/guard'
+require 'guard/watcher'
+require 'tempfile'
+
+module Guard
+
+  # The CoffeeScript guard that gets notifications about the following
+  # Guard events: `start`, `stop`, `reload`, `run_all` and `run_on_change`.
+  #
+  class Rsync < Guard
+    # Initialize Guard::Sync.
+    #
+    # @param [Array<Guard::Watcher>] watchers the watchers in the Guard block
+    # @param [Hash] options the options for the Guard
+    # @option options [String] :input the input directory
+    # @option options [String] :output the output directory
+    # @option options [Hash] :excludes the map of excludes patterns in the
+    #         input directory to exclude files in the output directory.
+    def initialize(watchers = [], options = { })
+      @input = ensure_no_trailing_slash(options[:input])
+      @output = options[:output]
+      raise 'input must be a directory' unless File.directory? @input
+      raise 'output must be a directory' unless File.directory? @output or @output =~ /^.*@.*:.*$/
+      @dirname = File.basename(@input)
+      @excludes = options[:excludes]
+      @run_group_on_start = options[:run_group_on_start]
+      super
+    end
+
+    # Call once when guard starts
+    def start
+      run_all
+      if @run_group_on_start
+        ::Guard.guards.each do |guard|
+          guard.run_all if self != guard && group == guard.group
+        end
+      end
+    end
+
+    # Gets called when rsync should be run.
+    #
+    # @return [Boolean] rsync was successful
+    def run_all
+      run_on_change([])
+    end
+
+    # Gets called when watched paths and files have changes.
+    #
+    # @param [Array<String>] paths the changed paths and files
+    # @return [Boolean] rsync was successful
+    def run_on_change(paths)
+      input_excludes = []
+      output_excludes = []
+      Dir.chdir(@input) do
+        Dir.glob('**/*').each do |file|
+          @excludes.each do |pattern, transform|
+            matches = file.match(pattern)
+            if matches
+              input_excludes << File.join('/', @dirname, file)
+              output_excludes << File.join('/', @dirname, transform.call(matches)) if transform
+            end
+          end
+        end
+      end
+      exclude_file = Tempfile.new('exclude')
+      begin
+        exclude_file.puts(input_excludes)
+        exclude_file.puts(output_excludes)
+        ::Guard.listener.ignore_paths.each do |dir|
+          next if dir == '.' or dir == '..'
+          exclude_file.puts(ensure_trailing_slash(File.basename(dir)))
+        end
+        exclude_file.flush
+        UI.info `rsync -av --delete --exclude-from "#{exclude_file.path}" "#{@input}" "#{@output}"`
+        success = $?.success?
+        return success
+      ensure
+         exclude_file.close
+         exclude_file.unlink
+      end
+    end
+
+    private
+    def ensure_trailing_slash(path)
+      path.gsub(/(.*[^\/])\Z/,'\1/')
+    end
+
+    def ensure_no_trailing_slash(path)
+      path.gsub(/\/\Z/,'')
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: guard-rsync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Kris Selden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70303394472940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70303394472940
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70303394472380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70303394472380
+description: Guard::Rsync automatically syncs directories.
+email:
+- kris.selden@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/guard/rsync.rb
+- LICENSE
+- README.md
+homepage: http://github.com/kselden/guard-rsync
+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: 1.3.6
+requirements: []
+rubyforge_project: guard-rsync
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Guard gem for syncing directories
+test_files: []