guard 2.6.1 → 2.7.0

data/lib/guard/plugin_util.rb

@@ -1,7 +1,6 @@
-require 'guard/ui'
+require "guard/ui"
 
 module Guard
-
   # This class contains useful methods to:
   #
   # * Fetch all the Guard plugins names;
@@ -10,6 +9,11 @@ module Guard
   # * Add its template to the Guardfile.
   #
   class PluginUtil
+    ERROR_NO_GUARD_OR_CLASS = "Could not load 'guard/%s' or'\
+    ' find class Guard::%s"
+
+    INFO_ADDED_GUARD_TO_GUARDFILE = "%s guard added to Guardfile,"\
+      " feel free to edit it"
 
     attr_accessor :name
 
@@ -18,18 +22,27 @@ module Guard
     # @return [Array<String>] a list of Guard plugin gem names
     #
     def self.plugin_names
-      if Gem::Version.create(Gem::VERSION) >= Gem::Version.create('1.8.0')
+      if Gem::Version.create(Gem::VERSION) >= Gem::Version.create("1.8.0")
         Gem::Specification.find_all.select do |x|
           if x.name =~ /^guard-/
             true
-          elsif x.name != 'guard'
-            guard_plugin_path = File.join(x.full_gem_path, "lib/guard/#{ x.name }.rb")
-            File.exists?( guard_plugin_path )
+          elsif x.name != "guard"
+
+            guard_plugin_path = File.join(
+              x.full_gem_path,
+              "lib/guard/#{ x.name }.rb"
+            )
+
+            File.exist?(guard_plugin_path)
           end
         end
       else
+        ::Guard::UI.deprecation \
+          "Rubygems version prior to 1.8.0 are no longer supported"\
+          " and may not work"
+
         Gem.source_index.find_name(/^guard-/)
-      end.map { |x| x.name.sub(/^guard-/, '') }.uniq
+      end.map { |x| x.name.sub(/^guard-/, "") }.uniq
     end
 
     # Initializes a new `Guard::PluginUtil` object.
@@ -37,7 +50,7 @@ module Guard
     # @param [String] name the name of the Guard plugin
     #
     def initialize(name)
-      @name = name.to_s.sub(/^guard-/, '')
+      @name = name.to_s.sub(/^guard-/, "")
     end
 
     # Initializes a new `Guard::Plugin` with the given `options` hash. This
@@ -45,16 +58,18 @@ module Guard
     # class as well as plugins that inherit from `Guard::Plugin`.
     #
     # @see Guard::Plugin
-    # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to upgrade for Guard 2.0
+    # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
+    # upgrade for Guard 2.0
     #
     # @return [Guard::Plugin] the initialized plugin
     # @return [Guard::Guard] the initialized plugin. This return type is
     #   deprecated and the plugin's maintainer should update it to be
     #   compatible with Guard 2.0. For more information on how to upgrade for
-    #   Guard 2.0, please head over to: https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0
+    #   Guard 2.0, please head over to:
+    #   https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0
     #
     def initialize_plugin(options)
-      if plugin_class.superclass.to_s == 'Guard::Guard'
+      if plugin_class.superclass.to_s == "Guard::Guard"
         plugin_class.new(options.delete(:watchers), options)
       else
         plugin_class.new(options)
@@ -67,7 +82,7 @@ module Guard
     #
     def plugin_location
       @plugin_location ||= begin
-        if Gem::Version.create(Gem::VERSION) >= Gem::Version.create('1.8.0')
+        if Gem::Version.create(Gem::VERSION) >= Gem::Version.create("1.8.0")
           Gem::Specification.find_by_name("guard-#{ name }").full_gem_path
         else
           Gem.source_index.find_name("guard-#{ name }").last.full_gem_path
@@ -89,7 +104,9 @@ module Guard
     #
     # * `rspec` will find a class `Guard::RSpec`
     #
-    # @option options [Boolean] fail_gracefully whether error messages should not be printed
+    # @option options [Boolean] fail_gracefully whether error messages should
+    # not be printed
+    #
     # @return [Class, nil] the loaded class
     #
     def plugin_class(options = {})
@@ -100,18 +117,18 @@ module Guard
         require "guard/#{ name.downcase }" if try_require
 
         @plugin_class ||= ::Guard.const_get(_plugin_constant)
-      rescue TypeError => typeError
+      rescue TypeError => error
         if try_require
           ::Guard::UI.error "Could not find class Guard::#{ _constant_name }"
-          ::Guard::UI.error typeError.backtrace.join("\n")
+          ::Guard::UI.error error.backtrace.join("\n")
         else
           try_require = true
           retry
         end
-      rescue LoadError => loadError
+      rescue LoadError => error
         unless options[:fail_gracefully]
-          ::Guard::UI.error "Could not load 'guard/#{ name.downcase }' or find class Guard::#{ _constant_name }"
-          ::Guard::UI.error loadError.backtrace.join("\n")
+          UI.error ERROR_NO_GUARD_OR_CLASS % [name.downcase, _constant_name]
+          UI.error error.backtrace.join("\n")
         end
       end
     end
@@ -119,17 +136,19 @@ module Guard
     # Adds a plugin's template to the Guardfile.
     #
     def add_to_guardfile
+      msg = "Guard.evaluator not initialized"
+      fail msg if ::Guard.evaluator.nil?
       if ::Guard.evaluator.guardfile_include?(name)
         ::Guard::UI.info "Guardfile already includes #{ name } guard"
       else
-        content = File.read('Guardfile')
-        File.open('Guardfile', 'wb') do |f|
+        content = File.read("Guardfile")
+        File.open("Guardfile", "wb") do |f|
           f.puts(content)
-          f.puts('')
+          f.puts("")
           f.puts(plugin_class.template(plugin_location))
         end
 
-        ::Guard::UI.info "#{ name } guard added to Guardfile, feel free to edit it"
+        UI.info INFO_ADDED_GUARD_TO_GUARDFILE % name
       end
     end
 
@@ -142,7 +161,9 @@ module Guard
     #   => Guard::RSpec
     #
     def _plugin_constant
-      @_plugin_constant ||= ::Guard.constants.find { |c| c.to_s.downcase == _constant_name.downcase }
+      @_plugin_constant ||= ::Guard.constants.detect do |c|
+        c.to_s.downcase == _constant_name.downcase
+      end
     end
 
     # Guesses the most probable name for the current plugin based on its name.
@@ -152,8 +173,8 @@ module Guard
     #   => "Rspec"
     #
     def _constant_name
-      @_constant_name ||= name.gsub(/\/(.?)/) { "::#{ $1.upcase }" }.gsub(/(?:^|[_-])(.)/) { $1.upcase }
+      @_constant_name ||= name.gsub(/\/(.?)/) { "::#{ $1.upcase }" }.
+        gsub(/(?:^|[_-])(.)/) { $1.upcase }
     end
-
   end
 end

data/lib/guard/plugin_util.rb.orig

