terminal_notifier.rb

require 'guard/ui'

module Guard
  module Notifier

    # 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.
    #
    # @example Add the `terminal-notifier-guard` gem to your `Gemfile`
    #   group :development
    #     gem 'terminal-notifier-guard'
    #   end
    #
    # @example Add the `:terminal_notifier` notifier to your `Guardfile`
    #   notification :terminal_notifier
    #
    # @example Add the `:terminal_notifier` notifier with configuration options to your `Guardfile`
    #   notification :terminal_notifier, app_name: "MyApp"
    #
    module TerminalNotifier
      extend self

      # 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 = {})
        require 'terminal-notifier-guard'

        if ::TerminalNotifier::Guard.available?
          true
        else
          ::Guard::UI.error 'The :terminal_notifier only runs on Mac OS X 10.8 and later.' unless silent
          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