cubicle 0.1.0

data/lib/cubicle/ratio.rb

@@ -0,0 +1,12 @@
+module Cubicle
+  class Ratio < CalculatedMeasure
+
+    attr_reader :numerator, :denominator
+    def initialize(member_name,numerator,denominator,opts={})
+      @numerator, @denominator = numerator, denominator
+      opts[:expression]="(value.#{denominator} > 0 && value.#{numerator} ? value.#{numerator}/value.#{denominator} : 0)"
+      super(member_name,opts)
+    end
+
+  end
+end

data/lib/cubicle/support.rb

@@ -0,0 +1,46 @@
+class Time
+  include Cubicle::DateTime
+
+  #support date ranges that can iterate by day, month, etc.
+   #iteration
+  def step_by
+    @step_by ||= :second
+  end
+
+  def step_by=(by)
+    @step_by = by
+  end
+
+  def succ
+    next_date = advance(step_by.to_s.pluralize.to_sym=>1)
+    next_date.step_by = self.step_by
+    next_date
+  end
+end
+
+class Date
+  include Cubicle::DateTime
+  
+  #support date ranges that can iterate by day, month, etc.
+   #iteration
+  def step_by
+    @step_by ||= :day
+  end
+
+  def step_by=(by)
+    @step_by = by
+  end
+
+  def succ
+    next_date = advance(step_by.to_s.pluralize.to_sym=>1)
+    next_date.step_by = self.step_by
+    next_date
+  end
+end
+
+class Range
+  def by!(step_by)
+    first.step_by = step_by if first.respond_to?(:step_by=)
+    self
+  end
+end

data/lib/cubicle/version.rb

@@ -0,0 +1,3 @@
+module Cubicle
+  VERSION = '0.1.0'
+end

data/test/config/database.yml

@@ -0,0 +1,15 @@
+development: &global_settings
+  database: cubicle_dev
+  host: 127.0.0.1
+  port: 27017
+
+test: 
+  database: cubicle_test
+  <<: *global_settings
+
+production:
+  database: cubicle
+  #username: username
+  #password: password
+  <<: *global_settings
+

data/test/cubicle/cubicle_aggregation_test.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+
+class AggregationTest < ActiveSupport::TestCase
+  context "Executing an ad hoc query via an aggregation" do
+    setup do
+      Defect.create_test_data
+      @results =  Cubicle::Aggregation.new("defects") do
+        dimension :product, :field_name=>"product.name"
+        count :total, :field_name=>"defect_id"
+      end.query
+    end
+    should "return appropriately aggregated data" do
+      assert_equal "Brush Fire Bottle Rockets", @results[0]["product"]
+      assert_equal 1, @results[0]["total"]
+      assert_equal "Evil's Pickling Spice", @results[1]["product"]
+      assert_equal 1, @results[1]["total"]
+      assert_equal "Sad Day Moonshine", @results[2]["product"]
+      assert_equal 3, @results[2]["total"]
+    end
+  end
+end

data/test/cubicle/cubicle_data_level_test.rb

