Class: RBS::CLI

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

Defined Under Namespace

Classes: ColoredIO, Diff, LibraryOptions

Constant Summary collapse

COMMANDS = 
[:ast, :annotate, :list, :ancestors, :methods, :method, :validate, :constant, :paths, :prototype, :vendor, :parse, :test, :collection, :subtract, :diff]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(stdout:, stderr:) ⇒ CLI

Returns a new instance of CLI.



91
92
93
94
 
# File 'lib/rbs/cli.rb', line 91

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

Instance Attribute Details

#original_args ⇒ Object (readonly)

Returns the value of attribute original_args.



89
90
91
 
# File 'lib/rbs/cli.rb', line 89

def original_args
  @original_args
end

#stderr ⇒ Object (readonly)

Returns the value of attribute stderr.



88
89
90
 
# File 'lib/rbs/cli.rb', line 88

def stderr
  @stderr
end

#stdout ⇒ Object (readonly)

Returns the value of attribute stdout.



87
88
89
 
# File 'lib/rbs/cli.rb', line 87

def stdout
  @stdout
end

Instance Method Details

#collection_options(args) ⇒ Object 



1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
 
# File 'lib/rbs/cli.rb', line 1308

def collection_options(args)
  OptionParser.new do |opts|
    opts.banner = <<~HELP
      Usage: rbs collection [install|update|init|clean|help]

      Manage RBS collection, which contains third party RBS.

      Examples:

        # Initialize the configuration file
        $ rbs collection init

        # Generate the lock file and install RBSs from the lock file
        $ rbs collection install

        # Update the RBSs
        $ rbs collection update

      Options:
    HELP
    opts.on('--frozen') if args[0] == 'install'
  end
end

#has_parser? ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/rbs/cli.rb', line 111

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

#parse_logging_options(opts) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/rbs/cli.rb', line 98

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|
    io = File.open(output, "a") or raise
    RBS.logger_output = io
  end

  opts
end

#run(args) ⇒ Object 



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

def run(args)
  @original_args = args.dup

  options = LibraryOptions.new

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

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

    Options:
  USAGE
  options.setup_library_options(opts)
  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 



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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/rbs/cli.rb', line 260

def run_ancestors(args, options)
  # @type var kind: :instance | :singleton
  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)

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

  loader = options.loader()

  env = Environment.from_loader(loader).resolve_type_names

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

  case env.constant_entry(type_name)
  when Environment::ClassEntry, Environment::ModuleEntry, Environment::ClassAliasEntry, Environment::ModuleAliasEntry
    type_name = env.normalize_module_name(type_name)

    ancestors = case kind
                when :instance
                  builder.instance_ancestors(type_name)
                when :singleton
                  builder.singleton_ancestors(type_name)
                else
                  raise
                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_annotate(args, options) ⇒ Object 



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
 
# File 'lib/rbs/cli.rb', line 1127

def run_annotate(args, options)
  require "rbs/annotate"

  source = RBS::Annotate::RDocSource.new()
  annotator = RBS::Annotate::RDocAnnotator.new(source: source)

  preserve = true

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

Import documents from RDoc and update RBS files.

Examples:

  $ rbs annotate stdlib/pathname/**/*.rbs

Options:
    EOB

    opts.on("--[no-]system", "Load RDoc from system (defaults to true)") {|b| source.with_system_dir = b }
    opts.on("--[no-]gems", "Load RDoc from gems (defaults to false)") {|b| source.with_gems_dir = b }
    opts.on("--[no-]site", "Load RDoc from site directory (defaults to false)") {|b| source.with_site_dir = b }
    opts.on("--[no-]home", "Load RDoc from home directory (defaults to false)") {|b| source.with_home_dir = b }
    opts.on("-d", "--dir DIRNAME", "Load RDoc from DIRNAME") {|d| source.extra_dirs << Pathname(d) }
    opts.on("--[no-]arglists", "Generate arglists section (defaults to true)") {|b| annotator.include_arg_lists = b }
    opts.on("--[no-]filename", "Include source file name in the documentation (defaults to true)") {|b| annotator.include_filename = b }
    opts.on("--[no-]preserve", "Try preserve the format of the original file (defaults to true)") {|b| preserve = b }
  end.parse!(args)

  source.load()

  args.each do |file|
    path = Pathname(file)
    if path.directory?
      Pathname.glob((path + "**/*.rbs").to_s).each do |path|
        stdout.puts "Processing #{path}..."
        annotator.annotate_file(path, preserve: preserve)
      end
    else
      stdout.puts "Processing #{path}..."
      annotator.annotate_file(path, preserve: preserve)
    end
  end
end

#run_ast(args, options) ⇒ Object 



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

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 = options.loader()

  env = Environment.from_loader(loader).resolve_type_names

  decls = env.declarations.select do |decl|
    loc = decl.location or raise
    # @type var name: String
    name = loc.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_collection(args, options) ⇒ Object 



1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
 
# File 'lib/rbs/cli.rb', line 1248

def run_collection(args, options)
  opts = collection_options(args)
  params = {}
  opts.order args.drop(1), into: params
  config_path = options.config_path or raise
  lock_path = Collection::Config.to_lockfile_path(config_path)

  subcommand = Abbrev.abbrev(['install', 'update', 'help'])[args[0]] || args[0]
  case subcommand
  when 'install'
    unless params[:frozen]
      Collection::Config.generate_lockfile(config_path: config_path, definition: Bundler.definition)
    end
    Collection::Installer.new(lockfile_path: lock_path, stdout: stdout).install_from_lockfile
  when 'update'
    # TODO: Be aware of argv to update only specified gem
    Collection::Config.generate_lockfile(config_path: config_path, definition: Bundler.definition, with_lockfile: false)
    Collection::Installer.new(lockfile_path: lock_path, stdout: stdout).install_from_lockfile
  when 'init'
    if config_path.exist?
      puts "#{config_path} already exists"
      exit 1
    end

    config_path.write(<<~'YAML')
      # Download sources
      sources:
        - type: git
          name: ruby/gem_rbs_collection
          remote: https://github.com/ruby/gem_rbs_collection.git
          revision: main
          repo_dir: gems

      # You can specify local directories as sources also.
      # - type: local
      #   path: path/to/your/local/repository

      # A directory to install the downloaded RBSs
      path: .gem_rbs_collection

      # gems:
      #   # If you want to avoid installing rbs files for gems, you can specify them here.
      #   - name: GEM_NAME
      #     ignore: true
    YAML
    stdout.puts "created: #{config_path}"
  when 'clean'
    unless lock_path.exist?
      puts "#{lock_path} should exist to clean"
      exit 1
    end
    Collection::Cleaner.new(lockfile_path: lock_path)
  when 'help'
    puts opts.help
  else
    puts opts.help
    exit 1
  end
end

#run_constant(args, options) ⇒ Object 



643
644
645
646
647
648
649
650
651
652
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
 
# File 'lib/rbs/cli.rb', line 643

def run_constant(args, options)
  # @type var context: String?
  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 = options.loader()
  env = Environment.from_loader(loader).resolve_type_names

  builder = DefinitionBuilder.new(env: env)
  resolver = Resolver::ConstantResolver.new(builder: builder)

  resolver_context = context ? [nil, TypeName(context).absolute!] : nil #: Resolver::context
  stdout.puts "Context: #{context}"
  const_name = TypeName(args[0])
  stdout.puts "Constant name: #{const_name}"

  if const_name.absolute?
    constant = resolver.table.constant(const_name)
  else
    head, *components = const_name.to_namespace.path
    head or raise

    constant = resolver.resolve(head, context: resolver_context)
    constant = components.inject(constant) do |const, component|
      if const
        resolver.resolve_child(const.name, component)
      end
    end
  end

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

#run_diff(argv, library_options) ⇒ Object 



1411
1412
1413
 
# File 'lib/rbs/cli.rb', line 1411

def run_diff(argv, library_options)
  Diff.new(argv: argv, library_options: library_options, stdout: stdout, stderr: stderr).run
end

#run_list(args, options) ⇒ Object 



197
198
199
200
201
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
254
255
256
257
258
 
# File 'lib/rbs/cli.rb', line 197

def run_list(args, options)
  # @type var list: Set[:class | :module | :interface]
  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 = options.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

    env.class_alias_decls.each do |name, entry|
      case entry
      when Environment::ModuleAliasEntry
        if list.include?(:module)
          stdout.puts "#{name} (module alias)"
        end
      when Environment::ClassAliasEntry
        if list.include?(:class)
          stdout.puts "#{name} (class alias)"
        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 



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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/rbs/cli.rb', line 379

def run_method(args, options)
  # @type var kind: :instance | :singleton
  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 = options.loader()
  env = Environment.from_loader(loader).resolve_type_names

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

  unless env.module_name?(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)
               else
                 raise
               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 = " "
  length_max = method.method_types.map { |type| type.to_s.length }.max or raise
  method.method_types.each do |type|
    stdout.puts format("    %s %-#{length_max}s   at %s", separator, type, type.location)
    separator = "|"
  end
end

#run_methods(args, options) ⇒ Object 



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
373
374
375
376
377
 
# File 'lib/rbs/cli.rb', line 323

def run_methods(args, options)
  # @type var kind: :instance | :singleton
  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 = options.loader()

  env = Environment.from_loader(loader).resolve_type_names

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

  if env.module_name?(type_name)
    definition = case kind
                 when :instance
                   builder.build_instance(type_name)
                 when :singleton
                   builder.build_singleton(type_name)
                 else
                   raise
                 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 



1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/rbs/cli.rb', line 1079

def run_parse(args, options)
  parse_method = :parse_signature
  # @type var e_code: String?
  e_code = nil

  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

Options:
    EOB

    opts.on('-e CODE', 'One line RBS script to parse') { |e| e_code = e }
    opts.on('--type', 'Parse code as a type') { |e| parse_method = :parse_type }
    opts.on('--method-type', 'Parse code as a method type') { |e| parse_method = :parse_method_type }
  end.parse!(args)

  syntax_error = false
  bufs = args.flat_map do |path|
    path = Pathname(path)
    FileFinder.each_file(path, skip_hidden: false, immediate: true).map do |file_path|
      Buffer.new(content: file_path.read, name: file_path)
    end
  end
  bufs << Buffer.new(content: e_code, name: '-e') if e_code

  bufs.each do |buf|
    RBS.logger.info "Parsing #{buf.name}..."
    case parse_method
    when :parse_signature
      Parser.parse_signature(buf)
    else
      Parser.public_send(parse_method, buf, require_eof: true)
    end
  rescue RBS::ParsingError => ex
    stdout.print ex.detailed_message(highlight: true)
    syntax_error = true
  end

  exit 1 if syntax_error
end

#run_paths(args, options) ⇒ Object 



701
702
703
704
705
706
707
708
709
710
711
712
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
 
# File 'lib/rbs/cli.rb', line 701

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
  $ rbs -r set paths
EOU
  end.parse!(args)

  loader = options.loader()

  kind_of = -> (path) {
    # @type var path: Pathname
    case
    when path.file?
      "file"
    when path.directory?
      "dir"
    when !path.exist?
      "absent"
    else
      "unknown"
    end
  }

  loader.each_dir do |source, dir|
    case source
    when :core
      stdout.puts "#{dir} (#{kind_of[dir]}, core)"
    when Pathname
      stdout.puts "#{dir} (#{kind_of[dir]})"
    when EnvironmentLoader::Library
      stdout.puts "#{dir} (#{kind_of[dir]}, library, name=#{source.name})"
    end
  end
end

#run_prototype(args, options) ⇒ Object 



743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
 
