fiveruns_tuneup 0.8.2

data/lib/fiveruns/tuneup/version.rb

@@ -0,0 +1,80 @@
+# (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
+    
+      # 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
+
+      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  = 2
+
+      # 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 @@
+Dependencies.load_paths.unshift File.dirname(__FILE__)

data/lib/tuneup_config.rb

@@ -0,0 +1,29 @@
+require 'yaml'
+
+class TuneupConfig
+  
+  delegate :[], :[]=, :each, :update, :to => :data
+
+  def self.defaults
+    { 'api_key' => nil }
+  end
+  
+  def save!
+    File.open(config_file, 'w') { |f| f.puts data.to_yaml }
+  end
+  
+  def data
+    @data ||= begin
+      YAML.load(File.read(config_file)) rescue self.class.defaults
+    end
+  end
+    
+  def config_file
+    File.join(RAILS_ROOT, 'config', 'fiveruns_tuneup.yml')
+  end
+  
+  def state
+    data['api_key'] ? :registered : :unregistered
+  end
+  
+end

data/lib/tuneup_controller.rb

@@ -0,0 +1,140 @@
+require 'net/https'
+require 'ostruct'
+require 'open-uri'
+
+class TuneupController < ActionController::Base
+  
+  self.logger = Fiveruns::Tuneup::LOGGER
+      
+  def show
+    render :update do |page|
+      page << tuneup_reload_panel
+    end
+  end
+  
+  def update
+    @config.update(params[:config])
+    @config.save!
+    redirect_to :action => 'show'
+  end
+  
+  def signin
+    if api_key = retrieve_api_key
+      @config['api_key'] = api_key
+      @config.save!
+    end
+    render :update do |page|
+      if api_key
+        page << tuneup_reload_panel
+      else
+        page << tuneup_show_flash(:error,
+                  :header => "TuneUp encountered an error",
+                  :message => "Could not access your FiveRuns TuneUp account.")
+      end
+    end
+  end
+  
+  def upload
+    token = upload_run
+    render :update do |page|
+      if token
+        link = link_to_function("here", tuneup_open_run(token))
+        page << tuneup_show_flash(:notice,
+                  :header => 'Run Uploaded to TuneUp',
+                  :message => "View your run #{link}.")
+      else
+        page << tuneup_show_flash(:error,
+                  :header => "TuneUp encountered an error",
+                  :message => "Could not upload run to your FiveRuns TuneUp account.")
+      end
+    end
+  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
+  
+  #######
+  private
+  #######
+  
+  def collect(state)
+    Fiveruns::Tuneup.collecting = state
+    render(:update) { |p| p['tuneup-panel'].replace(render(:partial => 'tuneup/panel/registered')) }
+  end
+
+  def find_config
+    @config = TuneupConfig.new
+  end
+  
+  #
+  # HTTP
+  #
+  
+  def upload_run
+    safely do
+      http = Net::HTTP.new(upload_uri.host, upload_uri.port)
+      http.use_ssl = true if Fiveruns::Tuneup.collector_url =~ /^https/
+      resp = nil
+      # TODO: Support targeted upload
+      filename = Fiveruns::Tuneup.last_filename_for_run_uri(params[:uri])
+      Fiveruns::Tuneup.log :debug, "Uploading #{filename} for URI #{params[:uri]}"
+      File.open(filename, 'rb') do |file|
+        multipart = Fiveruns::Tuneup::Multipart.new(file, 'api_key' => @config['api_key'] )
+       # Fiveruns::Tuneup.log :debug, multipart.to_s
+        resp = http.post(upload_uri.request_uri, multipart.to_s, "Content-Type" => multipart.content_type)
+      end
+      case resp.code.to_i
+      when 201
+        return resp.body.strip rescue nil
+      else
+        Fiveruns::Tuneup.log :error, "Recieved bad response from service (#{resp.inspect})"
+        return false
+      end
+    end
+  end
+  
+  def retrieve_api_key
+    safely do
+      http = Net::HTTP.new(api_key_uri.host, api_key_uri.port)
+      http.use_ssl = true if Fiveruns::Tuneup.collector_url =~ /^https/
+      data = "email=#{CGI.escape(params[:email])}&password=#{CGI.escape(params[:password])}"
+      resp = http.post(api_key_uri.path, data, "Content-Type" => "application/x-www-form-urlencoded")
+      case resp.code.to_i
+      when 200..299
+        resp.body.strip rescue nil
+      else
+        Fiveruns::Tuneup.log :error, "Recieved bad response from service (#{resp.inspect})"
+        false
+      end
+    end
+  end
+  
+  def safely
+    yield
+  rescue Exception => e
+    Fiveruns::Tuneup.log :error, "Could not access service: #{e.message}"
+    false
+  end
+  
+  def api_key_uri
+    @api_key_uri ||= URI.parse("#{Fiveruns::Tuneup.collector_url}/users")
+  end
+    
+  def upload_uri
+    @upload_uri ||= URI.parse("#{Fiveruns::Tuneup.collector_url}/runs")
+  end
+  
+end

