method_profiler 1.1.0 → 1.2.0

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -11,8 +11,8 @@ Create a new profiler by passing the object you want to profile to `MethodProfil
 ```ruby
 profiler = MethodProfiler.observe(MyClass)
 
-MyClass.nisi_inventore
-MyClass.nisi_inventore
+MyClass.labore_voluptatum
+MyClass.labore_voluptatum
 
 my_obj = MyClass.new
 
@@ -66,7 +66,7 @@ MethodProfiler results for: MyClass
 puts profiler.report.sort_by(:total_calls).order(:ascending)
 ```
 
-`#sort_by` accepts a symbol or string with the name of any of the columns in the table: `:method`, `:min`, `:max`, `:average`, or `:total_calls`.
+`#sort_by` accepts a symbol or string with the name of any of the columns in the table: `:method`, `:min`, `:max`, `:average`, `:total_time`, or `:total_calls`.
 
 `#order` accepts a symbol or string of `:ascending` or `:descending`. These can also be abbreviated with `:asc` and `:desc`.
 

data/Rakefile

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

data/lib/method_profiler/profiler.rb

@@ -33,8 +33,9 @@ module MethodProfiler
 
     def wrap_methods_with_profiling
       profiler = self
-      singleton_methods_to_wrap = find_singleton_methods
-      instance_methods_to_wrap = find_instance_methods
+      singleton_methods_to_wrap = @obj.methods(false)
+      instance_methods_to_wrap = @obj.instance_methods(false)
+      private_instance_methods_to_wrap = @obj.private_instance_methods(false)
 
       @obj.singleton_class.module_eval do
         singleton_methods_to_wrap.each do |method|
@@ -57,24 +58,24 @@ module MethodProfiler
           alias_method method, "#{method}_with_profiling"
         end
       end
-    end
 
-    def find_singleton_methods
-      @obj.singleton_class.instance_methods - @obj.singleton_class.ancestors.map do |a|
-        a == @obj ? [] : a.instance_methods
-      end.flatten
-    end
+      @obj.module_eval do
+        private_instance_methods_to_wrap.each do |method|
+          define_method("#{method}_with_profiling") do |*args, &block|
+            profiler.send(:profile, method) { send("#{method}_without_profiling", *args, &block) }
+          end
 
-    def find_instance_methods
-      @obj.instance_methods - @obj.ancestors.map do |a|
-        a == @obj ? [] : a.instance_methods
-      end.flatten
+          alias_method "#{method}_without_profiling", method
+          alias_method method, "#{method}_with_profiling"
+
+          private "#{method}_with_profiling"
+        end
+      end
     end
 
     def profile(method, singleton = false, &block)
       method_name = singleton ? ".#{method}" : "##{method}"
-      result = nil
-      elapsed_time, result = benchmark(result, &block)
+      elapsed_time, result = benchmark(block)
       elapsed_time = elapsed_time.to_s.match(/\(\s*([^\)]+)\)/)[1].to_f
       @data[method_name] << elapsed_time
       result
@@ -100,10 +101,9 @@ module MethodProfiler
       results
     end
 
-    private
-
-    def benchmark(result, &block)
-      elapsed_time = Benchmark.measure { result = block.call }
+    def benchmark(block_to_benchmark)
+      result = nil
+      elapsed_time = Benchmark.measure { result = block_to_benchmark.call }
       return elapsed_time, result
     end
   end

data/lib/method_profiler/report.rb

@@ -5,8 +5,18 @@ module MethodProfiler
   # Sorts and displays data collected by a {Profiler}.
   #
   class Report
+    # Report headers
+    HEADERS = {
+      :method => "Method",
+      :min => "Min Time",
+      :max => "Max Time",
+      :average => "Average Time",
+      :total_time => "Total Time",
+      :total_calls => "Total Calls",
+    }
+
     # Fields that can be passed to {#sort_by}.
-    FIELDS = [:method, :min, :max, :average, :total_time, :total_calls]
+    FIELDS = HEADERS.keys
 
     # Directions that can be passed to {#order}.
     DIRECTIONS = [:asc, :ascending, :desc, :descending]
