field_test 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21a7309f61348d5b03aa7a6073e2d7493dbc4f9a
+  data.tar.gz: 486affca9a9ade457fa2481925995bdc55b4a954
+SHA512:
+  metadata.gz: b9c4d1fa745aa15f132cf8c74dcfd4f456864601c661139f96bef2b9cd17266b3a8c1dfcaec56d8b7fed21617e25d83c51ead8e73a7d7c59ae0ac057c5959eff
+  data.tar.gz: d971c7c1907456a6af2162738ad4473891b02c17fd4b9b48e316757b596291cc84ee6dee73016f573284113f73a0884f611e20ab2e053af99f4929ada7e0a361

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Andrew Kane
+
+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,103 @@
+# Field Test
+
+:maple_leaf: A/B testing for Rails
+
+- Designed for web and email
+- Seamlessly handles the transition from anonymous visitor to logged in user
+- Results are stored in your database
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'field_test'
+```
+
+And run:
+
+```sh
+rails g field_test:install
+```
+
+## Getting Started
+
+Add an experiment to `config/field_test.yml`.
+
+```yml
+experiments:
+  button_color:
+    variants:
+      - control
+      - red
+      - green
+```
+
+Refer to it in views, controllers, and mailers.
+
+```ruby
+button_color = field_test(:button_color)
+```
+
+When someone converts, record it with:
+
+```ruby
+field_test_converted(:button_color)
+```
+
+Get the results with:
+
+```ruby
+experiment = FieldTest::Experiment.find(:button_color)
+experiment.results
+```
+
+When an experiment is over, specify a winner:
+
+```yml
+experiments:
+  button_color:
+    winner: red
+```
+
+All calls to `field_test` will now return the winner.
+
+## Features
+
+You can specify a variant with query parameters to make testing easier
+
+```
+http://localhost:3000/?field_test[button_color]=red
+```
+
+For mailers, you need to specify a participant:
+
+```ruby
+field_test(:button_color, participant: "test@example.org")
+```
+
+## Funnels
+
+For advanced funnels, we recommend an analytics platform like [Ahoy](https://github.com/ankane/ahoy) or [Mixpanel](https://mixpanel.com/).
+
+You can pass experiments and variants as properties.
+
+## TODO
+
+- Add confidence to stats
+- Add [Bayesian confidence](http://www.evanmiller.org/bayesian-ab-testing.html) to results
+- Exclude bots
+- User interface
+
+## History
+
+View the [changelog](https://github.com/ankane/field_test/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/field_test/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/field_test/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/app/models/field_test/membership.rb

@@ -0,0 +1,9 @@
+module FieldTest
+  class Membership < ActiveRecord::Base
+    self.table_name = "field_test_memberships"
+
+    validates :participant, presence: true
+    validates :experiment, presence: true
+    validates :variant, presence: true
+  end
+end

data/field_test.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "field_test/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "field_test"
+  spec.version       = FieldTest::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+
+  spec.summary       = "A/B testing for Rails"
+  spec.homepage      = "https://github.com/ankane/field_test"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties"
+  spec.add_dependency "activerecord"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

data/lib/field_test.rb

@@ -0,0 +1,21 @@
+require "field_test/experiment"
+require "field_test/engine"
+require "field_test/helpers"
+require "field_test/version"
+
+module FieldTest
+  class Error < StandardError; end
+  class ExperimentNotFound < Error; end
+end
+
+ActiveSupport.on_load(:action_controller) do
+  include FieldTest::Helpers
+end
+
+ActiveSupport.on_load(:action_view) do
+  include FieldTest::Helpers
+end
+
+ActiveSupport.on_load(:action_mailer) do
+  include FieldTest::Helpers
+end

data/lib/field_test/engine.rb

@@ -0,0 +1,4 @@
+module FieldTest
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/field_test/experiment.rb

@@ -0,0 +1,94 @@
+module FieldTest
+  class Experiment
+    attr_reader :id, :variants, :winner
+
+    def initialize(attributes)
+      attributes = attributes.symbolize_keys
+      @id = attributes[:id]
+      @variants = attributes[:variants]
+      @winner = attributes[:winner]
+    end
+
+    def variant(participants, options = {})
+      return winner if winner
+      return variants.first if options[:exclude]
+
+      participants = standardize_participants(participants)
+      membership = membership_for(participants) || FieldTest::Membership.new(experiment: id)
+
+      if options[:variant] && variants.include?(options[:variant])
+        membership.variant = options[:variant]
+      else
+        membership.variant ||= variants.sample
+      end
+
+      # upgrade to preferred participant
+      membership.participant = participants.first
+
+      if membership.changed?
+        begin
+          membership.save!
+        rescue ActiveRecord::RecordNotUnique
+          membership = memberships.find_by(participant: participants.first)
+        end
+      end
+
+      membership.try(:variant) || variants.first
+    end
+
+    def convert(participants)
+      participants = standardize_participants(participants)
+      membership = membership_for(participants)
+
+      if membership
+        membership.converted = true
+        membership.save! if membership.changed?
+        true
+      else
+        false
+      end
+    end
+
+    def memberships
+      FieldTest::Membership.where(experiment: id)
+    end
+
+    def results
+      data = memberships.group(:variant).group(:converted).count
+      results = {}
+      variants.each do |variant|
+        converted = data[[variant, true]].to_i
+        participated = converted + data[[variant, false]].to_i
+        results[variant] = {
+          participated: participated,
+          converted: converted,
+          conversion_rate: converted.to_f / participated
+        }
+      end
+      results
+    end
+
+    def self.find(id)
+      # reload in dev
+      @config = nil if Rails.env.development?
+
+      @config ||= YAML.load(ERB.new(File.read("config/field_test.yml")).result)
+
+      settings = @config["experiments"][id.to_s]
+      raise FieldTest::ExperimentNotFound unless settings
+
+      FieldTest::Experiment.new(settings.merge(id: id.to_s))
+    end
+
+    private
+
+      def membership_for(participants)
+        memberships = self.memberships.where(participant: participants).index_by(&:participant)
+        participants.map { |part| memberships[part] }.compact.first
+      end
+
+      def standardize_participants(participants)
+        Array(participants).map { |v| v.respond_to?(:model_name) ? "#{v.model_name.name}:#{v.id}" : v.to_s }
+      end
+  end
+end

data/lib/field_test/helpers.rb

@@ -0,0 +1,54 @@
+module FieldTest
+  module Helpers
+    def field_test(experiment, options = {})
+      exp = FieldTest::Experiment.find(experiment)
+
+      participants = field_test_participants(options)
+
+      if try(:request)
+        if params[:field_test] && params[:field_test][experiment]
+          options[:variant] ||= params[:field_test][experiment]
+        end
+      end
+
+      # cache results for request
+      @field_test_cache ||= {}
+      @field_test_cache[experiment] ||= exp.variant(participants, options)
+    end
+
+    def field_test_converted(experiment, options = {})
+      exp = FieldTest::Experiment.find(experiment)
+
+      participants = field_test_participants(options)
+
+      exp.convert(participants)
+    end
+
+    def field_test_participants(options = {})
+      participants = []
+
+      if options[:participant]
+        participants << options[:participant]
+      else
+        if respond_to?(:current_user, true) && current_user
+          participants << current_user
+        end
+
+        if try(:request)
+          # use cookie
+          cookie_key = "field_test"
+          token = cookies[cookie_key]
+          if participants.empty? && !token
+            token = SecureRandom.uuid
+            cookies[cookie_key] = {value: token, expires: 30.days.from_now}
+          end
+          if token
+            participants << "cookie:#{token.gsub(/[^a-z0-9\-]/i, "")}"
+          end
+        end
+      end
+
+      participants
+    end
+  end
+end

data/lib/field_test/version.rb

@@ -0,0 +1,3 @@
+module FieldTest
+  VERSION = "0.1.0"
+end

data/lib/generators/field_test/install_generator.rb

@@ -0,0 +1,31 @@
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+
+module FieldTest
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ::ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def copy_migration
+        migration_template "memberships.rb", "db/migrate/create_field_test_memberships.rb"
+      end
+
+      def copy_config
+        template "config.yml", "config/field_test.yml"
+      end
+    end
+  end
+end

data/lib/generators/field_test/templates/config.yml

@@ -0,0 +1,7 @@
+experiments:
+  button_color:
+    variants:
+      - control
+      - red
+      - green
+    # winner: red

data/lib/generators/field_test/templates/memberships.rb

@@ -0,0 +1,14 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :field_test_memberships do |t|
+      t.string :participant
+      t.string :experiment
+      t.string :variant
+      t.timestamp :created_at
+      t.boolean :converted, default: false
+    end
+
+    add_index :field_test_memberships, [:experiment, :participant], unique: true
+    add_index :field_test_memberships, :participant
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: field_test
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/models/field_test/membership.rb
+- field_test.gemspec
+- lib/field_test.rb
+- lib/field_test/engine.rb
+- lib/field_test/experiment.rb
+- lib/field_test/helpers.rb
+- lib/field_test/version.rb
+- lib/generators/field_test/install_generator.rb
+- lib/generators/field_test/templates/config.yml
+- lib/generators/field_test/templates/memberships.rb
+homepage: https://github.com/ankane/field_test
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A/B testing for Rails
+test_files: []