guard-remote-sync 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Patrick McJury
+
+MIT License
+
+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,24 @@
+guard-rsync-remote
+============
+
+**Usage**
+```
+bundle exec guard
+```
+
+**Example Guardfile**
+```
+guard 'rsync-remote',
+        :source => ".", 
+        :destination => '/export/home/{username}/tmp', 
+        :user => '{user}',
+        :remote_address => '{address}',
+        :verbose => true, 
+        :cli => "--color", 
+        :sync_on_start => true do
+  
+  watch(%r{^.+\.(js|xml|php|class|config)$})
+end
+```
+
+A more extensive and tested rsync guard

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

@@ -0,0 +1,96 @@
+module Guard
+  class RemoteSync
+    class Command
+
+      attr_accessor :command, :source, :destination
+
+      def initialize(source, destination, options = {})
+        @options = options
+        @source = source
+        @destination = destination
+        @command = build_command
+      end
+
+      def sync
+        UI.info "Guard::RsyncX `#{@command}`"
+        r = `#{@command}`
+        UI.info "Guard::RsyncX Status : \n #{r}" if @options[:verbose]
+      end
+
+      def test
+        @options[:dry_run] = true
+        test_command = build_command
+        @options[:dry_run] = false
+        $stdout.sync = true
+        `#{test_command}`
+        $stdout.sync = false
+        $?.exitstatus
+      end
+
+      private
+
+      def build_command
+        unless @options[:cli_options].nil?
+          UI.info "':cli' option was given so ignoring all other options, and outputting as is..."
+          command = "#{rsync_command} #{@options[:cli_options]}"
+        else
+          UI.debug "building rsync options from specified options"
+          @command_options = build_options
+          @remote_options = check_remote_options
+          destination = @remote_options.nil? ? "#{@destination.directory}" : "#{@remote_options}:#{@destination.directory}"
+          command = "#{rsync_command} #{@command_options}#{@source.directory} #{destination}"
+        end
+        command
+      end
+
+      def build_options
+        opts = ""
+        simple_opts = ""
+        [:archive, :recursive, :verbose].each do |o|
+          value = check_simple_option(o)
+          simple_opts.concat "#{value}" unless value.nil?
+        end
+        opts.concat "-#{simple_opts} " unless simple_opts.empty?
+
+        [:progress, :delete, :stats, :dry_run, :cvs_exclude].each do |o|
+          value = check_boolean_option(o)
+          opts.concat "#{value} " unless value.nil?
+        end
+        [:include, :include_from, :exclude, :exclude_from, :password_file].each do |o|
+          value = check_nil_option(o)
+          opts.concat "#{value} " unless value.nil?
+        end
+
+        opts
+      end
+
+      def rsync_command
+        "rsync"
+      end
+
+      def check_remote_options
+        unless @options[:user].nil? && @options[:remote_address].nil?
+          raise "A remote address is required if you specify a user" if !@options[:user].nil? && @options[:remote_address].nil?
+          raise "A user is required if you specify a remote address" if @options[:user].nil? && !@options[:remote_address].nil?
+          value = "#{@options[:user]}@#{@options[:remote_address]}"
+        else
+          value = nil
+        end
+        value
+      end
+
+      def check_boolean_option(option)
+        @options[option] ? "--#{option.to_s.gsub(/_/, '-')}" : nil
+      end
+
+      def check_nil_option(option)
+        @options[option].nil? ? nil : "--#{option.to_s.gsub(/_/, '-')} '#{@options[option]}'"
+      end
+
+      def check_simple_option(option)
+        @options[option] ? "#{option.to_s[0, 1]}" : nil
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Guard
+  class RemoteSync
+    class Source
+
+      attr_accessor :directory
+
+      def initialize(directory)
+        @directory = directory
+      end
+
+    end
+  end
+end

data/lib/guard/remote-sync/templates/Guardfile

@@ -0,0 +1,11 @@
+guard 'remote-sync',
+	:source => ".", 
+	:destination => '/export/home/{username}/tmp', 
+	:user => '{user}',
+	:remote_address => '{address}',
+	:verbose => true, 
+	:cli => "--color", 
+	:sync_on_start => true do
+  
+  watch(%r{^.+\.(js|xml|php|class|config)$})
+end

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

@@ -0,0 +1,5 @@
+module Guard
+  module RemoteSyncVersion
+      VERSION = "0.0.1"
+  end
+end

data/lib/guard/remote-sync.rb

