active-record-instance-count 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in active-record-instance-count.gemspec
+gemspec

data/README.md

@@ -0,0 +1,29 @@
+# ActiveRecordInstanceCount
+
+Rack middleware to log the number of instantiated ActiveRecord models in a request. Helpful to see how many objects you're instantiating. First step to recognize you have a problem.
+
+Logs a message like:
+
+```
+Instantiation Breakdown: Total: 3 | UserSession: 1 | User: 1 | UserDevice: 1
+```
+
+## Installation
+
+Add to your `Gemfile`:
+
+```
+gem 'active-record-instance-count'
+```
+
+Then provide an initializer, like `config/initializers/active_record_instance_counter.rb`:
+
+```
+YourApp::Application.middleware.use( ActiveRecordInstanceCount::Middleware, :logger => Rails.logger )
+```
+
+Provide a different `Logger` instance if you would like to redirect the output somewhere else. But keep in mind that no more context will be provided (e.g. the request details) so it might be fairly useless.
+
+## Credits
+
+_Heavily_ inspired from [Oink](https://github.com/noahd1/oink)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/active-record-instance-count.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "active-record-instance-count/version"
+
+Gem::Specification.new do |s|
+  s.name        = "active-record-instance-count"
+  s.version     = ActiveRecordInstanceCount::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cody Caughlan"]
+  s.email       = ["toolbag@gmail.com"]
+  s.homepage    = ""
+  s.summary     = "Rack middleware to write the number of instantiated ActiveRecord models to a log"
+  s.description = s.summary
+
+  #s.rubyforge_project = "active-record-instance-count"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/active-record-instance-count.rb

@@ -0,0 +1,36 @@
+require "active-record-instance-count/version"
+require "active-record-instance-count/utils/hash_utils"
+require "active-record-instance-count/instrumentation"
+
+module ActiveRecordInstanceCount
+  class Middleware
+    def initialize(app, options = {})
+      @app         = app
+      unless options[:logger]
+        raise 'Missing options[:logger] argument'
+      end
+      @logger      = options[:logger]
+      ActiveRecord::Base.send(:include, ActiveRecordInstanceCount::Instrumentation::ActiveRecord) 
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      log_activerecord
+      [status, headers, body]
+    end
+
+    def log_activerecord
+      sorted_list = ActiveRecordInstanceCount::HashUtils.to_sorted_array(ActiveRecord::Base.instantiated_hash)
+      sorted_list.unshift("Total: #{ActiveRecord::Base.total_objects_instantiated}")
+      @logger.info("Instantiation Breakdown: #{sorted_list.join(' | ')}")
+      reset_objects_instantiated
+    end
+    
+    private
+    
+    def reset_objects_instantiated
+      ActiveRecord::Base.reset_instance_type_count
+    end
+    
+  end
+end

data/lib/active-record-instance-count/instrumentation.rb

@@ -0,0 +1 @@
+require "active-record-instance-count/instrumentation/active_record"

data/lib/active-record-instance-count/instrumentation/active_record.rb

@@ -0,0 +1,63 @@
+module ActiveRecordInstanceCount
+
+  def self.extended_active_record?
+    @_extended_active_record
+  end
+
+  def self.extended_active_record!
+    @_extended_active_record = true
+  end
+
+  module Instrumentation
+    module ActiveRecord
+
+      def self.included(klass)
+        klass.class_eval do
+
+          @@instantiated = {}
+          @@total = nil
+
+          def self.reset_instance_type_count
+            @@instantiated = {}
+            @@total = nil
+          end
+
+          def self.increment_instance_type_count
+            @@instantiated[base_class.name] ||= 0
+            @@instantiated[base_class.name] += 1
+          end
+
+          def self.instantiated_hash
+            @@instantiated
+          end
+
+          def self.total_objects_instantiated
+            @@total ||= @@instantiated.values.sum
+          end
+
+          unless ActiveRecordInstanceCount.extended_active_record?
+            class << self
+              alias_method :allocate_before_counter, :allocate
+
+              def allocate
+                value = allocate_before_counter
+                increment_instance_type_count
+                value
+              end
+            end
+
+            alias_method :initialize_before_counter, :initialize
+
+            def initialize(*args, &block)
+              value = initialize_before_counter(*args, &block)
+              self.class.increment_instance_type_count
+              value
+            end
+
+            ActiveRecordInstanceCount.extended_active_record!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active-record-instance-count/utils/hash_utils.rb

@@ -0,0 +1,9 @@
+module ActiveRecordInstanceCount
+  module HashUtils
+
+    def self.to_sorted_array(hsh)
+      hsh.sort{ |a, b| b[1] <=>a [1] }.collect { |k,v| "#{k}: #{v}" }
+    end
+
+  end
+end

data/lib/active-record-instance-count/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordInstanceCount
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: active-record-instance-count
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cody Caughlan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-01 00:00:00.000000000Z
+dependencies: []
+description: Rack middleware to write the number of instantiated ActiveRecord models
+  to a log
+email:
+- toolbag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- active-record-instance-count.gemspec
+- lib/active-record-instance-count.rb
+- lib/active-record-instance-count/instrumentation.rb
+- lib/active-record-instance-count/instrumentation/active_record.rb
+- lib/active-record-instance-count/utils/hash_utils.rb
+- lib/active-record-instance-count/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Rack middleware to write the number of instantiated ActiveRecord models to
+  a log
+test_files: []