# File 'lib/rbs/cli.rb', line 743

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

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

    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 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("--todo", "Generates only undefined methods compared to objects") do
        Warning.warn("Geneating prototypes with `--todo` option is experimental\n", category: :experimental)
        todo = true
      end
      opts.on("--method-owner CLASS", "Generate method prototypes if the owner of the method is [CLASS]") do |klass|
        owners_included << klass
      end
      opts.on("--outline", "Generates only module/class/constant declaration (no method definition)") do
        outline = true
      end
      opts.on("--autoload", "Load all autoload path") do
        autoload = true
      end
    end.parse!(args)

    loader = options.loader()
    env = Environment.from_loader(loader).resolve_type_names

    # @type var autoloader: ^() { () -> void } -> void
    autoloader = ->(&block) {
      if autoload
        hook = Module.new do
          def autoload(name, path)
            super
          end
        end
        ::Module.prepend(hook)
        ::Kernel.prepend(hook)

        arguments = []
        TracePoint.new(:call) do |tp|
          base = tp.self.kind_of?(Module) ? tp.self : Kernel
          name = (tp.binding or raise).local_variable_get(:name)
          arguments << [base, name]
        end.enable(target: hook.instance_method(:autoload), &block)

        arguments.each do |(base, name)|
          begin
            base.const_get(name)
          rescue LoadError, StandardError
          end
        end
      else
        block.call
      end
    }
    autoloader.call do
      require_libs.each do |lib|
        require(lib)
      end
      relative_libs.each do |lib|
        eval("require_relative(lib)", binding, "rbs")
      end
    end

    runtime = Prototype::Runtime.new(patterns: args, env: env, merge: merge, todo: todo, owners_included: owners_included)
    runtime.outline = outline

    decls = runtime.decls

    writer = Writer.new(out: stdout)
    writer.write 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
end

#run_prototype_file(format, args) ⇒ Object 



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'lib/rbs/cli.rb', line 861

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

  # @type var output_dir: Pathname?
  output_dir = nil
  # @type var base_dir: Pathname?
  base_dir = nil
  # @type var force: bool
  force = false

  opts = OptionParser.new
  opts.banner = <<EOU
Usage: rbs prototype #{format} [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

You can run the tool in *batch* mode by passing `--out-dir` option.

  $ rbs prototype rb --out-dir=sig lib/foo.rb
  $ rbs prototype rbi --out-dir=sig/models --base-dir=app/models app/models
EOU

  opts.on("--out-dir=DIR", "Specify the path to save the generated RBS files") do |path|
    output_dir = Pathname(path)
  end

  opts.on("--base-dir=DIR", "Specify the path to calculate the relative path to save the generated RBS files") do |path|
    base_dir = Pathname(path)
  end

  opts.on("--force", "Overwrite existing RBS files") do
    force = true
  end

  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

  new_parser = -> do
    case format
    when "rbi"
      Prototype::RBI.new()
    when "rb"
      Prototype::RB.new()
    else
      raise
    end
  end

  input_paths = args.map {|arg| Pathname(arg) }

  if output_dir
    # @type var skip_paths: Array[Pathname]
    skip_paths = []

    # batch mode
    input_paths.each do |path|
      stdout.puts "Processing `#{path}`..."
      ruby_files =
        if path.file?
          [path]
        else
          path.glob("**/*.rb").sort
        end

      ruby_files.each do |file_path|
        stdout.puts "  Generating RBS for `#{file_path}`..."

        relative_path =
          if base_dir
            file_path.relative_path_from(base_dir)
          else
            if top = file_path.descend.first
              case
              when top == Pathname("lib")
                file_path.relative_path_from(top)
              when top == Pathname("app")
                file_path.relative_path_from(top)
              else
                file_path
              end
            else
              file_path
            end
          end
        relative_path = relative_path.cleanpath()

        if relative_path.absolute? || relative_path.descend.first&.to_s == ".."
          stdout.puts "  ⚠️  Cannot write the RBS to outside of the output dir: `#{relative_path}`"
          next
        end

        output_path = (output_dir + relative_path).sub_ext(".rbs")

        parser = new_parser[]
        begin
          parser.parse file_path.read()
        rescue SyntaxError
          stdout.puts "  ⚠️  Unable to parse due to SyntaxError: `#{file_path}`"
          next
        end

        if output_path.file?
          if force
            stdout.puts "    - Writing RBS to existing file `#{output_path}`..."
          else
            stdout.puts "    - Skipping existing file `#{output_path}`..."
            skip_paths << file_path
            next
          end
        else
          stdout.puts "    - Writing RBS to `#{output_path}`..."
        end

        (output_path.parent).mkpath
        output_path.open("w") do |io|
          writer = Writer.new(out: io)
          writer.write(parser.decls)
        end
      end
    end

    unless skip_paths.empty?
      stdout.puts
      stdout.puts ">>>> Skipped existing #{skip_paths.size} files. Use `--force` option to update the files."
      command = original_args.take(original_args.size - input_paths.size)

      skip_paths.take(10).each do |path|
        stdout.puts "  #{defined?(Bundler) ? "bundle exec " : ""}rbs #{Shellwords.join(command)} --force #{Shellwords.escape(path.to_s)}"
      end
      if skip_paths.size > 10
        stdout.puts "  ..."
      end
    end
  else
    # file mode
    parser = new_parser[]

    input_paths.each do |file|
      parser.parse file.read()
    end

    writer = Writer.new(out: stdout)
    writer.write parser.decls
  end
end

#run_subtract(args, _) ⇒ Object 



1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
 
# File 'lib/rbs/cli.rb', line 1332

def run_subtract(args, _)
  write_to_file = false
  # @type var subtrahend_paths: Array[String]
  subtrahend_paths = []

  opts = OptionParser.new do |opts|
    opts.banner = <<~HELP
      Usage:
        rbs subtract [options...] minuend.rbs [minuend2.rbs, ...] subtrahend.rbs
        rbs subtract [options...] minuend.rbs [minuend2.rbs, ...] --subtrahend subtrahend_1.rbs --subtrahend subtrahend_2.rbs

      Remove duplications between RBS files.

      Examples:

        # Generate RBS files from the codebase.
        $ rbs prototype rb lib/ > generated.rbs

        # Write more descrictive types by hand.
        $ $EDITOR handwritten.rbs

        # Remove hand-written method definitions from generated.rbs.
        $ rbs subtract --write generated.rbs handwritten.rbs

      Options:
    HELP
    opts.on('-w', '--write', 'Overwrite files directry') { write_to_file = true }
    opts.on('--subtrahend=PATH', '') { |path| subtrahend_paths << path }
    opts.parse!(args)
  end

  if subtrahend_paths.empty?
    *minuend_paths, subtrahend_path = args
    unless subtrahend_path
      stdout.puts opts.help
      exit 1
    end
    subtrahend_paths << subtrahend_path
  else
    minuend_paths = args
  end

  if minuend_paths.empty?
    stdout.puts opts.help
    exit 1
  end

  subtrahend = Environment.new.tap do |env|
    loader = EnvironmentLoader.new(core_root: nil)
    subtrahend_paths.each do |path|
      loader.add(path: Pathname(path))
    end
    loader.load(env: env)
  end

  minuend_paths.each do |minuend_path|
    FileFinder.each_file(Pathname(minuend_path), immediate: true, skip_hidden: true) do |rbs_path|
      buf = Buffer.new(name: rbs_path, content: rbs_path.read)
      _, dirs, decls = Parser.parse_signature(buf)
      subtracted = Subtractor.new(decls, subtrahend).call

      io = StringIO.new
      w = Writer.new(out: io)
      w.write(dirs)
      w.write(subtracted)

      if write_to_file
        if io.string.empty?
          rbs_path.delete
        else
          rbs_path.write(io.string)
        end
      else
        stdout.puts(io.string)
      end
    end
  end
end

#run_test(args, options) ⇒ Object 



1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
 
# File 'lib/rbs/cli.rb', line 1184

def run_test(args, options)
  # @type var unchecked_classes: Array[String]
  unchecked_classes = []
  # @type var targets: Array[String]
  targets = []
  # @type var sample_size: String?
  sample_size = nil
  # @type var double_suite: String?
  double_suite = nil

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

Examples:

  $ rbs test rake test
  $ rbs --log-level=debug test --target SomeModule::* rspec
  $ rbs test --target SomeModule::* --target AnotherModule::* --target SomeClass rake test

Options:
EOB
    opts.on("--target TARGET", "Sets the runtime test target") do |target|
      targets << target
    end

    opts.on("--sample-size SAMPLE_SIZE", "Sets the sample size") do |size|
      sample_size = size
    end

    opts.on("--unchecked-class UNCHECKED_CLASS", "Sets the class that would not be checked") do |unchecked_class|
      unchecked_classes << unchecked_class
    end

    opts.on("--double-suite DOUBLE_SUITE", "Sets the double suite in use (currently supported: rspec | minitest)") do |suite|
      double_suite = suite
    end
  end).order!(args)

  if args.length.zero?
    stdout.puts opts.help
    exit 1
  end

  # @type var env_hash: Hash[String, String?]
  env_hash = {
    'RUBYOPT' => "#{ENV['RUBYOPT']} -rrbs/test/setup",
    'RBS_TEST_OPT' => test_opt(options),
    'RBS_TEST_LOGLEVEL' => %w(DEBUG INFO WARN ERROR FATAL)[RBS.logger_level || 5] || "UNKNOWN",
    'RBS_TEST_SAMPLE_SIZE' => sample_size,
    'RBS_TEST_DOUBLE_SUITE' => double_suite,
    'RBS_TEST_UNCHECKED_CLASSES' => (unchecked_classes.join(',') unless unchecked_classes.empty?),
    'RBS_TEST_TARGET' => (targets.join(',') unless targets.empty?)
  }

  # @type var out: String
  # @type var err: String
  out, err, status = __skip__ = Open3.capture3(env_hash, *args)
  stdout.print(out)
  stderr.print(err)

  status
end

#run_validate(args, options) ⇒ Object 



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
479
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
527
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
607
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
 
# File 'lib/rbs/cli.rb', line 446

