rspec-stopwatch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e0a606b083a128209f5db137f74421518a7111c
+  data.tar.gz: 31a6dd12c74dbb4c430a7082e9bc8a72a4e635f8
+SHA512:
+  metadata.gz: 7cf4e151d64cd3e0cfa51d98c3762f6011415e4afb605c041bff17d7d4c097295eb95794c284614dae6a9c009e8ed7af15dd49b8110a2feaed3842dd4665d2b9
+  data.tar.gz: 117c606c609d00b87a7de6d5430b9d0fca1c80e99509cc798279b52a6d07728bbf91fbde7246ebf286d543bbf93aad25a9f33c824b06c9a028ee3b960dd925f8

data/lib/rspec-stopwatch.rb

@@ -0,0 +1,2 @@
+require_relative './rspec/stopwatch/matchers/run_for_matcher'
+

data/lib/rspec/stopwatch/matchers/run_for_matcher.rb

@@ -0,0 +1,83 @@
+require 'rspec'
+
+require 'active_support/core_ext/numeric/time'
+require 'benchmark'
+
+RSpec::Matchers.define :run_for do |time|
+  [:<, :<=, :>, :>=].each do |operator|
+    define_method(operator) do |expected|
+      RunForComparedTo.new(operator, expected)
+    end
+  end
+
+  class RunForComparedTo < RSpec::Matchers::BuiltIn::BaseMatcher
+    attr_reader :operator, :expected, :actual, :config
+
+    def initialize(operator, expected)
+      @operator, @expected = operator, expected.to_f
+
+      @config = {
+        :average_over => 10.times,
+        :drop_first => 1,
+      }
+    end
+
+    def matches?(block)
+      raise ArgumentError, 'Expecting a block to `expect`' if !block.is_a?(Proc)
+
+      begin
+        warmup_runs.each { block.call }
+        benchmark = Benchmark.measure { runs.each { block.call } }
+
+        @actual = benchmark.total / runs.count
+        @actual.in_milliseconds.send(operator, expected.in_milliseconds)
+      rescue ArgumentError
+        false
+      end
+    end
+
+    def supports_block_expectations?
+      true
+    end
+
+    def failure_message
+      failure_message_for_operator(operator)
+    end
+
+    def failure_message_when_negated
+      failure_message_for_operator(opposite_operator)
+    end
+
+    def description
+      "run for #{operator} #{expected_str}"
+    end
+
+    private
+
+    def runs
+      config[:average_over]
+    end
+
+    def warmup_runs
+      config[:drop_first].times
+    end
+
+    def failure_message_for_operator(operator)
+      "expected: #{operator} #{expected_str}\n" \
+      "     got: #{operator.to_s.gsub(/./, ' ')} #{actual_str}"
+    end
+
+    def opposite_operator
+      { :< => :>=, :<= => :>, :> => :<=, :>= => :< }[operator]
+    end
+
+    def expected_str
+      "#{expected.in_milliseconds} ms"
+    end
+
+    def actual_str
+      "#{actual.in_milliseconds} ms"
+    end
+  end
+end
+

data/lib/rspec/stopwatch/version.rb

@@ -0,0 +1,6 @@
+module RSpec
+  module Stopwatch
+    VERSION = '0.1.0'
+  end
+end
+

data/spec/matchers/run_for_spec.rb

@@ -0,0 +1,64 @@
+require 'rspec-stopwatch'
+
+describe :run_for, :matcher => true do
+  describe 'timing' do
+    it 'reports comparisons correctly' do
+      expect { 1000000.times { } }.to run_for > 0.001.seconds
+    end
+
+    it 'ignores real time' do
+      expect { sleep(0.2) }.to run_for < 0.1.second
+    end
+  end
+
+  describe 'success messages' do
+    subject { RunForComparedTo.new(:<, 1.second) }
+
+    before do
+      subject.matches?(lambda { })
+    end
+
+    it 'includes the operator' do
+      expect(subject.description).to include '<'
+    end
+
+    it 'includes the expectation time' do
+      expect(subject.description).to include '1000.0 ms'
+    end
+  end
+
+  describe 'failure messages' do
+    subject { RunForComparedTo.new(:>, 1.second) }
+
+    before do
+      subject.matches?(lambda { })
+    end
+
+    it 'includes the operator' do
+      expect(subject.failure_message).to include '>'
+    end
+
+    it 'includes the expected time' do
+      expect(subject.failure_message).to include '1000.0 ms'
+    end
+
+    it 'includes the actual time' do
+      expect(subject.failure_message).to include '0.0 ms'
+    end
+
+    context 'negated' do
+      it 'includes the opposite operator' do
+        expect(subject.failure_message_when_negated).to include '<='
+      end
+    end
+  end
+
+  describe 'error messages' do
+    it "raises when a block isn't passed" do
+      expect do
+        expect(:pikachu).to run_for < 1.second
+      end.to raise_error(ArgumentError).with_message 'Expecting a block to `expect`'
+    end
+  end
+end
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: rspec-stopwatch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henry J. Wylde
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Provides a matcher that checks the run time of a block
+email:
+- public@hjwylde.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec-stopwatch.rb
+- lib/rspec/stopwatch/matchers/run_for_matcher.rb
+- lib/rspec/stopwatch/version.rb
+- spec/matchers/run_for_spec.rb
+homepage: https://git.powershop.co.nz/hjwylde/rspec-stopwatch-gem
+licenses:
+- BSD-3-Clause
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby gem for writing performance specs
+test_files:
+- spec/matchers/run_for_spec.rb