Sha256: 10a621946a76af2418304368e5eb847300b3c4accc0b558455b428d8f405a1a2

Contents?: true

Size: 1.39 KB

Versions: 63

Compression:

Stored size: 1.39 KB

Contents

# frozen_string_literal: true
# (see Ruby::AliasHandler)
class YARD::Handlers::Ruby::Legacy::AliasHandler < YARD::Handlers::Ruby::Legacy::Base
  handles(/\Aalias(_method)?(\s|\()/)
  namespace_only

  process do
    if TkALIAS === statement.tokens.first
      tokens = statement.tokens[2..-1].to_s.split(/\s+/)
      names = [tokens[0], tokens[1]].map {|t| t.gsub(/^:(['"])?(.+?)\1?$|^(:)(.+)/, '\2') }
    else
      names = tokval_list(statement.tokens[2..-1], :attr)
    end
    raise YARD::Parser::UndocumentableError, statement.tokens.first.text if names.size != 2

    names = names.map {|n| Symbol === n ? n.to_s.delete('"') : n }
    new_meth = names[0].to_sym
    old_meth = names[1].to_sym
    old_obj = namespace.child(:name => old_meth, :scope => scope)
    new_obj = register MethodObject.new(namespace, new_meth, scope) do |o|
      o.add_file(parser.file, statement.tokens.first.line_no, statement.comments)
    end

    if old_obj
      new_obj.signature = old_obj.signature
      new_obj.source = old_obj.source
      new_obj.docstring = old_obj.docstring + YARD::Docstring.new(statement.comments)
      new_obj.docstring.line_range = statement.comments_range
      new_obj.docstring.hash_flag = statement.comments_hash_flag
      new_obj.docstring.object = new_obj
    else
      new_obj.signature = "def #{new_meth}" # this is all we know.
    end

    namespace.aliases[new_obj] = old_meth
  end
end

Version data entries

63 entries across 62 versions & 9 rubygems

Version Path
abaci-0.3.0 vendor/bundle/gems/yard-0.9.7/lib/yard/handlers/ruby/legacy/alias_handler.rb
yard-0.9.7 lib/yard/handlers/ruby/legacy/alias_handler.rb
yard-0.9.6 lib/yard/handlers/ruby/legacy/alias_handler.rb