benchmark_wrapper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3453361e87d0cb94b05c407523ce5055d15823d
+  data.tar.gz: cdfdd4407b524906893f6244fe445b4d3026fd4b
+SHA512:
+  metadata.gz: 257a85f8bcbe3daa014734b2baa2cc35b932a837a9eb4b207243280ee82105f8d7e2a70e6f0b50b20fb790ae922b7e9c4ebeee69b2832892f11484a6af5af505
+  data.tar.gz: 022299bff2dad99b7bb17e841ccd27826a808a98ebed55a359709d729f86bc958e79666b40cc0394301ad15974cf65bb36da6ff25a8439373770c65f1cfaa235

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-20mode
+  - jruby-19mode

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in benchmark_wrapper.gemspec
+gemspec
+
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 LFDM
+
+MIT 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.

data/README.md

@@ -0,0 +1,89 @@
+# BenchmarkWrapper
+[![Build Status](https://travis-ci.org/LFDM/benchmark_wrapper.png)](https://travis-ci.org/LFDM/benchmark_wrapper)
+[![Coverage Status](https://coveralls.io/repos/LFDM/benchmark_wrapper/badge.png)](https://coveralls.io/r/LFDM/benchmark_wrapper)
+[![Dependency Status](https://gemnasium.com/LFDM/benchmark_wrapper.png)](https://gemnasium.com/LFDM/benchmark_wrapper)
+
+Extend your class to wrap a benchmark around whatever method you want.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'benchmark_wrapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install benchmark_wrapper
+
+## Usage
+
+```ruby
+  require 'benchmark_wrapper'
+
+  class A
+    extend BenchmarkWrapper
+    
+    def method1; 1; end
+
+    def method2(arg); arg + yield; end
+
+    wrap_with_benchmark :method1, :method2
+  end
+
+  a = A.new
+
+  a.method1
+  #  0.000000   0.000000   0.000000 (  0.000010)
+  # => 1
+
+  a.method2(1) { 1 }
+  #  0.000000   0.000000   0.000000 (  0.000008)
+  # => 2
+```
+
+It's important to define the methods you want to be benchmarked before
+you wrap them. The following will not work:
+
+```ruby
+  class A
+    extend BenchmarkWrapper
+
+    wrap_with_benchmark :method1
+    
+    def method1; 1; end
+  end
+  
+  # NameError: undefined method `method1' for class `A'
+```
+
+Output defaults to $stdout but can be redirected:
+
+```ruby
+  RESULTS = []
+
+  class B
+    extend BenchmarkWrapper
+
+    def method1; 1; end
+   
+    wrap_with_benchmark :method1, out: RESULTS, out_method: :<<
+  end
+
+  B.new.method1
+  # => 1
+
+  RESULTS
+  # => [#<Benchmark::Tms ...>]
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/benchmark_wrapper.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'benchmark_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "benchmark_wrapper"
+  spec.version       = BenchmarkWrapper::VERSION
+  spec.authors       = ["LFDM"]
+  spec.email         = ["1986gh@gmail.com"]
+  spec.description   = %q{Benchmarking module}
+  spec.summary       = %q{Module to extend classes to wrap certain method calls with benchmarking}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov", "~> 0.7"
+end

data/lib/benchmark_wrapper.rb

@@ -0,0 +1,45 @@
+require "benchmark_wrapper/version"
+require "benchmark"
+
+module BenchmarkWrapper
+  def wrap_with_benchmark(*meths)
+    opts = extract_benchmark_receiver_options(meths)
+    out = opts[:out]
+    out_method = opts[:out_method]
+
+    meths.each do |meth|
+      without_bm, with_bm = wrapper_methods(meth)
+
+      define_method(with_bm) do |*args, &blk|
+        # obscenely ugly, but Benchmark class seems
+        # to have nothing to avoid this
+        ret_val = nil
+        bm = Benchmark.measure { ret_val = send(without_bm, *args, &blk) }
+        out.send(out_method, bm)
+        ret_val
+      end
+
+      alias_method without_bm, meth
+      alias_method meth, with_bm
+    end
+  end
+
+  private
+
+  def extract_benchmark_receiver_options(arr)
+    opts = arr.last.kind_of?(Hash) ? arr.pop : {}
+    default_bm_receiver.merge(opts)
+  end
+
+  def default_bm_receiver
+    # would love to have this inside a constant,
+    # but it would get untestable this way!
+    { out: $stdout, out_method: :puts}
+  end
+
+  def wrapper_methods(meth)
+    ['', 'out'].map do |str|
+      "#{meth}_with#{str}_benchmark".to_sym
+    end
+  end
+end

data/lib/benchmark_wrapper/version.rb

@@ -0,0 +1,3 @@
+module BenchmarkWrapper
+  VERSION = "0.0.1"
+end

data/spec/lib/benchmark_wrapper_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+require 'stringio'
+
+describe BenchmarkWrapper do
+  before :all do
+    string_io = StringIO.new
+    @stdout = $stdout
+    $stdout = string_io
+  end
+
+  let(:dummy) do
+    Class.new do
+      extend BenchmarkWrapper
+
+      def test1; 1; end
+      def test2; 2; end
+      def test_with_arg(x); 1 + x; end
+      def test_with_blk; yield; end
+      def test_with_arg_and_blk(x); x + yield; end
+    end
+  end
+
+  it 'should have a version number' do
+    BenchmarkWrapper::VERSION.should_not be_nil
+  end
+
+  describe "#wrap_with_benchmark" do
+    # Behavior tests
+    context 'with the default receiver $stdout' do
+      it "wraps a given method with a benchmark" do
+        dummy.wrap_with_benchmark(:test1)
+        obj = dummy.new
+        $stdout.should receive(:puts)
+        obj.test1
+      end
+
+      it "wrapped methods return their original return value" do
+        dummy.wrap_with_benchmark(:test1)
+        dummy.new.test1.should == 1
+      end
+
+      it "can wrap multiple methods at once" do
+        dummy.wrap_with_benchmark(:test1, :test2)
+        obj = dummy.new
+        $stdout.should receive(:puts).twice
+        obj.test1.should == 1
+        obj.test2.should == 2
+      end
+    end
+
+    context 'with a given receiver' do
+      it "defers the benchmark result to the given receiver" do
+        container = []
+        dummy.wrap_with_benchmark(:test1, out: container, out_method: :<<)
+        dummy.new.test1
+        container.should have(1).item
+        container.first.should be_an_instance_of Benchmark::Tms
+      end
+
+      it "can wrap multiple methods at once" do
+        container = []
+        dummy.wrap_with_benchmark(:test1, :test2, out: container, out_method: :<<)
+        obj = dummy.new
+        obj.test1.should == 1
+        obj.test2.should == 2
+        container.should have(2).items
+      end
+    end
+
+    it "doesn't fail when method take arguments" do
+      dummy.wrap_with_benchmark(:test_with_arg)
+      dummy.new.test_with_arg(0).should == 1
+    end
+
+    it "doesn't fail when method takes a block" do
+      dummy.wrap_with_benchmark(:test_with_blk)
+      dummy.new.test_with_blk { 3 }.should == 3
+    end
+
+    it "doesn't fail when method takes argument and block" do
+      dummy.wrap_with_benchmark(:test_with_arg_and_blk)
+      dummy.new.test_with_arg_and_blk(1) { 4 }.should == 5
+    end
+  end
+
+
+  after :all do
+    $stdout = @stdout
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'simplecov'
+require 'coveralls'
+
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'benchmark_wrapper'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: benchmark_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- LFDM
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Benchmarking module
+email:
+- 1986gh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark_wrapper.gemspec
+- lib/benchmark_wrapper.rb
+- lib/benchmark_wrapper/version.rb
+- spec/lib/benchmark_wrapper_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: Module to extend classes to wrap certain method calls with benchmarking
+test_files:
+- spec/lib/benchmark_wrapper_spec.rb
+- spec/spec_helper.rb