bloat_check 0.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in hash_keyword_args.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ronen Barzel
+
+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.

data/README.rdoc

@@ -0,0 +1,74 @@
+= bloat_check
+
+BloatCheck is yet another tool for debugging bloat and memory leaks in ruby
+projects.  This one has the feature that you can wrap any bit of code with
+a "BloatCheck" and it will log elapsed time, and memory & object growth.
+
+Plus you can include it in any rails controller to log that same info per
+request.
+
+== Installation
+
+Gemfile:
+        gem 'bloat_check'
+
+== Usage: Ruby Code
+
+Put this line anywhere:
+
+        BloatCheck.log("some label")
+
+and it will write to the log the current time, process memory size, and 5 ruby
+objects classes with most instances, prefixed with "BLOAT[pid]" and your label.
+
+Wrap it around any existing code, such as
+
+        BloatCheck.log("here's looking at you") do
+            some_suspec_computation()
+            and_more()
+        end
+
+And it will write to the log the deltas: elapsed time, change in memory
+size, and 5 ruby object classes that had the largest increase in number of
+instances.
+
+== Usage: Rails Controllers
+
+In a rails controller, you can do
+
+        class MyController < ApplicationController
+            include BloatCheck::WrapRequests
+
+            # etc.
+        end
+
+and every request will log the deltas incurred during that request.
+
+== Disabling (e.g., when running tests)
+
+BloatCheck is slow (calls system 'ps', and runs through
+ObjectSpace#each_object), so you might want to disable it in your unit
+tests or integration tests.  Do that via:
+
+        BloatCheck.disable = true
+
+Put this, e.g. in your spec/spec_helper.rb file
+
+== Choosing the logger
+
+By default, BloatCheck logs to the Rails logger if Rails is defined, or to
+STDOUT otherwise.  But you can specify your own logger using
+
+        BloatCheck.logger = Logger.new(...)
+
+
+== Versions
+
+Has been tested on MRI 1.9.3
+
+== History
+
+== Copyright
+
+Released under the MIT License.  See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = '-Ispec'
+end

data/bloat_check.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bloat_check/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["ronen barzel"]
+  gem.email         = ["ronen@barzel.org"]
+  gem.description   = %q{Another ruby/rails bloat and memory leak debugging tool.}
+  gem.summary       = %q{Another ruby/rails bloat and memory leak debugging tool.}
+  gem.homepage      = "http://github.com/ronen/blo"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "bloat_check"
+  gem.require_paths = ["lib"]
+  gem.version       = BloatCheck::VERSION
+
+  gem.add_dependency 'key_struct'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'simplecov-gem-adapter'
+end

data/lib/bloat_check.rb

@@ -0,0 +1,42 @@
+require 'bloat_check/version'
+require 'bloat_check/stats'
+require 'bloat_check/wrap_requests'
+
+module BloatCheck
+
+  def self.disabled?
+    return true if @disabled
+  end
+
+  def self.disable=(val)
+    @disabled = val
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.logger
+    return @logger if @logger
+    return Rails.logger if defined? Rails
+    @logger ||= Logger.new(STDERR).tap { |logger|
+      logger.formatter = proc do |severity, datetime, progname, msg|
+        "#{msg}\n"
+      end
+    }
+  end
+
+  def self.log(message)
+    start = Stats.get
+    if block_given?
+      begin
+        ret = yield
+      ensure
+        (Stats.get - start).log(message)
+      end
+      ret
+    else
+      start.log(message)
+    end
+  end
+end

data/lib/bloat_check/stats.rb

@@ -0,0 +1,34 @@
+require 'key_struct'
+
+module BloatCheck
+  class Stats < KeyStruct.reader(:memory, :counts, :time)
+
+    def to_s
+      "TIME=#{time.is_a?(Numeric) ? "#{time.round(1)} sec" : time} MEM=#{memory} OBJ: #{counts.sort_by(&:last).reverse[0...5].map(&it.join('>')).join(' ')}"
+    end
+
+    def log(prefix="")
+      BloatCheck.logger.warn("BLOAT[#{$$}] (#{Time.now}) #{prefix} #{self.to_s}") unless BloatCheck.disabled?
+    end
+
+    def -(other)
+      delta = {}
+      counts.each do |klass, count|
+        delta[klass] = count - other.counts[klass]
+      end
+      Stats.new(:memory => self.memory - other.memory, :counts => delta, :time => self.time - other.time)
+    end
+
+    def self.get 
+      return new(:memory => 0, :counts => {}, :time => 0) if BloatCheck.disabled?
+
+      memory = `ps -o rss= -p #{$$}`.to_i
+      counts = Hash.new(0)
+      ObjectSpace.each_object do |obj|
+        klass = (class << obj ; superclass ; end) # can't use obj.class method since it may be overwritten
+        counts[klass] += 1
+      end
+      self.new(:memory => memory, :counts => counts, :time => Time.now)
+    end
+  end
+end

data/lib/bloat_check/version.rb

@@ -0,0 +1,3 @@
+module BloatCheck
+  VERSION = "0.0.0"
+end

data/lib/bloat_check/wrap_requests.rb

@@ -0,0 +1,18 @@
+module BloatCheck
+  module WrapRequests
+    def self.included(klass)
+      klass.class_eval do
+        before_filter :init_bloat_stats
+        after_filter :dump_bloat_stats
+      end
+    end
+
+    def init_bloat_stats
+      @bloat_start = BloatCheck.stats
+    end
+
+    def dump_bloat_stats
+      (BloatCheck.stats - @bloat_start).log("REQ=#{request.method.inspect} URL=#{request.url.inspect}")
+    end
+  end
+end

data/spec/keyword_args_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe "BloatCheck" do
+
+  it "should have some specs"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+if RUBY_VERSION > "1.9"
+  require 'simplecov'
+  require 'simplecov-gem-adapter'
+  SimpleCov.start 'gem'
+end
+
+require 'rspec'
+require 'bloat_check'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: bloat_check
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- ronen barzel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: key_struct
+  requirement: &70128802826680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70128802826680
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70128802826220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70128802826220
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70128802825780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70128802825780
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70128802825200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70128802825200
+- !ruby/object:Gem::Dependency
+  name: simplecov-gem-adapter
+  requirement: &70128802824700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70128802824700
+description: Another ruby/rails bloat and memory leak debugging tool.
+email:
+- ronen@barzel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- bloat_check.gemspec
+- lib/bloat_check.rb
+- lib/bloat_check/stats.rb
+- lib/bloat_check/version.rb
+- lib/bloat_check/wrap_requests.rb
+- spec/keyword_args_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ronen/blo
+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.12
+signing_key: 
+specification_version: 3
+summary: Another ruby/rails bloat and memory leak debugging tool.
+test_files:
+- spec/keyword_args_spec.rb
+- spec/spec_helper.rb
+has_rdoc: