guard 1.8.3 → 2.0.0.pre

data/lib/guard/notifiers/growl_notify.rb

@@ -1,5 +1,4 @@
-require 'rbconfig'
-require 'guard/ui'
+require 'guard/notifiers/base'
 
 module Guard
   module Notifier
@@ -18,76 +17,72 @@ module Guard
     #   notification :growl_notify
     #
     # @example Add the `:growl_notify` notifier with configuration options to your `Guardfile`
-    #   notification :growl_notify, :sticky => true
+    #   notification :growl_notify, sticky: true
     #
-    module GrowlNotify
-      extend self
+    class GrowlNotify < Base
 
-      # Default options for growl_notify gem
+      # Default options for the growl_notify notifications.
       DEFAULTS = {
-        :sticky   => false,
-        :priority => 0
+        sticky:   false,
+        priority: 0
       }
 
-      # Test if the notification library is available.
+      def self.supported_hosts
+        %w[darwin]
+      end
+
+      def self.available?(opts = {})
+        super
+        _register!(opts) if require_gem_safely(opts)
+      end
+
+      # Shows a system notification.
       #
-      # @param [Boolean] silent true if no error messages should be shown
-      # @param [Hash] options notifier options
-      # @return [Boolean] the availability status
+      # @param [String] message the notification message body
+      # @param [Hash] opts additional notification library options
+      # @option opts [String] type the notification type. Either 'success',
+      #   'pending', 'failed' or 'notify'
+      # @option opts [String] title the notification title
+      # @option opts [String] image the path to the notification image
+      # @option opts [Boolean] sticky if the message should stick to the screen
+      # @option opts [Integer] priority the importance of message from -2 (very
+      #   low) to 2 (emergency)
       #
-      def available?(silent = false, options = {})
-        if RbConfig::CONFIG['host_os'] =~ /darwin/
-          require 'growl_notify'
+      def notify(message, opts = {})
+        self.class.require_gem_safely
+        normalize_standard_options!(opts)
 
-          begin
-            if ::GrowlNotify.application_name != 'Guard'
-              ::GrowlNotify.config do |c|
-                c.notifications         = %w(success pending failed notify)
-                c.default_notifications = 'notify'
-                c.application_name      = 'Guard'
-              end
-            end
+        opts = DEFAULTS.merge(
+          application_name: 'Guard',
+          with_name:        opts.delete(:type).to_s,
+          description:      message,
+          icon:             opts.delete(:image)
+        ).merge(opts)
 
-            true
+        ::GrowlNotify.send_notification(opts)
+      end
 
-          rescue ::GrowlNotify::GrowlNotFound
-            ::Guard::UI.error 'Please install Growl from http://growl.info' unless silent
-            false
+      # @private
+      #
+      def self._register!(options)
+        if ::GrowlNotify.application_name != 'Guard'
+          ::GrowlNotify.config do |c|
+            c.notifications         = %w(success pending failed notify)
+            c.default_notifications = 'notify'
+            c.application_name      = 'Guard'
           end
-
-        else
-          ::Guard::UI.error 'The :growl_notify notifier runs only on Mac OS X.' unless silent
-          false
         end
 
-      rescue LoadError, NameError
-        ::Guard::UI.error "Please add \"gem 'growl_notify'\" to your Gemfile and run Guard with \"bundle exec\"." unless silent
-        false
-      end
-
-      # Show a system notification.
-      #
-      # @param [String] type the notification type. Either 'success', 'pending', 'failed' or 'notify'
-      # @param [String] title the notification title
-      # @param [String] message the notification message body
-      # @param [String] image the path to the notification image
-      # @param [Hash] options additional notification library options
-      # @option options [Boolean] sticky if the message should stick to the screen
-      # @option options [Integer] priority the importance of message from -2 (very low) to 2 (emergency)
-      #
-      def notify(type, title, message, image, options = { })
-        require 'growl_notify'
+        true
 
-        ::GrowlNotify.send_notification(DEFAULTS.merge(options).merge({
-            :application_name => 'Guard',
-            :with_name        => type,
-            :title            => title,
-            :description      => message,
-            :icon             => image
-        }))
+      rescue ::GrowlNotify::GrowlNotFound
+        unless options[:silent]
+          ::Guard::UI.error 'Please install Growl from http://growl.info'
+        end
+        false
       end
 
     end
+
   end
 end
-

data/lib/guard/notifiers/libnotify.rb

@@ -1,12 +1,13 @@
-require 'rbconfig'
-require 'guard/ui'
+require 'guard/notifiers/base'
 
 module Guard
   module Notifier
 
-    # System notifications using the [libnotify](https://github.com/splattael/libnotify) gem.
+    # System notifications using the
+    # [libnotify](https://github.com/splattael/libnotify) gem.
     #
-    # This gem is available for Linux, FreeBSD, OpenBSD and Solaris and sends system notifications to
+    # This gem is available for Linux, FreeBSD, OpenBSD and Solaris and sends
+    # system notifications to
     # Gnome [libnotify](http://developer.gnome.org/libnotify):
     #
     # @example Add the `libnotify` gem to your `Gemfile`
@@ -18,61 +19,52 @@ module Guard
     #   notification :libnotify
     #
     # @example Add the `:libnotify` notifier with configuration options to your `Guardfile`
-    #   notification :libnotify, :timeout => 5, :transient => true, :append => false, :urgency => :critical
+    #   notification :libnotify, timeout: 5, transient: true, append: false, urgency: :critical
     #
-    module Libnotify
-      extend self
+    class Libnotify < Base
 
-      # Default options for libnotify gem
+      # Default options for the libnotify notifications.
       DEFAULTS = {
-        :transient => false,
-        :append    => true,
-        :timeout   => 3
+        transient: false,
+        append:    true,
+        timeout:   3
       }
 
-      # Test if the notification library is available.
-      #
-      # @param [Boolean] silent true if no error messages should be shown
-      # @param [Hash] options notifier options
-      # @return [Boolean] the availability status
-      #
-      def available?(silent = false, options = {})
-        if RbConfig::CONFIG['host_os'] =~ /linux|freebsd|openbsd|sunos|solaris/
-          require 'libnotify'
-
-          true
-
-        else
-          ::Guard::UI.error 'The :libnotify notifier runs only on Linux, FreeBSD, OpenBSD and Solaris.' unless silent
-          false
-        end
+      def self.supported_hosts
+        %w[linux freebsd openbsd sunos solaris]
+      end
 
-      rescue LoadError
-        ::Guard::UI.error "Please add \"gem 'libnotify'\" to your Gemfile and run Guard with \"bundle exec\"." unless silent
-        false
+      def self.available?(opts = {})
+        super
+        require_gem_safely(opts)
       end
 
-      # Show a system notification.
+      # Shows a system notification.
       #
-      # @param [String] type the notification type. Either 'success', 'pending', 'failed' or 'notify'
-      # @param [String] title the notification title
       # @param [String] message the notification message body
-      # @param [String] image the path to the notification image
-      # @param [Hash] options additional notification library options
-      # @option options [Boolean] transient keep the notifications around after display
-      # @option options [Boolean] append append onto existing notification
-      # @option options [Number, Boolean] timeout the number of seconds to display (1.5 (s), 1000 (ms), false)
+      # @param [Hash] opts additional notification library options
+      # @option opts [String] type the notification type. Either 'success',
+      #   'pending', 'failed' or 'notify'
+      # @option opts [String] title the notification title
+      # @option opts [String] image the path to the notification image
+      # @option opts [Boolean] transient keep the notifications around after
+      #   display
+      # @option opts [Boolean] append append onto existing notification
+      # @option opts [Number, Boolean] timeout the number of seconds to display
+      #   (1.5 (s), 1000 (ms), false)
       #
-      def notify(type, title, message, image, options = { })
-        require 'libnotify'
+      def notify(message, opts = {})
+        self.class.require_gem_safely
+        normalize_standard_options!(opts)
 
-        options = DEFAULTS.merge(options).merge({
-          :summary   => title,
-          :body      => message,
-          :icon_path => image
-        })
-        options[:urgency] ||= libnotify_urgency(type)
-        ::Libnotify.show(options)
+        opts = DEFAULTS.merge(
+          summary:   opts.delete(:title),
+          icon_path: opts.delete(:image),
+          body:      message,
+          urgency:   _libnotify_urgency(opts.delete(:type))
+        ).merge(opts)
+
+        ::Libnotify.show(opts)
       end
 
       private
@@ -83,7 +75,7 @@ module Guard
       # @param [String] type the Guard notification type
       # @return [Symbol] the libnotify urgency
       #
-      def libnotify_urgency(type)
+      def _libnotify_urgency(type)
         case type
         when 'failed'
           :normal
@@ -93,5 +85,6 @@ module Guard
       end
 
     end
+
   end
 end

data/lib/guard/notifiers/notifysend.rb

@@ -1,5 +1,4 @@
-require 'rbconfig'
-require 'guard/ui'
+require 'guard/notifiers/base'
 
 module Guard
   module Notifier
@@ -10,76 +9,97 @@ module Guard
     # @example Add the `:notifysend` notifier to your `Guardfile`
     #   notification :notifysend
     #
-    module NotifySend
-      extend self
+    class NotifySend < Base
 
