rspec-hash_matchers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea2a03da6e3912a91d08f5fc6108f17f0dcffac7
+  data.tar.gz: 557ec4129a587ac8e6f5341e1cdff7e41485d49b
+SHA512:
+  metadata.gz: 3df47e60b9de66c56e1c6d943c6271fde23006e1522a3ace80ff8a95a5f9a0d15008f3a5ebfac23ca3149ea697e602339f4a0f333bf4630e1b64c24fbf71f1d7
+  data.tar.gz: 767c7411e29f503fc10230bb689a67bc6343171c3a41e946f5f03e580ac54f9c0063cf17e321b668ca8422371a161abeedb1e6dd6d1fab0dcf5315a32a1932a6

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/README.md

@@ -0,0 +1,65 @@
+# RSpec::HashMatchers
+
+This gem is an extension to [RSpec](https://github.com/rspec/rspec) that allows
+additional matchers for ruby hashes.
+
+Especially useful when testing API responses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-hash_matchers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-hash_matchers
+
+## Usage
+
+### Contain exactly keys (in array)
+
+Like RSpec's `contain_exactly`, but for hash and array of hashes.
+
+* Order never matters
+* Allows any mix of keys and keys with values (make sure you put the keys with
+  values last)
+* Must contain all entries (hash keys or array entries), nothing more and
+  nothing less
+
+```ruby
+specify do
+  # Hash
+  expect(a: 1, b: 2, c: 3, d: 4).to contain_exactly_keys :d, :b, c: 3, a: 1
+  # Array of hashes
+  expect([
+    { a: 1, b: 2, c: 3 },
+    { d: 4, e: 5, f: 6 },
+    { g: 7, h: 8, i: 9 },
+  ]).to contain_exactly_keys_in_array(
+    [:e, f: 6, d: 4],     # second line
+    [:a, :b, :c],         # first line
+    { i: 9, h: 8, g: 7 }, # third line
+  )
+end
+```
+
+See [the spec](spec/rspec/hash_matchers/contain_exactly_spec.rb) for all
+examples of matches and mismatches.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/odedniv/rspec-hash_matchers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/hash_matchers"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec/hash_matchers/contain_exactly.rb

@@ -0,0 +1,48 @@
+require 'active_support'
+
+module RSpec
+  module HashMatchers
+    module ContainExactly
+      extend RSpec::Matchers::DSL
+
+      matcher :contain_exactly_keys do |*expected|
+        match do |actual|
+          hash_matchers_contain_exactly_keys?(actual, expected)
+        end
+      end
+
+      matcher :contain_exactly_keys_in_array do |*expected|
+        match do |actual|
+          next false if not actual.is_a?(Array)
+          next false if actual.length != expected.length
+          actual = actual.clone
+          expected = expected.clone
+          result = true
+          while expected.any?
+            e = expected.shift
+            i = actual.find_index { |a| hash_matchers_contain_exactly_keys?(a, e) }
+            break result = false if i.nil?
+            actual.delete_at(i)
+          end
+          result
+        end
+      end
+
+      def hash_matchers_contain_exactly_keys?(actual, expected)
+        return false if not actual.is_a?(Hash)
+
+        array = expected.is_a?(Hash) ? [expected] : expected.clone
+        hash = array.extract_options!
+
+        return false if actual.length != array.length + hash.length
+        return false if array.any? { |k| not actual.include?(k) }
+        return false if hash.any? { |k, v| actual[k] != v }
+        true
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::HashMatchers::ContainExactly
+end

data/lib/rspec/hash_matchers/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module HashMatchers
+    VERSION = "0.1.0"
+  end
+end

data/lib/rspec/hash_matchers.rb

@@ -0,0 +1,2 @@
+require "rspec/hash_matchers/version"
+require "rspec/hash_matchers/contain_exactly"

data/rspec-hash_matchers.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/hash_matchers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-hash_matchers"
+  spec.version       = RSpec::HashMatchers::VERSION
+  spec.authors       = ["Oded Niv"]
+  spec.email         = ["oded.niv@gmail.com"]
+
+  spec.summary       = %q{Better matchers for hashes.}
+  spec.description   = %q{RSpec extension to better match hashes.}
+  spec.homepage      = "https://github.com/odedniv/rspec-hash_matchers"
+  spec.license       = "UNLICENSE"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rspec-expectations", ">= 3.0"
+  spec.add_runtime_dependency "activesupport", ">= 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: rspec-hash_matchers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oded Niv
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: RSpec extension to better match hashes.
+email:
+- oded.niv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- UNLICENSE
+- bin/console
+- bin/setup
+- lib/rspec/hash_matchers.rb
+- lib/rspec/hash_matchers/contain_exactly.rb
+- lib/rspec/hash_matchers/version.rb
+- rspec-hash_matchers.gemspec
+homepage: https://github.com/odedniv/rspec-hash_matchers
+licenses:
+- UNLICENSE
+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.7
+signing_key: 
+specification_version: 4
+summary: Better matchers for hashes.
+test_files: []