guard 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfaee517cc2aeebf0c6f342096d0096c3bc6b2d8
-  data.tar.gz: 2d9a10f8924c4869b26b498c6bd9f21d3b89e5d0
+  metadata.gz: 949af1dc04bc3ed850cf0b63fd523bc1ddb3316a
+  data.tar.gz: a200da636376286362b7c8c06bfe48586c52124b
 SHA512:
-  metadata.gz: 0c631b422854e4addbb6416c6644bc764fe012f6026ca420ea851fe32962f91f717f2f92f01af5adf2a95bf5fad29ab10c3967cbef836271a9674aeef2bf0b77
-  data.tar.gz: 755d7a94b32acedca6b56cec9680b2cc64aeaefd1e06d753d1facdf0c71580ee3de720e3a586fd59093e5b41fc7603a32bc94c2fe73041dcb8ffaf7cba85b455
+  metadata.gz: 409a80a8cf1172d1d077e5a147d26a2dc91f4d90e0adcb17b1fbbe183e6404b087e91294536c3d94448ed0cc59f63bd2b30f2c21275e80fea34bd4ab17c7bece
+  data.tar.gz: 6642c59beed12c1b3bddd5eb93b3e8579a56a85f4c531ede1c193811feb1b3d32f96b0164b4c982c467dba2f3fbc15a4b1ee8b5508006c6f7af48398f8fd6b4f

data/LICENSE

@@ -1,3 +1,5 @@
+The MIT License (MIT)
+
 Copyright (c) 2009-2014 Thibaud Guillaume-Gentil
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.md

