field_test 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91cef396b68f0ed43abcce42c80290ba216fe77105a947f0317925f7abb4d0fc
-  data.tar.gz: d2119a7219f278d182bf5484f959f788b03f40c129f23a58211ff8c9bfcfaeb5
+  metadata.gz: 5303485194bd6850672facf548ba671a2e661e242edfc4a4e3ad90beeed7485d
+  data.tar.gz: c694d25c71464323daf17e7cd9844d8aa8f51eb3d65e0f788e92e0f5998f18b5
 SHA512:
-  metadata.gz: fce4404e2f2c90215f14414bc9cd5e8c8cb3fb023e1adaea5a116e63e096ad52f25b1a74130cbebbd2d97e80c294b41289249172ca0c02ffb44a6d0ccaddcfe5
-  data.tar.gz: 8dcd8402e676d67c15552b93277007f4cc2fc5210a4c7beef72a5b0a0acd9e6c1f4c171cc65d8300e810acb5fd524d19f67eabef4da3b1cb86aa83e4d0c5c943
+  metadata.gz: df92ba63ed13eaec202546d497b2408288b9b4c8901e3a8a25fff96fbb098fa4c3f6acbb9edcd713f94b4ff95540c9542a3c026b4842ca519b76b7f31df2888b
+  data.tar.gz: b9407161a151713987f2db017200ad673cff0eba08f5c114d5787bb322dc4eb87f431fac708b90b42653bed90d34a71a595763cbd32cb107a2a631bcfb7f198c

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 0.3.0
+
+- Added support for native apps
+- Added `cookies` option
+- Added `precision` option
+- Fixed bug in results with multiple goals
+- Fixed issue where metrics disappeared from dashboard when moving to multiple goals
+- Dropped support for Rails < 5
+
+Breaking changes
+
+- Split out participant id and type
+- Changed participant logic for emails
+
 ## 0.2.4
 
 - Fixed `PG::AmbiguousColumn` error

data/README.md

@@ -3,11 +3,13 @@
 :maple_leaf: A/B testing for Rails
 
 - Designed for web and email
-- Comes with a [handy dashboard](https://fieldtest.dokkuapp.com/)
+- Comes with a [dashboard](https://fieldtest.dokkuapp.com/) to view results and update variants
 - Seamlessly handles the transition from anonymous visitor to logged in user
 
 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)
+
 ## Installation
 
 Add this line to your application’s Gemfile:
@@ -19,7 +21,8 @@ gem "field_test"
 Run:
 
 ```sh
-rails g field_test:install
+rails generate field_test:install
+rails db:migrate
 ```
 
 And mount the dashboard in your `config/routes.rb`:
@@ -28,7 +31,7 @@ And mount the dashboard in your `config/routes.rb`:
 mount FieldTest::Engine, at: "field_test"
 ```
 
-Be sure to [secure the dashboard](#security) in production.
+Be sure to [secure the dashboard](#dashboard-security) in production.
 
 ![Screenshot](https://ankane.github.io/field_test/screenshot6.png)
 
@@ -45,12 +48,18 @@ experiments:
       - blue
 ```
 
-Refer to it in views, controllers, and mailers.
+Refer to it in controllers, views, and mailers.
 
 ```ruby
 button_color = field_test(:button_color)
 ```
 
+To make testing easier, you can specify a variant with query parameters
+
+```
+http://localhost:3000/?field_test[button_color]=green
+```
+
 When someone converts, record it with:
 
 ```ruby
@@ -67,22 +76,60 @@ experiments:
 
 All calls to `field_test` will now return the winner, and metrics will stop being recorded.
 
-## Features
+You can get the list of experiments and variants for a user with:
+
+```ruby
+field_test_experiments
+```
 
-You can specify a variant with query parameters to make testing easier
+## JavaScript and Native Apps
 
+For JavaScript and native apps, add calls to your normal endpoints.
+
+```ruby
+class CheckoutController < ActionController::API
+  def start
+    render json: {button_color: field_test(:button_color)}
+  end
+
+  def finish
+    field_test_converted(:button_color)
+    # ...
+  end
+end
 ```
-?field_test[button_color]=green
+
+For anonymous visitors in native apps, pass a `Field-Test-Visitor` header with a unique identifier.
+
+## Participants
+
+Any model or string can be a participant in an experiment.
+
+For web requests, it uses `current_user` (if it exists) and an anonymous visitor id to determine the participant. Set your own with:
+
+```ruby
+class ApplicationController < ActionController::Base
+  def field_test_participant
+    current_company
+  end
+end
 ```
 
-Assign a specific variant to a user with:
+For mailers, it tries `@user` then `params[:user]` to determine the participant. Set your own with:
 
 ```ruby
-experiment = FieldTest::Experiment.find(:button_color)
-experiment.variant(participant, variant: "green")
+class ApplicationMailer < ActionMailer::Base
+  def field_test_participant
+    @company
+  end
+end
 ```
 
-You can also change a user’s variant from the dashboard.
+You can also manually pass a participant with:
+
+```ruby
+field_test(:button_color, participant: company)
+```
 
 ## Config
 
@@ -126,6 +173,14 @@ experiments:
       - 15
 ```
 
+To help with GDPR compliance, you can switch from cookies to [anonymity sets](https://privacypatterns.org/patterns/Anonymity-set) for anonymous visitors. Visitors with the same IP mask and user agent are grouped together.
+
+```yml
+cookies: false
+```
+
+## Dashboard Config
+
 If the dashboard gets slow, you can make it faster with:
 
 ```yml
@@ -134,12 +189,19 @@ cache: true
 
 This will use the Rails cache to speed up winning probability calculations.
 
-## Funnels
+If you need more precision, set:
+
+```yml
+precision: 1
+```
+
+## Multiple Goals
 
 You can set multiple goals for an experiment to track conversions at different parts of the funnel. First, run:
 
 ```sh
-rails g field_test:events
+rails generate field_test:events
+rails db:migrate
 ```
 
 And add to your config:
@@ -162,20 +224,30 @@ The results for all goals will appear on the dashboard.
 
 ## Analytics Platforms
 
-You can also send experiment data to analytics platforms like [Google Analytics](https://www.google.com/analytics/), [Mixpanel](https://mixpanel.com/), and [Ahoy](https://github.com/ankane/ahoy). Use:
+You may also want to send experiment data as properties to other analytics platforms like [Segment](https://segment.com), [Amplitude](https://amplitude.com), and [Ahoy](https://github.com/ankane/ahoy). Get the list of experiments and variants with:
 
 ```ruby
 field_test_experiments
 ```
 
-to get all experiments and variants for a participant and pass them as properties.
+### Ahoy
+
+You can configure Field Test to use Ahoy’s visitor token instead of creating its own:
+
+```ruby
+class ApplicationController < ActionController::Base
+  def field_test_participant
+    [ahoy.user, ahoy.visitor_token]
+  end
+end
+```
 
-## Security
+## Dashboard Security
 
 #### Devise
 
 ```ruby
-authenticate :user, -> (user) { user.admin? } do
+authenticate :user, ->(user) { user.admin? } do
   mount FieldTest::Engine, at: "field_test"
 end
 ```
@@ -189,13 +261,104 @@ ENV["FIELD_TEST_USERNAME"] = "moonrise"
 ENV["FIELD_TEST_PASSWORD"] = "kingdom"
 ```
 
-## Credits
+## Reference
 
-A huge thanks to [Evan Miller](https://www.evanmiller.org/) for deriving the Bayesian formulas.
+Assign a specific variant to a user with:
+
+```ruby
+experiment = FieldTest::Experiment.find(:button_color)
+experiment.variant(participant, variant: "green")
+```
+
+You can also change a user’s variant from the dashboard.
+
+To associate models with field test memberships, use:
+
+```ruby
+class User < ApplicationRecord
+  has_many :field_test_memberships, class_name: "FieldTest::Membership", as: :participant
+end
+```
+
+Now you can do:
+
+```ruby
+user.field_test_memberships
+```
+
+## Upgrading
+
+### 0.3.0
+
+Upgrade the gem and add to `config/field_test.yml`:
+
+```yml
+legacy_participants: true
+```
+
+Also, if you use Field Test in emails, know that the default way participants are determined has changed. Restore the previous way with:
+
+```ruby
+class ApplicationMailer < ActionMailer::Base
+  def field_test_participant
+    message.to.first
+  end
+end
+```
+
+We also recommend upgrading participants when you have time.
+
+#### Upgrading Participants
+
+Field Test 0.3.0 splits the `field_test_memberships.participant` column into `participant_type` and `participant_id`.
+
+To upgrade without downtime, create a migration:
 
-## TODO
+```sh
+rails generate migration upgrade_field_test_participants
+```
+
+with:
 
-- Code samples for analytics platforms
+```ruby
+class UpgradeFieldTestParticipants < ActiveRecord::Migration[5.2]
+  def change
+    add_column :field_test_memberships, :participant_type, :string
+    add_column :field_test_memberships, :participant_id, :string
+
+    add_index :field_test_memberships, [:participant_type, :participant_id, :experiment],
+      unique: true, name: "index_field_test_memberships_on_participant_and_experiment"
+  end
+end
+```
+
+After you run it, writes will go to both the old and new sets of columns.
+
+Next, backfill data:
+
+```ruby
+FieldTest::Membership.where(participant_id: nil).find_each do |membership|
+  participant = membership.participant
+
+  if participant.include?(":")
+    participant_type, _, participant_id = participant.rpartition(":")
+    participant_type = nil if participant_type == "cookie" # legacy
+  else
+    participant_id = participant
+  end
+
+  membership.update!(
+    participant_type: participant_type,
+    participant_id: participant_id
+  )
+end
+```
+
+Finally, remove `legacy_participants: true` from the config file. Once you confirm it’s working, you can drop the `participant` column (you can rename it first just to be extra safe).
+
+## Credits
+
+A huge thanks to [Evan Miller](https://www.evanmiller.org/) for deriving the Bayesian formulas.
 
 ## History
 

data/app/controllers/field_test/memberships_controller.rb

@@ -2,8 +2,8 @@ module FieldTest
   class MembershipsController < BaseController
     def update
       membership = FieldTest::Membership.find(params[:id])
-      membership.update_attributes(membership_params)
-      redirect_to participant_path(membership.participant)
+      membership.update!(membership_params)
+      redirect_back(fallback_location: root_path)
     end
 
     private

data/app/controllers/field_test/participants_controller.rb

@@ -1,9 +1,17 @@
 module FieldTest
   class ParticipantsController < BaseController
     def show
-      @participant = params[:id]
       # TODO better ordering
-      @memberships = FieldTest::Membership.where(participant: @participant).order(:id)
+      @memberships =
+        if FieldTest.legacy_participants
+          @participant = params[:id]
+          FieldTest::Membership.where(participant: @participant).order(:id)
+        else
+          id = params[:id]
+          type = params[:type]
+          @participant = [type, id].compact.join(" ")
+          FieldTest::Membership.where(participant_type: type, participant_id: id).order(:id)
+        end
 
       @events =
         if FieldTest.events_supported?

data/app/helpers/field_test/base_helper.rb

@@ -0,0 +1,12 @@
+module FieldTest
+  module BaseHelper
+    def field_test_participant_link(membership)
+      if FieldTest.legacy_participants
+        link_to membership.participant, legacy_participant_path(membership.participant)
+      else
+        text = [membership.participant_type, membership.participant_id].compact.join(" ")
+        link_to text, participant_path(type: membership.participant_type, id: membership.participant_id)
+      end
+    end
+  end
+end

data/app/models/field_test/membership.rb

@@ -4,7 +4,8 @@ module FieldTest
 
     has_many :events, class_name: "FieldTest::Event"
 
-    validates :participant, presence: true
+    validates :participant, presence: true, if: -> { FieldTest.legacy_participants }
+    validates :participant_id, presence: true, if: -> { !FieldTest.legacy_participants }
     validates :experiment, presence: true
     validates :variant, presence: true
   end

data/app/views/field_test/experiments/_experiments.html.erb

@@ -38,7 +38,7 @@
             <td><%= result[:converted] %></td>
             <td>
               <% if result[:conversion_rate] %>
-                <%= (100.0 * result[:conversion_rate]).round %>%
+                <%= (100.0 * result[:conversion_rate]).round(FieldTest.precision) %>%
               <% else %>
                 -
               <% end %>
@@ -48,7 +48,7 @@
                 <% if result[:prob_winning] < 0.01 %>
                   &lt; 1%
                 <% else %>
-                  <%= (100.0 * result[:prob_winning]).round %>%
+                  <%= (100.0 * result[:prob_winning]).round(FieldTest.precision) %>%
                 <% end %>
               <% end %>
             </td>

data/app/views/field_test/experiments/show.html.erb

@@ -22,7 +22,7 @@
   <tbody>
     <% @memberships.each do |membership| %>
       <tr>
-        <td><%= link_to membership.participant, participant_path(membership.participant) %></td>
+        <td><%= field_test_participant_link(membership) %></td>
         <td><%= membership.variant %></td>
         <td>
           <% converted = false %>

data/config/routes.rb

@@ -1,6 +1,7 @@
 FieldTest::Engine.routes.draw do
   resources :experiments, only: [:show]
   resources :memberships, only: [:update]
-  get "participants/:id", to: "participants#show", constraints: {id: /.+/}, as: :participant
+  get "participants/:id", to: "participants#show", constraints: {id: /.+/}, as: :legacy_participant
+  get "participants", to: "participants#show", as: :participant
   root "experiments#index"
 end

data/lib/field_test.rb

@@ -1,26 +1,36 @@
-require "browser"
+# dependencies
 require "active_support"
+require "browser"
+require "ipaddr"
+
+# modules
 require "field_test/calculations"
 require "field_test/experiment"
-require "field_test/engine" if defined?(Rails)
 require "field_test/helpers"
 require "field_test/participant"
 require "field_test/version"
 
+# integrations
+require "field_test/engine" if defined?(Rails)
+
 module FieldTest
   class Error < StandardError; end
   class ExperimentNotFound < Error; end
   class UnknownParticipant < Error; end
 
-  def self.config
-    # reload in dev
-    @config = nil if Rails.env.development?
+  # same as ahoy
+  UUID_NAMESPACE = "a82ae811-5011-45ab-a728-569df7499c5f"
 
-    @config ||= YAML.load(ERB.new(File.read("config/field_test.yml")).result)
+  def self.config_path
+    path = defined?(Rails) ? Rails.root : File
+    path.join("config", "field_test.yml")
+  end
+
+  def self.config
+    @config ||= YAML.load(ERB.new(File.read(config_path)).result)
   end
 
   def self.exclude_bots?
-    config = self.config # dev performance
     config["exclude"] && config["exclude"]["bots"]
   end
 
@@ -28,6 +38,18 @@ module FieldTest
     config["cache"]
   end
 
+  def self.cookies
+    config.key?("cookies") ? config["cookies"] : true
+  end
+
+  def self.legacy_participants
+    config["legacy_participants"]
+  end
+
+  def self.precision
+    config["precision"] || 0
+  end
+
   def self.events_supported?
     unless defined?(@events_supported)
       connection = FieldTest::Membership.connection
@@ -41,16 +63,25 @@ module FieldTest
     end
     @events_supported
   end
-end
 
-ActiveSupport.on_load(:action_controller) do
-  include FieldTest::Helpers
+  def self.mask_ip(ip)
+    addr = IPAddr.new(ip)
+    if addr.ipv4?
+      # set last octet to 0
+      addr.mask(24).to_s
+    else
+      # set last 80 bits to zeros
+      addr.mask(48).to_s
+    end
+  end
 end
 
-ActiveSupport.on_load(:action_view) do
-  include FieldTest::Helpers
+ActiveSupport.on_load(:action_controller) do
+  require "field_test/controller"
+  include FieldTest::Controller
 end
 
 ActiveSupport.on_load(:action_mailer) do
-  include FieldTest::Helpers
+  require "field_test/mailer"
+  include FieldTest::Mailer
 end

data/lib/field_test/controller.rb

@@ -0,0 +1,57 @@
+module FieldTest
+  module Controller
+    extend ActiveSupport::Concern
+    include Helpers
+
+    included do
+      if respond_to?(:helper_method)
+        helper_method :field_test
+        helper_method :field_test_converted
+        helper_method :field_test_experiments
+      end
+    end
+
+    private
+
+    def field_test_participant
+      participants = []
+
+      if respond_to?(:current_user, true)
+        user = send(:current_user)
+        participants << user if user
+      end
+
+      cookie_key = "field_test"
+
+      if request.headers["Field-Test-Visitor"]
+        token = request.headers["Field-Test-Visitor"]
+      elsif FieldTest.cookies
+        token = cookies[cookie_key]
+
+        if participants.empty? && !token
+          token = SecureRandom.uuid
+          cookies[cookie_key] = {value: token, expires: 30.days.from_now}
+        end
+      else
+        # anonymity set
+        # note: hashing does not conceal input
+        token = Digest::UUID.uuid_v5(FieldTest::UUID_NAMESPACE, ["visitor", FieldTest.mask_ip(request.remote_ip), request.user_agent].join("/"))
+
+        # delete cookie if present
+        cookies.delete(cookie_key) if cookies[cookie_key]
+      end
+
+      # sanitize tokens
+      token = token.gsub(/[^a-z0-9\-]/i, "") if token
+
+      if token.present?
+        participants << token
+
+        # backwards compatibility
+        participants << "cookie:#{token}" if FieldTest.legacy_participants
+      end
+
+      participants
+    end
+  end
+end

data/lib/field_test/experiment.rb

@@ -13,6 +13,7 @@ module FieldTest
       @started_at = Time.zone.parse(attributes[:started_at].to_s) if attributes[:started_at]
       @ended_at = Time.zone.parse(attributes[:ended_at].to_s) if attributes[:ended_at]
       @goals = attributes[:goals] || ["conversion"]
+      @goals_defined = !attributes[:goals].nil?
       @use_events = attributes[:use_events]
     end
 
@@ -30,25 +31,18 @@ module FieldTest
         membership.variant ||= weighted_variant
       end
 
+      participant = participants.first
+
       # upgrade to preferred participant
-      membership.participant = participants.first
+      membership.participant = participant.participant if membership.respond_to?(:participant=)
+      membership.participant_type = participant.type if membership.respond_to?(:participant_type=)
+      membership.participant_id = participant.id if membership.respond_to?(:participant_id=)
 
       if membership.changed?
         begin
           membership.save!
-
-          # log it!
-          info = {
-            experiment: id,
-            variant: membership.variant,
-            participant: membership.participant
-          }.merge(options.slice(:ip, :user_agent))
-
-          # sorta logfmt :)
-          info = info.map { |k, v| v = "\"#{v}\"" if k == :user_agent; "#{k}=#{v}" }.join(" ")
-          Rails.logger.info "[field test] #{info}"
         rescue ActiveRecord::RecordNotUnique
-          membership = memberships.find_by(participant: participants.first)
+          membership = memberships.find_by(participant.where_values)
         end
       end
 
@@ -100,16 +94,29 @@ module FieldTest
       relation = relation.where("field_test_memberships.created_at >= ?", started_at) if started_at
       relation = relation.where("field_test_memberships.created_at <= ?", ended_at) if ended_at
 
-      if use_events?
+      if use_events? && @goals_defined
         data = {}
-        sql =
-          relation.joins("LEFT JOIN field_test_events ON field_test_events.field_test_membership_id = field_test_memberships.id")
-            .select("variant, COUNT(DISTINCT participant) AS participated, COUNT(DISTINCT field_test_membership_id) AS converted")
-            .where(field_test_events: {name: [goal, nil]})
-
-        FieldTest::Membership.connection.select_all(sql).each do |row|
-          data[[row["variant"], true]] = row["converted"].to_i
-          data[[row["variant"], false]] = row["participated"].to_i - row["converted"].to_i
+
+        participated = relation.count
+
+        adapter_name = relation.connection.adapter_name
+        column =
+          if FieldTest.legacy_participants
+            :participant
+          elsif adapter_name =~ /postg/i # postgres
+            "(participant_type, participant_id)"
+          elsif adapter_name =~ /mysql/i
+            "participant_type, participant_id"
+          else
+            # not perfect, but it'll do
+            "COALESCE(participant_type, '') || ':' || participant_id"
+          end
+
+        converted = events.merge(relation).where(field_test_events: {name: goal}).distinct.count(column)
+
+        (participated.keys + converted.keys).uniq.each do |variant|
+          data[[variant, true]] = converted[variant].to_i
+          data[[variant, false]] = participated[variant].to_i - converted[variant].to_i
         end
       else
         data = relation.group(:converted).count
@@ -125,6 +132,7 @@ module FieldTest
           conversion_rate: participated > 0 ? converted.to_f / participated : nil
         }
       end
+
       case variants.size
       when 1, 2, 3
         total = 0.0
@@ -189,32 +197,37 @@ module FieldTest
 
     private
 
-      def check_participants(participants)
-        raise FieldTest::UnknownParticipant, "Use the :participant option to specify a participant" if participants.empty?
-      end
+    def check_participants(participants)
+      raise FieldTest::UnknownParticipant, "Use the :participant option to specify a participant" if participants.empty?
+    end
 
-      def membership_for(participants)
-        memberships = self.memberships.where(participant: participants).index_by(&:participant)
-        participants.map { |part| memberships[part] }.compact.first
+    # TODO fetch in single query
+    def membership_for(participants)
+      membership = nil
+      participants.each do |participant|
+        membership = self.memberships.find_by(participant.where_values)
+        break if membership
       end
+      membership
+    end
 
-      def weighted_variant
-        total = weights.sum.to_f
-        pick = rand
-        n = 0
-        weights.map { |w| w / total }.each_with_index do |w, i|
-          n += w
-          return variants[i] if n >= pick
-        end
-        variants.last
+    def weighted_variant
+      total = weights.sum.to_f
+      pick = rand
+      n = 0
+      weights.map { |w| w / total }.each_with_index do |w, i|
+        n += w
+        return variants[i] if n >= pick
       end
+      variants.last
+    end
 
-      def cache_fetch(key)
-        if FieldTest.cache
-          Rails.cache.fetch(key.join("/")) { yield }
-        else
-          yield
-        end
+    def cache_fetch(key)
+      if FieldTest.cache
+        Rails.cache.fetch(key.join("/")) { yield }
+      else
+        yield
       end
+    end
   end
 end

data/lib/field_test/helpers.rb

@@ -3,11 +3,11 @@ module FieldTest
     def field_test(experiment, options = {})
       exp = FieldTest::Experiment.find(experiment)
 
-      participants = field_test_participants(options)
+      participants = FieldTest::Participant.standardize(field_test_participant, options)
 
       if try(:request)
-        if params[:field_test] && params[:field_test][experiment]
-          options[:variant] ||= params[:field_test][experiment]
+        if !options[:variant] && params[:field_test] && params[:field_test][experiment]
+          params_variant = params[:field_test][experiment]
         end
 
         if FieldTest.exclude_bots?
@@ -20,67 +20,29 @@ module FieldTest
 
       # cache results for request
       @field_test_cache ||= {}
-      @field_test_cache[experiment] ||= exp.variant(participants, options)
+
+      # don't update variant when passed via params
+      @field_test_cache[experiment] ||= params_variant || exp.variant(participants, options)
     end
 
     def field_test_converted(experiment, options = {})
       exp = FieldTest::Experiment.find(experiment)
 
-      participants = field_test_participants(options)
+      participants = FieldTest::Participant.standardize(field_test_participant, options)
 
       exp.convert(participants, goal: options[:goal])
     end
 
+    # TODO fetch in single query
     def field_test_experiments(options = {})
-      participants = field_test_participants(options)
-      memberships = FieldTest::Membership.where(participant: participants).group_by(&:participant)
+      participants = FieldTest::Participant.standardize(field_test_participant, options)
       experiments = {}
       participants.each do |participant|
-        memberships[participant].to_a.each do |membership|
+        FieldTest::Membership.where(participant.where_values).each do |membership|
           experiments[membership.experiment] ||= membership.variant
         end
       end
       experiments
     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
-
-        # controllers and views
-        if try(:request)
-          # use cookie
-          cookie_key = "field_test"
-
-          token = cookies[cookie_key]
-          token = token.gsub(/[^a-z0-9\-]/i, "") if token
-
-          if participants.empty? && !token
-            token = SecureRandom.uuid
-            cookies[cookie_key] = {value: token, expires: 30.days.from_now}
-          end
-          if token
-            participants << token
-
-            # backwards compatibility
-            participants << "cookie:#{token}"
-          end
-        end
-
-        # mailers
-        to = try(:message).try(:to).try(:first)
-        if to
-          participants << to
-        end
-      end
-
-      FieldTest::Participant.standardize(participants)
-    end
   end
 end

data/lib/field_test/mailer.rb

@@ -0,0 +1,20 @@
+module FieldTest
+  module Mailer
+    extend ActiveSupport::Concern
+    include Helpers
+
+    included do
+      helper_method :field_test
+      helper_method :field_test_converted
+      helper_method :field_test_experiments
+    end
+
+    def field_test_participant
+      if @user
+        @user
+      elsif respond_to?(:params) && params
+        params[:user]
+      end
+    end
+  end
+end

data/lib/field_test/participant.rb

@@ -1,7 +1,38 @@
 module FieldTest
   class Participant
-    def self.standardize(participants)
-      Array(participants).map { |v| v.respond_to?(:model_name) ? "#{v.model_name.name}:#{v.id}" : v.to_s }
+    attr_reader :type, :id
+
+    def initialize(object)
+      if object.is_a?(FieldTest::Participant)
+        @type = object.type
+        @id = object.id
+      elsif object.respond_to?(:model_name)
+        @type = object.model_name.name
+        @id = object.id.to_s
+      else
+        @id = object.to_s
+      end
+    end
+
+    def participant
+      [type, id].compact.join(":")
+    end
+
+    def where_values
+      if FieldTest.legacy_participants
+        {
+          participant: participant
+        }
+      else
+        {
+          participant_type: type,
+          participant_id: id
+        }
+      end
+    end
+
+    def self.standardize(participants, options = {})
+      Array(options[:participant] || participants).compact.map { |v| FieldTest::Participant.new(v) }
     end
   end
 end

data/lib/field_test/version.rb

@@ -1,3 +1,3 @@
 module FieldTest
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

data/lib/generators/field_test/events_generator.rb

@@ -24,9 +24,7 @@ module FieldTest
       end
 
       def migration_version
-        if ActiveRecord::VERSION::MAJOR >= 5
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-        end
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
     end
   end

data/lib/generators/field_test/install_generator.rb

@@ -28,9 +28,7 @@ module FieldTest
       end
 
       def migration_version
-        if ActiveRecord::VERSION::MAJOR >= 5
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-        end
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
     end
   end

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

@@ -1,11 +1,9 @@
 class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :field_test_events do |t|
-      t.integer :field_test_membership_id
+      t.references :field_test_membership
       t.string :name
       t.timestamp :created_at
     end
-
-    add_index :field_test_events, :field_test_membership_id
   end
 end

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

@@ -1,15 +1,16 @@
 class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :field_test_memberships do |t|
-      t.string :participant
+      t.string :participant_type
+      t.string :participant_id
       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
+    add_index :field_test_memberships, [:participant_type, :participant_id, :experiment],
+      unique: true, name: "index_field_test_memberships_on_participant"
     add_index :field_test_memberships, [:experiment, :created_at]
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: field_test
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-01-04 00:00:00.000000000 Z
+date: 2019-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: distribution
   requirement: !ruby/object:Gem::Requirement
@@ -108,23 +108,62 @@ dependencies:
     - - ">="
       - !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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
-email:
-- andrew@chartkick.com
+email: andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - app/controllers/field_test/base_controller.rb
 - app/controllers/field_test/experiments_controller.rb
 - app/controllers/field_test/memberships_controller.rb
 - app/controllers/field_test/participants_controller.rb
+- app/helpers/field_test/base_helper.rb
 - app/models/field_test/event.rb
 - app/models/field_test/membership.rb
 - app/views/field_test/experiments/_experiments.html.erb
@@ -133,12 +172,13 @@ files:
 - app/views/field_test/participants/show.html.erb
 - app/views/layouts/field_test/application.html.erb
 - config/routes.rb
-- field_test.gemspec
 - lib/field_test.rb
 - lib/field_test/calculations.rb
+- lib/field_test/controller.rb
 - lib/field_test/engine.rb
 - lib/field_test/experiment.rb
 - lib/field_test/helpers.rb
+- lib/field_test/mailer.rb
 - lib/field_test/participant.rb
 - lib/field_test/version.rb
 - lib/generators/field_test/events_generator.rb
@@ -147,7 +187,8 @@ files:
 - lib/generators/field_test/templates/events.rb.tt
 - lib/generators/field_test/templates/memberships.rb.tt
 homepage: https://github.com/ankane/field_test
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -157,15 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A/B testing for Rails

data/.gitignore

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

data/Gemfile

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

data/Rakefile

@@ -1,10 +0,0 @@
-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/field_test.gemspec

@@ -1,30 +0,0 @@
-# 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_dependency "distribution"
-  spec.add_dependency "browser", "~> 2.0"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-end