rubyperf 1.0.0 → 1.0.1

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "rubyperf"
   gem.homepage = "http://github.com/lpasqualis/rubyperf"
   gem.license = "MIT"
-  gem.summary = %Q{A gem to measure ruby code performance}
-  gem.description = %Q{Measures the performance of blocks of code, and provide reporting in various formats}
+  gem.summary = %Q{rubyperf helps you measure ruby code performance}
+  gem.description = %Q{Used to easily measure the performance of blocks of Ruby code, expressions and methods; provides reporting in various formats}
   gem.email = "lpasqualis@gmail.com"
   gem.authors = ["lpasqualis"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/perf/meter.rb

@@ -36,7 +36,7 @@ module Perf
     end
 
     # Takes a description and a code block and measures the performance of the block.
-    # It returns the value retuend by the block
+    # It returns the value returned by the block
     #
     # ==== Attributes
     #
@@ -134,9 +134,9 @@ module Perf
     end
 
     # Puts a wrapper around a set of methods of a specific class to measure their performance.
-    # The set is provided with an array of iinstance methods, and one of class methods.
+    # The set is provided with an array of instance methods, and one of class methods.
     #
-    # The method defines the wrapper, yelds to the block, and then restores the instrumented class.
+    # The method defines the wrapper, yields to the block, and then restores the instrumented class.
     # This ensures that the instrumented class is restored, and that the instrumentation occurs only in the context
     # of the block
     #
@@ -360,10 +360,14 @@ protected
 
     def method_missing(method_sym, *arguments, &block)
       if method_sym.to_s =~ /^report_(.*)$/
-        klass=Object.const_get("Perf").const_get("ReportFormat#{$1.capitalize}")
+        klass=Object.const_get("Perf").const_get("ReportFormat#{camelize($1)}")
         return klass.new.format(self) if klass
       end
       super
     end
+
+    def camelize(from)
+      from.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    end
   end
 end

data/lib/perf/report_format_list_of_measures.rb

@@ -0,0 +1,38 @@
+#
+# Copyright (c) 2012 Lorenzo Pasqualis - DreamBox Learning, Inc
+# https://github.com/lpasqualis/rubyperf
+#
+
+
+require 'rubyperf'
+require 'cgi'
+
+module Perf
+
+  # ReportFormatListOfMeasures is use for unit tests to list the measures taken and their count. It has no other
+  # real life purpose.
+
+  class ReportFormatListOfMeasures < ReportFormat
+
+    def format(perf,options={})
+      super.select{|x| x.length>0 }
+    end
+
+    def format_header(v)
+      ""
+    end
+
+    def format_measure(v)
+      "#{v[:title]},#{v[:count]}"
+    end
+
+    def format_footer(v)
+      ""
+    end
+
+    def format_title(what,options)
+      what
+    end
+
+  end
+end

data/lib/rubyperf.rb

@@ -153,3 +153,4 @@ require 'perf/no_op_meter'
 require 'perf/report_format'
 require 'perf/report_format_simple'
 require 'perf/report_format_html'
+require 'perf/report_format_list_of_measures'

data/rubyperf.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rubyperf}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["lpasqualis"]
-  s.date = %q{2012-01-13}
-  s.description = %q{Measures the performance of blocks of code, and provide reporting in various formats}
+  s.date = %q{2012-01-15}
+  s.description = %q{Used to easily measure the performance of blocks of Ruby code, expressions and methods; provides reporting in various formats}
   s.email = %q{lpasqualis@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     "lib/perf/no_op_meter.rb",
     "lib/perf/report_format.rb",
     "lib/perf/report_format_html.rb",
+    "lib/perf/report_format_list_of_measures.rb",
     "lib/perf/report_format_simple.rb",
     "lib/rubyperf.rb",
     "rubyperf.gemspec",
@@ -43,7 +44,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}
-  s.summary = %q{A gem to measure ruby code performance}
+  s.summary = %q{rubyperf helps you measure ruby code performance}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/test/perf_test_example.rb

@@ -15,5 +15,19 @@ class PerfTestExample
   def self.static_method
     (0..300000).to_a.reverse.reverse.reverse # Do something heavy
   end
+
+  def test_with_measure
+    Perf::MeterFactory.get.measure(:test_with_measure_block) do
+      test(1,2,3)
+      PerfTestExample.static_method
+    end
+  end
+
+  def test_with_measure_static
+    Perf::MeterFactory.get.measure(:test_with_measure_block) do
+      static_method
+    end
+  end
+
 end
 

data/test/test_meter_factory.rb

@@ -12,9 +12,10 @@ require 'rubyperf'
 require 'rubyperf_test_helpers'
 require 'perf_test_example'
 
