split_tester 0.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+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

@@ -0,0 +1,39 @@
+SplitTester
+===========
+
+This is a plugin that I wrote for doing split testing in a rails application with Google Analytics as your dashboard. The idea is to create an easy to use bucket testing system that wouldn't require another dashboard just for looking at the data. The logic and system are a simplified version of bucket testing based on what I've learned while bucket testing experiments on Yahoo! Search, one of the highest traffic pages on the internet.
+
+With this system, you don't need to muddy up your views, controllers or language files. The test elements are kept separate and can be turned on and off via percentage allocations of your traffic. It is a cookie based system, so users will have a consistent experience even if they end their session and return later. You can also run as many tests at the same time as you would like, only limited by the amount of traffic you have.
+
+I have also built in support for action caching so that you can keep your application fast and awesome.
+
+The code quality isn't as high as I would like and I have taken some shortcuts. I would love any help or input. :)
+
+A new test is a made up of a locale.yml file and or a collection of new views. The local file can override any translations that are in use and the views are direct replacements for views in the core app (BASELINE).
+
+Usage
+==========
+
+As a plugin:
+
+rails plugin install git://github.com/jhubert/rails-split-tester.git
+
+As a gem:
+
+Place this in your Gemfile:
+
+gem 'split_tester', :git => 'git://github.com/jhubert/rails-split-tester.git'
+
+then run:
+
+bundle install
+
+and then run the generator:
+
+rails g split_tester_install
+
+A file named split_tests.yml will be created in your config folder. This is where you will define the tests you want to run and what percentage of the traffic they should receive.
+
+A folder named "split" will be created in your test folder. This is where the actual configuration of the split tests will go.
+
+Please see my demo app for an example: https://github.com/jhubert/split-tested-app-demo

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the split_tester plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the split_tester plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SplitTester'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'lib/**/*',
+  'rails/**/*',
+  'files/*',
+  'test/**/*'
+]
+ 
+spec = Gem::Specification.new do |s|
+  s.name = "split_tester"
+  s.version = "0.3"
+  s.author = "Jeremy Hubert"
+  s.email = "jhubert@gmail.com"
+  s.homepage = "http://jeremyhubert.com/"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Provides A/B split testing functionality for Rails"
+  s.description = "Split Tester provides support for A/B Split testing your pages with integration into Google Analytics."
+  s.files = PKG_FILES.to_a
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README"]
+end
+ 
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/files/split_tests.yml

@@ -0,0 +1,9 @@
+# Size represents the percent of traffic you want for each test
+# The total of all sizes should equal 100% of traffic.
+# It's easiest to think of it as being based out of 10 or 100.
+BASELINE:
+  description: The baseline. This is a version running the default code.
+  size: 10
+FirstTest:
+  description: This is a sample test. Replace this with your actual test.
+  size: 0

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "lib", "split_tester")

data/install.rb

@@ -0,0 +1,7 @@
+# Install hook code here
+require 'fileutils'
+
+#Copy the Javascript files
+FileUtils.copy(File.dirname(__FILE__) + '/files/split_tests.yml', File.dirname(__FILE__) + '/../../../config/')
+
+FileUtils.mkdir_p(File.dirname(__FILE__) + '/../../../test/split/')

data/lib/generators/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates the initial files for the Split Tester
+
+Example:
+    rails generate split_tester
+
+    This will create:
+      config/split_tests.yml
+      test/split/

data/lib/generators/commands.rb

@@ -0,0 +1,37 @@
+require 'rails_generator'
+require 'rails_generator/commands'
+ 
+module SplitTester #:nodoc:
+  module Generator #:nodoc:
+    module Commands #:nodoc:
+      module Create
+        def setup
+          file("split_tests.yml", "definition.txt")
+        end
+      end
+ 
+      module Destroy
+        def setup
+          file("split_tests.yml", "definition.txt")
+        end
+      end
+ 
+      module List
+        def setup
+          file("split_tests.yml", "definition.txt")
+        end
+      end
+ 
+      module Update
+        def setup
+          file("split_tests.yml", "definition.txt")
+        end
+      end
+    end
+  end
+end
+ 
+Rails::Generator::Commands::Create.send   :include,  SplitTester::Generator::Commands::Create
+Rails::Generator::Commands::Destroy.send  :include,  SplitTester::Generator::Commands::Destroy
+Rails::Generator::Commands::List.send     :include,  SplitTester::Generator::Commands::List
+Rails::Generator::Commands::Update.send   :include,  SplitTester::Generator::Commands::Update

data/lib/generators/split_test_generator.rb

