master/README.rdoc

182 lines
4.6 KiB
Plaintext
Raw Normal View History

2010-10-03 21:00:33 +00:00
= Guard
2010-10-08 13:00:36 +00:00
Guard is a command line tool to easly handle events on files modifications.
== Features
- {FSEvent}[http://en.wikipedia.org/wiki/FSEvents] support on Mac OS X 10.5+ (without RubyCocoa!, please install {rb-fsevent gem, >= 0.3.2}[https://rubygems.org/gems/rb-fsevent])
- {Inotify}[http://en.wikipedia.org/wiki/Inotify] support on Linux (beta, please install {rb-inotify gem, >= 0.5.1}[https://rubygems.org/gems/rb-inotify])
- Polling for others (help us to support more systems)
- Super fast change detection (when polling not used)
2010-10-08 13:00:36 +00:00
- Automatic files modifications detection (even new files are detected)
- Growl notification (please install {growlnotify}[http://growl.info/documentation/growlnotify.php] & {growl gem}[https://rubygems.org/gems/growl])
- Libnotify notification (please install {libnotify gem}[https://rubygems.org/gems/libnotify])
2010-10-18 19:45:31 +00:00
- Tested on Ruby 1.8.6, 1.8.7 & 1.9.2
2010-10-08 13:00:36 +00:00
== Install
Install the gem:
gem install guard
Add it to your Gemfile (inside test group):
gem 'guard'
Generate an empty Guardfile with:
guard init
Add guard(s) you need (see available guards below)
=== On Mac OS X
Install rb-fsevent for {FSEvent}[http://en.wikipedia.org/wiki/FSEvents] support
gem install rb-fsevent
Install growl for Growl notification support
gem install growl
=== On Linux
Install rb-inotify for {inotify}[http://en.wikipedia.org/wiki/Inotify] support
gem install rb-inotify
Install libnotify for libonity notification support
gem install libnotify
2010-10-08 13:00:36 +00:00
== Usage
Just launch Guard inside your ruby/rails project with:
guard
Shell can be cleared after each change with:
guard -c
2010-10-08 13:00:36 +00:00
Options list is available with:
guard help [TASK]
2010-10-08 13:00:36 +00:00
Signal handlers are used to interact with Guard:
- Ctrl-C - Quit Guard (call stop guard(s) method before)
- Ctrl-\ - Call run_all guard(s) method
- Ctrl-Z - Call reload guard(s) method
== Available Guards
- {guard-rspec}[http://github.com/guard/guard-rspec]
2010-10-19 20:37:16 +00:00
- {guard-test}[http://github.com/guard/guard-test]
2010-10-20 20:36:26 +00:00
- {guard-minitest}[http://github.com/guard/guard-minitest]
- {guard-livereload}[http://github.com/guard/guard-livereload]
2010-10-19 20:37:16 +00:00
- {guard-sass}[http://github.com/guard/guard-sass]
- {guard-shell}[http://github.com/guard/guard-shell]
2010-10-08 13:00:36 +00:00
guard ideas:
- guard-spork
- guard-cucumber
- guard-bundler
- others ideas?
=== Add a guard to your Guardfile
Add it to your Gemfile (inside test group):
gem '<guard-name>'
Add guard definition to your Guardfile by running this command:
2010-10-08 13:00:36 +00:00
guard init <guard-name>
You are good to go!
== Create a guard
Create a new guard is very easy, just create a new gem with this basic structure:
2010-10-08 13:03:45 +00:00
lib/
guard/
guard-name/
templates/
Guardfile (needed for guard init <guard-name>)
guard-name.rb
2010-10-08 13:00:36 +00:00
lib/guard/guard-name.rb inherit from guard/guard and should overwrite at least one of the five guard methods. Example:
require 'guard'
require 'guard/guard'
module Guard
class GuardName < Guard
# ================
# = Guard method =
# ================
# Call once when guard starts
def start
true
end
# Call with Ctrl-C signal (when Guard quit)
def stop
true
end
# Call with Ctrl-Z signal
def reload
true
end
# Call with Ctrl-/ signal
def run_all
true
end
# Call on file(s) modifications
def run_on_change(paths)
true
end
end
end
Looks at available guards code for more concrete example.
== Guardfile DSL
2010-10-08 13:06:37 +00:00
Guardfile DSL consists of just two simple methods: guard & watch. Example:
2010-10-08 13:00:36 +00:00
guard 'rspec', :version => 2 do
watch('^spec/(.*)_spec.rb')
watch('^lib/(.*)\.rb') { |m| "spec/lib/#{m[1]}_spec.rb" }
watch('^spec/spec_helper.rb') { "spec" }
watch('^spec/spec_helper.rb') { `say hello` }
end
- "guard" method allow to add a guard with an optional options hash
- "watch" method allow to define which files are supervised per this guard. A optional block can be added to overwrite path sending to run_on_change guard method or launch simple command.
== TODO
- Add more specs, help are welcome because I'm not sure about how to test stuff like this :-)
== Development
- Source hosted at {GitHub}[http://github.com/guard/guard]
- Report issues/Questions/Feature requests on {GitHub Issues}[http://github.com/guard/guard/issues]
Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change
you make.
== Authors
2010-10-08 13:03:45 +00:00
{Thibaud Guillaume-Gentil}[http://github.com/thibaudgg]