Class: Castkit::Attribute

Inherits:
Object
  • Object
show all
Includes:
Castkit::AttributeExtensions::Access, Castkit::AttributeExtensions::Casting, Castkit::AttributeExtensions::Options, Castkit::AttributeExtensions::Serialization, Castkit::AttributeExtensions::Validation
Defined in:
lib/castkit/attribute.rb

Overview

Represents a typed attribute on a Castkit::DataObject.

Provides casting, validation, access control, and serialization behavior.

Constant Summary

Constants included from Castkit::AttributeExtensions::ErrorHandling

Castkit::AttributeExtensions::ErrorHandling::ERROR_OPTIONS

Constants included from Castkit::AttributeExtensions::Casting

Castkit::AttributeExtensions::Casting::PRIMITIVE_CASTERS

Constants included from Castkit::AttributeExtensions::Options

Castkit::AttributeExtensions::Options::DEFAULT_OPTIONS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Castkit::AttributeExtensions::Serialization

#dump, #load

Methods included from Castkit::AttributeExtensions::Access

#access, #full_access?, #ignore?, #readable?, #skip_deserialization?, #skip_serialization?, #writeable?

Methods included from Castkit::AttributeExtensions::Options

#alias_paths, #composite?, #dataobject?, #dataobject_collection?, #default, #ignore_blank?, #ignore_nil?, #key, #key_path, #optional?, #prefix, #required?, #unwrapped?

Constructor Details

#initialize(field, type, default: nil, **options) ⇒ Attribute

Initializes a new attribute definition.

Parameters:

  • field (Symbol) —

    the name of the attribute

  • type (Symbol, Class, Array) —

    the type or array of types

  • default (Object, Proc) (defaults to: nil) —

    optional default value

  • options (Hash) —

    additional configuration options



37
38
39
40
41
42
43
44
 
# File 'lib/castkit/attribute.rb', line 37

def initialize(field, type, default: nil, **options)
  @field = field
  @type = normalize_type(type)
  @default = default
  @options = populate_options(options)

  validate!
end

Instance Attribute Details

#field ⇒ Symbol (readonly)

Returns the attribute name.

Returns:

  • (Symbol) —

    the attribute name



23
24
25
 
# File 'lib/castkit/attribute.rb', line 23

def field
  @field
end

#options ⇒ Hash (readonly)

Returns attribute options (including aliases, default, access, etc.).

Returns:

  • (Hash) —

    attribute options (including aliases, default, access, etc.)



29
30
31
 
# File 'lib/castkit/attribute.rb', line 29

def options
  @options
end

#type ⇒ Symbol, ... (readonly)

Returns the declared type (normalized).

Returns:

  • (Symbol, Class, Array) —

    the declared type (normalized)



26
27
28
 
# File 'lib/castkit/attribute.rb', line 26

def type
  @type
end

Instance Method Details

#to_hash ⇒ Hash Also known as: to_h

Returns a hash representation of the attribute definition.

Returns:

  • (Hash) 


49
50
51
52
53
54
55
56
 
# File 'lib/castkit/attribute.rb', line 49

def to_hash
  {
    field: field,
    type: type,
    options: options,
    default: default
  }
end