rbs 0.13.0 → 0.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (156) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ruby.yml +9 -5
  3. data/.gitignore +0 -1
  4. data/CHANGELOG.md +33 -1
  5. data/Gemfile +4 -0
  6. data/README.md +9 -3
  7. data/Rakefile +14 -1
  8. data/Steepfile +1 -1
  9. data/bin/annotate-with-rdoc +1 -1
  10. data/bin/setup +0 -2
  11. data/bin/test_runner.rb +15 -1
  12. data/{stdlib/builtin → core}/array.rbs +124 -120
  13. data/{stdlib/builtin → core}/basic_object.rbs +54 -54
  14. data/{stdlib/builtin → core}/binding.rbs +42 -42
  15. data/core/builtin.rbs +70 -0
  16. data/{stdlib/builtin → core}/class.rbs +33 -33
  17. data/{stdlib/builtin → core}/comparable.rbs +0 -0
  18. data/{stdlib/builtin → core}/complex.rbs +90 -90
  19. data/{stdlib/builtin → core}/constants.rbs +0 -0
  20. data/{stdlib/builtin → core}/data.rbs +0 -0
  21. data/{stdlib/builtin → core}/deprecated.rbs +0 -0
  22. data/{stdlib/builtin → core}/dir.rbs +1 -1
  23. data/{stdlib/builtin → core}/encoding.rbs +33 -33
  24. data/{stdlib/builtin → core}/enumerable.rbs +99 -92
  25. data/{stdlib/builtin → core}/enumerator.rbs +40 -40
  26. data/{stdlib/builtin → core}/errno.rbs +0 -0
  27. data/{stdlib/builtin → core}/errors.rbs +2 -2
  28. data/{stdlib/builtin → core}/exception.rbs +50 -50
  29. data/{stdlib/builtin → core}/false_class.rbs +6 -6
  30. data/{stdlib/builtin → core}/fiber.rbs +14 -14
  31. data/{stdlib/builtin → core}/fiber_error.rbs +1 -1
  32. data/{stdlib/builtin → core}/file.rbs +0 -0
  33. data/{stdlib/builtin → core}/file_test.rbs +0 -0
  34. data/{stdlib/builtin → core}/float.rbs +161 -161
  35. data/{stdlib/builtin → core}/gc.rbs +3 -3
  36. data/{stdlib/builtin → core}/hash.rbs +15 -15
  37. data/{stdlib/builtin → core}/integer.rbs +0 -0
  38. data/{stdlib/builtin → core}/io.rbs +89 -89
  39. data/{stdlib/builtin → core}/kernel.rbs +70 -154
  40. data/{stdlib/builtin → core}/marshal.rbs +0 -0
  41. data/{stdlib/builtin → core}/match_data.rbs +1 -1
  42. data/{stdlib/builtin → core}/math.rbs +0 -0
  43. data/{stdlib/builtin → core}/method.rbs +19 -19
  44. data/{stdlib/builtin → core}/module.rbs +13 -13
  45. data/{stdlib/builtin → core}/nil_class.rbs +20 -20
  46. data/{stdlib/builtin → core}/numeric.rbs +101 -101
  47. data/{stdlib/builtin → core}/object.rbs +173 -173
  48. data/{stdlib/builtin → core}/proc.rbs +91 -91
  49. data/{stdlib/builtin → core}/process.rbs +0 -0
  50. data/{stdlib/builtin → core}/random.rbs +1 -1
  51. data/{stdlib/builtin → core}/range.rbs +4 -6
  52. data/{stdlib/builtin → core}/rational.rbs +83 -83
  53. data/{stdlib/builtin → core}/rb_config.rbs +0 -0
  54. data/{stdlib/builtin → core}/regexp.rbs +0 -0
  55. data/{stdlib/builtin → core}/ruby_vm.rbs +0 -0
  56. data/{stdlib/builtin → core}/signal.rbs +7 -7
  57. data/{stdlib/builtin → core}/string.rbs +10 -10
  58. data/{stdlib/builtin → core}/string_io.rbs +8 -8
  59. data/{stdlib/builtin → core}/struct.rbs +2 -2
  60. data/{stdlib/builtin → core}/symbol.rbs +1 -1
  61. data/{stdlib/builtin → core}/thread.rbs +189 -189
  62. data/{stdlib/builtin → core}/thread_group.rbs +2 -2
  63. data/{stdlib/builtin → core}/time.rbs +0 -0
  64. data/{stdlib/builtin → core}/trace_point.rbs +0 -0
  65. data/{stdlib/builtin → core}/true_class.rbs +10 -10
  66. data/{stdlib/builtin → core}/unbound_method.rbs +0 -0
  67. data/{stdlib/builtin → core}/warning.rbs +1 -1
  68. data/docs/CONTRIBUTING.md +1 -0
  69. data/docs/repo.md +125 -0
  70. data/docs/syntax.md +50 -6
  71. data/goodcheck.yml +22 -5
  72. data/lib/rbs.rb +1 -0
  73. data/lib/rbs/ast/comment.rb +1 -1
  74. data/lib/rbs/cli.rb +105 -103
  75. data/lib/rbs/definition.rb +9 -4
  76. data/lib/rbs/definition_builder.rb +54 -22
  77. data/lib/rbs/environment.rb +1 -1
  78. data/lib/rbs/environment_loader.rb +79 -105
  79. data/lib/rbs/namespace.rb +1 -1
  80. data/lib/rbs/parser.rb +3153 -0
  81. data/lib/rbs/parser.y +25 -11
  82. data/lib/rbs/prototype/rb.rb +47 -9
  83. data/lib/rbs/prototype/runtime.rb +17 -7
  84. data/lib/rbs/repository.rb +121 -0
  85. data/lib/rbs/test/hook.rb +2 -0
  86. data/lib/rbs/test/setup.rb +5 -3
  87. data/lib/rbs/test/setup_helper.rb +4 -4
  88. data/lib/rbs/test/tester.rb +4 -1
  89. data/lib/rbs/test/type_check.rb +12 -6
  90. data/lib/rbs/type_name.rb +3 -2
  91. data/lib/rbs/variance_calculator.rb +1 -1
  92. data/lib/rbs/vendorer.rb +38 -16
  93. data/lib/rbs/version.rb +1 -1
  94. data/lib/rbs/writer.rb +1 -1
  95. data/sig/cli.rbs +58 -0
  96. data/sig/constant.rbs +2 -2
  97. data/sig/constant_table.rbs +11 -11
  98. data/sig/declarations.rbs +2 -2
  99. data/sig/definition.rbs +10 -5
  100. data/sig/definition_builder.rbs +4 -1
  101. data/sig/environment_loader.rbs +92 -46
  102. data/sig/members.rbs +2 -2
  103. data/sig/method_types.rbs +1 -1
  104. data/sig/namespace.rbs +4 -4
  105. data/sig/parser.rbs +25 -0
  106. data/sig/polyfill.rbs +42 -0
  107. data/sig/rbs.rbs +8 -0
  108. data/sig/repository.rbs +79 -0
  109. data/sig/substitution.rbs +3 -3
  110. data/sig/typename.rbs +1 -1
  111. data/sig/types.rbs +1 -1
  112. data/sig/vendorer.rbs +44 -0
  113. data/sig/writer.rbs +15 -15
  114. data/stdlib/abbrev/{abbrev.rbs → 0/abbrev.rbs} +0 -0
  115. data/stdlib/base64/{base64.rbs → 0/base64.rbs} +1 -1
  116. data/stdlib/benchmark/{benchmark.rbs → 0/benchmark.rbs} +2 -2
  117. data/stdlib/{bigdecimal/math → bigdecimal-math/0}/big_math.rbs +0 -0
  118. data/stdlib/bigdecimal/{big_decimal.rbs → 0/big_decimal.rbs} +0 -0
  119. data/stdlib/coverage/{coverage.rbs → 0/coverage.rbs} +2 -2
  120. data/stdlib/csv/{csv.rbs → 0/csv.rbs} +4 -4
  121. data/stdlib/date/{date.rbs → 0/date.rbs} +4 -4
  122. data/stdlib/date/{date_time.rbs → 0/date_time.rbs} +1 -1
  123. data/stdlib/dbm/0/dbm.rbs +277 -0
  124. data/stdlib/erb/{erb.rbs → 0/erb.rbs} +0 -0
  125. data/stdlib/fiber/{fiber.rbs → 0/fiber.rbs} +0 -0
  126. data/stdlib/find/{find.rbs → 0/find.rbs} +12 -12
  127. data/stdlib/forwardable/{forwardable.rbs → 0/forwardable.rbs} +0 -0
  128. data/stdlib/ipaddr/{ipaddr.rbs → 0/ipaddr.rbs} +0 -0
  129. data/stdlib/json/{json.rbs → 0/json.rbs} +0 -0
  130. data/stdlib/logger/{formatter.rbs → 0/formatter.rbs} +0 -0
  131. data/stdlib/logger/{log_device.rbs → 0/log_device.rbs} +1 -1
  132. data/stdlib/logger/{logger.rbs → 0/logger.rbs} +1 -1
  133. data/stdlib/logger/{period.rbs → 0/period.rbs} +0 -0
  134. data/stdlib/logger/{severity.rbs → 0/severity.rbs} +0 -0
  135. data/stdlib/mutex_m/{mutex_m.rbs → 0/mutex_m.rbs} +0 -0
  136. data/stdlib/pathname/{pathname.rbs → 0/pathname.rbs} +40 -40
  137. data/stdlib/prime/{integer-extension.rbs → 0/integer-extension.rbs} +0 -0
  138. data/stdlib/prime/{prime.rbs → 0/prime.rbs} +1 -1
  139. data/stdlib/pstore/0/pstore.rbs +287 -0
  140. data/stdlib/pty/{pty.rbs → 0/pty.rbs} +1 -1
  141. data/stdlib/securerandom/{securerandom.rbs → 0/securerandom.rbs} +0 -0
  142. data/stdlib/set/{set.rbs → 0/set.rbs} +10 -10
  143. data/stdlib/tmpdir/{tmpdir.rbs → 0/tmpdir.rbs} +12 -12
  144. data/stdlib/tsort/0/cyclic.rbs +4 -0
  145. data/stdlib/tsort/0/interfaces.rbs +19 -0
  146. data/stdlib/tsort/0/tsort.rbs +363 -0
  147. data/stdlib/uri/{file.rbs → 0/file.rbs} +0 -0
  148. data/stdlib/uri/{generic.rbs → 0/generic.rbs} +1 -1
  149. data/stdlib/uri/{http.rbs → 0/http.rbs} +0 -0
  150. data/stdlib/uri/{https.rbs → 0/https.rbs} +0 -0
  151. data/stdlib/uri/{ldap.rbs → 0/ldap.rbs} +0 -0
  152. data/stdlib/uri/{ldaps.rbs → 0/ldaps.rbs} +0 -0
  153. data/stdlib/zlib/{zlib.rbs → 0/zlib.rbs} +0 -0
  154. data/steep/Gemfile.lock +9 -9
  155. metadata +104 -93
  156. data/stdlib/builtin/builtin.rbs +0 -42
