metry 1.0.0

data/radiant/example/config/database.yml

@@ -0,0 +1,20 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3.db
+
+# Warning: The database defined as 'test' will be erased and
+# re-generated from your development database when you run 'rake'.
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3.db
+
+cucumber:
+  adapter: sqlite3
+  database: db/test.sqlite3.db
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3.db

data/radiant/example/config/environment.rb

@@ -0,0 +1,83 @@
+# Be sure to restart your server when you modify this file
+
+# Uncomment below to force Rails into production mode when
+# you don't control web/app server and can't set it the proper way
+# ENV['RAILS_ENV'] ||= 'production'
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+require File.join(File.dirname(__FILE__), 'boot')
+
+require 'radius'
+
+Radiant::Initializer.run do |config|
+  # Skip frameworks you're not going to use (only works if using vendor/rails).
+  # To use Rails without a database, you must remove the Active Record framework
+  config.frameworks -= [ :action_mailer ]
+
+  # Only load the extensions named here, in the order given. By default all
+  # extensions in vendor/extensions are loaded, in alphabetical order. :all
+  # can be used as a placeholder for all extensions not explicitly named.
+  # config.extensions = [ :all ]
+
+  # Your secret key for verifying cookie session data integrity.
+  # If you change this key, all old sessions will become invalid!
+  # Make sure the secret is at least 30 characters and all random,
+  # no regular words or you'll be exposed to dictionary attacks.
+  config.action_controller.session = {
+    :session_key => '_radiant_session',
+    :secret      => '1f9ce57d47cafc63b3fce6acc136bd8aa886a3ab'
+  }
+
+  # Comment out this line if you want to turn off all caching, or
+  # add options to modify the behavior. In the majority of deployment 
+  # scenarios it is desirable to leave Radiant's cache enabled and in
+  # the default configuration.
+  #
+  # Additional options:
+  #  :use_x_sendfile => true
+  #    Turns on X-Sendfile support for Apache with mod_xsendfile or lighttpd.
+  #  :use_x_accel_redirect => '/some/virtual/path'
+  #    Turns on X-Accel-Redirect support for nginx. You have to provide
+  #    a path that corresponds to a virtual location in your webserver 
+  #    configuration.
+  #  :entitystore => "radiant:cache/entity"
+  #    Sets the entity store type (preceding the colon) and storage 
+  #   location (following the colon, relative to Rails.root).
+  #    We recommend you use radiant: since this will enable manual expiration.
+  #  :metastore => "radiant:cache/meta"
+  #    Sets the meta store type and storage location.  We recommend you use
+  #    radiant: since this will enable manual expiration and acceleration headers.
+  config.middleware.use ::Radiant::Cache
+
+  # Use the database for sessions instead of the cookie-based default,
+  # which shouldn't be used to store highly confidential information
+  # (create the session table with 'rake db:sessions:create')
+  config.action_controller.session_store = :cookie_store
+
+  # Activate observers that should always be running
+  config.active_record.observers = :user_action_observer
+
+  # Make Active Record use UTC-base instead of local time
+  config.active_record.default_timezone = :utc
+
+  # Set the default field error proc
+  config.action_view.field_error_proc = Proc.new do |html, instance|
+    if html !~ /label/
+      %{<div class="error-with-field">#{html} <small class="error">&bull; #{[instance.error_message].flatten.first}</small></div>}
+    else
+      html
+    end
+  end
+
+  config.after_initialize do
+    # Add new inflection rules using the following format:
+    ActiveSupport::Inflector.inflections do |inflect|
+      inflect.uncountable 'config'
+    end
+
+    require RAILS_ROOT + '/../../lib/metry'
+    Metry.init Metry::Tokyo.new(RAILS_ROOT + '/tracking/tracking')
+
+    config.middleware.insert_after ActionController::Failsafe, Metry::Rack::Tracking
+  end
+end

data/radiant/example/config/environments/cucumber.rb

@@ -0,0 +1,18 @@
+config.cache_classes = true # This must be true for Cucumber to operate correctly!
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+require 'pp'

data/radiant/example/config/environments/development.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes     = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils        = true
+
+# Show full error reports and caching is turned off
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/radiant/example/config/environments/production.rb

@@ -0,0 +1,19 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The production environment is meant for finished, "live" apps.
+# Code is not reloaded between requests
+config.cache_classes = true
+
+# Use a different logger for distributed setups
+# config.logger        = SyslogLogger.new
+
+
+# Full error reports are disabled and caching is on
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+
+# Enable serving of images, stylesheets, and javascripts from an asset server
+# config.action_controller.asset_host                  = "http://assets.example.com"
+
+# Disable delivery errors if you bad email addresses should just be ignored
+# config.action_mailer.raise_delivery_errors = false

data/radiant/example/config/environments/test.rb

@@ -0,0 +1,36 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# ensure test extensions are loaded
+# test_extension_dir = File.join(File.expand_path(RADIANT_ROOT), 'test', 'fixtures', 'extensions')
+# config.extension_paths.unshift test_extension_dir
+# config.extension_paths.uniq!
+# if !config.extensions.include?(:all)
+#   config.extensions.concat(Dir["#{test_extension_dir}/*"].sort.map {|x| File.basename(x).sub(/^\d+_/,'')})
+#   config.extensions.uniq!
+# end
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils    = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell ActionMailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+config.gem "rspec", :version => "1.2.6", :lib => false
+config.gem "rspec-rails", :version => "1.2.6", :lib => false
+config.gem "webrat", :version => "~>0.4.4", :lib => false
+config.gem "cucumber", :version => "~>0.3.9", :lib => false

data/radiant/example/config/routes.rb

@@ -0,0 +1 @@
+load File.join(RADIANT_ROOT, "config", "routes.rb") 

data/radiant/example/db/schema.rb

@@ -0,0 +1,112 @@
+# This file is auto-generated from the current state of the database. Instead of editing this file, 
+# please use the migrations feature of Active Record to incrementally modify your database, and
+# then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your database schema. If you need
+# to create the application database on another system, you should be using db:schema:load, not running
+# all the migrations from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20081203140407) do
+
+  create_table "config", :force => true do |t|
+    t.string "key",   :limit => 40, :default => "", :null => false
+    t.string "value",               :default => ""
+  end
+
+  add_index "config", ["key"], :name => "key", :unique => true
+
+  create_table "extension_meta", :force => true do |t|
+    t.string  "name"
+    t.integer "schema_version", :default => 0
+    t.boolean "enabled",        :default => true
+  end
+
+  create_table "layouts", :force => true do |t|
+    t.string   "name",          :limit => 100
+    t.text     "content"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.integer  "created_by_id"
+    t.integer  "updated_by_id"
+    t.string   "content_type",  :limit => 40
+    t.integer  "lock_version",                 :default => 0
+  end
+
+  create_table "page_parts", :force => true do |t|
+    t.string  "name",      :limit => 100
+    t.string  "filter_id", :limit => 25
+    t.text    "content"
+    t.integer "page_id"
+  end
+
+  add_index "page_parts", ["page_id", "name"], :name => "parts_by_page"
+
+  create_table "pages", :force => true do |t|
+    t.string   "title"
+    t.string   "slug",          :limit => 100
+    t.string   "breadcrumb",    :limit => 160
+    t.string   "class_name",    :limit => 25
+    t.integer  "status_id",                    :default => 1,     :null => false
+    t.integer  "parent_id"
+    t.integer  "layout_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.datetime "published_at"
+    t.integer  "created_by_id"
+    t.integer  "updated_by_id"
+    t.boolean  "virtual",                      :default => false, :null => false
+    t.integer  "lock_version",                 :default => 0
+    t.string   "description"
+    t.string   "keywords"
+  end
+
+  add_index "pages", ["class_name"], :name => "pages_class_name"
+  add_index "pages", ["parent_id"], :name => "pages_parent_id"
+  add_index "pages", ["slug", "parent_id"], :name => "pages_child_slug"
+  add_index "pages", ["virtual", "status_id"], :name => "pages_published"
+
+  create_table "sessions", :force => true do |t|
+    t.string   "session_id"
+    t.text     "data"
+    t.datetime "updated_at"
+  end
+
+  add_index "sessions", ["session_id"], :name => "index_sessions_on_session_id"
+  add_index "sessions", ["updated_at"], :name => "index_sessions_on_updated_at"
+
+  create_table "snippets", :force => true do |t|
+    t.string   "name",          :limit => 100, :default => "", :null => false
+    t.string   "filter_id",     :limit => 25
+    t.text     "content"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.integer  "created_by_id"
+    t.integer  "updated_by_id"
+    t.integer  "lock_version",                 :default => 0
+  end
+
+  add_index "snippets", ["name"], :name => "name", :unique => true
+
+  create_table "users", :force => true do |t|
+    t.string   "name",          :limit => 100
+    t.string   "email"
+    t.string   "login",         :limit => 40,  :default => "",    :null => false
+    t.string   "password",      :limit => 40
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.integer  "created_by_id"
+    t.integer  "updated_by_id"
+    t.boolean  "admin",                        :default => false, :null => false
+    t.boolean  "developer",                    :default => false, :null => false
+    t.text     "notes"
+    t.integer  "lock_version",                 :default => 0
+    t.string   "salt"
+    t.string   "session_token"
+  end
+
+  add_index "users", ["login"], :name => "login", :unique => true
+
+end

data/radiant/example/features/metry.feature

@@ -0,0 +1,139 @@
+Feature: Radiant support
+  In order to get metrics and run experiments on my Radiant applications
+  As a Radiant administrator
+  I want to have a Radiant extension that gives me Metry support
+  
+  Background:
+    Given an empty tracking database
+    And I am a new visitor
+    And I have a layout
+    And there is an empty Radiant cache
+  
+  Scenario: Basic Tracking
+    Given a page at "/" containing:
+      """
+      Hello!
+      """
+    When I view "/"
+    Then I should see "Hello!"
+    And there should be 1 tracking event
+  
+  Scenario: Caching shouldn't interfere with tracking
+    Given a page at "/" containing:
+      """
+      Hello!
+      """
+    When I view "/"
+    And I view "/"
+    Then there should be 2 tracking events
+  
+  Scenario: Running an experiment
+    Given a page at "/" containing:
+      """
+      <r:metry:experiment name="header" method="mod_visitor">
+      Hello!
+      <r:alternative name="grumpy">
+      Go away!
+      </r:alternative>
+      <r:alternative name="dopey">
+      Duh?
+      </r:alternative>
+      </r:metry:experiment>
+      """
+    When I view "/"
+    Then I should see "Hello!"
+    When I am a new visitor
+    And there is an empty Radiant cache
+    And I view "/"
+    Then I should see "Go away!"
+    When I am a new visitor
+    And there is an empty Radiant cache
+    And I view "/"
+    Then I should see "Duh?"
+    Then there should be a tracking event "1":
+      | key | value |
+      | visitor | 1 |
+      | experiment.header | control |
+    Then there should be a tracking event "2":
+      | key | value |
+      | visitor | 2 |
+      | experiment.header | grumpy |
+    Then there should be a tracking event "3":
+      | key | value |
+      | visitor | 3 |
+      | experiment.header | dopey |
+    Then there should be a visitor "1":
+      | key | value |
+      | experiment.header | control |
+    Then there should be a visitor "2":
+      | key | value |
+      | experiment.header | grumpy |
+    Then there should be a visitor "3":
+      | key | value |
+      | experiment.header | dopey |
+      
+  Scenario: Multiple access by same visitor should give same result
+    Given a page at "/" containing:
+      """
+      <r:metry:experiment name="switch" method="rand">
+      One
+      <r:alternative name="two">
+      Two
+      </r:alternative>
+      </r:metry:experiment>
+      """
+    When I view "/" 10 times
+    Then I should see the same "switch" alternative 10 times
+    When I am a new visitor
+    And I view "/" 10 times
+    Then I should see the same "switch" alternative 10 times
+    When I am a new visitor
+    And I view "/" 10 times
+    Then I should see the same "switch" alternative 10 times
+    When I am a new visitor
+    And I view "/" 10 times
+    Then I should see the same "switch" alternative 10 times
+  
+  Scenario: Caching shouldn't interfere with experiments
+    Given a page at "/" containing:
+      """
+      <r:metry:experiment name="cached" method="mod_visitor">
+      Sweet
+      <r:alternative name="two">
+      Sour
+      </r:alternative>
+      </r:metry:experiment>
+      """
+    When I view "/" 2 times
+    Then there should be a tracking event "1":
+      | key | value |
+      | experiment.cached | control |
+    Then there should be a tracking event "2":
+      | key | value |
+      | experiment.cached | control |
+  
+  Scenario: rand method should give reasonable experiment distribution
+    Given a page at "/" containing:
+      """
+      <r:metry:experiment name="lots" method="rand">
+      Control
+      <r:alternative name="alt1">
+      Alt1
+      </r:alternative>
+      <r:alternative name="alt2">
+      Alt2
+      </r:alternative>
+      <r:alternative name="alt3">
+      Alt3
+      </r:alternative>
+      <r:alternative name="alt4">
+      Alt4
+      </r:alternative>
+      </r:metry:experiment>
+      """
+    When 100 visitors view "/"
+    Then at least 10 should see alternative "control" of experiment "lots"
+    Then at least 10 should see alternative "alt1" of experiment "lots"
+    Then at least 10 should see alternative "alt2" of experiment "lots"
+    Then at least 10 should see alternative "alt3" of experiment "lots"
+    Then at least 10 should see alternative "alt4" of experiment "lots"