Class: Hell::CLI

Inherits:
Object
  • Object
show all
Defined in:
lib/hell/lib/cli.rb

Class Method Summary collapse

Class Method Details

.common_options(options, opts) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/hell/lib/cli.rb', line 141

def self.common_options(options, opts)
  opts.separator "Common options"

  opts.on_tail("-h", "--help", "Show this message") do
    puts opts.to_s.gsub(/^.*DEPRECATED.*$/s, '')
    exit
  end

  opts.on_tail("-v", "--version", "Show version") do
    puts "#{cmd} v#{Unicorn::Const::UNICORN_VERSION}"
    exit
  end

  opts.on('-a', '--app-root APP_ROOT', 'directory from which capistrano should run') do |app_root|
    if app_root
      options[:app_root] = app_root
      ENV['HELL_APP_ROOT'] = app_root
    end
  end

  opts.on('-b', '--base-path BASE_PATH', 'base directory path to use in the web ui') do |base_path|
    if base_path
      options[:base_path] = base_path
      ENV['HELL_BASE_PATH'] = base_path
    end
  end

  opts.on('-L', '--log-path LOG_PATH', 'directory path to hell logs') do |log_path|
    if log_path
      options[:log_path] = log_path
      ENV['HELL_LOG_PATH'] = log_path
    end
  end

  opts.on('-R', '--require-env REQUIRE_ENV', 'whether or not to require specifying an environment') do |require_env|
    if require_env
      options[:require_env] = !!require_env
      ENV['HELL_REQUIRE_ENV'] = !!require_env
    end
  end

  opts.on('-S', '--sentinel SENTINAL_PHRASE', 'sentinel phrase used to denote the end of a task run') do |sentinel|
    if sentinel
      options[:sentinel] = sentinel.split(',')
      ENV['HELL_SENTINEL_STRINGS'] = sentinel.split(',')
    end
  end

  opts.on('--pusher-app-id PUSHER_APP_ID', 'pusher app id') do |pusher_app_id|
    if pusher_app_id
      options[:pusher_app_id] = pusher_app_id
      ENV['HELL_PUSHER_APP_ID'] = pusher_app_id
    end
  end

  opts.on('--pusher-key PUSHER_KEY', 'pusher key') do |pusher_key|
    if pusher_key
      options[:pusher_key] = pusher_key
      ENV['HELL_PUSHER_KEY'] = pusher_key
    end
  end

  opts.on('--pusher-secret PUSHER_SECRET', 'pusher secret') do |pusher_secret|
    if pusher_secret
      options[:pusher_secret] = pusher_secret
      ENV['HELL_PUSHER_SECRET'] = pusher_secret
    end
  end

  [options, opts]
end

.default_options(unicorn_path = nil) ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/hell/lib/cli.rb', line 7

def self.default_options(unicorn_path=nil)
  rackup_opts = Unicorn::Configurator::RACKUP || {}
  rackup_opts[:port] = 4567

  options = rackup_opts[:options] || {}
  options[:config_file] = unicorn_path unless unicorn_path.nil?
  options[:listeners] = ['0.0.0.0:4567']

  options[:log_path] = ENV.fetch('HELL_LOG_PATH', File.join(Dir.pwd, 'log'))

  options[:app_root] = ENV.fetch('HELL_APP_ROOT', Dir.pwd)
  options[:base_path] = ENV.fetch('HELL_BASE_PATH', '/')
  options[:require_env] = !!ENV.fetch('HELL_REQUIRE_ENV', true)
  options[:sentinel] = ENV.fetch('HELL_SENTINEL_STRINGS', 'Hellish Task Completed').split(',')
  options[:pusher_app_id] = ENV.fetch('HELL_PUSHER_APP_ID', nil)
  options[:pusher_key] = ENV.fetch('HELL_PUSHER_KEY', nil)
  options[:pusher_secret] = ENV.fetch('HELL_PUSHER_SECRET', nil)

  options
end

.generic_options(options, opts) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/hell/lib/cli.rb', line 28

def self.generic_options(options, opts)
  cmd = File.basename($0)
  opts.banner = "Usage: #{cmd} " \
                "[ruby options] [#{cmd} options] [rackup config file]"
  opts.separator "Ruby options:"

  lineno = 1
  opts.on("-e", "--eval LINE", "evaluate a LINE of code") do |line|
    eval line, TOPLEVEL_BINDING, "-e", lineno
    lineno += 1
  end

  opts.on("-d", "--debug", "set debugging flags (set $DEBUG to true)") do
    $DEBUG = true
  end

  opts.on("-w", "--warn", "turn warnings on for your script") do
    $-w = true
  end

  opts.on("-I", "--include PATH",
          "specify $LOAD_PATH (may be used more than once)") do |path|
    $LOAD_PATH.unshift(*path.split(/:/))
  end

  opts.on("-r", "--require LIBRARY",
          "require the library, before executing your script") do |library|
    require library
  end

  [options, opts]
