field_test 0.2.4 → 0.4.1

data/lib/field_test/helpers.rb

@@ -1,86 +1,57 @@
 module FieldTest
   module Helpers
-    def field_test(experiment, options = {})
+    def field_test(experiment, **options)
       exp = FieldTest::Experiment.find(experiment)
 
-      participants = field_test_participants(options)
+      participants = FieldTest::Participant.standardize(options[:participant] || field_test_participant)
 
       if try(:request)
-        if params[:field_test] && params[:field_test][experiment]
-          options[:variant] ||= params[:field_test][experiment]
+        options = options.dup
+
+        if !options[:variant] && params[:field_test] && params[:field_test][experiment] && exp.variants.include?(params[:field_test][experiment])
+          params_variant = params[:field_test][experiment]
         end
 
         if FieldTest.exclude_bots?
           options[:exclude] = Browser.new(request.user_agent).bot?
         end
 
+        options[:exclude] ||= FieldTest.excluded_ips.any? { |ip| ip.include?(request.remote_ip) }
+
         options[:ip] = request.remote_ip
         options[:user_agent] = request.user_agent
       end
 
-      # cache results for request
-      @field_test_cache ||= {}
-      @field_test_cache[experiment] ||= exp.variant(participants, options)
+      # don't update variant when passed via params
+      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 = {})
+    def field_test_converted(experiment, **options)
       exp = FieldTest::Experiment.find(experiment)
 
-      participants = field_test_participants(options)
+      participants = FieldTest::Participant.standardize(options[:participant] || field_test_participant)
 
       exp.convert(participants, goal: options[:goal])
     end
 
-    def field_test_experiments(options = {})
-      participants = field_test_participants(options)
-      memberships = FieldTest::Membership.where(participant: participants).group_by(&:participant)
+    # TODO fetch in single query
+    def field_test_experiments(**options)
+      participants = FieldTest::Participant.standardize(options[:participant] || field_test_participant)
       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(participant)
+      Array(participant).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.4.1"
 end

data/lib/generators/field_test/events_generator.rb

@@ -1,32 +1,17 @@
-require "rails/generators"
-require "rails/generators/migration"
-require "active_record"
 require "rails/generators/active_record"
 
 module FieldTest
   module Generators
     class EventsGenerator < 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
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
 
       def copy_migration
         migration_template "events.rb", "db/migrate/create_field_test_events.rb", migration_version: migration_version
       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

@@ -1,23 +1,10 @@
-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
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
 
       def copy_migration
         migration_template "memberships.rb", "db/migrate/create_field_test_memberships.rb", migration_version: migration_version
@@ -28,9 +15,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
+      t.datetime :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.datetime :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.4.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-01-04 00:00:00.000000000 Z
+date: 2020-09-08 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
@@ -56,14 +56,14 @@ dependencies:
   name: browser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -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.1.2
 signing_key: 
 specification_version: 4
 summary: A/B testing for Rails