guard 1.4.0 → 2.18.0

data/bin/_guard-core

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "guard"
+
+begin
+  require "guard/aruba_adapter"
+rescue LoadError => e
+  abort "#{e.inspect} - perhaps you need to run using `bundle exec`?"
+end
+
+Guard::ArubaAdapter.new(ARGV.dup).execute!

data/bin/guard

@@ -1,6 +1,111 @@
 #!/usr/bin/env ruby
 
-require 'guard'
-require 'guard/cli'
+require "pathname"
 
-Guard::CLI.start
+class GuardReloader
+  class Config
+    def using_rubygems?
+      ENV["RUBYGEMS_GEMDEPS"]
+    end
+
+    def setup_rubygems_for_deps
+      require "rubygems"
+    end
+
+    def current_bundler_gemfile
+      ENV["BUNDLE_GEMFILE"]
+    end
+
+    def using_bundler?
+      ENV["BUNDLE_GEMFILE"]
+    end
+
+    def setup_bundler_env(gemfile)
+      ENV["BUNDLE_GEMFILE"] = gemfile
+    end
+
+    def setup_bundler
+      require "rubygems"
+      require "bundler/setup"
+    end
+
+    def program_path
+      Pathname(__FILE__)
+    end
+
+    def program_arguments
+      ARGV
+    end
+
+    def windows?
+      Gem.win_platform?
+    end
+
+    def exit_with(code)
+      exit(code)
+    end
+
+    def spawn_with(*args)
+      spawn(*args)
+    end
+
+    def wait_ignoring_interrupts(pid)
+      Process.wait2(pid)[1].exitstatus
+    rescue Interrupt
+      retry
+    rescue Errno::ECHILD
+      1
+    end
+
+    def exist?(path)
+      path.exist?
+    end
+
+    def guard_core_path
+      Gem.bin_path("guard", "_guard-core")
+    end
+  end
+
+  attr_reader :config
+  def initialize(config)
+    @config = config
+  end
+
+  def setup
+    return config.setup_bundler if config.using_bundler?
+    return config.setup_rubygems_for_deps if config.using_rubygems?
+
+    # No dependency management detected - check if binstubbed by bundler
+    relative_to_binstub = config.program_path + "../../Gemfile"
+    if config.exist?(relative_to_binstub)
+      config.setup_bundler_env(relative_to_binstub.to_s)
+      config.setup_bundler
+      return
+    end
+
+    unless config.exist?(Pathname("Gemfile"))
+      # Running guard with bare ruby here - it's up to the user
+      # to setup/install missing deps
+      return
+    end
+
+    STDERR.puts "Warning: you have a Gemfile, but you're not using"\
+      " bundler or RUBYGEMS_GEMDEPS"
+  end
+
+  def auto_restart
+    args = [Gem.ruby, config.guard_core_path] + config.program_arguments
+
+    loop do
+      exitcode = config.wait_ignoring_interrupts(config.spawn_with(*args))
+      config.exit_with(exitcode) if exitcode != 2
+    end
+  end
+end
+
+unless ENV["GUARD_SPECS_RUNNING"]
+  config = GuardReloader::Config.new
+  reloader = GuardReloader.new(config)
+  reloader.setup
+  reloader.auto_restart
+end

data/lib/guard/aruba_adapter.rb

@@ -0,0 +1,59 @@
+require "guard/cli"
+
+module Guard
+  class ArubaAdapter
+    def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR,
+                   kernel = Kernel)
+      @argv = argv
+      @stdin = stdin
+      @stdout = stdout
+      @stderr = stderr
+      @kernel = kernel
+
+      if ENV["INSIDE_ARUBA_TEST"] == "1"
+        UI.options = UI.options.merge(flush_seconds: 0)
+      end
+    end
+
+    def execute!
+      exit_code = execute
+      # Proxy our exit code back to the injected kernel.
+      @kernel.exit(exit_code)
+    end
+
+    def execute
+      # Thor accesses these streams directly rather than letting
+      # them be injected, so we replace them...
+      $stderr = @stderr
+      $stdin = @stdin
+      $stdout = @stdout
+
+      # Run our normal Thor app the way we know and love.
+      CLI.start(@argv)
+
+      # Thor::Base#start does not have a return value, assume
+      # success if no exception is raised.
+      0
+    rescue StandardError => e
+      # The ruby interpreter would pipe this to STDERR and exit 1 in the case
+      # of an unhandled exception
+      b = e.backtrace
+      @stderr.puts "#{b.shift}: #{e.message} (#{e.class})"
+      @stderr.puts b.map { |s| "\tfrom #{s}" }.join("\n")
+      1
+    rescue SystemExit => e
+      e.status
+    ensure
+      # flush the logger so the output doesn't appear in next CLI invocation
+      Guard.listener.stop if Guard.listener
+      UI.logger.flush
+      UI.logger.close
+      UI.reset_logger
+
+      # ...then we put them back.
+      $stderr = STDERR
+      $stdin = STDIN
+      $stdout = STDOUT
+    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,69 @@
+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
+          rescue Guard::Guardfile::Evaluator::NoPluginsError
+            # Do nothing - just the error
+          end
+
+          return 0 if bare # 0 - exit code
+
+          # Evaluate because it might have existed and creating was skipped
+          begin
+            Guardfile::Evaluator.new(session.evaluator_options).evaluate
+          rescue Guard::Guardfile::Evaluator::NoPluginsError
+          end
+
+          begin
+            if plugin_names.empty?
+              generator.initialize_all_templates
+            else
+              plugin_names.each do |plugin_name|
+                generator.initialize_template(plugin_name)
+              end
+            end
+          rescue Guardfile::Generator::Error => e
+            UI.error(e.message)
+            return 1
+          end
+
+          # TODO: capture exceptions to show msg and return exit code on
+          # failures
+          0 # exit code
+        end
+      end
+    end
+  end
+end

data/lib/guard/cli.rb

@@ -1,125 +1,152 @@
-require 'thor'
+require "thor"
 
-module Guard
+require "guard/version"
+
+require "guard/dsl_describer"
+require "guard/cli/environments/valid"
+require "guard/cli/environments/evaluate_only"
 
-  # Facade for the Guard command line interface managed by [Thor](https://github.com/wycats/thor).
-  # This is the main interface to Guard that is called by the Guard binary `bin/guard`.
-  # Do not put any logic in here, create a class and delegate instead.
+module Guard
+  # Facade for the Guard command line interface managed by
+  # [Thor](https://github.com/wycats/thor).
+  #
+  # This is the main interface to Guard that is called by the Guard binary
+  # `bin/guard`. Do not put any logic in here, create a class and delegate
+  # instead.
   #
   class CLI < Thor
-
-    require 'guard'
-    require 'guard/version'
-    require 'guard/dsl_describer'
-    require 'guard/guardfile'
-
     default_task :start
 
-    desc 'start', 'Starts Guard'
+    desc "start", "Starts Guard"
 
     method_option :clear,
-                  :type    => :boolean,
-                  :default => false,
-                  :aliases => '-c',
-                  :banner  => 'Auto clear shell before each change/run_all/reload'
+                  type: :boolean,
+                  default: false,
+                  aliases: "-c",
+                  banner: "Auto clear shell before each action"
 
     method_option :notify,
-                  :type    => :boolean,
-                  :default => true,
-                  :aliases => '-n',
-                  :banner  => 'Notifications feature (growl/libnotify)'
+                  type: :boolean,
+                  default: true,
+                  aliases: "-n",
+                  banner: "Notifications feature"
 
     method_option :debug,
-                  :type    => :boolean,
-                  :default => false,
-                  :aliases => '-d',
-                  :banner  => 'Show debug information'
+                  type: :boolean,
+                  default: false,
+                  aliases: "-d",
+                  banner: "Show debug information"
 
     method_option :group,
-                  :type    => :array,
-                  :default => [],
-                  :aliases => '-g',
-                  :banner  => 'Run only the passed groups'
-
+                  type: :array,
+                  default: [],
+                  aliases: "-g",
+                  banner: "Run only the passed groups"
+
+    method_option :plugin,
+                  type: :array,
+                  default: [],
+                  aliases: "-P",
+                  banner: "Run only the passed plugins"
+
+    # TODO: make it plural
     method_option :watchdir,
-                  :type    => :string,
-                  :aliases => '-w',
-                  :banner  => 'Specify the directory to watch'
+                  type: :array,
+                  aliases: "-w",
+                  banner: "Specify the directories to watch"
 
     method_option :guardfile,
-                  :type    => :string,
-                  :aliases => '-G',
-                  :banner  => 'Specify a Guardfile'
-
-    # DEPRECATED
-    method_option :no_vendor,
-                  :type    => :boolean,
-                  :default => false,
-                  :aliases => '-I',
-                  :banner  => 'DEPRECATED: Ignore vendored dependencies'
-
-    # DEPRECATED
-    method_option :watch_all_modifications,
-                  :type => :boolean,
-                  :default => false,
-                  :aliases => '-A',
-                  :banner => 'DEPRECATED: Watch for all file modifications including moves and deletions'
+                  type: :string,
+                  aliases: "-G",
+                  banner: "Specify a Guardfile"
 
     method_option :no_interactions,
-                  :type => :boolean,
-                  :default => false,
-                  :aliases => '-i',
-                  :banner => 'Turn off completely any guard terminal interactions'
+                  type: :boolean,
+                  default: false,
+                  aliases: "-i",
+                  banner: "Turn off completely any Guard terminal interactions"
 
     method_option :no_bundler_warning,
-                  :type => :boolean,
-                  :default => false,
-                  :aliases => '-B',
-                  :banner => 'Turn off warning when Bundler is not present'
-
-    method_option :show_deprecations,
-                  :type => :boolean,
-                  :default => false,
-                  :banner => 'Turn on deprecation warnings'
+                  type: :boolean,
+                  default: false,
+                  aliases: "-B",
+                  banner: "Turn off warning when Bundler is not present"
 
     # Listen options
     method_option :latency,
-                  :type    => :numeric,
-                  :aliases => '-l',
-                  :banner  => 'Overwrite Listen\'s default latency'
+                  type: :numeric,
+                  aliases: "-l",
+                  banner: 'Overwrite Listen\'s default latency'
 
     method_option :force_polling,
-                  :type    => :boolean,
-                  :default => false,
-                  :aliases => '-p',
-                  :banner  => 'Force usage of the Listen polling listener'
+                  type: :boolean,
+                  default: false,
+                  aliases: "-p",
+                  banner: "Force usage of the Listen polling listener"
+
+    method_option :wait_for_delay,
+                  type: :numeric,
+                  aliases: "-y",
+                  banner: 'Overwrite Listen\'s default wait_for_delay'
+
+    method_option :listen_on,
+                  type: :string,
+                  aliases: "-o",
+                  default: nil,
+                  banner: "Specify a network address to Listen on for "\
+                  "file change events (e.g. for use in VMs)"
+
+    def self.help(shell, subcommand = false)
+      super
+      command_help(shell, default_task)
+    end
 
-    # Start Guard by initializing the defined Guard plugins and watch the file system.
-    # This is the default task, so calling `guard` is the same as calling `guard start`.
+    # Start Guard by initializing the defined Guard plugins and watch the file
+    # system.
+    #
+    # This is the default task, so calling `guard` is the same as calling
+    # `guard start`.
     #
     # @see Guard.start
     #
     def start
-      verify_bundler_presence unless options[:no_bundler_warning]
-      ::Guard.start(options)
-    rescue Interrupt
-      ::Guard.stop
-      abort
+      if defined?(JRUBY_VERSION)
+        unless options[:no_interactions]
+          abort "\nSorry, JRuby and interactive mode are incompatible.\n"\
+            "As a workaround, use the '-i' option instead.\n\n"\
+            "More info: \n"\
+            " * https://github.com/guard/guard/issues/754\n"\
+            " * https://github.com/jruby/jruby/issues/2383\n\n"
+        end
+      end
+      exit(Cli::Environments::Valid.new(options).start_guard)
     end
 
-    desc 'list', 'Lists guards that can be used with init'
+    desc "list", "Lists Guard plugins that can be used with init"
 
-    # List the Guard plugins that are available for use in your system and marks
-    # those that are currently used in your `Guardfile`.
+    # List the Guard plugins that are available for use in your system and
+    # marks those that are currently used in your `Guardfile`.
     #
     # @see Guard::DslDescriber.list
     #
     def list
-      verify_bundler_presence
-      ::Guard::DslDescriber.list(options)
+      Cli::Environments::EvaluateOnly.new(options).evaluate
+      DslDescriber.new.list
+    end
+
+    desc "notifiers", "Lists notifiers and its options"
+
+    # List the Notifiers for use in your system.
+    #
+    # @see Guard::DslDescriber.notifiers
+    #
+    def notifiers
+      Cli::Environments::EvaluateOnly.new(options).evaluate
+      # TODO: pass the data directly to the notifiers?
+      DslDescriber.new.notifiers
     end
 
-    desc 'version', 'Show the Guard version'
+    desc "version", "Show the Guard version"
     map %w(-v --version) => :version
 
     # Shows the current version of Guard.
@@ -127,44 +154,37 @@ module Guard
     # @see Guard::VERSION
     #
     def version
-      verify_bundler_presence
-      ::Guard::UI.info "Guard version #{ ::Guard::VERSION }"
+      $stdout.puts "Guard version #{ VERSION }"
     end
 
-    desc 'init [GUARDS]', 'Generates a Guardfile at the current directory (if it is not already there) and adds all installed guards or the given GUARDS into it'
+    desc "init [GUARDS]", "Generates a Guardfile at the current directory"\
+      " (if it is not already there) and adds all installed Guard plugins"\
+      " or the given GUARDS into it"
 
     method_option :bare,
-                  :type => :boolean,
-                  :default => false,
-                  :aliases => '-b',
-                  :banner => 'Generate a bare Guardfile without adding any installed guard into it'
+                  type: :boolean,
+                  default: false,
+                  aliases: "-b",
+                  banner: "Generate a bare Guardfile without adding any"\
+                  " installed plugin into it"
 
     # Initializes the templates of all installed Guard plugins and adds them
     # to the `Guardfile` when no Guard name is passed. When passing
     # Guard plugin names it does the same but only for those Guard plugins.
     #
-    # @see Guard::Guard.initialize_template
-    # @see Guard::Guard.initialize_all_templates
+    # @see Guard::Guardfile.initialize_template
+    # @see Guard::Guardfile.initialize_all_templates
     #
-    # @param [Array<String>] guard_names the name of the Guard plugins to initialize
+    # @param [Array<String>] plugin_names the name of the Guard plugins to
+    # initialize
     #
-    def init(*guard_names)
-      verify_bundler_presence
-
-      ::Guard::Guardfile.create_guardfile(:abort_on_existence => options[:bare])
-
-      return if options[:bare]
-
-      if guard_names.empty?
-        ::Guard::Guardfile::initialize_all_templates
-      else
-        guard_names.each do |guard_name|
-          ::Guard::Guardfile.initialize_template(guard_name)
-        end
-      end
+    def init(*plugin_names)
+      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'
+    desc "show", "Show all defined Guard plugins and their options"
     map %w(-T) => :show
 
     # Shows all Guard plugins and their options that are defined in
@@ -173,27 +193,8 @@ module Guard
     # @see Guard::DslDescriber.show
     #
     def show
-      verify_bundler_presence
-      ::Guard::DslDescriber.show(options)
+      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.
-    #
-    def verify_bundler_presence
-      if File.exists?('Gemfile') && !ENV['BUNDLE_GEMFILE']
-        ::Guard::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