split 0.6.3 → 0.6.4

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+bundler_args: ''
 rvm:
   - 1.8.7
   - 1.9.2
@@ -13,6 +14,8 @@ rvm:
 matrix:
   allow_failures:
     - rvm: ruby-head
+    - rvm: rbx-18mode
+    - rvm: rbx-19mode
   exclude:
     - rvm: 1.8.7
       gemfile: gemfiles/4.0.gemfile

data/CHANGELOG.mdown

@@ -1,3 +1,19 @@
+## 0.6.4 (August 8, 2013)
+
+Features:
+
+  - Add hooks for experiment deletion and resetting (@craigmcnamara, #198)
+  - Allow Split::Helper to be used outside of a controller (@nfm, #190)
+  - Show current Rails/Rack Env in dashboard (@rceee, #187)
+
+Bugfixes:
+
+  - Fix whiplash algorithm when using goals (@swrobel, #193)
+
+Misc:
+
+  - Refactor dashboard js (@buddhamagnet)
+
 ## 0.6.3 (July 8, 2013)
 
 Features:

data/README.mdown

@@ -247,6 +247,19 @@ def log_trial_complete(trial)
 end
 ```
 
+### Experiment Hooks
+
+You can assign a proc that will be called when an experiment is reset or deleted. You can use these hooks to call methods within your application to keep data related to experiments in sync with Split.
+
+For example:
+
+``` ruby
+Split.configure do |config|
+  config.on_experiment_reset  = proc{ |experiment| # Do something on reset }
+  config.on_experiment_delete = proc{ |experiment| # Do something else on delete }
+end
+```
+
 ## Web Interface
 
 Split comes with a Sinatra-based front end to get an overview of how your experiments are doing.
@@ -551,7 +564,7 @@ Users may also write their own algorithms. The default algorithm may be specifie
 
   - [Split::Export](http://github.com/andrew/split-export) - easily export ab test data out of Split
   - [Split::Analytics](http://github.com/andrew/split-analytics) - push test data to google analytics
-  - [Split::Mongoid](https://github.com/MongoHQ/split-mongoid) - store data in mongoid instead of redis
+  - [Split::Mongoid](https://github.com/MongoHQ/split-mongoid) - store experiment data in mongoid (still uses redis)
 
 ## Screencast
 

data/lib/split/algorithms/whiplash.rb

@@ -10,26 +10,26 @@ module Split
       end
 
       private
-      
+
       def self.arm_guess(participants, completions)
         a = [participants, 0].max
         b = [participants-completions, 0].max
         s = SimpleRandom.new; s.set_seed; s.beta(a+fairness_constant, b+fairness_constant)
       end
-      
+
       def self.best_guess(alternatives)
         guesses = {}
-        alternatives.each do |alternative| 
-          guesses[alternative.name] = arm_guess(alternative.participant_count, alternative.completed_count) 
+        alternatives.each do |alternative|
+          guesses[alternative.name] = arm_guess(alternative.participant_count, alternative.all_completed_count)
         end
         gmax = guesses.values.max
         best = guesses.keys.select {|name| guesses[name] ==  gmax }
         return best.sample
       end
-      
+
       def self.fairness_constant
         7
       end
     end
   end
-end
+end

data/lib/split/configuration.rb

@@ -14,6 +14,8 @@ module Split
     attr_accessor :store_override
     attr_accessor :on_trial_choose
     attr_accessor :on_trial_complete
+    attr_accessor :on_experiment_reset
+    attr_accessor :on_experiment_delete
 
     attr_reader :experiments
 
@@ -161,6 +163,8 @@ module Split
       @ignore_filter = proc{ |request| is_robot? || is_ignored_ip_address? }
       @db_failover = false
       @db_failover_on_db_error = proc{|error|} # e.g. use Rails logger here
+      @on_experiment_reset = proc{|experiment|}
+      @on_experiment_delete = proc{|experiment|}
       @db_failover_allow_parameter_override = false
       @allow_multiple_experiments = false
       @enabled = true

data/lib/split/dashboard.rb

@@ -16,6 +16,12 @@ module Split
 
     get '/' do
       @experiments = Split::Experiment.all
+      # Display Rails Environment mode (or Rack version if not using Rails)
+      if Object.const_defined?('Rails')
+        @current_env = Rails.env.titlecase
+      else
+        @current_env = "Rack: #{Rack.version}"
+      end
       erb :index
     end
 

data/lib/split/dashboard/public/dashboard.js

@@ -1,23 +1,19 @@
 function confirmReset() {
-  var agree=confirm("This will delete all data for this experiment?");
-  if (agree)
-    return true;
-  else
-    return false;
+  var agree = confirm("This will delete all data for this experiment?");
+  return agree ? true : false;
 }
 
 function confirmDelete() {
-  var agree=confirm("Are you sure you want to delete this experiment and all its data?");
-  if (agree)
-    return true;
-  else
-    return false;
+  var agree = confirm("Are you sure you want to delete this experiment and all its data?");
+  return agree ? true : false;
 }
 
 function confirmWinner() {
-  var agree=confirm("This will now be returned for all users. Are you sure?");
-  if (agree)
-    return true;
-  else
-    return false;
+  var agree = confirm("This will now be returned for all users. Are you sure?");
+  return agree ? true : false;
+}
+
+function confirmStep(step) {
+  var agree = confirm(step);
+  return agree ? true : false;
 }

data/lib/split/dashboard/public/style.css

@@ -75,6 +75,14 @@ body {
   color: #fff;
 }
 
+.header p.environment {
+  clear: both;
+  padding: 10px 0 0 0;
+  color: #BBB;
+  font-style: italic;
+  float: right;
+}
+
 #main {
   padding: 10px 5%;
   background: #f9f9f9;

data/lib/split/dashboard/views/layout.erb

@@ -11,6 +11,7 @@
 <body>
   <div class="header">
     <h1>Split Dashboard</h1>
+    <p class="environment"><%= @current_env %></p>
   </div>
 
   <div id="main">

data/lib/split/experiment.rb

@@ -210,6 +210,7 @@ module Split
     def reset
       alternatives.each(&:reset)
       reset_winner
+      Split.configuration.on_experiment_reset.call(self)
       increment_version
     end
 
@@ -219,6 +220,7 @@ module Split
       Split.redis.srem(:experiments, name)
       Split.redis.del(name)
       delete_goals
+      Split.configuration.on_experiment_delete.call(self)
       increment_version
     end
 

data/lib/split/helper.rb

@@ -135,14 +135,14 @@ module Split
     end
 
     def is_robot?
-      request.user_agent =~ Split.configuration.robot_regex
+      defined?(request) && request.user_agent =~ Split.configuration.robot_regex
     end
 
     def is_ignored_ip_address?
       return false if Split.configuration.ignore_ip_addresses.empty?
 
       Split.configuration.ignore_ip_addresses.each do |ip|
-        return true if request.ip == ip || (ip.class == Regexp && request.ip =~ ip)
+        return true if defined?(request) && (request.ip == ip || (ip.class == Regexp && request.ip =~ ip))
       end
       false
     end

data/lib/split/version.rb

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

data/spec/experiment_spec.rb

@@ -174,6 +174,11 @@ describe Split::Experiment do
       experiment.delete
       experiment.version.should eql(1)
     end
+
+    it "should call the on_experiment_delete hook" do
+      expect(Split.configuration.on_experiment_delete).to receive(:call)
+      experiment.delete
+    end
   end
 
 
@@ -219,6 +224,11 @@ describe Split::Experiment do
       experiment.reset
       experiment.version.should eql(1)
     end
+
+    it "should call the on_experiment_reset hook" do
+      expect(Split.configuration.on_experiment_reset).to receive(:call)
+      experiment.reset
+    end
   end
 
   describe 'algorithm' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-08 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis