guard 2.6.1 → 2.7.0

data/lib/guard/jobs/sleep.rb

@@ -0,0 +1,25 @@
+require "guard/jobs/base"
+
+module Guard
+  module Jobs
+    class Sleep < Base
+      def foreground
+        ::Guard::UI.debug "Guards jobs done. Sleeping..."
+        sleep
+        ::Guard::UI.debug "Sleep interrupted by events."
+        :stopped
+      rescue Interrupt
+        ::Guard::UI.debug "Sleep interrupted by user."
+        :exit
+      end
+
+      def background
+        Thread.main.wakeup
+      end
+
+      def handle_interrupt
+        Thread.main.raise Interrupt
+      end
+    end
+  end
+end

data/lib/guard/notifier.rb

@@ -1,29 +1,26 @@
-require 'yaml'
-require 'rbconfig'
-require 'pathname'
-
-require 'guard/ui'
-require 'guard/notifiers/emacs'
-require 'guard/notifiers/file_notifier'
-require 'guard/notifiers/gntp'
-require 'guard/notifiers/growl_notify'
-require 'guard/notifiers/growl'
-require 'guard/notifiers/libnotify'
-require 'guard/notifiers/notifysend'
-require 'guard/notifiers/rb_notifu'
-require 'guard/notifiers/terminal_notifier'
-require 'guard/notifiers/terminal_title'
-require 'guard/notifiers/tmux'
+require "yaml"
+require "rbconfig"
+require "pathname"
+
+require "guard/ui"
+require "guard/notifiers/emacs"
+require "guard/notifiers/file_notifier"
+require "guard/notifiers/gntp"
+require "guard/notifiers/growl"
+require "guard/notifiers/libnotify"
+require "guard/notifiers/notifysend"
+require "guard/notifiers/rb_notifu"
+require "guard/notifiers/terminal_notifier"
+require "guard/notifiers/terminal_title"
+require "guard/notifiers/tmux"
 
 module Guard
-
   # The notifier handles sending messages to different notifiers. Currently the
   # following
   # libraries are supported:
   #
   # * Ruby GNTP
   # * Growl
-  # * GrowlNotify
   # * Libnotify
   # * rb-notifu
   # * emacs
@@ -45,7 +42,7 @@ module Guard
   # The notification type selection is based on the image option that is
   # sent to {#notify}. Each image type has its own notification type, and
   # notifications with custom images goes all sent as type `notify`. The
-  # `gntp` and `growl_notify` notifiers are able to register these types
+  # `gntp` notifier is able to register these types
   # at Growl and allows customization of each notification type.
   #
   # Guard can be configured to make use of more than one notifier at once.
@@ -53,7 +50,6 @@ module Guard
   # @see Guard::Dsl
   #
   module Notifier
-
     extend self
 
     # List of available notifiers, grouped by functionality
@@ -61,7 +57,6 @@ module Guard
       {
         gntp: GNTP,
         growl: Growl,
-        growl_notify: GrowlNotify,
         terminal_notifier: TerminalNotifier,
         libnotify: Libnotify,
         notifysend: NotifySend,
@@ -74,17 +69,17 @@ module Guard
     ]
 
     def notifiers
-      ENV['GUARD_NOTIFIERS'] ? YAML::load(ENV['GUARD_NOTIFIERS']) : []
+      ENV["GUARD_NOTIFIERS"] ? YAML::load(ENV["GUARD_NOTIFIERS"]) : []
     end
 
     def notifiers=(notifiers)
-      ENV['GUARD_NOTIFIERS'] = YAML::dump(notifiers)
+      ENV["GUARD_NOTIFIERS"] = YAML::dump(notifiers)
     end
 
     # Clear available notifications.
     #
     def clear_notifiers
-      ENV['GUARD_NOTIFIERS'] = nil
+      ENV["GUARD_NOTIFIERS"] = nil
     end
 
     # Turn notifications on. If no notifications are defined in the `Guardfile`
@@ -94,19 +89,24 @@ module Guard
     # @option options [Boolean] silent disable any logging
     #
     def turn_on(opts = {})
-      _auto_detect_notification if notifiers.empty? && (!::Guard.options || ::Guard.options[:notify])
+      if notifiers.empty? && (::Guard.options || {})[:notify]
+        _auto_detect_notification
+      end
 
       if notifiers.empty?
         turn_off
       else
         notifiers.each do |notifier|
           notifier_class = _get_notifier_module(notifier[:name])
-          ::Guard::UI.info "Guard is using #{ notifier_class.title } to send notifications." unless opts[:silent]
+          unless opts[:silent]
+            ::Guard::UI.info \
+              "Guard is using #{ notifier_class.title } to send notifications."
+          end
 
           notifier_class.turn_on if notifier_class.respond_to?(:turn_on)
         end
 
-        ENV['GUARD_NOTIFY'] = 'true'
+        ENV["GUARD_NOTIFY"] = "true"
       end
     end
 
@@ -119,14 +119,14 @@ module Guard
         notifier_class.turn_off if notifier_class.respond_to?(:turn_off)
       end
 
-      ENV['GUARD_NOTIFY'] = 'false'
+      ENV["GUARD_NOTIFY"] = "false"
     end
 
     # Toggle the system notifications on/off
     #
     def toggle
       if enabled?
-        ::Guard::UI.info 'Turn off notifications'
+        ::Guard::UI.info "Turn off notifications"
         turn_off
       else
         turn_on
@@ -138,7 +138,7 @@ module Guard
     # @return [Boolean] whether the notifications are on
     #
     def enabled?
-      ENV['GUARD_NOTIFY'] == 'true'
+      ENV["GUARD_NOTIFY"] == "true"
     end
 
     # Add a notification library to be used.
@@ -175,8 +175,10 @@ module Guard
 
         begin
           notifier.notify(message, opts.dup)
-        rescue Exception => e
-          ::Guard::UI.error "Error sending notification with #{ notifier.name }: #{ e.message }"
+        rescue RuntimeError => e
+          ::Guard::UI.error \
+            "Error sending notification with #{ notifier.name }: #{ e.message }"
+
           ::Guard::UI.debug e.backtrace.join("\n")
         end
       end
@@ -191,11 +193,9 @@ module Guard
     #
     def _get_notifier_module(name)
       NOTIFIERS.each do |group|
-        if notifier = group.find { |n, _| n == name }
-          return notifier.last
-        end
+        next unless (notifier = group.detect { |n, _| n == name })
+        return notifier.last
       end
-
       nil
     end
 
@@ -208,12 +208,15 @@ module Guard
       available = nil
 
       NOTIFIERS.each do |group|
-        notifier_added = group.find { |name, klass| add_notifier(name, silent: true) }
+        notifier_added = group.detect do |name, _|
+          add_notifier(name, silent: true)
+        end
         available ||= notifier_added
       end
 
-      ::Guard::UI.info('Guard could not detect any of the supported notification libraries.') unless available
+      return if available
+      ::Guard::UI.info \
+        "Guard could not detect any of the supported notification libraries."
     end
   end
-
 end

data/lib/guard/notifiers/base.rb

@@ -1,25 +1,26 @@
-require 'rbconfig'
-require 'guard/ui'
+require "rbconfig"
+require "guard/ui"
 
 module Guard
   module Notifier
-
     # Base class for all notifiers.
     #
     class Base
-
       HOSTS = {
-        darwin:  'Mac OS X',
-        linux:   'Linux',
-        freebsd: 'FreeBSD',
-        openbsd: 'OpenBSD',
-        sunos:   'SunOS',
-        solaris: 'Solaris',
-        mswin:   'Windows',
-        mingw:   'Windows',
-        cygwin:  'Windows'
+        darwin:  "Mac OS X",
+        linux:   "Linux",
+        freebsd: "FreeBSD",
+        openbsd: "OpenBSD",
+        sunos:   "SunOS",
+        solaris: "Solaris",
+        mswin:   "Windows",
+        mingw:   "Windows",
+        cygwin:  "Windows"
       }
 
