guard 1.5.4 → 1.6.0

data/lib/guard/dsl.rb

@@ -102,10 +102,7 @@ module Guard
     # 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`.
+      disable or pass options to the Pry interactor. All other usages are deprecated.
     EOS
 
     class << self
@@ -327,9 +324,15 @@ module Guard
     # @example Turn off interactions
     #   interactor :off
     #
-    def interactor(interactor)
-      if interactor == :off
-        ::Guard.options[:no_interactions] = true
+    # @param [Symbol,Hash] options either `:off` or a Hash with interactor options
+    #
+    def interactor(options)
+      if options == :off
+        ::Guard::Interactor.enabled = false
+
+      elsif options.is_a?(Hash)
+        ::Guard::Interactor.options = options
+
       else
         ::Guard::UI.deprecation(INTERACTOR_DEPRECATION)
       end
@@ -358,10 +361,9 @@ module Guard
     # @see Guard::DslDescriber
     #
     def group(name, options = {})
-      @groups = @@options[:group] || []
       name    = name.to_sym
 
-      if block_given? && (@groups.empty? || @groups.map(&:to_sym).include?(name))
+      if block_given?
         ::Guard.add_group(name.to_s.downcase, options)
         @current_group = name
 
@@ -450,7 +452,7 @@ module Guard
       ::Guard::UI.deprecation(IGNORE_PATHS_DEPRECATION)
     end
 
-    # Ignore certain patterns paths globally.
+    # Ignore certain paths globally.
     #
     # @example Ignore some paths
     #   ignore %r{^ignored/path/}, /man/
@@ -461,10 +463,21 @@ module Guard
       ::Guard.listener = ::Guard.listener.ignore(*regexps)
     end
 
-    # Filter certain patterns paths globally.
+    # Replace ignored paths globally
+    #
+    # @example Ignore only these paths
+    #   ignore! %r{^ignored/path/}, /man/
+    #
+    # @param [Regexp] regexps a pattern for ignoring paths
+    #
+    def ignore!(*regexps)
+      ::Guard.listener = ::Guard.listener.ignore!(*regexps)
+    end
+
+    # Filter certain paths globally.
     #
     # @example Filter some files
-    #   ignore /\.txt$/, /.*\.zip/
+    #   filter /\.txt$/, /.*\.zip/
     #
     # @param [Regexp] regexps a pattern for filtering paths
     #
@@ -472,6 +485,17 @@ module Guard
       ::Guard.listener = ::Guard.listener.filter(*regexps)
     end
 
+    # Replace filtered paths globally.
+    #
+    # @example Filter only these files
+    #   filter! /\.txt$/, /.*\.zip/
+    #
+    # @param [Regexp] regexps a pattern for filtering paths
+    #
+    def filter!(*regexps)
+      ::Guard.listener = ::Guard.listener.filter!(*regexps)
+    end
+
     # Configure the Guard logger.
     #
     # * Log level must be either `:debug`, `:info`, `:warn` or `:error`.
@@ -529,5 +553,33 @@ module Guard
       ::Guard::UI.options = ::Guard::UI.options.merge options
     end
 
+    # Sets the default scope on startup
+    #
+    # @example Scope Guard to a single group
+    #   scope :group => :frontend
+    #
+    # @example Scope Guard to multiple groups
+    #   scope :groups => [:specs, :docs]
+    #
+    # @example Scope Guard to a single plugin
+    #   scope :plugin => :test
+    #
+    # @example Scope Guard to multiple plugins
+    #   scope :plugins => [:jasmine, :rspec]
+    #
+    # @param [Hash] scopes the scope for the groups and plugins
+    #
+    def scope(scopes = {})
+      if ::Guard.options[:plugin].empty?
+        ::Guard.options[:plugin] = [scopes[:plugin]] if scopes[:plugin]
+        ::Guard.options[:plugin] = scopes[:plugins]  if scopes[:plugins]
+      end
+
+      if ::Guard.options[:group].empty?
+        ::Guard.options[:group] = [scopes[:group]] if scopes[:group]
+        ::Guard.options[:group] = scopes[:groups]  if scopes[:groups]
+      end
+    end
+
   end
 end

data/lib/guard/group.rb

@@ -37,7 +37,7 @@ module Guard
     # @return [String] the group name
     #
     def to_s
-      "#{@name} group"
+      @name.to_s.capitalize
     end
 
   end

data/lib/guard/guard.rb

@@ -58,6 +58,15 @@ module Guard
       @watchers, @options = watchers, options
     end
 
+    # Specify the source for the Guardfile template.
+    # Each Guard plugin can redefine this method to add its own logic.
+    #
+    # @param [String] The plugin name
+    #
+    def self.template(name)
+      File.read("#{ ::Guard.locate_guard(name) }/lib/guard/#{ name }/templates/Guardfile")
+    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`.
     #
@@ -68,7 +77,7 @@ module Guard
         ::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")
+        guard = template(name)
 
         File.open('Guardfile', 'wb') do |f|
           f.puts(content)
@@ -143,12 +152,13 @@ module Guard
     # @!method run_on_removals(paths)
 
     # Convert plugin to string representation. The
-    # default just uses the plugin class name.
-    # 
+    # default just uses the plugin class name and
+    # removes the Guard module name.
+    #
     # @return [String] the string representation
     #
     def to_s
-      self.class.to_s
+      self.class.to_s.downcase.sub('guard::', '').capitalize
     end
 
   end

data/lib/guard/guardfile.rb

@@ -30,6 +30,24 @@ module Guard
         end
       end
 
+      # Opens an existing guardfile and searches for redundant definitions
+      # if extraneous defintions are found, it warns the user
+      #
+      # @see Guard::CLI.init
+      #
+      # @param [String] class name of gem definition that you would like to search for in the Guardfile
+      # @param [String] contents of existing guardfile
+      #
+      def duplicate_definitions?(guard_class, guard_file)
+        matches = guard_file.to_s.scan(/guard\s[\'|\"]#{guard_class}[\'|\"]\sdo/)
+        if matches.count > 1
+          ::Guard::UI.info "There are #{matches.count.to_s} definitions in your Guardfile for '#{guard_class}', you may want to clean up your Guardfile as this could cause issues."
+          return true
+        else
+          return false
+        end
+      end
+
       # Adds the Guardfile template of a Guard implementation
       # to an existing Guardfile.
       #
@@ -42,6 +60,9 @@ module Guard
 
         if guard_class
           guard_class.init(guard_name)
+          guardfile_name = 'Guardfile'
+          guard_file = File.read(guardfile_name) if File.exists?(guardfile_name)
+          duplicate_definitions?(guard_name, guard_file)
         elsif File.exist?(File.join(HOME_TEMPLATES, guard_name))
           content  = File.read('Guardfile')
           template = File.read(File.join(HOME_TEMPLATES, guard_name))

data/lib/guard/interactor.rb

@@ -15,11 +15,69 @@ module Guard
     require 'guard/commands/notification'
     require 'guard/commands/pause'
     require 'guard/commands/reload'
+    require 'guard/commands/scope'
     require 'guard/commands/show'
 
-    GUARD_RC = '~/.guardrc'
+    # The default Ruby script to configure Guard Pry if the option `:guard_rc` is not defined.
+    GUARD_RC     = '~/.guardrc'
+
+    # The default Guard Pry history file if the option `:history_file` is not defined.
     HISTORY_FILE = '~/.guard_history'
 
+    # List of shortcuts for each interactor command
+    SHORTCUTS = {
+      :help         => 'h',
+      :all          => 'a',
+      :reload       => 'r',
+      :change       => 'c',
+      :show         => 's',
+      :scope        => 'o',
+      :notification => 'n',
+      :pause        => 'p',
+      :exit         => 'e',
+      :quit         => 'q'
+    }
+
+    attr_accessor :thread
+
+    class << self
+
+      # Get the interactor options
+      #
+      # @return [Hash] the options
+      #
+      def options
+        @options ||= { }
+      end
+
+      # Set the interactor options
+      #
+      # @param [Hash] options the interactor options
+      # @option options [String] :guard_rc the Ruby script to configure Guard Pry
+      # @option options [String] :history_file the file to write the Pry history to
+      #
+      def options=(options)
+        @options = options
+      end
+
+      # Is the interactor enabled?
+      #
+      # @return [Boolean] true if enabled
+      #
+      def enabled
+        @enabled.nil? ? true : @enabled
+      end
+
+      # Set the enabled status for the interactor
+      #
+      # @param [Boolean] status true if enabled
+      #
+      def enabled=(status)
+        @enabled = status
+      end
+
+    end
+
     # Initialize the interactor. This configures
     # Pry and creates some custom commands and aliases
     # for Guard.
@@ -27,9 +85,9 @@ module Guard
     def initialize
       return if ENV['GUARD_ENV'] == 'test'
 
-      Pry.config.should_load_rc = false
+      Pry.config.should_load_rc       = false
       Pry.config.should_load_local_rc = false
-      Pry.config.history.file = HISTORY_FILE
+      Pry.config.history.file         = self.class.options[:history_file] || HISTORY_FILE
 
       load_guard_rc
 
@@ -45,7 +103,7 @@ module Guard
     #
     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
+        load GUARD_RC if File.exist?(File.expand_path(self.class.options[:guard_rc] || GUARD_RC))
       end
     end
 
@@ -60,12 +118,12 @@ module Guard
     end
 
     # Creates command aliases for the commands
-    # `help`, `reload`, `change`, `show`, `notification`, `pause`, `exit` and `quit`,
+    # `help`, `reload`, `change`, `scope`, `notification`, `pause`, `exit` and `quit`,
     # which will be the first letter of the command.
     #
     def create_command_aliases
-      %w(help reload change show notification pause exit quit).each do |command|
-        Pry.commands.alias_command command[0].chr, command
+      SHORTCUTS.each do |command, shortcut|
+        Pry.commands.alias_command shortcut, command.to_s
       end
     end
 
@@ -114,15 +172,40 @@ module Guard
     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? }> "
+          history = pry.input_array.size
+          process = ::Guard.listener.paused? ? 'pause' : 'guard'
+          clip    = Pry.view_clip(target_self)
+          level = ":#{ nest_level }" unless nest_level.zero?
+          scope = if !::Guard.scope[:plugins].empty?
+                    "{#{ ::Guard.scope[:plugins].join }} "
+                  elsif !::Guard.scope[:groups].empty?
+                    "{#{ ::Guard.scope[:groups].join }} "
+                  else
+                    ''
+                  end
+
+          "[#{ history }] #{ scope }#{ process }(#{ clip })#{ level }> "
         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? }* "
+          history = pry.input_array.size
+          process = ::Guard.listener.paused? ? 'pause' : 'guard'
+          clip    = Pry.view_clip(target_self)
+          level = ":#{ nest_level }" unless nest_level.zero?
+          scope = if !::Guard.scope[:plugins].empty?
+                    "{#{ ::Guard.scope[:plugins].join }} "
+                  elsif !::Guard.scope[:groups].empty?
+                    "{#{ ::Guard.scope[:groups].join }} "
+                  else
+                    ''
+                  end
+
+          "[#{ history }] #{ scope }#{ process }(#{ clip })#{ level }* "
         end
       ]
     end
 
-    # Start the line reader in its own thread.
+    # Start the line reader in its own thread and
+    # stop Guard on Ctrl-D.
     #
     def start
       return if ENV['GUARD_ENV'] == 'test'
@@ -135,7 +218,6 @@ module Guard
         @thread = Thread.new do
           Pry.start
           ::Guard.stop
-          exit
         end
       end
     end
@@ -167,13 +249,13 @@ module Guard
     # when stopping.
     #
     def store_terminal_settings
-      @stty_save = `stty -g 2>/dev/null`.chomp
+      @stty_save = `stty -g 2>#{ DEV_NULL }`.chomp
     end
 
     # Restore terminal settings
     #
     def restore_terminal_settings
