solargraph 0.58.0 → 0.59.0

data/lib/solargraph/position.rb

@@ -1,119 +1,139 @@
-# frozen_string_literal: true
-
-module Solargraph
-  # The zero-based line and column numbers of a position in a string.
-  #
-  class Position
-    include Equality
-
-    # @return [Integer]
-    attr_reader :line
-
-    # @return [Integer]
-    attr_reader :character
-
-    alias column character
-
-    # @param line [Integer]
-    # @param character [Integer]
-    def initialize line, character
-      @line = line
-      @character = character
-    end
-
-    # @sg-ignore Fix "Not enough arguments to Module#protected"
-    protected def equality_fields
-      [line, character]
-    end
-
-    # @param other [Position]
-    def <=>(other)
-      return nil unless other.is_a?(Position)
-      if line == other.line
-        character <=> other.character
-      else
-        line <=> other.line
-      end
-    end
-
-    # Get a hash of the position. This representation is suitable for use in
-    # the language server protocol.
-    #
-    # @return [Hash]
-    def to_hash
-      {
-        line: line,
-        character: character
-      }
-    end
-
-    def inspect
-      "#<#{self.class} #{line}, #{character}>"
-    end
-
-    # Get a numeric offset for the specified text and position.
-    #
-    # @param text [String]
-    # @param position [Position]
-    # @return [Integer]
-    def self.to_offset text, position
-      return 0 if text.empty?
-      # @sg-ignore Unresolved call to + on Integer
-      text.lines[0...position.line].sum(&:length) + position.character
-    end
-
-    # Get a numeric offset for the specified text and a position identified
-    # by its line and character.
-    #
-    # @param text [String]
-    # @param line [Integer]
-    # @param character [Integer]
-    # @return [Integer]
-    def self.line_char_to_offset text, line, character
-      to_offset(text, Position.new(line, character))
-    end
-
-    # Get a position for the specified text and offset.
-    #
-    # @param text [String]
-    # @param offset [Integer]
-    # @return [Position]
-    def self.from_offset text, offset
-      cursor = 0
-      line = 0
-      character = nil
-      text.lines.each do |l|
-        line_length = l.length
-        char_length = l.chomp.length
-        if cursor + char_length >= offset
-          character = offset - cursor
-          break
-        end
-        cursor += line_length
-        line += 1
-      end
-      character = 0 if character.nil? and (cursor - offset).between?(0, 1)
-      raise InvalidOffsetError if character.nil?
-      Position.new(line, character)
-    end
-
-    # A helper method for generating positions from arrays of integers. The
-    # original parameter is returned if it is already a position.
-    #
-    # @raise [ArgumentError] if the object cannot be converted to a position.
-    #
-    # @param object [Position, Array(Integer, Integer)]
-    # @return [Position]
-    def self.normalize object
-      return object if object.is_a?(Position)
-      return Position.new(object[0], object[1]) if object.is_a?(Array)
-      raise ArgumentError, "Unable to convert #{object.class} to Position"
-    end
-
-    def == other
-      return false unless other.is_a?(Position)
-      # @sg-ignore https://github.com/castwide/solargraph/pull/1114
-      line == other.line and character == other.character
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  # The zero-based line and column numbers of a position in a string.
+  #
+  class Position
+    include Equality
+
+    # @return [Integer]
+    attr_reader :line
+
+    # @return [Integer]
+    attr_reader :character
+
+    alias column character
+
+    # @param line [Integer]
+    # @param character [Integer]
+    def initialize line, character
+      @line = line
+      @character = character
+    end
+
+    # @param other [Position]
+    def <=> other
+      return nil unless other.is_a?(Position)
+      if line == other.line
+        character <=> other.character
+      else
+        line <=> other.line
+      end
+    end
+
+    # Get a hash of the position. This representation is suitable for use in
+    # the language server protocol.
+    #
+    # @return [Hash]
+    def to_hash
+      {
+        line: line,
+        character: character
+      }
+    end
+
+    def inspect
+      "#<#{self.class} #{line}, #{character}>"
+    end
+
+    # Get a numeric offset for the specified text and position.
+    #
+    # @param text [String]
+    # @param position [Position]
+    # @return [Integer]
+    def self.to_offset text, position
+      return 0 if text.empty?
+
+      newline_index = -1
+      line = -1
+      last_line_index = 0
+
+      # @sg-ignore Typechecker thinks `newline_index` inside of the assignment
+      #   can be nil
+      while (newline_index = text.index("\n", newline_index + 1)) && line <= position.line
+        line += 1
+        break if line == position.line
+
+        last_line_index = newline_index
+      end
+
+      last_line_index += 1 if position.line.positive?
+      # @sg-ignore `last_line_index` is always an Integer because `newline_index`
+      #   is never nil inside the while block
+      last_line_index + position.character
+    end
+
+    # Get a numeric offset for the specified text and a position identified
+    # by its line and character.
+    #
+    # @param text [String]
+    # @param line [Integer]
+    # @param character [Integer]
+    # @return [Integer]
+    def self.line_char_to_offset text, line, character
+      to_offset(text, Position.new(line, character))
+    end
+
+    # Get a position for the specified text and offset.
+    #
+    # @raise [InvalidOffsetError] if the offset is outside the text range
+    #
+    # @param text [String]
+    # @param offset [Integer]
+    # @return [Position]
+    def self.from_offset text, offset
+      raise InvalidOffsetError if offset > text.length
+
+      cursor = 0
+      line = 0
+      character = offset
+      newline_index = -1
+
+      # @sg-ignore Typechecker thinks `newline_index` inside of the assignment
+      #   can be nil
+      while (newline_index = text.index("\n", newline_index + 1)) && newline_index < offset
+        line += 1
+        # @sg-ignore `newline_index` is always an Integer inside the while block
+        character = offset - newline_index - 1
+      end
+      character = 0 if character.nil? && (cursor - offset).between?(0, 1)
+      raise InvalidOffsetError if character.nil?
+      # @sg-ignore flow sensitive typing needs to handle 'raise if'
+      Position.new(line, character)
+    end
+
+    # A helper method for generating positions from arrays of integers. The
+    # original parameter is returned if it is already a position.
+    #
+    # @raise [ArgumentError] if the object cannot be converted to a position.
+    #
+    # @param object [Position, Array(Integer, Integer)]
+    # @return [Position]
+    def self.normalize object
+      return object if object.is_a?(Position)
+      return Position.new(object[0], object[1]) if object.is_a?(Array)
+      raise ArgumentError, "Unable to convert #{object.class} to Position"
+    end
+
+    def == other
+      return false unless other.is_a?(Position)
+      line == other.line and character == other.character
+    end
+
+    protected
+
+    def equality_fields
+      [line, character]
+    end
+  end
+end

data/lib/solargraph/range.rb

@@ -1,112 +1,113 @@
-# frozen_string_literal: true
-
-module Solargraph
-  # A pair of Positions that compose a section of text in code.
-  #
-  class Range
-    include Equality
-
-    # @return [Position]
-    attr_reader :start
-
-    # @return [Position]
-    attr_reader :ending
-
-    # @param start [Position]
-    # @param ending [Position]
-    def initialize start, ending
-      @start = start
-      @ending = ending
-    end
-
-    # @sg-ignore Fix "Not enough arguments to Module#protected"
-    protected def equality_fields
-      [start, ending]
-    end
-
-    # @param other [BasicObject]
-    def <=>(other)
-      return nil unless other.is_a?(Range)
-      # @sg-ignore https://github.com/castwide/solargraph/pull/1114
-      if start == other.start
-        # @sg-ignore https://github.com/castwide/solargraph/pull/1114
-        ending <=> other.ending
-      else
-        # @sg-ignore https://github.com/castwide/solargraph/pull/1114
-        start <=> other.start
-      end
-    end
-
-    # Get a hash of the range. This representation is suitable for use in
-    # the language server protocol.
-    #
-    # @return [Hash<Symbol, Position>]
-    def to_hash
-      {
-        start: start.to_hash,
-        end: ending.to_hash
-      }
-    end
-
-    # True if the specified position is inside the range.
-    #
-    # @param position [Position, Array(Integer, Integer)]
-    # @return [Boolean]
-    def contain? position
-      position = Position.normalize(position)
-      return false if position.line < start.line || position.line > ending.line
-      return false if position.line == start.line && position.character < start.character
-      return false if position.line == ending.line && position.character > ending.character
-      true
-    end
-
-    # True if the range contains the specified position and the position does not precede it.
-    #
-    # @param position [Position, Array(Integer, Integer)]
-    # @return [Boolean]
-    def include? position
-      position = Position.normalize(position)
-      contain?(position) && !(position.line == start.line && position.character == start.character)
-    end
-
-    # Create a range from a pair of lines and characters.
-    #
-    # @param l1 [Integer] Starting line
-    # @param c1 [Integer] Starting character
-    # @param l2 [Integer] Ending line
-    # @param c2 [Integer] Ending character
-    # @return [Range]
-    def self.from_to l1, c1, l2, c2
-      Range.new(Position.new(l1, c1), Position.new(l2, c2))
-    end
-
-    # Get a range from a node.
-    #
-    # @param node [Parser::AST::Node]
-    # @return [Range, nil]
-    def self.from_node node
-      if node&.loc && node.loc.expression
-        from_expr(node.loc.expression)
-      end
-    end
-
-    # Get a range from a Parser range, usually found in
-    # Parser::AST::Node#location#expression.
-    #
-    # @param expr [Parser::Source::Range]
-    # @return [Range]
-    def self.from_expr expr
-      from_to(expr.line, expr.column, expr.last_line, expr.last_column)
-    end
-
-    def == other
-      return false unless other.is_a?(Range)
-      # @sg-ignore https://github.com/castwide/solargraph/pull/1114
-      start == other.start && ending == other.ending
-    end
-
-    def inspect
-      "#<#{self.class} #{start.inspect} to #{ending.inspect}>"
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  # A pair of Positions that compose a section of text in code.
+  #
+  class Range
+    include Equality
+
+    # @return [Position]
+    attr_reader :start
+
+    # @return [Position]
+    attr_reader :ending
+
+    # @param start [Position]
+    # @param ending [Position]
+    def initialize start, ending
+      @start = start
+      @ending = ending
+    end
+
+    # @param other [BasicObject]
+    def <=> other
+      return nil unless other.is_a?(Range)
+      if start == other.start
+        ending <=> other.ending
+      else
+        start <=> other.start
+      end
+    end
+
+    # Get a hash of the range. This representation is suitable for use in
+    # the language server protocol.
+    #
+    # @return [Hash{Symbol => Position}]
+    def to_hash
+      {
+        start: start.to_hash,
+        end: ending.to_hash
+      }
+    end
+
+    # True if the specified position is inside the range.
+    #
+    # @param position [Position, Array(Integer, Integer)]
+    # @return [Boolean]
+    def contain? position
+      position = Position.normalize(position)
+      # @sg-ignore flow sensitive typing should be able to handle redefinition
+      return false if position.line < start.line || position.line > ending.line
+      # @sg-ignore flow sensitive typing should be able to handle redefinition
+      return false if position.line == start.line && position.character < start.character
+      # @sg-ignore flow sensitive typing should be able to handle redefinition
+      return false if position.line == ending.line && position.character > ending.character
+      true
+    end
+
+    # True if the range contains the specified position and the position does not precede it.
+    #
+    # @param position [Position, Array(Integer, Integer)]
+    # @sg-ignore flow sensitive typing should be able to handle redefinition
+    # @return [Boolean]
+    def include? position
+      position = Position.normalize(position)
+      # @sg-ignore flow sensitive typing should be able to handle redefinition
+      contain?(position) && !(position.line == start.line && position.character == start.character)
+    end
+
+    # Create a range from a pair of lines and characters.
+    #
+    # @param l1 [Integer] Starting line
+    # @param c1 [Integer] Starting character
+    # @param l2 [Integer] Ending line
+    # @param c2 [Integer] Ending character
+    # @return [Range]
+    def self.from_to l1, c1, l2, c2
+      Range.new(Position.new(l1, c1), Position.new(l2, c2))
+    end
+
+    # Get a range from a node.
+    #
+    # @param node [::Parser::AST::Node]
+    # @return [Range, nil]
+    def self.from_node node
+      return unless node&.loc&.expression
+      from_expr(node.loc.expression)
+    end
+
+    # Get a range from a Parser range, usually found in
+    # Parser::AST::Node#location#expression.
+    #
+    # @param expr [Parser::Source::Range]
+    # @return [Range]
+    def self.from_expr expr
+      from_to(expr.line, expr.column, expr.last_line, expr.last_column)
+    end
+
+    def == other
+      return false unless other.is_a?(Range)
+      start == other.start && ending == other.ending
+    end
+
+    def inspect
+      "#<#{self.class} #{start.inspect} to #{ending.inspect}>"
+    end
+
+    protected
+
+    def equality_fields
+      [start, ending]
+    end
+  end
+end