guard 1.4.0 → 1.5.0

data/lib/guard/commands/reload.rb

@@ -0,0 +1,35 @@
+module Guard
+  class Interactor
+
+    RELOAD = Pry::CommandSet.new do
+      create_command 'reload' do
+
+        group 'Guard'
+        description 'Reload all plugins.'
+
+        banner <<-BANNER
+          Usage: reload <scope>
+
+          Run the Guard plugin `reload` action.
+
+          You may want to specify an optional scope to the action,
+          either the name of a Guard plugin or a plugin group.
+        BANNER
+
+        def process(*entries)
+          scopes, rest = ::Guard::Interactor.convert_scope(entries)
+
+          if rest.length == 0
+            ::Guard.reload scopes
+          else
+            output.puts "Unkown scope #{ rest.join(', ') }"
+          end
+        end
+
+      end
+    end
+
+  end
+end
+
+Pry.commands.import ::Guard::Interactor::RELOAD

data/lib/guard/commands/show.rb

@@ -0,0 +1,27 @@
+require 'guard/dsl_describer'
+
+module Guard
+  class Interactor
+
+    SHOW = Pry::CommandSet.new do
+      create_command 'show' do
+
+        group 'Guard'
+        description 'Show all Guard plugins.'
+
+        banner <<-BANNER
+          Usage: show <scope>
+
+          Show all defined Guard plugins and their options.
+        BANNER
+
+        def process
+          ::Guard::DslDescriber.show(::Guard.options)
+        end
+      end
+    end
+
+  end
+end
+
+Pry.commands.import ::Guard::Interactor::SHOW

data/lib/guard/dsl.rb

@@ -16,7 +16,7 @@ module Guard
   #
   # A more advanced DSL use is the `callback` keyword that allows you to execute arbitrary
   # code before or after any of the `start`, `stop`, `reload`, `run_all`, `run_on_changes`,
-  # `run_on_additions`, `run_on_modifications` and `run_on_removals` Guard plugins method. 
+  # `run_on_additions`, `run_on_modifications` and `run_on_removals` Guard plugins method.
   # You can even insert more hooks inside these methods.
   # Please [checkout the Wiki page](https://github.com/guard/guard/wiki/Hooks-and-callbacks) for more details.
   #
@@ -93,12 +93,21 @@ module Guard
 
     # Deprecation message for the `ignore_paths` method
     IGNORE_PATHS_DEPRECATION = <<-EOS.gsub(/^\s*/, '')
-      Starting with Guard v1.1 the use of the 'ignore_paths' Guardfile dsl method is deprecated.
+      Starting with Guard v1.1 the use of the 'ignore_paths' Guardfile DSL method is deprecated.
 
       Please replace that method with the better 'ignore' or/and 'filter' methods.
       Documentation on the README: https://github.com/guard/guard#guardfile-dsl-ignore
     EOS
 
+    # Deprecation message for the `ignore_paths` method
+    INTERACTOR_DEPRECATION = <<-EOS.gsub(/^\s*/, '')
+      Starting with Guard v1.4 the use of the 'interactor' Guardfile DSL method is only used to
+      turn the Pry interactor off. All other usages are deprecated.
+
+      Please make use of the Pry plugin architecture to customize the interactions and place them
+      either in your `~/.guardrc` or the `Guardfile`.
+    EOS
+
     class << self
 
       @@options = nil
@@ -315,17 +324,15 @@ module Guard
 
     # 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
+      if interactor == :off
+        ::Guard.options[:no_interactions] = true
+      else
+        ::Guard::UI.deprecation(INTERACTOR_DEPRECATION)
+      end
     end
 
     # Declares a group of Guard plugins to be run with `guard start --group group_name`.
@@ -465,5 +472,62 @@ module Guard
       ::Guard.listener = ::Guard.listener.filter(*regexps)
     end
 
