Added: Command line "vanity list" catalogs all ongoing experiments, t…

…heir alternatives (and fingerprints) and all metrics.

CHANGELOG

@@ -1,5 +1,6 @@
 == 1.3.0
 * Added: Vanity query parameter that you can use to choose a particular alternative, e.g. to tie an advertisement banner with content of the site.
+* Added: Command line "vanity list" catalogs all ongoing experiments, their alternatives (and fingerprints) and all metrics.
 * Changed: Rails integration now separates use_vanity method, filters and helpers.
 * Changed: Explicit vanity_context_filter and vanity_reload_filter so you can skip them, or order filters relative to them.
 * Fixed: if metric cannot be loaded (e.g. offline, no db access) show error message for that metric but don't break dashboard.

bin/vanity

@@ -10,7 +10,8 @@ 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 << "  report  Report on all running experiments"
+  opts.banner << "  report  Report on all running experiments/metrics"
+  opts.banner << "  list    List all experiments and metrics"
 
   opts.separator ""
   opts.separator "General options:"
@@ -45,8 +46,8 @@ end
 
 ARGV.each do |cmd|
   case cmd
-  when "report"
-    Vanity::Commands.report options.output
+  when "report";  Vanity::Commands.report options.output
+  when "list";    Vanity::Commands.list
   else fail "No such command: #{cmd}"
   end
 end

lib/vanity/commands.rb

@@ -1 +1,2 @@
 require "vanity/commands/report"
+require "vanity/commands/list"

lib/vanity/commands/list.rb

@@ -0,0 +1,21 @@
+module Vanity
+  module Commands
+    class << self
+      # Lists all experiments and metrics.
+      def list
+        Vanity.playground.experiments.each do |id, experiment|
+          puts "experiment :%-.20s (%-.40s)" % [id, experiment.name]
+          if experiment.respond_to?(:alternatives)
+            experiment.alternatives.each do |alt|
+              hash = experiment.fingerprint(alt)
+              puts "  %s: %-40.40s  (%s)" % [alt.name, alt.value, hash]
+            end
+          end
+        end
+        Vanity.playground.metrics.each do |id, metric|
+          puts "metric :%-.20s (%-.40s)" % [id, metric.name]
+        end
+      end
+    end
+  end
+end