rspec_structure_matcher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28338edd23126a746b8847ffdcebecdd274895cb
+  data.tar.gz: 0647f41530631a0493bf2eee3db19e9ff0951e37
+SHA512:
+  metadata.gz: 7b48962f3160fe8d88191738cfef1afa2a668e878985737a28c5faf95d82e5e95caf61952b53ea6210ef64074bef24028d910a433471649abf85907ed34cd45f
+  data.tar.gz: b14a98ff870dbe04121b8debadd54439a672b3a44c9e24f2dbc777ff0f1fc002a4040f18694d4bffd818aa689fa70e34be2f81f6f578dea490281f8920bb16ab

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tony Marklove
+
+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,77 @@
+# RSpec Structure Matcher
+
+A simple JSON structure matcher for RSpec.
+
+When building an API it is nice to be able to test the response structure. Doing this with the built-in RSpec matchers can get tiresome. This matcher provides a nicer way to test for expected keys, value types, and even matching values against regular expressions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec_structure_matcher'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec_structure_matcher
+
+## Usage
+
+Define an expected response structure:
+
+    expected_video_response = {
+      title: String,
+      episode_number: Object, # Optional, may be null
+      tv_show: Hash,
+      published_on: /\d{4}-\d{2}-\d{2}/,
+      breadcrumbs: Array,
+      images: Hash
+    }
+
+Then, assuming `video` is a parsed JSON response you can simply expect against the expected structure:
+
+    expect(video).to have_structure(expected_video_response)
+
+### Comparison Types
+
+Including an item in the expected structure ensures that a key with that name exists in the response.
+
+Native Types (String, Hash, etc.)
+: Test that the value matches the type, using `is_a?`.
+
+Object
+: Useful for testing the key exists but not requiring an particular type. Optional values (which are `null` if they are not present) can use this as well.
+
+Regular Expression
+: Tests the value for a match against the regular expression. Very useful for things like dates where your code is relying on a particular format.
+
+### Testing Optional Values
+
+As mentioned above, you can use `Object` to test optional values, so that the test will pass even if the response contains a `null`. To add an extra level of checking you can use the `optionally_be` matcher:
+
+    expect(video['episode_number']).to optionally_be(Integer)
+
+This will pass if `video['episode_number']` is either `null` or `is_a?(Integer)`.
+
+### Deep Structures
+
+Similar to optional values, testing deep strucutres has been kept as simple as possible. Simply define a new expected structure:
+
+    tv_show_expected_structure = {
+      title: string
+    }
+
+And then compare the structure as normal:
+
+    expect(video['tv_show']) to have_structure(tv_show_expected_structure)
+
+## 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/have_structure_matcher.rb

@@ -0,0 +1,30 @@
+RSpec::Matchers.define :have_structure do |expected|
+  match do |actual|
+    missing_items(actual, expected).empty?
+  end
+
+  failure_message_for_should do |actual|
+    missing = missing_items(actual, expected)
+    "missing or invalid keys: #{missing.join(', ')}\n\n#{actual.slice(*missing)}"
+  end
+
+  def missing_items(actual, expected)
+    missing_items = []
+
+    expected.each do |key, value|
+      if !actual.has_key?(key.to_s) || !value_match(actual[key.to_s], value)
+        missing_items << key.to_s
+      end
+    end
+
+    missing_items
+  end
+
+  def value_match(actual_value, expected_value)
+    if expected_value.is_a?(Regexp)
+      actual_value =~ expected_value
+    else
+      actual_value.is_a?(expected_value)
+    end
+  end
+end

data/lib/optionally_be_matcher.rb

@@ -0,0 +1,9 @@
+RSpec::Matchers.define :optionally_be do |expected|
+  match do |actual|
+    actual.nil? || actual.is_a?(expected)
+  end
+
+  failure_message_for_should do |actual|
+    "#{actual} must be 'nil' or '#{expected}'"
+  end
+end

data/lib/rspec_structure_matcher.rb

@@ -0,0 +1,2 @@
+require 'have_structure_matcher'
+require 'optionally_be_matcher'

data/lib/version.rb

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

data/rspec_structure_matcher.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec_structure_matcher"
+  spec.version       = RspecStructureMatcher::VERSION
+  spec.authors       = ["Tony Marklove"]
+  spec.email         = ["tony@new-bamboo.co.uk"]
+  spec.description   = %q{Rspec matchers for structured JSON responses. Compare expected keys, value types, or even match values against regular expressions.}
+  spec.summary       = %q{Rspec matchers for structured JSON responses.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "rspec"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rspec_structure_matcher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tony Marklove
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-18 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Rspec matchers for structured JSON responses. Compare expected keys,
+  value types, or even match values against regular expressions.
+email:
+- tony@new-bamboo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/have_structure_matcher.rb
+- lib/optionally_be_matcher.rb
+- lib/rspec_structure_matcher.rb
+- lib/version.rb
+- rspec_structure_matcher.gemspec
+homepage: ''
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Rspec matchers for structured JSON responses.
+test_files: []