guard 2.6.1 → 2.7.0

data/lib/guard/guard.rb.orig

@@ -0,0 +1,42 @@
+require "guard/plugin/base"
+
+module Guard
+  # @deprecated Inheriting from `Guard::Guard` is deprecated, please inherit
+  #   from {Plugin} instead. Please note that the constructor signature has
+  #   changed from `Guard::Guard#initialize(watchers = [], options = {})` to
+  #   `Guard::Plugin#initialize(options = {})`.
+  #
+  # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
+  #   upgrade for Guard 2.0
+  #
+  class Guard
+    include ::Guard::Plugin::Base
+
+    # @deprecated Inheriting from `Guard::Guard` is deprecated, please inherit
+    #   from {Plugin} instead. Please note that the constructor signature
+    #   has changed from `Guard::Guard#initialize(watchers = [], options = {})`
+    #   to `Guard::Plugin#initialize(options = {})`.
+    #
+    # Initializes a Guard plugin. Don't do any work here,
+    #   especially as Guard plugins get initialized even if they are not in an
+    #   active group!
+    #
+    # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
+    #   upgrade for Guard 2.0
+    #
+    # @param [Array<Guard::Watcher>] watchers the Guard plugin file watchers
+    # @param [Hash] options the custom Guard plugin options
+    # @option options [Symbol] group the group this Guard plugin belongs to
+    # @option options [Boolean] any_return allow any object to be returned from
+    #   a watcher
+    # @option options [Boolean] first_match stop after the first watcher that
+    #   returns a valid result
+    #
+    def initialize(watchers = [], options = {})
+      UI.deprecation(Deprecator::GUARD_GUARD_DEPRECATION % title)
+
+      _set_instance_variables_from_options(options.merge(watchers: watchers))
+      _register_callbacks
+    end
+  end
+end

data/lib/guard/guardfile.rb

@@ -1,9 +1,8 @@
-require 'guard/guardfile/evaluator'
-require 'guard/guardfile/generator'
-require 'guard/ui'
+require "guard/guardfile/evaluator"
+require "guard/guardfile/generator"
+require "guard/ui"
 
 module Guard
-
   # @deprecated Use instance methods of {Guardfile::Evaluator} and
   #  {Guardfile::Generator} instead.
   #
@@ -11,34 +10,34 @@ module Guard
   # @see Guardfile::Generator
   #
   module Guardfile
-
     # @deprecated Use {Guardfile::Generator#create_guardfile} instead.
     #
-    # @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
     #
     def self.create_guardfile(options = {})
-      ::Guard::UI.deprecation(::Guard::Deprecator::CREATE_GUARDFILE_DEPRECATION)
+      UI.deprecation(Deprecator::CREATE_GUARDFILE_DEPRECATION)
       Generator.new(options).create_guardfile
     end
 
     # @deprecated Use {Guardfile::Generator#initialize_template} instead.
     #
-    # @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
     #
     def self.initialize_template(plugin_name)
-      ::Guard::UI.deprecation(::Guard::Deprecator::INITIALIZE_TEMPLATE_DEPRECATION)
+      UI.deprecation(Deprecator::INITIALIZE_TEMPLATE_DEPRECATION)
       Generator.new.initialize_template(plugin_name)
     end
 
     # @deprecated Use {Guardfile::Generator#initialize_all_templates} instead.
     #
-    # @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
     #
     def self.initialize_all_templates
-      ::Guard::UI.deprecation(::Guard::Deprecator::INITIALIZE_ALL_TEMPLATES_DEPRECATION)
+      UI.deprecation(Deprecator::INITIALIZE_ALL_TEMPLATES_DEPRECATION)
       Generator.new.initialize_all_templates
     end
-
   end
-
 end

data/lib/guard/guardfile/evaluator.rb

@@ -1,24 +1,35 @@
-require 'guard/options'
+require "guard/options"
+require "guard/plugin"
 
 module Guard
   module Guardfile
-
-    # This class is responsible for evaluating the Guardfile. It delegates
-    # to Guard::Dsl for the actual objects generation from the Guardfile content.
+    # This class is responsible for evaluating the Guardfile. It delegates to
+    # Guard::Dsl for the actual objects generation from the Guardfile content.
     #
     # @see Guard::Dsl
     #
     class Evaluator
+      attr_reader :options, :guardfile_path
 
-      attr_reader :options, :guardfile_source, :guardfile_path
+      def guardfile_source
+        @source
+      end
 
       # Initializes a new Guard::Guardfile::Evaluator object.
       #
       # @option opts [String] guardfile the path to a valid Guardfile
-      # @option opts [String] guardfile_contents a string representing the content of a valid Guardfile
+      # @option opts [String] guardfile_contents a string representing the
+      # content of a valid Guardfile
       #
       def initialize(opts = {})
-        @options = ::Guard::Options.new(opts.select { |k, _| [:guardfile, :guardfile_contents].include?(k.to_sym) })
+        @source = nil
+        @guardfile_path = nil
+
+        valid_options = opts.select do |k, _|
+          [:guardfile, :guardfile_contents].include?(k.to_sym)
+        end
+
+        @options = ::Guard::Options.new(valid_options)
       end
 
       # Evaluates the DSL methods in the `Guardfile`.
@@ -26,14 +37,20 @@ module Guard
       # @example Programmatically evaluate a Guardfile
       #   Guard::Guardfile::Evaluator.new.evaluate_guardfile
       #
-      # @example Programmatically evaluate a Guardfile with a custom Guardfile path
-      #   Guard::Guardfile::Evaluator.new(guardfile: '/Users/guardfile/MyAwesomeGuardfile').evaluate_guardfile
+      # @example Programmatically evaluate a Guardfile with a custom Guardfile
+      # path
+      #
+      #   options = { guardfile: '/Users/guardfile/MyAwesomeGuardfile' }
+      #   Guard::Guardfile::Evaluator.new(options).evaluate_guardfile
       #
       # @example Programmatically evaluate a Guardfile with an inline Guardfile
-      #   Guard::Guardfile::Evaluator.new(guardfile_contents: 'guard :rspec').evaluate_guardfile
+      #
+      #   options = { guardfile_contents: 'guard :rspec' }
+      #   Guard::Guardfile::Evaluator.new(options).evaluate_guardfile
       #
       def evaluate_guardfile
         _fetch_guardfile_contents
+        ::Guard.add_builtin_plugins(guardfile_path)
         _instance_eval_guardfile(guardfile_contents)
       end
 
@@ -42,7 +59,7 @@ module Guard
       #
       def reevaluate_guardfile
         # Don't re-evaluate inline Guardfile
-        return if @guardfile_source == :inline
+        return if @source == :inline
 
         _before_reevaluate_guardfile
         evaluate_guardfile
@@ -51,7 +68,9 @@ module Guard
 
       # Tests if the current `Guardfile` contains a specific Guard plugin.
       #
-      # @example Programmatically test if a Guardfile contains a specific Guard plugin
+      # @example Programmatically test if a Guardfile contains a specific Guard
+      # plugin
+      #
       #   File.read('Guardfile')
       #   => "guard :rspec"
       #
@@ -62,7 +81,8 @@ module Guard
       # @return [Boolean] whether the Guard plugin has been declared
       #
       def guardfile_include?(plugin_name)
-        _guardfile_contents_without_user_config.match(/^guard\s*\(?\s*['":]#{ plugin_name }['"]?/)
+        regexp = /^guard\s*\(?\s*['":]#{ plugin_name }['"]?/
+        _guardfile_contents_without_user_config.match(regexp)
       end
 
       # Gets the content of the `Guardfile` concatenated with the global
@@ -86,7 +106,7 @@ module Guard
       # @return [String] the Guardfile content
       #
       def _guardfile_contents_without_user_config
-        @guardfile_contents || ''
+        @guardfile_contents || ""
       end
 
       # Evaluates the content of the `Guardfile`.
@@ -94,7 +114,7 @@ module Guard
       # @param [String] contents the content to evaluate.
       #
       def _instance_eval_guardfile(contents)
-        ::Guard::Dsl.new.instance_eval(contents, @guardfile_path || '', 1)
+        ::Guard::Dsl.new.instance_eval(contents, @guardfile_path || "", 1)
       rescue => ex
         ::Guard::UI.error "Invalid Guardfile, original error is:\n#{ $! }"
         raise ex
@@ -103,62 +123,60 @@ module Guard
       # Gets the content to evaluate and stores it into @guardfile_contents.
       #
       def _fetch_guardfile_contents
-        _use_inline_guardfile || _use_provided_guardfile || _use_default_guardfile
+        _use_inline || _use_provided || _use_default
 
-        unless _guardfile_contents_usable?
-          ::Guard::UI.error 'No Guard plugins found in Guardfile, please add at least one.'
-        end
+        return if _guardfile_contents_usable?
+        ::Guard::UI.error "No Guard plugins found in Guardfile,"\
+          " please add at least one."
       end
 
       # Use the provided inline Guardfile if provided.
       #
-      def _use_inline_guardfile
-        if (@guardfile_source.nil? && options[:guardfile_contents]) || @guardfile_source == :inline
+      def _use_inline
+        source_from_option = @source.nil? && options[:guardfile_contents]
+        inline = @source == :inline
 
-          @guardfile_source   = :inline
-          @guardfile_contents = options[:guardfile_contents]
+        return false unless (source_from_option) || inline
 
-          ::Guard::UI.info 'Using inline Guardfile.'
+        @source   = :inline
+        @guardfile_contents = options[:guardfile_contents]
 
-          true
-        else
-          false
-        end
+        ::Guard::UI.info "Using inline Guardfile."
+        true
       end
 
       # Try to use the provided Guardfile. Exits Guard if the Guardfile cannot
       # be found.
       #
-      def _use_provided_guardfile
-        if (@guardfile_source.nil? && options[:guardfile]) || @guardfile_source == :custom
+      def _use_provided
+        source_from_file = @source.nil? && options[:guardfile]
+        return false unless source_from_file || (@source == :custom)
 
-          @guardfile_source = :custom
-
-          options[:guardfile] = File.expand_path(options[:guardfile])
-          if File.exist?(options[:guardfile])
-            _read_guardfile(options[:guardfile])
-            ::Guard::UI.info "Using Guardfile at #{ options[:guardfile] }."
-            true
-          else
-            ::Guard::UI.error "No Guardfile exists at #{ options[:guardfile] }."
-            exit 1
-          end
+        @source = :custom
 
+        options[:guardfile] = File.expand_path(options[:guardfile])
+        if File.exist?(options[:guardfile])
+          _read_guardfile(options[:guardfile])
+          ::Guard::UI.info "Using Guardfile at #{ options[:guardfile] }."
           true
         else
-          false
+          ::Guard::UI.error "No Guardfile exists at #{ options[:guardfile] }."
+          exit 1
         end
+
+        true
       end
 
       # Try to use one of the default Guardfiles (local or home Guardfile).
       # Exits Guard if no Guardfile is found.
       #
-      def _use_default_guardfile
+      def _use_default
         if guardfile_path = _find_default_guardfile
-          @guardfile_source = :default
+          @source = :default
           _read_guardfile(guardfile_path)
         else
-          ::Guard::UI.error 'No Guardfile found, please create one with `guard init`.'
+          ::Guard::UI.error \
+            "No Guardfile found, please create one with `guard init`."
           exit 1
         end
       end
@@ -167,7 +185,9 @@ module Guard
       # or nil otherwise.
       #
       def _find_default_guardfile
-        [_local_guardfile_path, _home_guardfile_path].find { |path| File.exist?(path) }
+        [_local_guardfile_path, _home_guardfile_path].detect do |path|
+          File.exist?(path)
+        end
       end
 
       # Reads the current `Guardfile` content.
@@ -201,13 +221,17 @@ module Guard
       def _after_reevaluate_guardfile
         ::Guard::Notifier.turn_on if ::Guard::Notifier.enabled?
 
-        if ::Guard.plugins.empty?
-          ::Guard::Notifier.notify('No plugins found in Guardfile, please add at least one.', title: 'Guard re-evaluate', image: :failed)
+        if !::Guard.send(:_non_builtin_plugins?)
+          ::Guard::Notifier.notify(
+            "No plugins found in Guardfile, please add at least one.",
+            title: "Guard re-evaluate",
+            image: :failed)
         else
-          msg = 'Guardfile has been re-evaluated.'
+          msg = "Guardfile has been re-evaluated."
           ::Guard::UI.info(msg)
-          ::Guard::Notifier.notify(msg, title: 'Guard re-evaluate')
+          ::Guard::Notifier.notify(msg, title: "Guard re-evaluate")
 
+          ::Guard.setup_scope
           ::Guard.runner.run(:start)
         end
       end
@@ -226,7 +250,7 @@ module Guard
       # @return [String] the path to the local Guardfile
       #
       def _local_guardfile_path
-        File.expand_path(File.join(Dir.pwd, 'Guardfile'))
+        File.expand_path(File.join(Dir.pwd, "Guardfile"))
       end
 
       # The path to the `.Guardfile` that is located at
@@ -235,7 +259,7 @@ module Guard
       # @return [String] the path to `~/.Guardfile`
       #
       def _home_guardfile_path
-        File.expand_path(File.join('~', '.Guardfile'))
+        File.expand_path(File.join("~", ".Guardfile"))
       end
 
       # The path to the user configuration `.guard.rb`
@@ -244,10 +268,8 @@ module Guard
       # @return [String] the path to `~/.guard.rb`
       #
       def _user_config_path
-        File.expand_path(File.join('~', '.guard.rb'))
+        File.expand_path(File.join("~", ".guard.rb"))
       end
-
     end
-
   end
 end

data/lib/guard/guardfile/evaluator.rb.orig

@@ -0,0 +1,275 @@
+require "guard/options"
+require "guard/plugin"
+
+module Guard
+  module Guardfile
+    # This class is responsible for evaluating the Guardfile. It delegates to
+    # Guard::Dsl for the actual objects generation from the Guardfile content.
+    #
+    # @see Guard::Dsl
+    #
+    class Evaluator
+      attr_reader :options, :guardfile_path
+
+      def guardfile_source
+        @source
+      end
+
+      # Initializes a new Guard::Guardfile::Evaluator object.
+      #
+      # @option opts [String] guardfile the path to a valid Guardfile
+      # @option opts [String] guardfile_contents a string representing the
+      # content of a valid Guardfile
+      #
+      def initialize(opts = {})
+        @source = nil
+        @guardfile_path = nil
+
+        valid_options = opts.select do |k, _|
+          [:guardfile, :guardfile_contents].include?(k.to_sym)
+        end
+
+        @options = ::Guard::Options.new(valid_options)
+      end
+
+      # Evaluates the DSL methods in the `Guardfile`.
+      #
+      # @example Programmatically evaluate a Guardfile
+      #   Guard::Guardfile::Evaluator.new.evaluate_guardfile
+      #
+      # @example Programmatically evaluate a Guardfile with a custom Guardfile
+      # path
+      #
+      #   options = { guardfile: '/Users/guardfile/MyAwesomeGuardfile' }
+      #   Guard::Guardfile::Evaluator.new(options).evaluate_guardfile
+      #
+      # @example Programmatically evaluate a Guardfile with an inline Guardfile
+      #
+      #   options = { guardfile_contents: 'guard :rspec' }
+      #   Guard::Guardfile::Evaluator.new(options).evaluate_guardfile
+      #
+      def evaluate_guardfile
+        _fetch_guardfile_contents
+        ::Guard.add_builtin_plugins
+        _instance_eval_guardfile(guardfile_contents)
+      end
+
+      # Re-evaluates the `Guardfile` to update
+      # the current Guard configuration.
+      #
+      def reevaluate_guardfile
+        # Don't re-evaluate inline Guardfile
+        return if @source == :inline
+
+        _before_reevaluate_guardfile
+        evaluate_guardfile
+        _after_reevaluate_guardfile
+      end
+
+      # Tests if the current `Guardfile` contains a specific Guard plugin.
+      #
+      # @example Programmatically test if a Guardfile contains a specific Guard
+      # plugin
+      #
+      #   File.read('Guardfile')
+      #   => "guard :rspec"
+      #
+      #   Guard::Guardfile::Evaluator.new.guardfile_include?('rspec)
+      #   => true
+      #
+      # @param [String] plugin_name the name of the Guard
+      # @return [Boolean] whether the Guard plugin has been declared
+      #
+      def guardfile_include?(plugin_name)
+        regexp = /^guard\s*\(?\s*['":]#{ plugin_name }['"]?/
+        _guardfile_contents_without_user_config.match(regexp)
+      end
+
+      # Gets the content of the `Guardfile` concatenated with the global
+      # user configuration file.
+      #
+      # @example Programmatically get the content of the current Guardfile
+      #   Guard::Guardfile::Evaluator.new.guardfile_contents
+      #   => "guard :rspec"
+      #
+      # @return [String] the Guardfile content
+      #
+      def guardfile_contents
+        config = File.read(_user_config_path) if File.exist?(_user_config_path)
+        [_guardfile_contents_without_user_config, config].compact.join("\n")
+      end
+
+      private
+
+      # Gets the content of the `Guardfile`.
+      #
+      # @return [String] the Guardfile content
+      #
+      def _guardfile_contents_without_user_config
+        @guardfile_contents || ""
+      end
+
+      # Evaluates the content of the `Guardfile`.
+      #
+      # @param [String] contents the content to evaluate.
+      #
+      def _instance_eval_guardfile(contents)
+        ::Guard::Dsl.new.instance_eval(contents, @guardfile_path || "", 1)
+      rescue => ex
+        ::Guard::UI.error "Invalid Guardfile, original error is:\n#{ $! }"
+        raise ex
+      end
+
+      # Gets the content to evaluate and stores it into @guardfile_contents.
+      #
+      def _fetch_guardfile_contents
+        _use_inline || _use_provided || _use_default
+
+        return if _guardfile_contents_usable?
+        ::Guard::UI.error "No Guard plugins found in Guardfile,"\
+          " please add at least one."
+      end
+
+      # Use the provided inline Guardfile if provided.
+      #
+      def _use_inline
+        source_from_option = @source.nil? && options[:guardfile_contents]
+        inline = @source == :inline
+
+        return false unless (source_from_option) || inline
+
+        @source   = :inline
+        @guardfile_contents = options[:guardfile_contents]
+
+        ::Guard::UI.info "Using inline Guardfile."
+        true
+      end
+
+      # Try to use the provided Guardfile. Exits Guard if the Guardfile cannot
+      # be found.
+      #
+      def _use_provided
+        source_from_file = @source.nil? && options[:guardfile]
+        return false unless source_from_file || (@source == :custom)
+
+        @source = :custom
+
+        options[:guardfile] = File.expand_path(options[:guardfile])
+        if File.exist?(options[:guardfile])
+          _read_guardfile(options[:guardfile])
+          ::Guard::UI.info "Using Guardfile at #{ options[:guardfile] }."
+          true
+        else
+          ::Guard::UI.error "No Guardfile exists at #{ options[:guardfile] }."
+          exit 1
+        end
+
+        true
+      end
+
+      # Try to use one of the default Guardfiles (local or home Guardfile).
+      # Exits Guard if no Guardfile is found.
+      #
+      def _use_default
+        if guardfile_path = _find_default_guardfile
+          @source = :default
+          _read_guardfile(guardfile_path)
+        else
+          ::Guard::UI.error \
+            "No Guardfile found, please create one with `guard init`."
+          exit 1
+        end
+      end
+
+      # Returns the first default Guardfile (either local or home Guardfile)
+      # or nil otherwise.
+      #
+      def _find_default_guardfile
+        [_local_guardfile_path, _home_guardfile_path].detect do |path|
+          File.exist?(path)
+        end
+      end
+
+      # Reads the current `Guardfile` content.
+      #
+      # @param [String] guardfile_path the path to the Guardfile
+      #
+      def _read_guardfile(guardfile_path)
+        @guardfile_path     = guardfile_path
+        @guardfile_contents = File.read(guardfile_path)
+      rescue => ex
+        ::Guard::UI.error "Error reading file #{ guardfile_path }:"
+        ::Guard::UI.error ex.inspect
+        ::Guard::UI.error ex.backtrace
+        exit 1
+      end
+
+      # Stops Guard and clear internal state
+      # before the Guardfile will be re-evaluated.
+      #
+      def _before_reevaluate_guardfile
+        ::Guard.runner.run(:stop)
+        ::Guard.reset_groups
+        ::Guard.reset_plugins
+        ::Guard.reset_scope
+        ::Guard::Notifier.clear_notifiers
+      end
+
+      # Starts Guard and notification and show a message
+      # after the Guardfile has been re-evaluated.
+      #
+      def _after_reevaluate_guardfile
+        ::Guard::Notifier.turn_on if ::Guard::Notifier.enabled?
+
+        if !::Guard.send(:_non_builtin_plugins?)
+          ::Guard::Notifier.notify(
+            "No plugins found in Guardfile, please add at least one.",
+            title: "Guard re-evaluate",
+            image: :failed)
+        else
+          msg = "Guardfile has been re-evaluated."
+          ::Guard::UI.info(msg)
+          ::Guard::Notifier.notify(msg, title: "Guard re-evaluate")
+
+          ::Guard.setup_scope
+          ::Guard.runner.run(:start)
+        end
+      end
+
+      # Tests if the current `Guardfile` content is usable.
+      #
+      # @return [Boolean] if the Guardfile is usable
+      #
+      def _guardfile_contents_usable?
+        guardfile_contents && guardfile_contents =~ /guard/m
+      end
+
+      # The path to the `Guardfile` that is located at
+      # the directory, where Guard has been started from.
+      #
+      # @return [String] the path to the local Guardfile
+      #
+      def _local_guardfile_path
+        File.expand_path(File.join(Dir.pwd, "Guardfile"))
+      end
+
+      # The path to the `.Guardfile` that is located at
+      # the users home directory.
+      #
+      # @return [String] the path to `~/.Guardfile`
+      #
+      def _home_guardfile_path
+        File.expand_path(File.join("~", ".Guardfile"))
+      end
+
+      # The path to the user configuration `.guard.rb`
+      # that is located at the users home directory.
+      #
+      # @return [String] the path to `~/.guard.rb`
+      #
+      def _user_config_path
+        File.expand_path(File.join("~", ".guard.rb"))
+      end
+    end
+  end
+end