jimeh-solargraph 0.40.4.0

data/lib/solargraph/pin/block.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class Block < Closure
+      # The signature of the method that receives this block.
+      #
+      # @return [Parser::AST::Node]
+      attr_reader :receiver
+
+      def initialize receiver: nil, args: [], **splat
+        super(**splat)
+        @receiver = receiver
+        @parameters = args
+      end
+
+      # @param api_map [ApiMap]
+      # @return [void]
+      def rebind api_map
+        @binder ||= binder_or_nil(api_map)
+      end
+
+      def binder
+        @binder || closure.binder
+      end
+
+      # @return [Array<String>]
+      def parameters
+        @parameters ||= []
+      end
+
+      # @return [Array<String>]
+      def parameter_names
+        @parameter_names ||= parameters.map(&:name)
+      end
+
+      private
+
+      # @param api_map [ApiMap]
+      # @return [ComplexType, nil]
+      def binder_or_nil api_map
+        return nil unless receiver
+        word = receiver.children.find { |c| c.is_a?(::Symbol) }.to_s
+        return nil unless api_map.rebindable_method_names.include?(word)
+        chain = Parser.chain(receiver, location.filename)
+        locals = api_map.source_map(location.filename).locals_at(location)
+        if ['instance_eval', 'instance_exec', 'class_eval', 'class_exec', 'module_eval', 'module_exec'].include?(chain.links.last.word)
+          return chain.base.infer(api_map, self, locals)
+        else
+          receiver_pin = chain.define(api_map, self, locals).first
+          if receiver_pin && receiver_pin.docstring
+            ys = receiver_pin.docstring.tag(:yieldself)
+            if ys && ys.types && !ys.types.empty?
+              return ComplexType.try_parse(*ys.types).qualify(api_map, receiver_pin.context.namespace)
+            end
+          end
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/solargraph/pin/class_variable.rb

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

data/lib/solargraph/pin/closure.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class Closure < Base
+      # @return [::Symbol] :class or :instance
+      attr_reader :scope
+
+      def initialize scope: :class, **splat
+        super(**splat)
+        @scope = scope
+      end
+
+      def context
+        @context ||= begin
+          result = super
+          if scope == :instance
+            Solargraph::ComplexType.parse(result.namespace)
+          else
+            result
+          end
+        end
+      end
+
+      def binder
+        @binder || context
+      end
+
+      # @return [Array<String>]
+      def gates
+        # @todo This check might not be necessary. There should always be a
+        #   root pin
+        closure ? closure.gates : ['']
+      end
+    end
+  end
+end

data/lib/solargraph/pin/common.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    module Common
+      # @return [Location]
+      attr_reader :location
+
+      # @return [Pin::Base, nil]
+      attr_reader :closure
+
+      # @return [String]
+      def name
+        @name ||= ''
+      end
+
+      # @return [ComplexType]
+      def return_type
+        @return_type ||= ComplexType::UNDEFINED
+      end
+
+      # @return [ComplexType]
+      def context
+        # Get the static context from the nearest namespace
+        @context ||= find_context
+      end
+      alias full_context context
+
+      # @return [String]
+      def namespace
+        context.namespace.to_s
+      end
+
+      # @return [ComplexType]
+      def binder
+        @binder || context
+      end
+
+      # @return [String]
+      def comments
+        @comments ||= ''
+      end
+
+      # @return [String]
+      def path
+        @path ||= name.empty? ? context.namespace : "#{context.namespace}::#{name}"
+      end
+
+      private
+
+      # @return [ComplexType]
+      def find_context
+        here = closure
+        until here.nil?
+          if here.is_a?(Pin::Namespace)
+            return here.return_type
+          elsif here.is_a?(Pin::Method)
+            if here.scope == :instance
+              return ComplexType.try_parse(here.context.namespace)
+            else
+              return here.context
+            end
+          end
+          here = here.closure
+        end
+        ComplexType::ROOT
+      end
+    end
+  end
+end