@@ -0,0 +1,11 @@
+require 'rails/generators'
+
+class SplitTestGenerator < Rails::Generators::NamedBase
+  argument :size, :type => :string, :default => '0', :banner => "size"
+  argument :description, :type => :string, :default => 'Your Test Description', :banner => "description"
+  source_root File.expand_path('../templates', __FILE__)
+
+  def manifest
+    append_to_file('config/split_tests.yml', "#{name}:\n  description: #{description}\n  size: #{size}\n")
+  end
+end

data/lib/generators/split_tester_install_generator.rb

@@ -0,0 +1,10 @@
+require 'rails/generators'
+
+class SplitTesterInstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def manifest
+    empty_directory('test/split/')
+    template('split_tests.yml', 'config/split_tests.yml')
+  end
+end

data/lib/generators/templates/split_tests.yml

@@ -0,0 +1,9 @@
+# Size represents the percent of traffic you want for each test
+# The total of all sizes should equal 100% of traffic.
+# It's easiest to think of it as being based out of 10 or 100.
+BASELINE:
+  description: The baseline. This is a version running the default code.
+  size: 10
+FirstTest:
+  description: This is a sample test. Replace this with your actual test.
+  size: 0

data/lib/split_tester/caching.rb

@@ -0,0 +1,14 @@
+# Change the namespace for caching if the current request
+# is a split test so that caches don't get mixed together
+module SplitTester #:nodoc:
+  module Caching
+    def self.included(base)
+      base.class_eval {
+        def fragment_cache_key(key)
+          namespace = is_split_test? ? "views-split-#{current_split_test_key}" : :views
+          ActiveSupport::Cache.expand_cache_key(key.is_a?(Hash) ? url_for(key).split("://").last : key, namespace)
+        end
+      }
+    end
+  end
+end

data/lib/split_tester/controller.rb

@@ -0,0 +1,47 @@
+module SplitTester #:nodoc:
+  module Controller
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+      base.class_eval {
+        helper_method :is_split_test?, :current_split_test_key
+
+        before_filter :setup_split_testing
+      }
+    end
+
+    module InstanceMethods
+      # If a split_test_key other than BASELINE exists, add the proper
+      # view path to the load paths used by ActionView
+      def setup_split_testing
+        return unless is_split_test?
+        split_test_path = SplitTester::Base.view_path(current_split_test_key)
+        prepend_view_path(split_test_path) if split_test_path
+      end
+
+      # Get the existing split_test_key from the session or the cookie.
+      # If there isn't one, or if the one isn't a running test anymore
+      # assign the user a new key and store it. 
+      # Don't assign a key if it is a crawler. (This doesn't feel right)
+      def get_split_test_key
+        return params[:force_test_key] if params[:force_test_key] && SplitTester::Base.active_test?(params[:force_test_key]) # just for testing
+        return session[:split_test_key] if session[:split_test_key] && SplitTester::Base.active_test?(session[:split_test_key])
+        return session[:split_test_key] = cookies[:split_test_key] if cookies[:split_test_key] && SplitTester::Base.active_test?(cookies[:split_test_key])
+        if (request.user_agent =~ /\b(Baidu|Gigabot|Googlebot|libwww-perl|lwp-trivial|msnbot|SiteUptime|Slurp|WordPress|ZIBB|ZyBorg)\b/i)
+          session[:split_test_key] = nil
+        else
+          session[:split_test_key] = SplitTester::Base.random_test_key
+          cookies[:split_test_key] = session[:split_test_key]
+        end
+        return session[:split_test_key]
+      end
+
+      def current_split_test_key
+        @split_test_key ||= get_split_test_key
+      end
+
+      def is_split_test?
+        current_split_test_key && current_split_test_key != 'BASELINE'
+      end
+    end
+  end
+end

data/lib/split_tester/railtie.rb

@@ -0,0 +1,22 @@
+require 'split_tester'
+
+module SplitTester
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      initializer "split_tester.init" do
+        SplitTester::Railtie.insert
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      ActionController::Base.send(:include, SplitTester::Controller)
+      ActionController::Caching::Fragments.send(:include, SplitTester::Caching)
+      ActionView::Helpers::TranslationHelper.send(:include, SplitTester::TranslationHelper)
+
+      SplitTester::Base.setup
+    end
+  end
+end

data/lib/split_tester/translation_helper.rb

