has_many_through_association.rb 11.7 KB
Newer Older
1 2 3
module ActiveRecord
  module Associations
    class HasManyThroughAssociation < AssociationProxy #:nodoc:
4 5
      def initialize(owner, reflection)
        super
6
        reflection.check_validity!
7 8 9 10
        @finder_sql = construct_conditions
        construct_sql
      end

11
      def find(*args)
12
        options = args.extract_options!
13 14 15 16 17 18 19 20 21 22 23 24

        conditions = "#{@finder_sql}"
        if sanitized_conditions = sanitize_sql(options[:conditions])
          conditions << " AND (#{sanitized_conditions})"
        end
        options[:conditions] = conditions

        if options[:order] && @reflection.options[:order]
          options[:order] = "#{options[:order]}, #{@reflection.options[:order]}"
        elsif @reflection.options[:order]
          options[:order] = @reflection.options[:order]
        end
25

26 27 28 29
        options[:select]  = construct_select(options[:select])
        options[:from]  ||= construct_from
        options[:joins]   = construct_joins(options[:joins])
        options[:include] = @reflection.source_reflection.options[:include] if options[:include].nil?
30

31 32
        merge_options_from_reflection!(options)

33 34 35 36 37 38 39 40 41 42
        # Pass through args exactly as we received them.
        args << options
        @reflection.klass.find(*args)
      end

      def reset
        @target = []
        @loaded = false
      end

43 44 45 46
      # Adds records to the association. The source record and its associates
      # must have ids in order to create records associating them, so this
      # will raise ActiveRecord::HasManyThroughCantAssociateNewRecords if
      # either is a new record.  Calls create! so you can rescue errors.
47 48 49 50
      #
      # The :before_add and :after_add callbacks are not yet supported.
      def <<(*records)
        return if records.empty?
51
        through = @reflection.through_reflection
52
        raise ActiveRecord::HasManyThroughCantAssociateNewRecords.new(@owner, through) if @owner.new_record?
53 54 55

        klass = through.klass
        klass.transaction do
56 57
          flatten_deeper(records).each do |associate|
            raise_on_type_mismatch(associate)
58
            raise ActiveRecord::HasManyThroughCantAssociateNewRecords.new(@owner, through) unless associate.respond_to?(:new_record?) && !associate.new_record?
59

60
            @owner.send(@reflection.through_reflection.name).proxy_target << klass.send(:with_scope, :create => construct_join_attributes(associate)) { klass.create! }
61
            @target << associate if loaded?
62 63
          end
        end
64 65

        self
66 67
      end

68 69
      [:push, :concat].each { |method| alias_method method, :<< }

70
      # Removes +records+ from this association.  Does not destroy +records+.
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
      def delete(*records)
        records = flatten_deeper(records)
        records.each { |associate| raise_on_type_mismatch(associate) }
        records.reject! { |associate| @target.delete(associate) if associate.new_record? }
        return if records.empty?
        
        @delete_join_finder ||= "find_all_by_#{@reflection.source_reflection.association_foreign_key}"
        through = @reflection.through_reflection
        through.klass.transaction do
          records.each do |associate|
            joins = @owner.send(through.name).send(@delete_join_finder, associate.id)
            @owner.send(through.name).delete(joins)
            @target.delete(associate)
          end
        end
      end

88 89
      def build(attrs = nil)
        raise ActiveRecord::HasManyThroughCantAssociateNewRecords.new(@owner, @reflection.through_reflection)
90
      end
91
      alias_method :new, :build
92 93 94

      def create!(attrs = nil)
        @reflection.klass.transaction do
95 96
          self << (object = @reflection.klass.send(:with_scope, :create => attrs) { @reflection.klass.create! })
          object
97 98 99
        end
      end

100 101 102 103
      # Returns the size of the collection by executing a SELECT COUNT(*) query if the collection hasn't been loaded and
      # calling collection.size if it has. If it's more likely than not that the collection does have a size larger than zero
      # and you need to fetch that collection afterwards, it'll take one less SELECT query if you use length.
      def size
104 105 106
        return @owner.send(:read_attribute, cached_counter_attribute_name) if has_cached_counter?
        return @target.size if loaded?
        return count
107 108
      end

109 110 111 112
      # Calculate sum using SQL, not Enumerable
      def sum(*args, &block)
        calculate(:sum, *args, &block)
      end
113 114 115 116 117 118 119 120 121 122
      
      def count(*args)
        column_name, options = @reflection.klass.send(:construct_count_options_from_args, *args)
        if @reflection.options[:uniq]
          # This is needed becase 'SELECT count(DISTINCT *)..' is not valid sql statement.
          column_name = "#{@reflection.klass.table_name}.#{@reflection.klass.primary_key}" if column_name == :all
          options.merge!(:distinct => true) 
        end
        @reflection.klass.send(:with_scope, construct_scope) { @reflection.klass.count(column_name, options) } 
      end
123

124 125 126 127 128
      protected
        def method_missing(method, *args, &block)
          if @target.respond_to?(method) || (!@reflection.klass.respond_to?(method) && Class.respond_to?(method))
            super
          else
129
            @reflection.klass.send(:with_scope, construct_scope) { @reflection.klass.send(method, *args, &block) }
130 131
          end
        end
132

133
        def find_target
134
          records = @reflection.klass.find(:all,
135
            :select     => construct_select,
136 137
            :conditions => construct_conditions,
            :from       => construct_from,
138
            :joins      => construct_joins,
139
            :order      => @reflection.options[:order],
140
            :limit      => @reflection.options[:limit],
141 142
            :group      => @reflection.options[:group],
            :include    => @reflection.options[:include] || @reflection.source_reflection.options[:include]
143
          )
144 145

          @reflection.options[:uniq] ? records.to_set.to_a : records
146 147
        end

148 149
        # Construct attributes for associate pointing to owner.
        def construct_owner_attributes(reflection)
150 151 152 153 154 155 156 157
          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

158 159
        # Construct attributes for :through pointing to owner and associate.
        def construct_join_attributes(associate)
160 161 162
          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)
163
          end
164
          join_attributes
165 166 167 168
        end

        # Associate attributes pointing to owner, quoted.
        def construct_quoted_owner_attributes(reflection)
169 170
          if as = reflection.options[:as]
            { "#{as}_id" => @owner.quoted_id,
171
              "#{as}_type" => reflection.klass.quote_value(
172 173
                @owner.class.base_class.name.to_s,
                reflection.klass.columns_hash["#{as}_type"]) }
174
          else
175 176 177 178
            { reflection.primary_key_name => @owner.quoted_id }
          end
        end

179
        # Build SQL conditions from attributes, qualified by table name.
180 181
        def construct_conditions
          table_name = @reflection.through_reflection.table_name
182
          conditions = construct_quoted_owner_attributes(@reflection.through_reflection).map do |attr, value|
183
            "#{table_name}.#{attr} = #{value}"
184
          end
185 186
          conditions << sql_conditions if sql_conditions
          "(" + conditions.join(') AND (') + ")"
187 188 189
        end

        def construct_from
190
          @reflection.table_name
191
        end
192

193
        def construct_select(custom_select = nil)
194
          selected = custom_select || @reflection.options[:select] || "#{@reflection.table_name}.*"
195
        end
196 197

        def construct_joins(custom_joins = nil)
198
          polymorphic_join = nil
199 200 201
          if @reflection.through_reflection.options[:as] || @reflection.source_reflection.macro == :belongs_to
            reflection_primary_key = @reflection.klass.primary_key
            source_primary_key     = @reflection.source_reflection.primary_key_name
202 203 204 205 206 207
            if @reflection.options[:source_type]
              polymorphic_join = "AND %s.%s = %s" % [
                @reflection.through_reflection.table_name, "#{@reflection.source_reflection.options[:foreign_type]}",
                @owner.class.quote_value(@reflection.options[:source_type])
              ]
            end
208 209 210
          else
            reflection_primary_key = @reflection.source_reflection.primary_key_name
            source_primary_key     = @reflection.klass.primary_key
211 212 213
            if @reflection.source_reflection.options[:as]
              polymorphic_join = "AND %s.%s = %s" % [
                @reflection.table_name, "#{@reflection.source_reflection.options[:as]}_type",
214
                @owner.class.quote_value(@reflection.through_reflection.klass.name)
215 216
              ]
            end
217
          end
218

219
          "INNER JOIN %s ON %s.%s = %s.%s %s #{@reflection.options[:joins]} #{custom_joins}" % [
220
            @reflection.through_reflection.table_name,
221
            @reflection.table_name, reflection_primary_key,
222 223
            @reflection.through_reflection.table_name, source_primary_key,
            polymorphic_join
224 225
          ]
        end
226

227
        def construct_scope
228
          { :create => construct_owner_attributes(@reflection),
229 230 231 232
            :find   => { :from        => construct_from,
                         :conditions  => construct_conditions,
                         :joins       => construct_joins,
                         :select      => construct_select } }
233
        end
234

235 236 237 238 239 240
        def construct_sql
          case
            when @reflection.options[:finder_sql]
              @finder_sql = interpolate_sql(@reflection.options[:finder_sql])

              @finder_sql = "#{@reflection.klass.table_name}.#{@reflection.primary_key_name} = #{@owner.quoted_id}"
241
              @finder_sql << " AND (#{conditions})" if conditions
242 243 244 245 246
          end

          if @reflection.options[:counter_sql]
            @counter_sql = interpolate_sql(@reflection.options[:counter_sql])
          elsif @reflection.options[:finder_sql]
247 248
            # replace the SELECT clause with COUNT(*), preserving any hints within /* ... */
            @reflection.options[:counter_sql] = @reflection.options[:finder_sql].sub(/SELECT (\/\*.*?\*\/ )?(.*)\bFROM\b/im) { "SELECT #{$1}COUNT(*) FROM" }
249 250 251 252 253
            @counter_sql = interpolate_sql(@reflection.options[:counter_sql])
          else
            @counter_sql = @finder_sql
          end
        end
254

255 256
        def conditions
          @conditions ||= [
257
            (interpolate_sql(@reflection.klass.send(:sanitize_sql, @reflection.options[:conditions])) if @reflection.options[:conditions]),
258 259 260
            (interpolate_sql(@reflection.active_record.send(:sanitize_sql, @reflection.through_reflection.options[:conditions])) if @reflection.through_reflection.options[:conditions]),
            ("#{@reflection.through_reflection.table_name}.#{@reflection.through_reflection.klass.inheritance_column} = #{@reflection.klass.quote_value(@reflection.through_reflection.klass.name.demodulize)}" unless @reflection.through_reflection.klass.descends_from_active_record?)
          ].compact.collect { |condition| "(#{condition})" }.join(' AND ') unless (!@reflection.options[:conditions] && !@reflection.through_reflection.options[:conditions] && @reflection.through_reflection.klass.descends_from_active_record?)
261
        end
262

263
        alias_method :sql_conditions, :conditions
264 265 266 267 268 269 270 271

        def has_cached_counter?
          @owner.attribute_present?(cached_counter_attribute_name)
        end

        def cached_counter_attribute_name
          "#{@reflection.name}_count"
        end
272 273 274
    end
  end
end