simple_split 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10bbe495f89c5d80168e05747bbdf32cc0ed8911
+  data.tar.gz: 64f86c88ead59e49ad0b5fc46f0dd3fc22cc98b2
+SHA512:
+  metadata.gz: eec5fe8cf16d9d28f84e62a3c99436aafe17909b5e54ec3bdce9fc30b1272fdbdede0fa36048dbff718a58633255b510c3868282747759fc5b044d4d6bb845d4
+  data.tar.gz: 8bb9f98d5a22fa4bab376e41e96ebb5cc225543f35997735c12b665b792ebfa75ba084f2132ef4ce56acc1c8c4ec5fd0dfd8703aa2ddedb1eb22d95ddfd1c86b

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,25 @@
+Encoding:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+DoubleNegation:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - "bin/**/*"
+    - "db/**/*"
+    - "config/**/*"
+    - "Rakefile"
+    - "spec/i18n_spec.rb"

data/Gemfile

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

data/README.md

@@ -0,0 +1,43 @@
+
+# simple_split – dead simple A/B testing on Rails
+
+The `simple_split` gem provides the absolute simplest possible support for split
+testing with Rails that could possibly exist. More feature-complete solutions
+like [`split`][split] provide more bells and whistles, but they also do far
+more than necessary for simple split testing with good analytics services.
+
+Instead, `simple_split` is bare-bones while still supporting flexible testing.
+
+  - Supports weighted variations
+  - Does not require the use of any data store
+  - Variations already seen by users are tracked via cookies
+
+## Quick Start
+
+Add `gem 'simple_split'` to your Gemfile, then run `bundle`. That's it. Now you
+can start adding split testing support to your project.
+
+All classes that inherit from `ActionView` or `ActionController` have access to
+the `ab_test` method. It accepts an experiment name and a list of variations.
+
+```ruby
+ab_test 'experiment_name', 'variation_a', 'variation_b', 'variation_c'
+```
+
+The result of a call to `ab_test` is a randomly selected variation. If a user
+has already seen a particular variation, that variation will always be returned
+instead of randomly selecting one.
+
+Weights can be specified using a hash.
+
+```ruby
+ab_test 'experiment_name', { 'variation_a' => 1.0, 'variation_b' => 0.2 }
+```
+
+## Credit
+
+This was inspired by the [`simple_abs`][simple_abs] gem, which was already quite
+stripped-down, but it didn't quite suit my needs.
+
+[split]: https://github.com/splitrb/split
+[simple_abs]: https://github.com/n8/simple_abs

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('bundler', 'bundler')

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'console' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('simple_split', 'console')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/setup

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'setup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('simple_split', 'setup')

data/lib/simple_split/version.rb

@@ -0,0 +1,3 @@
+module SimpleSplit
+  VERSION = '0.1.0'
+end

data/lib/simple_split.rb

@@ -0,0 +1,61 @@
+require 'active_support/all'
+require 'weighted_randomizer'
+
+module SimpleSplit
+  class TestSelector
+    def initialize(get_test, set_test)
+      @get_test = get_test
+      @set_test = set_test
+    end
+
+    def get_test(name, tests)
+      get_existing_test_value(name, tests) || assign_test(name, tests)
+    end
+
+    private
+
+    def get_existing_test_value(name, tests)
+      test_value = @get_test.call name
+      test_value if test_value.present? && tests.include?(test_value)
+    end
+
+    def assign_test(name, tests)
+      selected_test = select_test tests
+      @set_test.call name, selected_test
+      selected_test
+    end
+
+    def select_test(tests)
+      WeightedRandomizer.new(normalize_tests tests).sample
+    end
+
+    def normalize_tests(tests)
+      tests.flat_map do |test|
+        if test.is_a? Hash
+          test
+        elsif test.is_a? Array
+          normalize_tests(test)
+        else
+          { test => 1.0 }
+        end.to_a
+      end.to_h
+    end
+  end
+
+  module TestHelper
+    def ab_test(name, *tests)
+      TestSelector.new(->(k)    { cookies[k]     },
+                       ->(k, v) { cookies[k] = v })
+        .get_test name, tests
+    end
+  end
+
+  if defined? Rails
+    class Railtie < Rails::Railtie
+      initializer 'simple_split.initialize' do
+        ActionController::Base.send :include, SimpleSplit::TestHelper
+        ActionView::Base.send :include, SimpleSplit::TestHelper
+      end
+    end
+  end
+end

data/simple_split.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_split/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_split'
+  spec.version       = SimpleSplit::VERSION
+  spec.authors       = ['Alexis King']
+  spec.email         = ['alexis@gophilosophie.com']
+
+  spec.summary       = 'Dead simple, database-free AB testing in Rails'
+  spec.homepage      = 'https://github.com/lexi-lambda/simple_split'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.7.0'
+
+  spec.add_runtime_dependency 'activesupport', '>= 3.0'
+  spec.add_runtime_dependency 'weighted_randomizer', '>= 0.1.2'
+end

data/spec/lib/simple_split_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe SimpleSplit::TestSelector do
+  let(:data_store) { Hash.new }
+  let(:selector) do
+    SimpleSplit::TestSelector.new(->(k)    { data_store[k]     },
+                                  ->(k, v) { data_store[k] = v })
+  end
+
+  it 'uses an existing test if one is already set' do
+    data_store[:example_experiment] = :test_a
+    _(selector.get_test :example_experiment, [:test_a, :test_b])
+      .must_equal :test_a
+  end
+
+  it 'must save the chosen test if one does not yet exist' do
+    chosen_test = selector.get_test :example_experiment, [:test_a, :test_b]
+    _(data_store[:example_experiment]).must_equal chosen_test
+  end
+
+  it 'must select tests proportionally to their weights' do
+    non_storing_selector =
+      SimpleSplit::TestSelector.new(->(_) { nil }, ->(_, _) {})
+    tests = [{ test_a: 1.0, test_b: 2.0 }]
+
+    number_of_trials = 1_000
+    test_results = number_of_trials.times.map do
+      non_storing_selector.get_test(:example_experiment, tests) == :test_a
+    end
+    test_a_frequency = test_results.count(true).to_f / number_of_trials
+
+    _(test_a_frequency).must_be_close_to 0.3, 0.1
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'simple_split'
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: simple_split
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexis King
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: weighted_randomizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+description: 
+email:
+- alexis@gophilosophie.com
+executables:
+- bundler
+- console
+- rake
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/bundler
+- bin/console
+- bin/rake
+- bin/setup
+- lib/simple_split.rb
+- lib/simple_split/version.rb
+- simple_split.gemspec
+- spec/lib/simple_split_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lexi-lambda/simple_split
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Dead simple, database-free AB testing in Rails
+test_files:
+- spec/lib/simple_split_spec.rb
+- spec/spec_helper.rb