guard 1.5.4 → 1.6.0

data/CHANGELOG.md

@@ -1,16 +1,41 @@
+## 1.6.0 - 21 December, 2012
+
+### New features
+
+- Allow the Guard scope to be defined from the `Guardfile` with the `scope` DSL method. ([@netzpirat][])
+- [#378][] Scope plugins and groups from CLI and interactor. ([@netzpirat][])
+- [#369][] Allow Guard plugins to specify their template location. ([@schmurfy][])
+- [#364][] Add `ignore!` and `filter!` DSL methods. ([@tarsolya][])
+- [#362][] Add interactor options `:history_file` and `:guard_rc`. ([@netzpirat][])
+
+### Improvements
+
+- [#372][] Restore original TMux settings on stop. ([@rudicode][])
+- [#376][] Delegate Ctrl-C to Pry to exit continuation. ([@netzpirat][])
+- [#360][] Improve Guard/listen/interactor thread coordination. ([@netzpirat][])
+- [#368][] Detecting duplicate definitions and then warning the user. ([@jfolkins][])
+- [#367][] Change modeline's fgcolor when changing bgcolor in emacs notifier. ([@iljoo][])
+
+### Bug fixes
+
+- [#377][] Add the 'a' alias for the 'all' Pry command. (reported by [@cknadler][], fixed by [@rymai][])
+- [#365][] Fix terminal reset redirect to null devise on Windows. ([@cablegram][])
+- [#365][] Fix Emacs notifier detection on Windows. ([@cablegram][])
+- [#361][] Tmux notifier affects only the local session. ([@netzpirat][])
+
 ## 1.5.4 - 9 November, 2012
 
 ### Improvements
 
 - Thread handling improved and added thread debug mode. ([@netzpirat][])
 
-## Bug fix
+### Bug fix
 
 - [#358][] Ignore `~/.pryrc` since it breaks Guard when loading the Rails env. ([@netzpirat][])
 
 ## 1.5.3 - 31 October, 2012
 
-### Bug fix
+### Bug fixes
 
 - [#352][] Guard always reloading twice. ([@netzpirat][])
 - [#354][] Ignore `./.pryrc` since it breaks Guard when loading the Rails env. ([@netzpirat][])
@@ -657,6 +682,17 @@ The Listen integration has been supervised by [@thibaudgg][] and executed by [@M
 [#353]: https://github.com/guard/guard/issues/353
 [#354]: https://github.com/guard/guard/issues/354
 [#358]: https://github.com/guard/guard/issues/358
+[#360]: https://github.com/guard/guard/issues/360
+[#361]: https://github.com/guard/guard/issues/361
+[#362]: https://github.com/guard/guard/issues/362
+[#364]: https://github.com/guard/guard/issues/364
+[#365]: https://github.com/guard/guard/issues/365
+[#367]: https://github.com/guard/guard/issues/367
+[#368]: https://github.com/guard/guard/issues/368
+[#369]: https://github.com/guard/guard/issues/369
+[#376]: https://github.com/guard/guard/issues/376
+[#377]: https://github.com/guard/guard/issues/377
+[#378]: https://github.com/guard/guard/issues/378
 [@Gazer]: https://github.com/Gazer
 [@Maher4Ever]: https://github.com/Maher4Ever
 [@alandipert]: https://github.com/alandipert
@@ -665,9 +701,11 @@ The Listen integration has been supervised by [@thibaudgg][] and executed by [@M
 [@benolee]: https://github.com/benolee
 [@brainopia]: https://github.com/brainopia
 [@bronson]: https://github.com/bronson
+[@cablegram]: https://github.com/cablegram
 [@capotej]: https://github.com/capotej
 [@ches]: https://github.com/ches
 [@chrisberkhout]: https://github.com/chrisberkhout
+[@cknadler]: https://github.com/cknadler
 [@d1]: https://github.com/d1
 [@dgutov]: https://github.com/dgutov
 [@dnagir]: https://github.com/dnagir
@@ -685,9 +723,11 @@ The Listen integration has been supervised by [@thibaudgg][] and executed by [@M
 [@hawx]: https://github.com/hawx
 [@hron]: https://github.com/hron
 [@ianwhite]: https://github.com/ianwhite
+[@iljoo]: https://github.com/iljoo
 [@indirect]: https://github.com/indirect
 [@japgolly]: https://github.com/japgolly
 [@jeffutter]: https://github.com/jeffutter
+[@jfolkins]: https://github.com/jfolkins
 [@johnbintz]: https://github.com/johnbintz
 [@jredville]: https://github.com/jredville
 [@jrsacks]: https://github.com/jrsacks
@@ -716,6 +756,7 @@ The Listen integration has been supervised by [@thibaudgg][] and executed by [@M
 [@royvandewater]: https://github.com/royvandewater
 [@rupert654]: https://github.com/rupert654
 [@rymai]: https://github.com/rymai
+[@schmurfy]: https://github.com/schmurfy
 [@scottdavis]: https://github.com/scottdavis
 [@semperos]: https://github.com/semperos
 [@spadin]: https://github.com/spadin
@@ -724,6 +765,7 @@ The Listen integration has been supervised by [@thibaudgg][] and executed by [@M
 [@stouset]: https://github.com/stouset
 [@sunaku]: https://github.com/sunaku
 [@sutherland]: https://github.com/sutherland
+[@tarsolya]: https://github.com/tarsolya
 [@thibaudgg]: https://github.com/thibaudgg
 [@thierryhenrio]: https://github.com/thierryhenrio
 [@tinogomes]: https://github.com/tinogomes

data/README.md

@@ -101,7 +101,7 @@ group :development do
 end
 ```
 
-### System notifications
+## System notifications
 
 You can configure Guard to make use of the following system notification libraries:
 
@@ -374,7 +374,7 @@ Notifications can also be disabled globally by setting a `GUARD_NOTIFY` environm
 
 #### `-g`/`--group` option
 
-Only certain plugin groups can be run:
+Scope Guard to certain plugin groups on start:
 
 ```bash
 $ guard --group group_name another_group_name
@@ -383,6 +383,15 @@ $ guard -g group_name another_group_name # shortcut
 
 See the Guardfile DSL below for creating groups.
 
+#### `-P`/`--plugins` option
+
+Scope Guard to certain plugins on start:
+
+```bash
+$ guard --plugins plugin_name another_plugin_name
+$ guard -p plugin_name another_plugin_name # shortcut
+```
+
 #### `-d`/`--debug` option
 
 Guard can display debug information which can be very usefull for plugins
@@ -499,6 +508,7 @@ commands:
  * `n`, `notification`: Toggles the notifications.
  * `p`, `pause`: Toggles the file listener.
  * `r`, `reload`: Reload all plugins.
+ * `o`, `scope`: Scope Guard actions to plugins or groups.
  * `s`, `show`: Show all Guard plugins.
  * `e`, `exit`: Stop all plugins and quit Guard
 
@@ -636,6 +646,29 @@ $ guard -g specs
 
 Guard plugins that don't belong to a group are considered global and are always run.
 
+### scope
+
+The `scope` method allows you to define the default plugin or group scope for Guard, if not
+specified as command line option. Thus command line group and plugin scope takes precedence over
+the DSL scope configuration.
+
+You can define either a single plugin or group:
+
+```ruby
+scope :plugin => :rspec
+scope :group => :docs
+```
+
+or specify multiple plugins or groups.
+
+```ruby
+scope :plugins => [:test, :jasmine]
+scope :groups => [:docs, :frontend]
+```
+
+If you define both the plugin and group scope, the plugin scope has precedence. If you use both the
+plural and the singular option, the plural has precedence.
+
 ### notification
 
 If you don't specify any notification configuration in your `Guardfile`, Guard goes through the list of available
@@ -675,6 +708,12 @@ notification :off
 
 ### interactor
 
+You can customize the Pry interactor history and RC file like:
+
+```ruby
+interactor :guard_rc => '~/.my_guard-rc', :history_file => '~/.my_guard_history_file'
+```
+
 If you do not need the Pry interactions with Guard at all, you can turn it off:
 
 ```ruby
@@ -711,10 +750,18 @@ are ignored.
 Please note that method only accept regexps. More on the
 [Listen README](https://github.com/guard/listen#the-patterns-for-filtering-and-ignoring-paths).
 
+To append to the default ignored files and directories, use the `ignore` method:
+
 ```ruby
 ignore %r{^ignored/path/}, /public/
 ```
 
+To _replace_ to default ignored files and directories, use the `ignore!` method:
+
+```ruby
+ignore! /data/
+```
+
 ### filter
 
 The `filter` method allows you to focus by filtering files and directories without having to specify them by hand in the
@@ -728,6 +775,12 @@ Please note that method only accept regexps. More on the
 filter /\.txt$/, /.*\.zip/
 ```
 
+To _replace_ any existing filter, use the `filter!` method:
+
+```ruby
+filter /\.js$/
+```
+
 ### logger
 
 The `logger` method allows you to customize the Guard log output to your needs by specifying one or more options like:

data/lib/guard.rb

@@ -1,3 +1,4 @@
+require 'rbconfig'
 require 'thread'
 require 'listen'
 
@@ -21,8 +22,11 @@ module Guard
   # The location of user defined templates
   HOME_TEMPLATES = File.expand_path('~/.guard/templates')
 
+  WINDOWS = RbConfig::CONFIG["host_os"] =~ %r!(msdos|mswin|djgpp|mingw)!
+  DEV_NULL = WINDOWS ? "NUL" : "/dev/null"
+
   class << self
-    attr_accessor :options, :interactor, :runner, :listener, :lock
+    attr_accessor :options, :interactor, :runner, :listener, :lock, :scope, :running
 
     # Initialize the Guard singleton:
     #
@@ -40,12 +44,14 @@ module Guard
     # @deprecated @option options [Boolean] no_vendor ignore vendored dependencies
     #
     def setup(options = {})
+      @running    = true
       @lock       = Mutex.new
       @options    = options.dup
       @watchdir   = (options[:watchdir] && File.expand_path(options[:watchdir])) || Dir.pwd
       @runner     = ::Guard::Runner.new
+      @scope      = { :plugins => [], :groups => []}
 
-      if @options[:debug]
+      if options[:debug]
         Thread.abort_on_exception = true
         ::Guard::UI.options[:level] = :debug
         debug_command_execution
@@ -62,6 +68,14 @@ module Guard
       ::Guard::Dsl.evaluate_guardfile(options)
       ::Guard::UI.error 'No guards found in Guardfile, please add at least one.' if @guards.empty?
 
+      if @options[:group]
+        @scope[:groups] = @options[:group].map { |g| ::Guard.groups(g) }
+      end
+
+      if @options[:plugin]
+        @scope[:plugins] = @options[:plugin].map { |p| ::Guard.guards(p) }
+      end
+
       runner.deprecation_warning if @options[:show_deprecations]
 
       setup_notifier
@@ -91,15 +105,26 @@ module Guard
     # Currently two signals are caught:
     # - `USR1` which pauses listening to changes.
     # - `USR2` which resumes listening to changes.
+    # - 'INT' which is delegated to Pry if active, otherwise stops Guard.
     #
     def setup_signal_traps
       unless defined?(JRUBY_VERSION)
         if Signal.list.keys.include?('USR1')
-          Signal.trap('USR1') { ::Guard.pause unless @listener.paused? }
+          Signal.trap('USR1') { ::Guard.pause unless listener.paused? }
         end
 
         if Signal.list.keys.include?('USR2')
-          Signal.trap('USR2') { ::Guard.pause if @listener.paused? }
+          Signal.trap('USR2') { ::Guard.pause if listener.paused? }
+        end
+
+        if Signal.list.keys.include?('INT')
+          Signal.trap('INT') do
+            if interactor
+              interactor.thread.raise(Interrupt)
+            else
+              ::Guard.stop
+            end
+          end
         end
       end
     end
@@ -132,7 +157,7 @@ module Guard
     # Initializes the interactor unless the user has specified not to.
     #
     def setup_interactor
-      unless options[:no_interactions]
+      unless options[:no_interactions] || !::Guard::Interactor.enabled
         @interactor = ::Guard::Interactor.new
       end
     end
@@ -156,25 +181,25 @@ module Guard
     #
     def start(options = {})
       setup(options)
-      ::Guard::UI.info "Guard is now watching at '#{ @watchdir }'"
 
       within_preserved_state do
+        ::Guard::UI.debug 'Guard starts all plugins'
         runner.run(:start)
+        ::Guard::UI.info "Guard is now watching at '#{ @watchdir }'"
+        listener.start(false)
       end
-
-      # Blocks main thread
-      listener.start
     end
 
     # Stop Guard listening to file changes
     #
     def stop
       within_preserved_state(false) do
+        ::Guard::UI.debug 'Guard stops all plugins'
         runner.run(:stop)
+        ::Guard::Notifier.turn_off
         ::Guard::UI.info 'Bye bye...', :reset => true
-
-        # Unblocks main thread
         listener.stop
+        ::Guard.running = false
       end
     end
 
@@ -185,6 +210,8 @@ module Guard
     # @param [Hash] scopes hash with a Guard plugin or a group scope
     #
     def reload(scopes = {})
+      scopes = convert_scopes(scopes)
+
       within_preserved_state do
         ::Guard::UI.clear(:force => true)
         ::Guard::UI.action_with_scopes('Reload', scopes)
@@ -202,6 +229,8 @@ module Guard
     # @param [Hash] scopes hash with a Guard plugin or a group scope
     #
     def run_all(scopes = {})
+      scopes = convert_scopes(scopes)
+
       within_preserved_state do
         ::Guard::UI.clear(:force => true)
         ::Guard::UI.action_with_scopes('Run', scopes)
@@ -333,6 +362,7 @@ module Guard
           interactor.stop if interactor
           @result = yield
         rescue Interrupt
+          # Bring back Pry when the block is halted with Ctrl-C
         end
 
         interactor.start if interactor && restart_interactor
@@ -400,7 +430,14 @@ module Guard
     #
     def guard_gem_names
       if Gem::Version.create(Gem::VERSION) >= Gem::Version.create('1.8.0')
-        Gem::Specification.find_all.select { |x| x.name =~ /^guard-/ }
+        Gem::Specification.find_all.select do |x|
+          if x.name =~ /^guard-/
+            true
+          elsif x.name != "guard"
+            guard_plugin_path = File.join(x.full_gem_path, "lib/guard/#{x.name}.rb")
+            File.exists?( guard_plugin_path )
+          end
+        end
       else
         Gem.source_index.find_name(/^guard-/)
       end.map { |x| x.name.sub(/^guard-/, '') }
@@ -444,5 +481,40 @@ module Guard
       ::Guard::UI.deprecation(NO_VENDOR_DEPRECATION) if options[:no_vendor]
     end
 
+    # Convert the old scope format to the new scope format.
+    #
+    # @example Convert old scopes
+    #   convert_scopes({ :guard => :rspec, :group => :backend })
+    #   => { :plugins => [:rspec], :groups => [:backend] }
+    #
+    def convert_scopes(scopes)
+      if scopes[:guard]
+        scopes[:plugins] = [scopes[:guard]]
+        scopes.delete(:guard)
+      end
+
+      if scopes[:group]
+        scopes[:groups] = [scopes[:group]]
+        scopes.delete(:group)
+      end
+
+      scopes
+    end
+
+    # Determine if Guard needs to quit. This
+    # checks for Ctrl-D pressed.
+    #
+    # @return [Boolean] whether to quit or not
+    #
+    def quit?
+      STDIN.read_nonblock(1)
+      false
+    rescue Errno::EINTR
+      false
+    rescue Errno::EAGAIN
+      false
+    rescue EOFError
+      true
+    end
   end
 end

data/lib/guard/cli.rb

@@ -41,6 +41,12 @@ module Guard
                   :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    => :string,
                   :aliases => '-w',
@@ -102,9 +108,12 @@ module Guard
     def start
       verify_bundler_presence unless options[:no_bundler_warning]
       ::Guard.start(options)
-    rescue Interrupt
-      ::Guard.stop
-      abort
+
+      return if ENV['GUARD_ENV'] == 'test'
+
+      while ::Guard.running do
+        sleep 0.5
+      end
     end
 
     desc 'list', 'Lists guards that can be used with init'

data/lib/guard/commands/scope.rb

@@ -0,0 +1,32 @@
+module Guard
+  class Interactor
+
+    SCOPE = Pry::CommandSet.new do
+      create_command 'scope' do
+
+        group 'Guard'
+        description 'Scope Guard actions to groups and plugins.'
+
+        banner <<-BANNER
+          Usage: scope <scope>
+
+          Set the global Guard scope.
+        BANNER
+
+        def process(*entries)
+          scope, rest = ::Guard::Interactor.convert_scope(entries)
+
+          if rest.length == 0
+            ::Guard.scope =  scope
+          else
+            output.puts "Unkown scope #{ rest.join(', ') }"
+          end
+        end
+
+      end
+    end
+
+  end
+end
+
+Pry.commands.import ::Guard::Interactor::SCOPE