@@ -0,0 +1,43 @@
+require 'action_view'
+
+module SplitTester
+  module TranslationHelper
+    def self.included(base)
+      # Using class_eval here because base.send(:include, InstanceMethods)
+      # wasn't overwriting the translate method properly. Not sure why.
+      base.class_eval {
+         def translate(key, options = {})
+           key = scope_key_by_partial(key)
+           if is_split_test?
+             # normalize the parameters so that we can add in 
+             # the current_split_test_key properly
+             scope = options.delete(:scope)
+             keys = I18n.normalize_keys(I18n.locale, key, scope)
+             keys.shift
+             key = keys.join('.')
+
+             # Set the standard key as a default to fall back on automatically
+             if options[:default]
+               options[:default] = [options[:default]] unless options[:default].is_a?(Array)
+               options[:default].unshift(key.to_sym)
+             else
+               options[:default] = [key.to_sym]
+             end
+
+             key = "#{current_split_test_key}.#{key}"
+           end
+           translation = I18n.translate(key, options.merge!(:raise => true))
+           if html_safe_translation_key?(key) && translation.respond_to?(:html_safe)
+             translation.html_safe
+           else
+             translation
+           end
+         rescue I18n::MissingTranslationData => e
+           keys = I18n.normalize_keys(e.locale, e.key, e.options[:scope])
+           content_tag('span', keys.join(', '), :class => 'translation_missing')
+         end
+        alias t translate
+      }
+    end
+  end
+end

data/lib/split_tester.rb

@@ -0,0 +1,70 @@
+require 'split_tester/railtie'
+require 'split_tester/controller'
+require 'split_tester/translation_helper'
+require 'split_tester/caching'
+
+module SplitTester
+  class Base
+    # Doesn't have access to Rails.root here
+    begin
+      SPLIT_TESTS = YAML.load_file("config/split_tests.yml")
+      SPLIT_TESTS.keys
+      LOADED = true
+    rescue LoadError
+      puts "[SplitTester] Missing config/split_tests.yml"
+      LOADED = false
+    rescue
+      puts "[SplitTester] Invalid config/split_tests.yml"
+      LOADED = false
+    end
+
+    def self.setup
+      if LOADED
+        # Add the split test language files to the load path
+        I18n.load_path += Dir[Rails.root.join('test', 'split', '*', 'locale.{rb,yml}')]
+
+        @@preprocessed_pathsets = begin
+          SPLIT_TESTS.keys.reject { |k| k == 'BASELINE' }.inject({}) do |pathsets, slug|
+            path = custom_view_path(slug)
+            pathsets[path] = ActionView::Base.process_view_paths(path).first
+            pathsets
+          end
+        end
+
+        @@split_test_map = begin
+          tm = {} # test map
+          SPLIT_TESTS.each { |k, v| tm[k] = v['size'].to_i }
+          tm.keys.zip(tm.values).collect { |v,d| (0...d).collect { v }}.flatten
+        end
+      else
+        @@split_test_map = []
+        @@preprocessed_pathsets = []
+      end
+    end
+
+    def self.split_test_map
+      @@split_test_map
+    end
+
+    def self.preprocessed_pathsets
+      @@preprocessed_pathsets
+    end
+
+    def self.custom_view_path(name)
+      name == "views" ? "app/views" : "test/split/#{name}/views"
+    end
+
+    def self.active_test?(key)
+      return false unless LOADED
+      SPLIT_TESTS.has_key?(key)
+    end
+
+    def self.view_path(key)
+      preprocessed_pathsets[custom_view_path(key)]
+    end
+
+    def self.random_test_key
+      split_test_map.sample
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+# Include hook code here
+require 'split_tester/railtie'
+SplitTester::Railtie.insert

data/split_tester.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'split_tester'
+  s.version     = '0.3'
+  s.summary     = 'Provides A/B split testing functionality for Rails'
+  s.description = 'Split Tester provides support for A/B Split testing your pages with integration into Google Analytics.'
+
+  s.required_ruby_version     = '>= 1.8.7'
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.author            = 'Jeremy Hubert'
+  s.email             = 'jhubert@gmail.com'
+  s.homepage          = 'http://www.jeremyhubert.com'
+
+  s.add_dependency('rails',  '>=3.0.0')
+end

data/test/split_tester_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class SplitTesterTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

data/uninstall.rb

@@ -0,0 +1,2 @@
+# Uninstall hook code here
+puts "To clean up, just remove config/split_tests.yml and test/split/"

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: split_tester
+version: !ruby/object:Gem::Version 
+  hash: 13
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  version: "0.3"
+platform: ruby
+authors: 
+- Jeremy Hubert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-25 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Split Tester provides support for A/B Split testing your pages with integration into Google Analytics.
+email: jhubert@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- init.rb
+- install.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- split_tester.gemspec
+- uninstall.rb
+- lib/generators/commands.rb
+- lib/generators/split_test_generator.rb
+- lib/generators/split_tester_install_generator.rb
+- lib/generators/templates/split_tests.yml
+- lib/generators/USAGE
+- lib/split_tester/caching.rb
+- lib/split_tester/controller.rb
+- lib/split_tester/railtie.rb
+- lib/split_tester/translation_helper.rb
+- lib/split_tester.rb
+- rails/init.rb
+- files/split_tests.yml
+- test/split_tester_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://jeremyhubert.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provides A/B split testing functionality for Rails
+test_files: []
+