guard 2.8.2 → 2.9.0

data/lib/guard/cli.rb.orig

@@ -3,7 +3,8 @@ require "thor"
 require "guard"
 require "guard/version"
 require "guard/dsl_describer"
-require "guard/guardfile"
+require "guard/guardfile/evaluator"
+require "guard/guardfile/generator"
 
 module Guard
   # Facade for the Guard command line interface managed by
@@ -70,11 +71,6 @@ module Guard
                   aliases: "-B",
                   banner: "Turn off warning when Bundler is not present"
 
-    method_option :show_deprecations,
-                  type: :boolean,
-                  default: false,
-                  banner: "Turn on deprecation warnings"
-
     # Listen options
     method_option :latency,
                   type:    :numeric,
@@ -169,17 +165,23 @@ module Guard
       _verify_bundler_presence unless options[:no_bundler_warning]
 
       ::Guard.reset_options(options) # Since UI.deprecated uses config
-      ::Guard.reset_evaluator(options) # for initialize_all_templates
 
-      ::Guard::Guardfile.create_guardfile(abort_on_existence: options[:bare])
+      generator = Guardfile::Generator.new(abort_on_existence: options[:bare])
+      generator.create_guardfile
+
+      # Note: this reset "hack" will be fixed after refactoring
+      ::Guard.reset_plugins
+
+      # Evaluate because it might have existed and creating was skipped
+      ::Guard::Guardfile::Evaluator.new(Guard.options).evaluate_guardfile
 
       return if options[:bare]
 
       if plugin_names.empty?
-        ::Guard::Guardfile.initialize_all_templates
+        generator.initialize_all_templates
       else
         plugin_names.each do |plugin_name|
-          ::Guard::Guardfile.initialize_template(plugin_name)
+          generator.initialize_template(plugin_name)
         end
       end
     end

data/lib/guard/commander.rb

@@ -1,3 +1,10 @@
+require "listen"
+
+require "guard/notifier"
+require "guard/interactor"
+require "guard/runner"
+require "guard"
+
 module Guard
   # Commands supported by guard
   module Commander
@@ -22,13 +29,12 @@ module Guard
     def start(options = {})
       setup(options)
       ::Guard::UI.debug "Guard starts all plugins"
-      runner.run(:start)
+      Guard::Runner.new.run(:start)
       listener.start
 
       watched = ::Guard.watchdirs.join("', '")
       ::Guard::UI.info "Guard is now watching at '#{ watched }'"
 
-      # TODO: remove (left to avoid breaking too many specs)
       begin
         while interactor.foreground != :exit
           _process_queue while pending_changes?
@@ -44,8 +50,8 @@ module Guard
       listener.stop
       interactor.background
       ::Guard::UI.debug "Guard stops all plugins"
-      runner.run(:stop)
-      ::Guard::Notifier.turn_off
+      Guard::Runner.new.run(:stop)
+      ::Guard::Notifier.disconnect
       ::Guard::UI.info "Bye bye...", reset: true
     end
 
@@ -56,13 +62,14 @@ module Guard
     # @param [Hash] scopes hash with a Guard plugin or a group scope
     #
     def reload(scopes = {})
+      # TODO: guard reevaluator should probably handle all this
       ::Guard::UI.clear(force: true)
       ::Guard::UI.action_with_scopes("Reload", scopes)
 
       if scopes.empty?
-        evaluator.reevaluate_guardfile
+        Guard::Guardfile::Evaluator.new(Guard.options).reevaluate_guardfile
       else
-        runner.run(:reload, scopes)
+        Guard::Runner.new.run(:reload, scopes)
       end
     end
 
@@ -73,7 +80,7 @@ module Guard
     def run_all(scopes = {})
       ::Guard::UI.clear(force: true)
       ::Guard::UI.action_with_scopes("Run", scopes)
-      runner.run(:run_all, scopes)
+      Guard::Runner.new.run(:run_all, scopes)
     end
 
     # Pause Guard listening to file changes.
@@ -93,4 +100,5 @@ module Guard
       ::Guard::DslDescriber.new(::Guard.options).show
     end
   end
+  extend Commander
 end

data/lib/guard/commands/all.rb

@@ -1,5 +1,8 @@
 # required for async_queue_add
 require "pry"
+
+# TODO: remove this dependency
+require "guard/interactor"
 require "guard"
 
 module Guard

data/lib/guard/commands/change.rb

@@ -1,5 +1,8 @@
 require "pry"
 
+# TODO: remove
+require "guard"
+
 module Guard
   module Commands
     class Change

data/lib/guard/commands/pause.rb

@@ -1,5 +1,7 @@
 require "pry"
 
+require "guard"
+
 module Guard
   module Commands
     class Pause

data/lib/guard/commands/reload.rb

@@ -1,5 +1,9 @@
 require "pry"
 
