solargraph 0.58.1 → 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 (195) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/plugins.yml +3 -2
  3. data/.gitignore +1 -0
  4. data/CHANGELOG.md +10 -1
  5. data/lib/solargraph/api_map/cache.rb +110 -110
  6. data/lib/solargraph/api_map/constants.rb +279 -279
  7. data/lib/solargraph/api_map/index.rb +193 -193
  8. data/lib/solargraph/api_map/source_to_yard.rb +97 -97
  9. data/lib/solargraph/api_map/store.rb +384 -384
  10. data/lib/solargraph/api_map.rb +945 -945
  11. data/lib/solargraph/bench.rb +45 -45
  12. data/lib/solargraph/complex_type/type_methods.rb +228 -228
  13. data/lib/solargraph/complex_type/unique_type.rb +482 -482
  14. data/lib/solargraph/complex_type.rb +444 -444
  15. data/lib/solargraph/convention/data_definition/data_assignment_node.rb +61 -61
  16. data/lib/solargraph/convention/data_definition/data_definition_node.rb +91 -91
  17. data/lib/solargraph/convention/data_definition.rb +105 -105
  18. data/lib/solargraph/convention/gemfile.rb +15 -15
  19. data/lib/solargraph/convention/gemspec.rb +23 -23
  20. data/lib/solargraph/convention/rakefile.rb +17 -17
  21. data/lib/solargraph/convention/struct_definition/struct_assignment_node.rb +61 -61
  22. data/lib/solargraph/convention/struct_definition/struct_definition_node.rb +102 -102
  23. data/lib/solargraph/convention/struct_definition.rb +164 -164
  24. data/lib/solargraph/convention.rb +78 -78
  25. data/lib/solargraph/converters/dd.rb +17 -17
  26. data/lib/solargraph/converters/dl.rb +15 -15
  27. data/lib/solargraph/converters/dt.rb +15 -15
  28. data/lib/solargraph/converters/misc.rb +1 -1
  29. data/lib/solargraph/diagnostics/require_not_found.rb +53 -53
  30. data/lib/solargraph/diagnostics/rubocop.rb +118 -118
  31. data/lib/solargraph/diagnostics/rubocop_helpers.rb +68 -68
  32. data/lib/solargraph/diagnostics/type_check.rb +55 -55
  33. data/lib/solargraph/diagnostics/update_errors.rb +41 -41
  34. data/lib/solargraph/doc_map.rb +439 -439
  35. data/lib/solargraph/equality.rb +34 -34
  36. data/lib/solargraph/gem_pins.rb +98 -98
  37. data/lib/solargraph/language_server/error_codes.rb +20 -20
  38. data/lib/solargraph/language_server/host/diagnoser.rb +89 -89
  39. data/lib/solargraph/language_server/host/dispatch.rb +130 -130
  40. data/lib/solargraph/language_server/host/message_worker.rb +112 -112
  41. data/lib/solargraph/language_server/host/sources.rb +99 -99
  42. data/lib/solargraph/language_server/host.rb +878 -878
  43. data/lib/solargraph/language_server/message/base.rb +97 -97
  44. data/lib/solargraph/language_server/message/client/register_capability.rb +15 -15
  45. data/lib/solargraph/language_server/message/completion_item/resolve.rb +60 -60
  46. data/lib/solargraph/language_server/message/extended/check_gem_version.rb +114 -114
  47. data/lib/solargraph/language_server/message/extended/document.rb +23 -23
  48. data/lib/solargraph/language_server/message/extended/document_gems.rb +32 -32
  49. data/lib/solargraph/language_server/message/extended/download_core.rb +19 -19
  50. data/lib/solargraph/language_server/message/extended/search.rb +20 -20
  51. data/lib/solargraph/language_server/message/initialize.rb +191 -191
  52. data/lib/solargraph/language_server/message/text_document/completion.rb +56 -56
  53. data/lib/solargraph/language_server/message/text_document/definition.rb +40 -40
  54. data/lib/solargraph/language_server/message/text_document/document_highlight.rb +16 -16
  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 -148
  57. data/lib/solargraph/language_server/message/text_document/hover.rb +58 -58
  58. data/lib/solargraph/language_server/message/text_document/prepare_rename.rb +11 -11
  59. data/lib/solargraph/language_server/message/text_document/references.rb +16 -16
  60. data/lib/solargraph/language_server/message/text_document/rename.rb +19 -19
  61. data/lib/solargraph/language_server/message/text_document/signature_help.rb +24 -24
  62. data/lib/solargraph/language_server/message/text_document/type_definition.rb +25 -25
  63. data/lib/solargraph/language_server/message/workspace/did_change_configuration.rb +35 -35
  64. data/lib/solargraph/language_server/message/workspace/did_change_watched_files.rb +40 -40
  65. data/lib/solargraph/language_server/message/workspace/did_change_workspace_folders.rb +26 -26
  66. data/lib/solargraph/language_server/message/workspace/workspace_symbol.rb +23 -23
  67. data/lib/solargraph/language_server/message.rb +94 -94
  68. data/lib/solargraph/language_server/request.rb +27 -27
  69. data/lib/solargraph/language_server/transport/data_reader.rb +74 -74
  70. data/lib/solargraph/language_server/uri_helpers.rb +49 -49
  71. data/lib/solargraph/library.rb +683 -683
  72. data/lib/solargraph/location.rb +82 -82
  73. data/lib/solargraph/logging.rb +37 -37
  74. data/lib/solargraph/page.rb +92 -92
  75. data/lib/solargraph/parser/comment_ripper.rb +69 -69
  76. data/lib/solargraph/parser/flow_sensitive_typing.rb +255 -255
  77. data/lib/solargraph/parser/node_processor/base.rb +92 -92
  78. data/lib/solargraph/parser/node_processor.rb +62 -62
  79. data/lib/solargraph/parser/parser_gem/class_methods.rb +149 -149
  80. data/lib/solargraph/parser/parser_gem/flawed_builder.rb +19 -19
  81. data/lib/solargraph/parser/parser_gem/node_chainer.rb +166 -166
  82. data/lib/solargraph/parser/parser_gem/node_methods.rb +486 -486
  83. data/lib/solargraph/parser/parser_gem/node_processors/and_node.rb +22 -22
  84. data/lib/solargraph/parser/parser_gem/node_processors/args_node.rb +59 -59
  85. data/lib/solargraph/parser/parser_gem/node_processors/begin_node.rb +15 -15
  86. data/lib/solargraph/parser/parser_gem/node_processors/block_node.rb +46 -46
  87. data/lib/solargraph/parser/parser_gem/node_processors/def_node.rb +53 -53
  88. data/lib/solargraph/parser/parser_gem/node_processors/defs_node.rb +37 -37
  89. data/lib/solargraph/parser/parser_gem/node_processors/if_node.rb +23 -23
  90. data/lib/solargraph/parser/parser_gem/node_processors/ivasgn_node.rb +40 -40
  91. data/lib/solargraph/parser/parser_gem/node_processors/lvasgn_node.rb +29 -29
  92. data/lib/solargraph/parser/parser_gem/node_processors/masgn_node.rb +59 -59
  93. data/lib/solargraph/parser/parser_gem/node_processors/opasgn_node.rb +98 -98
  94. data/lib/solargraph/parser/parser_gem/node_processors/orasgn_node.rb +17 -17
  95. data/lib/solargraph/parser/parser_gem/node_processors/resbody_node.rb +38 -38
  96. data/lib/solargraph/parser/parser_gem/node_processors/sclass_node.rb +52 -52
  97. data/lib/solargraph/parser/parser_gem/node_processors/send_node.rb +291 -291
  98. data/lib/solargraph/parser/parser_gem/node_processors/until_node.rb +29 -29
  99. data/lib/solargraph/parser/parser_gem/node_processors/while_node.rb +29 -29
  100. data/lib/solargraph/parser/parser_gem/node_processors.rb +70 -70
  101. data/lib/solargraph/parser/parser_gem.rb +12 -12
  102. data/lib/solargraph/parser/region.rb +69 -69
  103. data/lib/solargraph/parser/snippet.rb +17 -17
  104. data/lib/solargraph/parser.rb +23 -23
  105. data/lib/solargraph/pin/base.rb +729 -729
  106. data/lib/solargraph/pin/base_variable.rb +126 -126
  107. data/lib/solargraph/pin/block.rb +104 -104
  108. data/lib/solargraph/pin/breakable.rb +9 -9
  109. data/lib/solargraph/pin/callable.rb +231 -231
  110. data/lib/solargraph/pin/closure.rb +72 -72
  111. data/lib/solargraph/pin/common.rb +79 -79
  112. data/lib/solargraph/pin/constant.rb +45 -45
  113. data/lib/solargraph/pin/conversions.rb +123 -123
  114. data/lib/solargraph/pin/delegated_method.rb +120 -120
  115. data/lib/solargraph/pin/documenting.rb +114 -114
  116. data/lib/solargraph/pin/instance_variable.rb +34 -34
  117. data/lib/solargraph/pin/keyword.rb +20 -20
  118. data/lib/solargraph/pin/local_variable.rb +75 -75
  119. data/lib/solargraph/pin/method.rb +672 -672
  120. data/lib/solargraph/pin/method_alias.rb +34 -34
  121. data/lib/solargraph/pin/namespace.rb +115 -115
  122. data/lib/solargraph/pin/parameter.rb +275 -275
  123. data/lib/solargraph/pin/proxy_type.rb +39 -39
  124. data/lib/solargraph/pin/reference/override.rb +47 -47
  125. data/lib/solargraph/pin/reference/superclass.rb +15 -15
  126. data/lib/solargraph/pin/reference.rb +39 -39
  127. data/lib/solargraph/pin/search.rb +61 -61
  128. data/lib/solargraph/pin/signature.rb +61 -61
  129. data/lib/solargraph/pin/symbol.rb +53 -53
  130. data/lib/solargraph/pin/until.rb +18 -18
  131. data/lib/solargraph/pin/while.rb +18 -18
  132. data/lib/solargraph/pin.rb +44 -44
  133. data/lib/solargraph/pin_cache.rb +245 -245
  134. data/lib/solargraph/position.rb +132 -119
  135. data/lib/solargraph/range.rb +112 -112
  136. data/lib/solargraph/rbs_map/conversions.rb +823 -823
  137. data/lib/solargraph/rbs_map/core_fills.rb +84 -84
  138. data/lib/solargraph/rbs_map/core_map.rb +58 -58
  139. data/lib/solargraph/rbs_map/stdlib_map.rb +43 -43
  140. data/lib/solargraph/rbs_map.rb +163 -163
  141. data/lib/solargraph/server_methods.rb +16 -16
  142. data/lib/solargraph/shell.rb +363 -352
  143. data/lib/solargraph/source/chain/array.rb +37 -37
  144. data/lib/solargraph/source/chain/call.rb +337 -337
  145. data/lib/solargraph/source/chain/class_variable.rb +13 -13
  146. data/lib/solargraph/source/chain/constant.rb +26 -26
  147. data/lib/solargraph/source/chain/global_variable.rb +13 -13
  148. data/lib/solargraph/source/chain/hash.rb +34 -34
  149. data/lib/solargraph/source/chain/if.rb +28 -28
  150. data/lib/solargraph/source/chain/instance_variable.rb +13 -13
  151. data/lib/solargraph/source/chain/link.rb +109 -109
  152. data/lib/solargraph/source/chain/literal.rb +48 -48
  153. data/lib/solargraph/source/chain/or.rb +23 -23
  154. data/lib/solargraph/source/chain/q_call.rb +11 -11
  155. data/lib/solargraph/source/chain/variable.rb +13 -13
  156. data/lib/solargraph/source/chain/z_super.rb +30 -30
  157. data/lib/solargraph/source/chain.rb +291 -291
  158. data/lib/solargraph/source/change.rb +82 -82
  159. data/lib/solargraph/source/cursor.rb +166 -166
  160. data/lib/solargraph/source/source_chainer.rb +194 -194
  161. data/lib/solargraph/source/updater.rb +55 -55
  162. data/lib/solargraph/source.rb +498 -498
  163. data/lib/solargraph/source_map/clip.rb +226 -226
  164. data/lib/solargraph/source_map/data.rb +34 -34
  165. data/lib/solargraph/source_map/mapper.rb +259 -259
  166. data/lib/solargraph/source_map.rb +212 -212
  167. data/lib/solargraph/type_checker/checks.rb +124 -124
  168. data/lib/solargraph/type_checker/param_def.rb +37 -37
  169. data/lib/solargraph/type_checker/problem.rb +32 -32
  170. data/lib/solargraph/type_checker/rules.rb +84 -84
  171. data/lib/solargraph/type_checker.rb +814 -814
  172. data/lib/solargraph/version.rb +1 -1
  173. data/lib/solargraph/workspace/config.rb +255 -255
  174. data/lib/solargraph/workspace/require_paths.rb +97 -97
  175. data/lib/solargraph/workspace.rb +220 -220
  176. data/lib/solargraph/yard_map/helpers.rb +44 -44
  177. data/lib/solargraph/yard_map/mapper/to_method.rb +130 -130
  178. data/lib/solargraph/yard_map/mapper/to_namespace.rb +31 -31
  179. data/lib/solargraph/yard_map/mapper.rb +79 -79
  180. data/lib/solargraph/yard_map/to_method.rb +89 -89
  181. data/lib/solargraph/yard_tags.rb +20 -20
  182. data/lib/solargraph/yardoc.rb +87 -87
  183. data/lib/solargraph.rb +105 -105
  184. data/rbs_collection.yaml +1 -1
  185. metadata +12 -12
  186. /data/{sig → rbs}/shims/ast/0/node.rbs +0 -0
  187. /data/{sig → rbs}/shims/ast/2.4/.rbs_meta.yaml +0 -0
  188. /data/{sig → rbs}/shims/ast/2.4/ast.rbs +0 -0
  189. /data/{sig → rbs}/shims/parser/3.2.0.1/builders/default.rbs +0 -0
  190. /data/{sig → rbs}/shims/parser/3.2.0.1/manifest.yaml +0 -0
  191. /data/{sig → rbs}/shims/parser/3.2.0.1/parser.rbs +0 -0
  192. /data/{sig → rbs}/shims/parser/3.2.0.1/polyfill.rbs +0 -0
  193. /data/{sig → rbs}/shims/thor/1.2.0.1/.rbs_meta.yaml +0 -0
  194. /data/{sig → rbs}/shims/thor/1.2.0.1/manifest.yaml +0 -0
  195. /data/{sig → rbs}/shims/thor/1.2.0.1/thor.rbs +0 -0
@@ -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,166 +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
- # @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
+ # 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