guard 0.1.0.beta.2 → 0.1.0

data/README.rdoc

@@ -1,3 +1,155 @@
 = Guard
 
-Documentation is coming.
+Guard is a command line tool to easly handle events on files modifications.
+
+== Features
+
+- FSEvent support on Mac OS X (without RubyCocoa!)
+- Inotify support on Linux (beta)
+- Super fast change detection
+- Automatic files modifications detection (even new files are detected)
+- Growl notification (please install {growlnotify}[http://growl.info/documentation/growlnotify.php])
+- Libnotify notification
+
+== Install
+
+Only Mac OS X (10.5+) & Linux are supported. Tested on Ruby 1.8.7 & 1.9.2dev.
+
+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)
+
+== Usage
+
+Just launch Guard inside your ruby/rails project with:
+
+    guard
+
+Options list is available with:
+
+    guard help
+
+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]
+
+guard ideas:
+
+- guard-spork
+- guard-livereload
+- guard-cucumber
+- guard-test
+- guard-sass
+- 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 with:
+
+    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:
+
+    - lib/
+      - guard/
+        - guard-name/
+          - templates/
+            - Guardfile (needed for guard init <guard-name>)
+        - guard-name.rb
+
+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
+
+Guardfile DSL consists of just 2 simple methods: guard & watch. Example:
+
+    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
+
+{Thibaud Guillaume-Gentil}[http://github.com/thibaudgg].

data/lib/guard.rb

@@ -19,7 +19,7 @@ module Guard
       
       Dsl.evaluate_guardfile
       if guards.empty?
-        UI.error "No guards found in Guardfile, too bad."
+        UI.error "No guards found in Guardfile, please add it at least one."
       else
         Interactor.init_signal_traps
         

data/lib/guard/cli.rb

@@ -8,12 +8,12 @@ module Guard
     desc "start", "Starts guard"
     method_option :clear, :type => :boolean, :default => false, :aliases => '-c', :banner => "Auto clear shell after each change"
     def start
-      Guard.start(options)
+      ::Guard.start(options)
     end
     
     desc "version", "Prints the guard's version information"
     def version
-      Guard::UI.info "Guard version #{Guard::VERSION}"
+      ::Guard::UI.info "Guard version #{Guard::VERSION}"
     end
     map %w(-v --version) => :version
     
@@ -23,12 +23,12 @@ module Guard
         puts "Writing new Guardfile to #{Dir.pwd}/Guardfile"
         FileUtils.cp(File.expand_path('../templates/Guardfile', __FILE__), 'Guardfile')
       elsif guard_name.nil?
-        Guard::UI.error "Guardfile already exists at #{Dir.pwd}/Guardfile"
+        ::Guard::UI.error "Guardfile already exists at #{Dir.pwd}/Guardfile"
         exit 1
       end
       
       if guard_name
-        guard_class = Guard.get_guard_class(guard_name)
+        guard_class = ::Guard.get_guard_class(guard_name)
         guard_class.init(guard_name)
       end
     end

data/lib/guard/version.rb

@@ -1,3 +1,3 @@
 module Guard
-  VERSION = "0.1.0.beta.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: guard
 version: !ruby/object:Gem::Version 
-  hash: 62196407
-  prerelease: true
+  hash: 27
+  prerelease: false
   segments: 
   - 0
   - 1
   - 0
-  - beta
-  - 2
-  version: 0.1.0.beta.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Thibaud Guillaume-Gentil
@@ -17,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-07 00:00:00 +02:00
+date: 2010-10-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,14 +43,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 62196407
+        hash: 27
         segments: 
         - 0
         - 1
         - 0
-        - beta
-        - 2
-        version: 0.1.0.beta.2
+        version: 0.1.0
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -151,7 +147,7 @@ dependencies:
         version: 0.1.3
   type: :runtime
   version_requirements: *id008
-description: Guard is a command line tool to easly manage script launch when your files change
+description: Guard is a command line tool to easly handle events on files modifications.
 email: 
 - thibaud@thibaud.me
 executables: 
@@ -216,6 +212,6 @@ rubyforge_project: guard
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Guard keep an eye on your files event
+summary: Guard keep an eye on your files modifications.
 test_files: []