Module: Familia::Features::SafeDump

Extended by:
ClassMethods
Defined in:
lib/familia/features/safe_dump.rb

Overview

SafeDump is a mixin that allows models to define a list of fields that are safe to dump. This is useful for serializing objects to JSON or other formats where you want to ensure that only certain fields are exposed.

To use SafeDump, include it in your model and use the DSL methods to define safe dump fields. The fields can be either symbols or hashes. If a field is a symbol, the method with the same name will be called on the object to retrieve the value. If the field is a hash, the key is the field name and the value is a lambda that will be called with the object as an argument. The hash syntax allows you to: * define a field name that is different from the method name * define a field that requires some computation on-the-fly * define a field that is not a method on the object

Example:

feature :safe_dump

safe_dump_field :objid safe_dump_field :updated safe_dump_field :created safe_dump_field :active, ->(obj) { obj.active? }

Alternatively, you can define multiple fields at once:

safe_dump_fields :objid, :updated, :created, { active: ->(obj) { obj.active? } }

Internally, all fields are normalized to the hash syntax and stored in of symbols in the order they were defined.

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.safe_dump_field(field_name, callable = nil) ⇒ Object Originally defined in module ClassMethods

Define a single safe dump field

Parameters:

  • field_name (Symbol) —

    The name of the field

  • callable (Proc, nil) (defaults to: nil) —

    Optional callable to transform the value

.safe_dump_field_map ⇒ Object Originally defined in module ClassMethods

Returns the field map used for dumping

.safe_dump_field_names ⇒ Object Originally defined in module ClassMethods

Returns an array of safe dump field names in the order they were defined

.safe_dump_fields(*fields) ⇒ Object Originally defined in module ClassMethods

Define multiple safe dump fields at once

Parameters:

  • fields (Array) —

    Mixed array of symbols and hashes

.set_safe_dump_fields(*fields) ⇒ Object Originally defined in module ClassMethods

Legacy method for setting safe dump fields (for backward compatibility)

Instance Method Details

#safe_dump ⇒ Object

Returns a hash of safe fields and their values. This method calls the callables defined in the safe_dump_field_map with the instance object as an argument.

The return values are not cached, so if you call this method multiple times, the callables will be called each time.

Example:

class Customer < Familia::HashKey include SafeDump @safe_dump_fields = [ :name, { :active => ->(cust) { cust.active? } } ]

def active?
  true # or false
end

cust = Customer.new :name => 'Lucy'
cust.safe_dump
#=> { :name => 'Lucy', :active => true }



134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/familia/features/safe_dump.rb', line 134

def safe_dump
  self.class.safe_dump_field_map.transform_values do |callable|
    transformed_value = callable.call(self)

    # If the value is a relative ancestor of SafeDump we can
    # call safe_dump on it, otherwise we'll just return the value as-is.
    if transformed_value.is_a?(SafeDump)
      transformed_value.safe_dump
    else
      transformed_value
    end
  end
end