guard 2.6.1 → 2.7.0

data/lib/guard/guardfile/generator.rb

@@ -1,27 +1,28 @@
 module Guard
   module Guardfile
-
     # This class is responsible for generating the Guardfile and adding Guard'
     # plugins' templates into it.
     #
     # @see Guard::CLI
     #
     class Generator
-
-      require 'guard'
-      require 'guard/ui'
+      require "guard"
+      require "guard/ui"
 
       attr_reader :options
 
       # The Guardfile template for `guard init`
-      GUARDFILE_TEMPLATE = File.expand_path('../../../guard/templates/Guardfile', __FILE__)
+      GUARDFILE_TEMPLATE = File.expand_path(
+        "../../../guard/templates/Guardfile",
+        __FILE__)
 
       # The location of user defined templates
       begin
-        HOME_TEMPLATES = File.expand_path('~/.guard/templates')
-      rescue ArgumentError => e
-        # home isn't defined.  Set to the root of the drive.  Trust that there won't be user defined templates there
-        HOME_TEMPLATES = File.expand_path('/')
+        HOME_TEMPLATES = File.expand_path("~/.guard/templates")
+      rescue ArgumentError
+        # home isn't defined.  Set to the root of the drive.  Trust that there
+        # won't be user defined templates there
+        HOME_TEMPLATES = File.expand_path("/")
       end
 
       # Initialize a new `Guard::Guardfile::Generator` object.
@@ -40,9 +41,9 @@ module Guard
       # @see Guard::CLI#init
       #
       def create_guardfile
-        if !File.exist?('Guardfile')
+        if !File.exist?("Guardfile")
           ::Guard::UI.info "Writing new Guardfile to #{ Dir.pwd }/Guardfile"
-          FileUtils.cp(GUARDFILE_TEMPLATE, 'Guardfile')
+          FileUtils.cp(GUARDFILE_TEMPLATE, "Guardfile")
         elsif options[:abort_on_existence]
           ::Guard::UI.error "Guardfile already exists at #{ Dir.pwd }/Guardfile"
           abort
@@ -61,21 +62,27 @@ module Guard
         if plugin_util.plugin_class(fail_gracefully: true)
           plugin_util.add_to_guardfile
 
-          @options[:guardfile] = File.read('Guardfile') if File.exists?('Guardfile')
+          begin
+            @options[:guardfile] = IO.read("Guardfile")
+          rescue Errno::ENOENT
+          end
 
         elsif File.exist?(File.join(HOME_TEMPLATES, plugin_name))
-          content = File.read('Guardfile')
+          content = File.read("Guardfile")
 
-          File.open('Guardfile', 'wb') do |f|
+          File.open("Guardfile", "wb") do |f|
             f.puts(content)
-            f.puts('')
+            f.puts("")
             f.puts(File.read(File.join(HOME_TEMPLATES, plugin_name)))
           end
 
-          ::Guard::UI.info "#{ plugin_name } template added to Guardfile, feel free to edit it"
+          ::Guard::UI.info \
+            "#{ plugin_name } template added to Guardfile, feel free to edit it"
         else
-          const_name = plugin_name.downcase.gsub('-', '')
-          UI.error "Could not load 'guard/#{ plugin_name.downcase }' or '~/.guard/templates/#{ plugin_name.downcase }' or find class Guard::#{ const_name.capitalize }"
+          const_name = plugin_name.downcase.gsub("-", "")
+          UI.error "Could not load 'guard/#{ plugin_name.downcase }'"\
+            " or '~/.guard/templates/#{ plugin_name.downcase }'"\
+            " or find class Guard::#{ const_name.capitalize }"
         end
       end
 
@@ -87,8 +94,6 @@ module Guard
       def initialize_all_templates
         ::Guard::PluginUtil.plugin_names.each { |g| initialize_template(g) }
       end
-
     end
-
   end
 end

data/lib/guard/interactor.rb

@@ -1,326 +1,85 @@
-require 'pry'
+require "guard/ui"
 
-require 'guard/commands/all'
-require 'guard/commands/change'
-require 'guard/commands/notification'
-require 'guard/commands/pause'
-require 'guard/commands/reload'
-require 'guard/commands/scope'
-require 'guard/commands/show'
-require 'guard/ui'
+require "guard/jobs/sleep"
+require "guard/jobs/pry_wrapper"
 
 module Guard
-
-  # The Guard interactor is a Pry REPL with a Guard
-  # specific command set.
-  #
   class Interactor