@@ -0,0 +1,178 @@
+require "guard/ui"
+
+module Guard
+  # This class contains useful methods to:
+  #
+  # * Fetch all the Guard plugins names;
+  # * Initialize a plugin, get its location;
+  # * Return its class name;
+  # * Add its template to the Guardfile.
+  #
+  class PluginUtil
+    ERROR_NO_GUARD_OR_CLASS = "Could not load 'guard/%s' or'\
+    ' find class Guard::%s"
+
+    INFO_ADDED_GUARD_TO_GUARDFILE = "%s guard added to Guardfile,"\
+      " feel free to edit it"
+
+    attr_accessor :name
+
+    # Returns a list of Guard plugin Gem names installed locally.
+    #
+    # @return [Array<String>] a list of Guard plugin gem names
+    #
+    def self.plugin_names
+      if Gem::Version.create(Gem::VERSION) >= Gem::Version.create("1.8.0")
+        Gem::Specification.find_all.select do |x|
+          if x.name =~ /^guard-/
+            true
+          elsif x.name != "guard"
+
+            guard_plugin_path = File.join(
+              x.full_gem_path,
+              "lib/guard/#{ x.name }.rb"
+            )
+
+            File.exist?(guard_plugin_path)
+          end
+        end
+      else
+        ::Guard::UI.deprecation \
+          "Rubygems version prior to 1.8.0 are no longer supported"\
+          " and may not work"
+
+        Gem.source_index.find_name(/^guard-/)
+      end.map { |x| x.name.sub(/^guard-/, "") }.uniq
+    end
+
+    # Initializes a new `Guard::PluginUtil` object.
+    #
+    # @param [String] name the name of the Guard plugin
+    #
+    def initialize(name)
+      @name = name.to_s.sub(/^guard-/, "")
+    end
+
+    # Initializes a new `Guard::Plugin` with the given `options` hash. This
+    # methods handles plugins that inherit from the deprecated `Guard::Guard`
+    # class as well as plugins that inherit from `Guard::Plugin`.
+    #
+    # @see Guard::Plugin
+    # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
+    # upgrade for Guard 2.0
+    #
+    # @return [Guard::Plugin] the initialized plugin
+    # @return [Guard::Guard] the initialized plugin. This return type is
+    #   deprecated and the plugin's maintainer should update it to be
+    #   compatible with Guard 2.0. For more information on how to upgrade for
+    #   Guard 2.0, please head over to:
+    #   https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0
+    #
+    def initialize_plugin(options)
+      if plugin_class.superclass.to_s == "Guard::Guard"
+        plugin_class.new(options.delete(:watchers), options)
+      else
+        plugin_class.new(options)
+      end
+    end
+
+    # Locates a path to a Guard plugin gem.
+    #
+    # @return [String] the full path to the plugin gem
+    #
+    def plugin_location
+      @plugin_location ||= begin
+        if Gem::Version.create(Gem::VERSION) >= Gem::Version.create("1.8.0")
+          Gem::Specification.find_by_name("guard-#{ name }").full_gem_path
+        else
+          Gem.source_index.find_name("guard-#{ name }").last.full_gem_path
+        end
+      end
+    rescue
+      ::Guard::UI.error "Could not find 'guard-#{ name }' gem path."
+    end
+
+    # Tries to load the Guard plugin main class. This transforms the supplied
+    # plugin name into a class name:
+    #
+    # * `guardname` will become `Guard::Guardname`
+    # * `dashed-guard-name` will become `Guard::DashedGuardName`
+    # * `underscore_guard_name` will become `Guard::UnderscoreGuardName`
+    #
+    # When no class is found with the strict case sensitive rules, another
+    # try is made to locate the class without matching case:
+    #
+    # * `rspec` will find a class `Guard::RSpec`
+    #
+    # @option options [Boolean] fail_gracefully whether error messages should
+    # not be printed
+    #
+    # @return [Class, nil] the loaded class
+    #
+    def plugin_class(options = {})
+      options = { fail_gracefully: false }.merge(options)
+
+      try_require = false
+      begin
+        require "guard/#{ name.downcase }" if try_require
+
+        @plugin_class ||= ::Guard.const_get(_plugin_constant)
+      rescue TypeError => error
+        if try_require
+          ::Guard::UI.error "Could not find class Guard::#{ _constant_name }"
+          ::Guard::UI.error error.backtrace.join("\n")
+        else
+          try_require = true
+          retry
+        end
+      rescue LoadError => error
+        unless options[:fail_gracefully]
+          UI.error ERROR_NO_GUARD_OR_CLASS % [name.downcase, _constant_name]
+          UI.error error.backtrace.join("\n")
+        end
+      end
+    end
+
+    # Adds a plugin's template to the Guardfile.
+    #
+    def add_to_guardfile
+      if ::Guard.evaluator.guardfile_include?(name)
+        ::Guard::UI.info "Guardfile already includes #{ name } guard"
+      else
+        content = File.read("Guardfile")
+        File.open("Guardfile", "wb") do |f|
+          f.puts(content)
+          f.puts("")
+          f.puts(plugin_class.template(plugin_location))
+        end
+
+        UI.info INFO_ADDED_GUARD_TO_GUARDFILE % name
+      end
+    end
+
+    private
+
+    # Returns the constant for the current plugin.
+    #
+    # @example Returns the constant for a plugin
+    #   > Guard::PluginUtil.new('rspec').send(:_plugin_constant)
+    #   => Guard::RSpec
+    #
+    def _plugin_constant
+      @_plugin_constant ||= ::Guard.constants.detect do |c|
+        c.to_s.downcase == _constant_name.downcase
+      end
+    end
+
+    # Guesses the most probable name for the current plugin based on its name.
+    #
+    # @example Returns the most probable name for a plugin
+    #   > Guard::PluginUtil.new('rspec').send(:_constant_name)
+    #   => "Rspec"
+    #
+    def _constant_name
+      @_constant_name ||= name.gsub(/\/(.?)/) { "::#{ $1.upcase }" }.
+        gsub(/(?:^|[_-])(.)/) { $1.upcase }
+    end
+  end
+end

data/lib/guard/rake_task.rb

@@ -1,17 +1,15 @@
 #!/usr/bin/env ruby
 
