lookout-vanity 1.8.2

data/lib/vanity/experiment/base.rb

@@ -0,0 +1,218 @@
+module Vanity
+  module Experiment
+
+    # These methods are available from experiment definitions (files located in
+    # the experiments directory, automatically loaded by Vanity).  Use these
+    # methods to define you experiments, for example:
+    #   ab_test "New Banner" do
+    #     alternatives :red, :green, :blue
+    #     metrics :signup
+    #   end
+    module Definition
+
+      attr_reader :playground
+
+      # Defines a new experiment, given the experiment's name, type and
+      # definition block.
+      def define(name, type, options = nil, &block)
+        fail "Experiment #{@experiment_id} already defined in playground" if playground.experiments[@experiment_id]
+        klass = Experiment.const_get(type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase })
+        experiment = klass.new(playground, @experiment_id, name, options)
+        experiment.instance_eval &block
+        experiment.save
+        playground.experiments[@experiment_id] = experiment
+      end
+
+      def new_binding(playground, id)
+        @playground, @experiment_id = playground, id
+        binding
+      end
+
+    end
+
+    # Base class that all experiment types are derived from.
+    class Base
+
+      class << self
+        
+        # Returns the type of this class as a symbol (e.g. AbTest becomes
+        # ab_test).
+        def type
+          name.split("::").last.gsub(/([a-z])([A-Z])/) { "#{$1}_#{$2}" }.gsub(/([A-Z])([A-Z][a-z])/) { "#{$1}_#{$2}" }.downcase
+        end
+
+        # Playground uses this to load experiment definitions.
+        def load(playground, stack, file)
+          fail "Circular dependency detected: #{stack.join('=>')}=>#{file}" if stack.include?(file)
+          source = File.read(file)
+          stack.push file
+          id = File.basename(file, ".rb").downcase.gsub(/\W/, "_").to_sym
+          context = Object.new
+          context.instance_eval do
+            extend Definition
+            experiment = eval(source, context.new_binding(playground, id), file)
+            fail NameError.new("Expected #{file} to define experiment #{id}", id) unless playground.experiments[id]
+            return experiment
+          end
+        rescue
+          error = NameError.exception($!.message, id)
+          error.set_backtrace $!.backtrace
+          raise error
+        ensure
+          stack.pop
+        end
+
+      end
+
+      def initialize(playground, id, name, options = nil)
+        @playground = playground
+        @id, @name = id.to_sym, name
+        @options = options || {}
+        @identify_block = method(:default_identify)
+      end
+
+      # Human readable experiment name (first argument you pass when creating a
+      # new experiment).
+      attr_reader :name
+      alias :to_s :name
+
+      # Unique identifier, derived from name experiment name, e.g. "Green
+      # Button" becomes :green_button.
+      attr_reader :id
+
+      attr_reader :playground
+
+      # Time stamp when experiment was created.
+      def created_at
+        @created_at ||= connection.get_experiment_created_at(@id)
+      end
+
+      # Time stamp when experiment was completed.
+      attr_reader :completed_at
+
+      # Returns the type of this experiment as a symbol (e.g. :ab_test).
+      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
+      # different identity.
+      #
+      # For example, if all your experiments use current_user and you need one
+      # experiment to use the current project:
+      #   ab_test "Project widget" do
+      #     alternatives :small, :medium, :large
+      #     identify do |controller|
+      #       controller.project.id
+      #     end
+      #   end
+      def identify(&block)
+        fail "Missing block" unless block
+        @identify_block = block
+      end
+
+
+      # -- Reporting --
+
+      # Sets or returns description. For example
+      #   ab_test "Simple" do
+      #     description "A simple A/B experiment"
+      #   end
+      #
+      #   puts "Just defined: " + experiment(:simple).description
+      def description(text = nil)
+        @description = text if text
+        @description
+      end
+ 
+
+      # -- Experiment completion --
+
+      # Define experiment completion condition.  For example:
+      #   complete_if do
+      #     !score(95).chosen.nil?
+      #   end
+      def complete_if(&block)
+        raise ArgumentError, "Missing block" unless block
+        raise "complete_if already called on this experiment" if @complete_block
+        @complete_block = block
+      end
+
+      # Force experiment to complete.
+      def complete!
+        @playground.logger.info "vanity: completed experiment #{id}"
+        return unless @playground.collecting?
+        connection.set_experiment_completed_at @id, Time.now
+        @completed_at = connection.get_experiment_completed_at(@id)
+      end
+
+      # Time stamp when experiment was completed.
+      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)
+      end
+
+      # -- Store/validate --
+
+      # Get rid of all experiment data.
+      def destroy
+        connection.destroy_experiment @id
+        @created_at = @completed_at = nil
+      end
+
+      # Called by Playground to save the experiment definition.
+      def save
+        return unless @playground.collecting?
+        connection.set_experiment_created_at @id, Time.now
+      end
+
+    protected
+
+      def identity
+        @identify_block.call(Vanity.context)
+      end
+
+      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)
+        context.send(:vanity_identity) or raise "Vanity.context.vanity_identity - no identity"
+      end
+
+      # Derived classes call this after state changes that may lead to
+      # experiment completing.
+      def check_completion!
+        if @complete_block
+          begin
+            complete! if @complete_block.call
+          rescue
+            warn "Error in Vanity::Experiment::Base: #{$!}"
+          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"
+      #   key("participants") => "vanity:experiments:green_button:participants"
+      def key(name = nil)
+        "#{@id}:#{name}"
+      end
+
+      # Shortcut for Vanity.playground.connection
+      def connection
+        @playground.connection
+      end
+      
+    end
+  end
+
+  class NoExperimentError < NameError
+  end
+  
+end

