ar_result_calculations 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ar_result_calculations.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.textile

@@ -0,0 +1,35 @@
+h1. Description
+
+p. ar_result_calculations adds methods to Array for when Array is an ActiveRecord result set. For example:
+
+bc. Product.all.sum(:price)
+Product.all.average(:price)
+Product.all.regression(:sales_volumn)
+
+p. Will return the sum of the attribute :price from all rows.  Note this is not the same as Product.sum(:price) which will create an SQL statement that does the summing.
+
+h2. Methods created on Array
+
+p. All methods take one parameter (column name).
+
+|_. Method|_. Description|
+|sum|Sum the given column.  Delegates to super() if not an AR result set|
+|mean|Mean of the given column.  Delegates to super() if not an AR result set. Aliases of **avg** and **average**|
+|count|Count the given column.  Delegates to super() if not an AR result set|
+|min|Min the given column.  Delegates to super() if not an AR result set|
+|max|Max the given column.  Delegates to super() if not an AR result set|
+|regression|Ordinary Least Squares regression on the given column.  Returns the regression as an array|
+|slope|Returns the slope of a regression on a given column|
+|make_numeric_|Coerces a column to be numeric.  Useful if you have derived columns returned from a query that are not in the model definition and hence are otherwise returned as strings.  Returns **self** so is composable|
+
+h1. License
+
+(The MIT License)
+
+Copyright © 2010 Kip Cole
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/ar_result_calculations.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ar_result_calculations/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ar_result_calculations"
+  s.version     = ArResultCalculations::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kip Cole"]
+  s.email       = ["kipcole9@gmail.com"]
+  s.homepage    = "http://github.com/kipcole9/ar_result_calculations"
+  s.summary     = %q{Calculations on ActiveRecord result sets.}
+  s.description = <<-EOF
+    Defines Array#calculation methods for ActiveRecord result sets. Provides
+    #sum, #min, #max, #count, #mean, #regression, #slope.  Delegates to super()
+    if not an AR result set where appropriate.
+  EOF
+
+  s.rubyforge_project = "ar_result_calculations"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/ar_result_calculations.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + '/ar_result_calculations/ar_result_calculations.rb'
+Array.send :include, ArResultCalculations::Calculations
+
+module ArResultCalculations
+
+end

data/lib/ar_result_calculations/ar_result_calculations.rb