-require 'rake'
-require 'rake/tasklib'
+require "rake"
+require "rake/tasklib"
 
-require 'guard/cli'
+require "guard/cli"
 
 module Guard
-
   # Provides a method to define a Rake task that
   # runs the Guard plugins.
   #
   class RakeTask < ::Rake::TaskLib
-
     # Name of the main, top level task
     attr_accessor :name
 
@@ -24,7 +22,7 @@ module Guard
     # @param [String] options the CLI options
     # @yield [Guard::RakeTask] the task
     #
-    def initialize(name = :guard, options = '')
+    def initialize(name = :guard, options = "")
       @name = name
       @options = options
 
@@ -42,6 +40,5 @@ module Guard
 
       end
     end
-
   end
 end

data/lib/guard/reevaluator.rb

@@ -0,0 +1,13 @@
+require "guard"
+require "guard/plugin"
+
+module Guard
+  class Reevaluator < Guard::Plugin
+    def run_on_modifications(files)
+      return unless ::Guard::Watcher.match_guardfile?(files)
+      ::Guard.save_scope
+      ::Guard.evaluator.reevaluate_guardfile
+      ::Guard.restore_scope
+    end
+  end
+end

data/lib/guard/runner.rb

@@ -1,18 +1,18 @@
-require 'lumberjack'
+require "lumberjack"
 
-require 'guard/ui'
-require 'guard/watcher'
+require "guard/ui"
+require "guard/watcher"
 
 module Guard
-
   # The runner is responsible for running all methods defined on each plugin.
   #
   class Runner
-
     # Runs a Guard-task on all registered plugins.
     #
     # @param [Symbol] task the task to run
-    # @param [Hash] scopes either the Guard plugin or the group to run the task on
+    #
+    # @param [Hash] scopes either the Guard plugin or the group to run the task
+    # on
     #
     # @see self.run_supervised_task
     #
@@ -24,7 +24,10 @@ module Guard
       end
     end
 
-    MODIFICATION_TASKS = [:run_on_modifications, :run_on_changes, :run_on_change]
+    MODIFICATION_TASKS = [
+      :run_on_modifications, :run_on_changes, :run_on_change
+    ]
+
     ADDITION_TASKS     = [:run_on_additions, :run_on_changes, :run_on_change]
     REMOVAL_TASKS      = [:run_on_removals, :run_on_changes, :run_on_deletion]
 
@@ -36,30 +39,32 @@ module Guard
     # @param [Array<String>] removed the removed paths.
     #
     def run_on_changes(modified, added, removed)
-      ::Guard::UI.clearable
+      types = {
+        MODIFICATION_TASKS => modified,
+        ADDITION_TASKS => added,
+        REMOVAL_TASKS => removed
+      }
 
-      #TODO: this should be handled like every other plugin
-      if ::Guard::Watcher.match_guardfile?(modified)
-        ::Guard.evaluator.reevaluate_guardfile
-      end
+      ::Guard::UI.clearable
 
       _scoped_plugins do |guard|
-        modified_paths = ::Guard::Watcher.match_files(guard, modified)
-        added_paths    = ::Guard::Watcher.match_files(guard, added)
-        removed_paths  = ::Guard::Watcher.match_files(guard, removed)
+        ::Guard::UI.clear
 
-        ::Guard::UI.clear if _clearable?(guard, modified_paths, added_paths, removed_paths)
+        types.each do |tasks, unmatched_paths|
+          paths = ::Guard::Watcher.match_files(guard, unmatched_paths)
+          next if paths.empty?
 
-        _run_first_task_found(guard, MODIFICATION_TASKS, modified_paths) unless modified_paths.empty?
-        _run_first_task_found(guard, ADDITION_TASKS, added_paths) unless added_paths.empty?
-        _run_first_task_found(guard, REMOVAL_TASKS, removed_paths) unless removed_paths.empty?
+          next unless (task = tasks.detect { |meth| guard.respond_to?(meth) })
+          run_supervised_task(guard, task, paths)
+        end
       end
     end
 
-    # Run a Guard plugin task, but remove the Guard plugin when his work leads to a system failure.
+    # Run a Guard plugin task, but remove the Guard plugin 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.
+    # 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::Plugin] guard the Guard to execute
     # @param [Symbol] task the task to run
@@ -67,27 +72,24 @@ module Guard
     # @raise [:task_has_failed] when task has failed
     #
     def run_supervised_task(guard, task, *args)
