Module: JSONAPI::Serializer::InstanceMethods

Defined in:
lib/jsonapi-serializers/serializer.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#base_url ⇒ Object

Override this to set a base URL (example.com) for all links. No trailing slash.



70
71
72
 
# File 'lib/jsonapi-serializers/serializer.rb', line 70

def base_url
  @base_url
end

#context ⇒ Object

Returns the value of attribute context.



26
27
28
 
# File 'lib/jsonapi-serializers/serializer.rb', line 26

def context
  @context
end

#object ⇒ Object

Returns the value of attribute object.



25
26
27
 
# File 'lib/jsonapi-serializers/serializer.rb', line 25

def object
  @object
end

Instance Method Details

#attributes ⇒ Object 



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/jsonapi-serializers/serializer.rb', line 153

def attributes
  return {} if self.class.attributes_map.nil?
  attributes = {}
  self.class.attributes_map.each do |attribute_name, attr_data|
    next if !should_include_attr?(attr_data[:options][:if], attr_data[:options][:unless])
    value = evaluate_attr_or_block(attribute_name, attr_data[:attr_or_block])
    attributes[format_name(attribute_name)] = value
  end
  attributes
end

#format_name(attribute_name) ⇒ Object

Override this to customize how attribute names are formatted. By default, attribute names are dasherized per the spec naming recommendations: jsonapi.org/recommendations/#naming



55
56
57
 
# File 'lib/jsonapi-serializers/serializer.rb', line 55

def format_name(attribute_name)
  attribute_name.to_s.dasherize
end

#has_many_relationship(attribute_name, attr_data) ⇒ Object 



188
189
190
 
# File 'lib/jsonapi-serializers/serializer.rb', line 188

def has_many_relationship(attribute_name, attr_data)
  evaluate_attr_or_block(attribute_name, attr_data[:attr_or_block])
end

#has_many_relationships ⇒ Object 



178
179
180
181
182
183
184
185
186
 
# File 'lib/jsonapi-serializers/serializer.rb', line 178

def has_many_relationships
  return {} if self.class.to_many_associations.nil?
  data = {}
  self.class.to_many_associations.each do |attribute_name, attr_data|
    next if !should_include_attr?(attr_data[:options][:if], attr_data[:options][:unless])
    data[attribute_name] = attr_data
  end
  data
end

#has_one_relationship(attribute_name, attr_data) ⇒ Object 



174
175
176
 
# File 'lib/jsonapi-serializers/serializer.rb', line 174

def has_one_relationship(attribute_name, attr_data)
  evaluate_attr_or_block(attribute_name, attr_data[:attr_or_block])
end

#has_one_relationships ⇒ Object 



164
165
166
167
168
169
170
171
172
 
# File 'lib/jsonapi-serializers/serializer.rb', line 164

def has_one_relationships
  return {} if self.class.to_one_associations.nil?
  data = {}
  self.class.to_one_associations.each do |attribute_name, attr_data|
    next if !should_include_attr?(attr_data[:options][:if], attr_data[:options][:unless])
    data[attribute_name] = attr_data
  end
  data
end

#id ⇒ Object

Override this to customize the JSON:API “id” for this object. Always return a string from this method to conform with the JSON:API spec.



40
41
42
 
# File 'lib/jsonapi-serializers/serializer.rb', line 40

def id
  object.id.to_s
end

#initialize(object, options = {}) ⇒ Object 



29
30
31
32
33
34
35
36
 
# File 'lib/jsonapi-serializers/serializer.rb', line 29

def initialize(object, options = {})
  @object = object
  @context = options[:context] || {}
  @base_url = options[:base_url]

  # Internal serializer options, not exposed through attr_accessor. No touchie.
  @_include_linkages = options[:include_linkages] || []
end

#links ⇒ Object 



86
87
88
89
 
# File 'lib/jsonapi-serializers/serializer.rb', line 86

def links
  data = {}
  data.merge!({'self' => self_link}) if self_link
end

#meta ⇒ Object

Override this to provide resource-object metadata. jsonapi.org/format/#document-structure-resource-objects



