guard 2.6.1 → 2.7.0

data/lib/guard/notifiers/gntp.rb

@@ -1,14 +1,15 @@
-require 'guard/notifiers/base'
+require "guard/notifiers/base"
 
 module Guard
   module Notifier
-
     # System notifications using the
     # [ruby_gntp](https://github.com/snaka/ruby_gntp) gem.
     #
     # This gem is available for OS X, Linux and Windows and sends system
     # notifications to the following system notification frameworks through the
-    # [Growl Network Transport Protocol](http://www.growlforwindows.com/gfw/help/gntp.aspx):
+    #
+    # [Growl Network Transport
+    # Protocol](http://www.growlforwindows.com/gfw/help/gntp.aspx):
     #
     # * [Growl](http://growl.info)
     # * [Growl for Windows](http://www.growlforwindows.com)
@@ -23,11 +24,11 @@ module Guard
     # @example Add the `:gntp` notifier to your `Guardfile`
     #   notification :gntp
     #
-    # @example Add the `:gntp` notifier with configuration options to your `Guardfile`
-    #   notification :gntp, sticky: true, host: '192.168.1.5', password: 'secret'
+    # @example Add the `:gntp` notifier with configuration options to your
+    #   `Guardfile` notification :gntp, sticky: true, host: '192.168.1.5',
+    #   password: 'secret'
     #
     class GNTP < Base
