verdict 0.2.0 → 0.2.1

data/test/metadata_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class MetadataTest < MiniTest::Unit::TestCase
+class MetadataTest < Minitest::Test
 
   def test_experiment_metadata
     experiment = Verdict::Experiment.new('experiment metadata') do

data/test/{fixed_percentage_segmenter_test.rb → segmenters/fixed_percentage_segmenter_test.rb}

@@ -1,9 +1,9 @@
 require 'test_helper'
 
-class FixedPercentageSegmenterTest < MiniTest::Unit::TestCase
+class FixedPercentageSegmenterTest < Minitest::Test
 
   def test_add_up_to_100_percent
-    s = Verdict::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
+    s = Verdict::Segmenters::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
     s.group :segment1, 1
     s.group :segment2, 54
     s.group :segment3, 27
@@ -18,7 +18,7 @@ class FixedPercentageSegmenterTest < MiniTest::Unit::TestCase
   end
 
   def test_definition_ofhalf_and_rest
-    s = Verdict::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
+    s = Verdict::Segmenters::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
     s.group :first_half, :half
     s.group :second_half, :rest
     s.verify!
@@ -30,7 +30,7 @@ class FixedPercentageSegmenterTest < MiniTest::Unit::TestCase
 
   def test_raises_if_less_than_100_percent
     assert_raises(Verdict::SegmentationError) do
-      s = Verdict::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
+      s = Verdict::Segmenters::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
       s.group :too_little, 99
       s.verify!
     end
@@ -38,34 +38,34 @@ class FixedPercentageSegmenterTest < MiniTest::Unit::TestCase
 
   def test_raises_if_greather_than_100_percent
     assert_raises(Verdict::SegmentationError) do
-      s = Verdict::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
+      s = Verdict::Segmenters::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
       s.group :too_much, 101
       s.verify!
     end
   end
 
   def test_consistent_assignment_for_subjects
-    s = Verdict::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
+    s = Verdict::Segmenters::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
     s.group :first_half, :half
     s.group :second_half, :rest
     s.verify!
 
-    3.times do 
+    3.times do
       assert s.groups['first_half']  === s.assign(1, nil, nil)
       assert s.groups['second_half'] === s.assign(2, nil, nil)
     end
   end
 
   def test_fair_segmenting
-    s = Verdict::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
+    s = Verdict::Segmenters::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
     s.group :first_third, 33
     s.group :second_third, 33
     s.group :final_third, :rest
     s.verify!
 
     assignments = { :first_third => 0, :second_third => 0, :final_third => 0 }
-    200.times do |n| 
-      assignment = s.assign(n, nil, nil) 
+    200.times do |n|
+      assignment = s.assign(n, nil, nil)
       assignments[assignment.to_sym] += 1
     end
 
@@ -76,7 +76,7 @@ class FixedPercentageSegmenterTest < MiniTest::Unit::TestCase
   end
 
   def test_group_json_export
-    s = Verdict::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
+    s = Verdict::Segmenters::FixedPercentageSegmenter.new(Verdict::Experiment.new('test'))
     s.group :first_third, 33
     s.group :rest, :rest
     s.verify!

data/test/{rollout_segmenter_test.rb → segmenters/rollout_segmenter_test.rb}

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class RolloutPercentageSegmenterTest < MiniTest::Unit::TestCase
+class RolloutPercentageSegmenterTest < Minitest::Test
 
   def setup
     @experiment = Verdict::Experiment.new('test') do
@@ -11,7 +11,7 @@ class RolloutPercentageSegmenterTest < MiniTest::Unit::TestCase
   def test_assignment
     included_subject = stub(id: 1)
     excluded_subject = stub(id: 2)
-    
+
     included_assignment = @experiment.assign(included_subject)
     assert included_assignment.qualified?
     assert included_assignment.permanent?

data/test/{static_segmenter_test.rb → segmenters/static_segmenter_test.rb}