@@ -0,0 +1,58 @@
+require "test_helper"
+
+class CubicleDataLevelTest < ActiveSupport::TestCase
+  context "Cubicle::CubicleDataLevel#new" do
+    should "succeed with no arguments" do
+      assert_nothing_raised do
+        Cubicle::DataLevel.new
+      end
+    end
+    should "Choose a default name if none is provided" do
+      assert_equal "Unknown Level", Cubicle::DataLevel.new.name
+    end
+    should "Set the name using the first argument" do
+      assert_equal :me, Cubicle::DataLevel.new(:me).name
+    end      
+  end
+  context "Indexing into a Cubicle::CubicleDataLevel" do
+    should "provide indifferent access" do
+      level = Cubicle::DataLevel.new
+      level[:hello] = "hi"
+      assert_equal "hi", level["hello"]
+      level["hi"] = :hello
+      assert_equal :hello, level[:hi]      
+    end
+    should "Provide an empty array as a default value for missing keys" do
+      assert_equal [], Cubicle::DataLevel.new["hello there"]
+      l = Cubicle::DataLevel.new
+      l[:hi] << 1 << 2 << 3
+      assert_equal [1,2,3], l[:hi]  
+    end
+    should "allow method missing to index into hash" do
+      l = Cubicle::DataLevel.new
+      l.hello = "goodbye"
+      assert_equal "goodbye", l[:hello]
+      assert_equal "goodbye", l.hello
+    end
+  end
+  context "CubeDataLevel.leaf_level?" do
+    should "Correctly identify a leaf level" do
+      l = Cubicle::DataLevel.new(:happy)
+      assert l.leaf_level?
+      l[:a] = []
+      assert l.leaf_level?
+    end
+    should "Corrently identify non-leaf level" do
+      l = Cubicle::DataLevel.new(:happy)
+      l[:a] = Cubicle::DataLevel.new(:sad)
+      assert_not_equal true, l.leaf_level?
+    end
+  end
+  context "CubeDataLevel.flatten" do
+    should "Flatten using a provided member name" do
+      l = Cubicle::DataLevel.new(:happy,{:a=>[{:a=>3,:b=>2}],:b=>[{:a=>4,:b=>1}]})
+      assert_equal [2,1], l.flatten(:b)
+    end
+  end
+
+end

data/test/cubicle/cubicle_data_test.rb

@@ -0,0 +1,51 @@
+require "test_helper"
+
+class CubicleDataTest  < ActiveSupport::TestCase
+  context "Given a map-reduce query result" do
+    setup do
+      @raw_data =   [{"_id"=>{"company_id"=>'c1', "month"=>"2009-11"}, "value"=>{"requests"=>1.0, "transports"=>1.0}},
+                     {"_id"=>{"company_id"=>'c1', "month"=>"2009-11"}, "value"=>{"requests"=>1.0, "controllable_declines"=>1.0}},
+                     {"_id"=>{"company_id"=>'c1', "month"=>"2010-01"}, "value"=>{"requests"=>2.0, "transports"=>2.0}}]
+      @query = Class.new do
+        extend Cubicle
+        dimensions :company_id, :month
+        measures :requests, :transports, :controllable_declines
+      end
+      @data = Cubicle::Data.new(@query,@raw_data)
+    end
+    context "CubicleData#initialize" do
+      should "merge dimension and measure hashes for each row when initialized" do
+        assert_equal 3, @data.length
+        assert_equal 4, @data[0].keys.length
+        assert_nil @data[0]["_id"]
+        assert_nil @data[0]["value"]
+        assert_equal ["company_id","month","requests","transports"].sort, @data[0].keys.sort
+      end
+    end
+    context "CubicleData.hierarchize" do
+      should "hierarchize according to the dimensions of the original query when called without arguments" do
+        hierarchy = @data.hierarchize
+        assert_equal 1, hierarchy.length
+        assert_equal :company_id, hierarchy.name
+        assert_equal 2, hierarchy.c1.length
+        assert_equal 2, hierarchy.c1["2009-11"].length
+        assert_equal 2.0, hierarchy.c1["2010-01"][0].transports
+      end
+      should "hierarchize according to the order of dimensions provided" do
+        hierarchy = @data.hierarchize :month, :company_id
+        assert_equal 2, hierarchy.length
+        assert_equal :month, hierarchy.name
+        assert_equal 1, hierarchy["2009-11"].length
+        assert_equal 2, hierarchy["2009-11"].c1.length
+        assert_equal 1.0, hierarchy["2009-11"].c1[0].transports
+      end
+      should "hierarchize only the provided dimensions" do
+        hierarchy = @data.hierarchize :month
+        assert_equal 2, hierarchy.length
+        assert hierarchy.leaf_level?
+        assert_equal 1.0, hierarchy["2009-11"][0].transports
+        assert_equal "c1", hierarchy["2009-11"][0].company_id
+      end
+    end
+  end
+end

data/test/cubicle/cubicle_query_test.rb

@@ -0,0 +1,326 @@
+require "test_helper"
+
+class CubicleQueryTest < ActiveSupport::TestCase
+  context "CubicleQuery#select" do
+    setup do
+      Defect.create_test_data
+    end
+    should "raise an exception when given a non-existent member" do
+      assert_raise RuntimeError do
+        DefectCubicle.query do
+          select :does_not_exist
+        end
+      end
+    end
+    should "query the underlying data source of cubicle rather than the persistent cache when :transient=>true" do
+      query = DefectCubicle.query :defer=>true  do
+        transient!
+        select :product, :total_defects
+      end
+      query.execute()
+      assert_equal "defects", query.source_collection_name
+    end
+    should "query the persistent cache when transient=>false" do
+      query = DefectCubicle.query :defer=>true do
+        select :product, :total_defects
+      end
+      query.execute()
+      assert_equal "defect_cubicles_cubicle", query.source_collection_name
+    end
+    should "Select dimensions in the by clause" do
+      query_results = DefectCubicle.query do
+        select :all_measures
+        by :product
+      end
+      assert_equal :product, query_results.name
+      assert_equal "Brush Fire Bottle Rockets", query_results.member_names[0]
+    end
+    should "Select aliased dimensions in the by clause" do
+      query_results = DefectCubicle.query do
+        select :all_measures
+        by :date
+      end
+      assert_equal :manufacture_date, query_results.name
+      assert_equal "2009-12-09", query_results.member_names[0]
+    end
+    context "when specifying a dimension" do
+      setup do
+        @results = DefectCubicle.query(:product, :all_measures)
+      end
+      should "return the specified subset of data, including all measures" do
+        assert_equal 3, @results.length
+
+        assert_equal "Brush Fire Bottle Rockets", @results[0]["product"]
+        assert_equal 1, @results[0]["total_defects"]
+        assert_equal 0, @results[0]["preventable_defects"]
+        assert_equal 0.43, @results[0]["total_cost"]
+        assert_equal 0.43, @results[0]["avg_cost"]
+        assert_equal 0, @results[0]["preventable_pct"]
+      end
+
+    end
+    context "when specifying a dimension using an alias" do
+      setup do
+        @results = DefectCubicle.query(:date, :all_measures)
+      end
+      should "return the specified subset of data, including all measures" do
+        assert_equal 4, @results.length
+        assert_equal "2009-12-09", @results[0]["manufacture_date"]
+        assert_equal 1, @results[0]["total_defects"]
+        assert_equal 0, @results[0]["preventable_defects"]
+        assert_equal 0.43, @results[0]["total_cost"]
+        assert_equal 0.43, @results[0]["avg_cost"]
+        assert_equal 0, @results[0]["preventable_pct"]
+      end
+    end
+    context "when specifying a dimension from a transient query" do
+      setup do
+        #DefectCubicle.transient!
+        @results = DefectCubicle.query do |q|
+          q.transient!
+          q.select :product, :all_measures
+        end
+      end
+      should "return the specified subset of data, including all measures" do
+        assert_equal 3, @results.length
+
+        assert_equal "Brush Fire Bottle Rockets", @results[0]["product"]
+        assert_equal 1, @results[0]["total_defects"]
+        assert_equal 0, @results[0]["preventable_defects"]
+        assert_equal 0.43, @results[0]["total_cost"]
+        assert_equal 0.43, @results[0]["avg_cost"]
+        assert_equal 0, @results[0]["preventable_pct"]
+      end
+
+    end
+    context "when specifying a dimensional filter on a transient query" do
+      setup do
+        @results = DefectCubicle.query do
+          transient!
+          select :product, :all_measures
+          where  :product=>"Sad Day Moonshine"
+        end
+      end
+      should "return a filtered subset of data" do
+        assert_equal 1, @results.length
+        assert_equal "Sad Day Moonshine", @results[0]["product"]
+        assert_equal 3, @results[0]["total_defects"]
+        assert_equal 2, @results[0]["preventable_defects"]
+        assert_equal 15.91, @results[0]["total_cost"]
+        assert_equal 15.91/3, @results[0]["avg_cost"]
+        assert_equal 2/3.0, @results[0]["preventable_pct"]
+      end
+
+    end
+    context "when specifying a dimensional filter on a transient query using an alias" do
+      setup do
+        #DefectCubicle.transient!
+        @results = DefectCubicle.query do
+          transient!
+          select :manufacture_date, :all_measures
+          where  :date=>"2009-12-09"
+        end
+      end
+      should "return a filtered subset of data" do
+        assert_equal 1, @results.length
+        assert_equal "2009-12-09", @results[0]["manufacture_date"]
+        assert_equal 1, @results[0]["total_defects"]
+        assert_equal 0, @results[0]["preventable_defects"]
+        assert_equal 0.43, @results[0]["total_cost"]
+        assert_equal 0.43, @results[0]["avg_cost"]
+        assert_equal 0, @results[0]["preventable_pct"]
+      end
+
+    end
+    context "when specifying a dimensional filter on a non-transient query" do
+      setup do
+        @results = DefectCubicle.query do
+          select :product, :all_measures
+          where  :product=>"Sad Day Moonshine"
+        end
+      end
+      should "return a filtered subset of data" do
+        assert_equal 1, @results.length
+        assert_equal "Sad Day Moonshine", @results[0]["product"]
+        assert_equal 3, @results[0]["total_defects"]
+        assert_equal 2, @results[0]["preventable_defects"]
+        assert_in_delta 15.91, @results[0]["total_cost"],0.0001
+        assert_in_delta 15.91/3, @results[0]["avg_cost"],0.0001
+        assert_in_delta 2/3.0, @results[0]["preventable_pct"],0.0001
+      end
+
+    end
+    context "when specifying a dimensional filter on a non-transient query using an alias" do
+      setup do
+        @results = DefectCubicle.query do
+          select :date, :all_measures
+          where  :date=>"2009-12-09"
+        end
+      end
+      should "return a filtered subset of data" do
+        assert_equal 1, @results.length
+        assert_equal "2009-12-09", @results[0]["manufacture_date"]
+        assert_equal 1, @results[0]["total_defects"]
+        assert_equal 0, @results[0]["preventable_defects"]
+        assert_equal 0.43, @results[0]["total_cost"]
+        assert_equal 0.43, @results[0]["avg_cost"]
+        assert_equal 0, @results[0]["preventable_pct"]
+      end
+
+    end
+    context "when specifying a dimensional filter on a non-transient query using $where" do
+      setup do
+        @results = DefectCubicle.query do
+          select :product, :all_measures
+          where  "$where"=>"this._id.product=='Sad Day Moonshine'"
+        end
+      end
+      should "return a filtered subset of data" do
+        assert_equal 1, @results.length
+        assert_equal "Sad Day Moonshine", @results[0]["product"]
+        assert_equal 3, @results[0]["total_defects"]
+        assert_equal 2, @results[0]["preventable_defects"]
+        assert_in_delta 15.91, @results[0]["total_cost"],0.0001
+        assert_in_delta 15.91/3, @results[0]["avg_cost"],0.0001
+        assert_equal 2/3.0, @results[0]["preventable_pct"]
+      end
+
+    end
+    context "when specifying a dimensional filter on a transient query using $where" do
+      setup do
+        @results = DefectCubicle.query do
+          transient!
+          select :product, :all_measures
+          where  "$where"=>"this.product.name=='Sad Day Moonshine'"
+        end
+      end
+      should "return a filtered subset of data" do
+        assert_equal 1, @results.length
+        assert_equal "Sad Day Moonshine", @results[0]["product"]
+        assert_equal 3, @results[0]["total_defects"]
+        assert_equal 2, @results[0]["preventable_defects"]
+        assert_equal 15.91, @results[0]["total_cost"]
+        assert_equal 15.91/3, @results[0]["avg_cost"]
+        assert_equal 2/3.0, @results[0]["preventable_pct"]
+      end
+
+    end
+    context "when specifying a dimensional filter for an expression based dimension on a transient query" do
+      setup do
+        @results = DefectCubicle.query do
+          transient!
+          select :product,:all_measures
+          where  :month=>"2010-01"
+        end
+      end
+      should "return a filtered subset of data" do
+        assert_equal 2, @results.length
+        assert_equal "Evil's Pickling Spice", @results[0]["product"]
+        assert_equal "Sad Day Moonshine", @results[1]["product"]
+      end
+
+    end
+    context "when specifying a sort order on a transient query" do
+      setup do
+        @results = DefectCubicle.query do
+          transient!
+          select :product,:all_measures
+          order_by [:product, :desc]
+        end
+      end
+      should "return sorted data" do
+        assert_equal 3, @results.length
+        assert_equal "Sad Day Moonshine", @results[0]["product"]
+        assert_equal "Evil's Pickling Spice", @results[1]["product"]
+        assert_equal "Brush Fire Bottle Rockets", @results[2]["product"]
+      end
+
+    end
+    context "when specifying a sort order on a non transient query" do
+      setup do
+        @results = DefectCubicle.query do
+          select :product,:all_measures
+          order_by [:product, :desc]
+        end
+      end
+      should "return sorted data" do
+        assert_equal 3, @results.length
+        assert_equal "Sad Day Moonshine", @results[0]["product"]
+        assert_equal "Evil's Pickling Spice", @results[1]["product"]
+        assert_equal "Brush Fire Bottle Rockets", @results[2]["product"]
+      end
+
+    end
+    context "when requesting YTD" do
+      setup do
+        Time.now = "2010-01-04"
+        @results = DefectCubicle.query do
+          select :date, :all_measures
+          year_to_date
+        end
+      end
+      should "present YTD data based on Time.now" do
+        assert_equal 1, @results.length
+        assert_in_delta 12.97, @results[0]["total_cost"],0.0001
+      end
+    end
+    context "when requesting MTD in a non-transient query do" do
+      setup do
+        Time.now = "2010-01-05"
+        @results = DefectCubicle.query do
+          select :month, :all_measures
+          month_to_date
+        end
+      end
+      should "present MTD data based on Time.now" do
+        assert_equal 1, @results.length
+        assert_in_delta 12.99, @results[0]["total_cost"],0.0001
+      end
+    end
+    context "when requesting MTD in a transient query do" do
+      setup do
+        Time.now = "2010-01-05"
+        @results = DefectCubicle.query do
+          transient!
+          select :month, :all_measures
+          month_to_date
+        end
+      end
+      should "present MTD data based on Time.now" do
+        assert_equal 1, @results.length
+        assert_in_delta 12.99, @results[0]["total_cost"],0.0001
+      end
+    end
+    context "when requesting for_the_last_complete 1.months" do
+      setup do
+        Time.now = "2010-01-30"
+        @results = DefectCubicle.query do
+          select :month, :all_measures
+          for_the_last_complete :month
+        end
+      end
+      should "present data for the previous month" do
+        assert_equal 1, @results.length
+        assert_equal 0.43, @results[0]["total_cost"]
+      end
+    end
+    context "Date filters against native Time types" do
+      setup do
+        Time.now = "2010-01-30"
+        Cubicle::DateTime.db_time_format = :native
+        @results = DefectCubicle.query do
+          time_dimension :manufacture_time
+          select :month, :all_measures
+          for_the_last_complete :month
+        end
+      end
+      should "dance like a butterfly and sting like a bee" do
+        assert_equal 1, @results.length
+        assert_equal 0.43, @results[0]["total_cost"]
+      end
+      teardown do
+        Cubicle::DateTime.db_time_format = :iso8601
+      end
+    end
+  end
+end