vanity 1.4.0 → 1.5.0.beta

data/lib/vanity/adapters/{mongo_adapter.rb → mongodb_adapter.rb}

@@ -18,7 +18,7 @@ module Vanity
       def initialize(options)
         @mongo = Mongo::Connection.new(options[:host], options[:port], :connect=>false)
         @options = options.clone
-        @options[:database] ||= (@options[:path] && @options[:path].split("/")[1])
+        @options[:database] ||= (@options[:path] && @options[:path].split("/")[1]) || "vanity"
         connect!
       end
 
@@ -38,7 +38,7 @@ module Vanity
       end
 
       def connect!
-        @mongo.connect_to_master
+        @mongo.connect
         database = @mongo.db(@options[:database])
         database.authenticate @options[:username], @options[:password], true if @options[:username]
         @metrics = database.collection("vanity.metrics")
@@ -49,7 +49,7 @@ module Vanity
 
       def to_s
         userinfo = @options.values_at(:username, :password).join(":") if @options[:username]
-        URI::Generic.build(:scheme=>"mongo", :userinfo=>userinfo, :host=>@options[:host], :port=>@options[:port], :path=>"/#{@options[:database]}").to_s
+        URI::Generic.build(:scheme=>"mongodb", :userinfo=>userinfo, :host=>@options[:host], :port=>@options[:port], :path=>"/#{@options[:database]}").to_s
       end
 
       def flushdb

data/lib/vanity/adapters/redis_adapter.rb

@@ -16,7 +16,7 @@ module Vanity
     class RedisAdapter < AbstractAdapter
       def initialize(options)
         @options = options.clone
-        @options[:db] = @options[:database] || (@options[:path] && @options[:path].split("/")[1].to_i)
+        @options[:db] ||= @options[:database] || (@options[:path] && @options[:path].split("/")[1].to_i)
         @options[:thread_safe] = true
         connect!
       end

data/lib/vanity/commands/report.rb

@@ -22,12 +22,16 @@ module Vanity
     end
 
     # Escape HTML.
-    def h(html)
-      CGI.escapeHTML(html)
+    def vanity_h(html)
+      CGI.escapeHTML(html.to_s)
+    end
+    
+    def vanity_html_safe(text)
+      text
     end
 
     # Dumbed down from Rails' simple_format.
-    def simple_format(text, options={})
+    def vanity_simple_format(text, options={})
       open = "<p #{options.map { |k,v| "#{k}=\"#{CGI.escapeHTML v}\"" }.join(" ")}>"
       text = open + text.gsub(/\r\n?/, "\n").   # \r\n and \r -> \n
         gsub(/\n\n+/, "</p>\n\n#{open}").       # 2+ newline  -> paragraph

data/lib/vanity/experiment/base.rb

@@ -81,7 +81,9 @@ module Vanity
       attr_reader :id
 
       # Time stamp when experiment was created.
-      attr_reader :created_at
+      def created_at
+        @created_at ||= connection.get_experiment_created_at(@id)
+      end
 
       # Time stamp when experiment was completed.
       attr_reader :completed_at
@@ -166,7 +168,6 @@ module Vanity
       def save
         return unless @playground.collecting?
         connection.set_experiment_created_at @id, Time.now
-        @created_at = connection.get_experiment_created_at(@id)
       end
 
     protected

data/lib/vanity/frameworks/rails.rb

@@ -1,5 +1,16 @@
 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
@@ -7,7 +18,7 @@ module Vanity
       #
       # 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
       #
@@ -15,7 +26,7 @@ module Vanity
       #       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
@@ -69,7 +80,7 @@ module Vanity
       # 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
@@ -80,7 +91,7 @@ module 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)) 
+                if hash = hashes.delete(experiment.fingerprint(alt))
                   experiment.chooses alt.value
                   break
                 end
@@ -120,11 +131,11 @@ module Vanity
       #   def index
       #     render action: ab_test(:new_page)
       #   end
-      # @example A/B test inside ERB template (condition) 
+      # @example A/B test inside ERB template (condition)
       #   <%= if ab_test(:banner) %>100% less complexity!<% end %>
-      # @example A/B test inside ERB template (value) 
+      # @example A/B test inside ERB template (value)
       #   <%= ab_test(:greeting) %> <%= current_user.name %>
-      # @example A/B test inside ERB template (capture) 
+      # @example A/B test inside ERB template (capture)
       #   <% ab_test :features do |count| %>
       #     <%= count %> features to choose from!
       #   <% end %>
@@ -137,6 +148,22 @@ module Vanity
           value
         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
 
 
@@ -151,13 +178,13 @@ module Vanity
     # Step 3: Open your browser to http://localhost:3000/vanity
     module Dashboard
       def index
-        render :template=>Vanity.template("_report"), :content_type=>Mime::HTML, :layout=>true
+        render :file=>Vanity.template("_report"), :content_type=>Mime::HTML, :layout=>false
       end
 
       def chooses
         exp = Vanity.playground.experiment(params[:e])
         exp.chooses(exp.alternatives[params[:a].to_i].value)
-        render :partial=>Vanity.template("experiment"), :locals=>{ :experiment=>exp }
+        render :file=>Vanity.template("_experiment"), :locals=>{:experiment=>exp}
       end
     end
   end
@@ -179,7 +206,7 @@ if defined?(ActionController)
       # 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 
+        setup_controller_request_and_response_without_vanity
         Vanity.context = @controller
       end
     end
@@ -187,18 +214,17 @@ if defined?(ActionController)
 end
 
 
-# Automatically configure Vanity.  Uses the 
+# Automatically configure Vanity.
 if defined?(Rails)
-  Rails.configuration.after_initialize do
-    # Use Rails logger by default.
-    Vanity.playground.logger ||= Rails.logger
-    Vanity.playground.load_path = Rails.root + Vanity.playground.load_path
-    Vanity.playground.collecting = Rails.env.production?
-
-    # Do this at the very end of initialization, allowing you to change
-    # connection adapter, turn collection on/off, etc.
+  if Rails.const_defined?(:Railtie) # Rails 3
+    class Plugin < Rails::Railtie # :nodoc:
+      initializer "vanity.require" do |app|
+        Vanity::Rails.load!
+      end
+    end
+  else
     Rails.configuration.after_initialize do
-      Vanity.playground.load!
+      Vanity::Rails.load!
     end
   end
 end
@@ -206,13 +232,13 @@ end
 
 # Reconnect whenever we fork under Passenger.
 if defined?(PhusionPassenger)
-  PhusionPassenger.on_event(:starting_worker_process) do |forked| 
-    if forked 
+  PhusionPassenger.on_event(:starting_worker_process) do |forked|
+    if forked
       begin
         Vanity.playground.establish_connection if Vanity.playground.collecting?
       rescue Exception=>ex
-        Rails.logger.error "Error reconnecting: #{ex.to_s}" 
+        Rails.logger.error "Error reconnecting: #{ex.to_s}"
       end
-    end 
-  end 
+    end
+  end
 end

data/lib/vanity/metric/active_record.rb

@@ -57,7 +57,7 @@ module Vanity
       def values(sdate, edate)
         query = { :conditions=>{ @ar_timestamp=>(sdate.to_time...(edate + 1).to_time) },
                   :group=>"date(#{@ar_scoped.connection.quote_column_name @ar_timestamp})" }
-        grouped = @ar_column ? @ar_scoped.calculate(@ar_aggregate, @ar_column, query) : @ar_scoped.count(query)
+        grouped = @ar_column ? @ar_scoped.send(@ar_aggregate, @ar_column, query) : @ar_scoped.count(query)
         (sdate..edate).inject([]) { |ordered, date| ordered << (grouped[date.to_s] || 0) }
       end
 

data/lib/vanity/playground.rb

@@ -9,7 +9,7 @@ module Vanity
   #   puts Vanity.playground.map(&:name)
   class Playground
 
-    DEFAULTS = { :load_path=>"experiments" }
+    DEFAULTS = { :collecting => true, :load_path=>"experiments" }
 
     # Created new Playground. Unless you need to, use the global
     # Vanity.playground.
@@ -40,7 +40,7 @@ module Vanity
         @logger.level = Logger::ERROR
       end
       @loading = []
-      @collecting = true
+      @collecting = @options[:collecting]
     end
    
     # Deprecated. Use redis.server instead.
@@ -141,7 +141,7 @@ module Vanity
         Dir[File.join(load_path, "metrics/*.rb")].each do |file|
           Metric.load self, @loading, file
         end
-        if File.exist?("config/vanity.yml") && remote = YAML.load_file("config/vanity.yml")["metrics"]
+        if File.exist?("config/vanity.yml") && remote = YAML.load(ERB.new(File.read("config/vanity.yml")).result)["metrics"]
           remote.each do |id, url|
             fail "Metric #{id} already defined in playground" if metrics[id.to_sym]
             metric = Metric.new(self, id)
@@ -195,19 +195,19 @@ module Vanity
       when nil
         if File.exists?("config/vanity.yml")
           env = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
-          spec = YAML.load_file("config/vanity.yml")[env]
+          spec = YAML.load(ERB.new(File.read("config/vanity.yml")).result)[env]
           fail "No configuration for #{env}" unless spec
           establish_connection spec
         elsif File.exists?("config/redis.yml")
           env = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
