Class: CacheCrispies::Attribute

Inherits:
Object
  • Object
show all
Defined in:
lib/cache_crispies/attribute.rb

Overview

Reperesents a single serialized attribute in a serializer. It’s generated by a call to either Base.serialize or Base.merge.

Defined Under Namespace

Classes: InvalidCoercionType

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key, from: nil, with: nil, through: nil, to: nil, collection: nil, optional: nil, nesting: [], conditions: [], &block) ⇒ Attribute

Initializes a new CacheCrispies::Attribute instance

Parameters:

  • key (Symbol) —

    the JSON key for this attribute

  • from (Symbol) (defaults to: nil) —

    the method on the model to call to get the value

  • with (CacheCrispies::Base) (defaults to: nil) —

    a serializer to use to serialize the

  • to (Class, Symbol) (defaults to: nil) —

    the data type to coerce the value into

  • collection (Boolean) (defaults to: nil) —

    force rendering as single or collection

  • optional (Boolean) (defaults to: nil) —

    render only if included in the option’s ‘included` array

  • nesting (Array<Symbol>) (defaults to: []) —

    the JSON keys this attribute will be nested inside

  • conditions (Array<CacheCrispies::Condition>) (defaults to: []) —

    the show_if condition blocks this attribute is nested inside. These will be evaluated for thruthiness and must all be true for this attribute to reneder. argument’s value



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/cache_crispies/attribute.rb', line 26

def initialize(
  key,
  from: nil, with: nil, through: nil, to: nil, collection: nil,
  optional: nil,
  nesting: [], conditions: [],
  &block
)
  @key = key
  @method_name = from || key || :itself
  @serializer = with
  @through = through
  @coerce_to = to
  @collection = collection
  @nesting = Array(nesting)
  @conditions = Array(conditions)
  @block = block

  @conditions << Optional.new(key) if optional
end

Instance Attribute Details

#block ⇒ Object (readonly)

Returns the value of attribute block.



46
47
48
 
# File 'lib/cache_crispies/attribute.rb', line 46

def block
  @block
end

#coerce_to ⇒ Object (readonly)

Returns the value of attribute coerce_to.



46
47
48
 
# File 'lib/cache_crispies/attribute.rb', line 46

def coerce_to
  @coerce_to
end

#collection ⇒ Object (readonly)

Returns the value of attribute collection.



46
47
48
 
# File 'lib/cache_crispies/attribute.rb', line 46

def collection
  @collection
end

#conditions ⇒ Object (readonly)

Returns the value of attribute conditions.



46
47
48
 
# File 'lib/cache_crispies/attribute.rb', line 46

def conditions
  @conditions
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



46
47
48
 
# File 'lib/cache_crispies/attribute.rb', line 46

def key
  @key
end

#method_name ⇒ Object (readonly)

Returns the value of attribute method_name.



46
47
48
 
# File 'lib/cache_crispies/attribute.rb', line 46

def method_name
  @method_name
end

#nesting ⇒ Object (readonly)

Returns the value of attribute nesting.



46
47
48
 
# File 'lib/cache_crispies/attribute.rb', line 46

def nesting
  @nesting
end

#serializer ⇒ Object (readonly)

Returns the value of attribute serializer.



46
47
48
 
# File 'lib/cache_crispies/attribute.rb', line 46

def serializer
  @serializer
end

#through ⇒ Object (readonly)

Returns the value of attribute through.



46
47
48
 
# File 'lib/cache_crispies/attribute.rb', line 46

def through
  @through
end

Instance Method Details

#value_for(target, options) ⇒ Object

Gets the value of the attribute for the given target object and options

Parameters:

  • target (Object) —

    typically ActiveRecord::Base, but could be anything

  • options (Hash) —

    any optional values from the serializer instance

Returns:

  • the value for the attribute for the given model and options

Raises:



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/cache_crispies/attribute.rb', line 65

def value_for(target, options)
  value =
    if block?
      block.call(target, options)
    elsif through?
      target.public_send(through)&.public_send(method_name)
    else
      target.public_send(method_name)
    end

  serializer ? serialize(value, options) : coerce(value)
end