Module: MiniReadline

Defined in:: lib/mini_readline.rb,
lib/mini_readline/options.rb,
lib/mini_readline/version.rb,
lib/mini_readline/read_line.rb,
lib/mini_readline/read_line/edit.rb,
lib/mini_readline/read_line/prompt.rb,
lib/mini_readline/read_line/history.rb,
lib/mini_readline/read_line/edit/enter.rb,
lib/mini_readline/read_line/no_history.rb,
lib/mini_readline/read_line/edit/cancel.rb,
lib/mini_readline/read_line/edit/go_end.rb,
lib/mini_readline/read_line/edit/go_home.rb,
lib/mini_readline/read_line/edit/go_left.rb,
lib/mini_readline/read_line/edit/go_right.rb,
lib/mini_readline/read_line/edit/unmapped.rb,
lib/mini_readline/read_line/edit/word_left.rb,
lib/mini_readline/read_line/edit/word_right.rb,
lib/mini_readline/read_line/edit/delete_left.rb,
lib/mini_readline/read_line/edit/edit_window.rb,
lib/mini_readline/read_line/edit/insert_text.rb,
lib/mini_readline/read_line/edit/delete_right.rb,
lib/mini_readline/read_line/edit/end_of_input.rb,
lib/mini_readline/read_line/edit/next_history.rb,
lib/mini_readline/read_line/edit/auto_complete.rb,
lib/mini_readline/read_line/edit/delete_all_left.rb,
lib/mini_readline/read_line/edit/delete_all_right.rb,
lib/mini_readline/read_line/edit/previous_history.rb,
lib/mini_readline/read_line/edit/edit_window/sync_cursor.rb,
lib/mini_readline/read_line/edit/edit_window/sync_window.rb,
lib/mini_readline/read_line/edit/auto_complete/array_source.rb,
lib/mini_readline/read_line/edit/auto_complete/auto_manager.rb,
lib/mini_readline/read_line/edit/auto_complete/auto_file_source.rb,
lib/mini_readline/read_line/edit/auto_complete/file_folder_source.rb,
lib/mini_readline/read_line/edit/auto_complete/quoted_file_folder_source.rb

Overview

The data source for auto-complete.

Defined Under Namespace

Classes: ArraySource, AutoFileSource, AutoManager, Edit, EditWindow, FileFolderSource, History, NoHistory, Prompt, QuotedFileFolderSource, Readline

Constant Summary collapse

BASE_OPTIONS = The base options shared by all instances.

{
  :scroll_step   => 12,       # The amount scrolled.


  :prompt        => ">",      # The default prompt.

  :alt_prompt    => "<< ",    # The prompt when scrolled.

                              # Set to nil to use main prompt.


  :auto_complete => false,    # Is auto complete enabled?

  :auto_source   => nil,      # Filled in by auto_complete.rb

                              # MiniReadline::QuotedFileFolderSource


  :chomp         => false,    # Remove the trailing new-line?


  :eoi_detect    => false,    # Is end of input detection enabled?


  :history       => false,    # Is the history buffer enabled?

  :log           => [],       # Default is no previous history

  :no_blanks     => true,     # No empty lines in history.

  :no_dups       => true,     # No duplicate lines in history.

  :no_move       => false,    # Don't move history entries.


  :secret_mask   => nil,      # No secret password mask. Use the

                              # string "*" to use stars or " "

                              # for invisible secrets.


  :initial       => ""        # The initial text for the entry.

                              # An empty string for none.

}

VERSION = The current version of the mini_readline gem.

"0.9.5".freeze

DESCRIPTION = A brief description.

"mini_readline: Get console input with edit, history, and auto-complete.".freeze

Class Method Summary collapse

.readline(prompt = "", history = nil, options = {}) ⇒ Object

The (limited) compatibility module function.

Class Method Details

.readline(prompt = "", history = nil, options = {}) ⇒ `Object`

The (limited) compatibility module function.



18
19
20

# File 'lib/mini_readline.rb', line 18

def self.readline(prompt = "", history = nil, options = {})
  get_reader.readline(options.merge({prompt: prompt, history: history}))
end