method_profiler 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 by Jimmy Cuadra
+
+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.md

@@ -0,0 +1,19 @@
+# MethodProfiler
+
+**MethodProfiler** collects performance information about the methods in your objects and creates reports to help you identify slow methods.
+
+```ruby
+profiler = MethodProfiler.new(MyClass)
+MyClass.new.foo
+puts profiler.report
+
+# MethodProfiler results for:
+# MyClass
+# +--------+--------------+-------------+
+# | Method | Average Time | Total Calls |
+# +--------+--------------+-------------+
+# | foo    | 91.037000 ms | 1           |
+# | bar    | 15.016000 ms | 2           |
+# | baz    | 23.005000 ms | 1           |
+# +--------+--------------+-------------+
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run specs"
+RSpec::Core::RakeTask.new { |t| t.rspec_opts = "--color" }
+
+task :default => :spec

data/lib/method_profiler.rb

@@ -0,0 +1,84 @@
+require 'benchmark'
+require 'hirb'
+
+class MethodProfiler
+  attr_reader :observed_methods, :data
+
+  def initialize(obj)
+    @obj = obj
+    initialize_data
+    find_obj_methods
+    wrap_methods_with_profiling
+  end
+
+  def profile(method, &block)
+    result = nil
+    benchmark = Benchmark.measure { result = block.call }
+    elapsed_time = benchmark.to_s.match(/\(\s*([^\)]+)\)/)[1].to_f
+    @data[method.to_sym] << elapsed_time
+    result
+  end
+
+  def report
+    [
+      "MethodProfiler results for:",
+      @obj.to_s,
+      Hirb::Helpers::Table.render(
+        final_data,
+        headers: ["Method", "Average Time", "Total Calls"],
+        description: false
+      )
+    ].join("\n")
+  end
+
+  def reset!
+    initialize_data
+    @final_data = nil
+  end
+
+  private
+
+  def initialize_data
+    @data = Hash.new { |h, k| h[k] = [] }
+  end
+
+  def find_obj_methods
+    @observed_methods ||= begin
+      methods = @obj.instance_methods
+      @obj.ancestors.each do |a|
+        next if a == @obj
+        methods -= a.instance_methods
+      end
+      methods
+    end
+  end
+
+  def wrap_methods_with_profiling
+    profiler = self
+    observed = observed_methods
+
+    @obj.module_eval do
+      observed.each do |method|
+        define_method("#{method}_with_profiling") do |*args|
+          profiler.profile(method) { send("#{method}_without_profiling", *args) }
+        end
+
+        alias_method "#{method}_without_profiling", method
+        alias_method method, "#{method}_with_profiling"
+      end
+    end
+  end
+
+  def final_data
+    @final_data ||= begin
+      final_data = []
+      data.each do |method, records|
+        total_calls = records.size
+        average = records.reduce(:+) / total_calls
+        final_data << [method, '%f ms' % (average * 1000), total_calls]
+      end
+      final_data.sort! { |a, b| b[1] <=> a[1] }
+      final_data
+    end
+  end
+end

data/method_profiler.gemspec

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name        = "method_profiler"
+  s.version     = "0.0.1"
+  s.authors     = ["Jimmy Cuadra"]
+  s.email       = ["jimmy@jimmycuadra.com"]
+  s.homepage    = "https://github.com/change/method_profiler"
+  s.summary     = %q{Find slow methods in your program.}
+  s.description = %q{MethodProfiler observes your code and generates reports about the methods that were run and how long they took.}
+
+  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"]
+
+  s.add_runtime_dependency "hirb", ">= 0.6.0"
+  s.add_development_dependency "rspec"
+end

data/spec/method_profiler_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+profiler = MethodProfiler.new(Petition)
+
+describe MethodProfiler do
+  before { @petition = Petition.new }
+  after { profiler.reset! }
+
+  it "can be instantiated with an object to observe" do
+    profiler.should be_true
+  end
+
+  it "finds all the object's instance methods" do
+    profiler.observed_methods.sort.should == [:foo, :bar, :baz].sort
+  end
+
+  it "creates wrapper methods for each method in the object" do
+    @petition.should respond_to(:foo)
+    @petition.should respond_to(:foo_with_profiling)
+    @petition.should respond_to(:foo_without_profiling)
+    @petition.should_not respond_to(:foo_with_profiling_with_profiling)
+  end
+
+  describe "#profile" do
+    it "adds a new record for the method call" do
+      @petition.foo
+      profiler.data[:foo].size.should == 1
+    end
+
+    it "calls the real method" do
+      @petition.should_receive(:foo_without_profiling)
+      @petition.foo
+    end
+
+    it "returns the value of the real method" do
+      @petition.baz.should == "blah"
+    end
+  end
+
+  describe "#report" do
+    it "outputs a string of report data" do
+      profiler.report.should be_an_instance_of(String)
+    end
+
+    it "outputs one line for each method that was called" do
+      @petition.foo
+      @petition.bar
+      @petition.baz
+      profiler.report.scan(/foo/).size.should == 1
+      profiler.report.scan(/bar/).size.should == 1
+      profiler.report.scan(/baz/).size.should == 1
+    end
+
+    it "combines multiple calls to the same method into one line" do
+      @petition.foo
+      @petition.foo
+      profiler.report.scan(/foo/).size.should == 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require "method_profiler"
+
+class Petition
+  def foo; end
+  def bar; end
+  def baz; "blah"; end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: method_profiler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jimmy Cuadra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hirb
+  requirement: &70119481195160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70119481195160
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70119481194080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70119481194080
+description: MethodProfiler observes your code and generates reports about the methods
+  that were run and how long they took.
+email:
+- jimmy@jimmycuadra.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/method_profiler.rb
+- method_profiler.gemspec
+- spec/method_profiler_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/change/method_profiler
+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.17
+signing_key: 
+specification_version: 3
+summary: Find slow methods in your program.
+test_files:
+- spec/method_profiler_spec.rb
+- spec/spec_helper.rb