planout 0.0.4 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5c5c1dd6ff42017cf545c0907f6787ea1f4d5a3
-  data.tar.gz: 1f07fd26a0d23f8bb5a168d72b7ae6ce719c4887
+  metadata.gz: de6ac7ac834d56d050fdc5d7a354f963e7fbef99
+  data.tar.gz: 5a28a98c04bf3560be6d2ce89662f083ed249ba5
 SHA512:
-  metadata.gz: 9811923bb113830dc50b5513e218b927bc4ca300ab8442c68e8ea14855b51f6086f52dc94d235b71da651dadf7dfff9be35978b3dc04d323049e519e5a2fbe9a
-  data.tar.gz: 0f86286b2428c19b46ac4f3bdcbff75cff14da944ab96d33dc76214ec7ce91e7a2ba32b62eba72603b23b4ba113cceec3c0cde67b2639bcd52c573c831b9f3ca
+  metadata.gz: 41b8aac76573def514e18e6676af436340f9f86a7e9cfb2c7295c46e8a10620a8ed53ffed8b883503de7eb84d391d96917cb437145bc4351e185da56d015a1df
+  data.tar.gz: c2b98270f2d422568adc7d12b3c6fad917a36c0ef744a3aa7312fa2c71acc0a1c6ee006a2cc33d8bfdbd510d6ff52d0891186cd0e7a8ed0fb9163b4d3738d870

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in planout.gemspec
 gemspec
+
+group :test do
+  gem 'rake'
+  gem 'minitest', '~> 5.5'
+end

data/README.md

