Class: JSONAPI::RelationshipBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/jsonapi/relationship_builder.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(relationship_class, model_class, options) ⇒ RelationshipBuilder

Returns a new instance of RelationshipBuilder.



6
7
8
9
10
11
 
# File 'lib/jsonapi/relationship_builder.rb', line 6

def initialize(relationship_class, model_class, options)
  @relationship_class = relationship_class
  @model_class        = model_class
  @resource_class     = options[:parent_resource]
  @options            = options
end

Instance Attribute Details

#model_class ⇒ Object (readonly)

Returns the value of attribute model_class.



3
4
5
 
# File 'lib/jsonapi/relationship_builder.rb', line 3

def model_class
  @model_class
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



3
4
5
 
# File 'lib/jsonapi/relationship_builder.rb', line 3

def options
  @options
end

#relationship_class ⇒ Object (readonly)

Returns the value of attribute relationship_class.



3
4
5
 
# File 'lib/jsonapi/relationship_builder.rb', line 3

def relationship_class
  @relationship_class
end

Instance Method Details

#build_belongs_to(relationship, foreign_key, associated_records_method_name, relationship_name) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/jsonapi/relationship_builder.rb', line 65

def build_belongs_to(relationship, foreign_key, associated_records_method_name, relationship_name)
  # Calls method matching foreign key name on model instance
  define_on_resource foreign_key do
    @model.method(foreign_key).call
  end

  # Returns instantiated related resource object or nil
  define_on_resource relationship_name do |options = {}|
    relationship = self.class._relationships[relationship_name]

    if relationship.polymorphic?
      associated_model = public_send(associated_records_method_name)
      resource_klass = self.class.resource_for_model(associated_model) if associated_model
      return resource_klass.new(associated_model, @context) if resource_klass
    else
      resource_klass = relationship.resource_klass
      if resource_klass
        associated_model = public_send(associated_records_method_name)
        return associated_model ? resource_klass.new(associated_model, @context) : nil
      end
    end
  end
end

#build_has_one(relationship, foreign_key, associated_records_method_name, relationship_name) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/jsonapi/relationship_builder.rb', line 89

def build_has_one(relationship, foreign_key, associated_records_method_name, relationship_name)
  # Returns primary key name of related resource class
  define_on_resource foreign_key do
    relationship = self.class._relationships[relationship_name]

    record = public_send(associated_records_method_name)
    return nil if record.nil?
    record.public_send(relationship.resource_klass._primary_key)
  end

  # Returns instantiated related resource object or nil
  define_on_resource relationship_name do |options = {}|
    relationship = self.class._relationships[relationship_name]

    resource_klass = relationship.resource_klass
    if resource_klass
      associated_model = public_send(associated_records_method_name)
      return associated_model ? resource_klass.new(associated_model, @context) : nil
    end
  end
end

#build_to_many(relationship, foreign_key, associated_records_method_name, relationship_name) ⇒ Object 



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
 
# File 'lib/jsonapi/relationship_builder.rb', line 111

def build_to_many(relationship, foreign_key, associated_records_method_name, relationship_name)
  # Returns array of primary keys of related resource classes
  define_on_resource foreign_key do
    records = public_send(associated_records_method_name)
    return records.collect do |record|
      record.public_send(relationship.resource_klass._primary_key)
    end
  end

  # Returns array of instantiated related resource objects
  define_on_resource relationship_name do |options = {}|
    relationship = self.class._relationships[relationship_name]

    resource_klass = relationship.resource_klass
    records = public_send(associated_records_method_name)

    filters = options.fetch(:filters, {})
    unless filters.nil? || filters.empty?
      records = resource_klass.apply_filters(records, filters, options)
    end

    records = resource_klass.apply_includes(records, options)

    sort_criteria = options.fetch(:sort_criteria, {})
    unless sort_criteria.nil? || sort_criteria.empty?
      order_options = relationship.resource_klass.construct_order_options(sort_criteria)
      records = resource_klass.apply_sort(records, order_options, @context)
    end

    paginator = options[:paginator]
    if paginator
      records = resource_klass.apply_pagination(records, paginator, order_options)
    end

    return records.collect do |record|
      if relationship.polymorphic?
        resource_klass = self.class.resource_for_model(record)
      end
      resource_klass.new(record, @context)
    end
  end
end

#define_foreign_key_setter(foreign_key) ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/jsonapi/relationship_builder.rb', line 42

def define_foreign_key_setter(foreign_key)
  define_on_resource "#{foreign_key}=" do |value|
    @model.method("#{foreign_key}=").call(value)
  end
  foreign_key
end

#define_on_resource(method_name, &block) ⇒ Object 



154
155
156
157
 
# File 'lib/jsonapi/relationship_builder.rb', line 154

def define_on_resource(method_name, &block)
  return if @resource_class.method_defined?(method_name)
  @resource_class.inject_method_definition(method_name, block)
end

#define_relationship_methods(relationship_name) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/jsonapi/relationship_builder.rb', line 13

def define_relationship_methods(relationship_name)
  # Initialize from an ActiveRecord model's properties
  if model_class && model_class.ancestors.collect{|ancestor| ancestor.name}.include?('ActiveRecord::Base')
    model_association = model_class.reflect_on_association(relationship_name)
    if model_association
      options[:class_name] ||= model_association.class_name
    end
  end

  relationship = register_relationship(
    relationship_name,
    relationship_class.new(relationship_name, options)
  )

  foreign_key = define_foreign_key_setter(relationship.foreign_key)

  case relationship
  when JSONAPI::Relationship::ToOne
    associated = define_resource_relationship_accessor(:one, relationship_name)
    args = [relationship, foreign_key, associated, relationship_name]

    relationship.belongs_to? ? build_belongs_to(*args) : build_has_one(*args)
  when JSONAPI::Relationship::ToMany
    associated = define_resource_relationship_accessor(:many, relationship_name)

    build_to_many(relationship, foreign_key, associated, relationship_name)
  end
end

#define_resource_relationship_accessor(type, relationship_name) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/jsonapi/relationship_builder.rb', line 49

def define_resource_relationship_accessor(type, relationship_name)
  associated_records_method_name = {
    one:  "record_for_#{relationship_name}",
    many: "records_for_#{relationship_name}"
  }
  .fetch(type)

  define_on_resource associated_records_method_name do
    relationship = self.class._relationships[relationship_name]
    relation_name = relationship.relation_name(context: @context)
    records_for(relation_name)
  end

  associated_records_method_name
end