field_test 0.3.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a60826c451cf3807f5e111f2b4a619f4c07db0011ff27e7f2ceb0dd03bd1807
-  data.tar.gz: 1150b7a05035bf91193dcdaca20a7075b1350d50ef037afebe6a1866baea5fb9
+  metadata.gz: 0b7676acb9075e7701de0019e3c7ca18a0242db8c87348d024006ff787c42d13
+  data.tar.gz: 92849469d6ca65422ef3f2a1b77f08c7695d79fa336b463cedf3991770be15cd
 SHA512:
-  metadata.gz: 9a2644d12172b876b33ddc7faec2c4490623fed35aa7ae1848f0486a9ff176a80c2bdc2db66ec9196b93034f8566dbfc11c2027f524177a946427b6c4b10d71b
-  data.tar.gz: 1dc282f0f054e7a95bdc4dfccd1361c11f28b53d70a2b5083ba73e40d3af13230246ad85e38990f74e7dab01a48fb5be9fefc5b2e6e1d8dff8cf066bb1dc525a
+  metadata.gz: 9f21fa35a6f44d085bbbfbd15e8174e7dd7f8a0d411e3a584097d59793776a0c0bd783cb4a3d7fee7f07402190a1a61487e1be554492208536f375b3e1981c7f
+  data.tar.gz: aeb943baab224022931a634fa190bbb3837856b3f0ee956c919f1233c6c6796a5251216a65334cd34878487e5902a251e695722a8982a19ffca6711e1d6113cf

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.5.1 (2021-09-22)
+
+- Improved performance of Bayesian calculations
+
+## 0.5.0 (2021-09-21)
+
+- Significantly improved performance of Bayesian calculations
+- Dropped support for Ruby < 2.6 and Rails < 5.2
+
+## 0.4.1 (2020-09-07)
+
+- Use `datetime` type in migration
+
+## 0.4.0 (2020-08-04)
+
+- Fixed CSRF vulnerability with non-session based authentication - [more info](https://github.com/ankane/field_test/issues/28)
+- Fixed cache key for requests
+
 ## 0.3.2 (2020-04-16)
 
 - Added support for excluding IP addresses
@@ -11,7 +29,7 @@
 
 Security
 
-- Fixed arbitrary variants via query parameters - see [#17](https://github.com/ankane/field_test/issues/17)
+- Fixed arbitrary variants via query parameters - [more info](https://github.com/ankane/field_test/issues/17)
 
 ## 0.3.0 (2019-06-02)
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016-2019 Andrew Kane
+Copyright (c) 2016-2021 Andrew Kane
 
 MIT License
 

data/README.md

@@ -9,7 +9,7 @@
 
 Uses [Bayesian statistics](https://www.evanmiller.org/bayesian-ab-testing.html) to evaluate results so you don’t need to choose a sample size ahead of time.
 
-[![Build Status](https://travis-ci.org/ankane/field_test.svg?branch=master)](https://travis-ci.org/ankane/field_test)
+[![Build Status](https://github.com/ankane/field_test/workflows/build/badge.svg?branch=master)](https://github.com/ankane/field_test/actions)
 
 ## Installation
 
@@ -160,7 +160,7 @@ experiment = FieldTest::Experiment.find(:button_color)
 button_color = experiment.variant(user)
 ```
 
-## Config
+## Exclusions
 
 By default, bots are returned the first variant and excluded from metrics. Change this with:
 
@@ -178,6 +178,14 @@ exclude:
     - 10.0.0.0/8
 ```
 
+You can also use custom logic:
+
+```ruby
+field_test(:button_color, exclude: request.user_agent == "Test")
+```
+
+## Config
+
 Keep track of when experiments started and ended. Use any format `Time.parse` accepts. Variants assigned outside this window are not included in metrics.
 
 ```yml

data/app/controllers/field_test/base_controller.rb

@@ -2,7 +2,7 @@ module FieldTest
   class BaseController < ActionController::Base
     layout "field_test/application"
 
-    protect_from_forgery
+    protect_from_forgery with: :exception
 
     http_basic_authenticate_with name: ENV["FIELD_TEST_USERNAME"], password: ENV["FIELD_TEST_PASSWORD"] if ENV["FIELD_TEST_PASSWORD"]
   end

data/ext/field_test/bayesian_ab.hpp

@@ -0,0 +1,103 @@
+#pragma once
+
+#include <cmath>
+#include <vector>
+
+namespace bayesian_ab {
+
+double logbeta(double a, double b) {
+  return std::lgamma(a) + std::lgamma(b) - std::lgamma(a + b);
+}
+
+double prob_b_beats_a(int alpha_a, int beta_a, int alpha_b, int beta_b) {
+  double total = 0.0;
+  double logbeta_aa_ba = logbeta(alpha_a, beta_a);
+  double beta_ba = beta_b + beta_a;
+
+  for (auto i = 0; i < alpha_b; i++) {
+    total += exp(logbeta(alpha_a + i, beta_ba) - log(beta_b + i) - logbeta(1 + i, beta_b) - logbeta_aa_ba);
+  }
+
+  return total;
+}
+
+double prob_c_beats_a_and_b(int alpha_a, int beta_a, int alpha_b, int beta_b, int alpha_c, int beta_c) {
+  double total = 0.0;
+
+  double logbeta_ac_bc = logbeta(alpha_c, beta_c);
+
+  std::vector<double> log_bb_j_logbeta_j_bb;
+  log_bb_j_logbeta_j_bb.reserve(alpha_b);
+
+  for (auto j = 0; j < alpha_b; j++) {
+    log_bb_j_logbeta_j_bb.push_back(log(beta_b + j) + logbeta(1 + j, beta_b));
+  }
+
+  double abc = beta_a + beta_b + beta_c;
+  std::vector<double> logbeta_ac_i_j;
+  logbeta_ac_i_j.reserve(alpha_a + alpha_b);
+
+  for (auto i = 0; i < alpha_a + alpha_b; i++) {
+    logbeta_ac_i_j.push_back(logbeta(alpha_c + i, abc));
+  }
+
+  for (auto i = 0; i < alpha_a; i++) {
+    double sum_i = -log(beta_a + i) - logbeta(1 + i, beta_a) - logbeta_ac_bc;
+
+    for (auto j = 0; j < alpha_b; j++) {
+      total += exp(sum_i + logbeta_ac_i_j[i + j] - log_bb_j_logbeta_j_bb[j]);
+    }
+  }
+
+  return 1 - prob_b_beats_a(alpha_c, beta_c, alpha_a, beta_a) -
+    prob_b_beats_a(alpha_c, beta_c, alpha_b, beta_b) + total;
+}
+
+double prob_d_beats_a_and_b_and_c(int alpha_a, int beta_a, int alpha_b, int beta_b, int alpha_c, int beta_c, int alpha_d, int beta_d) {
+  double total = 0.0;
+
+  double logbeta_ad_bd = logbeta(alpha_d, beta_d);
+
+  std::vector<double> log_bb_j_logbeta_j_bb;
+  log_bb_j_logbeta_j_bb.reserve(alpha_b);
+
+  for (auto j = 0; j < alpha_b; j++) {
+    log_bb_j_logbeta_j_bb.push_back(log(beta_b + j) + logbeta(1 + j, beta_b));
+  }
+
+  std::vector<double> log_bc_k_logbeta_k_bc;
+  log_bc_k_logbeta_k_bc.reserve(alpha_c);
+
+  for (auto k = 0; k < alpha_c; k++) {
+    log_bc_k_logbeta_k_bc.push_back(log(beta_c + k) + logbeta(1 + k, beta_c));
+  }
+
+  double abcd = beta_a + beta_b + beta_c + beta_d;
+  std::vector<double> logbeta_bd_i_j_k;
+  logbeta_bd_i_j_k.reserve(alpha_a + alpha_b + alpha_c);
+
+  for (auto i = 0; i < alpha_a + alpha_b + alpha_c; i++) {
+    logbeta_bd_i_j_k.push_back(logbeta(alpha_d + i, abcd));
+  }
+
+  for (auto i = 0; i < alpha_a; i++) {
+    double sum_i = -log(beta_a + i) - logbeta(1 + i, beta_a) - logbeta_ad_bd;
+
+    for (auto j = 0; j < alpha_b; j++) {
+      double sum_j = sum_i - log_bb_j_logbeta_j_bb[j];
+
+      for (auto k = 0; k < alpha_c; k++) {
+        total += exp(sum_j + logbeta_bd_i_j_k[i + j + k] - log_bc_k_logbeta_k_bc[k]);
+      }
+    }
+  }
+
+  return 1 - prob_b_beats_a(alpha_a, beta_a, alpha_d, beta_d) -
+    prob_b_beats_a(alpha_b, beta_b, alpha_d, beta_d) -
+    prob_b_beats_a(alpha_c, beta_c, alpha_d, beta_d) +
+    prob_c_beats_a_and_b(alpha_a, beta_a, alpha_b, beta_b, alpha_d, beta_d) +
+    prob_c_beats_a_and_b(alpha_a, beta_a, alpha_c, beta_c, alpha_d, beta_d) +
+    prob_c_beats_a_and_b(alpha_b, beta_b, alpha_c, beta_c, alpha_d, beta_d) - total;
+}
+
+}

data/ext/field_test/ext.cpp

@@ -0,0 +1,12 @@
+#include <rice/rice.hpp>
+#include "bayesian_ab.hpp"
+
+extern "C"
+void Init_ext() {
+  auto rb_mFieldTest = Rice::define_module("FieldTest");
+
+  Rice::define_class_under(rb_mFieldTest, "Calculations")
+    .define_singleton_function("prob_b_beats_a", &bayesian_ab::prob_b_beats_a)
+    .define_singleton_function("prob_c_beats_a_and_b", &bayesian_ab::prob_c_beats_a_and_b)
+    .define_singleton_function("prob_d_beats_a_and_b_and_c", &bayesian_ab::prob_d_beats_a_and_b_and_c);
+}

data/ext/field_test/extconf.rb

@@ -0,0 +1,5 @@
+require "mkmf-rice"
+
+$CXXFLAGS << " -std=c++17 $(optflags)"
+
+create_makefile("field_test/ext")

data/lib/field_test/helpers.rb

@@ -22,11 +22,16 @@ module FieldTest
         options[:user_agent] = request.user_agent
       end
 
-      # cache results for request
-      @field_test_cache ||= {}
-
       # don't update variant when passed via params
-      @field_test_cache[experiment] ||= params_variant || exp.variant(participants, options)
+      if params_variant
+        params_variant
+      else
+        # cache results for request
+        # TODO possibly remove in 0.4.0
+        cache_key = [exp.id, participants.map(&:where_values), options.slice(:variant, :exclude)]
+        @field_test_cache ||= {}
+        @field_test_cache[cache_key] ||= exp.variant(participants, options)
+      end
     end
 
     def field_test_converted(experiment, **options)

data/lib/field_test/version.rb

@@ -1,3 +1,3 @@
 module FieldTest
-  VERSION = "0.3.2"
+  VERSION = "0.5.1"
 end

data/lib/field_test.rb

@@ -3,8 +3,10 @@ require "active_support"
 require "browser"
 require "ipaddr"
 
+# ext
+require "field_test/ext"
+
 # modules
-require "field_test/calculations"
 require "field_test/experiment"
 require "field_test/helpers"
 require "field_test/participant"

data/lib/generators/field_test/templates/events.rb.tt

@@ -3,7 +3,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
     create_table :field_test_events do |t|
       t.references :field_test_membership
       t.string :name
-      t.timestamp :created_at
+      t.datetime :created_at
     end
   end
 end

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

@@ -5,7 +5,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
       t.string :participant_id
       t.string :experiment
       t.string :variant
-      t.timestamp :created_at
+      t.datetime :created_at
       t.boolean :converted, default: false
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: field_test
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.1
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,42 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
-- !ruby/object:Gem::Dependency
-  name: distribution
-  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'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: browser
   requirement: !ruby/object:Gem::Requirement
@@ -67,93 +53,24 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.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'
-- !ruby/object:Gem::Dependency
-  name: minitest
+  name: rice
   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: combustion
-  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: rails
-  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: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 4.0.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
-email: andrew@chartkick.com
+        version: 4.0.2
+description:
+email: andrew@ankane.org
 executables: []
-extensions: []
+extensions:
+- ext/field_test/extconf.rb
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
@@ -172,8 +89,10 @@ files:
 - app/views/field_test/participants/show.html.erb
 - app/views/layouts/field_test/application.html.erb
 - config/routes.rb
+- ext/field_test/bayesian_ab.hpp
+- ext/field_test/ext.cpp
+- ext/field_test/extconf.rb
 - lib/field_test.rb
-- lib/field_test/calculations.rb
 - lib/field_test/controller.rb
 - lib/field_test/engine.rb
 - lib/field_test/experiment.rb
@@ -190,7 +109,7 @@ homepage: https://github.com/ankane/field_test
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -198,15 +117,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: A/B testing for Rails
 test_files: []

data/lib/field_test/calculations.rb

@@ -1,58 +0,0 @@
-require "distribution/math_extension"
-
-# formulas from
-# https://www.evanmiller.org/bayesian-ab-testing.html
-module FieldTest
-  module Calculations
-    def self.prob_b_beats_a(alpha_a, beta_a, alpha_b, beta_b)
-      total = 0.0
-
-      # for performance
-      logbeta_aa_ba = Math.logbeta(alpha_a, beta_a)
-      beta_ba = beta_b + beta_a
-
-      0.upto(alpha_b - 1) do |i|
-        total += Math.exp(Math.logbeta(alpha_a + i, beta_ba) -
-          Math.log(beta_b + i) - Math.logbeta(1 + i, beta_b) -
-          logbeta_aa_ba)
-      end
-
-      total
-    end
-
-    def self.prob_c_beats_a_and_b(alpha_a, beta_a, alpha_b, beta_b, alpha_c, beta_c)
-      total = 0.0
-
-      # for performance
-      logbeta_ac_bc = Math.logbeta(alpha_c, beta_c)
-      abc = beta_a + beta_b + beta_c
-      log_bb_j = []
-      logbeta_j_bb = []
-      logbeta_ac_i_j = []
-      0.upto(alpha_b - 1) do |j|
-        log_bb_j[j] = Math.log(beta_b + j)
-        logbeta_j_bb[j] = Math.logbeta(1 + j, beta_b)
-
-        0.upto(alpha_a - 1) do |i|
-          logbeta_ac_i_j[i + j] ||= Math.logbeta(alpha_c + i + j, abc)
-        end
-      end
-
-      0.upto(alpha_a - 1) do |i|
-        # for performance
-        log_ba_i = Math.log(beta_a + i)
-        logbeta_i_ba = Math.logbeta(1 + i, beta_a)
-
-        0.upto(alpha_b - 1) do |j|
-          total += Math.exp(logbeta_ac_i_j[i + j] -
-            log_ba_i - log_bb_j[j] -
-            logbeta_i_ba - logbeta_j_bb[j] -
-            logbeta_ac_bc)
-        end
-      end
-
-      1 - prob_b_beats_a(alpha_c, beta_c, alpha_a, beta_a) -
-        prob_b_beats_a(alpha_c, beta_c, alpha_b, beta_b) + total
-    end
-  end
-end