calculon 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+docs
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create ruby-1.9.2-p0@calculon

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Muller
+
+MIT License
+
+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.md

@@ -0,0 +1,71 @@
+# Calculon
+
+Calculon provides aggregate time functions for ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'calculon'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install calculon
+```
+
+## Usage
+Calculon allows you to group attributes using aggregate functions (sum, avg, min, max, etc) into time buckets (minute, hour, day, month, year).  These buckets are "calendar" size - for instance, "by hour" means between absolute clock hours rather than a relative "within last 60 minutes, between 60-120 minutes ago, etc."
+
+Let's say you have a Game model with two columns, one for Team A's points and the other for Team B's points.
+
+```ruby
+class Game
+    attr_accessible :team_a_points, :team_b_points
+end
+```
+
+And now you want to know the total points for both teams by day:
+
+```ruby
+Game.by_day(:team_a_points => :sum, :team_b_points => :sum)
+```
+
+Awesome.  Now let's say you want to know the average yesterday where Team A scored more than 0 points:
+
+```ruby
+Game.by_day(:team_a_points => :avg, :team_b_points => :avg).on(Date.yesterday).where('team_a_points > 0')
+```
+
+Now say you hate typing, and want to get points more easily:
+
+```ruby
+class Game
+    calculon_view :points, :team_a_points => :sum, :team_b_points => :sum
+end
+```
+
+Now, you can get point sums more naturally:
+
+```ruby
+Game.points_by_day.on(Date.yesterday)
+Game.points_by_month.where('team_a_points > 0')
+Game.points_by_year
+```
+
+Let's say, however, that you want to know points by hour, but you want to get 24 results, regardless of whether or not a team scored (i.e., you want to fill in the "missing" hours):
+
+```ruby
+nogame = OpenStruct.new(:team_a_points => 0, :team_b_points => 0)
+Game.points_by_hour.on(Date.yesterday).to_filled_a(nogame)
+```
+
+This will return an array of length 24, with "nogame" filling in each hour for which there was no game.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+
+Rake::TestTask.new("test") { |t|
+  t.libs += ["lib", "."]
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+}
+
+task :default => [:test]
+
+RDoc::Task.new("doc") { |rdoc|
+  rdoc.title = "Calculon - aggregate methods for models for Rails"
+  rdoc.rdoc_dir = 'docs'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}

data/calculon.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'calculon/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "calculon"
+  gem.version       = Calculon::VERSION
+  gem.authors       = ["Brian Muller"]
+  gem.email         = ["bamuller@gmail.com"]
+  gem.description   = %q{Calculon provides aggregate time functions for ActiveRecord.}
+  gem.summary       = %q{Calculon provides aggregate time functions for ActiveRecord.}
+  gem.homepage      = "https://github.com/opbandit/calculon"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency("rails", ">= 3.2.0")
+  gem.add_development_dependency('rdoc')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('sqlite3')
+  gem.add_development_dependency('mysql2')
+end

data/lib/calculon.rb

@@ -0,0 +1,115 @@
+require "calculon/version"
+require 'calculon/railtie'
+require 'calculon/summarized_results'
+
+module ActiveRecord
+  module QueryMethods
+    attr_accessor :calculon_opts
+  end
+
+  class Relation
+    def to_results_hash
+      if(calculon_opts.nil?)
+        raise "Not a Calculon Relation: You must call by_day/by_hour/etc before you can call to_hash"
+      end
+      Calculon::SummarizedResults.new(self)
+    end
+
+    def to_filled_a(default=nil)
+      to_results_hash.fill_missing!(default).to_a
+    end
+  end
+end
+
+module Calculon
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    def calculon_view(name, cols, opts=nil)
+      metaclass = class << self; self; end
+      metaclass.instance_eval do
+        [ "minute", "hour", "day", "month", "year" ].each do |window|
+          define_method("#{name}_by_#{window}") { |nopts=nil|
+            nopts = (opts || {}).merge(nopts || {})
+            send("by_#{window}".intern, cols, nopts)
+          }
+        end
+      end
+    end
+
+    def default_time_column(column)
+      @@calculon_time_column = column
+    end
+
+    def default_calculon_opts
+      @@calculon_time_column ||= "created_at"
+      { :time_column => @@calculon_time_column, :bycols => [] }
+    end
+
+    def on(date, opts=nil)
+      opts = default_calculon_opts.merge(opts || {})
+      raise "'on' method takes a Date object as the first param" unless date.is_a?(Date)
+      between date.to_time, date.to_time + 86399.seconds
+    end
+
+    def between(starttime, endtime, opts=nil)
+      opts = default_calculon_opts.merge(opts || {})
+      relation = where ["#{opts[:time_column]} >= ? and #{opts[:time_column]} <= ?", starttime, endtime]
+      relation.calculon_opts ||= {}
+      relation.calculon_opts.merge!(:starttime => starttime, :endtime => endtime)
+      relation
+    end
+
+    def by_minute(cols, opts=nil)
+      tcol = "concat(date(%{time_column}),' ',lpad(hour(%{time_column}),2,'0'),':',lpad(minute(%{time_column}),2,'0'),':00')"
+      by_bucket :minute, tcol, cols, opts
+    end
+
+    def by_hour(cols, opts=nil)
+      by_bucket :hour, "concat(date(%{time_column}),' ',lpad(hour(%{time_column}),2,'0'),':00:00')", cols, opts
+    end
+
+    def by_day(cols, opts=nil)
+      by_bucket :day, "concat(date(%{time_column}),' 00:00:00')", cols, opts
+    end
+
+    def by_month(cols, opts=nil)
+      by_bucket :month, "concat(year(%{time_column}),'-',lpad(month(%{time_column}),2,'0'),'-01 00:00:00')", cols, opts
+    end
+
+    def by_year(cols, opts=nil)
+      by_bucket :year, "concat(year(%{time_column}),'-01-01 00:00:00')", cols, opts
+    end
+
+    def by_bucket(bucket_name, bucket, cols, opts=nil)
+      opts = default_calculon_opts.merge(opts || {})
+
+      unless ActiveRecord::Base.connection.adapter_name == "Mysql2"
+        raise "Mysql2 is the only supported connection adapter for calculon"
+      end
+
+      # Set column in bucket string.  This should be based on localtime, in case there are some points
+      # that fall on both sides of a date - so group by this conversion.  The 'where' doesn't
+      # need this conversion because Rails does this automatically before calling the query
+      # (see http://api.rubyonrails.org/classes/ActiveRecord/Base.html#method-c-default_timezone)
+      time_column = "CONVERT_TZ(#{opts[:time_column]}, '+00:00', '#{Time.zone.formatted_offset}')"
+      bucket = bucket % { :time_column => time_column }
+
+      # if we're grouping by other columns, we need to select them
+      groupby = opts[:bycols] + ["time_bucket"]
+      opts[:bycols].each { |c| cols[c] = nil }
+      cols = cols.map { |name,method| 
+        asname = name.to_s.gsub(' ', '').tr('^A-Za-z0-9', '_')
+        method.nil? ? name : "#{method}(#{name}) as #{asname}" 
+      } + [ "#{bucket} as time_bucket" ]
+
+      relation = select(cols.join(",")).group(*groupby).order("time_bucket ASC")
+      relation.calculon_opts ||= {}
+      relation.calculon_opts.merge!(opts)
+      relation.calculon_opts[:bybucket] = bucket_name
+      relation
+    end
+  end
+end

data/lib/calculon/railtie.rb

@@ -0,0 +1,11 @@
+module Calculon
+
+  class Railtie < Rails::Railtie
+    initializer 'calculon.insert_into_active_record' do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send(:include, Calculon)
+      end
+    end
+  end
+
+end

data/lib/calculon/summarized_results.rb

@@ -0,0 +1,61 @@
+module Calculon
+  class SummarizedResults < Hash
+    attr_reader :rows
+
+    def initialize(relation)
+      super({})
+
+      @bucket_size = relation.calculon_opts[:bybucket]
+      @grouped_by = relation.calculon_opts[:bycols] || []
+
+      @start_time = relation.calculon_opts[:starttime] || keys.sort.first
+      @start_time = @start_time.to_time if @start_time.is_a?(Date)
+
+      @end_time = relation.calculon_opts[:endtime] || keys.sort.last
+      @end_time = @end_time.to_time if @end_time.is_a?(Date)
+
+      relation.to_a.each { |row|
+        self[row.time_bucket] = row
+      }
+    end
+    
+    def fill_missing!(value=nil)
+      each_time { |key|
+        self[key] = value unless has_key?(key)
+      }
+      self
+    end
+
+    def to_a
+      results = []
+      each_time { |key|
+        results << self[key] if self.has_key?(key)
+      }
+      results
+    end
+
+    def time_format
+      { 
+        :minute => "%Y-%m-%d %H:%M:00", 
+        :hour => "%Y-%m-%d %H:00:00", 
+        :day => "%Y-%m-%d 00:00:00", 
+        :month => "%Y-%m-01 00:00:00", 
+        :year => "%Y-01-01 00:00:00"
+      }.fetch(@bucket_size)
+    end
+
+    def each_time
+      increment_amounts = { :minute => 1.minute, :hour => 1.hour, :day => 1.day, :month => 1.month, :year => 1.year }
+      increment = increment_amounts[@bucket_size]
+
+      # get the "floor" of the start and end times (the "floor" bucket)
+      current = Time.zone.parse(@start_time.strftime(time_format + " %z"))
+      last_time = Time.zone.parse(@end_time.strftime(time_format + " %z"))
+
+      while current <= last_time
+        yield current.strftime(time_format)
+        current += increment
+      end
+    end
+  end
+end

data/lib/calculon/version.rb

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

data/test/calculon_test.rb

@@ -0,0 +1,64 @@
+require 'test/unit'
+require 'rails/all'
+require 'calculon'
+
+ActiveRecord::Base.establish_connection adapter: "mysql2", database: "calculon_test", username: 'root'
+ActiveRecord::Base.default_timezone = :utc
+Time.zone = "UTC"
+
+class Game < ActiveRecord::Base
+  include Calculon
+  calculon_view :points, :team_a_points => :sum, :team_b_points => :sum
+end
+
+class CalculonTest < Test::Unit::TestCase
+  def setup
+    old = $stdout
+    $stdout = StringIO.new
+    ActiveRecord::Base.logger
+    ActiveRecord::Schema.define(version: 1) do
+      create_table :games do |t|
+        t.column :team_a_points, :integer, default: 0
+        t.column :team_b_points, :integer, default: 0
+        t.timestamps
+      end
+    end
+    $stdout = old
+  end
+
+  def teardown
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+  def test_results_hash
+    Game.create(:team_a_points => 10, :team_b_points => 20, :created_at => 33.hours.ago)
+    Game.create(:team_a_points => 30, :team_b_points => 40, :created_at => 2.hours.ago)
+
+    assert_equal Game.by_hour(:team_a_points => :sum).length, 2
+    results = Game.points_by_hour.to_results_hash
+    keys = [33.hours.ago.strftime("%Y-%m-%d %H:00:00"), 2.hours.ago.strftime("%Y-%m-%d %H:00:00")]
+    assert_equal keys, results.keys.sort
+    assert_equal results[keys.first].team_a_points, 10 
+    assert_equal results[keys.last].team_b_points, 40 
+
+    assert_equal Game.by_day(:team_a_points => :sum).length, 2
+    results = Game.points_by_day.to_results_hash
+    keys = [33.hours.ago.strftime("%Y-%m-%d 00:00:00"), 2.hours.ago.strftime("%Y-%m-%d 00:00:00")]
+    assert_equal keys, results.keys.sort
+    assert_equal results[keys.first].team_a_points, 10 
+    assert_equal results[keys.last].team_b_points, 40     
+  end
+
+  def test_results_hash_missing
+    Game.create(:team_a_points => 10, :created_at => Time.zone.now - 0.hours)
+    Game.create(:team_a_points => 20, :created_at => Time.zone.now - 1.hours)
+    Game.create(:team_a_points => 30, :created_at => Time.zone.now - 2.hours)
+    Game.create(:team_a_points => 40, :created_at => Time.zone.now - 25.hours)
+    
+    days = Game.points_by_day.to_a
+    assert_equal days.length, 2
+    assert_equal days.inject(0) { |s,g| s + g.team_a_points }, 100
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: calculon
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brian Muller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-04-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mysql2
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: Calculon provides aggregate time functions for ActiveRecord.
+email: 
+- bamuller@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- calculon.gemspec
+- lib/calculon.rb
+- lib/calculon/railtie.rb
+- lib/calculon/summarized_results.rb
+- lib/calculon/version.rb
+- test/calculon_test.rb
+homepage: https://github.com/opbandit/calculon
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 611864359157079367
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 611864359157079367
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Calculon provides aggregate time functions for ActiveRecord.
+test_files: 
+- test/calculon_test.rb