@@ -56,7 +56,10 @@ module RBS
56
56
  RBS.logger.info { "Skipping ##{name} because of `#{reason}`..." }
57
57
  end
58
58
  else
59
- if klass.instance_methods(false).include?(name) && !set.include?(name)
59
+ if !set.include?(name) && (
60
+ name == :initialize ||
61
+ klass.instance_methods(false).include?(name) ||
62
+ klass.private_instance_methods(false).include?(name))
60
63
  RBS.logger.info { "Setting up method hook in ##{name}..." }
61
64
  Hook.hook_instance_method klass, name, key: instance_key
62
65
  set << name
@@ -202,24 +202,30 @@ module RBS
202
202
  end
203
203
 
204
204
  def get_class(type_name)
205
- const_cache[type_name] ||= Object.const_get(type_name.to_s)
205
+ const_cache[type_name] ||= begin
206
+ Object.const_get(type_name.to_s)
207
+ rescue NameError
208
+ nil
209
+ end
206
210
  end
207
211
 
208
212
  def is_double?(value)
209
213
  unchecked_classes.any? { |unchecked_class| Test.call(value, IS_AP, Object.const_get(unchecked_class))}
214
+ rescue NameError
215
+ false
210
216
  end
211
217
 
212
218
  def value(val, type)
