split 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea348c09640ba8869242588929d2d337856fc834
-  data.tar.gz: 0bb555acfabcaf683051058097da01b803c56a50
+  metadata.gz: b771c2496cd674b0512e956fcdb3bf67768ba4a8
+  data.tar.gz: cd3ac62720dbaa5968d58be74ebc689854fd0fac
 SHA512:
-  metadata.gz: f411a5636ee2fcc0c296f2e3e1e24515af7524be73eec1fe8bd86998564eb61fcc60419d52dc02588a92ac85ecb28c6525e9a007cc5607efe1942a56c1fa3262
-  data.tar.gz: 6ff0d6a3be6295653be81d34e0c2479c2d38bd8e1ac6a2fb0aa20e5796329add32cf465b884d5ede25ba9121343ae888de62e78f9aff5e468604f635c2efabb6
+  metadata.gz: f94c6eca1509241995790fefc2407ae8cdc546ceae8aad2a4fa4975c47dd4370f5cc835b630a9c91a1cd7682a24bf49c34af422a31f576af70162003717f396e
+  data.tar.gz: 9e47de4c77fa41c39d525c2c79448c3d1e5fdc564dfa340d00857a91cedd11517fc3e871b7f4bb208eab9a5dfe29e2a026dcd40139569d471e146d68bfbc982c

data/.travis.yml

@@ -1,11 +1,12 @@
 language: ruby
 rvm:
-  - 2.1.5
+  - 2.2.0
 
 gemfile:
   - gemfiles/3.2.gemfile
   - gemfiles/4.0.gemfile
   - gemfiles/4.1.gemfile
+  - gemfiles/4.2.gemfile
 
 services:
    - redis-server

data/Appraisals

@@ -1,11 +1,15 @@
 appraise "3.2" do
-  gem "rails", "~> 3.2.13"
+  gem "rails", "~> 3.2.21"
 end
 
 appraise "4.0" do
-  gem "rails", "~> 4.0.12"
+  gem "rails", "~> 4.0.13"
 end
 
 appraise "4.1" do
-  gem "rails", "~> 4.1.8"
+  gem "rails", "~> 4.1.10"
+end
+
+appraise "4.2" do
+  gem "rails", "~> 4.2.1"
 end

data/CHANGELOG.md

