guard 0.4.0 → 0.5.0

data/lib/guard/listeners/darwin.rb

@@ -23,10 +23,13 @@ module Guard
 
     def self.usable?
       require 'rb-fsevent'
-      if !defined?(FSEvent::VERSION) || Gem::Version.new(FSEvent::VERSION) < Gem::Version.new('0.4.0')
+      if !defined?(FSEvent::VERSION) || (defined?(Gem::Version) &&
+          Gem::Version.new(FSEvent::VERSION) < Gem::Version.new('0.4.0'))
         UI.info "Please update rb-fsevent (>= 0.4.0)"
+        false
+      else
+        true
       end
-      true
     rescue LoadError
       UI.info "Please install rb-fsevent gem for Mac OSX FSEvents support"
       false

data/lib/guard/listeners/linux.rb

@@ -24,10 +24,13 @@ module Guard
 
     def self.usable?
       require 'rb-inotify'
-      if !defined?(INotify::VERSION) || Gem::Version.new(INotify::VERSION.join('.')) < Gem::Version.new('0.8.5')
+      if !defined?(INotify::VERSION) || (defined?(Gem::Version) &&
+          Gem::Version.new(INotify::VERSION.join('.')) < Gem::Version.new('0.8.5'))
         UI.info "Please update rb-inotify (>= 0.8.5)"
+        false
+      else
+        true
       end
-      true
     rescue LoadError
       UI.info "Please install rb-inotify gem for Linux inotify support"
       false
@@ -44,7 +47,8 @@ module Guard
     end
 
     def watch(directory)
-      worker.watch(directory, :recursive, :modify, :create) do |event|
+      # The event selection is based on https://github.com/guard/guard/wiki/Analysis-of-inotify-events-for-different-editors
+      worker.watch(directory, :recursive, :create, :move_self, :close_write) do |event|
         unless event.name == "" # Event on root directory
           @files << event.absolute_name
         end
@@ -55,18 +59,15 @@ module Guard
     def watch_change
       @watch_change = true
       until @stop
-        if Config::CONFIG['build'] =~ /java/ || IO.select([inotify.to_io], [], [], latency)
+        if RbConfig::CONFIG['build'] =~ /java/ || IO.select([inotify.to_io], [], [], latency)
           break if @stop
 
           sleep latency
           inotify.process
-          update_last_event
 
-          unless files.empty?
-            files.uniq!
-            callback.call( relativate_paths(files) )
-            files.clear
-          end
+          modified_files = modified_files(files.shift(files.size).map{|f| File.dirname(f) + '/' }.uniq)
+          update_last_event
+          callback.call(modified_files) unless modified_files.empty?
         end
       end
       @watch_change = false

data/lib/guard/listeners/windows.rb

@@ -2,8 +2,9 @@ module Guard
   class Windows < Listener
     attr_reader :fchange
 
-    def initialize
+    def initialize(*)
       super
+
       @fchange = FChange::Notifier.new
     end
 

data/lib/guard/notifier.rb

@@ -11,7 +11,7 @@ module Guard
 
     def self.turn_on
       ENV["GUARD_NOTIFY"] = 'true'
-      case Config::CONFIG['target_os']
+      case RbConfig::CONFIG['target_os']
       when /darwin/i
         require_growl
       when /linux/i
@@ -26,7 +26,7 @@ module Guard
         image = options.delete(:image) || :success
         title = options.delete(:title) || "Guard"
 
-        case Config::CONFIG['target_os']
+        case RbConfig::CONFIG['target_os']
         when /darwin/i
           notify_mac(title, message, image, options)
         when /linux/i
@@ -46,19 +46,19 @@ module Guard
     def self.notify_mac(title, message, image, options)
       require_growl # need for guard-rspec formatter that is called out of guard scope
       default_options = { :title => title, :icon => image_path(image), :name => "Guard" }
-      Growl.notify message, default_options.merge(options)
+      Growl.notify message, default_options.merge(options) if enabled?
     end
 
     def self.notify_linux(title, message, image, options)
       require_libnotify # need for guard-rspec formatter that is called out of guard scope
       default_options = { :body => message, :summary => title, :icon_path => image_path(image) }
-      Libnotify.show default_options.merge(options)
+      Libnotify.show default_options.merge(options) if enabled?
     end
 
     def self.notify_windows(title, message, image, options)
       require_rbnotifu # need for guard-rspec formatter that is called out of guard scope
       default_options = { :message => message, :title => title, :type => image_level(image), :time => 3 }
-      Notifu.show default_options.merge(options)
+      Notifu.show default_options.merge(options) if enabled?
     end
 
     def self.image_path(image)

data/lib/guard/ui.rb

@@ -12,7 +12,14 @@ module Guard
       def error(message, options = {})
         unless ENV["GUARD_ENV"] == "test"
           reset_line if options[:reset]
-          puts "ERROR: #{message}"
+          puts "#{color('ERROR:', ';31')} #{message}"
+        end
+      end
+
+      def deprecation(message, options = {})
+        unless ENV["GUARD_ENV"] == "test"
+          reset_line if options[:reset]
+          puts "#{color('DEPRECATION:', ';31')} #{message}"
         end
       end
 
@@ -24,11 +31,7 @@ module Guard
       end
 
       def reset_line
-        if color_enabled?
-          print "\r\e[0m"
-        else
-          print "\r\n"
-        end
+        print(color_enabled? ? "\r\e[0m" : "\r\n")
       end
 
       def clear
@@ -38,24 +41,21 @@ module Guard
     private
 
       def reset_color(text)
-        color(text, "\e[0m")
+        color(text, "")
       end
 
       def color(text, color_code)
-        if color_enabled?
-          return "#{color_code}#{text}\e[0m"
-        else
-          return text
-        end
+        color_enabled? ? "\e[0#{color_code}m#{text}\e[0m" : text
       end
 
       def color_enabled?
-        @color_enabled ||= if Config::CONFIG['target_os'] =~ /mswin|mingw/i
+        @color_enabled ||= if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
           unless ENV['ANSICON']
             begin
               require 'rubygems' unless ENV['NO_RUBYGEMS']
               require 'Win32/Console/ANSI'
             rescue LoadError
+              @color_enabled = false
               info "You must 'gem install win32console' to use color on Windows"
               false
             end

data/lib/guard/version.rb

@@ -1,3 +1,3 @@
 module Guard
-  VERSION = "0.4.0"
+  VERSION = "0.5.0" unless defined? Guard::VERSION
 end

data/lib/guard/watcher.rb

@@ -1,11 +1,11 @@
 module Guard
   class Watcher
     attr_accessor :pattern, :action
-    
+
     def initialize(pattern, action = nil)
       @pattern, @action = pattern, action
       @@warning_printed ||= false
-      
+
       # deprecation warning
       if @pattern.is_a?(String) && @pattern =~ /(^(\^))|(>?(\\\.)|(\.\*))|(\(.*\))|(\[.*\])|(\$$)/
         unless @@warning_printed
@@ -17,7 +17,7 @@ module Guard
         @pattern = Regexp.new(@pattern)
       end
     end
-    
+
     def self.match_files(guard, files)
       guard.watchers.inject([]) do |paths, watcher|
         files.each do |file|
@@ -33,7 +33,7 @@ module Guard
         paths.flatten.map { |p| p.to_s }
       end
     end
-    
+
     def self.match_files?(guards, files)
       guards.any? do |guard|
         guard.watchers.any? do |watcher|
@@ -41,7 +41,7 @@ module Guard
         end
       end
     end
-    
+
     def match_file?(file)
       if @pattern.is_a?(Regexp)
         file.match(@pattern)
@@ -49,14 +49,18 @@ module Guard
         file == @pattern ? [file] : nil
       end
     end
-    
+
+    def self.match_guardfile?(files)
+      files.any? { |file| "#{Dir.pwd}/#{file}" == Dsl.guardfile_path }
+    end
+
     def call_action(matches)
       begin
         @action.arity > 0 ? @action.call(matches) : @action.call
-      rescue
-        UI.error "Problem with watch action!"
+      rescue Exception => e
+        UI.error "Problem with watch action!\n#{e.message}\n\n#{e.backtrace.join("\n")}"
       end
     end
-    
+
   end
 end

data/lib/guard.rb

@@ -1,11 +1,12 @@
 module Guard
 
-  autoload :UI,         'guard/ui'
-  autoload :Dsl,        'guard/dsl'
-  autoload :Interactor, 'guard/interactor'
-  autoload :Listener,   'guard/listener'
-  autoload :Watcher,    'guard/watcher'
-  autoload :Notifier,   'guard/notifier'
+  autoload :UI,           'guard/ui'
+  autoload :Dsl,          'guard/dsl'
+  autoload :DslDescriber, 'guard/dsl_describer'
+  autoload :Interactor,   'guard/interactor'
+  autoload :Listener,     'guard/listener'
+  autoload :Watcher,      'guard/watcher'
+  autoload :Notifier,     'guard/notifier'
 
   class << self
     attr_accessor :options, :guards, :listener
@@ -22,22 +23,21 @@ module Guard
     end
 
     def start(options = {})
+      UI.clear if options[:clear]
       setup(options)
 
       Interactor.init_signal_traps
       Dsl.evaluate_guardfile(options)
 
-      if guards.empty?
-        UI.error "No guards found in Guardfile, please add at least one."
-      else
-        listener.on_change do |files|
-          run { run_on_change_for_all_guards(files) } if Watcher.match_files?(guards, files)
-        end
+      listener.on_change do |files|
+        Dsl.revaluate_guardfile if Watcher.match_guardfile?(files)
 
-        UI.info "Guard is now watching at '#{Dir.pwd}'"
-        guards.each { |guard| supervised_task(guard, :start) }
-        listener.start
+        run { run_on_change_for_all_guards(files) } if Watcher.match_files?(guards, files)
       end
+
+      UI.info "Guard is now watching at '#{Dir.pwd}'"
+      guards.each { |guard| supervised_task(guard, :start) }
+      listener.start
     end
 
     def run_on_change_for_all_guards(files)
@@ -58,11 +58,12 @@ module Guard
     # fire it if his work leads to a system failure
     def supervised_task(guard, task_to_supervise, *args)
       guard.send(task_to_supervise, *args)
-    rescue Exception
-      UI.error("#{guard.class.name} guard failed to achieve its <#{task_to_supervise.to_s}> command: #{$!}")
+    rescue Exception => ex
+      UI.error("#{guard.class.name} failed to achieve its <#{task_to_supervise.to_s}>, exception was:" +
+      "\n#{ex.class}: #{ex.message}\n#{ex.backtrace.join("\n")}")
       guards.delete guard
-      UI.info("Guard #{guard.class.name} has just been fired")
-      return $!
+      UI.info("\n#{guard.class.name} has just been fired")
+      return ex
     end
 
     def run
@@ -76,20 +77,30 @@ module Guard
     end
 
     def add_guard(name, watchers = [], options = {})
-      guard_class = get_guard_class(name)
-      @guards << guard_class.new(watchers, options)
+      if name.downcase == 'ego'
+        UI.deprecation("Guard::Ego is now part of Guard you can removed it from your Guardfile.")
+      else
+        guard_class = get_guard_class(name)
+        @guards << guard_class.new(watchers, options)
+      end
     end
 
     def get_guard_class(name)
-      try_to_load_gem(name)
-      self.const_get(self.constants.find { |klass_name| klass_name.to_s.downcase == name.to_s.downcase.gsub('-', '') })
-    rescue TypeError
-      UI.error "Could not find load find gem 'guard-#{name}' or find class Guard::#{name}"
-    end
-
-    def try_to_load_gem(name)
-      require "guard/#{name.to_s.downcase}"
-    rescue LoadError
+      try_require = false
+      const_name = name.to_s.downcase.gsub('-', '')
+      begin
+        require "guard/#{name.to_s.downcase}" if try_require
+        self.const_get(self.constants.find {|c| c.to_s.downcase == const_name })
+      rescue TypeError
+        unless try_require
+          try_require = true
+          retry
+        else
+          UI.error "Could not find class Guard::#{const_name.capitalize}"
+        end
+      rescue LoadError
+        UI.error "Could not load 'guard/#{name.downcase}' or find class Guard::#{const_name.capitalize}"
+      end
     end
 
     def locate_guard(name)

data/man/guard.1

