vanity 1.9.0 → 1.9.1

data/.travis.yml

@@ -11,8 +11,7 @@ rvm:
 env:
 - DB=mongodb
 - DB=redis
-- DB=mysql
-#- DB=postgres
+- DB=active_record
 gemfile:
   - Gemfile
   - gemfiles/rails3.gemfile
@@ -22,8 +21,6 @@ gemfile:
 before_script:
 - 'echo ''gem: --no-ri --no-rdoc'' > ~/.gemrc' # skip installing docs for gems
 - if [[ "`basename $BUNDLE_GEMFILE`" == "Gemfile" ]]; then rvm rubygems 1.8.25; fi # Rubygems 2.0.x fails with Rails 2.3
-- if [[ "$DB" == "mysql" ]]; then mysql -e 'create database vanity_test;' >/dev/null; fi
-#- if [[ "$DB" == "pgsql" ]]; then psql -c 'create database vanity_test;' -U postgres >/dev/null; fi
 matrix:
   exclude:
     # Rails 2 is not officially supported on Ruby 1.9.3
@@ -34,7 +31,7 @@ matrix:
       env: DB=redis
       gemfile: Gemfile
     - rvm: 1.9.3
-      env: DB=mysql
+      env: DB=active_record
       gemfile: Gemfile
     # Rails <= 3.2 is not officially supported on Ruby 2.0.0
     - rvm: 2.0.0
@@ -44,7 +41,7 @@ matrix:
       env: DB=redis
       gemfile: Gemfile
     - rvm: 2.0.0
-      env: DB=mysql
+      env: DB=active_record
       gemfile: Gemfile
     - rvm: 2.0.0
       env: DB=mongodb
@@ -53,7 +50,7 @@ matrix:
       env: DB=redis
       gemfile: gemfiles/rails3.gemfile
     - rvm: 2.0.0
-      env: DB=mysql
+      env: DB=active_record
       gemfile: gemfiles/rails3.gemfile
     # Rails >=4 officially supports >= Ruby 1.9.3
     - rvm: 1.8.7
@@ -63,7 +60,7 @@ matrix:
       env: DB=redis
       gemfile: gemfiles/rails4.gemfile
     - rvm: 1.8.7
-      env: DB=mysql
+      env: DB=active_record
       gemfile: gemfiles/rails4.gemfile
   allow_failures:
     - rvm: ruby-head
@@ -74,5 +71,5 @@ matrix:
       env: DB=redis
       gemfile: gemfiles/rails31.gemfile
     - rvm: 2.0.0
-      env: DB=mysql
+      env: DB=active_record
       gemfile: gemfiles/rails31.gemfile

data/CHANGELOG

@@ -1,3 +1,13 @@
+== 1.9.0 (2014-04-20)
+
+Include db:reset in blacklist for autoconnect. (@phillbaker)
+Add grace period to Vanity::Metric updated_at (@stangel)
+Add timestamps to vanity_participants (@inkredabull)
+Use sqlite3 for all active record adapter tests & updates to test tasks (@phillbaker)
+Fix ActiveRecord participant retrieval with non-primitive identities. (@phillbaker)
+Replace instance variables with locals to fix CLI. (@phillbaker)
+Replace js encoding with server-side call. (@phillbaker)
+
 == 1.9.0 (2014-01-18)
 
 Change order of preference for vanity identity, from highest to lowest: URL param, cookie, method call, assignment. (@phillbaker)

data/Gemfile

@@ -13,9 +13,7 @@ gem "redis", ">= 2.1"
 gem "redis-namespace", ">= 1.1.0"
 gem "bson_ext"
 gem "mongo"
-gem "mysql"
 gem "sqlite3"
-# gem "pg"
 
 # Math libraries
 gem "backports", :platforms => :mri_18

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vanity (1.9.0)
+    vanity (1.9.1)
 
 GEM
   remote: https://rubygems.org/
@@ -55,7 +55,6 @@ GEM
       metaclass (~> 0.0.1)
     mongo (1.6.0)
       bson (= 1.6.0)
-    mysql (2.8.1)
     passenger (2.2.15)
       fastthread (>= 1.0.1)
       rack
@@ -97,12 +96,12 @@ DEPENDENCIES
   appraisal (>= 1.0.0.beta2)
   backports
   bson_ext
+  bundler (>= 1.0.0)
   garb
   integration
   jekyll
   mocha
   mongo
-  mysql
   passenger (~> 2.0)
   rack
   rails (~> 2.3.8)

data/README.rdoc

@@ -33,7 +33,7 @@ Add to your Gemfile:
 
 ==== Step 1.2
 
-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.
+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 <code>config/vanity.yml</code>.
 
 ===== Redis Setup
 
@@ -42,6 +42,8 @@ Add to your Gemfile:
   gem "redis", ">= 2.1"
   gem "redis-namespace", ">= 1.1.0"
 
+By default Vanity is configured to use Redis on localhost port 6379 with database 0.
+
 ===== MongoDB Setup
 
 Add to your Gemfile:
@@ -49,12 +51,39 @@ Add to your Gemfile:
   gem "bson_ext"
   gem "mongo"
 
