guard 2.7.2 → 2.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a56573a032fe19caaec716bce14a5e8c31c861b
-  data.tar.gz: bd96b08fbe6d1df7dc92147104de03a8fdf9fc66
+  metadata.gz: 7fe4d02f1b032eb80f48d28b9e2a96cedc706a8d
+  data.tar.gz: 8835c817d58724daa4838a98688300cbde8c6118
 SHA512:
-  metadata.gz: 14b5197e11d01da9c1313fb06801df0533144f08cdfebd292d7f9c69db7b64ddc7deabfb638735f651d0f64a4c062de436e2c7bc2b301085e16d650fec570e6c
-  data.tar.gz: 58cfe1bd2aa5e666cf42c0ee118f02d9d288706d5713ef122fb0ebc43a1f03f81434d9df3e23f2050175fe719f59db7aa63e992305425fcfcbe39b836fb14393
+  metadata.gz: 42b4e420d55c5344df40f26ca6005da64cce67014d4dc06cbb08db146231fcb56c28a2b2c8a89434c3921e83cf3e946c8dcf3c821281fc948b038c5feb2a962c
+  data.tar.gz: 793aa5c2052dd4d37778b6361ceddd42a1e50d8ad4cd7eac1b4434955dfc6d7afadc94cdf6f96a2e0895fd2f26b05e138ab05d25cacf83d36a664221b3469215

data/lib/guard.rb.orig

@@ -0,0 +1,213 @@
+require "rbconfig"
+
+require "guard/commander"
+require "guard/deprecated_methods"
+require "guard/deprecator"
+require "guard/dsl"
+require "guard/group"
+require "guard/guardfile"
+require "guard/interactor"
+require "guard/notifier"
+require "guard/plugin_util"
+require "guard/runner"
+require "guard/setuper"
+require "guard/sheller"
+require "guard/ui"
+require "guard/watcher"
+require "guard/reevaluator"
+
+# Guard is the main module for all Guard related modules and classes.
+# Also Guard plugins should use this namespace.
+#
+module Guard
+  DEV_NULL = Gem.win_platform? ? "NUL" : "/dev/null"
+
+  extend Commander
+  extend DeprecatedMethods
+  extend Setuper
+
+  class << self
+    # Called by Pry scope command
+
+    def scope=(new_scope)
+      @scope = new_scope
+      @scope.dup.freeze
+    end
+
+    def scope
+<<<<<<< HEAD
+      fail "::Guard.setup() not called" if @scope.nil?
+=======
+>>>>>>> origin/api_safe_refactoring
+      @scope.dup.freeze
+    end
+    attr_reader :runner, :listener
+
+    # Smart accessor for retrieving specific plugins at once.
+    #
+    # @see Guard.plugin
+    # @see Guard.group
+    # @see Guard.groups
+    #
+    # @example Filter plugins by String or Symbol
+    #   Guard.plugins('rspec')
+    #   Guard.plugins(:rspec)
+    #
+    # @example Filter plugins by Regexp
+    #   Guard.plugins(/rsp.+/)
+    #
+    # @example Filter plugins by Hash
+    #   Guard.plugins(name: 'rspec', group: 'backend')
+    #
+    # @param [String, Symbol, Regexp, Hash] filter the filter to apply to the
+    # plugins
+    # @return [Plugin, Array<Plugin>] the filtered plugin(s)
+    #
+    def plugins(filter = nil)
+      @plugins ||= []
+
+      return @plugins if filter.nil?
+
+      filtered_plugins = case filter
+                         when String, Symbol
+                           @plugins.select do |plugin|
+                             plugin.name == filter.to_s.downcase.gsub("-", "")
+                           end
+                         when Regexp
+                           @plugins.select do |plugin|
+                             plugin.name =~ filter
+                           end
+                         when Hash
+                           @plugins.select do |plugin|
+                             filter.all? do |k, v|
+                               case k
+                               when :name
+                                 plugin.name == v.to_s.downcase.gsub("-", "")
+                               when :group
+                                 plugin.group.name == v.to_sym
+                               end
+                             end
+                           end
+                         end
+
+      filtered_plugins
+    end
+
+    # Smart accessor for retrieving a specific plugin.
+    #
+    # @see Guard.plugins
+    # @see Guard.group
+    # @see Guard.groups
+    #
+    # @example Find a plugin by String or Symbol
+    #   Guard.plugin('rspec')
+    #   Guard.plugin(:rspec)
+    #
+    # @example Find a plugin by Regexp
+    #   Guard.plugin(/rsp.+/)
+    #
+    # @example Find a plugin by Hash
+    #   Guard.plugin(name: 'rspec', group: 'backend')
+    #
+    # @param [String, Symbol, Regexp, Hash] filter the filter for finding the
+    #   plugin the Guard plugin
+    # @return [Plugin, nil] the plugin found, nil otherwise
+    #
+    def plugin(filter)
+      plugins(filter).first
+    end
+
+    # Smart accessor for retrieving specific groups at once.
+    #
+    # @see Guard.plugin
+    # @see Guard.plugins
+    # @see Guard.group
+    #
+    # @example Filter groups by String or Symbol
+    #   Guard.groups('backend')
+    #   Guard.groups(:backend)
+    #
+    # @example Filter groups by Regexp
+    #   Guard.groups(/(back|front)end/)
+    #
+    # @param [String, Symbol, Regexp] filter the filter to apply to the Groups
+    # @return [Array<Group>] the filtered group(s)
+    #
+    def groups(filter = nil)
+      @groups ||= []
+
+      return @groups if filter.nil?
+
+      case filter
+      when String, Symbol
+        @groups.select { |group| group.name == filter.to_sym }
+      when Regexp
+        @groups.select { |group| group.name.to_s =~ filter }
+      else
+        fail "Invalid filter: #{filter.inspect}"
+      end
+    end
+
+    # Smart accessor for retrieving a specific group.
+    #
+    # @see Guard.plugin
+    # @see Guard.plugins
+    # @see Guard.groups
+    #
+    # @example Find a group by String or Symbol
+    #   Guard.group('backend')
+    #   Guard.group(:backend)
+    #
+    # @example Find a group by Regexp
+    #   Guard.group(/(back|front)end/)
+    #
+    # @param [String, Symbol, Regexp] filter the filter for finding the group
+    # @return [Group] the group found, nil otherwise
+    #
+    def group(filter)
+      groups(filter).first
+    end
+
+    # Add a Guard plugin to use.
+    #
+    # @param [String] name the Guard name
+    # @param [Hash] options the plugin options (see Plugin documentation)
+    # @option options [String] group the group to which the plugin belongs
+    # @option options [Array<Watcher>] watchers the list of declared watchers
+    # @option options [Array<Hash>] callbacks the list of callbacks
+    # @return [Plugin] the added Guard plugin
+    # @see Plugin
+    #
+    def add_plugin(name, options = {})
+      instance = ::Guard::PluginUtil.new(name).initialize_plugin(options)
+      @plugins << instance
+      instance
+    end
+
+    # Used by runner to remove a failed plugin
+    def remove_plugin(plugin)
+      # TODO: coverage/aruba
+      @plugins.delete(plugin)
+    end
+
+    # Add a Guard plugin group.
+    #
+    # @param [String] name the group name
+    # @option options [Boolean] halt_on_fail if a task execution
+    #   should be halted for all Guard plugins in this group if
+    #   one Guard throws `:task_has_failed`
+    # @return [Group] the group added (or retrieved from the `@groups`
+    #   variable if already present)
+    #
+    # @see Group
+    #
+    def add_group(name, options = {})
+      unless (group = group(name))
+        group = ::Guard::Group.new(name, options)
+        @groups << group
+      end
+
+      group
+    end
+  end
+end

data/lib/guard/cli.rb

@@ -171,8 +171,15 @@ module Guard
       ::Guard.reset_options(options) # Since UI.deprecated uses config
       ::Guard.reset_evaluator(options) # for initialize_all_templates
 
+      # This is messed up (deprecated, etc) and will be fixed later
       ::Guard::Guardfile.create_guardfile(abort_on_existence: options[:bare])
 
+      # Note: this reset "hack" will be fixed after refactoring
+      ::Guard.reset_plugins
+
+      # Evaluate because it might have existed and creating was skipped
+      ::Guard.evaluator.evaluate_guardfile
+
       return if options[:bare]
 
       if plugin_names.empty?

data/lib/guard/cli.rb.orig

@@ -0,0 +1,218 @@
+require "thor"
+
+require "guard"
+require "guard/version"
+require "guard/dsl_describer"
+require "guard/guardfile"
+
+module Guard
+  # Facade for the Guard command line interface managed by
+  # [Thor](https://github.com/wycats/thor).
+  #
+  # This is the main interface to Guard that is called by the Guard binary
+  # `bin/guard`. Do not put any logic in here, create a class and delegate
+  # instead.
+  #
+  class CLI < Thor
+    default_task :start
+
+    desc "start", "Starts Guard"
+
+    method_option :clear,
+                  type:    :boolean,
+                  default: false,
+                  aliases: "-c",
+                  banner:  "Auto clear shell before each action"
+
+    method_option :notify,
+                  type:    :boolean,
+                  default: true,
+                  aliases: "-n",
+                  banner:  "Notifications feature"
+
+    method_option :debug,
+                  type:    :boolean,
+                  default: false,
+                  aliases: "-d",
+                  banner:  "Show debug information"
+
+    method_option :group,
+                  type:    :array,
+                  default: [],
+                  aliases: "-g",
+                  banner:  "Run only the passed groups"
+
+    method_option :plugin,
+                  type:    :array,
+                  default: [],
+                  aliases: "-P",
+                  banner:  "Run only the passed plugins"
+
+    method_option :watchdir,
+                  type:    :array,
+                  aliases: "-w",
+                  banner:  "Specify the directories to watch"
+
+    method_option :guardfile,
+                  type:    :string,
+                  aliases: "-G",
+                  banner:  "Specify a Guardfile"
+
+    method_option :no_interactions,
+                  type: :boolean,
+                  default: false,
+                  aliases: "-i",
+                  banner: "Turn off completely any Guard terminal interactions"
+
+    method_option :no_bundler_warning,
+                  type: :boolean,
+                  default: false,
+                  aliases: "-B",
+                  banner: "Turn off warning when Bundler is not present"
+
+    method_option :show_deprecations,
+                  type: :boolean,
+                  default: false,
+                  banner: "Turn on deprecation warnings"
+
+    # Listen options
+    method_option :latency,
+                  type:    :numeric,
+                  aliases: "-l",
+                  banner:  'Overwrite Listen\'s default latency'
+
+    method_option :force_polling,
+                  type:    :boolean,
+                  default: false,
+                  aliases: "-p",
+                  banner:  "Force usage of the Listen polling listener"
+
+    method_option :wait_for_delay,
+                  type:    :numeric,
+                  aliases: "-y",
+                  banner:  'Overwrite Listen\'s default wait_for_delay'
+
+    method_option :listen_on,
+                  type:    :string,
+                  aliases: "-o",
+                  default: false,
+                  banner:  "Specify a network address to Listen on for "\
+                  "file change events (e.g. for use in VMs)"
+
+    # Start Guard by initializing the defined Guard plugins and watch the file
+    # system.
+    #
+    # This is the default task, so calling `guard` is the same as calling
+    # `guard start`.
+    #
+    # @see Guard.start
+    #
+    def start
+      _verify_bundler_presence unless options[:no_bundler_warning]
+      ::Guard.start(options)
+    end
+
+    desc "list", "Lists Guard plugins that can be used with init"
+
+    # List the Guard plugins that are available for use in your system and
+    # marks those that are currently used in your `Guardfile`.
+    #
+    # @see Guard::DslDescriber.list
+    #
+    def list
+      ::Guard::DslDescriber.new(options).list
+    end
+
+    desc "notifiers", "Lists notifiers and its options"
+
+    # List the Notifiers for use in your system.
+    #
+    # @see Guard::DslDescriber.notifiers
+    #
+    def notifiers
+      ::Guard::DslDescriber.new(options).notifiers
+    end
+
+    desc "version", "Show the Guard version"
+    map %w(-v --version) => :version
+
+    # Shows the current version of Guard.
+    #
+    # @see Guard::VERSION
+    #
+    def version
+      $stdout.puts "Guard version #{ ::Guard::VERSION }"
+    end
+
+    desc "init [GUARDS]", "Generates a Guardfile at the current directory"\
+      " (if it is not already there) and adds all installed Guard plugins"\
+      " or the given GUARDS into it"
+
+    method_option :bare,
+                  type: :boolean,
+                  default: false,
+                  aliases: "-b",
+                  banner: "Generate a bare Guardfile without adding any"\
+                  " installed plugin into it"
+
+    # Initializes the templates of all installed Guard plugins and adds them
+    # to the `Guardfile` when no Guard name is passed. When passing
+    # Guard plugin names it does the same but only for those Guard plugins.
+    #
+    # @see Guard::Guardfile.initialize_template
+    # @see Guard::Guardfile.initialize_all_templates
+    #
+    # @param [Array<String>] plugin_names the name of the Guard plugins to
+    # initialize
+    #
+    def init(*plugin_names)
+      _verify_bundler_presence unless options[:no_bundler_warning]
+
+      ::Guard.reset_options(options) # Since UI.deprecated uses config
+      ::Guard.reset_evaluator(options) # for initialize_all_templates
+
+      ::Guard::Guardfile.create_guardfile(abort_on_existence: options[:bare])
+
+      return if options[:bare]
+
+      if plugin_names.empty?
+        ::Guard::Guardfile.initialize_all_templates
+      else
+        plugin_names.each do |plugin_name|
+          ::Guard::Guardfile.initialize_template(plugin_name)
+        end
+      end
+    end
+
+    desc "show", "Show all defined Guard plugins and their options"
+    map %w(-T) => :show
+
+    # Shows all Guard plugins and their options that are defined in
+    # the `Guardfile`
+    #
+    # @see Guard::DslDescriber.show
+    #
+    def show
+      ::Guard::DslDescriber.new(options).show
+    end
+
+    private
+
+    # Verifies if Guard is run with `bundle exec` and
+    # shows a hint to do so if not.
+    #
+    def _verify_bundler_presence
+      return unless File.exist?("Gemfile")
+      return if ENV["BUNDLE_GEMFILE"] || ENV["RUBYGEMS_GEMDEPS"]
+
+      ::Guard::UI.info <<EOF
+
+Guard here! It looks like your project has a Gemfile, yet you are running
+`guard` outside of Bundler. If this is your intent, feel free to ignore this
+message. Otherwise, consider using `bundle exec guard` to ensure your
+dependencies are loaded correctly.
+(You can run `guard` with --no-bundler-warning to get rid of this message.)
+EOF
+    end
+  end
+end