modesty 0.1.0

data/spec/identity_spec.rb

@@ -0,0 +1,161 @@
+require 'modesty'
+
+describe Modesty, "Working with identities" do
+  before :each do
+    @id = rand 10**10
+  end
+
+  it "can make an identity" do
+    Modesty.identify! @id
+    Modesty.identity.should == @id
+  end
+
+  it "can identify as nil" do
+    Modesty.identify! nil
+    Modesty.identity.should be_nil
+  end
+
+  it "can't identify as anything other than a Fixnum or nil." do
+    lambda do
+      Modesty.identify! "foo"
+    end.should raise_error(Modesty::IdentityError)
+  end
+
+  after :all do
+    Modesty.instance_variable_set("@identity", nil)
+  end
+end
+
+describe Modesty, "contextual identity" do
+  before :each do
+    Modesty.experiments.clear
+    Modesty.metrics.clear
+    Modesty.data.flushdb
+
+    Modesty.new_metric :donation_amount do |m|
+      m.submetric :birthday_wish
+    end
+    Modesty.new_metric :donation
+    Modesty.new_metric :creation
+
+    Modesty.new_experiment :creation_page do |e|
+      e.metric :creation
+      e.metric :donation, :as => :creator
+      e.metric :donation_amount, :as => :creator
+    end
+    @e = Modesty.experiments[:creation_page]
+    Modesty.identify! nil
+
+    @e.chooses :experiment, :for => 500
+    @e.chooses :control, :for => 600
+    @e.chooses :experiment, :for => 700
+    @group_exp = Modesty.metrics[:donation_amount/:creation_page/:experiment]
+    @group_ctrl = Modesty.metrics[:donation_amount/:creation_page/:control]
+  end
+
+  it "leaves the other metrics alone" do
+    Modesty.with_identity 700 do
+      @e.group.should == :experiment
+      Modesty.track! :creation
+    end
+
+    m = Modesty.metrics[:creation/:creation_page/:experiment]
+    m.distribution.should == {1 => 1}
+  end
+
+  it "expects a passed-in identity for the specified metrics" do
+    Modesty.identify! 700
+    lambda do
+      Modesty.track! :donation
+    end.should raise_error(Modesty::IdentityError)
+  end
+
+  it "aggregates counts by the contextual identity's experiment group" do
+    Modesty.with_identity 600 do
+      lambda do
+        #user 600 donated 10 bucks to user 700's birthday wish!
+        Modesty.track! :donation_amount, 10, :with => {:creator => 700}
+      end.should_not raise_error
+    end
+    @group_exp.distribution.should == {10 => 1}
+    @group_ctrl.distribution.should == {}
+
+    @e.chooses :experiment, :for => 500
+    #user 500 donated 2000 to 600's wish
+    Modesty.with_identity 500 do
+      Modesty.track! :donation_amount, 2000, :with => {:creator => 600}
+    end
+
+    @group_exp.distribution.should == {10 => 1}
+    @group_ctrl.distribution.should == {2000 => 1}
+  end
+
+  describe "with some data" do
+    before :each do
+      Modesty.data.flushdb
+
+      # users 500 and 700 hit the experiment
+      @e.chooses :experiment, :for => 700
+      @e.chooses :control, :for => 500
+
+      # user 600, who is in the control group, donates $45 to user 700's wish
+      Modesty.with_identity 600 do
+        Modesty.track! :donation_amount, 45, :with => {:creator => 700}
+      end
+
+      # user 500, who is in the experiment group, donates $30 to user 700's wish
+      Modesty.with_identity 500 do
+        Modesty.track! :donation_amount/:birthday_wish, 30, :with => {:creator => 700}
+      end
+
+      # a guest donates $15 to user 700's wish
+      Modesty.with_identity nil do
+        Modesty.track! :donation_amount, 15, :with => {:creator => 700}
+      end
+    end
+
+    it "knows its experiment" do
+      @group_exp.experiment.should == @e
+    end
+
+    it "aggregates work" do
+      @group_exp.aggregate_by(:creators).should == {700 => 90}
+      @group_ctrl.aggregate_by(:creators).should == {}
+    end
+
+    it "distributions work" do
+      @group_exp.distribution_by(:creator).should == {90 => 1}
+      @group_ctrl.distribution_by(:creator).should == {}
+    end
+
+    it "defaults to the given param as identity" do
+      @group_exp.aggregate.should == @group_exp.aggregate_by(:creator)
+      @group_exp.distribution.should == @group_exp.distribution_by(:creator)
+    end
+
+    it "all, unique, and unidentified_users work" do
+      @group_exp.all(:creators).should == [700]
+      @group_exp.all(:users).sort.should == [500, 600]
+      @group_exp.data.unidentified_users.should == 1
+    end
+
+    it "aggregates and distributes on the experiment" do
+      @e.aggregates(:donation_amount).should == {
+        :experiment => {
+          700 => 90
+        },
+        :control => {
+          500 => 0,
+        }
+      }
+      @e.distributions(:donation_amount).should == {
+        :experiment => {
+          90 => 1,
+        },
+        :control => {
+          0 => 1
+        }
+      }
+    end
+  end
+end

