guard 1.8.3 → 2.0.0.pre

data/lib/guard/notifiers/emacs.rb

@@ -1,4 +1,4 @@
-require 'rbconfig'
+require 'guard/notifiers/base'
 
 module Guard
   module Notifier
@@ -8,57 +8,57 @@ module Guard
     # @example Add the `:emacs` notifier to your `Guardfile`
     #   notification :emacs
     #
-    module Emacs
-      extend self
+    class Emacs < Base
 
       DEFAULTS = {
-        :client    => 'emacsclient',
-        :success   => 'ForestGreen',
-        :failed    => 'Firebrick',
-        :default   => 'Black',
-        :fontcolor => 'White',
+        client:    'emacsclient',
+        success:   'ForestGreen',
+        failed:    'Firebrick',
+        default:   'Black',
+        fontcolor: 'White',
       }
 
-      # Test if Emacs with running server 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 = {})
-        result = `#{ options.fetch(:client, DEFAULTS[:client]) } --eval '1' 2> #{DEV_NULL} || echo 'N/A'`
+      def self.available?(opts = {})
+        super
+        result = `#{ opts.fetch(:client, DEFAULTS[:client]) } --eval '1' 2> #{DEV_NULL} || echo 'N/A'`
 
-        if %w(N/A 'N/A').include?(result.chomp!)
-          false
-        else
-          true
-        end
+        !%w(N/A 'N/A').include?(result.chomp!)
       end
 
-      # Show a system notification.
+      # Shows a system notification.
       #
-      # @param [String] type the notification type. Either 'success', 'pending', 'failed' or 'notify'
+      # @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] success the color to use for success notifications (default is 'ForestGreen')
-      # @option options [String] failed the color to use for failure notifications (default is 'Firebrick')
-      # @option options [String] pending the color to use for pending notifications
-      # @option options [String] default the default color to use (default is 'Black')
-      # @option options [String] client the client to use for notification (default is 'emacsclient')
-      # @option options [String, Integer] priority specify an int or named key (default is 0)
+      # @param [Hash] opts additional notification library options
+      # @option opts [String] success the color to use for success
+      #   notifications (default is 'ForestGreen')
+      # @option opts [String] failed the color to use for failure
+      #   notifications (default is 'Firebrick')
+      # @option opts [String] pending the color to use for pending
+      #   notifications
+      # @option opts [String] default the default color to use (default is
+      #   'Black')
+      # @option opts [String] client the client to use for notification
+      #   (default is 'emacsclient')
+      # @option opts [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
-        fontcolor = emacs_color :fontcolor, options
+      def notify(message, opts = {})
+        normalize_standard_options!(opts)
+
+        opts      = DEFAULTS.merge(opts)
+        color     = emacs_color(opts[:type], opts)
+        fontcolor = emacs_color(:fontcolor, opts)
         elisp = <<-EOF.gsub(/\s+/, ' ').strip
           (set-face-attribute 'mode-line nil
                :background "#{color}"
                :foreground "#{fontcolor}")
         EOF
-        run_cmd [ options[:client], '--eval', elisp ]
+
+        _run_cmd(opts[:client], '--eval', elisp)
       end
 
       # Get the Emacs color for the notification type.
@@ -73,15 +73,17 @@ module Guard
       # @return [String] the name of the emacs color
       #
       def emacs_color(type, options = {})
-        default = options[:default] || DEFAULTS[:default]
+        default = options.fetch(:default, DEFAULTS[:default])
         options.fetch(type.to_sym, default)
       end
 
       private
 
-      def run_cmd(args)
+      def _run_cmd(*args)
         IO.popen(args).readlines
       end
+
     end
+
   end
 end

data/lib/guard/notifiers/file_notifier.rb

@@ -1,54 +1,58 @@
+require 'guard/notifiers/base'
+
 module Guard
   module Notifier
 
-    # Writes guard notification results to a file
+    # Writes Guard notification results to a file.
     #
     # @example Add the `:file` notifier to your `Guardfile`
     #   notification :file, path: 'tmp/guard_result'
     #
-    module FileNotifier
-      extend self
+    class FileNotifier < Base
 
-      # Default options for FileNotifier
       DEFAULTS = {
-        :format => "%s\n%s\n%s\n"
+        format: "%s\n%s\n%s\n"
       }
 
-      # Test if the file notification option is available?
-      #
-      # @param [Boolean] silent true if no error messages should be shown
-      # @param [Hash] options notifier options
-      # @return [Boolean] the availability status
+      # @param [Hash] opts some options
+      # @option opts [Boolean] path the path to a file where Guard notification
+      #   results will be written
       #