-      # Default options for the notify-send program
+      # Default options for the notify-send notifications.
       DEFAULTS = {
-        :t => 3000, # Default timeout is 3000ms
-        :h => 'int:transient:1' # Automatically close the notification
+        t: 3000, # Default timeout is 3000ms
+        h: 'int:transient:1' # Automatically close the notification
       }
 
-      # Full list of options supported by notify-send
+      # Full list of options supported by notify-send.
       SUPPORTED = [:u, :t, :i, :c, :h]
 
-      # Test if the notification program is available.
-      #
-      # @param [Boolean] silent true if no error messages should be shown
-      # @param [Hash] options notifier options
-      # @return [Boolean] the availability status
-      #
-      def available?(silent = false, options = {})
-        if (RbConfig::CONFIG['host_os'] =~ /linux|freebsd|openbsd|sunos|solaris/) and (not `which notify-send`.empty?)
-          true
-        else
-          ::Guard::UI.error 'The :notifysend notifier runs only on Linux, FreeBSD, OpenBSD and Solaris with the libnotify-bin package installed.' unless silent
-          false
-        end
+      def self.supported_hosts
+        %w[linux freebsd openbsd sunos solaris]
+      end
+
+      def self.available?(opts = {})
+        super
+        _register!(opts)
       end
 
-      # Show a system notification.
+      # Shows a system notification.
       #
-      # @param [String] type the notification type. Either 'success', 'pending', 'failed' or 'notify'
-      # @param [String] title the notification title
       # @param [String] message the notification message body
-      # @param [String] image the path to the notification image
-      # @param [Hash] options additional notification library options
-      # @option options [String] c the notification category
-      # @option options [Number] t the number of milliseconds to display (1000, 3000)
+      # @param [Hash] opts additional notification library options
+      # @option opts [String] type the notification type. Either 'success',
+      #   'pending', 'failed' or 'notify'
+      # @option opts [String] title the notification title
+      # @option opts [String] image the path to the notification image
+      # @option opts [String] c the notification category
+      # @option opts [Number] t the number of milliseconds to display (1000,
+      #   3000)
       #
-      def notify(type, title, message, image, options = { })
+      def notify(message, opts = {})
+        normalize_standard_options!(opts)
+
         command = [title, message]
-        options = DEFAULTS.merge(options).merge({
-          :i => image
-        })
-        options[:u] ||= notifysend_urgency(type)
-        system('notify-send', *to_arguments(command, SUPPORTED, options))
+        opts = DEFAULTS.merge(
+          i: opts.delete(:image),
+          u: _notifysend_urgency(opts.delete(:type))
+        ).merge(opts)
+
+        system('notify-send', *_to_arguments(command, SUPPORTED, opts))
       end
 
       private
 
-      # Convert Guards notification type to the best matching
+      # Converts Guards notification type to the best matching
       # notify-send urgency.
       #
       # @param [String] type the Guard notification type
       # @return [String] the notify-send urgency
       #
-      def notifysend_urgency(type)
+      def _notifysend_urgency(type)
         { 'failed' => 'normal', 'pending' => 'low' }.fetch(type, 'low')
       end
 
-      # Build a shell command out of a command string and option hash.
+      # Builds a shell command out of a command string and option hash.
       #
       # @param [String] command the command execute
       # @param [Array] supported list of supported option flags
       # @param [Hash] options additional command options
       # @return [Array<String>] the command and its options converted to a shell command.
       #
-      def to_arguments(command, supported, options = {})
+      def _to_arguments(command, supported, options = {})
         options.reduce(command) do |cmd, (flag, value)|
           supported.include?(flag) ? (cmd << "-#{ flag }" << value.to_s) : cmd
         end
       end
+
+      # @private
+      #
+      # @return [Boolean] whether or not the notify-send binary is available
+      #
+      def self._notifysend_binary_available?
+        !`which notify-send`.empty?
+      end
+
+      # @private
+      #
+      def self._register!(options)
+        unless _notifysend_binary_available?
+          unless options[:silent]
+            ::Guard::UI.error 'The :notifysend notifier runs only on Linux, FreeBSD, OpenBSD and Solaris with the libnotify-bin package installed.'
+          end
+          false
+        end
+
+        true
+      end
+
     end
+
   end
 end

data/lib/guard/notifiers/rb_notifu.rb

@@ -1,10 +1,10 @@
-require 'rbconfig'
-require 'guard/ui'
+require 'guard/notifiers/base'
 
 module Guard
   module Notifier
 
