guard-copy 0.0.2 → 0.0.3

data/README.md

@@ -36,7 +36,7 @@ guard :copy, :from => 'source', :to => 'target'
 ### Multiple Targets
 
 ``` ruby
-guard :copy, :from => 'source', :to => ['t1', 't2'] 
+guard :copy, :from => 'source', :to => ['t1', 't2']
 ```
 
 ### Newest Wildcard Target
@@ -48,6 +48,45 @@ guard :copy, :from => 'source', :to => 'target*', :glob => :newest
 This guard will copy files from the source directory to the newest
 directory starting with 'target'.
 
+## Options
+
+By default, Guard::Copy will copy modified and newly created files from
+the directory specified by the `:from` option to that specified by the
+`:to` option.
+
+### List of available options:
+
+``` ruby
+:from    => 'source'   # directory to copy files from
+:to      => 'target'   # directory or glob to copy files to; can be an array
+:glob    => :newest    # how to handle globs; default: :all
+                       #   :newest - copy to only the newest directory
+                       #   :all    - copy to all directories
+:delete  => true       # delete files from target directories
+:verbose => true       # log all operations as info messages
+```
+
+## Watchers
+
+The paths that files are ultimately copied to are generated by
+substituting the `:from` portion of the changed file's path with each of
+the `:to` directories. Because of this, any watchers you define will be
+modified to be relative to the `:from` directory.
+
+Therefore the following two watcher definitions are equivalent.
+
+``` ruby
+guard :copy, :from => 'source', :to => 'target' do
+  watch(%r{^source/.+\.js$})
+end
+```
+
+``` ruby
+guard :copy, :from => 'source', :to => 'target' do
+  watch(%r{^.+\.js$})
+end
+```
+
 ## Author
 
 [Marc Schwieterman](https://github.com/marcisme)

data/lib/guard/copy/target.rb

@@ -0,0 +1,37 @@
+module Guard
+  class Copy
+    class Target
+
+      attr_reader :pattern, :options, :paths
+
+      # Initialize a new target
+      #
+      # @param [String] pattern the pattern for this target
+      # @option options [Symbol] glob target resolution mode, `:newest` or `:all`
+      #
+      def initialize(pattern, options = {})
+        raise ArgumentError, 'pattern cannot be nil' unless pattern
+        raise ArgumentError, 'pattern cannot be empty' if pattern.empty?
+        @pattern = pattern
+        @options = {
+          :glob => :all
+        }.merge(options)
+        @paths = []
+      end
+
+      # Resolve the target into one or more paths
+      #
+      # @return [Boolean] true if the pattern resolved to any paths
+      def resolve
+        @paths.clear
+        if @options[:glob] == :newest
+          @paths.concat(Dir[@pattern].sort_by { |f| File.mtime(f) }.last(1))
+        else
+          @paths.concat(Dir[@pattern])
+        end
+        @paths.any?
+      end
+
+    end
+  end
+end

data/lib/guard/copy/version.rb

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

data/lib/guard/copy.rb

@@ -1,34 +1,51 @@
 require 'guard'
 require 'guard/guard'
-require 'guard/copy/version'
 require 'fileutils'
 
 module Guard
   class Copy < Guard
 
+    autoload :Target, 'guard/copy/target'
+
     attr_reader :targets
 
     # Initialize a Guard.
     # @param [Array<Guard::Watcher>] watchers the Guard file watchers
     # @param [Hash] options the custom Guard options
     def initialize(watchers = [], options = {})
-      # watchers are currently ignored
-      watchers << ::Guard::Watcher.new(%r{#{options[:from]}/.*})
-      options[:to] = Array(options[:to]).freeze
       super
+      if watchers.empty?
+        watchers << ::Guard::Watcher.new(%r{^#{options[:from]}/.*$})
+      else
+        watchers.each { |w| normalize_watcher(w, options[:from]) }
+      end
+      @targets = Array(options[:to]).map { |to| Target.new(to, options) }
     end
 
     # Call once when Guard starts. Please override initialize method to init stuff.
     # @raise [:task_has_failed] when start has failed
     def start
-      validate_from
-      validate_to
-      @targets = resolve_targets
-      if @targets.any?
+      validate_presence_of(:from)
+      validate_from_is_directory
+      validate_presence_of(:to)
+      validate_to_does_not_include_from
+      @targets.each do |target|
+        unless target.resolve
+          UI.warning("Guard::Copy - '#{target.pattern}' does not match a valid directory")
+        end
+      end
+      if target_paths.any?
         UI.info("Guard::Copy will copy files from:")
         UI.info("  #{options[:from]}")
         UI.info("to:")
-        @targets.each { |target| UI.info("  #{target}") }
+        target_paths.each { |target_path| UI.info("  #{target_path}") }
+
+        if options[:delete]
+          UI.info("Guard::Copy will delete files removed from:")
+          UI.info("  #{options[:from]}")
+          UI.info("from:")
+          target_paths.each { |target_path| UI.info("  #{target_path}") }
+        end
       end
     end
 
@@ -40,55 +57,85 @@ module Guard
 
     # 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_change(paths)
-      validate_targets
-      paths.each do |from_path|
-        @targets.each do |target|
-          to_path = from_path.sub(@options[:from], target)
-          validate_to_path(to_path)
-          FileUtils.cp(from_path, to_path)
-        end
+    # @raise [:task_has_failed] when run_on_changes has failed
+    def run_on_changes(paths)
+      validate_at_least_one_target('copy')
+      with_all_target_paths(paths) do |from_path, to_path|
+        validate_to_path(to_path)
+        UI.info("copying to #{to_path}") if options[:verbose]
+        FileUtils.cp(from_path, to_path)
       end
     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_deletion has failed
-    def run_on_deletion(paths)
+    # @raise [:task_has_failed] when run_on_removals has failed
+    def run_on_removals(paths)
+      return unless options[:delete]
+      validate_at_least_one_target('delete')
+      with_all_target_paths(paths) do |_, to_path|
+        validate_to_file(to_path)
+        UI.info("deleting #{to_path}") if options[:verbose]
+        FileUtils.rm(to_path)
+      end
     end
 
     private
 
-    def validate_from
-      unless options[:from]
-        UI.error('Guard::Copy - :from option is required')
-        throw :task_has_failed
+    def target_paths
+      @targets.map { |t| t.paths }.flatten
+    end
+
+    def with_all_target_paths(paths)
+      paths.each do |from_path|
+        target_paths.each do |target_path|
+          to_path = from_path.sub(@options[:from], target_path)
+          yield(from_path, to_path)
+        end
       end
-      if File.file?(options[:from])
-        UI.error("Guard::Copy - '#{options[:from]}' is a file and must be a directory")
-        throw :task_has_failed
+    end
+
+    def normalize_watcher(watcher, from)
+      unless watcher.pattern.source =~ %r{^\^#{from}/.*}
+        normalized_source = watcher.pattern.source.sub(%r{^\^?(#{from})?/?}, "^#{from}/")
+        UI.info('Guard::Copy is changing watcher pattern:')
+        UI.info("  #{watcher.pattern.source}")
+        UI.info('to:')
+        UI.info("  #{normalized_source}")
+        watcher.pattern = Regexp.new(normalized_source)
       end
-      unless File.directory?(options[:from])
-        UI.error('Guard::Copy - :from option does not contain a valid directory')
+    end
+
+    def validate_presence_of(option)
+      unless options[option]
+        UI.error("Guard::Copy - :#{option} option is required")
         throw :task_has_failed
       end
     end
 
-    def validate_to
-      if options[:to].empty?
-        UI.error('Guard::Copy - :to option is required')
-        throw :task_has_failed
+    def validate_from_is_directory
+      path = options[:from]
+      unless File.directory?(path)
+        if File.file?(path)
+          UI.error("Guard::Copy - '#{path}' is a file and must be a directory")
+          throw :task_has_failed
+        else
+          UI.error("Guard::Copy - :from option does not contain a valid directory")
+          throw :task_has_failed
+        end
       end
+    end
+
+    def validate_to_does_not_include_from
       if options[:to].include?(options[:from])
         UI.error('Guard::Copy - :to must not include :from')
         throw :task_has_failed
       end
     end
 
-    def validate_targets
-      if @targets.empty?
-        UI.error('Guard::Copy - cannot copy, no valid :to directories')
+    def validate_at_least_one_target(operation)
+      if target_paths.empty?
+        UI.error("Guard::Copy - cannot #{operation}, no valid :to directories")
         throw :task_has_failed
       end
     end
@@ -102,23 +149,11 @@ module Guard
       end
     end
 
-    def resolve_targets
-      Array.new.tap do |targets|
-        options[:to].each do |to|
-          if @options[:glob] == :newest
-            dirs = Dir[to].sort_by { |f| File.mtime(f) }.last(1)
-          else
-            dirs = Dir[to]
-          end
-          if dirs.any?
-            #dirs.each do |dir|
-              #throw :task_has_failed if File.file?(dir)
-            #end
-            targets.concat(dirs)
-          else
-            UI.warning("Guard::Copy - '#{to}' does not match a valid directory")
-          end
-        end
+    def validate_to_file(to_file)
+      unless File.file?(to_file)
+        UI.error('Guard::Copy - cannot delete, file does not exist:')
+        UI.error("  #{to_file}")
+        throw :task_has_failed
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-copy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-24 00:00:00.000000000 Z
+date: 2012-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,119 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.9.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.9.2
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: guard-cucumber
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.7.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.7.2
-- !ruby/object:Gem::Dependency
-  name: fakefs
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.11.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.11.4
+        version: 1.1.1
 description: Guard::Copy automatically copies files.
 email:
 - marc.schwieterman@gmail.com
@@ -146,6 +34,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/guard/copy/target.rb
 - lib/guard/copy/templates/Guardfile
 - lib/guard/copy/version.rb
 - lib/guard/copy.rb
@@ -165,7 +54,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 964757571042390819
+      hash: 1790192604358185863
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -174,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 964757571042390819
+      hash: 1790192604358185863
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24