Class: TerminalSize::TerminalSize

Inherits:
Object
  • Object
show all
Defined in:
lib/output/index_diagram/terminal_size.rb

Overview

class to extract the terminal dimension of the the terminal which called the executing script

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ TerminalSize

initialization



14
15
16
 
# File 'lib/output/index_diagram/terminal_size.rb', line 14

def initialize
  read_terminal_size
end

Instance Attribute Details

#columns ⇒ Integer (readonly)

Returns the number of lines of the used terminal.

Returns:

  • (Integer) —

    the number of lines of the used terminal



9
10
11
 
# File 'lib/output/index_diagram/terminal_size.rb', line 9

def columns
  @columns
end

#lines ⇒ Integer (readonly)

Returns the number of fields per row of the used terminal.

Returns:

  • (Integer) —

    the number of fields per row of the used terminal



11
12
13
 
# File 'lib/output/index_diagram/terminal_size.rb', line 11

def lines
  @lines
end

Instance Method Details

#command_exists?(command) ⇒ Boolean (private)

method to check if the given command can be executed

Parameters:

  • command (String) —

    the provided command string

Returns:

  • (Boolean) —

    true: command can be used, false if not



56
57
58
59
60
 
# File 'lib/output/index_diagram/terminal_size.rb', line 56

def command_exists?(command)
  ENV["PATH"].split(File::PATH_SEPARATOR).any? { |d|
    File.exist?(File.join(d, command))
  }
end

#detect_terminal_size ⇒ Array (private)

method to read the terminal dimension, using different shell programs

Returns:

  • (Array) —

    the read values for the terminal dimension



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/output/index_diagram/terminal_size.rb', line 34

def detect_terminal_size
  # take informations directly from ENV variable
  if (ENV["COLUMNS"] =~ /^\d+$/) && (ENV["LINES"] =~ /^\d+$/)
    [ENV["COLUMNS"].to_i, ENV["LINES"].to_i]
  # take informations from tput command
  elsif ((RUBY_PLATFORM =~ /java/ || (!STDIN.tty? && ENV["TERM"])) &&
          command_exists?("tput"))
    [`tput cols`.to_i, `tput lines`.to_i]
  # take informations from stty command
  elsif (STDIN.tty? && command_exists?("stty"))
    `stty size`.scan(/\d+/).map { |s| s.to_i }.reverse
  else
    nil
  end
rescue StandardError
  puts " Error: could not determine correct terminal size".red
  nil
end

#read_terminal_size ⇒ Object

method to determine the terminal dimension



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/output/index_diagram/terminal_size.rb', line 19

def read_terminal_size
  values = detect_terminal_size
  if (values != nil)
    @columns = values[0]
    @lines = values[1]
  else
    raise NoMethodError, " Error: terminal size cannot be retrieved on" \
                         " this system".red
  end
end