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,82 +1,82 @@
1
- # frozen_string_literal: true
2
-
3
- module Solargraph
4
- class Source
5
- # A change to be applied to text.
6
- #
7
- class Change
8
- include EncodingFixes
9
-
10
- # @return [Range]
11
- attr_reader :range
12
-
13
- # @return [String]
14
- attr_reader :new_text
15
-
16
- # @param range [Range] The starting and ending positions of the change.
17
- # If nil, the original text will be overwritten.
18
- # @param new_text [String] The text to be changed.
19
- def initialize range, new_text
20
- @range = range
21
- @new_text = new_text
22
- end
23
-
24
- # Write the change to the specified text.
25
- #
26
- # @param text [String] The text to be changed.
27
- # @param nullable [Boolean] If true, minor changes that could generate
28
- # syntax errors will be repaired.
29
- # @return [String] The updated text.
30
- def write text, nullable = false
31
- if nullable and !range.nil? and new_text.match(/[\.\[\{\(@\$:]$/)
32
- [':', '@'].each do |dupable|
33
- next unless new_text == dupable
34
- offset = Position.to_offset(text, range.start)
35
- if text[offset - 1] == dupable
36
- p = Position.from_offset(text, offset - 1)
37
- r = Change.new(Range.new(p, range.start), ' ')
38
- text = r.write(text)
39
- end
40
- break
41
- end
42
- commit text, "#{new_text[0..-2]} "
43
- elsif range.nil?
44
- new_text
45
- else
46
- commit text, new_text
47
- end
48
- end
49
-
50
- # Repair an update by replacing the new text with similarly formatted
51
- # whitespace.
52
- #
53
- # @param text [String] The text to be changed.
54
- # @return [String] The updated text.
55
- def repair text
56
- fixed = new_text.gsub(/[^\s]/, ' ')
57
- if range.nil?
58
- fixed
59
- else
60
- result = commit text, fixed
61
- off = Position.to_offset(text, range.start)
62
- match = result[0, off].match(/[\.:]+\z/)
63
- if match
64
- result = result[0, off].sub(/#{match[0]}\z/, ' ' * match[0].length) + result[off..-1]
65
- end
66
- result
67
- end
68
- end
69
-
70
- private
71
-
72
- # @param text [String]
73
- # @param insert [String]
74
- # @return [String]
75
- def commit text, insert
76
- start_offset = Position.to_offset(text, range.start)
77
- end_offset = Position.to_offset(text, range.ending)
78
- (start_offset == 0 ? '' : text[0..start_offset-1].to_s) + normalize(insert) + text[end_offset..-1].to_s
79
- end
80
- end
81
- end
82
- end
1
+ # frozen_string_literal: true
2
+
3
+ module Solargraph
4
+ class Source
5
+ # A change to be applied to text.
6
+ #
7
+ class Change
8
+ include EncodingFixes
9
+
10
+ # @return [Range]
11
+ attr_reader :range
12
+
13
+ # @return [String]
14
+ attr_reader :new_text
15
+
16
+ # @param range [Range] The starting and ending positions of the change.
17
+ # If nil, the original text will be overwritten.
18
+ # @param new_text [String] The text to be changed.
19
+ def initialize range, new_text
20
+ @range = range
21
+ @new_text = new_text
22
+ end
23
+
24
+ # Write the change to the specified text.
25
+ #
26
+ # @param text [String] The text to be changed.
27
+ # @param nullable [Boolean] If true, minor changes that could generate
28
+ # syntax errors will be repaired.
29
+ # @return [String] The updated text.
30
+ def write text, nullable = false
31
+ if nullable and !range.nil? and new_text.match(/[.\[{(@$:]$/)
32
+ [':', '@'].each do |dupable|
33
+ next unless new_text == dupable
34
+ offset = Position.to_offset(text, range.start)
35
+ if text[offset - 1] == dupable
36
+ p = Position.from_offset(text, offset - 1)
37
+ r = Change.new(Range.new(p, range.start), ' ')
38
+ text = r.write(text)
39
+ end
40
+ break
41
+ end
42
+ commit text, "#{new_text[0..-2]} "
43
+ elsif range.nil?
44
+ new_text
45
+ else
46
+ commit text, new_text
47
+ end
48
+ end
49
+
50
+ # Repair an update by replacing the new text with similarly formatted
51
+ # whitespace.
52
+ #
53
+ # @param text [String] The text to be changed.
54
+ # @return [String] The updated text.
55
+ def repair text
56
+ fixed = new_text.gsub(/[^\s]/, ' ')
57
+ if range.nil?
58
+ fixed
59
+ else
60
+ result = commit text, fixed
61
+ off = Position.to_offset(text, range.start)
62
+ match = result[0, off].match(/[.:]+\z/)
63
+ if match
64
+ result = result[0, off].sub(/#{match[0]}\z/, ' ' * match[0].length) + result[off..-1]
65
+ end
66
+ result
67
+ end
68
+ end
69
+
70
+ private
71
+
72
+ # @param text [String]
73
+ # @param insert [String]
74
+ # @return [String]
75
+ def commit text, insert
76
+ start_offset = Position.to_offset(text, range.start)
77
+ end_offset = Position.to_offset(text, range.ending)
78
+ (start_offset == 0 ? '' : text[0..start_offset-1].to_s) + normalize(insert) + text[end_offset..-1].to_s
79
+ end
80
+ end
81
+ end
82
+ end
@@ -1,167 +1,166 @@
1
- # frozen_string_literal: true
2
-
3
- module Solargraph
4
- class Source
5
- # Information about a single Position in a Source, including the
6
- # word located there.
7
- #
8
- class Cursor
9
- # @return [Position]
10
- attr_reader :position
11
-
12
- # @return [Source]
13
- attr_reader :source
14
-
15
- # @param source [Source]
16
- # @param position [Position, Array(Integer, Integer)]
17
- def initialize source, position
18
- @source = source
19
- @position = Position.normalize(position)
20
- end
21
-
22
- # @return [String]
23
- def filename
24
- source.filename
25
- end
26
-
27
- # The whole word at the current position. Given the text `foo.bar`, the
28
- # word at position(0,6) is `bar`.
29
- #
30
- # @return [String]
31
- def word
32
- @word ||= start_of_word + end_of_word
33
- end
34
-
35
- # The part of the word before the current position. Given the text
36
- # `foo.bar`, the start_of_word at position(0, 6) is `ba`.
37
- #
38
- # @sg-ignore Improve resolution of String#match below
39
- # @return [String]
40
- def start_of_word
41
- @start_of_word ||= begin
42
- match = source.code[0..offset-1].to_s.match(start_word_pattern)
43
- result = (match ? match[0] : '')
44
- # Including the preceding colon if the word appears to be a symbol
45
- result = ":#{result}" if source.code[0..offset-result.length-1].end_with?(':') and !source.code[0..offset-result.length-1].end_with?('::')
46
- result
47
- end
48
- end
49
-
50
- # The part of the word after the current position. Given the text
51
- # `foo.bar`, the end_of_word at position (0,6) is `r`.
52
- #
53
- # @return [String]
54
- def end_of_word
55
- @end_of_word ||= begin
56
- match = source.code[offset..-1].to_s.match(end_word_pattern)
57
- match ? match[0] : ''
58
- end
59
- end
60
-
61
- # @return [Boolean]
62
- def start_of_constant?
63
- source.code[offset-2, 2] == '::'
64
- end
65
-
66
- # The range of the word at the current position.
67
- #
68
- # @return [Range]
69
- def range
70
- @range ||= begin
71
- s = Position.from_offset(source.code, offset - start_of_word.length)
72
- e = Position.from_offset(source.code, offset + end_of_word.length)
73
- Solargraph::Range.new(s, e)
74
- end
75
- end
76
-
77
- # @return [Chain]
78
- def chain
79
- @chain ||= SourceChainer.chain(source, position)
80
- end
81
-
82
- # True if the statement at the cursor is an argument to a previous
83
- # method.
84
- #
85
- # Given the code `process(foo)`, a cursor pointing at `foo` would
86
- # identify it as an argument being passed to the `process` method.
87
- #
88
- # If #argument? is true, the #recipient method will return a cursor that
89
- # points to the method receiving the argument.
90
- #
91
- # @return [Boolean]
92
- def argument?
93
- # @argument ||= !signature_position.nil?
94
- @argument ||= !recipient.nil?
95
- end
96
-
97
- # @return [Boolean]
98
- def comment?
99
- @comment ||= source.comment_at?(position)
100
- end
101
-
102
- # @return [Boolean]
103
- def string?
104
- @string ||= source.string_at?(position)
105
- end
106
-
107
- # Get a cursor pointing to the method that receives the current statement
108
- # as an argument.
109
- #
110
- # @return [Cursor, nil]
111
- def recipient
112
- @recipient ||= begin
113
- node = recipient_node
114
- node ? Cursor.new(source, Range.from_node(node).ending) : nil
115
- end
116
- end
117
- alias receiver recipient
118
-
119
- # @return [AST::Node]
120
- def node
121
- @node ||= source.node_at(position.line, position.column)
122
- end
123
-
124
- # @return [Position]
125
- def node_position
126
- @node_position ||= begin
127
- if start_of_word.empty?
128
- match = source.code[0, offset].match(/[\s]*(\.|:+)[\s]*$/)
129
- if match
130
- Position.from_offset(source.code, offset - match[0].length)
131
- else
132
- position
133
- end
134
- else
135
- position
136
- end
137
- end
138
- end
139
-
140
- # @return [Parser::AST::Node, nil]
141
- def recipient_node
142
- @recipient_node ||= Solargraph::Parser::NodeMethods.find_recipient_node(self)
143
- end
144
-
145
- # @return [Integer]
146
- def offset
147
- @offset ||= Position.to_offset(source.code, position)
148
- end
149
-
150
- private
151
-
152
- # A regular expression to find the start of a word from an offset.
153
- #
154
- # @return [Regexp]
155
- def start_word_pattern
156
- /(@{1,2}|\$)?([a-z0-9_]|[^\u0000-\u007F])*\z/i
157
- end
158
-
159
- # A regular expression to find the end of a word from an offset.
160
- #
161
- # @return [Regexp]
162
- def end_word_pattern
163
- /^([a-z0-9_]|[^\u0000-\u007F])*[\?\!]?/i
164
- end
165
- end
166
- end
167
- end
1
+ # frozen_string_literal: true
2
+
3
+ module Solargraph
4
+ class Source
5
+ # Information about a single Position in a Source, including the
6
+ # word located there.
7
+ #
8
+ class Cursor
9
+ # @return [Position]
10
+ attr_reader :position
11
+
12
+ # @return [Source]
13
+ attr_reader :source
14
+
15
+ # @param source [Source]
16
+ # @param position [Position, Array(Integer, Integer)]
17
+ def initialize source, position
18
+ @source = source
19
+ @position = Position.normalize(position)
20
+ end
21
+
22
+ # @return [String]
23
+ def filename
24
+ source.filename
25
+ end
26
+
27
+ # The whole word at the current position. Given the text `foo.bar`, the
28
+ # word at position(0,6) is `bar`.
29
+ #
30
+ # @return [String]
31
+ def word
32
+ @word ||= start_of_word + end_of_word
33
+ end
34
+
35
+ # The part of the word before the current position. Given the text
36
+ # `foo.bar`, the start_of_word at position(0, 6) is `ba`.
37
+ #
38
+ # @return [String]
39
+ def start_of_word
40
+ @start_of_word ||= begin
41
+ match = source.code[0..offset-1].to_s.match(start_word_pattern)
42
+ result = (match ? match[0] : '')
43
+ # Including the preceding colon if the word appears to be a symbol
44
+ result = ":#{result}" if source.code[0..offset-result.length-1].end_with?(':') and !source.code[0..offset-result.length-1].end_with?('::')
45
+ result
46
+ end
47
+ end
48
+
49
+ # The part of the word after the current position. Given the text
50
+ # `foo.bar`, the end_of_word at position (0,6) is `r`.
51
+ #
52
+ # @return [String]
53
+ def end_of_word
54
+ @end_of_word ||= begin
55
+ match = source.code[offset..-1].to_s.match(end_word_pattern)
56
+ match ? match[0] : ''
57
+ end
58
+ end
59
+
60
+ # @return [Boolean]
61
+ def start_of_constant?
62
+ source.code[offset-2, 2] == '::'
63
+ end
64
+
65
+ # The range of the word at the current position.
66
+ #
67
+ # @return [Range]
68
+ def range
69
+ @range ||= begin
70
+ s = Position.from_offset(source.code, offset - start_of_word.length)
71
+ e = Position.from_offset(source.code, offset + end_of_word.length)
72
+ Solargraph::Range.new(s, e)
73
+ end
74
+ end
75
+
76
+ # @return [Chain]
77
+ def chain
78
+ @chain ||= SourceChainer.chain(source, position)
79
+ end
80
+
81
+ # True if the statement at the cursor is an argument to a previous
82
+ # method.
83
+ #
84
+ # Given the code `process(foo)`, a cursor pointing at `foo` would
85
+ # identify it as an argument being passed to the `process` method.
86
+ #
87
+ # If #argument? is true, the #recipient method will return a cursor that
88
+ # points to the method receiving the argument.
89
+ #
90
+ # @return [Boolean]
91
+ def argument?
92
+ # @argument ||= !signature_position.nil?
93
+ @argument ||= !recipient.nil?
94
+ end
95
+
96
+ # @return [Boolean]
97
+ def comment?
98
+ @comment ||= source.comment_at?(position)
99
+ end
100
+
101
+ # @return [Boolean]
102
+ def string?
103
+ @string ||= source.string_at?(position)
104
+ end
105
+
106
+ # Get a cursor pointing to the method that receives the current statement
107
+ # as an argument.
108
+ #
109
+ # @return [Cursor, nil]
110
+ def recipient
111
+ @recipient ||= begin
112
+ node = recipient_node
113
+ node ? Cursor.new(source, Range.from_node(node).ending) : nil
114
+ end
115
+ end
116
+ alias receiver recipient
117
+
118
+ # @return [AST::Node]
119
+ def node
120
+ @node ||= source.node_at(position.line, position.column)
121
+ end
122
+
123
+ # @return [Position]
124
+ def node_position
125
+ @node_position ||= begin
126
+ if start_of_word.empty?
127
+ match = source.code[0, offset].match(/\s*(\.|:+)\s*$/)
128
+ if match
129
+ Position.from_offset(source.code, offset - match[0].length)
130
+ else
131
+ position
132
+ end
133
+ else
134
+ position
135
+ end
136
+ end
137
+ end
138
+
139
+ # @return [Parser::AST::Node, nil]
140
+ def recipient_node
141
+ @recipient_node ||= Solargraph::Parser::NodeMethods.find_recipient_node(self)
142
+ end
143
+
144
+ # @return [Integer]
145
+ def offset
146
+ @offset ||= Position.to_offset(source.code, position)
147
+ end
148
+
149
+ private
150
+
151
+ # A regular expression to find the start of a word from an offset.
152
+ #
153
+ # @return [Regexp]
154
+ def start_word_pattern
155
+ /(@{1,2}|\$)?([a-z0-9_]|[^\u0000-\u007F])*\z/i
156
+ end
157
+
158
+ # A regular expression to find the end of a word from an offset.
159
+ #
160
+ # @return [Regexp]
161
+ def end_word_pattern
162
+ /^([a-z0-9_]|[^\u0000-\u007F])*[?!]?/i
163
+ end
164
+ end
165
+ end
166
+ end
@@ -1,23 +1,23 @@
1
- # frozen_string_literal: true
2
-
3
- module Solargraph
4
- class Source
5
- module EncodingFixes
6
- module_function
7
-
8
- # Convert strings to normalized UTF-8.
9
- #
10
- # @param string [String]
11
- # @return [String]
12
- def normalize string
13
- begin
14
- string.dup.force_encoding('UTF-8')
15
- rescue ::Encoding::CompatibilityError, ::Encoding::UndefinedConversionError, ::Encoding::InvalidByteSequenceError => e
16
- # @todo Improve error handling
17
- Solargraph::Logging.logger.warn "Normalize error: #{e.message}"
18
- string
19
- end
20
- end
21
- end
22
- end
23
- end
1
+ # frozen_string_literal: true
2
+
3
+ module Solargraph
4
+ class Source
5
+ module EncodingFixes
6
+ module_function
7
+
8
+ # Convert strings to normalized UTF-8.
9
+ #
10
+ # @param string [String]
11
+ # @return [String]
12
+ def normalize string
13
+ begin
14
+ string.dup.force_encoding('UTF-8')
15
+ rescue ::Encoding::CompatibilityError, ::Encoding::UndefinedConversionError, ::Encoding::InvalidByteSequenceError => e
16
+ # @todo Improve error handling
17
+ Solargraph::Logging.logger.warn "Normalize error: #{e.message}"
18
+ string
19
+ end
20
+ end
21
+ end
22
+ end
23
+ end