ghazel-fiveruns_tuneup 0.8.22

data/lib/fiveruns/tuneup/version.rb

@@ -0,0 +1,89 @@
+# (The MIT License)
+# 
+# Copyright (c) 2008 Jamis Buck <jamis@37signals.com>,
+#               with modifications by Bruce Williams <bruce@fiveruns.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.
+module Fiveruns
+  
+  module Tuneup
+    
+    # A class for describing the current version of a library. The version
+    # consists of three parts: the +major+ number, the +minor+ number, and the
+    # +tiny+ (or +patch+) number.
+    class Version
+    
+      include Comparable
+      
+      # A convenience method for instantiating a new Version instance with the
+      # given +major+, +minor+, and +tiny+ components.
+      def self.[](major, minor, tiny)
+        new(major, minor, tiny)
+      end
+      
+      def self.rails
+        @rails ||= begin
+          # handle ::Rails::VERSION not being set
+          Version.new(::Rails::VERSION::MAJOR, ::Rails::VERSION::MINOR, ::Rails::VERSION::TINY) rescue Version.new(0,0,0)
+        end
+      end
+
+      attr_reader :major, :minor, :tiny
+
+      # Create a new Version object with the given components.
+      def initialize(major, minor, tiny)
+        @major, @minor, @tiny = major, minor, tiny
+      end
+
+      # Compare this version to the given +version+ object.
+      def <=>(version)
+        to_i <=> version.to_i
+      end
+
+      # Converts this version object to a string, where each of the three
+      # version components are joined by the '.' character. E.g., 2.0.0.
+      def to_s
+        @to_s ||= [@major, @minor, @tiny].join(".")
+      end
+
+      # Converts this version to a canonical integer that may be compared
+      # against other version objects.
+      def to_i
+        @to_i ||= @major * 1_000_000 + @minor * 1_000 + @tiny
+      end
+      
+      def to_a
+        [@major, @minor, @tiny]
+      end
+
+      MAJOR = 0
+      MINOR = 8
+      TINY  = 22
+
+      # The current version as a Version instance
+      CURRENT = new(MAJOR, MINOR, TINY)
+      # The current version as a String
+      STRING = CURRENT.to_s
+      
+    end
+    
+  end
+  
+end

data/lib/fiveruns_tuneup.rb

@@ -0,0 +1,11 @@
+deps = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : Dependencies
+deps.load_paths.unshift File.dirname(__FILE__)
+
+# hack for Rails < 2.3 compatability.
+class String
+  if not instance_methods.include?("html_safe!")
+    def html_safe!
+      self
+    end
+  end
+end

data/lib/tuneup_controller.rb

@@ -0,0 +1,46 @@
+class TuneupController < ActionController::Base 
+
+  def show
+    session['fiveruns_tuneup_last_uri'] = params[:uri]
+    debug_rjs = response.template.debug_rjs
+    response.template.debug_rjs = false
+    ActionController::Base.silence do
+      render :update do |page|
+        page << tuneup_reload_panel
+      end
+    end
+    response.template.debug_rjs = debug_rjs
+  end
+  
+  def asset
+    filename = File.basename(params[:file])
+    if filename =~ /css$/
+      response.content_type = 'text/css'
+    end
+    send_file File.join(File.dirname(__FILE__) << "/../assets/#{filename}")
+  end
+  
+  def on
+    collect true
+  end
+  
+  def off
+    collect false
+  end
+  
+  def sandbox
+    
+  end
+  
+  #######
+  private
+  #######
+  
+  def collect(state)
+    Fiveruns::Tuneup.collecting = state
+    render :update do |page|
+      page << %[$('tuneup-panel').update("#{escape_javascript(render(:partial => 'tuneup/panel/show.html.erb'))}")]
+    end
+  end
+
+end

data/lib/tuneup_helper.rb

@@ -0,0 +1,181 @@
+module TuneupHelper #:nodoc:
+  
+  include BumpsparkHelper
+
+  def tuneup_collection_link
+    state = tuneup_collecting? ? :off : :on
+    %|<a onclick="new TuneUpSandbox.Ajax.Request('/tuneup/#{state}', {asynchronous:true, evalScripts:true}); return false;" href="#">Turn #{state.to_s.titleize}</a>|.html_safe!
+  end
+  
+  def tuneup_recording?
+    Fiveruns::Tuneup.recording?
+  end
+  
+  def tuneup_css_class_for_step(step)
+    returning [] do |classes|
+      if step.children.any?
+        classes << 'with-children'
+        classes << 'tuneup-opened' if step.depth == 1 || open_step?(step)
+      end
+    end.join(' ')
+  end
+  
+  def tuneup_collecting?
+    Fiveruns::Tuneup.collecting
+  end
+  
+  def tuneup_data
+    most_recent_data = Fiveruns::Tuneup.stack.first
+    most_recent_data.blank? ? most_recent_data : most_recent_data['stack']
+  end
+  
+  def tuneup_schemas
+    Fiveruns::Tuneup.stack.first['schemas']
+  end
+  
+  def trend
+    numbers= if Fiveruns::Tuneup.trend.size > 50
+      Fiveruns::Tuneup.trend[-50..-1]
+    else
+      Fiveruns::Tuneup.trend
+    end
+    return unless numbers.size > 1
+    tag(:img,
+      :src => build_data_url("image/png",bumpspark(numbers)), :alt => '',
+      :title => "Trend over last #{pluralize(numbers.size, 'run')}")
+  end
+  
+  def open_step?(step)
+     [/^Around filter/, /^Invoke/].any? { |pattern| step.name =~ pattern }
+  end
+  
+  def tuneup_step_link(step)
+    name = tuneup_style_step_name(tuneup_truncate_step_name(step))
+    link = if step.children.any?
+      link_to_function(name, "TuneUpSandbox.$('#{dom_id(step, :children)}').toggle();TuneUpSandbox.$('#{dom_id(step)}').toggleClassName('tuneup-opened');", :class => "tuneup-step-link", :title => step.name)
+    else
+      content_tag(:span, name, :title => step.name)
+    end
+    link << additional_step_links(step)
+  end
+  
+  def link_to_show
+    %|<a id="tuneup-back-to-run-link" onclick="#{redisplay_last_run} return false;" href="#">&lt;&lt;&lt; Back to Run</a>|.html_safe!
+  end
+  
+  def redisplay_last_run(namespaced=true)
+    namespace_js = lambda { |fun| namespaced ? "TuneUpSandbox.#{fun}" : fun }
+    "#{namespace_js['$']}('tuneup-panel').show();"
+  end
+
+  
+  def additional_step_links(step)
+    returning '' do |text|
+      text << sql_link(step) if step.sql
+      text << schema_link(step) if step.table_name
+    end.html_safe!
+  end
+  
+  def schema_link(step)
+    link_to_schema(image_tag('/images/tuneup/schema.png', :alt => 'Schema'), step.table_name,  :class => 'tuneup-schema tuneup-halo')
+  end
+  
+  def sql_link(step)
+    link_to_function(image_tag('/images/tuneup/magnify.png', :alt => 'Query'), :class => 'tuneup-sql tuneup-halo', :title => 'View Query') do |page| 
+      page << %(TuneUpSandbox.$("#{dom_id(step, :sql)}").toggle(); return false;)
+    end
+  end
+  
+  def link_to_schema(text, table, html_options={})
+    link_to_function(text, "TuneUp.switchSchema('#{table}')", html_options.merge(:title => "View Schema"))
+  end
+  
+  def tuneup_truncate_step_name(step)
+    chars = 50 - (step.depth * 2)
+    tuneup_truncate(step.name, chars)
+  end
+  
+  def tuneup_bar(step=tuneup_data, options={})
+    width = options.delete(:width) || 200
+    bars = Fiveruns::Tuneup::Step.layers.map do |layer|
+      percent = step.percentages_by_layer[layer]
+      if percent == 0
+        next
+      else
+        begin
+          size = (percent * width).to_i
+        rescue
+          raise "Can't find percent for #{layer.inspect} from #{step.percentages_by_layer.inspect}"\
+        end
+      end
+      size = 1 if size.zero?
+      content_tag(:li, ((size >= 10 && layer != :other) ? layer.to_s[0, 1].capitalize : ''),
+        :class => "tuneup-layer-#{layer}",
+        :style => "width:#{size}px",
+        :title => layer.to_s.titleize)
+    end
+    content_tag(:ul, bars.compact.join, options.merge(:class => 'tuneup-bar'))
+  end
+  
+  def tuneup_style_step_name(name)
+    case name
+    when /^Perform (\S+) action in (\S+Controller)$/
+      "Perform <strong>#{h $1}</strong> action in <strong>#{h $2}</strong>"
+    when /^Invoke (\S+) action$/
+      "Invoke <strong>#{h $1}</strong> action"
+    when /^(Find|Create|Delete|Update) ([A-Z]\S*)(.*?)$/
+      "#{h $1} <strong>#{h $2}</strong>#{h $3}"
+    when /^(Render.*?)(\S+)$/
+      "#{h $1}<strong>#{h $2}</strong>"
+    when /^(\S+ filter )(.*?)$/
+      "#{h $1}<strong>#{h $2}</strong>"
+    when 'Other'
+      "(<i>Other</i>)"
+    else
+      h(name)
+    end
+  end
+  
+  def tuneup_truncate(text, max=32)
+    if text.size > max
+      component = (max - 3) / 2
+      remainder = (max - 3) % 2
+      begin
+        text.sub(/^(.{#{component}}).*?(.{#{component + remainder}})$/s, '\1...\2')
+      rescue
+        text
+      end
+    else
+      text
+    end
+  end
+  
+  def tuneup_reload_panel
+    update_page do |page|
+      page << "$('tuneup-flash').removeClassName('tuneup-show');"
+      page << %[$('tuneup-content').update("#{escape_javascript(render(:partial => 'tuneup/panel/show.html.erb'))}");]
+      page << 'TuneUp.adjustAbsoluteElements(_document.body);'
+      page << 'TuneUp.adjustFixedElements();'
+    end
+  end
+  
+  def tuneup_show_flash(type, locals)
+    types = [:error, :notice].reject { |t| t == type }
+    update_page do |page|
+      page << %[$('tuneup-flash').update("#{escape_javascript(render(:partial => 'flash.html.erb', :locals => locals.merge(:type => type)))}");]
+      page << "$('tuneup-flash').addClassName('tuneup-show')"
+      types.each do |other_type|
+        page << "$('tuneup-flash').removeClassName('tuneup-#{other_type}')"
+      end
+      page << "$('tuneup-flash').addClassName('tuneup-#{type}')"
+      page << 'TuneUp.adjustAbsoluteElements(_document.body);'
+      page << 'TuneUp.adjustFixedElements();'
+    end
+  end
+  
+  def link_to_edit_step(step)
+    return nil unless step.file && step.line && RUBY_PLATFORM.include?('darwin')
+    link_to(image_tag('/images/tuneup/edit.png', :alt => 'Edit'), "txmt://open?url=file://#{CGI.escape step.file}&amp;line=#{step.line}", :class => 'tuneup-edit tuneup-halo', :title => 'Open in TextMate')
+  end
+    
+end

data/rails/init.rb

@@ -0,0 +1,14 @@
+Fiveruns::Tuneup.start do
+  require 'dispatcher'
+  
+  Fiveruns::Tuneup::Routing.install
+      
+  Dispatcher.to_prepare :tuneup_controller_filters do
+    TuneupController.filter_chain.clear
+  end
+  [ActionController::Base, ActiveRecord::Base, ActionView::Base].each do |target|
+    target.extend Fiveruns::Tuneup::CustomMethods
+  end
+  ActionController::Base.append_view_path(File.dirname(__FILE__) << "/../views")
+  require File.dirname(__FILE__) << "/../install" # Check for assets
+end

data/tasks/assets.rake

@@ -0,0 +1,32 @@
+namespace :fiveruns do
+  
+  namespace :tuneup do
+    
+    namespace :tmp do
+      
+      desc "Clear tempory data (runs, etc)"
+      task :clear => :environment do
+        rm_rf File.join(RAILS_ROOT, 'tmp', 'tuneup')
+      end
+      
+    end
+    
+    namespace :assets do
+          
+      desc "Install assets"
+      task :install => :environment do
+        require File.dirname(__FILE__) << "/../install"        
+      end
+    
+      desc "Uninstall assets"
+      task :uninstall => :environment do
+        require File.dirname(__FILE__) << "/../uninstall"
+      end  
+      
+      task :reset => [:uninstall, :install]
+      
+    end
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'Shoulda'

data/uninstall.rb

@@ -0,0 +1,6 @@
+# Remove Assets
+Dir[File.join(RAILS_ROOT, 'public', '*', 'tuneup')].each do |asset_dir|
+  show_name = asset_dir.split(File::SEPARATOR)[-3, 3].join(File::SEPARATOR)
+  FileUtils.rm_rf(asset_dir) rescue nil
+  STDERR.puts "FiveRuns TuneUp: Removed #{show_name}"
+end

data/views/tuneup/_data.html.erb

@@ -0,0 +1,15 @@
+<div id='tuneup-data'>
+  <div id='tuneup-top'>
+    <div id='tuneup-summary'>
+      <%= image_tag('tuneup/pin.png', :id => 'tuneup-pin',
+                    :style => 'float:left;', :onclick => 'TuneUp.pinToggle()') %>
+      <%= tuneup_bar(tuneup_data.children.first, :id => 'tuneup-root-bar') %>
+      <%= trend %> <%= tuneup_data.time.to_i %> ms 
+    </div>
+  </div>
+  <%= render :partial => 'schema.html.erb' %>
+  <ul id="tuneup-details">
+    <%= render :partial => 'step.html.erb', :collection => tuneup_data.children %>
+    <li style="clear:both"></li>
+  </ul>
+</div>

data/views/tuneup/_flash.html.erb

@@ -0,0 +1,6 @@
+<p>
+  <%= message %>
+  <% if type == :error %>
+    <emph>If problems persist, please contact <%= link_to "FiveRuns Support", 'mailto:support@fiveruns.com' %>.</emph>
+  <% end %>
+</p>

data/views/tuneup/_link.html.erb

@@ -0,0 +1 @@
+<p class='tuneup-full'><%= tuneup_collection_link %></p>

data/views/tuneup/_schema.html.erb

@@ -0,0 +1,17 @@
+<div id='tuneup-schema' style='display:none;'>
+  <% Fiveruns::Tuneup.schemas.each do |table, schema| %>
+    <div id='tuneup-schema-table-<%= table %>' class='tuneup-schema-table' style='display:none;'>
+      <h3>Schema for '<%= table %>'</h3>
+      <table>
+        <tr>
+          <th>Name</th><th>Type</th>
+        </tr>
+        <% schema[:columns].each do |column| %>
+          <tr>
+            <td><%=h column[:name] %></td><td><%=h column[:sql_type] %></td>
+          </tr>
+        <% end %>
+      </table>
+    </div>
+  <% end %>
+</div>

data/views/tuneup/_sql.html.erb

@@ -0,0 +1,23 @@
+<form id='<%= dom_id(step, :sql) %>' style='display:none;'>
+  <textarea cols='80' rows='<%= sql.query.split("\n").size %>'><%= sql.query %></textarea>
+  <% if sql.explain %>
+  <table>
+    <tr>
+      <% sql.explain.fields.each do |field| %>
+        <th><%=h field %></th>
+      <% end %>
+    </tr>
+    <% sql.explain.rows.each do |row| %>
+      <tr>
+        <% row.each_with_index do |value, index| %>
+          <% if index == sql.explain.table_offset %>
+            <td><%= link_to_schema value, value %></td>
+          <% else %>
+            <td><%=h value%></td>
+          <% end %>
+        <% end %>
+      </tr>
+    <% end %>
+  </table>
+  <% end %>
+</form>