rubyperf 1.3.2 → 1.3.4

data/VERSION

@@ -1 +1 @@
-1.3.2
+1.3.4

data/lib/perf/meter.rb

@@ -43,7 +43,7 @@ module Perf
       @instrumented_methods     = {METHOD_TYPE_INSTANCE=>[],METHOD_TYPE_CLASS=>[]}
       @class_methods            = []
       @subtract_overhead        = @options[:subtract_overhead]
-      if @subtract_overhead
+      if @@overhead.nil?
         @@overhead              ||= measure_overhead
         @measurements             = {}      # A hash of Measure; must repeat here to cleanup what measure_overhead did
       end
@@ -130,9 +130,10 @@ module Perf
         else
           t = Benchmark.measure { res=code.call }
           t -= @@overhead if @subtract_overhead && @@overhead  # Factor out the overhead of measure, if we are asked to do so
-          if t.total>=0 && t.real>=0
-            m.time    += t
-            root.time += t if root
+          root.count += m.count if root
+          if t.total>=0 || t.real>=0
+            m.time += t
+            root.time  += t if root
           end
         end
       ensure
@@ -307,6 +308,26 @@ module Perf
       restore_all_class_methods(klass)
     end
 
+    # Returns an index of accuracy of the measure calculated in relation to the overhead.
+    # The larger the accuracy, the more accurate the measure.
+    # accuracy < 0  means that it is not possible to calculate;
+    # accuracy <= 1 means that the measure is equal or smaller than the overhead.
+    #               This makes the measure very inaccurate.
+    # accuracy = X means that the measure is X times the overhead.
+
+    def accuracy(path)
+      if @@overhead
+        over=@@overhead.total+@@overhead.real
+        if over>0 && @@overhead.total>=0 && @@overhead.real>=0
+          m=get_measurement(path)
+          if m.count>0 && m.time.total>0 && m.time.real>0
+            return (m.time.total+m.time.real) / (over*m.count)
+          end
+        end
+      end
+      -1
+    end
+
 protected
 
     # This method measures the overhead of calling "measure" on an instace of Perf::Meter.

data/lib/perf/report_format.rb

@@ -13,7 +13,8 @@ module Perf
   #
   class ReportFormat
 
-    MIN_TOTAL_TIME = 1.0e-10
+    MIN_TOTAL_TIME      = 1.0e-10
+    MAX_ACCURACY_SIZE = 10
 
     # Format takes a Perf::Meter plus a hash of options and converts it into a header, followed by a series
     # of entries in a hash format that can be easily converted in any other format such as Text, HTML, XML, etc.
@@ -69,6 +70,7 @@ module Perf
                            :percent    => "percent",
                            :count      => "count",        :max_count  => max_count,
                            :time       => Benchmark::Tms::CAPTION,
+                           :accuracy  => "accuracy",      :max_accuracy => MAX_ACCURACY_SIZE,
                            :options    => options)
 
       # Root
@@ -81,6 +83,7 @@ module Perf
                               :percent    => percents[what]||0.0,
                               :count      => m.count,            :max_count  => max_count,
                               :time       => m.time,
+                              :accuracy   => format_accuracy(perf.accuracy(m.path)),    :max_accuracy => MAX_ACCURACY_SIZE,
                               :options    => options)
       end
 
@@ -129,5 +132,24 @@ module Perf
       ""
     end
 
+    # Format the accuracy
+    # See Perf::Meter#accuracy for more information
+
+    def format_accuracy(accuracy)
+      if accuracy<0
+        "unknown"
+      elsif accuracy<=1
+        "very poor"
+      elsif accuracy<=50
+        "poor"
+      elsif accuracy<=100
+        "fair"
+      elsif accuracy<=1000
+        "good"
+      else
+        "excellent"
+      end
+    end
+
   end
 end

data/lib/perf/report_format_html.rb

@@ -30,6 +30,55 @@ module Perf
     #     :count_format   => sprintf format of the count (see COUNT_FORMAT for default)
     #     :indent_string  => what string to use to indent the path (see INDENT for default)
     #
+    # ==== Stylesheet Example
+    #
+    #    table.rubyperf_report
+    #    {
+    #        border: solid 2px #555555;
+    #        padding: 0;
+    #    }
+    #
+    #    table.rubyperf_report tr.odd_row
+    #    {
+    #        background-color: #CCCCCC;
+    #    }
+    #
+    #    table.rubyperf_report tr.even_row
+    #    {
+    #        background-color: #DDDDDD;
+    #        padding: 0;
+    #    }
+    #
+    #    table.rubyperf_report td.title
+    #    {
+    #        text-align: left;
+    #        padding: 0;
+    #        font-family: "Courier New";
+    #        font-weight: bold;
+    #    }
+    #
+    #    table.rubyperf_report td.accuracy
+    #    {
+    #        text-align: left;
+    #        padding: 0;
+    #        font-family: "Courier New";
+    #    }
+    #
+    #    table.rubyperf_report td.percent, td.count, td.system_time, td.user_time, td.real_time, td.total_time
+    #    {
+    #        text-align: right;
+    #        padding: 0;
+    #        font-family: "Courier New";
+    #    }
+    #
+    #    table.rubyperf_report th
+    #    {
+    #        background-color: #888888;
+    #        border: 2px solid black;
+    #        text-align: left;
+    #        padding: 2px;
+    #    }
+
     # ==== Example
     #
     # m=Perf::Meter.new
@@ -50,6 +99,7 @@ module Perf
       "<table class='rubyperf_report'><tr>" \
         "<th class='title'>#{v[:title]}</th>" \
         "<th class='percent'>%</th>" \
