solargraph 0.56.0 → 0.58.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (191) hide show
  1. checksums.yaml +4 -4
  2. data/.gitattributes +2 -0
  3. data/.github/workflows/linting.yml +127 -0
  4. data/.github/workflows/plugins.yml +183 -7
  5. data/.github/workflows/rspec.yml +55 -5
  6. data/.github/workflows/typecheck.yml +6 -3
  7. data/.gitignore +6 -0
  8. data/.overcommit.yml +72 -0
  9. data/.rspec +1 -0
  10. data/.rubocop.yml +66 -0
  11. data/.rubocop_todo.yml +1279 -0
  12. data/.yardopts +1 -0
  13. data/CHANGELOG.md +92 -1
  14. data/README.md +8 -4
  15. data/Rakefile +125 -13
  16. data/bin/solargraph +3 -0
  17. data/lib/solargraph/api_map/cache.rb +110 -109
  18. data/lib/solargraph/api_map/constants.rb +279 -0
  19. data/lib/solargraph/api_map/index.rb +193 -175
  20. data/lib/solargraph/api_map/source_to_yard.rb +97 -88
  21. data/lib/solargraph/api_map/store.rb +384 -266
  22. data/lib/solargraph/api_map.rb +945 -973
  23. data/lib/solargraph/bench.rb +1 -0
  24. data/lib/solargraph/complex_type/type_methods.rb +228 -222
  25. data/lib/solargraph/complex_type/unique_type.rb +482 -475
  26. data/lib/solargraph/complex_type.rb +444 -423
  27. data/lib/solargraph/convention/active_support_concern.rb +111 -0
  28. data/lib/solargraph/convention/base.rb +17 -0
  29. data/lib/solargraph/convention/data_definition/data_assignment_node.rb +61 -0
  30. data/lib/solargraph/convention/data_definition/data_definition_node.rb +91 -0
  31. data/lib/solargraph/convention/data_definition.rb +105 -0
  32. data/lib/solargraph/convention/gemspec.rb +3 -2
  33. data/lib/solargraph/convention/struct_definition/struct_assignment_node.rb +61 -60
  34. data/lib/solargraph/convention/struct_definition/struct_definition_node.rb +102 -100
  35. data/lib/solargraph/convention/struct_definition.rb +164 -101
  36. data/lib/solargraph/convention.rb +32 -2
  37. data/lib/solargraph/diagnostics/require_not_found.rb +53 -53
  38. data/lib/solargraph/diagnostics/rubocop.rb +118 -113
  39. data/lib/solargraph/diagnostics/rubocop_helpers.rb +68 -66
  40. data/lib/solargraph/diagnostics/type_check.rb +55 -55
  41. data/lib/solargraph/doc_map.rb +439 -405
  42. data/lib/solargraph/environ.rb +9 -2
  43. data/lib/solargraph/equality.rb +34 -33
  44. data/lib/solargraph/gem_pins.rb +98 -88
  45. data/lib/solargraph/language_server/host/diagnoser.rb +89 -89
  46. data/lib/solargraph/language_server/host/dispatch.rb +130 -128
  47. data/lib/solargraph/language_server/host/message_worker.rb +112 -109
  48. data/lib/solargraph/language_server/host/sources.rb +99 -99
  49. data/lib/solargraph/language_server/host.rb +878 -871
  50. data/lib/solargraph/language_server/message/base.rb +2 -1
  51. data/lib/solargraph/language_server/message/extended/check_gem_version.rb +114 -114
  52. data/lib/solargraph/language_server/message/extended/document.rb +23 -23
  53. data/lib/solargraph/language_server/message/text_document/completion.rb +56 -56
  54. data/lib/solargraph/language_server/message/text_document/definition.rb +40 -38
  55. data/lib/solargraph/language_server/message/text_document/document_symbol.rb +26 -26
  56. data/lib/solargraph/language_server/message/text_document/formatting.rb +148 -131
  57. data/lib/solargraph/language_server/message/text_document/hover.rb +58 -58
  58. data/lib/solargraph/language_server/message/text_document/signature_help.rb +24 -24
  59. data/lib/solargraph/language_server/message/text_document/type_definition.rb +25 -24
  60. data/lib/solargraph/language_server/message/workspace/did_change_workspace_folders.rb +2 -0
  61. data/lib/solargraph/language_server/message/workspace/workspace_symbol.rb +23 -23
  62. data/lib/solargraph/language_server/progress.rb +8 -0
  63. data/lib/solargraph/language_server/request.rb +4 -1
  64. data/lib/solargraph/library.rb +683 -666
  65. data/lib/solargraph/location.rb +82 -79
  66. data/lib/solargraph/logging.rb +37 -28
  67. data/lib/solargraph/page.rb +3 -0
  68. data/lib/solargraph/parser/comment_ripper.rb +69 -62
  69. data/lib/solargraph/parser/flow_sensitive_typing.rb +255 -227
  70. data/lib/solargraph/parser/node_processor/base.rb +92 -87
  71. data/lib/solargraph/parser/node_processor.rb +62 -46
  72. data/lib/solargraph/parser/parser_gem/class_methods.rb +149 -159
  73. data/lib/solargraph/parser/parser_gem/flawed_builder.rb +1 -0
  74. data/lib/solargraph/parser/parser_gem/node_chainer.rb +166 -164
  75. data/lib/solargraph/parser/parser_gem/node_methods.rb +486 -497
  76. data/lib/solargraph/parser/parser_gem/node_processors/and_node.rb +22 -21
  77. data/lib/solargraph/parser/parser_gem/node_processors/args_node.rb +59 -59
  78. data/lib/solargraph/parser/parser_gem/node_processors/begin_node.rb +15 -15
  79. data/lib/solargraph/parser/parser_gem/node_processors/block_node.rb +46 -45
  80. data/lib/solargraph/parser/parser_gem/node_processors/casgn_node.rb +1 -21
  81. data/lib/solargraph/parser/parser_gem/node_processors/def_node.rb +53 -53
  82. data/lib/solargraph/parser/parser_gem/node_processors/if_node.rb +23 -21
  83. data/lib/solargraph/parser/parser_gem/node_processors/ivasgn_node.rb +40 -40
  84. data/lib/solargraph/parser/parser_gem/node_processors/lvasgn_node.rb +29 -29
  85. data/lib/solargraph/parser/parser_gem/node_processors/masgn_node.rb +59 -53
  86. data/lib/solargraph/parser/parser_gem/node_processors/namespace_node.rb +0 -22
  87. data/lib/solargraph/parser/parser_gem/node_processors/opasgn_node.rb +98 -41
  88. data/lib/solargraph/parser/parser_gem/node_processors/orasgn_node.rb +17 -16
  89. data/lib/solargraph/parser/parser_gem/node_processors/resbody_node.rb +38 -37
  90. data/lib/solargraph/parser/parser_gem/node_processors/sclass_node.rb +52 -43
  91. data/lib/solargraph/parser/parser_gem/node_processors/send_node.rb +291 -271
  92. data/lib/solargraph/parser/parser_gem/node_processors/sym_node.rb +1 -0
  93. data/lib/solargraph/parser/parser_gem/node_processors/while_node.rb +29 -29
  94. data/lib/solargraph/parser/parser_gem/node_processors.rb +70 -66
  95. data/lib/solargraph/parser/region.rb +69 -66
  96. data/lib/solargraph/parser/snippet.rb +17 -15
  97. data/lib/solargraph/pin/base.rb +729 -651
  98. data/lib/solargraph/pin/base_variable.rb +126 -125
  99. data/lib/solargraph/pin/block.rb +104 -103
  100. data/lib/solargraph/pin/breakable.rb +9 -9
  101. data/lib/solargraph/pin/callable.rb +231 -218
  102. data/lib/solargraph/pin/closure.rb +72 -74
  103. data/lib/solargraph/pin/common.rb +79 -75
  104. data/lib/solargraph/pin/constant.rb +2 -0
  105. data/lib/solargraph/pin/conversions.rb +123 -123
  106. data/lib/solargraph/pin/delegated_method.rb +120 -120
  107. data/lib/solargraph/pin/documenting.rb +114 -114
  108. data/lib/solargraph/pin/instance_variable.rb +34 -34
  109. data/lib/solargraph/pin/keyword.rb +20 -20
  110. data/lib/solargraph/pin/local_variable.rb +75 -76
  111. data/lib/solargraph/pin/method.rb +672 -651
  112. data/lib/solargraph/pin/method_alias.rb +34 -31
  113. data/lib/solargraph/pin/namespace.rb +115 -115
  114. data/lib/solargraph/pin/parameter.rb +275 -261
  115. data/lib/solargraph/pin/proxy_type.rb +39 -35
  116. data/lib/solargraph/pin/reference/override.rb +47 -33
  117. data/lib/solargraph/pin/reference/superclass.rb +15 -10
  118. data/lib/solargraph/pin/reference.rb +39 -22
  119. data/lib/solargraph/pin/search.rb +61 -56
  120. data/lib/solargraph/pin/signature.rb +61 -59
  121. data/lib/solargraph/pin/symbol.rb +53 -48
  122. data/lib/solargraph/pin/until.rb +18 -18
  123. data/lib/solargraph/pin/while.rb +18 -18
  124. data/lib/solargraph/pin.rb +44 -44
  125. data/lib/solargraph/pin_cache.rb +245 -185
  126. data/lib/solargraph/position.rb +132 -116
  127. data/lib/solargraph/range.rb +112 -107
  128. data/lib/solargraph/rbs_map/conversions.rb +823 -773
  129. data/lib/solargraph/rbs_map/core_fills.rb +18 -0
  130. data/lib/solargraph/rbs_map/core_map.rb +58 -51
  131. data/lib/solargraph/rbs_map/stdlib_map.rb +43 -43
  132. data/lib/solargraph/rbs_map.rb +163 -150
  133. data/lib/solargraph/shell.rb +352 -268
  134. data/lib/solargraph/source/chain/call.rb +337 -333
  135. data/lib/solargraph/source/chain/constant.rb +26 -89
  136. data/lib/solargraph/source/chain/hash.rb +34 -34
  137. data/lib/solargraph/source/chain/if.rb +28 -28
  138. data/lib/solargraph/source/chain/instance_variable.rb +13 -13
  139. data/lib/solargraph/source/chain/link.rb +11 -2
  140. data/lib/solargraph/source/chain/literal.rb +48 -48
  141. data/lib/solargraph/source/chain/or.rb +23 -23
  142. data/lib/solargraph/source/chain.rb +291 -282
  143. data/lib/solargraph/source/change.rb +82 -82
  144. data/lib/solargraph/source/cursor.rb +166 -167
  145. data/lib/solargraph/source/encoding_fixes.rb +23 -23
  146. data/lib/solargraph/source/source_chainer.rb +194 -194
  147. data/lib/solargraph/source/updater.rb +55 -55
  148. data/lib/solargraph/source.rb +498 -495
  149. data/lib/solargraph/source_map/clip.rb +226 -234
  150. data/lib/solargraph/source_map/data.rb +34 -30
  151. data/lib/solargraph/source_map/mapper.rb +259 -259
  152. data/lib/solargraph/source_map.rb +212 -200
  153. data/lib/solargraph/type_checker/checks.rb +124 -124
  154. data/lib/solargraph/type_checker/param_def.rb +37 -35
  155. data/lib/solargraph/type_checker/problem.rb +32 -32
  156. data/lib/solargraph/type_checker/rules.rb +84 -62
  157. data/lib/solargraph/type_checker.rb +814 -699
  158. data/lib/solargraph/version.rb +5 -5
  159. data/lib/solargraph/workspace/config.rb +255 -239
  160. data/lib/solargraph/workspace/require_paths.rb +97 -0
  161. data/lib/solargraph/workspace.rb +220 -249
  162. data/lib/solargraph/yard_map/helpers.rb +44 -16
  163. data/lib/solargraph/yard_map/mapper/to_constant.rb +5 -5
  164. data/lib/solargraph/yard_map/mapper/to_method.rb +130 -134
  165. data/lib/solargraph/yard_map/mapper/to_namespace.rb +31 -30
  166. data/lib/solargraph/yard_map/mapper.rb +79 -79
  167. data/lib/solargraph/yard_map/to_method.rb +89 -88
  168. data/lib/solargraph/yardoc.rb +87 -49
  169. data/lib/solargraph.rb +105 -90
  170. data/rbs/fills/bundler/0/bundler.rbs +4271 -0
  171. data/rbs/fills/open3/0/open3.rbs +172 -0
  172. data/rbs/fills/rubygems/0/basic_specification.rbs +326 -0
  173. data/rbs/fills/rubygems/0/errors.rbs +364 -0
  174. data/rbs/fills/rubygems/0/spec_fetcher.rbs +107 -0
  175. data/rbs/fills/rubygems/0/specification.rbs +1753 -0
  176. data/rbs/fills/{tuple.rbs → tuple/tuple.rbs} +2 -3
  177. data/rbs/shims/ast/0/node.rbs +5 -0
  178. data/rbs/shims/ast/2.4/.rbs_meta.yaml +9 -0
  179. data/rbs/shims/ast/2.4/ast.rbs +73 -0
  180. data/rbs/shims/parser/3.2.0.1/builders/default.rbs +195 -0
  181. data/rbs/shims/parser/3.2.0.1/manifest.yaml +7 -0
  182. data/rbs/shims/parser/3.2.0.1/parser.rbs +201 -0
  183. data/rbs/shims/parser/3.2.0.1/polyfill.rbs +4 -0
  184. data/rbs/shims/thor/1.2.0.1/.rbs_meta.yaml +9 -0
  185. data/rbs/shims/thor/1.2.0.1/manifest.yaml +7 -0
  186. data/rbs/shims/thor/1.2.0.1/thor.rbs +17 -0
  187. data/rbs_collection.yaml +4 -4
  188. data/solargraph.gemspec +26 -5
  189. metadata +187 -15
  190. data/lib/.rubocop.yml +0 -22
  191. data/lib/solargraph/parser/node_methods.rb +0 -97