+    # Configure the Guard logger.
+    #
+    # * Log level must be either `:debug`, `:info`, `:warn` or `:error`.
+    # * Template supports the following placeholders: `:time`, `:severity`, `:progname`, `:pid`, `:unit_of_work_id` and `:message`
+    # * Time format directives are the same as Time#strftime or :milliseconds
+    # * The `:only` and `:except` options must be a RegExp.
+    #
+    # @example Set the log level
+    #   logger :level => :warn
+    #
+    # @example Set a custom log template
+    #   logger :template => '[Guard - :severity - :progname - :time] :message'
+    #
+    # @example Set a custom time format
+    #   logger :time_format => '%h'
+    #
+    # @example Limit logging to a Guard plugin
+    #   logger :only => :jasmine
+    #
+    # @example Log all but not the messages from a specific Guard plugin
+    #   logger :except => :jasmine
+    #
+    # @param [Hash] options the log options
+    # @option options [String, Symbol] level the log level
+    # @option options [String] template the logger template
+    # @option options [String, Symbol] time_format the time format
+    # @option options [RegExp] only show only messages from the matching Guard plugin
+    # @option options [RegExp] except does not show messages from the matching Guard plugin
+    #
+    def logger(options)
+      if options[:level]
+        options[:level] = options[:level].to_sym
+
+        unless [:debug, :info, :warn, :error].include? options[:level]
+          ::Guard::UI.warning "Invalid log level `#{ options[:level] }` ignored. Please use either :debug, :info, :warn or :error."
+          options.delete :level
+        end
+      end
+
+      if options[:only] && options[:except]
+        ::Guard::UI.warning "You cannot specify the logger options :only and :except at the same time."
+
+        options.delete :only
+        options.delete :except
+      end
+
+      # Convert the :only and :except options to a regular expression
+      [:only, :except].each do |name|
+        if options[name]
+          list = [].push(options[name]).flatten.map { |plugin| Regexp.escape(plugin.to_s) }.join('|')
+          options[name] = Regexp.new(list, Regexp::IGNORECASE)
+        end
+      end
+
+      ::Guard::UI.options = ::Guard::UI.options.merge options
+    end
+
   end
 end

data/lib/guard/interactor.rb

@@ -1,110 +1,123 @@
 module Guard
 
-  # The interactor triggers specific action from input
-  # read by a interactor implementation.
-  #
-  # Currently the following actions are implemented:
-  #
-  # - h, help          => Show help
-  # - e, exit,
-  #   q. quit          => Exit Guard
-  # - r, reload        => Reload Guard
-  # - p, pause         => Toggle file modification listener
-  # - n, notification  => Toggle notifications
-  # - s, show          => Show Guard plugin configuration
-  # - c, change        => Trigger a file change
-  # - <enter>          => Run all
-  #
-  # It's also possible to scope `reload` and `run all` actions to only a specified group or a guard.
-  #
-  # @example Reload backend group
-  #   backend reload
-  #   reload backend
-  #
-  # @example Reload rspec guard
-  #   spork reload
-  #   reload spork
-  #
-  # @example Run all jasmine specs
-  #   jasmine
-  #
-  # @abstract
+  # The Guard interactor is a Pry REPL with a Guard
+  # specific command set.
   #
   class Interactor
 
+    require 'pry'
+
     require 'guard'
     require 'guard/ui'
-    require 'guard/dsl_describer'
-    require 'guard/notifier'
-    require 'guard/interactors/readline'
-    require 'guard/interactors/coolline'
-    require 'guard/interactors/simple'
-
-    ACTIONS = {
-      :help         => %w[help h],
-      :reload       => %w[reload r],
-      :stop         => %w[exit e quit q],
-      :pause        => %w[pause p],
-      :notification => %w[notification n],
-      :show         => %w[show s],
-      :change       => %w[change c]
-    }
-
-    # Set the interactor implementation
-    #
-    # @param [Symbol] interactor the name of the interactor
+
+    require 'guard/commands/all'
+    require 'guard/commands/change'
+    require 'guard/commands/notification'
+    require 'guard/commands/pause'
+    require 'guard/commands/reload'
+    require 'guard/commands/show'
+
+    GUARD_RC = '~/.guardrc'
+    HISTORY_FILE = '~/.guard_history'
+
+    # Initialize the interactor. This configures
+    # Pry and creates some custom commands and aliases
+    # for Guard.
     #
-    def self.interactor=(interactor)
-      @interactor = interactor
+    def initialize
+      return if ENV['GUARD_ENV'] == 'test'
+
+      Pry.config.history.file = HISTORY_FILE
+
+      load_guard_rc
+
+      create_run_all_command
+      create_command_aliases
+      create_guard_commands
+      create_group_commands
+
+      configure_prompt
     end
 
-    # Get an instance of the currently configured
-    # interactor implementation.
+    # Loads the `~/.guardrc` file when pry has started.
     #
-    # @return [Interactor] an interactor implementation
-    #
-    def self.fabricate
-      case @interactor
-      when :coolline
-        ::Guard::CoollineInteractor.new if ::Guard::CoollineInteractor.available?
-      when :readline
-        ::Guard::ReadlineInteractor.new if ::Guard::ReadlineInteractor.available?
-      when :simple
-        ::Guard::SimpleInteractor.new
-      when :off
-        nil
-      else
-        auto_detect
+    def load_guard_rc
+      Pry.config.hooks.add_hook :when_started, :load_guard_rc do
+        load GUARD_RC if File.exist? File.expand_path GUARD_RC
       end
     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
+    # Creates a command that triggers the `:run_all` action
+    # when the command is empty (just pressing enter on the
+    # beginning of a line).
     #
-    # Otherwise the plain gets interactor is returned.
+    def create_run_all_command
+      Pry.commands.block_command /^$/, 'Hit enter to run all' do
+        Pry.run_command 'all'
+      end
+    end
+
+    # Creates command aliases for the commands
+    # `help`, `reload`, `change`, `show`, `notification`, `pause`, `exit` and `quit`,
+    # which will be the first letter of the command.
     #
-    # @return [Interactor] an interactor implementation
+    def create_command_aliases
+      %w(help reload change show notification pause exit quit).each do |command|
+        Pry.commands.alias_command command[0].chr, command
+      end
+    end
+
+    # Create a shorthand command to run the `:run_all`
+    # action on a specific Guard plugin. For example,
+    # when guard-rspec is available, then a command
+    # `rspec` is created that runs `all rspec`.
     #
-    def self.auto_detect
-      [::Guard::CoollineInteractor, ::Guard::ReadlineInteractor, ::Guard::SimpleInteractor].detect do |interactor|
-        interactor.available?(true)
-      end.new
+    def create_guard_commands
+      ::Guard.guards.each do |guard|
+        name = guard.class.to_s.downcase.sub('guard::', '')
+
+        Pry.commands.create_command name, "Run all #{ name }" do
+          group 'Guard'
+
+          def process
+            Pry.run_command "all #{ match }"
+          end
+        end
+      end
     end
 
-    # Template method for checking if the Interactor is
-    # available in the current environment?
+    # Create a shorthand command to run the `:run_all`
+    # action on a specific Guard group. For example,
+    # when you have a group `frontend`, then a command
+    # `frontend` is created that runs `all frontend`.
     #
-    # @param [Boolean] silent true if no error messages should be shown
-    # @return [Boolean] the availability status
+    def create_group_commands
+      ::Guard.groups.each do |group|
+        name = group.name.to_s
+        next if name == 'default'
+
+        Pry.commands.create_command name, "Run all #{ name }" do
+          group 'Guard'
+
+          def process
+            Pry.run_command "all #{ match }"
+          end
+        end
+      end
+    end
+
+    # Configure the pry prompt to see `guard` instead of
+    # `pry`.
     #
-    def self.available?(silent = false)
-      true
+    def configure_prompt
+      Pry.config.prompt = [
+        proc do |target_self, nest_level, pry|
+          "[#{ pry.input_array.size }] #{ ::Guard.listener.paused? ? 'pause' : 'guard' }(#{ Pry.view_clip(target_self) })#{":#{ nest_level }" unless nest_level.zero? }> "
+        end,
+        proc do |target_self, nest_level, pry|
+          "[#{ pry.input_array.size }] #{ ::Guard.listener.paused? ? 'pause' : 'guard' }(#{ Pry.view_clip(target_self) })#{":#{ nest_level }" unless nest_level.zero? }* "
+        end
+      ]
     end
 
     # Start the line reader in its own thread.
@@ -112,8 +125,17 @@ module Guard
     def start
       return if ENV['GUARD_ENV'] == 'test'
 
-      ::Guard::UI.debug 'Start interactor'
-      @thread = Thread.new { read_line } if !@thread || !@thread.alive?
+      store_terminal_settings if stty_exists?
+
+      if !@thread || !@thread.alive?
+        ::Guard::UI.debug 'Start interactor'
+
+        @thread = Thread.new do
+          Pry.start
+          ::Guard.stop
+          exit
+        end
+      end
     end
 
     # Kill interactor thread if not current
@@ -121,157 +143,57 @@ module Guard
     def stop
       return if !@thread || ENV['GUARD_ENV'] == 'test'
 
-      ::Guard::UI.debug 'Stop interactor'
       unless Thread.current == @thread
+        ::Guard::UI.debug 'Stop interactor'
         @thread.kill
       end
-    end
 
-    # Read the user input. This method must be implemented
-    # by each interactor implementation.
-    #
-    # @abstract
-    #
-    def read_line
-      raise NotImplementedError
+      restore_terminal_settings if stty_exists?
     end
 