213
219
  if is_double?(val)
214
220
  RBS.logger.info("A double (#{val.inspect}) is detected!")
215
- return true
221
+ return true
216
222
  end
217
223
 
218
224
  case type
219
225
  when Types::Bases::Any
220
226
  true
221
227
  when Types::Bases::Bool
222
- true
228
+ val.is_a?(TrueClass) || val.is_a?(FalseClass)
223
229
  when Types::Bases::Top
224
230
  true
225
231
  when Types::Bases::Bottom
@@ -235,7 +241,7 @@ module RBS
235
241
  when Types::Bases::Instance
236
242
  Test.call(val, IS_AP, self_class)
237
243
  when Types::ClassInstance
238
- klass = get_class(type.name)
244
+ klass = get_class(type.name) or return false
239
245
  case
240
246
  when klass == ::Array
241
247
  Test.call(val, IS_AP, klass) && each_sample(val).all? {|v| value(v, type.args[0]) }
@@ -281,7 +287,7 @@ module RBS
281
287
  Test.call(val, IS_AP, klass)
282
288
  end
283
289
  when Types::ClassSingleton
284
- klass = get_class(type.name)
290
+ klass = get_class(type.name) or return false
285
291
  val == klass
286
292
  when Types::Interface
287
293
  methods = Set.new(Test.call(val, METHODS))