-          redis = YAML.load_file("config/redis.yml")[env]
+          redis = YAML.load(ERB.new(File.read("config/redis.yml")).result)[env]
           fail "No configuration for #{env}" unless redis
           establish_connection "redis://" + redis
         else
           establish_connection :adapter=>"redis"
         end
       when Symbol
-        spec = YAML.load_file("config/vanity.yml")[spec.to_s]
+        spec = YAML.load(ERB.new(File.read("config/vanity.yml")).result)[spec.to_s]
         establish_connection spec
       when String
         uri = URI.parse(spec)
@@ -283,7 +283,9 @@ module Vanity
 
   end
 
-  @playground = Playground.new
+  # In the case of Rails, use the Rails logger and collect only for
+  # production environment by default.
+  @playground = Playground.new(defined?(Rails) ? { :logger => Rails.logger, :collecting => Rails.env.production? } : {})  
   class << self
 
     # The playground instance.

data/lib/vanity/templates/_ab_test.erb

@@ -5,7 +5,7 @@
   <% score.alts.each do |alt| %>
     <tr class="<%= "choice" if score.choice == alt %>">
       <td class="option"><%= alt.name.gsub(/^o/, "O") %>:</td>
-      <td class="value"><code><%=h alt.value.to_s %></code></td>
+      <td class="value"><code><%=vanity_h alt.value.to_s %></code></td>
       <td>
         <%= "%.1f%%" % [alt.conversion_rate * 100] %>
         <%= "(%d%% better than %s)" % [alt.difference, score.least.name] if alt.difference && alt.difference >= 1 %>

data/lib/vanity/templates/_experiment.erb

