solargraph 0.39.7

data/lib/solargraph/pin/documenting.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'maruku'
+require 'yard'
+require 'reverse_markdown'
+require 'solargraph/converters/dl'
+require 'solargraph/converters/dt'
+require 'solargraph/converters/dd'
+require 'solargraph/converters/misc'
+
+# HACK: Setting :html_parser through `Maruku.new` does not work
+MaRuKu::Globals[:html_parser] = 'nokogiri'
+
+module Solargraph
+  module Pin
+    # A module to add the Pin::Base#documentation method.
+    #
+    module Documenting
+      # A documentation formatter that either performs Markdown conversion for
+      # text, or applies backticks for code blocks.
+      #
+      class DocSection
+        # @return [String]
+        attr_reader :plaintext
+
+        # @param code [Boolean] True if this section is a code block
+        def initialize code
+          @plaintext = String.new('')
+          @code = code
+        end
+
+        def code?
+          @code
+        end
+
+        # @param text [String]
+        # @return [String]
+        def concat text
+          @plaintext.concat text
+        end
+
+        def to_s
+          return "\n```ruby\n#{@plaintext}#{@plaintext.end_with?("\n") ? '' : "\n"}```\n\n" if code?
+          ReverseMarkdown.convert unescape_brackets(Maruku.new(escape_brackets(@plaintext), on_error: :raise).to_html)
+        rescue MaRuKu::Exception
+          # Maruku exceptions usually indicate that the documentation is in
+          # RDoc syntax.
+          ReverseMarkdown.convert YARD::Templates::Helpers::Markup::RDocMarkup.new(@plaintext).to_html
+        end
+
+        private
+
+        # @param text [String]
+        # @return [String]
+        def escape_brackets text
+          text.gsub(/(\[[^\]]*\])([^\(]|\z)/, '!!!`\1`!!!\2')
+        end
+
+        # @param text [String]
+        # @return [String]
+        def unescape_brackets text
+          text.gsub('!!!`[', '[').gsub(']`!!!', ']')
+        end
+      end
+
+      # @return [String]
+      def documentation
+        @documentation ||= begin
+          # Using DocSections allows for code blocks that start with an empty
+          # line and at least two spaces of indentation. This is a common
+          # convention in Ruby core documentation, e.g., String#split.
+          sections = [DocSection.new(false)]
+          normalize_indentation(docstring.to_s).gsub(/\t/, '  ').lines.each do |l|
+            if l.strip.empty?
+              sections.last.concat l
+            else
+              if (l =~ /^  [^\s]/ && sections.last.plaintext =~ /(\r?\n[ \t]*?){2,}$/) || (l.start_with?('  ') && sections.last.code?)
+                # Code block
+                sections.push DocSection.new(true) unless sections.last.code?
+                sections.last.concat l[2..-1]
+              else
+                # Regular documentation
+                sections.push DocSection.new(false) if sections.last.code?
+                sections.last.concat l
+              end
+            end
+          end
+          sections.map(&:to_s).join
+        end
+      end
+
+      private
+
+      # @param text [String]
+      # @return [String]
+      def normalize_indentation text
+        text.lines.map { |l| remove_odd_spaces(l) }.join
+      end
+
+      # @param line [String]
+      # @return [String]
+      def remove_odd_spaces line
+        return line unless line.start_with?(' ')
+        spaces = line.match(/^ +/)[0].length
+        return line unless spaces.odd?
+        line[1..-1]
+      end
+    end
+  end
+end

data/lib/solargraph/pin/duck_method.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    # DuckMethod pins are used to add completion items for type tags that
+    # use duck typing, e.g., `@param file [#read]`.
+    #
+    class DuckMethod < Pin::Method
+      # @param location [Solargraph::Location]
+      # @param name [String]
+      # def initialize location, name
+      #   # super(location, '', name, nil, :instance, :public, [])
+      # end
+    end
+  end
+end

data/lib/solargraph/pin/global_variable.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class GlobalVariable < BaseVariable
+    end
+  end
+end