@@ -306,7 +312,7 @@ module RBS
306
312
  Test.call(val, IS_AP, ::Array) &&
307
313
  type.types.map.with_index {|ty, index| value(val[index], ty) }.all?
308
314
  when Types::Record
309
- Test::call(val, IS_AP, ::Hash) &&
315
+ Test::call(val, IS_AP, ::Hash) &&
310
316
  type.fields.map {|key, type| value(val[key], type) }.all?
311
317
  when Types::Proc
312
318
  Test::call(val, IS_AP, ::Proc)
@@ -16,14 +16,15 @@ module RBS
16
16
  when "_"
17
17
  :interface
18
18
  else
19
- raise
19
+ # Defaults to :class
20
+ :class
20
21
  end
21
22
  end
22
23
 
23
24
  def ==(other)
24
25
  other.is_a?(self.class) && other.namespace == namespace && other.name == name
25
26
  end
26
-
27
+
27
28
  alias eql? ==
28
29
 
29
30
  def hash
@@ -135,7 +135,7 @@ module RBS
135
135
  when :contravariant
136
136
  :covariant
137
137
  else
138
- raise
138
+ raise
139
139
  end
140
140
  type(ty, result: result, context: con)
141
141
  end
@@ -1,9 +1,11 @@
1
1
  module RBS
2
2
  class Vendorer
3
3
  attr_reader :vendor_dir
4
+ attr_reader :loader
4
5
 
5
- def initialize(vendor_dir:)
6
+ def initialize(vendor_dir:, loader:)
6
7
  @vendor_dir = vendor_dir
8
+ @loader = loader
7
9
  end
8
10
 
9
11
  def ensure_dir
@@ -21,27 +23,47 @@ module RBS
21
23
  end
22
24
  end
23
25
 
24
- def stdlib!()
25
- ensure_dir do
26
- RBS.logger.info "Vendoring stdlib: #{EnvironmentLoader::STDLIB_ROOT} => #{vendor_dir + "stdlib"}..."
27
- FileUtils.copy_entry EnvironmentLoader::STDLIB_ROOT, vendor_dir + "stdlib"
26
+ def copy!
27
+ # @type var paths: Set[[Pathname, Pathname]]
28
+ paths = Set[]
29
+
30
+ if core_root = loader.core_root
31
+ RBS.logger.info "Vendoring core RBSs in #{vendor_dir + "core"}..."
32
+ loader.each_file(core_root, immediate: false, skip_hidden: true) do |file_path|
33
+ paths << [file_path, Pathname("core") + file_path.relative_path_from(core_root)]
34
+ end
28
35
  end
29
- end
30
36
 
31
- def gem!(name, version)
32
- ensure_dir do
33
- sig_path = EnvironmentLoader.gem_sig_path(name, version)
34
- RBS.logger.debug "Checking gem signature path: name=#{name}, version=#{version}, path=#{sig_path}"
37
+ loader.libs.each do |lib|
38
+ case
39
+ when (spec, path = EnvironmentLoader.gem_sig_path(lib.name, lib.version))
40
+ dest_dir = Pathname("#{lib.name}-#{spec.version}")
41
+
42
+ RBS.logger.info "Vendoring #{lib.name}(#{spec.version}) RBSs in #{vendor_dir + dest_dir}..."
35
43
 
36
- if sig_path&.directory?
37
- gems_dir = vendor_dir + "gems"
38
- gems_dir.mkpath unless gems_dir.directory?
44
+ loader.each_file(path, skip_hidden: true, immediate: false) do |file_path|
45
+ paths << [file_path, dest_dir + file_path.relative_path_from(path)]
46
+ end
39
47
 
40
- gem_dir = gems_dir + name
41
- RBS.logger.info "Vendoring gem(#{name}:#{version}): #{sig_path} => #{gem_dir}..."
42
- FileUtils.copy_entry sig_path, gem_dir
48
+ when (rbs, path = loader.repository.lookup_path(lib.name, lib.version))
49
+ dest_dir = Pathname("#{rbs.name}-#{path.version}")
50
+
51
+ RBS.logger.info "Vendoring #{lib.name}(#{path.version}) RBSs in #{vendor_dir + dest_dir}..."
52
+
53
+ loader.each_file(path.path, skip_hidden: true, immediate: false) do |file_path|
54
+ paths << [file_path, dest_dir + file_path.relative_path_from(path.path)]
55
+ end
56
+ else
57
+ RBS.logger.error "Couldn't find RBSs for #{lib.name} (#{lib.version}); skipping..."
43
58
  end
44
59
  end
60
+
61
+ paths.each do |from, to|
62
+ dest = vendor_dir + to
63
+ dest.parent.mkpath unless dest.parent.directory?
64
+
65
+ FileUtils.copy_file(from.to_s, dest.to_s)
66
+ end
45
67
  end
46
68
  end
47
69
  end
@@ -1,3 +1,3 @@
1
1
  module RBS
2
- VERSION = "0.13.0"
2
+ VERSION = "0.17.0"
3
3
  end
@@ -305,7 +305,7 @@ module RBS
305
305
  if prev_loc && decl_loc
306
306
  prev_end_line = prev_loc.end_line
307
307
  start_line = decl_loc.start_line
308
-
308
+
309
309
  if start_line - prev_end_line > 1
310
310
  puts
311
311
  end
@@ -0,0 +1,58 @@
1
+ module RBS
2
+ class CLI
3
+ class LibraryOptions
4
+ attr_accessor core_root: Pathname?
5
+
6
+ attr_reader libs: Array[String]
7
+ attr_reader dirs: Array[String]
8
+ attr_reader repos: Array[String]
9
+
10
+ def initialize: () -> void
11
+
12
+ def loader: () -> EnvironmentLoader
13
+ end
14
+
15
+ attr_reader stdout: IO
16
+ attr_reader stderr: IO
17
+
18
+ def initialize: (stdout: IO, stderr: IO) -> void
19
+
20
+ COMMANDS: Array[Symbol]
21
+
22
+ def library_parse: (OptionParser, options: LibraryOptions) -> void
23
+
24
+ def parse_logging_options: (OptionParser) -> void
25
+
26
+ def has_parser?: () -> bool
27
+
28
+ def run: (Array[String] args) -> void
29
+
30
+ def run_ast: (Array[String], LibraryOptions) -> void
31
+
32
+ def run_list: (Array[String], LibraryOptions) -> void
33
+
34
+ def run_ancestors: (Array[String], LibraryOptions) -> void
35
+
36
+ def run_methods: (Array[String], LibraryOptions) -> void
37
+
38
+ def run_method: (Array[String], LibraryOptions) -> void
39
+
40
+ def run_validate: (Array[String], LibraryOptions) -> void
41
+
42
+ def run_constant: (Array[String], LibraryOptions) -> void
43
+
44
+ def run_paths: (Array[String], LibraryOptions) -> void
45
+
46
+ def run_prototype: (Array[String], LibraryOptions) -> void
47
+
48
+ def run_prototype_file: (String format, Array[String]) -> void
49
+
50
+ def run_vendor: (Array[String], LibraryOptions) -> void
51
+
52
+ def run_parse: (Array[String], LibraryOptions) -> void
53
+
54
+ def run_test: (Array[String], LibraryOptions) -> void
55
+
56
+ def test_opt: (LibraryOptions) -> String?
57
+ end
58
+ end
@@ -11,9 +11,9 @@ module RBS
11
11
  attr_reader entry: constant_entry
