Class: ActiveModelSerializers::SerializableResource

Inherits:

Object

• Object
• ActiveModelSerializers::SerializableResource

show all

Includes:

Logging

Defined in:

lib/active_model_serializers/serializable_resource.rb

Constant Summary

ADAPTER_OPTION_KEYS =

Set.new([:include, :fields, :adapter, :meta, :meta_key, :links, :serialization_context, :key_transform])

Constants included from Logging

Logging::RENDER_EVENT

Instance Method Summary (collapse)

• - (Object) adapter (also: #adapter_instance)

  NOTE: if no adapter is available, returns the resource itself.

• - (Object) find_adapter
• - (Object) initialize(resource, options = {}) constructor

  Primary interface to composing a resource with a serializer and adapter.

• - (Object) serialization_scope
• - (Object) serialization_scope=(scope)
• - (Object) serialization_scope_name=(scope_name)
• - (Object) serializer (also: #serializer_class)

  Get serializer either explicitly :serializer or implicitly from resource Remove :serializer key from serializer_opts Replace :serializer key with :each_serializer if present.

• - (Boolean) serializer?
• - (Object) serializer_instance
• - (Boolean) use_adapter?

  True when no explicit adapter given, or explicit appear is truthy (non-nil) False when explicit adapter is falsy (nil or false).

Methods included from Logging

#notify_render, #notify_render_payload

15
16
17
18
19

# File 'lib/active_model_serializers/serializable_resource.rb', line 15

def initialize(resource, options = {})
  @resource = resource
  @adapter_opts, @serializer_opts =
    options.partition { |k, _| ADAPTER_OPTION_KEYS.include? k }.map { |h| Hash[h] }
end

34
35
36

# File 'lib/active_model_serializers/serializable_resource.rb', line 34

def adapter
  @adapter ||= find_adapter
end

39
40
41
42
43
44

# File 'lib/active_model_serializers/serializable_resource.rb', line 39

def find_adapter
  return resource unless serializer?
  ActiveModelSerializers::Adapter.create(serializer_instance, adapter_opts)
rescue ActiveModel::Serializer::CollectionSerializer::NoSerializerError
  resource
end

25
26
27

# File 'lib/active_model_serializers/serializable_resource.rb', line 25

def serialization_scope
  serializer_opts[:scope]
end

21
22
23

# File 'lib/active_model_serializers/serializable_resource.rb', line 21

def serialization_scope=(scope)
  serializer_opts[:scope] = scope
end

29
30
31

# File 'lib/active_model_serializers/serializable_resource.rb', line 29

def serialization_scope_name=(scope_name)
  serializer_opts[:scope_name] = scope_name
end

53
54
55
56
57
58
59
60
61
62
63
64

# File 'lib/active_model_serializers/serializable_resource.rb', line 53

def serializer
  @serializer ||=
    begin
      @serializer = serializer_opts.delete(:serializer)
      @serializer ||= ActiveModel::Serializer.serializer_for(resource)

      if serializer_opts.key?(:each_serializer)
        serializer_opts[:serializer] = serializer_opts.delete(:each_serializer)
      end
      @serializer
    end
end

73
74
75

# File 'lib/active_model_serializers/serializable_resource.rb', line 73

def serializer?
  use_adapter? && !serializer.nil?
end

46
47
48

# File 'lib/active_model_serializers/serializable_resource.rb', line 46

def serializer_instance
  @serializer_instance ||= serializer.new(resource, serializer_opts)
end

69
70
71

# File 'lib/active_model_serializers/serializable_resource.rb', line 69

def use_adapter?
  !(adapter_opts.key?(:adapter) && !adapter_opts[:adapter])
end