vignette 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66e0ea38c02b8c4f418c7c33dba373493ffc404b
-  data.tar.gz: a337a2691497d9f323ab0827a1082025088950bd
+  metadata.gz: 9e6cdf3a27251255b9bed7d82c76816ce95edc8c
+  data.tar.gz: 6a43fd6f66033556886fc788b21ef56c3b97f66f
 SHA512:
-  metadata.gz: 152ca489cb8aa27590be5ebb73851f0480ec0a7d64071a342a846aa814db6e036406f604458e28f472ba599559083ae03dbe6910d82758826b242347436873f1
-  data.tar.gz: a7803d620dffa98ee0a0cad175dd61e087830a5f9a44454ed2336fa8d6eabc4f4693329a05b73b16d72c4b49fede8fbecfa8509c9ecdd0a12374e5610f62790b
+  metadata.gz: 55df73bf300cdc624ebc4728c5fe5fa8213bb882322fe6749059e8bdd31dff343b40aa975f33655cd31b2644ce6ee1c8932a3048c6a656f0a323debd5b15861e
+  data.tar.gz: be530c3ba036ac2d02b0f855cb0424c14b6d184fab3ae374dd5bd1013b85d85a399b003f1744f06d4246eb7be0d613b3c7f86e9318b12ff775c0dc5086a029e9

data/README.md

@@ -92,6 +92,24 @@ This will lead to `Vignette.tests` to include: `{ "cat_names" => "Chairman Meow"
 
 Without a name, Vignettes will try to name themselves based on the name of the falling calling them, e.g. `(app/models/user.rb:25)` or `(app/views/users/new.html.haml:22)`
 
+## Force Choice
+
+When using in Ruby on Rails, you may set the `force_choice_param` flag, which will allow Vignette to choose a specific split based on a url param.  E.g. in an initializer:
+
+```ruby
+Vignette.force_choice_param = :v
+```
+
+and in a controller (e.g. `home_controller.rb`)
+
+```ruby
+def home
+    @salutation = ['hello', 'goodbye'].vignette
+end
+
+```
+Then, visit: `http://localhost:3000/?v=goodbye`. This will automatically choose the 'goodbye' split. Note: this will only choose a given split if that is an option in the Vignette array itself (e.g. `v=see+you` would be ignored).
+
 ## Caveats
 
 Tests are stored in your store object based on the original input.  If you change the input of the test (regardless of the name), a new test will be created.  Thus [1,2,3].vignette(:numbers) and [2,3,4].vignette(:numbers) will always be considered unique tests.  New tests will overwrite old tests with the same name in `Vignette.tests`.  This is by design so that you can update the test, have new results, but keep the same test name in your analytics system.

data/lib/vignette/object_extensions.rb

@@ -1,11 +1,5 @@
 module ObjectExtensions
 
-  module Merge
-    def merge(store, key, hash)
-
-    end
-  end
-
   # Extensions to the Array object
   module ArrayExtensions
 
@@ -17,9 +11,6 @@ module ObjectExtensions
     def vignette(name=nil, expect_consistent_name: true)
       vignette_crc = self.crc().abs.to_s(16)
 
-      key = "vignette_#{vignette_crc}"
-      test_name = nil
-
       vig = Vignette.vig
 
       test_name = if expect_consistent_name && name.present?
@@ -35,9 +26,11 @@ module ObjectExtensions
 
       result = if vig.has_key?(vignette_crc)
         vig[vignette_crc]['v']
+      elsif Vignette.force_choice && self.include?(Vignette.force_choice)
+        Vignette.force_choice
       else
         # Store key into storage if not available
-        new_value = self[Kernel.rand(length)]
+        new_value = self[Vignette::rand(length)]
 
         Vignette.set_vig( vig.merge(vignette_crc => { n: test_name, v: new_value, t: Time.now.to_i }) )
 
@@ -68,7 +61,13 @@ module ObjectExtensions
         Hash.new
       end
 
-      Vignette.with_repo(repo) do
+      force_choice = if Vignette.force_choice_param
+        params[Vignette.force_choice_param]
+      else
+        nil
+      end
+
+      Vignette.with_repo(repo, force_choice) do
         yield
       end
     end

data/lib/vignette/version.rb

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

data/lib/vignette.rb

@@ -16,12 +16,14 @@ module Vignette
   # Module Attributes, please set via `init()`
   mattr_accessor :logging
   mattr_accessor :store
+  mattr_accessor :force_choice_param
 
   # Initialization Code
 
   # Defaults
   Vignette.store = :session
   Vignette.logging = false
+  Vignette.force_choice_param = nil
 
   # We're going to include ArrayExtensions
   ActionController::Base.send(:include, ObjectExtensions::ActionControllerExtensions)
@@ -37,19 +39,21 @@ module Vignette
   end
 
   # Sets the current repo to be used to get and store tests for this thread
-  def self.set_repo(repo)
+  def self.set_repo(repo, force_choice=nil)
     Thread.current[:vignette_repo] = repo
+    Thread.current[:vignette_force_choice] = force_choice
   end
 
   # Clears the current repo on this thread
   def self.clear_repo
-    set_repo(nil)
+    set_repo(nil, nil)
   end
 
   # Performs block with repo set to `repo` for this thread
-  def self.with_repo(repo)
+  # Force choice will be automatically selected if given
+  def self.with_repo(repo, force_choice=nil)
     begin
-      Vignette.set_repo(repo)
+      Vignette.set_repo(repo, force_choice)
 
       yield
     ensure
@@ -69,6 +73,13 @@ module Vignette
     Thread.current[:vignette_repo]
   end
 
+  # Get the force_choice for this thread
+  def self.force_choice
+    raise Errors::ConfigError.new("Repo not active, please call Vignette.set_repo before using Vignette (or use around_filter in Rails)") if !active?
+
+    Thread.current[:vignette_force_choice]
+  end
+
   # From the repo (default whatever is set for the thread), grab Vignettes' repo and unpack
   def self.vig(repo=nil)
     repo ||= Vignette.repo # allow using existing
@@ -95,11 +106,14 @@ module Vignette
   private
 
   def self.strip_path(filename)
-    if defined?(Rails) && Rails
+    if defined?(Rails) && Rails && Rails.respond_to?(:root)
       filename.gsub(Regexp.new("#{Rails.root}[/]?"), '')
     else
       filename.split('/')[-1]
     end
   end
   
+  def self.rand(length)
+    Kernel.rand(length)
+  end
 end

data/spec/lib/vignette/object_extensions_spec.rb

@@ -16,6 +16,14 @@ describe ObjectExtensions do
 
       include ObjectExtensions::ActionControllerExtensions
 
+      def set_params(p)
+        @params = p
+      end
+
+      def params
+        @params || {}
+      end
+
       def session
         { session_id: "whatever" }
       end
@@ -44,5 +52,28 @@ describe ObjectExtensions do
         expect(Vignette.tests).to eq(number: 3)
       end
     end
+
+    context "with force choice" do
+      around(:each) do |example|
+        Vignette.force_choice_param = :v
+        example.run
+        Vignette.force_choice_param = nil
+      end
+
+      it "should correctly run forced choice" do
+        expect(Kernel).to receive(:rand).never
+        expect(Vignette.active?).to be(false)
+
+        tc = TestController.new
+        tc.set_params({v: 'dog'})
+
+        tc.run do
+          expect(Vignette.repo).to eq(tc.session)
+          expect(Vignette.active?).to be(true)
+          expect(%w{cat dog parrot turtle horse}.vignette).to eq('dog')
+          expect(Vignette.tests).to eq({})
+        end
+      end
+    end
   end
 end

data/spec/lib/vignette_spec.rb

@@ -177,4 +177,28 @@ describe Vignette do
     
   end
 
+  context 'for force choice' do
+    let!(:session) { Hash.new }
+    let(:array) { %w{a b c d e f g h i j k l m n o p q r s t u v w x y z} }
+
+    it 'should store tests in session' do
+      expect(Kernel).to receive(:rand).never
+
+      Vignette.set_repo(session, 'p')
+
+      expect(array.vignette).to eq('p')
+      expect(Vignette.tests).to eq({})
+    end
+
+    it 'should store tests in session' do
+      expect(Kernel).to receive(:rand).and_return(4)
+
+      Vignette.set_repo(session, 'zz')
+
+      expect(array.vignette).to eq('e')
+      expect(Vignette.tests).to_not eq({})
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vignette
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Geoff Hayes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport