class YARD::Handlers::Ruby::ConstantHandler
Handles any constant assignment
Private Instance Methods
extract_parameters(superclass)
click to toggle source
Extract the parameters from the Struct.new AST node, returning them as a list of strings
@param [MethodCallNode] superclass the AST node for the Struct.new call @return [Array<String>] the member names to generate methods for
# File lib/yard/handlers/ruby/constant_handler.rb, line 49 def extract_parameters(superclass) return [] unless superclass.parameters members = superclass.parameters.select {|x| x && x.type == :symbol_literal } members.map! {|x| x.source.strip[1..-1] } members end
process_constant(statement)
click to toggle source
# File lib/yard/handlers/ruby/constant_handler.rb, line 21 def process_constant(statement) name = statement[0].source value = statement[1].source obj = P(namespace, name) if obj.is_a?(NamespaceObject) && obj.namespace == namespace raise YARD::Parser::UndocumentableError, "constant for existing #{obj.type} #{obj}" else ensure_loaded! obj.parent register ConstantObject.new(namespace, name) {|o| o.source = statement; o.value = value.strip } end end
process_structclass(statement)
click to toggle source
# File lib/yard/handlers/ruby/constant_handler.rb, line 33 def process_structclass(statement) lhs = statement[0][0] if lhs.type == :const klass = create_class(lhs[0], P(:Struct)) create_attributes(klass, extract_parameters(statement[1])) parse_block(statement[1].block[1], :namespace => klass) unless statement[1].block.nil? else raise YARD::Parser::UndocumentableError, "Struct assignment to #{statement[0].source}" end end