guard 2.9.0 → 2.9.1

data/lib/guard/commands/all.rb

@@ -1,7 +1,6 @@
 # required for async_queue_add
 require "pry"
 
-# TODO: remove this dependency
 require "guard/interactor"
 require "guard"
 
@@ -23,7 +22,7 @@ module Guard
           BANNER
 
           def process(*entries)
-            scopes, unknown = ::Guard::Interactor.convert_scope(entries)
+            scopes, unknown = Interactor.convert_scope(entries)
 
             unless unknown.empty?
               output.puts "Unknown scopes: #{ unknown.join(", ") }"

data/lib/guard/commands/change.rb

@@ -1,6 +1,5 @@
 require "pry"
 
-# TODO: remove
 require "guard"
 
 module Guard
@@ -23,7 +22,7 @@ module Guard
               return
             end
 
-            ::Guard.async_queue_add(modified: files, added: [], removed: [])
+            Guard.async_queue_add(modified: files, added: [], removed: [])
           end
         end
       end

data/lib/guard/commands/reload.rb

@@ -1,6 +1,5 @@
 require "pry"
 
-# TODO: should not be necessary!
 require "guard/interactor"
 require "guard"
 
@@ -22,7 +21,7 @@ module Guard
           BANNER
 
           def process(*entries)
-            scopes, unknown = ::Guard::Interactor.convert_scope(entries)
+            scopes, unknown = Interactor.convert_scope(entries)
 
             unless unknown.empty?
               output.puts "Unknown scopes: #{ unknown.join(", ") }"

data/lib/guard/commands/scope.rb

@@ -29,8 +29,7 @@ module Guard
               return
             end
 
-            # TODO: provide a way for guard to know this was called from Pry
-            ::Guard.setup_scope(scope)
+            Guard.state.scope.from_interactor(scope)
           end
         end
       end

data/lib/guard/deprecated/evaluator.rb

@@ -0,0 +1,34 @@
+require "guard/config"
+fail "Deprecations disabled (strict mode)" if Guard::Config.new.strict?
+
+require "guard/ui"
+
+module Guard
+  module Deprecated
+    module Evaluator
+      def self.add_deprecated(klass)
+        klass.send(:include, self)
+      end
+
+      EVALUATE_GUARDFILE = <<-EOS.gsub(/^\s*/, "")
+        Starting with Guard 2.8.3 'Guard::Evaluator#evaluate_guardfile' is
+        deprecated in favor of '#evaluate'.
+      EOS
+
+      REEVALUATE_GUARDFILE = <<-EOS.gsub(/^\s*/, "")
+        Starting with Guard 2.8.3 'Guard::Evaluator#reevaluate_guardfile' is
+        deprecated in favor of '#reevaluate'.
+      EOS
+
+      def evaluate_guardfile
+        UI.deprecation(EVALUATE_GUARDFILE)
+        evaluate
+      end
+
+      def reevaluate_guardfile
+        UI.deprecation(REEVALUATE_GUARDFILE)
+        ::Guard::Reevaluator.new.reevaluate
+      end
+    end
+  end
+end

data/lib/guard/deprecated/guard.rb

@@ -138,10 +138,9 @@ module Guard
         EOS
 
         def evaluator
-          # TODO: probably deprecate once it isn't used internally
-          # TODO: this will be changed to the following when scope is reworked
           UI.deprecation(EVALUATOR)
-          ::Guard::Guardfile::Evaluator.new(::Guard.options)
+          options = ::Guard.state.session.evaluator_options
+          ::Guard::Guardfile::Evaluator.new(options)
         end
 
         RESET_EVALUATOR = <<-EOS.gsub(/^\s*/, "")
@@ -160,6 +159,19 @@ module Guard
           UI.deprecation(RUNNER)
           ::Guard::Runner.new
         end
+
+        EVALUATE_GUARDFILE = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.8.2 this method shouldn't be used
+        EOS
+
+        def evaluate_guardfile
+          UI.deprecation(EVALUATE_GUARDFILE)
+          options = ::Guard.state.session.evaluator_options
+          evaluator = ::Guard::Guardfile::Evaluator.new(options)
+          evaluator.evaluate
+          msg = "No plugins found in Guardfile, please add at least one."
+          ::Guard::UI.error msg if _pluginless_guardfile?
+        end
       end
     end
   end

data/lib/guard/deprecated/watcher.rb

@@ -0,0 +1,27 @@
+require "guard/config"
+fail "Deprecations disabled (strict mode)" if Guard::Config.new.strict?
+
+module Guard
+  module Deprecated
+    module Watcher
+      def self.add_deprecated(dsl_klass)
+        dsl_klass.send(:extend, ClassMethods)
+      end
+
+      module ClassMethods
+        MATCH_GUARDFILE = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.8.3 this method is deprecated.
+        EOS
+
+        def match_guardfile?(files)
+          require "guard/guardfile/evaluator"
+          UI.deprecation(MATCH_GUARDFILE)
+          options = ::Guard.state.session.evaluator_options
+          evaluator = ::Guard::Guardfile::Evaluator.new(options)
+          path = evaluator.guardfile_path
+          files.any? { |file| File.expand_path(file) == path }
+        end
+      end
+    end
+  end
+end

data/lib/guard/dsl.rb

@@ -26,10 +26,10 @@ module Guard
   # {Notifier} for more information about the supported libraries.
   #
   # A more advanced DSL use is the {#callback} keyword that allows you to
-  # execute arbitrary code before or after any of the {Plugin::Base#start},
-  # {Plugin::Base#stop}, {Plugin::Base#reload}, {Plugin::Base#run_all},
-  # {Plugin::Base#run_on_changes}, {Plugin::Base#run_on_additions},
-  # {Plugin::Base#run_on_modifications} and {Plugin::Base#run_on_removals}
+  # execute arbitrary code before or after any of the {Plugin#start},
+  # {Plugin#stop}, {Plugin#reload}, {Plugin#run_all},
+  # {Plugin#run_on_changes}, {Plugin#run_on_additions},
+  # {Plugin#run_on_modifications} and {Plugin#run_on_removals}
   # Guard plugins method.
   # You can even insert more hooks inside these methods. Please [checkout the
   # Wiki page](https://github.com/guard/guard/wiki/Hooks-and-callbacks) for
@@ -50,6 +50,10 @@ module Guard
   class Dsl
     Deprecated::Dsl.add_deprecated(self) unless Config.new.strict?
 
+    # Wrap exceptions during parsing Guardfile
+    class Error < RuntimeError
+    end
+
     WARN_INVALID_LOG_LEVEL = "Invalid log level `%s` ignored. "\
       "Please use either :debug, :info, :warn or :error."
 
@@ -88,9 +92,9 @@ module Guard
     def interactor(options)
       case options
       when :off
-        ::Guard::Interactor.enabled = false
+        Interactor.enabled = false
       when Hash
-        ::Guard::Interactor.options = options
+        Interactor.options = options
       end
     end
 
@@ -128,7 +132,7 @@ module Guard
 
       if block_given?
         groups.each do |group|
-          ::Guard.add_group(group, options)
+          Guard.state.session.groups.add(group, options)
         end
 
         @current_groups ||= []
@@ -138,7 +142,7 @@ module Guard
 
         @current_groups.pop
       else
-        ::Guard::UI.error \
+        UI.error \
           "No Guard plugins found in the group '#{ groups.join(", ") }',"\
           " please add at least one."
       end
@@ -176,7 +180,8 @@ module Guard
       @current_groups ||= []
       groups = @current_groups && @current_groups.last || [:default]
       groups.each do |group|
-        ::Guard.add_plugin(name, @plugin_options.merge(group: group))
+        opts = @plugin_options.merge(group: group)
+        Guard.state.session.plugins.add(name, opts)
       end
 
       @plugin_options = nil
@@ -214,7 +219,7 @@ module Guard
       @plugin_options ||= nil
       return guard(:plugin) { watch(pattern, &action) } unless @plugin_options
 
-      @plugin_options[:watchers] << ::Guard::Watcher.new(pattern, action)
+      @plugin_options[:watchers] << Watcher.new(pattern, action)
     end
 
     # Defines a callback to execute arbitrary code before or after any of
@@ -237,8 +242,6 @@ module Guard
     # @param [Array] args the callback arguments
     # @yield a callback block
     #
-    # @see Guard::Hooker
-    #
     def callback(*args, &block)
       @plugin_options ||= nil
       fail "callback must be called within a guard block" unless @plugin_options
@@ -262,8 +265,10 @@ module Guard
     #
     def ignore(*regexps)
       # TODO: instead, use Guard.reconfigure(ignore: regexps) or something
-      ::Guard.listener.ignore(regexps) if ::Guard.listener
+      Guard.listener.ignore(regexps) if Guard.listener
     end
+
+    # TODO: deprecate
     alias filter ignore
 
     # Replaces ignored paths globally
@@ -276,7 +281,7 @@ module Guard
     def ignore!(*regexps)
       @ignore_regexps ||= []
       @ignore_regexps << regexps
-      ::Guard.listener.ignore!(@ignore_regexps) if ::Guard.listener
+      Guard.listener.ignore!(@ignore_regexps) if Guard.listener
     end
     alias filter! ignore!
 
@@ -341,7 +346,7 @@ module Guard
         options[name] = Regexp.new(list.join("|"), Regexp::IGNORECASE)
       end
 
-      ::Guard::UI.options.merge!(options)
+      UI.options.merge!(options)
     end
 
     # Sets the default scope on startup
@@ -361,7 +366,43 @@ module Guard
     # @param [Hash] scopes the scope for the groups and plugins
     #
     def scope(scope = {})
-      ::Guard.setup_scope(scope)
+      Guard.state.session.guardfile_scope(scope)
+    end
+
+    def evaluate(contents, filename, lineno) # :nodoc
+      instance_eval(contents, filename.to_s, lineno)
+    rescue StandardError, ScriptError => e
+      prefix = "\n\t(dsl)> "
+      cleaned_backtrace = _cleanup_backtrace(e.backtrace)
+      backtrace = "#{prefix}#{cleaned_backtrace.join(prefix)}"
+      msg = "Invalid Guardfile, original error is: \n\n%s, \nbacktrace: %s"
+      raise Error, format(msg, e, backtrace)
+    end
+
+    private
+
+    def _cleanup_backtrace(backtrace)
+      dirs = { File.realpath(Dir.pwd) => ".", }
+
+      gem_env = ENV["GEM_HOME"] || ""
+      dirs[gem_env] = "$GEM_HOME" unless gem_env.empty?
+
+      gem_paths = (ENV["GEM_PATH"] || "").split(File::PATH_SEPARATOR)
+      gem_paths.each_with_index do |path, index|
+        dirs[path] = "$GEM_PATH[#{index}]"
+      end
+
+      backtrace.dup.map do |raw_line|
+        path = nil
+        symlinked_path = raw_line.split(":").first
+        begin
+          path = raw_line.sub(symlinked_path, File.realpath(symlinked_path))
+          dirs.detect { |dir, name| path.sub!(File.realpath(dir), name) }
+          path
+        rescue Errno::ENOENT
+          path || symlinked_path
+        end
+      end
     end
 
     # Sets the directories to pass to Listen
@@ -375,7 +416,7 @@ module Guard
       directories.each do |dir|
         fail "Directory #{dir.inspect} does not exist!" unless Dir.exist?(dir)
       end
-      ::Guard.watchdirs = directories
+      Guard.state.session.watchdirs = directories
     end
   end
 end

data/lib/guard/dsl_describer.rb

@@ -1,9 +1,11 @@
 # encoding: utf-8
 require "formatador"
 
-require "guard/guardfile/evaluator"
 require "guard/ui"
-require "guard/metadata"
+require "guard/notifier"
+
+require "set"
+require "ostruct"
 
 module Guard
   # The DslDescriber evaluates the Guardfile and creates an internal structure
@@ -14,20 +16,8 @@ module Guard
   # @see Guard::CLI
   #
   class DslDescriber
-    # Initializes a new DslDescriber object.
-    #
-    # @option options [String] guardfile the path to a valid Guardfile
-    #
-    # @option options [String] guardfile_contents a string representing the
-    # content of a valid Guardfile
-    #
-    # @see Guard::Guardfile::Evaluator#initialize
-    #
-    def initialize(options = {})
-      ::Guard.reset_groups
-      ::Guard.reset_plugins
-      ::Guard.reset_scope
-      ::Guard.reset_options(options)
+    def initialize(options = nil)
+      fail "options passed to DslDescriber are ignored!" unless options.nil?
     end
 
     # List the Guard plugins that are available for use in your system and marks
