guard 0.9.1 → 0.9.2

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 0.9.2 - December 22, 2011
+
+### Improvements
+
+- Add `interactor` to DSL to allow switching Guard interaction implementation. ([@netzpirat][])
+- Add quit action to the interactor. ([@Maher4Ever][])
+
+## 0.9.1 - December 19, 2011
+
+### Bug fix
+
+- Fix wrong `--no-vendor` option. ([@netzpirat][])
+- [#195](https://github.com/guard/guard/issues/195): Empty watch directory prohibit Guard from running. (reported by [@madtrick][], fixed by [@netzpirat][]
+
 ## 0.9.0 - December 19, 2011
 
 ### Bug fix
@@ -356,6 +370,8 @@
 [@jrsacks]: https://github.com/jrsacks
 [@koshigoe]: https://github.com/koshigoe
 [@limeyd]: https://github.com/limeyd
+[@madtrick]: https://github.com/madtrick
+[@Maher4Ever]: https://github.com/Maher4Ever
 [@mcmire]: https://github.com/mcmire
 [@mislav]: https://github.com/mislav
 [@monocle]: https://github.com/monocle

data/README.md

@@ -34,10 +34,6 @@ Add Guard to your `Gemfile`:
 ```ruby
 group :development do
   gem 'guard'
-
-  platforms :ruby do
-    gem 'rb-readline'
-  end
 end
 ```
 
@@ -361,11 +357,7 @@ read more about these files in the shared configuration section below.
 Interactions
 ------------
 
-You can interact with Guard and enter commands when Guard has nothing to do. You'll see a command prompt `>` when Guard
-is ready to accept a command. The command line supports history navigation with the `↑` and `↓` arrow keys, and
-command auto-completion with the `⇥` key.
-
-You can execute the following commands:
+You can interact with Guard and enter commands when Guard has nothing to do. Guard understands the following commands:
 
 * `↩`:                 Run all Guards.
 * `h`, `help`:         Show a help of the available interactor commands.
@@ -399,6 +391,23 @@ This will reload only the Ronn Guard. You can also reload all Guards within a gr
 > backend reload
 ```
 
+### Readline support
+
+With Readline enabled, you'll see a command prompt `>` when Guard is ready to accept a command. The command line
+supports history navigation with the `↑` and `↓` arrow keys, and command auto-completion with the `⇥` key.
+
+Unfortunately Readline [does not work on MRI](http://bugs.ruby-lang.org/issues/5539) on Mac OS X by default. You can
+work around the issue by installing a pure Ruby implementation:
+
+```ruby
+platforms :ruby do
+  gem 'rb-readline'
+end
+```
+
+Guard will automatically enable Readline support if your environment supports it, but you can disable Readline with the
+`interactor` DSL method or turn off completely with the `--no-interactions` option.
+
 Guardfile DSL
 -------------
 
@@ -529,6 +538,26 @@ or using the cli switch `-n`:
 notification :off
 ```
 
+### interactor
+
+You can disable the interactor auto detection and for a specific implementation:
+
+```ruby
+interactor :readline
+```
+
+will select Readline interactor. You can also force the simple interactor without Readline support with:
+
+```ruby
+interactor :simple
+```
+
+If you do not need the keyboard interactions with Guard at all, you can turn them off:
+
+```ruby
+interactor :off
+```
+
 ### callback
 
 The `callback` method allows you to execute arbitrary code before or after any of the `start`, `stop`, `reload`,

data/lib/guard.rb

@@ -62,7 +62,6 @@ module Guard
       @options    = options
       @guards     = []
       self.reset_groups
-      @interactor = Interactor.new unless options[:no_interactions]
       @listener   = Listener.select_and_init(options)
 
       UI.clear if @options[:clear]
@@ -177,7 +176,11 @@ module Guard
         run_supervised_task(guard, :start)
       end
 
-      interactor.start if interactor
+      unless options[:no_interactions]
+        @interactor = Interactor.fabricate
+        @interactor.start if @interactor
+      end
+
       listener.start
     end
 

data/lib/guard/dsl.rb

@@ -276,6 +276,21 @@ module Guard
       ::Guard::Notifier.add_notification(notifier.to_sym, options, false)
     end
 
+    # Sets the interactor to use.
+    #
+    # @example Use the readline interactor
+    #   interactor :readline
+    #
+    # @example Use the gets interactor
+    #   interactor :gets
+    #
+    # @example Turn off interactions
+    #   interactor :off
+    #
+    def interactor(interactor)
+      ::Guard::Interactor.interactor = interactor.to_sym
+    end
+
     # Declares a group of guards to be run with `guard start --group group_name`.
     #
     # @example Declare two groups of Guards

data/lib/guard/interactor.rb

@@ -1,21 +1,20 @@
-require 'readline'
-
 module Guard
 
-  # The interactor reads user input and triggers
-  # specific action upon them unless its locked.
-  #
-  # It used the readline library for history and
-  # completion support.
+  autoload :ReadlineInteractor, 'guard/interactors/readline'
+  autoload :SimpleInteractor,   'guard/interactors/simple'
+
+  # The interactor triggers specific action from input
+  # read by a interactor implementation.
   #
   # Currently the following actions are implemented:
   #
-  # - h, help         => Show help
-  # - e, exit         => Exit Guard
-  # - r, reload       => Reload Guard
-  # - p, pause        => Toggle file modification listener
-  # - n, notification => Toggle notifications
-  # - <enter>         => Run all
+  # - h, help          => Show help
+  # - e, exit,
+  #   q. quit          => Exit Guard
+  # - r, reload        => Reload Guard
+  # - p, pause         => Toggle file modification listener
+  # - n, notification  => Toggle notifications
+  # - <enter>          => Run all
   #
   # It's also possible to scope `reload` and `run all` actions to only a specified group or a guard.
   #
@@ -28,29 +27,62 @@ module Guard
   # @example Run all jasmine specs
   #   jasmine
   #
+  # @abstract
+  #
   class Interactor
 
     HELP_ENTRIES         = %w[help h]
     RELOAD_ENTRIES       = %w[reload r]
-    STOP_ENTRIES         = %w[exit e]
+    STOP_ENTRIES         = %w[exit e quit q]
     PAUSE_ENTRIES        = %w[pause p]
     NOTIFICATION_ENTRIES = %w[notification n]
 
-    COMPLETION_ACTIONS   = %w[help reload exit pause notification]
+    # Set the interactor implementation
+    #
+    # @param [Symbol] interactor the name of the interactor
+    #
+    def self.interactor=(interactor)
+      @interactor = interactor
+    end
 
-    # Initialize the interactor.
+    # Get an instance of the currently configured
+    # interactor implementation.
     #
-    def initialize
-      unless defined?(RbReadline) || defined?(JRUBY_VERSION)
-        ::Guard::UI.info 'Please add rb-readline for proper Readline support.'
+    # @return [Interactor] an interactor implementation
+    #
+    def self.fabricate
+      case @interactor
+      when :readline
+        ReadlineInteractor.new
+      when :simple
+        SimpleInteractor.new
+      when :off
+        nil
+      else
+        auto_detect
       end
-      
-      Readline.completion_proc = proc { |word| auto_complete(word) }
+    end
+
+    # Tries to detect an optimal interactor for the
+    # current environment.
+    #
+    # It returns the Readline implementation when:
+    #
+    # * rb-readline is installed
+    # * The Ruby implementation is JRuby
+    # * The current OS is not Mac OS X
+    #
+    # Otherwise the plain gets interactor is returned.
+    #
+    # @return [Interactor] an interactor implementation
+    #
+    def self.auto_detect
+      require 'readline'
 
-      begin
-        Readline.completion_append_character = ' '
-      rescue NotImplementedError
-        # Ignore, we just don't support it then
+      if defined?(RbReadline) || defined?(JRUBY_VERSION) || !RbConfig::CONFIG['target_os'] =~ /darwin/i
+        ReadlineInteractor.new
+      else
+        SimpleInteractor.new
       end
     end
 
@@ -69,40 +101,13 @@ module Guard
       end
     end
 
-    # Read a line from stdin with Readline.
+    # Read the user input. This method must be implemented
+    # by each interactor implementation.
     #
-    def read_line
-      while line = Readline.readline(prompt, true)
-        process_input(line)
-      end
-    end
-
-    # Auto complete the given word.
-    #
-    # @param [String] word the partial word
-    # @return [Array<String>] the matching words
-    #
-    def auto_complete(word)
-      completion_list.grep(/^#{ Regexp.escape(word) }/)
-    end
-
-    # Get the auto completion list.
-    #
-    # @return [Array<String>] the list of words
+    # @abstract
     #
-    def completion_list
-      groups = ::Guard.groups.map { |group| group.name.to_s }
-      guards = ::Guard.guards.map { |guard| guard.class.to_s.downcase.sub('guard::', '') }
-
-      COMPLETION_ACTIONS + groups + guards - ['default']
-    end
-
-    # The current interactor prompt
-    #
-    # @return [String] the prompt to show
-    #
-    def prompt
-      ::Guard.listener.paused? ? 'p> ' : '> '
+    def read_line
+      raise NotImplementedError
     end
 
     # Process the input from readline.
@@ -110,10 +115,6 @@ module Guard
     # @param [String] line the input line
     #
     def process_input(line)
-      if line =~ /^\s*$/ or Readline::HISTORY.to_a[-2] == line
-        Readline::HISTORY.pop
-      end
-
       scopes, action = extract_scopes_and_action(line)
 
       case action
@@ -159,10 +160,10 @@ module Guard
     #
     def help
       puts ''
-      puts 'e, exit          Exit Guard'
-      puts 'p, pause         Toggle file modification listener'
-      puts 'r, reload        Reload Guard'
-      puts 'n, notification  Toggle notifications'
+      puts '[e]xit, [q]uit   Exit Guard'
+      puts '[p]ause          Toggle file modification listener'
+      puts '[r]eload         Reload Guard'
+      puts '[n]otification   Toggle notifications'
       puts '<enter>          Run all Guards'
       puts ''
       puts 'You can scope the reload action to a specific guard or group:'

data/lib/guard/interactors/readline.rb

@@ -0,0 +1,72 @@
+module Guard
+
+  # Interactor that used readline for getting the user input.
+  # This enables history support and auto-completion, but is
+  # broken on OS X without installing `rb-readline` or using JRuby.
+  #
+  # @see http://bugs.ruby-lang.org/issues/5539
+  #
+  class ReadlineInteractor < Interactor
+
+    COMPLETION_ACTIONS   = %w[help reload exit pause notification]
+
+    # Initialize the interactor.
+    #
+    def initialize
+      require 'readline'
+
+      unless defined?(RbReadline) || defined?(JRUBY_VERSION)
+        ::Guard::UI.info 'Please add rb-readline for proper Readline support.'
+      end
+
+      Readline.completion_proc = proc { |word| auto_complete(word) }
+
+      begin
+        Readline.completion_append_character = ' '
+      rescue NotImplementedError
+        # Ignore, we just don't support it then
+      end
+    end
+
+    # Read a line from stdin with Readline.
+    #
+    def read_line
+      while line = Readline.readline(prompt, true)
+        if line =~ /^\s*$/ or Readline::HISTORY.to_a[-2] == line
+          Readline::HISTORY.pop
+        end
+
+        process_input(line)
+      end
+    end
+
+    # Auto complete the given word.
+    #
+    # @param [String] word the partial word
+    # @return [Array<String>] the matching words
+    #
+    def auto_complete(word)
+      completion_list.grep(/^#{ Regexp.escape(word) }/)
+    end
+
+    # Get the auto completion list.
+    #
+    # @return [Array<String>] the list of words
+    #
+    def completion_list
+      groups = ::Guard.groups.map { |group| group.name.to_s }
+      guards = ::Guard.guards.map { |guard| guard.class.to_s.downcase.sub('guard::', '') }
+
+      COMPLETION_ACTIONS + groups + guards - ['default']
+    end
+
+    # The current interactor prompt
+    #
+    # @return [String] the prompt to show
+    #
+    def prompt
+      ::Guard.listener.paused? ? 'p> ' : '> '
+    end
+
+  end
+end

data/lib/guard/interactors/simple.rb

@@ -0,0 +1,17 @@
+module Guard
+
+  # Simple interactor that that reads user
+  # input from standard input.
+  #
+  class SimpleInteractor < Interactor
+
+    # Read a line from stdin with Readline.
+    #
+    def read_line
+      while line = $stdin.gets
+        process_input(line.chomp)
+      end
+    end
+
+  end
+end

data/lib/guard/version.rb

@@ -1,6 +1,6 @@
 module Guard
   unless defined? Guard::VERSION
     # The current gem version of Guard
-    VERSION = '0.9.1'
+    VERSION = '0.9.2'
   end
 end

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" "October 2011" "" ""
+.TH "GUARD" "1" "December 2011" "" ""
 .
 .SH "NAME"
 \fBguard\fR \- Guard keeps an eye on your file modifications\.
@@ -27,7 +27,7 @@ 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\-v\fR, \fB\-\-verbose\fR Runs Guard in verbose mode\.
 .
 .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\.
@@ -44,7 +44,7 @@ The following options are available:
 .P
 \fB\-i\fR, \fB\-\-no\-interactions\fR Turn off completely any Guard terminal interactions\.
 .
-.SS "init <a href=\"guard\.html\">GUARD</a>"
+.SS "init [GUARD]"
 If no Guardfile is present in the current directory, creates an empty Guardfile\.
 .
 .P

data/man/guard.1.html

@@ -97,8 +97,8 @@
   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>-d</code>, <code>--debug</code>
-  Runs Guard in debug mode.</p>
+<p><code>-v</code>, <code>--verbose</code>
+  Runs Guard in verbose mode.</p>
 
 <p><code>-g</code>, <code>--group</code> <var>GROUP1</var> <var>GROUP2</var>...
   Runs only the groups specified by GROUP1, GROUP2 etc.
@@ -117,7 +117,7 @@
 <p><code>-i</code>, <code>--no-interactions</code>
   Turn off completely any Guard terminal interactions.</p>
 
-<h3 id="init-GUARD">init <a href="guard.html">GUARD</a></h3>
+<h3 id="init-GUARD-">init [GUARD]</h3>
 
 <p>If no Guardfile is present in the current directory, creates an empty Guardfile.</p>
 
@@ -172,7 +172,7 @@ https://github.com/guard/guard/blob/master/CHANGELOG.md</p>
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>October 2011</li>
+    <li class='tc'>December 2011</li>
     <li class='tr'>guard(1)</li>
   </ol>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-19 00:00:00.000000000Z
+date: 2011-12-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70121759712180 !ruby/object:Gem::Requirement
+  requirement: &70324163239920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *70121759712180
+  version_requirements: *70324163239920
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &70121759711540 !ruby/object:Gem::Requirement
+  requirement: &70324163237020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70121759711540
+  version_requirements: *70324163237020
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70121759710920 !ruby/object:Gem::Requirement
+  requirement: &70324163234420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70121759710920
+  version_requirements: *70324163234420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70121759709980 !ruby/object:Gem::Requirement
+  requirement: &70324163232220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70121759709980
+  version_requirements: *70324163232220
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70121759709280 !ruby/object:Gem::Requirement
+  requirement: &70324163230380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.5.0
   type: :development
   prerelease: false
-  version_requirements: *70121759709280
+  version_requirements: *70324163230380
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70121759708200 !ruby/object:Gem::Requirement
+  requirement: &70324163229000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.7.3
   type: :development
   prerelease: false
-  version_requirements: *70121759708200
+  version_requirements: *70324163229000
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70121759706360 !ruby/object:Gem::Requirement
+  requirement: &70324163221540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.17.2
   type: :development
   prerelease: false
-  version_requirements: *70121759706360
+  version_requirements: *70324163221540
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70121759704960 !ruby/object:Gem::Requirement
+  requirement: &70324163213600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 0.9.6.2
   type: :development
   prerelease: false
-  version_requirements: *70121759704960
+  version_requirements: *70324163213600
 description: Guard is a command line tool to easily handle events on file system modifications.
 email:
 - thibaud@thibaud.me
@@ -119,6 +119,8 @@ files:
 - lib/guard/guard.rb
 - lib/guard/hook.rb
 - lib/guard/interactor.rb
+- lib/guard/interactors/readline.rb
+- lib/guard/interactors/simple.rb
 - lib/guard/listener.rb
 - lib/guard/listeners/darwin.rb
 - lib/guard/listeners/linux.rb