data/lib/solargraph/pin/constant.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class Constant < BaseVariable
+      attr_reader :visibility
+
+      def initialize visibility: :public, **splat
+        super(**splat)
+        @visibility = visibility
+      end
+
+      def return_type
+        @return_type ||= generate_complex_type
+      end
+
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::CONSTANT
+      end
+
+      # @return [Integer]
+      def symbol_kind
+        LanguageServer::SymbolKinds::CONSTANT
+      end
+
+      def path
+        @path ||= context.namespace.to_s.empty? ? name : "#{context.namespace}::#{name}"
+      end
+
+      private
+
+      # @return [ComplexType]
+      def generate_complex_type
+        tags = docstring.tags(:return).map(&:types).flatten.reject(&:nil?)
+        if tags.empty?
+          tags = docstring.tags(:type).map(&:types).flatten.reject(&:nil?)
+        end
+        return ComplexType::UNDEFINED if tags.empty?
+        ComplexType.try_parse *tags
+      end
+    end
+  end
+end

data/lib/solargraph/pin/conversions.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'cgi'
+
+module Solargraph
+  module Pin
+    # @todo Move this stuff. It should be the responsibility of the language server.
+    module Conversions
+      # @return [Hash]
+      def completion_item
+        @completion_item ||= {
+          label: name,
+          kind: completion_item_kind,
+          detail: detail,
+          data: {
+            path: path,
+            return_type: return_type.tag,
+            location: (location ? location.to_hash : nil),
+            deprecated: deprecated?
+          }
+        }
+      end
+
+      # @return [Hash]
+      def resolve_completion_item
+        @resolve_completion_item ||= begin
+          extra = {}
+          alldoc = ''
+          # alldoc += link_documentation unless link_documentation.nil?
+          # alldoc += "\n\n" unless alldoc.empty?
+          alldoc += documentation unless documentation.nil?
+          extra[:documentation] = alldoc unless alldoc.empty?
+          completion_item.merge(extra)
+        end
+      end
+
+      # @return [Hash]
+      def signature_help
+        @signature_help ||= {
+          label: name + '(' + parameters.map(&:full).join(', ') + ')',
+          documentation: documentation
+        }
+      end
+
+      # @return [String]
+      def detail
+        # This property is not cached in an instance variable because it can
+        # change when pins get proxied.
+        detail = String.new
+        detail += "(#{parameters.map(&:full).join(', ')}) " unless !is_a?(Pin::Method) || parameters.empty?
+        detail += "=#{probed? ? '~' : (proxied? ? '^' : '>')} #{return_type.to_s}" unless return_type.undefined?
+        detail.strip!
+        return nil if detail.empty?
+        detail
+      end
+
+      # Get a markdown-flavored link to a documentation page.
+      #
+      # @return [String]
+      def link_documentation
+        @link_documentation ||= generate_link
+      end
+
+      def text_documentation
+        this_path = path || return_type.tag
+        return nil if this_path == 'undefined'
+        escape_brackets this_path
+      end
+
+      def reset_conversions
+        @completion_item = nil
+        @resolve_completion_item = nil
+        @signature_help = nil
+        @detail = nil
+        @link_documentation = nil
+      end
+
+      private
+
+      # @return [String]
+      def generate_link
+        this_path = path || return_type.tag
+        return nil if this_path == 'undefined'
+        return nil if this_path.nil? || this_path == 'undefined'
+        "[#{escape_brackets(this_path).gsub('_', '\\\\_')}](solargraph:/document?query=#{CGI.escape(this_path)})"
+      end
+
+      # @param text [String]
+      # @return [String]
+      def escape_brackets text
+        # text.gsub(/(\<|\>)/, "\\#{$1}")
+        text.gsub("<", '\<').gsub(">", '\>')
+      end
+    end
+  end
+end

data/lib/solargraph/pin/documenting.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'kramdown'
+require 'kramdown-parser-gfm'
+require 'yard'
+require 'reverse_markdown'
+require 'solargraph/converters/dl'
+require 'solargraph/converters/dt'
+require 'solargraph/converters/dd'
+require 'solargraph/converters/misc'
+
+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(Kramdown::Document.new(escape_brackets(@plaintext), input: 'GFM').to_html)
+        end
+
+        private
+
+        # @param text [String]
+        # @return [String]
+        def escape_brackets text
+          # text.gsub(/(\[[^\]]*\])([^\(]|\z)/, '!!!^\1^!!!\2')
+          text.gsub('[', '!!!!b').gsub(']', 'e!!!!')
+        end
+
+        # @param text [String]
+        # @return [String]
+        def unescape_brackets text
+          text.gsub('!!!!b', '[').gsub('e!!!!', ']')
+        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