activerecord 1.0.0 → 4.0.0

data/lib/active_record/associations/join_dependency/join_association.rb

@@ -0,0 +1,174 @@
+module ActiveRecord
+  module Associations
+    class JoinDependency # :nodoc:
+      class JoinAssociation < JoinPart # :nodoc:
+        include JoinHelper
+
+        # The reflection of the association represented
+        attr_reader :reflection
+
+        # The JoinDependency object which this JoinAssociation exists within. This is mainly
+        # relevant for generating aliases which do not conflict with other joins which are
+        # part of the query.
+        attr_reader :join_dependency
+
+        # A JoinBase instance representing the active record we are joining onto.
+        # (So in Author.has_many :posts, the Author would be that base record.)
+        attr_reader :parent
+
+        # What type of join will be generated, either Arel::InnerJoin (default) or Arel::OuterJoin
+        attr_accessor :join_type
+
+        # These implement abstract methods from the superclass
+        attr_reader :aliased_prefix
+
+        attr_reader :tables
+
+        delegate :options, :through_reflection, :source_reflection, :chain, :to => :reflection
+        delegate :table, :table_name, :to => :parent, :prefix => :parent
+        delegate :alias_tracker, :to => :join_dependency
+
+        alias :alias_suffix :parent_table_name
+
+        def initialize(reflection, join_dependency, parent = nil)
+          reflection.check_validity!
+
+          if reflection.options[:polymorphic]
+            raise EagerLoadPolymorphicError.new(reflection)
+          end
+
+          super(reflection.klass)
+
+          @reflection      = reflection
+          @join_dependency = join_dependency
+          @parent          = parent
+          @join_type       = Arel::InnerJoin
+          @aliased_prefix  = "t#{ join_dependency.join_parts.size }"
+          @tables          = construct_tables.reverse
+        end
+
+        def ==(other)
+          other.class == self.class &&
+            other.reflection == reflection &&
+            other.parent == parent
+        end
+
+        def find_parent_in(other_join_dependency)
+          other_join_dependency.join_parts.detect do |join_part|
+            case parent
+            when JoinBase
+              parent.base_klass == join_part.base_klass
+            else
+              parent == join_part
+            end
+          end
+        end
+
+        def join_to(manager)
+          tables        = @tables.dup
+          foreign_table = parent_table
+          foreign_klass = parent.base_klass
+
+          # The chain starts with the target table, but we want to end with it here (makes
+          # more sense in this context), so we reverse
+          chain.reverse.each_with_index do |reflection, i|
+            table = tables.shift
+
+            case reflection.source_macro
+            when :belongs_to
+              key         = reflection.association_primary_key
+              foreign_key = reflection.foreign_key
+            when :has_and_belongs_to_many
+              # Join the join table first...
+              manager.from(join(
+                table,
+                table[reflection.foreign_key].
+                  eq(foreign_table[reflection.active_record_primary_key])
+              ))
+
+              foreign_table, table = table, tables.shift
+
+              key         = reflection.association_primary_key
+              foreign_key = reflection.association_foreign_key
+            else
+              key         = reflection.foreign_key
+              foreign_key = reflection.active_record_primary_key
+            end
+
+            constraint = build_constraint(reflection, table, key, foreign_table, foreign_key)
+
+            scope_chain_items = scope_chain[i]
+
+            if reflection.type
+              scope_chain_items += [
+                ActiveRecord::Relation.new(reflection.klass, table)
+                  .where(reflection.type => foreign_klass.base_class.name)
+              ]
+            end
+
+            scope_chain_items.each do |item|
+              unless item.is_a?(Relation)
+                item = ActiveRecord::Relation.new(reflection.klass, table).instance_exec(self, &item)
+              end
+
+              constraint = constraint.and(item.arel.constraints) unless item.arel.constraints.empty?
+            end
+
+            manager.from(join(table, constraint))
+
+            # The current table in this iteration becomes the foreign table in the next
+            foreign_table, foreign_klass = table, reflection.klass
+          end
+
+          manager
+        end
+
+        #  Builds equality condition.
+        #
+        #  Example:
+        #
+        #  class Physician < ActiveRecord::Base
+        #    has_many :appointments
+        #  end
+        #
+        #  If I execute `Physician.joins(:appointments).to_a` then
+        #    reflection    #=> #<ActiveRecord::Reflection::AssociationReflection @macro=:has_many ...>
+        #    table         #=> #<Arel::Table @name="appointments" ...>
+        #    key           #=>  physician_id
+        #    foreign_table #=> #<Arel::Table @name="physicians" ...>
+        #    foreign_key   #=> id
+        #
+        def build_constraint(reflection, table, key, foreign_table, foreign_key)
+          constraint = table[key].eq(foreign_table[foreign_key])
+
+          if reflection.klass.finder_needs_type_condition?
+            constraint = table.create_and([
+              constraint,
+              reflection.klass.send(:type_condition, table)
+            ])
+          end
+
+          constraint
+        end
+
+        def join_relation(joining_relation)
+          self.join_type = Arel::OuterJoin
+          joining_relation.joins(self)
+        end
+
+        def table
+          tables.last
+        end
+
+        def aliased_table_name
+          table.table_alias || table.name
+        end
+
+        def scope_chain
+          @scope_chain ||= reflection.scope_chain.reverse
+        end
+
+      end
+    end
+  end
+end