data/lib/solargraph/pin/instance_variable.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class InstanceVariable < BaseVariable
+      def binder
+        closure.binder
+      end
+
+      def scope
+        closure.binder.scope
+      end
+
+      def context
+        @context ||= begin
+          result = super
+          if scope == :class
+            ComplexType.parse("Class<#{result.namespace}>")
+          else
+            ComplexType.parse("#{result.namespace}")
+          end
+        end
+      end
+
+      def nearly? other
+        super && binder == other.binder
+      end
+    end
+  end
+end

data/lib/solargraph/pin/keyword.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class Keyword < Base
+      def initialize name
+        super(name: name)
+      end
+
+      def name
+        @name
+      end
+    end
+  end
+end

data/lib/solargraph/pin/keyword_param.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class KeywordParam < Symbol
+    end
+  end
+end

data/lib/solargraph/pin/local_variable.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class LocalVariable < BaseVariable
+      include Localized
+
+      def initialize assignment: nil, presence: nil, **splat
+        super(**splat)
+        @assignment = assignment
+        @presence = presence
+      end
+
+      def try_merge! pin
+        return false unless super
+        @presence = pin.presence
+        true
+      end
+    end
+  end
+end

data/lib/solargraph/pin/localized.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    module Localized
+      # @return [Range]
+      attr_reader :presence
+
+      # @param other [Pin::Base] The caller's block
+      # @param position [Position, Array(Integer, Integer)] The caller's position
+      # @return [Boolean]
+      def visible_from?(other, position)
+        position = Position.normalize(position)
+        other.filename == filename &&
+          match_tags(other.full_context.tag, full_context.tag) &&
+          (other == closure ||
+            (closure.location.range.contain?(other.location.range.start) && closure.location.range.contain?(other.location.range.ending))
+          ) &&
+          presence.contain?(position)
+      end
+
+      # @param other_loc [Location]
+      def visible_at?(other_loc)
+        return false if location.filename != other_loc.filename
+        presence.include?(other_loc.range.start)
+      end
+
+      private
+
+      # @param tag1 [String]
+      # @param tag2 [String]
+      # @return [Boolean]
+      def match_tags tag1, tag2
+        # @todo This is an unfortunate hack made necessary by a discrepancy in
+        #   how tags indicate the root namespace. The long-term solution is to
+        #   standardize it, whether it's `Class<>`, an empty string, or
+        #   something else.
+        tag1 == tag2 ||
+          (['', 'Class<>'].include?(tag1) && ['', 'Class<>'].include?(tag2))
+      end
+    end
+  end
+end

data/lib/solargraph/pin/method.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class Method < BaseMethod
+      include Solargraph::Parser::NodeMethods
+
+      # @return [Array<String>]
+      attr_reader :parameters
+
+      # @param args [Array<String>]
+      # @param node [Parser::AST::Node, nil]
+      def initialize parameters: [], node: nil, **splat
+        super(**splat)
+        @parameters = parameters
+        @node = node
+      end
+
+      # @return [Array<String>]
+      def parameter_names
+        @parameter_names ||= parameters.map(&:name)
+      end
+
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::METHOD
+      end
+
+      def symbol_kind
+        LanguageServer::SymbolKinds::METHOD
+      end
+
+      def nearly? other
+        return false unless super
+        parameters == other.parameters and
+          scope == other.scope and
+          visibility == other.visibility
+      end
+
+      def probe api_map
+        infer_from_return_nodes(api_map)
+      end
+
+      def try_merge! pin
+        return false unless super
+        @node = pin.node
+        true
+      end
+
+      # @return [Array<Pin::Method>]
+      def overloads
+        @overloads ||= docstring.tags(:overload).map do |tag|
+          Solargraph::Pin::Method.new(
+            name: name,
+            closure: self,
+            # args: tag.parameters.map(&:first),
+            parameters: tag.parameters.map do |src|
+              Pin::Parameter.new(
+                location: location,
+                closure: self,
+                comments: tag.docstring.all.to_s,
+                name: src.first,
+                presence: location ? location.range : nil,
+                decl: :arg
+              )
+            end,
+            comments: tag.docstring.all.to_s
+          )
+        end
+      end
+
+      private
+
+      # @return [Parser::AST::Node, nil]
+      def method_body_node
+        return nil if node.nil?
+        return node.children[1].children.last if node.type == :DEFN
+        return node.children[2].children.last if node.type == :DEFS
+        return node.children[2] if node.type == :def || node.type == :DEFS
+        return node.children[3] if node.type == :defs
+        nil
+      end
+
+      # @param api_map [ApiMap]
+      # @return [ComplexType]
+      def infer_from_return_nodes api_map
+        return ComplexType::UNDEFINED if node.nil?
+        result = []
+        has_nil = false
+        return ComplexType::NIL if method_body_node.nil?
+        returns_from(method_body_node).each do |n|
+          if n.nil? || [:NIL, :nil].include?(n.type)
+            has_nil = true
+            next
+          end
+          rng = Range.from_node(n)
+          next unless rng
+          clip = api_map.clip_at(
+            location.filename,
+            rng.ending
+          )
+          chain = Solargraph::Parser.chain(n, location.filename)
+          type = chain.infer(api_map, self, clip.locals)
+          result.push type unless type.undefined?
+        end
+        result.push ComplexType::NIL if has_nil
+        return ComplexType::UNDEFINED if result.empty?
+        ComplexType.try_parse(*result.map(&:tag).uniq)
+      end
+    end
+  end
+end