@@ -1,5 +1,5 @@
-<h3><%=h experiment.name %> <span class="type">(<%= experiment.class.friendly_name %>)</span></h3>
-<%= experiment.description.to_s.split(/\n\s*\n/).map { |para| %{<p class="description">#{h para}</p>} }.join %>
+<h3><%=vanity_h experiment.name %> <span class="type">(<%= experiment.class.friendly_name %>)</span></h3>
+<%= experiment.description.to_s.split(/\n\s*\n/).map { |para| vanity_html_safe(%{<p class="description">#{vanity_h para}</p>}) }.join %>
 <%= render Vanity.template(experiment.type), :experiment=>experiment %>
 <p class="meta">Started <%= experiment.created_at.strftime("%a, %b %d") %>
   <%= " | Completed #{experiment.completed_at.strftime("%a, %b %d")}" unless experiment.active? %></p>

data/lib/vanity/templates/_experiments.erb

@@ -1,6 +1,6 @@
 <ul class="experiments">
   <% experiments.sort_by { |id, experiment| experiment.created_at }.reverse.each do |id, experiment| %>
-    <li class="experiment <%= experiment.type %>" id="experiment_<%=h id.to_s %>">
+    <li class="experiment <%= experiment.type %>" id="experiment_<%=vanity_h id.to_s %>">
     <%= render Vanity.template("experiment"), :id=>id, :experiment=>experiment %>
     </li>
   <% end %>

data/lib/vanity/templates/_metric.erb

@@ -1,14 +1,14 @@
-<h3><%=h metric.name %></h3>
-<%= simple_format h(Vanity::Metric.description(metric).to_s), :class=>"description" %>
+<h3><%=vanity_h metric.name %></h3>
+<%= vanity_simple_format vanity_h(Vanity::Metric.description(metric).to_s), :class=>"description" %>
 <%=
 begin 
   data = Vanity::Metric.data(metric)
   min, max = data.map(&:last).minmax
   js = data.map { |date,value| "['#{date.to_time.httpdate}',#{value}]" }.join(",")
-  %{<div class="chart"></div>
+  vanity_html_safe(%{<div class="chart"></div>
     <script type="text/javascript">
-    $(function(){Vanity.metric("#{h id.to_s}").plot([{label:"#{h metric.name}", data: [#{js}]}])})
-    </script>}
+    $(function(){Vanity.metric("#{vanity_h id.to_s}").plot([{label:"#{vanity_h metric.name}", data: [#{js}]}])})
+    </script>})
 rescue Exception=>ex
-  %{<div class="error">#{h ex.message}</div>}
+  %{<div class="error">#{vanity_h ex.message}</div>}
 end %>

data/lib/vanity/templates/_metrics.erb

@@ -1,13 +1,14 @@
 <ul class="metrics">
   <% metrics.sort_by { |id, metric| metric.name }.each do |id, metric| %>
     <li class="metric" id="metric_<%= id %>">
-      <%= render Vanity.template("metric"), :id=>id, :metric=>metric %>
+      <%= render :file=>Vanity.template("_metric"), :locals=>{:id=>id, :metric=>metric} %>
+      <%= render :file=>Vanity.template("_metric"), :locals=>{:id=>id, :metric=>metric} %>
     </li>
   <% end %>
 </ul>
 <form id="milestones">
   <% experiments.each do |id, experiment| %>
     <label><input type="checkbox" name="milestone" data-start="<%= experiment.created_at.httpdate %>"
-      data-end="<%= (experiment.completed_at || Time.now).httpdate %>"><%=h experiment.name %></label>
+      data-end="<%= (experiment.completed_at || Time.now).httpdate %>"><%=vanity_h experiment.name %></label>
   <% end %>
 </form>

data/lib/vanity/templates/_report.erb

@@ -4,22 +4,22 @@
     <style>
       .vanity { margin: 2em auto; width: 40em; font-family: "Helvetica Neue", "Helvetica", "Verdana", sans-serif }
       .vanity h1 { margin: 1em 0; border-bottom: 3px solid #ccc }
-      <%= File.read(Vanity.template("vanity.css")) %>
+      <%= vanity_html_safe(File.read(Vanity.template("vanity.css"))) %>
     </style>
-    <script type="text/javascript"><%= File.read(Vanity.template("jquery.min.js")) %></script>
-    <script type="text/javascript"><%= File.read(Vanity.template("flot.min.js")) %></script>
-    <script type="text/javascript"><%= File.read(Vanity.template("vanity.js")) %></script>
+    <script type="text/javascript"><%= vanity_html_safe(File.read(Vanity.template("jquery.min.js"))) %></script>
+    <script type="text/javascript"><%= vanity_html_safe(File.read(Vanity.template("flot.min.js"))) %></script>
+    <script type="text/javascript"><%= vanity_html_safe(File.read(Vanity.template("vanity.js"))) %></script>
     <% if respond_to?(:form_authenticity_token) %><script type="text/javascript">document.auth_token = "<%= form_authenticity_token %>"</script><% end %>
   </head>
   <body>
     <div class="vanity">
       <% experiments = Vanity.playground.experiments ; unless experiments.empty? %>
         <h2>Experiments</h2>
-        <%= render Vanity.template("experiments"), :experiments=>experiments %>
+        <%= render :file=>Vanity.template("_experiments"), :locals=>{:experiments=>experiments} %>
       <% end %>
       <% metrics = Vanity.playground.metrics ; unless metrics.empty? %>
         <h2>Metrics</h2>
-        <%= render Vanity.template("metrics"), :metrics=>metrics, :experiments=>experiments %>
+        <%= render :file=>Vanity.template("_metrics"), :locals=>{:metrics=>metrics, :experiments=>experiments} %>
       <% end %>
       <p class="footer">Generated by <a href="http://vanity.labnotes.org">Vanity</a></p>
     </div>

data/lib/vanity/version.rb

@@ -0,0 +1,11 @@
+module Vanity
+  VERSION = "1.5.0.beta"
+
+  module Version
+    version = VERSION.to_s.split(".").map { |i| i.to_i }
+    MAJOR = version[0]
+    MINOR = version[1]
+    PATCH = version[2]
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/test/metric/active_record_test.rb

@@ -42,7 +42,6 @@ context "ActiveRecord Metric" do
   end
 
   test "record average" do
-    Sky.aggregates
     File.open "tmp/experiments/metrics/sky_is_limit.rb", "w" do |f|
       f.write <<-RUBY
         metric "Sky is limit" do
@@ -51,13 +50,12 @@ context "ActiveRecord Metric" do
       RUBY
     end
     Vanity.playground.metrics
-    Sky.create! :height=>4
+    Sky.create! :height=>8
     Sky.create! :height=>2
-    assert_equal 3, Vanity::Metric.data(metric(:sky_is_limit)).last.last
+    assert_equal 5, Vanity::Metric.data(metric(:sky_is_limit)).last.last
   end
 
   test "record minimum" do
-    Sky.aggregates
     File.open "tmp/experiments/metrics/sky_is_limit.rb", "w" do |f|
       f.write <<-RUBY
         metric "Sky is limit" do
@@ -72,7 +70,6 @@ context "ActiveRecord Metric" do
   end
 
   test "record maximum" do
-    Sky.aggregates
     File.open "tmp/experiments/metrics/sky_is_limit.rb", "w" do |f|
       f.write <<-RUBY
         metric "Sky is limit" do
@@ -108,7 +105,6 @@ context "ActiveRecord Metric" do
   end
 
   test "with scope" do
-    Sky.aggregates
     File.open "tmp/experiments/metrics/sky_is_limit.rb", "w" do |f|
       f.write <<-RUBY
         metric "Sky is limit" do