@@ -0,0 +1,159 @@
+module ArResultCalculations
+  module Calculations
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+      # Return the sum of a column from an active record result set
+      # Calls super() if not a result set
+      # 
+      #   column:  The column name to sum
+      def sum(column = nil)
+        return super() unless column && first && first.class.respond_to?(:descends_from_active_record?)
+        inject( 0 ) { |sum, x| x[column].nil? ? sum : sum + x[column] }
+      end
+      
+      # Return the average of a column from an active record result set
+      # Calls super() if not a result set
+      # 
+      #   column:  The column name to average
+      def mean(column = nil)
+        return super() unless column && first && first.class.respond_to?(:descends_from_active_record?)
+        (length > 0) ? sum(column) / length : 0
+      end
+      alias :avg  :mean
+      alias :average  :mean
+      
+      # Return the count of a column from an active record result set
+      # Calls super() if not a result set.  nil values are not counted
+      # 
+      #   column:  The column name to count
+      def count(column = nil)
+        return super() unless column && first && first.class.respond_to?(:descends_from_active_record?)         
+        inject( 0 ) { |sum, x| x[column].nil? ? sum : sum + 1 }
+      end
+      
+      # Return the max of a column from an active record result set
+      # Calls super() if not a result set
+      # 
+      #   column:  The column name to max        
+      def max(column = nil)
+        return super() unless column && first && first.class.respond_to?(:descends_from_active_record?)  
+        map(&column.to_sym).max
+      end
+      alias :maximum :max
+      
+      # Return the min of a column from an active record result set
+      # Calls super() if not a result set
+      # 
+      #   column:  The column name to sum        
+      def min(column = nil)
+        return super() unless column && first && first.class.respond_to?(:descends_from_active_record?)  
+        map(&column.to_sym).min
+      end
+      alias :minimum :min
+      
+      # Return a regression (OLS) of a column from an active record result set
+      # Calls super() if not a result set
+      # 
+      #   column:  The column name to regress
+      def regression(column = nil)
+        return nil unless first
+        unless is_numeric?(first)
+          raise ArgumentError, "Regression needs an array of ActiveRecord objects" unless column && first && first.class.respond_to?(:descends_from_active_record?)  
+          series = map { |x| x[column] }
+        end
+        Array::LinearRegression.new(series || self).fit
+      end
+      
+      # Return the slope of a regression on a column from an active record result set
+      # Calls super() if not a result set
+      # 
+      #   column:  The column name to regress        
+      def slope(column = nil)
+        return nil unless first
+        unless is_numeric?(first)
+          column ||= first_numeric_column
+          series = map { |x| x[column] }
+        end
+        Array::LinearRegression.new(series || self).slope
+      end
+      alias :trend :slope
+      
+      # Force a column to be numeric.  Useful if you have derived
+      # columns from a query that is not part of the base model.
+      # 
+      #   column:  The column name to sum
+      #
+      #   returns self so you can compose other methods.     
+      def make_numeric(column)
+        return self unless column && first && first.class.respond_to?(:descends_from_active_record?)
+        each do |row|
+          next if is_numeric?(row[column])
+          row[column] = row[column] =~ /[-+]?[0-9]+(\.[0-9]+)/ ? row[column].to_f : row[column].to_i
+        end
+        self
+      end
+      alias :coerce_numeric :make_numeric 
+      
+    private
+      def first_numeric_column
+        raise ArgumentError, "Slope needs an array of ActiveRecord objects" unless first && first.class.respond_to?(:descends_from_active_record?)  
+        first.attributes.each {|attribute, value| return attribute if is_numeric?(value) }
+        raise ArgumentError, "Slope could not detect a numberic attribute.  Please provide an attribute name as an argument"
+      end
+      
+      def is_numeric?(val)
+        is_integer?(val) || is_float?(val)
+      end
+      
+      def is_integer?(val)
+        val.is_a?(Fixnum) || val.is_a?(Integer) || val.is_a?(Bignum)
+      end
+      
+      def is_float?(val)
+        val.is_a?(Float) || val.is_a?(Rational)
+      end
+    end
+    
+    module ClassMethods
+      # Courtesy of http://blog.internautdesign.com/2008/4/21/simple-linear-regression-best-fit
+      class Array::LinearRegression
+        attr_accessor :slope, :offset
+
+        def initialize dx, dy=nil
+          @size = dx.size
+          dy,dx = dx,axis() unless dy  # make 2D if given 1D
+          raise ArgumentError, "[regression] Arguments are not same length!" unless @size == dy.size
+          sxx = sxy = sx = sy = 0
+          dx.zip(dy).each do |x,y|
+            sxy += x*y
+            sxx += x*x
+            sx  += x
+            sy  += y
+          end
+          @slope = ( @size * sxy - sx * sy ) / ( @size * sxx - sx * sx ) rescue 0
+          @offset = (sy - @slope * sx) / @size
+        end
+
+        def fit
+          return axis.map{|data| predict(data) }
+        end
+
+        def predict( x )
+          y = @slope * x + @offset
+        end
+
+        def axis
+          (0...@size).to_a
+        end
+      end
+
+    end
+  end
+end
+

data/lib/ar_result_calculations/version.rb

@@ -0,0 +1,3 @@
+module ArResultCalculations
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: ar_result_calculations
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kip Cole
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-30 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: "    Defines Array#calculation methods for ActiveRecord result sets. Provides\n    #sum, #min, #max, #count, #mean, #regression, #slope.  Delegates to super()\n    if not an AR result set where appropriate.\n"
+email: 
+- kipcole9@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- ar_result_calculations.gemspec
+- lib/ar_result_calculations.rb
+- lib/ar_result_calculations/ar_result_calculations.rb
+- lib/ar_result_calculations/version.rb
+has_rdoc: true
+homepage: http://github.com/kipcole9/ar_result_calculations
+licenses: []
+
+post_install_message: 
+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: ar_result_calculations
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Calculations on ActiveRecord result sets.
+test_files: []
+