bucket 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+gem "rspec", :require => "spec"
+gem "ruby-debug"

data/README

@@ -0,0 +1,3 @@
+Bucket
+
+Description goes here.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rcov/rcovtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "bucket"
+    s.summary = %Q{A/B testing.}
+    s.email = "tyler.kovacs@gmail.com"
+    s.homepage = "http://github.com/tylerkovacs/bucket"
+    s.description = "See README"
+    s.authors = ["tylerkovacs"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'bucket'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rcov::RcovTask.new do |t|
+  t.libs << 'spec'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :noop do
+end
+
+Rake::TestTask.new(:spec => :noop) do |t|
+  t.libs << 'spec'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/TODO

@@ -0,0 +1,52 @@
+Soon
+- convert from plugin to gem
+- put on github and rubygems
+
+- general
+  - missing config directory shouldn't generate an exception at start
+  - measure spec coverage
+  - auto detect Rails and apply config hooks
+    - set controller filters, etc.
+    - apply different Rails config based on Rails version
+  - test under rails 2.3 and 3.0
+  - test under ruby 1.8.6, 1.8.7 and 1.9
+  - documentation
+    - comment source code liberally
+      - review all comments prior to first ship
+    - document all config options (logger, config_path)
+- bucket::test
+  - invalid test attribute name should log error
+    - or should it just generate an exception?
+      - if so, should it be a custom exception?
+  - option weighting
+  - attribute validation
+    - can't have empty options
+    - option weights must add up to 100
+  - users have persistent assignment to a test
+  - users can participate once or multiple times
+  - ability to define tests within the view for quick deployment
+
+
+
+config file syntax options
+
+bucket_test do
+  name 'test 1'
+  options [1, 2, 3]
+end
+
+bucket_test do
+  name 'test 2'
+  options {
+    1 => {:weight => 10},
+    2 => {:weight => 50},
+    3 => {:weight => 40}
+  }
+end
+
+bucket_test do
+  name 'test 2'
+  options [1, 2, 3]
+  weights {1 => 10, 2 => 50, 3 => 40}
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'bucket'

data/lib/bucket.rb

@@ -0,0 +1,11 @@
+class Bucket
+  include Bucket::Base
+end
+
+require "bucket/frameworks/rails" if defined?(Rails)
+
+if ENV["BUCKET_ENV"] == "test"
+  Bucket.config_path = File.join("spec", "config", "bucket")
+end
+
+Bucket.init

data/lib/bucket/base.rb

@@ -0,0 +1,38 @@
+require 'logger'
+
+class Bucket
+  module Base
+    @@config_path = File.join("config", "bucket")
+    @@logger = Logger.new(STDOUT)
+
+    ACCESSOR_NAMES = [:logger, :config_path]
+  
+    def self.included(base)
+      base.extend(ClassMethods)
+
+      ACCESSOR_NAMES.each do |accessor_name|
+        base.class_eval <<-EOF
+          def self.#{accessor_name}
+            @@#{accessor_name}
+          end
+
+          def self.#{accessor_name}=(value)
+            @@#{accessor_name} = value
+          end
+        EOF
+      end
+    end
+
+    module ClassMethods
+      def init
+        if !File.exists?(config_path)
+          logger.error("Bucket configuration directory missing: #{config_path}")
+        else
+          Dir.glob(File.join(config_path, "test_*")) do |filename|
+            Test.from_file(filename)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bucket/frameworks/rails.rb

@@ -0,0 +1,8 @@
+# Default to the Rails logger.
+Bucket.logger = RAILS_DEFAULT_LOGGER
+
+# Set config path based on RAILS_ROOT
+Bucket.config_path = File.join(RAILS_ROOT, "config", "bucket")
+
+Rails.configuration.after_initialize do
+end

data/lib/bucket/test.rb

@@ -0,0 +1,75 @@
+class Bucket
+  class Test
+    # Class variable storing all defined tests.
+    @@tests = {}
+
+    # Bucket::Test DSL
+    #
+    # The Bucket::Test DSL defines tests.
+    #
+    # Example:
+    # bucket_test do
+    #   name 'color test'
+    #   options ['red', 'green', 'blue']
+    # end
+    #
+    # Supported Attributes:
+    # name    : The name of the test.
+    # options : Test options.
+    ATTRIBUTE_NAMES = [:name, :options]
+
+    # Create get/set methods for all methods supported in the DSL.
+    ATTRIBUTE_NAMES.each do |attribute_name|
+      class_eval <<-EOF
+        def #{attribute_name}(value=nil)
+          if value
+            @attributes['#{attribute_name}'] = value
+          else
+            @attributes['#{attribute_name}']
+          end
+        end
+      EOF
+    end
+
+    def initialize
+      @attributes = {}
+    end
+
+    def choose
+      options[rand(options.length)]
+    end
+
+    def option
+      @option ||= choose
+    end
+
+    class << self
+      def from_file(filename)
+        from_string(File.read(filename))
+      end
+
+      def from_string(data)
+        instance_eval(data)
+      end
+
+      def bucket_test(options={}, &block)
+        Test.add_test(options, &block)
+      end
+
+      def add_test(options={}, &block)
+        test = self.new
+        test.instance_eval(&block)
+        @@tests[test.name] = test
+        test
+      end
+
+      def number_of_tests
+        @@tests.length
+      end
+
+      def clear!
+        @@tests.clear
+      end
+    end
+  end
+end

data/spec/lib/bucket_test_spec.rb

@@ -0,0 +1,93 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'tempfile'
+
+describe Bucket::Test do
+  before(:each) do
+    @definition =<<-EOF
+      bucket_test do
+        name 'test name'
+        options [1, 2, 3]
+      end
+    EOF
+    @test = Bucket::Test.from_string(@definition)
+  end
+
+  describe 'attributes' do
+    it 'should accept a string for the name attribute' do
+      @test.name 'new test name'
+      @test.name.should == 'new test name'
+    end
+
+    it 'should accept an array for the options attribute' do
+      @test.options [1, 2, 3, 4]
+      @test.options.should == [1, 2, 3, 4]
+    end
+  end
+
+  describe 'from_string' do
+    it 'should set supported attribute' do
+      @test.name.should == 'test name'
+      @test.options.should == [1, 2, 3]
+    end
+
+    it 'should register the new test' do
+      Bucket::Test.number_of_tests.should == 1
+    end
+  end
+
+  describe 'from_file' do
+    it 'should read the test definition from a file' do
+      Bucket::Test.clear!
+      Bucket::Test.number_of_tests.should == 0
+
+      Tempfile.open('from_file') do |file|
+        file.write @definition
+        file.fsync
+
+        new_test = Bucket::Test.from_file(file.path)
+        new_test.name.should == 'test name'
+        new_test.options.should == [1, 2, 3]
+      end
+
+      Bucket::Test.number_of_tests.should == 1
+    end
+  end
+
+  describe 'clear!' do
+    it 'should remove all registered tests' do
+      Bucket::Test.number_of_tests.should == 1
+      Bucket::Test.clear!
+      Bucket::Test.number_of_tests.should == 0
+    end
+  end
+
+  describe 'choose' do
+    it 'should choose an option at random' do
+      option = @test.choose
+      option.should_not be_nil
+      @test.options.should include(option)
+    end
+
+    it 'should choose an option using an even distribution' do
+      frequencies = Hash.new(0)
+      1000.times { frequencies[@test.choose] += 1}
+
+      frequencies.values.each do |val|
+        val.should be_close(333, 150) 
+      end
+    end
+  end
+
+  describe 'option' do
+    it 'should return the selected option' do
+      option = @test.option
+      option.should_not be_nil
+      @test.options.should include(option)
+    end
+
+    it 'should not change between calls' do
+      option = @test.option
+      10.times { @test.option.should == option }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+require 'spec'
+require 'spec/autorun'
+require 'ruby-debug'
+
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+ENV["RAILS_ENV"] = "test"
+ENV["BUCKET_ENV"] = "test"
+
+require File.dirname(__FILE__) + '/../lib/bucket/base'
+require File.dirname(__FILE__) + '/../lib/bucket/test'
+require File.dirname(__FILE__) + '/../lib/bucket'
+
+def load_environment
+  require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+  require 'spec/autorun'
+  require 'spec/rails'
+  require File.expand_path(File.dirname(__FILE__) + "/blueprints")
+  require 'lib/test/common_method'
+end
+
+Spec::Runner.configure do |config|
+  config.before(:each) { 
+    Bucket::Test.clear!
+  }
+
+  config.before(:all) { }
+  config.after(:each) { }
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: bucket
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- tylerkovacs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-08 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: See README
+email: tyler.kovacs@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- Gemfile
+- README
+- Rakefile
+- TODO
+- init.rb
+- lib/bucket.rb
+- lib/bucket/base.rb
+- lib/bucket/frameworks/rails.rb
+- lib/bucket/test.rb
+- spec/lib/bucket_test_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tylerkovacs/bucket
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A/B testing.
+test_files: 
+- spec/lib/bucket_test_spec.rb
+- spec/spec_helper.rb