rubyperf 0.0.0

data/lib/perf/noop_measure.rb

@@ -0,0 +1,39 @@
+#
+# Copyright (c) 2012 Lorenzo Pasqualis - DreamBox Learning, Inc
+# https://github.com/lpasqualis/rubyperf
+#
+
+module Perf
+  #
+  # This class can be used in substitution to a Perf::Measure class to avoid overhead when performance measurments is not
+  # required. It needs to maintain the same API as Perf::Measure.
+  #
+  class NoopMeasure
+
+    def measurements
+      {}
+    end
+
+    def current_stack
+      {}
+    end
+
+    def initialize(logger = nil)
+    end
+
+    def clear
+    end
+
+    #############################################################################################################
+
+    def measure(what,type=nil)
+      yield
+    end
+
+    def count_value(what_to_count)
+      nil
+    end
+
+  end
+
+end

data/lib/perf/report_format.rb

@@ -0,0 +1,130 @@
+#
+# Copyright (c) 2012 Lorenzo Pasqualis - DreamBox Learning, Inc
+# https://github.com/lpasqualis/rubyperf
+#
+
+module Perf
+
+  #
+  # Base class for all the standard formatting options for a Perf::Meter. Provies a simple interface to create
+  # custom views of the performance report.
+  #
+  class ReportFormat
+
+    MIN_TOTAL_TIME = 1.0e-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.
+    #
+    # You call this method every time that you want to generate a report from a Perf::Meter object.
+    #
+    # ==== Options
+    #
+    # * +:max_count_len+  : Maximum expected length of a block/espresson/method count.
+    #
+
+    def format(perf,options={})
+      options[:max_count_len] ||= 6
+      rep=[]
+      percents={}
+
+      max_count=options[:max_count_len]
+      max_title=0
+      keys_in_order=perf.measurements.keys.sort
+      total = Benchmark::Tms.new
+
+      perf.measurements.each_pair do |what,m|
+        title_len=format_title(what,options).length
+        path = what.split("\\")
+
+        max_title = title_len             if title_len>max_title
+        max_count = m[:count].to_s.length if m[:count].to_s.length>max_count
+
+        total += m[:time] if path.size==2    # This calculates the max of the level-1 entries needed for the root entry.
+      end
+
+      totals=[total.real]
+      depth=1
+      keys_in_order.each do |what|
+        m=perf.measurements[what]
+        path = what.split("\\")
+        if path.size-1 != depth
+          if path.size-1 > depth
+            totals.push 0
+          else
+            totals.pop(depth-(path.size-1))
+          end
+          depth=path.size-1
+        end
+        totals[totals.size-1] = m[:time].real
+        totals[totals.size-1] = MIN_TOTAL_TIME if totals[totals.size-1]<MIN_TOTAL_TIME
+        percents[what]=(m[:time].real*100.0)/totals[totals.size-2]
+      end
+
+      # Header
+      rep << format_header(:title      => "measure path", :max_title  => max_title,
+                           :percent    => "percent",
+                           :count      => "count",        :max_count  => max_count,
+                           :time       => Benchmark::Tms::CAPTION,
+                           :options    => options)
+
+      # Root
+
+      # Split of keys
+      keys_in_order.each do |what|
+        m=perf.measurements[what]
+        title = format_title(what,options)
+        rep << format_measure(:title      => title,              :max_title  => max_title,
+                              :percent    => percents[what]||0.0,
+                              :count      => m[:count],          :max_count  => max_count,
+                              :time       => m[:time],
+                              :options    => options)
+      end
+
+      rep << format_footer(options)
+      rep
+    end
+
+    # Override to format the output of a single measure. Returns the measure in whatever format the output needs to be.
+    #
+    # ==== Options
+    #
+    # * +v+  : Hash containing the following keys:
+    #           +title+      : Title - or path - of the block/method/expression (\root\a\b\c\d\something))
+    #           +max_title+  : Longest title in the report
+    #           +percent+    : Percentage of time spent in this measure compared to the containing block.
+    #           +count+      : How many times the block/method/exression was executed
+    #           +time+       : Execution time expressed as a Benchmark::Tms value; For titles this is Benchmark::Tms::CAPTION
+    #           +options+    : Formatting options, as passed by the framework or the user.
+    #
+
+    def format_measure(v)
+      v
+    end
+
+    # Override to format the output of the header of the data.
+    #
+    # See format_measure
+
+    def format_header(v)
+      format_measure(v)
+    end
+
+    # Override to format the output of the header of the data.
+    #
+    # See format_measure
+
+    def format_title(what,options)
+      what
+    end
+
+    # Override to format the output of the footer of the data.
+    #
+    # See format_measure
+
+    def format_footer(options)
+      ""
+    end
+
+  end
+end

data/lib/perf/report_format_html.rb

@@ -0,0 +1,34 @@
+#
+# Copyright (c) 2012 Lorenzo Pasqualis - DreamBox Learning, Inc
+# https://github.com/lpasqualis/rubyperf
+#
+
+require 'rubyperf'
+require 'cgi'
+
+module Perf
+  class ReportFormatHtml < ReportFormat
+
+    PERCENT_FORMAT            = "%.3f"
+    INDENT = "&nbsp;"*3
+
+    def format_header(v)
+      "<table class='rubyperf_report_format_html_table'><tr><th>#{v[:title]}</th><th>%</th><th>count</th><th>user</th><th>system</th><th>total</th><th>real</th></tr>"
+    end
+
+    def format_measure(v)
+       percent= v[:percent].is_a?(String) ? v[:percent] : (PERCENT_FORMAT%v[:percent])
+      "<tr><td>#{v[:title]}</td><td>#{percent}</td><td>#{v[:count]}</td><td>#{v[:time].utime}</td><td>#{v[:time].stime}</td><td>#{v[:time].total}</td><td>#{v[:time].real}</td></td>"
+    end
+
+    def format_footer(v)
+      "</table>"
+    end
+
+    def format_title(what,options)
+      path=what.split("\\")
+      "#{(path.size-2) ? INDENT*(path.size-2) : ""}\\#{CGI.escapeHTML(path.last)}"
+    end
+
+  end
+end

data/lib/perf/report_format_simple.rb

@@ -0,0 +1,67 @@
+#
+# Copyright (c) 2012 Lorenzo Pasqualis - DreamBox Learning, Inc
+# https://github.com/lpasqualis/rubyperf
+#
+
+require 'rubyperf'
+
+module Perf
+  # Formats the report this way:
+  #
+  # measure path                : percent%  count       user     system      total        real
+  # \                           : 100.000%      1   2.540000   0.030000   2.570000 (  4.602187)
+  #    \emtpy_loop              :   0.042%      1   0.000000   0.000000   0.000000 (  0.001946)
+  #    \measure_overhead_x10000 :   5.893%      1   0.260000   0.010000   0.270000 (  0.271223)
+  #        \nothing1            :  90.286%   1000   0.250000   0.010000   0.260000 (  0.244876)
+  #            \blah2           :   2.685%   1000   0.010000   0.000000   0.010000 (  0.006574)
+  #            \nothing2        :  74.104%   1000   0.120000   0.010000   0.130000 (  0.181462)
+  #                \blah3       :   4.020%   1000   0.010000   0.000000   0.010000 (  0.007294)
+  #                \nothing3    :   3.679%   1000   0.070000   0.000000   0.070000 (  0.006676)
+  #                \zzzzblah3   :   3.716%   1000   0.000000   0.000000   0.000000 (  0.006744)
+  #    \something               :  11.144%      1   0.000000   0.000000   0.000000 (  0.512861)
+  #        \something1          :  39.077%      1   0.000000   0.000000   0.000000 (  0.200411)
+  #        \something2          :  60.864%      2   0.000000   0.000000   0.000000 (  0.312149)
+  #    \string_operations       :  20.097%      2   0.910000   0.000000   0.910000 (  0.924894)
+  #        \ciao1000            :  50.085%      1   0.460000   0.000000   0.460000 (  0.463233)
+  #        \help1000            :  49.893%      1   0.450000   0.000000   0.450000 (  0.461461)
+  #    \test = "1"              :  21.737%      1   0.000000   0.000000   0.000000 (  1.000368)
+  #    \test = "false"          :   0.000%      2   0.000000   0.000000   0.000000 (  0.000015)
+  #
+  #
+  # Where:
+  #
+  #    percent% : is the percentage of the real time of the real time of its containing path.
+  #               For example blah2 is 2.685% of the real time of nothing1.The sum of the percentages at the same depth
+  #               should always be < 100% (for example depth2 1 is 0.042+5.893+11.144+20.097+21.737 = 58.913). The rest
+  #               is unmeasured time spent.
+  #    count    : is the number of time the measure was taken. All the measures are the cumulative elapsed time for all
+  #               the measures. For example blah3 numbers refer to the cumulative time spent in 1000 execution of that block.
+  #   user      : User CPU time
+  #   system    : System CPU time
+  #   total     : user+system
+  #   real      : Real time
+  #
+
+  class ReportFormatSimple < ReportFormat
+
+    DEFAULT_INDENT            = "    "
+    PERCENT_FORMAT            = "%.3f"
+    EXTRA_SPACES_AFTER_TITLE  = 2
+
+    def format(perf,options={})
+      options[:indent]        ||= DEFAULT_INDENT
+      super perf,options
+    end
+
+    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"
+    end
+
+    def format_title(what,options)
+      path=what.split("\\")
+      "#{(path.size-2) ? options[:indent]*(path.size-2) : ""}\\#{path.last}"
+    end
+
+  end
+end

