vignette 0.0.4pre2 → 0.0.5pre1

data/README.md

@@ -1,6 +1,20 @@
 # Vignette
 
-TODO: Write a gem description
+Vignette makes it dead simple to run reliable A/b tests in your Rails project.
+
+## Examples
+
+Vignette is as simple as sampling from an Array:
+
+    @price = [5, 10, 15].vignette
+
+We've also added a filter to HAML for testing:
+
+    %h1
+      :vignette
+        Welcome to the Zoo.
+        Come to see the Lions!
+        Don't get caught by a lemur!
 
 ## Installation
 
@@ -18,7 +32,32 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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.
+  
+    # To store in session (default)
+    Vignette.init(:session)
+
+    # To use cookies
+    Vignette.init(:cookies)
+
+    # Or random sampling
+    Vignette.init(:random)
+
+Running tests:
+
+    [ 1,2,3 ].vignette # Chooses an option and stores test as indicated above
+    %w{one two three}.vignette # Same with strings
+
+    # or in HAML
+
+    :vignette
+      Test one
+      Test <strong>two</strong>
+      Test #{three}
+
+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
 
 ## Contributing
 

data/lib/vignette/object_extensions.rb

@@ -35,28 +35,19 @@ module ObjectExtensions
         name
       end
 
-      store = case Vignette.store
-        when :cookies
-          raise VignetteError::ConfigError, "Missing cookies configuration in Vignette.  Must access Vignette in controller within around_filter." if Vignette.cookies.nil?
-          Rails.logger.debug [ 'Vignette::vignette', 'Cookies Sampling', key, Vignette.cookies[key] ] if Vignette.logging
-          Vignette.cookies
-        when :session
-          raise VignetteError::ConfigError, "Missing session configuration in Vignette.  Must access Vignette in controller within around_filter." if Vignette.session.nil?
-          Rails.logger.debug [ 'Vignette::vignette', 'Session Sampling', key, Vignette.session[key] ] if Vignette.logging
-          Vignette.session
-        else
-          Rails.logger.debug [ 'Vignette::vignette', 'Random Sampling' ] if Vignette.logging
-          {} # This is an empty storage
-        end
-      
+      store = Vignette.get_store
+
       choice = store[key] ||= rand(length) # Store key into storage if not available
-      
-      # We're going to track all tests in request
-      Vignette.request[:vignette] ||= {}
-      Vignette.request[:vignette][:tests] ||= {}
-      Vignette.request[:vignette][:tests][test_name] = choice
+      result = self[choice.to_i]
 
-      self[choice.to_i]
+      # TODO: Make this clearer for how to store the test items
+      if Vignette.session
+        Vignette.session[:vignette] ||= {}
+        Vignette.session[:vignette][:tests] ||= {}
+        Vignette.session[:vignette][:tests][test_name] = result
+      end
+      
+      return result
     end
 
   end

data/lib/vignette/version.rb

@@ -1,3 +1,3 @@
 module Vignette
-  VERSION = "0.0.4pre2"
+  VERSION = "0.0.5pre1"
 end

data/lib/vignette.rb

@@ -35,17 +35,29 @@ module Vignette
     Vignette.session = session
     Vignette.cookies = cookies
   end
-
+  
   def self.clear_request
     Vignette.request = Vignette.session = Vignette.cookies = nil # clear items
   end
-
-  def self.tests
-    return {} if Vignette.request.nil? # Can't return tests outside of yield
-    
-    Vignette.request[:vignette] ||= {}
-    Vignette.request[:vignette][:tests] ||= {}
-    Vignette.request[:vignette][:tests]
+  
+  def self.tests(session=Vignette.session)
+    session[:vignette] && session[:vignette][:tests] ? session[:vignette][:tests] : {}
+  end
+  
+  def self.get_store(session=Vignette.session, cookies=Vignette.cookies)
+    case Vignette.store
+    when :cookies
+      raise VignetteError::ConfigError, "Missing cookies configuration in Vignette.  Must access Vignette in controller within around_filter." if cookies.nil?
+      Rails.logger.debug [ 'Vignette::vignette', 'Cookies Sampling', cookies ] if Vignette.logging
+      cookies
+    when :session
+      raise VignetteError::ConfigError, "Missing session configuration in Vignette.  Must access Vignette in controller within around_filter." if session.nil?
+      Rails.logger.debug [ 'Vignette::vignette', 'Session Sampling', session ] if Vignette.logging
+      session
+    else
+      Rails.logger.debug [ 'Vignette::vignette', 'Random Sampling' ] if Vignette.logging
+      {} # This is an empty storage
+    end
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vignette
 version: !ruby/object:Gem::Version
-  version: 0.0.4pre2
+  version: 0.0.5pre1
   prerelease: 5
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies: []
 description: Simple, effective A/b testing made easy.
 email:
@@ -54,3 +54,4 @@ signing_key:
 specification_version: 3
 summary: With a few simple features, get A/b testing up in your application.
 test_files: []
+has_rdoc: