prosperity 0.0.1 → 0.0.2

data/spec/lib/prosperity/extractors/interval_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+module Prosperity
+  describe Extractors::Interval do
+    let(:expected_data_size) { 14 }
+    it_behaves_like "an extractor"
+
+    let(:start_time) { 1.year.ago }
+    let(:end_time) { start_time + 1.year }
+    let(:period) { Periods::MONTH }
+    let(:data) { subject.to_a }
+
+    subject { Extractors::Interval.new(metric, 'default', start_time, end_time, period) }
+
+    before do
+      User.delete_all
+      [2.years.ago, 1.month.ago, 1.month.from_now].each do |time|
+        User.create created_at: time
+      end
+      User.create created_at: 1.week.ago
+    end
+
+    context "simple scope" do
+      let(:metric) { UsersMetric.new }
+
+      describe "#to_a" do
+        it "returns the one entry per period" do
+          data.size.should == expected_data_size
+        end
+
+        it "only returns models from that period" do
+          data.sum.should == 2
+        end
+      end
+    end
+
+    context "simple sql fragment" do
+      let(:metric) { UsersSqlMetric.new }
+
+      describe "#to_a" do
+        it "returns the one entry per period" do
+          data.size.should == expected_data_size
+        end
+
+        it "only returns models from that period" do
+          data.sum.should == 2
+        end
+      end
+
+      context "with weekly period" do
+        let(:period) { Periods::WEEK }
+
+        describe "#to_a" do
+          it "returns the one entry per period" do
+            [54, 53].should include(data.size)
+          end
+
+          it "only returns models from that period" do
+            data.sum.should == 2
+          end
+        end
+
+        context "with alternate start and end times" do
+          let(:start_time) { 2.weeks.ago }
+          let(:end_time) { start_time + 2.weeks }
+
+          describe "#to_a" do
+            it "returns the one entry per period" do
+              data.size.should == 4
+            end
+
+            it "only returns models from that period" do
+              data.sum.should == 1
+            end
+          end
+        end
+      end
+    end
+
+    context "sql fragment with nested WITH" do
+      let(:metric) do
+        Class.new(Metric) do
+          sql "WITH all_columns AS (SELECT * FROM users) SELECT name, created_at FROM users"
+        end.new
+      end
+
+      describe "#to_a" do
+        it "returns the one entry per period" do
+          data.size.should == expected_data_size
+        end
+
+        it "only returns models from that period" do
+          data.sum.should == 2
+        end
+      end
+    end
+
+    context "a metric with a sum aggregate" do
+      before do
+        User.create! value: 1
+        User.create! value: 3
+      end
+
+      context "a non sql metric" do
+        let(:metric) do
+          Class.new(Metric) do
+            scope { User }
+            aggregate { sum(:value) }
+          end.new
+        end
+
+        describe "#to_a" do
+          it "returns the one entry per period" do
+            data.size.should == expected_data_size
+            data[-2].should == User.all.sum(:value)
+          end
+        end
+      end
+
+      context "a sql metric" do
+        let(:metric) do
+          Class.new(Metric) do
+            sql "SELECT * FROM users"
+            aggregate { sum(:value) }
+          end.new
+        end
+
+        describe "#to_a" do
+          it "returns the one entry per period" do
+            data.size.should == expected_data_size
+            data[-2].should == User.all.sum(:value)
+          end
+        end
+      end
+
+      context "ruby block" do
+        let(:metric) do
+          Class.new(Metric) do
+            value_at do |time, period, *|
+              10
+            end
+          end.new
+        end
+
+        describe "#to_a" do
+          it "delegates to the ruby block" do
+            data.should == [0] * expected_data_size
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/prosperity/extractors/total_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+module Prosperity
+  describe Extractors::Total do
+    it_behaves_like "an extractor"
+    let(:expected_data_size) { 14 }
+
+    let(:start_time) { 1.year.ago }
+    let(:end_time) { start_time + 12.months }
+    let(:period) { Periods::MONTH }
+
+    let(:data) { subject.to_a }
+    let(:metric) { UsersMetric.new }
+    let(:option) { 'default' }
+
+    subject { Extractors::Total.new(metric, option, start_time, end_time, period) }
+
+    before do 
+      User.delete_all
+      [2.years.ago, 1.month.ago, 1.month.from_now].each do |time|
+        User.create created_at: time
+      end
+    end
+
+    context "simple scope" do
+      describe "#to_a" do
+        it "returns the one entry per period" do
+          data.size.should == expected_data_size
+        end
+
+        it "returns the counts at it increases" do
+          data[0].should == 1
+          data[-1].should == 2
+        end
+      end
+    end
+
+    context "simple sql fragment" do
+      let(:metric) { UsersSqlMetric.new }
+
+      describe "#to_a" do
+        it "returns the one entry per period" do
+          data.size.should == expected_data_size
+        end
+
+        it "returns the counts at it increases" do
+          data[0].should == 1
+          data[-1].should == 2
+        end
+      end
+    end
+
+    context "with an option" do
+      let(:option) { "no_results" }
+
+      describe "#to_a" do
+        it "only returns the results for that option block" do
+          data.all?(&:zero?).should be_true          
+        end
+      end
+    end
+
+    context "ruby block" do
+      let(:metric) do
+        Class.new(Metric) do
+          value_at do |time, period, *|
+            10
+          end
+        end.new
+      end
+
+      describe "#to_a" do
+        it "delegates to the ruby block" do
+          data.should == [10] * expected_data_size
+        end
+      end
+    end
+  end
+end

