Class: Steep::CLI

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

Defined Under Namespace

Classes: SignatureOptions

Constant Summary collapse

BUILTIN_PATH = 
Pathname(__dir__).join("../../stdlib").realpath

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(stdout:, stdin:, stderr:, argv:) ⇒ CLI

Returns a new instance of CLI.



127
128
129
130
131
132
 
# File 'lib/steep/cli.rb', line 127

def initialize(stdout:, stdin:, stderr:, argv:)
  @stdout = stdout
  @stdin = stdin
  @stderr = stderr
  @argv = argv
end

Instance Attribute Details

#argv ⇒ Object (readonly)

Returns the value of attribute argv.



121
122
123
 
# File 'lib/steep/cli.rb', line 121

def argv
  @argv
end

#command ⇒ Object (readonly)

Returns the value of attribute command.



125
126
127
 
# File 'lib/steep/cli.rb', line 125

def command
  @command
end

#stderr ⇒ Object (readonly)

Returns the value of attribute stderr.



124
125
126
 
# File 'lib/steep/cli.rb', line 124

def stderr
  @stderr
end

#stdin ⇒ Object (readonly)

Returns the value of attribute stdin.



123
124
125
 
# File 'lib/steep/cli.rb', line 123

def stdin
  @stdin
end

#stdout ⇒ Object (readonly)

Returns the value of attribute stdout.



122
123
124
 
# File 'lib/steep/cli.rb', line 122

def stdout
  @stdout
end

Class Method Details

.available_commands ⇒ Object 



134
135
136
 
# File 'lib/steep/cli.rb', line 134

def self.available_commands
  [:check, :validate, :annotations, :scaffold, :interface, :version, :paths, :watch]
end

Instance Method Details

#handle_dir_options(opts, options) ⇒ Object 



167
168
169
170
171
172
 
# File 'lib/steep/cli.rb', line 167

def handle_dir_options(opts, options)
  opts.on("-I [PATH]") {|path| options << Pathname(path) }
  opts.on("-G [GEM]") {|gem| options << gem }
  opts.on("--no-builtin") { options.no_builtin! }
  opts.on("--no-bundler") { options.no_bundler! }
end

#process_annotations ⇒ Object 



228
229
230
231
 
# File 'lib/steep/cli.rb', line 228

def process_annotations
  source_paths = argv.map {|file| Pathname(file) }
  Drivers::Annotations.new(source_paths: source_paths, stdout: stdout, stderr: stderr).run
end

#process_check ⇒ Object 



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/steep/cli.rb', line 184

def process_check
  with_signature_options do |signature_options|
    verbose = false
    dump_all_types = false
    fallback_any_is_error = false
    strict = false

    OptionParser.new do |opts|
      handle_dir_options opts, signature_options
      opts.on("--verbose") { verbose = true }
      opts.on("--dump-all-types") { dump_all_types = true }
      opts.on("--strict") { strict = true }
      opts.on("--fallback-any-is-error") { fallback_any_is_error = true }
    end.parse!(argv)

    source_paths = argv.map {|path| Pathname(path) }
    if source_paths.empty?
      source_paths << Pathname(".")
    end

    Drivers::Check.new(source_paths: source_paths, signature_dirs: signature_options.paths, stdout: stdout, stderr: stderr).tap do |check|
      check.verbose = verbose
      check.dump_all_types = dump_all_types
      check.fallback_any_is_error = fallback_any_is_error || strict
      check.allow_missing_definitions = false if strict
    end.run
  end
end

#process_global_options ⇒ Object 



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/steep/cli.rb', line 138

def process_global_options
  OptionParser.new do |opts|
    opts.on("--version") do
      process_version
      exit 0
    end
  end.order!

  true
end

#process_interface ⇒ Object 



238
239
240
241
242
243
244
245
246
 
# File 'lib/steep/cli.rb', line 238

def process_interface
  with_signature_options do |signature_options|
    OptionParser.new do |opts|
      handle_dir_options opts, signature_options
    end.parse!(argv)

    Drivers::PrintInterface.new(type_name: argv.first, signature_dirs: signature_options.paths, stdout: stdout, stderr: stderr).run
  end
end

#process_paths ⇒ Object 



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/steep/cli.rb', line 278

def process_paths
  with_signature_options do |signature_options|
    OptionParser.new do |opts|
      handle_dir_options opts, signature_options
    end.parse!(argv)

    signature_options.paths.each do |path|
      stdout.puts path
    end

    0
  end
end

#process_scaffold ⇒ Object 



233
234
235
236
 
# File 'lib/steep/cli.rb', line 233

def process_scaffold
  source_paths = argv.map {|file| Pathname(file) }
  Drivers::Scaffold.new(source_paths: source_paths, stdout: stdout, stderr: stderr).run
end

#process_validate ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/steep/cli.rb', line 213

def process_validate
  with_signature_options do |signature_options|
    verbose = false

    OptionParser.new do |opts|
      handle_dir_options opts, signature_options
      opts.on("--verbose") { verbose = true }
    end.parse!(argv)

    Drivers::Validate.new(signature_dirs: signature_options.paths, stdout: stdout, stderr: stderr).tap do |validate|
      validate.verbose = verbose
    end.run
  end
end

#process_version ⇒ Object 



273
274
275
276
 
# File 'lib/steep/cli.rb', line 273

def process_version
  stdout.puts Steep::VERSION
  0
end

#process_watch ⇒ Object 



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/steep/cli.rb', line 248

def process_watch
  with_signature_options do |signature_options|
    strict = false
    fallback_any_is_error = false

    OptionParser.new do |opts|
      handle_dir_options opts, signature_options
      opts.on("--strict") { strict = true }
      opts.on("--fallback-any-is-error") { fallback_any_is_error = true }
    end.parse!(argv)

    source_dirs = argv.map {|path| Pathname(path) }
    if source_dirs.empty?
      source_dirs << Pathname(".")
    end

    Drivers::Watch.new(source_dirs: source_dirs, signature_dirs: signature_options.paths, stdout: stdout, stderr: stderr).tap do |driver|
      driver.options.fallback_any_is_error = fallback_any_is_error || strict
      driver.options.allow_missing_definitions = false if strict
    end.run

    0
  end
end

#run ⇒ Object 



160
161
162
163
164
165
 
# File 'lib/steep/cli.rb', line 160

def run
  process_global_options or return 1
  setup_command or return 1

  __send__(:"process_#{command}")
end

#setup_command ⇒ Object 



149
150
151
152
153
154
155
156
157
158
 
# File 'lib/steep/cli.rb', line 149

def setup_command
  @command = argv.shift&.to_sym
  if CLI.available_commands.include?(@command)
    true
  else
    stderr.puts "Unknown command: #{command}"
    stderr.puts "  available commands: #{CLI.available_commands.join(', ')}"
    false
  end
end

#with_signature_options ⇒ Object 



174
175
176
177
178
179
180
181
182
 
# File 'lib/steep/cli.rb', line 174

def with_signature_options
  yield SignatureOptions.new
rescue SignatureOptions::MissingGemError => exn
  stderr.puts Rainbow("Gem not found: name=#{exn.name}, version=#{exn.version}").red
  1
rescue SignatureOptions::NoTypeDefinitionFromGemError => exn
  stderr.puts Rainbow("Type definition directory not found: #{exn.gemspec.name} (#{exn.gemspec.version})").red
  1
end