@@ -1,5 +1,41 @@
+## 1.2.1 (May 17th, 2015)
+
+Features
+
+ - Handle redis DNS resolution failures gracefully (@fusion2004, #310)
+ - Push metadata to ab_test block (@ekorneeff, #296)
+ - Helper methods are now private when included in controllers (@ipoval, #303)
+
+Bugfixes:
+
+ - Return an empty hash as metadata when Split is disabled (@tomasdundacek, #313)
+ - Don't use capture helper from ActionView (@tomasdundacek, #312)
+
+Misc:
+
+ - Remove body "max-width" from dashboard (@xicreative, #299)
+ - fix private for class methods (@ipoval, #301)
+ - minor memoization fix in spec (@ipoval, #304)
+ - Minor documentation fixes (#295, #297, #305, #308)
+
+## 1.2.0 (January 24th, 2015)
+
+Features
+
+  - Configure redis using environment variables if available (@saratovsource , #293)
+  - Store metadata on experiment configuration (@dekz, #291)
+
+Bugfixes:
+
+ - Revert the Trial#complete! public API to support noargs (@dekz, #292)
+
 ## 1.1.0 (January 9th, 2015)
 
+Changes:
+
+  - Public class methods on `Split::Experiment` (e.g., `find_or_create`)
+    have been moved to `Split::ExperimentCatalog`.
+
 Features:
 
   - Decouple trial from Split::Helper (@joshdover, #286)

data/README.md

@@ -1,4 +1,4 @@
-# Split
+# [Split](http://libraries.io/rubygems/split)
 
 Split is a rack based ab testing framework designed to work with Rails, Sinatra or any other rack based app.
 
@@ -7,10 +7,10 @@ Split is heavily inspired by the Abingo and Vanity rails ab testing plugins and
 Split is designed to be hacker friendly, allowing for maximum customisation and extensibility.
 
 [![Gem Version](https://badge.fury.io/rb/split.svg)](http://badge.fury.io/rb/split)
-[![Build Status](https://secure.travis-ci.org/andrew/split.svg?branch=master)](http://travis-ci.org/andrew/split)
-[![Dependency Status](https://gemnasium.com/andrew/split.svg)](https://gemnasium.com/andrew/split)
-[![Code Climate](https://codeclimate.com/github/andrew/split.svg)](https://codeclimate.com/github/andrew/split)
-[![Coverage Status](http://img.shields.io/coveralls/andrew/split.svg)](https://coveralls.io/r/andrew/split)
+[![Build Status](https://secure.travis-ci.org/splitrb/split.svg?branch=master)](http://travis-ci.org/splitrb/split)
+[![Dependency Status](https://gemnasium.com/splitrb/split.svg)](https://gemnasium.com/splitrb/split)
+[![Code Climate](https://codeclimate.com/github/splitrb/split.svg)](https://codeclimate.com/github/splitrb/split)
+[![Coverage Status](http://img.shields.io/coveralls/splitrb/split.svg)](https://coveralls.io/r/splitrb/split)
 
 ## Requirements
 
@@ -87,7 +87,7 @@ Example: View
 
 ```erb
 <% ab_test("login_button", "/images/button1.jpg", "/images/button2.jpg") do |button_file| %>
-  <%= img_tag(button_file, :alt => "Login!") %>
+  <%= image_tag(button_file, :alt => "Login!") %>
 <% end %>
 ```
 
@@ -115,11 +115,11 @@ Example: Conversion tracking (in a view)
 Thanks for signing up, dude! <% finished("signup_page_redesign") %>
 ```
 
-You can find more examples, tutorials and guides on the [wiki](https://github.com/andrew/split/wiki).
+You can find more examples, tutorials and guides on the [wiki](https://github.com/splitrb/split/wiki).
 
 ## Statistical Validity
 
-Split has two options for you to use to determine which alternative is the best. 
+Split has two options for you to use to determine which alternative is the best.
 
 The first option (default on the dashboard) uses a z test (n>30) for the difference between your control and alternative conversion rates to calculate statistical significance. This test will tell you whether an alternative is better or worse than your control, but it will not distinguish between which alternative is the best in an experiment with multiple alternatives. Split will only tell you if your experiment is 90%, 95%, or 99% significant, and this test only works if you have more than 30 participants and 5 conversions for each branch.
 
@@ -250,7 +250,7 @@ For example:
 
 ``` ruby
 Split.configure do |config|
-  config.on_trial_choose   = :log_trial_choice
+  config.on_trial_choose   = :log_trial_choose
   config.on_trial_complete = :log_trial_complete
 end
 ```
@@ -364,6 +364,8 @@ Split.configure do |config|
 end
 ```
 
+You can set different Redis host via environment variable ```REDIS_URL```.
+
 ### Filtering
 
 In most scenarios you don't want to have AB-Testing enabled for web spiders, robots or special groups of users.
@@ -443,6 +445,37 @@ and:
 finished("my_first_experiment")
 ```
 
+You can also add meta data for each experiment, very useful when you need more than an alternative name to change behaviour:
+
+```yaml
+my_first_experiment:
+  alternatives:
+    - a
+    - b
+    meta:
+      a:
+        text: "Have a fantastic day"
+      b:
+        text: "Don't get hit by a bus"
+```
+
+This allows for some advanced experiment configuration using methods like:
+
+```ruby
+trial.alternative.name # => "a"
+
+trial.metadata['text'] # => "Have a fantastic day"
+```
+
+or in views:
+
+```erb
+<% ab_test("my_first_experiment") do |alternative, meta| %>
+  <%= alternative %>
+  <small><%= meta['text'] %></small>
+<% end %>
+```
+
 #### Metrics
 
 You might wish to track generic metrics, such as conversions, and use
@@ -503,7 +536,7 @@ To complete a goal conversion, you do it like:
 finished("link_color" => "purchase")
 ```
 
-**NOTE:** This does not mean that a single experiment can have/complete progressive goals. 
+**NOTE:** This does not mean that a single experiment can have/complete progressive goals.
 
 **Good Example**: Test if listing Plan A first result in more conversions to Plan A (goal: "plana_conversion") or Plan B (goal: "planb_conversion").
 
@@ -549,11 +582,8 @@ production: redis1.example.com:6379
 And our initializer:
 
 ```ruby
-rails_root = ENV['RAILS_ROOT'] || File.dirname(__FILE__) + '/../..'
-rails_env = ENV['RAILS_ENV'] || 'development'
-
-split_config = YAML.load_file(rails_root + '/config/split.yml')
-Split.redis = split_config[rails_env]
+split_config = YAML.load_file(Rails.root.join('config', 'split.yml'))
+Split.redis = split_config[Rails.env]
 ```
 
 ## Namespaces
@@ -584,7 +614,7 @@ conduct experiments that are not tied to a web session.
 
 ```ruby
 # create a new experiment
-experiment = Split::Experiment.find_or_create('color', 'red', 'blue')
+experiment = Split::ExperimentCatalog.find_or_create('color', 'red', 'blue')
 # create a new trial
 trial = Split::Trial.new(:experiment => experiment)
 # run trial
@@ -601,11 +631,11 @@ end
 
 ## Algorithms
 
-By default, Split ships with `Split::Algorithms::WeightedSample` that randomly selects from possible alternatives for a traditional a/b test. 
+By default, Split ships with `Split::Algorithms::WeightedSample` that randomly selects from possible alternatives for a traditional a/b test.
 It is possible to specify static weights to favor certain alternatives.
 
-`Split::Algorithms::Whiplash` is an implementation of a [multi-armed bandit algorithm](http://stevehanov.ca/blog/index.php?id=132). 
-This algorithm will automatically weight the alternatives based on their relative performance, 
+`Split::Algorithms::Whiplash` is an implementation of a [multi-armed bandit algorithm](http://stevehanov.ca/blog/index.php?id=132).
+This algorithm will automatically weight the alternatives based on their relative performance,
 choosing the better-performing ones more often as trials are completed.
 
 Users may also write their own algorithms. The default algorithm may be specified globally in the configuration file, or on a per experiment basis using the experiments hash of the configuration file.
@@ -620,8 +650,8 @@ end
 
 ## Extensions
 
-  - [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::Export](http://github.com/splitrb/split-export) - easily export ab test data out of Split
+  - [Split::Analytics](http://github.com/splitrb/split-analytics) - push test data to google analytics
   - [Split::Mongoid](https://github.com/MongoHQ/split-mongoid) - store experiment data in mongoid (still uses redis)
   - [Split::Cacheable](https://github.com/harrystech/split_cacheable) - automatically create cache buckets per test
   - [Split::Counters](https://github.com/bernardkroes/split-counters) - add counters per experiment and alternative
@@ -638,12 +668,12 @@ Ryan bates has produced an excellent 10 minute screencast about split on the Rai
 
 ## Contributors
 
-Over 70 different people have contributed to the project, you can see them all here: https://github.com/andrew/split/graphs/contributors
+Over 70 different people have contributed to the project, you can see them all here: https://github.com/splitrb/split/graphs/contributors
 
 ## Development
 
-Source hosted at [GitHub](http://github.com/andrew/split).
-Report Issues/Feature requests on [GitHub Issues](http://github.com/andrew/split/issues).
+Source hosted at [GitHub](http://github.com/splitrb/split).
+Report Issues/Feature requests on [GitHub Issues](http://github.com/splitrb/split/issues).
 Discussion at [Google Groups](https://groups.google.com/d/forum/split-ruby)
 
 Tests can be ran with `rake spec`
@@ -661,4 +691,4 @@ Tests can be ran with `rake spec`
 
 ## Copyright
 
-Copyright (c) 2015 Andrew Nesbitt. See [LICENSE](https://github.com/andrew/split/blob/master/LICENSE) for details.
+Copyright (c) 2015 Andrew Nesbitt. See [LICENSE](https://github.com/splitrb/split/blob/master/LICENSE) for details.

data/gemfiles/3.2.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "rails", "~> 3.2.13"
+gem "rails", "~> 3.2.21"
 
 gemspec :path => "../"

data/gemfiles/4.0.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "rails", "~> 4.0.12"
+gem "rails", "~> 4.0.13"
 
 gemspec :path => "../"

data/gemfiles/4.1.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "rails", "~> 4.1.8"
+gem "rails", "~> 4.1.10"
 
 gemspec :path => "../"

data/gemfiles/4.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "~> 4.2.1"
+
+gemspec :path => "../"

data/lib/split/algorithms/whiplash.rb

@@ -5,30 +5,32 @@ require 'simple-random'
 module Split
   module Algorithms
     module Whiplash
-      def self.choose_alternative(experiment)
-        experiment[best_guess(experiment.alternatives)]
-      end
+      class << self
+        def choose_alternative(experiment)
+          experiment[best_guess(experiment.alternatives)]
+        end
 
-      private
+        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 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.all_completed_count)
+        def best_guess(alternatives)
+          guesses = {}
+          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 }
+          best.sample
         end
-        gmax = guesses.values.max
-        best = guesses.keys.select {|name| guesses[name] ==  gmax }
-        return best.sample
-      end
 
-      def self.fairness_constant
-        7
+        def fairness_constant
+          7
+        end
       end
     end
   end

data/lib/split/configuration.rb

@@ -141,6 +141,10 @@ module Split
             experiment_config[experiment_name.to_sym][:goals] = goals
           end
 
+          if metadata = value_for(settings, :metadata)
+            experiment_config[experiment_name.to_sym][:metadata] = metadata
+          end
+
           if (resettable = value_for(settings, :resettable)) != nil
             experiment_config[experiment_name.to_sym][:resettable] = resettable
           end

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

@@ -7,7 +7,6 @@ html {
 body {
   padding: 0 10px;
   margin: 10px auto 0;
-  max-width:800px;
 }
 
 .header {

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

@@ -13,5 +13,5 @@
   <% end %>
 <% else %>
   <p class="intro">No experiments have started yet, you need to define them in your code and introduce them to your users.</p>
-  <p class="intro">Check out the <a href='https://github.com/andrew/split#readme'>Readme</a> for more help getting started.</p>
+  <p class="intro">Check out the <a href='https://github.com/splitrb/split#readme'>Readme</a> for more help getting started.</p>
 <% end %>

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

@@ -20,7 +20,7 @@
   </div>
 
   <div id="footer">
-    <p>Powered by <a href="http://github.com/andrew/split">Split</a> v<%=Split::VERSION %></p>
+    <p>Powered by <a href="http://github.com/splitrb/split">Split</a> v<%=Split::VERSION %></p>
   </div>
 </body>
 </html>

data/lib/split/encapsulated_helper.rb

@@ -2,7 +2,7 @@
 # mix into our model classes.
 #
 # This module exposes only two methods
-#  - ab_test and 
+#  - ab_test and
 #  - ab_test_finished
 # that can safely be mixed into any class.
 #
@@ -14,9 +14,12 @@ module Split
 
     class ContextShim
       include Split::Helper
+      public :ab_test, :finished
+
       def initialize(context)
         @context = context
       end
+
       def ab_user
         @ab_user ||= Split::Persistence.adapter.new(@context)
       end

data/lib/split/experiment.rb

@@ -6,6 +6,7 @@ module Split
     attr_accessor :goals
     attr_accessor :alternatives
     attr_accessor :alternative_probabilities
+    attr_accessor :metadata
 
     DEFAULT_OPTIONS = {
       :resettable => true
@@ -22,6 +23,7 @@ module Split
         set_alternatives_and_options(
           alternatives: load_alternatives_from_configuration,
           goals: load_goals_from_configuration,
+          metadata: load_metadata_from_configuration,
           resettable: exp_config[:resettable],
           algorithm: exp_config[:algorithm]
         )
@@ -29,6 +31,7 @@ module Split
         set_alternatives_and_options(
           alternatives: alternatives,
           goals: options[:goals],
+          metadata: options[:metadata],
           resettable: options[:resettable],
           algorithm: options[:algorithm]
         )
@@ -40,6 +43,7 @@ module Split
       self.goals = options[:goals]
       self.resettable = options[:resettable]
       self.algorithm = options[:algorithm]
+      self.metadata = options[:metadata]
     end
 
     def extract_alternatives_from_options(options)
@@ -56,6 +60,7 @@ module Split
         if exp_config
           alts = load_alternatives_from_configuration
           options[:goals] = load_goals_from_configuration
+          options[:metadata] = load_metadata_from_configuration
           options[:resettable] = exp_config[:resettable]
           options[:algorithm] = exp_config[:algorithm]
         end
@@ -79,16 +84,20 @@ module Split
         start unless Split.configuration.start_manually
         @alternatives.reverse.each {|a| Split.redis.lpush(name, a.name)}
         @goals.reverse.each {|a| Split.redis.lpush(goals_key, a)} unless @goals.nil?
+        Split.redis.set(metadata_key, @metadata.to_json) unless @metadata.nil?
       else
         existing_alternatives = load_alternatives_from_redis
         existing_goals = load_goals_from_redis
-        unless existing_alternatives == @alternatives.map(&:name) && existing_goals == @goals
+        existing_metadata = load_metadata_from_redis
+        unless existing_alternatives == @alternatives.map(&:name) && existing_goals == @goals && existing_metadata == @metadata
           reset
           @alternatives.each(&:delete)
           delete_goals
+          delete_metadata
           Split.redis.del(@name)
           @alternatives.reverse.each {|a| Split.redis.lpush(name, a.name)}
           @goals.reverse.each {|a| Split.redis.lpush(goals_key, a)} unless @goals.nil?
+          Split.redis.set(metadata_key, @metadata.to_json) unless @metadata.nil?
         end
       end
 
@@ -221,6 +230,10 @@ module Split
       "#{key}:finished"
     end
 
+    def metadata_key
+      "#{name}:metadata"
+    end
+
     def resettable?
       resettable
     end
@@ -238,6 +251,7 @@ module Split
       Split.redis.srem(:experiments, name)
       Split.redis.del(name)
       delete_goals
+      delete_metadata
       Split.configuration.on_experiment_delete.call(self)
       increment_version
     end
@@ -246,12 +260,17 @@ module Split
       Split.redis.del(goals_key)
     end
 
+    def delete_metadata
+      Split.redis.del(metadata_key)
+    end
+
     def load_from_redis
       exp_config = Split.redis.hgetall(experiment_config_key)
       self.resettable = exp_config['resettable']
       self.algorithm = exp_config['algorithm']
       self.alternatives = load_alternatives_from_redis
       self.goals = load_goals_from_redis
+      self.metadata = load_metadata_from_redis
     end
 
     def calc_winning_alternatives
@@ -388,6 +407,10 @@ module Split
       "experiment_configurations/#{@name}"
     end
 
+    def load_metadata_from_configuration
+      metadata = Split.configuration.experiment_for(@name)[:metadata]
+    end
+
     def load_goals_from_configuration
       goals = Split.configuration.experiment_for(@name)[:goals]
       if goals.nil?
@@ -401,6 +424,11 @@ module Split
       Split.redis.lrange(goals_key, 0, -1)
     end
 
+    def load_metadata_from_redis
+      meta = Split.redis.get(metadata_key)
+      JSON.parse(meta) unless meta.nil?
+    end
+
     def load_alternatives_from_configuration
       alts = Split.configuration.experiment_for(@name)[:alternatives]
       raise ArgumentError, "Experiment configuration is missing :alternatives array" unless alts

data/lib/split/experiment_catalog.rb

@@ -12,13 +12,8 @@ module Split
     end
 
     def self.find(name)
-      if Split.redis.exists(name)
-        obj = Experiment.new name
-        obj.load_from_redis
-      else
-        obj = nil
-      end
-      obj
+      return unless Split.redis.exists(name)
+      Experiment.new(name).tap { |exp| exp.load_from_redis }
     end
 
     def self.find_or_initialize(metric_descriptor, control = nil, *alternatives)
@@ -39,8 +34,6 @@ module Split
       experiment.save
     end
 
-    private
-
     def self.normalize_experiment(metric_descriptor)
       if Hash === metric_descriptor
         experiment_name = metric_descriptor.keys.first
@@ -51,6 +44,7 @@ module Split
       end
       return experiment_name, goals
     end
+    private_class_method :normalize_experiment
 
   end
 end

data/lib/split/helper.rb

@@ -1,5 +1,6 @@
 module Split
   module Helper
+    module_function
 
     def ab_test(metric_descriptor, control = nil, *alternatives)
       begin
@@ -15,7 +16,7 @@ module Split
         else
           control_variable(experiment.control)
         end
-      rescue Errno::ECONNREFUSED, Redis::CannotConnectError => e
+      rescue Errno::ECONNREFUSED, Redis::CannotConnectError, SocketError => e
         raise(e) unless Split.configuration.db_failover
         Split.configuration.db_failover_on_db_error.call(e)
 
@@ -28,13 +29,8 @@ module Split
       end
 
       if block_given?
-        if defined?(capture) # a block in a rails view
-          block = Proc.new { yield(alternative) }
-          concat(capture(alternative, &block))
-          false
-        else
-          yield(alternative)
-        end
+        metadata = trial ? trial.metadata : {}
+        yield(alternative, metadata)
       else
         alternative
       end
@@ -63,7 +59,6 @@ module Split
       end
     end
 
-
     def finished(metric_descriptor, options = {:reset => true})
       return if exclude_visitor? || Split.configuration.disabled?
       metric_descriptor, goals = normalize_metric(metric_descriptor)
@@ -130,8 +125,6 @@ module Split
       return experiment_pairs
     end
 
-    protected
-
     def normalize_metric(metric_descriptor)
       if Hash === metric_descriptor
         experiment_name = metric_descriptor.keys.first

data/lib/split/metric.rb

@@ -84,8 +84,6 @@ module Split
       end
     end
 
-    private
-
     def self.normalize_metric(label)
       if Hash === label
         metric_name = label.keys.first
@@ -96,5 +94,7 @@ module Split
       end
       return metric_name, goals
     end
+    private_class_method :normalize_metric
+
   end
 end

data/lib/split/persistence.rb

@@ -7,22 +7,19 @@ module Split
     ADAPTERS = {
       :cookie => Split::Persistence::CookieAdapter,
       :session => Split::Persistence::SessionAdapter
-    }
+    }.freeze
 
     def self.adapter
       if persistence_config.is_a?(Symbol)
-        adapter_class = ADAPTERS[persistence_config]
-        raise Split::InvalidPersistenceAdapterError unless adapter_class
+        ADAPTERS.fetch(persistence_config) { raise Split::InvalidPersistenceAdapterError }
       else
-        adapter_class = persistence_config
+        persistence_config
       end
-      adapter_class
     end
 
-    private
-
     def self.persistence_config
       Split.configuration.persistence
     end
+    private_class_method :persistence_config
   end
 end

data/lib/split/trial.rb

@@ -1,10 +1,12 @@
 module Split
   class Trial
     attr_accessor :experiment
+    attr_accessor :metadata
 
     def initialize(attrs = {})
       self.experiment   = attrs.delete(:experiment)
       self.alternative  = attrs.delete(:alternative)
+      self.metadata  = attrs.delete(:metadata)
 
       @user             = attrs.delete(:user)
       @options          = attrs
@@ -12,6 +14,10 @@ module Split
       @alternative_choosen = false
     end
 
+    def metadata
+      @metadata ||= experiment.metadata[alternative.name] if experiment.metadata
+    end
+
     def alternative
       @alternative ||=  if @experiment.has_winner?
                           @experiment.winner
@@ -26,14 +32,12 @@ module Split
       end
     end
 
-    def complete!(goals, context = nil)
-      goals = goals || []
-
+    def complete!(goals=[], context = nil)
       if alternative
-        if goals.empty?
+        if Array(goals).empty?
           alternative.increment_completion
         else
-          goals.each {|g| alternative.increment_completion(g) }
+          Array(goals).each {|g| alternative.increment_completion(g) }
         end
 
         context.send(Split.configuration.on_trial_complete, self) \

data/lib/split/version.rb

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

data/lib/split/zscore.rb

@@ -34,7 +34,7 @@ module Split
 
       # Formula for pooled error of the difference of the means: root(π*(1-π)*(1/na+1/nc)
       # π = (xa + xc) / (na + nc)
-      pi = (p_1*n_1 + p_2*n_2)/(n_1 + n_2) 
+      pi = (p_1*n_1 + p_2*n_2)/(n_1 + n_2)
       s_p = Math.sqrt(pi*(1-pi)*(1/n_1 + 1/n_2))
 
       # Formula for unpooled error of the difference of the means: root(sa**2/na + sc**2/nc)

data/lib/split.rb

@@ -53,7 +53,7 @@ module Split
   # create a new one.
   def redis
     return @redis if @redis
-    self.redis = 'localhost:6379'
+    self.redis = ENV.fetch('REDIS_URL', 'localhost:6379')
     self.redis
   end
 

data/spec/configuration_spec.rb

@@ -90,6 +90,36 @@ describe Split::Configuration do
         end
       end
 
+      context "in a configuration with metadata" do
+        before do
+          experiments_yaml = <<-eos
+            my_experiment:
+              alternatives:
+                - name: Control Opt
+                  percent: 67
+                - name: Alt One
+                  percent: 10
+                - name: Alt Two
+                  percent: 23
+              metadata:
+                Control Opt:
+                  text: 'Control Option'
+                Alt One:
+                  text: 'Alternative One'
+                Alt Two:
+                  text: 'Alternative Two'
+              resettable: false
+            eos
+          @config.experiments = YAML.load(experiments_yaml)
+        end
+
+        it 'should have metadata on the experiment' do
+          meta = @config.normalized_experiments[:my_experiment][:metadata]
+          expect(meta).to_not be nil
+          expect(meta['Control Opt']['text']).to eq('Control Option')
+        end
+      end
+
       context "in a complex configuration" do
         before do
           experiments_yaml = <<-eos
@@ -120,6 +150,7 @@ describe Split::Configuration do
           expect(@config.metrics).not_to be_nil
           expect(@config.metrics.keys).to eq([:my_metric])
         end
+
       end
     end
 

data/spec/experiment_spec.rb

@@ -147,6 +147,29 @@ describe Split::Experiment do
 
     end
 
+    describe '#metadata' do
+      let(:experiment) { Split::Experiment.new('basket_text', :alternatives => ['Basket', "Cart"], :algorithm => Split::Algorithms::Whiplash, :metadata => meta) }
+      context 'simple hash' do
+        let(:meta) {  { 'basket' => 'a', 'cart' => 'b' } }
+        it "should persist metadata in redis" do
+          experiment.save
+          e = Split::ExperimentCatalog.find('basket_text')
+          expect(e).to eq(experiment)
+          expect(e.metadata).to eq(meta)
+        end
+      end
+
+      context 'nested hash' do
+        let(:meta) {  { 'basket' => { 'one' => 'two' }, 'cart' => 'b' } }
+        it "should persist metadata in redis" do
+          experiment.save
+          e = Split::ExperimentCatalog.find('basket_text')
+          expect(e).to eq(experiment)
+          expect(e.metadata).to eq(meta)
+        end
+      end
+    end
+
     it "should persist algorithm in redis" do
       experiment = Split::Experiment.new('basket_text', :alternatives => ['Basket', "Cart"], :algorithm => Split::Algorithms::Whiplash)
       experiment.save

data/spec/helper_spec.rb

@@ -198,6 +198,37 @@ describe Split::Helper do
     end
   end
 
+  describe 'metadata' do
+    before do
+      Split.configuration.experiments = {
+        :my_experiment => {
+          :alternatives => ["one", "two"],
+          :resettable => false,
+          :metadata => { 'one' => 'Meta1', 'two' => 'Meta2' }
+        }
+      }
+    end
+
+    it 'should be passed to helper block' do
+      @params = {'my_experiment' => 'one'}
+      expect(ab_test('my_experiment')).to eq 'one'
+      expect(ab_test('my_experiment') do |alternative, meta|
+        meta
+      end).to eq('Meta1')
+    end
+
+    it 'should pass empty hash to helper block if library disabled' do
+      Split.configure do |config|
+        config.enabled = false
+      end
+
+      expect(ab_test('my_experiment')).to eq 'one'
+      expect(ab_test('my_experiment') do |_, meta|
+        meta
+      end).to eq({})
+    end
+  end
+
   describe 'finished' do
     before(:each) do
       @experiment_name = 'link_color'

data/spec/spec_helper.rb

@@ -32,8 +32,10 @@ def params
 end
 
 def request(ua = 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; de-de) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27')
-  r = OpenStruct.new
-  r.user_agent = ua
-  r.ip = '192.168.1.1'
-  @request ||= r
+  @request ||= begin
+    r = OpenStruct.new
+    r.user_agent = ua
+    r.ip = '192.168.1.1'
+    r
+  end
 end

data/spec/trial_spec.rb

@@ -33,6 +33,27 @@ describe Split::Trial do
     end
   end
 
+  describe "metadata" do
+    let(:alternatives) { ['basket', 'cart'] }
+    let(:metadata) { Hash[alternatives.map { |k| [k, "Metadata for #{k}"] }] }
+    let(:experiment) do
+      Split::Experiment.new('basket_text', :alternatives => alternatives, :metadata => metadata).save
+    end
+
+    it 'has metadata on each trial' do
+      trial = Split::Trial.new(:experiment => experiment, :user => user, :metadata => metadata['cart'],
+                               :override => 'cart')
+      expect(trial.metadata).to eq(metadata['cart'])
+    end
+
+    it 'has metadata on each trial from the experiment' do
+      trial = Split::Trial.new(:experiment => experiment, :user => user)
+      trial.choose!
+      expect(trial.metadata).to eq(metadata[trial.alternative.name])
+      expect(trial.metadata).to match /#{trial.alternative.name}/
+    end
+  end
+
   describe "#choose!" do
     def expect_alternative(trial, alternative_name)
       3.times do
@@ -109,6 +130,42 @@ describe Split::Trial do
       end
     end
 
+    describe "#complete!" do
+      let(:trial) { Split::Trial.new(:user => user, :experiment => experiment) }
+      context 'when there are no goals' do
+        it 'should complete the trial' do
+          trial.choose!
+          old_completed_count = trial.alternative.completed_count
+          trial.complete!
+          expect(trial.alternative.completed_count).to be(old_completed_count+1)
+        end
+      end
+
+      context 'when there are many goals' do
+        let(:goals) { ['first', 'second'] }
+        let(:trial) { Split::Trial.new(:user => user, :experiment => experiment, :goals => goals) }
+        shared_examples_for "goal completion" do
+          it 'should not complete the trial' do
+            trial.choose!
+            old_completed_count = trial.alternative.completed_count
+            trial.complete!(goal)
+            expect(trial.alternative.completed_count).to_not be(old_completed_count+1)
+          end
+        end
+
+        describe 'Array of Goals' do
+          let(:goal) { [goals.first] }
+          it_behaves_like 'goal completion'
+        end
+
+        describe 'String of Goal' do
+          let(:goal) { goals.first }
+          it_behaves_like 'goal completion'
+        end
+
+      end
+    end
+
     describe "alternative recording" do
       before(:each) { Split.configuration.store_override = false }
 

data/split.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Andrew Nesbitt"]
   s.licenses    = ['MIT']
   s.email       = ["andrewnez@gmail.com"]
-  s.homepage    = "https://github.com/andrew/split"
+  s.homepage    = "https://github.com/splitrb/split"
   s.summary     = %q{Rack based split testing framework}
 
   s.required_ruby_version = '>= 1.9.2'
@@ -25,9 +25,9 @@ Gem::Specification.new do |s|
   s.add_dependency 'sinatra',         '>= 1.2.6'
   s.add_dependency 'simple-random'
 
-  s.add_development_dependency 'bundler',     '~> 1.6'
+  s.add_development_dependency 'bundler',     '~> 1.7'
   s.add_development_dependency 'coveralls'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec',       '~> 3.0'
+  s.add_development_dependency 'rspec',       '~> 3.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2015-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.1.0
 description: 
 email:
 - andrewnez@gmail.com
@@ -155,6 +155,7 @@ files:
 - gemfiles/3.2.gemfile
 - gemfiles/4.0.gemfile
 - gemfiles/4.1.gemfile
+- gemfiles/4.2.gemfile
 - lib/split.rb
 - lib/split/algorithms.rb
 - lib/split/algorithms/weighted_sample.rb
@@ -208,7 +209,7 @@ files:
 - spec/support/cookies_mock.rb
 - spec/trial_spec.rb
 - split.gemspec
-homepage: https://github.com/andrew/split
+homepage: https://github.com/splitrb/split
 licenses:
 - MIT
 metadata: {}