+# TODO: should not be necessary!
+require "guard/interactor"
+require "guard"
+
 module Guard
   module Commands
     class Reload

data/lib/guard/commands/scope.rb

@@ -1,4 +1,6 @@
 require "pry"
+require "guard/interactor"
+require "guard"
 
 module Guard
   module Commands
@@ -27,6 +29,7 @@ module Guard
               return
             end
 
+            # TODO: provide a way for guard to know this was called from Pry
             ::Guard.setup_scope(scope)
           end
         end

data/lib/guard/config.rb

@@ -0,0 +1,24 @@
+require "guard/internals/environment"
+
+module Guard
+  class Config
+    def strict?
+      _env.strict?
+    end
+
+    def silence_deprecations?
+    end
+
+    private
+
+    def _env
+      @env ||= _create_env
+    end
+
+    def _create_env
+      Internals::Environment.new("GUARD").tap do |env|
+        env.create_method(:strict?)
+      end
+    end
+  end
+end

data/lib/guard/deprecated/dsl.rb

@@ -0,0 +1,45 @@
+require "guard/config"
+fail "Deprecations disabled (strict mode)" if Guard::Config.new.strict?
+
+module Guard
+  module Deprecated
+    module Dsl
+      def self.add_deprecated(dsl_klass)
+        dsl_klass.send(:extend, ClassMethods)
+      end
+
+      MORE_INFO_ON_UPGRADING_TO_GUARD_2 = <<-EOS.gsub(/^\s*/, "")
+        For more information on how to upgrade for Guard 2.0, please head over
+        to: https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0%s
+      EOS
+
+      module ClassMethods
+        # @deprecated Use
+        # `Guard::Guardfile::Evaluator.new(options).evaluate_guardfile`
+        # instead.
+        #
+        # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How
+        # to upgrade for Guard 2.0
+        #
+        EVALUATE_GUARDFILE = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.0 'Guard::Dsl.evaluate_guardfile(options)' is
+          deprecated.
+
+          Please use
+          'Guard::Guardfile::Evaluator.new(options).evaluate_guardfile'
+          instead.
+
+          #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods-1"}
+        EOS
+
+        def evaluate_guardfile(options = {})
+          require "guard/guardfile/evaluator"
+          require "guard/ui"
+
+          UI.deprecation(EVALUATE_GUARDFILE)
+          ::Guard::Guardfile::Evaluator.new(options).evaluate_guardfile
+        end
+      end
+    end
+  end
+end

data/lib/guard/deprecated/guard.rb

