guard 0.3.0 → 0.3.1

data/README.rdoc

@@ -4,40 +4,39 @@ Guard is a command line tool that easily handle events on files modifications.
 
 == Features
 
-- {FSEvent}[http://en.wikipedia.org/wiki/FSEvents] support on Mac OS X 10.5+ (without RubyCocoa!, {rb-fsevent gem, >= 0.3.5}[https://rubygems.org/gems/rb-fsevent] required)
-- {Inotify}[http://en.wikipedia.org/wiki/Inotify] support on Linux ({rb-inotify gem, >= 0.5.1}[https://rubygems.org/gems/rb-inotify] required)
-- Polling for others (help us to support more systems)
-- Super fast change detection (when polling not used)
-- Automatic files modifications detection (even new files are detected)
-- Growl notification ({growlnotify}[http://growl.info/documentation/growlnotify.php] & {growl gem}[https://rubygems.org/gems/growl] required)
-- Libnotify notification ({libnotify gem}[https://rubygems.org/gems/libnotify] required)
-- Tested on Ruby 1.8.6, 1.8.7 & 1.9.2
+- {FSEvent}[http://en.wikipedia.org/wiki/FSEvents] support on Mac OS X 10.5+ (without RubyCocoa!, {rb-fsevent gem, >= 0.3.5}[https://rubygems.org/gems/rb-fsevent] required).
+- {Inotify}[http://en.wikipedia.org/wiki/Inotify] support on Linux ({rb-inotify gem, >= 0.5.1}[https://rubygems.org/gems/rb-inotify] required).
+- Polling on the other operating systems (help us to support more OS).
+- Automatic & Super fast (when polling is not used) files modifications detection (even new files are detected).
+- Growl notifications ({growlnotify}[http://growl.info/documentation/growlnotify.php] & {growl gem}[https://rubygems.org/gems/growl] required).
+- Libnotify notifications ({libnotify gem}[https://rubygems.org/gems/libnotify] required).
+- Tested on Ruby 1.8.6, 1.8.7 & 1.9.2.
 
 == Install
 
 Install the gem:
 
-    gem install guard
+    $ gem install guard
 
-Add it to your Gemfile (inside test group):
+Add it to your Gemfile (inside the <tt>test</tt> group):
 
     gem 'guard'
 
 Generate an empty Guardfile with:
 
-    guard init
+    $ guard init
 
-Add the guards you need (see available guards below)
+Add the guards you need to your Guardfile (see the existing guards below).
 
 === On Mac OS X
 
-Install rb-fsevent for {FSEvent}[http://en.wikipedia.org/wiki/FSEvents] support:
+Install the rb-fsevent gem for {FSEvent}[http://en.wikipedia.org/wiki/FSEvents] support:
 
-    gem install rb-fsevent
+    $ gem install rb-fsevent
 
-Install growl for Growl notification support:
+Install the Growl gem if you want notification support:
 
-    gem install growl
+    $ gem install growl
 
 And add it to you Gemfile:
 
@@ -45,13 +44,13 @@ And add it to you Gemfile:
 
 === On Linux
 
-Install rb-inotify for {inotify}[http://en.wikipedia.org/wiki/Inotify] support:
+Install the rb-inotify gem for {inotify}[http://en.wikipedia.org/wiki/Inotify] support:
 
-    gem install rb-inotify
+    $ gem install rb-inotify
 
-Install libnotify for libonity notification support:
+Install the Libnotify gem if you want notification support:
 
-    gem install libnotify
+    $ gem install libnotify
 
 And add it to you Gemfile:
 
@@ -61,79 +60,67 @@ And add it to you Gemfile:
 
 Just launch Guard inside your Ruby / Rails project with:
 
-    guard
+    $ guard [start]
 
 or if you use Bundler, to run the Guard executable specific to your bundle:
 
-    bundle exec guard
+    $ bundle exec guard
 
 == Command line options
 
 Shell can be cleared after each change with:
 
-    guard --clear
-    guard -c # shortcut
+    $ guard --clear
+    $ guard -c # shortcut
 
-The guards to start can be specified by group (see Guardfile DSL below) specifying the `--group` (or `-g`) option:
+Notifications (growl/libnotify) can be disabled with:
 
-    guard --group group_name another_group_name
-    guard -g group_name another_group_name # shortcut
+    $ guard --notify false
+    $ guard -n false # shortcut
+
+The guards to start can be specified by group (see the Guardfile DSL below) specifying the <tt>--group</tt> (or <tt>-g</tt>) option:
+
+    $ guard --group group_name another_group_name
+    $ guard -g group_name another_group_name # shortcut
 
 Options list is available with:
 
-    guard help [TASK]
+    $ guard help [TASK]
 
 == Signal handlers
 
 Signal handlers are used to interact with Guard:
 
-- Ctrl-C - Quit Guard (call each guard's run_all method, in the same order they are declared in the Guarfile)
-- Ctrl-\ - Call each guard's run_all method, in the same order they are declared in the Guarfile
-- Ctrl-Z - Call each guard's reload method, in the same order they are declared in the Guarfile
+- <tt>Ctrl-C</tt> - Calls each guard's <tt>stop</tt> method, in the same order they are declared in the Guardfile, and then quits Guard itself.
+- <tt>Ctrl-\\</tt>  - Calls each guard's <tt>run_all</tt> method, in the same order they are declared in the Guardfile.
+- <tt>Ctrl-Z</tt> - Calls each guard's <tt>reload</tt> method, in the same order they are declared in the Guardfile.
 
 == Available Guards
 
-- {guard-bundler}[https://github.com/guard/guard-bundler] by {Yann Lugrin}[https://github.com/yannlugrin]
-- {guard-coffeescript}[https://github.com/guard/guard-coffeescript] by {Michael Kessler}[https://github.com/netzpirat]
-- {guard-compass}[https://github.com/guard/guard-compass] by {Olivier Amblet}[https://github.com/oliamb]
-- {guard-cucumber}[https://github.com/guard/guard-cucumber] by {Michael Kessler}[https://github.com/netzpirat]
-- {guard-ego}[https://github.com/guard/guard-ego] by {Fabio Kuhn}[https://github.com/mordaroso]
-- {guard-jammit}[https://github.com/guard/guard-jammit] by {Pelle Braendgaard}[https://github.com/pelle]
-- {guard-less}[https://github.com/guard/guard-less] by {Brendan Erwin}[https://github.com/brendanjerwin]
-- {guard-livereload}[https://github.com/guard/guard-livereload] by {Thibaud Guillaume-Gentil}[https://github.com/thibaudgg]
-- {guard-minitest}[https://github.com/guard/guard-minitest] by {Yann Lugrin}[https://github.com/yannlugrin]
-- {guard-nanoc}[https://github.com/guard/guard-nanoc] by {Yann Lugrin}[https://github.com/yannlugrin]
-- {guard-passenger}[https://github.com/guard/guard-passenger] by {Fabio Kuhn}[https://github.com/mordaroso]
-- {guard-rspec}[https://github.com/guard/guard-rspec] by {Thibaud Guillaume-Gentil}[https://github.com/thibaudgg]
-- {guard-sass}[https://github.com/guard/guard-sass] by {Joshua Hawxwell}[https://github.com/hawx]
-- {guard-shell}[https://github.com/guard/guard-shell] by {Joshua Hawxwell}[https://github.com/hawx]
-- {guard-soca}[https://github.com/guard/guard-soca] by {Luke Amdor}[https://github.com/rubbish]
-- {guard-spork}[https://github.com/guard/guard-spork] by {Thibaud Guillaume-Gentil}[https://github.com/thibaudgg]
-- {guard-stendhal}[https://github.com/guard/guard-stendhal] by {Josep Mª Bach}[https://github.com/txus]
-- {guard-test}[https://github.com/guard/guard-test] by {Rémy Coutable}[https://github.com/rymai]
+{Available Guards list}[https://github.com/guard/guard/wiki/List-of-available-Guards] (on the wiki now)
 
 === Add a guard to your Guardfile
 
-Add it to your Gemfile (inside test group):
+Add it to your Gemfile (inside the <tt>test</tt> group):
 
     gem '<guard-name>'
 
-Add guard definition to your Guardfile by running this command:
+Insert default guard's definition to your Guardfile by running this command:
 
-    guard init <guard-name>
+    $ guard init <guard-name>
 
 You are good to go!
 
 == Guardfile DSL
 
-The Guardfile DSL consists of just three simple main methods: `guard`, `watch` & `group`.
+The Guardfile DSL consists of just three simple methods: <tt>guard</tt>, <tt>watch</tt> & <tt>group</tt>.
 
 Required:
-- The `guard` method allows you to add a guard with an optional options hash.
-- The `watch` method allows you to define which files are supervised per this guard. A optional block can be added to overwrite path sent to run_on_change guard method or launch simple command.
+- The <tt>guard</tt> method allows you to add a guard with an optional hash of options.
+- The <tt>watch</tt> method allows you to define which files are supervised by this guard. An optional block can be added to overwrite the paths sent to the <tt>run_on_change</tt> guard method or to launch any arbitrary command.
 
 Optional:
-- The `group` method allows you to group several guards. Groups to run can be specified with the Guard DSL option `--group` (or `-g`). This comes in handy especially when you have a huge Guardfile and want to focus your development.
+- The <tt>group</tt> method allows you to group several guards together. Groups to be run can be specified with the Guard DSL option <tt>--group</tt> (or <tt>-g</tt>). This comes in handy especially when you have a huge Guardfile and want to focus your development on a certain part.
 
 Example:
 
@@ -142,9 +129,9 @@ Example:
         watch('Gemfile')
       end
 
-      guard 'rspec' do
+      guard 'rspec', :cli => '--color --format doc' do
         # Regexp watch patterns are matched with Regexp#match
-        watch(%r{^spec/(.+)_spec\.rb})
+        watch(%r{^spec/.+_spec\.rb})
         watch(%r{^lib/(.+)\.rb})         { |m| "spec/lib/#{m[1]}_spec.rb" }
         watch(%r{^spec/models/.+\.rb})   { ["spec/models", "spec/acceptance"] }
         watch(%r{^spec/.+\.rb})          { `say hello` }
@@ -156,17 +143,17 @@ Example:
 
     group 'frontend' do
       guard 'coffeescript', :output => 'public/javascripts/compiled' do
-        watch(%r{app/coffeescripts/.+\.coffee})
+        watch(%r{^app/coffeescripts/.+\.coffee})
       end
 
       guard 'livereload' do
-        watch(%r{app/.+\.(erb|haml)})
+        watch(%r{^app/.+\.(erb|haml)})
       end
     end
 
-== Create a guard
+== Create a new guard
 
-Create a new guard is very easy, just create a new gem with this basic structure:
+Creating a new guard is very easy, just create a new gem (<tt>bundle gem</tt> if you use Bundler) with this basic structure:
 
     lib/
       guard/
@@ -175,7 +162,7 @@ Create a new guard is very easy, just create a new gem with this basic structure
             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:
+<tt>Guard::GuardName</tt> (in <tt>lib/guard/guard-name.rb</tt>) must inherit from <tt>Guard::Guard</tt> and should overwrite at least one of the five basic <tt>Guard::Guard</tt> instance methods. Example:
 
     require 'guard'
     require 'guard/guard'
@@ -183,42 +170,42 @@ lib/guard/guard-name.rb inherit from guard/guard and should overwrite at least o
     module Guard
       class GuardName < Guard
 
-        def initialize(watchers = [], options = {})
+        def initialize(watchers=[], options={})
           super
           # init stuff here, thx!
         end
 
-        # ================
-        # = Guard method =
-        # ================
+        # =================
+        # = Guard methods =
+        # =================
 
-        # If one of those methods raise an exception, the Guard instance
-        # will be removed from the active guard.
+        # If one of those methods raise an exception, the Guard::GuardName instance
+        # will be removed from the active guards.
 
-        # Call once when guard starts
+        # Called once when Guard starts
         # Please override initialize method to init stuff
         def start
           true
         end
 
-        # Call with Ctrl-C signal (when Guard quit)
+        # Called on Ctrl-C signal (when Guard quits)
         def stop
           true
         end
 
-        # Call with Ctrl-Z signal
+        # Called on Ctrl-Z signal
         # This method should be mainly used for "reload" (really!) actions like reloading passenger/spork/bundler/...
         def reload
           true
         end
 
-        # Call with Ctrl-/ signal
+        # Called on Ctrl-/ signal
         # This method should be principally used for long action like running all specs/tests/...
         def run_all
           true
         end
 
-        # Call on file(s) modifications
+        # Called on file(s) modifications
         def run_on_change(paths)
           true
         end
@@ -226,12 +213,12 @@ lib/guard/guard-name.rb inherit from guard/guard and should overwrite at least o
       end
     end
 
-Looks at available guards code for more concrete example.
+Please take a look at the existing guards' source code (see the list above) for more concrete example.
 
 == Development
 
-- Source hosted at {GitHub}[https://github.com/guard/guard]
-- Report issues/Questions/Feature requests on {GitHub Issues}[https://github.com/guard/guard/issues]
+- Source hosted at {GitHub}[https://github.com/guard/guard].
+- Report Issues/Questions/Feature requests on {GitHub Issues}[https://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.

data/lib/guard.rb

@@ -17,6 +17,9 @@ module Guard
       @options  = options
       @listener = Listener.select_and_init
       @guards   = []
+
+      Notifier.turn_off unless options[:notify]
+
       self
     end
 
@@ -50,7 +53,7 @@ module Guard
       new_modified_files = listener.modified_files([Dir.pwd + '/'], :all => true)
       listener.update_last_event
       unless new_modified_files.empty?
-        run_on_change_for_all_guards(new_modified_files)
+        run { run_on_change_for_all_guards(new_modified_files) }
       end
     end
 
@@ -82,20 +85,16 @@ module Guard
 
     def get_guard_class(name)
       require "guard/#{name.downcase}"
-      klasses = []
-      ObjectSpace.each_object(Class) do |klass|
-        klasses << klass if klass.to_s.downcase.match(/^guard::#{name.downcase}/)
-      end
-      klasses.first
+      self.const_get(self.constants.find{|klass_name| klass_name.to_s.downcase == name.downcase })
     rescue LoadError
       UI.error "Could not find gem 'guard-#{name}', please add it in your Gemfile."
     end
 
     def locate_guard(name)
-      `gem open guard-#{name} --latest --command echo`.chomp
+      `gem which guard/#{name}`.chomp
     rescue
       UI.error "Could not find 'guard-#{name}' gem path."
     end
 
   end
-end
+end

data/lib/guard/cli.rb

@@ -4,22 +4,23 @@ require 'guard/version'
 module Guard
   class CLI < Thor
     default_task :start
-    
-    method_option :clear, :type => :boolean, :default => false, :aliases => '-c', :banner => "Auto clear shell before each change/run_all/reload"
-    method_option :debug, :type => :boolean, :default => false, :aliases => '-d', :banner => "Print debug messages"
-    method_option :group, :type => :array,   :default => [],    :aliases => '-g', :banner => "Run only the passed groups"
-    
+
+    method_option :clear,  :type => :boolean, :default => false, :aliases => '-c', :banner => "Auto clear shell before each change/run_all/reload"
+    method_option :notify, :type => :boolean, :default => true,  :aliases => '-n', :banner => "Notifications feature (growl/libnotify)"
+    method_option :debug,  :type => :boolean, :default => false, :aliases => '-d', :banner => "Print debug messages"
+    method_option :group,  :type => :array,   :default => [],    :aliases => '-g', :banner => "Run only the passed groups"
+
     desc "start", "Starts Guard"
     def start
       ::Guard.start(options)
     end
-    
+
     desc "version", "Prints Guard's version information"
     def version
       ::Guard::UI.info "Guard version #{Guard::VERSION}"
     end
     map %w(-v --version) => :version
-    
+
     desc "init [GUARD]", "Generates a Guardfile into the current working directory, or insert the given GUARD"
     def init(guard_name = nil)
       if !File.exist?("Guardfile")
@@ -29,12 +30,12 @@ module Guard
         ::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.init(guard_name)
       end
     end
-    
+
   end
 end

data/lib/guard/listeners/linux.rb

@@ -60,6 +60,7 @@ module Guard
           update_last_event
 
           unless files.empty?
+            files.uniq!
             files.map! { |file| file.gsub("#{Dir.pwd}/", '') }
             callback.call(files)
             files.clear

data/lib/guard/notifier.rb

@@ -3,9 +3,13 @@ require 'pathname'
 
 module Guard
   module Notifier
-    
+
+    def self.turn_off
+      @disable = true
+    end
+
     def self.notify(message, options = {})
-      unless ENV["GUARD_ENV"] == "test"
+      unless @disable || ENV["GUARD_ENV"] == "test"
         image = options[:image] || :success
         title = options[:title] || "Guard"
         case Config::CONFIG['target_os']
@@ -20,9 +24,9 @@ module Guard
         end
       end
     end
-    
+
   private
-    
+
     def self.image_path(image)
       images_path = Pathname.new(File.dirname(__FILE__)).join('../../images')
       case image
@@ -37,7 +41,7 @@ module Guard
         image
       end
     end
-    
+
     def self.growl_installed?
       @installed ||= begin
         require 'growl'
@@ -47,7 +51,7 @@ module Guard
         false
       end
     end
-    
+
     def self.libnotify_installed?
       @installed ||= begin
         require 'libnotify'
@@ -57,6 +61,6 @@ module Guard
         false
       end
     end
-    
+
   end
 end

data/lib/guard/ui.rb

@@ -1,46 +1,46 @@
 module Guard
   module UI
     class << self
-      
+
       def info(message, options = {})
         unless ENV["GUARD_ENV"] == "test"
           reset_line if options[:reset]
           puts reset_color(message) if message != ''
         end
       end
-      
+
       def error(message, options = {})
         unless ENV["GUARD_ENV"] == "test"
           reset_line if options[:reset]
           puts "ERROR: #{message}"
         end
       end
-      
+
       def debug(message, options = {})
         unless ENV["GUARD_ENV"] == "test"
           reset_line if options[:reset]
           puts "DEBUG: #{message}" if ::Guard.options && ::Guard.options[:debug]
         end
       end
-      
+
       def reset_line
-        print "\r\e "
+        print "\r\e[0m"
       end
-      
+
       def clear
         system("clear;")
       end
-      
+
     private
-      
+
       def reset_color(text)
         color(text, "\e[0m")
       end
-      
+
       def color(text, color_code)
         "#{color_code}#{text}\e[0m"
       end
-      
+
     end
   end
 end

data/lib/guard/version.rb

@@ -1,3 +1,3 @@
 module Guard
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: guard
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Thibaud Guillaume-Gentil
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-19 00:00:00 +01:00
+date: 2011-04-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,12 +42,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 27
         segments: 
         - 2
-        - 4
+        - 5
         - 0
-        version: 2.4.0
+        version: 2.5.0
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -58,12 +58,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 23
         segments: 
         - 0
-        - 1
-        - 9
-        version: 0.1.9
+        - 2
+        - 0
+        version: 0.2.0
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -82,22 +82,6 @@ dependencies:
         version: 0.14.6
   type: :runtime
   version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: open_gem
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 4
-        - 2
-        version: 1.4.2
-  type: :runtime
-  version_requirements: *id005
 description: Guard is a command line tool to easily handle events on files modifications.
 email: 
 - thibaud@thibaud.me