cubicle 0.1.4 → 0.1.5

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+==0.1.5
+ * Added duration_since (aliased as elapsed, age_since) to calculate the time elapsed since any
+   given timestamp and the current execution time of the query.
+
+== 0.1.4
+ * Cached aggregations were being stored on disk, but not properly utilized. This is now fixed.
+
 == 0.1.3
 * Formalized flat (Cubicle::Data::Table) and hierarchical (Cubicle::Data::Hierarchy) data results from cubicle queries,
   and added client side support for rolling up measure values in hierarchical data so that no matter how a given

data/cubicle.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cubicle}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Stults"]
-  s.date = %q{2010-03-25}
+  s.date = %q{2010-03-29}
   s.description = %q{Cubicle provides a dsl and aggregation caching framework for automating the generation, execution and caching of map reduce queries when using MongoDB in Ruby. Cubicle also includes a MongoMapper plugin for quickly performing ad-hoc, multi-level group-by queries against a MongoMapper model.}
   s.email = %q{hereiam@sonic.net}
   s.extra_rdoc_files = [

data/lib/cubicle/aggregation/dsl.rb

@@ -1,108 +1,117 @@
-module Cubicle
-  module Aggregation
-    module Dsl
-      
-      def source_collection_name(collection_name = nil)
-        return @source_collection = collection_name if collection_name
-        @source_collection ||= name.chomp("Cubicle").chomp("Cube").chomp("Aggregation").underscore.pluralize
-      end
-      alias source_collection_name= source_collection_name
-
-      def target_collection_name(collection_name = nil)
-        return nil if transient?
-        return @target_name = collection_name if collection_name
-        @target_name ||= "#{name.blank? ? source_collection_name : name.underscore.pluralize}_cubicle"
-      end
-      alias target_collection_name= target_collection_name
-
-      def dimension(*args)
-        dimensions << Cubicle::Dimension.new(*args)
-        dimensions[-1]
-      end      
-
-      def dimensions(*args)
-        return (@dimensions ||= Cubicle::MemberList.new) if args.length < 1
-        args = args[0] if args.length == 1 && args[0].is_a?(Array)
-        args.each {|dim| dimension dim }
-        @dimensions
-      end
-
-      def measure(*args)
-        measures << Measure.new(*args)
-        measures[-1]
-      end
-
-      def measures(*args)
-        return (@measures ||= Cubicle::MemberList.new) if args.length < 1
-        args = args[0] if args.length == 1 && args[0].is_a?(Array)
-        args.each {|m| measure m}
-        @measures
-      end
-
-      def count(*args)
-        options = args.extract_options!
-        options[:aggregation_method] = :count
-        measure(*(args << options))
-      end
-
-      def average(*args)
-        options = args.extract_options!
-        options[:aggregation_method] = :average
-        measure(*(args << options))
-        #Averaged fields need a count of non-null values to properly calculate the average
-        args[0] = "#{args[0]}_count".to_sym
-        count *args
-      end
-      alias avg average
-
-      def sum(*args)
-        options = args.extract_options!
-        options[:aggregation_method] = :sum
-        measure(*(args << options))
-      end
-
-      def duration(*args)
-        options = args.extract_options!
-        options[:in] ||= durations_in
-        args << options
-        measures << (dur = Duration.new(*args))
-        count("#{dur.name}_count".to_sym, :expression=>dur.expression) if dur.aggregation_method == :average
-      end
-
-      def average_duration(*args)
-        duration(*args)
-      end
-      alias avg_duration average_duration
-
-      def total_duration(*args)
-        options = args.extract_options!
-        options[:aggregation_method] = :sum
-        duration(*(args<<options))
-      end
-
-      def durations_in(unit_of_time = nil)
-        return (@duration_unit ||= :seconds) unless unit_of_time
-        @duration_unit = unit_of_time.to_s.pluralize.to_sym
-      end
-      alias :duration_unit :durations_in
-
-
-      def ratio(member_name, numerator, denominator)
-        measures << Ratio.new(member_name, numerator, denominator)
-      end
-
-      def aggregation(*member_list)
-        member_list = member_list[0] if member_list[0].is_a?(Array)
-        aggregations << member_list
-      end
-
-      def time_dimension(*args)
-        return (@time_dimension ||= nil) unless args.length > 0
-        @time_dimension = dimension(*args)
-      end
-      alias time_dimension= time_dimension
-      alias date time_dimension
-      alias time time_dimension
-    end
-  end
+module Cubicle
+  module Aggregation
+    module Dsl
+      
+      def source_collection_name(collection_name = nil)
+        return @source_collection = collection_name if collection_name
+        @source_collection ||= name.chomp("Cubicle").chomp("Cube").chomp("Aggregation").underscore.pluralize
+      end
+      alias source_collection_name= source_collection_name
+
+      def target_collection_name(collection_name = nil)
+        return nil if transient?
+        return @target_name = collection_name if collection_name
+        @target_name ||= "#{name.blank? ? source_collection_name : name.underscore.pluralize}_cubicle"
+      end
+      alias target_collection_name= target_collection_name
+
+      def dimension(*args)
+        dimensions << Cubicle::Dimension.new(*args)
+        dimensions[-1]
+      end      
+
+      def dimensions(*args)
+        return (@dimensions ||= Cubicle::MemberList.new) if args.length < 1
+        args = args[0] if args.length == 1 && args[0].is_a?(Array)
+        args.each {|dim| dimension dim }
+        @dimensions
+      end
+
+      def measure(*args)
+        measures << Measure.new(*args)
+        measures[-1]
+      end
+
+      def measures(*args)
+        return (@measures ||= Cubicle::MemberList.new) if args.length < 1
+        args = args[0] if args.length == 1 && args[0].is_a?(Array)
+        args.each {|m| measure m}
+        @measures
+      end
+
+      def count(*args)
+        options = args.extract_options!
+        options[:aggregation_method] = :count
+        measure(*(args << options))
+      end
+
+      def average(*args)
+        options = args.extract_options!
+        options[:aggregation_method] = :average
+        measure(*(args << options))
+        #Averaged fields need a count of non-null values to properly calculate the average
+        args[0] = "#{args[0]}_count".to_sym
+        count *args
+      end
+      alias avg average
+
+      def sum(*args)
+        options = args.extract_options!
+        options[:aggregation_method] = :sum
+        measure(*(args << options))
+      end
+
+      def duration(*args)
+        options = args.extract_options!
+        options[:in] ||= durations_in
+        args << options
+        measures << (dur = Duration.new(*args))
+        count("#{dur.name}_count".to_sym, :expression=>dur.expression) if dur.aggregation_method == :average
+      end
+
+      def average_duration(*args)
+        duration(*args)
+      end
+      alias avg_duration average_duration
+
+      def total_duration(*args)
+        options = args.extract_options!
+        options[:aggregation_method] = :sum
+        duration(*(args<<options))
+      end
+
+      def duration_since(*args)
+        options = args.extract_options!
+        ms1 = args.length > 1 ? args.delete_at(1) : args.shift
+        options[ms1] = :now
+        duration(*(args<<options))
+      end
+      alias age_since duration_since
+      alias elapsed duration_since
+
+      def durations_in(unit_of_time = nil)
+        return (@duration_unit ||= :seconds) unless unit_of_time
+        @duration_unit = unit_of_time.to_s.pluralize.to_sym
+      end
+      alias :duration_unit :durations_in
+
+
+      def ratio(member_name, numerator, denominator)
+        measures << Ratio.new(member_name, numerator, denominator)
+      end
+
+      def aggregation(*member_list)
+        member_list = member_list[0] if member_list[0].is_a?(Array)
+        aggregations << member_list
+      end
+
+      def time_dimension(*args)
+        return (@time_dimension ||= nil) unless args.length > 0
+        @time_dimension = dimension(*args)
+      end
+      alias time_dimension= time_dimension
+      alias date time_dimension
+      alias time time_dimension
+    end
+  end
 end

data/lib/cubicle/duration.rb

@@ -23,7 +23,7 @@ module Cubicle
       cond = " && (#{self.condition})" unless self.condition.blank?
       #prefix these names for the expression
       prefix = "#{self.timestamp_prefix}#{self.timestamp_prefix.blank? ? '' : '.'}"
-      ms1,ms2 = [self.begin_milestone,self.end_milestone].map{|ms|"this.#{prefix}#{ms}"}
+      ms1,ms2 = [self.begin_milestone,self.end_milestone].map{|ms|ms.to_s=='now' ? "new Date(#{Time.now.to_i*1000})" : "this.#{prefix}#{ms}"}
       @expression = "(#{ms1} && #{ms2}#{cond}) ? (#{ms2}-#{ms1})/#{denominator} : null"
     end
 

data/lib/cubicle/version.rb

@@ -1,3 +1,3 @@
 module Cubicle
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/test/cubicle/duration_test.rb

@@ -1,47 +1,69 @@
-require "test_helper"
-
-class DurationTest < ActiveSupport::TestCase
-  context "Querying a cubicle with durations" do
-    setup do
-      #record 1, ms1 = 1/1/2000, ms2 = 1/2/2000, ms3=1/4/2000
-      #record 2, ms1 = 1/1/2000, ms2 = 1/3/2000, ms3=1/5/2000
-      Defect.create_duration_test_data
-    end
-    should "correctly calculate durations for each activity" do
-      results = DefectCubicle.query do
-        select :all
-        by :operator
-      end
-      a1 = results["a"][0]
-      a2 = results["b"][0]
-
-      assert_equal 1 * 60 * 60 * 24, a1["ms1_to_ms2_average"]
-      assert_equal 2 * 60 * 60 * 24, a1["ms2_to_ms3_sum"]
-      assert_equal 3,                a1["total_duration"]
-
-      assert_equal 2 * 60 * 60 * 24, a2["ms1_to_ms2_average"]
-      assert_equal 2 * 60 * 60 * 24, a2["ms2_to_ms3_sum"]
-      assert_equal 4,                a2["total_duration"]
-    end
-     should "correctly aggregate durations" do
-      results = DefectCubicle.query do
-        select :all_measures, :product
-      end
-      results = results[0]
-
-      assert_equal 1.5 * 60 * 60 * 24, results["ms1_to_ms2_average"]
-      assert_equal 4 * 60 * 60 * 24,   results["ms2_to_ms3_sum"]
-      assert_equal 3.5,                results["total_duration"]
-
-     end
-    should "respect the condition argument" do
-      results = DefectCubicle.query do
-        select :all_measures, :product
-      end
-      results = results[0]
-
-      assert_equal 3, results["conditional_duration"]
-    end
-  end
-
+require "test_helper"
+
+class DurationTest < ActiveSupport::TestCase
+  context "Querying a cubicle with durations" do
+    setup do
+      #record 1, ms1 = 1/1/2000, ms2 = 1/2/2000, ms3=1/4/2000
+      #record 2, ms1 = 1/1/2000, ms2 = 1/3/2000, ms3=1/5/2000
+      Defect.create_duration_test_data
+    end
+    should "correctly calculate durations for each activity" do
+      results = DefectCubicle.query do
+        select :all
+        by :operator
+      end
+      a1 = results["a"][0]
+      a2 = results["b"][0]
+
+      assert_equal 1 * 60 * 60 * 24, a1["ms1_to_ms2_average"]
+      assert_equal 2 * 60 * 60 * 24, a1["ms2_to_ms3_sum"]
+      assert_equal 3,                a1["total_duration"]
+
+      assert_equal 2 * 60 * 60 * 24, a2["ms1_to_ms2_average"]
+      assert_equal 2 * 60 * 60 * 24, a2["ms2_to_ms3_sum"]
+      assert_equal 4,                a2["total_duration"]
+    end
+    should "correctly aggregate durations" do
+      results = DefectCubicle.query do
+        select :all_measures, :product
+      end
+      results = results[0]
+
+      assert_equal 1.5 * 60 * 60 * 24, results["ms1_to_ms2_average"]
+      assert_equal 4 * 60 * 60 * 24,   results["ms2_to_ms3_sum"]
+      assert_equal 3.5,                results["total_duration"]
+
+    end
+    should "respect the condition argument" do
+      results = DefectCubicle.query do
+        select :all_measures, :product
+      end
+      results = results[0]
+
+      assert_equal 3, results["conditional_duration"]
+    end
+    should "calculate duration_since via elapsed" do
+      Time.now = "1/10/2000"
+      results = DefectCubicle.query do
+        select :all_measures, :product
+      end
+      puts results.inspect
+      results = results[0]
+
+      assert_equal((6+5)/2.0, results["ms3_to_now_average"])
+
+    end
+    should "calculate named duration_since via age_since" do
+      Time.now = "1/10/2000"
+      results = DefectCubicle.query do
+        select :all_measures, :product
+      end
+      puts results.inspect
+      results = results[0]
+
+      assert_equal((6+5)/2.0, results["avg_time_since_ms3"])
+
+    end
+  end
+
 end

data/test/cubicles/defect_cubicle.rb

@@ -1,32 +1,34 @@
-class DefectCubicle
-  extend Cubicle::Aggregation
-
-  date       :manufacture_date,  :field_name=>'manufacture_date', :alias=>:date
-  dimension  :month,             :expression=>'this.manufacture_date.substring(0,7)'
-  dimension  :year,              :expression=>'this.manufacture_date.substring(0,4)'
-
-  dimension  :manufacture_time
-
-  dimension  :product,           :field_name=>'product.name'
-  dimension  :region,            :field_name=>'plant.address.region'
-
-  dimensions :operator, :outcome
-
-  count :total_defects,          :field_name=>'defect_id'
-  count :preventable_defects,    :expression=>'this.root_cause != "act_of_god"'
-  sum   :total_cost,             :field_name=>'cost'
-  avg   :avg_cost,               :field_name=>'cost'
-
-  #calculated fields
-  ratio :preventable_pct,  :preventable_defects, :total_defects
-
-  #durations
-  average_duration :ms1 => :ms2
-  total_duration :ms2 => :ms3
-  duration :total_duration, :ms1 => :ms3, :in=>:days
-  duration :conditional_duration, :ms1 => :ms3, :in=>:days, :condition=>"this.defect_id != 2"
-
-  #pre-cached aggregations
-  aggregation :month, :year, :product
-  aggregation :month, :region
+class DefectCubicle
+  extend Cubicle::Aggregation
+
+  date       :manufacture_date,  :field_name=>'manufacture_date', :alias=>:date
+  dimension  :month,             :expression=>'this.manufacture_date.substring(0,7)'
+  dimension  :year,              :expression=>'this.manufacture_date.substring(0,4)'
+
+  dimension  :manufacture_time
+
+  dimension  :product,           :field_name=>'product.name'
+  dimension  :region,            :field_name=>'plant.address.region'
+
+  dimensions :operator, :outcome
+
+  count :total_defects,          :field_name=>'defect_id'
+  count :preventable_defects,    :expression=>'this.root_cause != "act_of_god"'
+  sum   :total_cost,             :field_name=>'cost'
+  avg   :avg_cost,               :field_name=>'cost'
+
+  #calculated fields
+  ratio :preventable_pct,  :preventable_defects, :total_defects
+
+  #durations
+  average_duration :ms1 => :ms2
+  total_duration :ms2 => :ms3
+  duration  :total_duration, :ms1 => :ms3, :in=>:days
+  duration  :conditional_duration, :ms1 => :ms3, :in=>:days, :condition=>"this.defect_id != 2"
+  elapsed   :ms3, :in=>:days
+  age_since :avg_time_since_ms3, :ms3, :in=>:days
+
+  #pre-cached aggregations
+  aggregation :month, :year, :product
+  aggregation :month, :region
 end