association.rb 3.9 KB
Newer Older
1 2
# frozen_string_literal: true

J
Jon Leighton 已提交
3 4 5 6
module ActiveRecord
  module Associations
    class Preloader
      class Association #:nodoc:
7
        attr_reader :owners, :reflection, :preload_scope, :model, :klass
8
        attr_reader :preloaded_records
9 10 11 12 13 14 15

        def initialize(klass, owners, reflection, preload_scope)
          @klass         = klass
          @owners        = owners
          @reflection    = reflection
          @preload_scope = preload_scope
          @model         = owners.first && owners.first.class
16
          @preloaded_records = []
J
Jon Leighton 已提交
17 18
        end

19
        def run(preloader)
B
Bogdan Gusiev 已提交
20
          associated_records_by_owner(preloader) do |owner, records|
21 22
            associate_records_to_owner(owner, records)
          end
J
Jon Leighton 已提交
23 24 25
        end

        private
26 27 28 29 30
          # The name of the key on the associated records
          def association_key_name
            reflection.join_primary_key(klass)
          end

31 32 33 34 35
          # The name of the key on the model which declares the association
          def owner_key_name
            reflection.join_foreign_key
          end

36
          def associated_records_by_owner(preloader)
37 38 39 40 41 42
            records = load_records do |record|
              owner = owners_by_key[convert_key(record[association_key_name])]
              association = owner.association(reflection.name)
              association.set_inverse_instance(record)
            end

43
            owners.each_with_object({}) do |owner, result|
B
Bogdan Gusiev 已提交
44
              yield(owner, records[convert_key(owner[owner_key_name])] || [])
45
            end
46
          end
47

48 49 50 51
          def associate_records_to_owner(owner, records)
            raise NotImplementedError
          end

52
          def owner_keys
53
            @owner_keys ||= owners_by_key.keys
J
Jon Leighton 已提交
54 55
          end

56 57 58
          def owners_by_key
            unless defined?(@owners_by_key)
              @owners_by_key = owners.each_with_object({}) do |owner, h|
59 60
                key = convert_key(owner[owner_key_name])
                h[key] = owner if key
61 62 63 64 65
              end
            end
            @owners_by_key
          end

66
          def key_conversion_required?
67 68 69 70 71
            unless defined?(@key_conversion_required)
              @key_conversion_required = (association_key_type != owner_key_type)
            end

            @key_conversion_required
72
          end
73

74 75 76 77 78 79
          def convert_key(key)
            if key_conversion_required?
              key.to_s
            else
              key
            end
80
          end
81

82 83 84
          def association_key_type
            @klass.type_for_attribute(association_key_name.to_s).type
          end
85

86 87 88
          def owner_key_type
            @model.type_for_attribute(owner_key_name.to_s).type
          end
89

90
          def load_records(&block)
91 92 93
            return {} if owner_keys.empty?
            # Some databases impose a limit on the number of ids in a list (in Oracle it's 1000)
            # Make several smaller queries if necessary or make one query if the adapter supports it
94
            slices = owner_keys.each_slice(klass.connection.in_clause_length || owner_keys.size)
95
            @preloaded_records = slices.flat_map do |slice|
96
              records_for(slice, &block)
97 98 99 100
            end
            @preloaded_records.group_by do |record|
              convert_key(record[association_key_name])
            end
101
          end
102

103
          def records_for(ids, &block)
104
            scope.where(association_key_name => ids).load(&block)
105 106 107 108 109 110
          end

          def scope
            @scope ||= build_scope
          end

111
          def reflection_scope
112
            @reflection_scope ||= reflection.scope ? reflection.scope_for(klass.unscoped) : klass.unscoped
113
          end
114

115
          def build_scope
116
            scope = klass.scope_for_association
117

118 119
            if reflection.type
              scope.where!(reflection.type => model.base_class.sti_name)
120
            end
121

122
            scope.merge!(reflection_scope) if reflection.scope
123 124
            scope.merge!(preload_scope) if preload_scope
            scope
J
Jon Leighton 已提交
125 126 127 128 129
          end
      end
    end
  end
end