Table of Contents - virtus-1.0.5 Documentation
Pages
- LICENSE
-
README
- Virtus
- Ruby Object Mapper
- Installation
- Examples
- Using Virtus with Classes
- Cherry-picking extensions
- Using Virtus with Modules
- Dynamically Extending Instances
- Default Values
- Default values on dynamically extended instances
- Embedded Value
- Collection Member Coercions
- Hash attributes coercion
- IMPORTANT note about Boolean type
- IMPORTANT note about member coercions
- Value Objects
- Custom Coercions
- Private Attributes
- Overriding setters
- Strict Coercion Mode
- Nullify Blank Strings Mode
- Building modules with custom configuration
- Attribute Finalization and Circular Dependencies
- Ruby version support
- Credits
- Contributing
- TODO
Classes and Modules
- Virtus
- Virtus::Attribute
- Virtus::Attribute::Accessor
- Virtus::Attribute::Boolean
- Virtus::Attribute::Builder
- Virtus::Attribute::Coercer
- Virtus::Attribute::Coercible
- Virtus::Attribute::Collection
- Virtus::Attribute::DefaultValue
- Virtus::Attribute::DefaultValue::FromCallable
- Virtus::Attribute::DefaultValue::FromClonable
- Virtus::Attribute::DefaultValue::FromSymbol
- Virtus::Attribute::EmbeddedValue
- Virtus::Attribute::EmbeddedValue::FromOpenStruct
- Virtus::Attribute::EmbeddedValue::FromStruct
- Virtus::Attribute::Hash
- Virtus::Attribute::LazyDefault
- Virtus::Attribute::NullifyBlank
- Virtus::Attribute::Strict
- Virtus::AttributeSet
- Virtus::Builder
- Virtus::Builder::HookContext
- Virtus::ClassInclusions
- Virtus::ClassInclusions::Methods
- Virtus::ClassMethods
- Virtus::Coercer
- Virtus::CoercionError
- Virtus::Configuration
- Virtus::ConstMissingExtensions
- Virtus::Equalizer
- Virtus::Equalizer::Methods
- Virtus::Extensions
- Virtus::Extensions::AllowedWriterMethods
- Virtus::Extensions::Methods
- Virtus::InstanceMethods
- Virtus::InstanceMethods::Constructor
- Virtus::InstanceMethods::MassAssignment
- Virtus::Model
- Virtus::Model::Constructor
- Virtus::Model::Core
- Virtus::Model::MassAssignment
- Virtus::ModelBuilder
- Virtus::ModuleBuilder
- Virtus::ModuleExtensions
- Virtus::Options
- Virtus::PendingAttribute
- Virtus::TypeDefinition
- Virtus::TypeLookup
- Virtus::ValueObject
- Virtus::ValueObject::AllowedWriterMethods
- Virtus::ValueObject::ClassMethods
- Virtus::ValueObject::InstanceMethods
- Virtus::ValueObjectBuilder
Methods
- ::build — Virtus::Attribute
- ::build — Virtus::Attribute::DefaultValue
- ::build_coercer — Virtus::Attribute
- ::build_coercer — Virtus::Attribute::EmbeddedValue
- ::build_type — Virtus::Attribute
- ::build_type — Virtus::Attribute::Boolean
- ::build_type — Virtus::Attribute::Collection
- ::build_type — Virtus::Attribute::EmbeddedValue
- ::build_type — Virtus::Attribute::Hash
- ::call — Virtus::Attribute::Builder
- ::call — Virtus::Builder
- ::coerce — Virtus::Attribute
- ::coerce — Virtus
- ::coerce= — Virtus
- ::coercer — Virtus
- ::config — Virtus
- ::configuration — Virtus
- ::create — Virtus::AttributeSet
- ::determine_type — Virtus::Attribute::Builder
- ::extended — Virtus
- ::extended — Virtus::Attribute::Accessor
- ::extended — Virtus::ClassMethods
- ::extended — Virtus::Extensions
- ::extended — Virtus::Extensions::Methods
- ::extended — Virtus::Model
- ::extended — Virtus::Model::Core
- ::extended — Virtus::Model::MassAssignment
- ::extended — Virtus::ModuleExtensions
- ::extended — Virtus::TypeLookup
- ::finalize — Virtus
- ::handle? — Virtus::Attribute::DefaultValue::FromCallable
- ::handle? — Virtus::Attribute::DefaultValue::FromClonable
- ::handle? — Virtus::Attribute::DefaultValue::FromSymbol
- ::handles? — Virtus::Attribute::EmbeddedValue
- ::included — Virtus
- ::included — Virtus::ClassInclusions
- ::included — Virtus::Model
- ::included — Virtus::Model::Core
- ::included — Virtus::Model::Constructor
- ::included — Virtus::Model::MassAssignment
- ::included — Virtus::ValueObject
- ::merge_options! — Virtus::Attribute
- ::merge_options! — Virtus::Attribute::Collection
- ::merge_options! — Virtus::Attribute::Hash
- ::model — Virtus
- ::module — Virtus
- ::new — Virtus::CoercionError
- ::new — Virtus::Attribute
- ::new — Virtus::PendingAttribute
- ::new — Virtus::TypeDefinition
- ::new — Virtus::Attribute::Builder
- ::new — Virtus::Attribute::Coercer
- ::new — Virtus::Attribute::DefaultValue
- ::new — Virtus::AttributeSet
- ::new — Virtus::Builder
- ::new — Virtus::Builder::HookContext
- ::new — Virtus::Coercer
- ::new — Virtus::Configuration
- ::new — Virtus::Equalizer
- ::new — Virtus::InstanceMethods::Constructor
- ::pending — Virtus::Builder
- ::setup — Virtus::ModuleExtensions
- ::value_object — Virtus
- ::warn — Virtus
- #<< — Virtus::AttributeSet
- #<< — Virtus::Equalizer
- #== — Virtus::Equalizer::Methods
- #[] — Virtus::AttributeSet
- #[] — Virtus::InstanceMethods
- #[]= — Virtus::AttributeSet
- #[]= — Virtus::InstanceMethods
- #accept_options — Virtus::Options
- #accepted_options — Virtus::Options
- #add_accepted_options — Virtus::Options
- #add_extended_hook — Virtus::Builder
- #add_included_hook — Virtus::Builder
- #add_included_hook — Virtus::ModuleBuilder
- #allowed_methods — Virtus::ClassMethods
- #allowed_methods — Virtus::InstanceMethods
- #allowed_writer_methods — Virtus::ClassInclusions::Methods
- #allowed_writer_methods — Virtus::Extensions::AllowedWriterMethods
- #allowed_writer_methods — Virtus::ValueObject::AllowedWriterMethods
- #assert_valid_name — Virtus::ClassMethods
- #assert_valid_name — Virtus::InstanceMethods
- #attribute — Virtus::Extensions::Methods
- #attribute — Virtus::ModuleExtensions
- #attribute — Virtus::ValueObject::ClassMethods
- #attribute_name — Virtus::CoercionError
- #attribute_name? — Virtus::CoercionError
- #attribute_set — Virtus::ClassInclusions::Methods
- #attribute_set — Virtus::ClassMethods
- #attribute_set — Virtus::Extensions::Methods
- #attributes — Virtus::ClassMethods
- #attributes — Virtus::InstanceMethods::MassAssignment
- #attributes= — Virtus::InstanceMethods::MassAssignment
- #build_message — Virtus::CoercionError
- #call — Virtus::Attribute::Coercer
- #call — Virtus::Attribute::DefaultValue
- #call — Virtus::Attribute::DefaultValue::FromCallable
- #call — Virtus::Attribute::DefaultValue::FromClonable
- #call — Virtus::Attribute::DefaultValue::FromSymbol
- #call — Virtus::Attribute::EmbeddedValue::FromStruct
- #call — Virtus::Attribute::EmbeddedValue::FromOpenStruct
- #call — Virtus::Coercer
- #clone — Virtus::ValueObject::InstanceMethods
- #coerce — Virtus::Attribute
- #coerce — Virtus::Attribute::Collection
- #coerce — Virtus::Attribute::Hash
- #coerce — Virtus::AttributeSet
- #coerce — Virtus::Attribute::NullifyBlank
- #coerce — Virtus::Attribute::Strict
- #coercer — Virtus::Configuration
- #coercible? — Virtus::Attribute
- #const_missing — Virtus::ConstMissingExtensions
- #constructor? — Virtus::Builder::HookContext
- #define_accessor_methods — Virtus::Attribute
- #define_accessor_methods — Virtus::Attribute::Boolean
- #define_attributes — Virtus::ModuleExtensions
- #define_cmp_method — Virtus::Equalizer
- #define_hash_method — Virtus::Equalizer
- #define_inspect_method — Virtus::Equalizer
- #define_methods — Virtus::Equalizer
- #define_option_method — Virtus::Options
- #define_reader_method — Virtus::AttributeSet
- #define_writer_method — Virtus::AttributeSet
- #defined? — Virtus::Attribute::Accessor
- #determine_coercer — Virtus::Attribute::Builder
- #determine_type — Virtus::PendingAttribute
- #determine_type — Virtus::TypeLookup
- #determine_type_and_cache — Virtus::TypeLookup
- #determine_type_from_descendant — Virtus::TypeLookup
- #determine_type_from_primitive — Virtus::TypeLookup
- #determine_type_from_string — Virtus::TypeLookup
- #determine_visibility — Virtus::Attribute::Builder
- #dup — Virtus::ValueObject::InstanceMethods
- #each — Virtus::AttributeSet
- #eql? — Virtus::Equalizer::Methods
- #equalizer — Virtus::ValueObject::ClassMethods
- #extended — Virtus::ModuleExtensions
- #extensions — Virtus::Builder
- #extensions — Virtus::ValueObjectBuilder
- #finalize — Virtus::Attribute
- #finalize — Virtus::PendingAttribute
- #finalize — Virtus::Attribute::Collection
- #finalize — Virtus::Attribute::Hash
- #finalize — Virtus::AttributeSet
- #finalize? — Virtus::Builder::HookContext
- #finalized? — Virtus::Attribute
- #finalized? — Virtus::PendingAttribute
- #finalized? — Virtus::Attribute::Collection
- #finalized? — Virtus::Attribute::Hash
- #freeze — Virtus::InstanceMethods
- #get — Virtus::AttributeSet
- #get — Virtus::Attribute::Accessor
- #get — Virtus::Attribute::LazyDefault
- #include_comparison_methods — Virtus::Equalizer
- #included — Virtus::ModuleExtensions
- #inherited — Virtus::ClassMethods
- #inherited — Virtus::Options
- #initialize_attribute — Virtus::Attribute::Builder
- #initialize_attribute_method — Virtus::Builder::HookContext
- #initialize_class — Virtus::Attribute::Builder
- #initialize_coercer — Virtus::Attribute::Builder
- #initialize_default_value — Virtus::Attribute::Builder
- #initialize_options — Virtus::Attribute::Builder
- #initialize_primitive — Virtus::TypeDefinition
- #initialize_type — Virtus::Attribute::Builder
- #lazy? — Virtus::Attribute
- #mass_assignment? — Virtus::Builder::HookContext
- #merge — Virtus::AttributeSet
- #merge_attributes — Virtus::AttributeSet
- #modules — Virtus::Builder::HookContext
- #nullify_blank? — Virtus::Attribute
- #options — Virtus::Builder
- #options — Virtus::ValueObjectBuilder
- #options — Virtus::Options
- #pending? — Virtus::TypeDefinition
- #primitive — Virtus::TypeLookup
- #public_reader? — Virtus::Attribute::Accessor
- #public_writer? — Virtus::Attribute::Accessor
- #rename — Virtus::Attribute
- #required? — Virtus::Attribute
- #reset — Virtus::AttributeSet
- #reset_attribute — Virtus::InstanceMethods
- #set — Virtus::AttributeSet
- #set — Virtus::Attribute::Accessor
- #set — Virtus::Attribute::Coercible
- #set_default_attributes — Virtus::InstanceMethods
- #set_default_attributes! — Virtus::InstanceMethods
- #set_default_value — Virtus::Attribute::Accessor
- #set_defaults — Virtus::AttributeSet
- #set_options — Virtus::Options
- #skip_default? — Virtus::AttributeSet
- #strict? — Virtus::Attribute
- #success? — Virtus::Attribute::Coercer
- #success? — Virtus::Coercer
- #target_type — Virtus::CoercionError
- #to_h — Virtus::Configuration
- #to_h — Virtus::InstanceMethods::MassAssignment
- #to_hash — Virtus::InstanceMethods::MassAssignment
- #update_index — Virtus::AttributeSet
- #value_coerced? — Virtus::Attribute
- #value_coerced? — Virtus::Attribute::Boolean
- #values — Virtus::Extensions::Methods
- #with — Virtus::ValueObject::InstanceMethods
- #with_hook_context — Virtus::Builder