12
12
 
13
13
  def initialize: (name: TypeName, type: Types::t, entry: constant_entry) -> void
14
-
14
+
15
15
  def ==: (untyped other) -> bool
16
-
16
+
17
17
  alias eql? ==
18
18
 
19
19
  def hash: () -> Integer
@@ -6,25 +6,25 @@ module RBS
6
6
  attr_reader env(): Environment
7
7
 
8
8
  def initialize: (builder: DefinitionBuilder) -> void
9
-
9
+
10
10
  def absolute_type: (Types::t, context: Array[Namespace]) -> Types::t
11
-
11
+
12
12
  def absolute_type_name: (TypeName, context: Array[Namespace], location: Location?) -> TypeName
13
-
13
+
14
14
  def name_to_constant: (TypeName) -> Constant?
15
-
15
+
16
16
  def split_name: (TypeName) -> Array[Symbol]
17
-
17
+
18
18
  def resolve_constant_reference: (TypeName name, context: Array[Namespace]) -> Constant?
19
-
19
+
20
20
  def resolve_constant_reference_context: (Symbol, context: Array[Namespace]) -> Constant?
21
-
22
- def resolve_constant_reference_inherit: (Symbol, scopes: Array[Namespace], ?no_object: bool) -> Constant?
23
-
21
+
22
+ def resolve_constant_reference_inherit: (Symbol, scopes: Array[Namespace], ?no_object: boolish) -> Constant?
23
+
24
24
  def constant_scopes: (TypeName) -> Array[Namespace]
25
-
25
+
26
26
  def constant_scopes_module: (TypeName, scopes: Array[Namespace]) -> Array[Namespace]
27
-
27
+
28
28
  def constant_scopes0: (TypeName, ?scopes: Array[Namespace]) -> Array[Namespace]
29
29
  end
30
30
  end
@@ -2,7 +2,7 @@ module RBS
2
2
  module AST
3
3
  module Declarations
4
4
  type t = Class | Module | Interface | Constant | Global | Alias
5
-
5
+
6
6
  class Base
7
7
  end
8
8
 
@@ -14,7 +14,7 @@ module RBS
14
14
  attr_reader variance: variance
15
15
  attr_reader skip_validation: bool
16
16
 
17
- def initialize: (name: Symbol, variance: variance, skip_validation: bool) -> void
17
+ def initialize: (name: Symbol, variance: variance, skip_validation: boolish) -> void
18
18
 
19
19
  include _ToJson
20
20
  end
@@ -18,17 +18,17 @@ module RBS
18
18
  class TypeDef
19
19
  attr_reader type: MethodType
20
20
  attr_reader member: method_member
21
- attr_reader defined_in: TypeName?
21
+ attr_reader defined_in: TypeName
22
22
  attr_reader implemented_in: TypeName?
23
23
 
24
- def initialize: (type: MethodType, member: method_member, defined_in: TypeName?, implemented_in: TypeName?) -> void
24
+ def initialize: (type: MethodType, member: method_member, defined_in: TypeName, implemented_in: TypeName?) -> void
25
25
 
26
26
  def comment: () -> AST::Comment?
27
27
 
28
28
  def annotations: () -> Array[AST::Annotation]
29
29
 
30
- def update: (?type: MethodType, ?member: method_member, ?defined_in: TypeName?, ?implemented_in: TypeName?) -> TypeDef
31
-
30
+ def update: (?type: MethodType, ?member: method_member, ?defined_in: TypeName, ?implemented_in: TypeName?) -> TypeDef
31
+
32
32
  def overload?: () -> bool
33
33
  end
34
34
 
@@ -42,8 +42,13 @@ module RBS
42
42
  attr_reader comments: Array[AST::Comment]
43
43
  attr_reader annotations: Array[AST::Annotation]
44
44
  attr_reader members: Array[method_member]
45
+ attr_reader alias_of: Method?
45
46
 
46
- def initialize: (super_method: Method?, defs: Array[TypeDef], accessibility: accessibility, ?annotations: Array[AST::Annotation]) -> void
47
+ def initialize: (super_method: Method?,
48
+ defs: Array[TypeDef],
49
+ accessibility: accessibility,
50
+ alias_of: Method?,
51
+ ?annotations: Array[AST::Annotation]) -> void
47
52
 
48
53
  def public?: () -> bool
49
54
 
@@ -61,6 +61,8 @@ module RBS
61
61
 
62
62
  def ensure_namespace!: (Namespace, location: Location?) -> void
63
63
 
64
+ def build_singleton: (TypeName) -> Definition
65
+
64
66
  def build_instance: (TypeName) -> Definition
65
67
 
66
68
  def build_interface: (TypeName) -> Definition
@@ -69,11 +71,12 @@ module RBS
69
71
 
70
72
  def build_one_singleton: (TypeName) -> Definition
71
73
 
74
+ type ancestors = Definition::InstanceAncestors | Definition::SingletonAncestors | nil
72
75
  def merge_definitions: (TypeName,
73
76
  Array[[Definition::Ancestor::t, Definition]],
74
77
  entry: Environment::ModuleEntry | Environment::ClassEntry,
75
78
  self_type: Definition::self_type,
76
- ancestors: Array[Definition::Ancestor::t]) -> Definition
79
+ ancestors: ancestors) -> Definition
77
80
 
78
81
  type method_kind = :instance | :singleton
79
82
  def merge_method: (TypeName, Hash[Symbol, Definition::Method], Symbol, Definition::Method, Substitution, kind: method_kind) -> void
@@ -1,58 +1,104 @@
1
1
  module RBS
2
+ # EnvironmentLoader is an object to load RBS files from filesystem.
3
+ #
4
+ # Set up your configuration through repository and `#add` method.
5
+ #
6
+ # # Set up the repository to load library RBSs from.
7
+ # repo = RBS::Repository.default
8
+ # repo.add(Pathname("vendor/rbs/gem-rbs"))
9
+ # repo.add(Pathname("vendor/rbs/internal-rbs"))
10
+ #
11
+ # loader = RBS::EnvironmentLoader.new(repository: repo)
12
+ #
13
+ # # Add libraries to load RBS files.
14
+ # loader.add(library: "minitest")
15
+ # loader.add(library: "rbs", version: "1.0.0")
16
+ #
17
+ # # Add dirs to load RBS files from.
18
+ # loader.add(path: Pathname("sig"))
19
+ #
20
+ # # Load RBSs into an environment.
21
+ # environment = RBS::Environment.new()
22
+ # loader.load(env: environment)
23
+ #
2
24
  class EnvironmentLoader
3
- class UnknownLibraryNameError < StandardError
4
- attr_reader name: String
5
-
6
- def initialize: (name: String) -> void
7
- end
8
-
9
- class LibraryPath
10
- attr_reader name: String
11
- attr_reader path: Pathname
25
+ class UnknownLibraryError < StandardError
26
+ attr_reader library: Library
12
27
 
13
- def initialize: (name: String, path: Pathname) -> void
28
+ def initialize: (lib: Library) -> void
14
29
  end
15
30
 
16
- class GemPath
31
+ class Library < Struct[String | String?]
17
32
  attr_reader name: String
18
33
  attr_reader version: String?
19
- attr_reader path: Pathname
20
34
 
21
- def initialize: (name: String, version: String?, path: Pathname) -> void
35
+ def initialize: (name: String, version: String?) -> void
22
36
  end
23
37
 
24
- STDLIB_ROOT: Pathname
25
-
26
- type path = Pathname | LibraryPath | GemPath
27
-
28
- attr_reader paths: Array[path]
29
- attr_reader stdlib_root: Pathname
30
- attr_reader gem_vendor_path: Pathname?
31
-
32
- def self.gem_sig_path: (String, String?) -> Pathname?
33
-
34
- def initialize: (?stdlib_root: Pathname, ?gem_vendor_path: Pathname?) -> void
35
-
36
- def add: (path: Pathname?) -> void
37
- | (library: String?) -> void
38
-
39
- def self.parse_library: (String) -> [String, String?]
40
-
41
- def stdlib?: (String) -> Pathname?
42
-
43
- def gem?: (String, String?) -> Pathname?
44
-
45
- def each_signature: (Pathname, ?immediate: bool) { (Pathname) -> void } -> void
46
- | (Pathname, ?immediate: bool) -> Enumerator[Pathname, void]
47
-
48
- def each_library_path: { (path, Pathname) -> void } -> void
49
-
50
- def no_builtin!: (?bool) -> self
51
-
52
- def no_builtin?: () -> bool
53
-
54
- def each_decl: () { (AST::Declarations::t, Buffer, Pathname, path | :stdlib) -> void } -> void
55
-
56
- def load: (env: Environment) -> Array[[AST::Declarations::t, Pathname, path | :stdlib]]
38
+ DEFAULT_CORE_ROOT: Pathname
39
+
40
+ attr_reader core_root: Pathname?
41
+ attr_reader repository: Repository
42
+
43
+ attr_reader libs: Array[Library]
44
+ attr_reader dirs: Array[Pathname]
45
+
46
+ # The source where the RBS comes from.
47
+ #
48
+ # `:core` means it is part of core library.
49
+ # `Library` means it is from library.
50
+ # `Pathname` means it is loaded from a directory.
51
+ #
52
+ type source = :core
53
+ | Library
54
+ | Pathname
55
+
56
+ # Accepts two optional keyword arguments.
57
+ #
58
+ # `core_root` is the path to the directory with RBSs for core classes.
59
+ # The default value is the core library included in RBS gem. (EnvironmentLoader::DEFAULT_CORE_ROOT)
60
+ # Passing `nil` means it skips loading core class definitions.
61
+ #
62
+ # `repository` is the repository for library classes.
63
+ # The default value is repository only with stdlib classes. (Repository.new)
64
+ #
65
+ def initialize: (?core_root: Pathname?, ?repository: Repository) -> void
66
+
67
+ # Add a path or library to load RBSs from.
68
+ #
69
+ # `path` can be a file or a directory.
70
+ # All `.rbs` files from the given directory will be loaded.
71
+ # Specifying a file will load the file regardless the extension of the file is.
72
+ #
73
+ # `library` can be a name of a gem.
74
+ # Specifying `nil` to `version` will load any version available.
75
+ # It first tries to load RBS files from gem with specified version.
76
+ # If RBS files cannot be found in the gem, it tries to load RBSs from repository.
77
+ #
78
+ def add: (path: Pathname) -> void
79
+ | (library: String, version: String?) -> void
80
+
81
+ # This is helper function to test if RBS for a library is available or not.
82
+ #
83
+ def has_library?: (library: String, version: String?) -> bool
84
+
85
+ # Add all declarations to environment.
86
+ #
87
+ # Raises `UnknownLibraryError` if RBS cannot be loaded from a library.
88
+ #
89
+ # Returns an array of tuples of the declaration, path to the file, and the source.
90
+ #
91
+ def load: (env: Environment) -> Array[[AST::Declarations::t, Pathname, source]]
92
+
93
+ # Returns a pair of spec and path for a gem with RBS.
94
+ # Returns nil if the gem is not installed, or the gem doesn't provide RBS.
95
+ #
96
+ def self.gem_sig_path: (String name, String? version) -> [Gem::Specification, Pathname]?
97
+
98
+ def each_decl: () { (AST::Declarations::t, Buffer, source, Pathname) -> void } -> void
99
+
100
+ def each_dir: { (source, Pathname) -> void } -> void
101
+
102
+ def each_file: (Pathname path, immediate: boolish, skip_hidden: boolish) { (Pathname) -> void } -> void
57
103
  end
58
104
  end