@@ -0,0 +1,121 @@
+require 'guard'
+require 'guard/guard'
+
+module Guard
+  class RemoteSync < Guard
+
+    autoload :Command, 'guard/remote-sync/command'
+    autoload :Source, 'guard/remote-sync/source'
+
+    attr_accessor :command
+
+    # Initialize a Guard.
+    # @param [Array<Guard::Watcher>] watchers the Guard file watchers
+    # @param [Hash] options the custom Guard options
+    def initialize(watchers = [], options = {})
+      super
+      @options = {
+          :source => nil,
+          :destination => nil,
+          :user => nil,
+          :remote_address => nil,
+          :ssh => false,
+          :cli_options => nil,
+          :archive => true,
+          :recursive => true,
+          :verbose => true,
+          :delete => true,
+          :include => nil,
+          :include_from => nil,
+          :exclude => nil,
+          :exclude_from => ".rsync-filter",
+          :progress => true,
+          :sync_on_start => false,
+          :dry_run => false,
+          :cvs_exclude => true,
+          :password_file => nil
+      }.merge(options)
+
+      @source = Source.new(options[:source])
+      @destination = Source.new(options[:destination])
+      @command = Command.new(@source, @destination, @options)
+
+    end
+
+    # Call once when Guard starts. Please override initialize method to init stuff.
+    # @raise [:task_has_failed] when start has failed
+    def start
+      throw([:task_has_failed], "Guard::RsyncX options invalid") unless options_valid?
+      UI.info "Guard::RsyncX started in source directory '#{File.expand_path @source.directory}'"
+      Notifier.notify("Guard::RsyncX is running in directory #{File.expand_path @source.directory}", notifier_options)
+      @command.sync if options[:sync_on_start] && @command.test
+
+    end
+
+    # Called when `stop|quit|exit|s|q|e + enter` is pressed (when Guard quits).
+    # @raise [:task_has_failed] when stop has failed
+
+    def stop
+      UI.info "Guard::RsyncX stopped."
+      Notifier.notify("Guard::RsyncX stopped.",notifier_options)
+    end
+
+    # Called when `reload|r|z + enter` is pressed.
+    # This method should be mainly used for "reload" (really!) actions like reloading passenger/spork/bundler/...
+    # @raise [:task_has_failed] when reload has failed
+    def reload
+      Notifier.notify("Manual Guard::RsyncX synchronize  #{File.expand_path @source.directory} to #{@destination.directory}",notifier_options)
+      @command.sync
+    end
+
+    # Called when just `enter` is pressed
+    # This method should be principally used for long action like running all specs/tests/...
+    # @raise [:task_has_failed] when run_all has failed
+    def run_all
+      Notifier.notify("Manual Guard::RsyncX synchronize  #{@source.directory} to #{@destination.directory}",notifier_options)
+      @command.sync
+    end
+
+    # Called on file(s) modifications that the Guard watches.
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_change has failed
+    def run_on_changes(paths)
+      #paths.each do |p| ::Guard::UI.info("Files effect : #{p}")  end
+      @command.sync
+    end
+
+    # Called on file(s) deletions that the Guard watches.
+    # @param [Array<String>] paths the deleted files or paths
+    # @raise [:task_has_failed] when run_on_removals has failed
+    def run_on_removals(paths)
+      @command.sync
+    end
+
+    # Called on file(s) additions that the Guard watches.
+    # @param [Array<String>] paths the added files or paths
+    # @raise [:task_has_failed] when run_on_additions has failed
+    def run_on_additions(paths)
+      @command.sync
+    end
+
+    private
+
+    def options_valid?
+      valid = true
+      if options[:source].nil? && options[:cli_options].nil?
+        UI.error("Guard::RsyncX a source directory is required")
+        valid = false
+      end
+      if options[:destination].nil? && options[:cli_options].nil?
+        UI.error("Guard::RsyncX a source directory is required")
+        valid = false
+      end
+      valid
+    end
+
+    def notifier_options
+      {:title => "Guard::RsyncX", :image => :success}
+    end
+
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: guard-remote-sync
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Patrick McJury
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Guard::RemoteSync to automatically rsync your files.
+email:
+- pmcjury@mcjent.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/guard/remote-sync/command.rb
+- lib/guard/remote-sync/source.rb
+- lib/guard/remote-sync/templates/Guardfile
+- lib/guard/remote-sync/version.rb
+- lib/guard/remote-sync.rb
+- LICENSE
+- README.md
+homepage: https://github.com/pmcjury/guard-remote-sync
+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-remote-synch
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Guard gem for Remote Syncing through rsync
+test_files: []