66
67
 
# File 'lib/jsonapi-serializers/serializer.rb', line 66

def meta
end

#relationship_related_link(attribute_name) ⇒ Object 



82
83
84
 
# File 'lib/jsonapi-serializers/serializer.rb', line 82

def relationship_related_link(attribute_name)
  "#{self_link}/#{format_name(attribute_name)}"
end

#relationship_self_link(attribute_name) ⇒ Object 



78
79
80
 
# File 'lib/jsonapi-serializers/serializer.rb', line 78

def relationship_self_link(attribute_name)
  "#{self_link}/relationships/#{format_name(attribute_name)}"
end

#relationships ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/jsonapi-serializers/serializer.rb', line 91

def relationships
  data = {}
  # Merge in data for has_one relationships.
  has_one_relationships.each do |attribute_name, attr_data|
    formatted_attribute_name = format_name(attribute_name)

    data[formatted_attribute_name] = {}
    links_self = relationship_self_link(attribute_name)
    links_related = relationship_related_link(attribute_name)
    data[formatted_attribute_name]['links'] = {} if links_self || links_related
    data[formatted_attribute_name]['links']['self'] = links_self if links_self
    data[formatted_attribute_name]['links']['related'] = links_related if links_related

    if @_include_linkages.include?(formatted_attribute_name)
      object = has_one_relationship(attribute_name, attr_data)
      if object.nil?
        # Spec: Resource linkage MUST be represented as one of the following:
        # - null for empty to-one relationships.
        # http://jsonapi.org/format/#document-structure-resource-relationships
        data[formatted_attribute_name].merge!({'data' => nil})
      else
        related_object_serializer = JSONAPI::Serializer.find_serializer(object)
        data[formatted_attribute_name].merge!({
          'data' => {
            'type' => related_object_serializer.type.to_s,
            'id' => related_object_serializer.id.to_s,
          },
        })
      end
    end
  end

  # Merge in data for has_many relationships.
  has_many_relationships.each do |attribute_name, attr_data|
    formatted_attribute_name = format_name(attribute_name)

    data[formatted_attribute_name] = {}
    links_self = relationship_self_link(attribute_name)
    links_related = relationship_related_link(attribute_name)
    data[formatted_attribute_name]['links'] = {} if links_self || links_related
    data[formatted_attribute_name]['links']['self'] = links_self if links_self
    data[formatted_attribute_name]['links']['related'] = links_related if links_related

    # Spec: Resource linkage MUST be represented as one of the following:
    # - an empty array ([]) for empty to-many relationships.
    # - an array of linkage objects for non-empty to-many relationships.
    # http://jsonapi.org/format/#document-structure-resource-relationships
    if @_include_linkages.include?(formatted_attribute_name)
      data[formatted_attribute_name].merge!({'data' => []})
      objects = has_many_relationship(attribute_name, attr_data) || []
      objects.each do |obj|
        related_object_serializer = JSONAPI::Serializer.find_serializer(obj)
        data[formatted_attribute_name]['data'] << {
          'type' => related_object_serializer.type.to_s,
          'id' => related_object_serializer.id.to_s,
        }
      end
    end
  end
  data
end

#self_link ⇒ Object 



74
75
76
 
# File 'lib/jsonapi-serializers/serializer.rb', line 74

def self_link
  "#{base_url}/#{type}/#{id}"
end

#type ⇒ Object

Override this to customize the JSON:API “type” for this object. By default, the type is the object’s class name lowercased, pluralized, and dasherized, per the spec naming recommendations: jsonapi.org/recommendations/#naming For example, ‘MyApp::LongCommment’ will become the ‘long-comments’ type.



48
49
50
 
# File 'lib/jsonapi-serializers/serializer.rb', line 48

def type
  object.class.name.demodulize.tableize.dasherize
end

#unformat_name(attribute_name) ⇒ Object

The opposite of format_name. Override this if you override format_name.



60
61
62
 
# File 'lib/jsonapi-serializers/serializer.rb', line 60

def unformat_name(attribute_name)
  attribute_name.to_s.underscore
end