guard 2.10.5 → 2.11.0

data/lib/guard/notifiers/gntp.rb

@@ -1,111 +0,0 @@
-require "guard/notifiers/base"
-
-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'
-    #
-    class GNTP < Base
-      # Default options for the ruby gtnp notifications.
-      DEFAULTS = {
-        sticky: false
-      }
-
-      # Default options for the ruby gtnp client.
-      CLIENT_DEFAULTS = {
-        host:     "127.0.0.1",
-        password: "",
-        port:     23053
-      }
-
-      def self.supported_hosts
-        %w(darwin linux freebsd openbsd sunos solaris mswin mingw cygwin)
-      end
-
-      def self.gem_name
-        "ruby_gntp"
-      end
-
-      def self.available?(opts = {})
-        super && require_gem_safely(opts)
-      end
-
-      # Shows a system notification.
-      #
-      # @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 [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(message, opts = {})
-        super
-        self.class.require_gem_safely
-
-        opts = DEFAULTS.merge(
-          name: opts.delete(:type).to_s,
-          text: message,
-          icon: opts.delete(:image)
-        ).merge(opts)
-
-        _client(opts).notify(opts)
-      end
-
-      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
-
-      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
-      end
-    end
-  end
-end

data/lib/guard/notifiers/growl.rb

@@ -1,104 +0,0 @@
-require "guard/notifiers/base"
-
-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 notifier
-    # 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'
-    #
-    class Growl < Base
-      ERROR_INSTALL_GROWLNOTIFY = "Please install the 'growlnotify' executable'\
-    ' (available by installing the 'growl' gem)."
-
-      # Default options for the growl notifications.
-      DEFAULTS = {
-        sticky:   false,
-        priority: 0
-      }
-
-      def self.supported_hosts
-        %w(darwin)
-      end
-
-      def self.available?(opts = {})
-        super && require_gem_safely(opts) && _register!(opts)
-      end
-
-      # @private
-      #
-      # Detects if the Growl gem is available and if not, displays an
-      # error message unless `opts[:silent]` is true.
-      #
-      # @return [Boolean] whether or not Growl is installed
-      #
-      def self._register!(opts)
-        if ::Growl.installed?
-          true
-        else
-          unless opts[:silent]
-            UI.error UI::ERROR_INSTALL_GROWLNOTIFY
-          end
-          false
-        end
-      end
-
-      # Shows 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 integer
-      # between -2 and 2.
-      #
-      # @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 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(message, opts = {})
-        super
-        opts.delete(:type)
-        self.class.require_gem_safely
-
-        opts = DEFAULTS.merge(opts).merge(name: "Guard")
-
-        ::Growl.notify(message, opts)
-      end
-    end
-  end
-end

data/lib/guard/notifiers/libnotify.rb

@@ -1,86 +0,0 @@
-require "guard/notifiers/base"
-
-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, urgency: :critical
-    #
-    class Libnotify < Base
-      # Default options for the libnotify notifications.
-      DEFAULTS = {
-        transient: false,
-        append:    true,
-        timeout:   3
-      }
-
-      def self.supported_hosts
-        %w(linux freebsd openbsd sunos solaris)
-      end
-
-      def self.available?(opts = {})
-        super && require_gem_safely(opts)
-      end
-
-      # Shows a system notification.
-      #
-      # @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] 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(message, opts = {})
-        super
-        self.class.require_gem_safely
-
-        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
-
-      # 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"
-          :normal
-        else
-          :low
-        end
-      end
-    end
-  end
-end

data/lib/guard/notifiers/notifysend.rb

@@ -1,110 +0,0 @@
-require "guard/notifiers/base"
-require "guard/sheller"
-
-module Guard
-  module Notifier
-    # System notifications using notify-send, a binary that ships with
-    # the libnotify-bin package on many Debian-based distributions.
-    #
-    # @example Add the `:notifysend` notifier to your `Guardfile`
-    #   notification :notifysend
-    #
-    class NotifySend < Base
-      # Default options for the notify-send notifications.
-      DEFAULTS = {
-        t: 3000, # Default timeout is 3000ms
-        h: "int:transient:1" # Automatically close the notification
-      }
-
-      # Full list of options supported by notify-send.
-      SUPPORTED = [:u, :t, :i, :c, :h]
-
-      def self.supported_hosts
-        %w(linux freebsd openbsd sunos solaris)
-      end
-
-      def self.available?(opts = {})
-        super && _register!(opts)
-      end
-
-      # @private
-      #
-      # @return [Boolean] whether or not the notify-send binary is available
-      #
-      def self._notifysend_binary_available?
-        !::Guard::Sheller.stdout("which notify-send").empty?
-      end
-
-      # @private
-      #
-      # Detects if the notify-send binary is available and if not, displays an
-      # error message unless `opts[:silent]` is true.
-      #
-      # @return [Boolean] whether or not the notify-send binary is available
-      #
-      def self._register!(opts)
-        if _notifysend_binary_available?
-          true
-        else
-          unless opts[:silent]
-            ::Guard::UI.error "The :notifysend notifier runs only on Linux"\
-              ", FreeBSD, OpenBSD and Solaris with the libnotify-bin "\
-              "package installed."
-          end
-          false
-        end
-      end
-
-      # Shows a system notification.
-      #
-      # @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 [String] c the notification category
-      # @option opts [Number] t the number of milliseconds to display (1000,
-      #   3000)
-      #
-      def notify(message, opts = {})
-        super
-
-        command = [opts[:title], message]
-        opts = DEFAULTS.merge(
-          i: opts.delete(:image),
-          u: _notifysend_urgency(opts.delete(:type))
-        ).merge(opts)
-
-        Sheller.run("notify-send", *_to_arguments(command, SUPPORTED, opts))
-      end
-
-      private
-
-      # 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)
-        { failed: "normal", pending: "low" }.fetch(type, "low")
-      end
-
-      # 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] opts additional command options
-      #
-      # @return [Array<String>] the command and its options converted to a
-      # shell command.
-      #
-      def _to_arguments(command, supported, opts = {})
-        opts.inject(command) do |cmd, (flag, value)|
-          supported.include?(flag) ? (cmd << "-#{ flag }" << value.to_s) : cmd
-        end
-      end
-    end
-  end
-end

data/lib/guard/notifiers/rb_notifu.rb

@@ -1,100 +0,0 @@
-require "guard/notifiers/base"
-
-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
-    #
-    class Notifu < Base
-      # Default options for the rb-notifu notifications.
-      DEFAULTS = {
-        time:    3,
-        icon:    false,
-        baloon:  false,
-        nosound: false,
-        noquiet: false,
-        xp:      false
-      }
-
-      def self.supported_hosts
-        %w(mswin mingw)
-      end
-
-      def self.gem_name
-        "rb-notifu"
-      end
-
-      def self.available?(opts = {})
-        super && require_gem_safely(opts)
-      end
-
-      # Shows a system notification.
-      #
-      # @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 [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(message, opts = {})
-        super
-        self.class.require_gem_safely
-
-        opts = DEFAULTS.merge(
-          type:    _notifu_type(opts.delete(:type)),
-          message: message
-        ).merge(opts)
-
-        # The empty block is needed until
-        # https://github.com/stereobooster/rb-notifu/pull/1 is merged
-        ::Notifu.show(opts) {}
-      end
-
-      private
-
-      # 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.to_sym
-        when :failed
-          :error
-        when :pending
-          :warn
-        else
-          :info
-        end
-      end
-    end
-  end
-end