vanity 1.8.0 → 1.8.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  data.tar.gz: cf97c9c3b23e4edf20b47b84fda3f7f31eed9f770ca16c3fd4850bc38b542a2c335fa91c3b68ec912ffa21ccfa14eb14f4b3fc370016bcf797852d6089f99075
+  metadata.gz: 2377c5146a59528271b9bfc244236e8d7a3b142676bafbee8d527a0037a7a1cab0bf065e086922f3b354ef4f798a17d0e0f9aaa5e0fd7f04367970a660fd691e
+SHA1: 
+  data.tar.gz: e713ef94697abdc32fb3dc46e960b83d703f0451
+  metadata.gz: ece1cada68e0f549be1ad0cf0fea02f7ce387c75

data/.travis.yml

@@ -1,9 +1,13 @@
 language: ruby
 bundler_args: --without development
 script: 'rake appraisal test'
+services:
+  - mongodb
 rvm:
 - 1.8.7
-- 1.9.2
+- 1.9.3
+- 2.0.0
+- ruby-head
 env:
 - DB=mongodb
 - DB=redis
@@ -13,3 +17,7 @@ before_script:
 - "mysql -e 'create database vanity_test;' >/dev/null"
 - "rake appraisal:install"
 #- "psql -c 'create database vanity_test;' -U postgres >/dev/null"
+matrix:
+  allow_failures:
+    - rvm: 2.0.0
+    - rvm: ruby-head

data/Appraisals

@@ -1,7 +1,3 @@
-appraise "rails2" do
-  gem "rails", "2.3.14"
-end
-
 appraise "rails3" do
   gem "rails", "3.0.11"
   gem "passenger", "~>3.0"

data/CHANGELOG

@@ -1,9 +1,23 @@
+== 1.8.1 (2013-10-05)
+
+Added vanity_experiments helper for rails to return read only copy of active experiments (@iceberg901).
+Fixed support for Mass Assignment on Rails 3.2 (@hcarver).
+Fixed commandlin usage (@phillbaker).
+
+
+== 1.8.0 (2012-03-12)
+
+Improved support for Rails 3.1 and Rails 3.2. Thanks to masverba, Daan and IsaacLewis.
+
+Finer Grained Exceptions for Missing Experiments (Nick Barnwell)
+
+
 == 1.7.1 (2011-09-30)
 
 Minor change in locating config file (Ariel Salomon)
 
 Allow for table names in specified :timestamps (Peter Kovacs)
-    
+
 When a named scope includes a join, created_at can be ambiguous.  Use
 
 	metric "Sky is limit" do
@@ -28,7 +42,7 @@ connections are deprecated in favor of using the connection option with a URI
 
 1.7.0 adds support for ActionMailer, for example:
 
-	class UserMailer < ActionMailer::Base 
+	class UserMailer < ActionMailer::Base
 		def invite_email(user)
 			use_vanity_mailer user
 			mail :to => user.email, :subject => ab_test(:invite_subject)
@@ -218,7 +232,7 @@ To view Google Analytics metrics from within Vanity, first make sure you are
 using Garb.  For example, in your Gemfile:
 
   gem "vanity", "1.3.0"
-  gem "garb",   "0.5.0" 
+  gem "garb",   "0.5.0"
 
 Next, authenticate using your account credentials.  For example, in your
 config/environments/production.rb:
@@ -310,7 +324,7 @@ Much thanks to Ian Sefferman for fixing issues with Ruby 1.8.7 and Rails support
 * Added: Metrics.
 * Added: Use Vanity.playground.mock! when running tests and you'd rather not access a live Redis server.
 * Changed: A/B tests now using metrics for tracking.
-* Changed: Now throwing NameError instead of LoadError when failing to load experiment/metric.  NameError can be rescued on same line. 
+* Changed: Now throwing NameError instead of LoadError when failing to load experiment/metric.  NameError can be rescued on same line.
 * Changed: New, easier URL mapping for Dashboard: map.vanity "/vanity", :controller=>:vanity.
 * Changed: All tests are green on Ruby 1.8.6, 1.8.7 and 1.9.1.
 * Changed: Switched to redis-rb from http://github.com/ezmobius/redis-rb.

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
 
 gem "appraisal"

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    vanity (1.8.0)
+    vanity (1.8.1)
       redis (~> 2.0)
       redis-namespace (~> 1.0.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     RedCloth (4.2.9)
     SystemTimer (1.2.3)
@@ -23,7 +23,7 @@ GEM
     addressable (2.2.7)
     albino (1.3.3)
       posix-spawn (>= 0.3.6)
-    appraisal (0.4.1)
+    appraisal (0.5.2)
       bundler
       rake
     bson (1.6.0)
@@ -69,9 +69,9 @@ GEM
       activeresource (= 2.3.14)
       activesupport (= 2.3.14)
       rake (>= 0.8.3)
-    rake (0.9.2.2)
+    rake (10.1.0)
     redis (2.2.2)
-    redis-namespace (1.0.3)
+    redis-namespace (1.0.4)
       redis (< 3.0.0)
     shoulda (3.0.1)
       shoulda-context (~> 1.0.0)

data/README.rdoc

@@ -1,16 +1,21 @@
+= Vanity
+{<img src="https://travis-ci.org/assaf/vanity.png?branch=feature/readme-update" alt="Build Status" />}[https://travis-ci.org/assaf/vanity]
+
 Vanity is an Experiment Driven Development framework for Rails.
 
 * All about Vanity: http://vanity.labnotes.org
-* On github: http://github.com/assaf/vanity
+* On Github: http://github.com/assaf/vanity
 
 http://farm3.static.flickr.com/2540/4099665871_497f274f68_o.jpg
 
 
 == A/B Testing With Rails (In 5 Easy Steps)
 
-<b>Step 1:</b> Start using Vanity in your Rails application:
+=== <b>Step 1:</b> Start using Vanity in your Rails application
+
+==== Step 1.1
 
-== Rails 2.x configuration
+===== Rails 2.x installation
 
   Rails::Initializer.run do |config|
     gem.config "vanity"
@@ -19,39 +24,49 @@ http://farm3.static.flickr.com/2540/4099665871_497f274f68_o.jpg
       require "vanity"
     end
   end
-  
-== Rails 3 configuration
+
+===== Rails 3 installation
 
 Add to your Gemfile:
-    
+
   gem "vanity"
 
-If using a relational database, run the generator and migrations to create the database schema:
+===== Rails 4 installation
+
+Coming soon!
+
+==== Step 1.2
+
+Choose a method to store experiment results: for Redis or an external tracking mechanism, migrations aren't needed. Mongo is also available. To use a relational database, via ActiveRecord, run the generator and migrations to create the database schema:
 
   $ rails generate vanity
   $ rake db:migrate
-  
-Add to your application controller:
+
+==== Step 1.3
+
+add to your application controller:
 
   class ApplicationController < ActionController::Base
     use_vanity :current_user
   end
 
-<b>Step 2:</b> Define your first A/B test.  This experiment goes in the file <code>experiments/price_options.rb</code>:
+=== <b>Step 2:</b> Define your first A/B test
+
+This experiment goes in the file <code>experiments/price_options.rb</code>:
 
   ab_test "Price options" do
     description "Mirror, mirror on the wall, who's the better price of all?"
     alternatives 19, 25, 29
     metrics :signups
   end
-  
-  NOTE: If using a metric as above ("signups"), there needs to be a corresponding ruby file for that metric. Inside the "experiments" directory create a "metrics" directory with a file called "signups.rb". The contents of the file can describe the signup metric, refer to the "Metrics" Vanity documentation page for an example.
 
-<b>Step 3:</b> Present the different options to your users:
+NOTE: If using a metric as above ("signups"), there needs to be a corresponding ruby file for that metric. Inside the "experiments" directory create a "metrics" directory with a file called "signups.rb". The contents of the file can describe the signup metric, refer to the "Metrics" Vanity documentation page for an example.
+
+=== <b>Step 3:</b> Present the different options to your users
 
   <h2>Get started for only $<%= ab_test :price_options %> a month!</h2>
 
-<b>Step 4:</b> Measure conversion:
+=== <b>Step 4:</b> Measure conversion
 
   class SignupController < ApplicationController
     def signup
@@ -65,21 +80,11 @@ Add to your application controller:
     end
   end
 
-<b>Step 5:</b> Check the report:
+=== <b>Step 5:</b> Check the report:
 
   vanity report --output vanity.html
-  
-
-== Rails 3
-  
-There is currently an issue with report generation. The vanity-talk Google Group has a couple posts that outline the issue for now. This is one of the posts: http://groups.google.com/group/vanity-talk/browse_thread/thread/343081a72a0cefb6
-
-If you are collecting data (in development you need to opt-in to this by setting Vanity.playground.collecting = true in environments/development.rb) you can view experiment results with the vanity dashboard instead of the report. 
-
-The vanity dashboard setup instructions with Vanity work for Rails 3.x except the route is different. A Rails 3.x-style route would look like this:
-
-  `match '/vanity(/:action(/:id(.:format)))', :controller=>:vanity`
 
+Or see instructions for viewing the results using Rails.
 
 == Registering participants with Javascript
 
@@ -89,6 +94,16 @@ If robots or spiders make up a significant portion of your sites traffic they ca
 * Set Vanity.playground.add_participant_path = '/path/to/vanity/action', this should point to the add_participant path that is added with Vanity::Rails::Dashboard, make sure that this action is available to all users
 * Add <%= vanity_js %> to any page that needs uses an ab_test. vanity_js 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 vanity_js to the bottom of your layouts is a good option.  Keep in mind that if you call use_js! and don't include vanity_js in your view no participants will be recorded.
 
+== Compatibility Matrix
+
+Running Rails 2 on Ruby 2? Vanity probably won't work for you. But here's what does:
+
+  Persistence: Redis, Mongo, ActiveRecord
+  Rails: 2.3, 3, 3.1, 3.2
+  Ruby: 1.8.7, 1.9.3
+
+NOTE: Support for Rails 4 and Ruby 2.0 are coming soon!
+
 == Contributing
 
 * Fork the project
@@ -102,7 +117,7 @@ If robots or spiders make up a significant portion of your sites traffic they ca
 
 == Credits/License
 
-Original code, copyright of Assaf Arkin, released under the MIT license.  
+Original code, copyright of Assaf Arkin, released under the MIT license.
 
 Documentation available under the Creative Commons Attribution license.
 

data/Rakefile

@@ -17,7 +17,7 @@ task :install=>:build do
 end
 
 desc "Push new release to gemcutter and git tag"
-task :push=>["test:all", "build"] do
+task :push=>["build"] do
   sh "git push"
   puts "Tagging version #{spec.version} .."
   sh "git tag v#{spec.version}"
@@ -33,7 +33,7 @@ desc "Test everything"
 task "test:all"=>"test:adapters"
 
 # Ruby versions we're testing with.
-RUBIES = %w{1.8.7 1.9.2}
+RUBIES = %w{1.8.7 1.9.2 2.0.0}
 
 # Use rake test:rubies to run all combination of tests (see test:adapters) using
 # all the versions of Ruby specified in RUBIES. Or to test a specific version of

data/bin/vanity

@@ -1,16 +1,69 @@
 #!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'vanity' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
+# Is there a better way to detect Rails?
+if File.exist?("config/boot.rb") && File.exist?("config/environment.rb")
+  require "./config/environment"
+else
+  path = File.expand_path("../lib", File.dirname(__FILE__))
+  $LOAD_PATH.unshift path unless $LOAD_PATH.include?(path)
+  require "vanity"
+end
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require "optparse"
 
-require 'rubygems'
-require 'bundler/setup'
+playground = Vanity.playground
+options = Struct.new(:output).new
+opts = OptionParser.new("", 24, "  ") do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [options] command\n"
+  opts.banner << "Commands:\n"
+  opts.banner << "  list    List all experiments and metrics\n"
+  opts.banner << "  report  Report on all running experiments/metrics\n"
+  opts.banner << "  upgrade Upgrade your database when deploying new release\n"
 
-load Gem.bin_path('vanity', 'vanity')
+  opts.separator ""
+  opts.separator "Reporting options:"
+  opts.on "--output FILE", "Write report to this file (default: stdout)" do |path|
+    options.output = path
+  end
+
+  opts.separator ""
+  opts.separator "Common options:"
+  opts.on "--load_path PATH", "Path to experiments directory (default: #{playground.load_path})" do |path|
+    playground.load_path = path
+  end
+  opts.on "-d", "--database url", "Database connection URL (e.g. redis:/localhost:6379)" do |conn|
+    playground.establish_connection conn
+  end
+  opts.on "--redis HOST:PORT:DB", "DEPRECATED: Redis server host (default: localhost:6379)" do |redis|
+    host, port, db = redis.split(":")
+    playground.establish_connection "redis:/#{host}:#{port}/#{db}"
+  end
+  opts.on_tail "-h", "--help", "Show this message" do
+    puts opts.to_s.gsub(/^.*DEPRECATED.*$/s, '')
+    exit
+  end
+  opts.on_tail "-v", "--version", "Show version"  do
+    puts "Vanity #{Vanity::Version::STRING}"
+    exit
+  end
+end
+
+opts.parse!(ARGV)
+if ARGV.empty?
+  puts opts.banner
+  exit
+end
+
+ARGV.each do |cmd|
+  case cmd
+  when "report"
+    require "vanity/commands/report"
+    Vanity::Commands.report options.output
+  when "list"
+    require "vanity/commands/list"
+    Vanity::Commands.list
+  when "upgrade"
+    require "vanity/commands/upgrade"
+    Vanity::Commands.upgrade
+  else puts "No such command: #{cmd}"
+  end
+end

data/gemfiles/rails3.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source :rubygems
+source "https://rubygems.org"
 
 gem "appraisal"
 gem "garb"

data/gemfiles/rails3.gemfile.lock

@@ -1,12 +1,12 @@
 PATH
-  remote: /Users/dougcole/workspace/vanity
+  remote: /Users/phill/Development/ruby/vanity
   specs:
-    vanity (1.8.0)
+    vanity (1.8.1)
       redis (~> 2.0)
       redis-namespace (~> 1.0.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     SystemTimer (1.2.3)
     abstract (1.0.0)
@@ -97,7 +97,7 @@ GEM
     rdoc (3.12)
       json (~> 1.4)
     redis (2.2.2)
-    redis-namespace (1.0.3)
+    redis-namespace (1.0.4)
       redis (< 3.0.0)
     shoulda (3.0.1)
       shoulda-context (~> 1.0.0)

data/gemfiles/rails31.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source :rubygems
+source "https://rubygems.org"
 
 gem "appraisal"
 gem "garb"

data/gemfiles/rails31.gemfile.lock

@@ -1,12 +1,12 @@
 PATH
-  remote: /Users/dougcole/workspace/vanity
+  remote: /Users/phill/Development/ruby/vanity
   specs:
-    vanity (1.8.0)
+    vanity (1.8.1)
       redis (~> 2.0)
       redis-namespace (~> 1.0.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     SystemTimer (1.2.3)
     actionmailer (3.1.3)
@@ -103,7 +103,7 @@ GEM
     rdoc (3.12)
       json (~> 1.4)
     redis (2.2.2)
-    redis-namespace (1.0.3)
+    redis-namespace (1.0.4)
       redis (< 3.0.0)
     shoulda (3.0.1)
       shoulda-context (~> 1.0.0)

data/gemfiles/rails32.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source :rubygems
+source "https://rubygems.org"
 
 gem "appraisal"
 gem "garb"

data/gemfiles/rails32.gemfile.lock

@@ -1,12 +1,12 @@
 PATH
-  remote: /Users/dougcole/workspace/vanity
+  remote: /Users/phill/Development/ruby/vanity
   specs:
-    vanity (1.8.0)
+    vanity (1.8.1)
       redis (~> 2.0)
       redis-namespace (~> 1.0.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     SystemTimer (1.2.3)
     actionmailer (3.2.1)
@@ -101,7 +101,7 @@ GEM
     rdoc (3.12)
       json (~> 1.4)
     redis (2.2.2)
-    redis-namespace (1.0.3)
+    redis-namespace (1.0.4)
       redis (< 3.0.0)
     shoulda (3.0.1)
       shoulda-context (~> 1.0.0)

data/lib/vanity/adapters/active_record_adapter.rb

@@ -32,6 +32,8 @@ module Vanity
 
       # Metric value
       class VanityMetricValue < VanityRecord
+	       attr_accessible :date, :index, :value if respond_to?(:attr_accessible)
+
         self.table_name = :vanity_metric_values
         belongs_to :vanity_metric
       end
@@ -40,6 +42,7 @@ module Vanity
       class VanityExperiment < VanityRecord
         self.table_name = :vanity_experiments
         has_many :vanity_conversions, :dependent => :destroy
+	attr_accessible :experiment_id if respond_to?(:attr_accessible)
 
         # Finds or creates the experiment
         def self.retrieve(experiment)
@@ -61,6 +64,7 @@ module Vanity
       # Participant model
       class VanityParticipant < VanityRecord
         self.table_name = :vanity_participants
+	attr_accessible :experiment_id, :identity, :seen, :shown, :converted if respond_to?(:attr_accessible)
 
         # Finds the participant by experiment and identity. If
         # create is true then it will create the participant

data/lib/vanity/commands/report.rb

@@ -2,30 +2,28 @@ require "erb"
 require "cgi"
 
 module Vanity
-  
+
   # Render method available to templates (when used by Vanity command line,
   # outside Rails).
   module Render
-    
+
     # Render the named template.  Used for reporting and the dashboard.
-    def render(path, locals = {})
-      locals[:playground] = self
-      keys = locals.keys
-      struct = Struct.new(*keys)
-      struct.send :include, Render
-      locals = struct.new(*locals.values_at(*keys))
-      dir, base = File.split(path)
-      path = File.join(dir, "_#{base}")
-      erb = ERB.new(File.read(path), nil, '<>')
-      erb.filename = path
-      erb.result(locals.instance_eval { binding })
+    def render(path_or_options, locals = {})
+      if path_or_options.respond_to?(:keys)
+	render_erb(
+	  path_or_options[:file] || path_or_options[:partial],
+	  path_or_options[:locals]
+	)
+      else
+	render_erb(path_or_options, locals)
+      end
     end
 
     # Escape HTML.
     def vanity_h(html)
       CGI.escapeHTML(html.to_s)
     end
-    
+
     def vanity_html_safe(text)
       text
     end
@@ -38,6 +36,29 @@ module Vanity
         gsub(/([^\n]\n)(?=[^\n])/, '\1<br />') + # 1 newline   -> br
         "</p>"
     end
+
+    protected
+
+    def render_erb(path, locals = {})
+      locals[:playground] = self
+      keys = locals.keys
+      struct = Struct.new(*keys)
+      struct.send :include, Render
+      locals = struct.new(*locals.values_at(*keys))
+      dir, base = File.split(path)
+      path = File.join(dir, partialize(base))
+      erb = ERB.new(File.read(path), nil, '<>')
+      erb.filename = path
+      erb.result(locals.instance_eval { binding })
+    end
+
+    def partialize(template_name)
+      if template_name[0] != '_'
+	"_#{template_name}"
+      else
+	template_name
+      end
+    end
   end
 
   # Commands available when running Vanity from the command line (see bin/vanity).

data/lib/vanity/experiment/base.rb

@@ -34,7 +34,7 @@ module Vanity
     class Base
 
       class << self
-        
+
         # Returns the type of this class as a symbol (e.g. AbTest becomes
         # ab_test).
         def type
@@ -94,7 +94,7 @@ module Vanity
       def type
         self.class.type
       end
-     
+
       # Defines how we obtain an identity for the current experiment.  Usually
       # Vanity gets the identity form a session object (see use_vanity), but
       # there are cases where you want a particular experiment to use a
@@ -126,7 +126,7 @@ module Vanity
         @description = text if text
         @description
       end
- 
+
 
       # -- Experiment completion --
 
@@ -152,7 +152,7 @@ module Vanity
       def completed_at
         @completed_at ||= connection.get_experiment_completed_at(@id)
       end
-      
+
       # Returns true if experiment active, false if completed.
       def active?
         !@playground.collecting? || !connection.is_experiment_completed?(@id)
@@ -180,7 +180,7 @@ module Vanity
 
       def default_identify(context)
         raise "No Vanity.context" unless context
-        raise "Vanity.context does not respond to vanity_identity" unless context.respond_to?(:vanity_identity)
+        raise "Vanity.context does not respond to vanity_identity" unless context.respond_to?(:vanity_identity, true)
         context.send(:vanity_identity) or raise "Vanity.context.vanity_identity - no identity"
       end
 
@@ -195,7 +195,7 @@ module Vanity
           end
         end
       end
-      
+
       # Returns key for this experiment, or with an argument, return a key
       # using the experiment as the namespace.  Examples:
       #   key => "vanity:experiments:green_button"
@@ -208,11 +208,11 @@ module Vanity
       def connection
         @playground.connection
       end
-      
+
     end
   end
 
   class NoExperimentError < NameError
   end
-  
+
 end

data/lib/vanity/frameworks/rails.rb

@@ -1,5 +1,5 @@
 module Vanity
-  module Rails #:nodoc:
+  module Rails
     def self.load!
       Vanity.playground.load_path = ::Rails.root + Vanity.playground.load_path
       Vanity.playground.logger ||= ::Rails.logger
@@ -93,8 +93,8 @@ module Vanity
       end
       protected :use_vanity_mailer
     end
-    
-    
+
+
     # Vanity needs these filters.  They are includes in ActionController and
     # automatically added when you use #use_vanity in your controller.
     module Filters
@@ -142,7 +142,7 @@ module Vanity
       def vanity_reload_filter
         Vanity.playground.reload!
       end
-      
+
       # Filter to track metrics
       # pass _track param along to call track! on that alternative
       def vanity_track_filter
@@ -150,7 +150,7 @@ module Vanity
           track! params[:_track]
         end
       end
-      
+
       protected :vanity_context_filter, :vanity_query_parameter_filter, :vanity_reload_filter
     end
 
@@ -182,14 +182,10 @@ module Vanity
       #     <%= count %> features to choose from!
       #   <% end %>
       def ab_test(name, &block)
-        if Vanity.playground.using_js?
-          @_vanity_experiments ||= {}
-          @_vanity_experiments[name] ||= Vanity.playground.experiment(name.to_sym).choose
-          value = @_vanity_experiments[name].value
-        else
-          value = Vanity.playground.experiment(name.to_sym).choose.value
-        end
- 
+        @_vanity_experiments ||= {}
+        @_vanity_experiments[name] ||= Vanity.playground.experiment(name.to_sym).choose
+        value = @_vanity_experiments[name].value
+
         if block
           content = capture(value, &block)
           if defined?(block_called_from_erb?) && block_called_from_erb?(block)
@@ -201,13 +197,13 @@ module Vanity
           value
         end
       end
-      
+
       # Generate url with the identity of the current user and the metric to track on click
       def vanity_track_url_for(identity, metric, options = {})
         options = options.merge(:_identity => identity, :_track => metric)
         url_for(options)
       end
-      
+
       # Generate url with the fingerprint for the current Vanity experiment
       def vanity_tracking_image(identity, metric, options = {})
         options = options.merge(:controller => :vanity, :action => :image, :_identity => identity, :_track => metric)
@@ -215,7 +211,7 @@ module Vanity
       end
 
       def vanity_js
-        return if @_vanity_experiments.nil?
+        return if @_vanity_experiments.nil? || @_vanity_experiments.empty?
         javascript_tag do
           render :file => Vanity.template("_vanity.js.erb")
         end
@@ -236,6 +232,34 @@ module Vanity
       def vanity_simple_format(text, html_options={})
         vanity_html_safe(simple_format(text, html_options))
       end
+
+      # Return a copy of the active experiments on a page
+      #
+      # @example Render some info about each active experiment in development mode
+      #   <% if Rails.env.development? %>
+      #     <% vanity_experiments.each do |name, alternative| %>
+      #       <span>Participating in <%= name %>, seeing <%= alternative %>:<%= alternative.value %> </span>
+      #     <% end %>
+      #   <% end %>
+      # @example Push experiment values into javascript for use there
+      #   <% experiments = vanity_experiments %>
+      #   <% unless experiments.empty? %>
+      #     <script>
+      #       <% experiments.each do |name, alternative| %>
+      #         myAbTests.<%= name.to_s.camelize(:lower) %> = '<%= alternative.value %>';
+      #       <% end %>
+      #     </script>
+      #   <% end %>
+      def vanity_experiments
+        @_vanity_experiments ||= {}
+        experiments = {}
+
+        @_vanity_experiments.each do |name, alternative|
+          experiments[name] = alternative.clone
+        end
+
+        return experiments
+      end
     end
 
 
@@ -269,7 +293,7 @@ module Vanity
         render :status => 200, :nothing => true
       end
     end
-    
+
     module TrackingImage
       def image
         # send image

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

@@ -1,20 +1,16 @@
-<% unless @_vanity_experiments.empty? %>
-  var httpRequest;
-  <%
-    @_vanity_experiments.each do |name, alternative| 
-  %>
-    var params = "e=<%= name %>&a=<%= alternative.id %>&authenticity_token=" + encodeURIComponent("<%= form_authenticity_token %>");
-    if (window.XMLHttpRequest) { // Mozilla, Safari, ...
-      httpRequest = new XMLHttpRequest();
-    } else if (window.ActiveXObject) { // IE
-      try { httpRequest = new ActiveXObject("Msxml2.XMLHTTP"); }
-      catch (e) { }
-    }
-    if (httpRequest) {
-      httpRequest.open('POST', "<%= Vanity.playground.add_participant_path %>", true);
-      httpRequest.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
-      httpRequest.setRequestHeader("X-Requested-With", "XMLHttpRequest");
-      httpRequest.send(params);
-    }
-  <% end %>
-<% end %>
+var httpRequest;
+<% @_vanity_experiments.each do |name, alternative| %>
+  var params = "e=<%= name %>&a=<%= alternative.id %>&authenticity_token=" + encodeURIComponent("<%= form_authenticity_token %>");
+  if (window.XMLHttpRequest) { // Mozilla, Safari, ...
+    httpRequest = new XMLHttpRequest();
+  } else if (window.ActiveXObject) { // IE
+    try { httpRequest = new ActiveXObject("Msxml2.XMLHTTP"); }
+    catch (e) { }
+  }
+  if (httpRequest) {
+    httpRequest.open('POST', "<%= Vanity.playground.add_participant_path %>", true);
+    httpRequest.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
+    httpRequest.setRequestHeader("X-Requested-With", "XMLHttpRequest");
+    httpRequest.send(params);
+  }
+<% end %>

data/lib/vanity/version.rb

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

data/test/cli_test.rb

@@ -0,0 +1,53 @@
+require "test/test_helper"
+
+class PlaygroundTest < Test::Unit::TestCase
+
+  def test_responds_to_version
+    (RUBY_VERSION == "1.8.7" ? Object : IO).any_instance.expects(:puts)
+    ARGV.clear
+    ARGV << '--version'
+    load "bin/vanity"
+  rescue SystemExit => e
+    assert e.status == 0
+  end
+
+  def test_responds_to_help
+    (RUBY_VERSION == "1.8.7" ? Object : IO).any_instance.expects(:puts)
+    ARGV.clear
+    ARGV << '--help'
+    load "bin/vanity"
+  rescue SystemExit => e
+    assert e.status == 0
+  end
+
+  def test_responds_to_list
+    require "vanity/commands/list"
+    Vanity::Commands.expects(:list)
+    ARGV.clear
+    ARGV << 'list'
+    load "bin/vanity"
+  rescue SystemExit => e
+    assert e.status == 0
+  end
+
+  def test_responds_to_report
+    require "vanity/commands/report"
+    Vanity::Commands.expects(:report)
+    ARGV.clear
+    ARGV << 'report'
+    load "bin/vanity"
+  rescue SystemExit => e
+    assert e.status == 0
+  end
+
+  def test_responds_to_unknown_commands
+    require "vanity/commands/upgrade"
+    Vanity::Commands.expects(:upgrade)
+    ARGV.clear
+    ARGV << 'upgrade'
+    load "bin/vanity"
+  rescue SystemExit => e
+    assert e.status == 0
+  end
+
+end

data/test/dummy/config/application.rb

@@ -35,6 +35,12 @@ module Dummy
     # JavaScript files you want as :defaults (application.js is always included).
     # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
 
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = true if ActiveRecord::Base.respond_to?(:whitelist_attributes=)
+
     # Configure the default encoding used in templates for Ruby 1.9.
     config.encoding = "utf-8"
 

data/test/rails_helper_test.rb

@@ -21,18 +21,39 @@ class RailsHelperTest < ActionView::TestCase
     Vanity.playground.use_js!
     result = ab_test(:pie_or_cake)
     assert [:pie, :cake].include?(result)
-    10.times do 
+    10.times do
       assert result == ab_test(:pie_or_cake)
     end
   end
-  
+
   def test_vanity_track_url_for_returns_url_with_identity_and_metrics
     self.expects(:url_for).with(:controller => "controller", :action => "action", :_identity => '123', :_track => :sugar_high)
     vanity_track_url_for("123", :sugar_high, :controller => "controller", :action => "action")
   end
-  
+
   def test_vanity_tracking_image
     self.expects(:url_for).with(:controller => :vanity, :action => :image, :_identity => '123', :_track => :sugar_high).returns("/url")
     assert_equal image_tag("/url", :width => "1px", :height => "1px", :alt => ""), vanity_tracking_image("123", :sugar_high, options = {})
   end
+
+  def test_vanity_experiments
+    result = ab_test(:pie_or_cake)
+    test_description = ''
+    vanity_experiments.each do |name, alternative|
+      test_description += "Experiment #{name} chose #{alternative.value}"
+    end
+    assert_equal test_description, "Experiment pie_or_cake chose #{result}"
+  end
+
+  def test_vanity_experiments_return_is_read_only
+    result = ab_test(:pie_or_cake)
+    vanity_experiments_returns = vanity_experiments
+    vanity_experiments_returns[:some_new_key] = 'some new value'
+    assert_equal vanity_experiments.keys.length, 1
+  end
+
+  def test_vanity_experiments_returns_empty_hash_when_no_experiments
+    assert_equal vanity_experiments, {}
+  end
+
 end

metadata

@@ -1,47 +1,46 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: vanity
-version: !ruby/object:Gem::Version
-  version: 1.8.0
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  version: 1.8.1
 platform: ruby
-authors:
+authors: 
 - Assaf Arkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-12 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-10-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: redis
-  requirement: &70288496150040 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
+      - !ruby/object:Gem::Version 
+        version: "2.0"
   type: :runtime
-  prerelease: false
-  version_requirements: *70288496150040
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: redis-namespace
-  requirement: &70288496149580 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.0.0
   type: :runtime
-  prerelease: false
-  version_requirements: *70288496149580
+  version_requirements: *id002
 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
 - .rvmrc
@@ -79,8 +78,6 @@ files:
 - doc/metrics.textile
 - doc/rails.textile
 - doc/site.js
-- gemfiles/rails2.gemfile
-- gemfiles/rails2.gemfile.lock
 - gemfiles/rails3.gemfile
 - gemfiles/rails3.gemfile.lock
 - gemfiles/rails31.gemfile
@@ -125,6 +122,7 @@ files:
 - lib/vanity/templates/vanity.js
 - lib/vanity/version.rb
 - test/adapters/redis_adapter_test.rb
+- test/cli_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
@@ -176,36 +174,39 @@ files:
 - vanity.gemspec
 homepage: http://vanity.labnotes.org
 licenses: []
+
+metadata: {}
+
 post_install_message: To get started run vanity --help
-rdoc_options:
+rdoc_options: 
 - --title
-- Vanity 1.8.0
+- Vanity 1.8.1
 - --main
 - README.rdoc
 - --webcvs
 - http://github.com/assaf/vanity
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.1.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Experience Driven Development framework for Ruby
-test_files:
+test_files: 
 - test/adapters/redis_adapter_test.rb
+- test/cli_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb

data/gemfiles/rails2.gemfile

@@ -1,20 +0,0 @@
-# This file was generated by Appraisal
-
-source :rubygems
-
-gem "appraisal"
-gem "garb"
-gem "mocha"
-gem "mongo"
-gem "bson_ext"
-gem "mysql"
-gem "passenger", "~>2.0"
-gem "pg"
-gem "rack"
-gem "shoulda"
-gem "timecop"
-gem "webmock"
-gem "SystemTimer", "1.2.3", :platforms=>:mri_18
-gem "rails", "2.3.14"
-
-gemspec :path=>"../"

data/gemfiles/rails2.gemfile.lock

@@ -1,85 +0,0 @@
-PATH
-  remote: /Users/dougcole/workspace/vanity
-  specs:
-    vanity (1.8.0)
-      redis (~> 2.0)
-      redis-namespace (~> 1.0.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    SystemTimer (1.2.3)
-    actionmailer (2.3.14)
-      actionpack (= 2.3.14)
-    actionpack (2.3.14)
-      activesupport (= 2.3.14)
-      rack (~> 1.1.0)
-    activerecord (2.3.14)
-      activesupport (= 2.3.14)
-    activeresource (2.3.14)
-      activesupport (= 2.3.14)
-    activesupport (2.3.14)
-    addressable (2.2.7)
-    appraisal (0.4.1)
-      bundler
-      rake
-    bson (1.6.0)
-    bson_ext (1.6.0)
-      bson (= 1.6.0)
-    crack (0.3.1)
-    fastthread (1.0.7)
-    garb (0.9.1)
-      activesupport (>= 2.2.0)
-      crack (>= 0.1.6)
-    metaclass (0.0.1)
-    mocha (0.10.5)
-      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
-      rake (>= 0.8.1)
-    pg (0.13.2)
-    rack (1.1.3)
-    rails (2.3.14)
-      actionmailer (= 2.3.14)
-      actionpack (= 2.3.14)
-      activerecord (= 2.3.14)
-      activeresource (= 2.3.14)
-      activesupport (= 2.3.14)
-      rake (>= 0.8.3)
-    rake (0.9.2.2)
-    redis (2.2.2)
-    redis-namespace (1.0.3)
-      redis (< 3.0.0)
-    shoulda (3.0.1)
-      shoulda-context (~> 1.0.0)
-      shoulda-matchers (~> 1.0.0)
-    shoulda-context (1.0.0)
-    shoulda-matchers (1.0.0)
-    timecop (0.3.5)
-    webmock (1.8.0)
-      addressable (>= 2.2.7)
-      crack (>= 0.1.7)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  SystemTimer (= 1.2.3)
-  appraisal
-  bson_ext
-  garb
-  mocha
-  mongo
-  mysql
-  passenger (~> 2.0)
-  pg
-  rack
-  rails (= 2.3.14)
-  shoulda
-  timecop
-  vanity!
-  webmock