guard 2.10.5 → 2.11.0

data/lib/guard/jobs/pry_wrapper.rb

@@ -5,7 +5,7 @@ require "guard/commands/pause"
 require "guard/commands/reload"
 require "guard/commands/scope"
 require "guard/commands/show"
-require "guard/sheller"
+require "shellany/sheller"
 
 require "guard/jobs/base"
 
@@ -14,22 +14,22 @@ module Guard
     class TerminalSettings
       def initialize
         @settings = nil
-        @works = Sheller.run("hash", "stty") || false
+        @works = Shellany::Sheller.run("hash", "stty") || false
       end
 
       def restore
         return unless configurable? && @settings
-        Sheller.run("stty #{ @setting } 2>#{IO::NULL}")
+        Shellany::Sheller.run("stty #{ @setting } 2>#{IO::NULL}")
       end
 
       def save
         return unless configurable?
-        @settings = Sheller.stdout("stty -g 2>#{IO::NULL}").chomp
+        @settings = Shellany::Sheller.stdout("stty -g 2>#{IO::NULL}").chomp
       end
 
       def echo
         return unless configurable?
-        Sheller.run("stty echo 2>#{IO::NULL}")
+        Shellany::Sheller.run("stty echo 2>#{IO::NULL}")
       end
 
       def configurable?

data/lib/guard/notifier.rb

@@ -1,246 +1,70 @@
-require "yaml"
-require "rbconfig"
-require "pathname"
-require "nenv"
-
-require_relative "notifier/detected"
-
-require_relative "ui"
+require "notiffany/notifier"
+require "guard/ui"
 
 module Guard
-  # The notifier handles sending messages to different notifiers. Currently the
-  # following libraries are supported:
-  #
-  # * Ruby GNTP
-  # * Growl
-  # * Libnotify
-  # * rb-notifu
-  # * emacs
-  # * Terminal Notifier
-  # * Terminal Title
-  # * Tmux
-  #
-  # Please see the documentation of each notifier for more information about
-  # the requirements
-  # and configuration possibilities.
-  #
-  # Guard knows four different notification types:
-  #
-  # * success
-  # * pending
-  # * failed
-  # * notify
-  #
-  # 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` 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.
-  #
-  # @see Guard::Dsl
-  #
-  # TODO: rename to plural
-  module Notifier
-    extend self
-
-    NOTIFICATIONS_DISABLED = "Notifications disabled by GUARD_NOTIFY" +
-      " environment variable"
-
-    USING_NOTIFIER = "Guard is using %s to send notifications."
-
-    ONLY_NOTIFY = "Only notify() is available from a child process"
-
-    DEPRECTED_IMPLICIT_CONNECT = "Calling Guard::Notifier.notify()" +
-      " without a prior Notifier.connect() is deprecated"
-
-    # List of available notifiers, grouped by functionality
-    SUPPORTED = [
-      {
-        gntp: GNTP,
-        growl: Growl,
-        terminal_notifier: TerminalNotifier,
-        libnotify: Libnotify,
-        notifysend: NotifySend,
-        notifu: Notifu
-      },
-      { emacs: Emacs },
-      { tmux: Tmux },
-      { terminal_title: TerminalTitle },
-      { file: FileNotifier }
-    ]
-
-    Env = Nenv::Builder.build do
-      create_method(:notify?) { |data| data != "false" }
-      create_method(:notify_pid) { |data| data && Integer(data) }
-      create_method(:notify_pid=)
-      create_method(:notify_active?)
-      create_method(:notify_active=)
-    end
-
-    class NotServer < RuntimeError
-    end
-
-    def connect(options = {})
-      @detected = Detected.new(SUPPORTED)
-      return if _client?
-
-      _env.notify_pid = $$
-
-      fail "Already connected" if active?
-
-      return unless enabled? && options[:notify]
-
-      @detected.detect
-
-      turn_on
-    rescue Detected::NoneAvailableError => e
-      ::Guard::UI.info e.to_s
-    end
-
-    def disconnect
-      if _client?
-        @detected = nil
-        return
+  class Notifier
+    def self.connect(options = {})
+      @notifier ||= nil
+      fail "Already connected!" if @notifier
+      begin
+        opts = options.merge(namespace: "guard", logger: UI)
+        @notifier = Notiffany.connect(opts)
+      rescue Notiffany::Notifier::Detected::UnknownNotifier => e
+        UI.error "Failed to setup notification: #{e.message}"
+        fail
       end
-
-      turn_off if active?
-      @detected.reset unless @detected.nil?
-      _env.notify_pid = nil
-      @detected = nil
     end
 
-    # Turn notifications on.
-    #
-    # @param [Hash] options the turn_on options
-    # @option options [Boolean] silent disable any logging
-    #
-    def turn_on(options = {})
-      _check_server!
-      return unless enabled?
-
-      fail "Already active!" if active?
+    def self.disconnect
+      @notifier.disconnect
+      @notifier = nil
+    end
 
-      silent = options[:silent]
+    DEPRECATED_IMPLICIT_CONNECT = "Calling Notiffany::Notifier.notify()" +
+      " without a prior Notifier.connect() is deprecated"
 
-      @detected.available.each do |klass, _|
-        ::Guard::UI.info(format(USING_NOTIFIER, klass.title)) unless silent
-        klass.turn_on if klass.respond_to?(:turn_on)
+    def self.notify(message, options)
+      unless @notifier
+        # TODO: reenable again?
+        # UI.deprecation(DEPRECTED_IMPLICIT_CONNECT)
+        connect(notify: true)
       end
 
-      _env.notify_active = true
+      @notifier.notify(message, options)
+    rescue RuntimeError => e
+      UI.error "Notification failed for #{notifier.name}: #{e.message}"
+      UI.debug e.backtrace.join("\n")
     end
 
-    # Turn notifications off.
-    def turn_off
-      _check_server!
-
-      fail "Not active!" unless active?
-
-      @detected.available.each do |klass, _|
-        klass.turn_off if klass.respond_to?(:turn_off)
-      end
-
-      _env.notify_active = false
+    def self.turn_on
+      @notifier.turn_on
     end
 
-    # Toggle the system notifications on/off
-    def toggle
-      unless enabled?
-        ::Guard::UI.error NOTIFICATIONS_DISABLED
+    def self.toggle
+      unless @notifier.enabled?
+        UI.error NOTIFICATIONS_DISABLED
         return
       end
 
-      if active?
-        ::Guard::UI.info "Turn off notifications"
-        turn_off
+      if @notifier.active?
+        UI.info "Turn off notifications"
+        @notifier.turn_off
         return
       end
 
-      turn_on
-    end
-
-    # Test if the notifications can be enabled based on ENV['GUARD_NOTIFY']
-    def enabled?
-      _env.notify?
-    end
-
-    # Test if notifiers are currently turned on
-    def active?
-      _env.notify_active?
-    end
-
-    # Add a notification library to be used.
-    #
-    # @param [Symbol] name the name of the notifier to use
-    # @param [Hash] options the notifier options
-    # @option options [String] silent disable any error message
-    # @return [Boolean] if the notification could be added
-    #
-    def add(name, options = {})
-      _check_server!
-
-      return false unless enabled?
-
-      if name == :off && active?
-        turn_off
-        return false
-      end
-
-      # ok to pass new instance when called without connect (e.g. evaluator)
-      (@detected || Detected.new(SUPPORTED)).add(name, options)
-    end
-
-    # TODO: deprecate/remove
-    alias :add_notifier  :add
-
-    # Show a system notification with all configured notifiers.
-    #
-    # @param [String] message the message to show
-    # @option opts [Symbol, String] image the image symbol or path to an image
-    # @option opts [String] title the notification title
-    #
-    def notify(message, message_opts = {})
-      if _client?
-        # TODO: reenable again?
-        # UI.deprecation(DEPRECTED_IMPLICIT_CONNECT)
-        return unless enabled?
-        connect(notify: true)
-      else
-        return unless active?
-      end
-
-      @detected.available.each do |klass, options|
-        _notify(klass, options, message, message_opts)
-      end
+      @notifier.turn_on
     end
 
     # Used by dsl describer
-    def notifiers
-      @detected.available.map { |mod, opts| { name: mod.name, options: opts } }
-    end
-
-    private
-
-    def _env
-      @environment ||= Env.new("guard")
+    def self.supported
+      Notiffany::Notifier::SUPPORTED.inject(:merge)
     end
 
-    def _check_server!
-      _client? && fail(NotServer, ONLY_NOTIFY)
-    end
-
-    def _client?
-      (pid = _env.notify_pid) && (pid != $$)
-    end
-
-    def _notify(klass, options, message, message_options)
-      notifier = klass.new(options)
-      notifier.notify(message, message_options.dup)
-    rescue RuntimeError => e
-      ::Guard::UI.error "Notification failed for #{notifier.name}: #{e.message}"
-      ::Guard::UI.debug e.backtrace.join("\n")
+    # Used by dsl describer
+    def self.detected
+      @notifier.available.map do |mod|
+        { name: mod.name.to_sym, options: mod.options }
+      end
     end
   end
 end

data/lib/guard/plugin_util.rb

@@ -73,7 +73,7 @@ module Guard
     def plugin_location
       @plugin_location ||= _full_gem_path("guard-#{name}")
     rescue Gem::LoadError
-      ::Guard::UI.error "Could not find 'guard-#{ name }' gem path."
+      UI.error "Could not find 'guard-#{ name }' gem path."
     end
 
     # Tries to load the Guard plugin main class. This transforms the supplied

data/lib/guard/terminal.rb

@@ -1,10 +1,11 @@
-require "guard/sheller"
+require "shellany/sheller"
+
 module Guard
   class Terminal
     class << self
       def clear
         cmd =  Gem.win_platform? ? "cls" : "clear;"
-        exit_code, _, stderr = ::Guard::Sheller.system(cmd)
+        exit_code, _, stderr = Shellany::Sheller.system(cmd)
         fail Errno::ENOENT, stderr unless exit_code == 0
       end
     end

data/lib/guard/ui.rb

@@ -1,6 +1,11 @@
 require "guard/ui/colors"
 
 require "guard/terminal"
+require "guard/options"
+
+# TODO: rework this class from the bottom-up
+#  - remove dependency on Session and Scope
+#  - extract into a separate gem
 
 module Guard
   # The UI class helps to format messages for the user. Everything that is
@@ -37,7 +42,7 @@ module Guard
       # @return [Hash] the logger options
       #
       def options
-        @options ||= ::Guard::Options.new(
+        @options ||= Options.new(
           level: :info,
           template: ":time - :severity - :message",
           time_format: "%H:%M:%S")
@@ -52,7 +57,7 @@ module Guard
       #
       # TODO: deprecate?
       def options=(options)
-        @options = ::Guard::Options.new(options)
+        @options = Options.new(options)
       end
 
       # Assigns a log level

data/lib/guard/version.rb

@@ -1,3 +1,3 @@
 module Guard
-  VERSION = "2.10.5"
+  VERSION = "2.11.0"
 end

data/lib/guard/watcher.rb

@@ -29,8 +29,8 @@ module Guard
       return unless @pattern.is_a?(String) && @pattern =~ regexp
 
       unless @@warning_printed
-        ::Guard::UI.info "*" * 20 + "\nDEPRECATION WARNING!\n" + "*" * 20
-        ::Guard::UI.info <<-MSG
+        UI.info "*" * 20 + "\nDEPRECATION WARNING!\n" + "*" * 20
+        UI.info <<-MSG
             You have a string in your Guardfile watch patterns that seem to
             represent a Regexp.
 
@@ -43,7 +43,7 @@ module Guard
       end
 
       new_regexp = Regexp.new(@pattern).inspect
-      ::Guard::UI.info "\"#{@pattern}\" has been converted to #{ new_regexp }\n"
+      UI.info "\"#{@pattern}\" has been converted to #{ new_regexp }\n"
       @pattern = Regexp.new(@pattern)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 2.10.5
+  version: 2.11.0
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-22 00:00:00.000000000 Z
+date: 2015-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: shellany
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: notiffany
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 description: Guard is a command line tool to easily handle events on file system modifications.
 email:
 - thibaud@thibaud.gg
@@ -151,24 +179,11 @@ files:
 - lib/guard/jobs/pry_wrapper.rb
 - lib/guard/jobs/sleep.rb
 - lib/guard/notifier.rb
-- lib/guard/notifier/detected.rb
-- lib/guard/notifiers/base.rb
-- lib/guard/notifiers/emacs.rb
-- lib/guard/notifiers/file_notifier.rb
-- lib/guard/notifiers/gntp.rb
-- lib/guard/notifiers/growl.rb
-- lib/guard/notifiers/libnotify.rb
-- lib/guard/notifiers/notifysend.rb
-- lib/guard/notifiers/rb_notifu.rb
-- lib/guard/notifiers/terminal_notifier.rb
-- lib/guard/notifiers/terminal_title.rb
-- lib/guard/notifiers/tmux.rb
 - lib/guard/options.rb
 - lib/guard/plugin.rb
 - lib/guard/plugin_util.rb
 - lib/guard/rake_task.rb
 - lib/guard/runner.rb
-- lib/guard/sheller.rb
 - lib/guard/templates/Guardfile
 - lib/guard/terminal.rb
 - lib/guard/ui.rb