-
-    # The default Ruby script to configure Guard Pry if the option `:guard_rc` is not defined.
-    GUARD_RC = '~/.guardrc'
-
-    # The default Guard Pry history file if the option `:history_file` is not defined.
-    HISTORY_FILE = '~/.guard_history'
-
-    # List of shortcuts for each interactor command
-    SHORTCUTS = {
-      help:         'h',
-      all:          'a',
-      reload:       'r',
-      change:       'c',
-      show:         's',
-      scope:        'o',
-      notification: 'n',
-      pause:        'p',
-      exit:         'e',
-      quit:         'q'
-    }
-
-    attr_accessor :thread
-
-    # Get the interactor options
-    #
-    # @return [Hash] the options
-    #
-    def self.options
-      @options ||= {}
-    end
-
-    # Set the interactor options
-    #
-    # @param [Hash] options the interactor options
-    # @option options [String] :guard_rc the Ruby script to configure Guard Pry
-    # @option options [String] :history_file the file to write the Pry history to
-    #
-    def self.options=(options)
-      @options = options
-    end
-
-    # Is the interactor enabled?
-    #
-    # @return [Boolean] true if enabled
-    #
-    def self.enabled
-      @enabled || @enabled.nil?
-    end
-
-    # Set the enabled status for the interactor
-    #
-    # @param [Boolean] status true if enabled
-    #
-    def self.enabled=(status)
-      @enabled = status
-    end
-
-    # Converts and validates a plain text scope
-    # to a valid plugin or group scope.
-    #
-    # @param [Array<String>] entries the text scope
-    # @return [Hash, Array<String>] the plugin or group scope, the unknown entries
-    #
-    def self.convert_scope(entries)
-      scopes  = { plugins: [], groups: [] }
-      unknown = []
-
-      entries.each do |entry|
-        if plugin = ::Guard.plugin(entry)
-          scopes[:plugins] << plugin
-        elsif group = ::Guard.group(entry)
-          scopes[:groups] << group
-        else
-          unknown << entry
-        end
-      end
-
-      [scopes, unknown]
-    end
-
     # Initializes the interactor. This configures
     # Pry and creates some custom commands and aliases
     # for Guard.
     #
-    def initialize
-      return if ENV['GUARD_ENV'] == 'test'
-
-      Pry.config.should_load_rc       = false
-      Pry.config.should_load_local_rc = false
-      Pry.config.history.file         = File.expand_path(self.class.options[:history_file] || HISTORY_FILE)
-
-      @stty_exists = nil
-      _add_hooks
-
-      _replace_reset_command
-      _create_run_all_command
-      _create_command_aliases
-      _create_guard_commands
-      _create_group_commands
-
-      _configure_prompt
-    end
-
-    # Start the line reader in its own thread and
-    # stop Guard on Ctrl-D.
-    #
-    def start
-      return if ENV['GUARD_ENV'] == 'test'
-
-      _store_terminal_settings if _stty_exists?
-
-      unless @thread
-        ::Guard::UI.debug 'Start interactor'
-
-        @thread = Thread.new do
-          Pry.start
-          ::Guard.stop
-        end
-      end
-    end
-
-    # Kill interactor thread if not current
-    #
-    def stop
-      return if !@thread || ENV['GUARD_ENV'] == 'test'
-
-      unless Thread.current == @thread
-        ::Guard::UI.reset_line
-        ::Guard::UI.debug 'Stop interactor'
-        @thread.kill
-        @thread = nil
-      end
-
-      _restore_terminal_settings if _stty_exists?
-    end
-
-    private
-
-    # Add Pry hooks:
-    #
-    # * Load `~/.guardrc` within each new Pry session.
-    # * Load project's `.guardrc` within each new Pry session.
-    # * Restore prompt after each evaluation.
-    #
-    def _add_hooks
-      _add_load_guard_rc_hook
-      _add_load_project_guard_rc_hook
-      _add_restore_visibility_hook if _stty_exists?
-    end
+    def initialize(no_interaction = false)
+      @interactive = !no_interaction && self.class.enabled?
 
-    # Add a `when_started` hook that loads a global .guardrc if it exists.
-    #
-    def _add_load_guard_rc_hook
-      Pry.config.hooks.add_hook :when_started, :load_guard_rc do
-        (self.class.options[:guard_rc] || GUARD_RC).tap do |p|
-          load p if File.exist?(File.expand_path(p))
-        end
-      end
+      job_klass = interactive? ? Jobs::PryWrapper : Jobs::Sleep
+      @idle_job = job_klass.new(self.class.options)
     end
 
-    # Add a `when_started` hook that loads a project .guardrc if it exists.
-    #
-    def _add_load_project_guard_rc_hook
-      Pry.config.hooks.add_hook :when_started, :load_project_guard_rc do
-        project_guard_rc = Dir.pwd + '/.guardrc'
-        load project_guard_rc if File.exist?(project_guard_rc)
-      end
+    def interactive?
+      @interactive
     end
 
-    # Add a `after_eval` hook that restores visibility after a command is eval.
-    #
-    def _add_restore_visibility_hook
-      Pry.config.hooks.add_hook :after_eval, :restore_visibility do
-        system("stty echo 2>#{ DEV_NULL }")
-      end
+    # Run in foreground and wait until interrupted or closed
+    def foreground
+      idle_job.foreground
     end
 
-    # Replaces reset defined inside of Pry with a reset that
-    # instead restarts guard.
-    #
-    def _replace_reset_command
-      Pry.commands.command "reset", "Reset the Guard to a clean state." do
-        output.puts "Guard reset."
-        exec "guard"
-      end
+    # Remove interactor so other tasks can run in foreground
+    def background
+      idle_job.background
     end
 
-    # Creates a command that triggers the `:run_all` action
-    # when the command is empty (just pressing enter on the
-    # beginning of a line).
-    #
-    def _create_run_all_command
-      Pry.commands.block_command /^$/, 'Hit enter to run all' do
-        Pry.run_command 'all'
-      end
+    def handle_interrupt
+      idle_job.handle_interrupt
     end
 
-    # Creates command aliases for the commands
-    # `help`, `reload`, `change`, `scope`, `notification`, `pause`, `exit` and `quit`,
-    # which will be the first letter of the command.
-    #
-    def _create_command_aliases
-      SHORTCUTS.each do |command, shortcut|
-        Pry.commands.alias_command shortcut, command.to_s
+    class << self
+      def options
+        @options ||= {}
       end
-    end
 
-    # Create a shorthand command to run the `:run_all`
-    # action on a specific Guard plugin. For example,
-    # when guard-rspec is available, then a command
-    # `rspec` is created that runs `all rspec`.
-    #
-    def _create_guard_commands
-      ::Guard.plugins.each do |guard_plugin|
-        Pry.commands.create_command guard_plugin.name, "Run all #{ guard_plugin.title }" do
-          group 'Guard'
+      # Pass options to interactor's job when it's created
+      attr_writer :options
 
-          def process
-            Pry.run_command "all #{ match }"
-          end
-        end
+      # TODO: allow custom user idle jobs, e.g. [:pry, :sleep, :exit, ...]
+      def enabled?
+        @enabled || @enabled.nil?
       end
-    end
-
-    # Create a shorthand command to run the `:run_all`
-    # action on a specific Guard group. For example,
-    # when you have a group `frontend`, then a command
-    # `frontend` is created that runs `all frontend`.
-    #
-    def _create_group_commands
-      ::Guard.groups.each do |group|
-        next if group.name == :default
 
-        Pry.commands.create_command group.name.to_s, "Run all #{ group.title }" do
-          group 'Guard'
-
-          def process
-            Pry.run_command "all #{ match }"
+      alias_method :enabled, :enabled?
+
+      # TODO: handle switching interactors during runtime?
+      attr_writer :enabled
+
+      # Converts and validates a plain text scope
+      # to a valid plugin or group scope.
+      #
+      # @param [Array<String>] entries the text scope
+      # @return [Hash, Array<String>] the plugin or group scope, the unknown
+      #   entries
+      #
+      # TODO: call this from within action, not within interactor command
+      def convert_scope(entries)
+        scopes  = { plugins: [], groups: [] }
+        unknown = []
+
+        entries.each do |entry|
+          if plugin = ::Guard.plugin(entry)
+            scopes[:plugins] << plugin
+          elsif group = ::Guard.group(entry)
+            scopes[:groups] << group
+          else
+            unknown << entry
           end
         end
-      end
-    end
 
-    # Configures the pry prompt to see `guard` instead of
-    # `pry`.
-    #
-    def _configure_prompt
-      Pry.config.prompt = [_prompt('>'), _prompt('*')]
-    end
-
-    # Returns the plugins scope, or the groups scope ready for display in the
-    # prompt.
-    #
-    def _scope_for_prompt
-      [:plugins, :groups].each do |scope_name|
-        return "#{_join_scope_for_prompt(scope_name)} " unless ::Guard.scope[scope_name].empty?
-      end
-
-      ''
-    end
-
-    # Joins the scope corresponding to the given scope name with commas.
-    #
-    def _join_scope_for_prompt(scope_name)
-      ::Guard.scope[scope_name].map(&:title).join(',')
-    end
-
-    # Returns a proc that will return itself a string ending with the given
-    # `ending_char` when called.
-    #
-    def _prompt(ending_char)
-      proc do |target_self, nest_level, pry|
-        history = pry.input_array.size
-        process = ::Guard.listener.paused? ? 'pause' : 'guard'
-        level   = ":#{ nest_level }" unless nest_level.zero?
-
-        "[#{ history }] #{ _scope_for_prompt }#{ process }(#{ _clip_name(target_self) })#{ level }#{ ending_char } "
+        [scopes, unknown]
       end
     end
 
-    def _clip_name(target)
-      Pry.view_clip(target)
-    end
-
-    # Detects whether or not the stty command exists
-    # on the user machine.
-    #
-    # @return [Boolean] the status of stty
-    #
-    def _stty_exists?
-      @stty_exists ||= system('hash', 'stty') ? true : false if @stty_exists.nil?
-      @stty_exists
-    end
-
-    # Stores the terminal settings so we can resore them
-    # when stopping.
-    #
-    def _store_terminal_settings
-      @stty_save = `stty -g 2>#{ DEV_NULL }`.chomp
-    end
-
-    # Restore terminal settings
-    #
-    def _restore_terminal_settings
-      system("stty #{ @stty_save } 2>#{ DEV_NULL }") if @stty_save
-    end
+    private
 
+    attr_reader :idle_job
   end
 end