@@ -1,3 +1,7 @@
+# PlanOut
+[![Gem Version](https://badge.fury.io/rb/planout.svg)](http://badge.fury.io/rb/planout)
+[![Build Status](https://travis-ci.org/facebook/planout.svg)](https://travis-ci.org/facebook/planout)
+
 ## Overview
 This is a rough implementation of the Experiment / logging infrasture for running PlanOut experiments, with all the random assignment operators available in Python. This port is nearly a line-by-line port, and produces assignments that are completely consistent with those produced by the Python reference implementation.
 
@@ -24,7 +28,7 @@ This defines a simple experiment that randomly assigns three variables, foo, bar
 `foo` and `baz` use `userid` as input, while `bar` uses a pair, namely `userid` combined with the value of `foo` from the prior step.
 
 ```ruby
-module Planout
+module PlanOut
   class VotingExperiment < SimpleExperiment
     # Experiment#assign takes params and an input array
     def assign(params, **inputs)
@@ -48,7 +52,7 @@ end
 Then, we can examine the assignments produced for a few input userids. Note that since exposure logging is enabled by default, all of the experiments' inputs, configuration information, timestamp, and parameter assignments are pooped out via the Logger class.
 
 ```ruby
-my_exp = Planout::VotingExperiment.new(userid: 14)
+my_exp = PlanOut::VotingExperiment.new(userid: 14)
 my_button_color = my_exp.get(:button_color)
 button_text = my_exp.get(:button_text)
 puts "button color is #{my_button_color} and button text is #{button_text}."
@@ -57,7 +61,7 @@ puts "button color is #{my_button_color} and button text is #{button_text}."
 The output of the Ruby script looks something like this:
 
 ```ruby
-logged data: {"name":"Planout::VotingExperiment","time":1404944726,"salt":"Planout::VotingExperiment","inputs":{"userid":14},"params":{"button_color":"ff0000","button_text":"I'm a voter"},"event":"exposure"}
+logged data: {"name":"PlanOut::VotingExperiment","time":1404944726,"salt":"PlanOut::VotingExperiment","inputs":{"userid":14},"params":{"button_color":"ff0000","button_text":"I'm a voter"},"event":"exposure"}
 
 button color is ff0000 and button text is I'm a voter.
 ```

data/examples/{planout → plan_out}/voting_experiment.rb

@@ -1,6 +1,6 @@
-require_relative '../../lib/planout/simple_experiment'
+require_relative '../../lib/plan_out/simple_experiment'
 
-module Planout
+module PlanOut
   class VotingExperiment < SimpleExperiment
     def setup; end
 

data/lib/plan_out.rb

@@ -0,0 +1,8 @@
+require_relative 'plan_out/op_random'
+require_relative 'plan_out/assignment'
+require_relative 'plan_out/simple_experiment'
+require_relative 'plan_out/version'
+
+module PlanOut
+
+end

data/lib/{planout → plan_out}/assignment.rb

@@ -1,4 +1,4 @@
-module Planout
+module PlanOut
   class Assignment
     attr_accessor :experiment_salt, :data
 

data/lib/{planout → plan_out}/experiment.rb

@@ -1,7 +1,7 @@
 require 'logger'
 require 'json'
 
-module Planout
+module PlanOut
   class Experiment
     attr_accessor :auto_exposure_log
 

data/lib/plan_out/op_random.rb

@@ -0,0 +1,84 @@
+require_relative 'operator'
+
+module PlanOut
+  class OpRandom < OpSimple
+    LONG_SCALE = Float(0xFFFFFFFFFFFFFFF)
+
+    def get_unit(appended_unit = nil)
+      unit = @parameters[:unit]
+      unit = [unit] if !unit.is_a? Array
+      unit += appended_unit if appended_unit != nil
+      unit
+    end
+
+    def get_hash(appended_unit = nil)
+      salt = @parameters[:salt]
+      salty = "#{@mapper.experiment_salt}.#{salt}"
+      unit_str = get_unit(appended_unit).join('.')
+      x = "#{salty}.#{unit_str}"
+      last_hex = (Digest::SHA1.hexdigest(x))[0..14]
+      last_hex.to_i(16)
+    end
+
+    def get_uniform(min_val = 0.0, max_val = 1.0, appended_unit = nil)
+      zero_to_one = self.get_hash(appended_unit)/LONG_SCALE
+      min_val + (max_val-min_val) * zero_to_one
+    end
+  end
+
+  class RandomFloat < OpRandom
+    def simple_execute
+      min_val = @parameters.fetch(:min, 0)
+      max_val = @parameters.fetch(:max, 1)
+      get_uniform(min_val, max_val)
+    end
+  end
+
+  class RandomInteger < OpRandom
+    def simple_execute
+      min_val = @parameters.fetch(:min, 0)
+      max_val = @parameters.fetch(:max, 1)
+      min_val + get_hash() % (max_val - min_val + 1)
+    end
+  end
+
+  class BernoulliTrial < OpRandom
+    def simple_execute
+      p = @parameters[:p]
+      rand_val = get_uniform(0.0, 1.0)
+      (rand_val <= p) ? 1 : 0
+    end
+  end
+
+  class WeightedChoice < OpRandom
+    def simple_execute
+      choices = @parameters[:choices]
+      weights = @parameters[:weights]
+
+      return [] if choices.length() == 0
+
+      cum_weights = choices.zip(weights)
+      cum_sum = 0.0
+
+      cum_weights.each do |choice, weight|
+        cum_sum += weight
+        cum_weights[choice] = cum_sum
+      end
+
+      stop_value = get_uniform(0.0, cum_sum)
+
+      cum_weights.each do |choice, cum_weight|
+        choice if stop_value <= cum_weight
+      end
+    end
+  end
+
+  class UniformChoice < OpRandom
+    def simple_execute
+      choices = @parameters[:choices]
+      return [] if choices.length() == 0
+      rand_index = get_hash() % choices.length()
+      choices[rand_index]
+    end
+  end
+end

data/lib/{planout/op_simple.rb → plan_out/operator.rb}

@@ -1,6 +1,18 @@
-require_relative 'operator'
+require 'digest/sha1'
+
+module PlanOut
+  class Operator
+    attr_accessor :args
+
+    def initialize(parameters)
+      @args = parameters
+    end
+
+    def execute(mapper)
+      mapper.experiment_salt
+    end
+  end
 
-module Planout
   class OpSimple < Operator
     def execute(mapper)
       @mapper = mapper

data/lib/{planout → plan_out}/simple_experiment.rb

@@ -1,6 +1,6 @@
 require_relative 'experiment'
 
-module Planout
+module PlanOut
   class SimpleExperiment < Experiment
     def configure_logger
       @logger = Logger.new(STDOUT)

data/lib/plan_out/version.rb

@@ -0,0 +1,3 @@
+module PlanOut
+  VERSION = '0.1.1'
+end

data/planout.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'planout/version'
+require 'plan_out/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "planout"
-  spec.version       = Planout::VERSION
+  spec.version       = PlanOut::VERSION
   spec.authors       = ["Eytan Bakshy", "Mohnish Thallavajhula"]
   spec.email         = ["ebakshy@gmail.com", "i@mohni.sh"]
   spec.summary       = %q{PlanOut is a framework and programming language for online field experimentation.}

data/test/{planout → plan_out}/assignment_test.rb

@@ -1,6 +1,6 @@
 require_relative '../test_helper'
 
-module Planout
+module PlanOut
   class AssignmentTest < Minitest::Test
     def setup
       @assignment = Assignment.new('mtsalt')

data/test/{planout → plan_out}/experiment_test.rb

@@ -1,7 +1,7 @@
 require_relative '../test_helper'
-require_relative '../../examples/planout/voting_experiment'
+require_relative '../../examples/plan_out/voting_experiment'
 
-module Planout
+module PlanOut
   class ExperimentTest < Minitest::Test
     def setup
       @voting_experiment = VotingExperiment.new(userid: 14)
@@ -15,18 +15,18 @@ module Planout
       assert_equal(1, @voting_experiment.get(:missing_key, 1))
       assert_equal('ff0000', @voting_experiment2.get(:button_color))
       assert_equal("I'm voting", @voting_experiment.get(:button_text))
-      assert_equal("I'm a voter", @voting_experiment2.get(:button_text))
+      assert_equal("I'm voting", @voting_experiment2.get(:button_text))
     end
 
     def test_get_params
       assert_equal({ button_color: 'ff0000', button_text: "I'm voting" }, @voting_experiment.get_params)
-      assert_equal({ button_color: 'ff0000', button_text: "I'm a voter" }, @voting_experiment2.get_params)
+      assert_equal({ button_color: 'ff0000', button_text: "I'm voting" }, @voting_experiment2.get_params)
     end
 
     def test_as_blob
       result = @voting_experiment.as_blob
-      assert_equal('Planout::VotingExperiment', result[:name])
-      assert_equal('Planout::VotingExperiment', result[:salt])
+      assert_equal('PlanOut::VotingExperiment', result[:name])
+      assert_equal('PlanOut::VotingExperiment', result[:salt])
       assert_equal({ userid: 14 }, result[:inputs])
     end
   end

data/test/{planout → plan_out}/operator_test.rb

@@ -1,6 +1,6 @@
 require_relative '../test_helper'
 
-module Planout
+module PlanOut
   class OperatorTest < Minitest::Test
     def setup
       @operator = Operator.new({ foo: 'bar' })

data/test/test_helper.rb

@@ -1,2 +1,2 @@
 require 'minitest/autorun'
-require_relative '../lib/planout'
+require_relative '../lib/plan_out'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: planout
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.1
 platform: ruby
 authors:
 - Eytan Bakshy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2015-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,24 +67,18 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- examples/planout/voting_experiment.rb
-- lib/planout.rb
-- lib/planout/assignment.rb
-- lib/planout/bernoulli_trial.rb
-- lib/planout/experiment.rb
-- lib/planout/op_random.rb
-- lib/planout/op_simple.rb
-- lib/planout/operator.rb
-- lib/planout/random_float.rb
-- lib/planout/random_integer.rb
-- lib/planout/simple_experiment.rb
-- lib/planout/uniform_choice.rb
-- lib/planout/version.rb
-- lib/planout/weighted_choice.rb
+- examples/plan_out/voting_experiment.rb
+- lib/plan_out.rb
+- lib/plan_out/assignment.rb
+- lib/plan_out/experiment.rb
+- lib/plan_out/op_random.rb
+- lib/plan_out/operator.rb
+- lib/plan_out/simple_experiment.rb
+- lib/plan_out/version.rb
 - planout.gemspec
-- test/planout/assignment_test.rb
-- test/planout/experiment_test.rb
-- test/planout/operator_test.rb
+- test/plan_out/assignment_test.rb
+- test/plan_out/experiment_test.rb
+- test/plan_out/operator_test.rb
 - test/test_helper.rb
 homepage: https://facebook.github.io/planout
 licenses:
@@ -106,12 +100,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: PlanOut is a framework and programming language for online field experimentation.
 test_files:
-- test/planout/assignment_test.rb
-- test/planout/experiment_test.rb
-- test/planout/operator_test.rb
+- test/plan_out/assignment_test.rb
+- test/plan_out/experiment_test.rb
+- test/plan_out/operator_test.rb
 - test/test_helper.rb

data/lib/planout.rb

@@ -1,16 +0,0 @@
-require_relative 'planout/operator'
-require_relative 'planout/op_simple'
-require_relative 'planout/op_random'
-require_relative 'planout/random_float'
-require_relative 'planout/random_integer'
-require_relative 'planout/bernoulli_trial'
-require_relative 'planout/weighted_choice'
-require_relative 'planout/uniform_choice'
-require_relative 'planout/assignment'
-require_relative 'planout/experiment'
-require_relative 'planout/simple_experiment'
-require_relative 'planout/version'
-
-module Planout
-
-end

data/lib/planout/bernoulli_trial.rb

@@ -1,11 +0,0 @@
-require_relative 'op_random'
-
-module Planout
-  class BernoulliTrial < OpRandom
-    def simple_execute
-      p = @parameters[:p]
-      rand_val = get_uniform(0.0, 1.0)
-      (rand_val <= p) ? 1 : 0
-    end
-  end
-end

data/lib/planout/op_random.rb

@@ -1,28 +0,0 @@
-require_relative 'op_simple'
-
-module Planout
-  class OpRandom < OpSimple
-    LongScale = Float(0xFFFFFFFFFFFFFFF)
-
-    def get_unit(appended_unit = nil)
-      unit = @parameters[:unit]
-      unit = [unit] if !unit.is_a? Array
-      unit += appended_unit if appended_unit != nil
-      unit
-    end
-
-    def get_hash(appended_unit = nil)
-      salt = @parameters[:salt]
-      salty = "#{@mapper.experiment_salt}.#{salt}"
-      unit_str = get_unit(appended_unit).join('.')
-      x = "#{salty}.#{unit_str}"
-      last_hex = (Digest::SHA1.hexdigest(x))[0..14]
-      last_hex.to_i(16)
-    end
-
-    def get_uniform(min_val = 0.0, max_val = 1.0, appended_unit = nil)
-      zero_to_one = self.get_hash(appended_unit)/LongScale
-      min_val + (max_val-min_val) * zero_to_one
-    end
-  end
-end

data/lib/planout/operator.rb

@@ -1,14 +0,0 @@
-require 'digest/sha1'
-
-module Planout
-  class Operator
-    attr_accessor :args
-    def initialize(parameters)
-      @args = parameters
-    end
-
-    def execute(mapper)
-      mapper.experiment_salt
-    end
-  end
-end

data/lib/planout/random_float.rb

@@ -1,11 +0,0 @@
-require_relative 'op_random'
-
-module Planout
-  class RandomFloat < OpRandom
-    def simple_execute
-      min_val = @parameters.fetch(:min, 0)
-      max_val = @parameters.fetch(:max, 1)
-      get_uniform(min_val, max_val)
-    end
-  end
-end

data/lib/planout/random_integer.rb

@@ -1,11 +0,0 @@
-require_relative 'op_random'
-
-module Planout
-  class RandomInteger < OpRandom
-    def simple_execute
-      min_val = @parameters.fetch(:min, 0)
-      max_val = @parameters.fetch(:max, 1)
-      min_val + get_hash() % (max_val - min_val + 1)
-    end
-  end
-end

data/lib/planout/uniform_choice.rb

@@ -1,12 +0,0 @@
-require_relative 'op_random'
-
-module Planout
-  class UniformChoice < OpRandom
-    def simple_execute
-      choices = @parameters[:choices]
-      return [] if choices.length() == 0
-      rand_index = get_hash() % choices.length()
-      choices[rand_index]
-    end
-  end
-end

data/lib/planout/version.rb

@@ -1,3 +0,0 @@
-module Planout
-  VERSION = '0.0.4'
-end

data/lib/planout/weighted_choice.rb

@@ -1,26 +0,0 @@
-require_relative 'op_random'
-
-module Planout
-  class WeightedChoice < OpRandom
-    def simple_execute
-      choices = @parameters[:choices]
-      weights = @parameters[:weights]
-
-      return [] if choices.length() == 0
-
-      cum_weights = choices.zip(weights)
-      cum_sum = 0.0
-
-      cum_weights.each do |choice, weight|
-        cum_sum += weight
-        cum_weights[choice] = cum_sum
-      end
-
-      stop_value = get_uniform(0.0, cum_sum)
-
-      cum_weights.each do |choice, cum_weight|
-        choice if stop_value <= cum_weight
-      end
-    end
-  end
-end