-
       # Default options for the ruby gtnp notifications.
       DEFAULTS = {
         sticky: false
@@ -35,21 +36,21 @@ module Guard
 
       # Default options for the ruby gtnp client.
       CLIENT_DEFAULTS = {
-        host:     '127.0.0.1',
-        password: '',
+        host:     "127.0.0.1",
+        password: "",
         port:     23053
       }
 
       def self.supported_hosts
-        %w[darwin linux freebsd openbsd sunos solaris mswin mingw cygwin]
+        %w(darwin linux freebsd openbsd sunos solaris mswin mingw cygwin)
       end
 
       def self.gem_name
-        'ruby_gntp'
+        "ruby_gntp"
       end
 
       def self.available?(opts = {})
-        super and require_gem_safely(opts)
+        super && require_gem_safely(opts)
       end
 
       # Shows a system notification.
@@ -84,28 +85,27 @@ module Guard
 
       def _register!(gntp_client)
         gntp_client.register(
-          app_icon: images_path.join('guard.png').to_s,
+          app_icon: images_path.join("guard.png").to_s,
           notifications: [
-            { name: 'notify', enabled: true },
-            { name: 'failed', enabled: true },
-            { name: 'pending', enabled: true },
-            { name: 'success', enabled: true }
+            { name: "notify", enabled: true },
+            { name: "failed", enabled: true },
+            { name: "pending", enabled: true },
+            { name: "success", enabled: true }
           ]
         )
       end
 
       def _client(opts = {})
         @_client ||= begin
-          gntp = ::GNTP.new('Guard',
-                            opts.delete(:host) { CLIENT_DEFAULTS[:host] },
-                            opts.delete(:password) { CLIENT_DEFAULTS[:password] },
-                            opts.delete(:port) { CLIENT_DEFAULTS[:port] })
+          gntp = ::GNTP.new(
+            "Guard",
+            opts.delete(:host) { CLIENT_DEFAULTS[:host] },
+            opts.delete(:password) { CLIENT_DEFAULTS[:password] },
+            opts.delete(:port) { CLIENT_DEFAULTS[:port] })
           _register!(gntp)
           gntp
         end
       end
-
     end
-
   end
 end

data/lib/guard/notifiers/growl.rb

@@ -1,20 +1,20 @@
-require 'guard/notifiers/base'
+require "guard/notifiers/base"
 
 module Guard
   module Notifier
-
-    # System notifications using the [growl](https://github.com/visionmedia/growl) gem.
+    # System notifications using the
+    # [growl](https://github.com/visionmedia/growl) gem.
     #
     # This gem is available for OS X and sends system notifications to
-    # [Growl](http://growl.info) through the [GrowlNotify](http://growl.info/downloads)
-    # executable.
+    # [Growl](http://growl.info) through the
+    # [GrowlNotify](http://growl.info/downloads) executable.
     #
     # The `growlnotify` executable must be installed manually or by using
     # [Homebrew](http://mxcl.github.com/homebrew/).
     #
     # Sending notifications with this notifier will not show the different
-    # Guard notifications in the Growl preferences. Use the :gntp or :growl_notify
-    # notifiers if you want to customize each notification type in Growl.
+    # Guard notifications in the Growl preferences. Use the :gntp notifier
+    # if you want to customize each notification type in Growl.
     #
     # @example Install `growlnotify` with Homebrew
     #   brew install growlnotify
@@ -27,10 +27,13 @@ module Guard
     # @example Add the `:growl` notifier to your `Guardfile`
     #   notification :growl
     #
-    # @example Add the `:growl_notify` notifier with configuration options to your `Guardfile`
-    #   notification :growl, sticky: true, host: '192.168.1.5', password: 'secret'
+    # @example Add the `:growl_notify` notifier with configuration options to
+    # your `Guardfile` notification :growl, sticky: true, host: '192.168.1.5',
+    # password: 'secret'
     #
     class Growl < Base
+      ERROR_INSTALL_GROWLNOTIFY = "Please install the 'growlnotify' executable'\
+    ' (available by installing the 'growl' gem)."
 
       # Default options for the growl notifications.
       DEFAULTS = {
@@ -39,11 +42,11 @@ module Guard
       }
 
       def self.supported_hosts
-        %w[darwin]
+        %w(darwin)
       end
 
       def self.available?(opts = {})
-        super and require_gem_safely(opts) and _register!(opts)
+        super && require_gem_safely(opts) && _register!(opts)
       end
 
       # @private
@@ -58,7 +61,7 @@ module Guard
           true
         else
           unless opts[:silent]
-            ::Guard::UI.error "Please install the 'growlnotify' executable (available by installing the 'growl' gem)."
+            UI.error UI::ERROR_INSTALL_GROWLNOTIFY
           end
           false
         end
@@ -92,12 +95,10 @@ module Guard
         opts.delete(:type)
         self.class.require_gem_safely
 
-        opts = DEFAULTS.merge(opts).merge(name: 'Guard')
+        opts = DEFAULTS.merge(opts).merge(name: "Guard")
 
         ::Growl.notify(message, opts)
       end
-
     end
-
   end
 end

data/lib/guard/notifiers/libnotify.rb

@@ -1,8 +1,7 @@
-require 'guard/notifiers/base'
+require "guard/notifiers/base"
 
 module Guard
   module Notifier
-
     # System notifications using the
     # [libnotify](https://github.com/splattael/libnotify) gem.
     #
@@ -18,11 +17,11 @@ module Guard
     # @example Add the `:libnotify` notifier to your `Guardfile`
     #   notification :libnotify
     #
-    # @example Add the `:libnotify` notifier with configuration options to your `Guardfile`
-    #   notification :libnotify, timeout: 5, transient: true, append: false, urgency: :critical
+    # @example Add the `:libnotify` notifier with configuration options to your
+    #   `Guardfile` notification :libnotify, timeout: 5, transient: true,
+    #   append: false, urgency: :critical
     #
     class Libnotify < Base
-
       # Default options for the libnotify notifications.
       DEFAULTS = {
         transient: false,
@@ -31,11 +30,11 @@ module Guard
       }
 
       def self.supported_hosts
-        %w[linux freebsd openbsd sunos solaris]
+        %w(linux freebsd openbsd sunos solaris)
       end
 
       def self.available?(opts = {})
-        super and require_gem_safely(opts)
+        super && require_gem_safely(opts)
       end
 
       # Shows a system notification.
@@ -76,14 +75,12 @@ module Guard
       #
       def _libnotify_urgency(type)
         case type
-        when 'failed'
+        when "failed"
           :normal
         else
           :low
         end
       end
-
     end
-
   end
 end

data/lib/guard/notifiers/notifysend.rb

@@ -1,8 +1,8 @@
-require 'guard/notifiers/base'
+require "guard/notifiers/base"
+require "guard/sheller"
 
 module Guard
   module Notifier
-
     # System notifications using notify-send, a binary that ships with
     # the libnotify-bin package on many Debian-based distributions.
     #
@@ -10,22 +10,21 @@ module Guard
     #   notification :notifysend
     #
     class NotifySend < Base
-
       # Default options for the notify-send notifications.
       DEFAULTS = {
         t: 3000, # Default timeout is 3000ms
-        h: 'int:transient:1' # Automatically close the notification
+        h: "int:transient:1" # Automatically close the notification
       }
 
       # Full list of options supported by notify-send.
       SUPPORTED = [:u, :t, :i, :c, :h]
 
       def self.supported_hosts
-        %w[linux freebsd openbsd sunos solaris]
+        %w(linux freebsd openbsd sunos solaris)
       end
 
       def self.available?(opts = {})
-        super and _register!(opts)
+        super && _register!(opts)
       end
 
       # @private
@@ -33,7 +32,7 @@ module Guard
       # @return [Boolean] whether or not the notify-send binary is available
       #
       def self._notifysend_binary_available?
-        !`which notify-send`.empty?
+        !::Guard::Sheller.stdout("which notify-send").empty?
       end
 
       # @private
@@ -48,7 +47,9 @@ module Guard
           true
         else
           unless opts[:silent]
-            ::Guard::UI.error 'The :notifysend notifier runs only on Linux, FreeBSD, OpenBSD and Solaris with the libnotify-bin package installed.'
+            ::Guard::UI.error "The :notifysend notifier runs only on Linux"\
+              ", FreeBSD, OpenBSD and Solaris with the libnotify-bin "\
+              "package installed."
           end
           false
         end
@@ -75,7 +76,7 @@ module Guard
           u: _notifysend_urgency(opts.delete(:type))
         ).merge(opts)
 
-        system('notify-send', *_to_arguments(command, SUPPORTED, opts))
+        Sheller.run("notify-send", *_to_arguments(command, SUPPORTED, opts))
       end
 
       private
@@ -87,7 +88,7 @@ module Guard
       # @return [String] the notify-send urgency
       #
       def _notifysend_urgency(type)
-        { failed: 'normal', pending: 'low' }.fetch(type, 'low')
+        { failed: "normal", pending: "low" }.fetch(type, "low")
       end
 
       # Builds a shell command out of a command string and option hash.
@@ -95,15 +96,15 @@ module Guard
       # @param [String] command the command execute
       # @param [Array] supported list of supported option flags
       # @param [Hash] opts additional command options
-      # @return [Array<String>] the command and its options converted to a shell command.
+      #
+      # @return [Array<String>] the command and its options converted to a
+      # shell command.
       #
       def _to_arguments(command, supported, opts = {})
-        opts.reduce(command) do |cmd, (flag, value)|
+        opts.inject(command) do |cmd, (flag, value)|
           supported.include?(flag) ? (cmd << "-#{ flag }" << value.to_s) : cmd
         end
       end
-
     end
-
   end
 end

data/lib/guard/notifiers/rb_notifu.rb

@@ -1,8 +1,7 @@
-require 'guard/notifiers/base'
+require "guard/notifiers/base"
 
 module Guard
   module Notifier
-
     # System notifications using the
     # [rb-notifu](https://github.com/stereobooster/rb-notifu) gem.
     #
@@ -17,11 +16,10 @@ module Guard
     # @example Add the `:notifu` notifier to your `Guardfile`
     #   notification :notifu
     #
-    # @example Add the `:notifu` notifier with configuration options to your `Guardfile`
-    #   notification :notifu, time: 5, nosound: true, xp: true
+    # @example Add the `:notifu` notifier with configuration options to your
+    #   `Guardfile` notification :notifu, time: 5, nosound: true, xp: true
     #
     class Notifu < Base
-
       # Default options for the rb-notifu notifications.
       DEFAULTS = {
         time:    3,
@@ -33,15 +31,15 @@ module Guard
       }
 
       def self.supported_hosts
-        %w[mswin mingw]
+        %w(mswin mingw)
       end
 
       def self.gem_name
-        'rb-notifu'
+        "rb-notifu"
       end
 
       def self.available?(opts = {})
-        super and require_gem_safely(opts)
+        super && require_gem_safely(opts)
       end
 
       # Shows a system notification.
@@ -74,7 +72,8 @@ module Guard
           message: message
         ).merge(opts)
 
-        # The empty block is needed until https://github.com/stereobooster/rb-notifu/pull/1 is merged
+        # The empty block is needed until
+        # https://github.com/stereobooster/rb-notifu/pull/1 is merged
         ::Notifu.show(opts) {}
       end
 
@@ -96,7 +95,6 @@ module Guard
           :info
         end
       end
-
     end
   end
 end

data/lib/guard/notifiers/terminal_notifier.rb

@@ -1,10 +1,11 @@
-require 'guard/notifiers/base'
+require "guard/notifiers/base"
 
 module Guard
   module Notifier
-
     # System notifications using the
-    # [terminal-notifier-guard](https://github.com/Springest/terminal-notifier-guard)
+    #
+    # [terminal-notifier](https://github.com/Springest/terminal-notifier-guard)
+    #
     # gem.
     #
     # This gem is available for OS X 10.8 Mountain Lion and sends notifications
@@ -25,17 +26,19 @@ module Guard
     #   notification :terminal_notifier, activate: "com.googlecode.iterm2"
     #
     class TerminalNotifier < Base
+      ERROR_TERMINAL_NOTIFIER_ONLY_OSX10 = "The :terminal_notifier only runs"\
+        " on Mac OS X 10.8 and later."
 
       def self.supported_hosts
-        %w[darwin]
+        %w(darwin)
       end
 
       def self.gem_name
-        'terminal-notifier-guard'
+        "terminal-notifier-guard"
       end
 
       def self.available?(opts = {})
-        super and require_gem_safely(opts) and _register!(opts)
+        super && require_gem_safely(opts) && _register!(opts)
       end
 
       # Shows a system notification.
@@ -57,7 +60,9 @@ module Guard
         self.class.require_gem_safely
 
         opts.delete(:image)
-        opts[:title] = title || [opts.delete(:app_name) { 'Guard' }, opts[:type].downcase.capitalize].join(' ')
+        opts[:title] = title || [
+          opts.delete(:app_name) { "Guard" }, opts[:type].downcase.capitalize
+        ].join(" ")
 
         ::TerminalNotifier::Guard.execute(false, opts.merge(message: message))
       end
@@ -67,20 +72,19 @@ module Guard
       # Detects if the terminal-notifier-guard gem is available and if not,
       # displays an error message unless `opts[:silent]` is true.
       #
-      # @return [Boolean] whether or not the terminal-notifier-guard gem is available
+      # @return [Boolean] whether or not the terminal-notifier-guard gem is
+      # available
       #
       def self._register!(opts)
         if ::TerminalNotifier::Guard.available?
           true
         else
           unless opts[:silent]
-            ::Guard::UI.error 'The :terminal_notifier only runs on Mac OS X 10.8 and later.'
+            UI.error UI::ERROR_TERMINAL_NOTIFIER_ONLY_OSX10
           end
           false
         end
       end
-
     end
-
   end
 end