guard 2.6.1 → 2.7.0

data/lib/guard/notifiers/terminal_title.rb

@@ -1,12 +1,10 @@
-require 'guard/notifiers/base'
+require "guard/notifiers/base"
 
 module Guard
   module Notifier
-
     # Shows system notifications in the terminal title bar.
     #
     class TerminalTitle < Base
-
       # Shows a system notification.
       #
       # @param [Hash] opts additional notification library options
@@ -18,18 +16,16 @@ module Guard
       def notify(message, opts = {})
         super
 
-        first_line = message.sub(/^\n/, '').sub(/\n.*/m, '')
+        first_line = message.sub(/^\n/, "").sub(/\n.*/m, "")
 
-        puts "\e]2;[#{ opts[:title] }] #{ first_line }\a"
+        STDOUT.puts "\e]2;[#{ opts[:title] }] #{ first_line }\a"
       end
 
       # Clears the terminal title
       #
       def self.turn_off
-        puts "\e]2;\a"
+        STDOUT.puts "\e]2;\a"
       end
-
     end
-
   end
 end

data/lib/guard/notifiers/tmux.rb

@@ -1,8 +1,7 @@
-require 'guard/notifiers/base'
+require "guard/notifiers/base"
 
 module Guard
   module Notifier
-
     # Changes the color of the Tmux status bar and optionally
     # shows messages in the status bar.
     #
@@ -16,29 +15,31 @@ module Guard
     #   notification :tmux, color_location: 'status-right-bg'
     #
     class Tmux < Base
-
       # Default options for the tmux notifications.
       DEFAULTS = {
-        client:                 'tmux',
-        tmux_environment:       'TMUX',
-        success:                'green',
-        failed:                 'red',
-        pending:                'yellow',
-        default:                'green',
+        client:                 "tmux",
+        tmux_environment:       "TMUX",
+        success:                "green",
+        failed:                 "red",
+        pending:                "yellow",
+        default:                "green",
         timeout:                5,
         display_message:        false,
-        default_message_format: '%s - %s',
-        default_message_color:  'white',
+        default_message_format: "%s - %s",
+        default_message_color:  "white",
         display_on_all_clients: false,
         display_title:          false,
-        default_title_format:   '%s - %s',
-        line_separator:         ' - ',
+        default_title_format:   "%s - %s",
+        line_separator:         " - ",
         change_color:           true,
-        color_location:         'status-left-bg'
+        color_location:         "status-left-bg"
       }
 
+      ERROR_NOT_INSIDE_SESSION = "The :tmux notifier runs only on when Guard"\
+              " is executed inside of a tmux session."
+
       def self.available?(opts = {})
-        super and _register!(opts)
+        super && _register!(opts)
       end
 
       # @private
@@ -57,11 +58,12 @@ module Guard
       # @return [Boolean] whether or not a TMUX environment is available
       #
       def self._register!(opts)
+        @options_stored = false
         if _tmux_environment_available?(opts)
           true
         else
           unless opts[:silent]
-            ::Guard::UI.error 'The :tmux notifier runs only on when Guard is executed inside of a tmux session.'
+            ::Guard::UI.error ERROR_NOT_INSIDE_SESSION
           end
           false
         end
@@ -86,8 +88,8 @@ module Guard
       # @option opts [String] image the path to the notification image
       # @option opts [Boolean] change_color whether to show a color
       #   notification
-      # @option opts [String,Array] color_location the location where to draw the
-      #   color notification
+      # @option opts [String,Array] color_location the location where to draw
+      #   the color notification
       # @option opts [Boolean] display_message whether to display a message
       #   or not
       # @option opts [Boolean] display_on_all_clients whether to display a
@@ -98,11 +100,13 @@ module Guard
         opts.delete(:image)
 
         if opts.fetch(:change_color, DEFAULTS[:change_color])
-          color_locations = Array(opts.fetch(:color_location, DEFAULTS[:color_location]))
+          options = opts.fetch(:color_location, DEFAULTS[:color_location])
+          color_locations = Array(options)
           color = tmux_color(opts[:type], opts)
 
           color_locations.each do |color_location|
-            _run_client "set","#{_quiet_option}#{ color_location } #{ color }"
+            _run_client "set", "#{self.class._quiet_option}"\
+              "#{color_location} #{color}"
           end
         end
 
@@ -113,9 +117,8 @@ module Guard
           display_title(type, title, message, opts)
         end
 
-        if opts.fetch(:display_message, DEFAULTS[:display_message])
-          display_message(type, title, message, opts)
-        end
+        return unless opts.fetch(:display_message, DEFAULTS[:display_message])
+        display_message(type, title, message, opts)
       end
 
       # Displays a message in the title bar of the terminal.
@@ -133,11 +136,15 @@ module Guard
       #   formatter when no format per type is defined.
       #
       def display_title(type, title, message, opts = {})
-        title_format   = opts.fetch("#{ type }_title_format".to_sym, opts.fetch(:default_title_format, DEFAULTS[:default_title_format]))
+        format = "#{type}_title_format".to_sym
+        defaults = DEFAULTS[:default_title_format]
+        options = opts.fetch(:default_title_format, defaults)
+        title_format   = opts.fetch(format, options)
         teaser_message = message.split("\n").first
         display_title  = title_format % [title, teaser_message]
 
-        _run_client "set-option", "#{_quiet_option}set-titles-string '#{ display_title }'"
+        _run_client "set-option", "#{self.class._quiet_option}"\
+          "set-titles-string '#{display_title}'"
       end
 
       # Displays a message in the status bar of tmux.
@@ -169,8 +176,16 @@ module Guard
       #   line-break.
       #
       def display_message(type, title, message, opts = {})
-        message_format = opts.fetch("#{ type }_message_format".to_sym, opts.fetch(:default_message_format, DEFAULTS[:default_message_format]))
-        message_color = opts.fetch("#{ type }_message_color".to_sym, opts.fetch(:default_message_color, DEFAULTS[:default_message_color]))
+        default_format = DEFAULTS[:default_message_format]
+        default_format = opts.fetch(:default_message_format, default_format)
+        format = "#{type}_message_format".to_sym
+        message_format = opts.fetch(format, default_format)
+
+        default_color = DEFAULTS[:default_message_color]
+        default_color = opts.fetch(:default_message_color, default_color)
+        color = "#{type}_message_color".to_sym
+        message_color = opts.fetch(color, default_color)
+
         display_time = opts.fetch(:timeout, DEFAULTS[:timeout])
         separator = opts.fetch(:line_separator, DEFAULTS[:line_separator])
 
@@ -178,10 +193,15 @@ module Guard
         formatted_message = message.split("\n").join(separator)
         display_message = message_format % [title, formatted_message]
 
-        _run_client "set", "#{_quiet_option}display-time #{ display_time * 1000 }"
-        _run_client "set", "#{_quiet_option}message-fg #{ message_color }"
-        _run_client "set", "#{_quiet_option}message-bg #{ color }"
-        _run_client "display-message", "'#{ display_message }'"
+        _run_client(
+          "set",
+          "#{self.class._quiet_option}display-time #{display_time * 1000}")
+
+        _run_client "set", "#{self.class._quiet_option}"\
+          "message-fg #{message_color}"
+        _run_client "set", "#{self.class._quiet_option}"\
+          "message-bg #{color}"
+        _run_client "display-message", "'#{display_message}'"
       end
 
       # Get the Tmux color for the notification type.
@@ -192,9 +212,8 @@ module Guard
       #
       def tmux_color(type, opts = {})
         type = type.to_sym
-        type = :default unless [:success, :failed, :pending].include?(type)
 
-        opts.fetch(type, DEFAULTS[type])
+        opts[type] || DEFAULTS[type] || opts[:default] || DEFAULTS[:default]
       end
 
       # Notification starting, save the current Tmux settings
@@ -205,11 +224,7 @@ module Guard
           _reset_options_store
 
           _clients.each do |client|
-            options_store[client] ||= {}
-            `#{ DEFAULTS[:client] } show -t #{ client }`.each_line do |line|
-              option, _, setting = line.chomp.partition(' ')
-              @options_store[client][option] = setting
-            end
+            @options_store[client].merge!(_options_for_client(client))
           end
 
           @options_stored = true
@@ -224,11 +239,14 @@ module Guard
         if @options_stored
           @options_store.each do |client, options|
             options.each do |key, value|
-              if value
-                `#{ DEFAULTS[:client] } set -t #{ client } -q #{ key } #{ value }`
-              else
-                `#{ DEFAULTS[:client] } set -t #{ client } -q -u #{ key }`
-              end
+              args = [
+                DEFAULTS[:client], "set", "-t",
+                client, _quiet_option.strip
+              ]
+              args << "-u" unless value
+              args << key
+              args << value if value
+              Sheller.run(args.join(" "))
             end
           end
           _reset_options_store
@@ -241,35 +259,52 @@ module Guard
 
       private
 
-      def system(args)
-        args += " >#{ DEV_NULL } 2>&1" if ENV['GUARD_ENV'] == 'test'
-        super
-      end
-
       def self._clients
-        ttys = `#{ DEFAULTS[:client] } list-clients -F '\#{client_tty}'`.split(/\n/)
-        ttys.delete('(null)') #if user is running 'tmux -C' remove this client from list
+        args = [DEFAULTS[:client], "list-clients", "-F", "'\#{client_tty}'"]
+        ttys = Sheller.stdout(args.join(" "))
+        ttys = ttys.split(/\n/)
+
+        # if user is running 'tmux -C' remove this client from list
+        ttys.delete("(null)")
+
         ttys
       end
 
+      def self._options_for_client(client)
+        options = {}
+
+        lines = Sheller.stdout("#{DEFAULTS[:client]} show -t #{client}")
+
+        lines.each_line do |line|
+          option, _, setting = line.chomp.partition(" ")
+          options[option] = setting
+        end
+
+        options
+      end
+
       def _clients
         self.class._clients
       end
 
       def _run_client(cmd, args)
-        if @options.fetch(:display_on_all_clients, DEFAULTS[:display_on_all_clients])
-          _clients.each do |client|
-            system("#{ DEFAULTS[:client] } #{ cmd } #{ _client_cmd_flag(cmd) } #{ client.strip } #{ args }")
-          end
-        else
-          system("#{ DEFAULTS[:client] } #{ cmd } #{ args }")
+        default = DEFAULTS[:display_on_all_clients]
+        all_clients = @options.fetch(:display_on_all_clients, default)
+        clients = all_clients ? _clients : [nil]
+        clients.each do |client|
+          cmd_args = if client
+                       "#{_client_cmd_flag(cmd)} #{client.strip} #{args}"
+                     else
+                       args
+                     end
+          Sheller.run("#{DEFAULTS[:client]} #{cmd} #{cmd_args}")
         end
       end
 
       def _client_cmd_flag(cmd)
         case cmd
-          when 'set', 'set-option' then '-t'
-          when 'display-message' then '-c'
+        when "set", "set-option" then "-t"
+        when "display-message" then "-c"
         end
       end
 
@@ -281,26 +316,24 @@ module Guard
 
         _clients.each do |client|
           @options_store[client] = {
-            'status-left-bg'  => nil,
-            'status-right-bg' => nil,
-            'status-left-fg'  => nil,
-            'status-right-fg' => nil,
-            'message-bg'      => nil,
-            'message-fg'      => nil,
-            'display-time'    => nil
+            "status-left-bg"  => nil,
+            "status-right-bg" => nil,
+            "status-left-fg"  => nil,
+            "status-right-fg" => nil,
+            "message-bg"      => nil,
+            "message-fg"      => nil,
+            "display-time"    => nil
           }
         end
       end
 
-      def _tmux_version
-        @tmux_version ||= `tmux -V`.chomp.gsub(/[^0-9.]/, '').to_f
+      def self._tmux_version
+        @@tmux_version ||= Float(Sheller.stdout("tmux -V")[/\d+\.\d+/])
       end
 
-      def _quiet_option
-        '-q ' if _tmux_version >= 1.7
+      def self._quiet_option
+        "-q " if _tmux_version >= 1.7
       end
-
     end
-
   end
 end

data/lib/guard/options.rb

@@ -1,11 +1,9 @@
-require 'thor/core_ext/hash_with_indifferent_access'
+require "thor/core_ext/hash_with_indifferent_access"
 
 module Guard
-
   # A class that holds options. Can be instantiated with default options.
   #
   class Options < Thor::CoreExt::HashWithIndifferentAccess
-
     # Initializes an Guard::Options object. `default_opts` is merged into
     # `opts`.
     #
@@ -15,7 +13,5 @@ module Guard
     def initialize(opts = {}, default_opts = {})
       super(default_opts.merge(opts || {}))
     end
-
   end
-
 end

data/lib/guard/plugin.rb

@@ -1,7 +1,6 @@
-require 'guard/plugin/base'
+require "guard/plugin/base"
 
 module Guard
-
   # Base class from which every Guard plugin implementation must inherit.
   #
   # Guard will trigger the {#start}, {#stop}, {#reload}, {#run_all} and
@@ -62,5 +61,4 @@ module Guard
       _register_callbacks
     end
   end
-
 end

data/lib/guard/plugin/base.rb

@@ -1,13 +1,13 @@
 module Guard
-
   class Plugin
-
     # Colection of shared methods between `Guard::Guard` (deprecated)
     # and `Guard::Plugin`.
     #
     module Base
-      require 'guard/ui'
-      require 'guard/plugin/hooker'
+      TEMPLATE_FORMAT = "%s/lib/guard/%s/templates/Guardfile"
+
+      require "guard/ui"
+      require "guard/plugin/hooker"
 
       include ::Guard::Plugin::Hooker
 
@@ -28,7 +28,7 @@ module Guard
         # @return [String]
         #
         def non_namespaced_classname
-          self.to_s.sub('Guard::', '')
+          to_s.sub("Guard::", "")
         end
 
         # Returns the non-namespaced name of the plugin
@@ -50,7 +50,7 @@ module Guard
         # @param [String] plugin_location the plugin location
         #
         def template(plugin_location)
-          File.read("#{ plugin_location }/lib/guard/#{ non_namespaced_name }/templates/Guardfile")
+          File.read TEMPLATE_FORMAT % [plugin_location, non_namespaced_name]
         end
       end
 
@@ -147,13 +147,17 @@ module Guard
       # String representation of the plugin.
       #
       # @example String representation of an instance of the Guard::RSpec plugin
+      #
       #   Guard::RSpec.new.title
-      #   #=> "#<Guard::RSpec @name=rspec @group=#<Guard::Group @name=default @options={}> @watchers=[] @callbacks=[] @options={all_after_pass: true}>"
+      #   #=> "#<Guard::RSpec @name=rspec @group=#<Guard::Group @name=default
+      #   @options={}> @watchers=[] @callbacks=[] @options={all_after_pass:
+      #   true}>"
       #
       # @return [String] the string representation
       #
       def to_s
-        "#<#{self.class} @name=#{name} @group=#{group} @watchers=#{watchers} @callbacks=#{callbacks} @options=#{options}>"
+        "#<#{self.class} @name=#{name} @group=#{group} @watchers=#{watchers}"\
+        " @callbacks=#{callbacks} @options=#{options}>"
       end
 
       private
@@ -172,7 +176,6 @@ module Guard
         @callbacks = options.delete(:callbacks) { [] }
         @options   = options
       end
-
     end
   end
 end

data/lib/guard/plugin/hooker.rb

@@ -1,7 +1,5 @@
 module Guard
-
   class Plugin
-
     # Guard has a hook mechanism that allows you to insert callbacks for
     # individual Guard plugins.
     # By default, each of the Guard plugin instance methods has a "_begin" and
@@ -14,8 +12,7 @@ module Guard
     # wiki](https://github.com/guard/guard/wiki/Hooks-and-callbacks).
     #
     module Hooker
-
-      require 'guard/ui'
+      require "guard/ui"
 
       # Get all callbacks registered for all Guard plugins present in the
       # Guardfile.
@@ -106,7 +103,6 @@ module Guard
           Hooker.add_callback(callback[:listener], self, callback[:events])
         end
       end
-
     end
   end
 end