guard 1.4.0 → 2.18.0

data/lib/guard/commander.rb

@@ -0,0 +1,104 @@
+require "listen"
+
+require "guard/notifier"
+require "guard/interactor"
+require "guard/runner"
+require "guard/dsl_describer"
+
+require "guard/internals/state"
+
+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)
+      UI.debug "Guard starts all plugins"
+      Runner.new.run(:start)
+      listener.start
+
+      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
+
+      exitcode
+    ensure
+      stop
+    end
+
+    def stop
+      listener&.stop
+      interactor&.background
+      UI.debug "Guard stops all plugins"
+      Runner.new.run(:stop)
+      Notifier.disconnect
+      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 = {})
+      UI.clear(force: true)
+      UI.action_with_scopes("Reload", scopes)
+      Runner.new.run(:reload, scopes)
+    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 = {})
+      UI.clear(force: true)
+      UI.action_with_scopes("Run", scopes)
+      Runner.new.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.public_send(pause ? :pause : :start)
+      UI.info "File event handling has been #{pause ? 'paused' : 'resumed'}"
+    end
+
+    def show
+      DslDescriber.new.show
+    end
+  end
+  extend Commander
+end

data/lib/guard/commands/all.rb

@@ -0,0 +1,37 @@
+# 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.state.session.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/change.rb

@@ -0,0 +1,31 @@
+require "pry"
+
+require "guard"
+
+module Guard
+  module Commands
+    class Change
+      def self.import
+        Pry::Commands.create_command "change" do
+          group "Guard"
+          description "Trigger a file change."
+
+          banner <<-BANNER
+          Usage: change <file> <other_file>
+
+          Pass the given files to the Guard plugin `run_on_changes` action.
+          BANNER
+
+          def process(*files)
+            if files.empty?
+              output.puts "Please specify a file."
+              return
+            end
+
+            Guard.async_queue_add(modified: files, added: [], removed: [])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/guard/commands/notification.rb

@@ -0,0 +1,26 @@
+require "pry"
+
+require "guard/notifier"
+
+module Guard
+  module Commands
+    class Notification
+      def self.import
+        Pry::Commands.create_command "notification" do
+          group "Guard"
+          description "Toggles the notifications."
+
+          banner <<-BANNER
+          Usage: notification
+
+          Toggles the notifications on and off.
+          BANNER
+
+          def process
+            Notifier.toggle
+          end
+        end
+      end
+    end
+  end
+end

data/lib/guard/commands/pause.rb

@@ -0,0 +1,29 @@
+require "pry"
+
+require "guard"
+
+module Guard
+  module Commands
+    class Pause
+      def self.import
+        Pry::Commands.create_command "pause" do
+          group "Guard"
+          description "Toggles the file listener."
+
+          banner <<-BANNER
+          Usage: pause
+
+          Toggles the file listener on and off.
+
+          When the file listener is paused, the default Guard Pry
+          prompt will show the pause sign `[p]`.
+          BANNER
+
+          def process
+            ::Guard.async_queue_add([:guard_pause])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/guard/commands/reload.rb

@@ -0,0 +1,36 @@
+require "pry"
+
+require "guard"
+
+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.state.session.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

@@ -0,0 +1,38 @@
+require "pry"
+require "guard/interactor"
+require "guard"
+
+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.state.session.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.state.scope.from_interactor(scope)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/guard/commands/show.rb

@@ -0,0 +1,24 @@
+require "pry"
+
+module Guard
+  module Commands
+    class Show
+      def self.import
+        Pry::Commands.create_command "show" do
+          group "Guard"
+          description "Show all Guard plugins."
+
+          banner <<-BANNER
+          Usage: show
+
+          Show all defined Guard plugins and their options.
+          BANNER
+
+          def process
+            Guard.async_queue_add([:guard_show])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/guard/config.rb

@@ -0,0 +1,18 @@
+require "nenv"
+
+module Guard
+  config_class = Nenv::Builder.build do
+    create_method(:strict?)
+    create_method(:gem_silence_deprecations?)
+  end
+
+  class Config < config_class
+    def initialize
+      super "guard"
+    end
+
+    def silence_deprecations?
+      gem_silence_deprecations?
+    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/evaluator.rb

@@ -0,0 +1,39 @@
+require "guard/config"
+fail "Deprecations disabled (strict mode)" if Guard::Config.new.strict?
+
+require "guard/ui"
+
+module Guard
+  module Deprecated
+    module Evaluator
+      def self.add_deprecated(klass)
+        klass.send(:include, self)
+      end
+
+      EVALUATE_GUARDFILE = <<-EOS.gsub(/^\s*/, "")
+        Starting with Guard 2.8.3 'Guard::Evaluator#evaluate_guardfile' is
+        deprecated in favor of '#evaluate'.
+      EOS
+
+      REEVALUATE_GUARDFILE = <<-EOS.gsub(/^\s*/, "")
+        Starting with Guard 2.8.3 'Guard::Evaluator#reevaluate_guardfile' is
+        deprecated in favor of '#reevaluate'.
+
+        NOTE: this method no longer does anything since it could not be
+        implemented reliably.
+      EOS
+
+      def evaluate_guardfile
+        UI.deprecation(EVALUATE_GUARDFILE)
+        evaluate
+      end
+
+      def reevaluate_guardfile
+        # require guard only when needed, because
+        # guard's deprecations require us
+        require "guard"
+        UI.deprecation(REEVALUATE_GUARDFILE)
+      end
+    end
+  end
+end