-      begin
-        catch self.class.stopping_symbol_for(guard) do
-          guard.hook("#{ task }_begin", *args)
-          begin
-            result = guard.send(task, *args)
-          rescue Interrupt
-            throw(:task_has_failed)
-          end
-          guard.hook("#{ task }_end", result)
-          result
+      catch self.class.stopping_symbol_for(guard) do
+        guard.hook("#{ task }_begin", *args)
+        begin
+          result = guard.send(task, *args)
+        rescue Interrupt
+          throw(:task_has_failed)
         end
-
-      rescue Exception => ex
-        ::Guard::UI.error("#{ guard.class.name } failed to achieve its <#{ task.to_s }>, exception was:" +
-                 "\n#{ ex.class }: #{ ex.message }\n#{ ex.backtrace.join("\n") }")
-
-        ::Guard.plugins.delete guard
-        ::Guard::UI.info("\n#{ guard.class.name } has just been fired")
-
-        ex
+        guard.hook("#{ task }_end", result)
+        result
       end
+    rescue ScriptError, StandardError, RuntimeError
+      ::Guard::UI.error("#{ guard.class.name } failed to achieve its"\
+                        " <#{ task }>, exception was:" \
+                        "\n#{ $!.class }: #{ $!.message }" \
+                        "\n#{ $!.backtrace.join("\n") }")
+      ::Guard.plugins.delete guard
+      ::Guard::UI.info("\n#{ guard.class.name } has just been fired")
+      $!
     end
 
     # Returns the symbol that has to be caught when running a supervised task.
@@ -106,24 +108,6 @@ module Guard
 
     private
 
-    # Tries to run the first implemented task by a given guard
-    # from a collection of tasks.
-    #
-    # @param [Guard::Plugin] guard the Guard plugin to run the first found task on
-    # @param [Array<Symbol>] tasks the tasks to run the first among
-    # @param [Object] task_param the param to pass to each task
-    #
-    def _run_first_task_found(guard, tasks, task_param)
-      tasks.each do |task|
-        if guard.respond_to?(task)
-          run_supervised_task(guard, task, task_param)
-          break
-        else
-          ::Guard::UI.debug "Trying to run #{ guard.class.name }##{ task.to_s } with #{ task_param.inspect }"
-        end
-      end
-    end
-
     # Loop through all groups and run the given task for each Guard plugin.
     #
     # If no scope is supplied, the global Guard scope is taken into account.
@@ -151,27 +135,14 @@ module Guard
             end
           end
 
-          if block_return.nil?
-            ::Guard::UI.info "#{ current_plugin.class.name } has failed, other group's plugins execution has been halted."
-          end
+          next unless block_return.nil?
+
+          ::Guard::UI.info "#{ current_plugin.class.name } has failed,"\
+            " other group's plugins execution has been halted."
         end
       end
     end
 
-    # Logic to know if the UI can be cleared or not in the run_on_changes method
-    # based on the guard and the changes.
-    #
-    # @param [Guard::Plugin] guard the Guard plugin where run_on_changes is called
-    # @param [Array<String>] modified_paths the modified paths.
-    # @param [Array<String>] added_paths the added paths.
-    # @param [Array<String>] removed_paths the removed paths.
-    #
-    def _clearable?(guard, modified_paths, added_paths, removed_paths)
-      (MODIFICATION_TASKS.any? { |task| guard.respond_to?(task) } && !modified_paths.empty?) ||
-      (ADDITION_TASKS.any? { |task| guard.respond_to?(task) } && !added_paths.empty?) ||
-      (REMOVAL_TASKS.any? { |task| guard.respond_to?(task) } && !removed_paths.empty?)
-    end
-
     # Returns the current plugins scope.
     # Local plugins scope wins over global plugins scope.
     # If no plugins scope is found, then NO plugins are returned.
@@ -205,12 +176,13 @@ module Guard
     # Find the first non empty element in the given possibilities
     #
     def _find_non_empty_scope(type, local_scope, *additional_possibilities)
-      [
+      found = [
         local_scope[:"#{type}s"],
         local_scope[type.to_sym],
         ::Guard.scope[:"#{type}s"],
         additional_possibilities.flatten
-      ].compact.find { |a| !Array(a).empty? }
+      ].compact.detect { |a| !Array(a).empty? }
+      found ? [::Guard.group(:common)] + Array(found) : found
     end
 
     # Find the first non empty plugins scope