rails_instrument 0.0.1 → 0.0.2

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+doc

data/lib/rails_instrument/version.rb

@@ -1,3 +1,3 @@
 module RailsInstrument
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/rails_instrument.rb

@@ -1,19 +1,53 @@
 require "rails_instrument/version"
 
 module RailsInstrument
-  class Middleware
+  class <<self
+    # Resets the instrument statistics and counts
+    def reset!
+      $rails_instrument = {}
+    end
+
+    def init #:nodoc:
+      $rails_instrument ||= {}
+      $rails_instrument[:sql_count] ||= 0
+    end
+
+    def data #:nodoc:
+      $rails_instrument
+    end
+
+    # Return the number of sql fired from the last reset
+    def sql_count
+      data[:sql_count]
+    end
+
+    # Taken a block and return the instrument object for the operation done on the block.
+    # TODO: Make it to work with nested instrument blocks
+    def instrument(&block)
+      raise "A block is not passed" unless block_given?
+      RailsInstrument.reset!
+      yield
+      self
+    end
+
+    def increment_sql_count #:nodoc:
+      data[:sql_count] += 1
+    end
+  end
+
+  class Middleware  #:nodoc:
     def initialize(app, options = {})
       @app = app
     end
 
     def call(env)
-      $rails_instrument = {}
+      RailsInstrument.reset!
       status, headers, body = @app.call(env)
       begin
-        headers["X-View-Runtime"] = ($rails_instrument["process_action.action_controller"][:view_runtime] / 1000).to_s
-        headers["X-DB-Runtime"] = ($rails_instrument["process_action.action_controller"][:db_runtime] / 1000).to_s
-        headers["X-DB-Query-Count"] = $rails_instrument[:sql_count].to_s
-      rescue
+        headers["X-View-Runtime"] = (RailsInstrument.data["process_action.action_controller"][:view_runtime] / 1000).to_s
+        headers["X-DB-Runtime"] = (RailsInstrument.data["process_action.action_controller"][:db_runtime] / 1000).to_s
+        headers["X-DB-Query-Count"] = RailsInstrument.sql_count.to_s
+      rescue => e
         # Do nothing
       end
 
@@ -21,19 +55,18 @@ module RailsInstrument
     end
   end
 
-  class Engine < ::Rails::Engine
+  class Engine < ::Rails::Engine  #:nodoc:
     initializer "my_engine.add_middleware" do |app|
       app.middleware.use RailsInstrument::Middleware
 
       ActiveSupport::Notifications.subscribe("process_action.action_controller") do |name, start, finish, id, payload|
-        $rails_instrument ||= {}
+        RailsInstrument.init
         $rails_instrument[name] = payload
       end
 
       ActiveSupport::Notifications.subscribe("sql.active_record") do |name, start, finish, id, payload|
-        $rails_instrument ||= {}
-        $rails_instrument[:sql_count] ||= 0
-        $rails_instrument[:sql_count] += 1 if payload[:name] != "SCHEMA"
+        RailsInstrument.init
+        RailsInstrument.increment_sql_count unless (payload[:name] == "SCHEMA" || %w(BEGIN COMMIT ROLLBACK).include?(payload[:sql]))
       end
     end
   end

data/readme.md

@@ -0,0 +1,31 @@
+# Rails Instrument
+
+This gem is a middleware which add some instrumentation details like db
+runtime, view runtime, numner of sqls fired for each request in the
+response headers.
+
+## Response headers added
+
+* X-View-Runtime
+* X-DB-Runtime
+* X-DB-Query-Count
+
+
+## Installation
+
+Install the latest stable release:
+
+  [sudo] gem install rails_instrument
+
+In Rails >= 3, add it to your Gemfile:
+
+``` ruby
+gem 'carrierwave'
+```
+
+
+## TODO
+* Create chrome extension to show this information inline in the page
+* Add helper methods for tests. Ex: The number of sqls fired can be
+  asserted. - wip
+* Add tests coverage.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_instrument
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-13 00:00:00.000000000Z
+date: 2011-09-15 00:00:00.000000000Z
 dependencies: []
 description: Middleware to show instrumentation information in http headers
 email:
@@ -24,6 +24,7 @@ files:
 - lib/rails_instrument.rb
 - lib/rails_instrument/version.rb
 - rails_instrument.gemspec
+- readme.md
 homepage: https://github.com/selvakn/rails_instrument
 licenses: []
 post_install_message: