vanity 2.0.0.beta4 → 2.0.0.beta5

data/lib/vanity/templates.rb

@@ -0,0 +1,29 @@
+module Vanity
+  class Templates
+    def initialize
+      @template_directory = load_paths.find { |dir| File.exists?(dir) }
+    end
+
+    # Path to template.
+    def path(name)
+      File.join(@template_directory, name)
+    end
+
+    private
+
+    def load_paths
+      [Vanity.playground.custom_templates_path, gem_templates_path].compact
+    end
+
+    def gem_templates_path
+      File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+    end
+  end
+
+  class << self
+    def template(name)
+      @templates ||= Templates.new
+      @templates.path(name)
+    end
+  end
+end

data/lib/vanity/templates/_ab_test.erb

@@ -7,33 +7,33 @@
     <tr class="<%= "choice" if score.choice == alt %>">
       <td class="option"><%= alt.name.gsub(/^o/, "O") %>:</td>
       <td class="value"><code><%=vanity_h alt.value.to_s %></code></td>
-      <td class="value"><%= alt.participants %> participants</td>
-      <td class="value"><%= alt.converted %> converted</td>
+      <td class="value"><%= I18n.t 'vanity.participants', :count=>alt.participants %></td>
+      <td class="value"><%= I18n.t 'vanity.converted', :count=>alt.converted %></td>
       <td>
         <%= "%.1f%%" % [alt.conversion_rate * 100] %>
-        <%= "(%d%% this is best)" % [alt.probability] if score.method == :bayes_score %>
-        <%= "(%d%% better than %s)" % [alt.difference, score.least.name] if alt.difference && alt.difference >= 1 %>
+        <%= I18n.t('vanity.best_alternative', :probabilty=>alt.probability.to_i) if score.method == :bayes_score %>
+        <%= I18n.t('vanity.better_alternative_than', :probability=>alt.difference.to_i, :alternative=>score.least.name) if alt.difference && alt.difference >= 1 %>
       </td>
       <% if experiment.active? && respond_to?(:url_for) %>
         <td class="action">
           <small>
             <% if experiment.showing?(alt) %>
-              currently <br> shown
+              <%= I18n.t 'vanity.currently_shown' %>
             <% else %>
-              <a class="button chooses" title="Show me this alternative from now on" href="#"
-                data-id="<%= experiment.id %>" data-url="<%= url_for(:action=>:chooses, :e=>experiment.id, :a=>alt.id) %>">show me</a>
+              <a class="button chooses" title="<%= I18n.t 'vanity.choose_experiment' %>" href="#"
+                data-id="<%= experiment.id %>" data-url="<%= url_for(:action=>:chooses, :e=>experiment.id, :a=>alt.id) %>"><%= I18n.t 'vanity.show_me' %></a>
             <% end %>
           </small>
         </td>
         <td class="action">
           <small>
             <% if @to_confirm == alt.id %>
-             Finish this experiment and assign all current and future participants to <%= alt.name %>?
-             <a class="button chooses" title="Confirm experiment completion and assignment of all current and future participants to <%= alt.name %>" href="#"
-              data-id="<%= experiment.id %>" data-url="<%= url_for(:action=>:complete, :e=>experiment.id, :a=>alt.id, :confirmed=>alt.id) %>">confirm</a>
+              <%= I18n.t 'vanity.complete_and_confirm_experiment_label', :name=>alt.name %>
+              <a class="button chooses" title="<%= I18n.t 'vanity.complete_and_confirm_experiment', name: alt.name %>" href="#"
+              data-id="<%= experiment.id %>" data-url="<%= url_for(:action=>:complete, :e=>experiment.id, :a=>alt.id, :confirmed=>alt.id) %>"><%= I18n.t 'vanity.confirm' %></a>
             <% else %>
-             <a class="button chooses" title="Complete the experiment and assign all current and future participants to <%= alt.name %>" href="#"
-              data-id="<%= experiment.id %>" data-url="<%= url_for(:action=>:complete, :e=>experiment.id, :a=>alt.id) %>">make permanent</a>
+              <a class="button chooses" title="<%= I18n.t 'vanity.complete_experiment', :name=>alt.name %>" href="#"
+              data-id="<%= experiment.id %>" data-url="<%= url_for(:action=>:complete, :e=>experiment.id, :a=>alt.id) %>"><%= I18n.t 'vanity.make_permanent' %></a>
             <% end %>
           </small>
         </td>

data/lib/vanity/templates/_experiment.erb

@@ -1,5 +1,7 @@
 <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.html_safe %>
 <%= render :file => Vanity.template("_" + experiment.type), :locals => {: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>
+<p class="meta">
+  <%= I18n.t('vanity.started_at', :timestamp=>I18n.l(experiment.created_at, :format=>'%a, %b %d')) %>
+  <%= ' | '+I18n.t('vanity.completed_at', :timestamp=>I18n.l(experiment.completed_at, :format=>'%a, %b %d')) unless experiment.active? %>
+</p>

data/lib/vanity/templates/_participant.erb

@@ -1,4 +1,4 @@
-<p>Participant id <%= participant_id %> is taking part in the following experiments:
+<p><%= I18n.t 'vanity.participant_taking_part_on', :participant_id=>participant_id %>
 <ul class="experiments">
   <% participant_info.each do |experiment, alt| %>
     <li class="experiment <%= experiment.type %>" id="experiment_<%=vanity_h experiment.id.to_s %>">
@@ -9,4 +9,4 @@
     </li>
   <% end %>
 </ul>
-</p>
+</p>

data/lib/vanity/templates/_report.erb

@@ -1,6 +1,6 @@
 <html>
   <head>
-    <title>Vanity Report: <%= Time.now.strftime("%b %d %Y, %I:%M:%P") %></title>
+    <title><%= I18n.t('vanity.report', :timestamp=>I18n.l(Time.now, :format=>'%b %d %Y, %I:%M:%P')) %></title>
     <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 }
@@ -15,27 +15,27 @@
     <div class="vanity">
       <% unless Vanity.playground.collecting? %>
         <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>.
+          <%= I18n.t('vanity.not_collecting_data', :setting=>"<span style='font-family: courier'>Vanity.playground.collecting = true;</span>", :file=>"<span style='font-family: courier'>config/environments/[environment].rb</span>").html_safe %>
         </div>
       <% end %>
 
       <% if experiments_persisted %>
         <% if experiments.present? %>
-          <h2>Experiments</h2>
+          <h2><%= I18n.t 'vanity.experiments' %></h2>
           <%= render :file=>Vanity.template("_experiments"), :locals=>{:experiments=>experiments} %>
         <% end %>
 
         <% unless metrics.empty? %>
-          <h2>Metrics</h2>
+          <h2><%= I18n.t 'vanity.metrics' %></h2>
           <%= render :file=>Vanity.template("_metrics"), :locals=>{:metrics=>metrics, :experiments=>experiments} %>
         <% end %>
       <% else %>
         <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.
+          <%= I18n.t 'vanity.experiments_out_of_sync' %>
         </div>
       <% end %>
 
-      <p class="footer">Generated by <a href="http://vanity.labnotes.org">Vanity</a></p>
+      <p class="footer"><%= I18n.t('vanity.generated_by', :link=>'<a href="http://vanity.labnotes.org">Vanity</a>').html_safe %></p>
     </div>
   </body>
 </html>

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

@@ -1,16 +1,14 @@
 var httpRequest;
-<% @_vanity_experiments.each do |name, alternative| %>
-  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
-    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 %>
+var params = "v=<%= @_vanity_experiments.map{|name, alternative| "#{name}=#{alternative.id}" }.join(',') %>&authenticity_token=<%= CGI.escape(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);
+}

data/lib/vanity/templates/vanity.css

