guard 2.15.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d3499725d20725a5a0e1259e9e3f74694798f4a43e503f67f28bd218553bbe8
-  data.tar.gz: a20150e135df2bef124397c8532d85b20a5ea6d7b78259763465175c512c637e
+  metadata.gz: 909f2f0b8875294f9d73116fdcf9c0499cdd3e1e928db9fd8a0517ab7045f5e0
+  data.tar.gz: 0bd68633d9e2051c2912d01f941d16a601120379bdf841a688d850fa3a1be462
 SHA512:
-  metadata.gz: adcd66a415123303070578f425ea3aab1ccbbd1d0fad175054232d08da2dfa8365eb12e558cc6b1bf83874d29bb467a75cd636b3a8e5330f8e1dc6d408728988
-  data.tar.gz: 9138af75c456be233f5df7b92acedb73ca8c257ade2020a2a1eedb0b2ac1b8e7b42922a94f7169cff4084f5b1d8fdf56942086a6978a3263af8840a85f678ea5
+  metadata.gz: e25b07345fe9097d6e837ee1747e69df8c4d83d06c35e92548a96a2212dacfb1cee2016b74ad5fbb78ed74a2ade54ba17a844e305d6e45d8a194c722e3e84d25
+  data.tar.gz: 5ac8af0c983be8956442afa34e814865cdf3fec6616f7b3a5b8e6c7bb61339abe9b10332b45be5213ad910f2e1fb4a62fb2287a8ddb258d5b7ff45404ca562cc

data/README.md

@@ -1,10 +1,14 @@
 # Guard
 