data/lib/tuneup_helper.rb

@@ -0,0 +1,185 @@
+module TuneupHelper #:nodoc:
+  
+  include BumpsparkHelper
+
+  def tuneup_signin_url
+    "#{Fiveruns::Tuneup.collector_url}/users"
+  end
+  
+  def tuneup_signup_url
+    "#{Fiveruns::Tuneup.frontend_url}/signup"
+  end
+  
+  def tuneup_collection_link
+    state = tuneup_collecting? ? :off : :on
+    link_to_remote "Turn #{state.to_s.titleize}", :url => "/tuneup/#{state}"
+  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, "$('#{dom_id(step, :children)}').toggle();$('#{dom_id(step)}').toggleClassName('tuneup-opened');")
+    else
+      name
+    end
+    link << additional_step_links(step)
+  end
+  
+  def link_to_upload
+    link_to_remote "Upload this Run",
+      :url => "/tuneup/upload?uri=#{CGI.escape(params[:uri])}",
+      :loading => '$("tuneup-top").hide(); TuneUp.Spinner.start()',
+      :complete => ' TuneUp.Spinner.stop(); $("tuneup-top").show();',
+      :html => {:id => 'tuneup-save-link'}
+  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
+  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') { |p| p[dom_id(step, :sql)].toggle }
+  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_open_run(token)
+    %[window.open("#{Fiveruns::Tuneup.frontend_url}/runs/#{token}", 'fiveruns_tuneup');]
+  end
+  
+  def tuneup_reload_panel
+    update_page do |page|
+      page['tuneup-flash'].removeClassName('tuneup-show');
+      page['tuneup-content'].replace_html(render(:partial => "tuneup/panel/#{@config.state}"))
+    end
+  end
+  
+  def tuneup_show_flash(type, locals)
+    types = [:error, :notice].reject { |t| t == type }
+    update_page do |page|
+      page['tuneup-flash'].replace_html(render(:partial => 'flash', :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}");
+    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}&line=#{step.line}", :class => 'tuneup-edit tuneup-halo', :title => 'Open in TextMate')
+  end
+    
+end

data/rails/init.rb

@@ -0,0 +1,20 @@
+require 'dispatcher'
+Dispatcher.to_prepare :tuneup_route do
+  ActionController::Routing::Routes.add_route '/tuneup', :controller => 'tuneup', :action => 'show'
+  ActionController::Routing::Routes.add_route '/tuneup/:action', :controller => 'tuneup'
+  2.times do
+    route = ActionController::Routing::Routes.routes.pop
+    ActionController::Routing::Routes.routes.unshift(route)
+  end
+end
+Dispatcher.to_prepare :tuneup_controller_filters do
+  TuneupController.filter_chain.clear
+  TuneupController.before_filter :find_config, :except => :index
+end
+[ActionController::Base, ActiveRecord::Base, ActionView::Base].each do |target|
+  target.extend Fiveruns::Tuneup::CustomMethods
+end
+
+ActionController::Base.view_paths.push(File.dirname(__FILE__) << "/../views")
+require File.dirname(__FILE__) << "/../install" # Check for assets
+Fiveruns::Tuneup.start