verdict 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 969beb7809f021e2f73e70128dd7565081824240
-  data.tar.gz: 1abbcd8a1c3b5d0776d3649049d8b34cada22cf9
+  metadata.gz: 8efebedf53fee289950045fc2396359440dc0e15
+  data.tar.gz: 94bba89fe604abab1cd2f60b45b66bff0424ee75
 SHA512:
-  metadata.gz: ae0034fd9af434c7fec7be4dd0aabc427dca17c7990e150941251209323cbad98522d3057dd26abc6e1fffcb739e881d5cacc54c636b798cda322c1cdc0b056a
-  data.tar.gz: f1e8ef2ca4f3ddc3995b72b33b3fa3dd2259c4520c8e691362a33e1ccfab9ce42aff6bc336b7723c1505db6a86d3ce4bcc90df07376201fbea208486ab3ef4f0
+  metadata.gz: 538a77d48203d92c91a42072d9f64e60f9ab3b1d8ee857d380bfcd61328c73f1d9d96682db1a5dbb1c43c8ae4d52c57b38d156863408b77673b879c17ac4fa1a
+  data.tar.gz: c9535d06da2da5bef7a547b9565515f227dc8789d5d690d0b68867a5b5b6835a6dcf7645ee2dfa7a37d072d47cb22b932a0d014bc51c83dc4cff3734de03a0f0

data/lib/verdict/experiment.rb

@@ -59,7 +59,7 @@ class Verdict::Experiment
 
   def storage(subject_storage = nil, options = {})
     return @subject_storage if subject_storage.nil?
-    
+
     @store_unqualified = options[:store_unqualified] if options.has_key?(:store_unqualified)
     @subject_storage = case subject_storage
       when :memory; Verdict::Storage::MemoryStorage.new
@@ -86,7 +86,7 @@ class Verdict::Experiment
     segmenter.groups.keys
   end
 
-  def subject_assignment(subject_identifier, group, originally_created_at, temporary = false)
+  def subject_assignment(subject_identifier, group, originally_created_at = nil, temporary = false)
     Verdict::Assignment.new(self, subject_identifier, group, originally_created_at, temporary)
   end
 
@@ -123,26 +123,40 @@ class Verdict::Experiment
     end
   end
 
-  def disqualify_empty_identifier?
-    @disqualify_empty_identifier
+  def assign_manually(subject, group)
+    identifier = retrieve_subject_identifier(subject)
+    assign_manually_by_identifier(identifier, group)
   end
 
-  def disqualify(subject)
-    identifier = retrieve_subject_identifier(subject)
-    store_assignment(subject_assignment(identifier, nil, nil))
+  def assign_manually_by_identifier(subject_identifier, group)
+    assignment = subject_assignment(subject_identifier, group)
+    if !assignment.qualified? && !store_unqualified?
+      raise Verdict::Error, "Unqualified subject assignments are not stored for this experiment, so manual disqualification is impossible. Consider setting :store_unqualified to true for this experiment."
+    end
+
+    store_assignment(assignment)
+    assignment
+  end
+
+  def disqualify_manually(subject)
+    assign_manually(subject, nil)
   end
 
+  def disqualify_manually_by_identifier(subject_identifier)
+    assign_manually_by_identifier(subject_identifier, nil)
+  end    
+
   def store_assignment(assignment)
     @subject_storage.store_assignment(assignment) if should_store_assignment?(assignment)
     event_logger.log_assignment(assignment)
     assignment
   end
 
-  def remove_subject(subject)
-    remove_subject_identifier(retrieve_subject_identifier(subject))
+  def remove_subject_assignment(subject)
+    remove_subject_assignment_by_identifier(retrieve_subject_identifier(subject))
   end
 
-  def remove_subject_identifier(subject_identifier)
+  def remove_subject_assignment_by_identifier(subject_identifier)
     @subject_storage.remove_assignment(self, subject_identifier)
   end
 
@@ -202,6 +216,10 @@ class Verdict::Experiment
     @subject_storage.retrieve_assignment(self, subject_identifier)
   end
 
+  def disqualify_empty_identifier?
+    @disqualify_empty_identifier
+  end
+
   protected
 
   def default_options

data/lib/verdict/storage/memory_storage.rb

@@ -20,8 +20,8 @@ module Verdict
       end
 
       def remove_assignment(experiment, subject_identifier)
-        @assignments[assignment.experiment.handle] ||= {}
-        @assignments[assignment.experiment.handle].delete(subject_identifier)
+        @assignments[experiment.handle] ||= {}
+        @assignments[experiment.handle].delete(subject_identifier)
       end
 
       def clear_experiment(experiment)

data/lib/verdict/tasks.rake

@@ -1,59 +1,88 @@
-def require_env(key)
-  value = ENV[key.downcase].presence || ENV[key.upcase].presence
-  raise "Provide #{key} as environment variable" if value.blank?
-  value
+module Verdict
+  module Rake
+    def self.require_env(key)
+      if ENV.has_key?(key.upcase) && !ENV[key.upcase].empty?
+        ENV[key.upcase]
+      elsif ENV.has_key?(key.downcase) && !ENV[key.downcase].empty?
+        ENV[key.downcase]
+      else
+        raise ArgumentError, "Provide #{key.upcase} as environment variable"
+      end
+    end
+
+    def self.stdout
+      $stdout
+    end
+
+    def self.experiment
+      experiment_handle = Verdict::Rake.require_env('experiment')
+      Verdict[experiment_handle] or raise "Experiment `#{handle}` not found"
+    end
+
+    def self.group
+      group_handle = Verdict::Rake.require_env('group')
+      experiment.group(group_handle) or raise "Group `#{group_handle}` not found."
+    end
+
+    def self.subject_identifier
+      Verdict::Rake.require_env('subject')
+    end
+  end
 end
 
-namespace :experiments do
+namespace :verdict do
 
   desc "List all defined experiments"
-  task :list => 'environment' do
+  task :experiments => 'environment' do
     length = Verdict.repository.keys.map(&:length).max
     Verdict.repository.each do |_, experiment|
-      print "#{experiment.handle.ljust(length)} | "
-      print "Groups: #{experiment.groups.values.map(&:to_s).join(', ')}"
-      puts
+      Verdict::Rake.stdout.print "#{experiment.handle.ljust(length)} | "
+      Verdict::Rake.stdout.print "Groups: #{experiment.groups.values.map(&:to_s).join(', ')}"
+      Verdict::Rake.stdout.puts
     end
   end
 
   desc "Looks up the assignment for a given experiment and subject"
   task :lookup_assignment => 'environment' do
-    experiment = Verdict[require_env('experiment')] or raise "Experiment not found"
-    subject_identifier = require_env('subject')
+    experiment         = Verdict::Rake.experiment
+    subject_identifier = Verdict::Rake.subject_identifier
+
     assignment = experiment.lookup_assignment_for_identifier(subject_identifier)
     if assignment.nil?
-      puts "Subject #{ENV['subject']} is not assigned to experiment #{experiment.handle} yet."
+      Verdict::Rake.stdout.puts "Subject `#{subject_identifier}` is not assigned to experiment `#{experiment.handle}` yet."
     elsif assignment.qualified?
-      puts "Subject #{ENV['subject']} is assigned to group `#{assignment.group.handle}`"
+      Verdict::Rake.stdout.puts "Subject `#{subject_identifier}` is assigned to group `#{assignment.group.handle}` of experiment `#{experiment.handle}`."
     else
-      puts "Subject #{ENV['subject']} is unqualified for experiment #{experiment.handle}"
+      Verdict::Rake.stdout.puts "Subject `#{subject_identifier}` is unqualified for experiment `#{experiment.handle}`."
     end
   end
 
   desc "Manually assign a subject to a given group in an experiment"
   task :assign_manually => 'environment' do
-    experiment = Verdict[require_env('experiment')] or raise "Experiment not found"
-    group = experiment.group(require_env('group')) or raise "Group not found"
-    assignment = experiment.subject_assignment(require_env('subject'), group, false)
-    experiment.store_assignment(assignment)
+    experiment         = Verdict::Rake.experiment
+    group              = Verdict::Rake.group
+    subject_identifier = Verdict::Rake.subject_identifier
+
+    experiment.assign_manually_by_identifier(Verdict::Rake.require_env('subject'), group)
+    Verdict::Rake.stdout.puts "Subject `#{subject_identifier}` has been assigned to group `#{group.handle}` of experiment `#{experiment.handle}`."
   end
 
-  desc "Disqualify a subject from an experiment"
-  task :disqualify => 'environment' do
-    experiment = Verdict[require_env('experiment')] or raise "Experiment not found"
-    assignment = experiment.subject_assignment(require_env('subject'), nil, false)
-    experiment.store_assignment(assignment)
+  desc "Manually disqualify a subject from an experiment"
+  task :disqualify_manually => 'environment' do
+    experiment         = Verdict::Rake.experiment
+    subject_identifier = Verdict::Rake.subject_identifier
+
+    experiment.disqualify_manually_by_identifier(subject_identifier)
+    Verdict::Rake.stdout.puts "Subject `#{subject_identifier}` has been disqualified from experiment `#{experiment.handle}`."
   end
 
   desc "Removes the assignment for a subject so it will be reassigned to the experiment."
   task :remove_assignment => 'environment' do
-    experiment = Verdict[require_env('experiment')] or raise "Experiment not found"
-    experiment.remove_subject_identifier(require_env('subject'))
-  end
+    experiment         = Verdict::Rake.experiment
+    subject_identifier = Verdict::Rake.subject_identifier
 
-  desc "Runs the cleanup tasks for an experiment"
-  task :wrapup => 'environment' do
-    experiment = Verdict[require_env('experiment')] or raise "Experiment not found"
-    experiment.wrapup
+    experiment.remove_subject_assignment_by_identifier(subject_identifier)
+    Verdict::Rake.stdout.puts "Removed assignment of subject with identifier `#{subject_identifier}`."
+    Verdict::Rake.stdout.puts "The subject will be reasigned when it encounters the experiment `#{experiment.handle}` again."
   end
 end

data/lib/verdict/version.rb

@@ -1,3 +1,3 @@
 module Verdict
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/verdict.rb

@@ -40,7 +40,7 @@ module Verdict
 end
 
 require "verdict/version"
-require "verdict/railtie" if defined?(Rails)
+require "verdict/railtie" if defined?(Rails::Railtie)
 
 require "verdict/metadata"
 require "verdict/experiment"

data/test/experiment_test.rb

@@ -138,6 +138,38 @@ class ExperimentTest < Minitest::Test
     e.assign(mock('subject'))
   end
 
+  def test_assign_manually_stores_assignment
+    mock_store = Verdict::Storage::MockStorage.new
+    e = Verdict::Experiment.new('test') do
+      storage mock_store, store_unqualified: true
+      groups { group :all, 100 }
+    end
+
+    group = e.group('all')
+    mock_store.expects(:store_assignment).once
+    e.assign_manually(mock('subject'), group)
+  end
+
+  def test_disqualify_manually
+    e = Verdict::Experiment.new('test', store_unqualified: true) do
+      groups { group :all, 100 }
+    end
+
+    subject = stub(id: 'walrus')
+    original_assignment = e.assign(subject)
+    assert original_assignment.qualified?
+    new_assignment = e.disqualify_manually(subject)
+    assert !new_assignment.qualified?
+  end
+
+  def test_disqualify_manually_fails_with_store_unqualified_disabled
+    e = Verdict::Experiment.new('test', store_unqualified: false) do
+      groups { group :all, 100 }
+    end
+
+    assert_raises(Verdict::Error) { e.disqualify_manually('subject') }
+  end
+
   def test_returning_qualified_assignment_with_store_unqualified
     mock_store, mock_qualifier = Verdict::Storage::MockStorage.new, mock('qualifier')
     e = Verdict::Experiment.new('test') do
@@ -167,18 +199,6 @@ class ExperimentTest < Minitest::Test
     assert !assignment.qualified?
   end
 
-  def test_disqualify
-    e = Verdict::Experiment.new('test') do
-      groups { group :all, 100 }
-    end
-
-    subject = stub(id: 'walrus')
-    original_assignment = e.assign(subject)
-    assert original_assignment.qualified?
-    new_assignment = e.disqualify(subject)
-    assert !new_assignment.qualified?
-  end
-
   def test_assignment_event_logging
     e = Verdict::Experiment.new('test') do
       groups { group :all, 100 }

data/test/rake_tasks_test.rb

