Module: ActiveRecord::Associations::ThroughAssociationScope

### Home Classes Methods

### In Files

- lib/active_record/associations/through_association_scope.rb

### Methods

- #build_conditions
- #build_sti_condition
- #build_through_conditions
- #conditions
- #construct_conditions
- #construct_from
- #construct_join_attributes
- #construct_joins
- #construct_owner_attributes
- #construct_quoted_owner_attributes
- #construct_scope
- #construct_select
- #sql_conditions

### Files

- README.rdoc

### Class/Module Index

Quicksearch

- ActiveRecord
- ActiveRecord::ActiveRecordError
- ActiveRecord::AdapterNotFound
- ActiveRecord::AdapterNotSpecified
- ActiveRecord::Aggregations
- ActiveRecord::Aggregations::ClassMethods
- ActiveRecord::AssociationPreload
- ActiveRecord::AssociationPreload::ClassMethods
- ActiveRecord::AssociationTypeMismatch
- ActiveRecord::Associations
- ActiveRecord::Associations::ClassMethods
- ActiveRecord::Associations::HasOneThroughAssociation
- ActiveRecord::Associations::ThroughAssociationScope
- ActiveRecord::AttributeAssignmentError
- ActiveRecord::AttributeMethods
- ActiveRecord::AttributeMethods::BeforeTypeCast
- ActiveRecord::AttributeMethods::ClassMethods
- ActiveRecord::AttributeMethods::Dirty
- ActiveRecord::AttributeMethods::PrimaryKey
- ActiveRecord::AttributeMethods::PrimaryKey::ClassMethods
- ActiveRecord::AttributeMethods::Query
- ActiveRecord::AttributeMethods::Read
- ActiveRecord::AttributeMethods::Read::ClassMethods
- ActiveRecord::AttributeMethods::TimeZoneConversion
- ActiveRecord::AttributeMethods::TimeZoneConversion::ClassMethods
- ActiveRecord::AttributeMethods::Write
- ActiveRecord::AttributeMethods::Write::ClassMethods
- ActiveRecord::AutosaveAssociation
- ActiveRecord::AutosaveAssociation::ClassMethods
- ActiveRecord::Base
- ActiveRecord::Calculations
- ActiveRecord::Callbacks
- ActiveRecord::Callbacks::ClassMethods
- ActiveRecord::ConfigurationError
- ActiveRecord::ConnectionAdapters
- ActiveRecord::ConnectionAdapters::AbstractAdapter
- ActiveRecord::ConnectionAdapters::Column
- ActiveRecord::ConnectionAdapters::Column::Format
- ActiveRecord::ConnectionAdapters::ConnectionHandler
- ActiveRecord::ConnectionAdapters::ConnectionManagement
- ActiveRecord::ConnectionAdapters::ConnectionPool
- ActiveRecord::ConnectionAdapters::DatabaseLimits
- ActiveRecord::ConnectionAdapters::DatabaseStatements
- ActiveRecord::ConnectionAdapters::MysqlAdapter
- ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
- ActiveRecord::ConnectionAdapters::PostgreSQLColumn
- ActiveRecord::ConnectionAdapters::QueryCache
- ActiveRecord::ConnectionAdapters::Quoting
- ActiveRecord::ConnectionAdapters::SQLiteAdapter
- ActiveRecord::ConnectionAdapters::SQLiteAdapter::Version
- ActiveRecord::ConnectionAdapters::SchemaStatements
- ActiveRecord::ConnectionAdapters::Table
- ActiveRecord::ConnectionAdapters::TableDefinition
- ActiveRecord::ConnectionNotEstablished
- ActiveRecord::ConnectionTimeoutError
- ActiveRecord::CounterCache
- ActiveRecord::DangerousAttributeError
- ActiveRecord::DynamicFinderMatch
- ActiveRecord::DynamicScopeMatch
- ActiveRecord::FinderMethods
- ActiveRecord::Generators
- ActiveRecord::Generators::Migration
- ActiveRecord::Generators::MigrationGenerator
- ActiveRecord::Generators::ModelGenerator
- ActiveRecord::Generators::ObserverGenerator
- ActiveRecord::Generators::SessionMigrationGenerator
- ActiveRecord::InvalidForeignKey
- ActiveRecord::IrreversibleMigration
- ActiveRecord::Locking
- ActiveRecord::Locking::Optimistic
- ActiveRecord::Locking::Optimistic::ClassMethods
- ActiveRecord::Locking::Pessimistic
- ActiveRecord::LogSubscriber
- ActiveRecord::Migration
- ActiveRecord::MigrationProxy
- ActiveRecord::MultiparameterAssignmentErrors
- ActiveRecord::NamedScope
- ActiveRecord::NamedScope::ClassMethods
- ActiveRecord::NestedAttributes
- ActiveRecord::NestedAttributes::ClassMethods
- ActiveRecord::NestedAttributes::TooManyRecords
- ActiveRecord::Observer
- ActiveRecord::Persistence
- ActiveRecord::PredicateBuilder
- ActiveRecord::PreparedStatementInvalid
- ActiveRecord::QueryCache
- ActiveRecord::QueryCache::ClassMethods
- ActiveRecord::QueryMethods
- ActiveRecord::Railtie
- ActiveRecord::Railties
- ActiveRecord::Railties::ControllerRuntime
- ActiveRecord::Railties::ControllerRuntime::ClassMethods
- ActiveRecord::ReadOnlyRecord
- ActiveRecord::RecordInvalid
- ActiveRecord::RecordNotFound
- ActiveRecord::RecordNotSaved
- ActiveRecord::RecordNotUnique
- ActiveRecord::Reflection
- ActiveRecord::Reflection::ClassMethods
- ActiveRecord::Reflection::MacroReflection
- ActiveRecord::Relation
- ActiveRecord::Rollback
- ActiveRecord::Schema
- ActiveRecord::Serialization
- ActiveRecord::SerializationTypeMismatch
- ActiveRecord::SessionStore
- ActiveRecord::SessionStore::Session
- ActiveRecord::SessionStore::SqlBypass
- ActiveRecord::SpawnMethods
- ActiveRecord::StaleObjectError
- ActiveRecord::StatementInvalid
- ActiveRecord::TestFixtures
- ActiveRecord::TestFixtures::ClassMethods
- ActiveRecord::ThrowResult
- ActiveRecord::Timestamp
- ActiveRecord::Transactions
- ActiveRecord::Transactions::ClassMethods
- ActiveRecord::UnknownAttributeError
- ActiveRecord::Validations
- ActiveRecord::Validations::AssociatedValidator
- ActiveRecord::Validations::ClassMethods
- ActiveRecord::Validations::UniquenessValidator
- ActiveRecord::WrappedDatabaseException
- <
- Fixtures
- FixturesFileNotFound

No matching classes.

# ActiveRecord::Associations::ThroughAssociationScope

### Protected Instance Methods

build_conditions() click to toggle source

    # File lib/active_record/associations/through_association_scope.rb, line 116
    def build_conditions
      association_conditions = @reflection.options[:conditions]
      through_conditions = build_through_conditions
      source_conditions = @reflection.source_reflection.options[:conditions]
      uses_sti = !@reflection.through_reflection.klass.descends_from_active_record?

      if association_conditions || through_conditions || source_conditions || uses_sti
        all = []

        [association_conditions, source_conditions].each do |conditions|
          all << interpolate_and_sanitize_sql(conditions) if conditions
        end

        all << through_conditions  if through_conditions
        all << build_sti_condition if uses_sti

        all.map { |sql| "(#{sql})" } * ' AND '
      end
    end

build_sti_condition() click to toggle source

    # File lib/active_record/associations/through_association_scope.rb, line 147
    def build_sti_condition
      @reflection.through_reflection.klass.send(:type_condition).to_sql
    end

build_through_conditions() click to toggle source

    # File lib/active_record/associations/through_association_scope.rb, line 136
    def build_through_conditions
      conditions = @reflection.through_reflection.options[:conditions]
      if conditions.is_a?(Hash)
        interpolate_and_sanitize_sql(conditions, nil, @reflection.through_reflection.klass).gsub(
          @reflection.quoted_table_name,
          @reflection.through_reflection.quoted_table_name)
      elsif conditions
        interpolate_and_sanitize_sql(conditions)
      end
    end

conditions() click to toggle source

    # File lib/active_record/associations/through_association_scope.rb, line 111
    def conditions
      @conditions = build_conditions unless defined?(@conditions)
      @conditions
    end

Also aliased as: sql_conditions
construct_conditions() click to toggle source

Build SQL conditions from attributes, qualified by table name.

    # File lib/active_record/associations/through_association_scope.rb, line 21
    def construct_conditions
      table_name = @reflection.through_reflection.quoted_table_name
      conditions = construct_quoted_owner_attributes(@reflection.through_reflection).map do |attr, value|
        "#{table_name}.#{attr} = #{value}"
      end
      conditions << sql_conditions if sql_conditions
      "(" + conditions.join(') AND (') + ")"
    end

construct_from() click to toggle source

    # File lib/active_record/associations/through_association_scope.rb, line 44
    def construct_from
      @reflection.table_name
    end

