ab_tests 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ab_tests.gemspec
+gemspec
+
+group :test do
+  gem 'debugger'
+  gem 'activerecord'
+  gem 'actionpack' # action_controller, action_view
+  gem 'combustion', '~> 0.5.0'
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'sprockets'
+  gem 'sqlite3-ruby', :require => 'sqlite3'
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Scott Schulthess
+
+MIT License
+
+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,57 @@
+# AbTests
+
+AbTests is a simple gem for creating and deploying new a/b tests with only a simple addition of some ruby code in a view.
+
+For serious applications, I would recommend reading the source code of this gem and rolling your own version for easy customization.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ab_tests'
+
+And then execute:
+
+    $ bundle
+    $ bundle exec rails g ab_tests:install
+    $ bundle exec rake db:migrate
+
+Or install it yourself as:
+
+    $ gem install ab_tests
+
+## Usage
+
+To create an a/b test merely define the following.
+
+    <%= ab_test "example test", ["variation one", "variation two"], nil do |variation| %>
+      <% if variation == "variation one" %>
+        <p>
+          Variation one
+        </p>
+      <% end %>
+      <% if variation == "variation one" %>
+        <p>
+          Variation two
+        </p>
+      <% end %>
+    <% end %>
+
+
+The ab_test helper takes the following arguements: test_name, an array of variation names, and a unique user idenitfier (optional).
+
+The results of the tests are stored in the variations table.
+
+
+Currently, AbTests does not support variation percentages.  To date I've only had to run 50/50s and other evenly proportioned tests and I merely removed the variations when I have picked a winner. 
+
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/ab_tests.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ab_tests/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Scott Schulthess"]
+  gem.email         = ["scottschulthess@gmail.com"]
+  gem.description   = %q{A small rails gem for creating and recording A/B Tests}
+  gem.summary       = %q{This gem creates a table called variations and then provides a view helper to define a/b tests and record them on the fly}
+  gem.homepage      = ""
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ab_tests"
+  gem.require_paths = ["lib"]
+  gem.version       = AbTests::VERSION
+end

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/lib/ab_tests/railtie.rb

@@ -0,0 +1,8 @@
+require 'ab_tests/view_helpers'
+module AbTests
+  class Railtie < Rails::Railtie
+    initializer "ab_tests.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/ab_tests/variation.rb

@@ -0,0 +1,3 @@
+class AbTests::Variation < ActiveRecord::Base
+  attr_accessible :chosen_variation, :test_name, :unique_identifier
+end

data/lib/ab_tests/version.rb

@@ -0,0 +1,3 @@
+module AbTests
+  VERSION = "0.0.1"
+end

data/lib/ab_tests/view_helpers.rb

@@ -0,0 +1,24 @@
+require 'ab_tests/variation'
+
+module AbTests
+  module ViewHelpers
+    def ab_test(test_name, variation_names, unique_identifier,  &block)
+      unique_id_field = AbTests.configuration.unique_identifier
+      if previous_variation = AbTests::Variation.where(unique_id_field => unique_identifier, test_name: test_name).first and unique_identifier
+        unless Rails.env.test? # a block in a rails view
+          return capture(previous_variation.chosen_variation, &block)
+        else
+          yield(previous_variation.chosen_variation)
+        end
+      end
+      chosen_variation = variation_names.sample
+      AbTests::Variation.create(test_name: test_name, chosen_variation: chosen_variation, unique_id_field => unique_identifier)
+      unless Rails.env.test? # a block in a rails view
+        return capture(chosen_variation, &block)
+      else
+        yield(chosen_variation)
+      end
+    end
+  end
+end
+

data/lib/ab_tests.rb

@@ -0,0 +1,26 @@
+require "ab_tests/version"
+require 'ab_tests/railtie' if defined?(Rails)
+
+module AbTests
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :unique_identifier
+
+    def initialize
+      @unique_identifier = :unique_identifier
+    end
+
+  end
+end

data/lib/generators/ab_tests/install/install_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/migration'
+
+module AbTests
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      argument :unique_identifier, :type => :string, :default => "unique_identifier", desc: "The user identifier for recording who saw which variation"
+      desc "Generate an initializer for configuration, and a migration for recording the test results.  Take one argument, USER_ID, which is merely the foreign key for tracking which users saw what."
+
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "create_variations.rb.erb", "db/migrate/create_variations.rb"
+      end
+
+      def copy_initializer
+        template '../templates/ab_tests.rb.erb', 'config/initializers/ab_tests.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/ab_tests/install/templates/ab_tests.rb.erb

@@ -0,0 +1,8 @@
+# stuff goes here
+
+AbTests.configure do |config|
+
+  # a unique identifier aka user_id, arrival_id - correlating the a/b tests to other user data
+  # optional
+  # config.unique_identifier =  "<%= unique_identifier.to_s %>"
+end

data/lib/generators/ab_tests/install/templates/create_variations.rb.erb

@@ -0,0 +1,13 @@
+class CreateVariations < ActiveRecord::Migration
+  def change
+    create_table :variations do |t|
+      t.string "test_name"
+      t.string "chosen_variation" 
+      t.integer "<%=unique_identifier%>"
+
+      t.timestamps
+    end
+    add_index :variations, [:test_name, "<%=unique_identifier%>" ]
+  end
+end
+

data/spec/ab_test_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'ab_tests/view_helpers'
+include AbTests::ViewHelpers
+describe AbTests::ViewHelpers do
+
+  it "succeeds" do
+    lambda { ab_test('xyz', ['1', '2', '3'], 1) { |chosen_variation| 'test'} }.should_not raise_error
+  end
+
+  it "chooses a variation" do
+    result = ab_test('xyz', ['1', '2', '3'], 1) do |chosen_variation| 
+      raise "no chosen variation" unless chosen_variation
+    end
+  end
+
+  it "returns a result" do 
+    result = ab_test('xyz', ['1', '2', '3'], 1) do |chosen_variation| 
+      'test'
+    end
+    result.should eql 'test'
+  end
+
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define do
+
+  create_table "variations", :force => true do |t|
+    t.string   "test_name"
+    t.string   "chosen_variation"
+    t.integer  "unique_identifier"
+    t.datetime "created_at",        :null => false
+    t.datetime "updated_at",        :null => false
+  end
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+#
+#
+require 'ab_tests' 
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'combustion'
+
+Combustion.initialize! :active_record, :action_controller,
+                         :action_view, :sprockets
+
+require 'rspec/rails'
+
+RSpec.configure do |config|
+    config.use_transactional_fixtures = true
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: ab_tests
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Scott Schulthess
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies: []
+description: A small rails gem for creating and recording A/B Tests
+email:
+- scottschulthess@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ab_tests.gemspec
+- config.ru
+- lib/ab_tests.rb
+- lib/ab_tests/railtie.rb
+- lib/ab_tests/variation.rb
+- lib/ab_tests/version.rb
+- lib/ab_tests/view_helpers.rb
+- lib/generators/ab_tests/install/install_generator.rb
+- lib/generators/ab_tests/install/templates/ab_tests.rb.erb
+- lib/generators/ab_tests/install/templates/create_variations.rb.erb
+- spec/ab_test_spec.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb
+homepage: ''
+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.10
+signing_key: 
+specification_version: 3
+summary: This gem creates a table called variations and then provides a view helper
+  to define a/b tests and record them on the fly
+test_files:
+- spec/ab_test_spec.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb