vanity 0.3.1 → 0.4.0

data/test/experiment_test.rb

@@ -1,45 +1,38 @@
 require "test/test_helper"
 
-class ExperimentTest < MiniTest::Spec
-  it "creates ID from name" do
-    exp = experiment("Green Button/Alert") { }
-    assert_equal "Green Button/Alert", exp.name
-    assert_equal :green_button_alert, exp.id
+class ExperimentTest < MiniTest::Unit::TestCase
+  def test_experiment_mapping_name_to_id
+    experiment = Vanity.playground.define("Green Button/Alert", :ab_test) { }
+    assert_equal "Green Button/Alert", experiment.name
+    assert_equal :green_button_alert, experiment.id
   end
 
-  it "evalutes definition block at creation" do
-    experiment :green_button do
-      expects(:xmts).returns("x")
-    end
-    assert_equal "x", experiment(:green_button).xmts
-  end
-
-  it "saves experiments after defining it" do
-    experiment :green_button do
+  def test_saving_experiment_after_definition
+    Vanity.playground.define :simple, :ab_test do
       expects(:save)
     end
   end
 
-  it "stores when experiment created" do
-    experiment(:simple) { }
+  def test_experiment_has_created_timestamp
+    Vanity.playground.define(:simple, :ab_test) {}
     assert_instance_of Time, experiment(:simple).created_at
     assert_in_delta experiment(:simple).created_at.to_i, Time.now.to_i, 1
   end
-
-  it "keeps creation timestamp across definitions" do
+ 
+  def test_experiment_keeps_created_timestamp_across_definitions
     early, late = Time.now - 1.day, Time.now
     Time.expects(:now).once.returns(early)
-    experiment(:simple) { }
+    Vanity.playground.define(:simple, :ab_test) {}
     assert_equal early.to_i, experiment(:simple).created_at.to_i
 
     new_playground
     Time.expects(:now).once.returns(late)
-    experiment(:simple) { }
+    Vanity.playground.define(:simple, :ab_test) {}
     assert_equal early.to_i, experiment(:simple).created_at.to_i
   end
 
-  it "has description" do
-    experiment :simple do
+  def test_experiment_has_description
+    Vanity.playground.define :simple, :ab_test do
       description "Simple experiment"
     end
     assert_equal "Simple experiment", experiment(:simple).description

data/test/experiments/age_and_zipcode.rb

@@ -1,3 +1,18 @@
-experiment "Age and Zipcode" do
-  description "Testing new registration form that asks for age and zipcode."
+ab_test "Age and Zipcode" do
+  description <<-TEXT
+Testing new registration form that asks for age and zipcode. Option A presents
+the existing form, and option B adds age and zipcode fields.
+   
+We know option B will convert less, but higher quality leads. If we lose less
+than 20% conversions, we're going to switch to option B.
+  TEXT
+
+  complete_if do
+    alternatives.all? { |alt| alt.participants > 100 }
+  end
+  outcome_is do
+    one_field = alternative(false)
+    three_fields = alternative(true)
+    three_fields.conversion_rate >= 0.8 * one_field.conversion_rate ? three_fields : one_field
+  end
 end

data/test/experiments/null_abc.rb

@@ -1,4 +1,4 @@
-experiment "Null/ABC" do
+ab_test "Null/ABC" do
   description "Testing three alternatives"
   alternatives nil, :red, :green, :blue
 end

data/test/playground_test.rb

@@ -1,67 +1,89 @@
 require "test/test_helper"
 
-class PlaygroundTest < MiniTest::Spec
-  before do
+class PlaygroundTest < MiniTest::Unit::TestCase
+  def setup
     @namespace = "vanity:0"
   end
 
-  it "has one global instance" do
+  def test_has_one_global_instance
     assert instance = Vanity.playground
     assert_equal instance, Vanity.playground
   end
 
-  it "use vanity-{major} as default namespace" do
+  def test_playground_namespace
     assert @namespace, Vanity.playground.namespace
   end
 
