Class: Boxybox::Command

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

Overview

This is generated from the TTY application bootstrap and is used to access the commands available to this app

Direct Known Subclasses

Boxybox::Commands::Boxes

Instance Method Summary collapse

Instance Method Details

#command(**options) ⇒ Object

The external commands runner

See Also:



27
28
29
30
 
# File 'lib/boxybox/command.rb', line 27

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

#cursor ⇒ Object

The cursor movement

See Also:



37
38
39
40
 
# File 'lib/boxybox/command.rb', line 37

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

#editor ⇒ Object

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

See Also:



47
48
49
50
 
# File 'lib/boxybox/command.rb', line 47

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

#exec_exist?(*args) ⇒ Boolean

Check if executable exists

Returns:

  • (Boolean)

See Also:



117
118
119
120
 
# File 'lib/boxybox/command.rb', line 117

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

#execute ⇒ Object

Execute this command

Raises:

  • (NotImplementedError) 


15
16
17
18
19
20
 
# File 'lib/boxybox/command.rb', line 15

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

#generator ⇒ Object

File manipulation utility methods

See Also:



57
58
59
60
 
# File 'lib/boxybox/command.rb', line 57

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

#pager(**options) ⇒ Object

Terminal output paging

See Also:



67
68
69
70
 
# File 'lib/boxybox/command.rb', line 67

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

#platform ⇒ Object

Terminal platform and OS properties

See Also:



77
78
79
80
 
# File 'lib/boxybox/command.rb', line 77

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

#prompt(**options) ⇒ Object

The interactive prompt

See Also:



87
88
89
90
 
# File 'lib/boxybox/command.rb', line 87

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

#screen ⇒ Object

Get terminal screen properties

See Also:



97
98
99
100
 
# File 'lib/boxybox/command.rb', line 97

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

#which(*args) ⇒ Object

The unix which utility

See Also:



107
108
109
110
 
# File 'lib/boxybox/command.rb', line 107

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