solargraph 0.54.4 → 0.58.3

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 (238) 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 +185 -6
  5. data/.github/workflows/rspec.yml +55 -5
  6. data/.github/workflows/typecheck.yml +8 -3
  7. data/.gitignore +8 -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 +143 -0
  14. data/README.md +20 -6
  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 -167
  20. data/lib/solargraph/api_map/source_to_yard.rb +97 -88
  21. data/lib/solargraph/api_map/store.rb +384 -241
  22. data/lib/solargraph/api_map.rb +945 -875
  23. data/lib/solargraph/bench.rb +45 -28
  24. data/lib/solargraph/complex_type/type_methods.rb +228 -217
  25. data/lib/solargraph/complex_type/unique_type.rb +482 -386
  26. data/lib/solargraph/complex_type.rb +444 -394
  27. data/lib/solargraph/convention/active_support_concern.rb +111 -0
  28. data/lib/solargraph/convention/base.rb +20 -3
  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/gemfile.rb +15 -15
  33. data/lib/solargraph/convention/gemspec.rb +23 -22
  34. data/lib/solargraph/convention/rakefile.rb +17 -17
  35. data/lib/solargraph/convention/struct_definition/struct_assignment_node.rb +61 -0
  36. data/lib/solargraph/convention/struct_definition/struct_definition_node.rb +102 -0
  37. data/lib/solargraph/convention/struct_definition.rb +164 -0
  38. data/lib/solargraph/convention.rb +78 -47
  39. data/lib/solargraph/converters/dd.rb +17 -17
  40. data/lib/solargraph/converters/dl.rb +15 -15
  41. data/lib/solargraph/converters/dt.rb +15 -15
  42. data/lib/solargraph/converters/misc.rb +1 -1
  43. data/lib/solargraph/diagnostics/require_not_found.rb +53 -53
  44. data/lib/solargraph/diagnostics/rubocop.rb +118 -113
  45. data/lib/solargraph/diagnostics/rubocop_helpers.rb +68 -66
  46. data/lib/solargraph/diagnostics/type_check.rb +55 -55
  47. data/lib/solargraph/diagnostics/update_errors.rb +41 -41
  48. data/lib/solargraph/doc_map.rb +439 -188
  49. data/lib/solargraph/environ.rb +9 -2
  50. data/lib/solargraph/equality.rb +34 -33
  51. data/lib/solargraph/gem_pins.rb +98 -72
  52. data/lib/solargraph/language_server/error_codes.rb +20 -20
  53. data/lib/solargraph/language_server/host/diagnoser.rb +89 -89
  54. data/lib/solargraph/language_server/host/dispatch.rb +130 -128
  55. data/lib/solargraph/language_server/host/message_worker.rb +112 -106
  56. data/lib/solargraph/language_server/host/sources.rb +99 -99
  57. data/lib/solargraph/language_server/host.rb +878 -861
  58. data/lib/solargraph/language_server/message/base.rb +97 -96
  59. data/lib/solargraph/language_server/message/client/register_capability.rb +15 -15
  60. data/lib/solargraph/language_server/message/completion_item/resolve.rb +60 -60
  61. data/lib/solargraph/language_server/message/extended/check_gem_version.rb +114 -112
  62. data/lib/solargraph/language_server/message/extended/document.rb +23 -20
  63. data/lib/solargraph/language_server/message/extended/document_gems.rb +32 -32
  64. data/lib/solargraph/language_server/message/extended/download_core.rb +19 -19
  65. data/lib/solargraph/language_server/message/extended/search.rb +20 -20
  66. data/lib/solargraph/language_server/message/initialize.rb +191 -191
  67. data/lib/solargraph/language_server/message/text_document/completion.rb +56 -56
  68. data/lib/solargraph/language_server/message/text_document/definition.rb +40 -38
  69. data/lib/solargraph/language_server/message/text_document/document_highlight.rb +16 -16
  70. data/lib/solargraph/language_server/message/text_document/document_symbol.rb +26 -26
  71. data/lib/solargraph/language_server/message/text_document/formatting.rb +148 -131
  72. data/lib/solargraph/language_server/message/text_document/hover.rb +58 -58
  73. data/lib/solargraph/language_server/message/text_document/prepare_rename.rb +11 -11
  74. data/lib/solargraph/language_server/message/text_document/references.rb +16 -16
  75. data/lib/solargraph/language_server/message/text_document/rename.rb +19 -19
  76. data/lib/solargraph/language_server/message/text_document/signature_help.rb +24 -24
  77. data/lib/solargraph/language_server/message/text_document/type_definition.rb +25 -24
  78. data/lib/solargraph/language_server/message/workspace/did_change_configuration.rb +35 -35
  79. data/lib/solargraph/language_server/message/workspace/did_change_watched_files.rb +40 -40
  80. data/lib/solargraph/language_server/message/workspace/did_change_workspace_folders.rb +26 -24
  81. data/lib/solargraph/language_server/message/workspace/workspace_symbol.rb +23 -23
  82. data/lib/solargraph/language_server/message.rb +94 -94
  83. data/lib/solargraph/language_server/progress.rb +8 -0
  84. data/lib/solargraph/language_server/request.rb +27 -24
  85. data/lib/solargraph/language_server/transport/data_reader.rb +74 -74
  86. data/lib/solargraph/language_server/uri_helpers.rb +49 -49
  87. data/lib/solargraph/library.rb +683 -662
  88. data/lib/solargraph/location.rb +82 -58
  89. data/lib/solargraph/logging.rb +37 -27
  90. data/lib/solargraph/page.rb +92 -89
  91. data/lib/solargraph/parser/comment_ripper.rb +69 -56
  92. data/lib/solargraph/parser/flow_sensitive_typing.rb +255 -0
  93. data/lib/solargraph/parser/node_processor/base.rb +92 -87
  94. data/lib/solargraph/parser/node_processor.rb +62 -45
  95. data/lib/solargraph/parser/parser_gem/class_methods.rb +149 -157
  96. data/lib/solargraph/parser/parser_gem/flawed_builder.rb +19 -18
  97. data/lib/solargraph/parser/parser_gem/node_chainer.rb +166 -164
  98. data/lib/solargraph/parser/parser_gem/node_methods.rb +486 -495
  99. data/lib/solargraph/parser/parser_gem/node_processors/alias_node.rb +2 -1
  100. data/lib/solargraph/parser/parser_gem/node_processors/and_node.rb +22 -0
  101. data/lib/solargraph/parser/parser_gem/node_processors/args_node.rb +59 -57
  102. data/lib/solargraph/parser/parser_gem/node_processors/begin_node.rb +15 -15
  103. data/lib/solargraph/parser/parser_gem/node_processors/block_node.rb +46 -43
  104. data/lib/solargraph/parser/parser_gem/node_processors/casgn_node.rb +2 -1
  105. data/lib/solargraph/parser/parser_gem/node_processors/cvasgn_node.rb +2 -1
  106. data/lib/solargraph/parser/parser_gem/node_processors/def_node.rb +53 -50
  107. data/lib/solargraph/parser/parser_gem/node_processors/defs_node.rb +37 -36
  108. data/lib/solargraph/parser/parser_gem/node_processors/gvasgn_node.rb +2 -1
  109. data/lib/solargraph/parser/parser_gem/node_processors/if_node.rb +23 -0
  110. data/lib/solargraph/parser/parser_gem/node_processors/ivasgn_node.rb +40 -38
  111. data/lib/solargraph/parser/parser_gem/node_processors/lvasgn_node.rb +29 -28
  112. data/lib/solargraph/parser/parser_gem/node_processors/masgn_node.rb +59 -53
  113. data/lib/solargraph/parser/parser_gem/node_processors/namespace_node.rb +8 -7
  114. data/lib/solargraph/parser/parser_gem/node_processors/opasgn_node.rb +98 -0
  115. data/lib/solargraph/parser/parser_gem/node_processors/orasgn_node.rb +17 -16
  116. data/lib/solargraph/parser/parser_gem/node_processors/resbody_node.rb +38 -36
  117. data/lib/solargraph/parser/parser_gem/node_processors/sclass_node.rb +52 -42
  118. data/lib/solargraph/parser/parser_gem/node_processors/send_node.rb +291 -259
  119. data/lib/solargraph/parser/parser_gem/node_processors/sym_node.rb +3 -1
  120. data/lib/solargraph/parser/parser_gem/node_processors/until_node.rb +29 -0
  121. data/lib/solargraph/parser/parser_gem/node_processors/while_node.rb +29 -0
  122. data/lib/solargraph/parser/parser_gem/node_processors.rb +70 -56
  123. data/lib/solargraph/parser/parser_gem.rb +12 -12
  124. data/lib/solargraph/parser/region.rb +69 -66
  125. data/lib/solargraph/parser/snippet.rb +17 -15
  126. data/lib/solargraph/parser.rb +23 -22
  127. data/lib/solargraph/pin/base.rb +729 -378
  128. data/lib/solargraph/pin/base_variable.rb +126 -118
  129. data/lib/solargraph/pin/block.rb +104 -101
  130. data/lib/solargraph/pin/breakable.rb +9 -0
  131. data/lib/solargraph/pin/callable.rb +231 -147
  132. data/lib/solargraph/pin/closure.rb +72 -57
  133. data/lib/solargraph/pin/common.rb +79 -70
  134. data/lib/solargraph/pin/constant.rb +45 -43
  135. data/lib/solargraph/pin/conversions.rb +123 -123
  136. data/lib/solargraph/pin/delegated_method.rb +120 -101
  137. data/lib/solargraph/pin/documenting.rb +114 -98
  138. data/lib/solargraph/pin/instance_variable.rb +34 -34
  139. data/lib/solargraph/pin/keyword.rb +20 -15
  140. data/lib/solargraph/pin/local_variable.rb +75 -67
  141. data/lib/solargraph/pin/method.rb +672 -527
  142. data/lib/solargraph/pin/method_alias.rb +34 -31
  143. data/lib/solargraph/pin/namespace.rb +115 -107
  144. data/lib/solargraph/pin/parameter.rb +275 -212
  145. data/lib/solargraph/pin/proxy_type.rb +39 -29
  146. data/lib/solargraph/pin/reference/override.rb +47 -29
  147. data/lib/solargraph/pin/reference/require.rb +2 -2
  148. data/lib/solargraph/pin/reference/superclass.rb +15 -10
  149. data/lib/solargraph/pin/reference.rb +39 -22
  150. data/lib/solargraph/pin/search.rb +61 -56
  151. data/lib/solargraph/pin/signature.rb +61 -17
  152. data/lib/solargraph/pin/singleton.rb +1 -1
  153. data/lib/solargraph/pin/symbol.rb +53 -47
  154. data/lib/solargraph/pin/until.rb +18 -0
  155. data/lib/solargraph/pin/while.rb +18 -0
  156. data/lib/solargraph/pin.rb +44 -41
  157. data/lib/solargraph/pin_cache.rb +245 -0
  158. data/lib/solargraph/position.rb +132 -107
  159. data/lib/solargraph/range.rb +112 -98
  160. data/lib/solargraph/rbs_map/conversions.rb +823 -646
  161. data/lib/solargraph/rbs_map/core_fills.rb +84 -50
  162. data/lib/solargraph/rbs_map/core_map.rb +58 -28
  163. data/lib/solargraph/rbs_map/stdlib_map.rb +43 -33
  164. data/lib/solargraph/rbs_map.rb +163 -93
  165. data/lib/solargraph/server_methods.rb +16 -16
  166. data/lib/solargraph/shell.rb +363 -269
  167. data/lib/solargraph/source/chain/array.rb +37 -33
  168. data/lib/solargraph/source/chain/block_symbol.rb +1 -1
  169. data/lib/solargraph/source/chain/block_variable.rb +1 -1
  170. data/lib/solargraph/source/chain/call.rb +337 -303
  171. data/lib/solargraph/source/chain/class_variable.rb +13 -13
  172. data/lib/solargraph/source/chain/constant.rb +26 -89
  173. data/lib/solargraph/source/chain/global_variable.rb +13 -13
  174. data/lib/solargraph/source/chain/hash.rb +34 -33
  175. data/lib/solargraph/source/chain/head.rb +1 -1
  176. data/lib/solargraph/source/chain/if.rb +28 -28
  177. data/lib/solargraph/source/chain/instance_variable.rb +13 -13
  178. data/lib/solargraph/source/chain/link.rb +109 -98
  179. data/lib/solargraph/source/chain/literal.rb +48 -28
  180. data/lib/solargraph/source/chain/or.rb +23 -23
  181. data/lib/solargraph/source/chain/q_call.rb +11 -11
  182. data/lib/solargraph/source/chain/variable.rb +13 -13
  183. data/lib/solargraph/source/chain/z_super.rb +30 -30
  184. data/lib/solargraph/source/chain.rb +291 -252
  185. data/lib/solargraph/source/change.rb +82 -82
  186. data/lib/solargraph/source/cursor.rb +166 -167
  187. data/lib/solargraph/source/encoding_fixes.rb +23 -23
  188. data/lib/solargraph/source/source_chainer.rb +194 -194
  189. data/lib/solargraph/source/updater.rb +55 -55
  190. data/lib/solargraph/source.rb +498 -495
  191. data/lib/solargraph/source_map/clip.rb +226 -232
  192. data/lib/solargraph/source_map/data.rb +34 -30
  193. data/lib/solargraph/source_map/mapper.rb +259 -255
  194. data/lib/solargraph/source_map.rb +212 -217
  195. data/lib/solargraph/type_checker/checks.rb +124 -120
  196. data/lib/solargraph/type_checker/param_def.rb +37 -35
  197. data/lib/solargraph/type_checker/problem.rb +32 -32
  198. data/lib/solargraph/type_checker/rules.rb +84 -62
  199. data/lib/solargraph/type_checker.rb +814 -672
  200. data/lib/solargraph/version.rb +5 -5
  201. data/lib/solargraph/views/_method.erb +10 -10
  202. data/lib/solargraph/views/_namespace.erb +3 -3
  203. data/lib/solargraph/views/document.erb +10 -10
  204. data/lib/solargraph/workspace/config.rb +255 -239
  205. data/lib/solargraph/workspace/require_paths.rb +97 -0
  206. data/lib/solargraph/workspace.rb +220 -239
  207. data/lib/solargraph/yard_map/helpers.rb +44 -16
  208. data/lib/solargraph/yard_map/mapper/to_constant.rb +7 -5
  209. data/lib/solargraph/yard_map/mapper/to_method.rb +130 -94
  210. data/lib/solargraph/yard_map/mapper/to_namespace.rb +31 -28
  211. data/lib/solargraph/yard_map/mapper.rb +79 -78
  212. data/lib/solargraph/yard_map/to_method.rb +89 -86
  213. data/lib/solargraph/yard_tags.rb +20 -20
  214. data/lib/solargraph/yardoc.rb +87 -52
  215. data/lib/solargraph.rb +105 -72
  216. data/rbs/fills/bundler/0/bundler.rbs +4271 -0
  217. data/rbs/fills/open3/0/open3.rbs +172 -0
  218. data/rbs/fills/rubygems/0/basic_specification.rbs +326 -0
  219. data/rbs/fills/rubygems/0/errors.rbs +364 -0
  220. data/rbs/fills/rubygems/0/spec_fetcher.rbs +107 -0
  221. data/rbs/fills/rubygems/0/specification.rbs +1753 -0
  222. data/rbs/fills/tuple/tuple.rbs +149 -0
  223. data/rbs/shims/ast/0/node.rbs +5 -0
  224. data/rbs/shims/ast/2.4/.rbs_meta.yaml +9 -0
  225. data/rbs/shims/ast/2.4/ast.rbs +73 -0
  226. data/rbs/shims/parser/3.2.0.1/builders/default.rbs +195 -0
  227. data/rbs/shims/parser/3.2.0.1/manifest.yaml +7 -0
  228. data/rbs/shims/parser/3.2.0.1/parser.rbs +201 -0
  229. data/rbs/shims/parser/3.2.0.1/polyfill.rbs +4 -0
  230. data/rbs/shims/thor/1.2.0.1/.rbs_meta.yaml +9 -0
  231. data/rbs/shims/thor/1.2.0.1/manifest.yaml +7 -0
  232. data/rbs/shims/thor/1.2.0.1/thor.rbs +17 -0
  233. data/rbs_collection.yaml +19 -0
  234. data/solargraph.gemspec +27 -5
  235. metadata +215 -18
  236. data/lib/.rubocop.yml +0 -22
  237. data/lib/solargraph/cache.rb +0 -77
  238. data/lib/solargraph/parser/node_methods.rb +0 -83
@@ -1,188 +1,439 @@
1
- # frozen_string_literal: true
2
-
3
- module Solargraph
4
- # A collection of pins generated from required gems.
5
- #
6
- class DocMap
7
- # @return [Array<String>]
8
- attr_reader :requires
9
-
10
- # @return [Array<Gem::Specification>]
11
- attr_reader :preferences
12
-
13
- # @return [Array<Pin::Base>]
14
- attr_reader :pins
15
-
16
- # @return [Array<Gem::Specification>]
17
- attr_reader :uncached_gemspecs
18
-
19
- # @param requires [Array<String>]
20
- # @param preferences [Array<Gem::Specification>]
21
- # @param rbs_path [String, Pathname, nil]
22
- def initialize(requires, preferences, rbs_path = nil)
23
- @requires = requires.compact
24
- @preferences = preferences.compact
25
- @rbs_path = rbs_path
26
- generate
27
- end
28
-
29
- # @return [Array<Gem::Specification>]
30
- def gemspecs
31
- @gemspecs ||= required_gem_map.values.compact
32
- end
33
-
34
- # @return [Array<String>]
35
- def unresolved_requires
36
- @unresolved_requires ||= required_gem_map.select { |_, gemspec| gemspec.nil? }.keys
37
- end
38
-
39
- # @return [Hash{Gem::Specification => Array[Pin::Base]}]
40
- def self.gems_in_memory
41
- @gems_in_memory ||= {}
42
- end
43
-
44
- # @return [Set<Gem::Specification>]
45
- def dependencies
46
- @dependencies ||= (gemspecs.flat_map { |spec| fetch_dependencies(spec) } - gemspecs).to_set
47
- end
48
-
49
- private
50
-
51
- # @return [void]
52
- def generate
53
- @pins = []
54
- @uncached_gemspecs = []
55
- required_gem_map.each do |path, gemspec|
56
- if gemspec
57
- try_cache gemspec
58
- else
59
- try_stdlib_map path
60
- end
61
- end
62
- dependencies.each { |dep| try_cache dep }
63
- @uncached_gemspecs.uniq!
64
- end
65
-
66
- # @return [Hash{String => Gem::Specification, nil}]
67
- def required_gem_map
68
- @required_gem_map ||= requires.to_h { |path| [path, resolve_path_to_gemspec(path)] }
69
- end
70
-
71
- # @return [Hash{String => Gem::Specification}]
72
- def preference_map
73
- @preference_map ||= preferences.to_h { |gemspec| [gemspec.name, gemspec] }
74
- end
75
-
76
- # @param gemspec [Gem::Specification]
77
- # @return [void]
78
- def try_cache gemspec
79
- return if try_gem_in_memory(gemspec)
80
- cache_file = File.join('gems', "#{gemspec.name}-#{gemspec.version}.ser")
81
- if Cache.exist?(cache_file)
82
- cached = Cache.load(cache_file)
83
- gempins = update_from_collection(gemspec, cached)
84
- self.class.gems_in_memory[gemspec] = gempins
85
- @pins.concat gempins
86
- else
87
- Solargraph.logger.debug "No pin cache for #{gemspec.name} #{gemspec.version}"
88
- @uncached_gemspecs.push gemspec
89
- end
90
- end
91
-
92
- # @param path [String] require path that might be in the RBS stdlib collection
93
- # @return [void]
94
- def try_stdlib_map path
95
- map = RbsMap::StdlibMap.load(path)
96
- if map.resolved?
97
- Solargraph.logger.debug "Loading stdlib pins for #{path}"
98
- @pins.concat map.pins
99
- else
100
- # @todo Temporarily ignoring unresolved `require 'set'`
101
- Solargraph.logger.debug "Require path #{path} could not be resolved" unless path == 'set'
102
- end
103
- end
104
-
105
- # @param gemspec [Gem::Specification]
106
- # @return [Boolean]
107
- def try_gem_in_memory gemspec
108
- gempins = DocMap.gems_in_memory[gemspec]
109
- return false unless gempins
110
- Solargraph.logger.debug "Found #{gemspec.name} #{gemspec.version} in memory"
111
- @pins.concat gempins
112
- true
113
- end
114
-
115
- # @param gemspec [Gem::Specification]
116
- def update_from_collection gemspec, gempins
117
- return gempins unless @rbs_path && File.directory?(@rbs_path)
118
- return gempins if RbsMap.new(gemspec.name, gemspec.version).resolved?
119
-
120
- rbs_map = RbsMap.new(gemspec.name, gemspec.version, directories: [@rbs_path])
121
- return gempins unless rbs_map.resolved?
122
-
123
- Solargraph.logger.info "Updating #{gemspec.name} #{gemspec.version} from collection"
124
- GemPins.combine(gempins, rbs_map)
125
- end
126
-
127
- # @param path [String]
128
- # @return [Gem::Specification, nil]
129
- def resolve_path_to_gemspec path
130
- return nil if path.empty?
131
-
132
- gemspec = Gem::Specification.find_by_path(path)
133
- if gemspec.nil?
134
- gem_name_guess = path.split('/').first
135
- begin
136
- # this can happen when the gem is included via a local path in
137
- # a Gemfile; Gem doesn't try to index the paths in that case.
138
- #
139
- # See if we can make a good guess:
140
- potential_gemspec = Gem::Specification.find_by_name(gem_name_guess)
141
- file = "lib/#{path}.rb"
142
- gemspec = potential_gemspec if potential_gemspec.files.any? { |gemspec_file| file == gemspec_file }
143
- rescue Gem::MissingSpecError
144
- Solargraph.logger.debug "Require path #{path} could not be resolved to a gem via find_by_path or guess of #{gem_name_guess}"
145
- nil
146
- end
147
- end
148
- gemspec_or_preference gemspec
149
- end
150
-
151
- # @param gemspec [Gem::Specification, nil]
152
- # @return [Gem::Specification, nil]
153
- def gemspec_or_preference gemspec
154
- return gemspec unless gemspec && preference_map.key?(gemspec.name)
155
- return gemspec if gemspec.version == preference_map[gemspec.name].version
156
-
157
- change_gemspec_version gemspec, preference_map[by_path.name].version
158
- end
159
-
160
- # @param gemspec [Gem::Specification]
161
- # @param version [Gem::Version]
162
- # @return [Gem::Specification]
163
- def change_gemspec_version gemspec, version
164
- Gem::Specification.find_by_name(gemspec.name, "= #{version}")
165
- rescue Gem::MissingSpecError
166
- Solargraph.logger.info "Gem #{gemspec.name} version #{version} not found. Using #{gemspec.version} instead"
167
- gemspec
168
- end
169
-
170
- # @param gemspec [Gem::Specification]
171
- # @return [Array<Gem::Specification>]
172
- def fetch_dependencies gemspec
173
- only_runtime_dependencies(gemspec).each_with_object(Set.new) do |spec, deps|
174
- Solargraph.logger.info "Adding #{spec.name} dependency for #{gemspec.name}"
175
- dep = Gem::Specification.find_by_name(spec.name, spec.requirement)
176
- deps.merge fetch_dependencies(dep) if deps.add?(dep)
177
- rescue Gem::MissingSpecError
178
- Solargraph.logger.warn "Gem dependency #{spec.name} #{spec.requirements} for #{gemspec.name} not found."
179
- end.to_a
180
- end
181
-
182
- # @param gemspec [Gem::Specification]
183
- # @return [Array<Gem::Dependency>]
184
- def only_runtime_dependencies gemspec
185
- gemspec.dependencies - gemspec.development_dependencies
186
- end
187
- end
188
- end
1
+ # frozen_string_literal: true
2
+
3
+ require 'pathname'
4
+ require 'benchmark'
5
+ require 'open3'
6
+
7
+ module Solargraph
8
+ # A collection of pins generated from required gems.
9
+ #
10
+ class DocMap
11
+ include Logging
12
+
13
+ # @return [Array<String>]
14
+ attr_reader :requires
15
+ alias required requires
16
+
17
+ # @return [Array<Gem::Specification>]
18
+ attr_reader :preferences
19
+
20
+ # @return [Array<Pin::Base>]
21
+ attr_reader :pins
22
+
23
+ # @return [Array<Gem::Specification>]
24
+ def uncached_gemspecs
25
+ uncached_yard_gemspecs.concat(uncached_rbs_collection_gemspecs)
26
+ .sort
27
+ .uniq { |gemspec| "#{gemspec.name}:#{gemspec.version}" }
28
+ end
29
+
30
+ # @return [Array<Gem::Specification>]
31
+ attr_reader :uncached_yard_gemspecs
32
+
33
+ # @return [Array<Gem::Specification>]
34
+ attr_reader :uncached_rbs_collection_gemspecs
35
+
36
+ # @return [String, nil]
37
+ attr_reader :rbs_collection_path
38
+
39
+ # @return [String, nil]
40
+ attr_reader :rbs_collection_config_path
41
+
42
+ # @return [Workspace, nil]
43
+ attr_reader :workspace
44
+
45
+ # @return [Environ]
46
+ attr_reader :environ
47
+
48
+ # @param requires [Array<String>]
49
+ # @param preferences [Array<Gem::Specification>]
50
+ # @param workspace [Workspace, nil]
51
+ def initialize(requires, preferences, workspace = nil)
52
+ @requires = requires.compact
53
+ @preferences = preferences.compact
54
+ @workspace = workspace
55
+ @rbs_collection_path = workspace&.rbs_collection_path
56
+ @rbs_collection_config_path = workspace&.rbs_collection_config_path
57
+ @environ = Convention.for_global(self)
58
+ @requires.concat @environ.requires if @environ
59
+ load_serialized_gem_pins
60
+ pins.concat @environ.pins
61
+ end
62
+
63
+ # @param out [IO]
64
+ # @return [void]
65
+ def cache_all!(out)
66
+ # if we log at debug level:
67
+ if logger.info?
68
+ gem_desc = uncached_gemspecs.map { |gemspec| "#{gemspec.name}:#{gemspec.version}" }.join(', ')
69
+ logger.info "Caching pins for gems: #{gem_desc}" unless uncached_gemspecs.empty?
70
+ end
71
+ logger.debug { "Caching for YARD: #{uncached_yard_gemspecs.map(&:name)}" }
72
+ logger.debug { "Caching for RBS collection: #{uncached_rbs_collection_gemspecs.map(&:name)}" }
73
+ load_serialized_gem_pins
74
+ uncached_gemspecs.each do |gemspec|
75
+ cache(gemspec, out: out)
76
+ end
77
+ load_serialized_gem_pins
78
+ @uncached_rbs_collection_gemspecs = []
79
+ @uncached_yard_gemspecs = []
80
+ end
81
+
82
+ # @param gemspec [Gem::Specification]
83
+ # @param out [IO]
84
+ # @return [void]
85
+ def cache_yard_pins(gemspec, out)
86
+ pins = GemPins.build_yard_pins(yard_plugins, gemspec)
87
+ PinCache.serialize_yard_gem(gemspec, pins)
88
+ logger.info { "Cached #{pins.length} YARD pins for gem #{gemspec.name}:#{gemspec.version}" } unless pins.empty?
89
+ end
90
+
91
+ # @param gemspec [Gem::Specification]
92
+ # @param out [IO]
93
+ # @return [void]
94
+ def cache_rbs_collection_pins(gemspec, out)
95
+ rbs_map = RbsMap.from_gemspec(gemspec, rbs_collection_path, rbs_collection_config_path)
96
+ pins = rbs_map.pins
97
+ rbs_version_cache_key = rbs_map.cache_key
98
+ # cache pins even if result is zero, so we don't retry building pins
99
+ pins ||= []
100
+ PinCache.serialize_rbs_collection_gem(gemspec, rbs_version_cache_key, pins)
101
+ logger.info { "Cached #{pins.length} RBS collection pins for gem #{gemspec.name} #{gemspec.version} with cache_key #{rbs_version_cache_key.inspect}" unless pins.empty? }
102
+ end
103
+
104
+ # @param gemspec [Gem::Specification]
105
+ # @param rebuild [Boolean] whether to rebuild the pins even if they are cached
106
+ # @param out [IO, nil] output stream for logging
107
+ # @return [void]
108
+ def cache(gemspec, rebuild: false, out: nil)
109
+ build_yard = uncached_yard_gemspecs.include?(gemspec) || rebuild
110
+ build_rbs_collection = uncached_rbs_collection_gemspecs.include?(gemspec) || rebuild
111
+ if build_yard || build_rbs_collection
112
+ type = []
113
+ type << 'YARD' if build_yard
114
+ type << 'RBS collection' if build_rbs_collection
115
+ out.puts("Caching #{type.join(' and ')} pins for gem #{gemspec.name}:#{gemspec.version}") if out
116
+ end
117
+ cache_yard_pins(gemspec, out) if build_yard
118
+ cache_rbs_collection_pins(gemspec, out) if build_rbs_collection
119
+ end
120
+
121
+ # @return [Array<Gem::Specification>]
122
+ def gemspecs
123
+ @gemspecs ||= required_gems_map.values.compact.flatten
124
+ end
125
+
126
+ # @return [Array<String>]
127
+ def unresolved_requires
128
+ @unresolved_requires ||= required_gems_map.select { |_, gemspecs| gemspecs.nil? }.keys
129
+ end
130
+
131
+ # @return [Hash{Array(String, String) => Array<Pin::Base>}] Indexed by gemspec name and version
132
+ def self.all_yard_gems_in_memory
133
+ @yard_gems_in_memory ||= {}
134
+ end
135
+
136
+ # @return [Hash{String => Hash{Array(String, String) => Array<Pin::Base>}}] stored by RBS collection path
137
+ def self.all_rbs_collection_gems_in_memory
138
+ @rbs_collection_gems_in_memory ||= {}
139
+ end
140
+
141
+ # @return [Hash{Array(String, String) => Array<Pin::Base>}] Indexed by gemspec name and version
142
+ def yard_pins_in_memory
143
+ self.class.all_yard_gems_in_memory
144
+ end
145
+
146
+ # @return [Hash{Array(String, String) => Array<Pin::Base>}] Indexed by gemspec name and version
147
+ def rbs_collection_pins_in_memory
148
+ self.class.all_rbs_collection_gems_in_memory[rbs_collection_path] ||= {}
149
+ end
150
+
151
+ # @return [Hash{Array(String, String) => Array<Pin::Base>}] Indexed by gemspec name and version
152
+ def self.all_combined_pins_in_memory
153
+ @combined_pins_in_memory ||= {}
154
+ end
155
+
156
+ # @todo this should also include an index by the hash of the RBS collection
157
+ # @return [Hash{Array(String, String) => Array<Pin::Base>}] Indexed by gemspec name and version
158
+ def combined_pins_in_memory
159
+ self.class.all_combined_pins_in_memory
160
+ end
161
+
162
+ # @return [Array<String>]
163
+ def yard_plugins
164
+ @environ.yard_plugins
165
+ end
166
+
167
+ # @return [Set<Gem::Specification>]
168
+ def dependencies
169
+ @dependencies ||= (gemspecs.flat_map { |spec| fetch_dependencies(spec) } - gemspecs).to_set
170
+ end
171
+
172
+ private
173
+
174
+ # @return [void]
175
+ def load_serialized_gem_pins
176
+ @pins = []
177
+ @uncached_yard_gemspecs = []
178
+ @uncached_rbs_collection_gemspecs = []
179
+ with_gemspecs, without_gemspecs = required_gems_map.partition { |_, v| v }
180
+ # @sg-ignore Need support for RBS duck interfaces like _ToHash
181
+ # @type [Array<String>]
182
+ paths = Hash[without_gemspecs].keys
183
+ # @sg-ignore Need support for RBS duck interfaces like _ToHash
184
+ # @type [Array<Gem::Specification>]
185
+ gemspecs = Hash[with_gemspecs].values.flatten.compact + dependencies.to_a
186
+
187
+ paths.each do |path|
188
+ rbs_pins = deserialize_stdlib_rbs_map path
189
+ end
190
+
191
+ logger.debug { "DocMap#load_serialized_gem_pins: Combining pins..." }
192
+ time = Benchmark.measure do
193
+ gemspecs.each do |gemspec|
194
+ pins = deserialize_combined_pin_cache gemspec
195
+ @pins.concat pins if pins
196
+ end
197
+ end
198
+ logger.info { "DocMap#load_serialized_gem_pins: Loaded and processed serialized pins together in #{time.real} seconds" }
199
+ @uncached_yard_gemspecs.uniq!
200
+ @uncached_rbs_collection_gemspecs.uniq!
201
+ nil
202
+ end
203
+
204
+ # @return [Hash{String => Array<Gem::Specification>}]
205
+ def required_gems_map
206
+ @required_gems_map ||= requires.to_h { |path| [path, resolve_path_to_gemspecs(path)] }
207
+ end
208
+
209
+ # @return [Hash{String => Gem::Specification}]
210
+ def preference_map
211
+ @preference_map ||= preferences.to_h { |gemspec| [gemspec.name, gemspec] }
212
+ end
213
+
214
+ # @param gemspec [Gem::Specification]
215
+ # @return [Array<Pin::Base>, nil]
216
+ def deserialize_yard_pin_cache gemspec
217
+ if yard_pins_in_memory.key?([gemspec.name, gemspec.version])
218
+ return yard_pins_in_memory[[gemspec.name, gemspec.version]]
219
+ end
220
+
221
+ cached = PinCache.deserialize_yard_gem(gemspec)
222
+ if cached
223
+ logger.info { "Loaded #{cached.length} cached YARD pins from #{gemspec.name}:#{gemspec.version}" }
224
+ yard_pins_in_memory[[gemspec.name, gemspec.version]] = cached
225
+ cached
226
+ else
227
+ logger.debug "No YARD pin cache for #{gemspec.name}:#{gemspec.version}"
228
+ @uncached_yard_gemspecs.push gemspec
229
+ nil
230
+ end
231
+ end
232
+
233
+ # @param gemspec [Gem::Specification]
234
+ # @return [void]
235
+ def deserialize_combined_pin_cache(gemspec)
236
+ unless combined_pins_in_memory[[gemspec.name, gemspec.version]].nil?
237
+ return combined_pins_in_memory[[gemspec.name, gemspec.version]]
238
+ end
239
+
240
+ rbs_map = RbsMap.from_gemspec(gemspec, rbs_collection_path, rbs_collection_config_path)
241
+ rbs_version_cache_key = rbs_map.cache_key
242
+
243
+ cached = PinCache.deserialize_combined_gem(gemspec, rbs_version_cache_key)
244
+ if cached
245
+ logger.info { "Loaded #{cached.length} cached YARD pins from #{gemspec.name}:#{gemspec.version}" }
246
+ combined_pins_in_memory[[gemspec.name, gemspec.version]] = cached
247
+ return combined_pins_in_memory[[gemspec.name, gemspec.version]]
248
+ end
249
+
250
+ rbs_collection_pins = deserialize_rbs_collection_cache gemspec, rbs_version_cache_key
251
+
252
+ yard_pins = deserialize_yard_pin_cache gemspec
253
+
254
+ if !rbs_collection_pins.nil? && !yard_pins.nil?
255
+ logger.debug { "Combining pins for #{gemspec.name}:#{gemspec.version}" }
256
+ combined_pins = GemPins.combine(yard_pins, rbs_collection_pins)
257
+ PinCache.serialize_combined_gem(gemspec, rbs_version_cache_key, combined_pins)
258
+ combined_pins_in_memory[[gemspec.name, gemspec.version]] = combined_pins
259
+ logger.info { "Generated #{combined_pins_in_memory[[gemspec.name, gemspec.version]].length} combined pins for #{gemspec.name} #{gemspec.version}" }
260
+ return combined_pins
261
+ end
262
+
263
+ if !yard_pins.nil?
264
+ logger.debug { "Using only YARD pins for #{gemspec.name}:#{gemspec.version}" }
265
+ combined_pins_in_memory[[gemspec.name, gemspec.version]] = yard_pins
266
+ return combined_pins_in_memory[[gemspec.name, gemspec.version]]
267
+ elsif !rbs_collection_pins.nil?
268
+ logger.debug { "Using only RBS collection pins for #{gemspec.name}:#{gemspec.version}" }
269
+ combined_pins_in_memory[[gemspec.name, gemspec.version]] = rbs_collection_pins
270
+ return combined_pins_in_memory[[gemspec.name, gemspec.version]]
271
+ else
272
+ logger.debug { "Pins not yet cached for #{gemspec.name}:#{gemspec.version}" }
273
+ return nil
274
+ end
275
+ end
276
+
277
+ # @param path [String] require path that might be in the RBS stdlib collection
278
+ # @return [void]
279
+ def deserialize_stdlib_rbs_map path
280
+ map = RbsMap::StdlibMap.load(path)
281
+ if map.resolved?
282
+ logger.debug { "Loading stdlib pins for #{path}" }
283
+ @pins.concat map.pins
284
+ logger.debug { "Loaded #{map.pins.length} stdlib pins for #{path}" }
285
+ map.pins
286
+ else
287
+ # @todo Temporarily ignoring unresolved `require 'set'`
288
+ logger.debug { "Require path #{path} could not be resolved in RBS" } unless path == 'set'
289
+ nil
290
+ end
291
+ end
292
+
293
+ # @param gemspec [Gem::Specification]
294
+ # @param rbs_version_cache_key [String]
295
+ # @return [Array<Pin::Base>, nil]
296
+ def deserialize_rbs_collection_cache gemspec, rbs_version_cache_key
297
+ return if rbs_collection_pins_in_memory.key?([gemspec, rbs_version_cache_key])
298
+ cached = PinCache.deserialize_rbs_collection_gem(gemspec, rbs_version_cache_key)
299
+ if cached
300
+ logger.info { "Loaded #{cached.length} pins from RBS collection cache for #{gemspec.name}:#{gemspec.version}" } unless cached.empty?
301
+ rbs_collection_pins_in_memory[[gemspec, rbs_version_cache_key]] = cached
302
+ cached
303
+ else
304
+ logger.debug "No RBS collection pin cache for #{gemspec.name} #{gemspec.version}"
305
+ @uncached_rbs_collection_gemspecs.push gemspec
306
+ nil
307
+ end
308
+ end
309
+
310
+ # @param path [String]
311
+ # @return [::Array<Gem::Specification>, nil]
312
+ def resolve_path_to_gemspecs path
313
+ return nil if path.empty?
314
+ return gemspecs_required_from_bundler if path == 'bundler/require'
315
+
316
+ # @type [Gem::Specification, nil]
317
+ gemspec = Gem::Specification.find_by_path(path)
318
+ if gemspec.nil?
319
+ gem_name_guess = path.split('/').first
320
+ begin
321
+ # this can happen when the gem is included via a local path in
322
+ # a Gemfile; Gem doesn't try to index the paths in that case.
323
+ #
324
+ # See if we can make a good guess:
325
+ potential_gemspec = Gem::Specification.find_by_name(gem_name_guess)
326
+ file = "lib/#{path}.rb"
327
+ gemspec = potential_gemspec if potential_gemspec.files.any? { |gemspec_file| file == gemspec_file }
328
+ rescue Gem::MissingSpecError
329
+ logger.debug { "Require path #{path} could not be resolved to a gem via find_by_path or guess of #{gem_name_guess}" }
330
+ []
331
+ end
332
+ end
333
+ return nil if gemspec.nil?
334
+ [gemspec_or_preference(gemspec)]
335
+ end
336
+
337
+ # @param gemspec [Gem::Specification]
338
+ # @return [Gem::Specification]
339
+ def gemspec_or_preference gemspec
340
+ # :nocov: dormant feature
341
+ return gemspec unless preference_map.key?(gemspec.name)
342
+ return gemspec if gemspec.version == preference_map[gemspec.name].version
343
+
344
+ change_gemspec_version gemspec, preference_map[gemspec.name].version
345
+ # :nocov:
346
+ end
347
+
348
+ # @param gemspec [Gem::Specification]
349
+ # @param version [Gem::Version]
350
+ # @return [Gem::Specification]
351
+ def change_gemspec_version gemspec, version
352
+ Gem::Specification.find_by_name(gemspec.name, "= #{version}")
353
+ rescue Gem::MissingSpecError
354
+ Solargraph.logger.info "Gem #{gemspec.name} version #{version} not found. Using #{gemspec.version} instead"
355
+ gemspec
356
+ end
357
+
358
+ # @param gemspec [Gem::Specification]
359
+ # @return [Array<Gem::Specification>]
360
+ def fetch_dependencies gemspec
361
+ # @param spec [Gem::Dependency]
362
+ # @param deps [Set<Gem::Specification>]
363
+ only_runtime_dependencies(gemspec).each_with_object(Set.new) do |spec, deps|
364
+ Solargraph.logger.info "Adding #{spec.name} dependency for #{gemspec.name}"
365
+ dep = Gem.loaded_specs[spec.name]
366
+ # @todo is next line necessary?
367
+ # @sg-ignore Unresolved call to requirement on Gem::Dependency
368
+ dep ||= Gem::Specification.find_by_name(spec.name, spec.requirement)
369
+ deps.merge fetch_dependencies(dep) if deps.add?(dep)
370
+ rescue Gem::MissingSpecError
371
+ # @sg-ignore Unresolved call to requirement on Gem::Dependency
372
+ Solargraph.logger.warn "Gem dependency #{spec.name} #{spec.requirement} for #{gemspec.name} not found in RubyGems."
373
+ end.to_a
374
+ end
375
+
376
+ # @param gemspec [Gem::Specification]
377
+ # @return [Array<Gem::Dependency>]
378
+ def only_runtime_dependencies gemspec
379
+ gemspec.dependencies - gemspec.development_dependencies
380
+ end
381
+
382
+
383
+ def inspect
384
+ self.class.inspect
385
+ end
386
+
387
+ # @return [Array<Gem::Specification>, nil]
388
+ def gemspecs_required_from_bundler
389
+ # @todo Handle projects with custom Bundler/Gemfile setups
390
+ return unless workspace.gemfile?
391
+
392
+ if workspace.gemfile? && Bundler.definition&.lockfile&.to_s&.start_with?(workspace.directory)
393
+ # Find only the gems bundler is now using
394
+ Bundler.definition.locked_gems.specs.flat_map do |lazy_spec|
395
+ logger.info "Handling #{lazy_spec.name}:#{lazy_spec.version}"
396
+ [Gem::Specification.find_by_name(lazy_spec.name, lazy_spec.version)]
397
+ rescue Gem::MissingSpecError => e
398
+ logger.info("Could not find #{lazy_spec.name}:#{lazy_spec.version} with find_by_name, falling back to guess")
399
+ # can happen in local filesystem references
400
+ specs = resolve_path_to_gemspecs lazy_spec.name
401
+ logger.warn "Gem #{lazy_spec.name} #{lazy_spec.version} from bundle not found: #{e}" if specs.nil?
402
+ next specs
403
+ end.compact
404
+ else
405
+ logger.info 'Fetching gemspecs required from Bundler (bundler/require)'
406
+ gemspecs_required_from_external_bundle
407
+ end
408
+ end
409
+
410
+ # @return [Array<Gem::Specification>, nil]
411
+ def gemspecs_required_from_external_bundle
412
+ logger.info 'Fetching gemspecs required from external bundle'
413
+ return [] unless workspace&.directory
414
+
415
+ Solargraph.with_clean_env do
416
+ cmd = [
417
+ 'ruby', '-e',
418
+ "require 'bundler'; require 'json'; Dir.chdir('#{workspace&.directory}') { puts Bundler.definition.locked_gems.specs.map { |spec| [spec.name, spec.version] }.to_h.to_json }"
419
+ ]
420
+ o, e, s = Open3.capture3(*cmd)
421
+ if s.success?
422
+ Solargraph.logger.debug "External bundle: #{o}"
423
+ hash = o && !o.empty? ? JSON.parse(o.split("\n").last) : {}
424
+ hash.flat_map do |name, version|
425
+ Gem::Specification.find_by_name(name, version)
426
+ rescue Gem::MissingSpecError => e
427
+ logger.info("Could not find #{name}:#{version} with find_by_name, falling back to guess")
428
+ # can happen in local filesystem references
429
+ specs = resolve_path_to_gemspecs name
430
+ logger.warn "Gem #{name} #{version} from bundle not found: #{e}" if specs.nil?
431
+ next specs
432
+ end.compact
433
+ else
434
+ Solargraph.logger.warn "Failed to load gems from bundle at #{workspace&.directory}: #{e}"
435
+ end
436
+ end
437
+ end
438
+ end
439
+ end
@@ -13,16 +13,21 @@ module Solargraph
13
13
  # @return [Array<String>]
