Contents

# Handles any constant assignment
class YARD::Handlers::Ruby::ConstantHandler < YARD::Handlers::Ruby::Base
  include YARD::Handlers::Ruby::StructHandlerMethods
  namespace_only
  handles :assign
  
  process do
    if statement[1].call? && statement[1][0][0] == s(:const, "Struct") && 
        statement[1][2] == s(:ident, "new")
      process_structclass(statement)
    elsif statement[0].type == :var_field && statement[0][0].type == :const
      process_constant(statement)
    end
  end
  
  private
  
  def process_constant(statement)
    name = statement[0][0][0]
    value = statement[1].source
    register ConstantObject.new(namespace, name) {|o| o.source = statement; o.value = value.strip }
  end
  
  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]))
    else
      raise YARD::Parser::UndocumentableError, "Struct assignment to #{statement[0].source}"
    end
  end
  
  # 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
  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
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
yard-0.6.8	lib/yard/handlers/ruby/constant_handler.rb
yard-0.6.7	lib/yard/handlers/ruby/constant_handler.rb
yard-0.6.6	lib/yard/handlers/ruby/constant_handler.rb
yard-0.6.5	lib/yard/handlers/ruby/constant_handler.rb
yard-0.6.4	lib/yard/handlers/ruby/constant_handler.rb
yard-0.6.3	lib/yard/handlers/ruby/constant_handler.rb
yard-0.6.2	lib/yard/handlers/ruby/constant_handler.rb