solargraph 0.58.0 → 0.59.0

data/lib/solargraph/source/change.rb

@@ -1,82 +1,89 @@
-# frozen_string_literal: true
-
-module Solargraph
-  class Source
-    # A change to be applied to text.
-    #
-    class Change
-      include EncodingFixes
-
-      # @return [Range]
-      attr_reader :range
-
-      # @return [String]
-      attr_reader :new_text
-
-      # @param range [Range] The starting and ending positions of the change.
-      #   If nil, the original text will be overwritten.
-      # @param new_text [String] The text to be changed.
-      def initialize range, new_text
-        @range = range
-        @new_text = new_text
-      end
-
-      # Write the change to the specified text.
-      #
-      # @param text [String] The text to be changed.
-      # @param nullable [Boolean] If true, minor changes that could generate
-      #   syntax errors will be repaired.
-      # @return [String] The updated text.
-      def write text, nullable = false
-        if nullable and !range.nil? and new_text.match(/[.\[{(@$:]$/)
-          [':', '@'].each do |dupable|
-            next unless new_text == dupable
-            offset = Position.to_offset(text, range.start)
-            if text[offset - 1] == dupable
-              p = Position.from_offset(text, offset - 1)
-              r = Change.new(Range.new(p, range.start), ' ')
-              text = r.write(text)
-            end
-            break
-          end
-          commit text, "#{new_text[0..-2]} "
-        elsif range.nil?
-          new_text
-        else
-          commit text, new_text
-        end
-      end
-
-      # Repair an update by replacing the new text with similarly formatted
-      # whitespace.
-      #
-      # @param text [String] The text to be changed.
-      # @return [String] The updated text.
-      def repair text
-        fixed = new_text.gsub(/[^\s]/, ' ')
-        if range.nil?
-          fixed
-        else
-          result = commit text, fixed
-          off = Position.to_offset(text, range.start)
-          match = result[0, off].match(/[.:]+\z/)
-          if match
-            result = result[0, off].sub(/#{match[0]}\z/, ' ' * match[0].length) + result[off..-1]
-          end
-          result
-        end
-      end
-
-      private
-
-      # @param text [String]
-      # @param insert [String]
-      # @return [String]
-      def commit text, insert
-        start_offset = Position.to_offset(text, range.start)
-        end_offset = Position.to_offset(text, range.ending)
-        (start_offset == 0 ? '' : text[0..start_offset-1].to_s) + normalize(insert) + text[end_offset..-1].to_s
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  class Source
+    # A change to be applied to text.
+    #
+    class Change
+      include EncodingFixes
+
+      # @return [Range, nil]
+      attr_reader :range
+
+      # @return [String]
+      attr_reader :new_text
+
+      # @param range [Range, nil] The starting and ending positions of the change.
+      #   If nil, the original text will be overwritten.
+      # @param new_text [String] The text to be changed.
+      def initialize range, new_text
+        @range = range
+        @new_text = new_text
+      end
+
+      # Write the change to the specified text.
+      #
+      # @param text [String] The text to be changed.
+      # @param nullable [Boolean] If true, minor changes that could generate
+      #   syntax errors will be repaired.
+      # @return [String] The updated text.
+      def write text, nullable = false
+        if nullable && !range.nil? && new_text.match(/[.\[{(@$:]$/)
+          [':', '@'].each do |dupable|
+            next unless new_text == dupable
+            # @sg-ignore flow sensitive typing needs to handle attrs
+            offset = Position.to_offset(text, range.start)
+            if text[offset - 1] == dupable
+              p = Position.from_offset(text, offset - 1)
+              # @sg-ignore flow sensitive typing needs to handle attrs
+              r = Change.new(Range.new(p, range.start), ' ')
+              text = r.write(text)
+            end
+            break
+          end
+          commit text, "#{new_text[0..-2]} "
+        elsif range.nil?
+          new_text
+        else
+          commit text, new_text
+        end
+      end
+
+      # Repair an update by replacing the new text with similarly formatted
+      # whitespace.
+      #
+      # @param text [String] The text to be changed.
+      # @return [String] The updated text.
+      def repair text
+        fixed = new_text.gsub(/[^\s]/, ' ')
+        if range.nil?
+          fixed
+        else
+          result = commit text, fixed
+          # @sg-ignore flow sensitive typing needs to handle attrs
+          off = Position.to_offset(text, range.start)
+          # @sg-ignore Need to add nil check here
+          match = result[0, off].match(/[.:]+\z/)
+          if match
+            # @sg-ignore flow sensitive typing should be able to handle redefinition
+            result = result[0, off].sub(/#{match[0]}\z/, ' ' * match[0].length) + result[off..]
+          end
+          result
+        end
+      end
+
+      private
+
+      # @param text [String]
+      # @param insert [String]
+      # @return [String]
+      def commit text, insert
+        # @sg-ignore Need to add nil check here
+        start_offset = Position.to_offset(text, range.start)
+        # @sg-ignore Need to add nil check here
+        end_offset = Position.to_offset(text, range.ending)
+        (start_offset.zero? ? '' : text[0..(start_offset - 1)].to_s) + normalize(insert) + text[end_offset..].to_s
+      end
+    end
+  end
+end

data/lib/solargraph/source/cursor.rb

@@ -1,166 +1,172 @@
-# frozen_string_literal: true
-
-module Solargraph
-  class Source
-    # Information about a single Position in a Source, including the
-    # word located there.
-    #
-    class Cursor
-      # @return [Position]
-      attr_reader :position
-
-      # @return [Source]
-      attr_reader :source
-
-      # @param source [Source]
-      # @param position [Position, Array(Integer, Integer)]
-      def initialize source, position
-        @source = source
-        @position = Position.normalize(position)
-      end
-
-      # @return [String]
-      def filename
-        source.filename
-      end
-
-      # The whole word at the current position. Given the text `foo.bar`, the
-      # word at position(0,6) is `bar`.
-      #
-      # @return [String]
-      def word
-        @word ||= start_of_word + end_of_word
-      end
-
-      # The part of the word before the current position. Given the text
-      # `foo.bar`, the start_of_word at position(0, 6) is `ba`.
-      #
-      # @return [String]
-      def start_of_word
-        @start_of_word ||= begin
-          match = source.code[0..offset-1].to_s.match(start_word_pattern)
-          result = (match ? match[0] : '')
-          # Including the preceding colon if the word appears to be a symbol
-          result = ":#{result}" if source.code[0..offset-result.length-1].end_with?(':') and !source.code[0..offset-result.length-1].end_with?('::')
-          result
-        end
-      end
-
-      # The part of the word after the current position. Given the text
-      # `foo.bar`, the end_of_word at position (0,6) is `r`.
-      #
-      # @return [String]
-      def end_of_word
-        @end_of_word ||= begin
-          match = source.code[offset..-1].to_s.match(end_word_pattern)
-          match ? match[0] : ''
-        end
-      end
-
-      # @return [Boolean]
-      def start_of_constant?
-        source.code[offset-2, 2] == '::'
-      end
-
-      # The range of the word at the current position.
-      #
-      # @return [Range]
-      def range
-        @range ||= begin
-          s = Position.from_offset(source.code, offset - start_of_word.length)
-          e = Position.from_offset(source.code, offset + end_of_word.length)
-          Solargraph::Range.new(s, e)
-        end
-      end
-
-      # @return [Chain]
-      def chain
-        @chain ||= SourceChainer.chain(source, position)
-      end
-
-      # True if the statement at the cursor is an argument to a previous
-      # method.
-      #
-      # Given the code `process(foo)`, a cursor pointing at `foo` would
-      # identify it as an argument being passed to the `process` method.
-      #
-      # If #argument? is true, the #recipient method will return a cursor that
-      # points to the method receiving the argument.
-      #
-      # @return [Boolean]
-      def argument?
-        # @argument ||= !signature_position.nil?
-        @argument ||= !recipient.nil?
-      end
-
-      # @return [Boolean]
-      def comment?
-        @comment ||= source.comment_at?(position)
-      end
-
-      # @return [Boolean]
-      def string?
-        @string ||= source.string_at?(position)
-      end
-
-      # Get a cursor pointing to the method that receives the current statement
-      # as an argument.
-      #
-      # @return [Cursor, nil]
-      def recipient
-        @recipient ||= begin
-          node = recipient_node
-          node ? Cursor.new(source, Range.from_node(node).ending) : nil
-        end
-      end
-      alias receiver recipient
-
-      # @return [AST::Node]
-      def node
-        @node ||= source.node_at(position.line, position.column)
-      end
-
-      # @return [Position]
-      def node_position
-        @node_position ||= begin
-          if start_of_word.empty?
-            match = source.code[0, offset].match(/\s*(\.|:+)\s*$/)
-            if match
-              Position.from_offset(source.code, offset - match[0].length)
-            else
-              position
-            end
-          else
-            position
-          end
-        end
-      end
-
-      # @return [Parser::AST::Node, nil]
-      def recipient_node
-        @recipient_node ||= Solargraph::Parser::NodeMethods.find_recipient_node(self)
-      end
-
-      # @return [Integer]
-      def offset
-        @offset ||= Position.to_offset(source.code, position)
-      end
-
-      private
-
-      # A regular expression to find the start of a word from an offset.
-      #
-      # @return [Regexp]
-      def start_word_pattern
-        /(@{1,2}|\$)?([a-z0-9_]|[^\u0000-\u007F])*\z/i
-      end
-
-      # A regular expression to find the end of a word from an offset.
-      #
-      # @return [Regexp]
-      def end_word_pattern
-        /^([a-z0-9_]|[^\u0000-\u007F])*[?!]?/i
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  class Source
+    # Information about a single Position in a Source, including the
+    # word located there.
+    #
+    class Cursor
+      # @return [Position]
+      attr_reader :position
+
+      # @return [Source]
+      attr_reader :source
+
+      # @param source [Source]
+      # @param position [Position, Array(Integer, Integer)]
+      def initialize source, position
+        @source = source
+        @position = Position.normalize(position)
+      end
+
+      # @return [String, nil]
+      def filename
+        source.filename
+      end
+
+      # The whole word at the current position. Given the text `foo.bar`, the
+      # word at position(0,6) is `bar`.
+      #
+      # @return [String]
+      def word
+        @word ||= start_of_word + end_of_word
+      end
+
+      # The part of the word before the current position. Given the text
+      # `foo.bar`, the start_of_word at position(0, 6) is `ba`.
+      #
+      # @sg-ignore Need to add nil check here
+      # @return [String]
+      def start_of_word
+        @start_of_word ||= begin
+          match = source.code[0..(offset - 1)].to_s.match(start_word_pattern)
+          result = (match ? match[0] : '')
+          # Including the preceding colon if the word appears to be a symbol
+          # @sg-ignore Need to add nil check here
+          if source.code[0..(offset - result.length - 1)].end_with?(':') && !source.code[0..(offset - result.length - 1)].end_with?('::')
+            result = ":#{result}"
+          end
+          result
+        end
+      end
+
+      # The part of the word after the current position. Given the text
+      # `foo.bar`, the end_of_word at position (0,6) is `r`.
+      #
+      # @return [String]
+      # @sg-ignore Need to add nil check here
+      def end_of_word
+        @end_of_word ||= begin
+          match = source.code[offset..].to_s.match(end_word_pattern)
+          match ? match[0] : ''
+        end
+      end
+
+      # @return [Boolean]
+      def start_of_constant?
+        source.code[offset - 2, 2] == '::'
+      end
+
+      # The range of the word at the current position.
+      #
+      # @return [Range]
+      def range
+        @range ||= begin
+          s = Position.from_offset(source.code, offset - start_of_word.length)
+          e = Position.from_offset(source.code, offset + end_of_word.length)
+          Solargraph::Range.new(s, e)
+        end
+      end
+
+      # @return [Chain]
+      def chain
+        @chain ||= SourceChainer.chain(source, position)
+      end
+
+      # True if the statement at the cursor is an argument to a previous
+      # method.
+      #
+      # Given the code `process(foo)`, a cursor pointing at `foo` would
+      # identify it as an argument being passed to the `process` method.
+      #
+      # If #argument? is true, the #recipient method will return a cursor that
+      # points to the method receiving the argument.
+      #
+      # @return [Boolean]
+      def argument?
+        # @argument ||= !signature_position.nil?
+        @argument ||= !recipient.nil?
+      end
+
+      # @return [Boolean]
+      def comment?
+        @comment ||= source.comment_at?(position)
+      end
+
+      # @return [Boolean]
+      def string?
+        @string ||= source.string_at?(position)
+      end
+
+      # Get a cursor pointing to the method that receives the current statement
+      # as an argument.
+      #
+      # @return [Cursor, nil]
+      def recipient
+        @recipient ||= begin
+          node = recipient_node
+          # @sg-ignore Need to add nil check here
+          node ? Cursor.new(source, Range.from_node(node).ending) : nil
+        end
+      end
+      alias receiver recipient
+
+      # @return [AST::Node]
+      def node
+        @node ||= source.node_at(position.line, position.column)
+      end
+
+      # @return [Position]
+      def node_position
+        @node_position ||= if start_of_word.empty?
+                             # @sg-ignore Need to add nil check here
+                             match = source.code[0, offset].match(/\s*(\.|:+)\s*$/)
+                             if match
+                               # @sg-ignore Need to add nil check here
+                               Position.from_offset(source.code, offset - match[0].length)
+                             else
+                               position
+                             end
+                           else
+                             position
+                           end
+      end
+
+      # @return [Parser::AST::Node, nil]
+      def recipient_node
+        @recipient_node ||= Solargraph::Parser::NodeMethods.find_recipient_node(self)
+      end
+
+      # @return [Integer]
+      def offset
+        @offset ||= Position.to_offset(source.code, position)
+      end
+
+      private
+
+      # A regular expression to find the start of a word from an offset.
+      #
+      # @return [Regexp]
+      def start_word_pattern
+        /(@{1,2}|\$)?([a-z0-9_]|[^\u0000-\u007F])*\z/i
+      end
+
+      # A regular expression to find the end of a word from an offset.
+      #
+      # @return [Regexp]
+      def end_word_pattern
+        /^([a-z0-9_]|[^\u0000-\u007F])*[?!]?/i
+      end
+    end
+  end
+end

data/lib/solargraph/source/encoding_fixes.rb

@@ -1,23 +1,22 @@
-# frozen_string_literal: true
-
-module Solargraph
-  class Source
-    module EncodingFixes
-      module_function
-
-      # Convert strings to normalized UTF-8.
-      #
-      # @param string [String]
-      # @return [String]
-      def normalize string
-        begin
-          string.dup.force_encoding('UTF-8')
-        rescue ::Encoding::CompatibilityError, ::Encoding::UndefinedConversionError, ::Encoding::InvalidByteSequenceError => e
-          # @todo Improve error handling
-          Solargraph::Logging.logger.warn "Normalize error: #{e.message}"
-          string
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  class Source
+    module EncodingFixes
+      module_function
+
+      # Convert strings to normalized UTF-8.
+      #
+      # @param string [String]
+      # @return [String]
+      def normalize string
+        string.dup.force_encoding('UTF-8')
+      rescue ::Encoding::CompatibilityError, ::Encoding::UndefinedConversionError,
+             ::Encoding::InvalidByteSequenceError => e
+        # @todo Improve error handling
+        Solargraph::Logging.logger.warn "Normalize error: #{e.message}"
+        string
+      end
+    end
+  end
+end