guard 2.7.0 → 2.7.1

data/lib/guard/dsl_describer.rb.orig

@@ -1,184 +0,0 @@
-# encoding: utf-8
-require "formatador"
-
-require "guard/guardfile/evaluator"
-require "guard/ui"
-
-module Guard
-  # The DslDescriber evaluates the Guardfile and creates an internal structure
-  # of it that is used in some inspection utility methods like the CLI commands
-  # `show` and `list`.
-  #
-  # @see Guard::Dsl
-  # @see Guard::CLI
-  #
-  class DslDescriber
-    attr_reader :options
-
-    # Initializes a new DslDescriber object.
-    #
-    # @option options [String] guardfile the path to a valid Guardfile
-    #
-    # @option options [String] guardfile_contents a string representing the
-    # content of a valid Guardfile
-    #
-    # @see Guard::Guardfile::Evaluator#initialize
-    #
-    def initialize(options = {})
-      @options = options
-      ::Guard.reset_groups
-      ::Guard.reset_plugins
-      ::Guard.reset_scope
-    end
-
-    # List the Guard plugins that are available for use in your system and marks
-    # those that are currently used in your `Guardfile`.
-    #
-    # @see CLI#list
-    #
-    def list
-      _evaluate_guardfile
-
-      names = ::Guard::PluginUtil.plugin_names.sort.uniq
-      final_rows = names.inject([]) do |rows, name|
-        rows << {
-          Plugin: name.capitalize,
-          Guardfile: ::Guard.plugins(name) ? "✔" : "✘"
-        }
-      end
-
-      Formatador.display_compact_table(final_rows, [:Plugin, :Guardfile])
-    end
-
-    # Shows all Guard plugins and their options that are defined in
-    # the `Guardfile`.
-    #
-    # @see CLI#show
-    #
-    def show
-      _evaluate_guardfile
-      groups = ::Guard.groups
-
-      final_rows = groups.each_with_object([]) do |group, rows|
-
-        plugins = Array(::Guard.plugins(group: group.name))
-
-        plugins.each do |plugin|
-          options = plugin.options.inject({}) do |o, (k, v)|
-            o.tap { |option| option[k.to_s] = v }
-          end.sort
-
-          if options.empty?
-            rows << :split
-            rows << {
-              Group: group.title,
-              Plugin: plugin.title,
-              Option: "",
-              Value: ""
-            }
-          else
-            options.each_with_index do |(option, value), index|
-              if index == 0
-                rows << :split
-                rows << {
-                  Group: group.title,
-                  Plugin: plugin.title,
-                  Option: option.to_s,
-                  Value: value.inspect
-                }
-              else
-                rows << {
-                  Group: "",
-                  Plugin: "",
-                  Option: option.to_s,
-                  Value: value.inspect
-                }
-              end
-            end
-          end
-        end
-
-        rows
-      end
-
-      Formatador.display_compact_table(
-        final_rows.drop(1),
-        [:Group, :Plugin, :Option, :Value]
-      )
-    end
-
-    # Shows all notifiers and their options that are defined in
-    # the `Guardfile`.
-    #
-    # @see CLI#show
-    #
-    def notifiers
-      _evaluate_guardfile
-
-      merged_notifiers = ::Guard::Notifier::NOTIFIERS.inject(:merge)
-      final_rows = merged_notifiers.each_with_object([]) do |definition, rows|
-
-        name      = definition[0]
-        clazz     = definition[1]
-        available = clazz.available?(silent: true) ? "✔" : "✘"
-        notifier  = ::Guard::Notifier.notifiers.detect { |n| n[:name] == name }
-        used      = notifier ? "✔" : "✘"
-
-        options = _merge_options(clazz, notifier)
-        options.delete(:silent)
-
-        if options.empty?
-          rows << :split
-          _add_row(rows, name, available, used, "", "")
-        else
-          options.each_with_index do |(option, value), index|
-            if index == 0
-              rows << :split
-              _add_row(rows, name, available, used, option.to_s, value.inspect)
-            else
-              _add_row(rows, "", "", "", option.to_s, value.inspect)
-            end
-          end
-        end
-
-        rows
-      end
-
-      Formatador.display_compact_table(
-        final_rows.drop(1),
-        [:Name, :Available, :Used, :Option, :Value]
-      )
-    end
-
-    private
-
-    # Evaluates the `Guardfile` by delegating to
-    #   {Guard::Guardfile::Evaluator#evaluate_guardfile}.
-    #
-    def _evaluate_guardfile
-      ::Guard.save_scope
-      ::Guard::Guardfile::Evaluator.new(options).evaluate_guardfile
-      ::Guard.restore_scope
-    end
-
-    def _merge_options(klass, notifier)
-      notify_options = notifier ? notifier[:options] : {}
-
-      if klass.const_defined?(:DEFAULTS)
-        klass.const_get(:DEFAULTS).merge(notify_options)
-      else
-        notify_options
-      end
-    end
-
-    def _add_row(rows, name, available, used, option, value)
-      rows << {
-        Name: name,
-        Available: available,
-        Used: used,
-        Option: option,
-        Value: value
-      }
-    end
-  end
-end

data/lib/guard/guard.rb.orig

@@ -1,42 +0,0 @@
-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/evaluator.rb.orig

@@ -1,275 +0,0 @@
-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