-    # Process the input from readline.
-    #
-    # @param [String] line the input line
+    # Detects whether or not the stty command exists
+    # on the user machine.
     #
-    def process_input(line)
-      scopes, action, rest = extract_scopes_and_action(line)
-
-      case action
-      when :help
-        help
-      when :show
-        ::Guard::DslDescriber.show(::Guard.options)
-      when :stop
-        ::Guard.stop
-        exit
-      when :pause
-        ::Guard.pause
-      when :reload
-        ::Guard.reload(scopes)
-      when :change
-        ::Guard.within_preserved_state do
-          ::Guard.runner.run_on_changes(rest, [], [])
-        end
-      when :run_all
-        ::Guard.run_all(scopes)
-      when :notification
-        toggle_notification
-      else
-        ::Guard::UI.error "Unknown command #{ line }"
-      end
-    end
-
-    # Toggle the system notifications on/off
+    # @return [Boolean] the status of stty
     #
-    def toggle_notification
-      if ENV['GUARD_NOTIFY'] == 'true'
-        ::Guard::UI.info 'Turn off notifications'
-        ::Guard::Notifier.turn_off
-      else
-        ::Guard::Notifier.turn_on
-      end
+    def stty_exists?
+      @stty_exists ||= system('hash', 'stty')
     end
 
-    # Show the help.
+    # Stores the terminal settings so we can resore them
+    # when stopping.
     #
-    def help
-      puts ''
-      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 '[s]how           Show available Guard plugins'
-      puts '[c]hange <file>  Trigger a file change'
-      puts '<enter>          Run all Guard plugins'
-      puts ''
-      puts 'You can scope the reload action to a specific guard or group:'
-      puts ''
-      puts 'rspec reload     Reload the RSpec Guard'
-      puts 'backend reload   Reload the backend group'
-      puts ''
-      puts 'You can also run only a specific Guard or all Guard plugins in a specific group:'
-      puts ''
-      puts 'jasmine          Run the jasmine Guard'
-      puts 'frontend         Run all Guard plugins in the frontend group'
-      puts ''
+    def store_terminal_settings
+      @stty_save = `stty -g 2>/dev/null`.chomp
     end
 
-    # Extract the Guard or group scope and action from the
-    # input line. There's no strict order for scopes and
-    # actions.
-    #
-    # @example `spork reload` will only reload rspec
-    # @example `jasmine` will only run all jasmine specs
+    # Restore terminal settings
     #
-    # @param [String] line the readline input
-    # @return [Array] the group or guard scope, the action and the rest
-    #
-    def extract_scopes_and_action(line)
-      entries = line.split(' ')
-
-      scopes = extract_scopes(entries)
-      action = extract_action(entries)
-
-      action = :run_all if !action && (!scopes.empty? || entries.empty?)
-
-      [scopes, action, entries]
+    def restore_terminal_settings
+      system("stty #{ @stty_save } 2>/dev/null") if @stty_save
     end
 
-    private
-
-    # Extract a guard or group scope from entry if valid.
-    # Any entry found will be removed from the entries.
+    # Converts and validates a plain text scope
+    # to a valid plugin or group scope.
     #
-    # @param [Array<String>] entries the user entries
-    # @return [Hash] a hash with a Guard or a group scope
+    # @param [Array<String>] entries the text scope
+    # @return [Hash, Array<String>] the plugin or group scope, the unknown entries
     #
-    def extract_scopes(entries)
-      scopes = { }
+    def self.convert_scope(entries)
+      scopes  = { }
+      unknown = []
 
-      entries.delete_if do |entry|
+      entries.each do |entry|
         if guard = ::Guard.guards(entry)
           scopes[:guard] ||= guard
-          true
-
         elsif group = ::Guard.groups(entry)
           scopes[:group] ||= group
-          true
-
         else
-          false
+          unknown << entry
         end
       end
 
-      scopes
+      [scopes, unknown]
     end
-
-    # Find the action for the given input entry.
-    # Any action found will be removed from the entries.
-    #
-    # @param [Array<String>] entries the user entries
-    # @return [Symbol] a Guard action
-    #
-    def extract_action(entries)
-      action = nil
-
-      entries.delete_if do |entry|
-        if command = ACTIONS.detect { |k, list| list.include?(entry) }
-          action ||= command.first
-          true
-        else
-          false
-        end
-      end
-
-      action
-    end
-
   end
 end