Class: HighLine

Inherits:
Object show all
Extended by:
SingleForwardable
Includes:
BuiltinStyles, CustomErrors
Defined in:
lib/highline.rb,
lib/highline/list.rb,
lib/highline/menu.rb,
lib/highline/style.rb,
lib/highline/string.rb,
lib/highline/version.rb,
lib/highline/wrapper.rb,
lib/highline/question.rb,
lib/highline/simulate.rb,
lib/highline/terminal.rb,
lib/highline/menu/item.rb,
lib/highline/paginator.rb,
lib/highline/statement.rb,
lib/highline/color_scheme.rb,
lib/highline/custom_errors.rb,
lib/highline/list_renderer.rb,
lib/highline/builtin_styles.rb,
lib/highline/question_asker.rb,
lib/highline/terminal/ncurses.rb,
lib/highline/string_extensions.rb,
lib/highline/template_renderer.rb,
lib/highline/terminal/unix_stty.rb,
lib/highline/terminal/io_console.rb,
lib/highline/question/answer_converter.rb

Overview

:nodoc:

Defined Under Namespace

Modules: BuiltinStyles, CustomErrors, StringExtensions, Wrapper Classes: ColorScheme, List, ListRenderer, Menu, Paginator, Question, QuestionAsker, SampleColorScheme, Simulate, Statement, String, Style, TemplateRenderer, Terminal

Constant Summary collapse

VERSION =

The version of the installed library.

"3.1.1".freeze

Constants included from BuiltinStyles

BuiltinStyles::BASIC_COLORS, BuiltinStyles::COLORS, BuiltinStyles::COLOR_LIST, BuiltinStyles::STYLES, BuiltinStyles::STYLE_LIST

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BuiltinStyles

included

Constructor Details

#initialize(input = $stdin, output = $stdout, wrap_at = nil, page_at = nil, indent_size = 3, indent_level = 0) ⇒ HighLine

Create an instance of HighLine connected to the given input and output streams.

Parameters:

  • input (IO) (defaults to: $stdin) —

    the default input stream for HighLine.

  • output (IO) (defaults to: $stdout) —

    the default output stream for HighLine.

  • wrap_at (Integer) (defaults to: nil) —

    all statements outputed through HighLine will be wrapped to this column size if set.

  • page_at (Integer) (defaults to: nil) —

    page size and paginating.

  • indent_size (Integer) (defaults to: 3) —

    indentation size in spaces.

  • indent_level (Integer) (defaults to: 0) —

    how deep is indentated.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/highline.rb', line 109

def initialize(input = $stdin, output = $stdout,
               wrap_at = nil, page_at = nil,
               indent_size = 3, indent_level = 0)
  @input   = input
  @output  = output

  @multi_indent = true
  @indent_size  = indent_size
  @indent_level = indent_level

  self.wrap_at = wrap_at
  self.page_at = page_at

  @header   = nil
  @prompt   = nil
  @key      = nil

  @use_color = default_use_color
  @track_eof = true # The setting used to disable EOF tracking.
  @terminal = HighLine::Terminal.get_terminal(input, output)
end

Class Attribute Details

.color_scheme ⇒ Object

Pass ColorScheme to set a HighLine color scheme.



57
58
59
 
# File 'lib/highline.rb', line 57

def color_scheme
  @color_scheme
end

.default_instance ⇒ Object

Returns the value of attribute default_instance.



54
55
56
 
# File 'lib/highline.rb', line 54

def default_instance
  @default_instance
end

Instance Attribute Details

#indent_level ⇒ Integer

Returns The indentation level.

Returns:

  • (Integer) —

    The indentation level



165
166
167
 
# File 'lib/highline.rb', line 165

def indent_level
  @indent_level
end

#indent_size ⇒ Integer

Returns The indentation size in characters.

Returns:

  • (Integer) —

    The indentation size in characters



162
163
164
 
# File 'lib/highline.rb', line 162

def indent_size
  @indent_size
end

#input ⇒ IO (readonly)

Returns the default input stream for a HighLine instance.

Returns:

  • (IO) —

    the default input stream for a HighLine instance



168
169
170
 
# File 'lib/highline.rb', line 168

def input
  @input
end

#key ⇒ Object

TODO:

We should probably move this into the HighLine::Question object.

When gathering a Hash with HighLine::QuestionAsker#gather_hash, it tracks the current key being asked.



178
179
180
 
# File 'lib/highline.rb', line 178

def key
  @key
end

#multi_indent ⇒ Boolean

Returns Indentation over multiple lines.

Returns:

  • (Boolean) —

    Indentation over multiple lines



159
160
161
 
# File 'lib/highline.rb', line 159

def multi_indent
  @multi_indent
end

#output ⇒ IO (readonly)

Returns the default output stream for a HighLine instance.

Returns:

  • (IO) —

    the default output stream for a HighLine instance



171
172
173
 
# File 'lib/highline.rb', line 171

def output
  @output
end

#page_at ⇒ Integer

Returns The current row setting for paging output.

Returns:

  • (Integer) —

    The current row setting for paging output.



156
157
158
 
# File 'lib/highline.rb', line 156

def page_at
  @page_at
end

#terminal ⇒ HighLine::Terminal (readonly)

System specific that responds to #initialize_system_extensions, #terminal_size, #raw_no_echo_mode, #restore_mode, #get_character. It polymorphically handles specific cases for different platforms.

Returns:



184
185
186
 
# File 'lib/highline.rb', line 184

def terminal
  @terminal
end

#track_eof ⇒ Object

Pass false to turn off HighLine’s EOF tracking.



145
146
147
 
# File 'lib/highline.rb', line 145

def track_eof
  @track_eof
end

#use_color ⇒ Object

Set it to false to disable ANSI coloring



132
133
134
 
# File 'lib/highline.rb', line 132

def use_color
  @use_color
end

#wrap_at ⇒ Integer

Returns The current column setting for wrapping output.

Returns:

  • (Integer) —

    The current column setting for wrapping output.



153
154
155
 
# File 'lib/highline.rb', line 153

def wrap_at
  @wrap_at
end

Class Method Details

.add_to_color_scheme(hash) ⇒ Object

Pass a Hash to add new colors to the current scheme.



65
66
67
68
69
70
 
# File 'lib/highline.rb', line 65

def add_to_color_scheme(hash)
  old_hash = (color_scheme || {}).to_hash
  fail "Overlapping color schemes: #{old_hash.keys & hash.keys}"  unless
    (old_hash.keys & hash.keys).empty?
  self.color_scheme = ColorScheme.new(old_hash.merge hash)
end

.colorize_strings ⇒ Object

Adds color support to the base String class



127
128
129
 
# File 'lib/highline/string_extensions.rb', line 127

def self.colorize_strings
  ::String.send(:include, StringExtensions)
end

.find_or_create_style(arg) ⇒ Style

Search for a Style with the given properties and return it. If there’s no matched Style, it creates one. You can pass a Style, String or a Hash.

Parameters:

Returns:

  • (Style) —

    found or creted Style



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/highline/style.rb', line 30

def self.find_or_create_style(arg)
  if arg.is_a?(Style)
    Style.list[arg.name] || Style.index(arg)
  elsif arg.is_a?(::String) && arg =~ /^\e\[/ # arg is a code
    styles = Style.code_index[arg]
    if styles
      styles.first
    else
      Style.new(code: arg)
    end
  elsif Style.list[arg]
    Style.list[arg]
  elsif HighLine.color_scheme && HighLine.color_scheme[arg]
    HighLine.color_scheme[arg]
  elsif arg.is_a?(Hash)
    Style.new(arg)
  elsif arg.to_s.downcase =~ /^rgb_([a-f0-9]{6})$/
    Style.rgb(Regexp.last_match(1))
  elsif arg.to_s.downcase =~ /^on_rgb_([a-f0-9]{6})$/
    Style.rgb(Regexp.last_match(1)).on
  else
    raise NameError, "#{arg.inspect} is not a defined Style"
  end
end

.find_or_create_style_list(*args) ⇒ Style

Find a Style list or create a new one.

Examples:

Creating a Style list of the combined RED and BOLD styles.

style_list = HighLine.find_or_create_style_list(:red, :bold)

Parameters:

  • args (Array<Symbol>) —

    an Array of Symbols of each style that will be on the style list.

Returns:



62
63
64
65
 
# File 'lib/highline/style.rb', line 62

def self.find_or_create_style_list(*args)
  name = args
  Style.list[name] || Style.new(list: args)
end

.reset ⇒ Object

Reset HighLine to default. Clears Style index and resets color_scheme and use_color settings.



79
80
81
82
83
 
# File 'lib/highline.rb', line 79

def reset
  Style.clear_index
  reset_color_scheme
  reset_use_color
end

.reset_color_scheme ⇒ Object

Reset color scheme to default (nil)



73
74
75
 
# File 'lib/highline.rb', line 73

def reset_color_scheme
  self.color_scheme = nil
end

.String(s) ⇒ HighLine::String

Returns a HighLine::String from any given String.

Parameters:

Returns:



7
8
9
 
# File 'lib/highline/string_extensions.rb', line 7

def self.String(s) # rubocop:disable Naming/MethodName
  HighLine::String.new(s)
end

.Style(*args) ⇒ Style

Creates a style using find_or_create_style or find_or_create_style_list

Parameters:

  • args (Array<Style, Hash, String>) —

    style properties

Returns:



16
17
18
19
20
21
22
23
 
# File 'lib/highline/style.rb', line 16

def self.Style(*args)
  args = args.compact.flatten
  if args.size == 1
    find_or_create_style(args.first)
  else
    find_or_create_style_list(*args)
  end
end

.supports_rgb_color? ⇒ Boolean

For checking if the current version of HighLine supports RGB colors Usage: HighLine.supports_rgb_color? rescue false

using rescue for compatibility with older versions

Note: color usage also depends on HighLine.use_color being set TODO: Discuss removing this method

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/highline.rb', line 90

def supports_rgb_color?
  true
end

.using_color_scheme? ⇒ Boolean

Returns true if HighLine is currently using a color scheme.

Returns:

  • (Boolean) 


60
61
62
 
# File 'lib/highline.rb', line 60

def using_color_scheme?
  true if @color_scheme
end

Instance Method Details

#agree(yes_or_no_question, character = nil) ⇒ Object

A shortcut to HighLine.ask() a question that only accepts “yes” or “no” answers (“y” and “n” are allowed) and returns true or false (true for “yes”). If provided a true value, character will cause HighLine to fetch a single character response. A block can be provided to further configure the question as in HighLine.ask()

Raises EOFError if input is exhausted.

Parameters:

  • yes_or_no_question (String) —

    a question that accepts yes and no as answers

  • character (Boolean, :getc) (defaults to: nil) —

    character mode to be passed to Question#character

See Also:



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/highline.rb', line 200

def agree(yes_or_no_question, character = nil)
  ask(yes_or_no_question, ->(yn) { yn.downcase[0] == "y" }) do |q|
    q.validate                 = /\A(?:y(?:es)?|no?)\Z/i
    q.responses[:not_valid]    = 'Please enter "yes" or "no".'
    q.responses[:ask_on_error] = :question
    q.character                = character
    q.completion               = %w[yes no]

    yield q if block_given?
  end
end

#ask(template_or_question, answer_type = nil, &details) ⇒ Object

This method is the primary interface for user input. Just provide a question to ask the user, the answer_type you want returned, and optionally a code block setting up details of how you want the question handled. See #say for details on the format of question, and Question for more information about answer_type and what’s valid in the code block.

Raises EOFError if input is exhausted.

Parameters:

  • template_or_question (String, Question) —

    what to ask

  • answer_type (Class) (defaults to: nil) —

    to what class to convert the answer

  • details —

    to be passed to Question.new

Returns:

  • answer converted to the class in answer_type



224
225
226
227
228
229
230
231
232
 
# File 'lib/highline.rb', line 224

def ask(template_or_question, answer_type = nil, &details)
  question = Question.build(template_or_question, answer_type, &details)

  if question.gather
    QuestionAsker.new(question, self).gather_answers
  else
    QuestionAsker.new(question, self).ask_once
  end
end

#choose(*items, &details) ⇒ String

This method is HighLine’s menu handler. For simple usage, you can just pass all the menu items you wish to display. At that point, choose() will build and display a menu, walk the user through selection, and return their choice among the provided items. You might use this in a case statement for quick and dirty menus.

However, choose() is capable of much more. If provided, a block will be passed a HighLine::Menu object to configure. Using this method, you can customize all the details of menu handling from index display, to building a complete shell-like menuing system. See HighLine::Menu for all the methods it responds to.

Raises EOFError if input is exhausted.

Parameters:

  • items (Array<String>)
  • details (Proc) —

    to be passed to Menu.new

Returns:



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/highline.rb', line 252

def choose(*items, &details)
  menu = Menu.new(&details)
  menu.choices(*items) unless items.empty?

  # Set auto-completion
  menu.completion = menu.options

  # Set _answer_type_ so we can double as the Question for ask().
  # menu.option = normal menu selection, by index or name
  menu.answer_type = menu.shell ? shell_style_lambda(menu) : menu.options

  selected = ask(menu)
  return unless selected

  if menu.shell
    if menu.gather
      selection = []
      details = []
      selected.each do |value|
        selection << value[0]
        details << value[1]
      end
    else
      selection, details = selected
    end
  else
    selection = selected
  end

  if menu.gather
    menu.gather_selected(self, selection, details)
  else
    menu.select(self, selection, details)
  end
end

#color(string, *colors) ⇒ String

This method provides easy access to ANSI color sequences, without the user needing to remember to CLEAR at the end of each sequence. Just pass the string to color, followed by a list of colors you would like it to be affected by. The colors can be HighLine class constants, or symbols (:blue for BLUE, for example). A CLEAR will automatically be embedded to the end of the returned String.

This method returns the original string unchanged if use_color? is false.

Examples:

cli = HighLine.new
cli.color("Sustainable", :green, :bold)
# => "\e[32m\e[1mSustainable\e[0m"

# As class method (delegating to HighLine.default_instance)
HighLine.color("Sustainable", :green, :bold)

Parameters:

  • string (String) —

    string to be colored

  • colors (Array<Symbol>) —

    array of colors like [:red, :blue]

Returns:

  • (String) —

    (ANSI escaped) colored string



328
329
330
331
 
# File 'lib/highline.rb', line 328

def color(string, *colors)
  return string unless use_color?
  HighLine.Style(*colors).color(string)
end

#color_code(*colors) ⇒ String

In case you just want the color code, without the embedding and the CLEAR sequence.

Examples:

s = HighLine.Style(:red, :blue)
s.code # => "\e[31m\e[34m"

HighLine.color_code(:red, :blue) # => "\e[31m\e[34m"

cli = HighLine.new
cli.color_code(:red, :blue) # => "\e[31m\e[34m"

Parameters:

  • colors (Array<Symbol>)

Returns:

  • (String) —

    ANSI escape code for the given colors.



348
349
350
 
# File 'lib/highline.rb', line 348

def color_code(*colors)
  HighLine.Style(*colors).code
end

#get_response_character_mode(question) ⇒ String

Get response each character per turn

Parameters:

Returns:



628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/highline.rb', line 628

def get_response_character_mode(question)
  terminal.raw_no_echo_mode_exec do
    response = terminal.get_character
    if question.overwrite
      erase_current_line
    else
      echo = question.get_echo_for_response(response)
      say("#{echo}\n")
    end
    question.format_answer(response)
  end
end

#get_response_getc_mode(question) ⇒ String

Get response using #getc

Parameters:

Returns:



618
619
620
621
622
623
 
# File 'lib/highline.rb', line 618

def get_response_getc_mode(question)
  terminal.raw_no_echo_mode_exec do
    response = @input.getc
    question.format_answer(response)
  end
end

#get_response_line_mode(question) ⇒ String

Get response one line at time

Parameters:

Returns:



531
532
533
534
535
536
537
 
# File 'lib/highline.rb', line 531

def get_response_line_mode(question)
  if question.echo == true && !question.limit
    get_line(question)
  else
    get_line_raw_no_echo_mode(question)
  end
end

#indent(increase = 1, statement = nil, multiline = nil) ⇒ void

This method returns an undefined value.

Executes block or outputs statement with indentation

Parameters:

  • increase (Integer) (defaults to: 1) —

    how much to increase indentation

  • statement (Statement, String) (defaults to: nil) —

    to be said

  • multiline (Boolean) (defaults to: nil)

See Also:



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/highline.rb', line 448

def indent(increase = 1, statement = nil, multiline = nil)
  @indent_level += increase
  multi = @multi_indent
  @multi_indent ||= multiline
  begin
    if block_given?
      yield self
    else
      say(statement)
    end
  ensure
    @multi_indent = multi
    @indent_level -= increase
  end
end

#indentation ⇒ Object

Outputs indentation with current settings



436
437
438
 
# File 'lib/highline.rb', line 436

def indentation
  " " * @indent_size * @indent_level
end

#list(items, mode = :rows, option = nil) ⇒ String

Renders a list of itens using a ListRenderer

Parameters:

  • items (Array)
  • mode (Symbol) (defaults to: :rows)
  • option (defaults to: nil)

Returns:

See Also:



365
366
367
 
# File 'lib/highline.rb', line 365

def list(items, mode = :rows, option = nil)
  ListRenderer.new(items, mode, option, self).render
end

#new_scope ⇒ Object

Creates a new HighLine instance with the same options



502
503
504
505
 
# File 'lib/highline.rb', line 502

def new_scope
  self.class.new(@input, @output, @wrap_at,
                 @page_at, @indent_size, @indent_level)
end

#newline ⇒ Object

Outputs newline



467
468
469
 
# File 'lib/highline.rb', line 467

def newline
  @output.puts
end

#output_cols ⇒ Object

Returns the number of columns for the console, or a default it they cannot be determined.



475
476
477
478
479
480
 
# File 'lib/highline.rb', line 475

def output_cols
  return 80 unless @output.tty?
  terminal.terminal_size.first
rescue NoMethodError
  return 80
end

#output_rows ⇒ Object

Returns the number of rows for the console, or a default if they cannot be determined.



486
487
488
489
490
491
 
# File 'lib/highline.rb', line 486

def output_rows
  return 24 unless @output.tty?
  terminal.terminal_size.last
rescue NoMethodError
  return 24
end

#puts(*args) ⇒ Object

Call #puts on the HighLine’s output stream

Parameters:

  • args (String) —

    same args for Kernel#puts



495
496
497
 
# File 'lib/highline.rb', line 495

def puts(*args)
  @output.puts(*args)
end

#render_and_ident_statement(statement) ⇒ String

Renders and indents a statement.

Note: extracted here to be used by readline to render its prompt.

Parameters:

  • statement (String) —

    The statement to be rendered and indented.

Returns:

  • (String) —

    The rendered and indented statement.



400
401
402
403
404
 
# File 'lib/highline.rb', line 400

def render_and_ident_statement(statement)
  statement = render_statement(statement)
  statement = (indentation + statement) unless statement.empty?
  statement
end

#render_statement(statement) ⇒ Statement

Renders a statement using Statement

Parameters:

  • statement (String) —

    any string

Returns:



409
410
411
 
# File 'lib/highline.rb', line 409

def render_statement(statement)
  Statement.new(statement, self).to_s
end

#reset_use_color ⇒ Object

Resets the use of color.



140
141
142
 
# File 'lib/highline.rb', line 140

def reset_use_color
  @use_color = true
end

#say(statement) ⇒ Object

The basic output method for HighLine objects. If the provided statement ends with a space or tab character, a newline will not be appended (output will be flush()ed). All other cases are passed straight to Kernel.puts().

The statement argument is processed as an ERb template, supporting embedded Ruby code. The template is evaluated within a HighLine instance’s binding for providing easy access to the ANSI color constants and the HighLine#color() method.

Parameters:



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/highline.rb', line 380

def say(statement)
  statement = render_and_ident_statement(statement)
  return statement if statement.empty?

  # Don't add a newline if statement ends with whitespace, OR
  # if statement ends with whitespace before a color escape code.
  if /[ \t](\e\[\d+(;\d+)*m)?\Z/ =~ statement
    output.print(statement)
  else
    output.puts(statement)
  end
  output.flush # See: https://github.com/JEG2/highline/pull/276
end

#shell_style_lambda(menu) ⇒ lambda

Convenience method to craft a lambda suitable for beind used in autocompletion operations by #choose

Returns:

  • (lambda) —

    lambda to be used in autocompletion operations



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/highline.rb', line 292

def shell_style_lambda(menu)
  lambda do |command| # shell-style selection
    first_word = command.to_s.split.first || ""

    options = menu.options
    options.extend(OptionParser::Completion)
    answer = options.complete(first_word)

    raise Question::NoAutoCompleteMatch unless answer

    [answer.last, command.sub(/^\s*#{first_word}\s*/, "")]
  end
end

#track_eof? ⇒ Boolean

Returns true if HighLine is currently tracking EOF for input.

Returns:

  • (Boolean) 


148
149
150
 
# File 'lib/highline.rb', line 148

def track_eof?
  true if track_eof
end

#uncolor(string) ⇒ String

Remove color codes from a string.

Parameters:

  • string (String) —

    to be decolorized

Returns:

  • (String) —

    without the ANSI escape sequence (colors)



355
356
357
 
# File 'lib/highline.rb', line 355

def uncolor(string)
  Style.uncolor(string)
end

#use_color? ⇒ Boolean

Returns truethy if HighLine instance is currently using color escapes.

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/highline.rb', line 135

def use_color?
  use_color
end