+A sample <code>config/vanity.yml</code> might look like:
+
+  development:
+    adapter: mongodb
+    database: analytics
+  test:
+    collecting: false
+  production:
+    adapter: mongodb
+    database: analytics
+
+
 ===== 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 DataMapper, Sequel or another persistence framework, add to your Gemfile:
 
    gem "active_record"
 
+A sample <code>config/vanity.yml</code> might look like:
+
+  development:
+    adapter: active_record
+    active_record_adapter: sqlite3
+    database: db/development.sqlite3
+  test:
+    collecting: false
+  production:
+    adapter: active_record
+    active_record_adapter: mysql
+    database: vanity_test
+    pool: 5
+    timeout: 5000
+
 If you're going to store data in the database, run the generator and migrations to create the database schema:
 
   $ rails generate vanity
@@ -113,7 +142,7 @@ Conversions are created via the <code>track!</code> method. For example:
 
 To view metrics and experiment results with the dashboard in Rails 3 & Rails 4:
 
-  rails generate controller Vanity
+  rails generate controller --helper=false Vanity
 
 In <code>config/routes.rb</code>, add:
 
@@ -127,15 +156,13 @@ The controller should look like:
 
 == Registering participants with Javascript
 
-If robots or spiders make up a significant portion of your sites traffic they can affect your conversion rate. Vanity can optionally add participants to the experiments using asynchronous javascript callbacks, which will keep almost all robots out. To set this up simply do the following:
+If robots or spiders make up a significant portion of your sites traffic they can affect your conversion rate. Vanity can optionally add participants to the experiments using asynchronous javascript callbacks, which will keep many robots out. For those robots that do execute Javascript and are well-behaved (like Googlebot), Vanity filters out requests based on their user-agent string.
+
+To set this up simply do the following:
 
 * Add <code>Vanity.playground.use_js!</code>
 * Set <code>Vanity.playground.add_participant_path = '/path/to/vanity/action'</code>, this should point to the add_participant path that is added with Vanity::Rails::Dashboard, make sure that this action is accessible by all users (ie does not require authentication).
-* Add <code><%= vanity_js %></code> to any page that needs uses an ab_test. <code>vanity_js</code> needs to be included after your call to ab_test so that it knows which version of the experiment the participant is a member of. The helper will render nothing if the there are no ab_tests running on the current page, so adding <code>vanity_js</code> to the bottom of your layouts is a good option. Keep in mind that if you call <code>use_js!</code> and don't include <code>vanity_js</code> in your view no participants will be recorded.
-
-=== <b>Update regarding using AJAX registration to avoid robots</b>
-
-As of January 2014, as reported in {issue 175}[https://github.com/assaf/vanity/issues/175], Googlebot is now executing AJAX requests to the original domain of the page, which includes the current implementation of the JS callback. This means that Googlebot-originating requests may be included in experiments, greatly skewing results. A fix is being worked on, please follow the issue for further updates.
+* Add <code><%= vanity_js %></code> to any page that XX an ab_test. <code>vanity_js</code> needs to be included after your call to ab_test so that it knows which version of the experiment the participant is a member of. The helper will render nothing if the there are no ab_tests running on the current page, so adding <code>vanity_js</code> to the bottom of your layouts is a good option. Keep in mind that if you call <code>use_js!</code> and don't include <code>vanity_js</code> in your view no participants will be recorded.
 
 == Compatibility
 
@@ -160,11 +187,10 @@ For view tests/specs or integration testing, it's handy to set the outcome of an
 == Contributing
 
 * Fork the project
-* Please use a topic branch to make your changes, it's easier to test them that way
-* To set up the test suite run bundler, then run `rake appraisal:install` to prepare the test suite to run against multiple versions of Rails
+* Please use a feature branch to make your changes, it's easier to test them that way
+* To set up the test suite run `bundle`, then run `appraisal install` to prepare the test suite to run against multiple versions of Rails
 * Fix, patch, enhance, document, improve, sprinkle pixie dust
-* At minimum run `rake appraisal test`, if possible, please run rake test:all
-* Tests. Please. Run rake test, of if you can, rake test:all
+* 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 versions of ruby, rails and backends.)
 * Send a pull request on GitHub
 
 

data/Rakefile

@@ -1,29 +1,5 @@
 require "rake/testtask"
-
-# -- Building stuff --
-
-spec = Gem::Specification.load(Dir["*.gemspec"].first)
-
-desc "Build the Gem"
-task :build do
-  sh "gem build #{spec.name}.gemspec"
-end
-
-desc "Install #{spec.name} locally"
-task :install=>:build do
-  sudo = "sudo" unless File.writable?( Gem::ConfigMap[:bindir])
-  sh "#{sudo} gem install #{spec.name}-#{spec.version}.gem"
-end
-
-desc "Push new release to gemcutter and git tag"
-task :push=>["build"] do
-  sh "git push"
-  puts "Tagging version #{spec.version} .."
-  sh "git tag v#{spec.version}"
-  sh "git push --tag"
-  puts "Building and pushing gem .."
-  sh "gem push #{spec.name}-#{spec.version}.gem"
-end
+require "bundler/gem_tasks"
 
 
 # -- Testing stuff --
@@ -70,7 +46,7 @@ task "test:setup" do
 end
 
 # These are all the adapters we're going to test with.
-ADAPTERS = %w{redis mongodb mysql}
+ADAPTERS = %w{redis mongodb active_record}
 
 desc "Test using different back-ends"
 task "test:adapters", :adapter do |t, args|