def run_validate(args, options)
  stdout = stdout()
  exit_error = false

  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

    opts.on("--silent") do
      stdout = StringIO.new
    end
    opts.on("--[no-]exit-error-on-syntax-error", "exit(1) if syntax error is detected") {|bool|
      exit_error = bool
    }
  end.parse!(args)

  loader = options.loader()
  env = Environment.from_loader(loader).resolve_type_names

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

  syntax_errors = [] #: Array[String]

  no_self_type_validator = ->(type) {
    # @type var type: Types::t | MethodType
    if type.has_self_type?
      syntax_errors << "#{type.location}: `self` type is not allowed in this context"
    end
  }

  no_classish_type_validator = ->(type) {
    # @type var type: Types::t | MethodType
    if type.has_classish_type?
      syntax_errors << "#{type.location}: `instance` or `class` type is not allowed in this context"
    end
  }

  void_type_context_validator = ->(type, allowed_here = false) {
    # @type var type: Types::t | MethodType
    if allowed_here
      next if type.is_a?(Types::Bases::Void)
    end
    if type.with_nonreturn_void?
      syntax_errors << "#{type.location}: `void` type is only allowed in return type or generics parameter"
    end
  }

  env.class_decls.each do |name, decl|
    stdout.puts "Validating class/module definition: `#{name}`..."
    builder.build_instance(name).each_type do |type|
      validator.validate_type type, context: nil
    end
    builder.build_singleton(name).each_type do |type|
      validator.validate_type type, context: nil
    end

    case decl
    when Environment::ClassEntry
      decl.decls.each do |decl|
        if super_class = decl.decl.super_class
          super_class.args.each do |arg|
            void_type_context_validator[arg, true]
            no_self_type_validator[arg]
            no_classish_type_validator[arg]
          end
        end
      end
    when Environment::ModuleEntry
      decl.decls.each do |decl|
        decl.decl.self_types.each do |self_type|
          self_type.args.each do |arg|
            void_type_context_validator[arg, true]
            no_self_type_validator[arg]
            no_classish_type_validator[arg]
          end
        end
      end
    end

    d = decl.primary.decl

    validator.validate_type_params(
      d.type_params,
      type_name: name,
      location: d.location&.aref(:type_params)
    )

    d.type_params.each do |param|
      if ub = param.upper_bound
        void_type_context_validator[ub]
        no_self_type_validator[ub]
        no_classish_type_validator[ub]
      end
    end

    decl.decls.each do |d|
      d.decl.each_member do |member|
        case member
        when AST::Members::MethodDefinition
          validator.validate_method_definition(member, type_name: name)
          member.overloads.each do |ov|
            void_type_context_validator[ov.method_type]
          end
        when AST::Members::Attribute
          void_type_context_validator[member.type]
        when AST::Members::Mixin
          member.args.each do |arg|
            no_self_type_validator[arg]
            unless arg.is_a?(Types::Bases::Void)
              void_type_context_validator[arg, true]
            end
          end
        when AST::Members::Var
          void_type_context_validator[member.type]
          if member.is_a?(AST::Members::ClassVariable)
            no_self_type_validator[member.type]
          end
        end
      end
    end
  end

  env.class_alias_decls.each do |name, entry|
    stdout.puts "Validating class/module alias definition: `#{name}`..."
    validator.validate_class_alias(entry: entry)
  end

  env.interface_decls.each do |name, decl|
    stdout.puts "Validating interface: `#{name}`..."
    builder.build_interface(name).each_type do |type|
      validator.validate_type type, context: nil
    end

    validator.validate_type_params(
      decl.decl.type_params,
      type_name: name,
      location: decl.decl.location&.aref(:type_params)
    )

    decl.decl.members.each do |member|
      case member
      when AST::Members::MethodDefinition
        validator.validate_method_definition(member, type_name: name)
        member.overloads.each do |ov|
          void_type_context_validator[ov.method_type]
          no_classish_type_validator[ov.method_type]
        end
      end
    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)
    no_self_type_validator[const.decl.type]
    no_classish_type_validator[const.decl.type]
    void_type_context_validator[const.decl.type]
  end

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

  env.type_alias_decls.each do |name, decl|
    stdout.puts "Validating alias: `#{name}`..."
    builder.expand_alias1(name).tap do |type|
      validator.validate_type type, context: nil
    end
    validator.validate_type_alias(entry: decl)
    no_self_type_validator[decl.decl.type]
    no_classish_type_validator[decl.decl.type]
    void_type_context_validator[decl.decl.type]
  end

  unless syntax_errors.empty?
    syntax_errors.sort!
    syntax_errors.uniq!
    syntax_errors.each do |message|
      self.stdout.puts message
    end
    exit 1 if exit_error
  end
end

#run_vendor(args, options) ⇒ Object 



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/rbs/cli.rb', line 1026

def run_vendor(args, options)
  clean = 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("--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}..."

  loader = options.loader()

  args.each do |gem|
    name, version = gem.split(/:/, 2)

    next unless name

    stdout.puts "  Loading library: #{name}, version=#{version}..."
    loader.add(library: name, version: version)
  end

  vendorer = Vendorer.new(vendor_dir: vendor_dir, loader: loader)

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

  stdout.puts "  Copying RBS files..."
  vendorer.copy!
end

#test_opt(options) ⇒ Object 



1174
1175
1176
1177
1178
1179
1180
1181
1182
 
# File 'lib/rbs/cli.rb', line 1174

def test_opt options
  opts = []

  opts.push(*options.repos.map {|dir| "--repo #{Shellwords.escape(dir)}"})
  opts.push(*options.dirs.map {|dir| "-I #{Shellwords.escape(dir)}"})
  opts.push(*options.libs.map {|lib| "-r#{Shellwords.escape(lib)}"})

  opts.empty? ? nil : opts.join(" ")
end