guard 0.8.8 → 0.9.0

data/lib/guard/notifiers/gntp.rb

@@ -0,0 +1,114 @@
+require 'rbconfig'
+
+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](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/)
+    #
+    # @example Add the `ruby_gntp` gem to your `Gemfile`
+    #   group :development
+    #     gem 'ruby_gntp'
+    #   end
+    #
+    # @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'
+    #
+    module GNTP
+      extend self
+
+      # Default options for the ruby gtnp gem
+      DEFAULTS = {
+        :sticky   => false,
+        :host     => 'localhost',
+        :password => '',
+        :port     => 23053
+      }
+
+      # Is this notifier already registered
+      #
+      # @return [Boolean] registration status
+      #
+      def registered?
+        @registered ||= false
+      end
+
+      # Mark the notifier as registered.
+      #
+      def registered!
+        @registered = true
+      end
+
+      # Test if the notification library is available.
+      #
+      # @param [Boolean] silent true if no error messages should be shown
+      # @return [Boolean] the availability status
+      #
+      def available?(silent = false)
+        if RbConfig::CONFIG['host_os'] =~ /darwin|linux|freebsd|openbsd|sunos|solaris|mswin|mingw/
+          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
+
+      rescue LoadError
+        ::Guard::UI.error "Please add \"gem 'ruby_gntp'\" 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 [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
+      #
+      def notify(type, title, message, image, options = { })
+        require 'ruby_gntp'
+
+        options = DEFAULTS.merge(options)
+
+        gntp = ::GNTP.new('Guard', options.delete(:host), options.delete(:password), options.delete(:port))
+
+        unless registered?
+          gntp.register(:notifications => [
+              { :name => 'notify', :enabled => true },
+              { :name => 'failed', :enabled => true },
+              { :name => 'pending', :enabled => true },
+              { :name => 'success', :enabled => true }
+          ])
+
+          registered!
+        end
+
+        gntp.notify(options.merge({
+            :name  => type,
+            :title => title,
+            :text  => message,
+            :icon  => "file://#{ image }"
+        }))
+      end
+
+    end
+  end
+end
+

data/lib/guard/notifiers/growl.rb

@@ -0,0 +1,98 @@
+require 'rbconfig'
+
+module Guard
+  module Notifier
+
+    # 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.
+    #
+    # 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.
+    #
+    # @example Install `growlnotify` with Homebrew
+    #   brew install growlnotify
+    #
+    # @example Add the `growl` gem to your `Gemfile`
+    #   group :development
+    #     gem 'growl'
+    #   end
+    #
+    # @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'
+    #
+    module Growl
+      extend self
+
+      # Default options for growl gem
+      DEFAULTS = {
+        :sticky   => false,
+        :priority => 0
+      }
+
+      # Test if the notification library is available.
+      #
+      # @param [Boolean] silent true if no error messages should be shown
+      # @return [Boolean] the availability status
+      #
+      def available?(silent = false)
+        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
+
+      rescue LoadError, NameError
+        ::Guard::UI.error "Please add \"gem 'growl'\" to your Gemfile and run Guard with \"bundle exec\"." unless silent
+        false
+      end
+
+      # Show a system notification.
+      #
+      # 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.
+      #
+      # @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
+      #
+      def notify(type, title, message, image, options = { })
+        require 'growl'
+
+        ::Growl.notify(message, DEFAULTS.merge(options).merge({
+            :name => 'Guard',
+            :title => title,
+            :image => image
+        }))
+      end
+
+    end
+  end
+end

data/lib/guard/notifiers/growl_notify.rb

@@ -0,0 +1,91 @@
+require 'rbconfig'
+
+module Guard
+  module Notifier
+
+    # System notifications using the [GrowlNotify](https://github.com/scottdavis/growl_notify) gem.
+    #
+    # This gem is available for OS X and sends system notifications to
+    # [Growl](http://growl.info) through AppleScript.
+    #
+    # @example Add the `growl_notify` gem to your `Gemfile`
+    #   group :development
+    #     gem 'growl_notify'
+    #   end
+    #
+    # @example Add the `:growl_notify` notifier to your `Guardfile`
+    #   notification :growl_notify
+    #
+    # @example Add the `:growl_notify` notifier with configuration options to your `Guardfile`
+    #   notification :growl_notify, :sticky => true
+    #
+    module GrowlNotify
+      extend self
+
+      # Default options for growl_notify gem
+      DEFAULTS = {
+        :sticky   => false,
+        :priority => 0
+      }
+
+      # Test if the notification library is available.
+      #
+      # @param [Boolean] silent true if no error messages should be shown
+      # @return [Boolean] the availability status
+      #
+      def available?(silent = false)
+        if RbConfig::CONFIG['host_os'] =~ /darwin/
+          require 'growl_notify'
+
+          begin
+            if ::GrowlNotify.application_name != 'Guard'
+              ::GrowlNotify.config do |c|
+                c.notifications         = ['success', 'pending', 'failed', 'notify']
+                c.default_notifications = 'notify'
+                c.application_name      = 'Guard'
+              end
+            end
+
+            true
+
+          rescue ::GrowlNotify::GrowlNotFound
+            ::Guard::UI.error 'Please install Growl from http://growl.info' unless silent
+            false
+          end
+
+        else
+          ::Guard::UI.error 'The :growl_notify notifier runs only on Mac OS X.' unless silent
+          false
+        end
+
+      rescue LoadError
+        ::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'
+
+        ::GrowlNotify.send_notification(DEFAULTS.merge(options).merge({
+            :application_name => 'Guard',
+            :with_name        => type,
+            :title            => title,
+            :description      => message,
+            :icon             => image
+        }))
+      end
+
+    end
+  end
+end
+

data/lib/guard/notifiers/libnotify.rb

@@ -0,0 +1,96 @@
+require 'rbconfig'
+
+module Guard
+  module Notifier
+
+    # 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
+    # Gnome [libnotify](http://developer.gnome.org/libnotify):
+    #
+    # @example Add the `libnotify` gem to your `Gemfile`
+    #   group :development
+    #     gem 'libnotify'
+    #   end
+    #
+    # @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
+    #
+    module Libnotify
+      extend self
+
+      # Default options for libnotify gem
+      DEFAULTS = {
+        :transient => false,
+        :append    => true,
+        :timeout   => 3
+      }
+
+      # Test if the notification library is available.
+      #
+      # @param [Boolean] silent true if no error messages should be shown
+      # @return [Boolean] the availability status
+      #
+      def available?(silent = false)
+        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
+
+      rescue LoadError
+        ::Guard::UI.error "Please add \"gem 'libnotify'\" 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] 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)
+      #
+      def notify(type, title, message, image, options = { })
+        require 'libnotify'
+
+        ::Libnotify.show(DEFAULTS.merge(options).merge({
+          :urgency   => libnotify_urgency(type),
+          :summary   => title,
+          :body      => message,
+          :icon_path => image
+        }))
+      end
+
+      private
+
+      # Convert Guards notification type to the best matching
+      # libnotify urgency.
+      #
+      # @param [String] type the Guard notification type
+      # @return [Symbol] the libnotify urgency
+      #
+      def libnotify_urgency(type)
+        case type
+        when 'failed'
+          :critical
+        when 'pending'
+          :normal
+        else
+          :low
+        end
+      end
+
+    end
+  end
+end

data/lib/guard/notifiers/rb_notifu.rb

@@ -0,0 +1,101 @@
+require 'rbconfig'
+
+module Guard
+  module Notifier
+
+    # 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):
+    #
+    # @example Add the `rb-notifu` gem to your `Gemfile`
+    #   group :development
+    #     gem 'rb-notifu'
+    #   end
+    #
+    # @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
+    #
+    module Notifu
+      extend self
+
+      # Default options for rb-notifu gem
+      DEFAULTS = {
+        :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
+      # @return [Boolean] the availability status
+      #
+      def available?(silent = false)
+        if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+          require 'rb-notifu'
+
+          true
+
+        else
+          ::Guard::UI.error 'The :notifu notifier runs only on Windows.' unless silent
+          false
+        end
+
+      rescue LoadError
+        ::Guard::UI.error "Please add \"gem 'rb-notifu'\" 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 [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
+      #
+      def notify(type, title, message, image, options = { })
+        require 'rb-notifu'
+
+        ::Notifu.show(DEFAULTS.merge(options).merge({
+          :type    => notifu_type(type),
+          :title   => title,
+          :message => message
+        }))
+      end
+
+      private
+
+      # Convert 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'
+          :error
+        when 'pending'
+          :warn
+        else
+          :info
+        end
+      end
+
+    end
+  end
+end