Class: RBS::CLI

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

Defined Under Namespace

Classes: LibraryOptions

Constant Summary collapse

COMMANDS = 
[:ast, :list, :ancestors, :methods, :method, :validate, :constant, :paths, :prototype, :vendor, :parse]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(stdout:, stderr:) ⇒ CLI

Returns a new instance of CLI.



34
35
36
37
 
# File 'lib/rbs/cli.rb', line 34

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

Instance Attribute Details

#stderr ⇒ Object (readonly)

Returns the value of attribute stderr.



32
33
34
 
# File 'lib/rbs/cli.rb', line 32

def stderr
  @stderr
end

#stdout ⇒ Object (readonly)

Returns the value of attribute stdout.



31
32
33
 
# File 'lib/rbs/cli.rb', line 31

def stdout
  @stdout
end

Instance Method Details

#has_parser? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/rbs/cli.rb', line 69

def has_parser?
  defined?(RubyVM::AbstractSyntaxTree)
end

#library_parse(opts, options:) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/rbs/cli.rb', line 41

def library_parse(opts, options:)
  opts.on("-r LIBRARY", "Load RBS files of the library") do |lib|
    options.libs << lib
  end

  opts.on("-I DIR", "Load RBS files from the directory") do |dir|
    options.dirs << dir
  end

  opts.on("--no-stdlib", "Skip loading standard library signatures") do
    options.no_stdlib = true
  end

  opts
end

#parse_logging_options(opts) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/rbs/cli.rb', line 57

def parse_logging_options(opts)
  opts.on("--log-level LEVEL", "Specify log level (defaults to `warn`)") do |level|
    RBS.logger_level = level
  end

  opts.on("--log-output OUTPUT", "Specify the file to output log (defaults to stderr)") do |output|
    RBS.logger_output = File.open(output, "a")
  end

  opts
end

#parse_type_name(string) ⇒ Object 



747
748
749
750
751
752
 
# File 'lib/rbs/cli.rb', line 747

def parse_type_name(string)
  Namespace.parse(string).yield_self do |namespace|
    last = namespace.path.last
    TypeName.new(name: last, namespace: namespace.parent)
  end
end

#run(args) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/rbs/cli.rb', line 73

def run(args)
  options = LibraryOptions.new

  opts = OptionParser.new
  opts.banner = <<~USAGE
    Usage: rbs [options...] [command...]

    Available commands: #{COMMANDS.join(", ")}, version, help.

    Options:
  USAGE
  library_parse(opts, options: options)
  parse_logging_options(opts)
  opts.version = RBS::VERSION

  opts.order!(args)

  command = args.shift&.to_sym

  case command
  when :version
    stdout.puts opts.ver
  when *COMMANDS
    __send__ :"run_#{command}", args, options
  else
    stdout.puts opts.help
  end
end

#run_ancestors(args, options) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/rbs/cli.rb', line 202

def run_ancestors(args, options)
  kind = :instance

  OptionParser.new do |opts|
    opts.banner = <<EOU
Usage: rbs ancestors [options...] [type_name]

Show ancestors of the given class or module.

Examples:

  $ rbs ancestors --instance String
  $ rbs ancestors --singleton Array

Options:
EOU
    opts.on("--instance", "Ancestors of instance of the given type_name (default)") { kind = :instance }
    opts.on("--singleton", "Ancestors of singleton of the given type_name") { kind = :singleton }
  end.order!(args)

  loader = EnvironmentLoader.new()
  options.setup(loader)

  env = Environment.from_loader(loader).resolve_type_names

  builder = DefinitionBuilder.new(env: env)
  type_name = parse_type_name(args[0]).absolute!

  if env.class_decls.key?(type_name)
    ancestors = case kind
                when :instance
                  builder.instance_ancestors(type_name)
                when :singleton
                  builder.singleton_ancestors(type_name)
                end

    ancestors.ancestors.each do |ancestor|
      case ancestor
      when Definition::Ancestor::Singleton
        stdout.puts "singleton(#{ancestor.name})"
      when Definition::Ancestor::Instance
        if ancestor.args.empty?
          stdout.puts ancestor.name.to_s
        else
          stdout.puts "#{ancestor.name}[#{ancestor.args.join(", ")}]"
        end
      end
    end
  else
    stdout.puts "Cannot find class: #{type_name}"
  end
