benches 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0a31536816bbaf808af25fe99966c2d8968f6c6
+  data.tar.gz: d826ff23eebf397bf7c853ab12b226e67163a52e
+SHA512:
+  metadata.gz: b12382125632d996603f544e0f3ce547c5db085eaf28d5282b060ce6168271c3bbb7f131a657b5d37f9d29d6fc716416b4d8f0f48d39419e53b55bc094b91999
+  data.tar.gz: 7c9f41a9839e4a08081414f26b5b909f70bbbbdfa57c7a6114a16d1410db7ecbcebf1151066f88791daa84ec6f2984d6a269489ce9f6d721046eb660cd793341

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec

data/README.md

@@ -0,0 +1,32 @@
+# Benches
+
+Benches defines a simple benchmarking DSL that allows you to create benchmark routines for your Ruby code.
+
+## Defining a Routine
+
+Create a folder called regimens. For each class that you want to benchmark,
+create a file like integer.rb
+
+integer_routine.rb
+```ruby
+routine 4, 'benches 400 reps of to_s' # no arguments
+routine 30, 'benches 300 reps of * with (400)' # one argument
+routine 'test_string', "benches 500 reps of gsub with (s, '')" # two arguments
+```
+
+This will return the benchmark results of running `4.to_s` 400 times,
+`30 * 400` 300 times, and `'test_string'.gsub('s', '')` 500 times.
+
+The command `benchpress` will run all of the regimens.
+
+## Testing
+
+Simply run `rspec` to run the test suite.
+
+## Future Work
+
+- Allow benchmark results to be tested in block passed to routine
+
+## Credits
+
+All code (c) Evan Hemsley 2014

data/benches.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "benches/version"
+
+Gem::Specification.new do |s|
+  s.name        = "benches"
+  s.version     = Benches::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Evan Hemsley"]
+  s.email       = ["evan.hemsley@gmail.com"]
+  s.homepage    = 'http://github.com/ehemsley/benches'
+  s.summary     = 'A simple DSL for benchmarking your Ruby code'
+  s.description = 'Benches defines a simple benchmarking DSL that allows you to create benchmark routines for your Ruby code.'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.license       = 'MIT'
+end

data/bin/benchpress

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'benches'
+
+Dir["regimens/*_routine.rb"].each do |file|
+  puts "Performing #{File.basename(file).gsub("_routine.rb", "")} regimen: "
+  load file
+end

data/lib/benches/dsl.rb

@@ -0,0 +1,32 @@
+#input: instance_name benches n reps of method_name (with *args)
+#example: graph benches 50000 reps of dfs
+def routine(instance, input)
+  params = input.split(" ")
+  if params.last == params[4]
+    args = nil
+  else
+    args = coerce_args(input[/\(.*?\)/].gsub(/[()]/, "").split(","))
+  end
+
+  Benches::Routine.new(instance, params[4], params[1].to_i, *args).call
+end
+
+def coerce_args(args)
+  args.map do |arg|
+    if integer?(arg)
+      arg.to_i
+    elsif float?(arg)
+      arg.to_f
+    else
+      arg
+    end
+  end
+end
+
+def integer?(input)
+  !!(/^\d+$/ =~ input)
+end
+
+def float?(input)
+  !!(/^\d+(.\d+)$/ =~ input)
+end

data/lib/benches/routine.rb

@@ -0,0 +1,20 @@
+module Benches
+  class Routine
+    def initialize(instance, method, repetitions, *args)
+      @instance = instance
+      @method = method
+      @repetitions = repetitions
+      @args = args
+    end
+
+    def call
+      Benchmark.bm(@method.length) do |x|
+        x.report("#{@method}:") do
+          @repetitions.times do
+            @instance.send(@method, *@args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/benches/version.rb

@@ -0,0 +1,3 @@
+module Benches
+  VERSION = '0.1.0'
+end

data/lib/benches.rb

@@ -0,0 +1,3 @@
+require 'benchmark'
+require 'benches/routine'
+require 'benches/dsl'

data/license.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) [2014] [Evan Hemsley]
+
+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/spec/dsl_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe 'routine' do
+  context 'no method arguments' do
+    it 'returns benchmark result' do
+      expect((routine 'test_string', 'benches 20 reps of split').first).to be_a Benchmark::Tms
+    end
+  end
+
+  context 'method has integer argument' do
+    it 'returns benchmark result' do
+      expect((routine 'test_string', "benches 20 reps of insert with (0,a)").first).to be_a Benchmark::Tms
+    end
+  end
+
+  context 'method has float argument' do
+    it 'returns benchmark result' do
+      expect((routine 32.444, 'benches 20 reps of + with (4.43)').first).to be_a Benchmark::Tms
+    end
+  end
+end
+
+describe 'float?' do
+  context 'input string contains only a float' do
+    it 'returns true' do
+      expect(float?('32.555')).to eql true
+    end
+  end
+
+  context 'input string contains letters and numbers' do
+    it 'returns false' do
+      expect(float?('ab321')).to eql false
+    end
+  end
+
+  context 'input string contains an integer' do
+    it 'returns false' do
+      expect(float?('32')).to eql false
+    end
+  end
+
+  context 'input string does not contain any numbers' do
+    it 'returns false' do
+      expect(float?('stuff')).to eql false
+    end
+  end
+end
+
+describe 'integer?' do
+  context 'input string contains only an integer' do
+    it 'returns true' do
+      expect(integer?('32')).to eql true
+    end
+  end
+
+  context 'input string contains a float' do
+    it 'returns false' do
+      expect(integer?('32.423')).to eql false
+    end
+  end
+
+  context 'input string contains letters and numbers' do
+    it 'returns false' do
+      expect(integer?('abc123')).to eql false
+    end
+  end
+
+  context 'input string does not contain any numbers' do
+    it 'returns false' do
+      expect(integer?('abc')).to eql false
+    end
+  end
+end

data/spec/routine_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Benches::Routine do
+  describe 'initialize' do
+    context 'no method arguments' do
+      let(:bench) { Benches::Routine.new("test_string", 'split', 50000) }
+
+      it 'assigns instance correctly' do
+        expect(bench.instance_variable_get('@instance')).to eql 'test_string'
+      end
+
+      it 'assigns method correctly' do
+        expect(bench.instance_variable_get('@method')).to eql 'split'
+      end
+
+      it 'assigns repetitions correctly' do
+        expect(bench.instance_variable_get('@repetitions')).to eql 50000
+      end
+
+      it 'sets args to empty array' do
+        expect(bench.instance_variable_get('@args')).to eql []
+      end
+    end
+
+    context 'method has arguments' do
+      let(:bench) { Benches::Routine.new("test_string", 'insert', 50000, 1, 'a') }
+
+      it 'assigns instance correctly' do
+        expect(bench.instance_variable_get('@instance')).to eql 'test_string'
+      end
+
+      it 'assigns method correctly' do
+        expect(bench.instance_variable_get('@method')).to eql 'insert'
+      end
+
+      it 'assigns repetitions correctly' do
+        expect(bench.instance_variable_get('@repetitions')).to eql 50000
+      end
+
+      it' assigns args correctly' do
+        expect(bench.instance_variable_get('@args')).to eql [1, 'a']
+      end
+    end
+  end
+
+  describe 'call' do
+    context 'no method arguments' do
+      let(:bench) { Benches::Routine.new("test_string", 'split', 20) }
+
+      it 'performs benchmark' do
+        expect(bench.call.first).to be_a Benchmark::Tms
+      end
+    end
+
+    context 'method has arguments' do
+      let(:bench) { Benches::Routine.new("test_string", 'insert', 20, 1, 'a') }
+
+      it 'performs benchmark' do
+        expect(bench.call.first).to be_a Benchmark::Tms
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$:<< File.join(File.dirname(__FILE__), '..')
+require 'lib/benches'
+
+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
+
+  config.order = 'random'
+
+  config.color_enabled = true
+  config.tty = true
+  config.formatter =  :documentation
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: benches
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Evan Hemsley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-09 00:00:00.000000000 Z
+dependencies: []
+description: Benches defines a simple benchmarking DSL that allows you to create benchmark
+  routines for your Ruby code.
+email:
+- evan.hemsley@gmail.com
+executables:
+- benchpress
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- benches.gemspec
+- bin/benchpress
+- lib/benches.rb
+- lib/benches/dsl.rb
+- lib/benches/routine.rb
+- lib/benches/version.rb
+- license.md
+- spec/dsl_spec.rb
+- spec/routine_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ehemsley/benches
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple DSL for benchmarking your Ruby code
+test_files:
+- spec/dsl_spec.rb
+- spec/routine_spec.rb
+- spec/spec_helper.rb