runmetric 0.0.4

data/lib/runmetric.rb

@@ -0,0 +1,124 @@
+=begin rdoc
+
+== +runmetric.rb+: a simple solution to hide the complexity of the +Benchmark+ module
+
+Copyright (c) 2012 AJ AYIDJKIMO <aj.presenttense@gmail.com>
+
+All rights reserved. You can redistribute and/or modify it under the same terms as Ruby.
+
+== Overview
+
+This library provides the +Runmetric+ module, with its convenience method +run_metric+ that encapsulates (hides) some of the complexity of the +Benchmark+ module in the standard library. It was designed for use in online programming challenges, but it has application anytime performance (speed) information might be helpful or necessary in evaluating algorithm or application usage.
+
+== Usage
+
+This example, from code written by the developer, illustrates how runmetric might be used:
+
+  def problem(max)
+  
+    require 'runmetric'
+    include Runmetric
+  
+    run_metric(iterations: 10**5) do
+      (max/2..max).inject(:lcm)
+    end
+  
+  end
+  
+  problem(20)
+
+This output was automatically generated from the example code without use of +puts+ or +inspect+ methods:
+
+  Performance:
+  
+         user     system      total        real
+     0.312000   0.000000   0.312000 (  0.321018)
+  
+  Result(s):
+  
+  232792560
+
+Read the code in this module to understand how it operates and to see what other arguments the +run_metric+ method can take.
+
+=end
+
+module Runmetric
+
+  require 'benchmark'
+  include Benchmark
+
+  def run_metric(opts={}, *any, &code)
+
+    iterations = opts[:iterations] || 1
+    reports    = opts[:reports]    || 1
+    if iterations == 1 then
+      run_when = opts[:run_when] || :run_last_once
+    else
+      run_when = opts[:run_when] || :run_last
+    end
+
+    case run_when
+    when :run_first
+
+      # call code once to obtain results then within loop for timing
+      run_code(*any, &code)
+      time_code(reports, iterations, *any, &code)
+
+    when :run_last
+
+      # call code within loop for timing then once to obtain results
+      time_code(reports, iterations, *any, &code)
+      run_code(*any, &code)
+
+    when :run_last_once
+
+      # call code once to obtain results and timing
+      time_and_run_code(*any, &code)
+
+    else
+      raise ArgumentError
+    end
+
+  end
+
+  private
+
+  def run_code(*any, &code)                                    #:doc:
+
+    puts "\nResult(s):\n\n"
+    puts code.call(*any)
+
+  end
+
+  def time_and_run_code(*any, &code)                           #:doc:
+
+    results = 0
+
+    puts "\nPerformance:\n\n"
+    bm do |x|
+      x.report do
+        results = code.call(*any)
+      end
+    end
+
+    puts "\nResult(s):\n\n"
+    puts results
+
+  end
+
+  def time_code(reports, iterations, *any, &code)              #:doc:
+
+    puts "\nPerformance:\n\n"                                      
+    reports.times do
+      bm do |x|
+        x.report do
+          iterations.times do
+            code.call(*any)
+          end
+        end
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: runmetric
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- AJ Ayidjkimo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-06 00:00:00.000000000 Z
+dependencies: []
+description: This library provides the Runmetric module, with its convenience method
+  run_metric that encapsulates (hides) some of the complexity of the Benchmark module
+  in the standard library. It was designed for use in online programming challenges,
+  but it has application anytime performance (speed) information might be helpful
+  or necessary in evaluating algorithm or application usage.
+email: aj.presenttense@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/runmetric.rb
+homepage: http://www.technopolissoftware.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple solution to hide the complexity of the Benchmark module
+test_files: []