cosmicgraph 0.49.0

data/lib/solargraph/source_map/clip.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class SourceMap
+    # A static analysis tool for obtaining definitions, completions,
+    # signatures, and type inferences from a cursor.
+    #
+    class Clip
+      # @param api_map [ApiMap]
+      # @param cursor [Source::Cursor]
+      def initialize api_map, cursor
+        @api_map = api_map
+        @cursor = cursor
+      end
+
+      # @return [Array<Pin::Base>]
+      def define
+        return [] if cursor.comment? || cursor.chain.literal?
+        result = cursor.chain.define(api_map, block, locals)
+        result.concat((source_map.pins + source_map.locals).select{ |p| p.name == cursor.word && p.location.range.contain?(cursor.position) }) if result.empty?
+        result
+      end
+
+      # @return [Completion]
+      def complete
+        return package_completions([]) if !source_map.source.parsed? || cursor.string?
+        return package_completions(api_map.get_symbols) if cursor.chain.literal? && cursor.chain.links.last.word == '<Symbol>'
+        return Completion.new([], cursor.range) if cursor.chain.literal?
+        if cursor.comment?
+          tag_complete
+        else
+          code_complete
+        end
+      end
+
+      # @return [Array<Pin::Base>]
+      def signify
+        return [] unless cursor.argument?
+        chain = Parser.chain(cursor.recipient_node, cursor.filename)
+        chain.define(api_map, context_pin, locals).select { |pin| pin.is_a?(Pin::Method) }
+      end
+
+      # @return [ComplexType]
+      def infer
+        result = cursor.chain.infer(api_map, block, locals)
+        if result.tag == 'Class'
+          # HACK: Exception to return Object from Class#new
+          dfn = cursor.chain.define(api_map, block, locals).first
+          return ComplexType.try_parse('Object') if dfn && dfn.path == 'Class#new'
+        end
+        return result unless result.tag == 'self'
+        ComplexType.try_parse(cursor.chain.base.infer(api_map, block, locals).namespace)
+      end
+
+      # Get an array of all the locals that are visible from the cursors'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_map.locals_at(location)
+      end
+
+      def gates
+        block.gates
+      end
+
+      def in_block?
+        return @in_block unless @in_block.nil?
+        @in_block = begin
+          tree = cursor.source.tree_at(cursor.position.line, cursor.position.column)
+          Parser.is_ast_node?(tree[1]) && [:block, :ITER].include?(tree[1].type)
+        end
+      end
+
+      # @param phrase [String]
+      # @return [Array<Solargraph::Pin::Base>]
+      def translate phrase
+        chain = Parser.chain(Parser.parse(phrase))
+        chain.define(api_map, block, locals)
+      end
+
+      private
+
+      # @return [ApiMap]
+      attr_reader :api_map
+
+      # @return [Source::Cursor]
+      attr_reader :cursor
+
+      # @return [SourceMap]
+      def source_map
+        @source_map ||= api_map.source_map(cursor.filename)
+      end
+
+      def location
+        Location.new(source_map.filename, Solargraph::Range.new(cursor.position, cursor.position))
+      end
+
+      # @return [Solargraph::Pin::Base]
+      def block
+        @block ||= source_map.locate_block_pin(cursor.node_position.line, cursor.node_position.character)
+      end
+
+      # The context at the current position.
+      #
+      # @return [Pin::Base]
+      def context_pin
+        @context_pin ||= source_map.locate_named_path_pin(cursor.node_position.line, cursor.node_position.character)
+      end
+
+      # @return [Array<Pin::Base>]
+      def yielded_self_pins
+        return [] unless block.is_a?(Pin::Block) && block.receiver
+        chain = Parser.chain(block.receiver, source_map.source.filename)
+        receiver_pin = chain.define(api_map, context_pin, locals).first
+        return [] if receiver_pin.nil?
+        result = []
+        ys = receiver_pin.docstring.tag(:yieldpublic)
+        unless ys.nil? || ys.types.empty?
+          ysct = ComplexType.try_parse(*ys.types).qualify(api_map, receiver_pin.context.namespace)
+          result.concat api_map.get_complex_type_methods(ysct, '', false)
+        end
+        result
+      end
+
+      # @return [Array<Pin::KeywordParam]
+      def complete_keyword_parameters
+        return [] unless cursor.argument? && cursor.chain.links.one? && cursor.word =~ /^[a-z0-9_]*:?$/
+        pins = signify
+        result = []
+        done = []
+        pins.each do |pin|
+          pin.parameters.each do |param|
+            next if done.include?(param.name)
+            done.push param.name
+            next unless param.keyword?
+            result.push Pin::KeywordParam.new(pin.location, "#{param.name}:")
+          end
+          if !pin.parameters.empty? && pin.parameters.last.kwrestarg?
+            pin.docstring.tags(:param).each do |tag|
+              next if done.include?(tag.name)
+              done.push tag.name
+              result.push Pin::KeywordParam.new(pin.location, "#{tag.name}:")
+            end
+          end
+        end
+        result
+      end
+
+      # @param result [Array<Pin::Base>]
+      # @return [Completion]
+      def package_completions result
+        frag_start = cursor.start_of_word.to_s.downcase
+        filtered = result.uniq(&:name).select { |s|
+          s.name.downcase.start_with?(frag_start) &&
+            (!s.is_a?(Pin::Method) || s.name.match(/^[a-z0-9_]+(\!|\?|=)?$/i))
+        }
+        Completion.new(filtered, cursor.range)
+      end
+
+      def tag_complete
+        result = []
+        match = source_map.code[0..cursor.offset-1].match(/[\[<, ]([a-z0-9_:]*)\z/i)
+        if match
+          full = match[1]
+          if full.include?('::')
+            if full.end_with?('::')
+              result.concat api_map.get_constants(full[0..-3], *gates)
+            else
+              result.concat api_map.get_constants(full.split('::')[0..-2].join('::'), *gates)
+            end
+          else
+            result.concat api_map.get_constants('', full.end_with?('::') ? '' : context_pin.full_context.namespace, *gates) #.select { |pin| pin.name.start_with?(full) }
+          end
+        end
+        package_completions(result)
+      end
+
+      def code_complete
+        result = []
+        result.concat complete_keyword_parameters
+        if cursor.chain.constant? || cursor.start_of_constant?
+          full = cursor.chain.links.first.word
+          type = if cursor.chain.undefined?
+            cursor.chain.base.infer(api_map, context_pin, locals)
+          else
+            if full.include?('::') && cursor.chain.links.length == 1
+              ComplexType.try_parse(full.split('::')[0..-2].join('::'))
+            elsif cursor.chain.links.length > 1
+              ComplexType.try_parse(full)
+            else
+              ComplexType::UNDEFINED
+            end
+          end
+          if type.undefined?
+            if full.include?('::')
+              result.concat api_map.get_constants(full, *gates)
+            else
+              result.concat api_map.get_constants('', cursor.start_of_constant? ? '' : context_pin.full_context.namespace, *gates) #.select { |pin| pin.name.start_with?(full) }
+            end
+          else
+            result.concat api_map.get_constants(type.namespace, cursor.start_of_constant? ? '' : context_pin.full_context.namespace, *gates)
+          end
+        else
+          type = cursor.chain.base.infer(api_map, block, locals)
+          result.concat api_map.get_complex_type_methods(type, block.binder.namespace, cursor.chain.links.length == 1)
+          if cursor.chain.links.length == 1
+            if cursor.word.start_with?('@@')
+              return package_completions(api_map.get_class_variable_pins(context_pin.full_context.namespace))
+            elsif cursor.word.start_with?('@')
+              return package_completions(api_map.get_instance_variable_pins(block.binder.namespace, block.binder.scope))
+            elsif cursor.word.start_with?('$')
+              return package_completions(api_map.get_global_variable_pins)
+            end
+            result.concat locals
+            result.concat api_map.get_constants(context_pin.context.namespace, *gates)
+            result.concat api_map.get_methods(block.binder.namespace, scope: block.binder.scope, visibility: [:public, :private, :protected])
+            result.concat api_map.get_methods('Kernel')
+            # result.concat ApiMap.keywords
+            result.concat api_map.keyword_pins.to_a
+            result.concat yielded_self_pins
+          end
+        end
+        package_completions(result)
+      end
+    end
+  end
+end

data/lib/solargraph/source_map/completion.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class SourceMap
+    # The result of a completion request containing the pins that describe
+    # completion options and the range to be replaced.
+    #
+    class Completion
+      # @return [Array<Solargraph::Pin::Base>]
+      attr_reader :pins
+
+      # @return [Solargraph::Range]
+      attr_reader :range
+
+      # @param pins [Array<Solargraph::Pin::Base>]
+      # @param range [Solargraph::Range]
+      def initialize pins, range
+        @pins = pins
+        @range = range
+      end
+    end
+  end
+end

data/lib/solargraph/source_map/mapper.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class SourceMap
+    # The Mapper generates pins and other data for SourceMaps.
+    #
+    # This class is used internally by the SourceMap class. Users should not
+    # normally need to call it directly.
+    #
+    class Mapper
+      # include Source::NodeMethods
+
+      private_class_method :new
+
+      MACRO_REGEXP = /(@\!method|@\!attribute|@\!visibility|@\!domain|@\!macro|@\!parse|@\!override)/.freeze
+
+      # Generate the data.
+      #
+      # @param source [Source]
+      # @return [Array]
+      def map source
+        @source = source
+        @filename = source.filename
+        @code = source.code
+        @comments = source.comments
+        @pins, @locals = Parser.map(source)
+        @pins.each { |p| p.source = :code }
+        @locals.each { |l| l.source = :code }
+        process_comment_directives
+        [@pins, @locals]
+      # rescue Exception => e
+      #   Solargraph.logger.warn "Error mapping #{source.filename}: [#{e.class}] #{e.message}"
+      #   Solargraph.logger.warn e.backtrace.join("\n")
+      #   [[], []]
+      end
+
+      # @param filename [String]
+      # @param code [String]
+      # @return [Array]
+      def unmap filename, code
+        s = Position.new(0, 0)
+        e = Position.from_offset(code, code.length)
+        location = Location.new(filename, Range.new(s, e))
+        [[Pin::Namespace.new(location: location, name: '')], []]
+      end
+
+      class << self
+        # @param source [Source]
+        # @return [Array]
+        def map source
+          return new.unmap(source.filename, source.code) unless source.parsed?
+          new.map source
+        end
+      end
+
+      # @return [Array<Solargraph::Pin::Base>]
+      def pins
+        @pins ||= []
+      end
+
+      # @param position [Solargraph::Position]
+      # @return [Solargraph::Pin::Closure]
+      def closure_at(position)
+        pins.select{|pin| pin.is_a?(Pin::Closure) and pin.location.range.contain?(position)}.last
+      end
+
+      def process_comment source_position, comment_position, comment
+        return unless comment.encode('UTF-8', invalid: :replace, replace: '?') =~ MACRO_REGEXP
+        cmnt = remove_inline_comment_hashes(comment)
+        parse = Solargraph::Source.parse_docstring(cmnt)
+        last_line = 0
+        # @param d [YARD::Tags::Directive]
+        parse.directives.each do |d|
+          line_num = find_directive_line_number(cmnt, d.tag.tag_name, last_line)
+          pos = Solargraph::Position.new(comment_position.line + line_num - 1, comment_position.column)
+          process_directive(source_position, pos, d)
+          last_line = line_num + 1
+        end
+      end
+
+      # @param comment [String]
+      # @return [Integer]
+      def find_directive_line_number comment, tag, start
+        # Avoid overruning the index
+        return start unless start < comment.lines.length
+        num = comment.lines[start..-1].find_index do |line|
+          # Legacy method directives might be `@method` instead of `@!method`
+          # @todo Legacy syntax should probably emit a warning
+          line.include?("@!#{tag}") || (tag == 'method' && line.include?("@#{tag}"))
+        end
+        num.to_i + start
+      end
+
+      # @param source_position [Position]
+      # @param comment_position [Position]
+      # @param directive [YARD::Tags::Directive]
+      # @return [void]
+      def process_directive source_position, comment_position, directive
+        docstring = Solargraph::Source.parse_docstring(directive.tag.text).to_docstring
+        location = Location.new(@filename, Range.new(comment_position, comment_position))
+        case directive.tag.tag_name
+        when 'method'
+          namespace = closure_at(source_position) || @pins.first
+          if namespace.location.range.start.line < comment_position.line
+            namespace = closure_at(comment_position)
+          end
+          begin
+            src = Solargraph::Source.load_string("def #{directive.tag.name};end", @source.filename)
+            region = Parser::Region.new(source: src, closure: namespace)
+            gen_pin = Parser.process_node(src.node, region).first.last
+            return if gen_pin.nil?
+            # Move the location to the end of the line so it gets recognized
+            # as originating from a comment
+            shifted = Solargraph::Position.new(comment_position.line, @code.lines[comment_position.line].to_s.chomp.length)
+            # @todo: Smelly instance variable access
+            gen_pin.instance_variable_set(:@comments, docstring.all.to_s)
+            gen_pin.instance_variable_set(:@location, Solargraph::Location.new(@filename, Range.new(shifted, shifted)))
+            gen_pin.instance_variable_set(:@explicit, false)
+            @pins.push gen_pin
+          rescue Parser::SyntaxError => e
+            # @todo Handle error in directive
+          end
+        when 'attribute'
+          return if directive.tag.name.nil?
+          namespace = closure_at(source_position)
+          t = (directive.tag.types.nil? || directive.tag.types.empty?) ? nil : directive.tag.types.flatten.join('')
+          if t.nil? || t.include?('r')
+            pins.push Solargraph::Pin::Method.new(
+              location: location,
+              closure: namespace,
+              name: directive.tag.name,
+              comments: docstring.all.to_s,
+              scope: namespace.is_a?(Pin::Singleton) ? :class : :instance,
+              visibility: :public,
+              explicit: false,
+              attribute: true
+            )
+          end
+          if t.nil? || t.include?('w')
+            pins.push Solargraph::Pin::Method.new(
+              location: location,
+              closure: namespace,
+              name: "#{directive.tag.name}=",
+              comments: docstring.all.to_s,
+              scope: namespace.is_a?(Pin::Singleton) ? :class : :instance,
+              visibility: :public,
+              attribute: true
+            )
+            pins.last.parameters.push Pin::Parameter.new(name: 'value', decl: :arg, closure: pins.last)
+            if pins.last.return_type.defined?
+              pins.last.docstring.add_tag YARD::Tags::Tag.new(:param, '', pins.last.return_type.to_s.split(', '), 'value')
+            end
+          end
+        when 'visibility'
+          begin
+            kind = directive.tag.text&.to_sym
+            return unless [:private, :protected, :public].include?(kind)
+
+            name = directive.tag.name
+            closure = closure_at(source_position) || @pins.first
+            if closure.location.range.start.line < comment_position.line
+              closure = closure_at(comment_position)
+            end
+            if closure.is_a?(Pin::Method) && no_empty_lines?(comment_position.line, source_position.line)
+              # @todo Smelly instance variable access
+              closure.instance_variable_set(:@visibility, kind)
+            else
+              matches = pins.select{ |pin| pin.is_a?(Pin::Method) && pin.name == name && pin.namespace == namespace && pin.context.scope == namespace.is_a?(Pin::Singleton) ? :class : :instance }
+              matches.each do |pin|
+                # @todo Smelly instance variable access
+                pin.instance_variable_set(:@visibility, kind)
+              end
+            end
+          end
+        when 'parse'
+          begin
+            ns = closure_at(source_position)
+            src = Solargraph::Source.load_string(directive.tag.text, @source.filename)
+            region = Parser::Region.new(source: src, closure: ns)
+            # @todo These pins may need to be marked not explicit
+            index = @pins.length
+            loff = if @code.lines[comment_position.line].strip.end_with?('@!parse')
+              comment_position.line + 1
+            else
+              comment_position.line
+            end
+            Parser.process_node(src.node, region, @pins)
+            @pins[index..-1].each do |p|
+              # @todo Smelly instance variable access
+              p.location.range.start.instance_variable_set(:@line, p.location.range.start.line + loff)
+              p.location.range.ending.instance_variable_set(:@line, p.location.range.ending.line + loff)
+            end
+          rescue Parser::SyntaxError => e
+            # @todo Handle parser errors in !parse directives
+          end
+        when 'domain'
+          namespace = closure_at(source_position) || Pin::ROOT_PIN
+          namespace.domains.concat directive.tag.types unless directive.tag.types.nil?
+        when 'override'
+          pins.push Pin::Reference::Override.new(location, directive.tag.name, docstring.tags)
+        end
+      end
+
+      def no_empty_lines?(line1, line2)
+        @code.lines[line1..line2].none? { |line| line.strip.empty? }
+      end
+
+      def remove_inline_comment_hashes comment
+        ctxt = ''
+        num = nil
+        started = false
+        comment.lines.each { |l|
+          # Trim the comment and minimum leading whitespace
+          p = l.encode('UTF-8', invalid: :replace, replace: '?').gsub(/^#/, '')
+          if num.nil? && !p.strip.empty?
+            num = p.index(/[^ ]/)
+            started = true
+          elsif started && !p.strip.empty?
+            cur = p.index(/[^ ]/)
+            num = cur if cur < num
+          end
+          ctxt += "#{p[num..-1]}" if started
+        }
+        ctxt
+      end
+
+      # @return [void]
+      def process_comment_directives
+        return unless @code.encode('UTF-8', invalid: :replace, replace: '?') =~ MACRO_REGEXP
+        code_lines = @code.lines
+        @source.associated_comments.each do |line, comments|
+          src_pos = line ? Position.new(line, code_lines[line].to_s.chomp.index(/[^\s]/) || 0) : Position.new(code_lines.length, 0)
+          com_pos = Position.new(line + 1 - comments.lines.length, 0)
+          process_comment(src_pos, com_pos, comments)
+        end
+      rescue StandardError => e
+        raise e.class, "Error processing comment directives in #{@filename}: #{e.message}"
+      end
+    end
+  end
+end

data/lib/solargraph/source_map.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require 'yard'
+require 'yard-solargraph'
+require 'set'
+
+module Solargraph
+  # An index of pins and other ApiMap-related data for a Source.
+  #
+  class SourceMap
+    autoload :Mapper,        'solargraph/source_map/mapper'
+    autoload :Clip,          'solargraph/source_map/clip'
+    autoload :Completion,    'solargraph/source_map/completion'
+
+    # @return [Source]
+    attr_reader :source
+
+    # @return [Array<Pin::Base>]
+    attr_reader :pins
+
+    # @return [Array<Pin::Base>]
+    attr_reader :locals
+
+    # @param source [Source]
+    # @param pins [Array<Pin::Base>]
+    # @param locals [Array<Pin::Base>]
+    def initialize source, pins, locals
+      # HACK: Keep the library from changing this
+      @source = source.dup
+      @pins = pins
+      @locals = locals
+      environ.merge Convention.for_local(self) unless filename.nil?
+      @pin_class_hash = pins.to_set.classify(&:class).transform_values(&:to_a)
+      @pin_select_cache = {}
+    end
+
+    def pins_by_class klass
+      @pin_select_cache[klass] ||= @pin_class_hash.select { |key, _| key <= klass }.values.flatten
+    end
+
+    def rebindable_method_names
+      @rebindable_method_names ||= pins_by_class(Pin::Method)
+        .select { |pin| pin.comments && pin.comments.include?('@yieldself') }
+        .map(&:name)
+        .to_set
+    end
+
+    # @return [String]
+    def filename
+      source.filename
+    end
+
+    # @return [String]
+    def code
+      source.code
+    end
+
+    # @return [Array<Pin::Reference::Require>]
+    def requires
+      pins_by_class(Pin::Reference::Require)
+    end
+
+    # @return [Environ]
+    def environ
+      @environ ||= Environ.new
+    end
+
+    # @return [Array<Pin::Base>]
+    def document_symbols
+      @document_symbols ||= pins.select { |pin|
+        pin.path && !pin.path.empty?
+      }
+    end
+
+    # @param query [String]
+    # @return [Array<Pin::Base>]
+    def query_symbols query
+      Pin::Search.new(document_symbols, query).results
+    end
+
+    # @param position [Position]
+    # @return [Source::Cursor]
+    def cursor_at position
+      Source::Cursor.new(source, position)
+    end
+
+    # @param path [String]
+    # @return [Pin::Base]
+    def first_pin path
+      pins.select { |p| p.path == path }.first
+    end
+
+    # @param location [Solargraph::Location]
+    # @return [Array<Solargraph::Pin::Base>]
+    def locate_pins location
+      # return nil unless location.start_with?("#{filename}:")
+      (pins + locals).select { |pin| pin.location == location }
+    end
+
+    def locate_named_path_pin line, character
+      _locate_pin line, character, Pin::Namespace, Pin::Method
+    end
+
+    def locate_block_pin line, character
+      _locate_pin line, character, Pin::Namespace, Pin::Method, Pin::Block
+    end
+
+    # @param other_map [SourceMap]
+    # @return [Boolean]
+    def try_merge! other_map
+      return false if pins.length != other_map.pins.length || locals.length != other_map.locals.length || requires.map(&:name).uniq.sort != other_map.requires.map(&:name).uniq.sort
+      pins.each_index do |i|
+        return false unless pins[i].try_merge!(other_map.pins[i])
+      end
+      locals.each_index do |i|
+        return false unless locals[i].try_merge!(other_map.locals[i])
+      end
+      @source = other_map.source
+      true
+    end
+
+    # @param name [String]
+    # @return [Array<Location>]
+    def references name
+      source.references name
+    end
+
+    # @param location [Location]
+    # @return [Array<Pin::LocalVariable>]
+    def locals_at(location)
+      return [] if location.filename != filename
+      closure = locate_named_path_pin(location.range.start.line, location.range.start.character)
+      locals.select { |pin| pin.visible_at?(closure, location) }
+    end
+
+    class << self
+      # @param filename [String]
+      # @return [SourceMap]
+      def load filename
+        source = Solargraph::Source.load(filename)
+        SourceMap.map(source)
+      end
+
+      # @param code [String]
+      # @param filename [String, nil]
+      # @return [SourceMap]
+      def load_string code, filename = nil
+        source = Solargraph::Source.load_string(code, filename)
+        SourceMap.map(source)
+      end
+
+      # @param source [Source]
+      # @return [SourceMap]
+      def map source
+        result = SourceMap::Mapper.map(source)
+        new(source, *result)
+      end
+    end
+
+    private
+
+    # @param line [Integer]
+    # @param character [Integer]
+    # @param klasses [Array<Class>]
+    # @return [Pin::Base]
+    def _locate_pin line, character, *klasses
+      position = Position.new(line, character)
+      found = nil
+      pins.each do |pin|
+        # @todo Attribute pins should not be treated like closures, but
+        #   there's probably a better way to handle it
+        next if pin.is_a?(Pin::Method) && pin.attribute?
+        found = pin if (klasses.empty? || klasses.any? { |kls| pin.is_a?(kls) } ) && pin.location.range.contain?(position)
+        break if pin.location.range.start.line > line
+      end
+      # Assuming the root pin is always valid
+      found || pins.first
+    end
+  end
+end