activerecord 3.0.0 → 4.0.0

data/lib/active_record/associations/join_dependency.rb

@@ -0,0 +1,235 @@
+module ActiveRecord
+  module Associations
+    class JoinDependency # :nodoc:
+      autoload :JoinPart,        'active_record/associations/join_dependency/join_part'
+      autoload :JoinBase,        'active_record/associations/join_dependency/join_base'
+      autoload :JoinAssociation, 'active_record/associations/join_dependency/join_association'
+
+      attr_reader :join_parts, :reflections, :alias_tracker, :base_klass
+
+      # base is the base class on which operation is taking place.
+      # associations is the list of associations which are joined using hash, symbol or array.
+      # joins is the list of all string join commnads and arel nodes.
+      #
+      #  Example :
+      #
+      #  class Physician < ActiveRecord::Base
+      #    has_many :appointments
+      #    has_many :patients, through: :appointments
+      #  end
+      #
+      #  If I execute `@physician.patients.to_a` then
+      #    base #=> Physician
+      #    associations #=> []
+      #    joins #=>  [#<Arel::Nodes::InnerJoin: ...]
+      #
+      #  However if I execute `Physician.joins(:appointments).to_a` then
+      #    base #=> Physician
+      #    associations #=> [:appointments]
+      #    joins #=>  []
+      #
+      def initialize(base, associations, joins)
+        @base_klass    = base
+        @table_joins   = joins
+        @join_parts    = [JoinBase.new(base)]
+        @associations  = {}
+        @reflections   = []
+        @alias_tracker = AliasTracker.new(base.connection, joins)
+        @alias_tracker.aliased_name_for(base.table_name) # Updates the count for base.table_name to 1
+        build(associations)
+      end
+
+      def graft(*associations)
+        associations.each do |association|
+          join_associations.detect {|a| association == a} ||
+            build(association.reflection.name, association.find_parent_in(self) || join_base, association.join_type)
+        end
+        self
+      end
+
+      def join_associations
+        join_parts.last(join_parts.length - 1)
+      end
+
+      def join_base
+        join_parts.first
+      end
+
+      def columns
+        join_parts.collect { |join_part|
+          table = join_part.aliased_table
+          join_part.column_names_with_alias.collect{ |column_name, aliased_name|
+            table[column_name].as Arel.sql(aliased_name)
+          }
+        }.flatten
+      end
+
+      def instantiate(rows)
+        primary_key = join_base.aliased_primary_key
+        parents = {}
+
+        records = rows.map { |model|
+          primary_id = model[primary_key]
+          parent = parents[primary_id] ||= join_base.instantiate(model)
+          construct(parent, @associations, join_associations, model)
+          parent
+        }.uniq
+
+        remove_duplicate_results!(base_klass, records, @associations)
+        records
+      end
+
+      protected
+
+      def remove_duplicate_results!(base, records, associations)
+        case associations
+        when Symbol, String
+          reflection = base.reflections[associations]
+          remove_uniq_by_reflection(reflection, records)
+        when Array
+          associations.each do |association|
+            remove_duplicate_results!(base, records, association)
+          end
+        when Hash
+          associations.each_key do |name|
+            reflection = base.reflections[name]
+            remove_uniq_by_reflection(reflection, records)
+
+            parent_records = []
+            records.each do |record|
+              if descendant = record.send(reflection.name)
+                if reflection.collection?
+                  parent_records.concat descendant.target.uniq
+                else
+                  parent_records << descendant
+                end
+              end
+            end
+
+            remove_duplicate_results!(reflection.klass, parent_records, associations[name]) unless parent_records.empty?
+          end
+        end
+      end
+
+      def cache_joined_association(association)
+        associations = []
+        parent = association.parent
+        while parent != join_base
+          associations.unshift(parent.reflection.name)
+          parent = parent.parent
+        end
+        ref = @associations
+        associations.each do |key|
+          ref = ref[key]
+        end
+        ref[association.reflection.name] ||= {}
+      end
+
+      def build(associations, parent = nil, join_type = Arel::InnerJoin)
+        parent ||= join_parts.last
+        case associations
+        when Symbol, String
+          reflection = parent.reflections[associations.intern] or
+          raise ConfigurationError, "Association named '#{ associations }' was not found on #{ parent.base_klass.name }; perhaps you misspelled it?"
+          unless join_association = find_join_association(reflection, parent)
+            @reflections << reflection
+            join_association = build_join_association(reflection, parent)
+            join_association.join_type = join_type
+            @join_parts << join_association
+            cache_joined_association(join_association)
+          end
+          join_association
+        when Array
+          associations.each do |association|
+            build(association, parent, join_type)
+          end
+        when Hash
+          associations.keys.sort_by { |a| a.to_s }.each do |name|
+            join_association = build(name, parent, join_type)
+            build(associations[name], join_association, join_type)
+          end
+        else
+          raise ConfigurationError, associations.inspect
+        end
+      end
+
+      def find_join_association(name_or_reflection, parent)
+        if String === name_or_reflection
+          name_or_reflection = name_or_reflection.to_sym
+        end
+
+        join_associations.detect { |j|
+          j.reflection == name_or_reflection && j.parent == parent
+        }
+      end
+
+      def remove_uniq_by_reflection(reflection, records)
+        if reflection && reflection.collection?
+          records.each { |record| record.send(reflection.name).target.uniq! }
+        end
+      end
+
+      def build_join_association(reflection, parent)
+        JoinAssociation.new(reflection, self, parent)
+      end
+
+      def construct(parent, associations, join_parts, row)
+        case associations
+        when Symbol, String
+          name = associations.to_s
+
+          join_part = join_parts.detect { |j|
+            j.reflection.name.to_s == name &&
+              j.parent_table_name == parent.class.table_name }
+
+            raise(ConfigurationError, "No such association") unless join_part
+
+            join_parts.delete(join_part)
+            construct_association(parent, join_part, row)
+        when Array
+          associations.each do |association|
+            construct(parent, association, join_parts, row)
+          end
+        when Hash
+          associations.sort_by { |k,_| k.to_s }.each do |association_name, assoc|
+            association = construct(parent, association_name, join_parts, row)
+            construct(association, assoc, join_parts, row) if association
+          end
+        else
+          raise ConfigurationError, associations.inspect
+        end
+      end
+
+      def construct_association(record, join_part, row)
+        return if record.id.to_s != join_part.parent.record_id(row).to_s
+
+        macro = join_part.reflection.macro
+        if macro == :has_one
+          return record.association(join_part.reflection.name).target if record.association_cache.key?(join_part.reflection.name)
+          association = join_part.instantiate(row) unless row[join_part.aliased_primary_key].nil?
+          set_target_and_inverse(join_part, association, record)
+        else
+          association = join_part.instantiate(row) unless row[join_part.aliased_primary_key].nil?
+          case macro
+          when :has_many, :has_and_belongs_to_many
+            other = record.association(join_part.reflection.name)
+            other.loaded!
+            other.target.push(association) if association
+            other.set_inverse_instance(association)
+          when :belongs_to
+            set_target_and_inverse(join_part, association, record)
+          else
+            raise ConfigurationError, "unknown macro: #{join_part.reflection.macro}"
+          end
+        end
+        association
+      end
+
+      def set_target_and_inverse(join_part, association, record)
+        other = record.association(join_part.reflection.name)
+        other.target = association
+        other.set_inverse_instance(association)
+      end
+    end
+  end
+end

