module Solargraph::Pin::Conversions

@todo Move this stuff. It should be the responsibility of the language server. @todo abstract methods below should be verified to be overridden

by type checker when mixin included by non-abstract class

Public Instance Methods

completion_item ()

Source

# File lib/solargraph/pin/conversions.rb, line 38
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]

completion_item_kind ()

Source

# File lib/solargraph/pin/conversions.rb, line 17
def completion_item_kind
  raise NotImplementedError
end

@return [Integer] @abstract

deprecated? ()

Source

# File lib/solargraph/pin/conversions.rb, line 23
def deprecated?
  raise NotImplementedError
end

@abstract @return [Boolean]

detail ()

Source

# File lib/solargraph/pin/conversions.rb, line 71
def detail
  # This property is not cached in an instance variable because it can
  # change when pins get proxied.
  detail = String.new
  detail += "=#{probed? ? '~' : (proxied? ? '^' : '>')} #{return_type.to_s}" unless return_type.undefined?
  detail.strip!
  return nil if detail.empty?
  detail
end

@return [String, nil]

link_documentation ()

Source

# File lib/solargraph/pin/conversions.rb, line 84
def link_documentation
  @link_documentation ||= generate_link
end

Get a markdown-flavored link to a documentation page.

@return [String]

probed? ()

Source

# File lib/solargraph/pin/conversions.rb, line 28
def probed?
  raise NotImplementedError
end

@abstract

proxied? ()

Source

# File lib/solargraph/pin/conversions.rb, line 33
def proxied?
  raise NotImplementedError
end

@abstract

reset_conversions ()

Source

# File lib/solargraph/pin/conversions.rb, line 96
def reset_conversions
  @completion_item = nil
  @resolve_completion_item = nil
  @signature_help = nil
  @detail = nil
  @link_documentation = nil
end

@return [void]

resolve_completion_item ()

Source

# File lib/solargraph/pin/conversions.rb, line 53
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]

signature_help ()

Source

# File lib/solargraph/pin/conversions.rb, line 66
def signature_help
  []
end

@return [::Array<Hash>]

text_documentation ()

Source

# File lib/solargraph/pin/conversions.rb, line 89
def text_documentation
  this_path = path || name || return_type.tag
  return nil if this_path == 'undefined'
  escape_brackets this_path
end

@return [String, nil]

Private Instance Methods

escape_brackets (text)

Source

# File lib/solargraph/pin/conversions.rb, line 117
def escape_brackets text
  # text.gsub(/(\<|\>)/, "\\#{$1}")
  text.gsub("<", '\<').gsub(">", '\>')
end

@param text [String] @return [String]

generate_link ()

Source

# File lib/solargraph/pin/conversions.rb, line 107
def generate_link
  this_path = path || name || return_type.tag
  return nil if this_path == 'undefined'
  return nil if this_path.nil? || this_path == 'undefined'
  return this_path if path.nil?
  "[#{escape_brackets(this_path).gsub('_', '\\\\_')}](solargraph:/document?query=#{CGI.escape(this_path)})"
end

@return [String, nil]