planout 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a46fae7c42eb15d3ef908da8a4fc08a2ce74122
-  data.tar.gz: afc3daae905df1a66d4b33d18e431b21f55542ed
+  metadata.gz: d5c5c1dd6ff42017cf545c0907f6787ea1f4d5a3
+  data.tar.gz: 1f07fd26a0d23f8bb5a168d72b7ae6ce719c4887
 SHA512:
-  metadata.gz: da01c78e222266fdef408b6995b0fb5766605862c2530e1d445265c56ca76297dcf3f9f69f8765b596088de49b168e7cc2812f3c9b61b18197f90c69a7b10d1f
-  data.tar.gz: 75098dea4f8ca284bfe9bd01237776fc99f636fabb2a28ada74cf2cc0bc24a5940528e945014b69de5ae6961eea96e3dadcd427e0a7398637bfe93b5b314e9da
+  metadata.gz: 9811923bb113830dc50b5513e218b927bc4ca300ab8442c68e8ea14855b51f6086f52dc94d235b71da651dadf7dfff9be35978b3dc04d323049e519e5a2fbe9a
+  data.tar.gz: 0f86286b2428c19b46ac4f3bdcbff75cff14da944ab96d33dc76214ec7ce91e7a2ba32b62eba72603b23b4ba113cceec3c0cde67b2639bcd52c573c831b9f3ca

data/README.md

@@ -22,22 +22,25 @@ $ gem install planout
 
 This defines a simple experiment that randomly assigns three variables, foo, bar, and baz.
 `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
-class VotingExperiment < SimpleExperiment
-  # Experiment#assign takes params and an input array
-  def assign(params, **inputs)
-    userid = inputs[:userid]
-
-    params[:button_color] = UniformChoice.new({
-      choices: ['ff0000', '#00ff00'],
-      unit: userid
-    })
-
-    params[:button_text] = UniformChoice.new({
-      choices: ["I'm voting", "I'm a voter"],
-      unit: userid,
-      salt:'x'
-    })
+
+```ruby
+module Planout
+  class VotingExperiment < SimpleExperiment
+    # Experiment#assign takes params and an input array
+    def assign(params, **inputs)
+      userid = inputs[:userid]
+
+      params[:button_color] = UniformChoice.new({
+        choices: ['ff0000', '#00ff00'],
+        unit: userid
+      })
+
+      params[:button_text] = UniformChoice.new({
+        choices: ["I'm voting", "I'm a voter"],
+        unit: userid,
+        salt:'x'
+      })
+    end
   end
 end
 ```
@@ -45,7 +48,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 = 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}."
@@ -54,7 +57,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":"VotingExperiment","time":1404944726,"salt":"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/lib/planout/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: planout
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Eytan Bakshy
@@ -63,7 +63,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md

data/.gitignore

@@ -1,16 +0,0 @@
-/.bundle/
-/backup/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-.DS_Store