+        "<th class='accuracy'>accuracy</th>" \
         "<th class='count'>count</th>" \
         "<th class='user_time'>user</th>" \
         "<th class='system_time'>system</th>" \
@@ -65,6 +115,7 @@ module Perf
       "<tr class='#{@line % 2==0 ? "even_row" : "odd_row"}'>" \
         "<td class='title'>#{v[:title]}</td>" \
         "<td class='percent'>#{percent}</td>" \
+        "<td class='accuracy'>#{v[:accuracy]}</td>" \
         "<td class='count'>#{@count_format % v[:count]}</td>" \
         "<td class='user_time'>#{@time_format % v[:time].utime}</td>" \
         "<td class='system_time'>#{@time_format % v[:time].stime}</td>" \

data/lib/perf/report_format_simple.rb

@@ -56,7 +56,7 @@ module Perf
 
     def format_measure(v)
       percent= v[:percent].is_a?(String) ? v[:percent] : (PERCENT_FORMAT%v[:percent])
-      "#{v[:title].ljust(v[:max_title]+EXTRA_SPACES_AFTER_TITLE," ")}: #{percent.rjust(7," ")}% #{v[:count].to_s.rjust(v[:max_count]," ")} #{v[:time].to_s.gsub(/\n/,'')}\n"
+      "#{v[:title].ljust(v[:max_title]+EXTRA_SPACES_AFTER_TITLE," ")}: #{percent.rjust(7," ")}% #{v[:accuracy].rjust(v[:max_accuracy]," ")} #{v[:count].to_s.rjust(v[:max_count]," ")} #{v[:time].to_s.gsub(/\n/,'')}\n"
     end
 
     def format_title(what,options)

data/rubyperf.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rubyperf}
-  s.version = "1.3.2"
+  s.version = "1.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["lpasqualis"]

data/test/test_perf_meter.rb

@@ -66,7 +66,7 @@ class TestPerfMeter < Test::Unit::TestCase
       Array.new(1000000,"abc").reverse.sort
     end
 
-    assert_equal ['\blocks,0',
+    assert_equal ['\blocks,10',
     '\blocks\empty,1',
     '\blocks\emtpy_loop,1',
     '\blocks\rough_overhead_x10000,1',
@@ -87,7 +87,7 @@ class TestPerfMeter < Test::Unit::TestCase
     '\blocks\string_operations\help,1',
     '\blocks\test = "1",1',
     '\blocks\test = "false",2',
-    '\methods,0',
+    '\methods,3',
     '\methods\#<Class:Array>.new,1',
     '\methods\Array.reverse,1',
     '\methods\Array.sort,1'],
@@ -110,7 +110,7 @@ class TestPerfMeter < Test::Unit::TestCase
     assert_equal 6,m.report_simple.length
     assert_equal 6,m.report_html(:percent_format=>"%.8f").length
     assert_equal 6,m.report_html.length
-    assert_equal ['\methods,0',
+    assert_equal ['\methods,3',
                   '\methods\#<Class:PerfTestExample>.static_method,1',
                   '\methods\PerfTestExample.test,1',
                   '\methods\PerfTestExample.test_np,1'],
@@ -124,6 +124,18 @@ class TestPerfMeter < Test::Unit::TestCase
     assert m.has_measures?
   end
 
+  def test_accurancy
+    m=Perf::Meter.new
+    m.measure(:b) do
+    end
+    m.measure(:a) do
+      ("123"*1_000_000).reverse
+    end
+    assert m.accuracy(m.measurements['\blocks'].path) >= 0
+    assert m.accuracy(m.measurements['\blocks\a'].path) >= 0
+    assert m.accuracy(m.measurements['\blocks\b'].path) < 0
+  end
+
   def test_methods_with_measure
     Perf::MeterFactory.clear_all!
     m=Perf::MeterFactory.get
@@ -209,7 +221,7 @@ class TestPerfMeter < Test::Unit::TestCase
     m.measure(:b) { }
     m.measure(:d) { m.measure(:c) { m.measure(:d) {} }}
 
-    assert_equal ['\blocks,0',
+    assert_equal ['\blocks,3',
                   '\blocks\a,1',
                   '\blocks\b,1',
                   '\blocks\d,1',
@@ -258,14 +270,14 @@ class TestPerfMeter < Test::Unit::TestCase
     a.test_np
     #puts puts m.report_simple
     m.restore_all_methods(PerfTestExample)
-    assert_equal ['\blocks,0',
+    assert_equal ['\blocks,3',
                   '\blocks\measure_test,1',
                   '\blocks\measure_test_np,1',
                   '\blocks\some_expressions,1',
                   '\blocks\some_expressions\expression1 = "1111",1',
                   '\blocks\some_expressions\expression1 = "13579",1',
                   '\blocks\some_expressions\expression2 = "string",1',
-                  '\methods,0',
+                  '\methods,5',
                   '\methods\#<Class:PerfTestExample>.static_method,1',
                   '\methods\PerfTestExample.test,1',
                   '\methods\PerfTestExample.test_np,2'],
@@ -285,7 +297,7 @@ class TestPerfMeter < Test::Unit::TestCase
     b2_yes_overhead=Benchmark.measure { runs.times { a.reverse!                 } }
 
 
-    assert_equal  ['\blocks,0',
+    assert_equal  ['\blocks,500500',
                    '\blocks\a,1000'],
                   m_no_overhead.report_list_of_measures
 

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 3
-  - 2
+  - 4
   segments_generated: true
-  version: 1.3.2
+  version: 1.3.4
 platform: ruby
 authors: 
 - lpasqualis