Class: TTY::Cmd

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
PathHelpers
Defined in:
lib/tty/cmd.rb

Direct Known Subclasses

TTY::Commands::Add, TTY::Commands::New

Instance Method Summary collapse

Methods included from PathHelpers

#name_from_path, #relative_path_from, #root_path, #within_root_path

Instance Method Details

#command(**options) ⇒ Object

The external commands runner

See Also:



31
32
33
34
 
# File 'lib/tty/cmd.rb', line 31

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

#constantinize(str) ⇒ Object 



126
127
128
129
 
# File 'lib/tty/cmd.rb', line 126

def constantinize(str)
  str.gsub(/-[_-]*(?![_-]|$)/) { "::" }
     .gsub(/([_-]+|(::)|^)(.|$)/) { $2.to_s + $3.upcase}
end

#cursor ⇒ Object

The cursor movement

See Also:



41
42
43
44
 
# File 'lib/tty/cmd.rb', line 41

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

#editor ⇒ Object

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

See Also:



51
52
53
54
 
# File 'lib/tty/cmd.rb', line 51

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

#exec_exist?(*args) ⇒ Boolean

Check if executable exists

Returns:

  • (Boolean)

See Also:



121
122
123
124
 
# File 'lib/tty/cmd.rb', line 121

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

#execute ⇒ Object

Execute this command

Raises:

  • (NotImplementedError) 


19
20
21
22
23
24
 
# File 'lib/tty/cmd.rb', line 19

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

#generator ⇒ Object

File manipulation utility methods

See Also:



61
62
63
64
 
# File 'lib/tty/cmd.rb', line 61

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

#pager(**options) ⇒ Object

Terminal output paging

See Also:



71
72
73
74
 
# File 'lib/tty/cmd.rb', line 71

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

#platform ⇒ Object

Terminal platform and OS properties

See Also:



81
82
83
84
 
# File 'lib/tty/cmd.rb', line 81

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

#prompt(**options) ⇒ Object

The interactive prompt

See Also:



91
92
93
94
 
# File 'lib/tty/cmd.rb', line 91

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

#screen ⇒ Object

Get terminal screen properties

See Also:



101
102
103
104
 
# File 'lib/tty/cmd.rb', line 101

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

#which(*args) ⇒ Object

The unix which utility

See Also:



111
112
113
114
 
# File 'lib/tty/cmd.rb', line 111

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