solargraph 0.17.4 → 0.18.0

data/lib/solargraph/source/flawed_builder.rb

@@ -0,0 +1,10 @@
+module Solargraph
+  class Source
+    class FlawedBuilder < Parser::Builders::Default
+      def string_value(token)
+        value(token)
+      end
+    end
+    private_constant :FlawedBuilder
+  end
+end

data/lib/solargraph/source/fragment.rb

@@ -0,0 +1,319 @@
+module Solargraph
+  class Source
+    class Fragment
+      # @return [Integer]
+      attr_reader :offset
+
+      include NodeMethods
+
+      # @param source [Solargraph::Source]
+      # @param offset [Integer]
+      def initialize source, offset
+        # @todo Split this object from the source. The source can change; if
+        #   it does, this object's data should not.
+        @source = source
+        @code = source.code
+        @offset = offset
+      end
+
+      # Get the node at the current offset.
+      #
+      # @return [Parser::AST::Node]
+      def node
+        @node ||= @source.node_at(@offset)
+      end
+
+      # Get the fully qualified namespace at the current offset.
+      #
+      # @return [String]
+      def namespace
+        if @namespace.nil?
+          base = @source.parent_node_from(@offset, :class, :module, :def, :defs)
+          @namespace ||= @source.namespace_for(base)
+        end
+        @namespace
+      end
+
+      # Get the scope at the current offset.
+      #
+      # @return [Symbol] :class or :instance
+      def scope
+        if @scope.nil?
+          @scope = :class
+          tree = @source.tree_at(@offset)
+          until tree.empty?
+            cursor = tree.shift
+            break if cursor.type == :class or cursor.type == :module
+            if cursor.type == :def
+              pin = @source.method_pins.select{|pin| pin.contain?(@offset)}.first
+              # @todo The pin should never be nil here, but we're guarding it just in case
+              @scope = (pin.nil? ? :instance : pin.scope)
+            end
+          end
+        end
+        @scope
+      end
+
+      # Get the signature up to the current offset. Given the text `foo.bar`,
+      # the signature at offset 5 is `foo.b`.
+      #
+      # @return [String]
+      def signature
+        @signature ||= signature_data[1]
+      end
+
+      # Get the signature before the current word. Given the signature
+      # `String.new.split`, the base is `String.new`.
+      #
+      # @return [String]
+      def base
+        if @base.nil?
+          if signature.include?('.')
+            if signature.end_with?('.')
+              @base = signature[0..-2]
+            else
+              @base = signature.split('.')[0..-2].join('.')
+            end
+          elsif signature.include?('::')
+            if signature.end_with?('::')
+              @base = signature[0..-3]
+            else
+              @base = signature.split('::')[0..-2].join('::')
+            end
+          else
+            # @base = signature
+            @base = ''
+          end
+        end
+        @base
+      end
+
+      # Get the remainder of the word after the current offset. Given the text
+      # `foobar` with an offset of 3, the remainder is `bar`.
+      #
+      # @return [String]
+      def remainder
+        @remainder ||= remainder_at(@offset)
+      end
+
+      # Get the whole word at the current offset, including the remainder.
+      # Given the text `foobar.baz`, the whole word at any offset from 0 to 6
+      # is `foobar`.
+      #
+      # @return [String]
+      def whole_word
+        @whole_word ||= word + remainder
+      end
+
+      # Get the whole signature at the current offset, including the final
+      # word and its remainder.
+      #
+      # @return [String]
+      def whole_signature
+        @whole_signature ||= signature + remainder
+      end
+
+      # Get the entire phrase up to the current offset. Given the text
+      # `foo[bar].baz()`, the phrase at offset 10 is `foo[bar].b`.
+      #
+      # @return [String]
+      def phrase
+        @phrase ||= @code[signature_data[0]..@offset]
+      end
+
+      # Get the word before the current offset. Given the text `foo.bar`, the
+      # word at offset 6 is `ba`.
+      def word
+        @word ||= word_at(@offset)
+      end
+
+      # True if the current offset is inside a string.
+      #
+      # @return [Boolean]
+      def string?
+        @string = @source.string_at?(@offset) if @string.nil?
+        @string
+      end
+
+      # True if the current offset is inside a comment.
+      #
+      # @return [Boolean]
+      def comment?
+        @comment = get_comment_at(@offset) if @comment.nil?
+        @comment
+      end
+
+      # Get the range of the word up to the current offset.
+      #
+      # @return [Range]
+      def word_range
+        @word_range ||= word_range_at(@offset, false)
+      end
+
+      # Get the range of the whole word at the current offset, including its
+      # remainder.
+      #
+      # @return [Range]
+      def whole_word_range
+        @whole_word_range ||= word_range_at(@offset, true)
+      end
+
+      # Get an array of all the local variables in the source that are visible
+      # from the current offset.
+      #
+      # @return [Array<Solargraph::Pin::LocalVariable>]
+      def local_variable_pins
+        @local_variable_pins ||= @source.local_variable_pins.select{|pin| pin.visible_from?(node)}
+      end
+
+      private
+
+      def signature_data
+        @signature_data ||= get_signature_data_at(@offset)
+      end
+
+      def get_signature_data_at index
+        brackets = 0
+        squares = 0
+        parens = 0
+        signature = ''
+        index -=1
+        in_whitespace = false
+        while index >= 0
+          break if index > 0 and comment?
+          unless !in_whitespace and string?
+            break if brackets > 0 or parens > 0 or squares > 0
+            char = @code[index, 1]
+            if brackets.zero? and parens.zero? and squares.zero? and [' ', "\n", "\t"].include?(char)
+              in_whitespace = true
+            else
+              if brackets.zero? and parens.zero? and squares.zero? and in_whitespace
+                unless char == '.' or @code[index+1..-1].strip.start_with?('.')
+                  old = @code[index+1..-1]
+                  nxt = @code[index+1..-1].lstrip
+                  index += (@code[index+1..-1].length - @code[index+1..-1].lstrip.length)
+                  break
+                end
+              end
+              if char == ')'
+                parens -=1
+              elsif char == ']'
+                squares -=1
+              elsif char == '}'
+                brackets -= 1
+              elsif char == '('
+                parens += 1
+              elsif char == '{'
+                brackets += 1
+              elsif char == '['
+                squares += 1
+                signature = ".[]#{signature}" if squares == 0 and @code[index-2] != '%'
+              end
+              if brackets.zero? and parens.zero? and squares.zero?
+                break if ['"', "'", ',', ';', '%'].include?(char)
+                signature = char + signature if char.match(/[a-z0-9:\._@\$]/i) and @code[index - 1] != '%'
+                break if char == '$'
+                if char == '@'
+                  signature = "@#{signature}" if @code[index-1, 1] == '@'
+                  break
+                end
+              end
+              in_whitespace = false
+            end
+          end
+          index -= 1
+        end
+        if signature.start_with?('.')
+          pn = @source.node_at(index)
+          unless pn.nil?
+            literal = infer_literal_node_type(pn)
+            unless literal.nil?
+              signature = "#{literal}.new#{signature}"
+              # @todo Determine the index from the beginning of the literal node?
+            end
+          end
+        end
+        [index + 1, signature]
+      end  
+
+      # Determine if the specified index is inside a comment.
+      #
+      # @return [Boolean]
+      def get_comment_at(index)
+        return false if string?
+        line, col = Solargraph::Source.get_position_at(@source.code, index)
+        @source.comments.each do |c|
+          return true if index > c.location.expression.begin_pos and index <= c.location.expression.end_pos
+        end
+        false
+      end
+
+      # Select the word that directly precedes the specified index.
+      # A word can only consist of letters, numbers, and underscores.
+      #
+      # @param index [Integer]
+      # @return [String]
+      def word_at index
+        @code[beginning_of_word_at(index)..index - 1]
+      end
+
+      def beginning_of_word_at index
+        cursor = index - 1
+        # Words can end with ? or !
+        if @code[cursor, 1] == '!' or @code[cursor, 1] == '?'
+          cursor -= 1
+        end
+        while cursor > -1
+          char = @code[cursor, 1]
+          break if char.nil? or char.strip.empty?
+          break unless char.match(/[a-z0-9_]/i)
+          cursor -= 1
+        end
+        # Words can begin with @@, @, $, or :
+        if cursor > -1
+          if cursor > 0 and @code[cursor - 1, 2] == '@@'
+            cursor -= 2
+          elsif @code[cursor, 1] == '@' or @code[cursor, 1] == '$'
+            cursor -= 1
+          elsif @code[cursor, 1] == ':' and (cursor == 0 or @code[cursor - 1, 2] != '::')
+            cursor -= 1
+          end
+        end
+        cursor + 1
+      end
+
+      # @return Solargraph::Source::Range
+      def word_range_at index, whole
+        cursor = beginning_of_word_at(index)
+        start_offset = cursor
+        start_offset -= 1 if (start_offset > 1 and @code[start_offset - 1] == ':') and (start_offset == 1 or @code[start_offset - 2] != ':')
+        cursor = index
+        if whole
+          while cursor < @code.length
+            char = @code[cursor, 1]
+            break if char.nil? or char == ''
+            break unless char.match(/[a-z0-9_\?\!]/i)
+            cursor += 1
+          end
+        end
+        end_offset = cursor
+        end_offset = start_offset if end_offset < start_offset
+        start_pos = Solargraph::Source.get_position_at(@code, start_offset)
+        end_pos = Solargraph::Source.get_position_at(@code, end_offset)
+        Solargraph::Source::Range.from_to(start_pos[0], start_pos[1], end_pos[0], end_pos[1])
+      end
+
+      def remainder_at index
+        cursor = index
+        while cursor < @code.length
+          char = @code[cursor, 1]
+          break if char.nil? or char == ''
+          break unless char.match(/[a-z0-9_\?\!]/i)
+          cursor += 1
+        end
+        @code[index..cursor-1]
+      end
+
+    end
+  end
+end

data/lib/solargraph/source/position.rb

@@ -0,0 +1,26 @@
+module Solargraph
+  class Source
+    class Position
+      # @return [Integer]
+      attr_reader :line
+
+      # @return [Integer]
+      attr_reader :character
+
+      def initialize line, character
+        @line = line
+        @character = character
+      end
+
+      # Get a hash of the position. This representation is suitable for use in
+      # the language server protocol.
+      #
+      def to_hash
+        {
+          line: line,
+          character: character
+        }
+      end
+    end
+  end
+end

data/lib/solargraph/source/range.rb

@@ -0,0 +1,39 @@
+module Solargraph
+  class Source
+    class Range
+      # @return [Position]
+      attr_reader :start
+
+      # @return [Position]
+      attr_reader :end
+
+      # @param start [Position]
+      # @param ending [Position]
+      def initialize start, ending
+        @start = start
+        @end = ending
+      end
+
+      # Get a hash of the range. This representation is suitable for use in
+      # the language server protocol.
+      #
+      def to_hash
+        {
+          start: start.to_hash,
+          end: self.end.to_hash
+        }
+      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 [Position]
+      def self.from_to l1, c1, l2, c2
+        Range.new(Position.new(l1, c1), Position.new(l2, c2))
+      end
+    end
+  end
+end

data/lib/solargraph/suggestion.rb

@@ -17,7 +17,28 @@ module Solargraph
     attr_reader :label
 
     # @return [String]
-    attr_reader :kind
+    def kind
+      case @kind
+      when Solargraph::LanguageServer::CompletionItemKinds::CLASS
+        'Class'
+      when Solargraph::LanguageServer::CompletionItemKinds::CONSTANT
+        'Constant'
+      when Solargraph::LanguageServer::CompletionItemKinds::FIELD
+        'Field'
+      when Solargraph::LanguageServer::CompletionItemKinds::KEYWORD
+        'Keyword'
+      when Solargraph::LanguageServer::CompletionItemKinds::METHOD
+        'Method'
+      when Solargraph::LanguageServer::CompletionItemKinds::MODULE
+        'Module'
+      when Solargraph::LanguageServer::CompletionItemKinds::PROPERTY
+        'Property'
+      when Solargraph::LanguageServer::CompletionItemKinds::VARIABLE
+        'Variable'
+      else
+        nil
+      end
+    end
 
     # @return [String]
     attr_reader :insert
@@ -37,7 +58,10 @@ module Solargraph
     # @return [YARD::CodeObjects::Base]
     attr_reader :code_object
 
-    def initialize label, kind: KEYWORD, insert: nil, detail: nil, docstring: nil, code_object: nil, location: nil, arguments: [], return_type: nil, path: nil
+    # @return [Solargraph::Pin::Base]
+    attr_reader :pin
+
+    def initialize label, kind: KEYWORD, insert: nil, detail: nil, docstring: nil, code_object: nil, location: nil, arguments: [], return_type: nil, path: nil, pin: nil
       @helper = Server::Helpers.new
       @label = label.to_s
       @kind = kind
@@ -49,6 +73,7 @@ module Solargraph
       @arguments = arguments
       @return_type = return_type
       @path = path
+      @pin = pin
     end
 
     # The full path of the suggestion.
@@ -124,7 +149,7 @@ module Solargraph
     def as_json args = {}
       result = {
         label: @label,
-        kind: @kind,
+        kind: kind,
         insert: @insert,
         detail: @detail,
         path: path,
@@ -147,7 +172,7 @@ module Solargraph
     # @param pin [Solargraph::Pin::Base]
     def self.pull pin, return_type = nil
       return pin if pin.kind_of?(Suggestion)
-      Suggestion.new(pin.name, insert: pin.name.gsub(/=$/, ' = '), kind: pin.kind, docstring: pin.docstring, detail: pin.namespace, arguments: pin.parameters, path: pin.path, return_type: return_type || pin.return_type, location: pin.location)
+      Suggestion.new(pin.name, insert: pin.name.gsub(/=$/, ' = '), kind: pin.kind, docstring: pin.docstring, detail: pin.namespace, arguments: pin.parameters, path: pin.path, return_type: return_type || pin.return_type, location: pin.location, pin: pin)
     end
   end
 end