class Guard::ReadlineInteractor


@see bugs.ruby-lang.org/issues/5539<br><br>broken on OS X without installing ‘rb-readline` or using JRuby.
This enables history support and auto-completion, but is
Interactor that used readline for getting the user input.

def auto_complete(word)

Returns:
  • (Array) - the matching words

Parameters:
  • word (String) -- the partial word 
def auto_complete(word)
  completion_list.grep(/^#{ Regexp.escape(word) }/)
end

def completion_list

Returns:
  • (Array) - the list of words 
def completion_list
  groups = ::Guard.groups.map { |group| group.name.to_s }
  guards = ::Guard.guards.map { |guard| guard.class.to_s.downcase.sub('guard::', '') }
  COMPLETION_ACTIONS + groups + guards - ['default']
end

def initialize


Initialize the interactor. 
def initialize
  require 'readline'
  unless defined?(RbReadline) || defined?(JRUBY_VERSION) || RbConfig::CONFIG['target_os'] =~ /linux/i
    ::Guard::UI.info 'Please add rb-readline for proper Readline support.'
  end
  Readline.completion_proc = proc { |word| auto_complete(word) }
  begin
    Readline.completion_append_character = ' '
  rescue NotImplementedError
    # Ignore, we just don't support it then
  end
end

def prompt

Returns:
  • (String) - the prompt to show 
def prompt
  ::Guard.listener.paused? ? 'p> ' : '> '
end

def read_line


Read a line from stdin with Readline. 
def read_line
  while line = Readline.readline(prompt, true)
    line.gsub!(/^\W*/, '')
    if line =~ /^\s*$/ or Readline::HISTORY.to_a[-2] == line
      Readline::HISTORY.pop
    end
    process_input(line)
  end
end

def restore_terminal_settings


Restore terminal settings 
def restore_terminal_settings
  system('stty', @stty_save, '2>/dev/null')
end

def start


Start the interactor. 
def start
  store_terminal_settings if stty_exists?
  super
end

def stop


Stop the interactor. 
def stop
  super
  restore_terminal_settings if stty_exists?
end

def store_terminal_settings


when stopping.
Stores the terminal settings so we can resore them 
def store_terminal_settings
  @stty_save = `stty -g 2>/dev/null`.chomp
end

def stty_exists?

Returns:
  • (Boolean) - the status of stty 
def stty_exists?
  system('hash', 'stty')
end