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.



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

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 



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

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?(attribute_name, attr_data)
    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



57
58
59
 
# File 'lib/jsonapi-serializers/serializer.rb', line 57

def format_name(attribute_name)
  attribute_name.to_s.dasherize
end

#has_many_relationship(attribute_name, attr_data) ⇒ Object 



200
201
202
 
# File 'lib/jsonapi-serializers/serializer.rb', line 200

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

#has_many_relationships ⇒ Object 



190
191
192
193
194
195
196
197
198
 
# File 'lib/jsonapi-serializers/serializer.rb', line 190

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?(attribute_name, attr_data)
    data[attribute_name] = attr_data
  end
  data
end

#has_one_relationship(attribute_name, attr_data) ⇒ Object 



186
187
188
 
# File 'lib/jsonapi-serializers/serializer.rb', line 186

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

#has_one_relationships ⇒ Object 



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

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?(attribute_name, attr_data)
    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.



42
43
44
 
# File 'lib/jsonapi-serializers/serializer.rb', line 42

def id
  object.id.to_s
end

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



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

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

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

#jsonapi ⇒ Object

Override this to provide resource-object jsonapi object containing the version in use. jsonapi.org/format/#document-jsonapi-object



68
69
 
# File 'lib/jsonapi-serializers/serializer.rb', line 68

def jsonapi
end

#links ⇒ Object 



93
94
95
96
97
 
# File 'lib/jsonapi-serializers/serializer.rb', line 93

def links
  data = {}
  data['self'] = self_link if self_link
  data
end

#meta ⇒ Object

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



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

def meta
end

#relationship_related_link(attribute_name) ⇒ Object 



89
90
91
 
# File 'lib/jsonapi-serializers/serializer.rb', line 89

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

#relationship_self_link(attribute_name) ⇒ Object 



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

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

#relationships ⇒ Object 



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
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/jsonapi-serializers/serializer.rb', line 99

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] = {}

    if attr_data[:options][:include_links]
      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
    end

    if @_include_linkages.include?(formatted_attribute_name) || attr_data[:options][:include_data]
      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]['data'] = nil
      else
        related_object_serializer = JSONAPI::Serializer.find_serializer(object, @options)
        data[formatted_attribute_name]['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] = {}

    if attr_data[:options][:include_links]
      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
    end

    # 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) || attr_data[:options][:include_data]
      data[formatted_attribute_name]['data'] = []
      objects = has_many_relationship(attribute_name, attr_data) || []
      objects.each do |obj|
        related_object_serializer = JSONAPI::Serializer.find_serializer(obj, @options)
        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 



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

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.



50
51
52
 
# File 'lib/jsonapi-serializers/serializer.rb', line 50

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.



62
63
64
 
# File 'lib/jsonapi-serializers/serializer.rb', line 62

def unformat_name(attribute_name)
  attribute_name.to_s.underscore
end