weighted_average 0.0.4 → 0.0.5

data/README.rdoc

@@ -1,20 +1,29 @@
 = weighted_average
 
-Description goes here.
+Do weighted averages in ActiveRecord.
 
-= Rails 3 only
+== Rationale
 
-We use ARel so we need Rails 3. Please let me know if you want Rails 2, because I an (ungemified) version of that.
+You have a bunch of flight records with passenger count and distance.
 
-== 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.
+* Flight EWR <-> MSN; 30,000 passengers last month; 500 miles
+* Flight EWR <-> BOM; 15 passengers last month; 10,000 miles
+
+The average distance is <tt>(10_000 + 500) / 2 = 5250</tt>.
+
+The average distance weighted by passenger count is <tt>(30_000 * 500 + 15 * 10_000) / (10_500) = 1442</tt>.
+
+== Usage
+
+Using <tt>FlightSegment</tt> from {Brighter Planet's}[http://brighterplanet.com] {earth gem}[http://rubygems.org/gems/earth]:
+
+    >> FlightSegment.weighted_average(:distance, :weighted_by => :passengers)
+    => 2436.1959
+
+You can also see the SQL that is generated:
+
+    >> FlightSegment.weighted_average_relation(:distance, :weighted_by => :passengers).to_sql
+    => "SELECT (SUM((`flight_segments`.`distance`) * `flight_segments`.`passengers`) / SUM(`flight_segments`.`passengers`)) AS weighted_average FROM `flight_segments` WHERE (`flight_segments`.`distance` IS NOT NULL)"
 
 == Copyright
 

data/Rakefile

@@ -11,7 +11,6 @@ begin
     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"

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/weighted_average.rb

@@ -1,19 +1,12 @@
 require 'active_record'
-require 'active_support'
-require 'active_support/version'
-%w{
-  active_support/core_ext/module
-}.each do |active_support_3_requirement|
-  require active_support_3_requirement
-end if ActiveSupport::VERSION::MAJOR == 3
 
 module WeightedAverage
-  # Returns a number
+  # 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
+  # Returns the ARel relation for a weighted average query.
   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?)
@@ -64,11 +57,22 @@ module WeightedAverage
 end
 
 ActiveRecord::Associations::AssociationCollection.class_eval do
-  delegate :weighted_average, :weighted_average_relation, :to => :scoped
+  def self.weighted_average(*args) # :nodoc:
+    scoped.weighted_average(*args)
+  end
+  
+  def self.weighted_average_relation(*args) # :nodoc:
+    scoped.weighted_average_relation(*args)
+  end
 end
 ActiveRecord::Base.class_eval do
-  class << self
-    delegate :weighted_average, :weighted_average_relation, :to => :scoped
+  def self.weighted_average(*args) # :nodoc:
+    scoped.weighted_average(*args)
+  end
+  
+  def self.weighted_average_relation(*args) # :nodoc:
+    scoped.weighted_average_relation(*args)
   end
 end
+
 ActiveRecord::Relation.send :include, WeightedAverage

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: weighted_average
 version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Seamus Abshere
@@ -17,16 +18,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-18 00:00:00 -04:00
+date: 2010-09-20 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 299253626
         segments: 
         - 3
         - 0
@@ -35,63 +38,54 @@ dependencies:
         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 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 21
         segments: 
         - 0
         - 3
         - 3
         version: 0.3.3
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: cohort_scope
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 0
         - 0
         - 2
         version: 0.0.2
   type: :development
-  version_requirements: *id004
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: shoulda
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 33
         segments: 
         - 2
         - 10
         - 3
         version: 2.10.3
   type: :development
-  version_requirements: *id005
+  version_requirements: *id004
 description: Perform weighted averages, even across associations. Rails 3 only because it uses ARel.
 email: seamus@abshere.net
 executables: []
@@ -121,23 +115,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Perform weighted averages. Rails 3 only.