calculation_methods.rb 5.9 KB
Newer Older
1
module ActiveRecord
2
  module CalculationMethods
3 4

    def count(*args)
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
      calculate(:count, *construct_count_options_from_args(*args))
    end

    def average(column_name)
      calculate(:average, column_name)
    end

    def minimum(column_name)
      calculate(:minimum, column_name)
    end

    def maximum(column_name)
      calculate(:maximum, column_name)
    end

    def sum(column_name)
      calculate(:sum, column_name)
    end

    def calculate(operation, column_name, options = {})
      operation = operation.to_s.downcase

      if operation == "count"
        joins = @relation.joins(relation)
        if joins.present? && joins =~ /LEFT OUTER/i
          distinct = true
          column_name = @klass.primary_key if column_name == :all
        end
33

34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
        distinct = nil if column_name.to_s =~ /\s*DISTINCT\s+/i
        distinct ||= options[:distinct]
      else
        distinct = nil
      end

      distinct = options[:distinct] || distinct
      column_name = :all if column_name.blank? && operation == "count"

      if @relation.send(:groupings).any?
        return execute_grouped_calculation(operation, column_name)
      else
        return execute_simple_calculation(operation, column_name, distinct)
      end
    rescue ThrowResult
      0
    end

    private

    def execute_simple_calculation(operation, column_name, distinct) #:nodoc:
55
      column = if @klass.column_names.include?(column_name.to_s)
56
        Arel::Attribute.new(@klass.arel_table, column_name)
57 58 59 60
      else
        Arel::SqlLiteral.new(column_name == :all ? "*" : column_name.to_s)
      end

61 62
      relation = select(operation == 'count' ? column.count(distinct) : column.send(operation))
      type_cast_calculated_value(@klass.connection.select_value(relation.to_sql), column_for(column_name), operation)
63 64
    end

65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
    def execute_grouped_calculation(operation, column_name) #:nodoc:
      group_attr      = @relation.send(:groupings).first.value
      association     = @klass.reflect_on_association(group_attr.to_sym)
      associated      = association && association.macro == :belongs_to # only count belongs_to associations
      group_field     = associated ? association.primary_key_name : group_attr
      group_alias     = column_alias_for(group_field)
      group_column    = column_for(group_field)

      group = @klass.connection.adapter_name == 'FrontBase' ? group_alias : group_field

      aggregate_alias = column_alias_for(operation, column_name)

      select_statement = if operation == 'count' && column_name == :all
        "COUNT(*) AS count_all"
      else
        Arel::Attribute.new(@klass.arel_table, column_name).send(operation).as(aggregate_alias).to_sql
      end

      select_statement <<  ", #{group_field} AS #{group_alias}"

      relation = select(select_statement).group(group)

      calculated_data = @klass.connection.select_all(relation.to_sql)

      if association
        key_ids     = calculated_data.collect { |row| row[group_alias] }
        key_records = association.klass.base_class.find(key_ids)
        key_records = key_records.inject({}) { |hsh, r| hsh.merge(r.id => r) }
      end

      calculated_data.inject(ActiveSupport::OrderedHash.new) do |all, row|
        key   = type_cast_calculated_value(row[group_alias], group_column)
        key   = key_records[key] if associated
        value = row[aggregate_alias]
        all[key] = type_cast_calculated_value(value, column_for(column_name), operation)
        all
      end
    end
103 104 105 106 107

    def construct_count_options_from_args(*args)
      options     = {}
      column_name = :all

108
      # Handles count(), count(:column), count(:distinct => true), count(:column, :distinct => true)
109 110 111
      # TODO : relation.projections only works when .select() was last in the chain. Fix it!
      case args.size
      when 0
112
        select = get_projection_name_from_chained_relations
113
        column_name = select if select !~ /(,|\*)/
114 115
      when 1
        if args[0].is_a?(Hash)
116
          select = get_projection_name_from_chained_relations
117
          column_name = select if select !~ /(,|\*)/
118 119 120 121 122 123 124 125 126 127 128 129 130
          options = args[0]
        else
          column_name = args[0]
        end
      when 2
        column_name, options = args
      else
        raise ArgumentError, "Unexpected parameters passed to count(): #{args.inspect}"
      end

      [column_name || :all, options]
    end

131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
    # Converts the given keys to the value that the database adapter returns as
    # a usable column name:
    #
    #   column_alias_for("users.id")                 # => "users_id"
    #   column_alias_for("sum(id)")                  # => "sum_id"
    #   column_alias_for("count(distinct users.id)") # => "count_distinct_users_id"
    #   column_alias_for("count(*)")                 # => "count_all"
    #   column_alias_for("count", "id")              # => "count_id"
    def column_alias_for(*keys)
      table_name = keys.join(' ')
      table_name.downcase!
      table_name.gsub!(/\*/, 'all')
      table_name.gsub!(/\W+/, ' ')
      table_name.strip!
      table_name.gsub!(/ +/, '_')

      @klass.connection.table_alias_for(table_name)
    end

    def column_for(field)
      field_name = field.to_s.split('.').last
      @klass.columns.detect { |c| c.name.to_s == field_name }
    end

    def type_cast_calculated_value(value, column, operation = nil)
      case operation
        when 'count' then value.to_i
        when 'sum'   then type_cast_using_column(value || '0', column)
        when 'average'   then value && (value.is_a?(Fixnum) ? value.to_f : value).to_d
        else type_cast_using_column(value, column)
      end
    end

    def type_cast_using_column(value, column)
      column ? column.type_cast(value) : value
    end

168 169 170 171 172
    def get_projection_name_from_chained_relations(relation = @relation)
      if relation.respond_to?(:projections) && relation.projections.present?
        relation.send(:select_clauses).join(', ')
      elsif relation.respond_to?(:relation)
        get_projection_name_from_chained_relations(relation.relation)
173 174 175
      end
    end

176 177
  end
end