end

#run_ast(args, options) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/rbs/cli.rb', line 102

def run_ast(args, options)
  OptionParser.new do |opts|
    opts.banner = <<EOB
Usage: rbs ast [patterns...]

Print JSON AST of loaded environment.
You can specify patterns to filter declarations with the file names.

Examples:

  $ rbs ast
  $ rbs ast 'basic_object.rbs'
  $ rbs -I ./sig ast ./sig
  $ rbs -I ./sig ast '*/models/*.rbs'
EOB
  end.order!(args)

  patterns = args.map do |arg|
    path = Pathname(arg)
    if path.exist?
      # Pathname means a directory or a file
      path
    else
      # String means a `fnmatch` pattern
      arg
    end
  end

  loader = EnvironmentLoader.new()
  options.setup(loader)

  env = Environment.from_loader(loader).resolve_type_names

  decls = env.declarations.select do |decl|
    name = decl.location.buffer.name

    patterns.empty? || patterns.any? do |pat|
      case pat
      when Pathname
        Pathname(name).ascend.any? {|p| p == pat }
      when String
        name.end_with?(pat) || File.fnmatch(pat, name, File::FNM_EXTGLOB)
      end
    end
  end

  stdout.print JSON.generate(decls)
  stdout.flush
end

#run_constant(args, options) ⇒ Object 



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/rbs/cli.rb', line 432

def run_constant(args, options)
  context = nil

  OptionParser.new do |opts|
    opts.banner = <<EOU
Usage: rbs constant [options...] [name]

Resolve constant based on RBS.

Examples:

  $ rbs constant ::Object
  $ rbs constant UTF_8
  $ rbs constant --context=::Encoding UTF_8

Options:
EOU
    opts.on("--context CONTEXT", "Name of the module where the constant resolution starts") {|c| context = c }
  end.order!(args)

  unless args.size == 1
    stdout.puts "Expected one argument."
    return
  end

  loader = EnvironmentLoader.new()

  options.setup(loader)

  env = Environment.from_loader(loader).resolve_type_names

  builder = DefinitionBuilder.new(env: env)
  table = ConstantTable.new(builder: builder)

  namespace = context ? Namespace.parse(context).absolute! : Namespace.root
  stdout.puts "Context: #{namespace}"
  name = Namespace.parse(args[0]).to_type_name
  stdout.puts "Constant name: #{name}"

  constant = table.resolve_constant_reference(name, context: namespace.ascend.to_a)

  if constant
    stdout.puts " => #{constant.name}: #{constant.type}"
  else
    stdout.puts " => [no constant]"
  end
end

#run_list(args, options) ⇒ Object 



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
 
# File 'lib/rbs/cli.rb', line 152

def run_list(args, options)
  list = Set[]

  OptionParser.new do |opts|
    opts.banner = <<EOB
Usage: rbs list [options...]

List classes, modules, and interfaces.

Examples:

  $ rbs list
  $ rbs list --class --module --interface

Options:
EOB
    opts.on("--class", "List classes") { list << :class }
    opts.on("--module", "List modules") { list << :module }
    opts.on("--interface", "List interfaces") { list << :interface }
  end.order!(args)

  list.merge([:class, :module, :interface]) if list.empty?

  loader = EnvironmentLoader.new()
  options.setup(loader)

  env = Environment.from_loader(loader).resolve_type_names

  if list.include?(:class) || list.include?(:module)
    env.class_decls.each do |name, entry|
      case entry
      when Environment::ModuleEntry
        if list.include?(:module)
          stdout.puts "#{name} (module)"
        end
      when Environment::ClassEntry
        if list.include?(:class)
          stdout.puts "#{name} (class)"
        end
      end
    end
  end

  if list.include?(:interface)
    env.interface_decls.each do |name, entry|
      stdout.puts "#{name} (interface)"
    end
  end
end

#run_method(args, options) ⇒ Object 



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/rbs/cli.rb', line 309

def run_method(args, options)
  kind = :instance

  OptionParser.new do |opts|
    opts.banner = <<EOU
Usage: rbs method [options...] [type_name] [method_name]

Show the information of the method specified by type_name and method_name.

Examples:

  $ rbs method --instance Kernel puts
  $ rbs method --singleton String try_convert

Options:
EOU
    opts.on("--instance", "Show an instance method (default)") { kind = :instance }
    opts.on("--singleton", "Show a singleton method") { kind = :singleton }
  end.order!(args)

  unless args.size == 2
    stdout.puts "Expected two arguments, but given #{args.size}."
    return
  end

  loader = EnvironmentLoader.new()
  options.setup(loader)

  env = Environment.from_loader(loader).resolve_type_names

  builder = DefinitionBuilder.new(env: env)
  type_name = parse_type_name(args[0]).absolute!
  method_name = args[1].to_sym

  unless env.class_decls.key?(type_name)
    stdout.puts "Cannot find class: #{type_name}"
    return
  end

  definition = case kind
               when :instance
                 builder.build_instance(type_name)
               when :singleton
                 builder.build_singleton(type_name)
               end

  method = definition.methods[method_name]

  unless method
    stdout.puts "Cannot find method: #{method_name}"
    return
  end

  stdout.puts "#{type_name}#{kind == :instance ? "#" : "."}#{method_name}"
  stdout.puts "  defined_in: #{method.defined_in}"
  stdout.puts "  implementation: #{method.implemented_in}"
  stdout.puts "  accessibility: #{method.accessibility}"
  stdout.puts "  types:"
  separator = " "
  for type in method.method_types
    stdout.puts "    #{separator} #{type}"
    separator = "|"
  end
end

#run_methods(args, options) ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/rbs/cli.rb', line 255

def run_methods(args, options)
  kind = :instance
  inherit = true

  OptionParser.new do |opts|
    opts.banner = <<EOU
Usage: rbs methods [options...] [type_name]

Show methods defined in the class or module.

Examples:

  $ rbs methods --instance Kernel
  $ rbs methods --singleton --no-inherit String

Options:
EOU
    opts.on("--instance", "Show instance methods (default)") { kind = :instance }
    opts.on("--singleton", "Show singleton methods") { kind = :singleton }
    opts.on("--[no-]inherit", "Show methods defined in super class and mixed modules too") {|v| inherit = v }
  end.order!(args)

  unless args.size == 1
    stdout.puts "Expected one argument."
    return
  end

  loader = EnvironmentLoader.new()
  options.setup(loader)

  env = Environment.from_loader(loader).resolve_type_names

  builder = DefinitionBuilder.new(env: env)
  type_name = parse_type_name(args[0]).absolute!

  if env.class_decls.key?(type_name)
    definition = case kind
                 when :instance
                   builder.build_instance(type_name)
                 when :singleton
                   builder.build_singleton(type_name)
                 end

    definition.methods.keys.sort.each do |name|
      method = definition.methods[name]
      if inherit || method.implemented_in == type_name
        stdout.puts "#{name} (#{method.accessibility})"
      end
    end
  else
    stdout.puts "Cannot find class: #{type_name}"
  end
end

#run_parse(args, options) ⇒ Object 



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/rbs/cli.rb', line 713

def run_parse(args, options)
  OptionParser.new do |opts|
    opts.banner = <<-EOB
Usage: rbs parse [files...]

Parse given RBS files and print syntax errors.

Examples:

  $ rbs parse sig/app/models.rbs sig/app/controllers.rbs
    EOB
  end.parse!(args)

  loader = EnvironmentLoader.new()

  syntax_error = false
  args.each do |path|
    path = Pathname(path)
    loader.each_signature(path) do |sig_path|
      Parser.parse_signature(sig_path.read)
    rescue RBS::Parser::SyntaxError => ex
      loc = ex.error_value.location
      stdout.puts "#{sig_path}:#{loc.start_line}:#{loc.start_column}: parse error on value: (#{ex.token_str})"
      syntax_error = true
    rescue RBS::Parser::SemanticsError => ex
      loc = ex.location
      stdout.puts "#{sig_path}:#{loc.start_line}:#{loc.start_column}: #{ex.original_message}"
      syntax_error = true
    end
  end

  exit 1 if syntax_error
