guard 1.8.3 → 2.0.0.pre

data/lib/guard/notifiers/terminal_notifier.rb

@@ -1,12 +1,14 @@
-require 'guard/ui'
+require 'guard/notifiers/base'
 
 module Guard
   module Notifier
 
-    # System notifications using the [terminal-notifier-guard](https://github.com/Springest/terminal-notifier-guard gem.
+    # System notifications using the
+    # [terminal-notifier-guard](https://github.com/Springest/terminal-notifier-guard)
+    # gem.
     #
-    # This gem is available for OS X 10.8 Mountain Lion and sends notifications to the OS X
-    # notification center.
+    # This gem is available for OS X 10.8 Mountain Lion and sends notifications
+    # to the OS X notification center.
     #
     # @example Add the `terminal-notifier-guard` gem to your `Gemfile`
     #   group :development
@@ -19,49 +21,59 @@ module Guard
     # @example Add the `:terminal_notifier` notifier with configuration options to your `Guardfile`
     #   notification :terminal_notifier, app_name: "MyApp"
     #
-    module TerminalNotifier
-      extend self
+    class TerminalNotifier < Base
 
-      # Test if the notification library is available.
+      def self.supported_hosts
+        %w[darwin]
+      end
+
+      def self.gem_name
+        'terminal-notifier-guard'
+      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 (ignored)
+      # @option opts [String] app_name name of your app
+      # @option opts [String] execute a command
+      # @option opts [String] activate an app bundle
+      # @option opts [String] open some url or file
       #
-      def available?(silent = false, options = {})
-        require 'terminal-notifier-guard'
+      def notify(message, opts = {})
+        self.class.require_gem_safely
+        title = opts[:title]
+        normalize_standard_options!(opts)
 
+        opts.delete(:image)
+        opts[:title] = title || [opts.delete(:app_name) { 'Guard' }, opts[:type].downcase.capitalize].join(' ')
+
+        ::TerminalNotifier::Guard.execute(false, opts.merge(message: message))
+      end
+
+      # @private
+      #
+      def self._register!(options)
         if ::TerminalNotifier::Guard.available?
           true
         else
-          ::Guard::UI.error 'The :terminal_notifier only runs on Mac OS X 10.8 and later.' unless silent
+          unless options[:silent]
+            ::Guard::UI.error 'The :terminal_notifier only runs on Mac OS X 10.8 and later.'
+          end
           false
         end
-
-      rescue LoadError, NameError
-        ::Guard::UI.error "Please add \"gem 'terminal-notifier-guard'\" 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 (ignored)
-      # @param [Hash] options additional notification library options
-      # @option options [String] app_name name of your app
-      # @option options [String] execute a command
-      # @option options [String] activate an app bundle
-      # @option options [String] open some url or file
-      #
-      def notify(type, title, message, image, options = { })
-        require 'terminal-notifier-guard'
-        options[:title] = title || [options[:app_name] || 'Guard', type.downcase.capitalize].join(' ')
-        options.merge!(:type => type.to_sym, :message => message)
-        options.delete :app_name if options[:app_name]
-        ::TerminalNotifier::Guard.execute(false, options)
-      end
     end
+
   end
 end

data/lib/guard/notifiers/terminal_title.rb

@@ -1,31 +1,35 @@
-# Module for notifying test result to terminal title
+require 'guard/notifiers/base'
+
 module Guard
   module Notifier
-    module TerminalTitle
-      extend self
 
-      # Test if the notification library is available.
+    # Shows system notifications in the terminal title bar.
+    #
+    class TerminalTitle < Base
+
+      # 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 [Hash] opts additional notification library options
+      # @option opts [String] message the notification message body
+      # @option opts [String] type the notification type. Either 'success',
+      #   'pending', 'failed' or 'notify'
+      # @option opts [String] title the notification title
       #
-      def available?(silent = false, options = {})
-        true
+      def notify(message, opts = {})
+        normalize_standard_options!(opts)
+
+        first_line = message.sub(/^\n/, '').sub(/\n.*/m, '')
+
+        puts "\e]2;[#{ opts[:title] }] #{ first_line }\a"
       end
 
-      # Show a system notification.
+      # Clears the terminal title
       #
-      # @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
-      #
-      def notify(type, title, message, image, options = { })
-        first_line = message.sub(/^\n/, '').sub(/\n.*/m, '')
-        puts("\e]2;[#{ title }] #{ first_line }\a")
+      def self.turn_off
+        puts "\e]2;\a"
       end
+
     end
+
   end
 end

