guinea_pig 0.1.3

data/.gitignore

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

data/.rvmrc.example

@@ -0,0 +1 @@
+rvm use --create 1.9.3-p286@guinea_pig

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ab_test.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fernando Guillen
+
+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,48 @@
+# GuineaPig
+
+Very simple ABTest functionality for Ruby, based in ActiveRecord and with Rails 3 generators
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "guinea_pig"
+
+## Usage
+
+### Configure the experiments
+
+    # config/ab_experiments.yml
+    experiment_monkey:
+      - "alternative_monkey_1"
+      - "alternative_monkey_2"
+
+    experiment_elefant:
+      - "alternative_elefant_1"
+      - "alternative_elefant_2"
+      - "alternative_elefant_3"
+
+### Create the table
+
+    rails generate guinea_pig:migration
+    rake db:migrate
+
+### Experiment!
+
+#### LandingPage experiment
+
+    redirect_to GuineaPig.alternative(:experiment_monkey, user)
+
+#### CSS experiment
+
+    <%= stylesheet_link_tag "/assets/css/#{GuineaPig.alternative(:experiment_monkey, user)}.css" %>
+
+### Convert!
+
+    if user.has_bought_something?
+      GuineaPig.conversion(:experiment_monkey, user)
+    end
+
+## Sate of the art
+
+Beta version but already used in production environments

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "."
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/guinea_pig.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/guinea_pig/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Fernando Guillen"]
+  gem.email         = ["fguillen.mail@gmail.com"]
+  gem.description   = "Very simple ABTest functionality for Ruby, based in ActiveRecord and with Rails 3 generators"
+  gem.summary       = "Very simple ABTest functionality for Ruby, based in ActiveRecord and with Rails 3 generators"
+  gem.homepage      = "https://github.com/fguillen/GuineaPig"
+
+  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          = "guinea_pig"
+  gem.require_paths = ["lib"]
+  gem.version       = GuineaPig::VERSION
+
+  gem.add_runtime_dependency "rails", "~> 3.0"
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "assert_difference"
+end

data/lib/generators/guinea_pig/migration_generator.rb

@@ -0,0 +1,25 @@
+require "rails/generators"
+
+class GuineaPig::MigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  desc "Generates migration for ABTest model"
+
+  def self.source_root
+    File.join(File.dirname(__FILE__), "templates")
+  end
+
+  def self.next_migration_number(dirname) #:nodoc:
+    migration_number_attempt = Time.now.utc.strftime("%Y%m%d%H%M%S")
+
+    if ActiveRecord::Base.timestamped_migrations && migration_number_attempt > current_migration_number(dirname).to_s
+      migration_number_attempt
+    else
+      serial_migration_number(dirname)
+    end
+  end
+
+  def copy_migration
+    migration_template "create_ab_tests.rb", "db/migrate/create_ab_tests.rb"
+  end
+end

data/lib/generators/guinea_pig/templates/create_ab_tests.rb

@@ -0,0 +1,17 @@
+class CreateAbTests < ActiveRecord::Migration
+  def self.up
+    create_table :ab_tests do |t|
+      t.string      :experiment, :null => false
+      t.string      :alternative, :null => false
+      t.integer     :guinea_pig_id, :null => false
+      t.string      :guinea_pig_type, :null => false
+      t.integer     :seen_count, :default => 0
+      t.integer     :conversion_count, :default => 0
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :ab_tests
+  end
+end

data/lib/guinea_pig.rb

@@ -0,0 +1,21 @@
+require "active_record"
+require_relative "guinea_pig/version"
+require_relative "guinea_pig/ab_test"
+require_relative "guinea_pig/experiments"
+
+module GuineaPig
+  def self.get(experiment, guinea_pig)
+    ::GuineaPig::ABTest.where(:experiment => experiment, :guinea_pig_id => guinea_pig.id, :guinea_pig_type => guinea_pig.class.name).first_or_create
+  end
+
+  def self.alternative(experiment, guinea_pig)
+    ab_test = get(experiment, guinea_pig)
+    ab_test.increment!(:seen_count)
+    ab_test.alternative
+  end
+
+  def self.conversion(experiment, guinea_pig)
+    ab_test = get(experiment, guinea_pig)
+    ab_test.conversion!
+  end
+end

data/lib/guinea_pig/ab_test.rb

@@ -0,0 +1,23 @@
+module GuineaPig
+  class ABTest < ::ActiveRecord::Base
+    before_validation :initialize_alternative, :on => :create
+
+    attr_accessible :experiment, :guinea_pig, :alternative
+
+    validates :alternative, :presence => true
+    validates :guinea_pig_id, :presence => true
+    validates :guinea_pig_type, :presence => true
+    validates :experiment, :presence => true
+    validates :experiment, :uniqueness => {:scope => [:guinea_pig_id, :guinea_pig_type]}
+
+    belongs_to :guinea_pig, :polymorphic => true
+
+    def conversion!
+      increment!(:conversion_count)
+    end
+
+    def initialize_alternative
+      self.alternative ||= ::GuineaPig::Experiments.pick_alternative(experiment)
+    end
+  end
+end

data/lib/guinea_pig/experiments.rb

@@ -0,0 +1,15 @@
+module GuineaPig
+  module Experiments
+    def self.pick_alternative(experiment)
+      experiments[experiment].sample
+    end
+
+    def self.experiments
+      @experiments ||= YAML::load(File.open(experiments_path)).symbolize_keys
+    end
+
+    def self.experiments_path
+      "#{Rails.root}/config/ab_experiments.yml"
+    end
+  end
+end

data/lib/guinea_pig/version.rb

@@ -0,0 +1,3 @@
+module GuineaPig
+  VERSION = "0.1.3"
+end

data/test/etc/test_session.rb

@@ -0,0 +1,13 @@
+require "fileutils"
+require "#{File.dirname(__FILE__)}/test/test_helper"
+
+module GuineaPig
+  module Experiments
+    def self.experiments_path
+      "#{File.dirname(__FILE__)}/test/fixtures/ab_experiments.yml"
+    end
+  end
+end
+
+user = User.create!
+ab_test = GuineaPig.get(:experiment_monkey, user)

data/test/fixtures/ab_experiments.yml

@@ -0,0 +1,8 @@
+experiment_monkey:
+  - "alternative_monkey_1"
+  - "alternative_monkey_2"
+
+experiment_elefant:
+  - "alternative_elefant_1"
+  - "alternative_elefant_2"
+  - "alternative_elefant_3"

data/test/guinea_pig_test.rb

@@ -0,0 +1,63 @@
+require_relative "test_helper"
+
+class GuineaPigTest < MiniTest::Unit::TestCase
+  def setup
+    GuineaPig::ABTest.destroy_all
+    User.destroy_all
+
+    GuineaPig::Experiments.stubs(:experiments_path).returns("#{FIXTURES}/ab_experiments.yml")
+    @user = User.create!
+  end
+
+  def test_get
+    ab_test = GuineaPig.get(:experiment_monkey, @user)
+    ab_test.reload
+
+    assert_equal("experiment_monkey", ab_test.experiment)
+    assert_includes(["alternative_monkey_1", "alternative_monkey_2"], ab_test.alternative)
+    assert_equal(@user, ab_test.guinea_pig)
+    assert_equal(0, ab_test.seen_count)
+    assert_equal(0, ab_test.conversion_count)
+  end
+
+  def test_get_multiple_times_for_the_same_guinea_pig_should_return_the_same_alternative
+    first_ab_test =
+      assert_difference "GuineaPig::ABTest.count", 1 do
+        GuineaPig.get(:experiment_monkey, @user)
+      end
+
+    second_ab_test =
+      assert_difference "GuineaPig::ABTest.count", 0 do
+        GuineaPig.get(:experiment_monkey, @user)
+      end
+
+    assert_equal(first_ab_test, second_ab_test)
+  end
+
+  def test_alternative
+    alternatives = 10.times.map { GuineaPig.alternative(:experiment_monkey, User.create!) }.uniq.sort
+    assert_equal(["alternative_monkey_1", "alternative_monkey_2"], alternatives)
+  end
+
+  def test_update_seen_counter_in_alternative
+    GuineaPig.alternative(:experiment_monkey, @user)
+    assert_equal(1, GuineaPig.get(:experiment_monkey, @user).seen_count)
+
+    GuineaPig.alternative(:experiment_monkey, @user)
+    assert_equal(2, GuineaPig.get(:experiment_monkey, @user).seen_count)
+  end
+
+  def test_conversion
+    ab_test = GuineaPig::ABTest.create!(:experiment => :experiment_monkey, :guinea_pig => @user)
+
+    assert_equal(0, ab_test.conversion_count)
+
+    GuineaPig.conversion(:experiment_monkey, @user)
+    ab_test.reload
+    assert_equal(1, ab_test.conversion_count)
+
+    GuineaPig.conversion(:experiment_monkey, @user)
+    ab_test.reload
+    assert_equal(2, ab_test.conversion_count)
+  end
+end

data/test/models.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/test/schema.rb

@@ -0,0 +1,4 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table "users", :force => true do |t|
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require "minitest/unit"
+require "minitest/autorun"
+require "mocha/setup"
+require "assert_difference"
+require_relative "../lib/guinea_pig"
+
+FileUtils.rm("#{File.dirname(__FILE__)}/db/guinea_pig.sqlite", :force => true)
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => "#{File.dirname(__FILE__)}/db/guinea_pig.sqlite"
+)
+
+require_relative "../lib/generators/guinea_pig/templates/create_ab_tests"
+CreateAbTests.up
+
+load("#{File.dirname(__FILE__)}/schema.rb")
+load("#{File.dirname(__FILE__)}/models.rb")
+
+class MiniTest::Unit::TestCase
+  include AssertDifference
+  FIXTURES = File.expand_path("#{File.dirname(__FILE__)}/fixtures")
+end
+

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: guinea_pig
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+  prerelease: 
+platform: ruby
+authors:
+- Fernando Guillen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70261810612440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70261810612440
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70261810611140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70261810611140
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70261810609940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70261810609940
+- !ruby/object:Gem::Dependency
+  name: assert_difference
+  requirement: &70261810609260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70261810609260
+description: Very simple ABTest functionality for Ruby, based in ActiveRecord and
+  with Rails 3 generators
+email:
+- fguillen.mail@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc.example
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- guinea_pig.gemspec
+- lib/generators/guinea_pig/migration_generator.rb
+- lib/generators/guinea_pig/templates/create_ab_tests.rb
+- lib/guinea_pig.rb
+- lib/guinea_pig/ab_test.rb
+- lib/guinea_pig/experiments.rb
+- lib/guinea_pig/version.rb
+- test/db/.keep
+- test/etc/test_session.rb
+- test/fixtures/ab_experiments.yml
+- test/guinea_pig_test.rb
+- test/models.rb
+- test/schema.rb
+- test/test_helper.rb
+homepage: https://github.com/fguillen/GuineaPig
+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.15
+signing_key: 
+specification_version: 3
+summary: Very simple ABTest functionality for Ruby, based in ActiveRecord and with
+  Rails 3 generators
+test_files:
+- test/db/.keep
+- test/etc/test_session.rb
+- test/fixtures/ab_experiments.yml
+- test/guinea_pig_test.rb
+- test/models.rb
+- test/schema.rb
+- test/test_helper.rb