clientperf 0.0.1

data/History.rdoc

@@ -0,0 +1,3 @@
+= History
+
+* v0.0.1. Just in time for Austin on Rails

data/Manifest

@@ -0,0 +1,15 @@
+bin/clientperf
+History.rdoc
+init.rb
+lib/clientperf.rb
+lib/clientperf_controller.rb
+lib/clientperf_result.rb
+lib/clientperf_uri.rb
+lib/extend_action_controller.rb
+Manifest
+rails/init.rb
+Rakefile
+README.rdoc
+views/clientperf/index.html.erb
+views/clientperf/show.html.erb
+views/layouts/clientperf.html.erb

data/README.rdoc

@@ -0,0 +1,50 @@
+= clientperf
+
+== Synopsis
+
+Measures the time it takes a user's browser to get from the top of a web page to the window.onload event. This includes all asset requests.
+
+== Installation
+
+	sudo gem install clientperf
+	clientperf /path/to/rails/app
+	rake db:migrate
+
+== Usage
+
+	http://<site>/clientperf to view metrics
+
+== Configuration
+
+edit config/clientperf.yml
+	
+	---
+	username: bob
+	password: foo
+	
+this allows for http basic auth on the /clientperf url
+
+== License
+
+Copyright (c) 2008 Eric Falcao <efalcao@gmail.com>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'echoe'
+
+require File.dirname(__FILE__) << "/lib/clientperf"
+
+Echoe.new 'clientperf' do |p|
+  p.version = Clientperf.version
+  p.author = "Eric Falcao"
+  p.email  = 'efalcao@gmail.com'
+  p.project = 'clientperf'
+  p.summary = "Instrumentation for the FiveRuns TuneUp product."
+  p.url = "http://github.com/efalcao/clientperf"
+  p.include_rakefile = true
+end

data/bin/clientperf

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+require File.dirname(__FILE__) << "/../lib/clientperf"
+require File.dirname(__FILE__) << "/../lib/clientperf_config"
+require File.dirname(__FILE__) << "/../lib/clientperf_migraions"
+
+# For older Rails versions
+# USAGE: clientperf [RAILS_ROOT]
+rails_dir = ARGV[0] || Dir.pwd
+plugin_dir = File.join(rails_dir, 'vendor/plugins')
+unless File.directory?(plugin_dir)
+  abort "clientperf: #{plugin_dir} does not exist; cannot install plugin"
+end
+
+FileUtils.rm_rf File.join(plugin_dir, 'clientperf') rescue nil
+
+File.readlines(File.dirname(__FILE__) << "/../Manifest").each do |line|
+  stub = line.strip
+  origin = File.dirname(__FILE__) << "/../#{stub}"
+  next if origin =~ /\/clientperf$/
+  if File.file?(origin)
+    destination = File.join(plugin_dir, 'clientperf', stub)
+    FileUtils.mkdir_p File.dirname(destination)
+    FileUtils.cp origin, destination
+  end
+end
+
+ClientperfMigrations.install(rails_dir)
+ClientperfConfig.create_unless_exists
+
+STDERR.puts "Installed clientperf (v#{Clientperf.version}) in vendor/plugins/clientperf"

data/clientperf.gemspec

@@ -0,0 +1,45 @@
+
+# Gem::Specification for Clientperf-0.0.1
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{clientperf}
+  s.version = "0.0.1"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eric Falcao"]
+  s.date = %q{2008-06-18}
+  s.default_executable = %q{clientperf}
+  s.description = %q{Instrumentation for the FiveRuns TuneUp product.}
+  s.email = %q{efalcao@gmail.com}
+  s.executables = ["clientperf"]
+  s.extra_rdoc_files = ["bin/clientperf", "lib/clientperf.rb", "lib/clientperf_controller.rb", "lib/clientperf_result.rb", "lib/clientperf_uri.rb", "lib/extend_action_controller.rb", "README.rdoc"]
+  s.files = ["bin/clientperf", "History.rdoc", "init.rb", "lib/clientperf.rb", "lib/clientperf_controller.rb", "lib/clientperf_result.rb", "lib/clientperf_uri.rb", "lib/extend_action_controller.rb", "Manifest", "rails/init.rb", "Rakefile", "README.rdoc", "views/clientperf/index.html.erb", "views/clientperf/show.html.erb", "views/layouts/clientperf.html.erb", "clientperf.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/efalcao/clientperf}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Clientperf", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{clientperf}
+  s.rubygems_version = %q{1.0.1}
+  s.summary = %q{Instrumentation for the FiveRuns TuneUp product.}
+end
+
+
+# # Original Rakefile source (requires the Echoe gem):
+# 
+# require 'rubygems'
+# require 'echoe'
+# 
+# require File.dirname(__FILE__) << "/lib/clientperf"
+# 
+# Echoe.new 'clientperf' do |p|
+#   p.version = Clientperf.version
+#   p.author = "Eric Falcao"
+#   p.email  = 'efalcao@gmail.com'
+#   p.project = 'clientperf'
+#   p.summary = "Instrumentation for the FiveRuns TuneUp product."
+#   p.url = "http://github.com/efalcao/clientperf"
+#   p.include_rakefile = true
+# end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) << "/rails/init"

data/lib/clientperf.rb

@@ -0,0 +1,46 @@
+module Clientperf
+  
+  class << self
+    def load
+      if supported_rails_version?
+        require 'dispatcher'
+        Dispatcher.to_prepare :clientperf_route do
+          ActionController::Routing::Routes.add_route '/clientperf', :controller => 'clientperf', :action => 'index'
+          ActionController::Routing::Routes.add_route '/clientperf/measure.gif', :controller => 'clientperf', :action => 'measure'
+          ActionController::Routing::Routes.add_route '/clientperf/reset', :controller => 'clientperf', :action => 'reset'
+          ActionController::Routing::Routes.add_route '/clientperf/:id', :controller => 'clientperf', :action => 'show'
+          ActionController::Routing::Routes.add_route '/clientperf/:id/reset', :controller => 'clientperf', :action => 'reset'
+          5.times do
+            route = ActionController::Routing::Routes.routes.pop
+            ActionController::Routing::Routes.routes.unshift(route)
+          end
+        end
+        
+        Dispatcher.to_prepare :clientperf_controller_filters do
+          ClientperfController.filter_chain.clear
+          ClientperfController.before_filter :authenticate
+        end
+        
+        ActionController::Base.append_view_path(File.dirname(__FILE__) << "/../views")
+        ActionController::Base.send! :include, ExtendActionController
+      end
+    end
+    
+    def version
+      "0.0.1"
+    end
+    
+    private
+    
+    def supported_rails_version?
+      version = Rails::VERSION rescue nil
+      return true unless version
+      if version::MAJOR < 2
+        STDERR.puts "[clientperf] rails < 2.0 not supported. skipping load."
+        false
+      else
+        true
+      end
+    end
+  end
+end

data/lib/clientperf_controller.rb

@@ -0,0 +1,42 @@
+class ClientperfController < ActionController::Base
+  def index
+    @uris = ClientperfUri.find(:all, :include => :clientperf_results)
+  end
+  
+  def show
+    @uri = ClientperfUri.find(params[:id], :include => :clientperf_results)
+  end
+  
+  def reset
+    if request.post?
+      if params[:id]
+        ClientperfUri.destroy(params[:id])
+      else
+        ClientperfUri.destroy_all
+      end
+    end
+    redirect_to :action => 'index'
+  end
+  
+  def measure
+    milliseconds = params[:e].to_i - params[:b].to_i rescue nil
+    if milliseconds && params[:u]
+      uri = ClientperfUri.find_or_create_by_uri(params[:u])
+      ClientperfResult.create(:milliseconds => milliseconds, :clientperf_uri => uri)
+    end
+    render :nothing => true
+  end
+  
+  private
+  
+  def authenticate
+    return true if action_name == 'measure'
+    
+    config = ClientperfConfig.new
+    if config.has_auth?
+      authenticate_or_request_with_http_basic do |user_name, password|
+        user_name == config['username'] && password == config['password']
+      end
+    end
+  end
+end

data/lib/clientperf_result.rb

@@ -0,0 +1,10 @@
+class ClientperfResult < ActiveRecord::Base
+  belongs_to :clientperf_uri
+  after_create :update_uri
+  
+  private
+  
+  def update_uri
+    clientperf_uri.update_attribute(:updated_at, Time.now)
+  end
+end

data/lib/clientperf_uri.rb

@@ -0,0 +1,23 @@
+class ClientperfUri < ActiveRecord::Base
+  has_many :clientperf_results, :dependent => :delete_all
+
+  def result_average
+    @result_average ||= clientperf_results.inject(0) {|sum, result| sum += result.milliseconds; next sum} / clientperf_results.size
+  end
+  
+  def chart_url
+    "http://chart.apis.google.com/chart?cht=ls&chs=300x200&chd=s:#{chart_data}"
+  end
+  
+  private 
+  
+  def chart_data
+    encode = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
+    max_value = clientperf_results.max {|a, b| a.milliseconds <=> b.milliseconds}.milliseconds + 10
+    
+    clientperf_results.map do |result|
+      char = 62 * result.milliseconds / max_value.to_f
+      encode[char.round,1]
+    end.join
+  end
+end

data/lib/extend_action_controller.rb

@@ -0,0 +1,66 @@
+module ExtendActionController
+  def self.included(base)
+    base.alias_method_chain :process, :clientperf
+  end
+  
+  def process_with_clientperf(request, response, *args, &block)
+    result = process_without_clientperf(request, response, *args, &block)
+    if add_clientperf?(request, response)
+      add_clientperf_to(response)
+    end
+    result
+  end
+  
+  def add_clientperf_to(response)
+    if response.body =~ /<html[^>]*?>/im
+      replacement = %q(\1
+        <script type='text/javascript'>
+          var clientPerfStart = (new Date()).getTime();
+          var clientPerf = function() {
+            var attach = function(instance, eventName, listener) {
+            	var listenerFn = listener;
+            	if (instance.addEventListener) {
+            		instance.addEventListener(eventName, listenerFn, false);
+            	}
+            	else if (instance.attachEvent) { // Internet explorer
+            		listenerFn = function() {
+            	    	listener(window.event);
+            		};
+            		instance.attachEvent("on" + eventName, listenerFn);
+            	}
+            	else {
+            	    // I could do some further attachment here, if I wanted too. for older browsers
+            	    // ex: instance['on' + eventName] = listener;
+            		throw new Error("Event registration not supported");
+            	}
+            };
+            
+            var endRun = function() {
+              var clientPerfEnd = (new Date()).getTime();
+              var img = document.createElement('img');
+              img.src = '/clientperf/measure.gif?b=' + clientPerfStart + '&e=' + clientPerfEnd + '&u=' + location.href;
+              document.body.appendChild(img);
+            };
+            
+            try {
+                attach(window, 'load', endRun);
+            }
+            catch(e) {
+                window.onload = endRun;
+            }
+          }
+          clientPerf();
+        </script>
+      )
+      
+      response.body.sub!(/(<html[^>]*?>)/im, replacement)
+      response.headers["Content-Length"] = response.body.size
+    end
+  end
+  
+  def add_clientperf?(request, response)
+    !request.xhr? && response.content_type && response.content_type.include?('html') && 
+      response.body && response.headers['Status'] && response.headers['Status'].include?('200') && 
+      controller_name != 'clientperf'
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+Clientperf.load

data/views/clientperf/index.html.erb

@@ -0,0 +1,19 @@
+<%= button_to "Reset all data", {:action => 'reset'},  :confirm => "are you sure?" %>
+<table>
+	<tr>
+		<td>URI</td>
+		<td># of times measured</td>
+		<td>avg. client time (ms)</td>
+		<td>first measured</td>
+		<td>last measured</td>
+	</tr>
+	<% @uris.each do |uri| %>
+	<tr>
+		<td><%= link_to uri.uri, "/clientperf/#{uri.id}" %></td>
+		<td><%= uri.clientperf_results.size %></td>
+		<td><%= uri.result_average %></td>
+		<td><%= uri.created_at.strftime("%M/%d/%y") %></td>
+		<td><%= uri.updated_at.strftime("%M/%d/%y") %></td>
+	</tr>
+	<% end %>
+</table>

data/views/clientperf/show.html.erb

@@ -0,0 +1,5 @@
+<%= button_to "Reset this URI", {:action => 'reset', :id => @uri.id},  :confirm => "are you sure?" %>
+<h1><%= @uri.uri %></h1>
+<h3>times measured: <%= @uri.clientperf_results.size %></h3>
+<h3>average time: <%= @uri.result_average %>ms</h3>
+<img src="<%= @uri.chart_url %>" />

data/views/layouts/clientperf.html.erb

@@ -0,0 +1,12 @@
+<html>
+	<head>
+		<title></title>
+		<style type="text/css">
+		</style>
+	</head>
+	<body>
+		<h1>clientperf</h1>
+		<h3>a measurement tool for client-side performance</h3>
+		<%= yield %>
+	</body>
+</html>

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: clientperf
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Eric Falcao
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-18 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Instrumentation for the FiveRuns TuneUp product.
+email: efalcao@gmail.com
+executables: 
+- clientperf
+extensions: []
+
+extra_rdoc_files: 
+- bin/clientperf
+- lib/clientperf.rb
+- lib/clientperf_controller.rb
+- lib/clientperf_result.rb
+- lib/clientperf_uri.rb
+- lib/extend_action_controller.rb
+- README.rdoc
+files: 
+- bin/clientperf
+- History.rdoc
+- init.rb
+- lib/clientperf.rb
+- lib/clientperf_controller.rb
+- lib/clientperf_result.rb
+- lib/clientperf_uri.rb
+- lib/extend_action_controller.rb
+- Manifest
+- rails/init.rb
+- Rakefile
+- README.rdoc
+- views/clientperf/index.html.erb
+- views/clientperf/show.html.erb
+- views/layouts/clientperf.html.erb
+- clientperf.gemspec
+has_rdoc: true
+homepage: http://github.com/efalcao/clientperf
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Clientperf
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: clientperf
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Instrumentation for the FiveRuns TuneUp product.
+test_files: []
+