@@ -80,7 +56,7 @@ task "test:adapters", :adapter do |t, args|
     adapters = args.adapter ? [args.adapter] : ADAPTERS
     adapters.each do |adapter|
       puts "** Testing #{adapter} adapter"
-      sh "rake appraisal test DB=#{adapter} #{'--trace' if Rake.application.options.trace}"
+      sh "bundle exec appraisal rake test DB=#{adapter} #{'--trace' if Rake.application.options.trace}"
     end
   rescue LoadError
     warn "The appraisal gem must be available"
@@ -107,40 +83,20 @@ end
 task(:clobber) { rm_rf "tmp" }
 
 
-# -- Documenting stuff --
-
-begin
-  require "yard"
-  YARD::Rake::YardocTask.new(:yardoc) do |task|
-    task.files  = FileList["lib/**/*.rb"].exclude("lib/vanity/backport.rb")
-    task.options = "--output", "html/api", "--title", "Vanity #{spec.version}", "--main", "README.rdoc", "--files", "CHANGELOG"
-  end
-rescue LoadError
-end
+# -- Documenting stuff -- #TODO make sure works under 1.9/2.0
 
 desc "Jekyll generates the main documentation (sans API)"
 task(:jekyll) { sh "jekyll", "doc", "html" }
-file "html/vanity.pdf"=>:jekyll do |t|
-  pages = %w{index metrics ab_testing rails email identity configuring contributing}.map{ |p| "html/#{p}.html" }
-  args = %w{--disable-javascript --outline --title Vanity --header-html doc/_layouts/_header.html --print-media-type}
-  args.concat %w{--margin-left 20 --margin-right 20 --margin-top 20 --margin-bottom 20 --header-spacing 5}
-  args.concat pages << t.name
-  sh "wkhtmltopdf", *args
-end
 
-file "html/vanity-api.zip"=>:yardoc do |t|
-  Dir.chdir "html" do
-    sh "zip vanity-api.zip -r api"
-  end
-end
-desc "Create documentation in docs directory (including API)"
-task :docs=>[:jekyll, :yardoc, "html/vanity-api.zip", "html/vanity.pdf"]
+desc "Create documentation in docs directory"
+task :docs=>[:jekyll]
+
 desc "Remove temporary files and directories"
-task(:clobber) { rm_rf "html" ; rm_rf ".yardoc" }
+task(:clobber) { rm_rf "html" }
 
-desc "Publish documentation to vanity.labnotes.org"
+desc "Publish documentation to vanity.labnotes.org via Github Pages on gh-pages git branch"
 task :publish=>[:clobber, :docs] do
-  sh "rsync -cr --del --progress html/ labnotes.org:/var/www/vanity/"
+  # TODO
 end
 
 

data/doc/rails.textile

@@ -7,7 +7,6 @@ title: Using with Rails
 # "Installing Vanity":#install
 # "Configuring Vanity":#config
 # "Test Environment":#test
-# "Dashboard":#dashboard
 # "Unicorn and Forking Servers":#fork
 </div>
 
@@ -78,27 +77,6 @@ h4. Enabling/disable collection
 When collection is off, Vanity doesn't connect to the database server, so there's no need to set a database configuration for these environments.
 
 
