guard 1.4.0 → 2.18.0

data/man/guard.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GUARD" "1" "July 2012" "" ""
+.TH "GUARD" "1" "November 2014" "" ""
 .
 .SH "NAME"
 \fBguard\fR \- Guard keeps an eye on your file modifications\.
@@ -27,10 +27,13 @@ The following options are available:
 \fB\-n\fR, \fB\-\-notify\fR \fIFLAG\fR Disable notifications (Growl or Libnotify depending on your system)\. Notifications can be disabled globally by setting a GUARD_NOTIFY environment variable to false\. FLAG can be \fBtrue\fR/\fBfalse\fR or \fBt\fR/\fBf\fR\.
 .
 .P
-\fB\-d\fR, \fB\-\-debug\fR Runs Guard in debug mode\.
+\fB\-g\fR, \fB\-\-group\fR \fIGROUP1\fR \fIGROUP2\fR\.\.\. Scopes the Guard actions to the groups specified by GROUP1, GROUP2, etc\. Group names should be separated by spaces\. Plugins that don\'t belong to a group are considered global and are always run\.
 .
 .P
-\fB\-g\fR, \fB\-\-group\fR \fIGROUP1\fR \fIGROUP2\fR\.\.\. Runs only the groups specified by GROUP1, GROUP2 etc\. Groups name should be separated by spaces\. Guards that don\'t belong to a group are considered global and are always run\.
+\fB\-P\fR, \fB\-\-plugin\fR \fIPLUGIN1\fR \fIPLUGIN2\fR\.\.\. Scopes the Guard actions to the plugins specified by PLUGIN1, PLUGIN2, etc\. Plugin names should be separated by spaces\.
+.
+.P
+\fB\-d\fR, \fB\-\-debug\fR Runs Guard in debug mode\.
 .
 .P
 \fB\-w\fR, \fB\-\-watchdir\fR \fIPATH\fR Tells Guard to watch PATH instead of \fB\./\fR\.
@@ -45,14 +48,14 @@ The following options are available:
 \fB\-B\fR, \fB\-\-no\-bundler\-warning\fR Turn off warning when Bundler is not present\.
 .
 .P
-\fB\-\-show\-deprecations\fR Turn on deprecation warnings\.
-.
-.P
 \fB\-l\fR, \fB\-\-latency\fR Overwrite Listen\'s default latency\.
 .
 .P
 \fB\-p\fR, \fB\-\-force\-polling\fR Force usage of the Listen polling listener\.
 .
+.P
+\fB\-y\fR, \fB\-\-wait\-for\-delay\fR Overwrite Listen\'s default \fBwait_for_delay\fR, useful for kate\-like editors through ssh access\.
+.
 .SS "init [GUARDS]"
 If no Guardfile is present in the current directory, creates an empty Guardfile\.
 .
@@ -95,11 +98,11 @@ Thibaud Guillaume\-Gentil is the main author\.
 .P
 A list of contributors based on all commits can be found here: https://github\.com/guard/guard/contributors
 .
-.P
-For an exhaustive list of all the contributors, please see the CHANGELOG: https://github\.com/guard/guard/blob/master/CHANGELOG\.md
+.SH "CHANGELOG"
+The changelog can be found at: https://github\.com/guard/guard/blob/master/CHANGELOG\.md
 .
 .P
 This manual has been written by Remy Coutable\.
 .
 .SH "WWW"
-https://github\.com/guard/guard
+http://guardgem\.org/

data/man/guard.1.html

@@ -59,6 +59,7 @@
     <a href="#COMMANDS">COMMANDS</a>
     <a href="#EXAMPLES">EXAMPLES</a>
     <a href="#AUTHORS-CONTRIBUTORS">AUTHORS / CONTRIBUTORS</a>
+    <a href="#CHANGELOG">CHANGELOG</a>
     <a href="#WWW">WWW</a>
   </div>
 
@@ -97,14 +98,18 @@
   Notifications can be disabled globally by setting a GUARD_NOTIFY environment variable to false.
   FLAG can be <code>true</code>/<code>false</code> or <code>t</code>/<code>f</code>.</p>
 
