Class: Dru::Command

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

Defined Under Namespace

Classes: MissingContainerError

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#options ⇒ Object

Returns the value of attribute options.



15
16
17
 
# File 'lib/dru/command.rb', line 15

def options
  @options
end

Instance Method Details

#command(**options) ⇒ Object

The external commands runner

See Also:



34
35
36
37
 
# File 'lib/dru/command.rb', line 34

def command(**options)
  require 'tty-command'
  TTY::Command.new({ printer: :quiet, uuid: false }.merge(options))
end

#container_name_to_id(container_name = 'app') ⇒ Object 



163
164
165
 
# File 'lib/dru/command.rb', line 163

def container_name_to_id(container_name = 'app')
  run_docker_compose_command('ps', '-q', container_name, printer: :null).first
end

#cursor ⇒ Object

The cursor movement

See Also:



44
45
46
47
 
# File 'lib/dru/command.rb', line 44

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

#default_docker_compose ⇒ Object 



141
142
143
 
# File 'lib/dru/command.rb', line 141

def default_docker_compose
  File.join(project_configuration_path, 'docker-compose.yml')
end

#docker_compose_paths ⇒ Object 



151
152
153
 
# File 'lib/dru/command.rb', line 151

def docker_compose_paths
  docker_compose_default_path + docker_compose_environment_path
end

#editor ⇒ Object

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

See Also:



54
55
56
57
 
# File 'lib/dru/command.rb', line 54

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

#environment ⇒ Object 



133
134
135
 
# File 'lib/dru/command.rb', line 133

def environment
  options && options[:environment]
end

#environment_docker_compose ⇒ Object 



145
146
147
148
149
 
# File 'lib/dru/command.rb', line 145

def environment_docker_compose
  return unless environment

  File.join(project_configuration_path, "docker-compose.#{environment}.yml")
end

#exec_exist?(*args) ⇒ Boolean

Check if executable exists

Returns:

  • (Boolean)

See Also:



124
125
126
127
 
# File 'lib/dru/command.rb', line 124

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

#execute ⇒ Object

Execute this command

Raises:

  • (NotImplementedError) 


22
23
24
25
26
27
 
# File 'lib/dru/command.rb', line 22

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

#generator ⇒ Object

File manipulation utility methods

See Also:



64
65
66
67
 
# File 'lib/dru/command.rb', line 64

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

#pager(**options) ⇒ Object

Terminal output paging

See Also:



74
75
76
77
 
# File 'lib/dru/command.rb', line 74

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

#platform ⇒ Object

Terminal platform and OS properties

See Also:



84
85
86
87
 
# File 'lib/dru/command.rb', line 84

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

#project_configuration_path ⇒ Object 



137
138
139
 
# File 'lib/dru/command.rb', line 137

def project_configuration_path
  File.expand_path(project_name, Dru.config.docker_projects_folder)
end

#project_name ⇒ Object 



129
130
131
 
# File 'lib/dru/command.rb', line 129

def project_name
  File.basename(Dir.pwd)
end

#prompt(**options) ⇒ Object

The interactive prompt

See Also:



94
95
96
97
 
# File 'lib/dru/command.rb', line 94

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

#run_docker_compose_command(*args, **options) ⇒ Object 



155
156
157
158
159
160
161
 
# File 'lib/dru/command.rb', line 155

def run_docker_compose_command(*args, **options)
  if options[:tty]
    system(DOCKER_COMPOSE_COMMAND, *docker_compose_paths, *args)
  else
    command(options).run(DOCKER_COMPOSE_COMMAND, *docker_compose_paths, *args)
  end
end

#screen ⇒ Object

Get terminal screen properties

See Also:



104
105
106
107
 
# File 'lib/dru/command.rb', line 104

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

#which(*args) ⇒ Object

The unix which utility

See Also:



114
115
116
117
 
# File 'lib/dru/command.rb', line 114

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