periodic_calculations 0.0.1

data/spec/periodic_calculations/query_options_spec.rb

@@ -0,0 +1,82 @@
+describe PeriodicCalculations::QueryOptions do
+
+  it "initializes without errors when valid parameters" do
+    time = Time.now
+    query_options = described_class.new(:count, :id, time, time)
+    query_options.window_start.should == time
+  end
+
+  describe "raises ArgumentError when" do
+    it "no operation" do
+      expect {
+        described_class.new(nil, :id, Time.now, Time.now)
+      }.to raise_error(ArgumentError)
+    end
+
+    it "invalid operation" do
+      expect {
+        described_class.new(:xxx, :id, Time.now, Time.now)
+      }.to raise_error(ArgumentError)
+    end
+
+    it "no column_name" do
+      expect {
+        described_class.new(nil, nil, Time.now, Time.now)
+      }.to raise_error(ArgumentError)
+    end
+
+    it "no window start" do
+      expect {
+        described_class.new(:count, :id, nil, Time.now)
+      }.to raise_error(ArgumentError)
+    end
+
+    it "no window end" do
+      expect {
+        described_class.new(:count, :id, Time.now, nil)
+      }.to raise_error(ArgumentError)
+    end
+
+    it "window start is not a Time" do
+      expect {
+        described_class.new(:count, :id, 3, Time.now)
+      }.to raise_error(ArgumentError)
+    end
+
+    it "window end is not a Time" do
+      expect {
+        described_class.new(:count, :id, Time.now, 3)
+      }.to raise_error(ArgumentError)
+    end
+
+    it "interval_unit is not valid" do
+      expect {
+        described_class.new(:count, :id, Time.now, Time.now, :interval_unit => '3days')
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "defaults" do
+    let(:query_options) do
+      time = Time.now
+      described_class.new(:count, :id, time, time)
+    end
+
+    it "timestamp_column to :created_at" do
+      query_options.timestamp_column.should == :created_at
+    end
+
+    it "interval_unit to :day" do
+      query_options.interval_unit.should == :day
+    end
+
+    it "cumulative to false" do
+      query_options.cumulative.should be_false
+    end
+
+    it "timezone_offset to Rails timezone offset in seconds" do
+      query_options.timezone_offset.should == Time.now.in_time_zone.utc_offset
+    end
+  end
+
+end

data/spec/periodic_calculations/query_spec.rb

@@ -0,0 +1,211 @@
+require 'spec_helper'
+
+describe PeriodicCalculations::Query do
+
+  before { Activity.delete_all }
+
+  let(:scope) { Activity.all }
+  let(:time) { Time.now }
+
+  let(:operation) { :count }
+  let(:column_name) { :id }
+  let(:start_time) { time - 1.day }
+  let(:end_time) { time + 1.day }
+  let(:options) { {} }
+
+  describe "#to_sql" do
+    it "returns the sanitized_sql" do
+      query_options = PeriodicCalculations::QueryOptions.new(operation, column_name, start_time, end_time, options)
+      query = PeriodicCalculations::Query.new(scope, query_options)
+
+      query.stub(:sanitized_sql).and_return("wohoo")
+      query.to_sql.should == "wohoo"
+    end
+  end
+
+  describe "#execute" do
+
+    def execute(scope, *args)
+      query_options = PeriodicCalculations::QueryOptions.new(*args)
+      PeriodicCalculations::Query.new(scope, query_options).execute
+    end
+
+    describe "Intervals" do
+      it "should add missing values within range" do
+        execute(scope, operation, column_name, start_time, end_time, options).should have(3).items
+      end
+
+      it "should return one single day when same dates" do
+        start_time = time
+        end_time = time
+
+        execute(scope, operation, column_name, start_time, end_time, options).should have(1).items
+      end
+
+      it "should return two day when consecutive" do
+        start_time = time
+        end_time = time + 1.day
+
+        execute(scope, operation, column_name, start_time, end_time, options).should have(2).items
+      end
+
+      it "should operate by day" do
+        start_time = time
+        end_time = time + 2.day
+        options.merge!(:interval_unit => :day)
+
+        execute(scope, operation, column_name, start_time, end_time, options).should have(3).items
+      end
+
+      it "should operate by week" do
+        start_time = time
+        end_time = time + 1.week
+        options.merge!(:interval_unit => :week)
+
+        execute(scope, operation, column_name, start_time, end_time, options).should have(2).items
+      end
+
+      it "should operate by month" do
+        start_time = time.beginning_of_month
+        end_time = time + 4.months
+        options.merge!(:interval_unit => :month)
+
+        execute(scope, operation, column_name, start_time, end_time, options).should have(5).items
+      end
+    end
+
+    describe "Time window" do
+      it "should consider rows outside current scope" do
+        Activity.create(:quantity => 3, :created_at => time)
+        scope = Activity.where(:quantity => 3)
+
+        execute(scope, operation, column_name, start_time, end_time, options).map(&:last).should == [0, 1, 0]
+      end
+
+      it "should NOT consider rows outside current scope" do
+        Activity.create(:quantity => 0, :created_at => time)
+        scope = Activity.where(:quantity => 3)
+
+        execute(scope, operation, column_name, start_time, end_time, options).map(&:last).should == [0, 0, 0]
+      end
+
+      it "should operate with a custom timestamp column" do
+        Activity.create(:quantity => 3, :finished_at => time)
+        options[:timestamp_column] = :finished_at
+        execute(scope, operation, column_name, start_time, end_time, options).map(&:last).should == [0, 1, 0]
+      end
+
+      it "should return matching results taking timezone into account" do
+        Time.zone = ActiveSupport::TimeZone["Pacific Time (US & Canada)"]
+
+        Time.zone.name.should == "Pacific Time (US & Canada)" # ensure correctly set
+
+        # Outside left window limit
+        Activity.create(:quantity => 3, :created_at => start_time.beginning_of_day - 1.seconds)
+        # Inside by left window limit
+        Activity.create(:quantity => 3, :created_at => start_time.beginning_of_day + 1.seconds)
+        # Inside by right window limit
+        Activity.create(:quantity => 3, :created_at => end_time.end_of_day - 1.seconds)
+        # Outside by right window limit
+        Activity.create(:quantity => 3, :created_at => end_time.end_of_day + 1.seconds)
+
+        execute(scope, :count, column_name, start_time, end_time, options).map(&:last).should == [1, 0, 1]
+      end
+    end
+
+    describe "Operation: count" do
+       it "should count NON cumulatively" do
+        Activity.create(:created_at => time - 10.day)
+        Activity.create(:created_at => time)
+
+        execute(scope, operation, column_name, start_time, end_time, options).map(&:last).should == [0, 1, 0]
+      end
+
+      it "should count cumulatively" do
+        options[:cumulative] = true
+
+        # outside interval matters
+        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]
+      end
+    end
+
+    describe "Operation: average" do
+      it "should calculate the average cumulatively" do
+        Activity.create(:quantity => 4, :created_at => time)
+        Activity.create(:quantity => 8, :created_at => time)
+
+        execute(scope, :avg, :quantity, start_time, end_time, options).map(&:last).should == [0, 6, 0]
+      end
+
+      it "should calculate the average NON cumulatively" do
+        Activity.create(:quantity => 4, :created_at => time - 10.days)
+        Activity.create(:quantity => 8, :created_at => time)
+
+        options[:cumulative] = true
+
+        execute(scope, :avg, :quantity, start_time, end_time, options).map(&:last).should == [4, 6, 6]
+      end
+    end
+
+    describe "Operation: sum" do
+      it "should calculate the sum NON cumulatively" do
+        Activity.create(:quantity => 4, :created_at => time)
+        Activity.create(:quantity => 8, :created_at => time)
+
+        execute(scope, :sum, :quantity, start_time, end_time, options).map(&:last).should == [0, 12, 0]
+      end
+
+      it "should calculate the sum cumulatively" do
+        options[:cumulative] = true
+
+        Activity.create(:quantity => 4, :created_at => time - 10.days)
+        Activity.create(:quantity => 8, :created_at => time)
+
+        execute(scope, :sum, :quantity, start_time, end_time, options).map(&:last).should == [4, 12, 12]
+      end
+    end
+
+    describe "Operation: minimum" do
+      it "should calculate the minimum no cumulatively" do
+        Activity.create(:quantity => 4, :created_at => time)
+        Activity.create(:quantity => 8, :created_at => time)
+
+        execute(scope, :min, :quantity, start_time, end_time, options).map(&:last).should == [0, 4, 0]
+      end
+
+      it "should calculate the minimum cumulatively" do
+        options[:cumulative] = true
+
+        Activity.create(:quantity => 8, :created_at => time - 10.days)
+        Activity.create(:quantity => 4, :created_at => time)
+
+        execute(scope, :min, :quantity, start_time, end_time, options).map(&:last).should == [8, 4, 4]
+      end
+    end
+
+    describe "Operation: maximum" do
+      it "should calculate the maximum NON cumulatively" do
+        Activity.create(:quantity => 4, :created_at => time)
+        Activity.create(:quantity => 8, :created_at => time)
+
+        execute(scope, :max, :quantity, start_time, end_time, options).map(&:last).should == [0, 8, 0]
+      end
+
+      it "should calculate the maximum cumulatively" do
+        options[:cumulative] = true
+
+        Activity.create(:quantity => 4, :created_at => time - 10.days)
+        Activity.create(:quantity => 8, :created_at => time)
+
+        execute(scope, :max, :quantity, start_time, end_time, options).map(&:last).should == [4, 8, 8]
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
+ENV["RAILS_ENV"] = "test"
+require File.expand_path("../dummy/config/environment", __FILE__)
+require 'rspec/rails'

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: periodic_calculations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Pol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Periodic Calculations gem allows you to retrieve periodic results of
+  aggregates that can be accumulated over time with PostgreSQL.
+email:
+- polmiro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/periodic_calculations.rb
+- lib/periodic_calculations/base.rb
+- lib/periodic_calculations/engine.rb
+- lib/periodic_calculations/lazy_query.rb
+- lib/periodic_calculations/query.rb
+- lib/periodic_calculations/query_options.rb
+- lib/periodic_calculations/version.rb
+- periodic_calculations.gemspec
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/images/.keep
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/.keep
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/mailers/.keep
+- spec/dummy/app/models/.keep
+- spec/dummy/app/models/activity.rb
+- spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/db/migrate/20131203172849_create_activities.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/lib/assets/.keep
+- spec/dummy/log/.keep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/model_spec.rb
+- spec/periodic_calculations/lazy_query_spec.rb
+- spec/periodic_calculations/query_options_spec.rb
+- spec/periodic_calculations/query_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/polmiro/periodic_calculations
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Retrieve periodic stats in periods of time
+test_files:
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/images/.keep
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/.keep
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/mailers/.keep
+- spec/dummy/app/models/.keep
+- spec/dummy/app/models/activity.rb
+- spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/db/migrate/20131203172849_create_activities.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/lib/assets/.keep
+- spec/dummy/log/.keep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/model_spec.rb
+- spec/periodic_calculations/lazy_query_spec.rb
+- spec/periodic_calculations/query_options_spec.rb
+- spec/periodic_calculations/query_spec.rb
+- spec/spec_helper.rb