Class: Appetize::Command

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/appetize/command.rb

Instance Method Summary collapse

Instance Method Details

#command(**options) ⇒ Object

The external commands runner


26
27
28
29
# File 'lib/appetize/command.rb', line 26

def command(**options)
  require "tty-command"
  TTY::Command.new(options)
end

#cursorObject

The cursor movement


36
37
38
39
# File 'lib/appetize/command.rb', line 36

def cursor
  require "tty-cursor"
  TTY::Cursor
end

#editorObject

Open a file or text in the user's preferred editor


46
47
48
49
# File 'lib/appetize/command.rb', line 46

def editor
  require "tty-editor"
  TTY::Editor
end

#exec_exist?(*args) ⇒ Boolean

Check if executable exists

Returns:

  • (Boolean)

See Also:


116
117
118
119
# File 'lib/appetize/command.rb', line 116

def exec_exist?(*args)
  require "tty-which"
  TTY::Which.exist?(*args)
end

#executeObject

Execute this command

Raises:

  • (NotImplementedError)

14
15
16
17
18
19
# File 'lib/appetize/command.rb', line 14

def execute(*)
  raise(
    NotImplementedError,
    "#{self.class}##{__method__} must be implemented"
  )
end

#generatorObject

File manipulation utility methods


56
57
58
59
# File 'lib/appetize/command.rb', line 56

def generator
  require "tty-file"
  TTY::File
end

#pager(**options) ⇒ Object

Terminal output paging


66
67
68
69
# File 'lib/appetize/command.rb', line 66

def pager(**options)
  require "tty-pager"
  TTY::Pager.new(options)
end

#platformObject

Terminal platform and OS properties


76
77
78
79
# File 'lib/appetize/command.rb', line 76

def platform
  require "tty-platform"
  TTY::Platform.new
end

#prompt(**options) ⇒ Object

The interactive prompt


86
87
88
89
# File 'lib/appetize/command.rb', line 86

def prompt(**options)
  require "tty-prompt"
  TTY::Prompt.new(options)
end

#screenObject

Get terminal screen properties


96
97
98
99
# File 'lib/appetize/command.rb', line 96

def screen
  require "tty-screen"
  TTY::Screen
end

#which(*args) ⇒ Object

The unix which utility


106
107
108
109
# File 'lib/appetize/command.rb', line 106

def which(*args)
  require "tty-which"
  TTY::Which.which(*args)
end