-**IMPORTANT: [Ruby 2.1 is officially outdated and unsupported!](https://www.ruby-lang.org/en/news/2016/03/30/ruby-2-1-9-released/) Please upgrade to Ruby >=2.3 or >=2.2.9 before installing Guard! To install for older versions, update Bundler at least 1.12: `gem update bundler` and Bundler should correctly resolve to earlier gems for your given Ruby version.**
+**IMPORTANT: Please upgrade to Ruby >= 2.4 before installing Guard! To install for older versions, update Bundler at least 1.12: `gem update bundler` and Bundler should correctly resolve to earlier gems for your given Ruby version.**
+
+- [Ruby 2.1 is officially outdated and unsupported!](https://www.ruby-lang.org/en/news/2016/03/30/ruby-2-1-9-released/)
+- [Ruby 2.2 is officially outdated and unsupported!](https://www.ruby-lang.org/en/news/2018/06/20/support-of-ruby-2-2-has-ended/)
+- [Ruby 2.3 is officially outdated and unsupported!](https://www.ruby-lang.org/en/news/2019/03/31/support-of-ruby-2-3-has-ended/)
 
 :exclamation: Guard is currently accepting more maintainers. Please [read this](https://github.com/guard/guard/wiki/Maintainers) if you're interested in joining the team.
 
-[![Gem Version](https://img.shields.io/gem/v/guard.svg?style=flat)](https://rubygems.org/gems/guard) [![Build Status](https://travis-ci.org/guard/guard.svg?branch=master)](https://travis-ci.org/guard/guard) [![Dependency Status](https://gemnasium.com/guard/guard.svg)](https://gemnasium.com/guard/guard) [![Code Climate](https://codeclimate.com/github/guard/guard/badges/gpa.svg)](https://codeclimate.com/github/guard/guard) [![Test Coverage](https://codeclimate.com/github/guard/guard/badges/coverage.svg)](https://codeclimate.com/github/guard/guard) [![Inline docs](http://inch-ci.org/github/guard/guard.svg)](http://inch-ci.org/github/guard/guard)
+[![Gem Version](https://img.shields.io/gem/v/guard.svg?style=flat)](https://rubygems.org/gems/guard) [![Build Status](https://travis-ci.org/guard/guard.svg?branch=master)](https://travis-ci.org/guard/guard) [![Code Climate](https://codeclimate.com/github/guard/guard/badges/gpa.svg)](https://codeclimate.com/github/guard/guard) [![Test Coverage](https://codeclimate.com/github/guard/guard/badges/coverage.svg)](https://codeclimate.com/github/guard/guard) [![Inline docs](http://inch-ci.org/github/guard/guard.svg)](http://inch-ci.org/github/guard/guard) [![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
 
 <img src="http://f.cl.ly/items/0A0M3W2x3I1P450z341U/guard-Icon.png" alt="Guard Icon" align="right" />
 Guard automates various tasks by running custom rules whenever file or directories are modified.
@@ -31,8 +35,8 @@ Before you file an issue, make sure you have read the _[known issues](#issues)_
 
 * File system changes handled by our awesome [Listen](https://github.com/guard/listen) gem.
 * Support for visual system notifications.
-* Huge eco-system with [more than 220](https://rubygems.org/search?query=guard-) Guard plugins.
-* Tested against Ruby 2.2.9, 2.3.6, 2.4.3, 2.5.0, JRuby & Rubinius.
+* Huge eco-system with [more than 300](https://rubygems.org/search?query=guard-) Guard plugins.
+* Tested against the latest Ruby 2.4.x, 2.5.x, 2.6.x, JRuby & Rubinius. See [`.travis-ci.yml`](https://github.com/guard/guard/blob/master/.travis.yml) for the exact versions.
 
 ## Screencast
 
@@ -73,9 +77,7 @@ $ bundle exec guard
 
 If you are on Mac OS X and have problems with either Guard not reacting to file
 changes or Pry behaving strange, then you should [add proper Readline support
-to Ruby on Mac OS
-X](https://github.com/guard/guard/wiki/Add-Readline-support-to-Ruby-on-Mac-OS-X).
-
+to Ruby on macOS](https://github.com/guard/guard/wiki/Add-Readline-support-to-Ruby-on-Mac-OS-X).
 
 ## Avoiding gem/dependency problems
 
@@ -86,10 +88,10 @@ If you're getting sick of typing `bundle exec` all the time, try one of the foll
 * (Recommended) Running `bundle binstub guard` will create `bin/guard` in your
   project, which means running `bin/guard` (tab completion will save you a key
   stroke or two) will have the exact same result as `bundle exec guard`.
-  
+
 * Or, you can `alias be="bundle exec"` in your `.bashrc` or similar and the execute only `be guard`.
-  **Protip**: It will work for all comands executed in `bundle exec` context!  
-  
+  **Protip**: It will work for all comands executed in `bundle exec` context!
+
 
 * Or, for RubyGems >= 2.2.0 (at least, though the more recent the better),
   simply set the `RUBYGEMS_GEMDEPS` environment variable to `-` (for autodetecting
@@ -132,8 +134,8 @@ Just launch Guard inside your Ruby or Rails project with:
 $ bundle exec guard
 ```
 
-Guard will look for a `Guardfile` in your current directory. If it does not find one, it will look in your `$HOME`
-directory for a `.Guardfile`.
+Guard will look for a `Guardfile` or `guardfile.rb` in your current directory. If it does not find one, it will look
+in your `$HOME` directory for a `.Guardfile`.
 
 Please look here to see all the [command line options for Guard](https://github.com/guard/guard/wiki/Command-line-options-for-Guard)
 
@@ -153,15 +155,32 @@ Before reporting a problem, please read how to [File an issue](https://github.co
 ## Development / Contributing
 
 See the [Contributing Guide](https://github.com/guard/guard/blob/master/CONTRIBUTING.md#development).
+
+## Releasing
+
+### Prerequisites
+
+* You must have commit rights to the GitHub repository.
+* You must have push rights for rubygems.org.
+
+### How to release
+
+1. Determine which would be the correct next version number according to [semver](http://semver.org/).
+1. Update the version in `./lib/guard/version.rb`.
+1. Commit the version in a single commit, the message should be "Bump VERSION to X.Y.Z".
+1. Push and open a pull request.
+1. Once CI is green, merge the pull request.
+1. Pull the changes locally and run `bundle exec rake release:full`; this will tag, push to GitHub, publish to rubygems.org, and publish the [release notes](https://github.com/guard/guard/releases) .
+
 ### Author
 
 [Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](https://twitter.com/thibaudgg))
 
 ### Core Team
 
-* R.I.P. :broken_heart: [Michael Kessler](https://github.com/netzpirat) ([flinkfinger.com](http://www.flinkfinger.com)).
+* R.I.P. :broken_heart: [Michael Kessler](https://github.com/netzpirat).
 * [Rémy Coutable](https://github.com/rymai).
-* [Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](https://twitter.com/thibaudgg), [thibaud.gg](http://thibaud.gg/)).
+* [Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](https://twitter.com/thibaudgg), [thibaud.gg](https://thibaud.gg/)).
 
 ### Contributors
 

data/lib/guard/commander.rb

@@ -47,13 +47,14 @@ module Guard
         exitcode = e.status
       end
 
-      stop
       exitcode
+    ensure
+      stop
     end
 
     def stop
-      listener.stop
-      interactor.background
+      listener&.stop
+      interactor&.background
       UI.debug "Guard stops all plugins"
       Runner.new.run(:stop)
       Notifier.disconnect

data/lib/guard/dsl.rb

@@ -37,7 +37,8 @@ module Guard
   #
   # There are two possible locations for the `Guardfile`:
   #
-  # * The `Guardfile` in the current directory where Guard has been started
+  # * The `Guardfile` or `guardfile.rb` in the current directory where Guard
+  #   has been started
   # * The `.Guardfile` in your home directory.
   #
   # In addition, if a user configuration `.guard.rb` in your home directory is
@@ -68,7 +69,7 @@ module Guard
     #   notification :ruby_gntp, host: '192.168.1.5'
     #
     # @param [Symbol, String] notifier the name of the notifier to use
-    # @param [Hash] options the notification library options
+    # @param [Hash] opts the notification library options
     #
     # @see Guard::Notifier for available notifier and its options.
     #
@@ -366,7 +367,7 @@ module Guard
     # @example Scope Guard to multiple plugins
     #   scope plugins: [:jasmine, :rspec]
     #
-    # @param [Hash] scopes the scope for the groups and plugins
+    # @param [Hash] scope the scope for the groups and plugins
     #
     def scope(scope = {})
       # TODO: use a Guardfile::Results class

data/lib/guard/guardfile/evaluator.rb

@@ -18,6 +18,12 @@ module Guard
     class Evaluator
       Deprecated::Evaluator.add_deprecated(self) unless Config.new.strict?
 
+      DEFAULT_GUARDFILES = %w(
+        guardfile.rb
+        Guardfile
+        ~/.Guardfile
+      ).freeze
+
       ERROR_NO_GUARDFILE = "No Guardfile found,"\
         " please create one with `guard init`."
 
@@ -60,7 +66,7 @@ module Guard
           @contents = opts[:contents]
         elsif opts[:guardfile]
           @type = :custom
-          @path = Pathname(opts[:guardfile]) # may be updated by _read
+          @path = Pathname.new(opts[:guardfile]) # may be updated by _read
         end
       end
 
@@ -178,19 +184,21 @@ module Guard
       end
 
       def _use_default!
-        @path, @contents = _read("Guardfile")
-        @type = :default
-      rescue Errno::ENOENT
-        begin
-          @path, @contents = _read("~/.Guardfile")
-          @type = :default
-        rescue Errno::ENOENT
-          fail NoGuardfileError, ERROR_NO_GUARDFILE
+        DEFAULT_GUARDFILES.each do |guardfile|
+          begin
+            @path, @contents = _read(guardfile)
+            @type = :default
+            break
+          rescue Errno::ENOENT
+            if guardfile == DEFAULT_GUARDFILES.last
+              fail NoGuardfileError, ERROR_NO_GUARDFILE
+            end
+          end
         end
       end
 
       def _read(path)
-        full_path = Pathname(path).expand_path
+        full_path = Pathname.new(path.to_s).expand_path
         [full_path, full_path.read]
       rescue Errno::ENOENT
         fail
@@ -202,7 +210,7 @@ module Guard
       end
 
       def _guardfile_contents
-        @user_config ||= Pathname("~/.guard.rb").expand_path.read
+        @user_config ||= Pathname.new("~/.guard.rb").expand_path.read
         [@contents, @user_config].compact.join("\n")
       rescue Errno::ENOENT
         @contents || ""

data/lib/guard/guardfile/generator.rb

@@ -32,11 +32,11 @@ module Guard
 
       # The location of user defined templates
       begin
-        HOME_TEMPLATES = Pathname("~/.guard/templates").expand_path
+        HOME_TEMPLATES = Pathname.new("~/.guard/templates").expand_path
       rescue ArgumentError
         # home isn't defined.  Set to the root of the drive.  Trust that there
         # won't be user defined templates there
-        HOME_TEMPLATES = Pathname("/").expand_path
+        HOME_TEMPLATES = Pathname.new("/").expand_path
       end
 
       class Error < RuntimeError
@@ -63,7 +63,7 @@ module Guard
       # @see Guard::CLI#init
       #
       def create_guardfile
-        path = Pathname("Guardfile").expand_path
+        path = Pathname.new("Guardfile").expand_path
         if path.exist?
           _ui(:error, "Guardfile already exists at #{path}")
           abort
@@ -81,7 +81,7 @@ module Guard
       #   initialize
       #
       def initialize_template(plugin_name)
-        guardfile = Pathname("Guardfile")
+        guardfile = Pathname.new("Guardfile")
 
         plugin_util = PluginUtil.new(plugin_name)
         # TODO: change to "valid?" method

data/lib/guard/jobs/pry_wrapper.rb

@@ -40,11 +40,21 @@ module Guard
     class PryWrapper < Base
       # The default Ruby script to configure Guard Pry if the option `:guard_rc`
       # is not defined.
-      GUARD_RC = "~/.guardrc"
+
+      GUARD_RC = if ENV["XDG_CONFIG_HOME"] && File.exist?(ENV["XDG_CONFIG_HOME"] + "/guard/guardrc")
+                   ENV["XDG_CONFIG_HOME"] + "/guard/guardrc"
+                 else
+                   "~/.guardrc"
+                 end
 
       # The default Guard Pry history file if the option `:history_file` is not
       # defined.
-      HISTORY_FILE = "~/.guard_history"
+
+      HISTORY_FILE = if ENV["XDG_DATA_HOME"] && File.exist?(ENV["XDG_DATA_HOME"] + "/guard/history")
+                       ENV["XDG_DATA_HOME"] + "/guard/history"
+                     else
+                       "~/.guard_history"
+                     end
 
       # List of shortcuts for each interactor command
       SHORTCUTS = {
@@ -95,6 +105,14 @@ module Guard
 
       attr_reader :thread
 
+      def _pry_config
+        Pry.config
+      end
+
+      def _pry_commands
+        Pry.commands
+      end
+
       def _switch_to_pry
         th = nil
         @mutex.synchronize do
@@ -125,11 +143,10 @@ module Guard
       end
 
       def _setup(options)
-        Pry.config.should_load_rc = false
-        Pry.config.should_load_local_rc = false
-        history_file_path = options[:history_file] || HISTORY_FILE
-        Pry.config.history.file = File.expand_path(history_file_path)
+        _pry_config.should_load_rc = false
+        _pry_config.should_load_local_rc = false
 
+        _configure_history_file(options[:history_file] || HISTORY_FILE)
         _add_hooks(options)
 
         Commands::All.import
@@ -144,6 +161,17 @@ module Guard
         _configure_prompt
       end
 
+      def _configure_history_file(history_file)
+        history_file_path = File.expand_path(history_file)
+
+        # Pry >= 0.13
+        if _pry_config.respond_to?(:history_file=)
+          _pry_config.history_file = history_file_path
+        else
+          _pry_config.history.file = history_file_path
+        end
+      end
+
       # Add Pry hooks:
       #
       # * Load `~/.guardrc` within each new Pry session.
@@ -159,7 +187,7 @@ module Guard
       # Add a `when_started` hook that loads a global .guardrc if it exists.
       #
       def _add_load_guard_rc_hook(guard_rc)
-        Pry.config.hooks.add_hook :when_started, :load_guard_rc do
+        _pry_config.hooks.add_hook :when_started, :load_guard_rc do
           guard_rc.expand_path.tap { |p| load p if p.exist? }
         end
       end
@@ -167,7 +195,7 @@ module Guard
       # Add a `when_started` hook that loads a project .guardrc if it exists.
       #
       def _add_load_project_guard_rc_hook(guard_rc)
-        Pry.config.hooks.add_hook :when_started, :load_project_guard_rc do
+        _pry_config.hooks.add_hook :when_started, :load_project_guard_rc do
           load guard_rc if guard_rc.exist?
         end
       end
@@ -175,7 +203,7 @@ module Guard
       # Add a `after_eval` hook that restores visibility after a command is
       # eval.
       def _add_restore_visibility_hook
-        Pry.config.hooks.add_hook :after_eval, :restore_visibility do
+        _pry_config.hooks.add_hook :after_eval, :restore_visibility do
           @terminal_settings.echo
         end
       end
@@ -192,7 +220,7 @@ module Guard
       # instead restarts guard.
       #
       def _replace_reset_command
-        Pry.commands.command "reset", "Reset the Guard to a clean state." do
+        _pry_commands.command "reset", "Reset the Guard to a clean state." do
           output.puts "Guard reset."
           exec "guard"
         end
@@ -203,7 +231,7 @@ module Guard
       # beginning of a line).
       #
       def _create_run_all_command
-        Pry.commands.block_command(/^$/, "Hit enter to run all") do
+        _pry_commands.block_command(/^$/, "Hit enter to run all") do
           Pry.run_command "all"
         end
       end
@@ -214,7 +242,7 @@ module Guard
       #
       def _create_command_aliases
         SHORTCUTS.each do |command, shortcut|
-          Pry.commands.alias_command shortcut, command.to_s
+          _pry_commands.alias_command shortcut, command.to_s
         end
       end
 
@@ -225,8 +253,8 @@ module Guard
       #
       def _create_guard_commands
         Guard.state.session.plugins.all.each do |guard_plugin|
-          cmd = "Run all #{ guard_plugin.title }"
-          Pry.commands.create_command guard_plugin.name, cmd do
+          cmd = "Run all #{guard_plugin.title}"
+          _pry_commands.create_command guard_plugin.name, cmd do
             group "Guard"
 
             def process
@@ -245,8 +273,8 @@ module Guard
         Guard.state.session.groups.all.each do |group|
           next if group.name == :default
 
-          cmd = "Run all #{ group.title }"
-          Pry.commands.create_command group.name.to_s, cmd do
+          cmd = "Run all #{group.title}"
+          _pry_commands.create_command group.name.to_s, cmd do
             group "Guard"
 
             def process
@@ -260,7 +288,15 @@ module Guard
       # `pry`.
       #
       def _configure_prompt
-        Pry.config.prompt = [_prompt(">"), _prompt("*")]
+        prompt_procs = [_prompt(">"), _prompt("*")]
+        prompt =
+          if Pry::Prompt.is_a?(Class)
+            Pry::Prompt.new("Guard", "Guard Pry prompt", prompt_procs)
+          else
+            prompt_procs
+          end
+
+        _pry_config.prompt = prompt
       end
 
       # Returns the plugins scope, or the groups scope ready for display in the
@@ -289,12 +325,11 @@ module Guard
       end
 
       def _history(pry)
-        # https://github.com/pry/pry/blob/5bf2585d0a49a4a3666a9eae80ee31153e3ffcf4/CHANGELOG.md#v0120-november-5-2018
-        if Gem::Version.new(Pry::VERSION) < Gem::Version.new("0.12.0")
-          return pry.input_array.size
+        if pry.respond_to?(:input_ring)
+          pry.input_ring.size
+        else
+          pry.input_array.size
         end
-
-        pry.input_ring.size
       end
     end
   end

data/lib/guard/notifier.rb

@@ -16,7 +16,7 @@ module Guard
     end
 
     def self.disconnect
-      @notifier.disconnect
+      @notifier && @notifier.disconnect
       @notifier = nil
     end
 

data/lib/guard/plugin_util.rb

@@ -59,7 +59,7 @@ module Guard
         klass.new(options.delete(:watchers), options)
       else
         begin
-          klass.new(options)
+          klass.new(**options)
         rescue ArgumentError => e
           fail "Failed to call #{klass}.new(options): #{e}"
         end

data/lib/guard/runner.rb

@@ -11,7 +11,7 @@ module Guard
     #
     # @param [Symbol] task the task to run
     #
-    # @param [Hash] scopes either the Guard plugin or the group to run the task
+    # @param [Hash] scope_hash either the Guard plugin or the group to run the task
     # on
     #
     def run(task, scope_hash = {})
@@ -70,7 +70,7 @@ module Guard
     # 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 [Guard::Plugin] plugin guard the Guard to execute
     # @param [Symbol] task the task to run
     # @param [Array] args the arguments for the task
     # @raise [:task_has_failed] when task has failed

data/lib/guard/version.rb

@@ -1,3 +1,3 @@
 module Guard
-  VERSION = "2.15.0"
+  VERSION = "2.17.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.17.0
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2021-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -219,7 +219,7 @@ homepage: http://guardgem.org
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -234,9 +234,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Guard keeps an eye on your file modifications
 test_files: []