banana_split 0.0.1

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2010 Dennis Plougmann Buus and Rasmus Rønn Nielsen
+
+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.rdoc

@@ -0,0 +1,42 @@
+== Banana Split
+
+Banana Split is a simple lightweight split testing utility for Rails. It makes it extremely easy to tests different designs on your users:
+
+  <%= ab_test :buy_form, :colorful => 'shop/colorful_buy_form', :simplistic => 'shop/simplistic_buy_form' %>
+
+Here, Bananasplit will render the shop/colorful_buy_form partial 50% of the times, and shop/simplistic_buy_form the other 50%. On the immediate action after purchase do like so to complete the goal:
+
+  def receipt
+	ab_goal :buy_form
+	# whatever...
+  end
+
+The ab_goal takes the value of the goal completion as a second argument - it defaults to 1.
+
+== Other examples
+
+  <%= submit_tag ab_test(:sign_up_button_text, {
+    :standard => { :text => 'Create user' },
+    :funky => { :text => 'Come on in!' }
+  }) %>
+
+  <%= submit_tag ab_test(:welcome_message, {
+    :simple => { :partial => 'welcome/simple_welcome_message', :locals => { :statistics => @statistics },
+    :complex => { :partial => 'welcome/complex_welcome_message', :locals => { :statistics => @statistics }
+  }) %>
+
+== Showing test results
+
+Banana Split currently provides no ways of rendering the split test results but the included models makes it very easy to do so.
+
+== Installation
+
+Add banana_split to your Gemfile:
+
+  gem 'banana_split'
+
+And run the installer:
+
+  rails generate banana_split
+
+... and you're ready to go :)

data/lib/banana_split/controller.rb

@@ -0,0 +1,21 @@
+module BananaSplit
+  module Controller
+    def self.included(base)
+      base.class_eval do
+        helper_method :current_user_id
+      end
+    end
+    
+    def ab_goal(test_name, value = 1)
+      test_run = AbTestRun.last :conditions => { :user_id => current_user_id }
+      if test_run && test_run.value == 0
+        test_run.update_attribute(:value, value)
+      end
+    end
+    
+    def current_user_id
+      current_user.id
+    end
+    
+  end
+end

data/lib/banana_split/version.rb

@@ -0,0 +1,9 @@
+module BananaSplit
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/banana_split/view_helpers.rb

@@ -0,0 +1,20 @@
+module BananaSplit
+  module ViewHelpers
+    
+    def ab_test(test_name, designs)
+      test = AbTest.find_or_create_by_name(:name => test_name.to_s)
+      
+      design_name = designs.keys.sample
+      design_render_options = designs[design_name]
+      design = AbTestDesign.find_or_create_by_ab_test_id_and_name :ab_test_id => test.id, :name => design_name.to_s
+      
+      test_run = test.runs.create({
+        :ab_test_design_id => design.id, 
+        :user_id => current_user_id
+      })
+      
+      design_render_options ? render(design_render_options) : nil
+    end
+    
+  end
+end

data/lib/banana_split.rb

@@ -0,0 +1,22 @@
+module BananaSplit
+  class << self
+    
+    def enable
+      enable_view_helpers
+      enable_controller
+    end
+    
+    def enable_view_helpers
+      require 'banana_split/view_helpers'
+      ActionView::Base.send :include, ViewHelpers
+    end
+    
+    def enable_controller
+      require 'banana_split/controller'
+      ActionController::Base.send :include, Controller
+    end
+    
+  end
+end
+
+BananaSplit.enable

data/lib/generators/banana_split_generator.rb

@@ -0,0 +1,25 @@
+module BananaSplit
+  module Generators
+    class BananaSplitGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+      namespace "banana_split"
+
+      def create_models
+        copy_file "models/ab_test.rb", "app/models/ab_test.rb"
+        copy_file "models/ab_test_design.rb", "app/models/ab_test_design.rb"
+        copy_file "models/ab_test_run.rb", "app/models/ab_test_run.rb"
+      end
+
+      def create_migration
+        migration_template "migrations/migration.rb", "db/migrate/create_banana_split_tables"
+      end
+      
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+      
+    end
+  end
+end

data/lib/generators/templates/migrations/migration.rb

@@ -0,0 +1,25 @@
+class CreateBananaSplitTables < ActiveRecord::Migration
+  def self.up
+    create_table(:ab_tests) do |t|
+      t.string :name
+    end
+    
+    create_table(:ab_test_designs) do |t|
+      t.references :ab_test
+      t.string :name
+    end
+    
+    create_table(:ab_test_runs) do |t|
+      t.references :user
+      t.references :ab_test
+      t.references :ab_test_design
+      t.integer :value, :null => false, :default => 0
+    end
+  end
+
+  def self.down
+    drop_table :ab_tests
+    drop_table :ab_test_designs
+    drop_table :ab_test_runs
+  end
+end

data/lib/generators/templates/models/ab_test.rb

@@ -0,0 +1,4 @@
+class AbTest < ActiveRecord::Base
+	has_many :designs, :class_name => 'AbTestDesign', :dependent => :destroy
+	has_many :runs, :class_name => 'AbTestRun', :dependent => :destroy
+end

data/lib/generators/templates/models/ab_test_design.rb

@@ -0,0 +1,3 @@
+class AbTestDesign < ActiveRecord::Base
+  belongs_to :ab_test
+end

data/lib/generators/templates/models/ab_test_run.rb

@@ -0,0 +1,3 @@
+class AbTestRun < ActiveRecord::Base
+  belongs_to :ab_test
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: banana_split
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dennis Plougman Buus
+- "Rasmus R\xC3\xB8nn Nielsen"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-28 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Description not written yet.
+email: rasmusrnielsen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/banana_split/controller.rb
+- lib/banana_split/version.rb
+- lib/banana_split/view_helpers.rb
+- lib/banana_split.rb
+- lib/generators/banana_split_generator.rb
+- lib/generators/templates/migrations/migration.rb
+- lib/generators/templates/models/ab_test.rb
+- lib/generators/templates/models/ab_test_design.rb
+- lib/generators/templates/models/ab_test_run.rb
+- README.rdoc
+- LICENSE
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: AB testing for Rails
+test_files: []
+