end

.option_parser(args, unicorn_path = nil) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/hell/lib/cli.rb', line 252

def self.option_parser(args, unicorn_path=nil)
  options = Hell::CLI.default_options(unicorn_path)

  op = OptionParser.new("", 24, '  ') do |opts|
    options, opts = Hell::CLI.generic_options(options, opts)

    options, opts = Hell::CLI.server_options(options, opts)

    options, opts = Hell::CLI.unicorn_options(options, opts)

    # I'm avoiding Unicorn-specific config options on the command-line.
    # IMNSHO, config options on the command-line are redundant given
    # config files and make things unnecessarily complicated with multiple
    # places to look for a config option.

    options, opts = Hell::CLI.common_options(options, opts)

    opts.parse! args
  end

  [options, op]
end

.runner_option_parser(args) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/hell/lib/cli.rb', line 213

def self.runner_option_parser(args)
  options = {
    :environment => nil,
    :task => nil,
    :verbose => false,
    :pusher_app_id => ENV.fetch('HELL_PUSHER_APP_ID', nil),
    :pusher_key => ENV.fetch('HELL_PUSHER_KEY', nil),
    :pusher_secret => ENV.fetch('HELL_PUSHER_SECRET', nil),
  }

  op = OptionParser.new("", 24, '  ') do |opts|
    options, opts = Hell::CLI.generic_options(options, opts)

    options, opts = Hell::CLI.runner_options(options, opts)

    options, opts = Hell::CLI.common_options(options, opts)

    opts.parse! args
  end

  [options, op]
end

.runner_options(options, opts) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/hell/lib/cli.rb', line 61

def self.runner_options(options, opts)
  opts.separator "Runner options"

  opts.on("--base-url BASE_URL", "base hell url") do |base_url|
    options[:base_url] = base_url.gsub(/[\/]+$/, '') if base_url
  end

  opts.on("--environment ENVIRONMENT", "environment to run task in") do |environment|
    options[:environment] = environment if environment
  end

  opts.on("--task TASK", "full task name to run") do |task|
    options[:task] = task if task
  end

  opts.on("--verbose", "run task in verbose mode") do |environment|
    options[:verbose] = true if verbose
  end

  [options, opts]
end

.server_options(options, opts) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/hell/lib/cli.rb', line 83

def self.server_options(options, opts)
  # some of these switches exist for rackup command-line compatibility,
  opts.separator "Server options"

  opts.on("-o", "--host HOST",
          "listen on HOST (default: 0.0.0.0)") do |h|
    rackup_opts[:host] = h || '0.0.0.0'
    rackup_opts[:set_listener] = true
  end

  opts.on("-p", "--port PORT",
          "use PORT (default: 4567)") do |p|
    rackup_opts[:port] = p || 4567
    rackup_opts[:port] = rackup_opts[:port].to_i
    rackup_opts[:set_listener] = true
  end

  opts.on("-E", "--env RACK_ENV",
          "use RACK_ENV for defaults (default: development)") do |e|
    ENV["RACK_ENV"] = e
  end

  opts.on("-D", "--daemonize", "run daemonized in the background") do |d|
    rackup_opts[:daemonize] = !!d
  end

  opts.on("-P", "--pid FILE", "DEPRECATED") do |f|
    warn %q{Use of --pid/-P is strongly discouraged}
    warn %q{Use the 'pid' directive in the Unicorn config file instead}
    options[:pid] = f
  end

  opts.on("-s", "--server SERVER",
          "this flag only exists for compatibility") do |s|
    warn "-s/--server only exists for compatibility with rackup"
  end

  [options, opts]
end

.unicorn_option_parser(args, unicorn_path = nil) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/hell/lib/cli.rb', line 236

def self.unicorn_option_parser(args, unicorn_path=nil)
  options, op = Hell::CLI.option_parser(args, unicorn_path)

  [
    :app_root,
    :base_path,
    :require_env,
    :sentinel,
    :pusher_app_id,
    :pusher_key,
    :pusher_secret,
  ].each {|key| options.delete(key)}

  [options, op]
end

.unicorn_options(options, opts) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/hell/lib/cli.rb', line 123

def self.unicorn_options(options, opts)
  # Unicorn-specific stuff
  opts.separator "Unicorn options:"

  opts.on("-l", "--listen {HOST:PORT|PATH}",
          "listen on HOST:PORT or PATH",
          "this may be specified multiple times",
          "(default: 0.0.0.0:4567)") do |address|
    options[:listeners] << address || '0.0.0.0:4567'
  end

  opts.on("-c", "--config-file FILE", "Unicorn-specific config file") do |f|
    options[:config_file] = unicorn_path
  end

  [options, opts]
end