guard 2.10.2 → 2.10.3

data/lib/guard/commands/scope.rb

@@ -17,7 +17,7 @@ module Guard
           BANNER
 
           def process(*entries)
-            scope, unknown = ::Guard::Interactor.convert_scope(entries)
+            scope, unknown = Guard.state.session.convert_scope(entries)
 
             unless unknown.empty?
               output.puts "Unknown scopes: #{unknown.join(",") }"

data/lib/guard/config.rb

@@ -1,24 +1,18 @@
-require "guard/internals/environment"
+require "nenv"
 
 module Guard
-  class Config
-    def strict?
-      _env.strict?
-    end
-
-    def silence_deprecations?
-    end
-
-    private
+  config_class = Nenv::Builder.build do
+    create_method(:strict?)
+    create_method(:gem_silence_deprecations?)
+  end
 
-    def _env
-      @env ||= _create_env
+  class Config < config_class
+    def initialize
+      super "guard"
     end
 
-    def _create_env
-      Internals::Environment.new("GUARD").tap do |env|
-        env.create_method(:strict?)
-      end
+    def silence_deprecations?
+      gem_silence_deprecations?
     end
   end
 end

data/lib/guard/deprecated/evaluator.rb

@@ -26,8 +26,11 @@ module Guard
       end
 
       def reevaluate_guardfile
+        # require guard only when needed, becuase
+        # guard's deprecations require us
+        require "guard"
         UI.deprecation(REEVALUATE_GUARDFILE)
-        ::Guard::Reevaluator.new.reevaluate
+        ::Guard.state.reset_session { evaluate }
       end
     end
   end

data/lib/guard/deprecated/guard.rb

@@ -2,7 +2,8 @@ require "guard/config"
 fail "Deprecations disabled (strict mode)" if Guard::Config.new.strict?
 
 require "guard/ui"
-require "guard/plugin_util"
+require "guard/internals/session"
+require "guard/internals/state"
 require "guard/guardfile/evaluator"
 
 module Guard
@@ -34,7 +35,7 @@ module Guard
 
         def guards(filter = nil)
           ::Guard::UI.deprecation(GUARDS)
-          plugins(filter)
+          ::Guard.state.session.plugins.all(filter)
         end
 
         # @deprecated Use `Guard.add_plugin(name, options = {})` instead.
@@ -133,6 +134,15 @@ module Guard
           UI.deprecation(LOCK)
         end
 
+        LISTENER_ASSIGN = <<-EOS.gsub(/^\s*/, "")
+          listener= should not be used
+        EOS
+
+        def listener=(_)
+          UI.deprecation(LISTENER_ASSIGN)
+          ::Guard.listener
+        end
+
         EVALUATOR = <<-EOS.gsub(/^\s*/, "")
           Starting with Guard 2.8.2 this method shouldn't be used
         EOS
@@ -184,6 +194,86 @@ module Guard
           UI.deprecation(OPTIONS)
           ::Guard.state.session.options
         end
+
+        ADD_GROUP = <<-EOS.gsub(/^\s*/, "")
+          add_group is deprecated since 2.10.0 in favor of
+          Guard.state.session.groups.add
+        EOS
+
+        def add_group(name, options = {})
+          UI.deprecation(ADD_GROUP)
+          ::Guard.state.session.groups.add(name, options)
+        end
+
+        ADD_PLUGIN = <<-EOS.gsub(/^\s*/, "")
+          add_plugin is deprecated since 2.10.0 in favor of
+          Guard.state.session.plugins.add
+        EOS
+
+        def add_plugin(name, options = {})
+          UI.deprecation(ADD_PLUGIN)
+          ::Guard.state.session.plugins.add(name, options)
+        end
+
+        GROUP = <<-EOS.gsub(/^\s*/, "")
+          group is deprecated since 2.10.0 in favor of
+          Guard.state.session.group.add(filter).first
+        EOS
+
+        def group(filter)
+          UI.deprecation(GROUP)
+          ::Guard.state.session.groups.all(filter).first
+        end
+
+        PLUGIN = <<-EOS.gsub(/^\s*/, "")
+          plugin is deprecated since 2.10.0 in favor of
+          Guard.state.session.group.add(filter).first
+        EOS
+
+        def plugin(filter)
+          UI.deprecation(PLUGIN)
+          ::Guard.state.session.plugins.all(filter).first
+        end
+
+        GROUPS = <<-EOS.gsub(/^\s*/, "")
+          group is deprecated since 2.10.0 in favor of
+          Guard.state.session.groups.all(filter)
+        EOS
+
+        def groups(filter)
+          UI.deprecation(GROUPS)
+          ::Guard.state.session.groups.all(filter)
+        end
+
+        PLUGINS = <<-EOS.gsub(/^\s*/, "")
+          plugins is deprecated since 2.10.0 in favor of
+          Guard.state.session.plugins.all(filter)
+        EOS
+
+        def plugins(filter)
+          UI.deprecation(PLUGINS)
+          ::Guard.state.session.plugins.all(filter)
+        end
+
+        SCOPE = <<-EOS.gsub(/^\s*/, "")
+          scope is deprecated since 2.10.0 in favor of
+          Guard.state.scope.to_hash
+        EOS
+
+        def scope
+          UI.deprecation(SCOPE)
+          ::Guard.state.scope.to_hash
+        end
+
+        SCOPE_ASSIGN = <<-EOS.gsub(/^\s*/, "")
+          scope= is deprecated since 2.10.0 in favor of
+          Guard.state.scope.to_hash
+        EOS
+
+        def scope=(scope)
+          UI.deprecation(SCOPE_ASSIGN)
+          ::Guard.state.scope.from_interactor(scope)
+        end
       end
     end
   end

data/lib/guard/dsl_describer.rb

@@ -3,6 +3,7 @@ require "formatador"
 
 require "guard/ui"
 require "guard/notifier"
+require "guard"
 
 require "set"
 require "ostruct"
@@ -26,6 +27,7 @@ module Guard
     # @see CLI#list
     #
     def list
+      # TODO: remove dependency on Guard in this whole file
       # collect metadata
       data = PluginUtil.plugin_names.sort.inject({}) do |hash, name|
         hash[name.capitalize] = Guard.state.session.plugins.all(name).any?

data/lib/guard/guardfile/evaluator.rb

@@ -1,12 +1,11 @@
 require "guard/config"
+require "guard/deprecated/evaluator" unless Guard::Config.new.strict?
 
 require "guard/options"
 require "guard/plugin"
 
 require "guard/dsl"
 
-require "guard/deprecated/evaluator" unless Guard::Config.new.strict?
-
 module Guard
   module Guardfile
     # This class is responsible for evaluating the Guardfile. It delegates to

data/lib/guard/interactor.rb

@@ -1,5 +1,3 @@
-require "guard/ui"
-
 module Guard
   class Interactor
     # Initializes the interactor. This configures
@@ -55,33 +53,6 @@ module Guard
 
       # TODO: handle switching interactors during runtime?
       attr_writer :enabled
-
-      # Converts and validates a plain text scope
-      # to a valid plugin or group scope.
-      #
-      # @param [Array<String>] entries the text scope
-      # @return [Hash, Array<String>] the plugin or group scope, the unknown
-      #   entries
-      #
-      # TODO: call this from within action, not within interactor command
-      def convert_scope(entries)
-        scopes  = { plugins: [], groups: [] }
-        unknown = []
-
-        session = Guard.state.session
-
-        entries.each do |entry|
-          if plugin = session.plugins.all(entry).first
-            scopes[:plugins] << plugin
-          elsif group = session.groups.all(entry).first
-            scopes[:groups] << group
-          else
-            unknown << entry
-          end
-        end
-
-        [scopes, unknown]
-      end
     end
 
     private

data/lib/guard/internals/plugins.rb

@@ -1,3 +1,5 @@
+require "guard/plugin_util"
+require "guard/group"
 require "guard/plugin"
 
 module Guard

data/lib/guard/internals/scope.rb

@@ -1,3 +1,5 @@
+require "guard"
+
 module Guard
   # @private api
   module Internals
@@ -82,10 +84,12 @@ module Guard
           !source.empty?
         end
 
+        # TODO: not tested when groups/plugins given don't exist
+
         # TODO: should already be instantiated
         Array(items).map do |name|
           (type == :group ? _groups : _plugins).all(name).first
-        end
+        end.compact
       end
 
       def _instantiate(meth, obj)

data/lib/guard/internals/session.rb

@@ -8,9 +8,6 @@ module Guard
   module Internals
     # TODO: split into a commandline class and session (plugins, groups)
     # TODO: swap session and metadata
-    # This class contains variables set during
-    # evaluation of the guardfile (and are reset
-    # before reevaluation)
     class Session
       attr_reader :options
       attr_reader :plugins
@@ -55,8 +52,8 @@ module Guard
       def initialize(new_options)
         @options = Options.new(new_options, DEFAULT_OPTIONS)
 
-        @plugins = Internals::Plugins.new
-        @groups = Internals::Groups.new
+        @plugins = Plugins.new
+        @groups = Groups.new
 
         @cmdline_groups = @options[:group]
         @cmdline_plugins = @options[:plugin]
@@ -83,9 +80,13 @@ module Guard
       # TODO: create a EvaluatorResult class?
       attr_reader :guardfile_group_scope
       attr_reader :guardfile_plugin_scope
-      attr_accessor :guardfile_ignore
       attr_accessor :guardfile_ignore_bang
 
+      attr_reader :guardfile_ignore
+      def guardfile_ignore=(ignores)
+        @guardfile_ignore += Array(ignores).flatten
+      end
+
       def clearing(on)
         @clear = on
       end
@@ -140,6 +141,24 @@ module Guard
       def interactor_name
         @interactor_name
       end
+
+      # TODO: call this from within action, not within interactor command
+      def convert_scope(entries)
+        scopes  = { plugins: [], groups: [] }
+        unknown = []
+
+        entries.each do |entry|
+          if plugin = plugins.all(entry).first
+            scopes[:plugins] << plugin
+          elsif group = groups.all(entry).first
+            scopes[:groups] << group
+          else
+            unknown << entry
+          end
+        end
+
+        [scopes, unknown]
+      end
     end
   end
 end

data/lib/guard/internals/state.rb

@@ -3,16 +3,15 @@ require "guard/group"
 require "guard/plugin_util"
 require "guard/internals/session"
 require "guard/internals/scope"
+require "guard/runner"
 
 module Guard
   module Internals
     class State
       # Minimal setup for non-interactive commands (list, init, show, etc.)
       def initialize(cmdline_opts)
-        # NOTE: this is reset during reevaluation
         @session = Session.new(cmdline_opts)
 
-        # NOTE: this should persist across reevaluate() calls
         @scope = Scope.new
 
         # NOTE: must be set before anything calls Guard::UI.debug
@@ -23,10 +22,16 @@ module Guard
       attr_reader :session
 
       # @private api
-      # used to clear instance variables during reevaluation
-      def reset_session
+      # 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

data/lib/guard/notifier.rb

@@ -1,8 +1,8 @@
 require "yaml"
 require "rbconfig"
 require "pathname"
+require "nenv"
 
-require_relative "internals/environment"
 require_relative "notifier/detected"
 
 require_relative "ui"
@@ -71,6 +71,14 @@ module Guard
       { 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
 
@@ -216,17 +224,7 @@ module Guard
     private
 
     def _env
-      (@environment ||= _create_env)
-    end
-
-    def _create_env
-      Internals::Environment.new("GUARD").tap do |env|
-        env.create_method(:notify?) { |data| data != "false" }
-        env.create_method(:notify_pid) { |data| data && Integer(data) }
-        env.create_method(:notify_pid=)
-        env.create_method(:notify_active?)
-        env.create_method(:notify_active=)
-      end
+      @environment ||= Env.new("guard")
     end
 
     def _check_server!

data/lib/guard/notifier/detected.rb

@@ -1,4 +1,4 @@
-require "guard/internals/environment"
+require "nenv"
 
 require_relative "../notifiers/emacs"
 require_relative "../notifiers/file_notifier"
@@ -13,6 +13,13 @@ require_relative "../notifiers/tmux"
 
 module Guard
   module Notifier
+    # @private api
+
+    YamlEnvStorage = Nenv::Builder.build do
+      create_method(:notifiers=) { |data| YAML::dump(data) }
+      create_method(:notifiers) { |data| data ? YAML::load(data) : [] }
+    end
+
     # @private api
     class Detected
       NO_SUPPORTED_NOTIFIERS = "Guard could not detect any of the supported" +
@@ -23,10 +30,7 @@ module Guard
 
       def initialize(supported)
         @supported = supported
-        @environment = Internals::Environment.new("GUARD").tap do |env|
-          env.create_method(:notifiers=) { |data| YAML::dump(data) }
-          env.create_method(:notifiers) { |data| data ? YAML::load(data) : [] }
-        end
+        @environment = YamlEnvStorage.new("guard")
       end
 
       def reset