@@ -0,0 +1,166 @@
+require "guard/config"
+fail "Deprecations disabled (strict mode)" if Guard::Config.new.strict?
+
+require "guard/ui"
+require "guard/plugin_util"
+require "guard/guardfile/evaluator"
+
+module Guard
+  # @deprecated Every method in this module is deprecated
+  module Deprecated
+    module Guard
+      def self.add_deprecated(klass)
+        klass.send(:extend, ClassMethods)
+      end
+
+      module ClassMethods
+        MORE_INFO_ON_UPGRADING_TO_GUARD_2 = <<-EOS.gsub(/^\s*/, "")
+          For more information on how to upgrade for Guard 2.0, please head
+          over to: https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0%s
+        EOS
+
+        # @deprecated Use `Guard.plugins(filter)` instead.
+        #
+        # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
+        #   upgrade for Guard 2.0
+        #
+        GUARDS = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.0 'Guard.guards(filter)' is deprecated.
+
+          Please use 'Guard.plugins(filter)' instead.
+
+            #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods"}
+        EOS
+
+        def guards(filter = nil)
+          ::Guard::UI.deprecation(GUARDS)
+          plugins(filter)
+        end
+
+        # @deprecated Use `Guard.add_plugin(name, options = {})` instead.
+        #
+        # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
+        #   upgrade for Guard 2.0
+        #
+        ADD_GUARD = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.0 'Guard.add_guard(name, options = {})' is
+          deprecated.
+
+          Please use 'Guard.add_plugin(name, options = {})' instead.
+
+        #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods"}
+        EOS
+
+        def add_guard(*args)
+          ::Guard::UI.deprecation(ADD_GUARD)
+          add_plugin(*args)
+        end
+
+        # @deprecated Use
+        #   `Guard::PluginUtil.new(name).plugin_class(fail_gracefully:
+        #   fail_gracefully)` instead.
+        #
+        # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
+        #   upgrade for Guard 2.0
+        #
+        GET_GUARD_CLASS = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.0 'Guard.get_guard_class(name, fail_gracefully
+          = false)' is deprecated and is now always on.
+
+          Please use 'Guard::PluginUtil.new(name).plugin_class(fail_gracefully:
+          fail_gracefully)' instead.
+
+        #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods"}
+        EOS
+
+        def get_guard_class(name, fail_gracefully = false)
+          UI.deprecation(GET_GUARD_CLASS)
+          PluginUtil.new(name).plugin_class(fail_gracefully: fail_gracefully)
+        end
+
+        # @deprecated Use `Guard::PluginUtil.new(name).plugin_location` instead.
+        #
+        # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
+        #   upgrade for Guard 2.0
+        #
+        LOCATE_GUARD = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.0 'Guard.locate_guard(name)' is deprecated.
+
+          Please use 'Guard::PluginUtil.new(name).plugin_location' instead.
+
+        #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods"}
+        EOS
+
+        def locate_guard(name)
+          UI.deprecation(LOCATE_GUARD)
+          PluginUtil.new(name).plugin_location
+        end
+
+        # @deprecated Use `Guard::PluginUtil.plugin_names` instead.
+        #
+        # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
+        #   upgrade for Guard 2.0
+        #
+        # Deprecator message for the `Guard.guard_gem_names` method
+        GUARD_GEM_NAMES = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.0 'Guard.guard_gem_names' is deprecated.
+
+          Please use 'Guard::PluginUtil.plugin_names' instead.
+
+        #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods"}
+        EOS
+
+        def guard_gem_names
+          UI.deprecation(GUARD_GEM_NAMES)
+          PluginUtil.plugin_names
+        end
+
+        RUNNING = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.7.1 it was discovered that Guard.running was
+          never initialized or used internally.
+        EOS
+
+        def running
+          UI.deprecation(RUNNING)
+          nil
+        end
+
+        LOCK = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.7.1 it was discovered that this accessor was
+          never initialized or used internally.
+        EOS
+        def lock
+          UI.deprecation(LOCK)
+        end
+
+        EVALUATOR = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.8.2 this method shouldn't be used
+        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)
+        end
+
+        RESET_EVALUATOR = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.8.2 this method shouldn't be used
+        EOS
+
+        def reset_evaluator(_options)
+          UI.deprecation(RESET_EVALUATOR)
+        end
+
+        RUNNER = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.8.2 this method shouldn't be used
+        EOS
+
+        def runner
+          UI.deprecation(RUNNER)
+          ::Guard::Runner.new
+        end
+      end
+    end
+  end
+end

data/lib/guard/deprecated/guardfile.rb

@@ -0,0 +1,84 @@
+require "guard/config"
+fail "Deprecations disabled (strict mode)" if Guard::Config.new.strict?
+
+require "guard/guardfile/generator"
+
+module Guard
+  module Deprecated
+    module Guardfile
+      def self.add_deprecated(dsl_klass)
+        dsl_klass.send(:extend, ClassMethods)
+      end
+
+      module ClassMethods
+        MORE_INFO_ON_UPGRADING_TO_GUARD_2 = <<-EOS.gsub(/^\s*/, "")
+          For more information on how to upgrade for Guard 2.0, please head
+          over to: https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0%s
+        EOS
+        # @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
+        #
+        CREATE_GUARDFILE = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.0 'Guard::Guardfile.create_guardfile(options)'
+          is deprecated.
+
+          Please use 'Guard::Guardfile::Generator.new(options).create_guardfile'
+          instead.
+
+          #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods-2"}
+        EOS
+
+        def create_guardfile(options = {})
+          UI.deprecation(CREATE_GUARDFILE)
+          ::Guard::Guardfile::Generator.new(options).create_guardfile
+        end
+
+        # @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
+        #
+        # Deprecator message for the `Guardfile.initialize_template` method
+        INITIALIZE_TEMPLATE = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.0
+          'Guard::Guardfile.initialize_template(plugin_name)' is deprecated.
+
+          Please use
+          'Guard::Guardfile::Generator.new.initialize_template(plugin_name)'
+          instead.
+
+          #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods-2"}
+        EOS
+
+        def initialize_template(plugin_name)
+          UI.deprecation(INITIALIZE_TEMPLATE)
+          ::Guard::Guardfile::Generator.new.initialize_template(plugin_name)
+        end
+
+        # @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
+        #
+        # Deprecator message for the `Guardfile.initialize_all_templates` method
+        INITIALIZE_ALL_TEMPLATES = <<-EOS.gsub(/^\s*/, "")
+          Starting with Guard 2.0 'Guard::Guardfile.initialize_all_templates'
+          is deprecated.
+
+          Please use 'Guard::Guardfile::Generator.new.initialize_all_templates'
+          instead.
+
+          #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#deprecated-methods-2"}
+        EOS
+
+        def initialize_all_templates
+          UI.deprecation(INITIALIZE_ALL_TEMPLATES)
+          ::Guard::Guardfile::Generator.new.initialize_all_templates
+        end
+      end
+    end
+  end
+end