should_be_faster 0.0.1

data/README

@@ -0,0 +1,9 @@
+$ gem install should_be_faster
+
+describe Benchmarkable do
+  it 'should be faster than the old crap code' do
+    old = lambda { 100.times.map { rand } }
+    new = lambda { true }
+    old.should be_at_least(10).times.slower_than(new)
+  end
+end

data/lib/should_be_faster.rb

@@ -0,0 +1,103 @@
+require 'benchmark'
+require 'spec'
+require 'spec/matchers'
+
+def _benchmark(code, iter)
+  Benchmark.measure { iter.times { code.call } }
+end
+
+Spec::Matchers.define(:be_faster_than) do |rhs_code, options|
+  options ||= {}
+  options[:matcher] = self
+  options[:faster]  = true
+  Spec::Matchers::BenchmarkComparison.new(rhs_code, options).benchmark_comparison
+end
+
+Spec::Matchers.define(:be_slower_than) do |rhs_code, options|
+  options ||= {}
+  options[:matcher] = self
+  options[:faster]  = false
+  Spec::Matchers::BenchmarkComparison.new(rhs_code, options).benchmark_comparison
+end
+
+module Spec
+  module Matchers
+    class BenchmarkComparison
+      def initialize(rhs_code, options={})
+        @rhs_code = rhs_code
+        @options  = options
+        @options[:iterations] ||= 100
+        @options[:factor]     ||= 1
+        @options[:faster]       = @options[:faster] ? true : false  # I hate ||= not working with booleans
+      end
+
+      def benchmark_comparison
+        factor  = @options[:factor]
+        iter    = @options[:iterations]
+        matcher = @options[:matcher]
+        faster  = @options[:faster]
+        rhs     = _benchmark(@rhs_code, iter).real
+        lhs     = nil
+
+        matcher.match do |lhs_code|
+          lhs = (_benchmark(lhs_code, iter).real * factor)
+          if faster
+            lhs < rhs
+          else
+            lhs > rhs
+          end
+        end
+
+        matcher.instance_eval do
+          failure_message_for_should do |actual|
+            if faster
+              "ran too slow: #{lhs / rhs}x, #{lhs - rhs}s"
+            else
+              "ran too fast: #{rhs / lhs}x, #{rhs - lhs}s"
+            end
+          end
+
+          failure_message_for_should_not do |actual|
+            if faster
+              "ran too slow: #{rhs / lhs}x, #{rhs - lhs}s"
+            else
+              "ran too fast: #{lhs / rhs}x, #{lhs - rhs}s"
+            end
+          end
+
+          description do
+            if faster
+              "be faster than #{rhs}"
+            else
+              "be slower than #{rhs}"
+            end
+          end
+        end
+      end
+    end
+
+    class BePredicate < Be
+      def times
+        self
+      end
+
+      def faster_than(rhs_code, options={})
+        Matcher.new(:faster_than) do
+          options ||= {}
+          options[:faster]  = true
+          options[:matcher] = self
+          Spec::Matchers::BenchmarkComparison.new(rhs_code, options).benchmark_comparison
+        end
+      end
+
+      def slower_than(rhs_code, options={})
+        Matcher.new(:slower_than) do
+          options ||= {}
+          options[:faster]  = false
+          options[:matcher] = self
+          Spec::Matchers::BenchmarkComparison.new(rhs_code, options).benchmark_comparison
+        end
+      end
+    end
+  end
+end

data/spec/should_be_faster_spec.rb

@@ -0,0 +1,67 @@
+require 'lib/should_be_faster'
+
+describe 'should_be_faster' do
+  it 'should default to 100 iterations' do
+    options = mock('hash')
+    options.stub!(:[]).and_return(nil)
+    options.stub!(:[]=)
+    options.should_receive(:[]=).with(:iterations, 100)
+    Spec::Matchers::BenchmarkComparison.new(nil, options)
+  end
+
+  it 'should take an options hash to specify iterations' do
+    options = mock('hash')
+    options.stub!(:[])
+    options.stub!(:[]=)
+    options.stub!(:[]).with(:iterations).and_return(20)
+    Spec::Matchers::BenchmarkComparison.new(nil, options)
+    options[:iterations].should == 20
+  end
+
+  context 'when ensuring code is' do
+    before do
+      @fast = lambda { [1, 2, 3, 4, 5, 6, 7, 8, 9].sort }
+      @slow = lambda { 100.times.map { rand } }
+    end
+
+    context 'faster_than' do
+      it 'should ensure lhs  < rhs' do
+        @fast.should be_faster_than(@slow)
+      end
+
+      it 'should ensure lhs !> rhs' do
+        @slow.should_not be_faster_than(@fast)
+      end
+    end
+
+    context 'slower_than' do
+      it 'should ensure lhs  > rhs' do
+        @slow.should be_slower_than(@fast)
+      end
+
+      it 'should ensure lhs !< rhs' do
+        @fast.should_not be_slower_than(@slow)
+      end
+    end
+
+    context 'at_least(x).times.faster_than' do
+      it 'should ensure lhs  < rhs' do
+        @fast.should be_at_least(2).times.faster_than(@slow)
+      end
+
+      it 'should ensure lhs !> rhs' do
+        @slow.should_not be_at_least(2).times.faster_than(@fast)
+      end
+    end
+
+    context 'at_least(x).times.slower_than' do
+      it 'should ensure lhs  > rhs' do
+        @slow.should be_at_least(2).times.slower_than(@fast)
+      end
+
+      it 'should ensure lhs !< rhs' do
+        @fast.should_not be_at_least(2).times.slower_than(@slow)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: should_be_faster
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Turnbull
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-16 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: dsturnbull@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/should_be_faster.rb
+- README
+has_rdoc: true
+homepage: http://github.com/dsturnbull/should_be_faster
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: provides rspec matcher to do simple benchmark tests
+test_files: 
+- spec/should_be_faster_spec.rb