split 0.6.0 → 0.6.1

data/CHANGELOG.mdown

@@ -1,3 +1,14 @@
+## 0.6.1 (May 4, 2013)
+
+Bugfixes:
+
+  - Use the specified algorithm for the experiment instead of the default (@woodhull, #165)
+
+Misc:
+
+  - Ensure experiements are valid when configuring (@ashmckenzie, #159)
+  - Allow arrays to be passed to ab_test (@fenelon, #156)
+
 ## 0.6.0 (April 4, 2013)
 
 Features:
@@ -19,7 +30,7 @@ Misc:
   - updated minimum json version requirement
   - Refactor Yaml Configuration (@rtwomey, #124)
   - Refactoring of Experiments (@iangreenleaf @tamird, #117 #118)
-  - Added more known Bots, including Pingdom, Bing, YandexBot (@julesie, @zinkkrysty)
+  - Added more known Bots, including Pingdom, Bing, YandexBot (@julesie, @zinkkrysty, @dimko)
   - Improved Readme (@iangreenleaf @phoet)
 
 ## 0.5.0 (January 28, 2013)

data/lib/split.rb

@@ -30,7 +30,7 @@ module Split
 
       @redis = Redis::Namespace.new(namespace, :redis => redis)
     elsif server.respond_to? :namespace=
-        @redis = server
+      @redis = server
     else
       @redis = Redis::Namespace.new(:split, :redis => server)
     end

data/lib/split/configuration.rb

@@ -9,10 +9,11 @@ module Split
     attr_accessor :db_failover_allow_parameter_override
     attr_accessor :allow_multiple_experiments
     attr_accessor :enabled
-    attr_accessor :experiments
     attr_accessor :persistence
     attr_accessor :algorithm
 
+    attr_reader :experiments
+
     def bots
       @bots ||= {
         # Indexers
@@ -63,6 +64,11 @@ module Split
       }
     end
 
+    def experiments= experiments
+      raise InvalidExperimentsFormatError.new('Experiments must be a Hash') unless experiments.respond_to?(:keys)
+      @experiments = experiments
+    end
+
     def disabled?
       !enabled
     end

data/lib/split/exceptions.rb

@@ -1,4 +1,5 @@
 module Split
   class InvalidPersistenceAdapterError < StandardError; end
   class ExperimentNotFound < StandardError; end
-end
+  class InvalidExperimentsFormatError < StandardError; end
+end

data/lib/split/experiment.rb

@@ -166,7 +166,7 @@ module Split
 
     def random_alternative
       if alternatives.length > 1
-        Split.configuration.algorithm.choose_alternative(self)
+        algorithm.choose_alternative(self)
       else
         alternatives.first
       end

data/lib/split/helper.rb

@@ -6,6 +6,11 @@ module Split
         puts 'WARNING: You should always pass the control alternative through as the second argument with any other alternatives as the third because the order of the hash is not preserved in ruby 1.8'
       end
 
+      # Check if array is passed to ab_test: ab_test('name', ['Alt 1', 'Alt 2', 'Alt 3'])
+      if control.is_a? Array and alternatives.length.zero?
+        control, alternatives = control.first, control[1..-1]
+      end
+
       begin
       experiment_name_with_version, goals = normalize_experiment(metric_descriptor)
       experiment_name = experiment_name_with_version.to_s.split(':')[0]

data/lib/split/trial.rb

@@ -6,7 +6,7 @@ module Split
     def initialize(attrs = {})
       self.experiment = attrs[:experiment]  if !attrs[:experiment].nil?
       self.alternative = attrs[:alternative] if !attrs[:alternative].nil?
-      self.goals = attrs[:goals] if !attrs[:goals].nil?
+      self.goals = attrs[:goals].nil? ? [] : attrs[:goals]
     end
 
     def alternative

data/lib/split/version.rb

@@ -1,6 +1,6 @@
 module Split
   MAJOR   = 0
   MINOR   = 6
-  PATCH   = 0
+  PATCH   = 1
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/spec/configuration_spec.rb

@@ -120,20 +120,44 @@ describe Split::Configuration do
     end
 
     context "as symbols" do
-      before do
-        experiments_yaml = <<-eos
-          :my_experiment:
-            :alternatives:
-              - Control Opt
-              - Alt One
-              - Alt Two
-            :resettable: false
-          eos
-        @config.experiments = YAML.load(experiments_yaml)
+
+      context "with valid YAML" do
+        before do
+          experiments_yaml = <<-eos
+            :my_experiment:
+              :alternatives:
+                - Control Opt
+                - Alt One
+                - Alt Two
+              :resettable: false
+            eos
+          @config.experiments = YAML.load(experiments_yaml)
+        end
+
+        it "should normalize experiments" do
+          @config.normalized_experiments.should == {:my_experiment=>{:alternatives=>["Control Opt", ["Alt One", "Alt Two"]]}}
+        end
       end
 
-      it "should normalize experiments" do
-        @config.normalized_experiments.should == {:my_experiment=>{:alternatives=>["Control Opt", ["Alt One", "Alt Two"]]}}
+      context "with invalid YAML" do
+
+        let(:yaml) { YAML.load(input) }
+
+        context "with an empty string" do
+          let(:input) { '' }
+
+          it "should raise an error" do
+            expect { @config.experiments = yaml }.to raise_error(/Experiments must be a Hash/)
+          end
+        end
+
+        context "with just the YAML header" do
+          let(:input) { '---' }
+
+          it "should raise an error" do
+            expect { @config.experiments = yaml }.to raise_error(/Experiments must be a Hash/)
+          end
+        end
       end
     end
   end

data/spec/experiment_spec.rb

@@ -139,6 +139,15 @@ describe Split::Experiment do
       e.should == experiment
       e.algorithm.should == Split::Algorithms::Whiplash
     end
+    
+    it "should persist a new experiment in redis, that does not exist in the configuration file" do
+      experiment = Split::Experiment.new('foobar', :alternatives => ['tra', 'la'], :algorithm => Split::Algorithms::Whiplash)
+      experiment.save
+
+      e = Split::Experiment.find('foobar')
+      e.should == experiment
+      e.alternatives.collect{|a| a.name}.should == ['tra', 'la']
+    end
   end
 
   describe 'deleting' do
@@ -230,7 +239,8 @@ describe Split::Experiment do
     end
 
     it "should use the specified algorithm if a winner does not exist" do
-      Split.configuration.algorithm.should_receive(:choose_alternative).and_return(Split::Alternative.new('green', 'link_color'))
+      experiment.algorithm = Split::Algorithms::Whiplash
+      experiment.algorithm.should_receive(:choose_alternative).and_return(Split::Alternative.new('green', 'link_color'))
       experiment.next_alternative.name.should eql('green')
     end
   end

data/spec/helper_spec.rb

@@ -15,6 +15,10 @@ describe Split::Helper do
       lambda { ab_test('xyz', '1', '2', '3') }.should_not raise_error
     end
 
+    it "should not raise an error when passed an array for alternatives" do
+      lambda { ab_test('xyz', ['1', '2', '3']) }.should_not raise_error
+    end
+
     it "should raise the appropriate error when passed integers for alternatives" do
       lambda { ab_test('xyz', 1, 2, 3) }.should raise_error(ArgumentError)
     end
@@ -801,8 +805,7 @@ describe Split::Helper do
     end
 
     it "fails gracefully if config is missing" do
-      Split.configuration.experiments = nil
-      lambda { ab_test :my_experiment }.should raise_error(/not found/i)
+      lambda { Split.configuration.experiments = nil }.should raise_error(/Experiments must be a Hash/)
     end
 
     it "fails gracefully if config is missing alternatives" do

data/spec/trial_spec.rb

@@ -8,6 +8,7 @@ describe Split::Trial do
     trial = Split::Trial.new(:experiment => experiment, :alternative => alternative)
     trial.experiment.should == experiment
     trial.alternative.should == alternative
+    trial.goals.should == []
   end
 
   describe "alternative" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-04 00:00:00.000000000 Z
+date: 2013-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70363788679740 !ruby/object:Gem::Requirement
+  requirement: &70334741839320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70363788679740
+  version_requirements: *70334741839320
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &70363788691860 !ruby/object:Gem::Requirement
+  requirement: &70334741851360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70363788691860
+  version_requirements: *70334741851360
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70363788708940 !ruby/object:Gem::Requirement
+  requirement: &70334741849020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *70363788708940
+  version_requirements: *70334741849020
 - !ruby/object:Gem::Dependency
   name: simple-random
-  requirement: &70363788722360 !ruby/object:Gem::Requirement
+  requirement: &70334741846920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70363788722360
+  version_requirements: *70334741846920
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70363788720900 !ruby/object:Gem::Requirement
+  requirement: &70334741860380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70363788720900
+  version_requirements: *70334741860380
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70363788716120 !ruby/object:Gem::Requirement
+  requirement: &70334741859480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70363788716120
+  version_requirements: *70334741859480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70363788729360 !ruby/object:Gem::Requirement
+  requirement: &70334741857740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '2.12'
   type: :development
   prerelease: false
-  version_requirements: *70363788729360
+  version_requirements: *70334741857740
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70363788751640 !ruby/object:Gem::Requirement
+  requirement: &70334741856560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: '0.6'
   type: :development
   prerelease: false
-  version_requirements: *70363788751640
+  version_requirements: *70334741856560
 description: 
 email:
 - andrewnez@gmail.com