weighted_average 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+test/test.log

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Seamus Abshere
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,21 @@
+= weighted_average
+
+Description goes here.
+
+= Rails 3 only
+
+We use ARel so we need Rails 3. Please let me know if you want Rails 2, because I an (ungemified) version of that.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Seamus Abshere, Andy Rossmeissl, Ian Hough, and Matt Kling. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "weighted_average"
+    gem.summary = %Q{Perform weighted averages. Rails 3 only.}
+    gem.description = %Q{Perform weighted averages, even across associations. Rails 3 only because it uses ARel.}
+    gem.email = "seamus@abshere.net"
+    gem.homepage = "http://github.com/seamusabshere/weighted_average"
+    gem.authors = ["Seamus Abshere", "Andy Rossmeissl", "Ian Hough", "Matt Kling"]
+    gem.add_dependency 'activerecord', '>=3.0.0.beta2'
+    gem.add_dependency 'activesupport', '>=3.0.0.beta2'
+    gem.add_dependency 'arel', '>=0.3.3'
+    gem.add_development_dependency 'cohort_scope', '>=0.0.2'
+    gem.add_development_dependency "shoulda", ">= 2.10.3"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "weighted_average #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/weighted_average.rb

@@ -0,0 +1,75 @@
+require 'active_support'
+require 'active_record'
+
+module ActiveRecord
+  module WeightedAverage
+    # Returns a number
+    def weighted_average(*args)
+      connection.select_value(weighted_average_relation(*args).to_sql, 'weighted_average').to_f
+    end
+    
+    # Returns the ARel relation
+    def weighted_average_relation(column_names, options = {})
+      raise ArgumentError, "Only use array form if the weighting column in the foreign table is not called 'weighting'" if options[:weighted_by].is_a?(Array) and options[:weighted_by].length != 2
+      raise ArgumentError, "No nil values in weighted_by, please" if Array.wrap(options[:weighted_by]).any?(&:nil?)
+      
+      # aircraft['seats'] or (aircraft['seats'] + aircraft['payload'])
+      columns = Array.wrap(column_names).map { |column_name| arel_table[column_name.to_s] }
+
+      # :airline_aircraft_seat_class
+      association = if options[:weighted_by].present?
+        options[:weighted_by].is_a?(Array) ? reflect_on_association(options[:weighted_by].first.to_sym) : reflect_on_association(options[:weighted_by].to_sym)
+      end
+      
+      # AirlineAircraftSeatClass
+      association_class = association.klass if association
+            
+      # AirlineAircraftSeatClass.arel_table
+      foreign_arel_table = association_class.arel_table if association_class
+
+      # set up join ON
+      join_on = if association_class
+        raise ArgumentError, "#{association.primary_key_name} isn't a column in the #{association_class.table_name} table" unless association_class.column_names.include?(association.primary_key_name)
+        foreign_arel_table[association.primary_key_name].eq arel_table[primary_key]
+      end
+      
+      # 'weighting'
+      weighted_by_column = if association_class and options[:weighted_by].is_a?(Array)
+        options[:weighted_by].last.to_s
+      elsif !association_class and (options[:weighted_by].is_a?(String) or options[:weighted_by].is_a?(Symbol))
+        options[:weighted_by].to_s
+      else
+        'weighting'
+      end
+      
+      # [foreign_]arel_table['weighting']
+      weighted_by = if foreign_arel_table
+        foreign_arel_table[weighted_by_column]
+      else
+        arel_table[weighted_by_column]
+      end
+
+      disaggregate_by = if options[:disaggregate_by].present?
+        raise ArgumentError, "Disaggregating by a foreign table isn't supported right now" if options[:disaggregate_by].is_a?(Array)
+        arel_table[options[:disaggregate_by].to_s]
+      end
+
+      # FIXME
+      # projecting "12345" so that we don't get any other fields back
+      if foreign_arel_table
+        foreign_arel_table = foreign_arel_table.project('12345')
+      end
+
+      relation = select("(SUM((#{columns.map { |column| column.to_sql }.join(' + ')}) #{"/ #{disaggregate_by.to_sql} " if disaggregate_by}* #{weighted_by.to_sql}) / SUM(#{weighted_by.to_sql})) AS weighted_average")
+      columns.each do |column|
+        relation = relation.where("#{column.to_sql} IS NOT NULL")
+      end
+      relation = relation.outer_join(foreign_arel_table).on(join_on) if foreign_arel_table
+      relation
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  extend ActiveRecord::WeightedAverage
+end

data/test/helper.rb

@@ -0,0 +1,220 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'ruby-debug'
+require 'logger'
+require 'cohort_scope'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'weighted_average'
+
+class Test::Unit::TestCase
+end
+
+$logger = Logger.new STDOUT #'test/test.log'
+
+ActiveSupport::Notifications.subscribe do |*args|
+  event = ActiveSupport::Notifications::Event.new(*args)
+  $logger.debug "#{event.payload[:name]} (#{event.duration}) #{event.payload[:sql]}"
+end
+
+ActiveRecord::Base.establish_connection(
+  'adapter' => 'mysql',
+  'database' => 'weighted_average_test',
+  'username' => 'root',
+  'password' => ''
+)
+
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.uncountable %w{aircraft airline_aircraft}
+  inflect.uncountable 'commons'
+  inflect.uncountable 'food'
+  inflect.uncountable 'shelter'
+  inflect.uncountable 'transportation'
+  inflect.uncountable 'press_coverage'
+  inflect.irregular 'foot', 'feet'
+end
+
+ActiveRecord::Schema.define(:version => 20090819143429) do
+  create_table "segments", :force => true, :options => 'ENGINE=InnoDB default charset=utf8', :id => false do |t|
+    t.integer  "aircraft_id" # should this be here?
+    t.integer  "departures_performed"
+    t.integer  "payload"
+    t.integer  "seats"
+    t.integer  "passengers"
+    t.integer  "freight"
+    t.integer  "mail"
+    t.integer  "ramp_to_ramp"
+    t.integer  "air_time"
+    t.float    "load_factor"
+    t.float    "freight_share"
+    t.integer  "distance"
+    t.integer  "departures_scheduled"
+    t.string   "unique_carrier"
+    t.integer  "dot_airline_id"
+    t.string   "unique_carrier_name"
+    t.string   "unique_carrier_entity"
+    t.string   "region"
+    t.string   "carrier"
+    t.string   "carrier_name"
+    t.integer  "carrier_group"
+    t.integer  "carrier_group_new"
+    t.string   "origin_airport_iata"
+    t.string   "origin_city_name"
+    t.integer  "origin_city_num"
+    t.string   "origin_state_abr"
+    t.string   "origin_state_fips"
+    t.string   "origin_state_nm"
+    t.string   "origin_country_iso_3166"
+    t.string   "origin_country_name"
+    t.integer  "origin_wac"
+    t.string   "dest_airport_iata"
+    t.string   "dest_city_name"
+    t.integer  "dest_city_num"
+    t.string   "dest_state_abr"
+    t.string   "dest_state_fips"
+    t.string   "dest_state_nm"
+    t.string   "dest_country_iso_3166"
+    t.string   "dest_country_name"
+    t.integer  "dest_wac"
+    t.integer  "bts_aircraft_group"
+    t.integer  "bts_aircraft_type"
+    t.integer  "bts_aircraft_config"
+    t.integer  "year"
+    t.integer  "quarter"
+    t.integer  "month"
+    t.integer  "bts_distance_group"
+    t.string   "bts_service_class"
+    t.string   "data_source"
+    t.float    "seats_per_departure"
+    
+    t.string 'payload_units'
+    t.string 'freight_units'
+    t.string 'mail_units'
+    t.string 'distance_units'
+    
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    
+    t.string   "row_hash"
+  end
+  execute 'ALTER TABLE segments ADD PRIMARY KEY (row_hash);'
+  
+  create_table "aircraft", :force => true do |t|
+    t.string   "name"
+    t.integer  "seats"
+    t.integer  "fuel_type_id"
+    t.float    "endpoint_fuel"
+    t.integer  "manufacturer_id"
+    t.datetime "updated_at"
+    t.datetime "created_at"
+    t.date     "bts_begin_date"
+    t.date     "bts_end_date"
+    t.float    "load_factor"
+    t.float    "freight_share"
+    t.float    "m3"
+    t.float    "m2"
+    t.float    "m1"
+    t.float    "distance"
+    t.float    "payload"
+    t.integer  "aircraft_class_id"
+    t.float    "multiplier"
+    t.string   "manufacturer_name"
+    t.string   "brighter_planet_aircraft_class_code"
+    t.integer  "weighting"
+    t.integer  "bts_aircraft_type"
+  end
+  
+  create_table "aircraft_classes", :force => true do |t|
+    t.string  "name"
+    t.integer "seats"
+    t.integer "fuel_type_id"
+    t.float   "endpoint_fuel"
+    t.string  "brighter_planet_aircraft_class_code"
+    t.float   "m1"
+    t.float   "m2"
+    t.float   "m3"
+  end
+
+  create_table "aircraft_seat_classes", :force => true do |t|
+    t.integer  "aircraft_id"
+    t.integer  "seat_class_id"
+    t.integer  "seats"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.float    "multiplier"
+    t.boolean  "fresh"
+  end
+
+  create_table "airline_aircraft", :force => true do |t|
+    t.integer  "airline_id"
+    t.integer  "aircraft_id"
+    t.integer  "seats"
+    t.datetime "updated_at"
+    t.datetime "created_at"
+    t.float    "total_seat_area"
+    t.float    "average_seat_area"
+    t.boolean  "fresh"
+    t.float    "multiplier"
+  end
+
+  create_table "airline_aircraft_seat_classes", :force => true do |t|
+    t.integer  "seats"
+    t.float    "pitch"
+    t.float    "width"
+    t.float    "multiplier"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.float    "seat_area"
+    t.string   "name"
+    t.integer  "airline_id"
+    t.integer  "aircraft_id"
+    t.integer  "seat_class_id"
+    t.integer  "weighting"
+    t.integer  "peers"
+  end
+  
+end
+
+class Segment < ActiveRecord::Base
+  set_primary_key :row_hash
+  validates_presence_of :row_hash
+  extend CohortScope
+  self.minimum_cohort_size = 1
+end
+
+(1..10).each do |i|
+  a = Segment.new
+  a.payload = i
+  a.row_hash = ActiveSupport::SecureRandom.hex(10)
+  a.save!
+end
+
+# Segment.create! :payload => 4, :row_hash => '19290oaijsoidjvlaioshdiluas'
+# Segment.create! :payload => 5, :row_hash => 'sojsdlviuahsdlvahliruhvailsuf'
+# Segment.create! :payload => 6, :row_hash => 'dsiauhiluashdliufhalsidfhuailsd'
+
+class AirlineAircraftSeatClass < ActiveRecord::Base
+  # include CohortScope
+
+  # belongs_to :airline, :class_name => 'Airline', :foreign_key => 'airline_id'
+  belongs_to :aircraft, :class_name => 'Aircraft', :foreign_key => 'aircraft_id'
+  # belongs_to :seat_class, :class_name => 'SeatClass', :foreign_key => 'seat_class_id'
+  has_one :aircraft_class, :class_name => 'AircraftClass', :through => :aircraft
+end
+
+
+class Aircraft < ActiveRecord::Base
+  belongs_to :aircraft_class, :class_name => 'AircraftClass', :foreign_key => 'aircraft_class_id'
+  # belongs_to :manufacturer, :class_name => 'Manufacturer', :foreign_key => 'manufacturer_id'
+  # has_many :airline_aircraft, :class_name => 'AirlineAircraft'
+  # has_many :seat_classes, :class_name => 'AircraftSeatClass'
+  has_many :segments, :class_name => "Segment"
+  has_many :airline_aircraft_seat_classes, :class_name => 'AirlineAircraftSeatClass'
+end
+
+class AircraftClass < ActiveRecord::Base
+  has_many :aircraft, :class_name => 'Aircraft'
+  has_many :airline_aircraft_seat_classes, :through => :aircraft
+end

data/test/test_weighted_average.rb

@@ -0,0 +1,180 @@
+require 'helper'
+
+class TestWeightedAverage < Test::Unit::TestCase
+  # should "update all weighted averages, has_many through" do
+  #   should_have_same_sql(
+  #     AircraftClass.construct_update_all_weighted_averages_sql(:seats, :association => :airline_aircraft_seat_classes),
+  #     "UPDATE `aircraft_classes` SET `aircraft_classes`.seats = (SELECT (SUM((`airline_aircraft_seat_classes`.seats * `airline_aircraft_seat_classes`.weighting) / SUM(`airline_aircraft_seat_classes`.weighting)) AS weighted_average FROM `airline_aircraft_seat_classes`  LEFT OUTER JOIN `aircraft` ON `aircraft`.id = `airline_aircraft_seat_classes`.aircraft_id     WHERE ((`aircraft`.aircraft_class_id = `aircraft_classes`.id AND `airline_aircraft_seat_classes`.aircraft_id = `aircraft`.id) AND (`airline_aircraft_seat_classes`.seats IS NOT NULL)) )"
+  #   )
+  # end
+  # 
+  # should "update all weighted averages" do
+  #   should_have_same_sql(
+  #     Aircraft.construct_update_all_weighted_averages_sql(:seats, :association => :airline_aircraft_seat_classes),
+  #     "UPDATE `aircraft` SET `aircraft`.seats = (SELECT (SUM((`airline_aircraft_seat_classes`.seats * `airline_aircraft_seat_classes`.weighting) / SUM(`airline_aircraft_seat_classes`.weighting)) AS weighted_average FROM `airline_aircraft_seat_classes` WHERE ((`airline_aircraft_seat_classes`.aircraft_id = `aircraft`.id) AND (`airline_aircraft_seat_classes`.seats IS NOT NULL)) )"
+  #   )
+  # 
+  #   should_have_same_sql(
+  #     Aircraft.construct_update_all_weighted_averages_sql(:seats, :association => :airline_aircraft_seat_classes),
+  #     "UPDATE `aircraft` SET `aircraft`.seats = (#{AirlineAircraftSeatClass.construct_weighted_average_sql(:seats, {}, :conditions => '`airline_aircraft_seat_classes`.aircraft_id = `aircraft`.id')})"
+  #   )
+  # end
+  # 
+  # should "update all weighted averages, custom weighting" do
+  #   should_have_same_sql(
+  #     Aircraft.construct_update_all_weighted_averages_sql(:distance, :by => :passengers, :association => :segments),
+  #     "UPDATE `aircraft` SET `aircraft`.distance = (SELECT (SUM((`segments`.distance * `segments`.passengers) / SUM(`segments`.passengers)) AS weighted_average FROM `segments` WHERE ((`segments`.aircraft_id = `aircraft`.id) AND (`segments`.distance IS NOT NULL)) )"
+  #   )
+  # 
+  #   should_have_same_sql(
+  #     Aircraft.construct_update_all_weighted_averages_sql(:distance, :by => :passengers, :association => :segments),
+  #     "UPDATE `aircraft` SET `aircraft`.distance = (#{Segment.construct_weighted_average_sql(:distance, { :by => :passengers }, :conditions => '`segments`.aircraft_id = `aircraft`.id' )})"
+  #   )
+  # end
+  # 
+  # should "update all weighted averages, custom weighting and disaggregator" do
+  #   should_have_same_sql(
+  #     Aircraft.construct_update_all_weighted_averages_sql(:payload, :by => :passengers, :association => :segments, :disaggregator => :departures_performed),
+  #     "UPDATE `aircraft` SET `aircraft`.payload = (SELECT (SUM((`segments`.payload / `segments`.departures_performed * `segments`.passengers) / SUM(`segments`.passengers)) AS weighted_average FROM `segments` WHERE ((`segments`.aircraft_id = `aircraft`.id) AND (`segments`.payload IS NOT NULL)) )"
+  #   )
+  # 
+  #   should_have_same_sql(
+  #     Aircraft.construct_update_all_weighted_averages_sql(:payload, :by => :passengers, :association => :segments, :disaggregator => :departures_performed),
+  #     "UPDATE `aircraft` SET `aircraft`.payload = (#{Segment.construct_weighted_average_sql(:payload, { :by => :passengers, :disaggregator => :departures_performed }, :conditions => '`segments`.aircraft_id = `aircraft`.id')})"
+  #   )
+  # end
+
+  # plain
+
+  should "do default weighting" do
+    should_have_same_sql(
+      "SELECT (SUM((`airline_aircraft_seat_classes`.`seats`) * `airline_aircraft_seat_classes`.`weighting`) / SUM(`airline_aircraft_seat_classes`.`weighting`)) AS weighted_average FROM `airline_aircraft_seat_classes` WHERE (`airline_aircraft_seat_classes`.`seats` IS NOT NULL)",
+      AirlineAircraftSeatClass.weighted_average_relation('seats')
+    )
+  end
+  
+  should "do custom weighting" do
+    should_have_same_sql(
+      "SELECT (SUM((`segments`.`distance`) * `segments`.`passengers`) / SUM(`segments`.`passengers`)) AS weighted_average FROM `segments` WHERE (`segments`.`distance` IS NOT NULL)",
+      Segment.weighted_average_relation('distance', :weighted_by => 'passengers')
+    )
+  end
+  
+  # multiple columns
+  
+  should "add multiple columns before averaging" do
+    should_have_same_sql(
+      "SELECT (SUM((`airline_aircraft_seat_classes`.`seats` + `airline_aircraft_seat_classes`.`pitch`) * `airline_aircraft_seat_classes`.`weighting`) / SUM(`airline_aircraft_seat_classes`.`weighting`)) AS weighted_average FROM `airline_aircraft_seat_classes` WHERE (`airline_aircraft_seat_classes`.`seats` IS NOT NULL) AND (`airline_aircraft_seat_classes`.`pitch` IS NOT NULL)",
+      AirlineAircraftSeatClass.weighted_average_relation(['seats', 'pitch'])
+    )
+  end
+  
+  # conditions
+  
+  # a subquery used in Aircraft.update_all_seats
+  should "do default weighting with conditions" do 
+    conditions = 'aircraft_id = 1'
+    
+    should_have_same_sql(
+      "SELECT (SUM((`airline_aircraft_seat_classes`.`seats`) * `airline_aircraft_seat_classes`.`weighting`) / SUM(`airline_aircraft_seat_classes`.`weighting`)) AS weighted_average FROM `airline_aircraft_seat_classes` WHERE (#{conditions}) AND (`airline_aircraft_seat_classes`.`seats` IS NOT NULL)",
+      AirlineAircraftSeatClass.where(conditions).weighted_average_relation('seats')
+    )
+  end
+  
+  # note fake condition
+  should "do custom weighting with conditions" do
+    conditions = '456 = 456'
+    should_have_same_sql(
+      "SELECT (SUM((`segments`.`load_factor`) * `segments`.`passengers`) / SUM(`segments`.`passengers`)) AS weighted_average FROM `segments` WHERE (#{conditions}) AND (`segments`.`load_factor` IS NOT NULL)",
+      Segment.where(conditions).weighted_average_relation('load_factor', :weighted_by => 'passengers')
+    )
+  end
+  
+  # foreign weightings
+  
+  # fake! we would never calc seats this way
+  should "do foreign default weighting" do
+    should_have_same_sql(
+      "SELECT (SUM((`aircraft`.`seats`) * `airline_aircraft_seat_classes`.`weighting`) / SUM(`airline_aircraft_seat_classes`.`weighting`)) AS weighted_average, 12345 FROM `aircraft` LEFT OUTER JOIN `airline_aircraft_seat_classes` ON `airline_aircraft_seat_classes`.`aircraft_id` = `aircraft`.`id` WHERE (`aircraft`.`seats` IS NOT NULL)",
+      Aircraft.weighted_average_relation('seats', :weighted_by => :airline_aircraft_seat_classes)
+    )
+  end
+  
+  # Aircraft#m3 fallback value
+  # a subquery used in Aircraft.update_all_m3s
+  should "do foreign custom weighting" do
+    should_have_same_sql(
+      "SELECT (SUM((`aircraft`.`m3`) * `segments`.`passengers`) / SUM(`segments`.`passengers`)) AS weighted_average, 12345 FROM `aircraft` LEFT OUTER JOIN `segments` ON `segments`.`aircraft_id` = `aircraft`.`id` WHERE (`aircraft`.`m3` IS NOT NULL)",
+      Aircraft.weighted_average_relation(:m3, :weighted_by => [:segments, :passengers])
+    )
+  end
+  
+  # scoped
+  
+  should "do default weighting, scoped" do
+    conditions = '456 = 456'
+    should_have_same_sql(
+      "SELECT (SUM((`airline_aircraft_seat_classes`.`seats`) * `airline_aircraft_seat_classes`.`weighting`) / SUM(`airline_aircraft_seat_classes`.`weighting`)) AS weighted_average FROM `airline_aircraft_seat_classes` WHERE (#{conditions}) AND (`airline_aircraft_seat_classes`.`seats` IS NOT NULL)",
+      AirlineAircraftSeatClass.scoped(:conditions => conditions).weighted_average_relation(:seats)
+    )
+  end
+  
+  should "do custom weighting, scoped" do
+    conditions = '999 = 999'
+    should_have_same_sql(
+      "SELECT (SUM((`segments`.`load_factor`) * `segments`.`passengers`) / SUM(`segments`.`passengers`)) AS weighted_average FROM `segments` WHERE (#{conditions}) AND (`segments`.`load_factor` IS NOT NULL)",
+      Segment.scoped(:conditions => conditions).weighted_average_relation(:load_factor, :weighted_by => :passengers)
+    )
+  end
+  
+  # scoped foreign weightings
+  
+  should "do foreign default weighting, scoped" do
+    conditions = '454 != 999'
+    should_have_same_sql(
+      "SELECT (SUM((`aircraft`.`seats`) * `airline_aircraft_seat_classes`.`weighting`) / SUM(`airline_aircraft_seat_classes`.`weighting`)) AS weighted_average, 12345 FROM `aircraft` LEFT OUTER JOIN `airline_aircraft_seat_classes` ON `airline_aircraft_seat_classes`.`aircraft_id` = `aircraft`.`id` WHERE (#{conditions}) AND (`aircraft`.`seats` IS NOT NULL)",
+      Aircraft.scoped(:conditions => conditions).weighted_average_relation(:seats, :weighted_by => :airline_aircraft_seat_classes)
+    )
+  end
+  
+  should "do foreign custom weighting, scoped" do
+    conditions = '`aircraft`.`m3` > 1'
+    should_have_same_sql(
+      "SELECT (SUM((`aircraft`.`m3`) * `segments`.`passengers`) / SUM(`segments`.`passengers`)) AS weighted_average, 12345 FROM `aircraft` LEFT OUTER JOIN `segments` ON `segments`.`aircraft_id` = `aircraft`.`id` WHERE (#{conditions}) AND (`aircraft`.`m3` IS NOT NULL)",
+      Aircraft.scoped(:conditions => conditions).weighted_average_relation(:m3, :weighted_by => [:segments, :passengers])
+    )
+  end
+  
+  # disaggregation
+  
+  should "do custom weighting with disaggregation" do
+    should_have_same_sql(
+      "SELECT (SUM((`segments`.`load_factor`) / `segments`.`departures_performed` * `segments`.`passengers`) / SUM(`segments`.`passengers`)) AS weighted_average FROM `segments` WHERE (`segments`.`load_factor` IS NOT NULL)",
+      Segment.weighted_average_relation(:load_factor, :weighted_by => :passengers, :disaggregate_by => :departures_performed)
+    )
+  end
+
+  # cohorts (requires the cohort_scope gem)
+
+  should "do custom weighting, with a cohort" do
+    should_have_same_sql(
+      "SELECT (SUM((`segments`.`load_factor`) * `segments`.`passengers`) / SUM(`segments`.`passengers`)) AS weighted_average FROM `segments` WHERE (`segments`.`payload` = 5) AND (`segments`.`load_factor` IS NOT NULL)",
+      Segment.big_cohort(:payload => 5).weighted_average_relation(:load_factor, :weighted_by => :passengers)
+    )
+  end
+
+  private
+
+  def should_have_same_sql(*args)
+    # make sure everything is an SQL string
+    args.map! { |arg| arg.is_a?(String) ? arg : arg.to_sql }
+    # clean up whitespace
+    args.map! { |arg| arg.to_s.gsub /\s+/, ' ' }
+    # treat the first arg as the "known good"
+    best = args.shift
+    # compare everything to the known good
+    args.each { |arg| assert_equal best, arg }
+    # make sure the SQL is valid
+    assert_nothing_raised { ActiveRecord::Base.connection.execute best }
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification 
+name: weighted_average
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Seamus Abshere
+- Andy Rossmeissl
+- Ian Hough
+- Matt Kling
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-07 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta2
+        version: 3.0.0.beta2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta2
+        version: 3.0.0.beta2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: arel
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 3
+        version: 0.3.3
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: cohort_scope
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 2
+        version: 0.0.2
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 3
+        version: 2.10.3
+  type: :development
+  version_requirements: *id005
+description: Perform weighted averages, even across associations. Rails 3 only because it uses ARel.
+email: seamus@abshere.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/weighted_average.rb
+- test/helper.rb
+- test/test_weighted_average.rb
+has_rdoc: true
+homepage: http://github.com/seamusabshere/weighted_average
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Perform weighted averages. Rails 3 only.
+test_files: 
+- test/helper.rb
+- test/test_weighted_average.rb