@@ -9,12 +9,12 @@
 .vanity .experiment .type { margin-left: .3em; color: #bbb; font-size: .8em; font-weight: normal }
 
 .vanity .ab_test table { border-collapse: collapse; table-layout: fixed; width: 100%; border-bottom: 1px solid #ccc; margin: 1em 0 0 0 }
-.vanity .ab_test td { padding: .5em; border-top: 1px solid #ccc }
+.vanity .ab_test td { padding: .5em; border-top: 1px solid #ccc; width: 2em; overflow: hidden }
 .vanity .ab_test .choice td { font-weight: bold; background: #f0f0f8 }
 .vanity .ab_test caption { caption-side: bottom; padding: .5em; background: transparent; text-align: left }
-.vanity .ab_test td.option { width: 5em; white-space: nowrap; overflow: hidden }
-.vanity .ab_test td.value { width: 8em; overflow: hidden }
-.vanity .ab_test td.action { width: 6em; overflow: hidden; text-align: right }
+.vanity .ab_test td.option { width: 5em; white-space: nowrap; }
+.vanity .ab_test td.value { width: 8em;  }
+.vanity .ab_test td.action { width: 6em; text-align: right }
 
 .vanity .metrics { list-style: none; margin: 0; padding: 0; border-bottom: 1px solid #ddd }
 .vanity .metric { margin: 2em 0 }

data/lib/vanity/version.rb

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

data/test/frameworks/rails/action_controller_test.rb

@@ -34,7 +34,7 @@ class UseVanityControllerTest < ActionController::TestCase
   def test_render_js_for_tests
     Vanity.playground.use_js!
     get :js
-    assert_match /script.*e=pie_or_cake.*script/m, @response.body
+    assert_match /script.*v=pie_or_cake=.*script/m, @response.body
   end
 
   def test_chooses_sets_alternatives_for_rails_tests

data/test/frameworks/rails/rails_test.rb

@@ -1,20 +1,20 @@
 require "test_helper"
 
-class LoadPathAndConnectionConfigurationTest < Test::Unit::TestCase
+describe "Rails load path and connection configuration" do
 
-  def test_load_path
+  it "load_path" do
     assert_equal File.expand_path("tmp/experiments"), load_rails("", <<-RB)
 $stdout << Vanity.playground.load_path
     RB
   end
 
-  def test_settable_load_path
+  it "settable_load_path" do
     assert_equal File.expand_path("tmp/predictions"), load_rails(%Q{\nVanity.playground.load_path = "predictions"\n}, <<-RB)
 $stdout << Vanity.playground.load_path
     RB
   end
 
-  def test_absolute_load_path
+  it "absolute_load_path" do
     Dir.mktmpdir do |dir|
       assert_equal dir, load_rails(%Q{\nVanity.playground.load_path = "#{dir}"\n}, <<-RB)
 $stdout << Vanity.playground.load_path
@@ -23,201 +23,217 @@ $stdout << Vanity.playground.load_path
   end
 
   if ENV['DB'] == 'redis'
-    def test_default_connection
+    it "default_connection" do
       assert_equal "redis://127.0.0.1:6379/0", load_rails("", <<-RB)
 $stdout << Vanity.playground.connection
       RB
     end
 
-    def test_connection_from_string
+    it "connection_from_string" do
       assert_equal "redis://192.168.1.1:6379/5", load_rails(%Q{\nVanity.playground.establish_connection "redis://192.168.1.1:6379/5"\n}, <<-RB)
 $stdout << Vanity.playground.connection
       RB
     end
 
-    def test_connection_from_yaml
-      FileUtils.mkpath "tmp/config"
-      @original_env = ENV["RAILS_ENV"]
-      ENV["RAILS_ENV"] = "production"
-      File.open("tmp/config/vanity.yml", "w") do |io|
-        io.write <<-YML
+    it "connection_from_yaml" do
+      begin
+        FileUtils.mkpath "tmp/config"
+        @original_env = ENV["RAILS_ENV"]
+        ENV["RAILS_ENV"] = "production"
+        File.open("tmp/config/vanity.yml", "w") do |io|
+          io.write <<-YML
 production:
   adapter: redis
   host: somehost
   database: 15
         YML
-      end
-      assert_equal "redis://somehost:6379/15", load_rails("", <<-RB)
+        end
+        assert_equal "redis://somehost:6379/15", load_rails("", <<-RB)
 $stdout << Vanity.playground.connection
-      RB
-    ensure
-      ENV["RAILS_ENV"] = @original_env
-      File.unlink "tmp/config/vanity.yml"
+        RB
+      ensure
+        ENV["RAILS_ENV"] = @original_env
+        File.unlink "tmp/config/vanity.yml"
+      end
     end
 
-    def test_connection_from_yaml_url
-      FileUtils.mkpath "tmp/config"
-      @original_env = ENV["RAILS_ENV"]
-      ENV["RAILS_ENV"] = "production"
-      File.open("tmp/config/vanity.yml", "w") do |io|
-        io.write <<-YML
+    it "connection_from_yaml_url" do
+      begin
+        FileUtils.mkpath "tmp/config"
+        @original_env = ENV["RAILS_ENV"]
+        ENV["RAILS_ENV"] = "production"
+        File.open("tmp/config/vanity.yml", "w") do |io|
+          io.write <<-YML
 production: redis://somehost/15
-        YML
-      end
-      assert_equal "redis://somehost:6379/15", load_rails("", <<-RB)
+          YML
+        end
+        assert_equal "redis://somehost:6379/15", load_rails("", <<-RB)
 $stdout << Vanity.playground.connection
-      RB
-    ensure
-      ENV["RAILS_ENV"] = @original_env
-      File.unlink "tmp/config/vanity.yml"
+        RB
+      ensure
+        ENV["RAILS_ENV"] = @original_env
+        File.unlink "tmp/config/vanity.yml"
+      end
     end
 
-    def test_connection_from_yaml_with_erb
-      FileUtils.mkpath "tmp/config"
-      @original_env = ENV["RAILS_ENV"]
-      ENV["RAILS_ENV"] = "production"
-      # Pass storage URL through environment like heroku does
-      @original_redis_url = ENV["REDIS_URL"]
-      ENV["REDIS_URL"] = "redis://somehost:6379/15"
-      File.open("tmp/config/vanity.yml", "w") do |io|
-        io.write <<-YML
+    it "connection_from_yaml_with_erb" do
+      begin
+        FileUtils.mkpath "tmp/config"
+        @original_env = ENV["RAILS_ENV"]
+        ENV["RAILS_ENV"] = "production"
+        # Pass storage URL through environment like heroku does
+        @original_redis_url = ENV["REDIS_URL"]
+        ENV["REDIS_URL"] = "redis://somehost:6379/15"
+        File.open("tmp/config/vanity.yml", "w") do |io|
+          io.write <<-YML
 production: <%= ENV['REDIS_URL'] %>
         YML
-      end
-      assert_equal "redis://somehost:6379/15", load_rails("", <<-RB)
+        end
+        assert_equal "redis://somehost:6379/15", load_rails("", <<-RB)
 $stdout << Vanity.playground.connection
-      RB
-    ensure
-      ENV["RAILS_ENV"] = @original_env
-      ENV["REDIS_URL"] = @original_redis_url
-      File.unlink "tmp/config/vanity.yml"
+        RB
+      ensure
+        ENV["RAILS_ENV"] = @original_env
+        ENV["REDIS_URL"] = @original_redis_url
+        File.unlink "tmp/config/vanity.yml"
+      end
     end
 
-    def test_connection_from_redis_yml
-      FileUtils.mkpath "tmp/config"
-      yml = File.open("tmp/config/redis.yml", "w")
-      yml << "production: internal.local:6379\n"
-      yml.flush
-      assert_equal "redis://internal.local:6379/0", load_rails("", <<-RB)
+    it "connection_from_redis_yml" do
+      begin
+        FileUtils.mkpath "tmp/config"
+        yml = File.open("tmp/config/redis.yml", "w")
+        yml << "production: internal.local:6379\n"
+        yml.flush
+        assert_equal "redis://internal.local:6379/0", load_rails("", <<-RB)
 $stdout << Vanity.playground.connection
-      RB
-    ensure
-      File.unlink yml.path
+        RB
+      ensure
+        File.unlink yml.path
+      end
     end
   end
 
   if ENV['DB'] == 'mongo'
-    def test_mongo_connection_from_yaml
-      FileUtils.mkpath "tmp/config"
-      File.open("tmp/config/vanity.yml", "w") do |io|
-        io.write <<-YML
+    it "mongo_connection_from_yaml" do
+      begin
+        FileUtils.mkpath "tmp/config"
+        File.open("tmp/config/vanity.yml", "w") do |io|
+          io.write <<-YML
 mongodb:
   adapter: mongodb
   host: localhost
   port: 27017
   database: vanity_test
-        YML
-      end
+          YML
+        end
 
-      assert_equal "mongodb://localhost:27017/vanity_test", load_rails("", <<-RB, "mongodb")
+        assert_equal "mongodb://localhost:27017/vanity_test", load_rails("", <<-RB, "mongodb")
 $stdout << Vanity.playground.connection
-      RB
-    ensure
-      File.unlink "tmp/config/vanity.yml"
+        RB
+      ensure
+        File.unlink "tmp/config/vanity.yml"
+      end
     end
 
     unless ENV['CI'] == 'true' #TODO this doesn't get tested on CI
-      def test_mongodb_replica_set_connection
-        FileUtils.mkpath "tmp/config"
-        File.open("tmp/config/vanity.yml", "w") do |io|
-          io.write <<-YML
+      it "mongodb_replica_set_connection" do
+        begin
+          FileUtils.mkpath "tmp/config"
+          File.open("tmp/config/vanity.yml", "w") do |io|
+            io.write <<-YML
 mongodb:
   adapter: mongodb
   hosts:
     - localhost
   port: 27017
   database: vanity_test
-          YML
-        end
+            YML
+          end
 
-        assert_equal "mongodb://localhost:27017/vanity_test", load_rails("", <<-RB, "mongodb")
+          assert_equal "mongodb://localhost:27017/vanity_test", load_rails("", <<-RB, "mongodb")
 $stdout << Vanity.playground.connection
-        RB
+          RB
 
-        assert_equal "Mongo::ReplSetConnection", load_rails("", <<-RB, "mongodb")
+          assert_equal "Mongo::ReplSetConnection", load_rails("", <<-RB, "mongodb")
 $stdout << Vanity.playground.connection.mongo.class
-        RB
-      ensure
-        File.unlink "tmp/config/vanity.yml"
+          RB
+        ensure
+          File.unlink "tmp/config/vanity.yml"
+        end
       end
     end
   end
 
-  def test_connection_from_yaml_missing
-    FileUtils.mkpath "tmp/config"
-    File.open("tmp/config/vanity.yml", "w") do |io|
-      io.write <<-YML
+  it "connection_from_yaml_missing" do
+    begin
+      FileUtils.mkpath "tmp/config"
+      File.open("tmp/config/vanity.yml", "w") do |io|
+        io.write <<-YML
 production:
   adapter: redis
       YML
-    end
+      end
 
-     assert_equal "No configuration for development", load_rails("\nbegin\n", <<-RB, "development")
+       assert_equal "No configuration for development", load_rails("\nbegin\n", <<-RB, "development")
 rescue RuntimeError => e
   $stdout << e.message
 end
       RB
-  ensure
-    File.unlink "tmp/config/vanity.yml"
+    ensure
+      File.unlink "tmp/config/vanity.yml"
+    end
   end
 
-  def test_collection_from_vanity_yaml
-    FileUtils.mkpath "tmp/config"
-    File.open("tmp/config/vanity.yml", "w") do |io|
-      io.write <<-YML
+  it "collection_from_vanity_yaml" do
+    begin
+      FileUtils.mkpath "tmp/config"
+      File.open("tmp/config/vanity.yml", "w") do |io|
+        io.write <<-YML
 production:
   collecting: false
   adapter: mock
-      YML
-    end
-    assert_equal "false", load_rails("", <<-RB)
+        YML
+      end
+      assert_equal "false", load_rails("", <<-RB)
 $stdout << Vanity.playground.collecting?
-    RB
-  ensure
-    File.unlink "tmp/config/vanity.yml"
+      RB
+    ensure
+      File.unlink "tmp/config/vanity.yml"
+    end
   end
 
-  def test_collection_true_in_production_by_default
+  it "collection_true_in_production_by_default" do
     assert_equal "true", load_rails("", <<-RB)
 $stdout << Vanity.playground.collecting?
     RB
   end
 
-  def test_collection_false_in_production_when_configured
+  it "collection_false_in_production_when_configured" do
     assert_equal "false", load_rails("\nVanity.playground.collecting = false\n", <<-RB)
 $stdout << Vanity.playground.collecting?
     RB
   end
 
-  def test_collection_true_in_development_by_default
+  it "collection_true_in_development_by_default" do
     assert_equal "true", load_rails("", <<-RB, "development")
 $stdout << Vanity.playground.collecting?
     RB
   end
 
-  def test_collection_true_in_development_when_configured
+  it "collection_true_in_development_when_configured" do
     assert_equal "true", load_rails("\nVanity.playground.collecting = true\n", <<-RB, "development")
 $stdout << Vanity.playground.collecting?
     RB
   end
 
-  def test_playground_loads_if_connected
+  it "playground_loads_if_connected" do
     assert_equal "{}", load_rails("", <<-RB)
 $stdout << Vanity.playground.instance_variable_get(:@experiments).inspect
     RB
   end
 
-  def test_playground_does_not_load_if_not_connected
+  it "playground_does_not_load_if_not_connected" do
     ENV['VANITY_DISABLED'] = '1'
     assert_equal "nil", load_rails("", <<-RB)
 $stdout << Vanity.playground.instance_variable_get(:@experiments).inspect