guard 2.8.2 → 2.9.0

data/lib/guard/dsl_describer.rb

@@ -3,6 +3,7 @@ require "formatador"
 
 require "guard/guardfile/evaluator"
 require "guard/ui"
+require "guard/metadata"
 
 module Guard
   # The DslDescriber evaluates the Guardfile and creates an internal structure
@@ -113,13 +114,18 @@ module Guard
     def notifiers
       _evaluate_guardfile
 
-      merged_notifiers = ::Guard::Notifier::NOTIFIERS.inject(:merge)
+      supported = ::Guard::Notifier::SUPPORTED
+      Notifier.connect(notify: false)
+      detected = Notifier.notifiers
+      Notifier.disconnect
+
+      merged_notifiers = supported.inject(:merge)
       final_rows = merged_notifiers.each_with_object([]) do |definition, rows|
 
         name      = definition[0]
         clazz     = definition[1]
         available = clazz.available?(silent: true) ? "✔" : "✘"
-        notifier  = ::Guard::Notifier.notifiers.detect { |n| n[:name] == name }
+        notifier  = detected.detect { |n| n[:name] == name }
         used      = notifier ? "✔" : "✘"
 
         options = _merge_options(clazz, notifier)

data/lib/guard/dsl_describer.rb.orig

@@ -3,6 +3,7 @@ require "formatador"
 
 require "guard/guardfile/evaluator"
 require "guard/ui"
+require "guard/metadata"
 
 module Guard
   # The DslDescriber evaluates the Guardfile and creates an internal structure
@@ -35,11 +36,13 @@ 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: ::Guard.plugins(name) ? "✔" : "✘"
+          Guardfile: used ? "✔" : "✘"
         }
       end
 
@@ -111,13 +114,18 @@ module Guard
     def notifiers
       _evaluate_guardfile
 
-      merged_notifiers = ::Guard::Notifier::NOTIFIERS.inject(:merge)
+      supported = ::Guard::Notifier::SUPPORTED
+      Notifier.connect
+      detected = Notifier.notifiers
+      Notifier.disconnect
+
+      merged_notifiers = supported.inject(:merge)
       final_rows = merged_notifiers.each_with_object([]) do |definition, rows|
 
         name      = definition[0]
         clazz     = definition[1]
         available = clazz.available?(silent: true) ? "✔" : "✘"
-        notifier  = ::Guard::Notifier.notifiers.detect { |n| n[:name] == name }
+        notifier  = detected.detect { |n| n[:name] == name }
         used      = notifier ? "✔" : "✘"
 
         options = _merge_options(clazz, notifier)

data/lib/guard/guardfile.rb

@@ -1,49 +1,37 @@
-require "guard/guardfile/evaluator"
-require "guard/guardfile/generator"
-require "guard/ui"
-
-module Guard
-  # @deprecated Use instance methods of {Guardfile::Evaluator} and
-  #  {Guardfile::Generator} instead.
-  #
-  # @see Guardfile::Evaluator
-  # @see Guardfile::Generator
-  #
-  module Guardfile
-    # @deprecated Use {Guardfile::Generator#create_guardfile} instead.
-    #
-    # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
-    # upgrade for Guard 2.0
-    #
-    def self.create_guardfile(options = {})
-      # FIXME: used internally by Guard
-      # TODO: reenable after majore refactoring is finished
-      # UI.deprecation(Deprecator::CREATE_GUARDFILE_DEPRECATION)
-      Generator.new(options).create_guardfile
-    end
+require "guard/config"
 
-    # @deprecated Use {Guardfile::Generator#initialize_template} instead.
-    #
-    # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
-    # upgrade for Guard 2.0
-    #
-    def self.initialize_template(plugin_name)
-      # FIXME: used internally by Guard
-      # TODO: reenable after majore refactoring is finished
-      # UI.deprecation(Deprecator::INITIALIZE_TEMPLATE_DEPRECATION)
-      Generator.new.initialize_template(plugin_name)
-    end
+if Guard::Config.new.strict?
+  abort "Error: Deprecated file #{__FILE__} is being used"
+else
+  require "guard/deprecated/guardfile"
+
+  # TODO: deprecate this whole file
+
+  module Guard
+    unless Guard::Config.new.silence_deprecations?
+      UPGRADE_WIKI_URL =
+        "https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0"
+
+      STDERR.puts <<-EOS
+        (guard/guardfile.rb message)
+
+        You are including "guard/guardfile.rb", which has been deprecated
+        since 2013 ... and will be removed.
 
-    # @deprecated Use {Guardfile::Generator#initialize_all_templates} instead.
-    #
-    # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
-    # upgrade for Guard 2.0
-    #
-    def self.initialize_all_templates
-      # FIXME: used internally by Guard
-      # TODO: reenable after majore refactoring is finished
-      # UI.deprecation(Deprecator::INITIALIZE_ALL_TEMPLATES_DEPRECATION)
-      Generator.new.initialize_all_templates
+        Migration is easy, see: #{UPGRADE_WIKI_URL}
+
+        This file was included from:
+          #{caller[0..10] * "\n  >"}
+
+        Sorry for the inconvenience and have a nice day!
+
+        (end of guard/guardfile.rb message)
+
+
+      EOS
+    end
+    module Guardfile
+      extend Deprecated::Guardfile::ClassMethods
     end
   end
 end

data/lib/guard/guardfile/evaluator.rb

@@ -1,6 +1,13 @@
+require "guard/config"
 require "guard/options"
 require "guard/plugin"
 
+# TODO: this class shouldn't use notify directly
+require "guard/notifier"
+
+require "guard/dsl"
+require "guard/metadata"
+
 module Guard
   module Guardfile
     # This class is responsible for evaluating the Guardfile. It delegates to
@@ -52,7 +59,7 @@ module Guard
       def evaluate_guardfile
         _fetch_guardfile_contents
         _instance_eval_guardfile(guardfile_contents)
-        ::Guard.add_builtin_plugins(guardfile_path)
+        Guard.add_builtin_plugins(guardfile_path)
       end
 
       # Re-evaluates the `Guardfile` to update
@@ -211,20 +218,20 @@ module Guard
       # before the Guardfile will be re-evaluated.
       #
       def _before_reevaluate_guardfile
-        ::Guard.runner.run(:stop)
+        Guard::Runner.new.run(:stop)
         ::Guard.reset_groups
         ::Guard.reset_plugins
         ::Guard.reset_scope
-        ::Guard::Notifier.clear_notifiers
+        ::Guard::Notifier.disconnect
       end
 
       # Starts Guard and notification and show a message
       # after the Guardfile has been re-evaluated.
       #
       def _after_reevaluate_guardfile
-        ::Guard::Notifier.turn_on if ::Guard::Notifier.enabled?
+        ::Guard::Notifier.connect(::Guard.options)
 
-        if !::Guard.send(:_pluginless_guardfile?)
+        if ::Guard.send(:_pluginless_guardfile?)
           ::Guard::Notifier.notify(
             "No plugins found in Guardfile, please add at least one.",
             title: "Guard re-evaluate",
@@ -235,7 +242,7 @@ module Guard
           ::Guard::Notifier.notify(msg, title: "Guard re-evaluate")
 
           ::Guard.setup_scope
-          ::Guard.runner.run(:start)
+          Guard::Runner.new.run(:start)
         end
       end
 

data/lib/guard/guardfile/generator.rb

@@ -1,3 +1,6 @@
+require "guard/ui"
+require "guard/plugin_util"
+
 module Guard
   module Guardfile
     # This class is responsible for generating the Guardfile and adding Guard'
@@ -6,9 +9,6 @@ module Guard
     # @see Guard::CLI
     #
     class Generator
-      require "guard"
-      require "guard/ui"
-
       attr_reader :options
 
       # The Guardfile template for `guard init`
@@ -59,6 +59,7 @@ module Guard
       #
       def initialize_template(plugin_name)
         plugin_util = ::Guard::PluginUtil.new(plugin_name)
+        # TODO: change to "plugin_class?" method
         if plugin_util.plugin_class(fail_gracefully: true)
           plugin_util.add_to_guardfile
 

data/lib/guard/interactor.rb

@@ -1,8 +1,5 @@
 require "guard/ui"
 
-require "guard/jobs/sleep"
-require "guard/jobs/pry_wrapper"
-
 module Guard
   class Interactor
     # Initializes the interactor. This configures
@@ -12,6 +9,10 @@ module Guard
     def initialize(no_interaction = false)
       @interactive = !no_interaction && self.class.enabled?
 
+      # TODO: only require the one used
+      require "guard/jobs/sleep"
+      require "guard/jobs/pry_wrapper"
+
       job_klass = interactive? ? Jobs::PryWrapper : Jobs::Sleep
       @idle_job = job_klass.new(self.class.options)
     end
@@ -34,6 +35,9 @@ module Guard
       idle_job.handle_interrupt
     end
 
+    # TODO: everything below is just so the DSL can set options
+    # before setup() is called, which makes it useless for when
+    # Guardfile is reevaluated
     class << self
       def options
         @options ||= {}

data/lib/guard/internals/debugging.rb

@@ -1,5 +1,6 @@
 # Because it's used by Sheller
 require "open3"
+require "logger"
 
 require "guard/ui"
 

data/lib/guard/internals/environment.rb

@@ -0,0 +1,93 @@
+module Guard
+  # @private api
+  module Internals
+    class Environment
+      class Error < ArgumentError
+      end
+
+      class MethodError < Error
+        def initialize(meth)
+          @meth = meth
+        end
+      end
+
+      class NoMethodError < MethodError
+        def message
+          format("No such method %s", @meth.inspect)
+        end
+      end
+
+      class AlreadyExistsError < MethodError
+        def message
+          format("Method %s already exists", @meth.inspect)
+        end
+      end
+
+      class Loader
+        def initialize(meth)
+          @bool = meth.to_s.end_with?("?")
+        end
+
+        def load(raw_value, &callback)
+          return callback.call(raw_value) if callback
+          @bool ? _to_bool(raw_value) : raw_value
+        end
+
+        private
+
+        def _to_bool(raw_value)
+          case raw_value
+          when nil
+            nil
+          when ""
+            fail ArgumentError, "Can't convert empty string into Bool"
+          when "0", "false"
+            false
+          else
+            true
+          end
+        end
+      end
+
+      class Dumper
+        def initialize
+        end
+
+        def dump(raw_value, &callback)
+          return callback.call(raw_value) if callback
+          raw_value.nil? ? nil : raw_value.to_s
+        end
+      end
+
+      def initialize(namespace)
+        @namespace = namespace
+        @methods = {}
+      end
+
+      def create_method(meth, &block)
+        fail AlreadyExistsError, meth if @methods.key?(meth)
+        @methods[meth] = block
+      end
+
+      def method_missing(*args)
+        meth, raw_value = *args
+        fail NoMethodError, meth unless @methods.key?(meth)
+
+        callback = @methods[meth]
+        env_name = format("%s_%s", @namespace, _sanitize(meth))
+
+        if args.size == 2
+          ENV[env_name] = Dumper.new.dump(raw_value, &callback)
+        else
+          Loader.new(meth).load(ENV[env_name], &callback)
+        end
+      end
+
+      private
+
+      def _sanitize(meth)
+        meth[/^([^=?]*)[=?]?$/, 1].upcase
+      end
+    end
+  end
+end

data/lib/guard/internals/helpers.rb

@@ -0,0 +1,13 @@
+module Guard
+  # @private api
+  module Internals
+    module Helpers
+      def _relative_pathname(path)
+        full_path = Pathname(path)
+        full_path.relative_path_from(Pathname.pwd)
+      rescue ArgumentError
+        full_path
+      end
+    end
+  end
+end

data/lib/guard/internals/traps.rb

@@ -0,0 +1,10 @@
+module Guard
+  module Internals
+    module Traps
+      def self.handle(signal, &block)
+        return unless Signal.list.key?(signal)
+        Signal.trap(signal, &block)
+      end
+    end
+  end
+end

data/lib/guard/jobs/pry_wrapper.rb

@@ -5,6 +5,7 @@ require "guard/commands/pause"
 require "guard/commands/reload"
 require "guard/commands/scope"
 require "guard/commands/show"
+require "guard/sheller"
 
 require "guard/jobs/base"
 
@@ -18,17 +19,17 @@ module Guard
 
       def restore
         return unless configurable? && @settings
-        ::Guard::Sheller.run("stty #{ @setting } 2>#{ DEV_NULL }")
+        ::Guard::Sheller.run("stty #{ @setting } 2>#{IO::NULL}")
       end
 
       def save
         return unless configurable?
-        @settings = ::Guard::Sheller.stdout("stty -g 2>#{ DEV_NULL }").chomp
+        @settings = ::Guard::Sheller.stdout("stty -g 2>#{IO::NULL}").chomp
       end
 
       def echo
         return unless configurable?
-        ::Guard::Sheller.run("stty echo 2>#{ DEV_NULL }")
+        ::Guard::Sheller.run("stty echo 2>#{IO::NULL}")
       end
 
       def configurable?

data/lib/guard/jobs/sleep.rb

@@ -1,9 +1,11 @@
 require "guard/jobs/base"
+require "guard/ui"
 
 module Guard
   module Jobs
     class Sleep < Base
       def foreground
+        # TODO: cleanup the namespace
         ::Guard::UI.debug "Guards jobs done. Sleeping..."
         sleep
         ::Guard::UI.debug "Sleep interrupted by events."

data/lib/guard/metadata.rb

@@ -0,0 +1,190 @@
+require "guard/group"
+
+require "guard/plugin_util"
+
+# TODO: should not be necessary
+require "guard/internals/helpers"
+
+module Guard
+  extend Internals::Helpers
+
+  # TODO: change to a normal class
+  class << self
+    DEFAULT_GROUPS = [:common, :default]
+
+    DEFAULT_OPTIONS = {
+      clear: false,
+      notify: true,
+      debug: false,
+      group: [],
+      plugin: [],
+      watchdir: nil,
+      guardfile: nil,
+      no_interactions: false,
+      no_bundler_warning: false,
+      latency: nil,
+      force_polling: false,
+      wait_for_delay: nil,
+      listen_on: nil
+    }
+
+    def add_group(name, options = {})
+      unless (group = group(name))
+        group = Group.new(name, options)
+        @groups << group
+      end
+
+      group
+    end
+
+    def group(filter)
+      groups(filter).first
+    end
+
+    def groups(filter = nil)
+      @groups ||= []
+
+      return @groups if filter.nil?
+
+      case filter
+      when String, Symbol
+        @groups.select { |group| group.name == filter.to_sym }
+      when Regexp
+        @groups.select { |group| group.name.to_s =~ filter }
+      else
+        fail "Invalid filter: #{filter.inspect}"
+      end
+    end
+
+    # TODO: remove
+    def _reset_for_tests
+      @options = nil
+      @queue = nil
+      @watchdirs = nil
+      @watchdirs = nil
+      @listener = nil
+      @interactor = nil
+      @scope = nil
+    end
+
+    # TODO: remove
+    def clear_options
+      @options = nil
+    end
+
+    # TODO: remove
+    def reset_groups
+      @groups = DEFAULT_GROUPS.map { |name| Group.new(name) }
+    end
+
+    # TODO: remove
+    def reset_plugins
+      @plugins = []
+    end
+
+    def plugins(filter = nil)
+      @plugins ||= []
+
+      return @plugins if filter.nil?
+
+      filtered_plugins = case filter
+                         when String, Symbol
+                           @plugins.select do |plugin|
+                             plugin.name == filter.to_s.downcase.gsub("-", "")
+                           end
+                         when Regexp
+                           @plugins.select do |plugin|
+                             plugin.name =~ filter
+                           end
+                         when Hash
+                           @plugins.select do |plugin|
+                             filter.all? do |k, v|
+                               case k
+                               when :name
+                                 plugin.name == v.to_s.downcase.gsub("-", "")
+                               when :group
+                                 plugin.group.name == v.to_sym
+                               end
+                             end
+                           end
+                         end
+
+      filtered_plugins
+    end
+
+    def scope
+      fail "::Guard.setup() not called" if @scope.nil?
+      @scope.dup.freeze
+    end
+
+    def plugin(filter)
+      plugins(filter).first
+    end
+
+    # Used by runner to remove a failed plugin
+    def remove_plugin(plugin)
+      # TODO: coverage/aruba
+      @plugins.delete(plugin)
+    end
+
+    # TODO: move elsewhere
+    def add_builtin_plugins(guardfile)
+      return unless guardfile
+
+      pattern = _relative_pathname(guardfile).to_s
+      watcher = ::Guard::Watcher.new(pattern)
+      ::Guard.add_plugin(:reevaluator, watchers: [watcher], group: :common)
+    end
+
+    def add_plugin(name, options = {})
+      instance = ::Guard::PluginUtil.new(name).initialize_plugin(options)
+      @plugins << instance
+      instance
+    end
+
+    def reset_scope
+      # calls Guard.scope=() to set the instance variable directly, as opposed
+      # to Guard.scope()
+      ::Guard.scope = { groups: [], plugins: [] }
+    end
+
+    # Called by Pry scope command
+
+    def scope=(new_scope)
+      @scope = new_scope
+      @scope.dup.freeze
+    end
+
+    # Used to merge CLI options with Setuper defaults
+    def reset_options(new_options)
+      @options = ::Guard::Options.new(new_options, DEFAULT_OPTIONS)
+    end
+
+    def save_scope
+      # This actually replaces scope from command line,
+      # so scope set by 'scope' Pry command will be reset
+      @saved_scope = _prepare_scope(::Guard.scope)
+    end
+
+    def restore_scope
+      ::Guard.setup_scope(@saved_scope || {})
+    end
+
+    private
+
+    def _prepare_scope(new_scope)
+      fail "Guard::setup() not called!" if options.nil?
+      {
+        plugins: _scope_names(new_scope, :plugin),
+        groups: _scope_names(new_scope, :group)
+      }
+    end
+
+    def _scope_names(new_scope, name)
+      items = Array(options[name])
+      items = Array(new_scope[:"#{name}s"] || new_scope[name]) if items.empty?
+      # Convert objects to names
+      items.map { |p| p.respond_to?(:name) ? p.name : p }
+    end
+  end
+end