periodic_calculations 0.0.2 → 0.0.3

data/README.md

@@ -5,4 +5,14 @@
 [![Coverage Status](https://coveralls.io/repos/polmiro/periodic_calculations/badge.png)](https://coveralls.io/r/polmiro/periodic_calculations)
 [![Gem Version](https://badge.fury.io/rb/periodic_calculations.png)](http://badge.fury.io/rb/periodic_calculations)
 
-Periodic Calculations gem allows you to retrieve periodic results of aggregates that can be accumulated over time with PostgreSQL.
+Periodic Calculations gem allows you to retrieve periodic results of aggregates that can be accumulated over time with PostgreSQL. The results are returned in real time (there are no scheduled precalculations).
+
+The returned data is ready to be displayed in a graph, for example, using the [jQuery Flot](http://www.flotcharts.org/) library.
+
+## Demo ##
+
+Please check out the [demo](http://periodic-calculations-demo.herokuapp.com) to see it in action.
+
+## How does it work ##
+
+It takes advantage of the [window_functions](http://www.postgresql.org/docs/9.1/static/tutorial-window.html) to be able to generate accumulated metrics over time.

data/lib/periodic_calculations/base.rb

@@ -2,10 +2,11 @@ module PeriodicCalculations
   module Base
     extend ActiveSupport::Concern
 
-    # TODO:
-    #  * Rails 4 compatible only right now (scoped vs all)
-
     module ClassMethods
+      def periodic_count_all(*args)
+        periodic_calculation(:count, "*", *args)
+      end
+
       def periodic_count(*args)
         periodic_calculation(:count, *args)
       end
@@ -28,7 +29,8 @@ module PeriodicCalculations
 
       def periodic_calculation(operation, column_name, window_start, window_end, options = {})
         query_options = QueryOptions.new(operation, column_name, window_start, window_end, options)
-        query = Query.new(all, query_options)
+        current_scope = Rails::VERSION::MAJOR >= 4 ? all : scoped
+        query = Query.new(current_scope, query_options)
         LazyQuery.new(query)
       end
     end

data/lib/periodic_calculations/query.rb

@@ -16,6 +16,7 @@ module PeriodicCalculations
       @timestamp_column = query_options.timestamp_column
       @operation = query_options.operation.upcase
       @window_function = query_options.cumulative ? "ORDER" : "PARTITION"
+      @inside_operation = query_options.operation == :count ? "SUM" : query_options.operation.upcase
       @binds = {
         :unit     => query_options.interval_unit,
         :interval => "1 #{query_options.interval_unit.upcase}",
@@ -82,7 +83,7 @@ module PeriodicCalculations
           -- running window function calculate results and fill up gaps
           , results AS (
             SELECT  DISTINCT frame,
-                    #{@operation}(result) OVER (#{@window_function} BY frame) AS result
+                    #{@inside_operation}(result) OVER (#{@window_function} BY frame) AS result
             FROM (
               SELECT frame, result FROM preprocessed_results
               UNION ALL

data/lib/periodic_calculations/version.rb

@@ -1,3 +1,3 @@
 module PeriodicCalculations
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/model_spec.rb

@@ -9,6 +9,13 @@ describe "Model" do
     klass.should respond_to(:periodic_calculation)
   end
 
+  describe ".periodic_count_all" do
+    it "calculates a periodic count operation for all rows" do
+      klass.should_receive(:periodic_calculation).with(:count, "*", :args).once.and_return(true)
+      klass.periodic_count_all(:args)
+    end
+  end
+
   describe ".periodic_count" do
     it "calculates a periodic count operation" do
       klass.should_receive(:periodic_calculation).with(:count, :args).once.and_return(true)

data/spec/performance_matchers.rb

@@ -0,0 +1,17 @@
+RSpec::Matchers.define :perform_in do |goal|
+  match do |actual|
+    @time = Benchmark.realtime do
+      actual.call
+    end
+
+    @time < goal
+  end
+
+  failure_message_for_should do |actual|
+    "It took too long. Goal: #{goal}, Benchmark: #{@time}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "It did not take long enough. Goal: #{goal}, Benchmark: #{@time}"
+  end
+end

data/spec/performance_spec.rb

@@ -0,0 +1,40 @@
+describe "Performance tests", :performance => true do
+  PERIODS = 300
+  DATA_POINTS_PER_INTERVAL = 3000
+
+  before :all do
+    ActiveRecord::Base.connection.execute("DELETE   FROM activities;")
+
+    @time = Time.now
+    PERIODS.times do |days|
+      inserts = []
+
+      DATA_POINTS_PER_INTERVAL.times do |quantity|
+        quantity = 4000 + (quantity * 100)
+        created_at = @time - days.days
+        inserts << "(#{quantity}, '#{created_at.utc}')"
+      end
+
+      ActiveRecord::Base.connection.execute(<<-SQL)
+        INSERT INTO activities(quantity, created_at) VALUES #{inserts.join(", ")}
+      SQL
+    end
+  end
+
+  after :all do
+    ActiveRecord::Base.connection.execute("DELETE   FROM activities;")
+  end
+
+  it "should be performant with non cumulative queries" do
+    expect do
+      Activity.periodic_sum(:quantity, @time - PERIODS.days, @time).result
+    end.to perform_in(1)
+  end
+
+  it "should be performant cumulative queries" do
+    expect do
+      Activity.periodic_sum(:quantity, @time - PERIODS.days, @time, :cumulative => true).result
+    end.to perform_in(1)
+  end
+
+end

data/spec/periodic_calculations/query_spec.rb

@@ -124,12 +124,13 @@ describe PeriodicCalculations::Query do
 
         # outside interval matters
         Activity.create(:created_at => time - 10.day)
+        Activity.create(:created_at => time - 10.day)
 
         Activity.create(:created_at => time - 1.day)
         Activity.create(:created_at => time)
         Activity.create(:created_at => time + 1.day)
 
-        execute(scope, operation, column_name, start_time, end_time, options).map(&:last).should == [2, 3, 4]
+        execute(scope, operation, column_name, start_time, end_time, options).map(&:last).should == [3, 4, 5]
       end
     end
 

data/spec/spec_helper.rb

@@ -4,3 +4,11 @@ Coveralls.wear!
 ENV["RAILS_ENV"] = "test"
 require File.expand_path("../dummy/config/environment", __FILE__)
 require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.filter_run_excluding :performance => true
+  config.before(:all, :performance => true) do
+    require 'benchmark'
+    require 'performance_matchers'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: periodic_calculations
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-08 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -154,6 +154,8 @@ files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/model_spec.rb
+- spec/performance_matchers.rb
+- spec/performance_spec.rb
 - spec/periodic_calculations/lazy_query_spec.rb
 - spec/periodic_calculations/query_options_spec.rb
 - spec/periodic_calculations/query_spec.rb
@@ -223,6 +225,8 @@ test_files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/model_spec.rb
+- spec/performance_matchers.rb
+- spec/performance_spec.rb
 - spec/periodic_calculations/lazy_query_spec.rb
 - spec/periodic_calculations/query_options_spec.rb
 - spec/periodic_calculations/query_spec.rb