+<p><code>-g</code>, <code>--group</code> <var>GROUP1</var> <var>GROUP2</var>...
+  Scopes the Guard actions to the groups specified by GROUP1, GROUP2, etc.
+  Group names should be separated by spaces.
+  Plugins that don't belong to a group are considered global and are always run.</p>
+
+<p><code>-P</code>, <code>--plugin</code> <var>PLUGIN1</var> <var>PLUGIN2</var>...
+  Scopes the Guard actions to the plugins specified by PLUGIN1, PLUGIN2, etc.
+  Plugin names should be separated by spaces.</p>
+
 <p><code>-d</code>, <code>--debug</code>
   Runs Guard in debug mode.</p>
 
-<p><code>-g</code>, <code>--group</code> <var>GROUP1</var> <var>GROUP2</var>...
-  Runs only the groups specified by GROUP1, GROUP2 etc.
-  Groups name should be separated by spaces.
-  Guards that don't belong to a group are considered global and are always run.</p>
-
 <p><code>-w</code>, <code>--watchdir</code> <var>PATH</var>
   Tells Guard to watch PATH instead of <code>./</code>.</p>
 
@@ -117,15 +122,15 @@
 <p><code>-B</code>, <code>--no-bundler-warning</code>
   Turn off warning when Bundler is not present.</p>
 
-<p><code>--show-deprecations</code>
-  Turn on deprecation warnings.</p>
-
 <p><code>-l</code>, <code>--latency</code>
   Overwrite Listen's default latency.</p>
 
 <p><code>-p</code>, <code>--force-polling</code>
   Force usage of the Listen polling listener.</p>
 
+<p><code>-y</code>, <code>--wait-for-delay</code>
+  Overwrite Listen's default <code>wait_for_delay</code>, useful for kate-like editors through ssh access.</p>
+
 <h3 id="init-GUARDS-">init [GUARDS]</h3>
 
 <p>If no Guardfile is present in the current directory, creates an empty Guardfile.</p>
@@ -169,19 +174,20 @@ For instance to initialize guard-rspec, run <code>guard init rspec</code>.</p>
 <p>A list of contributors based on all commits can be found here:
 https://github.com/guard/guard/contributors</p>
 
-<p>For an exhaustive list of all the contributors, please see the CHANGELOG:
-https://github.com/guard/guard/blob/master/CHANGELOG.md</p>
+<h2 id="CHANGELOG">CHANGELOG</h2>
+
+<p>The changelog can be found at: https://github.com/guard/guard/blob/master/CHANGELOG.md</p>
 
 <p>This manual has been written by Remy Coutable.</p>
 
 <h2 id="WWW">WWW</h2>
 
-<p>https://github.com/guard/guard</p>
+<p>http://guardgem.org/</p>
 
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>July 2012</li>
+    <li class='tc'>November 2014</li>
     <li class='tr'>guard(1)</li>
   </ol>
 

metadata

@@ -1,170 +1,241 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 1.4.0
-  prerelease: 
+  version: 2.18.0
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-26 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.6
+        version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.6
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: lumberjack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.12
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.12
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: formatador
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: nenv
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '0.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: shellany
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
-  type: :development
+        version: '0.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: '0.0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: notiffany
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
-  type: :development
+        version: '0.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '0.0'
 description: Guard is a command line tool to easily handle events on file system modifications.
 email:
-- thibaud@thibaud.me
+- thibaud@thibaud.gg
 executables:
 - guard
+- _guard-core
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/_guard-core
 - bin/guard
 - images/failed.png
-- images/guard.png
 - images/pending.png
 - images/success.png
+- lib/guard.rb
+- lib/guard/aruba_adapter.rb
 - lib/guard/cli.rb
+- lib/guard/cli/environments/bundler.rb
+- lib/guard/cli/environments/evaluate_only.rb
+- lib/guard/cli/environments/valid.rb
+- lib/guard/commander.rb
+- lib/guard/commands/all.rb
+- lib/guard/commands/change.rb
+- lib/guard/commands/notification.rb
+- lib/guard/commands/pause.rb
+- lib/guard/commands/reload.rb
+- lib/guard/commands/scope.rb
+- lib/guard/commands/show.rb
+- lib/guard/config.rb
+- lib/guard/deprecated/dsl.rb
+- lib/guard/deprecated/evaluator.rb
+- lib/guard/deprecated/guard.rb
+- lib/guard/deprecated/guardfile.rb
+- lib/guard/deprecated/watcher.rb
 - lib/guard/dsl.rb
 - lib/guard/dsl_describer.rb