-      system("stty #{ @stty_save } 2>/dev/null") if @stty_save
+      system("stty #{ @stty_save } 2>#{ DEV_NULL }") if @stty_save
     end
 
     # Converts and validates a plain text scope
@@ -183,14 +265,14 @@ module Guard
     # @return [Hash, Array<String>] the plugin or group scope, the unknown entries
     #
     def self.convert_scope(entries)
-      scopes  = { }
+      scopes  = { :plugins => [], :groups => [] }
       unknown = []
 
       entries.each do |entry|
-        if guard = ::Guard.guards(entry)
-          scopes[:guard] ||= guard
+        if plugin = ::Guard.guards(entry)
+          scopes[:plugins] << plugin
         elsif group = ::Guard.groups(entry)
-          scopes[:group] ||= group
+          scopes[:groups] << group
         else
           unknown << entry
         end

data/lib/guard/notifier.rb

@@ -103,6 +103,8 @@ module Guard
       else
         notifications.each do |notification|
           ::Guard::UI.info "Guard uses #{ get_notifier_module(notification[:name]).to_s.split('::').last } to send notifications."
+          notifier = get_notifier_module(notification[:name])
+          notifier.turn_on(notification[:options]) if notifier.respond_to?(:turn_on)
         end
 
         ENV['GUARD_NOTIFY'] = 'true'
@@ -112,6 +114,11 @@ module Guard
     # Turn notifications off.
     #
     def turn_off
+      notifications.each do |notification|
+        notifier = get_notifier_module(notification[:name])
+        notifier.turn_off(notification[:options]) if notifier.respond_to?(:turn_off)
+      end
+
       ENV['GUARD_NOTIFY'] = 'false'
     end
 

data/lib/guard/notifiers/emacs.rb

@@ -12,10 +12,11 @@ module Guard
       extend self
 
       DEFAULTS = {
-        :client  => 'emacsclient',
-        :success => 'ForestGreen',
-        :failed  => 'Firebrick',
-        :default => 'Black',
+        :client    => 'emacsclient',
+        :success   => 'ForestGreen',
+        :failed    => 'Firebrick',
+        :default   => 'Black',
+        :fontcolor => 'White',
       }
 
       # Test if Emacs with running server is available.
@@ -24,9 +25,9 @@ module Guard
       # @return [Boolean] the availability status
       #
       def available?(silent = false)
-        result = `#{ DEFAULTS[:client] } --eval '1' 2> /dev/null || echo 'N/A'`
+        result = `#{ DEFAULTS[:client] } --eval '1' 2> #{DEV_NULL} || echo 'N/A'`
 
-        if result.chomp! == 'N/A'
+        if %w(N/A 'N/A').include?(result.chomp!)
           false
         else
           true
@@ -48,9 +49,10 @@ module Guard
       # @option options [String, Integer] priority specify an int or named key (default is 0)
       #
       def notify(type, title, message, image, options = { })
-        options = DEFAULTS.merge options
-        color   = emacs_color type, options
-        system(%(#{ options[:client] } --eval "(set-face-background 'modeline \\"#{ color }\\")"))
+        options   = DEFAULTS.merge options
+        color     = emacs_color type, options
+        fontcolor = emacs_color :fontcolor, options
+        system(%(#{ options[:client] } --eval "(set-face-attribute 'mode-line nil :background \\"#{ color }\\" :foreground \\"#{ fontcolor }\\")"))
       end
 
       # Get the Emacs color for the notification type.