vanity 1.5.1 → 1.5.2

data/CHANGELOG

@@ -1,3 +1,21 @@
+== 1.5.2 (2011-04-11)
+
+Fixed to work with redis-rb 2.2.0 (Kevin Menard).
+
+Fixed to work with Postgresql: it complained that the index names generated by
+add_index were too long, so I gave them shorter names (Robert Rasmussen).
+
+Fixed SQL errors comparing an int to a varchar column, and no "as" on a column
+alias (Robert Rasmussen).
+
+Fixed auto-escaped text in the experiment template that I marked as html_safe
+(Robert Rasmussen).
+
+Added some Rails 3.x documentation to the 2-minute demo instructionsa (Andy Atkinson).
+
+Fix to set collecting flag from vanity.yml config file.
+
+
 == 1.5.1 (2010-12-20)
 
 Fixes some minor bugs in RoR when including the Dashboard (netguru)

data/README.rdoc

@@ -10,6 +10,8 @@ http://farm3.static.flickr.com/2540/4099665871_497f274f68_o.jpg
 
 <b>Step 1:</b> Start using Vanity in your Rails application:
 
+  == Rails 2.x configuration
+
   Rails::Initializer.run do |config|
     gem.config "vanity"
 
@@ -17,6 +19,10 @@ http://farm3.static.flickr.com/2540/4099665871_497f274f68_o.jpg
       require "vanity"
     end
   end
+  
+  == Rails 3 configuration
+  
+  gem 'vanity' # in Gemfile, either outside of a group or inside of a bundler group
 
 And:
 
@@ -31,6 +37,8 @@ And:
     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 "signup.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:
 
@@ -53,6 +61,16 @@ And:
 <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`
 
 
 == Contributing

data/Rakefile

@@ -29,7 +29,7 @@ end
 # -- Testing stuff --
 
 desc "Test everything"
-task "test:all"=>"test:rubies"
+task "test:all"=>"test:adapters"
 
 # Ruby versions we're testing with.
 RUBIES = %w{1.8.7 1.9.2}

data/lib/vanity/adapters/active_record_adapter.rb

@@ -49,7 +49,7 @@ module Vanity
               t.integer :alternative
               t.integer :conversions
             end
-            connection.add_index :vanity_conversions, [:vanity_experiment_id, :alternative]
+            connection.add_index :vanity_conversions, [:vanity_experiment_id, :alternative], :name => "by_experiment_id_and_alternative"
 
             connection.create_table :vanity_participants do |t|
               t.string :experiment_id
@@ -59,10 +59,10 @@ module Vanity
               t.integer :converted
             end
             connection.add_index :vanity_participants, [:experiment_id]
-            connection.add_index :vanity_participants, [:experiment_id, :identity]
-            connection.add_index :vanity_participants, [:experiment_id, :shown]
-            connection.add_index :vanity_participants, [:experiment_id, :seen]
-            connection.add_index :vanity_participants, [:experiment_id, :converted]
+            connection.add_index :vanity_participants, [:experiment_id, :identity], :name => "by_experiment_id_and_identity"
+            connection.add_index :vanity_participants, [:experiment_id, :shown], :name => "by_experiment_id_and_shown"
+            connection.add_index :vanity_participants, [:experiment_id, :seen], :name => "by_experiment_id_and_seen"
+            connection.add_index :vanity_participants, [:experiment_id, :converted], :name => "by_experiment_id_and_converted"
 
             VanitySchema.create(:version => 1)
           end
@@ -124,7 +124,7 @@ module Vanity
         def self.retrieve(experiment, identity, create = true, update_with = nil)
           record = VanityParticipant.first(
                   :conditions =>
-                          {:experiment_id => experiment.to_s, :identity => identity})
+                          {:experiment_id => experiment.to_s, :identity => identity.to_s})
 
           if record
             record.update_attributes(update_with) if update_with
@@ -185,7 +185,7 @@ module Vanity
         dates = (from.to_date..to.to_date).map(&:to_s)
         conditions = [connection.quote_column_name('date') + ' IN (?)', dates]
         order = "#{connection.quote_column_name('date')}"
-        select = "sum(#{connection.quote_column_name('value')}) value, #{connection.quote_column_name('date')}"
+        select = "sum(#{connection.quote_column_name('value')}) AS value, #{connection.quote_column_name('date')}"
         group_by = "#{connection.quote_column_name('date')}"
 
         values = record.vanity_metric_values.all(

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.delete(:path).split("/")[1].to_i)
         @options[:thread_safe] = true
         connect!
       end

data/lib/vanity/playground.rb

@@ -21,16 +21,34 @@ module Vanity
     # - load_path -- Path to load experiments/metrics from
     # - logger -- Logger to use
     def initialize(*args)
-      options = args.pop if Hash === args.last
-      @options = DEFAULTS.merge(options || {})
+      options = Hash === args.last ? args.pop : {}
+      # In the case of Rails, use the Rails logger and collect only for
+      # production environment by default.
+      defaults = options[:rails] ? DEFAULTS.merge(:collecting => ::Rails.env.production?, :logger => ::Rails.logger) : DEFAULTS
+      if File.exists?("config/vanity.yml")
+        env = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
+        config = YAML.load(ERB.new(File.read("config/vanity.yml")).result)[env]
+        if Hash === config
+          config = config.inject({}) { |h,kv| h[kv.first.to_sym] = kv.last ; h }
+        else
+          config = { :connection=>config }
+        end
+      else
+        config = {}
+      end
+
+      @options = defaults.merge(config).merge(options)
       if @options.values_at(:host, :port, :db).any?
         warn "Deprecated: please specify Redis connection as URL (\"redis://host:port/db\")"
-        establish_connection :adapter=>"redis", :host=>options[:host], :port=>options[:port], :database=>options[:db]
+        establish_connection :adapter=>"redis", :host=>@options[:host], :port=>@options[:port], :database=>@options[:db] || @options[:database]
       elsif @options[:redis]
         @adapter = RedisAdapter.new(:redis=>@options[:redis])
       else
         connection_spec = args.shift || @options[:connection]
-        establish_connection "redis://" + connection_spec if connection_spec
+        if connection_spec
+          connection_spec = "redis://" + connection_spec unless connection_spec[/^\w+:/]
+          establish_connection connection_spec
+        end
       end
 
       warn "Deprecated: namespace option no longer supported directly" if @options[:namespace]
@@ -40,7 +58,7 @@ module Vanity
         @logger.level = Logger::ERROR
       end
       @loading = []
-      @collecting = @options[:collecting]
+      @collecting = !!@options[:collecting]
     end
    
     # Deprecated. Use redis.server instead.
@@ -285,7 +303,7 @@ module Vanity
 
   # 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? } : {})  
+  @playground = Playground.new(:rails=>defined?(::Rails))
   class << self
 
     # The playground instance.

data/lib/vanity/templates/_experiment.erb

@@ -1,5 +1,5 @@
 <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 %>
+<%= 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>

data/lib/vanity/version.rb

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

data/test/myapp/log/production.log

@@ -3054,3 +3054,113 @@ Completed in 5ms (View: 1 | 200 OK [http://:? ]
 Processing MainController#index (for  at 2010-12-20 16:51:45) [GET]
   Parameters: {" "=>nil}
 Completed in 6ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 14:36:53) [GET]
+  Parameters: {" "=>nil}
+Completed in 5ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 14:37:51) [GET]
+  Parameters: {" "=>nil}
+Completed in 12ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 14:38:49) [GET]
+  Parameters: {" "=>nil}
+Completed in 7ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 14:40:48) [GET]
+  Parameters: {" "=>nil}
+Completed in 5ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 14:47:11) [GET]
+  Parameters: {" "=>nil}
+Completed in 9ms (View: 2 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 14:49:05) [GET]
+  Parameters: {" "=>nil}
+Completed in 6ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 14:51:18) [GET]
+  Parameters: {" "=>nil}
+Completed in 12ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 14:52:58) [GET]
+  Parameters: {" "=>nil}
+Completed in 6ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:29:31) [GET]
+  Parameters: {" "=>nil}
+Completed in 5ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:31:08) [GET]
+  Parameters: {" "=>nil}
+Completed in 5ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:31:56) [GET]
+  Parameters: {" "=>nil}
+Completed in 8ms (View: 2 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:32:12) [GET]
+  Parameters: {" "=>nil}
+Completed in 5ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:33:10) [GET]
+  Parameters: {" "=>nil}
+Completed in 5ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:33:39) [GET]
+  Parameters: {" "=>nil}
+Completed in 8ms (View: 3 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:34:00) [GET]
+  Parameters: {" "=>nil}
+Completed in 9ms (View: 2 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:35:17) [GET]
+  Parameters: {" "=>nil}
+Completed in 6ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:37:38) [GET]
+  Parameters: {" "=>nil}
+Completed in 6ms (View: 2 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:38:23) [GET]
+  Parameters: {" "=>nil}
+Completed in 8ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:42:25) [GET]
+  Parameters: {" "=>nil}
+Completed in 7ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:43:22) [GET]
+  Parameters: {" "=>nil}
+Completed in 6ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:43:59) [GET]
+  Parameters: {" "=>nil}
+Completed in 6ms (View: 1 | 200 OK [http://:? ]
+
+
+Processing MainController#index (for  at 2011-04-11 15:44:31) [GET]
+  Parameters: {" "=>nil}
+Completed in 9ms (View: 1 | 200 OK [http://:? ]

data/test/rails_test.rb

@@ -223,6 +223,23 @@ $stdout << Vanity.playground.connection
   ensure
     File.unlink yml.path
   end
+  
+  def test_collection_from_vanity_yaml
+    FileUtils.mkpath "tmp/config"
+    ENV["RAILS_ENV"] = "development"
+    File.open("tmp/config/vanity.yml", "w") do |io|
+      io.write <<-YML
+development:
+  collecting: false
+      YML
+    end
+    assert_equal "false", load_rails(<<-RB)
+initializer.after_initialize
+$stdout << Vanity.playground.collecting?
+    RB
+  ensure
+    File.unlink "tmp/config/vanity.yml"
+  end
 
   def test_collection_true_in_production_by_default
     assert_equal "true", load_rails(<<-RB, "production")
@@ -262,7 +279,6 @@ $stdout << Vanity.playground.collecting?
     RB
   end
 
-
   def load_rails(code, env = "production")
     tmp = Tempfile.open("test.rb")
     tmp.write <<-RB

data/vanity.gemspec

@@ -14,7 +14,6 @@ Gem::Specification.new do |spec|
   spec.files          = Dir["{bin,lib,vendor,test}/**/*", "CHANGELOG", "MIT-LICENSE", "README.rdoc", "Rakefile", "Gemfile", "*.gemspec"]
   spec.executable     = "vanity"
 
-  spec.has_rdoc         = true
   spec.extra_rdoc_files = "README.rdoc", "CHANGELOG"
   spec.rdoc_options     = "--title", "Vanity #{spec.version}", "--main", "README.rdoc",
                           "--webcvs", "http://github.com/assaf/#{spec.name}"

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: vanity
 version: !ruby/object:Gem::Version 
-  hash: 1
-  prerelease: false
-  segments: 
-  - 1
-  - 5
-  - 1
-  version: 1.5.1
+  prerelease: 
+  version: 1.5.2
 platform: ruby
 authors: 
 - Assaf Arkin
@@ -15,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-20 00:00:00 -08:00
-default_executable: 
+date: 2011-04-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: redis
@@ -26,10 +20,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
         version: "2.0"
   type: :runtime
   version_requirements: *id001
@@ -41,10 +31,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 0
-        - 7
         version: "0.7"
   type: :runtime
   version_requirements: *id002
@@ -126,14 +112,13 @@ files:
 - Rakefile
 - Gemfile
 - vanity.gemspec
-has_rdoc: true
 homepage: http://vanity.labnotes.org
 licenses: []
 
 post_install_message: To get started run vanity --help
 rdoc_options: 
 - --title
-- Vanity 1.5.1
+- Vanity 1.5.2
 - --main
 - README.rdoc
 - --webcvs
@@ -145,25 +130,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 57
-      segments: 
-      - 1
-      - 8
-      - 7
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Experience Driven Development framework for Ruby