+- lib/guard/dsl_reader.rb
 - lib/guard/group.rb
-- lib/guard/guard.rb
 - lib/guard/guardfile.rb
-- lib/guard/hook.rb
+- lib/guard/guardfile/evaluator.rb
+- lib/guard/guardfile/generator.rb
 - lib/guard/interactor.rb
-- lib/guard/interactors/coolline.rb
-- lib/guard/interactors/helpers/completion.rb
-- lib/guard/interactors/helpers/terminal.rb
-- lib/guard/interactors/readline.rb
-- lib/guard/interactors/simple.rb
+- lib/guard/internals/debugging.rb
+- lib/guard/internals/groups.rb
+- lib/guard/internals/helpers.rb
+- lib/guard/internals/plugins.rb
+- lib/guard/internals/queue.rb
+- lib/guard/internals/scope.rb
+- lib/guard/internals/session.rb
+- lib/guard/internals/state.rb
+- lib/guard/internals/tracing.rb
+- lib/guard/internals/traps.rb
+- lib/guard/jobs/base.rb
+- lib/guard/jobs/pry_wrapper.rb
+- lib/guard/jobs/sleep.rb
 - lib/guard/notifier.rb
-- lib/guard/notifiers/emacs.rb
-- lib/guard/notifiers/gntp.rb
-- lib/guard/notifiers/growl.rb
-- lib/guard/notifiers/growl_notify.rb
-- lib/guard/notifiers/libnotify.rb
-- lib/guard/notifiers/notifysend.rb
-- lib/guard/notifiers/rb_notifu.rb
-- lib/guard/notifiers/terminal_notifier.rb
-- lib/guard/notifiers/tmux.rb
+- lib/guard/options.rb
+- lib/guard/plugin.rb
+- lib/guard/plugin_util.rb
+- lib/guard/rake_task.rb
 - lib/guard/runner.rb
 - lib/guard/templates/Guardfile
+- lib/guard/terminal.rb
 - lib/guard/ui.rb
+- lib/guard/ui/colors.rb
+- lib/guard/ui/config.rb
+- lib/guard/ui/logger.rb
 - lib/guard/version.rb
-- lib/guard/version.rbc
 - lib/guard/watcher.rb
-- lib/guard.rb
-- CHANGELOG.md
-- LICENSE
+- lib/guard/watcher/pattern.rb
+- lib/guard/watcher/pattern/deprecated_regexp.rb
+- lib/guard/watcher/pattern/match_result.rb
+- lib/guard/watcher/pattern/matcher.rb
+- lib/guard/watcher/pattern/pathname_path.rb
+- lib/guard/watcher/pattern/simple_path.rb
+- lib/tasks/releaser.rb
 - man/guard.1
 - man/guard.1.html
-- README.md
-homepage: https://github.com/guard/guard
-licenses: []
+homepage: http://guardgem.org
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 1379407495203457243
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
-rubyforge_project: guard
-rubygems_version: 1.8.24
+rubygems_version: 3.1.4
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Guard keeps an eye on your file modifications
 test_files: []
-has_rdoc: 

data/lib/guard/guard.rb

@@ -1,156 +0,0 @@
-module Guard
-
-  # Base class that every Guard plugin implementation must inherit from.
-  #
-  # Guard will trigger the `start`, `stop`, `reload`, `run_all` and `run_on_changes`
-  # (`run_on_additions`, `run_on_modifications` and `run_on_removals`) task methods
-  # depending on user interaction and file modification.
-  #
-  # `run_on_changes` could be implemented to handle all the changes task case (additions,
-  # modifications, removals) in once, or each task can be implemented separatly with a
-  # specific behavior.
-  #
-  # In each of these Guard task methods you have to implement some work when you want to
-  # support this kind of task. The return value of each Guard task method is not evaluated
-  # by Guard, but I'll be passed to the "_end" hook for further evaluation. You can
-  # throw `:task_has_failed` to indicate that your Guard plugin method was not successful,
-  # and successive Guard plugin tasks will be aborted when the group has set the `:halt_on_fail`
-  # option.
-  #
-  # @see Guard::Hook
-  # @see Guard::Group
-  #
-  # @example Throw :task_has_failed
-  #
-  #   def run_all
-  #     if !runner.run(['all'])
-  #       throw :task_has_failed
-  #     end
-  #   end
-  #
-  # Each Guard plugin should provide a template Guardfile located within the Gem
-  # at `lib/guard/guard-name/templates/Guardfile`.
-  #
-  # By default all watchers for a Guard plugin have to return strings of paths to the
-  # Guard, but if your Guard plugin wants to allow any return value from a watcher,
-  # you can set the `any_return` option to true.
-  #
-  # If one of those methods raise an exception other than `:task_has_failed`,
-  # the Guard::GuardName instance will be removed from the active guards.
-  #
-  class Guard
-    require 'guard/hook'
-    require 'guard/ui'
-
-    include ::Guard::Hook
-
-    attr_accessor :watchers, :options, :group
-
-    # Initializes a Guard plugin.
-    #
-    # @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
-    #
-    def initialize(watchers = [], options = {})
-      @group = options[:group] ? options.delete(:group).to_sym : :default
-      @watchers, @options = watchers, options
-    end
-
-    # Initialize the Guard plugin. This will copy the Guardfile template inside the Guard plugin gem.
-    # The template Guardfile must be located within the Gem at `lib/guard/guard-name/templates/Guardfile`.
-    #
-    # @param [String] name the name of the Guard plugin
-    #
-    def self.init(name)
-      if ::Guard::Dsl.guardfile_include?(name)
-        ::Guard::UI.info "Guardfile already includes #{ name } guard"
-      else
-        content = File.read('Guardfile')
-        guard   = File.read("#{ ::Guard.locate_guard(name) }/lib/guard/#{ name }/templates/Guardfile")
-
-        File.open('Guardfile', 'wb') do |f|
-          f.puts(content)
-          f.puts("")
-          f.puts(guard)
-        end
-
-        ::Guard::UI.info "#{ name } guard added to Guardfile, feel free to edit it"
-      end
-    end
-
-    # Call once when Guard starts. Please override initialize method to init stuff.
-    #
-    # @raise [:task_has_failed] when start has failed
-    # @return [Object] the task result
-    #
-    # @!method start
-
-    # Called when `stop|quit|exit|s|q|e + enter` is pressed (when Guard quits).
-    #
-    # @raise [:task_has_failed] when stop has failed
-    # @return [Object] the task result
-    #
-    # @!method stop
-
-    # Called when `reload|r|z + enter` is pressed.
-    # This method should be mainly used for "reload" (really!) actions like reloading passenger/spork/bundler/...
-    #
-    # @raise [:task_has_failed] when reload has failed
-    # @return [Object] the task result
-    #
-    # @!method  reload
-
-    # Called when just `enter` is pressed
-    # This method should be principally used for long action like running all specs/tests/...
-    #
-    # @raise [:task_has_failed] when run_all has failed
-    # @return [Object] the task result
-    #
-    # @!method run_all
-
-    # Default behaviour on file(s) changes that the Guard plugin watches.
-    #
-    # @param [Array<String>] paths the changes files or paths
-    # @raise [:task_has_failed] when run_on_changes has failed
-    # @return [Object] the task result
-    #
-    # @!method run_on_changes(paths)
-
-    # Called on file(s) additions that the Guard plugin watches.
-    #
-    # @param [Array<String>] paths the changes files or paths
-    # @raise [:task_has_failed] when run_on_additions has failed
-    # @return [Object] the task result
-    #
-    # @!method run_on_additions(paths)
-
-    # Called on file(s) modifications that the Guard plugin watches.
-    #
-    # @param [Array<String>] paths the changes files or paths
-    # @raise [:task_has_failed] when run_on_modifications has failed
-    # @return [Object] the task result
-    #
-    # @!method run_on_modifications(paths)
-
-    # Called on file(s) removals that the Guard plugin watches.
-    #
-    # @param [Array<String>] paths the changes files or paths
-    # @raise [:task_has_failed] when run_on_removals has failed
-    # @return [Object] the task result
-    #
-    # @!method run_on_removals(paths)
-
-    # Convert plugin to string representation. The
-    # default just uses the plugin class name.
-    # 
-    # @return [String] the string representation
-    #
-    def to_s
-      self.class.to_s
-    end
-
-  end
-
-end