guard 2.7.2 → 2.7.3

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.orig

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

data/lib/guard/guardfile/evaluator.rb

@@ -22,6 +22,7 @@ module Guard
       # content of a valid Guardfile
       #
       def initialize(opts = {})
+        @evaluated = false
         @source = nil
         @guardfile_path = nil
 
@@ -81,8 +82,8 @@ module 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)
+        /^\s*guard\s*\(?\s*['":]#{ plugin_name }['"]?/.
+          match _guardfile_contents_without_user_config
       end
 
       # Gets the content of the `Guardfile` concatenated with the global
@@ -106,6 +107,7 @@ module Guard
       # @return [String] the Guardfile content
       #
       def _guardfile_contents_without_user_config
+        fail "BUG: no data - Guardfile wasn't evaluated" unless @evaluated
         @guardfile_contents || ""
       end
 
@@ -124,6 +126,7 @@ module Guard
       #
       def _fetch_guardfile_contents
         _use_inline || _use_provided || _use_default
+        @evaluated = true
 
         return if _guardfile_contents_usable?
         ::Guard::UI.error "No Guard plugins found in Guardfile,"\

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
+        _instance_eval_guardfile(guardfile_contents)
+        ::Guard.add_builtin_plugins(guardfile_path)
+      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(:_pluginless_guardfile?)
+          ::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

data/lib/guard/notifiers/base.rb.orig

@@ -0,0 +1,221 @@
+require "rbconfig"
+require "guard/ui"
+
+module Guard
+  module Notifier
+    # Base class for all notifiers.
+    #
+    class Base
+      HOSTS = {
+        darwin:  "Mac OS X",
+        linux:   "Linux",
+        freebsd: "FreeBSD",
+        openbsd: "OpenBSD",
+        sunos:   "SunOS",
+        solaris: "Solaris",
+        mswin:   "Windows",
+        mingw:   "Windows",
+        cygwin:  "Windows"
+      }
+
+      ERROR_ADD_GEM_AND_RUN_BUNDLE = "Please add \"gem '%s'\" to your Gemfile "\
+        "and run Guard with \"bundle exec\"."
+
+      attr_reader :options
+
+      def initialize(opts = {})
+        @options = opts
+      end
+
+      # This method should be overriden by subclasses and return an array of
+      # OSes the notifier supports. By default, it returns :all which mean
+      # there's no check against the current OS.
+      #
+      # @see HOSTS for the list of possible OSes
+      #
+      def self.supported_hosts
+        :all
+      end
+
+      # Test if the notifier can be used.
+      #
+      # @param [Hash] opts notifier options
+      # @option opts [Boolean] silent true if no error messages should be shown
+      # @return [Boolean] the availability status
+      #
+      def self.available?(opts = {})
+        if _supported_host?
+          true
+        else
+          hosts = supported_hosts.map { |host| HOSTS[host.to_sym] }.join(", ")
+          unless opts.fetch(:silent) { false }
+            ::Guard::UI.error "The :#{name} notifier runs only on #{hosts}."
+          end
+          false
+        end
+      end
+
+      # This method must be overriden.
+      #
+      def notify(_message, opts = {})
+        options.delete(:silent)
+        opts.replace(options.merge(opts))
+        normalize_standard_options!(opts)
+      end
+
+      # Returns the title of the notifier.
+      #
+      # @example Un-modulize the class name
+      #   Guard::Notifier::FileNotifier.title
+      #   #=> 'FileNotifier'
+      #
+      # @return [String] the title of the notifier
+      #
+      def self.title
+        to_s.sub(/.+::(\w+)$/, '\1')
+      end
+
+      # Returns the name of the notifier.
+      #
+      # @example Un-modulize, underscorize and downcase the class name
+      #   Guard::Notifier::FileNotifier.name
+      #   #=> 'file_notifier'
+      #
+      # @return [String] the name of the notifier
+      #
+      def self.name
+        title.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+      end
+
+      # Returns the name of the notifier's gem. By default it returns the
+      # notifier name. This method can be overriden by subclasses.
+      #
+      # @example Un-modulize, underscorize and downcase the class name
+      #   Guard::Notifier::FileNotifier.gem_name
+      #   #=> 'file_notifier'
+      #
+      # @return [String] the name of the notifier's gem
+      #
+      def self.gem_name
+        name
+      end
+
+      # This method tries to require the gem whose name is returned by
+      # `.gem_name`. If a LoadError or NameError occurs, it displays an error
+      # message (unless opts[:silent] is true) and returns false.
+      #
+      # @param [Hash] opts some options
+      # @option opts [Boolean] silent true if no error messages should be shown
+      #
+      # @return [Boolean] whether or not the gem is loaded
+      #
+      def self.require_gem_safely(opts = {})
+        require gem_name
+        true
+      rescue LoadError, NameError
+        unless opts[:silent]
+          UI.error ERROR_ADD_GEM_AND_RUN_BUNDLE % [gem_name]
+        end
+        false
+      end
+
+      # Returns the title of the notifier.
+      #
+      # @example Un-modulize the class name
+      #   Guard::Notifier::FileNotifier.new.title
+      #   #=> 'FileNotifier'
+      #
+      # @return [String] the title of the notifier
+      #
+      def title
+        self.class.title
+      end
+
+      # Returns the name of the notifier.
+      #
+      # @example Un-modulize, underscorize and downcase the class name
+      #   Guard::Notifier::FileNotifier.new.name
+      #   #=> 'file_notifier'
+      #
+      # @return [String] the name of the notifier
+      #
+      def name
+        self.class.name
+      end
+
+      # Paths where all Guard images are located
+      #
+      # @return [Pathname] the path to the images directory
+      #
+      def images_path
+        @images_path ||= Pathname.new(__FILE__).dirname + "../../../images"
+      end
+
+      # @private
+      #
+      # Checks if the current OS is supported by the notifier.
+      #
+      # @see .supported_hosts
+      #
+      def self._supported_host?
+        supported_hosts == :all ||
+        RbConfig::CONFIG["host_os"] =~ /#{supported_hosts.join('|')}/
+      end
+
+      # Set or modify the `:title`, `:type` and `:image` options for a
+      # notification. Should be used in `#notify`.
+      #
+      # @param [Hash] opts additional notification library options
+      # @option opts [String] type the notification type. Either 'success',
+      #   'pending', 'failed' or 'notify'
+      # @option opts [String] title the notification title
+      # @option opts [String] image the path to the notification image
+      #
+      def normalize_standard_options!(opts)
+        opts[:title] ||= "Guard"
+        opts[:type]  ||= _notification_type(opts.fetch(:image, :success))
+        opts[:image]   = _image_path(opts.delete(:image) { :success })
+      end
+
+      private
+
+      # Get the image path for an image symbol for the following
+      # known image types:
+      #
+      # - failed
+      # - pending
+      # - success
+      #
+      # If the image is not a known symbol, it will be returned unmodified.
+      #
+      # @param [Symbol, String] image the image symbol or path to an image
+      #
+      # @return [String] the image path
+      #
+      def _image_path(image)
+        case image
+        when :failed, :pending, :success
+          images_path.join("#{image}.png").to_s
+        else
+          image
+        end
+      end
+
+      # Get the notification type depending on the
+      # image that has been selected for the notification.
+      #
+      # @param [Symbol, String] image the image symbol or path to an image
+      #
+      # @return [String] the notification type
+      #
+      def _notification_type(image)
+        case image
+        when :failed, :pending, :success
+          image
+        else
+          :notify
+        end
+      end
+    end
+  end
+end