Module: JsonapiCompliable::Adapters::ActiveRecordSideloading

Defined in:
lib/jsonapi_compliable/adapters/active_record_sideloading.rb

Instance Method Summary collapse

Instance Method Details

#belongs_to(association_name, scope: nil, resource:, foreign_key:, primary_key: :id, &blk) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/jsonapi_compliable/adapters/active_record_sideloading.rb', line 28

def belongs_to(association_name, scope: nil, resource:, foreign_key:, primary_key: :id, &blk)
  _scope = scope

  allow_sideload association_name, type: :belongs_to, resource: resource, foreign_key: foreign_key, primary_key: primary_key do
    scope do |parents|
      parent_ids = parents.map { |p| p.send(foreign_key) }
      _scope.call.where(primary_key => parent_ids.uniq.compact)
    end

    assign do |parents, children|
      children_hash = children.index_by(&primary_key)
      parents.each do |parent|
        relevant_child = children_hash[parent.send(foreign_key)]
        parent.send(:"#{association_name}=", relevant_child)
      end
    end

    instance_eval(&blk) if blk
  end
end

#has_and_belongs_to_many(association_name, scope: nil, resource:, foreign_key:, primary_key: :id, as: nil, &blk) ⇒ Object 



89
90
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
 
# File 'lib/jsonapi_compliable/adapters/active_record_sideloading.rb', line 89

def has_and_belongs_to_many(association_name, scope: nil, resource:, foreign_key:, primary_key: :id, as: nil, &blk)
  through = foreign_key.keys.first
  fk      = foreign_key.values.first
  _scope  = scope

  allow_sideload association_name, type: :habtm, foreign_key: foreign_key, primary_key: primary_key, resource: resource do
    scope do |parents|
      parent_ids = parents.map { |p| p.send(primary_key) }
      parent_ids.uniq!
      parent_ids.compact!

      table_name = parents[0]
        .class.reflections[through.to_s].klass.table_name

      _scope.call
        .includes(through)
        .where(table_name => { fk => parent_ids })
        .distinct
    end

    assign do |parents, children|
      parents.each do |parent|
        parent.association(association_name).loaded!
        relevant_children = children.select { |c| c.send(through).any? { |ct| ct.send(fk) == parent.send(primary_key) } }
        relevant_children.each do |c|
          parent.association(association_name).add_to_target(c, :skip_callbacks)
        end
      end
    end

    instance_eval(&blk) if blk
  end
end

#has_many(association_name, scope: nil, resource:, foreign_key:, primary_key: :id, &blk) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/jsonapi_compliable/adapters/active_record_sideloading.rb', line 4

def has_many(association_name, scope: nil, resource:, foreign_key:, primary_key: :id, &blk)
  _scope = scope

  allow_sideload association_name, type: :has_many, resource: resource, foreign_key: foreign_key, primary_key: primary_key do
    scope do |parents|
      parent_ids = parents.map { |p| p.send(primary_key) }
      _scope.call.where(foreign_key => parent_ids.uniq.compact)
    end

    assign do |parents, children|
      children_hash = children.group_by(&foreign_key)
      parents.each do |parent|
        parent.association(association_name).loaded!
        relevant_children = children_hash[parent.send(primary_key)] || []
        relevant_children.each do |c|
          parent.association(association_name).add_to_target(c, :skip_callbacks)
        end
      end
    end

    instance_eval(&blk) if blk
  end
end

#has_one(association_name, scope: nil, resource:, foreign_key:, primary_key: :id, &blk) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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_compliable/adapters/active_record_sideloading.rb', line 49

def has_one(association_name, scope: nil, resource:, foreign_key:, primary_key: :id, &blk)
  _scope = scope

  allow_sideload association_name, type: :has_one, foreign_key: foreign_key, primary_key: primary_key, resource: resource do
    scope do |parents|
      parent_ids = parents.map { |p| p.send(primary_key) }
      _scope.call.where(foreign_key => parent_ids.uniq.compact)
    end

    # The 'assigned' code here is to remove all children that do not
    # get assigned. This is because there is no 'limit(1)' in the query.
    # If we did 'limit(1)' for the query, it wouldn't work for index
    # actions (only 1 would come back, when we want one *per result*).
    #
    # Instead, avoid pagination in the query, assign only one result, and
    # remove anything else. This is more or less what AR does.
    assign do |parents, children|
      assigned = []
      children_hash = children.group_by(&foreign_key)
      parents.each do |parent|
        parent.association(association_name).loaded!
        relevant_children = children_hash[parent.send(primary_key)]
        next unless relevant_children
        relevant_child = relevant_children.first

        # Use private methods because of Rails bug
        # https://github.com/rails/rails/issues/32886
        association = parent.association(association_name)
        association.send(:set_owner_attributes, relevant_child)
        association.send(:set_inverse_instance, relevant_child)
        association.send(:target=, relevant_child)
        assigned << relevant_child
      end
      children.replace(assigned)
    end

    instance_eval(&blk) if blk
  end
end

#polymorphic_belongs_to(association_name, group_by:, groups:, &blk) ⇒ Object 



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
 
# File 'lib/jsonapi_compliable/adapters/active_record_sideloading.rb', line 123

def polymorphic_belongs_to(association_name, group_by:, groups:, &blk)
  allow_sideload association_name, type: :polymorphic_belongs_to, polymorphic: true do
    group_by(group_by)

    groups.each_pair do |type, config|
      primary_key = config[:primary_key] || :id
      foreign_key = config[:foreign_key]

      allow_sideload type, parent: self, primary_key: primary_key, foreign_key: foreign_key, type: :belongs_to, resource: config[:resource] do
        scope do |parents|
          parent_ids = parents.map { |p| p.send(foreign_key) }
          parent_ids.compact!
          parent_ids.uniq!
          config[:scope].call.where(primary_key => parent_ids)
        end

        assign do |parents, children|
          parents.each do |parent|
            parent.send(:"#{association_name}=", children.find { |c| c.send(primary_key) == parent.send(foreign_key) })
          end
        end
      end
    end
  end

  instance_eval(&blk) if blk
end