guard 2.7.2 → 2.7.3

data/lib/guard/commander.rb.orig

@@ -0,0 +1,103 @@
+module Guard
+  # Commands supported by guard
+  module Commander
+    # Start Guard by evaluating the `Guardfile`, initializing declared Guard
+    # plugins and starting the available file change listener.
+    # Main method for Guard that is called from the CLI when Guard starts.
+    #
+    # - Setup Guard internals
+    # - Evaluate the `Guardfile`
+    # - Configure Notifiers
+    # - Initialize the declared Guard plugins
+    # - Start the available file change listener
+    #
+    # @option options [Boolean] clear if auto clear the UI should be done
+    # @option options [Boolean] notify if system notifications should be shown
+    # @option options [Boolean] debug if debug output should be shown
+    # @option options [Array<String>] group the list of groups to start
+    # @option options [String] watchdir the director to watch
+    # @option options [String] guardfile the path to the Guardfile
+    # @see CLI#start
+    #
+    def start(options = {})
+      setup(options)
+      ::Guard::UI.debug "Guard starts all plugins"
+      runner.run(:start)
+      listener.start
+<<<<<<< HEAD
+
+      watched = ::Guard.watchdirs.join("', '")
+      ::Guard::UI.info "Guard is now watching at '#{ watched }'"
+=======
+      ::Guard::UI.info "Guard is now watching at '#{ ::Guard.watchdirs.join "', '" }'"
+>>>>>>> origin/api_safe_refactoring
+
+      _interactor_loop
+    end
+
+    # TODO: refactor (left to avoid breaking too many specs)
+    def stop
+      listener.stop
+      interactor.background
+      ::Guard::UI.debug "Guard stops all plugins"
+      runner.run(:stop)
+      ::Guard::Notifier.turn_off
+      ::Guard::UI.info "Bye bye...", reset: true
+    end
+
+    # Reload Guardfile and all Guard plugins currently enabled.
+    # If no scope is given, then the Guardfile will be re-evaluated,
+    # which results in a stop/start, which makes the reload obsolete.
+    #
+    # @param [Hash] scopes hash with a Guard plugin or a group scope
+    #
+    def reload(scopes = {})
+      ::Guard::UI.clear(force: true)
+      ::Guard::UI.action_with_scopes("Reload", scopes)
+
+      if scopes.empty?
+        evaluator.reevaluate_guardfile
+      else
+        runner.run(:reload, scopes)
+      end
+    end
+
+    # Trigger `run_all` on all Guard plugins currently enabled.
+    #
+    # @param [Hash] scopes hash with a Guard plugin or a group scope
+    #
+    def run_all(scopes = {})
+      ::Guard::UI.clear(force: true)
+      ::Guard::UI.action_with_scopes("Run", scopes)
+      runner.run(:run_all, scopes)
+    end
+
+    # Pause Guard listening to file changes.
+    #
+    def pause(expected = nil)
+      paused = listener.paused?
+      states = { paused: true, unpaused: false, toggle: !paused }
+      pause = states[expected || :toggle]
+      fail ArgumentError, "invalid mode: #{expected.inspect}" if pause.nil?
+      return if pause == paused
+
+      listener.send(pause ? :pause : :unpause)
+      UI.info "File modification listening is now #{pause.to_s.upcase}"
+    end
+
+    def show
+      ::Guard::DslDescriber.new(::Guard.options).show
+    end
+
+    private
+
+    # TODO: remove (left to avoid breaking too many specs)
+    def _interactor_loop
+      while interactor.foreground != :exit
+        _process_queue while pending_changes?
+      end
+    rescue Interrupt
+      stop
+    end
+  end
+end

data/lib/guard/commands/all.rb.orig

@@ -0,0 +1,36 @@
+# required for async_queue_add
+require "pry"
+require "guard"
+
+module Guard
+  module Commands
+    class All
+      def self.import
+        Pry::Commands.create_command "all" do
+          group "Guard"
+          description "Run all plugins."
+
+          banner <<-BANNER
+          Usage: all <scope>
+
+          Run the Guard plugin `run_all` action.
+
+          You may want to specify an optional scope to the action,
+          either the name of a Guard plugin or a plugin group.
+          BANNER
+
+          def process(*entries)
+            scopes, unknown = ::Guard::Interactor.convert_scope(entries)
+
+            unless unknown.empty?
+              output.puts "Unknown scopes: #{ unknown.join(", ") }"
+              return
+            end
+
+            ::Guard.async_queue_add([:guard_run_all, scopes])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/guard/commands/reload.rb.orig

@@ -0,0 +1,34 @@
+require "pry"
+
+module Guard
+  module Commands
+    class Reload
+      def self.import
+        Pry::Commands.create_command "reload" do
+          group "Guard"
+          description "Reload all plugins."
+
+          banner <<-BANNER
+          Usage: reload <scope>
+
+          Run the Guard plugin `reload` action.
+
+          You may want to specify an optional scope to the action,
+          either the name of a Guard plugin or a plugin group.
+          BANNER
+
+          def process(*entries)
+            scopes, unknown = ::Guard::Interactor.convert_scope(entries)
+
+            unless unknown.empty?
+              output.puts "Unknown scopes: #{ unknown.join(", ") }"
+              return
+            end
+
+            ::Guard.async_queue_add([:guard_reload, scopes])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/guard/commands/scope.rb.orig

@@ -0,0 +1,36 @@
+require "pry"
+
+module Guard
+  module Commands
+    class Scope
+      def self.import
+        Pry::Commands.create_command "scope" do
+          group "Guard"
+          description "Scope Guard actions to groups and plugins."
+
+          banner <<-BANNER
+          Usage: scope <scope>
+
+          Set the global Guard scope.
+          BANNER
+
+          def process(*entries)
+            scope, unknown = ::Guard::Interactor.convert_scope(entries)
+
+            unless unknown.empty?
+              output.puts "Unknown scopes: #{unknown.join(",") }"
+              return
+            end
+
+            if scope[:plugins].empty? && scope[:groups].empty?
+              output.puts "Usage: scope <scope>"
+              return
+            end
+
+            ::Guard.setup_scope(scope)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/guard/deprecated_methods.rb.orig

@@ -0,0 +1,71 @@
+module Guard
+  module DeprecatedMethods
+    # @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
+    #
+    def guards(filter = nil)
+      ::Guard::UI.deprecation(::Guard::Deprecator::GUARDS_DEPRECATION)
+      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
+    #
+    def add_guard(*args)
+      ::Guard::UI.deprecation(::Guard::Deprecator::ADD_GUARD_DEPRECATION)
+      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
+    #
+    def get_guard_class(name, fail_gracefully = false)
+      UI.deprecation(Deprecator::GET_GUARD_CLASS_DEPRECATION)
+      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
+    #
+    def locate_guard(name)
+      UI.deprecation(Deprecator::LOCATE_GUARD_DEPRECATION)
+      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
+    #
+    def guard_gem_names
+      UI.deprecation(Deprecator::GUARD_GEM_NAMES_DEPRECATION)
+      PluginUtil.plugin_names
+    end
+
+    def running
+      UI.deprecation(Deprecator::GUARD_RUNNING_DEPRECATION)
+      nil
+    end
+
+    def lock
+      UI.deprecation(Deprecator::GUARD_LOCK_DEPRECATION)
+    end
+
+    def evaluator
+      UI.deprecation(Deprecator::GUARD_EVALUATOR_DEPRECATION)
+      # TODO: this will be changed to the following when scope is reworked
+      # ::Guard.session.evaluator
+      ::Guard.instance_variable_get(:@evaluator)
+    end
+  end
+end

data/lib/guard/deprecator.rb.orig

@@ -0,0 +1,206 @@
+require "guard/ui"
+
+module Guard
+  class Deprecator
+    UPGRADE_WIKI = "https://github.com/guard/guard/wiki"\
+      "/Upgrade-guide-for-existing-guards-to-Guard-v1.1"
+
+    MORE_INFO_ON_UPGRADING_TO_GUARD_1_1 = <<-EOS.gsub(/^\s*/, "")
+      For more information on how to update existing Guard plugins, please head
+      over to:
+      #{UPGRADE_WIKI}
+    EOS
+
+    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
+
+    ADD_GUARD_DEPRECATION = <<-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
+
+    GUARDS_DEPRECATION = <<-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
+
+    # Deprecator message for the `Guard.get_guard_class` method
+    GET_GUARD_CLASS_DEPRECATION = <<-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
+
+    # Deprecator message for the `Guard.locate_guard` method
+    LOCATE_GUARD_DEPRECATION = <<-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
+
+    # Deprecator message for the `Guard.guard_gem_names` method
+    GUARD_GEM_NAMES_DEPRECATION = <<-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
+
+    # Deprecator message for the `Guard::Dsl.evaluate_guardfile` method
+    EVALUATE_GUARDFILE_DEPRECATION = <<-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
+
+    # Deprecator message for the `Guardfile.create_guardfile` method
+    CREATE_GUARDFILE_DEPRECATION = <<-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
+
+    # Deprecator message for the `Guardfile.initialize_template` method
+    INITIALIZE_TEMPLATE_DEPRECATION = <<-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
+
+    # Deprecator message for the `Guardfile.initialize_all_templates` method
+    INITIALIZE_ALL_TEMPLATES_DEPRECATION = <<-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
+
+    # Deprecator message for when a Guard plugin inherits from Guard::Guard
+    GUARD_GUARD_DEPRECATION = <<-EOS.gsub(/^\s*/, "")
+      Starting with Guard 2.0, Guard::%s should inherit from Guard::Plugin
+      instead of Guard::Guard.
+
+      Please note that the constructor signature has changed from
+      Guard::Guard#initialize(watchers = [], options = {}) to
+      Guard::Plugin#initialize(options = {}).
+
+      #{MORE_INFO_ON_UPGRADING_TO_GUARD_2 % "#changes-in-guardguard"}
+    EOS
+
+<<<<<<< HEAD
+    GUARD_RUNNING_DEPRECATION = <<-EOS.gsub(/^\s*/, "")
+      Starting with Guard 2.7.1 it was discovered that Guard.running was never
+      initialized or used internally.
+    EOS
+
+    GUARD_LOCK_DEPRECATION = <<-EOS.gsub(/^\s*/, "")
+      Starting with Guard 2.7.1 it was discovered that this accessor was never
+      initialized or used internally.
+    EOS
+
+    GUARD_EVALUATOR_DEPRECATION = <<-EOS.gsub(/^\s*/, "")
+      Starting with Guard 2.7.1 ::Guard.session.evaluator should be used
+      instead.
+    EOS
+=======
+    # Deprecator message for the `watch_all_modifications` start option
+    WATCH_ALL_MODIFICATIONS_DEPRECATION = <<-EOS.gsub(/^\s*/, '')
+      Starting with Guard 1.1 the 'watch_all_modifications' option is removed
+      and is now always on.
+    EOS
+
+    # Deprecator message for the `no_vendor` start option
+    NO_VENDOR_DEPRECATION = <<-EOS.gsub(/^\s*/, '')
+      Starting with Guard 1.1 the 'no_vendor' option is removed because the
+      monitoring gems are now part of a new gem called Listen.
+      (https://github.com/guard/listen)
+
+      You can specify a custom version of any monitoring gem directly in your
+      Gemfile if you want to overwrite Listen's default monitoring gems.
+    EOS
+
+    # Deprecator message for the `run_on_change` method
+    RUN_ON_CHANGE_DEPRECATION = <<-EOS.gsub(/^\s*/, '')
+      Starting with Guard 1.1 the use of the 'run_on_change' method in the '%s' guard is deprecated.
+
+      Please consider replacing that method-call with 'run_on_changes' if the type of change
+      is not important for your usecase or using either 'run_on_modifications' or 'run_on_additions'
+      based on the type of the changes you want to handle.
+
+      #{MORE_INFO_ON_UPGRADING_TO_GUARD_1_1}
+    EOS
+
+    # Deprecator message for the `run_on_deletion` method
+    RUN_ON_DELETION_DEPRECATION = <<-EOS.gsub(/^\s*/, '')
+      Starting with Guard 1.1 the use of the 'run_on_deletion' method in the '%s' guard is deprecated.
+
+      Please consider replacing that method-call with 'run_on_removals' for future proofing your code.
+
+      #{MORE_INFO_ON_UPGRADING_TO_GUARD_1_1}
+    EOS
+
+    # Deprecator message for the `interactor` method
+    DSL_METHOD_INTERACTOR_DEPRECATION = <<-EOS.gsub(/^\s*/, '')
+      Starting with Guard 1.4 the use of the 'interactor' Guardfile DSL method is only used to
+      disable or pass options to the Pry interactor. All other usages are deprecated.
+    EOS
+
+    # Deprecator message for the `ignore_paths` method
+    DSL_METHOD_IGNORE_PATHS_DEPRECATION = <<-EOS.gsub(/^\s*/, '')
+      Starting with Guard 1.1 the use of the 'ignore_paths' Guardfile DSL method is deprecated.
+
+      Please replace that method with the better 'ignore' or/and 'filter' methods.
+      Documentation on the README: https://github.com/guard/guard#ignore
+    EOS
+
+    # Displays a warning for each deprecated options used when starting Guard.
+    #
+    def self.deprecated_options_warning(options)
+      ::Guard::UI.deprecation(WATCH_ALL_MODIFICATIONS_DEPRECATION) if options.watch_all_modifications
+      ::Guard::UI.deprecation(NO_VENDOR_DEPRECATION) if options.no_vendor
+    end
+
+    # Displays a warning for each deprecated method used is any registered Guard plugin.
+    #
+    def self.deprecated_plugin_methods_warning
+      ::Guard.plugins.each do |plugin|
+        ::Guard::UI.deprecation(RUN_ON_CHANGE_DEPRECATION % plugin.class.name)   if plugin.respond_to?(:run_on_change)
+        ::Guard::UI.deprecation(RUN_ON_DELETION_DEPRECATION % plugin.class.name) if plugin.respond_to?(:run_on_deletion)
+      end
+    end
+
+>>>>>>> parent of a5162d2... Remove deprecated methods and options. Fixes #425.
+  end
+end