@@ -36,17 +26,21 @@ module Guard
     # @see CLI#list
     #
     def list
-      _evaluate_guardfile
-      names = ::Guard::PluginUtil.plugin_names.sort.uniq
-      final_rows = names.inject([]) do |rows, name|
-        used = ::Guard.plugins(name).any?
-        rows << {
-          Plugin: name.capitalize,
-          Guardfile: used ? "✔" : "✘"
-        }
+      # collect metadata
+      data = PluginUtil.plugin_names.sort.inject({}) do |hash, name|
+        hash[name.capitalize] = Guard.state.session.plugins.all(name).any?
+        hash
+      end
+
+      # presentation
+      header = [:Plugin, :Guardfile]
+      final_rows = []
+      data.each do |name, used|
+        final_rows << { Plugin: name, Guardfile: used ? "✔" : "✘" }
       end
 
-      Formatador.display_compact_table(final_rows, [:Plugin, :Guardfile])
+      # render
+      Formatador.display_compact_table(final_rows, header)
     end
 
     # Shows all Guard plugins and their options that are defined in
@@ -55,53 +49,52 @@ module Guard
     # @see CLI#show
     #
     def show
-      _evaluate_guardfile
-      groups = ::Guard.groups
+      # collect metadata
+      groups = Guard.state.session.groups.all
 
-      final_rows = groups.each_with_object([]) do |group, rows|
+      objects = []
 
-        plugins = Array(::Guard.plugins(group: group.name))
+      empty_plugin = OpenStruct.new
+      empty_plugin.options = [["", nil]]
 
+      groups.each do |group|
+        plugins = Array(Guard.state.session.plugins.all(group: group.name))
+        plugins = [empty_plugin] if plugins.empty?
         plugins.each do |plugin|
-          options = plugin.options.inject({}) do |o, (k, v)|
-            o.tap { |option| option[k.to_s] = v }
-          end.sort
-
-          if options.empty?
-            rows << :split
-            rows << {
-              Group: group.title,
-              Plugin: plugin.title,
-              Option: "",
-              Value: ""
-            }
-          else
-            options.each_with_index do |(option, value), index|
-              if index == 0
-                rows << :split
-                rows << {
-                  Group: group.title,
-                  Plugin: plugin.title,
-                  Option: option.to_s,
-                  Value: value.inspect
-                }
-              else
-                rows << {
-                  Group: "",
-                  Plugin: "",
-                  Option: option.to_s,
-                  Value: value.inspect
-                }
-              end
-            end
+          options = plugin.options
+          options = [["", nil]] if options.empty?
+          options.each do |option, raw_value|
+            value = raw_value.nil? ? "" : raw_value.inspect
+            objects << [group.title, plugin.title, option.to_s, value]
           end
         end
+      end
 
-        rows
+      # presentation
+      rows = []
+      prev_group = prev_plugin = prev_option = prev_value = nil
+      objects.each do |group, plugin, option, value|
+        group_changed = prev_group != group
+        plugin_changed = (prev_plugin != plugin || group_changed)
+
+        rows << :split if group_changed || plugin_changed
+
+        rows << {
+          Group: group_changed ? group : "",
+          Plugin: plugin_changed ? plugin : "",
+          Option: option,
+          Value: value
+        }
+
+        prev_group = group
+        prev_plugin = plugin
+        prev_option = option
+        prev_value = value
       end
 
+      # render
       Formatador.display_compact_table(
-        final_rows.drop(1),
+        rows.drop(1),
         [:Group, :Plugin, :Option, :Value]
       )
     end
@@ -112,8 +105,6 @@ module Guard
     # @see CLI#show
     #
     def notifiers
-      _evaluate_guardfile
-
       supported = ::Guard::Notifier::SUPPORTED
       Notifier.connect(notify: false)
       detected = Notifier.notifiers
@@ -156,15 +147,6 @@ module Guard
 
     private
 
-    # Evaluates the `Guardfile` by delegating to
-    #   {Guard::Guardfile::Evaluator#evaluate_guardfile}.
-    #
-    def _evaluate_guardfile
-      ::Guard.save_scope
-      ::Guard::Guardfile::Evaluator.new(::Guard.options).evaluate_guardfile
-      ::Guard.restore_scope
-    end
-
     def _merge_options(klass, notifier)
       notify_options = notifier ? notifier[:options] : {}