construct_join_attributes(associate) click to toggle source

Construct attributes for :through pointing to owner and associate.

    # File lib/active_record/associations/through_association_scope.rb, line 94
    def construct_join_attributes(associate)
      # TODO: revisit this to allow it for deletion, supposing dependent option is supported
      raise ActiveRecord::HasManyThroughCantAssociateThroughHasOneOrManyReflection.new(@owner, @reflection) if [:has_one, :has_many].include?(@reflection.source_reflection.macro)

      join_attributes = construct_owner_attributes(@reflection.through_reflection).merge(@reflection.source_reflection.primary_key_name => associate.id)

      if @reflection.options[:source_type]
        join_attributes.merge!(@reflection.source_reflection.options[:foreign_type] => associate.class.base_class.name.to_s)
      end

      if @reflection.through_reflection.options[:conditions].is_a?(Hash)
        join_attributes.merge!(@reflection.through_reflection.options[:conditions])
      end

      join_attributes
    end

construct_joins(custom_joins = nil) click to toggle source

    # File lib/active_record/associations/through_association_scope.rb, line 53
    def construct_joins(custom_joins = nil)
      polymorphic_join = nil
      if @reflection.source_reflection.macro == :belongs_to
        reflection_primary_key = @reflection.klass.primary_key
        source_primary_key     = @reflection.source_reflection.primary_key_name
        if @reflection.options[:source_type]
          polymorphic_join = "AND %s.%s = %s" % [
            @reflection.through_reflection.quoted_table_name, "#{@reflection.source_reflection.options[:foreign_type]}",
            @owner.class.quote_value(@reflection.options[:source_type])
          ]
        end
      else
        reflection_primary_key = @reflection.source_reflection.primary_key_name
        source_primary_key     = @reflection.through_reflection.klass.primary_key
        if @reflection.source_reflection.options[:as]
          polymorphic_join = "AND %s.%s = %s" % [
            @reflection.quoted_table_name, "#{@reflection.source_reflection.options[:as]}_type",
            @owner.class.quote_value(@reflection.through_reflection.klass.name)
          ]
        end
      end

      "INNER JOIN %s ON %s.%s = %s.%s %s #{@reflection.options[:joins]} #{custom_joins}" % [
        @reflection.through_reflection.quoted_table_name,
        @reflection.quoted_table_name, reflection_primary_key,
        @reflection.through_reflection.quoted_table_name, source_primary_key,
        polymorphic_join
      ]
    end

construct_owner_attributes(reflection) click to toggle source

Construct attributes for associate pointing to owner.

    # File lib/active_record/associations/through_association_scope.rb, line 84
    def construct_owner_attributes(reflection)
      if as = reflection.options[:as]
        { "#{as}_id" => @owner.id,
          "#{as}_type" => @owner.class.base_class.name.to_s }
      else
        { reflection.primary_key_name => @owner.id }
      end
    end

construct_quoted_owner_attributes(reflection) click to toggle source

Associate attributes pointing to owner, quoted.

    # File lib/active_record/associations/through_association_scope.rb, line 31
    def construct_quoted_owner_attributes(reflection)
      if as = reflection.options[:as]
        { "#{as}_id" => owner_quoted_id,
          "#{as}_type" => reflection.klass.quote_value(
            @owner.class.base_class.name.to_s,
            reflection.klass.columns_hash["#{as}_type"]) }
      elsif reflection.macro == :belongs_to
        { reflection.klass.primary_key => @owner.class.quote_value(@owner[reflection.primary_key_name]) }
      else
        { reflection.primary_key_name => owner_quoted_id }
      end
    end

construct_scope() click to toggle source

    # File lib/active_record/associations/through_association_scope.rb, line 8
    def construct_scope
      { :create => construct_owner_attributes(@reflection),
        :find   => { :conditions  => construct_conditions,
                     :joins       => construct_joins,
                     :include     => @reflection.options[:include] || @reflection.source_reflection.options[:include],
                     :select      => construct_select,
                     :order       => @reflection.options[:order],
                     :limit       => @reflection.options[:limit],
                     :readonly    => @reflection.options[:readonly],
         } }
    end

construct_select(custom_select = nil) click to toggle source

    # File lib/active_record/associations/through_association_scope.rb, line 48
    def construct_select(custom_select = nil)
      distinct = "DISTINCT " if @reflection.options[:uniq]
      selected = custom_select || @reflection.options[:select] || "#{distinct}#{@reflection.quoted_table_name}.*"
    end

sql_conditions() click to toggle source
Alias for: conditions

[Validate]

Generated with the Darkfish Rdoc Generator 2.