@@ -1,116 +1,132 @@
1
- # frozen_string_literal: true
2
-
3
- module Solargraph
4
- # The zero-based line and column numbers of a position in a string.
5
- #
6
- class Position
7
- include Equality
8
-
9
- # @return [Integer]
10
- attr_reader :line
11
-
12
- # @return [Integer]
13
- attr_reader :character
14
-
15
- alias column character
16
-
17
- # @param line [Integer]
18
- # @param character [Integer]
19
- def initialize line, character
20
- @line = line
21
- @character = character
22
- end
23
-
24
- # @sg-ignore Fix "Not enough arguments to Module#protected"
25
- protected def equality_fields
26
- [line, character]
27
- end
28
-
29
- def <=>(other)
30
- return nil unless other.is_a?(Position)
31
- if line == other.line
32
- character <=> other.character
33
- else
34
- line <=> other.line
35
- end
36
- end
37
-
38
- # Get a hash of the position. This representation is suitable for use in
39
- # the language server protocol.
40
- #
41
- # @return [Hash]
42
- def to_hash
43
- {
44
- line: line,
45
- character: character
46
- }
47
- end
48
-
49
- def inspect
50
- "#<#{self.class} #{line}, #{character}>"
51
- end
52
-
53
- # Get a numeric offset for the specified text and position.
54
- #
55
- # @param text [String]
56
- # @param position [Position]
57
- # @return [Integer]
58
- def self.to_offset text, position
59
- return 0 if text.empty?
60
- text.lines[0...position.line].sum(&:length) + position.character
61
- end
62
-
63
- # Get a numeric offset for the specified text and a position identified
64
- # by its line and character.
65
- #
66
- # @param text [String]
67
- # @param line [Integer]
68
- # @param character [Integer]
69
- # @return [Integer]
70
- def self.line_char_to_offset text, line, character
71
- to_offset(text, Position.new(line, character))
72
- end
73
-
74
- # Get a position for the specified text and offset.
75
- #
76
- # @param text [String]
77
- # @param offset [Integer]
78
- # @return [Position]
79
- def self.from_offset text, offset
80
- cursor = 0
81
- line = 0
82
- character = nil
83
- text.lines.each do |l|
84
- line_length = l.length
85
- char_length = l.chomp.length
86
- if cursor + char_length >= offset
87
- character = offset - cursor
88
- break
89
- end
90
- cursor += line_length
91
- line += 1
92
- end
93
- character = 0 if character.nil? and (cursor - offset).between?(0, 1)
94
- raise InvalidOffsetError if character.nil?
95
- Position.new(line, character)
96
- end
97
-
98
- # A helper method for generating positions from arrays of integers. The
99
- # original parameter is returned if it is already a position.
100
- #
101
- # @raise [ArgumentError] if the object cannot be converted to a position.
102
- #
103
- # @param object [Position, Array(Integer, Integer)]
104
- # @return [Position]
105
- def self.normalize object
106
- return object if object.is_a?(Position)
107
- return Position.new(object[0], object[1]) if object.is_a?(Array)
108
- raise ArgumentError, "Unable to convert #{object.class} to Position"
109
- end
110
-
111
- def == other
112
- return false unless other.is_a?(Position)
113
- line == other.line and character == other.character
114
- end
115
- end
116
- end
1
+ # frozen_string_literal: true
2
+
3
+ module Solargraph
4
+ # The zero-based line and column numbers of a position in a string.
5
+ #
6
+ class Position
7
+ include Equality
8
+
9
+ # @return [Integer]
10
+ attr_reader :line
11
+
12
+ # @return [Integer]
13
+ attr_reader :character
14
+
15
+ alias column character
16
+
17
+ # @param line [Integer]
18
+ # @param character [Integer]
19
+ def initialize line, character
20
+ @line = line
21
+ @character = character
22
+ end
23
+
24
+ # @sg-ignore Fix "Not enough arguments to Module#protected"
25
+ protected def equality_fields
26
+ [line, character]
27
+ end
28
+
29
+ # @param other [Position]
30
+ def <=>(other)
31
+ return nil unless other.is_a?(Position)
32
+ if line == other.line
33
+ character <=> other.character
34
+ else
35
+ line <=> other.line
36
+ end
37
+ end
38
+
39
+ # Get a hash of the position. This representation is suitable for use in
40
+ # the language server protocol.
41
+ #
42
+ # @return [Hash]
43
+ def to_hash
44
+ {
45
+ line: line,
46
+ character: character
47
+ }
48
+ end
49
+
50
+ def inspect
51
+ "#<#{self.class} #{line}, #{character}>"
52
+ end
53
+
54
+ # Get a numeric offset for the specified text and position.
55
+ #
56
+ # @param text [String]
57
+ # @param position [Position]
58
+ # @return [Integer]
59
+ def self.to_offset text, position
60
+ return 0 if text.empty?
61
+
62
+ newline_index = -1
63
+ line = -1
64
+ last_line_index = 0
65
+
66
+ while (newline_index = text.index("\n", newline_index + 1)) && line <= position.line
67
+ line += 1
68
+ break if line == position.line
69
+
70
+ line_length = newline_index - last_line_index
71
+ last_line_index = newline_index
72
+ end
73
+
74
+ last_line_index += 1 if position.line > 0
75
+ last_line_index + position.character
76
+ end
77
+
78
+ # Get a numeric offset for the specified text and a position identified
79
+ # by its line and character.
80
+ #
81
+ # @param text [String]
82
+ # @param line [Integer]
83
+ # @param character [Integer]
84
+ # @return [Integer]
85
+ def self.line_char_to_offset text, line, character
86
+ to_offset(text, Position.new(line, character))
87
+ end
88
+
89
+ # Get a position for the specified text and offset.
90
+ #
91
+ # @raise [InvalidOffsetError] if the offset is outside the text range
92
+ #
93
+ # @param text [String]
94
+ # @param offset [Integer]
95
+ # @return [Position]
96
+ def self.from_offset text, offset
97
+ raise InvalidOffsetError if offset > text.length
98
+
99
+ cursor = 0
100
+ line = 0
101
+ character = offset
102
+ newline_index = -1
103
+
104
+ while (newline_index = text.index("\n", newline_index + 1)) && newline_index < offset
105
+ line += 1
106
+ character = offset - newline_index - 1
107
+ end
108
+ character = 0 if character.nil? and (cursor - offset).between?(0, 1)
109
+ raise InvalidOffsetError if character.nil?
110
+ Position.new(line, character)
111
+ end
112
+
113
+ # A helper method for generating positions from arrays of integers. The
114
+ # original parameter is returned if it is already a position.
115
+ #
116
+ # @raise [ArgumentError] if the object cannot be converted to a position.
117
+ #
118
+ # @param object [Position, Array(Integer, Integer)]
119
+ # @return [Position]
120
+ def self.normalize object
121
+ return object if object.is_a?(Position)
122
+ return Position.new(object[0], object[1]) if object.is_a?(Array)
123
+ raise ArgumentError, "Unable to convert #{object.class} to Position"
124
+ end
125
+
126
+ def == other
127
+ return false unless other.is_a?(Position)
128
+ # @sg-ignore https://github.com/castwide/solargraph/pull/1114
129
+ line == other.line and character == other.character
130
+ end
131
+ end
132
+ end
@@ -1,107 +1,112 @@
1
- # frozen_string_literal: true
2
-
3
- module Solargraph
4
- # A pair of Positions that compose a section of text in code.
5
- #
6
- class Range
7
- include Equality
8
-
9
- # @return [Position]
10
- attr_reader :start
11
-
12
- # @return [Position]
13
- attr_reader :ending
14
-
15
- # @param start [Position]
16
- # @param ending [Position]
17
- def initialize start, ending
18
- @start = start
19
- @ending = ending
20
- end
21
-
22
- # @sg-ignore Fix "Not enough arguments to Module#protected"
23
- protected def equality_fields
24
- [start, ending]
25
- end
26
-
27
- def <=>(other)
28
- return nil unless other.is_a?(Range)
29
- if start == other.start
30
- ending <=> other.ending
31
- else
32
- start <=> other.start
33
- end
34
- end
35
-
36
- # Get a hash of the range. This representation is suitable for use in
37
- # the language server protocol.
38
- #
39
- # @return [Hash<Symbol, Position>]
40
- def to_hash
41
- {
42
- start: start.to_hash,
43
- end: ending.to_hash
44
- }
45
- end
46
-
47
- # True if the specified position is inside the range.
48
- #
49
- # @param position [Position, Array(Integer, Integer)]
50
- # @return [Boolean]
51
- def contain? position
52
- position = Position.normalize(position)
53
- return false if position.line < start.line || position.line > ending.line
54
- return false if position.line == start.line && position.character < start.character
55
- return false if position.line == ending.line && position.character > ending.character
56
- true
57
- end
58
-
59
- # True if the range contains the specified position and the position does not precede it.
60
- #
61
- # @param position [Position, Array(Integer, Integer)]
62
- # @return [Boolean]
63
- def include? position
64
- position = Position.normalize(position)
65
- contain?(position) && !(position.line == start.line && position.character == start.character)
66
- end
67
-
68
- # Create a range from a pair of lines and characters.
69
- #
70
- # @param l1 [Integer] Starting line
71
- # @param c1 [Integer] Starting character
72
- # @param l2 [Integer] Ending line
73
- # @param c2 [Integer] Ending character
74
- # @return [Range]
75
- def self.from_to l1, c1, l2, c2
76
- Range.new(Position.new(l1, c1), Position.new(l2, c2))
77
- end
78
-
79
- # Get a range from a node.
80
- #
81
- # @param node [Parser::AST::Node]
82
- # @return [Range, nil]
83
- def self.from_node node
84
- if node&.loc && node.loc.expression
85
- from_expr(node.loc.expression)
86
- end
87
- end
88
-
89
- # Get a range from a Parser range, usually found in
90
- # Parser::AST::Node#location#expression.
91
- #
92
- # @param expr [Parser::Source::Range]
93
- # @return [Range]
94
- def self.from_expr expr
95
- from_to(expr.line, expr.column, expr.last_line, expr.last_column)
96
- end
97
-
98
- def == other
99
- return false unless other.is_a?(Range)
100
- start == other.start && ending == other.ending
101
- end
102
-
103
- def inspect
104
- "#<#{self.class} #{start.inspect} to #{ending.inspect}>"
105
- end
106
- end
107
- end
1
+ # frozen_string_literal: true
2
+
3
+ module Solargraph
4
+ # A pair of Positions that compose a section of text in code.
5
+ #
6
+ class Range
7
+ include Equality
8
+
9
+ # @return [Position]
10
+ attr_reader :start
11
+
12
+ # @return [Position]
13
+ attr_reader :ending
14
+
15
+ # @param start [Position]
16
+ # @param ending [Position]
17
+ def initialize start, ending
18
+ @start = start
19
+ @ending = ending
20
+ end
21
+
22
+ # @sg-ignore Fix "Not enough arguments to Module#protected"
23
+ protected def equality_fields
24
+ [start, ending]
25
+ end
26
+
27
+ # @param other [BasicObject]
28
+ def <=>(other)
29
+ return nil unless other.is_a?(Range)
30
+ # @sg-ignore https://github.com/castwide/solargraph/pull/1114
31
+ if start == other.start
32
+ # @sg-ignore https://github.com/castwide/solargraph/pull/1114
33
+ ending <=> other.ending
34
+ else
35
+ # @sg-ignore https://github.com/castwide/solargraph/pull/1114
36
+ start <=> other.start
37
+ end
38
+ end
39
+
40
+ # Get a hash of the range. This representation is suitable for use in
41
+ # the language server protocol.
42
+ #
43
+ # @return [Hash<Symbol, Position>]
44
+ def to_hash
45
+ {
46
+ start: start.to_hash,
47
+ end: ending.to_hash
48
+ }
49
+ end
50
+
51
+ # True if the specified position is inside the range.
52
+ #
53
+ # @param position [Position, Array(Integer, Integer)]
54
+ # @return [Boolean]
55
+ def contain? position
56
+ position = Position.normalize(position)
57
+ return false if position.line < start.line || position.line > ending.line
58
+ return false if position.line == start.line && position.character < start.character
59
+ return false if position.line == ending.line && position.character > ending.character
60
+ true
61
+ end
62
+
63
+ # True if the range contains the specified position and the position does not precede it.
64
+ #
65
+ # @param position [Position, Array(Integer, Integer)]
66
+ # @return [Boolean]
67
+ def include? position
68
+ position = Position.normalize(position)
69
+ contain?(position) && !(position.line == start.line && position.character == start.character)
70
+ end
71
+
72
+ # Create a range from a pair of lines and characters.
73
+ #
74
+ # @param l1 [Integer] Starting line
75
+ # @param c1 [Integer] Starting character
76
+ # @param l2 [Integer] Ending line
77
+ # @param c2 [Integer] Ending character
78
+ # @return [Range]
79
+ def self.from_to l1, c1, l2, c2
80
+ Range.new(Position.new(l1, c1), Position.new(l2, c2))
81
+ end
82
+
83
+ # Get a range from a node.
84
+ #
85
+ # @param node [Parser::AST::Node]
86
+ # @return [Range, nil]
87
+ def self.from_node node
88
+ if node&.loc && node.loc.expression
89
+ from_expr(node.loc.expression)
90
+ end
91
+ end
92
+
93
+ # Get a range from a Parser range, usually found in
94
+ # Parser::AST::Node#location#expression.
95
+ #
96
+ # @param expr [Parser::Source::Range]
97
+ # @return [Range]
98
+ def self.from_expr expr
99
+ from_to(expr.line, expr.column, expr.last_line, expr.last_column)
100
+ end
101
+
102
+ def == other
103
+ return false unless other.is_a?(Range)
104
+ # @sg-ignore https://github.com/castwide/solargraph/pull/1114
105
+ start == other.start && ending == other.ending
106
+ end
107
+
108
+ def inspect
109
+ "#<#{self.class} #{start.inspect} to #{ending.inspect}>"
110
+ end
111
+ end
112
+ end