-  it "fails if it cannot load named experiment from file" do
-    assert_raises MissingSourceFile do
+
+  # -- Loading experiments --
+
+  def test_fails_if_cannot_load_named_experiment
+    assert_raises LoadError do
       experiment("Green button")
     end
   end
 
-  it "loads named experiment from experiments directory" do
-    Vanity.playground.expects(:require).with("experiments/green_button")
-    begin
-      experiment("Green button")
-    rescue LoadError=>ex
+  def test_loading_experiment
+    Vanity.playground.load_path = Dir.tmpdir
+    File.open File.join(Dir.tmpdir, "green_button.rb"), "w" do |f|
+      f.write <<-RUBY
+        ab_test "Green Button" do
+          def xmts
+            "x"
+          end
+        end
+      RUBY
     end
+    assert_equal "x", experiment(:green_button).xmts
   end
 
-  it "complains if experiment not defined in expected filed" do
-    Vanity.playground.expects(:require).with("experiments/green_button")
+  def test_fails_if_error_loading_experiment
+    Vanity.playground.load_path = Dir.tmpdir
+    File.open File.join(Dir.tmpdir, "green_button.rb"), "w" do |f|
+      f.write "fail 'yawn!'"
+    end
     assert_raises LoadError do
-      experiment("Green button")
+      experiment(:green_button)
     end
   end
 
-  it "returns experiment defined in file" do
-    playground = class << Vanity.playground ; self ; end
-    playground.send :define_method, :require do |file|
-      Vanity.playground.define "Green Button" do
-        def xmts ; "x" ; end
-      end
+  def test_complains_if_not_defined_where_expected
+    Vanity.playground.load_path = Dir.tmpdir
+    File.open File.join(Dir.tmpdir, "green_button.rb"), "w" do |f|
+      f.write ""
+    end
+    assert_raises LoadError do
+      experiment("Green button")
     end
-    assert_equal "x", experiment("Green button").xmts
   end
 
-  it "can define and access experiment using symbol" do
-    assert green = experiment("Green Button") { }
-    assert_equal green, experiment(:green_button)
-    assert red = experiment(:red_button) { }
-    assert_equal red, experiment("Red Button")
+  def test_reloading_experiments
+    Vanity.playground.define(:ab, :ab_test) {}
+    Vanity.playground.define(:cd, :ab_test) {}
+    assert 2, Vanity.playground.experiments.count
+    Vanity.playground.reload!
+    assert_empty Vanity.playground.experiments
   end
 
-  it "detect and fail when defining the same experiment twice" do
-    experiment("Green Button") { }
+  # -- Defining experiment --
+  
+  def test_can_access_experiment_by_name_or_id
+    exp = Vanity.playground.define(:green_button, :ab_test) { }
+    assert_equal exp, experiment("Green Button")
+    assert_equal exp, experiment(:green_button)
+  end
+
+  def test_fail_when_defining_same_experiment_twice
+    Vanity.playground.define("Green Button", :ab_test) { }
     assert_raises RuntimeError do
-      experiment(:green_button) { }
+      Vanity.playground.define("Green Button", :ab_test) { }
     end
   end
 
-  it "uses playground namespace in experiment" do
-    experiment(:green_button) { }
+  def test_uses_playground_namespace_for_experiment
+    Vanity.playground.define(:green_button, :ab_test) { }
     assert_equal "#{@namespace}:green_button", experiment(:green_button).send(:key)
     assert_equal "#{@namespace}:green_button:participants", experiment(:green_button).send(:key, "participants")
   end
+
 end

data/test/rails_test.rb

@@ -13,7 +13,7 @@ class UseVanityTest < ActionController::TestCase
   tests UseVanityController
 
   def setup
-    experiment :simple do
+    Vanity.playground.define :simple, :ab_test do
     end
     UseVanityController.class_eval do
       use_vanity :current_user

data/test/test_helper.rb

@@ -5,6 +5,7 @@ require "minitest/spec"
 require "mocha"
 require "action_controller"
 require "action_controller/test_case"
+require "initializer"
 require "lib/vanity/rails"
 MiniTest::Unit.autorun
 
@@ -31,3 +32,4 @@ end
 ActionController::Routing::Routes.draw do |map|
   map.connect ':controller/:action/:id'
 end
+Rails.configuration = Rails::Configuration.new

data/vanity.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |spec|
   spec.name           = "vanity"
-  spec.version        = "0.3.1"
+  spec.version        = "0.4.0"
   spec.author         = "Assaf Arkin"
   spec.email          = "assaf@labnotes.org"
-  spec.homepage       = "http://assaf.github.com/vanity"
+  spec.homepage       = "http://vanity.labnotes.org"
   spec.summary        = "Experience Driven Development framework for Rails"
   spec.description    = "Mirror, mirror on the wall ..."
   spec.post_install_message = "To get started run vanity --help"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vanity
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Assaf Arkin
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-13 00:00:00 -08:00
+date: 2009-11-19 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -29,14 +29,15 @@ files:
 - lib/vanity/experiment/ab_test.rb
 - lib/vanity/experiment/base.rb
 - lib/vanity/playground.rb
-- lib/vanity/rails/console.rb
+- lib/vanity/rails/dashboard.rb
 - lib/vanity/rails/helpers.rb
 - lib/vanity/rails/testing.rb
 - lib/vanity/rails.rb
 - lib/vanity/templates/_ab_test.erb
+- lib/vanity/templates/_experiment.erb
 - lib/vanity/templates/_experiments.erb
 - lib/vanity/templates/_report.erb
-- lib/vanity/templates/_vanity.css
+- lib/vanity/templates/vanity.css
 - lib/vanity.rb
 - vendor/redis-0.1/lib/dist_redis.rb
 - vendor/redis-0.1/lib/hash_ring.rb
@@ -61,13 +62,13 @@ files:
 - README.rdoc
 - vanity.gemspec
 has_rdoc: true
-homepage: http://assaf.github.com/vanity
+homepage: http://vanity.labnotes.org
 licenses: []
 
 post_install_message: To get started run vanity --help
 rdoc_options: 
 - --title
-- Vanity 0.3.1
+- Vanity 0.4.0
 - --main
 - README.rdoc
 - --webcvs

data/lib/vanity/rails/console.rb

@@ -1,14 +0,0 @@
-module Vanity
-  module Rails
-    module ConsoleActions
-      def index
-        render Vanity.template("_report"), content_type: Mime::HTML, layout: true
-      end
-
-      def chooses
-        experiment(params[:e]).chooses(experiment(params[:e]).alternatives[params[:a].to_i].value)
-        redirect_to :back
-      end
-    end
-  end
-end

data/lib/vanity/templates/_vanity.css

@@ -1,13 +0,0 @@
-<style>
-  .vanity .experiments { list-style: none; margin: 0; padding: 0 }
-  .vanity .experiment { padding-bottom: 1em; margin: 0 0 1em 0; border-bottom: 1px dashed #ddd }
-  .vanity .experiment .type { margin-left: .3em; color: #bbb; font-size: .8em; font-weight: normal }
-  .vanity .experiment table { border-collapse: collapse; table-layout: fixed; width: 100%; border-bottom: 1px solid #ccc; margin: 1em 0 0 0 }
-  .vanity .experiment td { padding: .5em; border-top: 1px solid #ccc }
-  .vanity .experiment .choice td { font-weight: bold; background: #f0f0f8 }
-  .vanity .experiment td.option { width: 5em; white-space: nowrap; overflow: hidden }
-  .vanity .experiment td.value { width: 8em; white-space: nowrap; overflow: hidden }
-  .vanity .experiment td.action { width: 6em; overflow: hidden; text-align: center }
-  .vanity .experiment caption { caption-side: bottom; padding: .5em; background: transparent; margin-bottom: 1em; text-align: left }
-  .vanity .experiment .meta { color: #444; font-style: italic }
-</style>