data/lib/active_record/associations/join_dependency/join_base.rb

@@ -0,0 +1,24 @@
+module ActiveRecord
+  module Associations
+    class JoinDependency # :nodoc:
+      class JoinBase < JoinPart # :nodoc:
+        def ==(other)
+          other.class == self.class &&
+            other.base_klass == base_klass
+        end
+
+        def aliased_prefix
+          "t0"
+        end
+
+        def table
+          Arel::Table.new(table_name, arel_engine)
+        end
+
+        def aliased_table_name
+          base_klass.table_name
+        end
+      end
+    end
+  end
+end

data/lib/active_record/associations/join_dependency/join_part.rb

@@ -0,0 +1,78 @@
+module ActiveRecord
+  module Associations
+    class JoinDependency # :nodoc:
+      # A JoinPart represents a part of a JoinDependency. It is inherited
+      # by JoinBase and JoinAssociation. A JoinBase represents the Active Record which
+      # everything else is being joined onto. A JoinAssociation represents an association which
+      # is joining to the base. A JoinAssociation may result in more than one actual join
+      # operations (for example a has_and_belongs_to_many JoinAssociation would result in
+      # two; one for the join table and one for the target table).
+      class JoinPart # :nodoc:
+        # The Active Record class which this join part is associated 'about'; for a JoinBase
+        # this is the actual base model, for a JoinAssociation this is the target model of the
+        # association.
+        attr_reader :base_klass
+
+        delegate :table_name, :column_names, :primary_key, :reflections, :arel_engine, :to => :base_klass
+
+        def initialize(base_klass)
+          @base_klass = base_klass
+          @cached_record = {}
+          @column_names_with_alias = nil
+        end
+
+        def aliased_table
+          Arel::Nodes::TableAlias.new table, aliased_table_name
+        end
+
+        def ==(other)
+          raise NotImplementedError
+        end
+
+        # An Arel::Table for the active_record
+        def table
+          raise NotImplementedError
+        end
+
+        # The prefix to be used when aliasing columns in the active_record's table
+        def aliased_prefix
+          raise NotImplementedError
+        end
+
+        # The alias for the active_record's table
+        def aliased_table_name
+          raise NotImplementedError
+        end
+
+        # The alias for the primary key of the active_record's table
+        def aliased_primary_key
+          "#{aliased_prefix}_r0"
+        end
+
+        # An array of [column_name, alias] pairs for the table
+        def column_names_with_alias
+          unless @column_names_with_alias
+            @column_names_with_alias = []
+
+            ([primary_key] + (column_names - [primary_key])).compact.each_with_index do |column_name, i|
+              @column_names_with_alias << [column_name, "#{aliased_prefix}_r#{i}"]
+            end
+          end
+          @column_names_with_alias
+        end
+
+        def extract_record(row)
+          Hash[column_names_with_alias.map{|cn, an| [cn, row[an]]}]
+        end
+
+        def record_id(row)
+          row[aliased_primary_key]
+        end
+
+        def instantiate(row)
+          @cached_record[record_id(row)] ||= base_klass.instantiate(extract_record(row))
+        end
+      end
+    end
+  end
+end

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