module Solargraph::YardMap::Mapper::ToMethod

Public Class Methods

make(code_object, name = nil, scope = nil, visibility = nil, closure = nil, spec = nil) click to toggle source
# File lib/solargraph/yard_map/mapper/to_method.rb, line 9
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)
  comments = code_object.docstring ? code_object.docstring.all.to_s : ''
  pin = Pin::Method.new(
    location: location,
    closure: closure,
    name: name || code_object.name.to_s,
    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?
  )
  pin.parameters.concat get_parameters(code_object, location, comments, pin)
  pin
end

Private Class Methods

arg_name(a) click to toggle source

@param a [Array] @return [String]

# File lib/solargraph/yard_map/mapper/to_method.rb, line 56
def arg_name a
  a[0].gsub(/[^a-z0-9_]/i, '')
end
arg_type(a) click to toggle source

@param a [Array] @return [::Symbol]

# File lib/solargraph/yard_map/mapper/to_method.rb, line 62
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
get_parameters(code_object, location, comments, pin) click to toggle source

@param code_object [YARD::CodeObjects::Base] @return [Array<Solargraph::Pin::Parameter>]

# File lib/solargraph/yard_map/mapper/to_method.rb, line 36
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