solargraph 0.56.0 → 0.58.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (191) hide show
  1. checksums.yaml +4 -4
  2. data/.gitattributes +2 -0
  3. data/.github/workflows/linting.yml +127 -0
  4. data/.github/workflows/plugins.yml +183 -7
  5. data/.github/workflows/rspec.yml +55 -5
  6. data/.github/workflows/typecheck.yml +6 -3
  7. data/.gitignore +6 -0
  8. data/.overcommit.yml +72 -0
  9. data/.rspec +1 -0
  10. data/.rubocop.yml +66 -0
  11. data/.rubocop_todo.yml +1279 -0
  12. data/.yardopts +1 -0
  13. data/CHANGELOG.md +92 -1
  14. data/README.md +8 -4
  15. data/Rakefile +125 -13
  16. data/bin/solargraph +3 -0
  17. data/lib/solargraph/api_map/cache.rb +110 -109
  18. data/lib/solargraph/api_map/constants.rb +279 -0
  19. data/lib/solargraph/api_map/index.rb +193 -175
  20. data/lib/solargraph/api_map/source_to_yard.rb +97 -88
  21. data/lib/solargraph/api_map/store.rb +384 -266
  22. data/lib/solargraph/api_map.rb +945 -973
  23. data/lib/solargraph/bench.rb +1 -0
  24. data/lib/solargraph/complex_type/type_methods.rb +228 -222
  25. data/lib/solargraph/complex_type/unique_type.rb +482 -475
  26. data/lib/solargraph/complex_type.rb +444 -423
  27. data/lib/solargraph/convention/active_support_concern.rb +111 -0
  28. data/lib/solargraph/convention/base.rb +17 -0
  29. data/lib/solargraph/convention/data_definition/data_assignment_node.rb +61 -0
  30. data/lib/solargraph/convention/data_definition/data_definition_node.rb +91 -0
  31. data/lib/solargraph/convention/data_definition.rb +105 -0
  32. data/lib/solargraph/convention/gemspec.rb +3 -2
  33. data/lib/solargraph/convention/struct_definition/struct_assignment_node.rb +61 -60
  34. data/lib/solargraph/convention/struct_definition/struct_definition_node.rb +102 -100
  35. data/lib/solargraph/convention/struct_definition.rb +164 -101
  36. data/lib/solargraph/convention.rb +32 -2
  37. data/lib/solargraph/diagnostics/require_not_found.rb +53 -53
  38. data/lib/solargraph/diagnostics/rubocop.rb +118 -113
  39. data/lib/solargraph/diagnostics/rubocop_helpers.rb +68 -66
  40. data/lib/solargraph/diagnostics/type_check.rb +55 -55
  41. data/lib/solargraph/doc_map.rb +439 -405
  42. data/lib/solargraph/environ.rb +9 -2
  43. data/lib/solargraph/equality.rb +34 -33
  44. data/lib/solargraph/gem_pins.rb +98 -88
  45. data/lib/solargraph/language_server/host/diagnoser.rb +89 -89
  46. data/lib/solargraph/language_server/host/dispatch.rb +130 -128
  47. data/lib/solargraph/language_server/host/message_worker.rb +112 -109
  48. data/lib/solargraph/language_server/host/sources.rb +99 -99
  49. data/lib/solargraph/language_server/host.rb +878 -871
  50. data/lib/solargraph/language_server/message/base.rb +2 -1
  51. data/lib/solargraph/language_server/message/extended/check_gem_version.rb +114 -114
  52. data/lib/solargraph/language_server/message/extended/document.rb +23 -23
  53. data/lib/solargraph/language_server/message/text_document/completion.rb +56 -56
  54. data/lib/solargraph/language_server/message/text_document/definition.rb +40 -38
  55. data/lib/solargraph/language_server/message/text_document/document_symbol.rb +26 -26
  56. data/lib/solargraph/language_server/message/text_document/formatting.rb +148 -131
  57. data/lib/solargraph/language_server/message/text_document/hover.rb +58 -58
  58. data/lib/solargraph/language_server/message/text_document/signature_help.rb +24 -24
  59. data/lib/solargraph/language_server/message/text_document/type_definition.rb +25 -24
  60. data/lib/solargraph/language_server/message/workspace/did_change_workspace_folders.rb +2 -0
  61. data/lib/solargraph/language_server/message/workspace/workspace_symbol.rb +23 -23
  62. data/lib/solargraph/language_server/progress.rb +8 -0
  63. data/lib/solargraph/language_server/request.rb +4 -1
  64. data/lib/solargraph/library.rb +683 -666
  65. data/lib/solargraph/location.rb +82 -79
  66. data/lib/solargraph/logging.rb +37 -28
  67. data/lib/solargraph/page.rb +3 -0
  68. data/lib/solargraph/parser/comment_ripper.rb +69 -62
  69. data/lib/solargraph/parser/flow_sensitive_typing.rb +255 -227
  70. data/lib/solargraph/parser/node_processor/base.rb +92 -87
  71. data/lib/solargraph/parser/node_processor.rb +62 -46
  72. data/lib/solargraph/parser/parser_gem/class_methods.rb +149 -159
  73. data/lib/solargraph/parser/parser_gem/flawed_builder.rb +1 -0
  74. data/lib/solargraph/parser/parser_gem/node_chainer.rb +166 -164
  75. data/lib/solargraph/parser/parser_gem/node_methods.rb +486 -497
  76. data/lib/solargraph/parser/parser_gem/node_processors/and_node.rb +22 -21
  77. data/lib/solargraph/parser/parser_gem/node_processors/args_node.rb +59 -59
  78. data/lib/solargraph/parser/parser_gem/node_processors/begin_node.rb +15 -15
  79. data/lib/solargraph/parser/parser_gem/node_processors/block_node.rb +46 -45
  80. data/lib/solargraph/parser/parser_gem/node_processors/casgn_node.rb +1 -21
  81. data/lib/solargraph/parser/parser_gem/node_processors/def_node.rb +53 -53
  82. data/lib/solargraph/parser/parser_gem/node_processors/if_node.rb +23 -21
  83. data/lib/solargraph/parser/parser_gem/node_processors/ivasgn_node.rb +40 -40
  84. data/lib/solargraph/parser/parser_gem/node_processors/lvasgn_node.rb +29 -29
  85. data/lib/solargraph/parser/parser_gem/node_processors/masgn_node.rb +59 -53
  86. data/lib/solargraph/parser/parser_gem/node_processors/namespace_node.rb +0 -22
  87. data/lib/solargraph/parser/parser_gem/node_processors/opasgn_node.rb +98 -41
  88. data/lib/solargraph/parser/parser_gem/node_processors/orasgn_node.rb +17 -16
  89. data/lib/solargraph/parser/parser_gem/node_processors/resbody_node.rb +38 -37
  90. data/lib/solargraph/parser/parser_gem/node_processors/sclass_node.rb +52 -43
  91. data/lib/solargraph/parser/parser_gem/node_processors/send_node.rb +291 -271
  92. data/lib/solargraph/parser/parser_gem/node_processors/sym_node.rb +1 -0
  93. data/lib/solargraph/parser/parser_gem/node_processors/while_node.rb +29 -29
  94. data/lib/solargraph/parser/parser_gem/node_processors.rb +70 -66
  95. data/lib/solargraph/parser/region.rb +69 -66
  96. data/lib/solargraph/parser/snippet.rb +17 -15
  97. data/lib/solargraph/pin/base.rb +729 -651
  98. data/lib/solargraph/pin/base_variable.rb +126 -125
  99. data/lib/solargraph/pin/block.rb +104 -103
  100. data/lib/solargraph/pin/breakable.rb +9 -9
  101. data/lib/solargraph/pin/callable.rb +231 -218
  102. data/lib/solargraph/pin/closure.rb +72 -74
  103. data/lib/solargraph/pin/common.rb +79 -75
  104. data/lib/solargraph/pin/constant.rb +2 -0
  105. data/lib/solargraph/pin/conversions.rb +123 -123
  106. data/lib/solargraph/pin/delegated_method.rb +120 -120
  107. data/lib/solargraph/pin/documenting.rb +114 -114
  108. data/lib/solargraph/pin/instance_variable.rb +34 -34
  109. data/lib/solargraph/pin/keyword.rb +20 -20
  110. data/lib/solargraph/pin/local_variable.rb +75 -76
  111. data/lib/solargraph/pin/method.rb +672 -651
  112. data/lib/solargraph/pin/method_alias.rb +34 -31
  113. data/lib/solargraph/pin/namespace.rb +115 -115
  114. data/lib/solargraph/pin/parameter.rb +275 -261
  115. data/lib/solargraph/pin/proxy_type.rb +39 -35
  116. data/lib/solargraph/pin/reference/override.rb +47 -33
  117. data/lib/solargraph/pin/reference/superclass.rb +15 -10
  118. data/lib/solargraph/pin/reference.rb +39 -22
  119. data/lib/solargraph/pin/search.rb +61 -56
  120. data/lib/solargraph/pin/signature.rb +61 -59
  121. data/lib/solargraph/pin/symbol.rb +53 -48
  122. data/lib/solargraph/pin/until.rb +18 -18
  123. data/lib/solargraph/pin/while.rb +18 -18
  124. data/lib/solargraph/pin.rb +44 -44
  125. data/lib/solargraph/pin_cache.rb +245 -185
  126. data/lib/solargraph/position.rb +132 -116
  127. data/lib/solargraph/range.rb +112 -107
  128. data/lib/solargraph/rbs_map/conversions.rb +823 -773
  129. data/lib/solargraph/rbs_map/core_fills.rb +18 -0
  130. data/lib/solargraph/rbs_map/core_map.rb +58 -51
  131. data/lib/solargraph/rbs_map/stdlib_map.rb +43 -43
  132. data/lib/solargraph/rbs_map.rb +163 -150
  133. data/lib/solargraph/shell.rb +352 -268
  134. data/lib/solargraph/source/chain/call.rb +337 -333
  135. data/lib/solargraph/source/chain/constant.rb +26 -89
  136. data/lib/solargraph/source/chain/hash.rb +34 -34
  137. data/lib/solargraph/source/chain/if.rb +28 -28
  138. data/lib/solargraph/source/chain/instance_variable.rb +13 -13
  139. data/lib/solargraph/source/chain/link.rb +11 -2
  140. data/lib/solargraph/source/chain/literal.rb +48 -48
  141. data/lib/solargraph/source/chain/or.rb +23 -23
  142. data/lib/solargraph/source/chain.rb +291 -282
  143. data/lib/solargraph/source/change.rb +82 -82
  144. data/lib/solargraph/source/cursor.rb +166 -167
  145. data/lib/solargraph/source/encoding_fixes.rb +23 -23
  146. data/lib/solargraph/source/source_chainer.rb +194 -194
  147. data/lib/solargraph/source/updater.rb +55 -55
  148. data/lib/solargraph/source.rb +498 -495
  149. data/lib/solargraph/source_map/clip.rb +226 -234
  150. data/lib/solargraph/source_map/data.rb +34 -30
  151. data/lib/solargraph/source_map/mapper.rb +259 -259
  152. data/lib/solargraph/source_map.rb +212 -200
  153. data/lib/solargraph/type_checker/checks.rb +124 -124
  154. data/lib/solargraph/type_checker/param_def.rb +37 -35
  155. data/lib/solargraph/type_checker/problem.rb +32 -32
  156. data/lib/solargraph/type_checker/rules.rb +84 -62
  157. data/lib/solargraph/type_checker.rb +814 -699
  158. data/lib/solargraph/version.rb +5 -5
  159. data/lib/solargraph/workspace/config.rb +255 -239
  160. data/lib/solargraph/workspace/require_paths.rb +97 -0
  161. data/lib/solargraph/workspace.rb +220 -249
  162. data/lib/solargraph/yard_map/helpers.rb +44 -16
  163. data/lib/solargraph/yard_map/mapper/to_constant.rb +5 -5
  164. data/lib/solargraph/yard_map/mapper/to_method.rb +130 -134
  165. data/lib/solargraph/yard_map/mapper/to_namespace.rb +31 -30
  166. data/lib/solargraph/yard_map/mapper.rb +79 -79
  167. data/lib/solargraph/yard_map/to_method.rb +89 -88
  168. data/lib/solargraph/yardoc.rb +87 -49
  169. data/lib/solargraph.rb +105 -90
  170. data/rbs/fills/bundler/0/bundler.rbs +4271 -0
  171. data/rbs/fills/open3/0/open3.rbs +172 -0
  172. data/rbs/fills/rubygems/0/basic_specification.rbs +326 -0
  173. data/rbs/fills/rubygems/0/errors.rbs +364 -0
  174. data/rbs/fills/rubygems/0/spec_fetcher.rbs +107 -0
  175. data/rbs/fills/rubygems/0/specification.rbs +1753 -0
  176. data/rbs/fills/{tuple.rbs → tuple/tuple.rbs} +2 -3
  177. data/rbs/shims/ast/0/node.rbs +5 -0
  178. data/rbs/shims/ast/2.4/.rbs_meta.yaml +9 -0
  179. data/rbs/shims/ast/2.4/ast.rbs +73 -0
  180. data/rbs/shims/parser/3.2.0.1/builders/default.rbs +195 -0
  181. data/rbs/shims/parser/3.2.0.1/manifest.yaml +7 -0
  182. data/rbs/shims/parser/3.2.0.1/parser.rbs +201 -0
  183. data/rbs/shims/parser/3.2.0.1/polyfill.rbs +4 -0
  184. data/rbs/shims/thor/1.2.0.1/.rbs_meta.yaml +9 -0
  185. data/rbs/shims/thor/1.2.0.1/manifest.yaml +7 -0
  186. data/rbs/shims/thor/1.2.0.1/thor.rbs +17 -0
  187. data/rbs_collection.yaml +4 -4
  188. data/solargraph.gemspec +26 -5
  189. metadata +187 -15
  190. data/lib/.rubocop.yml +0 -22
  191. data/lib/solargraph/parser/node_methods.rb +0 -97
@@ -48,6 +48,24 @@ module Solargraph
48
48
  Solargraph::Pin::Reference::Include.new(name: '_ToAry',
49
49
  closure: Solargraph::Pin::Namespace.new(name: 'Array', source: :core_fill),
50
50
  generic_values: ['generic<Elem>'],
51
+ source: :core_fill),
52
+ Solargraph::Pin::Reference::Include.new(name: '_ToAry',
53
+ closure: Solargraph::Pin::Namespace.new(name: 'Set', source: :core_fill),
54
+ generic_values: ['generic<Elem>'],
55
+ source: :core_fill),
56
+ Solargraph::Pin::Reference::Include.new(name: '_Each',
57
+ closure: Solargraph::Pin::Namespace.new(name: 'Array', source: :core_fill),
58
+ generic_values: ['generic<Elem>'],
59
+ source: :core_fill),
60
+ Solargraph::Pin::Reference::Include.new(name: '_Each',
61
+ closure: Solargraph::Pin::Namespace.new(name: 'Set', source: :core_fill),
62
+ generic_values: ['generic<Elem>'],
63
+ source: :core_fill),
64
+ Solargraph::Pin::Reference::Include.new(name: '_ToS',
65
+ closure: Solargraph::Pin::Namespace.new(name: 'Object', source: :core_fill),
66
+ source: :core_fill),
67
+ Solargraph::Pin::Reference::Include.new(name: '_ToS',
68
+ closure: Solargraph::Pin::Namespace.new(name: 'String', source: :core_fill),
51
69
  source: :core_fill)
52
70
  ]
53
71
 
@@ -1,51 +1,58 @@
1
- # frozen_string_literal: true
2
-
3
- module Solargraph
4
- class RbsMap
5
- # Ruby core pins
6
- #
7
- class CoreMap
8
-
9
- def resolved?
10
- true
11
- end
12
-
13
- FILLS_DIRECTORY = File.join(File.dirname(__FILE__), '..', '..', '..', 'rbs', 'fills')
14
-
15
- def initialize; end
16
-
17
- def pins
18
- return @pins if @pins
19
-
20
- @pins = []
21
- cache = PinCache.deserialize_core
22
- if cache
23
- @pins.replace cache
24
- else
25
- loader.add(path: Pathname(FILLS_DIRECTORY))
26
- @pins = conversions.pins
27
- @pins.concat RbsMap::CoreFills::ALL
28
- processed = ApiMap::Store.new(pins).pins.reject { |p| p.is_a?(Solargraph::Pin::Reference::Override) }
29
- @pins.replace processed
30
-
31
- PinCache.serialize_core @pins
32
- end
33
- @pins
34
- end
35
-
36
- def loader
37
- @loader ||= RBS::EnvironmentLoader.new(repository: RBS::Repository.new(no_stdlib: false))
38
- end
39
-
40
- private
41
-
42
- def loader
43
- @loader ||= RBS::EnvironmentLoader.new(repository: RBS::Repository.new(no_stdlib: false))
44
- end
45
-
46
- def conversions
47
- @conversions ||= Conversions.new(loader: loader)
48
- end
49
- end
50
- end
51
- end
1
+ # frozen_string_literal: true
2
+
3
+ module Solargraph
4
+ class RbsMap
5
+ # Ruby core pins
6
+ #
7
+ class CoreMap
8
+ include Logging
9
+
10
+ def resolved?
11
+ true
12
+ end
13
+
14
+ FILLS_DIRECTORY = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'rbs', 'fills'))
15
+
16
+ def initialize; end
17
+
18
+ # @return [Enumerable<Pin::Base>]
19
+ def pins
20
+ return @pins if @pins
21
+
22
+ @pins = []
23
+ cache = PinCache.deserialize_core
24
+ if cache
25
+ @pins.replace cache
26
+ else
27
+ @pins.concat conversions.pins
28
+
29
+ # Avoid RBS::DuplicatedDeclarationError by loading in a different EnvironmentLoader
30
+ fill_loader = RBS::EnvironmentLoader.new(core_root: nil, repository: RBS::Repository.new(no_stdlib: false))
31
+ fill_loader.add(path: Pathname(FILLS_DIRECTORY))
32
+ fill_conversions = Conversions.new(loader: fill_loader)
33
+ @pins.concat fill_conversions.pins
34
+
35
+ @pins.concat RbsMap::CoreFills::ALL
36
+
37
+ processed = ApiMap::Store.new(pins).pins.reject { |p| p.is_a?(Solargraph::Pin::Reference::Override) }
38
+ @pins.replace processed
39
+
40
+ PinCache.serialize_core @pins
41
+ end
42
+ @pins
43
+ end
44
+
45
+ private
46
+
47
+ # @return [RBS::EnvironmentLoader]
48
+ def loader
49
+ @loader ||= RBS::EnvironmentLoader.new(repository: RBS::Repository.new(no_stdlib: false))
50
+ end
51
+
52
+ # @return [Conversions]
53
+ def conversions
54
+ @conversions ||= Conversions.new(loader: loader)
55
+ end
56
+ end
57
+ end
58
+ end
@@ -1,43 +1,43 @@
1
- # frozen_string_literal: true
2
-
3
- require 'rbs'
4
-
5
- module Solargraph
6
- class RbsMap
7
- # Ruby stdlib pins
8
- #
9
- class StdlibMap < RbsMap
10
- include Logging
11
-
12
- # @type [Hash{String => RbsMap}]
13
- @stdlib_maps_hash = {}
14
-
15
- # @param library [String]
16
- def initialize library
17
- cached_pins = PinCache.deserialize_stdlib_require library
18
- if cached_pins
19
- @pins = cached_pins
20
- @resolved = true
21
- @loaded = true
22
- logger.debug { "Deserialized #{cached_pins.length} cached pins for stdlib require #{library.inspect}" }
23
- else
24
- super
25
- unless resolved?
26
- @pins = []
27
- logger.info { "Could not resolve #{library.inspect}" }
28
- return
29
- end
30
- generated_pins = pins
31
- logger.debug { "Found #{generated_pins.length} pins for stdlib library #{library}" }
32
- PinCache.serialize_stdlib_require library, generated_pins
33
- end
34
- end
35
-
36
- # @param library [String]
37
- # @return [StdlibMap]
38
- def self.load library
39
- @stdlib_maps_hash[library] ||= StdlibMap.new(library)
40
- end
41
- end
42
- end
43
- end
1
+ # frozen_string_literal: true
2
+
3
+ require 'rbs'
4
+
5
+ module Solargraph
6
+ class RbsMap
7
+ # Ruby stdlib pins
8
+ #
9
+ class StdlibMap < RbsMap
10
+ include Logging
11
+
12
+ # @type [Hash{String => RbsMap}]
13
+ @stdlib_maps_hash = {}
14
+
15
+ # @param library [String]
16
+ def initialize library
17
+ cached_pins = PinCache.deserialize_stdlib_require library
18
+ if cached_pins
19
+ @pins = cached_pins
20
+ @resolved = true
21
+ @loaded = true
22
+ logger.debug { "Deserialized #{cached_pins.length} cached pins for stdlib require #{library.inspect}" }
23
+ else
24
+ super
25
+ unless resolved?
26
+ @pins = []
27
+ logger.info { "Could not resolve #{library.inspect}" }
28
+ return
29
+ end
30
+ generated_pins = pins
31
+ logger.debug { "Found #{generated_pins.length} pins for stdlib library #{library}" }
32
+ PinCache.serialize_stdlib_require library, generated_pins
33
+ end
34
+ end
35
+
36
+ # @param library [String]
37
+ # @return [StdlibMap]
38
+ def self.load library
39
+ @stdlib_maps_hash[library] ||= StdlibMap.new(library)
40
+ end
41
+ end
42
+ end
43
+ end
@@ -1,150 +1,163 @@
1
- # frozen_string_literal: true
2
-
3
- require 'pathname'
4
- require 'rbs'
5
-
6
- module Solargraph
7
- class RbsMap
8
- autoload :Conversions, 'solargraph/rbs_map/conversions'
9
- autoload :CoreMap, 'solargraph/rbs_map/core_map'
10
- autoload :CoreFills, 'solargraph/rbs_map/core_fills'
11
- autoload :StdlibMap, 'solargraph/rbs_map/stdlib_map'
12
-
13
- include Logging
14
-
15
- # @type [Hash{String => RbsMap}]
16
- @@rbs_maps_hash = {}
17
-
18
- attr_reader :library
19
-
20
- attr_reader :rbs_collection_paths
21
-
22
- attr_reader :rbs_collection_config_path
23
-
24
- # @param library [String]
25
- # @param version [String, nil]
26
- # @param rbs_collection_paths [Array<Pathname, String>]
27
- def initialize library, version = nil, rbs_collection_config_path: nil, rbs_collection_paths: []
28
- if rbs_collection_config_path.nil? && !rbs_collection_paths.empty?
29
- raise 'Please provide rbs_collection_config_path if you provide rbs_collection_paths'
30
- end
31
- @library = library
32
- @version = version
33
- @rbs_collection_config_path = rbs_collection_config_path
34
- @rbs_collection_paths = rbs_collection_paths
35
- add_library loader, library, version
36
- end
37
-
38
- def loader
39
- @loader ||= RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
40
- end
41
-
42
- # @return string representing the version of the RBS info fetched
43
- # for the given library. Must change when the RBS info is
44
- # updated upstream for the same library and version. May change
45
- # if the config for where information comes form changes.
46
- def cache_key
47
- @hextdigest ||= begin
48
- data = nil
49
- if rbs_collection_config_path
50
- lockfile_path = RBS::Collection::Config.to_lockfile_path(Pathname.new(rbs_collection_config_path))
51
- if lockfile_path.exist?
52
- collection_config = RBS::Collection::Config.from_path lockfile_path
53
- gem_config = collection_config.gem(library)
54
- data = gem_config&.to_s
55
- end
56
- end
57
- if data.nil? || data.empty?
58
- if resolved?
59
- # definitely came from the gem itself and not elsewhere -
60
- # only one version per gem
61
- 'gem-export'
62
- else
63
- 'unresolved'
64
- end
65
- else
66
- Digest::SHA1.hexdigest(data)
67
- end
68
- end
69
- end
70
-
71
- def self.from_gemspec gemspec, rbs_collection_path, rbs_collection_config_path
72
- rbs_map = RbsMap.new(gemspec.name, gemspec.version,
73
- rbs_collection_paths: [rbs_collection_path].compact,
74
- rbs_collection_config_path: rbs_collection_config_path)
75
- return rbs_map if rbs_map.resolved?
76
-
77
- # try any version of the gem in the collection
78
- RbsMap.new(gemspec.name, nil,
79
- rbs_collection_paths: [rbs_collection_path].compact,
80
- rbs_collection_config_path: rbs_collection_config_path)
81
- end
82
-
83
- def pins
84
- @pins ||= resolved? ? conversions.pins : []
85
- end
86
-
87
- # @generic T
88
- # @param path [String]
89
- # @param klass [Class<generic<T>>]
90
- # @return [generic<T>, nil]
91
- def path_pin path, klass = Pin::Base
92
- pin = pins.find { |p| p.path == path }
93
- pin if pin&.is_a?(klass)
94
- end
95
-
96
- # @param path [String]
97
- # @return [Array<Pin::Base>]
98
- def path_pins path
99
- pins.select { |p| p.path == path }
100
- end
101
-
102
- def resolved?
103
- @resolved
104
- end
105
-
106
- def repository
107
- @repository ||= RBS::Repository.new(no_stdlib: false).tap do |repo|
108
- @rbs_collection_paths.each do |dir|
109
- dir_path = Pathname.new(dir)
110
- repo.add(dir_path) if dir_path.exist? && dir_path.directory?
111
- end
112
- end
113
- end
114
-
115
- # @param library [String]
116
- # @return [RbsMap]
117
- def self.load library
118
- @@rbs_maps_hash[library] ||= RbsMap.new(library)
119
- end
120
-
121
- private
122
-
123
- def loader
124
- @loader ||= RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
125
- end
126
-
127
- def conversions
128
- @conversions ||= Conversions.new(loader: loader)
129
- end
130
-
131
- # @param loader [RBS::EnvironmentLoader]
132
- # @param library [String]
133
- # @return [Boolean] true if adding the library succeeded
134
- def add_library loader, library, version
135
- @resolved = if loader.has_library?(library: library, version: version)
136
- loader.add library: library, version: version
137
- logger.debug { "#{short_name} successfully loaded library #{library}:#{version}" }
138
- true
139
- else
140
- logger.info { "#{short_name} did not find data for library #{library}:#{version}" }
141
- false
142
- end
143
- end
144
-
145
- # @return [String]
146
- def short_name
147
- self.class.name.split('::').last
148
- end
149
- end
150
- end
1
+ # frozen_string_literal: true
2
+
3
+ require 'digest'
4
+ require 'pathname'
5
+ require 'rbs'
6
+
7
+ module Solargraph
8
+ class RbsMap
9
+ autoload :Conversions, 'solargraph/rbs_map/conversions'
10
+ autoload :CoreMap, 'solargraph/rbs_map/core_map'
11
+ autoload :CoreFills, 'solargraph/rbs_map/core_fills'
12
+ autoload :StdlibMap, 'solargraph/rbs_map/stdlib_map'
13
+
14
+ include Logging
15
+
16
+ # @type [Hash{String => RbsMap}]
17
+ @@rbs_maps_hash = {}
18
+
19
+ attr_reader :library
20
+
21
+ attr_reader :rbs_collection_paths
22
+
23
+ attr_reader :rbs_collection_config_path
24
+
25
+ # @param library [String]
26
+ # @param version [String, nil]
27
+ # @param rbs_collection_config_path [String, Pathname, nil]
28
+ # @param rbs_collection_paths [Array<Pathname, String>]
29
+ def initialize library, version = nil, rbs_collection_config_path: nil, rbs_collection_paths: []
30
+ if rbs_collection_config_path.nil? && !rbs_collection_paths.empty?
31
+ raise 'Please provide rbs_collection_config_path if you provide rbs_collection_paths'
32
+ end
33
+ @library = library
34
+ @version = version
35
+ @rbs_collection_config_path = rbs_collection_config_path
36
+ @rbs_collection_paths = rbs_collection_paths
37
+ add_library loader, library, version
38
+ end
39
+
40
+ # @return [RBS::EnvironmentLoader]
41
+ def loader
42
+ @loader ||= RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
43
+ end
44
+
45
+ # @return [String] representing the version of the RBS info fetched
46
+ # for the given library. Must change when the RBS info is
47
+ # updated upstream for the same library and version. May change
48
+ # if the config for where information comes form changes.
49
+ def cache_key
50
+ @hextdigest ||= begin
51
+ # @type [String, nil]
52
+ data = nil
53
+ if rbs_collection_config_path
54
+ lockfile_path = RBS::Collection::Config.to_lockfile_path(Pathname.new(rbs_collection_config_path))
55
+ if lockfile_path.exist?
56
+ collection_config = RBS::Collection::Config.from_path lockfile_path
57
+ gem_config = collection_config.gem(library)
58
+ data = gem_config&.to_s
59
+ end
60
+ end
61
+ if data.nil? || data.empty?
62
+ if resolved?
63
+ # definitely came from the gem itself and not elsewhere -
64
+ # only one version per gem
65
+ 'gem-export'
66
+ else
67
+ 'unresolved'
68
+ end
69
+ else
70
+ Digest::SHA1.hexdigest(data)
71
+ end
72
+ end
73
+ end
74
+
75
+ # @param gemspec [Gem::Specification, Bundler::LazySpecification]
76
+ # @param rbs_collection_path [String, Pathname, nil]
77
+ # @param rbs_collection_config_path [String, Pathname, nil]
78
+ # @return [RbsMap]
79
+ def self.from_gemspec gemspec, rbs_collection_path, rbs_collection_config_path
80
+ rbs_map = RbsMap.new(gemspec.name, gemspec.version,
81
+ rbs_collection_paths: [rbs_collection_path].compact,
82
+ rbs_collection_config_path: rbs_collection_config_path)
83
+ return rbs_map if rbs_map.resolved?
84
+
85
+ # try any version of the gem in the collection
86
+ RbsMap.new(gemspec.name, nil,
87
+ rbs_collection_paths: [rbs_collection_path].compact,
88
+ rbs_collection_config_path: rbs_collection_config_path)
89
+ end
90
+
91
+ # @return [Array<Pin::Base>]
92
+ def pins
93
+ @pins ||= resolved? ? conversions.pins : []
94
+ end
95
+
96
+ # @generic T
97
+ # @param path [String]
98
+ # @param klass [Class<generic<T>>]
99
+ # @return [generic<T>, nil]
100
+ def path_pin path, klass = Pin::Base
101
+ pin = pins.find { |p| p.path == path }
102
+ pin if pin&.is_a?(klass)
103
+ end
104
+
105
+ # @param path [String]
106
+ # @return [Array<Pin::Base>]
107
+ def path_pins path
108
+ pins.select { |p| p.path == path }
109
+ end
110
+
111
+ def resolved?
112
+ @resolved
113
+ end
114
+
115
+ # @return [RBS::Repository]
116
+ def repository
117
+ @repository ||= RBS::Repository.new(no_stdlib: false).tap do |repo|
118
+ @rbs_collection_paths.each do |dir|
119
+ dir_path = Pathname.new(dir)
120
+ repo.add(dir_path) if dir_path.exist? && dir_path.directory?
121
+ end
122
+ end
123
+ end
124
+
125
+ # @param library [String]
126
+ # @return [RbsMap]
127
+ def self.load library
128
+ @@rbs_maps_hash[library] ||= RbsMap.new(library)
129
+ end
130
+
131
+ private
132
+
133
+ # @return [RBS::EnvironmentLoader]
134
+ def loader
135
+ @loader ||= RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
136
+ end
137
+
138
+ # @return [Conversions]
139
+ def conversions
140
+ @conversions ||= Conversions.new(loader: loader)
141
+ end
142
+
143
+ # @param loader [RBS::EnvironmentLoader]
144
+ # @param library [String]
145
+ # @param version [String, nil]
146
+ # @return [Boolean] true if adding the library succeeded
147
+ def add_library loader, library, version
148
+ @resolved = if loader.has_library?(library: library, version: version)
149
+ loader.add library: library, version: version
150
+ logger.debug { "#{short_name} successfully loaded library #{library}:#{version}" }
151
+ true
152
+ else
153
+ logger.info { "#{short_name} did not find data for library #{library}:#{version}" }
154
+ false
155
+ end
156
+ end
157
+
158
+ # @return [String]
159
+ def short_name
160
+ self.class.name.split('::').last
161
+ end
162
+ end
163
+ end