guard 2.10.5 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df6dd8c3a8afddbe828bc11ed09f1586ebd6a5fa
-  data.tar.gz: 64d5137c8119bdc11273ba20aa3592e228dbaf3b
+  metadata.gz: 209b3d3d20d2fda90cb9b5e5f75a2d529f48897f
+  data.tar.gz: 8df8704e331f6484c83e004a14c7e885bb1fadd1
 SHA512:
-  metadata.gz: 19e7f4548e9b3d36560ce126b8bc3df6a95ac789d82a9bf811c00f88f9fae2f9b2c7dff248b73a8f70a1785471fde1dd28932486e13497cc9715270412431a25
-  data.tar.gz: 5893cb11c600e01bb7e999255696ce081a62389abd2d20ac5031131f03aa82f7d990e837c5dd3676d699391c99e6791a2bff7f03f0c153713e1926e45ae01972
+  metadata.gz: 48954718bc20698fbe55d2dd994f656d358fd34268aa559044cd1e5d00257b6d2a3983ec146cb6b2f3be8e1cb0ae63fc3b9ccc37c662416687a191df39adf216
+  data.tar.gz: cf36a4710fbe3bc24b91f4991f6f80fb046bd143b4fa8304878da13bb979610ca9cb9d435eac945a63e37fa43acbb40bbfb3f91edad138ebb0ba21107e6ad68a

data/lib/guard.rb

@@ -133,9 +133,6 @@ module Guard
       evaluator = Guardfile::Evaluator.new(options)
       evaluator.evaluate
 
-      # TODO: remove this workaround when options are removed
-      state.session.clearing(state.session.options[:clear])
-
       UI.reset_and_clear
 
       msg = "No plugins found in Guardfile, please add at least one."

data/lib/guard/aruba_adapter.rb

@@ -11,7 +11,7 @@ module Guard
       @kernel = kernel
 
       if ENV["INSIDE_ARUBA_TEST"] == "1"
-        ::Guard::UI.options = ::Guard::UI.options.merge(flush_seconds: 0)
+        UI.options = UI.options.merge(flush_seconds: 0)
       end
     end
 
@@ -29,7 +29,7 @@ module Guard
       $stdout = @stdout
 
       # Run our normal Thor app the way we know and love.
-      ::Guard::CLI.start(@argv)
+      CLI.start(@argv)
 
       # Thor::Base#start does not have a return value, assume
       # success if no exception is raised.
@@ -45,10 +45,10 @@ module Guard
       e.status
     ensure
       # flush the logger so the output doesn't appear in next CLI invocation
-      ::Guard.listener.stop if ::Guard.listener
-      ::Guard::UI.logger.flush
-      ::Guard::UI.logger.close
-      ::Guard::UI.reset_logger
+      Guard.listener.stop if Guard.listener
+      UI.logger.flush
+      UI.logger.close
+      UI.reset_logger
 
       # ...then we put them back.
       $stderr = STDERR

data/lib/guard/cli.rb

@@ -96,6 +96,11 @@ module Guard
                   banner:  "Specify a network address to Listen on for "\
                   "file change events (e.g. for use in VMs)"
 
+    def self.help(shell, subcommand = false)
+      super
+      command_help(shell, default_task)
+    end
+
     # Start Guard by initializing the defined Guard plugins and watch the file
     # system.
     #

data/lib/guard/commander.rb

@@ -79,7 +79,7 @@ module Guard
     def run_all(scopes = {})
       UI.clear(force: true)
       UI.action_with_scopes("Run", scopes)
-      Guard::Runner.new.run(:run_all, scopes)
+      Runner.new.run(:run_all, scopes)
     end
 
     # Pause Guard listening to file changes.

data/lib/guard/commands/all.rb

@@ -21,14 +21,14 @@ module Guard
           BANNER
 
           def process(*entries)
-            scopes, unknown = ::Guard.state.session.convert_scope(entries)
+            scopes, unknown = Guard.state.session.convert_scope(entries)
 
             unless unknown.empty?
               output.puts "Unknown scopes: #{ unknown.join(", ") }"
               return
             end
 
-            ::Guard.async_queue_add([:guard_run_all, scopes])
+            Guard.async_queue_add([:guard_run_all, scopes])
           end
         end
       end

data/lib/guard/commands/notification.rb

@@ -17,7 +17,7 @@ module Guard
           BANNER
 
           def process
-            ::Guard::Notifier.toggle
+            Notifier.toggle
           end
         end
       end

data/lib/guard/commands/reload.rb

@@ -20,14 +20,14 @@ module Guard
           BANNER
 
           def process(*entries)
-            scopes, unknown = ::Guard.state.session.convert_scope(entries)
+            scopes, unknown = Guard.state.session.convert_scope(entries)
 
             unless unknown.empty?
               output.puts "Unknown scopes: #{ unknown.join(", ") }"
               return
             end
 
-            ::Guard.async_queue_add([:guard_reload, scopes])
+            Guard.async_queue_add([:guard_reload, scopes])
           end
         end
       end

data/lib/guard/commands/show.rb

@@ -15,7 +15,7 @@ module Guard
           BANNER
 
           def process
-            ::Guard.async_queue_add([:guard_show])
+            Guard.async_queue_add([:guard_show])
           end
         end
       end

data/lib/guard/deprecated/evaluator.rb

@@ -18,6 +18,9 @@ module Guard
       REEVALUATE_GUARDFILE = <<-EOS.gsub(/^\s*/, "")
         Starting with Guard 2.8.3 'Guard::Evaluator#reevaluate_guardfile' is
         deprecated in favor of '#reevaluate'.
+
+        NOTE: this method no longer does anything since it could not be
+        implemented reliably.
       EOS
 
       def evaluate_guardfile
@@ -30,7 +33,6 @@ module Guard
         # guard's deprecations require us
         require "guard"
         UI.deprecation(REEVALUATE_GUARDFILE)
-        ::Guard.state.reset_session { evaluate }
       end
     end
   end

data/lib/guard/deprecated/guard.rb

@@ -30,7 +30,7 @@ module Guard
 
           Please use 'Guard.plugins(filter)' instead.
 
-            #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods"}
+        #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods"}
         EOS
 
         def guards(filter = nil)
@@ -192,7 +192,62 @@ module Guard
 
         def options
           UI.deprecation(OPTIONS)
-          ::Guard.state.session.options
+
+          Class.new(Hash) do
+            def initialize
+              super(to_hash)
+            end
+
+            def to_hash
+              session = ::Guard.state.session
+              {
+                clear: session.clearing?,
+                debug: session.debug?,
+                watchdir: Array(session.watchdirs).map(&:to_s),
+                notify: session.notify_options[:notify],
+                no_interactions: (session.interactor_name == :sleep)
+              }
+            end
+
+            def to_a
+              to_hash.to_a
+            end
+
+            def fetch(key, *args)
+              hash = to_hash
+              verify_key!(hash, key)
+              hash.fetch(key, *args)
+            end
+
+            def []=(key, value)
+              case key
+              when :clear
+                ::Guard.state.session.clearing(value)
+              else
+                msg = "Oops! Guard.option[%s]= is unhandled or unsupported." \
+                  "Please file an issue if you rely on this option working."
+                fail NotImplementedError, format(msg, key)
+              end
+            end
+
+            def keys
+              to_hash.keys
+            end
+
+            def include?(value)
+              keys.include? value
+            end
+
+            private
+
+            def verify_key!(hash, key)
+              return if hash.key?(key)
+              msg = "Oops! Guard.option[%s] is unhandled or unsupported." \
+                "Please file an issue if you rely on this option working."
+              fail NotImplementedError, format(msg, key)
+            end
+
+          end.new
         end
 
         ADD_GROUP = <<-EOS.gsub(/^\s*/, "")