data/lib/rubyperf.rb

@@ -0,0 +1,154 @@
+#
+# Copyright (c) 2012 Lorenzo Pasqualis - DreamBox Learning, Inc
+#
+# Project home-page git repository:
+#    https://github.com/lpasqualis/rubyperf
+#
+# Author can be contacted at:
+#    lpasqualis@gmail.com
+#
+# Author's Blog:
+#    http://www.lorenzopasqualis.com
+#
+# License:
+#
+#  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.
+#
+#############################################################################
+#
+# This gem measures the execution time of blocks of code, methods and expressions.
+# It generates detailed reports in various formats showing the nested structure
+# of the measures.
+#
+# Designed to give tools to drill in the performance of hot code and identify
+# bottlenecks.
+#
+# Currently available output formats for the report: text, html.
+#
+# Example of use:
+#
+#    require 'rubyperf'
+#
+#    def example
+#        m=Perf::Meter.new
+#        m.measure(:string_operations) do
+#          m.measure(:ciao) do
+#            1000.times do; "CIAO"*100; end
+#          end
+#        end
+#        m.measure(:string_operations) do
+#          m.measure(:help) do
+#            1000.times do; "HELP"*100; end
+#          end
+#        end
+#        m.measure(:emtpy_loop) do
+#          50000.times do; end;
+#        end
+#        m.measure(:rough_overhead_x10000) do
+#          1000.times do
+#            m.measure(:block_1) do
+#              m.measure(:block_1_1) do
+#              end
+#              m.measure(:block_1_2) do
+#                m.measure(:block_1_2_1) do
+#                end
+#                m.measure(:block_1_2_2) do
+#                end
+#                m.measure(:block_1_2_3) do
+#                  m.measure_result(:bool_exp_1_2_3) { false }
+#                  m.measure_result(:bool_exp_1_2_3) { true }
+#                end
+#              end
+#            end
+#          end
+#        end
+#
+#        m.measure(:sleep1) do
+#          m.measure(:sleep1_1) do
+#            sleep(0.01)
+#          end
+#          m.measure(:sleep_1_2) do
+#            sleep(0.02)
+#          end
+#          m.measure(:sleep_1_3) do
+#            sleep(0.03)
+#          end
+#        end
+#        m.measure(:empty) do
+#        end
+#        m.measure_result("test") { sleep(1) }
+#        m.measure_result("test") { false }
+#        m.measure_result("test") { false }
+#
+#        m.method_meters(Array,[:sort,:reverse],[:new]) do
+#          Array.new(1000000,"abc").reverse.sort
+#        end
+#
+#        puts m.report_simple
+#    end
+#
+#  This sample outputs the following report (see notes)).
+#
+#  measure path                                   : percent%  count       user     system      total        real
+#
+#  \blocks                                        : 100.000%   8014   1.040000   0.060000   1.100000 (  2.167488)
+#      \empty                                     :   0.000%      1   0.000000   0.000000   0.000000 (  0.000005)
+#      \emtpy_loop                                :   0.130%      1   0.010000   0.000000   0.010000 (  0.002825)
+#      \rough_overhead_x10000                     :  49.354%      1   1.000000   0.060000   1.060000 (  1.069733)
+#          \block_1                               :  92.013%   1000   0.890000   0.050000   0.940000 (  0.984297)
+#              \block_1_1                         :   0.503%   1000   0.020000   0.000000   0.020000 (  0.004951)
+#              \block_1_2                         :  77.414%   1000   0.670000   0.040000   0.710000 (  0.761979)
+#                  \block_1_2_1                   :   0.640%   1000   0.000000   0.010000   0.010000 (  0.004880)
+#                  \block_1_2_2                   :   0.644%   1000   0.010000   0.000000   0.010000 (  0.004904)
+#                  \block_1_2_3                   :  48.027%   1000   0.370000   0.020000   0.390000 (  0.365958)
+#                      \bool_exp_1_2_3 = "false"  :   1.354%   1000   0.000000   0.000000   0.000000 (  0.004956)
+#                      \bool_exp_1_2_3 = "true"   :   1.369%   1000   0.020000   0.000000   0.020000 (  0.005012)
+#      \sleep1                                    :   2.868%      1   0.000000   0.000000   0.000000 (  0.062157)
+#          \sleep1_1                              :  17.808%      1   0.000000   0.000000   0.000000 (  0.011069)
+#          \sleep_1_2                             :  32.524%      1   0.000000   0.000000   0.000000 (  0.020216)
+#          \sleep_1_3                             :  49.090%      1   0.000000   0.000000   0.000000 (  0.030513)
+#      \string_operations                         :   1.468%      2   0.030000   0.000000   0.030000 (  0.031817)
+#          \ciao                                  :  95.276%      1   0.030000   0.000000   0.030000 (  0.030314)
+#          \help                                  :   4.111%      1   0.000000   0.000000   0.000000 (  0.001308)
+#      \test = "1"                                :  46.160%      1   0.000000   0.000000   0.000000 (  1.000502)
+#      \test = "false"                            :   0.000%      2   0.000000   0.000000   0.000000 (  0.000008)
+#  \methods                                       : 100.000%      3   0.140000   0.010000   0.150000 (  0.154880)
+#      \#<Class:Array>                            :  21.416%      1   0.030000   0.010000   0.040000 (  0.033169)
+#          \new                                   :  99.907%      1   0.030000   0.010000   0.040000 (  0.033138)
+#      \Array                                     :  78.489%      2   0.110000   0.000000   0.110000 (  0.121563)
+#          \reverse                               :  38.671%      1   0.040000   0.000000   0.040000 (  0.047010)
+#          \sort                                  :  61.287%      1   0.070000   0.000000   0.070000 (  0.074502)
+#
+#
+#  Note: the percentage in each line is calculated on the real time of the containing block. For example in the example
+#          -> block_1_1 takes 0.503% of the real time of block_1
+#          -> block_1_2 takes 77.414% of the real time of block
+#
+# TODO:
+#
+#  * Eliminate the overhead of the perf meter operations from the computation of times.
+#
+
+require 'perf/meter'
+require 'perf/meter_factory'
+require 'perf/no_op_meter'
+require 'perf/report_format'
+require 'perf/report_format_simple'
+require 'perf/report_format_html'

data/test/helper.rb

@@ -0,0 +1,24 @@
+#
+# Copyright (c) 2012 Lorenzo Pasqualis - DreamBox Learning, Inc
+# https://github.com/lpasqualis/rubyperf
+#
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubyperf'
+
+class Test::Unit::TestCase
+end
+

data/test/perf_test_example.rb

@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2012 Lorenzo Pasqualis - DreamBox Learning, Inc
+# https://github.com/lpasqualis/rubyperf
+#
+
+class PerfTestExample
+  def test(a,b,c)
+    (0..100000).to_a.reverse.reverse.reverse # Do something heavy
+  end
+
+  def test_np
+    (0..300000).to_a.reverse.reverse.reverse # Do something heavy
+  end
+
+  def self.static_method
+    (0..300000).to_a.reverse.reverse.reverse # Do something heavy
+  end
+end
+

data/test/rubyperf_test_helpers.rb

@@ -0,0 +1,43 @@
+#
+# Copyright (c) 2012 Lorenzo Pasqualis - DreamBox Learning, Inc
+# https://github.com/lpasqualis/rubyperf
+#
+
+require 'rubyperf'
+require 'perf_test_example'
+
+class RubyperfTestHelpers
+  def self.get_measure
+    m=Perf::Meter.new
+
+    a=PerfTestExample.new
+    m.measure(:measure_test) { a.test(1,2,3) }
+    m.measure(:measure_test_np) { a.test_np }
+    m.measure(:some_expressions) do
+      m.measure_result(:expression1) { 1234+12345 }
+      m.measure_result(:expression1) { 1234-123 }
+      m.measure_result(:expression2) { "string" }
+    end
+    # Then use the instance method
+    m.method_meters(PerfTestExample,[:test,:test_np],[:static_method]) do
+      a=PerfTestExample.new
+      a.test(1,2,3)
+      a.test_np
+      PerfTestExample.static_method
+    end
+    m
+  end
+
+  def self.verify_report(m,expected_paths)
+    rf=Perf::ReportFormat.new
+    r=rf.format(m)
+    cnt=0
+    expected_paths.each do |ep|
+      r.each do |l|
+        cnt+=1 if l[:title]==ep
+      end
+    end
+    cnt==expected_paths.size
+  end
+
+end