-      def available?(silent = false, options = {})
-        options.has_key?(:path)
+      def self.available?(opts = {})
+        super
+        opts.has_key?(:path)
       end
 
-      # Write the notification to a file. By default it writes type, title, and
-      # message separated by newlines.
+      # Writes the notification to a file. By default it writes type, title,
+      # and message separated by newlines.
       #
-      # @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] format printf style format for file contents
-      # @option options [String] path the path of where to write the file
+      # @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] format printf style format for file contents
+      # @option opts [String] path the path of where to write the file
       #
-      def notify(type, title, message, image, options = { })
-        if options[:path]
-          format = options.fetch(:format, DEFAULTS[:format])
+      def notify(message, opts = {})
+        normalize_standard_options!(opts)
+
+        if opts[:path]
+          format = opts.fetch(:format, DEFAULTS[:format])
 
-          write(options[:path], format % [type, title, message])
+          _write(opts[:path], format % [opts[:type], opts[:title], message])
         else
           ::Guard::UI.error ':file notifier requires a :path option'
         end
       end
 
       private
-      def write(path, contents)
+
+      def _write(path, contents)
         File.write(path, contents)
       end
+
     end
 
   end

data/lib/guard/notifiers/gntp.rb

@@ -1,19 +1,19 @@
-require 'rbconfig'
-require 'guard/ui'
+require 'guard/notifiers/base'
 
 module Guard
   module Notifier
 
-    # System notifications using the [ruby_gntp](https://github.com/snaka/ruby_gntp) gem.
+    # 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
+    # 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](http://growl.info)
     # * [Growl for Windows](http://www.growlforwindows.com)
     # * [Growl for Linux](http://mattn.github.com/growl-for-linux)
-    # * [Snarl](https://sites.google.com/site/snarlapp/)
+    # * [Snarl](https://sites.google.com/site/snarlapp)
     #
     # @example Add the `ruby_gntp` gem to your `Gemfile`
     #   group :development
@@ -24,96 +24,89 @@ module Guard
     #   notification :gntp
     #
     # @example Add the `:gntp` notifier with configuration options to your `Guardfile`
-    #   notification :gntp, :sticky => true, :host => '192.168.1.5', :password => 'secret'
+    #   notification :gntp, sticky: true, host: '192.168.1.5', password: 'secret'
     #
-    module GNTP
-      extend self
+    class GNTP < Base
 
-      # Default options for the ruby gtnp gem
+      # Default options for the ruby gtnp notifications.
       DEFAULTS = {
-        :sticky   => false,
-        :host     => '127.0.0.1',
-        :password => '',
-        :port     => 23053
+        sticky: false
       }
 
-      # Is this notifier already registered
-      #
-      # @return [Boolean] registration status
-      #
-      def registered?
-        @registered ||= false
-      end
+      # Default options for the ruby gtnp client.
+      CLIENT_DEFAULTS = {
+        host:     '127.0.0.1',
+        password: '',
+        port:     23053
+      }
 
-      # Mark the notifier as registered.
-      #
-      def registered!
-        @registered = true
+      def self.supported_hosts
+        %w[darwin linux freebsd openbsd sunos solaris mswin mingw cygwin]
       end
 
-      # 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'] =~ /darwin|linux|freebsd|openbsd|sunos|solaris|mswin|mingw|cygwin/
-          require 'ruby_gntp'
-          true
-
-        else
-          ::Guard::UI.error 'The :gntp notifier runs only on Mac OS X, Linux, FreeBSD, OpenBSD, Solaris and Windows.' unless silent
-          false
-        end
+      def self.gem_name
+        'ruby_gntp'
+      end
 
-      rescue LoadError
-        ::Guard::UI.error "Please add \"gem 'ruby_gntp'\" 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 [String] host the hostname or IP address to which to send a remote notification
-      # @option options [String] password the password used for remote notifications
-      # @option options [Integer] port the port to send a remote notification
-      # @option options [Boolean] sticky make the notification sticky
+      # @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] host the hostname or IP address to which to send
+      #   a remote notification
+      # @option opts [String] password the password used for remote
+      #   notifications
+      # @option opts [Integer] port the port to send a remote notification
+      # @option opts [Boolean] sticky make the notification sticky
       #
-      def notify(type, title, message, image, options = { })
-        require 'ruby_gntp'
+      def notify(message, opts = {})
+        self.class.require_gem_safely
+        normalize_standard_options!(opts)
 