14
14
  attr_reader :domains
15
15
 
16
- # @return [Array<Pin::Reference::Override>]
16
+ # @return [Array<Pin::Base>]
17
17
  attr_reader :pins
18
18
 
19
+ # @return [Array<String>]
20
+ attr_reader :yard_plugins
21
+
19
22
  # @param requires [Array<String>]
20
23
  # @param domains [Array<String>]
21
24
  # @param pins [Array<Pin::Base>]
22
- def initialize requires: [], domains: [], pins: []
25
+ # @param yard_plugins [Array<String>]
26
+ def initialize requires: [], domains: [], pins: [], yard_plugins: []
23
27
  @requires = requires
24
28
  @domains = domains
25
29
  @pins = pins
30
+ @yard_plugins = yard_plugins
26
31
  end
27
32
 
28
33
  # @return [self]
@@ -30,6 +35,7 @@ module Solargraph
30
35
  domains.clear
31
36
  requires.clear
32
37
  pins.clear
38
+ yard_plugins.clear
33
39
  self
34
40
  end
35
41
 
@@ -39,6 +45,7 @@ module Solargraph
39
45
  domains.concat other.domains
40
46
  requires.concat other.requires
41
47
  pins.concat other.pins
48
+ yard_plugins.concat other.yard_plugins
42
49
  self
43
50
  end
44
51
  end