data/lib/guard/notifiers/tmux.rb

@@ -1,3 +1,5 @@
+require 'guard/notifiers/base'
+
 module Guard
   module Notifier
 
@@ -8,100 +10,118 @@ module Guard
     #   notification :tmux
     #
     # @example Enable text messages
-    #   notification :tmux, :display_message => true
+    #   notification :tmux, display_message: true
     #
     # @example Customize the tmux status colored for notifications
-    #   notification :tmux, :color_location => 'status-right-bg'
+    #   notification :tmux, color_location: 'status-right-bg'
     #
-    module Tmux
-      extend self
+    class Tmux < Base
 
-      # Default options for Tmux
+      # Default options for the tmux notifications.
       DEFAULTS = {
-        :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',
-        :line_separator         => ' - ',
-        :color_location         => 'status-left-bg'
+        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',
+        line_separator:         ' - ',
+        color_location:         'status-left-bg'
       }
 
-      # Test if currently running in a Tmux session
-      #
-      # @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 ENV[options.fetch(:tmux_environment, DEFAULTS[:tmux_environment])].nil?
-          ::Guard::UI.error 'The :tmux notifier runs only on when Guard is executed inside of a tmux session.' unless silent
+      def self.available?(opts = {})
+        super
+
+        if ENV[opts.fetch(:tmux_environment, DEFAULTS[:tmux_environment])].nil?
+          unless opts[:silent]
+            ::Guard::UI.error 'The :tmux notifier runs only on when Guard is executed inside of a tmux session.'
+          end
           false
         else
           true
         end
       end
 
-      # Show a system notification. By default, the Tmux notifier only makes use of a color based
-      # notification, changing the background color of the `color_location` to the color defined
-      # in either the `success`, `failed`, `pending` or `default`, depending on the notification type.
-      # If you also want display a text message, you have to enable it explicit by setting `display_message`
-      # to `true`.
+      # Shows a system notification.
+      #
+      # By default, the Tmux notifier only makes
+      # use of a color based notification, changing the background color of the
+      # `color_location` to the color defined in either the `success`,
+      # `failed`, `pending` or `default`, depending on the notification type.
+      # If you also want display a text message, you have to enable it explicit
+      # by setting `display_message` to `true`.
       #
-      # @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] color_location the location where to draw the color notification
-      # @option options [Boolean] display_message whether to display a message or not
+      # @param [Hash] opts additional notification library options
+      # @option opts [String] type the notification type. Either 'success',
+      #   'pending', 'failed' or 'notify'
+      # @option opts [String] message the notification message body
+      # @option opts [String] image the path to the notification image
+      # @option opts [String] color_location the location where to draw the
+      #   color notification
+      # @option opts [Boolean] display_message whether to display a message
+      #   or not
       #
-      def notify(type, title, message, image, options = { })
-        color = tmux_color(type, options)
-        color_location = options[:color_location] || DEFAULTS[:color_location]
+      def notify(message, opts = {})
+        normalize_standard_options!(opts)
+        opts.delete(:image)
+
+        color_location = opts.fetch(:color_location, DEFAULTS[:color_location])
+        color = tmux_color(opts[:type], opts)
 
-        run_client "set #{ color_location } #{ color }"
+        _run_client "set #{ color_location } #{ color }"
 
-        show_message = options[:display_message] || DEFAULTS[:display_message]
-        display_message(type, title, message, options) if show_message
+        if opts.fetch(:display_message, DEFAULTS[:display_message])
+          display_message(opts.delete(:type).to_s, opts.delete(:title), message, opts)
+        end
       end
 
-      # Display a message in the status bar of tmux.
+      # Displays a message in the status bar of tmux.
       #
-      # @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 [Hash] options additional notification library options
-      # @option options [Integer] timeout the amount of seconds to show the message in the status bar
-      # @option options [String] success_message_format a string to use as formatter for the success message.
-      # @option options [String] failed_message_format a string to use as formatter for the failed message.
-      # @option options [String] pending_message_format a string to use as formatter for the pending message.
-      # @option options [String] default_message_format a string to use as formatter when no format per type is defined.
-      # @option options [String] success_message_color the success notification foreground color name.
-      # @option options [String] failed_message_color the failed notification foreground color name.
-      # @option options [String] pending_message_color the pending notification foreground color name.
-      # @option options [String] default_message_color a notification foreground color to use when no color per type is defined.
-      # @option options [String] line_separator a string to use instead of a line-break.
+      # @option options [Integer] timeout the amount of seconds to show the
+      #   message in the status bar
+      # @option options [String] success_message_format a string to use as
+      #   formatter for the success message.
+      # @option options [String] failed_message_format a string to use as
+      #   formatter for the failed message.
+      # @option options [String] pending_message_format a string to use as
+      #   formatter for the pending message.
+      # @option options [String] default_message_format a string to use as
+      #   formatter when no format per type is defined.
+      # @option options [String] success_message_color the success notification
+      #   foreground color name.
+      # @option options [String] failed_message_color the failed notification
+      #   foreground color name.
+      # @option options [String] pending_message_color the pending notification
+      #   foreground color name.
+      # @option options [String] default_message_color a notification
+      #   foreground color to use when no color per type is defined.
+      # @option options [String] line_separator a string to use instead of a
+      #   line-break.
       #
-      def display_message(type, title, message, options = { })
-          message_format = options["#{ type }_message_format".to_sym] || options[:default_message_format] || DEFAULTS[:default_message_format]
-          message_color = options["#{ type }_message_color".to_sym] || options[:default_message_color] || DEFAULTS[:default_message_color]
-          display_time = options[:timeout] || DEFAULTS[:timeout]
-          separator = options[:line_separator] || DEFAULTS[:line_separator]
-
-          color = tmux_color type, options
-          formatted_message = message.split("\n").join(separator)
-          display_message = message_format % [title, formatted_message]
-
-          run_client "set display-time #{ display_time * 1000 }"
-          run_client "set message-fg #{ message_color }"
-          run_client "set message-bg #{ color }"
-          run_client "display-message '#{ display_message }'"
+      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]))
+        display_time = opts.fetch(:timeout, DEFAULTS[:timeout])
+        separator = opts.fetch(:line_separator, DEFAULTS[:line_separator])
+
+        color = tmux_color type, opts
+        formatted_message = message.split("\n").join(separator)
+        display_message = message_format % [title, formatted_message]
+
+        _run_client "set display-time #{ display_time * 1000 }"
+        _run_client "set message-fg #{ message_color }"
+        _run_client "set message-bg #{ color }"
+        _run_client "display-message '#{ display_message }'"
       end
 
       # Get the Tmux color for the notification type.
@@ -110,55 +130,51 @@ module Guard
       # @param [String] type the notification type
       # @return [String] the name of the emacs color
       #
-      def tmux_color(type, options = { })
-        case type
-        when 'success'
-          options[:success] || DEFAULTS[:success]
-        when 'failed'
-          options[:failed]  || DEFAULTS[:failed]
-        when 'pending'
-          options[:pending] || DEFAULTS[:pending]
-        else
-          options[:default] || DEFAULTS[:default]
-        end
+      def tmux_color(type, opts = {})
+        type = type.to_sym
+        type = :default unless [:success, :failed, :pending].include?(type)
+
+        opts.fetch(type, DEFAULTS[type])
       end
 
       # Notification starting, save the current Tmux settings
       # and quiet the Tmux output.
       #
-      def turn_on(options = { })
+      def turn_on
         unless @options_stored
-          reset_options_store
-
+          _reset_options_store
           `#{ DEFAULTS[:client] } show`.each_line do |line|
             option, _, setting = line.chomp.partition(' ')
-            @options_store[option] = setting
+            options_store[option] = setting
           end
 
           @options_stored = true
         end
 
-        run_client "set quiet on"
+        _run_client 'set quiet on'
       end
 
       # Notification stopping. Restore the previous Tmux state
       # if available (existing options are restored, new options
       # are unset) and unquiet the Tmux output.
       #
-      def turn_off(options = { })
+      def turn_off
         if @options_stored
           @options_store.each do |key, value|
             if value
-              run_client "set #{ key } #{ value }"
+              _run_client "set #{ key } #{ value }"
             else
-              run_client "set -u #{ key }"
+              _run_client "set -u #{ key }"
             end
           end
-
-          reset_options_store
+          _reset_options_store
         end
 
-        run_client 'set quiet off'
+        _run_client 'set quiet off'
+      end
+
+      def options_store
+        @options_store ||= {}
       end
 
       private
@@ -168,13 +184,13 @@ module Guard
         super
       end
 
-      def run_client(args)
+      def _run_client(args)
         system("#{ DEFAULTS[:client] } #{args}")
       end
 
       # Reset the internal Tmux options store defaults.
       #
-      def reset_options_store
+      def _reset_options_store
         @options_stored = false
         @options_store = {
           'status-left-bg'  => nil,
@@ -188,5 +204,6 @@ module Guard
       end
 
     end
+
   end
 end