end

#run_paths(args, options) ⇒ Object 



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/rbs/cli.rb', line 480

def run_paths(args, options)
  OptionParser.new do |opts|
    opts.banner = <<EOU
Usage: rbs paths

Show paths to directories where the RBS files are loaded from.

Examples:

  $ rbs paths
  $ tbs -r set paths
EOU
  end.parse!(args)

  loader = EnvironmentLoader.new()

  options.setup(loader)

  kind_of = -> (path) {
    case
    when path.file?
      "file"
    when path.directory?
      "dir"
    when !path.exist?
      "absent"
    else
      "unknown"
    end
  }

  if loader.stdlib_root
    path = loader.stdlib_root
    stdout.puts "#{path}/builtin (#{kind_of[path]}, stdlib)"
  end

  loader.paths.each do |path|
    case path
    when Pathname
      stdout.puts "#{path} (#{kind_of[path]})"
    when EnvironmentLoader::GemPath
      stdout.puts "#{path.path} (#{kind_of[path.path]}, gem, name=#{path.name}, version=#{path.version})"
    when EnvironmentLoader::LibraryPath
      stdout.puts "#{path.path} (#{kind_of[path.path]}, library, name=#{path.name})"
    end
  end
end

#run_prototype(args, options) ⇒ Object 



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/rbs/cli.rb', line 528

def run_prototype(args, options)
  format = args.shift

  case format
  when "rbi", "rb"
    decls = run_prototype_file(format, args)
  when "runtime"
    require_libs = []
    relative_libs = []
    merge = false
    owners_included = []

    OptionParser.new do |opts|
      opts.banner = <<EOU
Usage: rbs prototype runtime [options...] [pattern...]

Generate RBS prototype based on runtime introspection.
It loads Ruby code specified in [options] and generates RBS prototypes for classes matches to [pattern]. 

Examples:

  $ rbs prototype runtime String
  $ rbs prototype runtime --require set Set
  $ rbs prototype runtime -R lib/rbs RBS::*

Options:
EOU
      opts.on("-r", "--require LIB", "Load library using `require`") do |lib|
        require_libs << lib
      end
      opts.on("-R", "--require-relative LIB", "Load library using `require_relative`") do |lib|
        relative_libs << lib
      end
      opts.on("--merge", "Merge generated prototype RBS with existing RBS") do
        merge = true
      end
      opts.on("--method-owner CLASS", "Generate method prototypes if the owner of the method is [CLASS]") do |klass|
        owners_included << klass
      end
    end.parse!(args)

    loader = EnvironmentLoader.new()

    options.setup(loader)

    env = Environment.from_loader(loader).resolve_type_names

    require_libs.each do |lib|
      require(lib)
    end

    relative_libs.each do |lib|
      eval("require_relative(lib)", binding, "rbs")
    end

    decls = Prototype::Runtime.new(patterns: args, env: env, merge: merge, owners_included: owners_included).decls
  else
    stdout.puts <<EOU
Usage: rbs prototype [generator...] [args...]

Generate prototype of RBS files.
Supported generators are rb, rbi, runtime.

Examples:

  $ rbs prototype rb foo.rb
  $ rbs prototype rbi foo.rbi
  $ rbs prototype runtime String
EOU
    exit 1
  end

  if decls
    writer = Writer.new(out: stdout)
    writer.write decls
  else
    exit 1
  end
end

#run_prototype_file(format, args) ⇒ Object 



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/rbs/cli.rb', line 608

def run_prototype_file(format, args)
  availability = unless has_parser?
                   "\n** This command does not work on this interpreter (#{RUBY_ENGINE}) **\n"
                 end

  opts = OptionParser.new
  opts.banner = <<EOU
Usage: rbs prototype #{format} [options...] [files...]
#{availability}
Generate RBS prototype from source code.
It parses specified Ruby code and and generates RBS prototypes.

It only works on MRI because it parses Ruby code with `RubyVM::AbstractSyntaxTree`.

Examples:

  $ rbs prototype rb lib/foo.rb
  $ rbs prototype rbi sorbet/rbi/foo.rbi