data/lib/guard/dsl.rb

@@ -72,9 +72,8 @@ module Guard
     #
     # @see Guard::Notifier for available notifier and its options.
     #
-    def notification(notifier, options = {})
-      # TODO: remove dependency on Notifier (let session handle this)
-      Notifier.add(notifier.to_sym, options.merge(silent: false))
+    def notification(notifier, opts = {})
+      Guard.state.session.guardfile_notification = { notifier.to_sym => opts }
     end
 
     # Sets the interactor options or disable the interactor.

data/lib/guard/dsl_describer.rb

@@ -107,22 +107,20 @@ module Guard
     # @see CLI#show
     #
     def notifiers
-      supported = ::Guard::Notifier::SUPPORTED
-      Notifier.connect(notify: false)
-      detected = Notifier.notifiers
+      supported = Notifier.supported
+      Notifier.connect(notify: true, silent: true)
+      detected = Notifier.detected
       Notifier.disconnect
 
-      merged_notifiers = supported.inject(:merge)
-      final_rows = merged_notifiers.each_with_object([]) do |definition, rows|
+      detected_names = detected.map { |item| item[:name] }
+
+      final_rows = supported.each_with_object([]) do |(name, _), rows|
+        available = detected_names.include?(name) ? "✔" : "✘"
 
-        name      = definition[0]
-        clazz     = definition[1]
-        available = clazz.available?(silent: true) ? "✔" : "✘"
         notifier  = detected.detect { |n| n[:name] == name }
         used      = notifier ? "✔" : "✘"
 
-        options = _merge_options(clazz, notifier)
-        options.delete(:silent)
+        options = notifier ? notifier[:options] : {}
 
         if options.empty?
           rows << :split
@@ -149,16 +147,6 @@ module Guard
 
     private
 
-    def _merge_options(klass, notifier)
-      notify_options = notifier ? notifier[:options] : {}
-
-      if klass.const_defined?(:DEFAULTS)
-        klass.const_get(:DEFAULTS).merge(notify_options)
-      else
-        notify_options
-      end
-    end
-
     def _add_row(rows, name, available, used, option, value)
       rows << {
         Name: name,

data/lib/guard/guardfile/evaluator.rb

@@ -141,7 +141,7 @@ module Guard
       def _instance_eval_guardfile(contents)
         Dsl.new.evaluate(contents, @guardfile_path || "", 1)
       rescue => ex
-        ::Guard::UI.error "Invalid Guardfile, original error is:\n#{ $! }"
+        UI.error "Invalid Guardfile, original error is:\n#{ $! }"
         raise ex
       end
 
@@ -163,7 +163,7 @@ module Guard
         @source   = :inline
         @guardfile_contents = options[:guardfile_contents]
 
-        ::Guard::UI.info "Using inline Guardfile."
+        UI.info "Using inline Guardfile."
         true
       end
 
@@ -193,9 +193,9 @@ module Guard
       rescue Errno::ENOENT
         fail
       rescue SystemCallError => e
-        ::Guard::UI.error "Error reading file #{full_path}:"
-        ::Guard::UI.error e.inspect
-        ::Guard::UI.error e.backtrace
+        UI.error "Error reading file #{full_path}:"
+        UI.error e.inspect
+        UI.error e.backtrace
         abort
       end
 

data/lib/guard/guardfile/generator.rb

@@ -64,7 +64,7 @@ module Guard
       def initialize_template(plugin_name)
         guardfile = Pathname("Guardfile")
 
-        plugin_util = ::Guard::PluginUtil.new(plugin_name)
+        plugin_util = PluginUtil.new(plugin_name)
         # TODO: change to "valid?" method
         if plugin_util.plugin_class(fail_gracefully: true)
           plugin_util.add_to_guardfile
@@ -91,13 +91,13 @@ module Guard
       # @see Guard::CLI#init
       #
       def initialize_all_templates
-        ::Guard::PluginUtil.plugin_names.each { |g| initialize_template(g) }
+        PluginUtil.plugin_names.each { |g| initialize_template(g) }
       end
 
       private
 
       def _ui(*args)
-        ::Guard::UI.send(*args)
+        UI.send(*args)
       end
     end
   end

data/lib/guard/internals/debugging.rb

@@ -28,7 +28,7 @@ module Guard
 
           Thread.abort_on_exception = true
 
-          ::Guard::UI.level = Logger::DEBUG
+          UI.level = Logger::DEBUG
 
           TRACES.each { |mod, meth| _trace(mod, meth, &method(:_notify)) }
           @traced = true
@@ -36,14 +36,14 @@ module Guard
 
         def stop
           return unless @started ||= false
-          ::Guard::UI.level = Logger::INFO
+          UI.level = Logger::INFO
           _reset
         end
 
         private
 
         def _notify(*args)
-          ::Guard::UI.debug "Command execution: #{args.join(" ")}"
+          UI.debug "Command execution: #{args.join(" ")}"
         end
 
         # reset singleton - called by tests
@@ -55,11 +55,11 @@ module Guard
         end
 
         def _trace(mod, meth, &block)
-          ::Guard::Internals::Tracing.trace(mod, meth, &block)
+          Tracing.trace(mod, meth, &block)
         end
 
         def _untrace(mod, meth)
-          ::Guard::Internals::Tracing.untrace(mod, meth)
+          Tracing.untrace(mod, meth)
         end
       end
     end

data/lib/guard/internals/session.rb

@@ -9,7 +9,6 @@ module Guard
     # TODO: split into a commandline class and session (plugins, groups)
     # TODO: swap session and metadata
     class Session
-      attr_reader :options
       attr_reader :plugins
       attr_reader :groups
 
@@ -68,6 +67,8 @@ module Guard
         @guardfile_group_scope = []
         @guardfile_ignore = []
         @guardfile_ignore_bang = []
+
+        @guardfile_notifier_options = {}
       end
 
       def guardfile_scope(scope)
@@ -120,12 +121,12 @@ module Guard
       end
 
       def listener_args
-        if options[:listen_on]
-          [:on, options[:listen_on]]
+        if @options[:listen_on]
+          [:on, @options[:listen_on]]
         else
           listener_options = {}
           [:latency, :force_polling, :wait_for_delay].each do |option|
-            listener_options[option] = options[option] if options[option]
+            listener_options[option] = @options[option] if @options[option]
           end
           expanded_watchdirs = watchdirs.map { |dir| File.expand_path dir }
           [:to, *expanded_watchdirs, listener_options]
@@ -133,16 +134,26 @@ module Guard
       end
 
       def evaluator_options
-        opts = { guardfile: options[:guardfile] }
+        opts = { guardfile: @options[:guardfile] }
         # TODO: deprecate :guardfile_contents
-        if options[:guardfile_contents]
-          opts[:contents] = options[:guardfile_contents]
+        if @options[:guardfile_contents]
+          opts[:contents] = @options[:guardfile_contents]
         end
         opts
       end
 
       def notify_options
-        { notify: @options[:notify] }
+        names = @guardfile_notifier_options.keys
+        return { notify: false } if names.include?(:off)
+
+        {
+          notify: @options[:notify],
+          notifiers: @guardfile_notifier_options
+        }
+      end
+
+      def guardfile_notification=(config)
+        @guardfile_notifier_options.merge!(config)
       end
 
       def interactor_name

data/lib/guard/internals/state.rb

@@ -20,19 +20,6 @@ module Guard
 
       attr_reader :scope
       attr_reader :session
-
-      # @private api
-      # TODO: REMOVE!
-      def reset_session(&block)
-        Runner.new.run(:stop)
-        Notifier.disconnect
-        options = @session.options.dup
-        @session = Session.new(options)
-        block.call
-        Runner.new.run(:start)
-      ensure
-        Notifier.connect(session.notify_options)
-      end
     end
   end
 end