ab_tester 0.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'jeweler'
+  gem 'rcov'
+end

data/Gemfile.lock

@@ -0,0 +1,17 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.0)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.0)
+    rcov (0.9.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rcov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Dalton Pinto
+
+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.mdown

@@ -0,0 +1,64 @@
+# ABTester
+
+A stupid simple gem that helps to do very simple AB Tests with Rails 3 pages and emails.
+
+## Install
+
+Criando um projeto do zero:
+
+    gem install ab_tester
+
+## Usage
+
+On controller or mailer
+
+    class SomeController < ApplicationController
+      ab_tester 'choice_a' => 3, 'choice_b' => 2, 'choice_c' => 6
+
+      protected
+      def identity_hash
+        # Some way to identity uniquely a user, put something on session, cookie, or simple use some data from somewhere
+        current_user.id
+      end
+    end
+
+On view:
+
+    <p>Choice selected:</p>
+    <% ab_choice 'choice_a' %>
+      Choice A
+    <% end %>
+    <% ab_choice 'choice_a' %>
+      Choice B
+    <% end %>
+    <% ab_choice 'choice_a' %>
+      Choice C
+    <% end %>
+
+It's possible to get data on controller using choices:
+
+    def index
+      ab_choice 'all_data' do
+        @users = User.all
+      end
+
+      ab_choice 'some_users' do
+        @users = User.page(params[:page])
+      end
+    end
+
+## Statistics
+
+    rake ab_tester:stats
+
+## Reseting Stats
+
+    rake ab_tester:reset
+
+## Dumping Data
+
+    rake ab_tester:dump
+
+## TODO
+
+* Tests, shame on me!

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ab_tester"
+  gem.homepage = "http://github.com/efqdalton/ab_tester"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple gem for AB Tests}
+  gem.description = %Q{Yet another AB Test gem, but this supports AbstractController, not only ActionController}
+  gem.email = "dalthon@aluno.ita.br"
+  gem.authors = ["Dalton Pinto"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ab_tester #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/ab_tester.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ab_tester}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dalton Pinto"]
+  s.date = %q{2011-06-01}
+  s.description = %q{Yet another AB Test gem, but this supports AbstractController, not only ActionController}
+  s.email = %q{dalthon@aluno.ita.br}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.mdown"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.mdown",
+    "Rakefile",
+    "VERSION",
+    "ab_tester.gemspec",
+    "lib/ab_choice.rb",
+    "lib/ab_tester.rb",
+    "lib/ab_tester/choice_options.rb",
+    "lib/helpers/ab_choice_helper.rb",
+    "lib/rails/generators/a_b_tester/a_b_tester_generator.rb",
+    "lib/rails/generators/a_b_tester/templates/create_ab_choices.rb",
+    "lib/tasks/ab_tester.rake",
+    "test/helper.rb",
+    "test/test_ab_tester.rb"
+  ]
+  s.homepage = %q{http://github.com/efqdalton/ab_tester}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A simple gem for AB Tests}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/ab_choice.rb

@@ -0,0 +1,18 @@
+class ABChoice < ActiveRecord::Base
+  scope :succeed,   where(:success => true )
+  scope :unsucceed, where(:success => false)
+
+  def success!
+    unless success?
+      update_attributes :success => true, :succeeded_at => DateTime.now
+    end
+  end
+
+  def self.succeed(identity_hash)
+    self.find_by_identity_hash(identity_hash).success!
+  end
+
+  def self.reset!
+    self.destroy_all
+  end
+end

data/lib/ab_tester.rb

@@ -0,0 +1,56 @@
+require 'rails'
+
+autoload :ABChoice,       'ab_choice'
+autoload :ABChoiceHelper, 'helpers/ab_choice_helper'
+
+ActionView::Base.class_eval do
+  include ABChoiceHelper
+end
+
+module ABTester
+  autoload :ChoiceOptions, 'ab_tester/choice_options'
+
+  def find_or_create_choice(choice_value = self.class.ab_options.shuffle)
+    ab_choice = ABChoice.find_or_create_by_identity_hash identity_hash
+    ab_choice.update_attribute(:choice, @selected_choice_value || choice_value) unless ab_choice.choice
+    ab_choice
+  end
+
+  def choose(selected_choice_value)
+    @selected_choice_value = selected_choice_value
+  end
+
+  def ab_choice(selected_choice_value, &block)
+    @ab_choice ||= find_or_create_choice
+
+    if @ab_choice.choice == selected_choice_value.to_s
+      yield
+    else
+      nil
+    end
+  end
+
+  module ClassMethods
+    def ab_test(options_hash)
+      @ab_options = ChoiceOptions.new options_hash
+    end
+
+    def ab_options
+      @ab_options or raise "Choices definitions missing! Call at_test method on controller!"
+    end
+  end
+
+  def self.included(base)
+    base.send :extend,        ABTester::ClassMethods
+    base.send :protected,     :ab_choice
+    base.send :helper_method, :choose
+    base.send :helper_method, :identity_hash
+    base.send :helper_method, :find_or_create_choice
+  end
+
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/ab_tester.rake"
+    end
+  end
+end

data/lib/ab_tester/choice_options.rb

@@ -0,0 +1,16 @@
+class ABTester::ChoiceOptions
+  def initialize(options_hash)
+    @total_rank  = 0
+    @ranked_keys = []
+
+    options_hash.each do |key, value|
+      @total_rank += value
+      @ranked_keys << [key, @total_rank]
+    end
+  end
+
+  def shuffle
+    random_value = rand @total_rank
+    @ranked_keys.find{ |key, rank| random_value < rank }[0]
+  end
+end

data/lib/helpers/ab_choice_helper.rb

@@ -0,0 +1,11 @@
+module ABChoiceHelper
+  def ab_choice(selected_choice_value, &block)
+    @ab_choice ||= find_or_create_choice
+
+    if @ab_choice.choice == selected_choice_value.to_s
+      capture &block
+    else
+      nil
+    end
+  end
+end

data/lib/rails/generators/a_b_tester/a_b_tester_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+
+class ABTesterGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  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_choices.rb', 'db/migrate/create_ab_choices.rb'
+  end
+end

data/lib/rails/generators/a_b_tester/templates/create_ab_choices.rb

@@ -0,0 +1,15 @@
+class CreateAbChoices < ActiveRecord::Migration
+  def self.up
+    create_table :ab_choices do |t|
+      t.string      :identity_hash
+      t.boolean     :success, :default => false
+      t.string      :choice
+      t.datetime    :succeeded_at
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :ab_choices
+  end
+end

data/lib/tasks/ab_tester.rake

@@ -0,0 +1,26 @@
+namespace :ab_tester do
+  desc "Generate Statistics"
+  task :stats => :environment do
+    all_successful_choices = ABChoice.group(:choice).where(:success => true).count
+    all_choices            = ABChoice.group(:choice).count
+
+    max_choice_char_size = all_choices.keys.map{ |c| c.to_s.size }.max + 1
+
+    puts "Choices:"
+    all_choices.each do |choice, all_count|
+      puts format("  %-#{max_choice_char_size}s: %2.2f (%d/%d)", choice, all_successful_choices[choice].to_f*100/all_count, all_successful_choices[choice], all_count)
+    end
+  end
+
+  desc "I cant believe that this description is required if you want to know what it does!"
+  task :reset => :environment do
+    ABChoice.reset!
+  end
+
+  desc "Outputs a tsv file that has all data"
+  task :dump => :environment do
+    ABChoice.all.each do |c|
+      puts [c.identity_hash, c.success, c.choice, c.succeeded_at, c.created_at].join("\t")
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ab_tester'
+
+class Test::Unit::TestCase
+end

data/test/test_ab_tester.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestAbTester < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: ab_tester
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dalton Pinto
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-01 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: jeweler
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id002
+description: Yet another AB Test gem, but this supports AbstractController, not only ActionController
+email: dalthon@aluno.ita.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.mdown
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.mdown
+- Rakefile
+- VERSION
+- ab_tester.gemspec
+- lib/ab_choice.rb
+- lib/ab_tester.rb
+- lib/ab_tester/choice_options.rb
+- lib/helpers/ab_choice_helper.rb
+- lib/rails/generators/a_b_tester/a_b_tester_generator.rb
+- lib/rails/generators/a_b_tester/templates/create_ab_choices.rb
+- lib/tasks/ab_tester.rake
+- test/helper.rb
+- test/test_ab_tester.rb
+has_rdoc: true
+homepage: http://github.com/efqdalton/ab_tester
+licenses: 
+- MIT
+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.6.2
+signing_key: 
+specification_version: 3
+summary: A simple gem for AB Tests
+test_files: []
+