EOU
  opts.parse!(args)

  unless has_parser?
    stdout.puts "Not supported on this interpreter (#{RUBY_ENGINE})."
    exit 1
  end

  if args.empty?
    stdout.puts opts
    return nil
  end

  parser = case format
           when "rbi"
             Prototype::RBI.new()
           when "rb"
             Prototype::RB.new()
           end

  args.each do |file|
    parser.parse Pathname(file).read
  end

  parser.decls
end

#run_validate(args, options) ⇒ Object 



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/rbs/cli.rb', line 374

def run_validate(args, options)
  OptionParser.new do |opts|
    opts.banner = <<EOU
Usage: rbs validate

Validate RBS files. It ensures the type names in RBS files are present and the type applications have correct arity.

Examples:

  $ rbs validate
EOU
  end.parse!(args)

  loader = EnvironmentLoader.new()

  options.setup(loader)

  env = Environment.from_loader(loader).resolve_type_names

  builder = DefinitionBuilder.new(env: env)
  validator = Validator.new(env: env, resolver: TypeNameResolver.from_env(env))

  env.class_decls.each_key do |name|
    stdout.puts "Validating class/module definition: `#{name}`..."
    builder.build_instance(name).each_type do |type|
      validator.validate_type type, context: [Namespace.root]
    end
    builder.build_singleton(name).each_type do |type|
      validator.validate_type type, context: [Namespace.root]
    end
  end

  env.interface_decls.each_key do |name|
    stdout.puts "Validating interface: `#{name}`..."
    builder.build_interface(name).each_type do |type|
      validator.validate_type type, context: [Namespace.root]
    end
  end

  env.constant_decls.each do |name, const|
    stdout.puts "Validating constant: `#{name}`..."
    validator.validate_type const.decl.type, context: const.context
    builder.ensure_namespace!(name.namespace, location: const.decl.location)
  end

  env.global_decls.each do |name, global|
    stdout.puts "Validating global: `#{name}`..."
    validator.validate_type global.decl.type, context: [Namespace.root]
  end

  env.alias_decls.each do |name, decl|
    stdout.puts "Validating alias: `#{name}`..."
    builder.expand_alias(name).tap do |type|
      validator.validate_type type, context: [Namespace.root]
    end
  end
end

#run_vendor(args, options) ⇒ Object 



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/rbs/cli.rb', line 653

def run_vendor(args, options)
  clean = false
  vendor_stdlib = false
  vendor_dir = Pathname("vendor/sigs")

  OptionParser.new do |opts|
    opts.banner = <<-EOB
Usage: rbs vendor [options...] [gems...]

Vendor signatures in the project directory.
This command ignores the RBS loading global options, `-r` and `-I`.

Examples:

  $ rbs vendor
  $ rbs vendor --vendor-dir=sig
  $ rbs vendor --no-stdlib

Options:
    EOB

    opts.on("--[no-]clean", "Clean vendor directory (default: no)") do |v|
      clean = v
    end

    opts.on("--[no-]stdlib", "Vendor stdlib signatures or not (default: no)") do |v|
      vendor_stdlib = v
    end

    opts.on("--vendor-dir [DIR]", "Specify the directory for vendored signatures (default: vendor/sigs)") do |path|
      vendor_dir = Pathname(path)
    end
  end.parse!(args)

  stdout.puts "Vendoring signatures to #{vendor_dir}..."

  vendorer = Vendorer.new(vendor_dir: vendor_dir)

  if clean
    stdout.puts "  Deleting #{vendor_dir}..."
    vendorer.clean!
  end

  if vendor_stdlib
    stdout.puts "  Vendoring standard libraries..."
    vendorer.stdlib!
  end

  args.each do |gem|
    name, version = EnvironmentLoader.parse_library(gem)

    unless EnvironmentLoader.gem_sig_path(name, version)
      stdout.puts "  ⚠️ Cannot find rubygem: name=#{name}, version=#{version} 🚨"
    else
      stdout.puts "  Vendoring gem: name=#{name}, version=#{version}..."
      vendorer.gem!(name, version)
    end
  end
end