bnchmrkr 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 865d3a5f2015a2a17b83d3d7cfd6d5afa288746e
-  data.tar.gz: ce9151c449de83712d5174a646c809e16cad45a7
+  metadata.gz: 214df34c63b9b084f735e0f68b852f7b133cac08
+  data.tar.gz: 0a62535f2639dfcab95c35c4a90740b8ba5b8207
 SHA512:
-  metadata.gz: d95759bbf07da4be053570967b004472561c1d9c58b5d7a21fd4257526afab82e1a2d6b7ecdf3066652c66ee8df564e011f603da57867cc3031512b8c5acb0cf
-  data.tar.gz: acc31c13b9f1ebd6005336a538870a16bc2a35127663aa87ecf990d9584f6cba51e9858a33c395426cea7ab29a6162dc8d1d5c104b1b273f3ff0db9b8ab64e98
+  metadata.gz: be45d3fd8037efeeea35eda76b1ebb2258d5b96a09e95fe5e525cf77f5907e243f7a7f3e2c5c6a20fb9b5a2ad5eff1546013a857f74a26fb7b6f35c723c2fabf
+  data.tar.gz: dedbf34a52fccd4e5a45387fc8bfc412cff22b0421d9380a5d59560644d445fbea82a5f4aaf5d26b2047228eba72fedb47ba2cb4cd92ce057f616e6e75a440aa

data/.reek

@@ -0,0 +1,36 @@
+---
+
+Attribute:
+  enabled: false
+
+# so judgy.. and without context
+BooleanParameter:
+  enabled: false
+
+ControlParameter:
+  enabled: false
+
+DuplicateMethodCall:
+  enabled: false
+
+NestedIterators:
+  max_allowed_nesting: 3
+
+# more lacking context judgement - when _would_ you be ok with '!' ?
+PrimaDonnaMethod:
+  enabled: false
+
+# this feels a bit arbitrary.. maybe would make more sense if was an average
+TooManyStatements:
+  max_statements: 15
+
+# i don't name my exceptions specifically. that doesn't make me a bad person.
+UncommunicativeVariableName:
+  accept: /^[a|b|e|f|i|j|k|l|m|r]$/
+
+# or my comparators in ~sort() functions
+## https://github.com/troessner/reek/issues/886
+UncommunicativeParameterName:
+  accept:
+    - a
+    - b

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+
+notifications:
+  email: false
+
+bundler_args: --without test --jobs 3 --retry 3
+script: bundle exec rake test reek build

data/Gemfile

@@ -2,8 +2,11 @@ ruby '2.0.0'
 
 source 'https://rubygems.org'
 
+gem 'rake', '~> 10.5.0', '>= 10.5.0'
+
 group :development do
-  gem 'jeweler', '~> 0'
+  gem 'jeweler', '~> 2.0.1', '>= 2.0.1'
+  gem 'reek', '~> 3.11', '>= 3.11'
   gem 'test-unit', '~> 3.0.0', '>= 3.0.0'
 end
 

data/Gemfile.lock

@@ -1,20 +1,82 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    jeweler (0.11.1)
-      rubyforge
-      schacon-git (>= 1.1.1)
-    json_pure (1.8.3)
+    addressable (2.4.0)
+    ast (2.2.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.2)
+    codeclimate-engine-rb (0.3.1)
+      virtus (~> 1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    equalizer (0.0.11)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      oauth2
+    hashie (3.4.3)
+    highline (1.7.8)
+    ice_nine (0.11.2)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.1)
+    mini_portile2 (2.0.0)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    oauth2 (1.1.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0, < 1.5.2)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    parser (2.3.0.6)
+      ast (~> 2.2)
     power_assert (0.2.7)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
-    schacon-git (1.2.2)
+    rack (1.6.4)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    rdoc (4.2.2)
+      json (~> 1.4)
+    reek (3.11)
+      codeclimate-engine-rb (~> 0.3.1)
+      parser (~> 2.3, >= 2.3.0.6)
+      rainbow (~> 2.0)
     test-unit (3.0.9)
       power_assert
+    thread_safe (0.3.5)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  jeweler (~> 0)
+  jeweler (~> 2.0.1, >= 2.0.1)
+  rake (~> 10.5.0, >= 10.5.0)
+  reek (~> 3.11, >= 3.11)
   test-unit (~> 3.0.0, >= 3.0.0)

data/README.md

@@ -7,10 +7,10 @@ Bnchmrkr (Benchmarker) is a tool to help benchmark different method implementati
 it is driven by [Benchmark](http://ruby-doc.org/stdlib-2.0.0/libdoc/benchmark/rdoc/Benchmark.html)
 
 ## usage
+
 ### pre-built gem installation (stable)
 
-[RubyGems](http://rubygems.org/gems/bnchmrkr)
-[![Gem Version](https://badge.fury.io/rb/bnchmrkr.png)](http://badge.fury.io/rb/bnchmrkr)
+[![Gem Version](https://badge.fury.io/rb/bnchmrkr.png)](https://rubygems.org/gems/bnchmrkr)
 
 ```sh
 gem install bnchmrkr
@@ -22,6 +22,8 @@ irb(main):001:0> require 'bnchmrkr'
 
 ### from-source installation (latest)
 
+[![build status](https://travis-ci.org/chorankates/bnchmrkr.svg)](https://travis-ci.org/chorankates/bnchmrkr)
+
 ```sh
 git clone https://github.com/chorankates/bnchmrkr.git
 cd bnchmrkr
@@ -33,7 +35,7 @@ irb(main):001:0> require 'bnchmrkr'
 => true
 ```
 
-# examples
+## examples
 
 ```rb
 tester = Bnchmrkr.new({
@@ -74,7 +76,7 @@ overall:
           slowest => stat [0.076243]
 ```
 
-# instance methods
+## instance methods
 ```
   benchmark!
   count

data/Rakefile

@@ -1,10 +1,19 @@
 require 'jeweler'
+require 'rake'
+require 'rake/clean'
 require 'rake/testtask'
+require 'reek/rake/task'
+
+BASEDIR = File.dirname(__FILE__)
+
+$LOAD_PATH << File.join([BASEDIR, 'lib'])
+$LOAD_PATH << BASEDIR
 
-$LOAD_PATH << File.join([File.dirname(__FILE__), 'lib'])
-$LOAD_PATH << File.dirname(__FILE__)
 require 'bnchmrkr'
 
+CLEAN.include('bnchmrkr.gemspec')
+CLOBBER.include('pkg/*')
+
 Jeweler::Tasks.new do |gem|
   gem.name        = 'bnchmrkr'
   gem.summary     = 'compare execution time'
@@ -29,10 +38,17 @@ namespace :test do
     t.verbose = true
   end
 
+  Rake::TestTask.new do |t|
+    t.name = 'examples'
+    t.libs << 'lib'
+    t.test_files = FileList['test/examples/**/*.rb']
+    t.verbose = true
+  end
+
 end
 
 desc 'run all tests'
-task :test => ['test:unit'] do
+task :test => ['test:unit', 'test:examples'] do
 end
 
 desc 'run all examples'
@@ -41,4 +57,12 @@ task :examples do
     sh "time ruby #{file}"
     puts
   end
+end
+
+Reek::Rake::Task.new do |t|
+  t.config_file   = File.join(BASEDIR, '.reek')
+  t.source_files  = './**/*.rb'
+  t.reek_opts     = '--no-wiki-links'
+  t.fail_on_error = false
+  t.verbose       = true
 end

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/lib/bnchmrkr.rb

@@ -2,6 +2,7 @@
 
 require 'benchmark'
 
+# Bnchmrkr is a tool to help Benchmark.measure {} and compare different method implementations
 class Bnchmrkr
 
   attr_reader :count, :results
@@ -36,10 +37,14 @@ class Bnchmrkr
   def benchmark!
     @lambdas.each_pair do |name, l|
       1.upto(@count).each do |round|
-        measure = Benchmark.measure {
-          l.call
-        }
-        add_measure(name, measure)
+        begin
+          measure = Benchmark.measure {
+            l.call
+          }
+          add_measure(name, measure)
+        rescue => e
+          add_measure(sprintf('%s-failed', name).to_sym, Benchmark.measure {})
+        end
       end
     end
 
@@ -56,7 +61,8 @@ class Bnchmrkr
     string     = String.new
     inspection = self.inspect
     return string unless inspection.nil? or inspection.has_key?(:overall)
-    longest_key = 15 # TODO determine this dynamically
+
+    longest_key = inspection[:specific].keys.each { |i| i.length }.max.length + 5
 
     inspection[:specific].keys.each do |i|
       string << sprintf('%s:%s', i, "\n")
@@ -67,7 +73,13 @@ class Bnchmrkr
 
     string << sprintf('overall:%s', "\n")
     inspection[:overall].each_pair do |type, measure|
-      string << sprintf("  %#{longest_key}s => %s [%s]%s", type, measure[:name], measure[:measure], "\n")
+      string << sprintf("  %#{longest_key}s => %s [%s]%s%s",
+                        type,
+                        measure[:name],
+                        measure[:measure],
+                        measure.has_key?(:faster_by) ? sprintf(' [faster by %s]', measure[:faster_by]) : '',
+                        "\n"
+      )
     end
 
     string
@@ -109,14 +121,14 @@ class Bnchmrkr
     @slowest
   end
 
-  # +a+ {:name => name, :measure => measure}
-  # +b+ {:name => name, :measure => measure}
+  # +a+ Symbol that represents a known lambda
+  # +b+ Symbol that represents a known lambda
   # +mode+ :fastest, :slowest, :mean, :median, :total
   # return boolean if a is faster than b, false if invalid
   def is_faster?(a, b, mode = :total)
     result = calculate_per_lambda
-    return false unless result.has_key?(a[:name]) and result.has_key?(b[:name])
-    result[a[:name]][mode] < result[b[:name]][mode]
+    return false unless result.has_key?(a) and result.has_key?(b)
+    result[a][mode] < result[b][mode]
   end
 
   # +a+ {:name => name, :measure => measure}
@@ -129,14 +141,37 @@ class Bnchmrkr
 
   # +a+ {:name => name, :measure => measure}
   # +b+ {:name => name, :measure => measure}
-  # return Float representing difference in measure, or false, if b is slower than a
-  def faster_by(a, b, percent = true)
+  # +percent+ Boolean representing percent (String) or Float difference
+  # return Float representing difference in measures, or false, if b is slower than a
+  def faster_by_result(a, b, percent = true)
     return false if b[:measure] < a[:measure]
 
-    faster = (b[:measure] - a[:measure]) / b[:measure]
+    faster = (b[:measure] - a[:measure]) / a[:measure]
     percent ? sprintf('%4f%', faster * 100) : faster
   end
 
+  # +a+ Symbol representing name of known lambda type
+  # +b+ Symbol representing name of known lambda type
+  # +percent+ Boolean representing percent (String) or Float difference
+  # return Float representing difference in measures, or false, if b is slower than a
+  def faster_by_type(a, b, percent = true)
+    fastest_a = fastest_by_type(a)
+    fastest_b = fastest_by_type(b)
+
+    return false if fastest_b < fastest_a
+
+    faster = (fastest_b - fastest_a) / fastest_a
+    percent ? sprintf('%4f%', faster * 100) : faster
+  end
+
+  def slower_by_type(a, b, percent = true)
+    ! faster_by_type(a, b, percent)
+  end
+
+  def slower_by_result(a, b, percent = true)
+    ! faster_by_result(a, b, percent)
+  end
+
   private
 
   def add_measure(name, measure)
@@ -156,9 +191,8 @@ class Bnchmrkr
       hash[name] = Hash.new
 
       total = 0
+      # TODO add the mode
       measures.collect {|m| total += m.real }
-
-      # TODO do we want to determine the mode?
       hash[name][:fastest] = sorted.first.real
       hash[name][:slowest] = sorted.last.real
       hash[name][:mean]    = sprintf('%5f', total / sorted.size)
@@ -181,6 +215,7 @@ class Bnchmrkr
       end
     end
 
+    @fastest[:faster_by] = self.faster_by_result(@fastest, @slowest)
     { :fastest => @fastest, :slowest => @slowest }
   end
 

data/test/examples/test_examples.rb

@@ -0,0 +1,20 @@
+require_relative File.expand_path(sprintf('%s/../../lib/bnchmrkr', File.dirname(__FILE__)))
+require 'test-unit'
+
+# run all examples, ensure non-0 exit code and non-nil output
+class TestExamples < Test::Unit::TestCase
+
+  def setup;  end
+
+  def test_all_examples
+    @files = Dir.glob(sprintf('%s/../../examples/*.rb', File.dirname(__FILE__)))
+
+    @files.each do |file|
+      raw = `ruby #{file}`
+
+      assert_true($?.success?)
+      assert_not_nil(raw)
+    end
+  end
+
+end

data/test/unit/test_contrived.rb

@@ -1,6 +1,7 @@
 require_relative File.expand_path(sprintf('%s/../../lib/bnchmrkr', File.dirname(__FILE__)))
 require 'test-unit'
 
+# tests for the example in examplescontrived.rb
 class TestContrived < Test::Unit::TestCase
 
   def setup
@@ -38,8 +39,8 @@ class TestContrived < Test::Unit::TestCase
   end
 
   def test_is_faster?
-    fast = @tester.fastest_overall
-    slow = @tester.slowest_overall
+    fast = @tester.fastest_overall[:name]
+    slow = @tester.slowest_overall[:name]
 
     forward = @tester.is_faster?(fast, slow)
     reverse = @tester.is_faster?(slow, fast)
@@ -52,8 +53,8 @@ class TestContrived < Test::Unit::TestCase
   end
 
   def test_is_slower?
-    fast = @tester.fastest_overall
-    slow = @tester.slowest_overall
+    fast = @tester.fastest_overall[:name]
+    slow = @tester.slowest_overall[:name]
 
     forward = @tester.is_slower?(slow, fast)
     reverse = @tester.is_slower?(fast, slow)
@@ -65,13 +66,24 @@ class TestContrived < Test::Unit::TestCase
     assert_true(equal) # ugh, this is misleading.. but is_slower? is boolean opposite of is_slower?
   end
 
-  def test_faster_by
-
+  def test_faster_by_result
     fast = @tester.fastest_overall
     slow = @tester.slowest_overall
 
-    assert_true(@tester.faster_by(fast, slow, false).is_a?(Float))
-    assert_false(@tester.faster_by(slow, fast))
+    assert_not_nil(@tester.faster_by_result(fast, slow, true))
+    assert_match(/\d+\.\d+%/, @tester.faster_by_result(fast, slow, true))
+    assert_true(@tester.faster_by_result(fast, slow, false).is_a?(Float))
+    assert_false(@tester.faster_by_result(slow, fast))
+  end
+
+  def test_faster_by_type
+    fastest = @tester.fastest_overall[:name]
+    slowest = @tester.slowest_overall[:name]
+
+    assert_not_nil(@tester.faster_by_type(fastest, slowest, true))
+    assert_match(/\d+\.\d+%/, @tester.faster_by_type(fastest, slowest, true))
+    assert_true(@tester.faster_by_type(fastest, slowest, false).is_a?(Float))
+    assert_false(@tester.faster_by_type(slowest, fastest))
 
   end
 

data/test/unit/test_exceptions.rb

@@ -0,0 +1,35 @@
+require_relative File.expand_path(sprintf('%s/../../lib/bnchmrkr', File.dirname(__FILE__)))
+require 'test-unit'
+
+# test that exceptions thrown in the middle of a #benchmark! run will behave in expected ways
+class TestExceptions < Test::Unit::TestCase
+
+  def setup; end
+
+  def test_lambdas_will_raise
+    tester = Bnchmrkr.new({
+      :divbyzero => lambda {
+        10 / 0
+      },
+    })
+
+    assert_nothing_raised do
+      tester.benchmark!
+      assert_true(tester.results.has_key?('divbyzero-failed'.to_sym))
+    end
+  end
+
+  def test_lambdas_wont_raise_anyway
+    tester = Bnchmrkr.new({
+      :foo => lambda { 'bar' }
+    })
+
+    assert_nothing_raised do
+      tester.benchmark!
+      assert_true(tester.results.has_key?(:foo))
+    end
+
+  end
+
+
+end

data/test/unit/test_initialize.rb

@@ -1,11 +1,11 @@
 require_relative File.expand_path(sprintf('%s/../../lib/bnchmrkr', File.dirname(__FILE__)))
 require 'test-unit'
 
-class TestInitialize < Test::Unit::TestCase
 
-  def setup
+# test valid/invalid instantiations
+class TestInitialize < Test::Unit::TestCase
 
-  end
+  def setup; end
 
   def test_valid
 

metadata

@@ -1,29 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: bnchmrkr
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Conor Horan-Kates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-08 00:00:00.000000000 Z
+date: 2016-04-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 10.5.0
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 10.5.0
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.5.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.11'
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.11'
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -52,14 +98,17 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- .reek
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - VERSION
-- bnchmrkr.gemspec
 - lib/bnchmrkr.rb
+- test/examples/test_examples.rb
 - test/unit/test_contrived.rb
+- test/unit/test_exceptions.rb
 - test/unit/test_initialize.rb
 homepage: http://github.com/chorankates/bnchmrkr
 licenses:

data/bnchmrkr.gemspec

@@ -1,51 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: bnchmrkr 0.0.2 ruby lib
-
-Gem::Specification.new do |s|
-  s.name = "bnchmrkr"
-  s.version = "0.0.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Conor Horan-Kates"]
-  s.date = "2016-03-08"
-  s.description = "given a hash of lambdas, runs and compares the amount of time each implementation takes"
-  s.email = "conor.code@gmail.com"
-  s.extra_rdoc_files = [
-    "README.md"
-  ]
-  s.files = [
-    "Gemfile",
-    "Gemfile.lock",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "bnchmrkr.gemspec",
-    "lib/bnchmrkr.rb",
-    "test/unit/test_contrived.rb",
-    "test/unit/test_initialize.rb"
-  ]
-  s.homepage = "http://github.com/chorankates/bnchmrkr"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
-  s.summary = "compare execution time"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<jeweler>, ["~> 0"])
-      s.add_development_dependency(%q<test-unit>, [">= 3.0.0", "~> 3.0.0"])
-    else
-      s.add_dependency(%q<jeweler>, ["~> 0"])
-      s.add_dependency(%q<test-unit>, [">= 3.0.0", "~> 3.0.0"])
-    end
-  else
-    s.add_dependency(%q<jeweler>, ["~> 0"])
-    s.add_dependency(%q<test-unit>, [">= 3.0.0", "~> 3.0.0"])
-  end
-end
-