-        options = DEFAULTS.merge(options)
+        opts = DEFAULTS.merge(
+          name: opts.delete(:type).to_s,
+          text: message,
+          icon: opts.delete(:image)
+        ).merge(opts)
 
-        gntp = ::GNTP.new('Guard', options.delete(:host), options.delete(:password), options.delete(:port))
+        _client(opts).notify(opts)
+      end
 
-        unless registered?
-          gntp.register({
-              :app_icon => File.expand_path(File.join(__FILE__, '..', '..', '..', '..', 'images', 'guard.png')),
-              :notifications => [
-                  { :name => 'notify', :enabled => true },
-                  { :name => 'failed', :enabled => true },
-                  { :name => 'pending', :enabled => true },
-                  { :name => 'success', :enabled => true }
-              ]
-          })
+      private
+
+      def _register!(gntp_client)
+        gntp_client.register(
+          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 }
+          ]
+        )
+      end
 
-          registered!
+      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] })
+          _register!(gntp)
+          gntp
         end
-
-        gntp.notify(options.merge({
-            :name  => type,
-            :title => title,
-            :text  => message,
-            :icon  => image
-        }))
       end
 
     end
+
   end
 end
-

data/lib/guard/notifiers/growl.rb

@@ -1,5 +1,4 @@
-require 'rbconfig'
-require 'guard/ui'
+require 'guard/notifiers/base'
 
 module Guard
   module Notifier
@@ -29,72 +28,70 @@ module Guard
     #   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'
+    #   notification :growl, sticky: true, host: '192.168.1.5', password: 'secret'
     #
-    module Growl
-      extend self
+    class Growl < Base
 
-      # Default options for growl gem
+      # Default options for the growl notifications.
       DEFAULTS = {
-        :sticky   => false,
-        :priority => 0
+        sticky:   false,
+        priority: 0
       }
 
-      # 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'] =~ /darwin/
-          require 'growl'
-
-          if ::Growl.installed?
-            true
-          else
-            ::Guard::UI.error "Please install the 'growlnotify' executable." unless silent
-            false
-          end
-
-        else
-          ::Guard::UI.error 'The :growl notifier runs only on Mac OS X.' unless silent
-          false
-        end
+      def self.supported_hosts
+        %w[darwin]
+      end
 
-      rescue LoadError, NameError
-        ::Guard::UI.error "Please add \"gem 'growl'\" to your Gemfile and run Guard with \"bundle exec\"." unless silent
-        false
+      def self.available?(opts = {})
+        super
+        _register!(opts) if require_gem_safely(opts)
       end
 
-      # Show a system notification.
+      # Shows a system notification.
       #
-      # The documented options are for GrowlNotify 1.3, but the older options are
-      # also supported. Please see `growlnotify --help`.
+      # The documented options are for GrowlNotify 1.3, but the older options
+      # are also supported. Please see `growlnotify --help`.
       #
-      # Priority can be one of the following named keys: `Very Low`, `Moderate`, `Normal`,
-      # `High`, `Emergency`. It can also be an int between -2 and 2.
+      # Priority can be one of the following named keys: `Very Low`,
+      # `Moderate`, `Normal`, `High`, `Emergency`. It can also be an integer
+      # between -2 and 2.
       #
-      # @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 make the notification sticky
-      # @option options [String, Integer] priority specify an int or named key (default is 0)
-      # @option options [String] host the hostname or IP address to which to send a remote notification
-      # @option options [String] password the password used for remote notifications
+      # @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 make the notification sticky
+      # @option opts [String, Integer] priority specify an int or named key
+      #   (default is 0)
+      # @option opts [String] host the hostname or IP address to which to
+      #   send a remote notification
+      # @option opts [String] password the password used for remote
+      #   notifications
       #
-      def notify(type, title, message, image, options = { })
-        require 'growl'
+      def notify(message, opts = {})
+        self.class.require_gem_safely
+        normalize_standard_options!(opts)
+        opts.delete(:type)
+
+        opts = DEFAULTS.merge(opts).merge(name: 'Guard')
 
-        ::Growl.notify(message, DEFAULTS.merge(options).merge({
-            :name => 'Guard',
-            :title => title,
-            :image => image
-        }))
+        ::Growl.notify(message, opts)
+      end
+
+      # @private
+      #
+      def self._register!(options)
+        unless ::Growl.installed?
+          ::Guard::UI.error "Please install the 'growlnotify' executable." unless options[:silent]
+          return false
+        end
+
+        true
       end
 
     end
+
   end
 end