@@ -1,9 +1,9 @@
 require 'test_helper'
 
-class StaticSegmenterTest < MiniTest::Unit::TestCase
+class StaticSegmenterTest < Minitest::Test
 
   def setup
-    @segmenter = Verdict::StaticSegmenter.new(Verdict::Experiment.new('test'))
+    @segmenter = Verdict::Segmenters::StaticSegmenter.new(Verdict::Experiment.new('test'))
     @segmenter.group :beta, ['id1', 'id2']
   end
 

data/test/{memory_subject_storage_test.rb → storage/memory_subject_storage_test.rb}

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class MemorySubjectStorageTest < MiniTest::Unit::TestCase
+class MemorySubjectStorageTest < Minitest::Test
 
   def setup
     @storage = storage = Verdict::Storage::MemoryStorage.new

data/test/{redis_subject_storage_test.rb → storage/redis_subject_storage_test.rb}

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class RedisSubjectStorageTest < MiniTest::Unit::TestCase
+class RedisSubjectStorageTest < Minitest::Test
 
   def setup
     @redis = ::Redis.new(host: REDIS_HOST, port: REDIS_PORT)
@@ -80,7 +80,7 @@ class RedisSubjectStorageTest < MiniTest::Unit::TestCase
 
   def test_started_at
     key = @storage.send(:generate_experiment_start_timestamp_key, @experiment)
-    
+
     assert !@redis.exists(key)
     a = @experiment.send(:ensure_experiment_has_started)
     assert @redis.exists(key)

data/test/test_helper.rb

@@ -1,3 +1,11 @@
+unless RUBY_ENGINE == 'rbx'
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/vendor/"
+    add_filter "/test/"
+  end
+end
+
 require "bundler/setup"
 require "minitest/autorun"
 require "minitest/pride"

data/verdict.gemspec

@@ -16,10 +16,10 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  
-  gem.add_development_dependency "minitest", '~> 4.2'
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "mocha"
-  gem.add_development_dependency "timecop"
-  gem.add_development_dependency "redis"
+
+  gem.add_development_dependency("minitest", '~> 5.2')
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("mocha")
+  gem.add_development_dependency("timecop")
+  gem.add_development_dependency("redis")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verdict
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-21 00:00:00.000000000 Z
+date: 2014-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -99,14 +99,18 @@ files:
 - lib/verdict/conversion.rb
 - lib/verdict/event_logger.rb
 - lib/verdict/experiment.rb
-- lib/verdict/fixed_percentage_segmenter.rb
 - lib/verdict/group.rb
 - lib/verdict/metadata.rb
 - lib/verdict/railtie.rb
-- lib/verdict/rollout_segmenter.rb
-- lib/verdict/segmenter.rb
-- lib/verdict/static_segmenter.rb
+- lib/verdict/segmenters.rb
+- lib/verdict/segmenters/base_segmenter.rb
+- lib/verdict/segmenters/fixed_percentage_segmenter.rb
+- lib/verdict/segmenters/rollout_segmenter.rb
+- lib/verdict/segmenters/static_segmenter.rb
 - lib/verdict/storage.rb
+- lib/verdict/storage/memory_storage.rb
+- lib/verdict/storage/mock_storage.rb
+- lib/verdict/storage/redis_storage.rb
 - lib/verdict/tasks.rake
 - lib/verdict/version.rb
 - test/assignment_test.rb
@@ -114,13 +118,13 @@ files:
 - test/event_logger_test.rb
 - test/experiment_test.rb
 - test/experiments_repository_test.rb
-- test/fixed_percentage_segmenter_test.rb
 - test/group_test.rb
-- test/memory_subject_storage_test.rb
 - test/metadata_test.rb
