vignette 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f45e9d2eb38a89e35ec4bf6d0cf62d80f77b92ad
-  data.tar.gz: 8ab414f006635373e0a88eaae142b85f4a205c1c
+  metadata.gz: 66e0ea38c02b8c4f418c7c33dba373493ffc404b
+  data.tar.gz: a337a2691497d9f323ab0827a1082025088950bd
 SHA512:
-  metadata.gz: 0f5b19dea4363391a52e2f7758e03007c0a616d29e15f59f285942d4b15ea3918ff7281160cee2427341bafd0139f7e7c658c97acd97fd13c565a75421c2d183
-  data.tar.gz: a98445107d11417e51eef0e16566a5cdc1559995ed061a8cc53b01930e02641ba68ccb96ef088620a10984ed14e60594a9c9e5a65946243975f009f5f38e6823
+  metadata.gz: 152ca489cb8aa27590be5ebb73851f0480ec0a7d64071a342a846aa814db6e036406f604458e28f472ba599559083ae03dbe6910d82758826b242347436873f1
+  data.tar.gz: a7803d620dffa98ee0a0cad175dd61e087830a5f9a44454ed2336fa8d6eabc4f4693329a05b73b16d72c4b49fede8fbecfa8509c9ecdd0a12374e5610f62790b

data/README.md

@@ -1,6 +1,6 @@
 # Vignette
 
-Vignette makes it dead simple to run reliable A/b tests in your Rails project.
+Vignette makes it dead simple to run reliable A/b tests in your Ruby projects.  Vignette integrates seamlessly with Rails by default.
 
 ## Examples
 
@@ -32,7 +32,11 @@ 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.  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`.
+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 a simple Hash object, based on how you configure Vignette.
+
+If you run Vignettes from within a Rails request cycle (set up automatically by 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).  You can simply call `Vignette.with_repo(Hash.new)` with wherever you want the current tests stored.
+
+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(store: :session)
@@ -64,6 +68,12 @@ The choices for these tests are exposed through the `Vignette.test` method:
 
 You may store these values as properties in your analytics system.
 
+## Stores
+
+You can set anything for the store so long as it can take keys and values based on []= (e.g. `repo["k"] = "v"`).  We will handle serialization, etc.  That said, if you are using a custom store, it must be unique for each "user".  Thus, if you want to keep a global hash object `TESTS`, then you would want to do: `Vignette.with_repo(TESTS[user.id] ||= {})`.
+
+If you are in `rails`, then you can simply run `Vignette.set_store(store: :session)` and Vignette will automatically set the repo to be `session` or `cookies` for each request.
+
 ## Naming Tests
 
 Vignette tests can also be specifically named, e.g:

data/lib/vignette/object_extensions.rb

@@ -52,7 +52,7 @@ module ObjectExtensions
   module ActionControllerExtensions
 
     def self.included(controller)
-      controller.around_filter(:with_vignettes)
+      controller.prepend_around_filter(:with_vignettes)
     end
 
     private

data/lib/vignette/version.rb

@@ -1,3 +1,3 @@
 module Vignette
-  VERSION = "0.0.14"
+  VERSION = "0.0.15"
 end

data/spec/lib/vignette/object_extensions_spec.rb

@@ -10,7 +10,7 @@ describe ObjectExtensions do
         @@filters
       end
 
-      def self.around_filter(filter)
+      def self.prepend_around_filter(filter)
         @@filters << filter
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vignette
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Geoff Hayes