Skip to content

Commit

Permalink
Make calculations typecasty! (closes #4016) [Rick Olson]
Browse files Browse the repository at this point in the history 
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@3722 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information
@dhh
dhh committed Mar 1, 2006
1 parent 32e0beb commit a8d085a
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 26 deletions.
44 changes: 37 additions & 7 deletions activerecord/lib/active_record/calculations.rb
View file
@@ -1,5 +1,6 @@
module ActiveRecord module ActiveRecord
module Calculations module Calculations
CALCULATIONS_OPTIONS = [:conditions, :joins, :order, :select, :group, :having, :distinct]
def self.included(base) def self.included(base)
base.extend(ClassMethods) base.extend(ClassMethods)
end end
Expand All @@ -19,6 +20,11 @@ module ClassMethods
# * <tt>:include</tt>: Named associations that should be loaded alongside using LEFT OUTER JOINs. The symbols named refer # * <tt>:include</tt>: Named associations that should be loaded alongside using LEFT OUTER JOINs. The symbols named refer
# to already defined associations. When using named associations count returns the number DISTINCT items for the model you're counting. # to already defined associations. When using named associations count returns the number DISTINCT items for the model you're counting.
# See eager loading under Associations. # See eager loading under Associations.
# * <tt>:order</tt>: An SQL fragment like "created_at DESC, name" (really only used with GROUP BY calculations).
# * <tt>:group</tt>: An attribute name by which the result should be grouped. Uses the GROUP BY SQL-clause.
# * <tt>:select</tt>: By default, this is * as in SELECT * FROM, but can be changed if you for example want to do a join, but not
# include the joined columns.
# * <tt>:distinct</tt>: Set this to true to make this a distinct calculation, such as SELECT COUNT(DISTINCT posts.id) ...
# #
# Examples for counting all: # Examples for counting all:
# Person.count # returns the total count of all people # Person.count # returns the total count of all people
Expand All @@ -37,7 +43,6 @@ module ClassMethods
# Note: Person.count(:all) will not work because it will use :all as the condition. Use Person.count instead. # Note: Person.count(:all) will not work because it will use :all as the condition. Use Person.count instead.
def count(*args) def count(*args)
options = {} options = {}
column_name = :all


#For backwards compatibility, we need to handle both count(conditions=nil, joins=nil) or count(options={}). #For backwards compatibility, we need to handle both count(conditions=nil, joins=nil) or count(options={}).
if args.size >= 0 and args.size <= 2 if args.size >= 0 and args.size <= 2
Expand All @@ -55,9 +60,8 @@ def count(*args)
else else
raise(ArgumentError, "Unexpected parameters passed to count(*args): expected either count(conditions=nil, joins=nil) or count(options={})") raise(ArgumentError, "Unexpected parameters passed to count(*args): expected either count(conditions=nil, joins=nil) or count(options={})")
end end


column_name = options[:select] if options[:select] options[:include] ? count_with_associations(options) : calculate(:count, :all, options)
options[:include] ? count_with_associations(options) : calculate(:count, column_name, options)
end end


# Calculates average value on a given column. The value is returned as a float. See #calculate for examples with options. # Calculates average value on a given column. The value is returned as a float. See #calculate for examples with options.
Expand Down Expand Up @@ -109,14 +113,26 @@ def sum(column_name, options = {})
# ... # ...
# end # end
# #
# Options:
# * <tt>:conditions</tt>: An SQL fragment like "administrator = 1" or [ "user_name = ?", username ]. See conditions in the intro.
# * <tt>:joins</tt>: An SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id". (Rarely needed).
# The records will be returned read-only since they will have attributes that do not correspond to the table's columns.
# * <tt>:order</tt>: An SQL fragment like "created_at DESC, name" (really only used with GROUP BY calculations).
# * <tt>:group</tt>: An attribute name by which the result should be grouped. Uses the GROUP BY SQL-clause.
# * <tt>:select</tt>: By default, this is * as in SELECT * FROM, but can be changed if you for example want to do a join, but not
# include the joined columns.
# * <tt>:distinct</tt>: Set this to true to make this a distinct calculation, such as SELECT COUNT(DISTINCT posts.id) ...
#
# Examples: # Examples:
# Person.calculate(:count, :all) # The same as Person.count # Person.calculate(:count, :all) # The same as Person.count
# Person.average(:age) # SELECT AVG(age) FROM people... # Person.average(:age) # SELECT AVG(age) FROM people...
# Person.minimum(:age, :conditions => ['last_name != ?', 'Drake']) # Selects the minimum age for everyone with a last name other than 'Drake' # Person.minimum(:age, :conditions => ['last_name != ?', 'Drake']) # Selects the minimum age for everyone with a last name other than 'Drake'
# Person.minimum(:age, :having => 'min(age) > 17', :group => :last_name) # Selects the minimum age for any family without any minors # Person.minimum(:age, :having => 'min(age) > 17', :group => :last_name) # Selects the minimum age for any family without any minors
def calculate(operation, column_name, options = {}) def calculate(operation, column_name, options = {})
validate_calculation_options(operation, options)
column_name = options[:select] if options[:select]
column_name = '*' if column_name == :all column_name = '*' if column_name == :all
column = columns.detect { |c| c.name.to_s == column_name.to_s } column = column_for column_name
aggregate = select_aggregate(operation, column_name, options) aggregate = select_aggregate(operation, column_name, options)
aggregate_alias = column_alias_for(operation, column_name) aggregate_alias = column_alias_for(operation, column_name)
if options[:group] if options[:group]
Expand Down Expand Up @@ -149,6 +165,7 @@ def execute_grouped_calculation(operation, column_name, column, aggregate, aggre
associated = association && association.macro == :belongs_to # only count belongs_to associations associated = association && association.macro == :belongs_to # only count belongs_to associations
group_field = (associated ? "#{options[:group]}_id" : options[:group]).to_s group_field = (associated ? "#{options[:group]}_id" : options[:group]).to_s
group_alias = column_alias_for(group_field) group_alias = column_alias_for(group_field)
group_column = column_for group_field
sql = construct_calculation_sql(aggregate, aggregate_alias, options.merge(:group_field => group_field, :group_alias => group_alias)) sql = construct_calculation_sql(aggregate, aggregate_alias, options.merge(:group_field => group_field, :group_alias => group_alias))
calculated_data = connection.select_all(sql) calculated_data = connection.select_all(sql)


Expand All @@ -159,13 +176,21 @@ def execute_grouped_calculation(operation, column_name, column, aggregate, aggre
end end


calculated_data.inject(OrderedHash.new) do |all, row| calculated_data.inject(OrderedHash.new) do |all, row|
key = associated ? key_records[row[group_alias].to_i] : row[group_alias] key = associated ? key_records[row[group_alias].to_i] : type_cast_calculated_value(row[group_alias], group_column)
value = row[aggregate_alias] value = row[aggregate_alias]
all << [key, type_cast_calculated_value(value, column, operation)] all << [key, type_cast_calculated_value(value, column, operation)]
end end
end end


private private
def validate_calculation_options(operation, options = {})
if operation.to_s == 'count'
options.assert_valid_keys(CALCULATIONS_OPTIONS + [:include])
else
options.assert_valid_keys(CALCULATIONS_OPTIONS)
end
end

def select_aggregate(operation, column_name, options) def select_aggregate(operation, column_name, options)
"#{operation}(#{'DISTINCT ' if options[:distinct]}#{column_name})" "#{operation}(#{'DISTINCT ' if options[:distinct]}#{column_name})"
end end
Expand All @@ -180,7 +205,12 @@ def column_alias_for(*keys)
keys.join(' ').downcase.gsub(/\*/, 'all').gsub(/\W+/, ' ').strip.gsub(/ +/, '_') keys.join(' ').downcase.gsub(/\*/, 'all').gsub(/\W+/, ' ').strip.gsub(/ +/, '_')
end end


def type_cast_calculated_value(value, column, operation) def column_for(field)
field_name = field.to_s.split('.').last
columns.detect { |c| c.name.to_s == field_name }
end

def type_cast_calculated_value(value, column, operation = nil)
operation = operation.to_s.downcase operation = operation.to_s.downcase
case operation case operation
when 'count' then value.to_i when 'count' then value.to_i
Expand Down
58 changes: 39 additions & 19 deletions activerecord/test/calculations_test.rb
View file
Expand Up @@ -27,22 +27,22 @@ def test_should_get_minimum_of_field


def test_should_group_by_field def test_should_group_by_field
c = Account.sum(:credit_limit, :group => :firm_id) c = Account.sum(:credit_limit, :group => :firm_id)
%w( 1 6 2 ).each { |firm_id| assert c.keys.include?(firm_id) } [1,6,2].each { |firm_id| assert c.keys.include?(firm_id) }
end end


def test_should_group_by_summed_field def test_should_group_by_summed_field
c = Account.sum(:credit_limit, :group => :firm_id) c = Account.sum(:credit_limit, :group => :firm_id)
assert_equal 50, c['1'] assert_equal 50, c[1]
assert_equal 105, c['6'] assert_equal 105, c[6]
assert_equal 60, c['2'] assert_equal 60, c[2]
end end


def test_should_group_by_summed_field_having_condition def test_should_group_by_summed_field_having_condition
c = Account.sum(:credit_limit, :group => :firm_id, c = Account.sum(:credit_limit, :group => :firm_id,
:having => 'sum(credit_limit) > 50') :having => 'sum(credit_limit) > 50')
assert_nil c['1'] assert_nil c[1]
assert_equal 105, c['6'] assert_equal 105, c[6]
assert_equal 60, c['2'] assert_equal 60, c[2]
end end


def test_should_group_by_summed_association def test_should_group_by_summed_association
Expand All @@ -59,25 +59,25 @@ def test_should_sum_field_with_conditions
def test_should_group_by_summed_field_with_conditions def test_should_group_by_summed_field_with_conditions
c = Account.sum(:credit_limit, :conditions => 'firm_id > 1', c = Account.sum(:credit_limit, :conditions => 'firm_id > 1',
:group => :firm_id) :group => :firm_id)
assert_nil c['1'] assert_nil c[1]
assert_equal 105, c['6'] assert_equal 105, c[6]
assert_equal 60, c['2'] assert_equal 60, c[2]
end end


def test_should_group_by_summed_field_with_conditions_and_having def test_should_group_by_summed_field_with_conditions_and_having
c = Account.sum(:credit_limit, :conditions => 'firm_id > 1', c = Account.sum(:credit_limit, :conditions => 'firm_id > 1',
:group => :firm_id, :group => :firm_id,
:having => 'sum(credit_limit) > 60') :having => 'sum(credit_limit) > 60')
assert_nil c['1'] assert_nil c[1]
assert_equal 105, c['6'] assert_equal 105, c[6]
assert_nil c['2'] assert_nil c[2]
end end


def test_should_group_by_fields_with_table_alias def test_should_group_by_fields_with_table_alias
c = Account.sum(:credit_limit, :group => 'accounts.firm_id') c = Account.sum(:credit_limit, :group => 'accounts.firm_id')
assert_equal 50, c['1'] assert_equal 50, c[1]
assert_equal 105, c['6'] assert_equal 105, c[6]
assert_equal 60, c['2'] assert_equal 60, c[2]
end end


def test_should_calculate_with_invalid_field def test_should_calculate_with_invalid_field
Expand All @@ -87,9 +87,9 @@ def test_should_calculate_with_invalid_field


def test_should_calculate_grouped_with_invalid_field def test_should_calculate_grouped_with_invalid_field
c = Account.count(:all, :group => 'accounts.firm_id') c = Account.count(:all, :group => 'accounts.firm_id')
assert_equal 1, c['1'] assert_equal 1, c[1]
assert_equal 2, c['6'] assert_equal 2, c[6]
assert_equal 1, c['2'] assert_equal 1, c[2]
end end


def test_should_calculate_grouped_association_with_invalid_field def test_should_calculate_grouped_association_with_invalid_field
Expand Down Expand Up @@ -135,4 +135,24 @@ def test_should_group_by_summed_field_with_conditions_and_having
assert_nil c['Leetsoft'] assert_nil c['Leetsoft']
assert_equal 8, c['Jadedpixel'] assert_equal 8, c['Jadedpixel']
end end

def test_should_reject_invalid_options
assert_nothing_raised do
[:count, :sum].each do |func|
# empty options are valid
Company.send(:validate_calculation_options, func)
# these options are valid for all calculations
[:select, :conditions, :joins, :order, :group, :having, :distinct].each do |opt|
Company.send(:validate_calculation_options, func, opt => true)
end
end

# :include is only valid on :count
Company.send(:validate_calculation_options, :count, :include => true)
end

assert_raises(ArgumentError) { Company.send(:validate_calculation_options, :sum, :include => :posts) }
assert_raises(ArgumentError) { Company.send(:validate_calculation_options, :sum, :foo => :bar) }
assert_raises(ArgumentError) { Company.send(:validate_calculation_options, :count, :foo => :bar) }
end
end end

0 comments on commit a8d085a

Please sign in to comment.