-- test/redis_subject_storage_test.rb
-- test/rollout_segmenter_test.rb
-- test/static_segmenter_test.rb
+- test/segmenters/fixed_percentage_segmenter_test.rb
+- test/segmenters/rollout_segmenter_test.rb
+- test/segmenters/static_segmenter_test.rb
+- test/storage/memory_subject_storage_test.rb
+- test/storage/redis_subject_storage_test.rb
 - test/test_helper.rb
 - verdict.gemspec
 homepage: http://github.com/Shopify/verdict
@@ -142,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A library to centrally define experiments for your application, and collect
@@ -153,11 +157,12 @@ test_files:
 - test/event_logger_test.rb
 - test/experiment_test.rb
 - test/experiments_repository_test.rb
-- test/fixed_percentage_segmenter_test.rb
 - test/group_test.rb
-- test/memory_subject_storage_test.rb
 - test/metadata_test.rb
-- test/redis_subject_storage_test.rb
-- test/rollout_segmenter_test.rb
-- test/static_segmenter_test.rb
+- test/segmenters/fixed_percentage_segmenter_test.rb
+- test/segmenters/rollout_segmenter_test.rb
+- test/segmenters/static_segmenter_test.rb
+- test/storage/memory_subject_storage_test.rb
+- test/storage/redis_subject_storage_test.rb
 - test/test_helper.rb
+has_rdoc: 

data/lib/verdict/fixed_percentage_segmenter.rb

@@ -1,52 +0,0 @@
-class Verdict::FixedPercentageSegmenter < Verdict::Segmenter
-
-  class Group < Verdict::Group
-
-    attr_reader :percentile_range
-
-    def initialize(experiment, handle, percentile_range)
-      super(experiment, handle)
-      @percentile_range = percentile_range
-    end
-
-    def percentage_size
-      percentile_range.end - percentile_range.begin
-    end
-
-    def to_s
-      "#{handle} (#{percentage_size}%)"
-    end
-
-    def as_json(options = {})
-      super(options).merge(percentage: percentage_size)
-    end
-  end
-
-  def initialize(experiment)
-    super
-    @total_percentage_segmented = 0
-  end
-
-  def verify!
-    raise Verdict::SegmentationError, "Should segment exactly 100% of the cases, but segments add up to #{@total_percentage_segmented}%." if @total_percentage_segmented != 100
-  end
-
-  def register_group(handle, size)
-    percentage = size.kind_of?(Hash) && size[:percentage] ? size[:percentage] : size
-    n = case percentage
-      when :rest; 100 - @total_percentage_segmented
-      when :half; 50
-      when Integer; percentage
-      else Integer(percentage)
-    end
-
-    group = Group.new(experiment, handle, @total_percentage_segmented ... (@total_percentage_segmented + n))
-    @total_percentage_segmented += n
-    return group
-  end
-
-  def assign(identifier, subject, context)
-    percentile = Digest::MD5.hexdigest("#{@experiment.handle}#{identifier}").to_i(16) % 100
-    groups.values.find { |group| group.percentile_range.include?(percentile) }
-  end
-end

data/lib/verdict/rollout_segmenter.rb

@@ -1,53 +0,0 @@
-class Verdict::RolloutSegmenter < Verdict::Segmenter
-
-  class Group < Verdict::Group
-
-    attr_reader :percentile_range
-
-    def initialize(experiment, handle, percentile_range)
-      super(experiment, handle)
-      @percentile_range = percentile_range
-    end
-
-    def percentage_size
-      percentile_range.end - percentile_range.begin
-    end
-
-    def to_s
-      "#{handle} (#{percentage_size}%)"
-    end
-
-    def as_json(options = {})
-      super(options).merge(percentage: percentage_size)
-    end
-  end
-
-  def initialize(experiment)
-    super
-    @total_percentage_segmented = 0
-  end
-
-  def verify!
-    raise Verdict::SegmentationError, "Should segment less than 100% of the cases, but segments add up to #{@total_percentage_segmented}%." if @total_percentage_segmented >= 100
-  end
-
-  def register_group(handle, size)
-    percentage = size.kind_of?(Hash) && size[:percentage] ? size[:percentage] : size
-    n = case percentage
-      when :rest; 100 - @total_percentage_segmented
-      when :half; 50
-      when Integer; percentage
-      else Integer(percentage)
-    end
-
-    group = Group.new(experiment, handle, @total_percentage_segmented ... (@total_percentage_segmented + n))
-    @total_percentage_segmented += n
-    return group
-  end
-
-  def assign(identifier, subject, context)
-    percentile = Digest::MD5.hexdigest("#{@experiment.handle}#{identifier}").to_i(16) % 100
-    groups.values.find { |group| group.percentile_range.include?(percentile) }
-  end
-
-end