data/lib/active_record/associations/join_helper.rb

@@ -0,0 +1,45 @@
+module ActiveRecord
+  module Associations
+    # Helper class module which gets mixed into JoinDependency::JoinAssociation and AssociationScope
+    module JoinHelper #:nodoc:
+
+      def join_type
+        Arel::InnerJoin
+      end
+
+      private
+
+      def construct_tables
+        tables = []
+        chain.each do |reflection|
+          tables << alias_tracker.aliased_table_for(
+            table_name_for(reflection),
+            table_alias_for(reflection, reflection != self.reflection)
+          )
+
+          if reflection.source_macro == :has_and_belongs_to_many
+            tables << alias_tracker.aliased_table_for(
+              (reflection.source_reflection || reflection).join_table,
+              table_alias_for(reflection, true)
+            )
+          end
+        end
+        tables
+      end
+
+      def table_name_for(reflection)
+        reflection.table_name
+      end
+
+      def table_alias_for(reflection, join = false)
+        name = "#{reflection.plural_name}_#{alias_suffix}"
+        name << "_join" if join
+        name
+      end
+
+      def join(table, constraint)
+        table.create_join(table, table.create_on(constraint), join_type)
+      end
+    end
+  end
+end

data/lib/active_record/associations/preloader/association.rb

@@ -0,0 +1,121 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      class Association #:nodoc:
+        attr_reader :owners, :reflection, :preload_scope, :model, :klass
+
+        def initialize(klass, owners, reflection, preload_scope)
+          @klass         = klass
+          @owners        = owners
+          @reflection    = reflection
+          @preload_scope = preload_scope
+          @model         = owners.first && owners.first.class
+          @scope         = nil
+          @owners_by_key = nil
+        end
+
+        def run
+          unless owners.first.association(reflection.name).loaded?
+            preload
+          end
+        end
+
+        def preload
+          raise NotImplementedError
+        end
+
+        def scope
+          @scope ||= build_scope
+        end
+
+        def records_for(ids)
+          scope.where(association_key.in(ids))
+        end
+
+        def table
+          klass.arel_table
+        end
+
+        # The name of the key on the associated records
+        def association_key_name
+          raise NotImplementedError
+        end
+
+        # This is overridden by HABTM as the condition should be on the foreign_key column in
+        # the join table
+        def association_key
+          table[association_key_name]
+        end
+
+        # The name of the key on the model which declares the association
+        def owner_key_name
+          raise NotImplementedError
+        end
+
+        # We're converting to a string here because postgres will return the aliased association
+        # key in a habtm as a string (for whatever reason)
+        def owners_by_key
+          @owners_by_key ||= owners.group_by do |owner|
+            key = owner[owner_key_name]
+            key && key.to_s
+          end
+        end
+
+        def options
+          reflection.options
+        end
+
+        private
+
+        def associated_records_by_owner
+          owners_map = owners_by_key
+          owner_keys = owners_map.keys.compact
+
+          if klass.nil? || owner_keys.empty?
+            records = []
+          else
+            # 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
+            sliced  = owner_keys.each_slice(klass.connection.in_clause_length || owner_keys.size)
+            records = sliced.map { |slice| records_for(slice).to_a }.flatten
+          end
+
+          # Each record may have multiple owners, and vice-versa
+          records_by_owner = Hash[owners.map { |owner| [owner, []] }]
+          records.each do |record|
+            owner_key = record[association_key_name].to_s
+
+            owners_map[owner_key].each do |owner|
+              records_by_owner[owner] << record
+            end
+          end
+          records_by_owner
+        end
+
+        def reflection_scope
+          @reflection_scope ||= reflection.scope ? klass.unscoped.instance_exec(nil, &reflection.scope) : klass.unscoped
+        end
+
+        def build_scope
+          scope = klass.unscoped
+          scope.default_scoped = true
+
+          values         = reflection_scope.values
+          preload_values = preload_scope.values
+
+          scope.where_values      = Array(values[:where])      + Array(preload_values[:where])
+          scope.references_values = Array(values[:references]) + Array(preload_values[:references])
+
+          scope.select!   preload_values[:select] || values[:select] || table[Arel.star]
+          scope.includes! preload_values[:includes] || values[:includes]
+
+          if options[:as]
+            scope.where!(klass.table_name => { reflection.type => model.base_class.sti_name })
+          end
+
+          scope
+        end
+      end
+    end
+  end
+end

data/lib/active_record/associations/preloader/belongs_to.rb

@@ -0,0 +1,17 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      class BelongsTo < SingularAssociation #:nodoc:
+
+        def association_key_name
+          reflection.options[:primary_key] || klass && klass.primary_key
+        end
+
+        def owner_key_name
+          reflection.foreign_key
+        end
+
+      end
+    end
+  end
+end

data/lib/active_record/associations/preloader/collection_association.rb

@@ -0,0 +1,24 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      class CollectionAssociation < Association #:nodoc:
+
+        private
+
+        def build_scope
+          super.order(preload_scope.values[:order] || reflection_scope.values[:order])
+        end
+
+        def preload
+          associated_records_by_owner.each do |owner, records|
+            association = owner.association(reflection.name)
+            association.loaded!
+            association.target.concat(records)
+            records.each { |record| association.set_inverse_instance(record) }
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/active_record/associations/preloader/has_and_belongs_to_many.rb

@@ -0,0 +1,60 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      class HasAndBelongsToMany < CollectionAssociation #:nodoc:
+        attr_reader :join_table
+
+        def initialize(klass, records, reflection, preload_options)
+          super
+          @join_table = Arel::Table.new(reflection.join_table).alias('t0')
+        end
+
+        # Unlike the other associations, we want to get a raw array of rows so that we can
+        # access the aliased column on the join table
+        def records_for(ids)
+          scope = super
+          klass.connection.select_all(scope.arel, 'SQL', scope.bind_values)
+        end
+
+        def owner_key_name
+          reflection.active_record_primary_key
+        end
+
+        def association_key_name
+          'ar_association_key_name'
+        end
+
+        def association_key
+          join_table[reflection.foreign_key]
+        end
+
+        private
+
+        # Once we have used the join table column (in super), we manually instantiate the
+        # actual records, ensuring that we don't create more than one instances of the same
+        # record
+        def associated_records_by_owner
+          records = {}
+          super.each_value do |rows|
+            rows.map! { |row| records[row[klass.primary_key]] ||= klass.instantiate(row) }
+          end
+        end
+
+        def build_scope
+          super.joins(join).select(join_select)
+        end
+
+        def join_select
+          association_key.as(Arel.sql(association_key_name))
+        end
+
+        def join
+          condition = table[reflection.association_primary_key].eq(
+            join_table[reflection.association_foreign_key])
+
+          table.create_join(join_table, table.create_on(condition))
+        end
+      end
+    end
+  end
+end

data/lib/active_record/associations/preloader/has_many.rb

@@ -0,0 +1,17 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      class HasMany < CollectionAssociation #:nodoc:
+
+        def association_key_name
+          reflection.foreign_key
+        end
+
+        def owner_key_name
+          reflection.active_record_primary_key
+        end
+
+      end
+    end
+  end
+end

data/lib/active_record/associations/preloader/has_many_through.rb

@@ -0,0 +1,19 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      class HasManyThrough < CollectionAssociation #:nodoc:
+        include ThroughAssociation
+
+        def associated_records_by_owner
+          records_by_owner = super
+
+          if reflection_scope.distinct_value
+            records_by_owner.each_value { |records| records.uniq! }
+          end
+
+          records_by_owner
+        end
+      end
+    end
+  end
+end

data/lib/active_record/associations/preloader/has_one.rb

@@ -0,0 +1,23 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      class HasOne < SingularAssociation #:nodoc:
+
+        def association_key_name
+          reflection.foreign_key
+        end
+
+        def owner_key_name
+          reflection.active_record_primary_key
+        end
+
+        private
+
+        def build_scope
+          super.order(preload_scope.values[:order] || reflection_scope.values[:order])
+        end
+
+      end
+    end
+  end
+end

data/lib/active_record/associations/preloader/has_one_through.rb

@@ -0,0 +1,9 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      class HasOneThrough < SingularAssociation #:nodoc:
+        include ThroughAssociation
+      end
+    end
+  end
+end

data/lib/active_record/associations/preloader/singular_association.rb

@@ -0,0 +1,21 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      class SingularAssociation < Association #:nodoc:
+
+        private
+
+        def preload
+          associated_records_by_owner.each do |owner, associated_records|
+            record = associated_records.first
+
+            association = owner.association(reflection.name)
+            association.target = record
+            association.set_inverse_instance(record)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/active_record/associations/preloader/through_association.rb

@@ -0,0 +1,63 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      module ThroughAssociation #:nodoc:
+
+        def through_reflection
+          reflection.through_reflection
+        end
+
+        def source_reflection
+          reflection.source_reflection
+        end
+
+        def associated_records_by_owner
+          through_records = through_records_by_owner
+
+          Preloader.new(through_records.values.flatten, source_reflection.name, reflection_scope).run
+
+          through_records.each do |owner, records|
+            records.map! { |r| r.send(source_reflection.name) }.flatten!
+            records.compact!
+          end
+        end
+
+        private
+
+        def through_records_by_owner
+          Preloader.new(owners, through_reflection.name, through_scope).run
+
+          Hash[owners.map do |owner|
+            through_records = Array.wrap(owner.send(through_reflection.name))
+
+            # Dont cache the association - we would only be caching a subset
+            if (through_scope != through_reflection.klass.unscoped) ||
+               (reflection.options[:source_type] && through_reflection.collection?)
+              owner.association(through_reflection.name).reset
+            end
+
+            [owner, through_records]
+          end]
+        end
+
+        def through_scope
+          through_scope = through_reflection.klass.unscoped
+
+          if options[:source_type]
+            through_scope.where! reflection.foreign_type => options[:source_type]
+          else
+            unless reflection_scope.where_values.empty?
+              through_scope.includes_values = Array(reflection_scope.values[:includes] || options[:source])
+              through_scope.where_values    = reflection_scope.values[:where]
+            end
+
+            through_scope.references! reflection_scope.values[:references]
+            through_scope.order! reflection_scope.values[:order] if through_scope.eager_loading?
+          end
+
+          through_scope
+        end
+      end
+    end
+  end
+end