fiveruns-dash-rails 0.7.8 → 0.8.1

data/README.rdoc

@@ -8,11 +8,11 @@ You'll need a Dash account before using this library.
 
 This library is released as a gem from the official repository at http://github.com/fiveruns/dash-rails
 
-  sudo gem install fiveruns-dash-rails --source 'http://gems.github.com'
+  sudo gem install fiveruns-dash-rails --source http://gems.github.com
 
 == Usage
 
-See the Ruby Language Guide http://dash.fiveruns.com/help/ruby.html for information on how to use this library. 
+See the Dash Ruby support pages http://support.fiveruns.com/faqs/dash/ruby for information on how to use this library. 
 
 == Authors
 
@@ -20,7 +20,8 @@ The FiveRuns Development Team & Dash community
 
 == Dependencies
 
-* The fiveruns-dash-ruby gem (see http://github.com/fiveruns/dash-ruby)
+* The fiveruns-dash-activerecord gem (http://github.com/fiveruns/dash-activerecord)
+* The fiveruns-dash-ruby gem (http://github.com/fiveruns/dash-ruby)
 * The json gem (as a dependency for fiveruns-dash-ruby)
 
 == Verifying your setup
@@ -53,7 +54,7 @@ The best way to contribute is by sending pull requests via GitHub.  The official
 
 Please join the dash-users Google group, http://groups.google.com/group/dash-users
 
-You can also contact us via Twitter, Campfire, or email; see the main help page, http://dash.fiveruns.com/help, for details.
+You can also contact us via Twitter, Campfire, or email; see the main help page, http://support.fiveruns.com, for details.
 
 == License
 

data/Rakefile

@@ -20,19 +20,14 @@ begin
     s.homepage = "http://github.com/fiveruns/dash-rails" 
     s.description = "Provides an API to send metrics from Rails applications to the FiveRuns Dash service" 
     s.authors = ["FiveRuns Development Team"] 
-    s.files =  FileList['README.rdoc', 'Rakefile', 'version.yml', 'init.rb', "{lib,rails,test}/**/*", ] 
-    s.add_dependency 'fiveruns-dash-ruby', '>= 0.7.1' 
+    s.files = FileList['README.rdoc', 'Rakefile', 'VERSION.yml', 'init.rb', "{lib,rails,test}/**/*", ] 
+    s.add_dependency 'fiveruns-dash-ruby', '>= 0.8.1' 
+    s.add_dependency 'fiveruns-dash-activerecord', '>= 0.8.1'
   end 
 rescue LoadError 
   puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com" 
 end
 
-NAME = "dash-rails"
-AUTHOR = "FiveRuns Development Team"
-EMAIL = "dev@fiveruns.com"
-HOMEPAGE = "http://dash.fiveruns.com/"
-SUMMARY = "FiveRuns Dash library for Ruby on Rails"
-
 task :coverage do
   rm_f "coverage"
   rm_f "coverage.data"

data/lib/fiveruns/dash/rails/context/action.rb

@@ -0,0 +1,44 @@
+module Fiveruns::Dash::Rails::Context
+  
+  module Action
+
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+      base.alias_method_chain :perform_action, :fiveruns_dash_context
+      base.extend(ClassMethods)
+      (class << base; self; end).alias_method_chain :process, :fiveruns_dash_tracing
+    end
+
+    module ClassMethods
+
+      def process_with_fiveruns_dash_tracing(*args, &block)
+        operation = lambda { process_without_fiveruns_dash_tracing(*args, &block) }
+        params = args.first.parameters
+        # TODO/FIXME: For now, we simply look for a 'trace' parameter to select requests to trace; in the
+        #             future, we need a more advanced sampling mechanism (some operation in a recipe a
+        #             request must pass, or selection criteria returned in a response from the service)
+        trace_context = ['action', "#{params['controller'].camelize}Controller##{params['action']}"]
+        if ::Fiveruns::Dash.trace_contexts.include?(trace_context)
+          ::Fiveruns::Dash.session.trace(trace_context) do
+            operation.call
+          end
+        else
+          operation.call
+        end
+      end
+
+    end
+
+    module InstanceMethods 
+         
+      def perform_action_with_fiveruns_dash_context(*args, &block)
+        action_name = (request.parameters['action'] || 'index').to_s
+        Fiveruns::Dash::Context.set ['action', %(#{self.class.name}##{action_name})]
+        perform_action_without_fiveruns_dash_context(*args, &block)
+      end
+
+    end
+    
+  end
+
+end

data/lib/fiveruns/dash/rails/context/active_record.rb

@@ -0,0 +1,62 @@
+module Fiveruns::Dash::Rails::Context
+  
+  module ActiveRecord
+    
+    def self.included(base)
+      class << base
+        Fiveruns::Dash::ActiveRecord::CLASS_METHODS.each do |meth|
+          head = meth
+          tail = ''
+          head, tail = meth[0..(meth.length-2)], meth[-1..-1] if %w(? !).include? meth[-1..-1]
+          self.class_eval <<-EOM
+            def #{head}_with_dash_context#{tail}(*args, &block)
+              Fiveruns::Dash::Rails::Context::ActiveRecord.with_model_context(self.name) do
+                #{head}_without_dash_context#{tail}(*args, &block)
+              end
+            end
+          EOM
+          alias_method_chain(meth.to_sym, :dash_context)
+        end
+      end
+
+      Fiveruns::Dash::ActiveRecord::INSTANCE_METHODS.each do |meth|
+        head = meth
+        tail = ''
+        head, tail = meth[0..meth.length-2], meth[-1..-1] if %w(? !).include? meth[-1..-1]
+        base.class_eval <<-EOM
+          def #{head}_with_dash_context#{tail}(*args, &block)
+            Fiveruns::Dash::Rails::Context::ActiveRecord.with_model_context(self.class.name) do
+              #{head}_without_dash_context#{tail}(*args, &block)
+            end
+          end
+        EOM
+        base.alias_method_chain(meth.to_sym, :dash_context)
+      end
+    end
+
+    def self.with_model_context(model_name)
+      context = Fiveruns::Dash::Context.context
+      # don't change context if model context has already been set.
+      if context.size > 0 && context[-2] == 'model' && context[-1] == model_name
+        return yield
+      end
+
+      original_context = Fiveruns::Dash::Context.context.dup
+      begin
+        if context[-2] == 'model'
+          # Some models will internally load other models.
+          Fiveruns::Dash::Context.context.pop
+          Fiveruns::Dash::Context.context << model_name
+        else
+          Fiveruns::Dash::Context.context << 'model'
+          Fiveruns::Dash::Context.context << model_name
+        end
+        return yield
+      ensure
+        Fiveruns::Dash::Context.set original_context
+      end
+    end
+    
+  end
+      
+end

data/lib/fiveruns/dash/rails/context/template.rb

@@ -0,0 +1,57 @@
+module Fiveruns::Dash::Rails::Context
+  
+  module Template
+  
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+      base.alias_method_chain(:render, :fiveruns_dash_context)
+    end
+  
+    RAILS_ROOT_RE = /\A#{Regexp.quote RAILS_ROOT}/
+
+    GEM_REs = Gem.path.map do |path|
+      /\A#{Regexp.quote path}\/gems/
+    end
+  
+    def self.sanitize_view_path(path)
+      path = if path[0..0] == '/'
+        if path =~ RAILS_ROOT_RE
+          trimmed = path.sub(RAILS_ROOT_RE, 'RAILS_ROOT')
+          trimmed
+        elsif (re = GEM_REs.find { |re| path =~ re })
+          trimmed = path.sub(re, 'GEMS')
+        else
+          path
+        end
+      else
+        path
+      end
+      # Remove extensions, if any
+      path.sub(/\.[^\/\\]*$/, '')
+    end
+
+    module InstanceMethods
+    
+      def render_with_fiveruns_dash_context(*args, &block)
+        original_context = Fiveruns::Dash::Context.context.dup
+      
+        begin
+          Fiveruns::Dash::Context.context << 'view'
+          if respond_to?(:path)
+            Fiveruns::Dash::Context.context << Fiveruns::Dash::Rails::Context::Template.sanitize_view_path(path)
+          else
+            Fiveruns::Dash::Context.context << '(inline)'
+          end
+          result = render_without_fiveruns_dash_context(*args, &block)
+        ensure
+          Fiveruns::Dash::Context.set original_context
+        end
+      
+        result
+      end
+    
+    end
+    
+  end
+  
+end

data/lib/fiveruns/dash/rails/initializer.rb

@@ -0,0 +1,17 @@
+module Fiveruns::Dash::Rails::Initializer
+  
+  def self.included(base)
+    base.send(:include, InstanceMethods)
+    base.alias_method_chain :prepare_dispatcher, :dash
+  end
+  
+  module InstanceMethods
+    
+    def prepare_dispatcher_with_dash
+      prepare_dispatcher_without_dash
+      Fiveruns::Dash::Rails.dash_start_block.call
+    end
+    
+  end
+  
+end

data/lib/fiveruns/dash/rails.rb

@@ -1,4 +1,3 @@
-require File.dirname(__FILE__) << "/rails/version"
 require File.dirname(__FILE__) << "/rails/startup"
 
 if START_FIVERUNS_DASH_RAILS
@@ -7,10 +6,29 @@ if START_FIVERUNS_DASH_RAILS
     module Dash
     
       module Rails
+        
+        version_file = File.dirname(__FILE__) << "/../../../VERSION.yml"
+        version = YAML.load(version_file)
+        VERSION = [
+          version[:major],
+          version[:minor],
+          version[:patch]
+        ].map(&:to_s).join('.')
       
         class << self
           attr_accessor :server
         end
+        
+        def self.clean_hash(obj = {})
+          (obj || {}).keys.inject({}) do |all, key|
+            val = obj[key]
+            if val.is_a?(Hash)
+              val = clean(val)
+            end
+            all[key.to_s] = val
+            all
+          end
+        end
       
         def self.queue_size
           return 0 unless server_type
@@ -50,7 +68,6 @@ if START_FIVERUNS_DASH_RAILS
           store_dash_start_block do 
             configure(tokens, &block) unless tokens.empty?
             if Fiveruns::Dash.configuration.ready?
-              RAILS_DEFAULT_LOGGER.info "Starting Dash"
               Fiveruns::Dash.session.start 
             else
               log_error unless env == 'development'
@@ -79,14 +96,14 @@ if START_FIVERUNS_DASH_RAILS
         def self.log_error
           # TODO: Add URL for help
           message =<<-EOM
-  FiveRuns Dash [Rails] (v#{Version::STRING}) Application token missing
+  FiveRuns Dash [Rails] (v#{VERSION}) Application token missing
     ===
-    In config/initializers/dash.rb or at the bottom of config/environment.rb, please add:
+    In config/initializers/dash.rb please add:
 
-      Fiveruns::Dash::Rails.configure :#{env} => 'YOUR-#{env.upcase}-ENV-APP-TOKEN-HERE'
+      Fiveruns::Dash::Rails.start :#{env} => '#{env.upcase}-APP-TOKEN'
 
     You can also set app tokens for other environments (eg, staging), at the same time.
-    See http://todo/path/to/help for more information
+    See http://support.fiveruns.com/faqs/dash/rails for more information
     ===
           EOM
           RAILS_DEFAULT_LOGGER.warn(message.strip)
@@ -157,65 +174,6 @@ if START_FIVERUNS_DASH_RAILS
           end
         end
         
-        module ActionContext
-      
-          def self.included(base)
-            base.send(:include, InstanceMethods)
-            base.alias_method_chain :perform_action, :fiveruns_dash_context
-            base.extend(ClassMethods)
-            (class << base; self; end).alias_method_chain :process, :fiveruns_dash_tracing
-          end
-        
-          module ClassMethods
-        
-            def process_with_fiveruns_dash_tracing(*args, &block)
-              operation = lambda { process_without_fiveruns_dash_tracing(*args, &block) }
-              params = args.first.parameters
-              # TODO/FIXME: For now, we simply look for a 'trace' parameter to select requests to trace; in the
-              #             future, we need a more advanced sampling mechanism (some operation in a recipe a
-              #             request must pass, or selection criteria returned in a response from the service)
-              trace_context = ['action', "#{params['controller'].camelize}Controller##{params['action']}"]
-              if ::Fiveruns::Dash.trace_contexts.include?(trace_context)
-                ::Fiveruns::Dash.session.trace(trace_context) do
-                  operation.call
-                end
-              else
-                operation.call
-              end
-            end
-        
-          end
-      
-          module InstanceMethods 
-                    
-            def perform_action_with_fiveruns_dash_context(*args, &block)
-              action_name = (request.parameters['action'] || 'index').to_s
-              Fiveruns::Dash::Context.set ['action', %(#{self.class.name}##{action_name})]
-              perform_action_without_fiveruns_dash_context(*args, &block)
-            end
-        
-          end
-      
-        end
-        
-        module Initializer
-          
-          def self.included(base)
-            base.send(:include, InstanceMethods)
-            base.alias_method_chain :prepare_dispatcher, :dash
-          end
-          
-          module InstanceMethods
-            
-            def prepare_dispatcher_with_dash
-              prepare_dispatcher_without_dash
-              Fiveruns::Dash::Rails.dash_start_block.call
-            end
-            
-          end
-          
-        end
-        
       end 
       
     end

data/lib/fiveruns/dash/recipes/actionpack.rb

@@ -0,0 +1,15 @@
+Fiveruns::Dash.register_recipe :actionpack, :url => 'http://dash.fiveruns.com' do |recipe|
+  
+  recipe.time :response_time, :method => 'ActionController::Base#perform_action', :mark => true
+  recipe.counter :requests, 'Requests', :incremented_by => 'ActionController::Base#perform_action'
+  
+  targets = []
+  targets << 'ActionView::Template#render' if defined?(ActionView::Template)
+  targets << 'ActionView::PartialTemplate#render' if defined?(ActionView::PartialTemplate)
+  if !targets.empty?
+    recipe.time :render_time, :method => targets
+  else
+    Fiveruns::Dash.logger.warn 'Collection of "render_time" unsupported for this version of Rails'
+  end
+  
+end

data/lib/fiveruns/dash/recipes/rails.rb

@@ -1,36 +1,17 @@
-module Fiveruns::Dash::Rails::Hash
+# Rails #######################################################################
+Fiveruns::Dash.register_recipe :rails, :url => 'http://dash.fiveruns.com' do |recipe|
   
-  def self.clean(extended_hash = {})
-    (extended_hash || {}).keys.inject({}) do |all, key|
-      val = extended_hash[key]
-      if val.kind_of? Hash
-        val = clean(val)
+  recipe.add_recipe :activerecord, :url => 'http://dash.fiveruns.com',
+                    :total_time => 'response_time'
+  recipe.modify :recipe_name => :activerecord, :recipe_url => 'http://dash.fiveruns.com' do |metric|
+    metric.find_context_with do |obj, *args|
+      if Fiveruns::Dash::Context.context == []
+        []
+      else
+        [[], Fiveruns::Dash::Context.context]
       end
-      all[key.to_s] = val
-      all
     end
   end
-  
-end
-
-# ActionPack ##################################################################
-Fiveruns::Dash.register_recipe :actionpack, :url => 'http://dash.fiveruns.com' do |recipe|
-  recipe.time :response_time, :method => 'ActionController::Base#perform_action', :mark => true
-  recipe.counter :requests, 'Requests', :incremented_by => 'ActionController::Base#perform_action'
-  
-  targets = []
-  targets << 'ActionView::Template#render' if defined?(ActionView::Template)
-  targets << 'ActionView::PartialTemplate#render' if defined?(ActionView::PartialTemplate)
-  if !targets.empty?
-    recipe.time :render_time, :method => targets
-  else
-    Fiveruns::Dash.logger.warn 'Collection of "render_time" unsupported for this version of Rails'
-  end
-end
-
-# Rails #######################################################################
-Fiveruns::Dash.register_recipe :rails, :url => 'http://dash.fiveruns.com' do |recipe|  
-  recipe.add_recipe :activerecord, :url => 'http://dash.fiveruns.com'
 
   recipe.add_recipe :actionpack, :url => 'http://dash.fiveruns.com'
   recipe.modify :recipe_name => :actionpack, :recipe_url => 'http://dash.fiveruns.com' do |metric|
@@ -49,21 +30,21 @@ Fiveruns::Dash.register_recipe :rails, :url => 'http://dash.fiveruns.com' do |re
     info = {:name => "#{ex.class.name} in #{controller.class.name}##{controller.params[:action]}"}
     begin
       session_data = controller.request.session.instance_variable_get("@data")
-      info[:session] = Fiveruns::Dash::Rails::Hash.clean(session_data).to_json
+      info[:session] = Fiveruns::Dash::Rails.clean_hash(session_data).to_json
     rescue Exception => e
       Fiveruns::Dash.logger.warn "Could not dump session data for exception: #{e.message}"
       nil
     end
     begin
       request_data = { :url => controller.request.url, :params => controller.params.inspect }
-      info[:request] = Fiveruns::Dash::Rails::Hash.clean(request_data).to_json
+      info[:request] = Fiveruns::Dash::Rails.clean_hash(request_data).to_json
     rescue Exception => e 
       Fiveruns::Dash.logger.error "Could not dump request data for exception: #{e.message}"
       nil
     end
     begin
       header_data = controller.request.headers
-      info[:headers] = Fiveruns::Dash::Rails::Hash.clean(header_data).to_json
+      info[:headers] = Fiveruns::Dash::Rails.clean_hash(header_data).to_json
     rescue Exception => e 
       Fiveruns::Dash.logger.error "Could not dump header data for exception: #{e.message}"
       nil
@@ -72,17 +53,21 @@ Fiveruns::Dash.register_recipe :rails, :url => 'http://dash.fiveruns.com' do |re
   end
   
   # Same classes as the exception_notification plugin
-  IGNORE = [ActiveRecord::RecordNotFound, ActionController::RoutingError, ActionController::UnknownController, ActionController::UnknownAction]
-
-  recipe.ignore_exceptions do |exc|
-    IGNORE.include? exc.class
+  recipe.ignore_exceptions do |exception|
+    [ ActiveRecord::RecordNotFound,
+      ActionController::RoutingError,
+      ActionController::UnknownController,
+      ActionController::UnknownAction
+    ].include?(exception.class)
   end
 
   recipe.added do
-    ActionController::Base.send(:include, Fiveruns::Dash::Rails::ActionContext)
-    ActionView::Template.send(:include, Fiveruns::Dash::Rails::TemplateContext) if defined?(ActionView::Template)
-    ActionView::InlineTemplate.send(:include, Fiveruns::Dash::Rails::TemplateContext) if defined?(ActionView::InlineTemplate)
-    ActionView::PartialTemplate.send(:include, Fiveruns::Dash::Rails::TemplateContext) if defined?(ActionView::PartialTemplate)
+    
+    ActiveRecord::Base.send(:include, Fiveruns::Dash::Rails::Context::ActiveRecord)
+    ActionController::Base.send(:include, Fiveruns::Dash::Rails::Context::Action)
+    ActionView::Template.send(:include, Fiveruns::Dash::Rails::Context::Template) if defined?(ActionView::Template)
+    ActionView::InlineTemplate.send(:include, Fiveruns::Dash::Rails::Context::Template) if defined?(ActionView::InlineTemplate)
+    ActionView::PartialTemplate.send(:include, Fiveruns::Dash::Rails::Context::Template) if defined?(ActionView::PartialTemplate)
 
     begin
       if defined?(Mongrel)
@@ -105,19 +90,23 @@ Fiveruns::Dash.register_recipe :rails, :url => 'http://dash.fiveruns.com' do |re
       end
     end
 
-    # Passenger forks the Rails processes, which has the side effect of
-    # killing our reporter thread.  We need to revive the thread.
-    class ActionController::Base
-      def perform_action_with_dash_startup(*args, &block)
+    if defined?(Passenger)
+      # Passenger forks the Rails processes, which has the side effect of
+      # killing our reporter thread.  We need to revive the thread.
+      class ActionController::Base
+        def perform_action_with_dash_startup(*args, &block)
+          Fiveruns::Dash.session.reporter.revive!
+          perform_action_without_dash_startup(*args, &block)
+        end
+
+        alias_method_chain :perform_action, :dash_startup
+      end
+    elsif defined?(PhusionPassenger)
+      # Passenger 2.1+ has an event to handle this gracefully
+      PhusionPassenger.on_event(:starting_worker_process) do
         Fiveruns::Dash.session.reporter.revive!
-        perform_action_without_dash_startup(*args, &block)
       end
-
-      alias_method_chain :perform_action, :dash_startup
     end
   end
   
-  recipe.absolute :queue_size do
-    Fiveruns::Dash::Rails.queue_size || 0
-  end
 end

data/lib/fiveruns-dash-rails.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) << "/fiveruns/dash/rails/startup"
+
+if START_FIVERUNS_DASH_RAILS
+  gem 'fiveruns-dash-ruby' # Put its path first
+  require 'fiveruns/dash'
+  begin
+    require 'fiveruns/dash/activerecord'
+  rescue LoadError
+    abort "Missing the `activerecord' recipe. Please install the fiveruns-dash-activerecord gem"
+  end
+  require 'fiveruns/dash/rails'
+  require 'fiveruns/dash/rails/initializer'
+  require 'fiveruns/dash/rails/context/action'
+  require 'fiveruns/dash/rails/context/active_record'
+  require 'fiveruns/dash/rails/context/template'
+  require File.dirname(__FILE__) << "/../rails/init"  
+end

data/lib/fiveruns_dash_rails.rb

@@ -1,9 +1,2 @@
-require File.dirname(__FILE__) << "/fiveruns/dash/rails/startup"
-
-if START_FIVERUNS_DASH_RAILS
-  gem 'fiveruns-dash-ruby' # Put its path first
-  require 'fiveruns/dash'
-  require 'fiveruns/dash/rails'
-  require 'fiveruns/dash/template_context'
-  require File.dirname(__FILE__) << "/../rails/init"  
-end
+# Stub for backwards compatibility
+require File.dirname(__FILE__) << "/fiveruns-dash-rails"

data/rails/init.rb

@@ -20,7 +20,7 @@ end
 
 if START_FIVERUNS_DASH_RAILS
 
-  require 'fiveruns_dash_rails'
+  require 'fiveruns-dash-rails'
   Fiveruns::Dash.logger = RAILS_DEFAULT_LOGGER
   Fiveruns::Dash::Rails.load_recipes
   Fiveruns::Dash.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fiveruns-dash-rails
 version: !ruby/object:Gem::Version 
-  version: 0.7.8
+  version: 0.8.1
 platform: ruby
 authors: 
 - FiveRuns Development Team
@@ -9,17 +9,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-11 00:00:00 -08:00
+date: 2009-02-20 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: fiveruns-dash-ruby
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.7.1
+        version: 0.8.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fiveruns-dash-activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
     version: 
 description: Provides an API to send metrics from Rails applications to the FiveRuns Dash service
 email: dev@fiveruns.com
@@ -32,22 +43,24 @@ extra_rdoc_files: []
 files: 
 - README.rdoc
 - Rakefile
-- version.yml
+- VERSION.yml
 - init.rb
 - lib/fiveruns
 - lib/fiveruns/dash
 - lib/fiveruns/dash/rails
+- lib/fiveruns/dash/rails/context
+- lib/fiveruns/dash/rails/context/action.rb
+- lib/fiveruns/dash/rails/context/active_record.rb
+- lib/fiveruns/dash/rails/context/template.rb
+- lib/fiveruns/dash/rails/initializer.rb
 - lib/fiveruns/dash/rails/startup.rb
-- lib/fiveruns/dash/rails/version.rb
 - lib/fiveruns/dash/rails.rb
 - lib/fiveruns/dash/recipes
-- lib/fiveruns/dash/recipes/activerecord.rb
+- lib/fiveruns/dash/recipes/actionpack.rb
 - lib/fiveruns/dash/recipes/rails.rb
-- lib/fiveruns/dash/template_context.rb
+- lib/fiveruns-dash-rails.rb
 - lib/fiveruns_dash_rails.rb
 - rails/init.rb
-- test/activerecord_test.rb
-- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/fiveruns/dash-rails
 post_install_message: 

data/lib/fiveruns/dash/rails/version.rb

@@ -1,97 +0,0 @@
-# (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 Dash
-    
-    module Rails
-    
-      # 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
-        
-        # Borrowed from TuneUp
-        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
-
-        PARSED = YAML.load(File.read(File.dirname(__FILE__) << "/../../../../version.yml"))
-
-        MAJOR = PARSED[:major]
-        MINOR = PARSED[:minor]
-        TINY  = PARSED[:patch]
-
-        # 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
-  
-end

data/lib/fiveruns/dash/recipes/activerecord.rb

@@ -1,96 +0,0 @@
-module Fiveruns::Dash::ActiveRecordContext
-  CLASS_METHODS = %w(find find_by_sql calculate create create! update_all destroy destroy_all delete delete_all)
-  INSTANCE_METHODS = %w(update save save! destroy)
-
-  def self.included(base)
-    class << base
-      CLASS_METHODS.each do |meth|
-        head = meth
-        tail = ''
-        head, tail = meth[0..(meth.length-2)], meth[-1..-1] if %w(? !).include? meth[-1..-1]
-        self.class_eval <<-EOM
-          def #{head}_with_dash_context#{tail}(*args, &block)
-            Fiveruns::Dash::ActiveRecordContext.with_model_context(self.name) do
-              #{head}_without_dash_context#{tail}(*args, &block)
-            end
-          end
-        EOM
-        alias_method_chain(meth.to_sym, :dash_context)
-      end
-    end
-
-    INSTANCE_METHODS.each do |meth|
-      head = meth
-      tail = ''
-      head, tail = meth[0..meth.length-2], meth[-1..-1] if %w(? !).include? meth[-1..-1]
-      base.class_eval <<-EOM
-        def #{head}_with_dash_context#{tail}(*args, &block)
-          Fiveruns::Dash::ActiveRecordContext.with_model_context(self.class.name) do
-            #{head}_without_dash_context#{tail}(*args, &block)
-          end
-        end
-      EOM
-      base.alias_method_chain(meth.to_sym, :dash_context)
-    end
-  end
-
-  def self.with_model_context(model_name)
-    ctx = Fiveruns::Dash::Context.context
-    # don't change context if model context has already been set.
-    return yield if ctx.size > 0 && ctx[-2] == 'model' && ctx[-1] == model_name
-
-    original_context = Fiveruns::Dash::Context.context.dup
-    begin
-      if ctx[-2] == 'model'
-        # Some models will internally load other models.
-        Fiveruns::Dash::Context.context.pop
-        Fiveruns::Dash::Context.context << model_name
-      else
-        Fiveruns::Dash::Context.context << 'model'
-        Fiveruns::Dash::Context.context << model_name
-      end
-      return yield
-    ensure
-      Fiveruns::Dash::Context.set original_context
-    end
-  end
-  
-  def self.all_methods
-    CLASS_METHODS.map { |m| "ActiveRecord::Base.#{m}" } + INSTANCE_METHODS.map { |m| "ActiveRecord::Base##{m}"}
-  end
-  
-end
-
-# ActiveRecord ################################################################
-
-Fiveruns::Dash.register_recipe :activerecord, :url => 'http://dash.fiveruns.com' do |recipe|
-  # We need a way to get the total time for a request/operation so that we can
-  # calculate the relative percentage used by AR/DB.  Default to "response_time" for the Rails
-  # recipe but daemons can set this constant to provide their own total time metric.
-  total_time = recipe.options[:ar_total_time] ? recipe.options[:ar_total_time] : "response_time"
-
-  recipe.time :ar_time, 'ActiveRecord Time', :methods => Fiveruns::Dash::ActiveRecordContext.all_methods, :reentrant => true, :only_within => total_time
-  recipe.time :db_time, 'Database Time', :methods => %w(ActiveRecord::ConnectionAdapters::AbstractAdapter#log), :only_within => total_time
-
-  recipe.percentage :ar_util, 'ActiveRecord Utilization', :sources => ["ar_time", total_time] do |ar_time, all_time|
-    all_time == 0 ? 0 : (ar_time / all_time) * 100.0
-  end
-  recipe.percentage :db_util, 'Database Utilization', :sources => ["db_time", total_time] do |db_time, all_time|
-    all_time == 0 ? 0 : (db_time / all_time) * 100.0
-  end
-
-  recipe.modify :recipe_name => :activerecord, :recipe_url => 'http://dash.fiveruns.com' do |metric|
-    metric.find_context_with do |obj, *args|
-      if Fiveruns::Dash::Context.context == []
-        []
-      else
-        [[], Fiveruns::Dash::Context.context]
-      end
-    end
-  end
-
-  recipe.added do
-    ActiveRecord::Base.send(:include, Fiveruns::Dash::ActiveRecordContext)
-  end
-end
-

data/lib/fiveruns/dash/template_context.rb

@@ -1,54 +0,0 @@
-
-module Fiveruns::Dash::Rails::TemplateContext
-  
-  def self.included(base)
-    base.send(:include, InstanceMethods)
-    base.alias_method_chain(:render, :fiveruns_dash_context)
-  end
-  
-  RAILS_ROOT_RE = /\A#{Regexp.quote RAILS_ROOT}/
-
-  GEM_REs = Gem.path.map do |path|
-    /\A#{Regexp.quote path}\/gems/
-  end
-  
-  def self.sanitize_view_path(path)
-    path = if path[0..0] == '/'
-      if path =~ RAILS_ROOT_RE
-        trimmed = path.sub(RAILS_ROOT_RE, 'RAILS_ROOT')
-        trimmed
-      elsif (re = GEM_REs.find { |re| path =~ re })
-        trimmed = path.sub(re, 'GEMS')
-      else
-        path
-      end
-    else
-      path
-    end
-    # Remove extensions, if any
-    path.sub(/\.[^\/\\]*$/, '')
-  end
-
-  module InstanceMethods
-    
-    def render_with_fiveruns_dash_context(*args, &block)
-      original_context = Fiveruns::Dash::Context.context.dup
-      
-      begin
-        Fiveruns::Dash::Context.context << 'view'
-        if respond_to?(:path)
-          Fiveruns::Dash::Context.context << Fiveruns::Dash::Rails::TemplateContext.sanitize_view_path(path)
-        else
-          Fiveruns::Dash::Context.context << '(inline)'
-        end
-        result = render_without_fiveruns_dash_context(*args, &block)
-      ensure
-        Fiveruns::Dash::Context.set original_context
-      end
-      
-      result
-    end
-    
-  end
-  
-end

data/test/activerecord_test.rb

@@ -1,113 +0,0 @@
-require File.dirname(__FILE__) << "/test_helper"
-
-class ActiverecordTest < Test::Unit::TestCase
-
-  class TestModel < ActiveRecord::Base
-  end
-
-  class TestEngine
-    def doit
-      sleep 1
-      2.times do
-        t = TestModel.create!(:name => 'foo')
-        t.destroy
-      end
-    end
-
-    def conn
-      TestModel.connection.execute("select sleep(1)")
-    end
-
-    def entry(meth)
-      send(meth)
-    end
-  end
-  
-
-  context "Metric" do
-    
-    setup do
-      ActiveRecord::Base.configurations = { 'test' => { 'database' => 'test', 'adapter' => 'mysql', 'user' => 'root', 'hostname' => 'localhost' }}
-      ActiveRecord::Base.establish_connection
-      ActiveRecord::Base.connection.execute("create table if not exists test_models (id integer PRIMARY KEY, name varchar(32) not null)")
-      ActiveRecord::Base.connection.execute("delete from test_models")
-    end
-
-    should "collect basic AR metrics" do
-      ar_scenario do
-        TestEngine.new.entry(:doit)
-
-        data = Fiveruns::Dash.session.data
-        # data.each do |hsh|
-        #   puts "#{hsh[:name]}: #{hsh[:values].inspect}"
-        # end
-
-        assert metric('test_time', data) > 1.0
-        assert metric('ar_util', data) > metric('db_util', data)
-        assert metric('db_util', data) < 5
-      end
-    end
-
-    should "collect DB metrics" do
-      ar_scenario do
-        TestEngine.new.entry(:conn)
-        
-        data = Fiveruns::Dash.session.data
-        # data.each do |hsh|
-        #   puts "#{hsh[:name]}: #{hsh[:values].inspect}"
-        # end
-
-        assert metric('test_time', data) > 1.0
-        assert metric('test_time', data) < 1.1
-        assert metric('db_time', data) > 1.0
-        assert metric('db_time', data) < 1.1
-        assert metric('db_util', data) > 90.0
-        assert metric('db_util', data) < 100.0
-      end
-    end
-  end
-
-  def ar_scenario(&block)
-    child = fork do
-      mock_activerecord!
-      yield
-    end
-    Process.wait
-    assert_equal 0, $?.exitstatus
-  end
-
-  def metric(metric, data, in_ctx=[])
-    hsh = data.detect { |hsh| hsh[:name] == metric }
-    assert hsh, "No metric named #{metric} was found in metrics payload"
-    vals = hsh[:values]
-    assert vals, "No values found for #{metric} in metrics payload"
-    val = vals.detect { |val| val[:context] == in_ctx }
-    assert val, "No value for #{metric} found for context #{in_ctx.inspect}"
-    val[:value]
-  end
-
-  def mock_activerecord!
-    require 'fiveruns/dash'
-    require 'fiveruns/dash/recipes/activerecord'
-
-    eval <<-MOCK
-      module Fiveruns::Dash
-        class Reporter
-          private
-          def run
-          end
-        end
-      end
-    MOCK
-
-    Fiveruns::Dash.register_recipe :tester, :url => 'http://dash.fiveruns.com' do |recipe|
-      recipe.time :test_time, 'Test Time', :method => 'ActiverecordTest::TestEngine#entry'
-    end
-    Fiveruns::Dash.configure :app => '666', :ar_total_time => 'test_time' do |config|
-      config.add_recipe :ruby
-      config.add_recipe :activerecord
-      config.add_recipe :tester
-    end
-    Fiveruns::Dash.session.start(true)
-  end
-end

data/test/test_helper.rb

@@ -1,30 +0,0 @@
-RAILS_ENV='test'
-RAILS_ROOT=File.dirname(__FILE__)
-require 'test/unit'
-require 'logger'
-require 'rubygems'
-
-begin
-  require 'shoulda'
-  require 'flexmock/test_unit'
-  require 'fake_web'
-rescue
-  puts "Please install the Shoulda, FakeWeb and flexmock gems to run the Dash plugin tests."
-end
-
-require 'shoulda'
-require 'flexmock/test_unit'
-
-RAILS_DEFAULT_LOGGER=Logger.new(STDOUT)
-require 'active_record'
-require 'action_controller'
-require 'action_controller/test_process'
-require 'action_controller/test_case'
-require 'action_view'
-
-$:.unshift(File.dirname(__FILE__) << '/../lib')
-$:.unshift(File.dirname(__FILE__) << '/../../fiveruns_dash/lib')
-
-class Test::Unit::TestCase
-
-end

data/version.yml

@@ -1,4 +0,0 @@
---- 
-:major: 0
-:minor: 7
-:patch: 8