@@ -0,0 +1,89 @@
+require 'test_helper'
+require 'stringio'
+
+class RakeTasksTest < Minitest::Test
+
+  def setup
+    require 'rake' unless defined?(Rake)
+    Rake::Task.define_task(:environment) 
+    Rake.application.rake_require('verdict/tasks')
+    
+    @experiment = Verdict::Experiment.define(:rake, store_unqualified: true) do
+      groups do
+        group :a, 50
+        group :b, 50
+      end
+    end
+
+    ENV['EXPERIMENT'] = 'rake'
+    ENV['SUBJECT']    = '1'
+    ENV['GROUP']      = 'a'
+
+    Verdict::Rake.stubs(:stdout).returns(@stdout = StringIO.new)
+  end
+
+  def teardown
+    Rake::Task["environment"].reenable
+    Rake::Task["verdict:lookup_assignment"].reenable
+    Rake::Task["verdict:experiments"].reenable
+    Rake::Task["verdict:assign_manually"].reenable
+    Rake::Task["verdict:disqualify_manually"].reenable
+    Rake::Task["verdict:remove_assignment"].reenable
+
+    Verdict.repository.clear
+  end
+
+  def test_require_env
+    assert_equal 'a', Verdict::Rake.require_env('GROUP')
+    assert_equal 'a', Verdict::Rake.require_env('group')
+
+    ENV['group'] = 'b'
+    assert_equal 'a', Verdict::Rake.require_env('group') # uppercase has presedence
+
+    assert_raises(ArgumentError) { Verdict::Rake.require_env('non_existent_env') }
+  end
+
+  def test_experiment_list
+    Rake.application.invoke_task("verdict:experiments")
+    assert_equal 'rake | Groups: a (50%), b (50%)', @stdout.string.chomp
+  end
+
+  def test_lookup_assignment_fails_without_experiment_env_variable
+    ENV['EXPERIMENT'] = ''
+    assert_raises(ArgumentError) { Rake.application.invoke_task("verdict:lookup_assignment") }
+  end
+
+  def test_lookup_assignment_fails_without_subject_env_variable
+    ENV.delete('SUBJECT')
+    assert_raises(ArgumentError) { Rake.application.invoke_task("verdict:lookup_assignment") }
+  end
+
+  def test_assign_manually
+    Rake.application.invoke_task("verdict:assign_manually")
+    assert_equal 'Subject `1` has been assigned to group `a` of experiment `rake`.', @stdout.string.chomp
+
+    @stdout.string = ""
+    Rake.application.invoke_task("verdict:lookup_assignment")
+    assert_equal 'Subject `1` is assigned to group `a` of experiment `rake`.', @stdout.string.chomp
+  end
+
+  def test_disqualify_manually
+    Rake.application.invoke_task("verdict:disqualify_manually")
+    assert_equal 'Subject `1` has been disqualified from experiment `rake`.', @stdout.string.chomp
+
+    @stdout.string = ""
+    Rake.application.invoke_task("verdict:lookup_assignment")
+    assert_equal 'Subject `1` is unqualified for experiment `rake`.', @stdout.string.chomp
+  end
+
+  def test_remove_assignment
+    @experiment.assign('1')
+    Rake.application.invoke_task("verdict:remove_assignment")
+    assert_equal 'Removed assignment of subject with identifier `1`.', @stdout.string.lines.to_a[0].chomp
+    assert_equal 'The subject will be reasigned when it encounters the experiment `rake` again.', @stdout.string.lines.to_a[1].chomp
+
+    @stdout.string = ""
+    Rake.application.invoke_task("verdict:lookup_assignment")
+    assert_equal 'Subject `1` is not assigned to experiment `rake` yet.', @stdout.string.chomp
+  end
+end

data/test/storage/redis_subject_storage_test.rb

@@ -62,11 +62,11 @@ class RedisSubjectStorageTest < Minitest::Test
     assert !@experiment.assign('subject_1').qualified?
   end
 
-  def test_remove_assignment
+  def test_remove_subject_assignment
     experiment_key = @storage.send(:generate_experiment_key, @experiment)
     @experiment.assign('subject_3')
     assert @redis.hexists(experiment_key, 'subject_3')
-    @experiment.remove_subject('subject_3')
+    @experiment.remove_subject_assignment('subject_3')
     assert !@redis.hexists(experiment_key, 'subject_3')
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verdict
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -120,6 +120,7 @@ files:
 - test/experiments_repository_test.rb
 - test/group_test.rb
 - test/metadata_test.rb
+- test/rake_tasks_test.rb
 - test/segmenters/fixed_percentage_segmenter_test.rb
 - test/segmenters/rollout_segmenter_test.rb
 - test/segmenters/static_segmenter_test.rb
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A library to centrally define experiments for your application, and collect
@@ -159,6 +160,7 @@ test_files:
 - test/experiments_repository_test.rb
 - test/group_test.rb
 - test/metadata_test.rb
+- test/rake_tasks_test.rb
 - test/segmenters/fixed_percentage_segmenter_test.rb
 - test/segmenters/rollout_segmenter_test.rb
 - test/segmenters/static_segmenter_test.rb