vanity 2.2.8 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 32b2be75e4a14bf3ce84ba1a49f3ae8b86e6fcf6
-  data.tar.gz: 40c8689393515ddd853df28130eace503b1327cb
+SHA256:
+  metadata.gz: 7481c8ea284e72b569511d54af761ad1626fdfe9246dbb0750fdf56d5f04b2ba
+  data.tar.gz: 8ebab61bbb360d445e30d555114a006608693499878cf9655b6765b0148959da
 SHA512:
-  metadata.gz: 91931eacb3c34fdf4e9caa8c1ca98b62f0e3cbfd521a58ace103eec63177d28fcfe64646db79d25bb1daeac93dda0814c02dc8d665d2509ccaed30a00c230493
-  data.tar.gz: 1604cd40d0e73ac1e26a0ba5eebbeaba98e5efa03e23bb50dde6d279325302e8881852808470c3b170b98345d6f36f6d457fdebd4f578404c7b5620f3a1650fb
+  metadata.gz: 930f5cd9d45efdbd8bb9463cfe40914d3e6f87a57cd481d1accc5c7bd328aaf2d52e18a132665dc5100deda3f80662bcc96d94ffab76499c05a1c7b5a14aaf68
+  data.tar.gz: 0aa058369c4f8218be1837d24bbc9c68e5f27110e9829a97aab1e8183d5748e0f614be9901de4f9fd8b266dceb0342efbe57baef9b320cd17c69db1574575dfc

data/.github/workflows/test.yml

@@ -0,0 +1,55 @@
+name: Test
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches: '*'
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+      mongo:
+        image: mongo
+        ports:
+          - 27017:27017
+    strategy:
+      matrix:
+        ruby:
+          - 2.5
+          # - jruby-9.2.20.1
+        db:
+          - mongodb
+          - redis
+          - active_record
+        gemfile:
+          - gemfiles/rails42.gemfile
+          - gemfiles/rails42_protected_attributes.gemfile
+          - gemfiles/rails51.gemfile
+          - gemfiles/rails52.gemfile
+          - gemfiles/rails60.gemfile
+          - gemfiles/rails61.gemfile
+        exclude:
+          - ruby: jruby-9.1.13.0
+            gemfile: gemfiles/rails5.gemfile
+    env:
+      DB: ${{ matrix.db }}
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run Tests
+        run: bundle exec rake test

data/Appraisals

@@ -1,38 +1,42 @@
-appraise "rails32" do
+appraise "rails42" do
   gem "mocha",  "~> 1.0", :require=>false
-  gem "minitest", "~>4.2.0"
-  gem "rails", "3.2.22"
-  gem "minitest_tu_shim", "~> 1.3.3", :platforms => :mri_22
-  gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
+  gem "rails", "4.2.9"
+  gem "fastthread", :github => "zoltankiss/fastthread", :platforms => :mri_20
   gem "passenger", "~>3.0"
-  gem "test-unit", "~> 3.0"
 end
 
-appraise "rails41" do
+appraise "rails42-protected_attributes" do
+  gem "protected_attributes", "1.1.0"
   gem "mocha",  "~> 1.0", :require=>false
-  gem "rails", "4.1.9"
-  gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
+  gem "rails", "4.2.9"
+  gem "fastthread", :github => "zoltankiss/fastthread", :platforms => :mri_20
   gem "passenger", "~>3.0"
 end
 
-appraise "rails42" do
+appraise "rails51" do
   gem "mocha",  "~> 1.0", :require=>false
-  gem "rails", "4.2.0"
-  gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
+  gem "rails", "~>5.1.0"
+  gem "fastthread", :github => "zoltankiss/fastthread", :platforms => :mri_20
   gem "passenger", "~>3.0"
 end
 
-appraise "rails42-protected_attributes" do
-  gem "protected_attributes", "1.1.0"
+appraise "rails52" do
   gem "mocha",  "~> 1.0", :require=>false
-  gem "rails", "4.2.0"
-  gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
+  gem "rails", "~>5.2.0"
+  gem "fastthread", :github => "zoltankiss/fastthread", :platforms => :mri_20
   gem "passenger", "~>3.0"
 end
 
-appraise "rails5" do
+appraise "rails60" do
   gem "mocha",  "~> 1.0", :require=>false
-  gem "rails", "5.0.0"
-  gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
+  gem "rails", "~>5.2.0"
+  gem "fastthread", :github => "zoltankiss/fastthread", :platforms => :mri_20
   gem "passenger", "~>3.0"
-end
+end
+
+appraise "rails61" do
+  gem "mocha",  "~> 1.0", :require=>false
+  gem "rails", "~>5.2.0"
+  gem "fastthread", :github => "zoltankiss/fastthread", :platforms => :mri_20
+  gem "passenger", "~>3.0"
+end

