benches 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 289a188d0ee7e80411be4e9d4812c49e98496ea0
-  data.tar.gz: d8798a409099b2a5a9e5bb0ef177ed93142957ba
+  metadata.gz: c5283633dfb5c13e49a963c2ac09b027387441c9
+  data.tar.gz: b28b6003fd2a48648b364a9142e004f8a91404cf
 SHA512:
-  metadata.gz: 798b63c764e81844813d278b3c74692fcba823cc1443cd6dd3b70af6292ec1e09e3c85fa7d7ebbf13f92c548819dc9a2d0eaf23634058afacc7c099e65746cc4
-  data.tar.gz: 5e22ea4b6deb9d7350103f12f8f76432089d2428f12de1664b465571855692510ea25b454d7a3cf93fbafdc56508189470bb306b469c701f7130958132fa62aa
+  metadata.gz: c6643716c20ebb0178d298fe53fae8415f6fd68918fc139ead3342a23f8a72676bf70802197f8dcc030687629fe33bc1aa2742f4c4821dbab2c3c8405e5cbfb0
+  data.tar.gz: 021dfda72bcf425c84d68d0771e19afa58ef1eeab6af95083812c3b6b69a3b6ed0617765804d4165d9953a2d4fc32f5871a190983b6533b30ce52aea0c074556

data/README.md

@@ -1,35 +1,52 @@
 # Benches
 
-Benches defines a simple benchmarking DSL that allows you to create benchmark routines for your Ruby code.
+Benches defines a simple rspec matcher that allows you to create benchmarking specs for your Ruby code.
 
-## Defining a Routine
+## Usage
 
-Create a folder called regimens. For each class that you want to benchmark,
-create a file like integer_regimen.rb
+To include the matchers in your specs, set up your `spec_helper.rb` like so:
+```ruby
+  require 'benches'
+  # other requirements
+
+  RSpec.configure do |config|
+    config.include Benches::Matchers
+    #other configuration code
+  end
+```
+
+The run_in_less_than matcher expects a block and checks if the block runs in less than a certain amount of time.
 
-integer_regimen.rb
 ```ruby
-subject 5 do
-  benches '500 reps of to_s in less than 5 seconds'
-  benches '400 reps of + in less than 2 seconds', 3
-  benches '300 reps of * in less than 3 seconds', 400
-end
+  describe Integer
+    describe 'to_s' do
+      it 'meets the performance metrics when running 1 time' do
+        expect{5.to_s}.to run_in_less_than(1.second)
+      end
+    end
+  end
+```
 
-subject 20 do
-  benches '500 reps of to_s in less than 5 seconds'
-  benches '400 reps of + in less than 2 seconds', 3
-  benches '300 reps of * in less than 3 seconds', 400
+You can also specify that a block should run a certain number of times in less than a certain duration.
+
+```ruby
+describe Integer do
+  describe 'to_s' do
+    it 'meets the performance metrics' do
+      expect{5.to_s}.to run(500).times_in_less_than(5.seconds)
+    end
+  end
 end
 ```
 
-If the benchmarks runs within the allotted time, it will
-be printed green, otherwise it will be printed red.
+The duration specified should be an ActiveSupport::Duration object, like `5.seconds` or `1.hour`.
 
-The command `benchpress` runs all of the regimen files
+If the benchmark runs within the allotted time, the test will pass.
+Otherwise it will fail.
 
 ## Testing
 
-Simply run `rspec` to run the test suite.
+Simply run `rspec` to run the sample spec.
 
 ## Credits
 

data/benches.gemspec

@@ -9,13 +9,16 @@ Gem::Specification.new do |s|
   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.summary     = 'A simple rspec matcher for testing performance metrics'
+  s.description = 'Benches defines a simple rspec matcher that allows you to create benchmarking specs 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.add_dependency 'rspec', '~> 2.14', '>= 2.14.1'
+  s.add_dependency 'activesupport', '~> 4.0', '>= 4.0.3'
+
   s.license       = 'MIT'
 end

data/lib/benches/matchers/run.rb

@@ -0,0 +1,37 @@
+module Benches
+  module Matchers
+
+    RSpec::Matchers.define :run do |repetitions|
+
+      chain :time_in_less_than do |duration|
+        @duration = duration
+      end
+
+      chain :times_in_less_than do |duration|
+        @duration = duration
+      end
+
+      match do |actual|
+        Benchmark.measure do
+          repetitions.times do
+            actual.call
+          end
+        end.utime.seconds < @duration
+      end
+
+      failure_message_for_should do |actual|
+        "expected code to run in less than #{@duration.inspect}"
+      end
+
+      failure_message_for_should_not do |actual|
+        "expected code not to run in less than #{@duration.inspect} seconds"
+      end
+
+      description do
+        "run in less than #{@duration.inspect}"
+      end
+    end
+
+  end
+end
+

data/lib/benches/matchers/run_in_less_than.rb

@@ -0,0 +1,27 @@
+module Benches
+  module Matchers
+
+    RSpec::Matchers.define :run_in_less_than do |duration|
+
+      match do |actual|
+        Benchmark.measure do
+          actual.call
+        end.utime.seconds < duration
+      end
+
+      failure_message_for_should do |actual|
+        "expected code to run in less than #{duration.inspect}"
+      end
+
+      failure_message_for_should_not do |actual|
+        "expected code not to run in less than #{duration.inspect} seconds"
+      end
+
+      description do
+        "run in less than #{duration.inspect}"
+      end
+
+    end
+
+  end
+end

data/lib/benches/version.rb

@@ -1,3 +1,3 @@
 module Benches
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/benches.rb

@@ -1,4 +1,5 @@
 require 'benchmark'
-require 'benches/routine'
-require 'benches/regimen'
-require 'benches/dsl'
+require 'active_support/core_ext/numeric/time'
+
+require 'benches/matchers/run'
+require 'benches/matchers/run_in_less_than'

data/spec/matchers/run_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Integer do
+  describe 'to_s' do
+    it 'meets the performance metrics when running 1 time' do
+      expect{5.to_s}.to run_in_less_than(1.second)
+    end
+
+    it 'meets the performance metrics when running 500 times' do
+      expect{5.to_s}.to run(500).times_in_less_than(5.seconds)
+    end
+  end
+end

metadata

@@ -1,21 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: benches
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.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.
+date: 2014-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+description: Benches defines a simple rspec matcher that allows you to create benchmarking
+  specs for your Ruby code.
 email:
 - evan.hemsley@gmail.com
-executables:
-- benchpress
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -23,15 +62,12 @@ files:
 - Gemfile.lock
 - README.md
 - benches.gemspec
-- bin/benchpress
 - lib/benches.rb
-- lib/benches/dsl.rb
-- lib/benches/regimen.rb
-- lib/benches/routine.rb
+- lib/benches/matchers/run.rb
+- lib/benches/matchers/run_in_less_than.rb
 - lib/benches/version.rb
 - license.md
-- spec/dsl_spec.rb
-- spec/routine_spec.rb
+- spec/matchers/run_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/ehemsley/benches
 licenses:
@@ -56,8 +92,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A simple DSL for benchmarking your Ruby code
+summary: A simple rspec matcher for testing performance metrics
 test_files:
-- spec/dsl_spec.rb
-- spec/routine_spec.rb
+- spec/matchers/run_spec.rb
 - spec/spec_helper.rb

data/bin/benchpress

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

data/lib/benches/dsl.rb

@@ -1,9 +0,0 @@
-def subject(instance, &block)
-  @regimen = Benches::Regimen.new(instance)
-  block.call
-  @regimen.call
-end
-
-def benches(input, *args)
-  @regimen.add_input(input, args)
-end

data/lib/benches/regimen.rb

@@ -1,33 +0,0 @@
-require 'colorize'
-
-module Benches
-  class Regimen
-    def initialize(subject)
-      @subject = subject
-      @inputs = []
-    end
-
-    def add_input(input, args)
-      @inputs << [input, args]
-    end
-
-    def call
-      puts @subject.to_s.blue
-      @inputs.each do |input|
-        input_string = input.first
-        args = input.last
-        routine(@subject, input_string, args) ? puts("  #{input_string}".green) : puts("  #{input_string}".red)
-      end
-    end
-
-    private
-
-    def routine(instance, input, args)
-      params = input.split(" ")
-
-      result = Benches::Routine.new(instance, params[3], params[0].to_i, *args).call
-      result.utime < params[7].to_f
-    end
-
-  end
-end

data/lib/benches/routine.rb

@@ -1,18 +0,0 @@
-module Benches
-  class Routine
-    def initialize(instance, method, repetitions, *args)
-      @instance = instance
-      @method = method
-      @repetitions = repetitions
-      @args = args
-    end
-
-    def call
-      Benchmark.measure do
-        @repetitions.times do
-          @instance.send(@method, *@args)
-        end
-      end
-    end
-  end
-end

data/spec/dsl_spec.rb

@@ -1,5 +0,0 @@
-require 'spec_helper'
-
-describe 'subject' do
-  
-end

data/spec/routine_spec.rb

@@ -1,63 +0,0 @@
-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).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).to be_a Benchmark::Tms
-      end
-    end
-  end
-end