data/spec/load_spec.rb

@@ -0,0 +1,87 @@
+require 'modesty'
+
+describe "the config file" do
+  before :all do
+    Modesty.root = File.join(
+      Modesty::TEST,
+      'myapp',
+      'modesty'
+    )
+    Modesty.environment = 'test'
+    Modesty.load_config!
+  end
+
+  it "can set the metrics directory" do
+    Modesty.metrics_dir.should ==
+      File.expand_path(
+        File.join(
+          File.dirname(__FILE__),
+          "../test/myapp/modesty/metrics"
+        )
+      )
+  end
+
+  after :all do
+    Modesty.root = nil
+  end
+end
+
+describe "loading metrics" do
+  before :all do
+    Modesty.root = File.join(
+      Modesty::TEST,
+      'myapp'
+    )
+
+    Modesty.environment = 'test'
+    Modesty.metrics.clear
+  end
+
+  it "can load metrics" do
+    lambda do
+      Modesty.load_all_metrics!
+    end.should_not raise_error
+  end
+
+  it "doesn't try to load directories" do
+    lambda do
+      Modesty.load_all_metrics!
+    end.should_not raise_error(Errno::EISDIR)
+  end
+
+  it "actually loads the metrics" do
+    [
+      :baked_goods,
+      :baked_goods/:cookies,
+      :baked_goods/:brownies,
+      :baked_goods/:cake,
+      :baked_goods/:cake/:chocolate,
+      :baked_goods/:cake/:ice_cream,
+    ].each do |m|
+      Modesty.metrics.should include m
+    end
+  end
+
+  after :all do
+    Modesty.root = nil
+  end
+end
+
+describe "Loading experiments" do
+  before :all do
+    Modesty.environment = 'test'
+    Modesty.metrics.clear
+    Modesty.experiments.clear
+    Modesty.load_all_metrics!
+  end
+
+  it "can load experiments" do
+    lambda do
+      Modesty.load_all_experiments!
+    end.should_not raise_error
+  end
+
+  it "actually loads experiments" do
+    Modesty.experiments.should include :cookbook
+  end
+end

data/spec/metric_spec.rb

@@ -0,0 +1,176 @@
+require 'modesty'
+
+describe Modesty::Metric, "Creating Metrics" do
+  before :each do
+    Modesty.set_store :redis, :mock => true
+    Modesty.metrics.clear
+  end
+
+  it "can create a metric without a block" do
+    m = Modesty.new_metric(:foo)
+    m.slug.should == :foo
+    Modesty.metrics[:foo].should == m
+  end
+
+  it "can create a metric with a block" do
+    m = Modesty.new_metric :foo do |m|
+      m.description "Foo"
+    end
+    m.slug.should == :foo
+    m.description.should == "Foo"
+    Modesty.metrics[:foo].should == m
+  end
+
+  it "can create submetrics" do
+    Modesty.new_metric :foo do |foo|
+      foo.description "Foo"
+
+      foo.submetric :bar do |bar|
+        bar.description "Bar"
+
+        bar.submetric :baz do |baz|
+          baz.description "Baz"
+        end
+      end
+    end
+
+    Modesty.metrics.should include :foo
+    Modesty.metrics.should include :foo/:bar
+    Modesty.metrics.should include :foo/:bar/:baz
+
+    Modesty.metrics[:foo].parent.should == nil
+    Modesty.metrics[:foo/:bar].parent.should_not == nil
+    Modesty.metrics[:foo/:bar].parent.slug.should == :foo
+    Modesty.metrics[:foo/:bar/:baz].parent.should_not == nil
+    Modesty.metrics[:foo/:bar/:baz].parent.slug.should == :foo/:bar
+  end
+end
+
+describe Modesty::Metric, "Tracking Metrics" do
+  before :each do
+    Modesty.set_store :redis, :mock => true
+    Modesty.data.flushdb
+    Modesty.metrics.clear
+    Modesty.new_metric :foo do |foo|
+      foo.description "Foo"
+
+      foo.submetric :bar do |bar|
+        bar.description "Bar"
+
+        bar.submetric :baz do |baz|
+          baz.description "Baz"
+        end
+      end
+    end
+  end
+
+  it "can track a metric" do
+    (1..100).each do |i|
+      lambda { Modesty.track! :foo }.should_not raise_error
+      Modesty.metrics[:foo].count.to_i.should == i
+    end
+  end
+
+  it "can track a metric with a count" do
+    (1..100).each do |i|
+      lambda { Modesty.track! :foo, 3 }.should_not raise_error
+      Modesty.metrics[:foo].count.to_i.should == i*3
+    end
+  end
+
+  it "can fetch a metric for a date" do
+    now = Time.now
+    Time.stub!(:now).and_return(now-1.day)
+    25.times {|i| Modesty.track! :foo}
+    Modesty.metrics[:foo].count((now-1.day).to_date).should == 25
+  end
+
+  it "can fetch a metric over a date range" do
+    now = Time.now
+    Time.stub!(:now).and_return(now-1.day)
+    25.times {|i| Modesty.track! :foo}
+    Time.stub!(:now).and_return(now)
+    50.times {|i| Modesty.track! :foo}
+    Modesty.metrics[:foo].count((now-1.day).to_date..(now.to_date)).should == [25, 50]
+  end
+
+  it "can fetch a metric over a date range as array" do
+    now = Time.now
+    Time.stub!(:now).and_return(now-1.day)
+    25.times {|i| Modesty.track! :foo}
+    Time.stub!(:now).and_return(now)
+    50.times {|i| Modesty.track! :foo}
+    Modesty.metrics[:foo].count((now-1.day).to_date, now.to_date).should == [25, 50]
+  end
+
+  it "can track one submetric" do
+    (1..100).each do |i|
+      lambda { Modesty.track! :foo/:bar }.should_not raise_error
+      Modesty.metrics[:foo].count.to_i.should == i
+      Modesty.metrics[:foo/:bar].count.to_i.should == i
+      Modesty.metrics[:foo/:bar/:baz].count.to_i.should == 0
+    end
+  end
+
+  it "can track more than one submetric" do
+    (1..100).each do |i|
+      lambda { Modesty.track! :foo/:bar/:baz }.should_not raise_error
+      Modesty.metrics[:foo].count.to_i.should == i
+      Modesty.metrics[:foo/:bar].count.to_i.should == i
+      Modesty.metrics[:foo/:bar/:baz].count.to_i.should == i
+    end
+  end
+
+  describe "can track with custom data" do
+    before :each do
+      @m = Modesty.metrics[:foo/:bar]
+      lambda do
+        Modesty.track! :foo/:bar, :with => {:zing => 56, :user => 1}
+      end.should_not raise_error
+      @m.unique(:zings).should == 1
+      @m.all(:zings).should include 56
+
+      lambda do
+        Modesty.track! :foo/:bar, :with => {:zing => 97, :user => 2}, :count => 4
+      end.should_not raise_error
+      @m.unique(:zings).should == 2
+      @m.all(:zings).should include 97
+
+      lambda do
+        Modesty.track! :foo/:bar, 7, :with => {:zing => 97}
+      end.should_not raise_error
+    end
+
+    it "and count unique" do
+      @m.unique(:zings).should == 2
+      @m.unique(:zings, :all).should == 2
+    end
+
+    it "and bucket by dates" do
+      @m.unique(:zings, Date.parse('1/1/2002')).should == 0
+    end
+
+    it "and count all" do
+      @m.all(:zings).count.should == 2
+    end
+
+
+    it "and keep an aggregate by users" do
+      @m.aggregate.should == {1 => 1, 2 => 4}
+    end
+
+    it "and keep a distribution by users" do
+      @m.distribution.should == {1 => 1, 4 => 1}
+      @m.distribution(:all).should == {1 => 1, 4 => 1}
+    end
+
+    it "and keep an aggregate by custom data" do
+      @m.aggregate_by(:zings).should == {56 => 1, 97 => 11}
+    end
+
+    it "and keep a distribution by custom data" do
+      @m.distribution_by(:zings).should == {1 => 1, 11 => 1}
+    end
+
+  end
+end

data/spec/rails_spec.rb

@@ -0,0 +1,48 @@
+require 'modesty'
+
+describe "bootstrap" do
+  before :all do
+    Modesty.data.flushdb
+    Modesty.metrics.clear
+    Modesty.experiments.clear
+
+    unless defined? Rails
+      class Rails
+        def self.root
+          File.join(
+            File.expand_path(File.dirname(__FILE__)),
+            '../test/myapp'
+          )
+        end
+
+        def self.configuration
+          self
+        end
+
+        def self.env
+          'test'
+        end
+
+        def self.after_initialize
+          yield
+        end
+      end
+    end
+
+    require 'modesty/frameworks/rails'
+  end
+
+  it "bootstraps Redis" do
+    Modesty.data.store.should be_an_instance_of Redis
+    Modesty.data.store.client.port.should == 6379
+    Modesty.data.store.client.host.should == 'localhost'
+  end
+
+  it "loads metrics" do
+    Modesty.metrics.keys.should include :baked_goods
+  end
+
+  it "loads experiments" do
+    Modesty.experiments.keys.should include :cookbook
+  end
+end