data/CHANGELOG

@@ -1,4 +1,23 @@
-== Unreleased
+== 3.0.1 (2022-01-26)
+
+* Update template rendering and update_attributes for Rails 6.1 compatibility (@bensheldon)
+
+== 3.0.0 (2018-11-02)
+
+* Fully destroy experiments using the Redis adapter (@urbanautomaton)
+* Fix support for rails 5.1, 5.2 migrations (@phillbaker)
+* Support for redis 4 (#334) (@askehansen)
+* Drop support for redis-rb <= 3.2.0 (@phillbaker)
+* Drop support for rails 2, test recent rubies (@phillbaker)
+
+== 2.2.10 (2018-03-18)
+
+* Fix broken table size in report dashboard (#339) (@ilyasovd)
+* Prevent dupe participation in same experiment (#335)(@pihman)
+
+== 2.2.9 (2018-02-03)
+
+* Fix race condition using the activerecord adapater when vanity creates experiments or rows in the conversions table (@fcheung)
 
 == 2.2.8 (2017-09-26)
 * Rails 5.1 compatibility (#326, #327, #330, @sebjacobs, @bensheldon, @terracatta)

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 # "development" gems in gemspec are required for testing, gems in the
 # development group here are for documentation
@@ -8,7 +9,7 @@ gemspec development_group: :test
 gem "rack"
 
 # Persistence
-gem "redis", ">= 2.1"
+gem "redis", ">= 3.2.1"
 gem "redis-namespace", ">= 1.1.0"
 gem "mongo", "~> 2.1"
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vanity (2.2.8)
+    vanity (3.0.1)
       i18n
 
 GEM
@@ -15,7 +15,7 @@ GEM
       activerecord (>= 2.2)
     activesupport (2.3.14)
     addressable (2.2.7)
-    appraisal (1.0.3)
+    appraisal (2.4.1)
       bundler
       rake
       thor (>= 0.14.0)
@@ -32,16 +32,19 @@ GEM
       execjs
     coffee-script-source (1.9.1)
     colorator (0.1)
+    concurrent-ruby (1.1.9)
     crack (0.3.1)
     execjs (2.5.2)
     fakefs (0.6.7)
     fast-stemmer (1.0.2)
-    ffi (1.9.8)
+    ffi (1.15.5)
+    ffi (1.15.5-java)
     garb (0.9.1)
       activesupport (>= 2.2.0)
       crack (>= 0.1.6)
     hitimes (1.2.2)
-    i18n (0.7.0)
+    i18n (1.9.0)
+      concurrent-ruby (~> 1.0)
     integration (0.1.0)
     jdbc-sqlite3 (3.8.7)
     jekyll (2.5.3)
@@ -85,24 +88,31 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
+    pry (0.10.3-java)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+      spoon (~> 0.0)
     pygments.rb (0.6.3)
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.2.0)
     rack (1.1.3)
-    rake (10.1.0)
+    rake (13.0.6)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
     redcarpet (3.2.3)
-    redis (3.0.6)
-    redis-namespace (1.3.2)
-      redis (~> 3.0.4)
+    redis (4.0.3)
+    redis-namespace (1.6.0)
+      redis (>= 3.0.4)
     rubystats (0.2.5)
     safe_yaml (1.0.4)
     sass (3.4.13)
     slop (3.6.0)
+    spoon (0.0.6)
+      ffi
     sqlite3 (1.3.10)
-    thor (0.19.1)
+    thor (1.2.1)
     timecop (0.3.5)
     timers (4.0.1)
       hitimes
@@ -111,8 +121,8 @@ GEM
     webmock (1.8.0)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
-    yajl-ruby (1.2.1)
-    yard (0.7.5)
+    yajl-ruby (1.2.3)
+    yard (0.9.16)
 
 PLATFORMS
   java
@@ -121,7 +131,7 @@ PLATFORMS
 DEPENDENCIES
   RedCloth
   activerecord-jdbc-adapter
-  appraisal (~> 1.0.2)
+  appraisal (~> 2.0)
   bundler (>= 1.8.0)
   fakefs
   garb (< 0.9.2)
@@ -133,7 +143,7 @@ DEPENDENCIES
   pry
   rack
   rake
-  redis (>= 2.1)
+  redis (>= 3.2.1)
   redis-namespace (>= 1.1.0)
   rubystats (>= 0.2.5)
   sqlite3 (~> 1.3.10)
@@ -143,4 +153,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   1.11.2
+   1.17.1

data/README.md

@@ -1,6 +1,6 @@
 # Vanity
-[![Build
-Status](https://travis-ci.org/assaf/vanity.png?branch=master)](https://travis-ci.org/assaf/vanity)
+[![Test Status](https://github.com/assaf/vanity/workflows/Test/badge.svg)](https://github.com/assaf/vanity/actions)
+
 
 Vanity is an A/B testing framework for Rails that is datastore agnostic.
 
@@ -9,13 +9,34 @@ Vanity is an A/B testing framework for Rails that is datastore agnostic.
 
 [![Dashboard](doc/images/sidebar_test.png)](http://github.com/assaf/vanity)
 
-## A/B Testing With Rails
-
-### **Step 1:** Start using Vanity in your Rails application
-
-#### Step 1.1
-
-##### Rails 3 & Rails 4 installation
+<!-- toc -->
+
+- [Installation](#installation)
+- [Setup](#setup)
+  * [Datastore](#datastore)
+    + [Redis Setup](#redis-setup)
+    + [MongoDB Setup](#mongodb-setup)
+    + [SQL Database Setup](#sql-database-setup)
+    + [Forking servers and reconnecting](#forking-servers-and-reconnecting)
+  * [Initialization](#initialization)
+  * [User identification](#user-identification)
+    + [Rails](#rails)
+    + [Other](#other)
+  * [Define a A/B test](#define-a-ab-test)
+  * [Present the different options to your users](#present-the-different-options-to-your-users)
+  * [Measure conversion](#measure-conversion)
+  * [Check the report](#check-the-report)
+    + [Rails report dashboard](#rails-report-dashboard)
+- [Registering participants with Javascript](#registering-participants-with-javascript)
+- [Compatibility](#compatibility)
+- [Testing](#testing)
+- [Updating documentation](#updating-documentation)
+- [Contributing](#contributing)
+- [Credits/License](#creditslicense)
+
+<!-- tocstop -->
+
+## Installation
 
 Add to your Gemfile:
 
@@ -26,19 +47,21 @@ gem "vanity"
 (For support for older versions of Rails and Ruby 1.8, please see the [1.9.x
 branch](https://github.com/assaf/vanity/tree/1-9-stable).)
 
-#### Step 1.2
+## Setup
+
+### Datastore
 
 Choose a datastore that best fits your needs and preferences for storing
 experiment results. Choose one of: Redis, MongoDB or an SQL database. While
 Redis is usually faster, it may add additional complexity to your stack.
 Datastores should be configured using a `config/vanity.yml`.
 
-##### Redis Setup
+#### Redis Setup
 
 Add to your Gemfile:
 
 ```ruby
-gem "redis", ">= 2.1"
+gem "redis", ">= 3.2"
 gem "redis-namespace", ">= 1.1.0"
 ```
 
@@ -73,7 +96,7 @@ Vanity.connect!(
 )
 ```
 
-##### MongoDB Setup
+#### MongoDB Setup
 
 Add to your Gemfile:
 
@@ -94,7 +117,7 @@ production:
   database: analytics
 ```
 
-##### SQL Database Setup
+#### SQL Database Setup
 
 Vanity supports multiple SQL stores (like MySQL, MariaDB, Postgres, Sqlite,
 etc.) using ActiveRecord, which is built into Rails. If you're using
@@ -116,10 +139,11 @@ test:
   active_record_adapter: default
   collecting: false
 production:
+  adapter: active_record
   active_record_adapter: postgresql
   <% uri = URI.parse(ENV['DATABASE_URL']) %>
   host:     <%= uri.host %>
-  username: <%= uri.username %>
+  username: <%= uri.user%>
   password: <%= uri.password %>
   port:     <%= uri.port %>
   database: <%= uri.path.sub('/', '') %>
@@ -133,7 +157,7 @@ $ rails generate vanity
 $ rake db:migrate
 ```
 
-##### Forking servers and reconnecting
+#### Forking servers and reconnecting
 
 If you're using a forking server (like Passenger or Unicorn), you should
 reconnect after a new worker is created:
@@ -165,7 +189,25 @@ Vanity.connect!(
 )
 ```
 
-#### Step 1.3
+### Initialization
+
+If you're using Rails, this is done automagically. Otherwise, some manual setup is required, for example on an app's booting:
+
+```
+$redis = Redis.new # or from elsewhere
+Vanity.configure do |config|
+  # ... any config
+end
+Vanity.connect!(
+  adapter: :redis,
+  redis: $redis
+)
+Vanity.load!
+```
+
+### User identification
+
+#### Rails
 
 Turn Vanity on, and pass a reference to a method that identifies a user. For
 example:
@@ -179,7 +221,28 @@ end
 For more information, please see the [identity
 documentation](http://vanity.labnotes.org/identity.html).
 
-### **Step 2:** Define your first A/B test
+#### Other
+
+Vanity pulls the identity from a "context" object that responds to `vanity_identity`, so we need to define a `Vanity.context` (this is how the [ActionMailer integration](https://github.com/assaf/vanity/blob/master/lib/vanity/frameworks/rails.rb#L107-L133) works):
+
+```
+class AVanityContext
+  def vanity_identity
+    "123"
+  end
+end
+
+Vanity.context = AVanityContext.new() # Any object that responds to `#vanity_identity`
+```
+
+If you're using plain ruby objects, you could also alias something in your identity model to respond similarly and then set that as the vanity context:
+```
+class User
+  alias_method :vanity_identity, :id
+end
+```
+
+### Define a A/B test
 
 This experiment goes in the file `experiments/price_options.rb`:
 
@@ -200,15 +263,25 @@ metric "Signup (Activation)" do
 end
 ```
 
-### **Step 3:** Present the different options to your users
+### Present the different options to your users
+
+In Rails' templates, this is straightforward:
 
 ```erb
 <h2>Get started for only $<%= ab_test :price_options %> a month!</h2>
 ```
 
-### **Step 4:** Measure conversion
+Outside of templates:
 
-Conversions are created via the `Vanity.track!` method. For example:
+```
+Vanity.ab_test(:invite_subject)
+```
+
+### Measure conversion
+
+Conversions are created via the `Vanity.track!` method. A user should already be added to an experiment, via `ab_test` before this is called - otherwise, the conversion will be tracked, but the user will not be added to the experiment.
+
+For example, in Rails:
 
 ```ruby
 class SignupController < ApplicationController
@@ -224,12 +297,26 @@ class SignupController < ApplicationController
 end
 ```
 
-### **Step 5:** Check the report:
+Outside of an Rails controller, for example in a Rack handler:
+
+```
+identity_object = Identity.new(env['rack.session'])
+Vanity.track!(:click, {
+  # can be any object that responds to `to_s` with a string
+  # that contains the unique identifier or the string identifier itself
+  :identity=>identity_object,
+  :values=>[1] # optional
+})
+```
+
+### Check the report
 
 ```sh
 vanity report --output vanity.html
 ```
 
+#### Rails report dashboard
+
 To view metrics and experiment results with the dashboard in Rails 3 & Rails
 4:
 
@@ -293,18 +380,15 @@ your view no participants will be recorded.
 
 Here's what's tested and known to work:
 
-    Ruby 2.1
-      Persistence: Redis, Mongo, ActiveRecord
-      Rails: 3.2, 4.1, 4.2
-    Ruby 2.2
-      Persistence: Redis, Mongo, ActiveRecord
-      Rails: 3.2, 4.1, 4.2, 5
     Ruby 2.3
-      Persistence: Redis, Mongo, ActiveRecord
-      Rails: 3.2, 4.1, 4.2, 5
-    JRuby 1.9
-      Persistence: Redis, Mongo, ActiveRecord
-      Rails: 3.2, 4.1, 4.2
+      Persistence: Redis (redis-rb >= 3.2.1), Mongo, ActiveRecord
+      Rails: 4.1, 4.2, 5
+    Ruby 2.4
+      Persistence: Redis (redis-rb >= 3.2.1), Mongo, ActiveRecord
+      Rails: 4.1, 4.2, 5
+    JRuby 9.1
+      Persistence: Redis (redis-rb >= 3.2.1), Mongo, ActiveRecord
+      Rails: 4.1, 4.2
 
 ## Testing
 
@@ -341,7 +425,7 @@ Go ahead and target a pull request against the `gh-pages` branch.
     prepare the test suite to run against multiple versions of Rails
 *   Fix, patch, enhance, document, improve, sprinkle pixie dust
 *   Tests. Please. Run `appraisal rake test`, of if you can, `rake test:all`.
-    (This project uses Travis CI where the test suite is run against multiple
+    (This project uses Github Actions where the test suite is run against multiple
     versions of ruby, rails and backends.)
 *   Send a pull request on GitHub
 

data/gemfiles/rails42.gemfile

@@ -3,15 +3,15 @@
 source "https://rubygems.org"
 
 gem "rack"
-gem "redis", ">= 2.1"
+gem "redis", ">= 3.2.1"
 gem "redis-namespace", ">= 1.1.0"
 gem "mongo", "~> 2.1"
 gem "integration", "<= 0.1.0"
 gem "rubystats", ">= 0.2.5"
-gem "garb", "< 0.9.2", :require => false
-gem "mocha", "~> 1.0", :require => false
-gem "rails", "4.2.0"
-gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
+gem "garb", "< 0.9.2", require: false
+gem "mocha", "~> 1.0", require: false
+gem "rails", "4.2.9"
+gem "fastthread", platforms: :mri_20, git: "https://github.com/zoltankiss/fastthread.git"
 gem "passenger", "~>3.0"
 
 group :development do
@@ -30,4 +30,4 @@ platforms :jruby do
   gem "jdbc-sqlite3"
 end
 
-gemspec :development_group => :test, :path => "../"
+gemspec development_group: :test, path: "../"