moumar/guard-copy

Copy files when they are changed

Guard::Copy

Copy guard copies files to one or more locations whenever files are created or modified.

• Tested against Ruby 1.8.7, 1.9.2, 1.9.3, and the latest versions of JRuby

Installation

Please be sure to have Guard installed.

Install the gem:

$ gem install guard-copy

Add guard definition to your Guardfile by running this command:

$ guard init copy

Usage

Please read Guard usage doc

Guardfile

Copy guard can copy files from one source directory to one or more target directories identified either explicitly or with wildcards.

Single Target

guard :copy, :from => 'source', :to => 'target'

Multiple Targets

guard :copy, :from => 'source', :to => ['t1', 't2']

Newest Wildcard Target

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:

:from         => 'source' # directory to copy files from
:to           => 'target' # directory or glob to copy files to; string or array
:glob         => :newest  # how to handle globs; default: :all
                          #   :newest - copy to only the newest directory
                          #   :all    - copy to all directories
:mkpath       => true     # create directories in target when full target path
                          # does not exist; default: false
:delete       => true     # delete files from target directories; default: false
:verbose      => true     # log all operations as info messages; default: false
:absolute     => true     # allow absolute paths for :to; default: false
:run_at_start => true     # copy all files at startup (does not remove any files)

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.

guard :copy, :from => 'source', :to => 'target' do
  watch(%r{^source/.+\.js$})
end

guard :copy, :from => 'source', :to => 'target' do
  watch(%r{^.+\.js$})
end

Author

Marc Schwieterman

License

Copyright (c) 2012 Marc Schwieterman

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.