data/lib/verdict/segmenter.rb

@@ -1,87 +0,0 @@
-require 'digest/md5'
-
-# Base class of all segmenters.
-#
-# The segmenter is responsible for assigning subjects to groups. You can
-# implement any assignment strategy you like by subclassing this class and
-# using it in your experiment.
-#
-# - You should implement the register_group method for the experiment definition DSL
-#   to make the system aware of the groups that the segmenter could return. 
-# - The verify! method is called after all the groups have been defined, so it can
-#   detect internal inconsistencies in the group definitions.
-# - The assign method is where your assignment magic lives.
-class Verdict::Segmenter
-
-  # The experiment to which this segmenter is associated
-  attr_reader :experiment
-
-  # A hash of the groups that are defined in this experiment, indexed by their
-  # handle. The assign method should return one of the groups in this hash
-  attr_reader :groups
-
-  def initialize(experiment)
-    @experiment = experiment
-    @groups = {}
-  end
-
-  # DSL method to register a group. It calls the register_group method of the
-  # segmenter implementation
-  def group(handle, *args, &block)
-    group = register_group(handle, *args)
-    @groups[group.handle] = group
-    group.instance_eval(&block) if block_given?
-  end
-
-  # The group method is called from the experiment definition DSL.
-  # It should register a new group to the segmenter, with the given handle.
-  #
-  # - The handle parameter is a symbol that uniquely identifies the group within
-  #   this experiment.
-  # - The return value of this method should be a Verdict::Group instance.
-  def register_group(handle, *args)
-    raise NotImplementedError
-  end
-
-  # The verify! method is called after all the groups have been defined in the
-  # experiment definition DSL. You can run any consistency checks in this method, 
-  # and if anything is off, you can raise a Verdict::SegmentationError to
-  # signify the problem.
-  def verify!
-    # noop by default
-  end
-
-  # The assign method is called to assign a subject to one of the groups that have been defined
-  # in the segmenter implementation.
-  #
-  # - The identifier parameter is a string that uniquely identifies the subject.
-  # - The subject paramater is the  subject instance that was passed to the framework,
-  #   when the application code calls Experiment#assign or Experiment#switch.
-  # - The context parameter is an object that was passed to the framework, you can use this
-  #   object any way you like in your segmenting logic.
-  #
-  # This method should return the Verdict::Group instance to which the subject should be assigned.
-  # This instance should be one of the group instance that was registered in the definition DSL.
-  def assign(identifier, subject, context)
-    raise NotImplementedError
-  end
-
-
-  # This method is called whenever a subjects converts to a goal, i.e., when Experiment#convert
-  # is called. You can use this to implement a feedback loop in your segmenter.
-  #
-  # - The identifier parameter is a string that uniquely identifies the subject.
-  # - The subject paramater is the  subject instance that was passed to the framework,
-  #   when the application code calls Experiment#assign or Experiment#switch.
-  # - The conversion parameter is a Verdict::Conversion instance that describes what
-  #   goal the subject converted to.
-  #
-  # The return value of this method is not used.
-  def conversion_feedback(identifier, subject, conversion)
-    # noop by default
-  end
-end
-
-require 'verdict/static_segmenter'
-require 'verdict/fixed_percentage_segmenter'
-require 'verdict/rollout_segmenter'