@@ -3,14 +3,29 @@ module Vanity # Base class that all experiment types are derived from. class Base - def initialize(name, &block) - @name = name.to_s - @namespace = "#{Vanity.playground.namespace}:experiments:#{name.downcase.gsub(/\W/, "_")}" + + class << self + # Type is a symbol derived from class name (e.g. AbTest becomes ab_test). + def type + name.split("::").last.gsub(/([a-z])([A-Z])/) { "#{$1}_#{$2}" }.gsub(/([A-Z])([A-Z][a-z])/) { "#{$1}_#{$2}" }.downcase + end + end + + def initialize(id, name, &block) + @id, @name = id.to_sym, name + @namespace = "#{Vanity.playground.namespace}:experiments:#{@id}" created = redis.get(key(:created_at)) || (redis.setnx(key(:created_at), Time.now.to_i) ; redis.get(key(:created_at))) @created_at = Time.at(created.to_i) end - attr_reader :name, :created_at + # Human readable experiment name, supplied during creation. + attr_reader :name + + # Unique identifier, derived from name, e.g. "Green Button" become :green_button. + attr_reader :id + + # Time stamp when experiment first created in database. + attr_reader :created_at # Sets of returs description. For example # experiment :simple do @@ -26,6 +41,10 @@ module Vanity def save #:nodoc: end + def type + self.class.name.split("::").last.gsub(/([a-z])([A-Z])/) { "#{$1}_#{$2}" }.gsub(/([A-Z])([A-Z][a-z])/) { "#{$1}_#{$2}" }.downcase + end + protected # Returns key for this experiment or with additional name, e.g. lib/vanity/experiment/base.rb @@ -26,20 +26,15 @@ module Vanity # Defines a new experiment. Generally, do not call this directly, # use #experiment instead. def define(name, options = nil, &block) - name = name.to_s.downcase.gsub(/\W/, "_") - raise "Experiment #{name} already defined once" if @experiments[name] - yaml = redis.get("#{namespace}:experiments:#{name}") - if yaml - experiment = YAML.load(yaml) - else - options ||= {} - type = options[:type] || :ab_test - klass = Experiment.const_get(type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }) - experiment = klass.new(name) - end + id = name.to_s.downcase.gsub(/\W/, "_") + raise "Experiment #{id} already defined once" if @experiments[id] + options ||= {} + type = options[:type] || :ab_test + klass = Experiment.const_get(type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }) + experiment = klass.new(id, name) experiment.instance_eval &block experiment.save - @experiments[name] = experiment + @experiments[id] = experiment end # Returns the named experiment. You may not have guessed, but this method @@ -49,11 +44,11 @@ module Vanity # non-word characters with underscores, so "Green call to action" becomes # "green_call_to_action". You can also use a symbol if you feel like it. def experiment(name) - name = name.to_s.downcase.gsub(/\W/, "_") - unless @experiments.has_key?(name) - require "experiments/#{name}" + id = name.to_s.downcase.gsub(/\W/, "_") + unless @experiments.has_key?(id) + require "experiments/#{id}" end - @experiments[name] or fail LoadError, "Expected experiments/#{name}.rb to define experiment #{name}" + @experiments[id] or fail LoadError, "Expected experiments/#{id}.rb to define experiment #{name}" end end lib/vanity/playground.rb @@ -1,6 +1,25 @@ 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 + 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 + expects(:save) + end + end + it "stores when experiment created" do experiment(:simple) { } assert_instance_of Time, experiment(:simple).created_at test/experiment_test.rb @@ -49,9 +49,11 @@ class PlaygroundTest < MiniTest::Spec 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") { } + Vanity.playground.define "Green Button" do + def xmts ; "x" ; end + end end - assert_equal "green_button", experiment("Green button").name + assert_equal "x", experiment("Green button").xmts end it "can define and access experiment using symbol" do @@ -68,19 +70,6 @@ class PlaygroundTest < MiniTest::Spec end end - it "evalutes definition block when creating experiment" 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 - expects(:save) - end - end - it "uses playground namespace in experiment" do experiment(:green_button) { } assert_equal "#{@namespace}:experiments:green_button", experiment(:green_button).send(:key) test/playground_test.rb db700f0bd2d80cb7b71ff6ced983cf079f4c6fea Assaf Arkin assaf@labnotes.org http://github.com/assaf/vanity/commit/99af2d50692c8f5de90496a95c4cdcde53f5f951 99af2d50692c8f5de90496a95c4cdcde53f5f951 2009-11-06T18:09:02-08:00 2009-11-06T18:03:15-08:00 Separating experiment name & experiment ID. 8d75dad7fe322180de75a581f90ffff96fb401f0 Assaf Arkin assaf@labnotes.org