data/spec/lib/prosperity/helpers/time_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+module Prosperity
+  describe Helpers::Time do
+
+  end
+end

data/spec/lib/prosperity/metric_finder_spec.rb

@@ -16,5 +16,12 @@ module Prosperity
         metrics.first.superclass.should == Metric
       end
     end
+
+    describe ".find_by_name" do
+      it "finds a metric by name" do
+        metric = described_class.find_by_name('UsersMetric')
+        metric.should be < Metric
+      end
+    end
   end
 end

data/spec/lib/prosperity/metric_spec.rb

@@ -16,6 +16,72 @@ module Prosperity
       it "gets the scope" do
         subject.scope.should == User
       end
+
+      it "should not be sql" do
+        subject.should_not be_sql
+      end
+
+      it "should have the default aggregate" do
+        subject.aggregate.should be_an(Aggregate::Count)
+      end
+    end
+
+    context "A raw sql metric" do
+      context "From a string" do
+        subject do
+          Class.new(Metric) do
+            sql "SELECT name, created_at FROM users"
+          end.new
+        end
+
+        it "groups by created_at by default" do
+          subject.group_by.should == :created_at
+        end
+
+        it "gets the scope" do
+          subject.sql.should == "SELECT name, created_at FROM users"
+        end
+
+        it "raises an exception when adding an option" do
+          expect {
+            subject.class.option "active" do |scope|
+              scope.active
+            end
+          }.to raise_exception(SqlMetricCannotHaveOption)
+        end
+
+        it "should be sql" do
+          subject.should be_sql
+        end
+      end
+
+      context "From a block" do
+        subject do
+          Class.new(Metric) do
+            sql { "SELECT name, created_at FROM users" }
+          end.new
+        end
+
+        it "groups by created_at by default" do
+          subject.group_by.should == :created_at
+        end
+
+        it "gets the scope" do
+          subject.sql.should == "SELECT name, created_at FROM users"
+        end
+
+        it "raises an exception when adding an option" do
+          expect {
+            subject.class.option "active" do |scope|
+              scope.active
+            end
+          }.to raise_exception(SqlMetricCannotHaveOption)
+        end
+
+        it "should be sql" do
+          subject.should be_sql
+        end
+      end
     end
     
     context "a metric missing the scope" do
@@ -29,11 +95,22 @@ module Prosperity
       end
     end
 
+    context "a metric missing the sql" do
+      subject do
+        Class.new(Metric) do
+        end
+      end
+
+      it "raises an exception when accessing the sql" do
+        expect { subject.sql }.to raise_exception(MissingSql)
+      end
+    end
+
     context "A simple scope metric with multiple options" do
       subject do
         Class.new(Metric) do 
           scope { User }
-          options "active" do |scope|
+          option "active" do |scope|
             scope.active
           end
         end.new
@@ -45,5 +122,53 @@ module Prosperity
         subject.options['active'].should be_present
       end
     end
