module Solargraph::YardMap::Mapper::ToMethod

def self.make code_object, name = nil, scope = nil, visibility = nil, closure = nil, spec = nil

Returns:
  • (Solargraph::Pin::Method) -

Parameters:
  • spec (Gem::Specification, nil) --
  • closure (Solargraph::Pin::Namespace, nil) --
  • visibility (Symbol, nil) --
  • scope (Symbol, nil) --
  • name (String, nil) --
  • code_object (YARD::CodeObjects::Base) --
def self.make code_object, name = nil, scope = nil, visibility = nil, closure = nil, spec = nil
  closure ||= Solargraph::Pin::Namespace.new(
    name: code_object.namespace.to_s,
    gates: [code_object.namespace.to_s]
  )
  location = object_location(code_object, spec)
  name ||= code_object.name.to_s
  return_type = ComplexType::SELF if name == 'new'
  comments = code_object.docstring ? code_object.docstring.all.to_s : ''
  pin = Pin::Method.new(
    location: location,
    closure: closure,
    name: name,
    comments: comments,
    scope: scope || code_object.scope,
    visibility: visibility || code_object.visibility,
    # @todo Might need to convert overloads to signatures

    parameters: [],
    explicit: code_object.is_explicit?,
    return_type: return_type
  )
  pin.parameters.concat get_parameters(code_object, location, comments, pin)
  pin
end

def arg_name a

Returns:
  • (String) -

Parameters:
  • a (Array) --
def arg_name a
  a[0].gsub(/[^a-z0-9_]/i, '')
end

def arg_type a

Returns:
  • (::Symbol) -

Parameters:
  • a (Array) --
def arg_type a
  if a[0].start_with?('**')
    :kwrestarg
  elsif a[0].start_with?('*')
    :restarg
  elsif a[0].start_with?('&')
    :blockarg
  elsif a[0].end_with?(':')
    a[1] ? :kwoptarg : :kwarg
  elsif a[1]
    :optarg
  else
    :arg
  end
end

def get_parameters code_object, location, comments, pin

Returns:
  • (Array) -

Parameters:
  • pin (Pin::Base) --
  • comments (String) --
  • location (Location) -- ,
  • code_object (YARD::CodeObjects::Base) --
def get_parameters code_object, location, comments, pin
  return [] unless code_object.is_a?(YARD::CodeObjects::MethodObject)
  # HACK: Skip `nil` and `self` parameters that are sometimes emitted

  # for methods defined in C

  # See https://github.com/castwide/solargraph/issues/345

  code_object.parameters.select { |a| a[0] && a[0] != 'self' }.map do |a|
    Solargraph::Pin::Parameter.new(
      location: location,
      closure: pin,
      comments: comments,
      name: arg_name(a),
      presence: nil,
      decl: arg_type(a),
      asgn_code: a[1]
    )
  end
end