data/lib/vanity/frameworks.rb

@@ -0,0 +1,16 @@
+# Automatically configure Vanity.
+if defined?(Rails)
+  if Rails.const_defined?(:Railtie) # Rails 3
+    class Plugin < Rails::Railtie # :nodoc:
+      initializer "vanity.require" do |app|
+        require 'vanity/frameworks/rails'  
+        Vanity::Rails.load!
+      end
+    end
+  else
+    Rails.configuration.after_initialize do
+      require 'vanity/frameworks/rails'  
+      Vanity::Rails.load!
+    end
+  end
+end

data/lib/vanity/frameworks/rails.rb

@@ -0,0 +1,325 @@
+module Vanity
+  module Rails #:nodoc:
+    def self.load!
+      Vanity.playground.load_path = ::Rails.root + Vanity.playground.load_path
+      Vanity.playground.logger ||= ::Rails.logger
+
+      # Do this at the very end of initialization, allowing you to change
+      # connection adapter, turn collection on/off, etc.
+      ::Rails.configuration.after_initialize do
+        Vanity.playground.load!
+      end
+    end
+
+    # The use_vanity method will setup the controller to allow testing and
+    # tracking of the current user.
+    module UseVanity
+      # Defines the vanity_identity method and the set_identity_context filter.
+      #
+      # Call with the name of a method that returns an object whose identity
+      # will be used as the Vanity identity.  Confusing?  Let's try by example:
+      #
+      #   class ApplicationController < ActionController::Base
+      #     use_vanity :current_user
+      #
+      #     def current_user
+      #       User.find(session[:user_id])
+      #     end
+      #   end
+      #
+      # If that method (current_user in this example) returns nil, Vanity will
+      # set the identity for you (using a cookie to remember it across
+      # requests).  It also uses this mechanism if you don't provide an
+      # identity object, by calling use_vanity with no arguments.
+      #
+      # Of course you can also use a block:
+      #   class ProjectController < ApplicationController
+      #     use_vanity { |controller| controller.params[:project_id] }
+      #   end
+      def use_vanity(symbol = nil, &block)
+        if block
+          define_method(:vanity_identity) { block.call(self) }
+        else
+          define_method :vanity_identity do
+            return @vanity_identity if @vanity_identity
+            if symbol && object = send(symbol)
+              @vanity_identity = object.id
+            elsif request.get? && params[:_identity]
+              @vanity_identity = params[:_identity]
+              cookies["vanity_id"] = { :value=>@vanity_identity, :expires=>1.month.from_now }
+              @vanity_identity
+            elsif response # everyday use
+              #conditional for Rails2 support
+              secure_random = defined?(SecureRandom) ? SecureRandom : ActiveSupport::SecureRandom
+              @vanity_identity = cookies["vanity_id"] || secure_random.hex(16)
+              cookie = { :value=>@vanity_identity, :expires=>1.month.from_now }
+              # Useful if application and admin console are on separate domains.
+              # This only works in Rails 3.x.
+              cookie[:domain] ||= ::Rails.application.config.session_options[:domain] if ::Rails.respond_to?(:application)
+              cookies["vanity_id"] = cookie
+              @vanity_identity
+            else # during functional testing
+              @vanity_identity = "test"
+            end
+          end
+        end
+        protected :vanity_identity
+        around_filter :vanity_context_filter
+        before_filter :vanity_reload_filter unless ::Rails.configuration.cache_classes
+        before_filter :vanity_query_parameter_filter
+        after_filter :vanity_track_filter
+      end
+      protected :use_vanity
+    end
+
+    module UseVanityMailer
+      def use_vanity_mailer(symbol = nil)
+        # Context is the instance of ActionMailer::Base
+        Vanity.context = self
+        if symbol && (@object = symbol)
+          class << self
+            define_method :vanity_identity do
+              @vanity_identity = (String === @object ? @object : @object.id)
+            end
+          end
+        else
+          class << self
+            define_method :vanity_identity do
+              secure_random = defined?(SecureRandom) ? SecureRandom : ActiveSupport::SecureRandom
+              @vanity_identity = @vanity_identity || secure_random.hex(16)
+            end
+          end
+        end
+      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
+      # Around filter that sets Vanity.context to controller.
+      def vanity_context_filter
+        previous, Vanity.context = Vanity.context, self
+        yield
+      ensure
+        Vanity.context = previous
+      end
+
+      # This filter allows user to choose alternative in experiment using query
+      # parameter.
+      #
+      # Each alternative has a unique fingerprint (run vanity list command to
+      # see them all).  A request with the _vanity query parameter is
+      # intercepted, the alternative is chosen, and the user redirected to the
+      # same request URL sans _vanity parameter.  This only works for GET
+      # requests.
+      #
+      # For example, if the user requests the page
+      # http://example.com/?_vanity=2907dac4de, the first alternative of the
+      # :null_abc experiment is chosen and the user redirected to
+      # http://example.com/.
+      def vanity_query_parameter_filter
+        if request.get? && params[:_vanity]
+          hashes = Array(params.delete(:_vanity))
+          Vanity.playground.experiments.each do |id, experiment|
+            if experiment.respond_to?(:alternatives)
+              experiment.alternatives.each do |alt|
+                if hash = hashes.delete(experiment.fingerprint(alt))
+                  experiment.chooses alt.value
+                  break
+                end
+              end
+            end
+            break if hashes.empty?
+          end
+          redirect_to url_for(params)
+        end
+      end
+
+      # Before filter to reload Vanity experiments/metrics.  Enabled when
+      # cache_classes is false (typically, testing environment).
+      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
+        if request.get? && params[:_track]
+          track! params[:_track]
+        end
+      end
+      
+      protected :vanity_context_filter, :vanity_query_parameter_filter, :vanity_reload_filter
+    end
+
+
+    # Introduces ab_test helper (controllers and views).  Similar to the generic
+    # ab_test method, with the ability to capture content (applicable to views,
+    # see examples).
+    module Helpers
+      # This method returns one of the alternative values in the named A/B test.
+      #
+      # @example A/B two alternatives for a page
+      #   def index
+      #     if ab_test(:new_page) # true/false test
+      #       render action: "new_page"
+      #     else
+      #       render action: "index"
+      #     end
+      #   end
+      # @example Similar, alternative value is page name
+      #   def index
+      #     render action: ab_test(:new_page)
+      #   end
+      # @example A/B test inside ERB template (condition)
+      #   <%= if ab_test(:banner) %>100% less complexity!<% end %>
+      # @example A/B test inside ERB template (value)
+      #   <%= ab_test(:greeting) %> <%= current_user.name %>
+      # @example A/B test inside ERB template (capture)
+      #   <% ab_test :features do |count| %>
+      #     <%= 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
+ 
+        if block
+          content = capture(value, &block)
+          if defined?(block_called_from_erb?) && block_called_from_erb?(block)
+             concat(content)
+          else
+            content
+          end
+        else
+          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)
+        image_tag(url_for(options), :width => "1px", :height => "1px", :alt => "")
+      end
+
+      def vanity_js
+        return if @_vanity_experiments.nil?
+        javascript_tag do
+          render :file => Vanity.template("_vanity.js.erb")
+        end
+      end
+
+      def vanity_h(text)
+        h(text)
+      end
+
+      def vanity_html_safe(text)
+        if text.respond_to?(:html_safe)
+          text.html_safe
+        else
+          text
+        end
+      end
+
+      def vanity_simple_format(text, html_options={})
+        vanity_html_safe(simple_format(text, html_options))
+      end
+    end
+
+
+    # Step 1: Add a new resource in config/routes.rb:
+    #   map.vanity "/vanity/:action/:id", :controller=>:vanity
+    #
+    # Step 2: Create a new experiments controller:
+    #   class VanityController < ApplicationController
+    #     include Vanity::Rails::Dashboard
+    #   end
+    #
+    # Step 3: Open your browser to http://localhost:3000/vanity
+    module Dashboard
+      def index
+        render :file=>Vanity.template("_report"), :content_type=>Mime::HTML, :layout=>false
+      end
+
+      def chooses
+        exp = Vanity.playground.experiment(params[:e].to_sym)
+        exp.chooses(exp.alternatives[params[:a].to_i].value)
+        render :file=>Vanity.template("_experiment"), :locals=>{:experiment=>exp}
+      end
+
+      def add_participant
+      	if params[:e].nil? || params[:e].empty?
+      	  render :status => 404, :nothing => true
+      	  return
+      	end
+        exp = Vanity.playground.experiment(params[:e].to_sym)
+        exp.chooses(exp.alternatives[params[:a].to_i].value)
+        render :status => 200, :nothing => true
+      end
+    end
+    
+    module TrackingImage
+      def image
+        # send image
+        send_file(File.expand_path("../images/x.gif", File.dirname(__FILE__)), :type => 'image/gif', :stream => false, :disposition => 'inline')
+      end
+    end
+  end
+end
+
+
+# Enhance ActionController with use_vanity, filters and helper methods.
+if defined?(ActionController)
+  # Include in controller, add view helper methods.
+  ActionController::Base.class_eval do
+    extend Vanity::Rails::UseVanity
+    include Vanity::Rails::Filters
+    helper Vanity::Rails::Helpers
+  end
+
+  module ActionController
+    class TestCase
+      alias :setup_controller_request_and_response_without_vanity :setup_controller_request_and_response
+      # Sets Vanity.context to the current controller, so you can do things like:
+      #   experiment(:simple).chooses(:green)
+      def setup_controller_request_and_response
+        setup_controller_request_and_response_without_vanity
+        Vanity.context = @controller
+      end
+    end
+  end
+end
+
+if defined?(ActionMailer)
+  # Include in mailer, add view helper methods.
+  ActionMailer::Base.class_eval do
+    include Vanity::Rails::UseVanityMailer
+    include Vanity::Rails::Filters
+    helper Vanity::Rails::Helpers
+  end
+end
+
+# Reconnect whenever we fork under Passenger.
+if defined?(PhusionPassenger)
+  PhusionPassenger.on_event(:starting_worker_process) do |forked|
+    if forked
+      begin
+        Vanity.playground.reconnect! if Vanity.playground.collecting?
+      rescue Exception=>ex
+        Rails.logger.error "Error reconnecting: #{ex.to_s}"
+      end
+    end
+  end
+end