+
+    context "A metric with a custom group by" do
+      subject do
+        Class.new(Metric) do 
+          scope { User }
+          group_by "users.created_at"
+        end.new
+      end
+
+      its(:group_by) { should == 'users.created_at' }
+    end
+
+    context "A metric with a a sum aggregate" do
+      subject do
+        Class.new(Metric) do 
+          scope { User }
+          aggregate { sum(:some_column) }
+        end.new
+      end
+
+      let(:aggregate) { subject.aggregate }
+
+      it "has the correct aggregate info" do
+        aggregate.should be_an(Aggregate::Sum)
+        aggregate.column.should == :some_column
+      end
+    end
+
+    context "a ruby code metric" do
+      subject do
+        Class.new(Metric) do
+          value_at do |time, period, option|
+            :expected
+          end
+        end.new
+      end
+
+      it "has the correct value_at info" do
+        subject.value_at.call.should == :expected
+      end
+
+      describe ".ruby?" do
+        it "should be true" do
+          subject.class.ruby?.should == true
+          subject.ruby?.should == true
+        end
+      end
+    end
   end
 end

data/spec/lib/prosperity/periods_spec.rb

@@ -2,6 +2,20 @@ require 'spec_helper'
 
 module Prosperity
   describe Periods do
+    subject { Periods::DAY }
 
+    describe "#each_period" do
+      it "iterates until the end time" do
+        times = []
+        start_time = DateTime.new(2012, 01, 01)
+        end_time = DateTime.new(2012, 01, 05)
+
+        subject.each_period(start_time, end_time) do |start_time|
+          times << start_time
+        end
+
+        times.should == Array.new(6) { |i| DateTime.new(2012, 01, i + 1) }
+      end
+    end
   end
 end

data/spec/models/prosperity/dashboard_graph_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+module Prosperity
+  describe DashboardGraph do
+  end
+end

data/spec/models/prosperity/dashboard_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+module Prosperity
+  describe Dashboard do
+  end
+end

data/spec/models/prosperity/graph_line_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+module Prosperity
+  describe GraphLine do
+  end
+end

data/spec/models/prosperity/graph_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+module Prosperity
+  describe Graph do
+  end
+end

data/spec/spec_helper.rb

@@ -5,10 +5,13 @@ require 'rspec/rails'
 require 'rspec/autorun'
 require 'pry-debugger'
 
-Dir[File.join(__dir__, "support/**/*.rb")].each {|f| require f }
-TEST_FILES = File.join(__dir__, "test_files")
+PROSPERITY_ROOT = File.expand_path("..", __FILE__)
+
+Dir[File.join(PROSPERITY_ROOT, "support/**/*.rb")].each {|f| require f }
+TEST_FILES = File.join(PROSPERITY_ROOT, "test_files")
 
 RSpec.configure do |config|
+  config.render_views
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus

data/spec/support/shared/extractors.rb

@@ -0,0 +1,64 @@
+shared_examples "an extractor" do
+  AGGREGATES = [:sum, :minimum, :maximum, :average]
+  let(:expected_data_size) { 14 }
+
+  ["sql", "normal"].each do |type|
+    AGGREGATES.each do |agg|
+      context "a #{type} metric with aggregate #{agg}" do
+        let(:metric) do
+          Class.new(Prosperity::Metric) do
+            if type == 'sql'
+              sql "SELECT * FROM users"
+            else
+              scope { User }
+            end
+            aggregate { send(agg, :value) }
+          end.new
+        end
+
+        describe "#to_a" do
+          let(:data) { subject.to_a }
+          it "returns the one entry per period" do
+            data.size.should == expected_data_size
+          end
+        end
+      end
+    end
+
+    context "a sql metric with default aggregat" do
+      let(:metric) do
+        Class.new(Prosperity::Metric) do
+          if type == 'sql'
+            sql "SELECT * FROM users"
+          else
+            scope { User }
+          end
+        end.new
+      end
+
+      describe "#to_a" do
+        let(:data) { subject.to_a }
+        it "returns the one entry per period" do
+          data.size.should == expected_data_size
+        end
+      end
+    end
+  end
+
+  context "a full SQL metric" do
+    let(:metric) do
+      Class.new(Prosperity::Metric) do
+        sql "SELECT * FROM users"
+        group_by "created_at"
+        aggregate { "SUM(value)" }
+      end.new
+    end
+
+    describe "#to_a" do
+      let(:data) { subject.to_a }
+      it "returns the one entry per period" do
+        data.size.should == expected_data_size
+      end
+    end
+  end
+end

data/spec/support/test_database.rb

@@ -12,6 +12,7 @@ RSpec.configure do |config|
     m.create_table :users do |t|
       t.string :email
       t.string :name
+      t.integer :value
       t.timestamps
     end
   end