guard 2.10.2 → 2.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3106af4e3722da1f4bd41e051e5baf1ff8ace4f7
-  data.tar.gz: 0ef587f058e7f02bc5b4195a0b3b3b4d25847ddd
+  metadata.gz: 12901ae839ae58fdc3f18c932ffc1aef5fbd5f93
+  data.tar.gz: 05665929d7b77277aa5cd37156e6984b11651379
 SHA512:
-  metadata.gz: b5f3825c29f9c01f14b50051055e105a3695288da0ce2ba2d42fdd4e4af92881afb455515da551a1faaf192b28ba8eb2e599f0640002ff9c1d2d8db0796c734a
-  data.tar.gz: c107a499ff6e9814b536a9c1f723c5a7badc97e33f74ae8409f5b72d082fff63c09d3eac630cd9b6b12c9591ed1210b907ea05680f2b615d62bcde31b2eb5784
+  metadata.gz: 8d850a23954953c2a6b2ba15813ee408d8fa29d8a85dec0c15b5fb68ab7e51b7bc2e1cb87951975991e5ac24305e58b99ac41088f7e2c96b1f662119e3ad924f
+  data.tar.gz: 067ca85ff9546dfedd73972e87acdf97c6aa48cdbfa3ea6475df7280bd8f52bab9b587bd0117511b12410f6bb79c781c8c46e88c6e3fc0698f569fefddf75a99

data/lib/guard.rb

@@ -3,38 +3,27 @@ require "listen"
 
 require "guard/config"
 require "guard/deprecated/guard" unless Guard::Config.new.strict?
+require "guard/internals/helpers"
 
 require "guard/internals/debugging"
 require "guard/internals/traps"
-require "guard/internals/helpers"
-
 require "guard/internals/queue"
-require "guard/internals/state"
 
-require "guard/options"
-require "guard/commander"
-require "guard/dsl"
-require "guard/group"
+# TODO: remove this class altogether
 require "guard/interactor"
-require "guard/notifier"
-require "guard/plugin_util"
-require "guard/runner"
-require "guard/sheller"
-require "guard/ui"
-require "guard/watcher"
-require "guard/guardfile/evaluator"
 
 # Guard is the main module for all Guard related modules and classes.
 # Also Guard plugins should use this namespace.
-#
 module Guard
   Deprecated::Guard.add_deprecated(self) unless Config.new.strict?
 
   class << self
+    attr_reader :state
+    attr_reader :queue
     attr_reader :listener
+    attr_reader :interactor
 
     # @private api
-    attr_reader :queue
 
     include Internals::Helpers
 
@@ -85,10 +74,6 @@ module Guard
       @state = Internals::State.new(cmdline_options)
     end
 
-    attr_reader :state
-
-    attr_reader :interactor
-
     # Asynchronously trigger changes
     #
     # Currently supported args:
@@ -133,21 +118,15 @@ module Guard
           removed: _relative_pathnames(removed)
         }
 
+        _guardfile_deprecated_check(relative_paths[:modified])
+
         async_queue_add(relative_paths) if _relevant_changes?(relative_paths)
       end
     end
 
     # TODO: obsoleted? (move to Dsl?)
     def _pluginless_guardfile?
-      # no Reevaluator means there was no Guardfile configured that could be
-      # reevaluated, so we don't have a pluginless guardfile, because we don't
-      # have a Guardfile to begin with...
-      #
-      # But, if we have a Guardfile, we'll at least have the built-in
-      # Reevaluator, so the following will work:
-
-      plugins = state.session.plugins.all
-      plugins.empty? || plugins.map(&:name) == ["reevaluator"]
+      state.session.plugins.all.empty?
     end
 
     def _evaluate(options)
@@ -170,5 +149,26 @@ module Guard
     rescue Guardfile::Evaluator::NoPluginsError => e
       UI.error(e.message)
     end
+
+    # TODO: remove at some point
+    # TODO: not tested because collides with ongoing refactoring
+    def _guardfile_deprecated_check(modified)
+      modified.map!(&:to_s)
+      guardfiles = modified.select { |path| /^(?:.+\/)?Guardfile$/.match(path) }
+      return if guardfiles.empty?
+
+      if guardfiles.any? { |path| /^Guardfile$/.match(path) }
+        UI.warning <<EOS
+Guardfile changed - Guard will exit so you can restart it manually.
+
+More info here: https://github.com/guard/guard/wiki/Guard-2.10.3-exits-when-Guardfile-is-changed
+EOS
+        exit 2 # nonzero to break any while loop
+      else
+        msg = "Config changed: %s - Guard will exit so it can be restarted."
+        UI.info format(msg, guardfiles.inspect)
+        exit 0 # 0 so any shell while loop can continue
+      end
+    end
   end
 end

data/lib/guard/cli.rb

@@ -1,9 +1,10 @@
 require "thor"
 
-require "guard"
 require "guard/version"
-require "guard/guardfile/generator"
+
 require "guard/dsl_describer"
+require "guard/cli/environments/valid"
+require "guard/cli/environments/evaluate_only"
 
 module Guard
   # Facade for the Guard command line interface managed by
@@ -104,8 +105,7 @@ module Guard
     # @see Guard.start
     #
     def start
-      _verify_bundler_presence unless options[:no_bundler_warning]
-      _start(options)
+      exit(Cli::Environments::Valid.new(options).start_guard)
     end
 
     desc "list", "Lists Guard plugins that can be used with init"
@@ -116,7 +116,7 @@ module Guard
     # @see Guard::DslDescriber.list
     #
     def list
-      _require_guardfile(options) # just to show which plugins are actually used
+      Cli::Environments::EvaluateOnly.new(options).evaluate
       DslDescriber.new.list
     end
 
@@ -127,7 +127,8 @@ module Guard
     # @see Guard::DslDescriber.notifiers
     #
     def notifiers
-      _require_guardfile(options)
+      Cli::Environments::EvaluateOnly.new(options).evaluate
+      # TODO: pass the data directly to the notifiers?
       DslDescriber.new.notifiers
     end
 
@@ -164,32 +165,9 @@ module Guard
     # initialize
     #
     def init(*plugin_names)
-      _verify_bundler_presence unless options[:no_bundler_warning]
-      bare = options[:bare]
-
-      generator = Guardfile::Generator.new
-      Guard.init(options)
-      session = Guard.state.session
-
-      begin
-        Guardfile::Evaluator.new(session.evaluator_options).evaluate
-      rescue Guardfile::Evaluator::NoGuardfileError
-        generator.create_guardfile
-      end
-
-      return if bare
-
-      # Evaluate because it might have existed and creating was skipped
-      # FIXME: still, I don't know why this is needed
-      Guardfile::Evaluator.new(session.evaluator_options).evaluate
-
-      if plugin_names.empty?
-        generator.initialize_all_templates
-      else
-        plugin_names.each do |plugin_name|
-          generator.initialize_template(plugin_name)
-        end
-      end
+      env = Cli::Environments::Valid.new(options)
+      exitcode = env.initialize_guardfile(plugin_names)
+      exit(exitcode)
     end
 
     desc "show", "Show all defined Guard plugins and their options"
@@ -201,53 +179,8 @@ module Guard
     # @see Guard::DslDescriber.show
     #
     def show
-      _require_guardfile(options)
-      # TODO: use Metadata class
+      Cli::Environments::EvaluateOnly.new(options).evaluate
       DslDescriber.new.show
     end
-
-    private
-
-    # Verifies if Guard is run with `bundle exec` and
-    # shows a hint to do so if not.
-    #
-    # TODO: move this elsewhere!!! (because of complex specs)
-    def _verify_bundler_presence
-      return unless File.exist?("Gemfile")
-      return if ENV["BUNDLE_GEMFILE"] || ENV["RUBYGEMS_GEMDEPS"]
-
-      UI.info <<EOF
-
-Guard here! It looks like your project has a Gemfile, yet you are running
-`guard` outside of Bundler. If this is your intent, feel free to ignore this
-message. Otherwise, consider using `bundle exec guard` to ensure your
-dependencies are loaded correctly.
-(You can run `guard` with --no-bundler-warning to get rid of this message.)
-EOF
-    end
-
-    def _require_guardfile(options)
-      Guard.init(options) # to setup metadata
-      session = Guard.state.session
-      Guardfile::Evaluator.new(session.evaluator_options).evaluate
-    rescue Dsl::Error,
-           Guardfile::Evaluator::NoPluginsError,
-           Guardfile::Evaluator::NoGuardfileError,
-           Guardfile::Evaluator::NoCustomGuardfile => e
-      # catch to throw message instead of call stack
-      UI.error(e.message)
-      abort
-    end
-
-    def _start(options)
-      Guard.start(options)
-    rescue Dsl::Error,
-           Guardfile::Evaluator::NoPluginsError,
-           Guardfile::Evaluator::NoGuardfileError,
-           Guardfile::Evaluator::NoCustomGuardfile => e
-      # catch to throw message instead of call stack
-      UI.error(e.message)
-      abort
-    end
   end
 end

data/lib/guard/cli/environments/bundler.rb

@@ -0,0 +1,22 @@
+require "guard/ui"
+
+module Guard
+  module Cli
+    module Environments
+      class Bundler
+        def verify
+          return unless File.exist?("Gemfile")
+          return if ENV["BUNDLE_GEMFILE"] || ENV["RUBYGEMS_GEMDEPS"]
+          UI.info <<EOF
+
+Guard here! It looks like your project has a Gemfile, yet you are running
+`guard` outside of Bundler. If this is your intent, feel free to ignore this
+message. Otherwise, consider using `bundle exec guard` to ensure your
+dependencies are loaded correctly.
+(You can run `guard` with --no-bundler-warning to get rid of this message.)
+EOF
+        end
+      end
+    end
+  end
+end

data/lib/guard/cli/environments/evaluate_only.rb

@@ -0,0 +1,35 @@
+require "guard"
+
+module Guard
+  module Cli
+    module Environments
+      class EvaluateOnly
+        def initialize(options)
+          @options = options
+        end
+
+        def evaluate
+          # TODO: check bundler setup first?
+          #
+          # TODO: it should be easier to pass options created with init
+          # directly to evaluator
+          #
+          # TODO: guardfile/DSL should interact only with a given object, and
+          # not global Guard object (setting global state only needed before
+          # start() is called)
+          #
+          Guard.init(@options)
+          session = Guard.state.session
+          Guardfile::Evaluator.new(session.evaluator_options).evaluate
+        rescue \
+          Dsl::Error,
+          Guardfile::Evaluator::NoPluginsError,
+          Guardfile::Evaluator::NoGuardfileError,
+          Guardfile::Evaluator::NoCustomGuardfile => e
+          UI.error(e.message)
+          abort
+        end
+      end
+    end
+  end
+end

data/lib/guard/cli/environments/valid.rb

@@ -0,0 +1,59 @@
+require "guard/cli/environments/bundler"
+require "guard/commander"
+require "guard/guardfile/generator"
+
+module Guard
+  module Cli
+    module Environments
+      class Valid
+        def initialize(options)
+          @options = options
+        end
+
+        def start_guard
+          # TODO: just to make sure tests are ok
+          Bundler.new.verify unless @options[:no_bundler_warning]
+          Guard.start(@options)
+        rescue Dsl::Error,
+               Guardfile::Evaluator::NoPluginsError,
+               Guardfile::Evaluator::NoGuardfileError,
+               Guardfile::Evaluator::NoCustomGuardfile => e
+          # catch to throw message instead of call stack
+          UI.error(e.message)
+          abort
+        end
+
+        def initialize_guardfile(plugin_names = [])
+          bare = @options[:bare]
+
+          Guard.init(@options)
+          session = Guard.state.session
+
+          generator = Guardfile::Generator.new
+          begin
+            Guardfile::Evaluator.new(session.evaluator_options).evaluate
+          rescue Guardfile::Evaluator::NoGuardfileError
+            generator.create_guardfile
+          end
+
+          return 0 if bare # 0 - exit code
+
+          # Evaluate because it might have existed and creating was skipped
+          # FIXME: still, I don't know why this is needed
+          Guardfile::Evaluator.new(session.evaluator_options).evaluate
+
+          if plugin_names.empty?
+            generator.initialize_all_templates
+          else
+            plugin_names.each do |plugin_name|
+              generator.initialize_template(plugin_name)
+            end
+          end
+          # TODO: capture exceptions to show msg and return exit code on
+          # failures
+          0 # exit code
+        end
+      end
+    end
+  end
+end

data/lib/guard/commander.rb

@@ -3,9 +3,9 @@ require "listen"
 require "guard/notifier"
 require "guard/interactor"
 require "guard/runner"
-require "guard/reevaluator"
 require "guard/dsl_describer"
-require "guard"
+
+require "guard/internals/state"
 
 module Guard
   # Commands supported by guard
@@ -37,14 +37,18 @@ module Guard
       watched = Guard.state.session.watchdirs.join("', '")
       UI.info "Guard is now watching at '#{ watched }'"
 
+      exitcode = 0
       begin
         while interactor.foreground != :exit
           Guard.queue.process while Guard.queue.pending?
         end
       rescue Interrupt
+      rescue SystemExit => e
+        exitcode = e.status
       end
 
       stop
+      exitcode
     end
 
     def stop
@@ -63,15 +67,9 @@ 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
       UI.clear(force: true)
       UI.action_with_scopes("Reload", scopes)
-
-      if scopes.empty?
-        Reevaluator.new.reevaluate
-      else
-        Runner.new.run(:reload, scopes)
-      end
+      Runner.new.run(:reload, scopes)
     end
 
     # Trigger `run_all` on all Guard plugins currently enabled.

data/lib/guard/commands/all.rb

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

data/lib/guard/commands/reload.rb

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