data/lib/solargraph/pin/method_alias.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    # Use this class to track method aliases for later remapping. Common
+    # examples that defer mapping are aliases for superclass methods or
+    # methods from included modules.
+    #
+    class MethodAlias < BaseMethod
+      # @return [::Symbol]
+      attr_reader :scope
+
+      # @return [String]
+      attr_reader :original
+
+      def initialize scope: :instance, original: nil, **splat
+        super(**splat)
+        @scope = scope
+        @original = original
+      end
+
+      def visibility
+        :public
+      end
+
+      def path
+        @path ||= namespace + (scope == :instance ? '#' : '.') + name
+      end
+    end
+  end
+end

data/lib/solargraph/pin/namespace.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class Namespace < Closure
+      # @return [::Symbol] :public or :private
+      attr_reader :visibility
+
+      # @return [::Symbol] :class or :module
+      attr_reader :type
+
+      # @param type [Symbol] :class or :module
+      # @param visibility [Symbol] :public or :private
+      # @param gates [Array<String>]
+      def initialize type: :class, visibility: :public, gates: [''], **splat
+        # super(location, namespace, name, comments)
+        super(**splat)
+        @type = type
+        @visibility = visibility
+        if name.start_with?('::')
+          @name = name[2..-1]
+          @closure = Solargraph::Pin::ROOT_PIN
+        end
+        @open_gates = gates
+        if @open_gates.one? && @open_gates.first.empty? && @name.include?('::')
+          # In this case, a chained namespace was opened (e.g., Foo::Bar)
+          # but Foo does not exist.
+          parts = @name.split('::')
+          @name = parts.pop
+          @closure = Pin::Namespace.new(name: parts.join('::'), gates: [parts.join('::')])
+          @context = nil
+        end
+      end
+
+      def namespace
+        context.namespace
+      end
+
+      def full_context
+        @full_context ||= ComplexType.try_parse("#{type.to_s.capitalize}<#{path}>")
+      end
+
+      def binder
+        full_context
+      end
+
+      def scope
+        context.scope
+      end
+
+      def completion_item_kind
+        (type == :class ? LanguageServer::CompletionItemKinds::CLASS : LanguageServer::CompletionItemKinds::MODULE)
+      end
+
+      # @return [Integer]
+      def symbol_kind
+        (type == :class ? LanguageServer::SymbolKinds::CLASS : LanguageServer::SymbolKinds::MODULE)
+      end
+
+      def path
+        @path ||= (namespace.empty? ? '' : "#{namespace}::") + name
+      end
+
+      def return_type
+        @return_type ||= ComplexType.try_parse( (type == :class ? 'Class' : 'Module') + "<#{path}>" )
+      end
+
+      def domains
+        @domains ||= []
+      end
+
+      def typify api_map
+        return_type
+      end
+
+      def gates
+        @gates ||= if path.empty?
+          @open_gates
+        else
+          [path] + @open_gates
+        end
+      end
+    end
+  end
+end