+      ERROR_ADD_GEM_AND_RUN_BUNDLE = "Please add \"gem '%s'\" to your Gemfile "\
+        "and run Guard with \"bundle exec\"."
+
       attr_reader :options
 
       def initialize(opts = {})
@@ -46,15 +47,17 @@ module Guard
         if _supported_host?
           true
         else
-          hosts = supported_hosts.map { |host| HOSTS[host.to_sym] }.join(', ')
-          ::Guard::UI.error "The :#{name} notifier runs only on #{hosts}." unless opts.fetch(:silent) { false }
+          hosts = supported_hosts.map { |host| HOSTS[host.to_sym] }.join(", ")
+          unless opts.fetch(:silent) { false }
+            ::Guard::UI.error "The :#{name} notifier runs only on #{hosts}."
+          end
           false
         end
       end
 
       # This method must be overriden.
       #
-      def notify(message, opts = {})
+      def notify(_message, opts = {})
         options.delete(:silent)
         opts.replace(options.merge(opts))
         normalize_standard_options!(opts)
@@ -69,7 +72,7 @@ module Guard
       # @return [String] the title of the notifier
       #
       def self.title
-        self.to_s.sub(/.+::(\w+)$/, '\1')
+        to_s.sub(/.+::(\w+)$/, '\1')
       end
 
       # Returns the name of the notifier.
@@ -111,7 +114,7 @@ module Guard
         true
       rescue LoadError, NameError
         unless opts[:silent]
-          ::Guard::UI.error "Please add \"gem '#{gem_name}'\" to your Gemfile and run Guard with \"bundle exec\"."
+          UI.error ERROR_ADD_GEM_AND_RUN_BUNDLE % [gem_name]
         end
         false
       end
@@ -145,7 +148,7 @@ module Guard
       # @return [Pathname] the path to the images directory
       #
       def images_path
-        @images_path ||= Pathname.new(File.dirname(__FILE__)).join('../../../images')
+        @images_path ||= Pathname.new(__FILE__).dirname + "../../../images"
       end
 
       # @private
@@ -156,7 +159,7 @@ module Guard
       #
       def self._supported_host?
         supported_hosts == :all ||
-        RbConfig::CONFIG['host_os'] =~ /#{supported_hosts.join('|')}/
+        RbConfig::CONFIG["host_os"] =~ /#{supported_hosts.join('|')}/
       end
 
       # Set or modify the `:title`, `:type` and `:image` options for a
@@ -169,7 +172,7 @@ module Guard
       # @option opts [String] image the path to the notification image
       #
       def normalize_standard_options!(opts)
-        opts[:title] ||= 'Guard'
+        opts[:title] ||= "Guard"
         opts[:type]  ||= _notification_type(opts.fetch(:image, :success))
         opts[:image]   = _image_path(opts.delete(:image) { :success })
       end
@@ -192,7 +195,7 @@ module Guard
       def _image_path(image)
         case image
         when :failed, :pending, :success
-          images_path.join("#{image.to_s}.png").to_s
+          images_path.join("#{image}.png").to_s
         else
           image
         end
@@ -213,8 +216,6 @@ module Guard
           :notify
         end
       end
-
     end
-
   end
 end

data/lib/guard/notifiers/emacs.rb

@@ -1,25 +1,24 @@
-require 'guard/notifiers/base'
+require "guard/notifiers/base"
 
 module Guard
   module Notifier
-
-    # Send a notification to Emacs with emacsclient (http://www.emacswiki.org/emacs/EmacsClient).
+    # Send a notification to Emacs with emacsclient
+    # (http://www.emacswiki.org/emacs/EmacsClient).
     #
     # @example Add the `:emacs` notifier to your `Guardfile`
     #   notification :emacs
     #
     class Emacs < Base
-
       DEFAULTS = {
-        client:    'emacsclient',
-        success:   'ForestGreen',
-        failed:    'Firebrick',
-        default:   'Black',
-        fontcolor: 'White',
+        client:    "emacsclient",
+        success:   "ForestGreen",
+        failed:    "Firebrick",
+        default:   "Black",
+        fontcolor: "White",
       }
 
       def self.available?(opts = {})
-        super and _emacs_client_available?(opts)
+        super && _emacs_client_available?(opts)
       end
 
       # @private
@@ -27,8 +26,10 @@ module Guard
       # @return [Boolean] whether or not the emacs client is available
       #
       def self._emacs_client_available?(opts)
-        result = `#{opts.fetch(:client, DEFAULTS[:client])} --eval '1' 2> #{DEV_NULL} || echo 'N/A'`
-        !%w(N/A 'N/A').include?(result.chomp!)
+        client_name = opts.fetch(:client, DEFAULTS[:client])
+        cmd = "#{client_name} --eval '1' 2> #{DEV_NULL} || echo 'N/A'"
+        stdout = Sheller.stdout(cmd)
+        !%w(N/A 'N/A').include?(stdout.chomp!)
       end
 
       # Shows a system notification.
@@ -58,13 +59,13 @@ module Guard
         opts      = DEFAULTS.merge(opts)
         color     = emacs_color(opts[:type], opts)
         fontcolor = emacs_color(:fontcolor, opts)
-        elisp = <<-EOF.gsub(/\s+/, ' ').strip
+        elisp = <<-EOF.gsub(/\s+/, " ").strip
           (set-face-attribute 'mode-line nil
                :background "#{color}"
                :foreground "#{fontcolor}")
         EOF
 
-        _run_cmd(opts[:client], '--eval', elisp)
+        _run_cmd(opts[:client], "--eval", elisp)
       end
 
       # Get the Emacs color for the notification type.
@@ -72,10 +73,19 @@ module Guard
       #
       # @param [String] type the notification type
       # @param [Hash] options aditional notification 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] 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')
+      #
       # @return [String] the name of the emacs color
       #
       def emacs_color(type, options = {})
@@ -85,13 +95,9 @@ module Guard
 
       private
 
-      def _run_cmd(*args)
-        p = IO.popen(args)
-        p.readlines
-        p.close
+      def _run_cmd(cmd, *args)
+        Sheller.run(cmd, *args)
       end
-
     end
-
   end
 end

data/lib/guard/notifiers/file_notifier.rb

@@ -1,15 +1,13 @@
-require 'guard/notifiers/base'
+require "guard/notifiers/base"
 
 module Guard
   module Notifier
-
     # Writes Guard notification results to a file.
     #
     # @example Add the `:file` notifier to your `Guardfile`
     #   notification :file, path: 'tmp/guard_result'
     #
     class FileNotifier < Base
-
       DEFAULTS = {
         format: "%s\n%s\n%s\n"
       }
@@ -19,7 +17,7 @@ module Guard
       #   results will be written
       #
       def self.available?(opts = {})
-        super and opts.has_key?(:path)
+        super && opts.has_key?(:path)
       end
 
       # Writes the notification to a file. By default it writes type, title,
@@ -42,7 +40,7 @@ module Guard
 
           _write(opts[:path], format % [opts[:type], opts[:title], message])
         else
-          ::Guard::UI.error ':file notifier requires a :path option'
+          ::Guard::UI.error ":file notifier requires a :path option"
         end
       end
 
@@ -51,8 +49,6 @@ module Guard
       def _write(path, contents)
         File.write(path, contents)
       end
-
     end
-
   end
 end