vignette 0.0.6pre1 → 0.0.6

data/README.md

@@ -8,7 +8,7 @@ Vignette is as simple as sampling from an Array:
 
     @price = [5, 10, 15].vignette
 
-We've also added a filter to HAML for testing:
+We've also added a filter to HAML for running quick A/b tests:
 
     %h1
       :vignette
@@ -32,7 +32,7 @@ Or install it yourself as:
 
 ## Usage
 
-Vignette was crafted to make A/b testing as simple as possible.  Simply run the `vignette` function on any Array and get the result from a A/b test.  Vignette will store this choice in session, a cookies or nowhere, based on how you configure Vignette.  For this to work, all calls to Vignette must be within the request cycle (within an around_filter in ActionController::Base).  Test are identified by a checksum of the Array, and thus, changing the Array will restart that test.
+Vignette was crafted to make A/b testing as simple as possible.  Simply run the `vignette` function on any Array and get the result from a A/b test.  Vignette will store this choice in session, a cookies or nowhere, based on how you configure Vignette.  If you're in the request cycle (within an around_filter), Vignette will grab `session` or `cookies` for you.  Otherwise, you'll need to specify where to store the result (if you want it consistent for the end-user).  Vignette `tests` are identified by a checksum of the Array, and thus, changing the Array results in a new `test`.
   
     # To store in session (default)
     Vignette.init(:session)
@@ -40,7 +40,7 @@ Vignette was crafted to make A/b testing as simple as possible.  Simply run the
     # To use cookies
     Vignette.init(:cookies)
 
-    # Or random sampling
+    # Or random sampling [no persistence]
     Vignette.init(:random)
 
 Running tests:
@@ -57,7 +57,9 @@ Running tests:
 
 Finally, to store in analytics which tests were run, simple check
 
-    Vignette.test -> { 'views/orders/new.html.haml:54d3c10a1b21' => 0 } # First choice was select for new.html.haml test
+    Vignette.test -> { 'views/orders/new.html.haml:54d3c10a1b21' => 'Test one' } # First choice was select for new.html.haml test
+
+N.B. If you choose to store your `tests` in `cookies`, then the chosen result will be stored in a cookie sent to the user's browser.  Thus, be careful not to store any secret information in a test.
 
 ## Contributing
 

data/lib/vignette/version.rb

@@ -1,3 +1,3 @@
 module Vignette
-  VERSION = "0.0.6pre1"
+  VERSION = "0.0.6"
 end

data/lib/vignette.rb

@@ -1,6 +1,7 @@
 require "vignette/version"
 require "vignette/object_extensions"
 require "vignette/filter"
+require "vignette/vignette_errors"
 
 module Vignette
   # Your code goes here...

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: vignette
 version: !ruby/object:Gem::Version
-  version: 0.0.6pre1
-  prerelease: 5
+  version: 0.0.6
+  prerelease: 
 platform: ruby
 authors:
 - Geoff Hayes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies: []
 description: Simple, effective A/b testing made easy.
 email:
@@ -44,9 +44,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25