@@ -1,6 +1,8 @@
-Guard [![Gem Version](https://badge.fury.io/rb/guard.png)](http://badge.fury.io/rb/guard) [![Build Status](https://travis-ci.org/guard/guard.png?branch=master)](https://travis-ci.org/guard/guard) [![Dependency Status](https://gemnasium.com/guard/guard.png)](https://gemnasium.com/guard/guard) [![Code Climate](https://codeclimate.com/github/guard/guard.png)](https://codeclimate.com/github/guard/guard) [![Coverage Status](https://coveralls.io/repos/guard/guard/badge.png?branch=master)](https://coveralls.io/r/guard/guard)
+Guard
 =====
 
+[![Gem Version](https://badge.fury.io/rb/guard.png)](http://badge.fury.io/rb/guard) [![Build Status](https://travis-ci.org/guard/guard.png?branch=master)](https://travis-ci.org/guard/guard) [![Dependency Status](https://gemnasium.com/guard/guard.png)](https://gemnasium.com/guard/guard) [![Code Climate](https://codeclimate.com/github/guard/guard.png)](https://codeclimate.com/github/guard/guard) [![Coverage Status](https://coveralls.io/repos/guard/guard/badge.png?branch=master)](https://coveralls.io/r/guard/guard) [![Inline docs](http://inch-pages.github.io/github/guard/guard.png)](http://inch-pages.github.io/github/guard/guard)
+
 <img src="http://cl.ly/image/1k3o1r2Z3a0J/guard-Icon.png" alt="Guard Icon" align="right" />
 Guard is a command line tool to easily handle events on file system modifications.
 
@@ -399,7 +401,7 @@ more detailed information. `help guard` will show all Guard related commands ava
 
 Pry supports the Ruby built-in Readline, [rb-readline](https://github.com/luislavena/rb-readline) and
 [Coolline](https://github.com/Mon-Ouie/coolline). Just install the readline implementation of your choice by adding it
-to your `Gemfile.
+to your `Gemfile`.
 
 You can also disable the interactions completely by running Guard with the `--no-interactions` option.
 
@@ -492,10 +494,17 @@ You can also launch any arbitrary command in the supplied block:
 
 ```ruby
 guard :shell do
-  watch('.*') { `git status` }
+  watch(/.*/) { `git status` }
 end
 ```
 
+You can also define `watch`es outside of a `guard` plugin. This is useful to perform arbitrary Ruby
+logic (i.e. something project-specific).
+
+```ruby
+watch(/.*/) { |m| puts "#{m[0]} changed." }
+```
+
 ### group
 
 The `group` method allows you to group several plugins together. This comes in handy especially when you

data/lib/guard/dsl.rb

@@ -165,16 +165,16 @@ module Guard
     # @see #group
     #
     def guard(name, options = {})
-      @watchers  = []
-      @callbacks = []
+      @plugin_options = options.merge(watchers: [], callbacks: [])
 
       yield if block_given?
 
       groups = @current_groups && @current_groups.last || [:default]
       groups.each do |group|
-        options.merge!(group: group, watchers: @watchers, callbacks: @callbacks)
-        ::Guard.add_plugin(name, options)
+        ::Guard.add_plugin(name, @plugin_options.merge(group: group))
       end
+
+      @plugin_options = nil
     end
 
     # Defines a pattern to be watched in order to run actions on file modification.
@@ -186,6 +186,9 @@ module Guard
     #     watch(%r{^app/controllers/(.+).rb}) { |m| 'spec/acceptance/#{m[1]}s_spec.rb' }
     #   end
     #
+    # @example Declare global watchers outside of a Guard
+    #   watch(%r{^(.+)$}) { |m| puts "#{m[1]} changed." }
+    #
     # @param [String, Regexp] pattern the pattern that Guard must watch for modification
     # @yield a block to be run when the pattern is matched
     # @yieldparam [MatchData] m matches of the pattern
@@ -195,7 +198,11 @@ module Guard
     # @see #guard
     #
     def watch(pattern, &action)
-      @watchers << ::Guard::Watcher.new(pattern, action)
+      # Allow watches in the global scope (to execute arbitrary commands) by
+      # building a generic Guard::Plugin.
+      return guard(:plugin) { watch(pattern, &action) } unless @plugin_options
+
+      @plugin_options[:watchers] << ::Guard::Watcher.new(pattern, action)
     end
 
     # Defines a callback to execute arbitrary code before or after any of
@@ -216,6 +223,8 @@ module Guard
     # @see Guard::Hooker
     #
     def callback(*args, &block)
+      fail "callback must be called within a guard block" unless @plugin_options
+
       block, events = if args.size > 1
         # block must be the first argument in that case, the yielded block is
         # ignored
@@ -223,7 +232,7 @@ module Guard
       else
         [block, args[0]]
       end
-      @callbacks << { events: events, listener: block }
+      @plugin_options[:callbacks] << { events: events, listener: block }
     end
 
     # Ignores certain paths globally.

data/lib/guard/guardfile/evaluator.rb

@@ -10,7 +10,7 @@ module Guard
     #
     class Evaluator
 
-      attr_reader :options
+      attr_reader :options, :guardfile_source, :guardfile_path
 
       # Initializes a new Guard::Guardfile::Evaluator object.
       #
@@ -41,6 +41,9 @@ module Guard
       # the current Guard configuration.
       #
       def reevaluate_guardfile
+        # Don't re-evaluate inline Guardfile
+        return if @guardfile_source == :inline
+
         _before_reevaluate_guardfile
         evaluate_guardfile
         _after_reevaluate_guardfile
@@ -50,10 +53,10 @@ module Guard
       #
       # @example Programmatically test if a Guardfile contains a specific Guard plugin
       #   File.read('Guardfile')
-      #   #=> "guard :rspec"
+      #   => "guard :rspec"
       #
       #   Guard::Guardfile::Evaluator.new.guardfile_include?('rspec)
-      #   #=> true
+      #   => true
       #
       # @param [String] plugin_name the name of the Guard
       # @return [Boolean] whether the Guard plugin has been declared
@@ -62,39 +65,12 @@ module Guard
         _guardfile_contents_without_user_config.match(/^guard\s*\(?\s*['":]#{ plugin_name }['"]?/)
       end
 
-      # Gets the file path to the project `Guardfile`.
-      #
-      # @example Gets the path of the currently evaluated Guardfile
-      #   Dir.pwd
-      #   #=> "/Users/remy/Code/github/guard"
-      #
-      #   evaluator = Guard::Guardfile::Evaluator.new
-      #   evaluator.evaluate_guardfile
-      #   #=> nil
-      #
-      #   evaluator.guardfile_path
-      #   #=> "/Users/remy/Code/github/guard/Guardfile"
-      #
-      # @example Gets the "path" of an inline Guardfile
-      #   > Guard::Guardfile::Evaluator.new(guardfile_contents: 'guard :rspec').evaluate_guardfile
-      #   => nil
-      #
-      #   > Guard::Guardfile::Evaluator.new.guardfile_path
-      #   => "Inline Guardfile"
-      #
-      # @return [String] the path to the Guardfile or 'Inline Guardfile' if
-      #   the Guardfile has been specified via the `:guardfile_contents` option.
-      #
-      def guardfile_path
-        options[:guardfile_path] || ''
-      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"
+      #   => "guard :rspec"
       #
       # @return [String] the Guardfile content
       #
@@ -110,7 +86,7 @@ module Guard
       # @return [String] the Guardfile content
       #
       def _guardfile_contents_without_user_config
-        options[:guardfile_contents] || ''
+        @guardfile_contents || ''
       end
 
       # Evaluates the content of the `Guardfile`.
@@ -118,14 +94,13 @@ module Guard
       # @param [String] contents the content to evaluate.
       #
       def _instance_eval_guardfile(contents)
-        ::Guard::Dsl.new.instance_eval(contents, options[:guardfile_path], 1)
+        ::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
-      # the options as `:guardfile_contents`.
+      # Gets the content to evaluate and stores it into @guardfile_contents.
       #
       def _fetch_guardfile_contents
         _use_inline_guardfile || _use_provided_guardfile || _use_default_guardfile
@@ -138,26 +113,40 @@ module Guard
       # Use the provided inline Guardfile if provided.
       #
       def _use_inline_guardfile
-        return false unless options[:guardfile_contents]
+        if (@guardfile_source.nil? && options[:guardfile_contents]) || @guardfile_source == :inline
+
+          @guardfile_source   = :inline
+          @guardfile_contents = options[:guardfile_contents]
+
+          ::Guard::UI.info 'Using inline Guardfile.'
 
-        ::Guard::UI.info 'Using inline Guardfile.'
-        options[:guardfile_path] = 'Inline Guardfile'
+          true
+        else
+          false
+        end
       end
 
       # Try to use the provided Guardfile. Exits Guard if the Guardfile cannot
       # be found.
       #
       def _use_provided_guardfile
-        return false unless options[:guardfile]
+        if (@guardfile_source.nil? && options[:guardfile]) || @guardfile_source == :custom
+
+          @guardfile_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
 
-        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
+          false
         end
       end
 
@@ -166,6 +155,7 @@ module Guard
       #
       def _use_default_guardfile
         if guardfile_path = _find_default_guardfile
+          @guardfile_source = :default
           _read_guardfile(guardfile_path)
         else
           ::Guard::UI.error 'No Guardfile found, please create one with `guard init`.'
@@ -185,8 +175,8 @@ module Guard
       # @param [String] guardfile_path the path to the Guardfile
       #
       def _read_guardfile(guardfile_path)
-        options[:guardfile_path]     = guardfile_path
-        options[:guardfile_contents] = File.read(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

data/lib/guard/notifiers/tmux.rb

@@ -204,9 +204,10 @@ module Guard
       # Notification starting, save the current Tmux settings
       # and quiet the Tmux output.
       #
-      def turn_on
+      def self.turn_on
         unless @options_stored
           _reset_options_store
+
           _clients.each do |client|
             options_store[client] ||= {}
             `#{ DEFAULTS[:client] } show -t #{ client }`.each_line do |line|
@@ -214,6 +215,7 @@ module Guard
               @options_store[client][option] = setting
             end
           end
+
           @options_stored = true
         end
       end
@@ -222,7 +224,7 @@ module Guard
       # if available (existing options are restored, new options
       # are unset) and unquiet the Tmux output.
       #
-      def turn_off
+      def self.turn_off
         if @options_stored
           @options_store.each do |client, options|
             options.each do |key, value|
@@ -237,7 +239,7 @@ module Guard
         end
       end
 
-      def options_store
+      def self.options_store
         @options_store ||= {}
       end
 
@@ -248,8 +250,12 @@ module Guard
         super
       end
 
+      def self._clients
+        `#{ DEFAULTS[:client] } list-clients -F '\#{ client_tty }'`.split(/\n/)
+      end
+
       def _clients
-        %x( #{DEFAULTS[:client]} list-clients -F '\#{client_tty}').split(/\n/);
+        self.class._client
       end
 
       def _run_client(cmd, args)
@@ -271,10 +277,11 @@ module Guard
 
       # Reset the internal Tmux options store defaults.
       #
-      def _reset_options_store
+      def self._reset_options_store
         @options_stored = false
         @options_store = {}
-        _clients.each do | client |
+
+        _clients.each do |client|
           @options_store[client] = {
             'status-left-bg'  => nil,
             'status-right-bg' => nil,
@@ -287,16 +294,8 @@ module Guard
         end
       end
 
-      # Remove clients which no longer exist from options store
-      #
-      def _remove_old_clients
-        (options_store.keys - _clients).each do | old_client |
-          options_store.delete old_client
-        end
-      end
-
       def _tmux_version
-        @tmux_version ||= `tmux -V`.chomp.gsub(/[^0-9.]/,'').to_f
+        @tmux_version ||= `tmux -V`.chomp.gsub(/[^0-9.]/, '').to_f
       end
 
     end

data/lib/guard/version.rb

@@ -1,3 +1,3 @@
 module Guard
-  VERSION = '2.5.1'
+  VERSION = '2.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -80,34 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.4
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.0.0.beta1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.0.0.beta1
 description: Guard is a command line tool to easily handle events on file system modifications.
 email:
 - thibaud@thibaud.gg