useful_matchers 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjZhODc2MmI3MTBkODg3MDdjMjhhNmVhYWI1M2FlY2EyNTdiYWMyZQ==
+  data.tar.gz: !binary |-
+    ODA0NmZkNWM5ODk0YzhjM2I1ZjA0ZjMwMzkzMTZmOTU0ZWNkN2NlYg==
+SHA512:
+  metadata.gz: !binary |-
+    YjMyNTRhZWNjNDNjOTUxYzY0N2E1N2I3M2YzOTIwODljZmEwZTBhNDhiZjEx
+    ZTY0YWYyM2IxNTdkZDIzNDlkZWYyZGEwOGQwYjc3OTY2YzU5OWFjN2Q5YTY5
+    OWZlYWNmMmVkOTJhOWJlYmY5NjdhMDIyY2QzZDBmM2I1MGE4OGE=
+  data.tar.gz: !binary |-
+    ZDE1MDFhMmY1NDJlMTQ1YTZmMmFiZjQzMTZhMDFlOTI2NmE2ZDQwMzg1Zjlj
+    YWNlY2QyNzhmOTkwM2RiOWUzNzYzYTg0ZGI0NGM1NDg3MzJkN2MwZjY3YmEz
+    YzFiNGYyZmE1NzMyZTYxYjRhODY3MTYzYTQyYmMxNjQ5MDk4YWU=

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2014 Ersin Akinci, Two Maestros LLC
+Portions copyright (c) 2006-2014, Tammer Saleh, thoughtbot, inc.
+
+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,36 @@
+# UsefulMatchers
+
+A useful collection of matchers for RSpec.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'useful_matchers'
+
+Or install it yourself as:
+
+    $ gem install useful_matchers
+
+## Usage
+
+Add the following to your spec_helper.rb file:
+
+    require 'useful_matchers/matchers'
+
+Then start using the matchers in your specs.
+
+## Matchers
+
+    include_key(key)
+    include_key(key).with_value(value)
+
+TODO
+
+## Contributing
+
+1. Fork it ( https://github.com/twomaestros/useful-matchers/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/useful_matchers.rb

@@ -0,0 +1,2 @@
+require "useful_matchers/version"
+require "useful_matchers/matchers"

data/lib/useful_matchers/matchers.rb

@@ -0,0 +1,31 @@
+require 'useful_matchers/matchers/independent'
+
+module UsefulMatchers
+  module Matchers
+  end
+end
+
+def recurse_to_leaf_modules(mod)
+  leaf_nodes = []
+  next_level = mod.constants.collect {
+    |c| mod.const_get(c)
+  }.select {
+    |c| c.instance_of?(Module)
+  }.each do |child|
+    leaf_nodes.concat recurse_to_leaf_modules child
+  end
+  
+  if next_level.empty? && mod.instance_of?(Module)
+    return [mod]
+  else
+    return leaf_nodes
+  end
+end
+
+if RSpec.respond_to?(:configure)
+  RSpec.configure do |config|
+    recurse_to_leaf_modules(UsefulMatchers::Matchers).each do |mod|
+      config.include mod
+    end
+  end
+end

data/lib/useful_matchers/matchers/independent.rb

@@ -0,0 +1,7 @@
+require 'useful_matchers/matchers/independent/hashes'
+
+module UsefulMatchers
+  # Matchers that don't depend on Rails
+  module Independent
+  end
+end

data/lib/useful_matchers/matchers/independent/hashes.rb

@@ -0,0 +1,10 @@
+require 'useful_matchers/matchers/independent/hashes/include_key_and_value'
+
+module UsefulMatchers
+  module Matchers
+    module Independent
+      module Hashes
+      end
+    end
+  end
+end

data/lib/useful_matchers/matchers/independent/hashes/include_key_and_value.rb

@@ -0,0 +1,90 @@
+module UsefulMatchers
+  module Matchers
+    module Independent
+      module Hashes
+        def include_key(key)
+          IncludeKeyAndValueMatcher.new key
+        end
+        
+        class IncludeKeyAndValueMatcher
+          def initialize(key)
+            @key = key
+            
+            @value     = nil
+            # Use boolean flag since we can't test whether @value is set by testing whether @value is nil
+            # because we should be able to evaluate nil values.
+            @value_set = false
+            @subject   = nil
+          end
+          
+          def matches?(subject)
+            @subject = subject
+            
+            if @value_set
+              ensure_subject_has_target_key && ensure_target_key_corresponds_to_target_value
+            else
+              ensure_subject_has_target_key
+            end
+          end
+          
+          def with_value(value)
+            @value     = value
+            @value_set = true
+            self
+          end
+          
+          def failure_message
+            if @value_set
+              "expected that the value for key #{format_key} in the hash is #{format_value}"
+            else
+              "expected that the hash contains #{format_key} as a key"
+            end
+          end
+          alias failure_message_for_should failure_message
+          
+          def failure_message_when_negated
+            if @value_set
+              "expected that the value for key #{format_key} in the hash isn't #{format_value}"
+            else
+              "expected that the hash doesn't contain #{format_key} as a key"
+            end
+          end
+          alias failure_message_for_should_not failure_message_when_negated
+          
+          private
+          
+          def ensure_subject_has_target_key
+            @subject.keys.include?(@key)
+          end
+          
+          def ensure_target_key_corresponds_to_target_value
+            @subject[@key] == @value
+          end
+          
+          def format_key
+            format_parameter(@key)
+          end
+          
+          def format_value
+            format_parameter(@value)
+          end
+          
+          def format_parameter(param)
+            formatted_param = param
+            
+            case param
+            when ''
+              formatted_param = 'empty string'
+            when nil
+              formatted_param = 'nil'
+            when Symbol
+              formatted_param = ":#{param.to_s}"
+            end
+            
+            formatted_param
+          end
+        end
+      end
+    end
+  end
+end

data/lib/useful_matchers/version.rb

@@ -0,0 +1,3 @@
+module UsefulMatchers
+  VERSION = "0.0.1"
+end

data/spec/matchers/independent/hashes/include_key_and_value_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe UsefulMatchers::Matchers::Independent::Hashes::IncludeKeyAndValueMatcher do
+  let(:matched_hash)              { { key => value } }
+  let(:partially_mismatched_hash) { { key => 'Adams' } }
+  let(:totally_mismatched_hash)           { { john: 'Adams' } }
+  
+  context 'when the target key and value are typical' do
+    let(:key)                    { :george }
+    let(:value)                  { 'Washington' }
+    let(:key_only_msg)           { "expected that the hash contains :george as a key" }
+    let(:key_with_value_msg)     { "expected that the value for key :george in the hash is Washington" }
+    let(:neg_key_only_msg)       { "expected that the hash doesn't contain :george as a key" }
+    let(:neg_key_with_value_msg) { "expected that the value for key :george in the hash isn't Washington" }
+    it_behaves_like 'an IncludeKeyAndValueMatcher'
+  end
+  
+  context 'when the target key and value are nils' do
+    let(:key)                    { nil }
+    let(:value)                  { nil }
+    let(:key_only_msg)           { "expected that the hash contains nil as a key" }
+    let(:key_with_value_msg)     { "expected that the value for key nil in the hash is nil" }
+    let(:neg_key_only_msg)       { "expected that the hash doesn't contain nil as a key" }
+    let(:neg_key_with_value_msg) { "expected that the value for key nil in the hash isn't nil" }
+    it_behaves_like 'an IncludeKeyAndValueMatcher'
+  end
+  
+  context 'when the target key and value are empty strings' do
+    let(:key)                    { '' }
+    let(:value)                  { '' }
+    let(:key_only_msg)           { "expected that the hash contains empty string as a key" }
+    let(:key_with_value_msg)     { "expected that the value for key empty string in the hash is empty string" }
+    let(:neg_key_only_msg)       { "expected that the hash doesn't contain empty string as a key" }
+    let(:neg_key_with_value_msg) { "expected that the value for key empty string in the hash isn't empty string" }
+    it_behaves_like 'an IncludeKeyAndValueMatcher'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+PROJECT_ROOT = File.expand_path('../..', __FILE__)
+Dir[ File.join(PROJECT_ROOT, 'spec/support/**/*.rb') ].each { |file| require file }
+
+require 'useful_matchers/matchers'
+
+RSpec.configure do |config|
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+  config.order = "random"
+  config.color = true
+end

data/spec/support/examples/matchers/independent/hashes/include_key_and_value_examples.rb

@@ -0,0 +1,73 @@
+shared_examples "an IncludeKeyAndValueMatcher" do
+  context 'when evaluating a matched hash (target key and target value are present)' do
+    context 'when positiviely evaluating' do
+      it 'succeeds (in matching just the key)' do
+        expect(matched_hash).to include_key(key)
+      end
+      it 'succeeds (in matching both the key and the value)' do
+        expect(matched_hash).to include_key(key).with_value(value)
+      end
+    end
+    
+    context 'when negatively evaluating' do
+      it 'fails (in matching just the key)' do
+        expect {
+          expect(matched_hash).to_not include_key(key)
+        }.to fail_with_message(neg_key_only_msg)
+      end
+      it 'fails (in matching both the key and the value)' do
+        expect {
+          expect(matched_hash).to_not include_key(key).with_value(value)
+        }.to fail_with_message(neg_key_with_value_msg)
+      end
+    end
+  end
+  
+  context 'when evaluating a partially mismatched hash (only target key is present)' do
+    context 'when positiviely evaluating' do
+      it 'succeeds (in matching just the key)' do
+        expect(partially_mismatched_hash).to include_key(key)
+      end
+      it 'fails (in matching both the key and the value)' do
+        expect {
+          expect(partially_mismatched_hash).to include_key(key).with_value(value)
+        }.to fail_with_message(key_with_value_msg)
+      end
+    end
+    
+    context 'when negatively evaluating' do
+      it 'fails (in matching just the key)' do
+        expect {
+          expect(partially_mismatched_hash).to_not include_key(key)
+        }.to fail_with_message(neg_key_only_msg)
+      end
+      it 'succeeds (in matching both the key and the value)' do
+        expect(partially_mismatched_hash).to_not include_key(key).with_value(value)
+      end
+    end
+  end
+  
+  context 'when evaluating a totally mismatched hash (neither target key nor target value are present)' do
+    context 'when positiviely evaluating' do
+      it 'fails (in matching just the key)' do
+        expect {
+          expect(totally_mismatched_hash).to include_key(key)
+        }.to fail_with_message(key_only_msg)
+      end
+      it 'fails (in matching both the key and the value)' do
+        expect {
+          expect(totally_mismatched_hash).to include_key(key).with_value(value)
+        }.to fail_with_message(key_with_value_msg)
+      end
+    end
+    
+    context 'when negatively evaluating' do
+      it 'succeeds (in matching just the key)' do
+        expect(totally_mismatched_hash).to_not include_key(key)
+      end
+      it 'succeeds (in matching both the key and the value)' do
+        expect(totally_mismatched_hash).to_not include_key(key).with_value(value)
+      end
+    end
+  end
+end

data/spec/support/matchers/fail_with_message_matcher.rb

@@ -0,0 +1,70 @@
+# Copyright (c) 2006-2014, Tammer Saleh, thoughtbot, inc.
+
+# 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.
+
+# Taken from shoulda_matchers:
+# https://github.com/thoughtbot/shoulda-matchers/blob/master/spec/support/fail_with_message_matcher.rb
+
+RSpec::Matchers.define :fail_with_message do |expected|
+  def supports_block_expectations?
+    true
+  end
+
+  match do |block|
+    @actual = nil
+
+    begin
+      block.call
+    rescue RSpec::Expectations::ExpectationNotMetError => ex
+      @actual = ex.message
+    end
+
+    @actual && @actual == expected
+  end
+
+  def failure_message
+    msg = "Expectation should have failed with message '#{expected}'"
+
+    if @actual
+      msg << ", actually failed with '#{@actual}'"
+    else
+      msg << ", but did not fail."
+    end
+
+    msg
+  end
+
+  def failure_message_for_should
+    failure_message
+  end
+
+  def failure_message_when_negated
+    msg  = "Expectation should not have failed with message '#{expected}'"
+    msg << ", but did."
+
+    msg
+  end
+
+  def failure_message_for_should_not
+    failure_message_when_negated
+  end
+end

data/useful_matchers.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'useful_matchers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "useful_matchers"
+  spec.version       = UsefulMatchers::VERSION
+  spec.authors       = ["Two Maestros"]
+  spec.email         = ["team@twomaestros.com"]
+  spec.summary       = %q{A set of useful matchers for RSpec}
+  spec.description   = %q{A set of useful matchers for RSpec}
+  spec.homepage      = "http://github.com/twomaestros/useful-matchers"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "rspec"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: useful_matchers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Two Maestros
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A set of useful matchers for RSpec
+email:
+- team@twomaestros.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/useful_matchers.rb
+- lib/useful_matchers/matchers.rb
+- lib/useful_matchers/matchers/independent.rb
+- lib/useful_matchers/matchers/independent/hashes.rb
+- lib/useful_matchers/matchers/independent/hashes/include_key_and_value.rb
+- lib/useful_matchers/version.rb
+- spec/matchers/independent/hashes/include_key_and_value_spec.rb
+- spec/spec_helper.rb
+- spec/support/examples/matchers/independent/hashes/include_key_and_value_examples.rb
+- spec/support/matchers/fail_with_message_matcher.rb
+- useful_matchers.gemspec
+homepage: http://github.com/twomaestros/useful-matchers
+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 set of useful matchers for RSpec
+test_files:
+- spec/matchers/independent/hashes/include_key_and_value_spec.rb
+- spec/spec_helper.rb
+- spec/support/examples/matchers/independent/hashes/include_key_and_value_examples.rb
+- spec/support/matchers/fail_with_message_matcher.rb