guard 0.8.2 → 0.8.3

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.8.3 - October 1, 2011
+
+### Bugs fixes:
+
+- Pull request [#145](https://github.com/guard/guard/pull/145): Fix over-utilization of CPU in Interactor. ([@johnbintz][])
+
+### Improvement:
+
+- Pull request [#146](https://github.com/guard/guard/pull/146): Use a mutex instead of a lock for more efficient/simple locking. ([@f1sherman][])
+- Make Guard implementation of `:task_has_failed` simple. ([@netzpirat][])
+
 ## 0.8.2 - September 30, 2011
 
 ### Bugs fixes:
@@ -282,6 +293,7 @@
 [@dnagir]: https://github.com/dnagir
 [@docwhat]: https://github.com/docwhat
 [@etehtsea]: https://github.com/etehtsea
+[@f1sherman]: https://github.com/f1sherman
 [@fabioyamate]: https://github.com/fabioyamate
 [@fnichol]: https://github.com/fnichol
 [@Gazer]: https://github.com/Gazer

data/lib/guard.rb

@@ -1,3 +1,5 @@
+require 'thread'
+
 # Guard is the main module for all Guard related modules and classes.
 # Also other Guard implementation should use this namespace.
 #
@@ -39,6 +41,8 @@ module Guard
 
       debug_command_execution if @options[:debug]
 
+      @lock = Mutex.new
+
       self
     end
 
@@ -123,9 +127,6 @@ module Guard
     def stop
       UI.info 'Bye bye...', :reset => true
 
-      listener.lock
-      interactor.lock
-
       run_guard_task(:stop)
 
       listener.stop
@@ -151,13 +152,13 @@ module Guard
     # Pause Guard listening to file changes.
     #
     def pause
-      if listener.locked
+      if listener.paused?
         UI.info 'Un-paused files modification listening', :reset => true
         listener.clear_changed_files
-        listener.unlock
+        listener.run
       else
         UI.info 'Paused files modification listening', :reset => true
-        listener.lock
+        listener.pause
       end
     end
 
@@ -175,31 +176,27 @@ module Guard
     # @yield the block to run
     #
     def run
-      listener.lock
-      interactor.lock
-
       UI.clear if options[:clear]
 
-      begin
-        yield
-      rescue Interrupt
+      @lock.synchronize do
+        begin
+          yield
+        rescue Interrupt
+        end
       end
-
-      interactor.unlock
-      listener.unlock
     end
 
     # Loop through all groups and run the given task for each Guard.
     #
     # Stop the task run for the all Guards within a group if one Guard
-    # throws `:task_has_failed` and the group has its `:halt_on_fail` option to `true`.
+    # throws `:task_has_failed`.
     #
     # @param [Symbol] task the task to run
     # @param [Array<String>] files the list of files to pass to the task
     #
     def run_guard_task(task, files = nil)
       groups.each do |group|
-        catch group.options[:halt_on_fail] == true ? :task_has_failed : :no_catch do
+        catch :task_has_failed do
           guards(:group => group.name).each do |guard|
             if task == :run_on_change
               run_on_change_task(files, guard, task)
@@ -262,17 +259,22 @@ module Guard
 
     # Run a Guard task, but remove the Guard when his work leads to a system failure.
     #
+    # When the Group has `:halt_on_fail` disabled, we've to catch `:task_has_failed`
+    # here in order to avoid an uncaught throw error.
+    #
     # @param [Guard::Guard] guard the Guard to execute
     # @param [Symbol] task the task to run
     # @param [Array] args the arguments for the task
     # @raise [:task_has_failed] when task has failed
     #
     def run_supervised_task(guard, task, *args)
-      guard.hook("#{ task }_begin", *args)
-      result = guard.send(task, *args)
-      guard.hook("#{ task }_end", result)
+      catch guard_symbol(guard) do
+        guard.hook("#{ task }_begin", *args)
+        result = guard.send(task, *args)
+        guard.hook("#{ task }_end", result)
 
-      result
+        result
+      end
 
     rescue Exception => ex
       UI.error("#{ guard.class.name } failed to achieve its <#{ task.to_s }>, exception was:" +
@@ -284,6 +286,25 @@ module Guard
       ex
     end
 
+    # Get the symbol we have to catch when running a supervised task.
+    # If we are within a Guard group that has the `:halt_on_fail`
+    # option set, we do NOT catch it here, it will be catched at the
+    # group level.
+    #
+    # @see .run_guard_task
+    #
+    # @param [Guard::Guard] guard the Guard to execute
+    # @return [Symbol] the symbol to catch
+    #
+    def guard_symbol(guard)
+      if guard.group.class == Symbol
+        group = groups(guard.group)
+        group.options[:halt_on_fail] ? :no_catch : :task_has_failed
+      else
+        :task_has_failed
+      end
+    end
+
     # Add a Guard to use.
     #
     # @param [String] name the Guard name

data/lib/guard/interactor.rb

@@ -12,67 +12,27 @@ module Guard
   #
   class Interactor
 
-    class LockException < Exception; end
-    class UnlockException < Exception; end
-
-    attr_reader :locked
-
-    # Initialize the interactor in unlocked state.
-    #
-    def initialize
-      @locked = false
-    end
-
     # Start the interactor in its own thread.
     #
     def start
       return if ENV["GUARD_ENV"] == 'test'
 
       @thread = Thread.new do
-        loop do
-          begin
-            if !@locked && (entry = $stdin.gets)
-              entry.gsub! /\n/, ''
-              case entry
-                when 'stop', 'quit', 'exit', 's', 'q', 'e'
-                  ::Guard.stop
-                when 'reload', 'r', 'z'
-                  ::Guard::Dsl.reevaluate_guardfile
-                  ::Guard.reload
-                when 'pause', 'p'
-                  ::Guard.pause
-                else
-                  ::Guard.run_all
-              end
-            end
-          rescue LockException
-            lock
-          rescue UnlockException
-            unlock
+        while entry = $stdin.gets.chomp
+          entry.gsub! /\n/, ''
+          case entry
+            when 'stop', 'quit', 'exit', 's', 'q', 'e'
+              ::Guard.stop
+            when 'reload', 'r', 'z'
+              ::Guard::Dsl.reevaluate_guardfile
+              ::Guard.reload
+            when 'pause', 'p'
+              ::Guard.pause
+            else
+              ::Guard.run_all
           end
         end
       end
     end
-
-    # Lock the interactor.
-    #
-    def lock
-      if !@thread || @thread == Thread.current
-        @locked = true
-      else
-        @thread.raise(LockException)
-      end
-    end
-
-    # Unlock the interactor.
-    #
-    def unlock
-      if !@thread || @thread == Thread.current
-        @locked = false
-      else
-        @thread.raise(UnlockException)
-      end
-    end
-
   end
 end

data/lib/guard/listener.rb

@@ -19,7 +19,11 @@ module Guard
     DEFAULT_IGNORE_PATHS = %w[. .. .bundle .git log tmp vendor]
 
     attr_accessor :changed_files
-    attr_reader :directory, :ignore_paths, :locked
+    attr_reader :directory, :ignore_paths
+
+    def paused?
+      @paused
+    end
 
     # Select the appropriate listener implementation for the
     # current OS and initializes it.
@@ -52,7 +56,7 @@ module Guard
       @file_timestamp_hash      = {}
       @relativize_paths         = options.fetch(:relativize_paths, true)
       @changed_files            = []
-      @locked                   = false
+      @paused                   = false
       @ignore_paths             = DEFAULT_IGNORE_PATHS
       @ignore_paths            |= options[:ignore_paths] if options[:ignore_paths]
       @watch_all_modifications  = options.fetch(:watch_all_modifications, false)
@@ -68,7 +72,7 @@ module Guard
 
       Thread.new do
         loop do
-          if @changed_files != [] && !@locked
+          if @changed_files != [] && !@paused
             changed_files = @changed_files.dup
             clear_changed_files
             ::Guard.run_on_change(changed_files)
@@ -91,16 +95,16 @@ module Guard
     def stop
     end
 
-    # Lock the listener to ignore change events.
+    # Pause the listener to ignore change events.
     #
-    def lock
-      @locked = true
+    def pause
+      @paused = true
     end
 
-    # Unlock the listener to listen again to change events.
+    # Unpause the listener to listen again to change events.
     #
-    def unlock
-      @locked = false
+    def run
+      @paused = false
     end
 
     # Clear the list of changed files.

data/lib/guard/version.rb

@@ -1,6 +1,6 @@
 module Guard
   unless defined? Guard::VERSION
     # The current gem version of Guard
-    VERSION = '0.8.2'
+    VERSION = '0.8.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-30 00:00:00.000000000Z
+date: 2011-10-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70168902445600 !ruby/object:Gem::Requirement
+  requirement: &70160547964420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *70168902445600
+  version_requirements: *70160547964420
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70168902457840 !ruby/object:Gem::Requirement
+  requirement: &70160547963800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70168902457840
+  version_requirements: *70160547963800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70168902478500 !ruby/object:Gem::Requirement
+  requirement: &70160547962800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70168902478500
+  version_requirements: *70160547962800
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70168902484120 !ruby/object:Gem::Requirement
+  requirement: &70160547961820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.3.1
   type: :development
   prerelease: false
-  version_requirements: *70168902484120
+  version_requirements: *70160547961820
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70168902486840 !ruby/object:Gem::Requirement
+  requirement: &70160547961140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *70168902486840
+  version_requirements: *70160547961140
 - !ruby/object:Gem::Dependency
   name: kramdown
-  requirement: &70168902520560 !ruby/object:Gem::Requirement
+  requirement: &70160547960440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: 0.13.3
   type: :development
   prerelease: false
-  version_requirements: *70168902520560
+  version_requirements: *70160547960440
 description: Guard is a command line tool to easily handle events on file system modifications.
 email:
 - thibaud@thibaud.me