guard 1.8.3 → 2.0.0.pre

data/lib/guard/cli.rb

@@ -1,5 +1,10 @@
 require 'thor'
 
+require 'guard'
+require 'guard/version'
+require 'guard/dsl_describer'
+require 'guard/guardfile'
+
 module Guard
 
   # Facade for the Guard command line interface managed by [Thor](https://github.com/wycats/thor).
@@ -8,97 +13,78 @@ module Guard
   #
   class CLI < Thor
 
-    require 'guard'
-    require 'guard/version'
-    require 'guard/dsl_describer'
-    require 'guard/guardfile'
-
     default_task :start
 
     desc 'start', 'Starts Guard'
 
     method_option :clear,
-                  :type    => :boolean,
-                  :default => false,
-                  :aliases => '-c',
-                  :banner  => 'Auto clear shell before each action'
+                  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'
+                  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'
+                  type:    :array,
+                  default: [],
+                  aliases: '-P',
+                  banner:  'Run only the passed plugins'
 
     method_option :watchdir,
-                  :type    => :array,
-                  :aliases => '-w',
-                  :banner  => 'Specify the directories 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'
+                  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,
+                  banner: 'Turn on deprecation warnings'
 
     # 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'
 
     # 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`.
@@ -106,7 +92,7 @@ module Guard
     # @see Guard.start
     #
     def start
-      verify_bundler_presence unless options[:no_bundler_warning]
+      _verify_bundler_presence unless options[:no_bundler_warning]
       ::Guard.start(options)
 
       return if ENV['GUARD_ENV'] == 'test'
@@ -116,7 +102,7 @@ module Guard
       end
     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`.
@@ -124,7 +110,17 @@ module Guard
     # @see Guard::DslDescriber.list
     #
     def list
-      ::Guard::DslDescriber.list(options)
+      ::Guard::DslDescriber.new(options).list
+    end
+
+    desc 'notifiers', 'Lists notifiers and its options'
+
+    # List the Notifiers for use in your system.
+    #
+    # @see Guard::DslDescriber.notifiers
+    #
+    def notifiers
+      ::Guard::DslDescriber.new(options).notifiers
     end
 
     desc 'version', 'Show the Guard version'
@@ -138,35 +134,35 @@ module Guard
       puts "Guard version #{ ::Guard::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
+    def init(*plugin_names)
+      _verify_bundler_presence
 
-      ::Guard::Guardfile.create_guardfile(:abort_on_existence => options[:bare])
+      ::Guard::Guardfile.create_guardfile(abort_on_existence: options[:bare])
 
       return if options[:bare]
 
-      if guard_names.empty?
+      if plugin_names.empty?
         ::Guard::Guardfile.initialize_all_templates
       else
-        guard_names.each do |guard_name|
-          ::Guard::Guardfile.initialize_template(guard_name)
+        plugin_names.each do |plugin_name|
+          ::Guard::Guardfile.initialize_template(plugin_name)
         end
       end
     end
@@ -180,7 +176,7 @@ module Guard
     # @see Guard::DslDescriber.show
     #
     def show
-      ::Guard::DslDescriber.show(options)
+      ::Guard::DslDescriber.new(options).show
     end
 
     private
@@ -188,7 +184,7 @@ module Guard
     # Verifies if Guard is run with `bundle exec` and
     # shows a hint to do so if not.
     #
-    def verify_bundler_presence
+    def _verify_bundler_presence
       if File.exists?('Gemfile') && !ENV['BUNDLE_GEMFILE']
         ::Guard::UI.info <<EOF
 

data/lib/guard/commander.rb

@@ -0,0 +1,121 @@
+module 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) unless running
+
+      within_preserved_state do
+        ::Guard::UI.debug 'Guard starts all plugins'
+        runner.run(:start)
+        ::Guard::UI.info "Guard is now watching at '#{ @watchdirs.join "', '" }'"
+        listener.start
+      end
+    end
+
+    # Stop Guard listening to file changes.
+    #
+    def stop
+      setup unless running
+
+      within_preserved_state do
+        ::Guard::UI.debug 'Guard stops all plugins'
+        runner.run(:stop)
+        ::Guard::Notifier.turn_off
+        ::Guard::UI.info 'Bye bye...', reset: true
+        listener.stop
+        @running = false
+      end
+    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 = {})
+      setup unless running
+
+      within_preserved_state do
+        ::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
+    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 = {})
+      setup unless running
+
+      within_preserved_state do
+        ::Guard::UI.clear(force: true)
+        ::Guard::UI.action_with_scopes('Run all', scopes)
+        runner.run(:run_all, scopes)
+      end
+    end
+
+    # Pause Guard listening to file changes.
+    #
+    def pause
+      if listener.paused?
+        ::Guard::UI.info 'Un-paused files modification listening', reset: true
+        listener.unpause
+      else
+        ::Guard::UI.info 'Paused files modification listening', reset: true
+        listener.pause
+      end
+    end
+
+    # Runs a block where the interactor is
+    # blocked and execution is synchronized
+    # to avoid state inconsistency.
+    #
+    # @param [Boolean] restart_interactor whether to restart the interactor or
+    #   not
+    # @yield the block to run
+    #
+    def within_preserved_state
+      lock.synchronize do
+        begin
+          interactor.stop if interactor
+          @result = yield
+        rescue Interrupt
+          # Bring back Pry when the block is halted with Ctrl-C
+        end
+
+        interactor.start if running
+      end
+
+      @result
+    end
+
+  end
+
+end

data/lib/guard/commands/all.rb

@@ -22,7 +22,7 @@ module Guard
           if rest.empty?
             ::Guard.run_all scopes
           else
-            output.puts "Unkown scope #{ rest.join(', ') }"
+            output.puts "Unknown scope #{ rest.join(', ') }"
           end
         end
       end

data/lib/guard/commands/reload.rb

@@ -22,7 +22,7 @@ module Guard
           if rest.empty?
             ::Guard.reload scopes
           else
-            output.puts "Unkown scope #{ rest.join(', ') }"
+            output.puts "Unknown scope #{ rest.join(', ') }"
           end
         end
 

data/lib/guard/deprecated_methods.rb

@@ -0,0 +1,59 @@
+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)
+      ::Guard::UI.deprecation(::Guard::Deprecator::GET_GUARD_CLASS_DEPRECATION)
+      ::Guard::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)
+      ::Guard::UI.deprecation(::Guard::Deprecator::LOCATE_GUARD_DEPRECATION)
+      ::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
+    #
+    def guard_gem_names
+      ::Guard::UI.deprecation(::Guard::Deprecator::GUARD_GEM_NAMES_DEPRECATION)
+      ::Guard::PluginUtil.plugin_names
+    end
+
+  end
+
+end