-class TestPerfMeter < Test::Unit::TestCase
+class TestMeterFactory < Test::Unit::TestCase
 
   def test_basic
+    Perf::MeterFactory.clear_all!
     m1=Perf::MeterFactory.get()
     m2=Perf::MeterFactory.get()
 

data/test/test_perf_meter.rb

@@ -11,17 +11,87 @@ require 'perf_test_example'
 
 class TestPerfMeter < Test::Unit::TestCase
 
-  ALLOW_OUTPUT = false
-
-  def test_overhead
-    runs=3000
+  def test_basic
     m=Perf::Meter.new
-    b1=Benchmark.measure { runs.times { m.measure(:a) { } }}
-    b2=Benchmark.measure {runs.times {} }
+    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
 
-    puts b1      if ALLOW_OUTPUT
-    puts b2      if ALLOW_OUTPUT
-    puts b1-b2   if ALLOW_OUTPUT
+    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
+
+    assert_equal ['\blocks,0',
+    '\blocks\empty,1',
+    '\blocks\emtpy_loop,1',
+    '\blocks\rough_overhead_x10000,1',
+    '\blocks\rough_overhead_x10000\block_1,1000',
+    '\blocks\rough_overhead_x10000\block_1\block_1_1,1000',
+    '\blocks\rough_overhead_x10000\block_1\block_1_2,1000',
+    '\blocks\rough_overhead_x10000\block_1\block_1_2\block_1_2_1,1000',
+    '\blocks\rough_overhead_x10000\block_1\block_1_2\block_1_2_2,1000',
+    '\blocks\rough_overhead_x10000\block_1\block_1_2\block_1_2_3,1000',
+    '\blocks\rough_overhead_x10000\block_1\block_1_2\block_1_2_3\bool_exp_1_2_3 = "false",1000',
+    '\blocks\rough_overhead_x10000\block_1\block_1_2\block_1_2_3\bool_exp_1_2_3 = "true",1000',
+    '\blocks\sleep1,1',
+    '\blocks\sleep1\sleep1_1,1',
+    '\blocks\sleep1\sleep_1_2,1',
+    '\blocks\sleep1\sleep_1_3,1',
+    '\blocks\string_operations,2',
+    '\blocks\string_operations\ciao,1',
+    '\blocks\string_operations\help,1',
+    '\blocks\test = "1",1',
+    '\blocks\test = "false",2',
+    '\methods,0',
+    '\methods\#<Class:Array>.new,1',
+    '\methods\Array.reverse,1',
+    '\methods\Array.sort,1'],
+    m.report_list_of_measures
   end
 
   def test_method_not_corrupted_after_restoring
@@ -36,7 +106,15 @@ class TestPerfMeter < Test::Unit::TestCase
     end
     assert PerfTestExample.methods.sort     == cmethods
     assert PerfTestExample.new.methods.sort == imethods
-    puts m.report_simple if ALLOW_OUTPUT
+
+    assert_equal ['\methods,0',
+                  '\methods\#<Class:PerfTestExample>.static_method,1',
+                  '\methods\PerfTestExample.test,1',
+                  '\methods\PerfTestExample.test_np,1'],
+                 m.report_list_of_measures
+
+    assert_equal 6,m.report_simple.length
+    assert_equal 6,m.report_html.length
   end
 
   def test_method_metering
@@ -47,7 +125,26 @@ class TestPerfMeter < Test::Unit::TestCase
       a.test_np
       PerfTestExample.static_method
     end
-    puts m.report_simple if ALLOW_OUTPUT
+
+    assert_equal ['\methods,0',
+                  '\methods\#<Class:PerfTestExample>.static_method,1',
+                  '\methods\PerfTestExample.test,1',
+                  '\methods\PerfTestExample.test_np,1'],
+                m.report_list_of_measures
+  end
+
+  def test_methods_with_measure
+    Perf::MeterFactory.clear_all!
+    m=Perf::MeterFactory.get
+    m.method_meters(PerfTestExample,[:test,:test_np,:test_with_measure],[:static_method]) do
+      a=PerfTestExample.new
+      a.test(1,2,3)
+      a.test_np
+      a.test_with_measure
+      PerfTestExample.static_method
+    end
+    assert_equal 10,m.report_simple.length
+    assert_equal 10,m.report_html.length
   end
 
   def test_base_report
@@ -70,17 +167,10 @@ class TestPerfMeter < Test::Unit::TestCase
                                                 "#{Perf::Meter::PATH_MEASURES}\\d",
                                                 "#{Perf::Meter::PATH_MEASURES}\\b",
                                                 "#{Perf::Meter::PATH_MEASURES}"])
-    puts m.report_simple if ALLOW_OUTPUT
-  end
-
-  def test_output_html
-    m=RubyperfTestHelpers.get_measure
-    htmlcode=m.report_html
-    puts htmlcode if ALLOW_OUTPUT
   end
 
   def test_exception_handling
-    # An exeption thwon in a block that we are measuring needs to leave the Perf::Meter in a good state.
+    # An exception thrown in a block that we are measuring needs to leave the Perf::Meter in a good state.
     # This test checks the state after an exception.
     exception_raised  = false
     measuring_correct = false
@@ -105,7 +195,6 @@ class TestPerfMeter < Test::Unit::TestCase
     assert exception_raised
     assert measuring_correct
     assert stack_correct
-    puts m.report_simple if ALLOW_OUTPUT
   end
 
   def test_return_values
@@ -121,8 +210,6 @@ class TestPerfMeter < Test::Unit::TestCase
       assert_equal 5,m.measure_result(:five) {5}
       assert_equal "byebye",m.measure_result(:byebye) {"bye"+"bye"}
     end
-
-    puts m.report_simple if ALLOW_OUTPUT
   end
 
   def test_nesting_measure
@@ -130,14 +217,14 @@ class TestPerfMeter < Test::Unit::TestCase
     m.measure(:a) { }
     m.measure(:b) { }
     m.measure(:d) { m.measure(:c) { m.measure(:d) {} }}
-    assert_not_nil m.measurements["#{Perf::Meter::PATH_MEASURES}\\d\\c\\d"]
-    assert_not_nil m.measurements["#{Perf::Meter::PATH_MEASURES}\\d\\c"]
-    assert_not_nil m.measurements["#{Perf::Meter::PATH_MEASURES}\\d"]
-    assert_not_nil m.measurements["#{Perf::Meter::PATH_MEASURES}\\b"]
-    assert_not_nil m.measurements["#{Perf::Meter::PATH_MEASURES}\\a"]
-    assert_not_nil m.measurements["#{Perf::Meter::PATH_MEASURES}"]
-    assert_nil m.measurements["#{Perf::Meter::PATH_MEASURES}\\huh"]
-    puts m.report_simple if ALLOW_OUTPUT
+
+    assert_equal ['\blocks,0',
+                  '\blocks\a,1',
+                  '\blocks\b,1',
+                  '\blocks\d,1',
+                  '\blocks\d\c,1',
+                  '\blocks\d\c\d,1'],
+         m.report_list_of_measures
   end
 
   def test_measure_instance_method
@@ -180,65 +267,31 @@ class TestPerfMeter < Test::Unit::TestCase
     a.test_np
     #puts puts m.report_simple
     m.restore_all_methods(PerfTestExample)
-    puts m.report_simple if ALLOW_OUTPUT
+    assert_equal ['\blocks,0',
+                  '\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\#<Class:PerfTestExample>.static_method,1',
+                  '\methods\PerfTestExample.test,1',
+                  '\methods\PerfTestExample.test_np,2'],
+                  m.report_list_of_measures
   end
 
-  def test_basic
-    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 if ALLOW_OUTPUT
 
+  def test_overhead
+    runs=1_000
+    a=(1..100_000).to_a
+    m=Perf::Meter.new
+    b1=Benchmark.measure { runs.times { m.measure(:a) { a.reverse! } } }
+    b2=Benchmark.measure { runs.times { a.reverse!                 } }
+    assert_equal  ['\blocks,0',
+                   '\blocks\a,1000'],
+                  m.report_list_of_measures
+    # Here we should assert if the overhead is > a certain percentage.
+    # puts "Measurement overhead x 1000 = #{b1-b2}"
   end
 end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 0
+  - 1
   segments_generated: true
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - lpasqualis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-13 00:00:00 -08:00
+date: 2012-01-15 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,7 +74,7 @@ dependencies:
         segments_generated: true
         version: "0"
   requirement: *id004
-description: Measures the performance of blocks of code, and provide reporting in various formats
+description: Used to easily measure the performance of blocks of Ruby code, expressions and methods; provides reporting in various formats
 email: lpasqualis@gmail.com
 executables: []
 
@@ -97,6 +97,7 @@ files:
 - lib/perf/no_op_meter.rb
 - lib/perf/report_format.rb
 - lib/perf/report_format_html.rb
+- lib/perf/report_format_list_of_measures.rb
 - lib/perf/report_format_simple.rb
 - lib/rubyperf.rb
 - rubyperf.gemspec
@@ -136,6 +137,6 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: A gem to measure ruby code performance
+summary: rubyperf helps you measure ruby code performance
 test_files: []