@@ -0,0 +1,70 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GUARD" "1" "June 2011" "" ""
+.
+.SH "NAME"
+\fBguard\fR \- Guard keeps an eye on your file modifications\.
+.
+.SH "SYNOPSIS"
+guard \fIcommand\fR \fIoptions\fR
+.
+.SH "DESCRIPTION"
+Guard is a command line tool that easily handle events on files modifications\.
+.
+.SH "HOMEPAGE"
+https://github\.com/guard/guard
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-c\fR, \fB\-\-clear\fR
+Clears the Shell after each change\.
+.
+.TP
+\fB\-n\fR \fIflag\fR, \fB\-\-notify\fR \fIflag\fR
+Disable notifications (Growl or Libnotify depending on your system)\. Note that notifications can also be disabled globally by setting a GUARD_NOTIFY environment variable to false\. The \fIflag\fR part can be passed to guard using true/false or t/f\.
+.
+.TP
+\fB\-g\fR \fIgroup\fR \.\.\., \fB\-\-group\fR \fIgroup\fR \.\.\.
+Runs only the groups specified\.
+.
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+Runs Guard in debug mode\.
+.
+.TP
+\fB\-h\fR
+List all of Guard\'s available commands\.
+.
+.SH "COMMANDS"
+.
+.TP
+\fBstart\fR
+Starts Guard\. This is the default command if none is provided\.
+.
+.TP
+\fBinit\fR [guard]
+Add the requested guard\'s default Guardfile configuration to the current Guardfile\.
+.
+.TP
+\fBshow\fR, \fB\-T\fR
+List defined groups and guards for the current Guardfile\.
+.
+.SH "EXAMPLES"
+\fB[bundle exec] guard \-\-clear \-\-group backend frontend \-\-notify false \-\-debug\fR
+.
+.P
+or in a more concise way:
+.
+.P
+\fB[bundle exec] guard \-c \-g backend frontend \-n f \-d\fR
+.
+.SH "AUTHORS / CONTRIBUTORS"
+Thibaud Guillaume\-Gentil is the main author\.
+.
+.P
+A list of contributors based on all commits can be found here: https://github\.com/guard/guard/contributors
+.
+.P
+For an exhaustive list of all the contributors, please see the CHANGELOG: https://github\.com/guard/guard/blob/master/CHANGELOG\.md

data/man/guard.1.html

@@ -0,0 +1,138 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>guard(1) - Guard keeps an eye on your file modifications.</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#HOMEPAGE">HOMEPAGE</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#COMMANDS">COMMANDS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#AUTHORS-CONTRIBUTORS">AUTHORS / CONTRIBUTORS</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>guard(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>guard(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>guard</code> - <span class="man-whatis">Guard keeps an eye on your file modifications.</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p>guard <var>command</var> <var>options</var></p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p>Guard is a command line tool that easily handle events on files modifications.</p>
+
+<h2 id="HOMEPAGE">HOMEPAGE</h2>
+
+<p>https://github.com/guard/guard</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<dl>
+<dt><code>-c</code>, <code>--clear</code></dt><dd><p>Clears the Shell after each change.</p></dd>
+<dt><code>-n</code> <var>flag</var>, <code>--notify</code> <var>flag</var></dt><dd><p>Disable notifications (Growl or Libnotify depending on your system).
+Note that notifications can also be disabled globally by setting a GUARD_NOTIFY environment variable to false.
+The <var>flag</var> part can be passed to guard using true/false or t/f.</p></dd>
+<dt><code>-g</code> <var>group</var> ..., <code>--group</code> <var>group</var> ...</dt><dd><p>Runs only the groups specified.</p></dd>
+<dt><code>-d</code>, <code>--debug</code></dt><dd><p>Runs Guard in debug mode.</p></dd>
+<dt class="flush"><code>-h</code></dt><dd><p>List all of Guard's available commands.</p></dd>
+</dl>
+
+
+<h2 id="COMMANDS">COMMANDS</h2>
+
+<dl>
+<dt class="flush"><code>start</code></dt><dd><p>Starts Guard. This is the default command if none is provided.</p></dd>
+<dt><code>init</code> [guard]</dt><dd><p>Add the requested guard's default Guardfile configuration to the current Guardfile.</p></dd>
+<dt><code>show</code>, <code>-T</code></dt><dd><p>List defined groups and guards for the current Guardfile.</p></dd>
+</dl>
+
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<p><code>[bundle exec] guard --clear --group backend frontend --notify false --debug</code></p>
+
+<p>or in a more concise way:</p>
+
+<p><code>[bundle exec] guard -c -g backend frontend -n f -d</code></p>
+
+<h2 id="AUTHORS-CONTRIBUTORS">AUTHORS / CONTRIBUTORS</h2>
+
+<p>Thibaud Guillaume-Gentil is the main author.</p>
+
+<p>A list of contributors based on all commits can be found here:
+https://github.com/guard/guard/contributors</p>
+
+<p>For an exhaustive list of all the contributors, please see the CHANGELOG:
+https://github.com/guard/guard/blob/master/CHANGELOG.md</p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>June 2011</li>
+    <li class='tr'>guard(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>