rspec-instrumentation-matcher 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-instrumentation-matcher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Vlad Verestiuc
+
+MIT License
+
+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/README.md

@@ -0,0 +1,34 @@
+rspec-instrumentation-matcher
+=============================
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-instrumentation-matcher'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-instrumentation-matcher
+
+## Usage
+
+    expect{ subject.do_something }.to instrument("key").with( foo: :bar )
+    expect{ subject.do_something }.to instrument("key").once
+    expect{ subject.do_something }.to instrument("key").at_least(1)
+    expect{ subject.do_something }.to instrument("key").at_most(10)
+    expect{ subject.do_something }.to instrument("key").times(5)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rspec-instrumentation-matcher.rb

@@ -0,0 +1,141 @@
+require "rspec-instrumentation-matcher/version"
+
+module RSpec
+  module Instrumentation
+    module Matcher
+      def instrument(subject)
+        InstrumentMatcher.new(subject)
+      end
+      class InstrumentMatcher
+
+        def initialize(subject)
+          @subject = subject
+          @payload = nil
+          @received = 0
+          @at_least = 1
+        end
+
+        def matches?(event_proc)
+          raise_block_syntax_error if block_given?
+
+          subscription = ActiveSupport::Notifications.subscribe @subject do |name, start, finish, id, _payload|
+            @payload = _payload
+            @received += 1
+          end
+
+          event_proc.call
+
+          ActiveSupport::Notifications.unsubscribe(subscription)
+
+          times? and at_least? and at_most? and with?
+
+        end
+
+        def failure_message
+          message = "Expected #{@subject} to be instrumented"
+          message << " at least #{count @at_least}" unless at_least?
+          message << " at most #{count @at_most}" unless at_most?
+          message << " exactly #{count @times}" unless times?
+
+          if !at_least? or !at_most? or !times?
+            message << " but was instrumented #{count @received}"
+            message << " and the payload should have been" unless with?
+          else
+            message << " with" unless with?
+          end
+
+          message << " #{@payload_expectation.inspect} instead of #{@payload.inspect}" unless with?
+
+
+          message
+
+        end
+
+        def at_least(value)
+          @at_least=value
+          self
+        end
+
+        def at_most(value)
+          @at_most = value
+          self
+        end
+
+        def once
+          times(1)
+        end
+
+        def never
+          times(0)
+        end
+
+
+
+        def times(value)
+          @times = value
+          self
+        end
+
+
+        def with(expectation)
+          @with = true
+          @payload_expectation = expectation
+          self
+        end
+
+
+        private
+        def count(value)
+          if value == 1
+            "1 time"
+          else
+            "#{value} times"
+          end
+        end
+
+        def at_least?
+          return true unless @at_least
+          @received <= @at_least
+        end
+
+        def at_most?
+          return true unless @at_most
+          @received >= @at_most
+        end
+
+        def times?
+          return true unless @times
+          @received == @times
+        end
+
+        def delta_payload
+          unmatched = @payload_expectation.reject do |key,value|
+            matched_value?(value, @payload[key]) if @payload.key? key
+          end
+        end
+
+        def with?
+          !@payload.nil? and delta_payload.size == 0
+        end
+
+
+        def matched_value?(expected, actual)
+          case expected
+          when actual then true
+          when Class then actual.is_a? expected
+          when Regexp then actual =~ expected
+          else false
+          end
+        end
+
+
+      end
+    end
+  end
+end
+
+module RSpec::Matchers
+  include RSpec::Instrumentation::Matcher
+end
+
+

data/lib/rspec-instrumentation-matcher/version.rb

@@ -0,0 +1,7 @@
+module Rspec
+  module Instrumentation
+    module Matcher
+      VERSION = "0.0.1"
+    end
+  end
+end

data/rspec-instrumentation-matcher.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec-instrumentation-matcher/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rspec-instrumentation-matcher"
+  gem.version       = Rspec::Instrumentation::Matcher::VERSION
+  gem.authors       = ["Vlad Verestiuc"]
+  gem.email         = ["vlad.verestiuc@me.com"]
+  gem.description   = %q{Rspec matcher for ActiveSupport::Notifications}
+  gem.summary       = %q{Support for spec-ing ActiveSupport::Notifications.instrument calls}
+  gem.homepage      = "https://github.com/vvlad/rspec-instrumentation-matcher"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rspec-expectations'
+  gem.add_dependency 'activesupport'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: rspec-instrumentation-matcher
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Vlad Verestiuc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rspec matcher for ActiveSupport::Notifications
+email:
+- vlad.verestiuc@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec-instrumentation-matcher.rb
+- lib/rspec-instrumentation-matcher/version.rb
+- rspec-instrumentation-matcher.gemspec
+homepage: https://github.com/vvlad/rspec-instrumentation-matcher
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Support for spec-ing ActiveSupport::Notifications.instrument calls
+test_files: []
+has_rdoc: