Sha256: be223db82b4ae33d6c9ad989116de2c0d00d9d276a9335f106b40e8f37951e24
Contents?: true
Size: 1.86 KB
Versions: 6
Compression:
Stored size: 1.86 KB
Contents
class YARD::Handlers::Ruby::Legacy::AttributeHandler < YARD::Handlers::Ruby::Legacy::Base
handles /\Aattr(?:_(?:reader|writer|accessor))?(?:\s|\()/
def process
begin
attr_type = statement.tokens.first.text.to_sym
symbols = tokval_list statement.tokens[2..-1], :attr, TkTRUE, TkFALSE
read, write = true, false
rescue SyntaxError
raise YARD::Parser::UndocumentableError, attr_type
end
# Change read/write based on attr_reader/writer/accessor
case attr_type
when :attr
# In the case of 'attr', the second parameter (if given) isn't a symbol.
write = symbols.pop if symbols.size == 2
when :attr_accessor
write = true
when :attr_reader
# change nothing
when :attr_writer
read, write = false, true
end
# Add all attributes
symbols.each do |name|
namespace.attributes[scope][name] = SymbolHash[:read => nil, :write => nil]
# Show their methods as well
{:read => name, :write => "#{name}="}.each do |type, meth|
next unless (type == :read ? read : write)
namespace.attributes[scope][name][type] = MethodObject.new(namespace, meth, scope) do |o|
if type == :write
src = "def #{meth}(value)"
full_src = "#{src}\n @#{name} = value\nend"
doc = "Sets the attribute +#{name}+\n@param value the value to set the attribute +#{name}+ to."
else
src = "def #{meth}"
full_src = "#{src}\n @#{name}\nend"
doc = "Returns the value of attribute +#{name}+"
end
o.source ||= full_src
o.signature ||= src
o.docstring = statement.comments.to_s.empty? ? doc : statement.comments
end
# Register the objects explicitly
register namespace.attributes[scope][name][type]
end
end
end
end
Version data entries
6 entries across 6 versions & 1 rubygems