@@ -68,15 +78,8 @@ module MethodProfiler
         "MethodProfiler results for: #{@obj}",
         Hirb::Helpers::Table.render(
           to_a,
-          :headers => {
-            :method => "Method",
-            :min => "Min Time",
-            :max => "Max Time",
-            :average => "Average Time",
-            :total_time => "Total Time",
-            :total_calls => "Total Calls",
-          },
-          :fields => [:method, :min, :max, :average, :total_time, :total_calls],
+          :headers => HEADERS.dup,
+          :fields => FIELDS.dup,
           :filters => {
             :min => :to_milliseconds,
             :max => :to_milliseconds,

data/method_profiler.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "method_profiler"
-  s.version     = "1.1.0"
+  s.version     = "1.2.0"
   s.authors     = ["Jimmy Cuadra"]
   s.email       = ["jimmy@jimmycuadra.com"]
   s.homepage    = "https://github.com/change/method_profiler"

data/spec/method_profiler/profiler_spec.rb

@@ -9,6 +9,8 @@ describe MethodProfiler::Profiler do
     petition.should respond_to(:foo_with_profiling)
     petition.should respond_to(:foo_without_profiling)
     petition.should_not respond_to(:foo_with_profiling_with_profiling)
+    petition.private_methods.should include(:shh_with_profiling)
+    petition.private_methods.should include(:shh_without_profiling)
   end
 
   it "returns correct values for class methods" do
@@ -19,6 +21,10 @@ describe MethodProfiler::Profiler do
     petition.baz.should == "blah"
   end
 
+  it "returns correct values for private methods" do
+    petition.send(:shh).should == "secret"
+  end
+
   it "yields to implicit blocks" do
     petition.method_with_implicit_block {|v| v }.should == "implicit"
   end

data/spec/method_profiler/report_spec.rb

@@ -5,15 +5,15 @@ describe MethodProfiler::Report do
     profiler = MethodProfiler::Profiler.new(Petition)
 
     # Fake the timings for testing purposes
-    profiler.stub(:benchmark) do |result, block|
-      result = block.call
+    profiler.stub(:benchmark) do |block_to_benchmark|
+      result = block_to_benchmark.call
       "(#{rand})"
     end
 
     petition = Petition.new
 
-    [:hay, :hay, :guys].each { |m| petition.class.send(m) }
-    [:foo, :bar, :baz].each { |m| petition.send(m) }
+    [:hay, :guys].each { |m| petition.class.send(m) }
+    [:foo, :bar, :baz, :shh].each { |m| petition.send(m) }
 
     @report = profiler.report
   end
@@ -22,57 +22,51 @@ describe MethodProfiler::Report do
     it "returns an array of records" do
       results = @report.to_a
       results.should be_an Array
-      results.size.should == 5
+      results.size.should == 6
     end
 
-    it "sorts by average time (descending) by default" do
+    it "returns results sorted by average time (descending) by default" do
       results = @report.to_a
       average_times = results.map { |r| r[:average] }
       average_times.should == average_times.sort.reverse
     end
+  end
 
-    it "sorts by another type if it's been changed" do
+  describe "#sort_by" do
+    it "sets the result key to order results by" do
       results = @report.sort_by(:min).to_a
       min_times = results.map { |r| r[:min] }
       min_times.should == min_times.sort.reverse
     end
 
-    it "sorts in a different direction if it's been changed" do
-      results = @report.order(:ascending).to_a
-      average_times = results.map { |r| r[:average] }
-      average_times.should == average_times.sort
-    end
-  end
-
-  describe "#sort_by" do
-    it "sets the sort type" do
-      @report.sort_by(:total_calls)
-      @report.instance_variable_get("@sort_by").should == :total_calls
-    end
-
     it "defaults to average if an invalid sort type is passed" do
-      @report.sort_by(:foo)
-      @report.instance_variable_get("@sort_by").should == :average
+      results = @report.sort_by(:foo).to_a
+      average_times = results.map { |r| r[:average] }
+      average_times.should == average_times.sort.reverse
     end
   end
 
   describe "#order" do
     it "sets the sort direction" do
-      @report.order(:ascending)
-      @report.instance_variable_get("@order").should == :ascending
+      results = @report.order(:ascending).to_a
+      average_times = results.map { |r| r[:average] }
+      average_times.should == average_times.sort
     end
 
     it "defaults to descending if an invalid direction is passed" do
-      @report.order(:foo)
-      @report.instance_variable_get("@order").should == :descending
+      results = @report.order(:foo).to_a
+      average_times = results.map { |r| r[:average] }
+      average_times.should == average_times.sort.reverse
     end
 
-    it "allows normalizes :asc and :desc aliases" do
-      @report.order(:asc)
-      @report.instance_variable_get("@order").should == :ascending
+    it "allows :asc and :desc aliases" do
+      results = @report.order(:asc).to_a
+      average_times = results.map { |r| r[:average] }
+      average_times.should == average_times.sort
 
-      @report.order(:desc)
-      @report.instance_variable_get("@order").should == :descending
+      results = @report.order(:desc).to_a
+      average_times = results.map { |r| r[:average] }
+      average_times.should == average_times.sort.reverse
     end
   end
 
@@ -86,6 +80,7 @@ describe MethodProfiler::Report do
       output.scan(/#foo/).size.should == 1
       output.scan(/#bar/).size.should == 1
       output.scan(/#baz/).size.should == 1
+      output.scan(/#shh/).size.should == 1
     end
   end
 end

data/spec/support/petition.rb

@@ -31,4 +31,10 @@ class Petition
   def method_with_explicit_block_and_args(*args, &block)
     block.call args
   end
+  
+  private
+
+  def shh
+    "secret"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: method_profiler
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-10 00:00:00.000000000 Z
+date: 2013-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hirb
-  requirement: &70291604515080 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70291604515080
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70291604514680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70291604514680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70291604514220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70291604514220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: MethodProfiler observes your code and generates reports about the methods
   that were run and how long they took.
 email:
@@ -53,6 +68,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .travis.yml
 - Gemfile
 - LICENSE
@@ -89,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Find slow methods in your program.