solargraph 0.26.1 → 0.27.0

data/lib/solargraph/source/call_chainer.rb

@@ -1,273 +0,0 @@
-module Solargraph
-  class Source
-    # Information about a location in a source, including the location's word
-    # and signature, literal values at the base of signatures, and whether the
-    # location is inside a string or comment. ApiMaps use Fragments to provide
-    # results for completion and definition queries.
-    #
-    class CallChainer
-      include NodeMethods
-
-      private_class_method :new
-
-      class << self
-        # @param source [Source]
-        # @param line [Integer]
-        # @param column [Integer]
-        # @return [Source::Chain]
-        def chain source, line, column
-          new(source, line, column).chain
-        end
-      end
-
-      # @param source [Solargraph::Source]
-      # @param line [Integer]
-      # @param column [Integer]
-      def initialize source, line, column
-        @source = source
-        # @source.code = source.code
-        @line = line
-        @column = column
-        @calculated_literal = false
-      end
-
-      # @return [Source::Chain]
-      def chain
-        links = []
-        # @todo Smelly colon handling
-        if @source.code[0..offset-1].end_with?(':') and !@source.code[0..offset-1].end_with?('::')
-          links.push Chain::Link.new
-          links.push Chain::Link.new
-        elsif @source.string_at?(line, column)
-          links.push Chain::Literal.new('String')
-        else
-          links.push Chain::Literal.new(base_literal) if base_literal?
-          sig = whole_signature
-          unless sig.empty?
-            sig = sig[1..-1] if sig.start_with?('.')
-            head = true
-            sig.split('.', -1).each do |word|
-              if word.include?('::')
-                # @todo Smelly way of handling constants
-                parts = (word.start_with?('::') ? word[2..-1] : word).split('::', -1)
-                last = parts.pop
-                links.push Chain::Constant.new(parts.join('::')) unless parts.empty?
-                links.push (last.nil? ? Chain::UNDEFINED_CONSTANT : Chain::Constant.new(last))
-              else
-                links.push word_to_link(word, head)
-              end
-              head = false
-            end
-          end
-          # Literal string hack
-          links.push Chain::UNDEFINED_CALL if base_literal? and @source.code[offset - 1] == '.' and links.length == 1
-        end
-        @chain ||= Chain.new(source.filename, links)
-      end
-
-      private
-
-      # The zero-based line number of the fragment's location.
-      #
-      # @return [Integer]
-      attr_reader :line
-
-      # The zero-based column number of the fragment's location.
-      #
-      # @return [Integer]
-      attr_reader :column
-
-      # @return [Solargraph::Source]
-      attr_reader :source
-
-      def word_to_link word, head
-        if word.start_with?('@@')
-          Chain::ClassVariable.new(word)
-        elsif word.start_with?('@')
-          Chain::InstanceVariable.new(word)
-        elsif word.start_with?('$')
-          Chain::GlobalVariable.new(word)
-        elsif word.end_with?(':')
-          Chain::Link.new
-        elsif word.empty?
-          Chain::UNDEFINED_CALL
-        elsif head and !@source.code[signature_data[0]..-1].match(/^[\s]*?#{word}[\s]*?\(/)
-          # The head needs to allow for ambiguous references to constants and
-          # methods. For example, `String` might be either. If the word is not
-          # followed by an open parenthesis, use Chain::Head for ambiguous
-          # results.
-          Chain::Head.new(word)
-        else
-          Chain::Call.new(word)
-        end
-      end
-
-      # An alias for #column.
-      #
-      # @return [Integer]
-      def character
-        @column
-      end
-
-      # @return [Source::Position]
-      def position
-        @position ||= Position.new(line, column)
-      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].to_s
-      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 signature at the current offset, including the final
-      # word and its remainder.
-      #
-      # @return [String]
-      def whole_signature
-        @whole_signature ||= signature + remainder
-      end
-
-      # True if the current offset is inside a string.
-      #
-      # @return [Boolean]
-      def string?
-        # @string ||= (node.type == :str or node.type == :dstr)
-        @string ||= @source.string_at?(line, character)
-      end
-
-      # True if the fragment is a signature that stems from a literal value.
-      #
-      # @return [Boolean]
-      def base_literal?
-        !base_literal.nil?
-      end
-
-      # The type of literal value at the root of the signature (or nil).
-      #
-      # @return [String]
-      def base_literal
-        if @base_literal.nil? and !@calculated_literal
-          @calculated_literal = true
-          if signature.start_with?('.')
-            pn = @source.node_at(line, column - 2)
-            @base_literal = infer_literal_node_type(pn) unless pn.nil?
-          end
-        end
-        @base_literal
-      end
-
-      # @return [Integer]
-      def offset
-        @offset ||= get_offset(line, column)
-      end
-
-      def get_offset line, column
-        Position.line_char_to_offset(@source.code, line, column)
-      end
-
-      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
-          pos = Position.from_offset(@source.code, index)
-          break if index > 0 and @source.comment_at?(pos.line, pos.character)
-          unless !in_whitespace and string?
-            break if brackets > 0 or parens > 0 or squares > 0
-            char = @source.code[index, 1]
-            break if char.nil? # @todo Is this the right way to handle this?
-            if brackets.zero? and parens.zero? and squares.zero? and [' ', "\r", "\n", "\t"].include?(char)
-              in_whitespace = true
-            else
-              if brackets.zero? and parens.zero? and squares.zero? and in_whitespace
-                unless char == '.' or @source.code[index+1..-1].strip.start_with?('.')
-                  old = @source.code[index+1..-1]
-                  nxt = @source.code[index+1..-1].lstrip
-                  index += (@source.code[index+1..-1].length - @source.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 parens.zero? and brackets.zero? and squares.zero? and @source.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 @source.code[index - 1] != '%'
-                break if char == '$'
-                if char == '@'
-                  signature = "@#{signature}" if @source.code[index-1, 1] == '@'
-                  break
-                end
-              end
-              in_whitespace = false
-            end
-          end
-          index -= 1
-        end
-        # @todo Smelly exceptional case for integer literals
-        match = signature.match(/^[0-9]+/)
-        if match
-          index += match[0].length
-          signature = signature[match[0].length..-1].to_s
-          @base_literal = 'Integer'
-        # @todo Smelly exceptional case for array literals
-        elsif signature.start_with?('.[]')
-          index += 2
-          signature = signature[3..-1].to_s
-          @base_literal = 'Array'
-        elsif signature.start_with?('.')
-          pos = Position.from_offset(source.code, index)
-          node = source.node_at(pos.line, pos.character)
-          lit = infer_literal_node_type(node)
-          unless lit.nil?
-            signature = signature[1..-1].to_s
-            index += 1
-            @base_literal = lit
-          end
-        end
-        [index + 1, signature]
-      end
-
-      # @return [String]
-      def remainder_at index
-        cursor = index
-        while cursor < @source.code.length
-          char = @source.code[cursor, 1]
-          break if char.nil? or char == ''
-          break unless char.match(/[a-z0-9_\?\!]/i)
-          cursor += 1
-        end
-        @source.code[index..cursor-1].to_s
-      end
-    end
-  end
-end

data/lib/solargraph/source/fragment.rb

@@ -1,342 +0,0 @@
-module Solargraph
-  class Source
-    # Information about a location in a source, including the location's word
-    # and signature, literal values at the base of signatures, and whether the
-    # location is inside a string or comment. ApiMaps use Fragments to provide
-    # results for completion and definition queries.
-    #
-    class Fragment
-      include NodeMethods
-
-      # The zero-based line number of the fragment's location.
-      #
-      # @return [Integer]
-      attr_reader :line
-
-      # The zero-based column number of the fragment's location.
-      #
-      # @return [Integer]
-      attr_reader :column
-
-      # @return [Solargraph::Source]
-      attr_reader :source
-
-      # @param source [Solargraph::Source]
-      # @param line [Integer]
-      # @param column [Integer]
-      def initialize source, line, column
-        @source = source
-        @code = source.code
-        @line = line
-        @column = column
-        @calculated_literal = false
-      end
-
-      # An alias for #column.
-      #
-      # @return [Integer]
-      def character
-        @column
-      end
-
-      # @return [Source::Position]
-      def position
-        @position ||= Position.new(line, column)
-      end
-
-      # Get the fully qualified namespace at the current offset.
-      #
-      # @return [String]
-      def namespace
-        if @namespace.nil?
-          pin = @source.locate_namespace_pin(line, character)
-          @namespace = (pin.nil? ? '' : pin.path)
-        end
-        @namespace
-      end
-
-      # True if the fragment is inside a method argument.
-      #
-      # @return [Boolean]
-      def argument?
-        @argument ||= !signature_position.nil?
-      end
-
-      # @return [Fragment]
-      def recipient
-        return nil if signature_position.nil?
-        @recipient ||= @source.fragment_at(*signature_position)
-      end
-
-      # Get the scope at the current offset.
-      #
-      # @return [Symbol] :class or :instance
-      def scope
-        if @scope.nil?
-          @scope = :class
-          @scope = :instance if named_path.kind == Pin::METHOD and named_path.scope == :instance
-        end
-        @scope
-      end
-
-      # Get the signature before the current word. Given the signature
-      # `String.new.split`, the base is `String.new`.
-      #
-      # @return [String]
-      def base
-        chain.links[0..-2].map(&:word).join('.')
-      end
-
-      # @return [Source::Chain]
-      def chain
-        @chain ||= generate_chain
-      end
-
-      # Get the whole signature at the current offset, including the final
-      # word and its remainder.
-      #
-      # @return [String]
-      def whole_signature
-        chain.links.reject{|l| l.word == '<undefined>'}.map(&:word).join('.')
-      end
-
-      # Get the word before the current offset. Given the text `foo.bar`, the
-      # word at offset 6 is `ba`.
-      #
-      # @return [String]
-      def start_of_word
-        @start_of_word ||= begin
-          match = @code[0..offset-1].to_s.match(start_word_pattern)
-          result = (match ? match[0] : '')
-          result = ":#{result}" if @code[0..offset-result.length].end_with?('::') and !@code[0..offset-result.length].end_with?('::')
-          result
-        end
-      end
-
-      def word
-        start_of_word
-      end
-
-      def end_of_word
-        @end_of_word ||= begin
-          match = @code[offset..-1].to_s.match(end_word_pattern)
-          match ? match[0] : ''
-        end
-      end
-
-      def remainder
-        end_of_word
-      end
-
-      def whole_word
-        start_of_word + end_of_word
-      end
-
-      # True if the current offset is inside a string.
-      #
-      # @return [Boolean]
-      def string?
-        @string ||= @source.string_at?(line, character)
-      end
-
-      # True if the current offset is inside a comment.
-      #
-      # @return [Boolean]
-      def comment?
-        @comment ||= @source.comment_at?(line, column)
-      end
-
-      # Get the range of the whole word at the current offset, including its
-      # remainder.
-      #
-      # @return [Range]
-      def word_range
-        @word_range ||= word_range_at(offset - start_of_word.length, offset + end_of_word.length)
-      end
-
-      # @return [Solargraph::Pin::Base]
-      def block
-        @block ||= @source.locate_block_pin(line, character)
-      end
-
-      # @return [Solargraph::Pin::Base]
-      def named_path
-        @named_path ||= @source.locate_named_path_pin(line, character)
-      end
-
-      # Get an array of all the locals that are visible from the fragment's
-      # position. Locals can be local variables, method parameters, or block
-      # parameters. The array starts with the nearest local pin.
-      #
-      # @return [Array<Solargraph::Pin::Base>]
-      def locals
-        @locals ||= @source.locals.select{|pin| pin.visible_from?(block, position)}.reverse
-      end
-
-      # True if the fragment is inside a literal value.
-      #
-      # @return [Boolean]
-      def literal?
-        !literal.nil?
-      end
-
-      # The fragment's literal type, or nil if the fragment is not inside a
-      # literal value.
-      #
-      # @return [String]
-      def literal
-        if @literal.nil? and !@calculated_actual_literal
-          @calculated_actual_literal = true
-          pn = @source.node_at(line, column)
-          @literal = infer_literal_node_type(pn)
-        end
-      end
-
-      # Get a set of available completions for the specified fragment. The
-      # resulting Completion object contains an array of pins and the range of
-      # text to replace in the source.
-      #
-      # @param api_map [ApiMap]
-      # @return [Completion]
-      def complete api_map
-        return Completion.new([], word_range) if chain.literal? or comment?
-        result = []
-        type = infer_base_type(api_map)
-        if chain.tail.constant?
-          result.concat api_map.get_constants(type.namespace, namespace)
-        else
-          result.concat api_map.get_complex_type_methods(type, namespace, chain.links.length == 1)
-          if chain.links.length == 1
-            if word.start_with?('@@')
-              return package_completions(api_map.get_class_variable_pins(namespace))
-            elsif word.start_with?('@')
-              return package_completions(api_map.get_instance_variable_pins(namespace, scope))
-            elsif word.start_with?('$')
-              return package_completions(api_map.get_global_variable_pins)
-            elsif word.start_with?(':') and !word.start_with?('::')
-              return package_completions(api_map.get_symbols)
-            end
-            result.concat api_map.get_constants('', namespace)
-            result.concat prefer_non_nil_variables(locals)
-            result.concat api_map.get_methods(namespace, scope: scope, visibility: [:public, :private, :protected])
-            result.concat api_map.get_methods('Kernel')
-            result.concat ApiMap.keywords
-          end
-        end
-        package_completions(result)
-      end
-
-      def define api_map
-        return [] if chain.literal?
-        return [] if string? or comment? or literal?
-        # HACK: Checking for self first because it's also a keyword
-        return [] if ApiMap::KEYWORDS.include?(chain.links.first.word) and chain.links.first.word != 'self'
-        chain.define_with(api_map, named_path, locals)
-      end
-
-      # Get an array of pins that describe the method being called by the
-      # argument list where the fragment is located. This is useful for queries
-      # that need to know what parameters the current method expects to receive.
-      #
-      # If the fragment is not inside an argument list, return an empty array.
-      #
-      # @param api_map [Solargraph::Source::Fragment]
-      # @return [Array<Solargraph::Pin::Base>]
-      def signify api_map
-        return [] unless argument?
-        return [] if recipient.whole_signature.nil? or recipient.whole_signature.empty?
-        result = []
-        result.concat recipient.define(api_map)
-        result.select{ |pin| pin.kind == Pin::METHOD }
-      end
-
-      # @param api_map [ApiMap]
-      # @return [ComplexType]
-      def infer_base_type api_map
-        chain.infer_base_type_with(api_map, named_path, locals)
-      end
-
-      private
-
-      # @return [Integer]
-      def offset
-        @offset ||= get_offset(line, column)
-      end
-
-      def get_offset line, column
-        Position.line_char_to_offset(@code, line, column)
-      end
-
-      def get_position_at(offset)
-        pos = Position.from_offset(@code, offset)
-        [pos.line, pos.character]
-      end
-
-      # @return Solargraph::Source::Range
-      def word_range_at first, last
-        s = Position.from_offset(@source.code, first)
-        e = Position.from_offset(@source.code, last)
-        Solargraph::Source::Range.new(s, e)
-      end
-
-      def signature_position
-        if @signature_position.nil?
-          open_parens = 0
-          cursor = offset - 1
-          while cursor >= 0
-            break if cursor < 0
-            if @code[cursor] == ')'
-              open_parens -= 1
-            elsif @code[cursor] == '('
-              open_parens += 1
-            end
-            break if open_parens == 1
-            cursor -= 1
-          end
-          if cursor >= 0
-            @signature_position = get_position_at(cursor)
-          end
-        end
-        @signature_position
-      end
-
-      def generate_chain
-        CallChainer.chain(source, line, column)
-      end
-
-      def start_word_pattern
-        /(@{1,2}|\$)?([a-z0-9_]|[^\u0000-\u007F])*\z/i
-      end
-
-      def end_word_pattern
-        /^([a-z0-9_]|[^\u0000-\u007F])*[\?\!]?/i
-      end
-
-      # @param fragment [Source::Fragment]
-      # @param result [Array<Pin::Base>]
-      # @return [Completion]
-      def package_completions result
-        frag_start = word.to_s.downcase
-        filtered = result.uniq(&:identifier).select{|s| s.name.downcase.start_with?(frag_start) and (s.kind != Pin::METHOD or s.name.match(/^[a-z0-9_]+(\!|\?|=)?$/i))}.sort_by.with_index{ |x, idx| [x.name, idx] }
-        Completion.new(filtered, word_range)
-      end
-
-      # Sort an array of pins to put nil or undefined variables last.
-      #
-      # @param pins [Array<Solargraph::Pin::Base>]
-      # @return [Array<Solargraph::Pin::Base>]
-      def prefer_non_nil_variables pins
-        result = []
-        nil_pins = []
-        pins.each do |pin|
-          if pin.variable? and pin.nil_assignment?
-            nil_pins.push pin
-          else
-            result.push pin
-          end
-        end
-        result + nil_pins
-      end
-    end
-  end
-end