Class Virtus::Attribute
In: lib/virtus/attribute/lazy_default.rb
lib/virtus/attribute/default_value.rb
lib/virtus/attribute/coercible.rb
lib/virtus/attribute/collection.rb
lib/virtus/attribute/boolean.rb
lib/virtus/attribute/builder.rb
lib/virtus/attribute/accessor.rb
lib/virtus/attribute/strict.rb
lib/virtus/attribute/default_value/from_callable.rb
lib/virtus/attribute/default_value/from_symbol.rb
lib/virtus/attribute/default_value/from_clonable.rb
lib/virtus/attribute/nullify_blank.rb
lib/virtus/attribute/embedded_value.rb
lib/virtus/attribute/hash.rb
lib/virtus/attribute/coercer.rb
lib/virtus/attribute.rb
Parent: Object

Attribute objects handle coercion and provide interface to hook into an attribute set instance that‘s included into a class or object

@example 

  # non-strict mode
  attr = Virtus::Attribute.build(Integer)
  attr.coerce('1')
  # => 1

  # strict mode
  attr = Virtus::Attribute.build(Integer, :strict => true)
  attr.coerce('not really coercible')
  # => Virtus::CoercionError: Failed to coerce "fsafa" into Integer

Methods

axiom_type?   axiom_type?   build   build_coercer   build_type   coerce   coerce   coercible?   coercion_method   coercion_method   define_accessor_methods   determine_type   finalize   finalized?   infer_key_and_value_types   infer_member_type   lazy?   merge_options!   new   nullify_blank?   pending?   pending?   primitive   rename   required?   strict?   value_coerced?  

Included Modules

::Equalizer

Classes and Modules

Module Virtus::Attribute::Accessor
Module Virtus::Attribute::Coercible
Module Virtus::Attribute::LazyDefault
Module Virtus::Attribute::NullifyBlank
Module Virtus::Attribute::Strict
Class Virtus::Attribute::Boolean
Class Virtus::Attribute::Builder
Class Virtus::Attribute::Coercer
Class Virtus::Attribute::Collection
Class Virtus::Attribute::DefaultValue
Class Virtus::Attribute::EmbeddedValue
Class Virtus::Attribute::Hash

Attributes

coercer  [R]  @api private
default_value  [R]  @api private
options  [R]  @api private
primitive  [R]  @api private
type  [R]  Return type of this attribute

@return [Axiom::Types::Type]

@api public

Public Class methods

axiom_type?(type)

@api private

build(type, options = {})

Builds an attribute instance

@param [Class,Array,Hash,String,Symbol] type 

  this can be an explicit class or an object from which virtus can infer
  the type

@param [to_hash] options 

  optional extra options hash

@return [Attribute]

@api public

coerce(value = Undefined)

@see Virtus.coerce

@deprecated

@api public

merge_options!(*)

@api private

Public Instance methods

coerce(input)

Coerce the input into the expected type

@example 

  attr = Virtus::Attribute.build(String)
  attr.coerce(:one) # => 'one'

@param [Object] input

@api public

coercible?()

Return if the attribute is coercible

@example 

  attr = Virtus::Attribute.build(String, :coerce => true)
  attr.coercible? # => true

  attr = Virtus::Attribute.build(String, :coerce => false)
  attr.coercible? # => false

@return [Boolean]

@api public

coercion_method()

@api private

finalize()

@api private

finalized?()

Return if the attribute was already finalized

@example 

  attr = Virtus::Attribute.build(String, :finalize => true)
  attr.finalized? # => true

  attr = Virtus::Attribute.build(String, :finalize => false)
  attr.finalized? # => false

@return [Boolean]

@api public

lazy?()

Return if the attribute has lazy default value evaluation

@example 

  attr = Virtus::Attribute.build(String, :lazy => true)
  attr.lazy? # => true

  attr = Virtus::Attribute.build(String, :lazy => false)
  attr.lazy? # => false

@return [Boolean]

@api public

nullify_blank?()

Return if the attribute is in the nullify blank coercion mode

@example 

  attr = Virtus::Attribute.build(String, :nullify_blank => true)
  attr.nullify_blank? # => true

  attr = Virtus::Attribute.build(String, :nullify_blank => false)
  attr.nullify_blank? # => false

@return [Boolean]

@api public

primitive()

@api private

rename(name)

Return a new attribute with the new name

@param [Symbol] name

@return [Attribute]

@api public

required?()

Return if the attribute is accepts nil values as valid coercion output

@example 

  attr = Virtus::Attribute.build(String, :required => true)
  attr.required? # => true

  attr = Virtus::Attribute.build(String, :required => false)
  attr.required? # => false

@return [Boolean]

@api public

strict?()

Return if the attribute is in the strict coercion mode

@example 

  attr = Virtus::Attribute.build(String, :strict => true)
  attr.strict? # => true

  attr = Virtus::Attribute.build(String, :strict => false)
  attr.strict? # => false

@return [Boolean]

@api public

value_coerced?(value)

Return if the given value was coerced

@param [Object] value

@return [Boolean]

@api public

[Validate]