crabby 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+# Saber - The Simple A/B Experiment Renderer
+
+## What is Saber?
+
+Saber provides a very thin layer for organizing and displaying a/b or "split"
+test experiments. It is designed to facilitate a/b testing of site designs,
+experiences and workflows, but is meant as a lightweight alternatives to other
+a/b test frameworks.
+
+Split is not a full-featured framework. It has one role, which is to provide a
+simple DSL for displaying variations in a/b exeperiments. It is not responsible
+for recording those experiments. In this way we avoid coupling to specific
+database implementations. 
+
+There are many, many very good analytics tools and frameworks out there, and 
+we feel those are going to be the best suited to recording and analyzing the
+results of a/b experiments.
+
+## How to use Saber
+
+### In the Controllers
+
+Saber adds a simple helper method to setup an A/B experiment to your controllers
+
+For example to setup an A/B test with three variants and equal weighting:
+
+```ruby
+def index
+  setup_ab_test_parameters ['v1', 'v2', 'v3']
+end
+```
+
+If some non-uniform weighting is desired simply use a Hash
+
+```ruby
+def index
+  setup_ab_test_parameters { v1: 1, v2: 3, v3:1 }
+end
+```
+
+In the above example 'v2' is 3 times more likely than v1 or v3 to be shown. The
+weighting can be any numbers including floats, or percent values, they are
+simply used relative to their total.
+
+### In the Views
+
+Saber simply sets a parameter called `@ab_version` which is available in the
+view. However a much nicer handy view helper is provided in stead. The
+recommended usage is:
+
+```haml
+-if ab_version(:v1)
+  -# v1 specific view content goes here
+-elsif ab_version(:v2)
+  -# v2 specific view content goes here
+```
+
+There are a number of ways you can organize content for A/B tests which is why
+Saber takes no opinions on this matter. Depending on the type of A/B test the
+approach you may want to take can vary greatly.
+
+If the content between tests varies greatly then I recommend using a seperate
+partial for each test and then use the view helper to add the conditional logic
+to decide which partial to render.
+
+If the content differences are small then just sprinkle where needed.
+
+### Ensuring consistent testing using `session` variables
+
+Saber stores a session value in `session[:page_version]` with the name of the
+ab-test version. It ensures that repeated views by the same person show the same
+page (showing a different page each time would be strange and also probably
+invalidate you a/b test results somewhat).
+
+### Overriding Saber
+
+Saber can also be overidden as needed by passing a query parameter like
+`?page_version=v2`. This will skip the random selection (or the current session
+parameter) and show the 'v2' page every time (it also sets
+`session[:page_version]` to 'v2' for convenience).
+
+### Where are the Analytics?
+
+There are so many great analytics platforms out there for collecting a/b testing
+metrics that do a better job than I (or most people) could hope to achieve with
+a simple gem. 
+
+This means you are free to analyse your a/b test results with any one you choose
+(I like [Mixpanel][mp] myself). Saber may provide some integration helpers for
+these services in the future (pull requests accepted).
+
+If you really want to host your analytics then [Split][split] is probably much
+better suited to your needs.
+
+This projectd uses the MIT-LICENSE.
+
+[mp]: http://mixpanel.com
+[split]: https://github.com/andrew/split

data/Rakefile

@@ -0,0 +1,32 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Saber'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+end

data/lib/crabby.rb

@@ -0,0 +1 @@
+require 'crabby/railtie' if defined?(Rails)

data/lib/crabby/controller_helper.rb

@@ -0,0 +1,34 @@
+module Crabby
+  module ControllerHelper
+    private
+    # Helps with rendering a simple a/b test by setting a page page_version variable
+    def setup_ab_test_parameters values
+      versions = {}
+      if values.is_a? Array
+        values.each { |v| versions[v] = 1 }
+      elsif values.is_a? Hash
+        versions = values
+      else
+        raise "Must pass either a weighted hash or an array of versions to use"
+      end
+      set_version params[:page_version] if versions.keys.any? { |k| k.to_s == params[:page_version].to_s }
+      set_version(session[:page_version]) if not @ab_version and versions.keys.any? { |k| k.to_s == session[:page_version].to_s }
+      set_random_version(versions) unless @ab_version
+    end
+
+    def set_random_version versions
+      total = versions.values.inject(:+).to_f
+      roll = Random.rand(total)
+      sum = 0.0
+      version = versions.find do |k,v|
+        sum = sum + v
+        roll <= sum
+      end
+      session[:page_version] = @ab_version = version[0].to_s
+    end
+
+    def set_version version
+      session[:page_version] = @ab_version = version.to_s
+    end
+  end
+end

data/lib/crabby/railtie.rb

@@ -0,0 +1,12 @@
+require 'crabby/view_helper'
+require 'crabby/controller_helper'
+module Crabby
+  class Railtie < Rails::Railtie
+    initializer "crabby.view_helper" do
+      ActionView::Base.send :include, ViewHelper
+    end
+    initializer "crabby.controller_helper" do
+      ActionController::Base.send :include, ControllerHelper
+    end
+  end
+end

data/lib/crabby/version.rb

@@ -0,0 +1,3 @@
+module Crabby
+  VERSION = "0.0.2"
+end

data/lib/crabby/view_helper.rb

@@ -0,0 +1,7 @@
+module Crabby
+  module ViewHelper
+    def ab_version? name
+      return name.to_s == @ab_version
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: crabby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Chris Nicola
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides some utility functions for controllers and views that make running
+  a/b tests a breeze.
+email:
+- chnicola@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/crabby/controller_helper.rb
+- lib/crabby/railtie.rb
+- lib/crabby/version.rb
+- lib/crabby/view_helper.rb
+- lib/crabby.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/lucisferre/crabby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.18
+signing_key: 
+specification_version: 3
+summary: Compact rails A/B testing utilities
+test_files: []