-h3(#dashboard).  Dashboard
-
-Start by adding a new resource in @config/routes.rb@:
-
-<pre>
-map.vanity "/vanity/:action/:id", :controller=>:vanity
-</pre>
-
-Create a new controller for Vanity:
-
-<pre>
-class VanityController < ApplicationController
-  include Vanity::Rails::Dashboard
-end
-</pre>
-
-Now open your browser to "http://localhost:3000/vanity":http://localhost:3000/vanity.
-
-The Dashboard renders complete HTML pages with CSS and all necessary JavaScript libraries.  Thankfully, HTML is forgiving enough that it will render correctly even with your existing application layout.  You can decide to keep your layout, or tell the controller to set @layout false@.
-
-
 h3(#fork).  Unicorn and Forking Servers
 
 Unicorn forks the master process to create worker processes efficiently.  Since the master processes opens a connection to the database, all workers end up sharing that connection, resulting in ugly contention issues.

data/gemfiles/rails3.gemfile

@@ -7,7 +7,6 @@ gem "redis", ">= 2.1"
 gem "redis-namespace", ">= 1.1.0"
 gem "bson_ext"
 gem "mongo"
-gem "mysql"
 gem "sqlite3"
 gem "backports", :platforms=>:mri_18
 gem "integration"

data/gemfiles/rails3.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (1.9.0)
+    vanity (1.9.1)
 
 GEM
   remote: https://rubygems.org/
@@ -90,7 +90,6 @@ GEM
       metaclass (~> 0.0.1)
     mongo (1.6.0)
       bson (= 1.6.0)
-    mysql (2.8.1)
     passenger (3.0.11)
       daemon_controller (>= 0.2.5)
       fastthread (>= 1.0.1)
@@ -151,13 +150,13 @@ DEPENDENCIES
   appraisal (>= 1.0.0.beta2)
   backports
   bson_ext
+  bundler (>= 1.0.0)
   fastthread!
   garb
   integration
   jekyll
   mocha
   mongo
-  mysql
   passenger (~> 3.0)
   rack
   rails (= 3.0.11)

data/gemfiles/rails31.gemfile

@@ -7,7 +7,6 @@ gem "redis", ">= 2.1"
 gem "redis-namespace", ">= 1.1.0"
 gem "bson_ext"
 gem "mongo"
-gem "mysql"
 gem "sqlite3"
 gem "backports", :platforms=>:mri_18
 gem "integration"

data/gemfiles/rails31.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (1.9.0)
+    vanity (1.9.1)
 
 GEM
   remote: https://rubygems.org/
@@ -90,7 +90,6 @@ GEM
     mongo (1.6.0)
       bson (= 1.6.0)
     multi_json (1.1.0)
-    mysql (2.8.1)
     passenger (3.0.11)
       daemon_controller (>= 0.2.5)
       fastthread (>= 1.0.1)
@@ -160,13 +159,13 @@ DEPENDENCIES
   appraisal (>= 1.0.0.beta2)
   backports
   bson_ext
+  bundler (>= 1.0.0)
   fastthread!
   garb
   integration
   jekyll
   mocha
   mongo
-  mysql
   passenger (~> 3.0)
   rack
   rails (= 3.1.3)

data/gemfiles/rails32.gemfile

@@ -7,7 +7,6 @@ gem "redis", ">= 2.1"
 gem "redis-namespace", ">= 1.1.0"
 gem "bson_ext"
 gem "mongo"
-gem "mysql"
 gem "sqlite3"
 gem "backports", :platforms=>:mri_18
 gem "integration"

data/gemfiles/rails32.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (1.9.0)
+    vanity (1.9.1)
 
 GEM
   remote: https://rubygems.org/
@@ -91,7 +91,6 @@ GEM
     mongo (1.6.0)
       bson (= 1.6.0)
     multi_json (1.1.0)
-    mysql (2.8.1)
     passenger (3.0.11)
       daemon_controller (>= 0.2.5)
       fastthread (>= 1.0.1)
@@ -160,13 +159,13 @@ DEPENDENCIES
   appraisal (>= 1.0.0.beta2)
   backports
   bson_ext
+  bundler (>= 1.0.0)
   fastthread!
   garb
   integration
   jekyll
   mocha
   mongo
-  mysql
   passenger (~> 3.0)
   rack
   rails (= 3.2.1)

data/gemfiles/rails4.gemfile

@@ -7,7 +7,6 @@ gem "redis", ">= 2.1"
 gem "redis-namespace", ">= 1.1.0"
 gem "bson_ext"
 gem "mongo"
-gem "mysql"
 gem "sqlite3"
 gem "backports", :platforms=>:mri_18
 gem "integration"

data/gemfiles/rails4.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (1.9.0)
+    vanity (1.9.1)
 
 GEM
   remote: https://rubygems.org/
@@ -88,7 +88,6 @@ GEM
     mongo (1.9.2)
       bson (~> 1.9.2)
     multi_json (1.8.2)
-    mysql (2.9.1)
     passenger (3.0.21)
       daemon_controller (>= 1.0.0)
       fastthread (>= 1.0.1)
@@ -158,13 +157,13 @@ DEPENDENCIES
   appraisal (>= 1.0.0.beta2)
   backports
   bson_ext
+  bundler (>= 1.0.0)
   fastthread!
   garb
   integration
   jekyll
   mocha
   mongo
-  mysql
   passenger (~> 3.0)
   rack
   rails (= 4.0.0)

data/generators/templates/vanity_migration.rb

@@ -35,6 +35,7 @@ class VanityMigration < ActiveRecord::Migration
       t.integer :shown
       t.integer :seen
       t.integer :converted
+      t.timestamps
     end
     add_index :vanity_participants, [:experiment_id]
     add_index :vanity_participants, [:experiment_id, :identity], :name => "by_experiment_id_and_identity"

data/lib/generators/templates/vanity_migration.rb

@@ -35,6 +35,7 @@ class VanityMigration < ActiveRecord::Migration
       t.integer :shown
       t.integer :seen
       t.integer :converted
+      t.timestamps
     end
     add_index :vanity_participants, [:experiment_id]
     add_index :vanity_participants, [:experiment_id, :identity], :name => "by_experiment_id_and_identity"

data/lib/vanity/adapters/abstract_adapter.rb

@@ -4,7 +4,7 @@ module Vanity
     class << self
       # Creates new connection to underlying datastore and returns suitable
       # adapter (adapter object extends AbstractAdapter and wraps the
-      # connection). Vanity.playgroup.establish_connection uses this.
+      # connection). Vanity.playground.establish_connection uses this.
       #
       # @since 1.4.0
       def establish_connection(spec)

data/lib/vanity/adapters/active_record_adapter.rb

@@ -34,12 +34,24 @@ module Vanity
 
       # Metric model
       class VanityMetric < VanityRecord
+        UPDATED_AT_GRACE_PERIOD = 1.minute
         self.table_name = :vanity_metrics
         has_many :vanity_metric_values
 
         def self.retrieve(metric)
           rails_agnostic_find_or_create_by(:metric_id, metric.to_s)
         end
+
+        def touch_with_grace_period
+          now = Time.now
+          self.updated_at = now if updated_before_grace_period?(now)
+        end
+
+        private
+
+        def updated_before_grace_period?(now)
+          now - updated_at >= UPDATED_AT_GRACE_PERIOD
+        end
       end
 
       # Metric value
@@ -78,24 +90,21 @@ module Vanity
         self.table_name = :vanity_participants
         attr_accessible :experiment_id, :identity, :seen, :shown, :converted if needs_attr_accessible?
 
-        # Finds the participant by experiment and identity. If
-        # create is true then it will create the participant
-        # if not found. If a hash is passed then this will be
-        # passed to create if creating, or will be used to
-        # update the found participant.
+        # Finds the participant by experiment and identity. If create is true
+        # then it will create the participant if not found. If a hash is
+        # passed then this will be passed to create if creating, or will be
+        # used to update the found participant.
         def self.retrieve(experiment, identity, create = true, update_with = nil)
           if record = VanityParticipant.first(:conditions=>{ :experiment_id=>experiment.to_s, :identity=>identity.to_s })
             record.update_attributes(update_with) if update_with
           elsif create
-            record = VanityParticipant.create({ :experiment_id=>experiment.to_s, :identity=>identity }.merge(update_with || {}))
+            record = VanityParticipant.create({ :experiment_id=>experiment.to_s, :identity=>identity.to_s }.merge(update_with || {}))
           end
           record
         end
       end
 
       def initialize(options)
-
-
         @options = options.inject({}) { |h,kv| h[kv.first.to_s] = kv.last ; h }
         if @options["active_record_adapter"] && (@options["active_record_adapter"] != "default")
           @options["adapter"] = @options["active_record_adapter"]
@@ -136,7 +145,7 @@ module Vanity
           record.vanity_metric_values.create(:date => timestamp.to_date.to_s, :index => index, :value => value)
         end
 
-        record.updated_at = Time.now
+        record.touch_with_grace_period
         record.save
       end
 
@@ -150,10 +159,10 @@ module Vanity
         group_by = "#{connection.quote_column_name('date')}"
 
         values = record.vanity_metric_values.all(
-                :select => select,
-                :conditions => conditions,
-                :order => order,
-                :group => group_by
+          :select => select,
+          :conditions => conditions,
+          :order => order,
+          :group => group_by
         )
 
         dates.map do |date|
@@ -211,9 +220,9 @@ module Vanity
         conversions = record.vanity_conversions.sum(:conversions, :conditions => {:alternative => alternative})
 
         {
-                :participants => participants,
-                :converted => converted,
-                :conversions => conversions
+          :participants => participants,
+          :converted => converted,
+          :conversions => conversions
         }
       end
 

data/lib/vanity/adapters/redis_adapter.rb

@@ -155,9 +155,9 @@ module Vanity
       end
 
       def ab_add_participant(experiment, alternative, identity)
-  call_redis_with_failover(experiment, alternative, identity) do
-    @experiments.sadd "#{experiment}:alts:#{alternative}:participants", identity
-  end
+        call_redis_with_failover(experiment, alternative, identity) do
+          @experiments.sadd "#{experiment}:alts:#{alternative}:participants", identity
+        end
       end
 
       def ab_seen(experiment, identity, alternative)
@@ -177,7 +177,7 @@ module Vanity
             if @experiments.sismember "#{experiment}:alts:#{alternative.id}:participants", identity
               return alternative.id
             end
-                end
+          end
           nil
         end
       end

data/lib/vanity/autoconnect.rb

@@ -16,6 +16,7 @@ module Vanity
       'db:migrate',
       'db:migrate:status',
       'db:rollback',
+      'db:reset',
       'db:schema:cache:clear',
       'db:schema:cache:dump',
       'db:schema:dump',

data/lib/vanity/commands/report.rb

@@ -15,7 +15,7 @@ module Vanity
           path_or_options[:locals]
         )
       else
-       render_erb(path_or_options, locals)
+        render_erb(path_or_options, locals)
       end
     end
 
@@ -69,7 +69,11 @@ module Vanity
       # Generate an HTML report. Outputs to the named file, or stdout with no
       # arguments.
       def report(output = nil)
-        html = render(Vanity.template("report"))
+        html = render(Vanity.template("report"),
+          :experiments=>Vanity.playground.experiments,
+          :experiments_persisted=>Vanity.playground.experiments_persisted?,
+          :metrics=>Vanity.playground.metrics
+        )
         if output
           File.open output, 'w' do |file|
             file.write html

data/lib/vanity/experiment/ab_test.rb

@@ -460,10 +460,11 @@ module Vanity
         end
       end
 
-      # Called when tracking associated metric.
+      # Called via a hook by the associated metric.
       def track!(metric_id, timestamp, count, *args)
         return unless active?
         identity = identity() rescue nil
+        identity ||= args.last[:identity] if args.last.is_a?(Hash) && args.last[:identity]
         if identity
           return if connection.ab_showing(@id, identity)
           index = alternative_for(identity)

data/lib/vanity/frameworks/rails.rb

@@ -292,10 +292,11 @@ module Vanity
     # Step 3: Open your browser to http://localhost:3000/vanity
     module Dashboard
       def index
-        @experiments = Vanity.playground.experiments
-        @experiments_persisted = Vanity.playground.experiments_persisted?
-        @metrics = Vanity.playground.metrics
-        render :file=>Vanity.template("_report"), :content_type=>Mime::HTML
+        render :file=>Vanity.template("_report"),:content_type=>Mime::HTML, :locals=>{
+          :experiments=>Vanity.playground.experiments,
+          :experiments_persisted=>Vanity.playground.experiments_persisted?,
+          :metrics=>Vanity.playground.metrics
+        }
       end
 
       def participant

data/lib/vanity/helpers.rb

@@ -52,13 +52,21 @@ module Vanity
       end
     end
 
-    # Tracks an action associated with a metric.
+    # Tracks an action associated with a metric. Useful for calling from a
+    # Rack handler. Note that 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.
     #
     # @example
     #   track! :invitation
+    # @example
+    #   track! :click, { :identity=>Identity.new(env['rack.session']), :values=>[1] }
+    #
+    # @param count_or_options Defaults to a count of 1. Also accepts a hash
+    #   of options passed (eventually) to AbTest#track!.
     # @since 1.2.0
-    def track!(name, count = 1)
-      Vanity.playground.track! name, count
+    def track!(name, count_or_options = 1)
+      Vanity.playground.track! name, count_or_options
     end
   end
 end

data/lib/vanity/metric/base.rb

@@ -152,12 +152,12 @@ module Vanity
       when Numeric
         values = [args]
       end
-        identity = Vanity.context.vanity_identity rescue nil
+      identity ||= Vanity.context.vanity_identity rescue nil
       [timestamp || Time.now, identity, values || [1]]
     end
     protected :track_args
 
-    # Metric definitions use this to introduce tracking hook. The hook is
+    # Metric definitions use this to introduce tracking hooks. The hook is
     # called with metric identifier, timestamp, count and possibly additional
     # arguments.
     #
@@ -235,7 +235,7 @@ module Vanity
 
     def call_hooks(timestamp, identity, values)
       @hooks.each do |hook|
-        hook.call @id, timestamp, values.first || 1
+        hook.call @id, timestamp, values.first || 1, :identity=>identity
       end
     end
 

data/lib/vanity/templates/_report.erb

@@ -14,23 +14,23 @@
   <body>
     <div class="vanity">
       <% unless Vanity.playground.collecting? %>
-        <div class="alert">
+        <div class="alert collecting">
           Vanity is currently not collecting data or metrics. To turn on data collection, set <span style='font-family: courier'>Vanity.playground.collecting = true;</span> in <span style='font-family: courier'>config/environments/[environment].rb</span>.
         </div>
       <% end %>
 
-      <% if @experiments_persisted %>
-        <% if @experiments.present? %>
+      <% if experiments_persisted %>
+        <% if experiments.present? %>
           <h2>Experiments</h2>
-          <%= render :file=>Vanity.template("_experiments"), :locals=>{:experiments=>@experiments} %>
+          <%= render :file=>Vanity.template("_experiments"), :locals=>{:experiments=>experiments} %>
         <% end %>
 
-        <% unless @metrics.empty? %>
+        <% unless metrics.empty? %>
           <h2>Metrics</h2>
-          <%= render :file=>Vanity.template("_metrics"), :locals=>{:metrics=>@metrics, :experiments=>@experiments} %>
+          <%= render :file=>Vanity.template("_metrics"), :locals=>{:metrics=>metrics, :experiments=>experiments} %>
         <% end %>
       <% else %>
-        <div class="alert">
+        <div class="alert persistance">
           Vanity's cached experiments are out of sync with those on the filesystem and/or those in the datastore. Please restart your server and/or turn on collecting.
         </div>
       <% end %>

data/lib/vanity/templates/_vanity.js.erb

@@ -1,6 +1,6 @@
 var httpRequest;
 <% @_vanity_experiments.each do |name, alternative| %>
-  var params = "e=<%= name %>&a=<%= alternative.id %>&authenticity_token=" + encodeURIComponent("<%= form_authenticity_token %>");
+  var params = "e=<%= name %>&a=<%= alternative.id %>&authenticity_token=<%= CGI.escape(form_authenticity_token) %>";
   if (window.XMLHttpRequest) { // Mozilla, Safari, ...
     httpRequest = new XMLHttpRequest();
   } else if (window.ActiveXObject) { // IE

data/lib/vanity/version.rb

@@ -1,5 +1,5 @@
 module Vanity
-  VERSION = "1.9.0"
+  VERSION = "1.9.1"
 
   module Version
     version = VERSION.to_s.split(".").map { |i| i.to_i }

data/test/adapters/redis_adapter_test.rb

@@ -29,6 +29,12 @@ class RedisAdapterTest < Test::Unit::TestCase
     [redis_adapter, mocked_redis]
   end
 
+  def test_connect_to_existing_redis
+    mocked_redis = stub("Redis")
+    adapter = Vanity::Adapters.redis_connection(:redis => mocked_redis)
+    assert_equal mocked_redis, adapter.redis
+  end
+
   def test_graceful_failure_metric_track
     redis_adapter, mocked_redis = stub_redis
     mocked_redis.stubs(:incrby).raises(RuntimeError)

data/test/experiment/ab_test.rb

@@ -225,18 +225,31 @@ class AbTestTest < ActionController::TestCase
     assert_equal id, experiment(:foobar).playground.connection.ab_assigned(experiment(:foobar).id, "6e98ec")
   end
 
+  def test_ab_assigned
+    identity = { :a => :b }
+    new_ab_test :foobar do
+      alternatives "foo", "bar"
+      identify { identity }
+      metrics :coolness
+    end
+    assert_equal nil, experiment(:foobar).playground.connection.ab_assigned(experiment(:foobar).id, identity)
+    assert id = experiment(:foobar).choose.id
+    assert_equal id, experiment(:foobar).playground.connection.ab_assigned(experiment(:foobar).id, identity)
+  end
+
   # -- Unequal probabilities --
 
   def test_returns_the_same_alternative_consistently_when_using_probabilities
     new_ab_test :foobar do
       alternatives "foo", "bar"
       identify { "6e98ec" }
-      rebalance_frequency 100
+      rebalance_frequency 10
       metrics :coolness
     end
-    assert value = experiment(:foobar).choose.value
+    value = experiment(:foobar).choose.value
+    assert value
     assert_match /foo|bar/, value
-    1000.times do
+    100.times do
       assert_equal value, experiment(:foobar).choose.value
     end
   end
@@ -252,9 +265,9 @@ class AbTestTest < ActionController::TestCase
     altered_alts[0].probability=30
     altered_alts[1].probability=70
     experiment(:foobar).set_alternative_probabilities altered_alts
-    alts = Array.new(1000) { experiment(:foobar).choose.value }
+    alts = Array.new(600) { experiment(:foobar).choose.value }
     assert_equal %w{bar foo}, alts.uniq.sort
-    assert_in_delta alts.select { |a| a == altered_alts[0].value }.size, 300, 100 # this may fail, such is propability
+    assert_in_delta alts.select { |a| a == altered_alts[0].value }.size, 200, 60 # this may fail, such is propability
   end
 
   # -- Rebalancing probabilities --

data/test/helper_test.rb

@@ -0,0 +1,14 @@
+require "test/test_helper"
+
+context "Object#track!" do
+  test "identity option sets identity" do
+    metric "Coolness"
+    new_ab_test :foobar do
+      alternatives "foo", "bar"
+      metrics :coolness
+    end
+    track! :coolness, :identity=>'quux', :values=>[2]
+
+    assert_equal 2, experiment(:foobar).alternatives.sum(&:conversions)
+  end
+end

data/test/metric/active_record_test.rb

@@ -264,6 +264,7 @@ context "ActiveRecord Metric" do
       end
     end
     Vanity.playground.metrics
+    Sky.create!
     (1..5).each do |height|
       Sky.create! :height=>height
     end

data/test/metric/base_test.rb

@@ -81,7 +81,7 @@ context "Metric tracking" do
     2.times { Vanity.playground.track! :cheers_sec }
     yawns = Vanity.playground.metric(:yawns_sec).values(today, today).first
     cheers = Vanity.playground.metric(:cheers_sec).values(today, today).first
-    assert yawns = 2 * cheers
+    assert yawns == 2 * cheers
   end
 
   test "can tell the time" do

data/test/passenger_test.rb

@@ -11,7 +11,7 @@ if !defined?(Rails::Railtie) && ActiveRecord::Base.connected?
       @original = Vanity.playground.connection
       File.unlink "test/myapp/config/vanity.yml" rescue nil
       File.open("test/myapp/config/vanity.yml", "w") do |io|
-	io.write YAML.dump({ "production"=>DATABASE })
+      io.write YAML.dump({ "production"=>DATABASE })
       end
       @server = PhusionPassenger::SpawnManager.new
       @server.start

data/test/rails_dashboard_test.rb

@@ -23,31 +23,31 @@ class RailsDashboardTest < ActionController::TestCase
     get :index
     assert_response :success
     assert @response.body =~ %r{div class="vanity"}
+    assert @response.body =~ %r{<h2>Experiments</h2>}
+    assert @response.body =~ %r{<h2>Metrics</h2>}
   end
 
-  def test_assigns_experiments
+  def test_index_not_collecting
+    Vanity.playground.collecting = false
     get :index
-    experiments = assigns(:experiments).with_indifferent_access
-
-    assert experiments.respond_to?(:keys)
-    assert experiments.keys.include?("food")
-    assert experiments.values.first.name == :food
+    assert_response :success
+    assert @response.body =~ %r{<div class="alert collecting">}
   end
 
-  def test_assigns_metrics
-    get :index
-    metrics = assigns(:metrics).with_indifferent_access
-    assert metrics.respond_to?(:keys)
-    assert metrics.keys.include?("sugar_high")
-    assert metrics.values.first.name == "sugar_high"
-  end
+  def test_index_not_persisted
+    name = 'Price'
+    id = :price
+    experiment = Vanity::Experiment::AbTest.new(Vanity.playground, id, name)
+    Vanity.playground.experiments[id] = experiment
 
-  def test_assigns_experiments_persisted
     get :index
-    assert assigns(:experiments_persisted)
+    assert_response :success
+    assert @response.body =~ %r{<div class="alert persistance">}
+
+    Vanity.playground.experiments.delete(id)
   end
 
-  # --  Actions used in non-admin actions --
+  # --  Actions used in non-admin actions, e.g. in JS --
 
   def test_add_participant
     xhr :post, :add_participant, :e => "food", :a => 0

data/test/test_helper.rb

@@ -56,8 +56,7 @@ module VanityTestHelpers
   DATABASE = {
     "redis"=>"redis://localhost/15",
     "mongodb"=>"mongodb://localhost/vanity",
-    "mysql"=> { "adapter"=>"active_record", "active_record_adapter"=>"mysql", "database"=>"vanity_test" },
-    "postgres"=> { "adapter"=>"active_record", "active_record_adapter"=>"postgresql", "database"=>"vanity_test", "username"=>"postgres" },
+    "active_record"=> { "adapter"=>"active_record", "active_record_adapter"=>"sqlite3", "database"=>"vanity_test.sqlite3", "timeout" => 10000, "busy_timeout" => 1000 },
     "mock"=>"mock:/"
   }[ENV["DB"]] or raise "No support yet for #{ENV["DB"]}"
 
@@ -77,18 +76,11 @@ module VanityTestHelpers
     WebMock.reset!
   end
 
-  # Call this on teardown. It wipes put the playground and any state held in it
-  # (mostly experiments), resets vanity ID, and clears database of all experiments.
-  def nuke_playground
-    Vanity.playground.connection.flushdb
-    new_playground
-  end
-
   # Call this if you need a new playground, e.g. to re-define the same experiment,
   # or reload an experiment (saved by the previous playground).
   def new_playground
     Vanity.playground = Vanity::Playground.new(:logger=>$logger, :load_path=>"tmp/experiments")
-    Vanity.playground.establish_connection DATABASE
+    Vanity.playground.establish_connection(DATABASE)
   end
 
   # Defines the specified metrics (one or more names). Returns metric, or array
@@ -151,6 +143,9 @@ if defined?(ActiveSupport::TestCase)
   class ActiveSupport::TestCase
     include WebMock::API
     include VanityTestHelpers
+
+    self.use_instantiated_fixtures = false if respond_to?(:use_instantiated_fixtures)
+    self.use_transactional_fixtures = false if respond_to?(:use_transactional_fixtures)
   end
 end
 
@@ -168,17 +163,17 @@ if defined?(ActionController::TestCase)
   end
 end
 
-if ENV["DB"] == "postgres"
-  ActiveRecord::Base.establish_connection :adapter=>"postgresql", :database=>"vanity_test"
-elsif ENV["DB"] == "mysql"
-  ActiveRecord::Base.establish_connection :adapter=>"mysql", :database=>"vanity_test"
-end
-ActiveRecord::Base.logger = $logger
+if ENV["DB"] == "active_record"
+  connection = {}
+  connection[:adapter] = VanityTestHelpers::DATABASE['active_record_adapter']
+  connection[:database] = VanityTestHelpers::DATABASE['database']
+  ActiveRecord::Base.establish_connection(connection)
+  ActiveRecord::Base.logger = $logger
 
-if ENV["DB"] == "mysql" || ENV["DB"] == "postgres"
   require "generators/templates/vanity_migration"
   VanityMigration.down rescue nil
   VanityMigration.up
+  ActiveRecord::Base.connection_pool.disconnect!
 end
 
 # test/spec/mini v3

data/vanity.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
                           "--webcvs", "http://github.com/assaf/#{spec.name}"
 
   spec.required_ruby_version = ">= 1.8.7"
+
+  spec.add_development_dependency "bundler", ">= 1.0.0"
 end

metadata

@@ -1,33 +1,41 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: vanity
-version: !ruby/object:Gem::Version 
-  hash: 51
+version: !ruby/object:Gem::Version
+  version: 1.9.1
   prerelease: 
-  segments: 
-  - 1
-  - 9
-  - 0
-  version: 1.9.0
 platform: ruby
-authors: 
+authors:
 - Assaf Arkin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-01-28 00:00:00 Z
-dependencies: []
-
+date: 2014-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: Mirror, mirror on the wall ...
 email: assaf@labnotes.org
-executables: 
+executables:
 - vanity
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
 - CHANGELOG
-files: 
+files:
 - .autotest
 - .gitignore
 - .travis.yml
@@ -149,6 +157,7 @@ files:
 - test/experiments/metrics/signups.rb
 - test/experiments/metrics/yawns.rb
 - test/experiments/null_abc.rb
+- test/helper_test.rb
 - test/metric/active_record_test.rb
 - test/metric/base_test.rb
 - test/metric/google_analytics_test.rb
@@ -167,46 +176,37 @@ files:
 - test/test_helper.rb
 - vanity.gemspec
 homepage: http://vanity.labnotes.org
-licenses: 
+licenses:
 - MIT
 post_install_message: To get started run vanity --help
-rdoc_options: 
+rdoc_options:
 - --title
-- Vanity 1.9.0
+- Vanity 1.9.1
 - --main
 - README.rdoc
 - --webcvs
 - http://github.com/assaf/vanity
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 57
-      segments: 
-      - 1
-      - 8
-      - 7
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Experience Driven Development framework for Ruby
-test_files: 
+test_files:
 - test/adapters/redis_adapter_test.rb
 - test/autoconnect_test.rb
 - test/cli_test.rb
@@ -242,6 +242,7 @@ test_files:
 - test/experiments/metrics/signups.rb
 - test/experiments/metrics/yawns.rb
 - test/experiments/null_abc.rb
+- test/helper_test.rb
 - test/metric/active_record_test.rb
 - test/metric/base_test.rb
 - test/metric/google_analytics_test.rb