-    # System notifications using the [rb-notifu](https://github.com/stereobooster/rb-notifu) gem.
+    # System notifications using the
+    # [rb-notifu](https://github.com/stereobooster/rb-notifu) gem.
     #
     # This gem is available for Windows and sends system notifications to
     # [Notifu](http://www.paralint.com/projects/notifu/index.html):
@@ -18,80 +18,80 @@ module Guard
     #   notification :notifu
     #
     # @example Add the `:notifu` notifier with configuration options to your `Guardfile`
-    #   notification :notifu, :time => 5, :nosound => true, :xp => true
+    #   notification :notifu, time: 5, nosound: true, xp: true
     #
-    module Notifu
-      extend self
+    class Notifu < Base
 
-      # Default options for rb-notifu gem
+      # Default options for the rb-notifu notifications.
       DEFAULTS = {
-        :time    => 3,
-        :icon    => false,
-        :baloon  => false,
-        :nosound => false,
-        :noquiet => false,
-        :xp      => false
+        time:    3,
+        icon:    false,
+        baloon:  false,
+        nosound: false,
+        noquiet: false,
+        xp:      false
       }
 
-      # Test if the notification library is available.
-      #
-      # @param [Boolean] silent true if no error messages should be shown
-      # @param [Hash] options notifier options
-      # @return [Boolean] the availability status
-      #
-      def available?(silent = false, options = {})
-        if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
-          require 'rb-notifu'
-
-          true
+      def self.supported_hosts
+        %w[mswin mingw]
+      end
 
-        else
-          ::Guard::UI.error 'The :notifu notifier runs only on Windows.' unless silent
-          false
-        end
+      def self.gem_name
+        'rb-notifu'
+      end
 
-      rescue LoadError
-        ::Guard::UI.error "Please add \"gem 'rb-notifu'\" to your Gemfile and run Guard with \"bundle exec\"." unless silent
-        false
+      def self.available?(opts = {})
+        super
+        require_gem_safely(opts)
       end
 
-      # Show a system notification.
+      # Shows a system notification.
       #
-      # @param [String] type the notification type. Either 'success', 'pending', 'failed' or 'notify'
-      # @param [String] title the notification title
       # @param [String] message the notification message body
-      # @param [String] image the path to the notification image
-      # @param [Hash] options additional notification library options
-      # @option options [Number] time the number of seconds to display (0 for infinit)
-      # @option options [Boolean] icon specify an icon to use ("parent" uses the icon of the parent process)
-      # @option options [Boolean] baloon enable ballon tips in the registry (for this user only)
-      # @option options [Boolean] nosound do not play a sound when the tooltip is displayed
-      # @option options [Boolean] noquiet show the tooltip even if the user is in the quiet period that follows his very first login (Windows 7 and up)
-      # @option options [Boolean] xp use IUserNotification interface event when IUserNotification2 is available
+      # @param [Hash] opts additional notification library options
+      # @option opts [String] type the notification type. Either 'success',
+      #   'pending', 'failed' or 'notify'
+      # @option opts [String] title the notification title
+      # @option opts [String] image the path to the notification image
+      # @option opts [Number] time the number of seconds to display (0 for
+      #   infinit)
+      # @option opts [Boolean] icon specify an icon to use ("parent" uses the
+      #   icon of the parent process)
+      # @option opts [Boolean] baloon enable ballon tips in the registry (for
+      #   this user only)
+      # @option opts [Boolean] nosound do not play a sound when the tooltip is
+      #   displayed
+      # @option opts [Boolean] noquiet show the tooltip even if the user is in
+      #   the quiet period that follows his very first login (Windows 7 and up)
+      # @option opts [Boolean] xp use IUserNotification interface event when
+      #   IUserNotification2 is available
       #
-      def notify(type, title, message, image, options = { })
-        require 'rb-notifu'
+      def notify(message, opts = {})
+        self.class.require_gem_safely
+        normalize_standard_options!(opts)
+
+        opts = DEFAULTS.merge(
+          type:    _notifu_type(opts.delete(:type)),
+          message: message
+        ).merge(opts)
 
-        ::Notifu.show(DEFAULTS.merge(options).merge({
-          :type    => notifu_type(type),
-          :title   => title,
-          :message => message
-        }))
+        # The empty block is needed until https://github.com/stereobooster/rb-notifu/pull/1 is merged
+        ::Notifu.show(opts) {}
       end
 
       private
 
-      # Convert Guards notification type to the best matching
+      # Converts Guards notification type to the best matching
       # Notifu type.
       #
       # @param [String] type the Guard notification type
       # @return [Symbol] the Notify notification type
       #
-      def notifu_type(type)
-        case type
-        when 'failed'
+      def _notifu_type(type)
+        case type.to_sym
+        when :failed
           :error
-        when 'pending'
+        when :pending
           :warn
         else
           :info