Module: Virtus::ClassMethods

Defined in:

lib/virtus/class_methods.rb

Instance Method Summary

• #attribute(name, type, options = {}) ⇒ Virtus::Attributes::Object

  Defines an attribute on an object’s class.

• #attributes ⇒ Hash

  Returns all the attributes defined on a Class.

Instance Method Details

#attribute(name, type, options = {}) ⇒ Virtus::Attributes::Object

Defines an attribute on an object’s class.

Usage:

class Book
  include Virtus

  attribute :title,        String
  attribute :author,       String
  attribute :published_at, DateTime
  attribute :page_count,   Integer
end

Parameters:

• name (Symbol) —

  the name of an attribute

• type (Class) —

  the type class of an attribute

• options (Hash) (defaults to: {}) —

  the extra options hash

Returns:

• (Virtus::Attributes::Object)

# File 'lib/virtus/class_methods.rb', line 28

def attribute(name, type, options = {})
  attribute_klass  = Virtus.determine_type(type)
  attributes[name] = attribute_klass.new(name, self, options)
end

#attributes ⇒ Hash

Returns all the attributes defined on a Class.

Returns:

• (Hash) —

  an attributes hash indexed by attribute names

# File 'lib/virtus/class_methods.rb', line 39

def attributes
  @attributes ||= {}
end