rspec_structure_matcher 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +77 -0
- data/Rakefile +1 -0
- data/lib/have_structure_matcher.rb +30 -0
- data/lib/optionally_be_matcher.rb +9 -0
- data/lib/rspec_structure_matcher.rb +2 -0
- data/lib/version.rb +3 -0
- data/rspec_structure_matcher.gemspec +25 -0
- metadata +97 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 28338edd23126a746b8847ffdcebecdd274895cb
|
4
|
+
data.tar.gz: 0647f41530631a0493bf2eee3db19e9ff0951e37
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 7b48962f3160fe8d88191738cfef1afa2a668e878985737a28c5faf95d82e5e95caf61952b53ea6210ef64074bef24028d910a433471649abf85907ed34cd45f
|
7
|
+
data.tar.gz: b14a98ff870dbe04121b8debadd54439a672b3a44c9e24f2dbc777ff0f1fc002a4040f18694d4bffd818aa689fa70e34be2f81f6f578dea490281f8920bb16ab
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Tony Marklove
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,77 @@
|
|
1
|
+
# RSpec Structure Matcher
|
2
|
+
|
3
|
+
A simple JSON structure matcher for RSpec.
|
4
|
+
|
5
|
+
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.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
gem 'rspec_structure_matcher'
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install rspec_structure_matcher
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
Define an expected response structure:
|
24
|
+
|
25
|
+
expected_video_response = {
|
26
|
+
title: String,
|
27
|
+
episode_number: Object, # Optional, may be null
|
28
|
+
tv_show: Hash,
|
29
|
+
published_on: /\d{4}-\d{2}-\d{2}/,
|
30
|
+
breadcrumbs: Array,
|
31
|
+
images: Hash
|
32
|
+
}
|
33
|
+
|
34
|
+
Then, assuming `video` is a parsed JSON response you can simply expect against the expected structure:
|
35
|
+
|
36
|
+
expect(video).to have_structure(expected_video_response)
|
37
|
+
|
38
|
+
### Comparison Types
|
39
|
+
|
40
|
+
Including an item in the expected structure ensures that a key with that name exists in the response.
|
41
|
+
|
42
|
+
Native Types (String, Hash, etc.)
|
43
|
+
: Test that the value matches the type, using `is_a?`.
|
44
|
+
|
45
|
+
Object
|
46
|
+
: 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.
|
47
|
+
|
48
|
+
Regular Expression
|
49
|
+
: 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.
|
50
|
+
|
51
|
+
### Testing Optional Values
|
52
|
+
|
53
|
+
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:
|
54
|
+
|
55
|
+
expect(video['episode_number']).to optionally_be(Integer)
|
56
|
+
|
57
|
+
This will pass if `video['episode_number']` is either `null` or `is_a?(Integer)`.
|
58
|
+
|
59
|
+
### Deep Structures
|
60
|
+
|
61
|
+
Similar to optional values, testing deep strucutres has been kept as simple as possible. Simply define a new expected structure:
|
62
|
+
|
63
|
+
tv_show_expected_structure = {
|
64
|
+
title: string
|
65
|
+
}
|
66
|
+
|
67
|
+
And then compare the structure as normal:
|
68
|
+
|
69
|
+
expect(video['tv_show']) to have_structure(tv_show_expected_structure)
|
70
|
+
|
71
|
+
## Contributing
|
72
|
+
|
73
|
+
1. Fork it
|
74
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
75
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
76
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
77
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
@@ -0,0 +1,30 @@
|
|
1
|
+
RSpec::Matchers.define :have_structure do |expected|
|
2
|
+
match do |actual|
|
3
|
+
missing_items(actual, expected).empty?
|
4
|
+
end
|
5
|
+
|
6
|
+
failure_message_for_should do |actual|
|
7
|
+
missing = missing_items(actual, expected)
|
8
|
+
"missing or invalid keys: #{missing.join(', ')}\n\n#{actual.slice(*missing)}"
|
9
|
+
end
|
10
|
+
|
11
|
+
def missing_items(actual, expected)
|
12
|
+
missing_items = []
|
13
|
+
|
14
|
+
expected.each do |key, value|
|
15
|
+
if !actual.has_key?(key.to_s) || !value_match(actual[key.to_s], value)
|
16
|
+
missing_items << key.to_s
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
missing_items
|
21
|
+
end
|
22
|
+
|
23
|
+
def value_match(actual_value, expected_value)
|
24
|
+
if expected_value.is_a?(Regexp)
|
25
|
+
actual_value =~ expected_value
|
26
|
+
else
|
27
|
+
actual_value.is_a?(expected_value)
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
data/lib/version.rb
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "rspec_structure_matcher"
|
8
|
+
spec.version = RspecStructureMatcher::VERSION
|
9
|
+
spec.authors = ["Tony Marklove"]
|
10
|
+
spec.email = ["tony@new-bamboo.co.uk"]
|
11
|
+
spec.description = %q{Rspec matchers for structured JSON responses. Compare expected keys, value types, or even match values against regular expressions.}
|
12
|
+
spec.summary = %q{Rspec matchers for structured JSON responses.}
|
13
|
+
spec.homepage = ""
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_dependency "rspec"
|
22
|
+
|
23
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
24
|
+
spec.add_development_dependency "rake"
|
25
|
+
end
|
metadata
ADDED
@@ -0,0 +1,97 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: rspec_structure_matcher
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Tony Marklove
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2013-12-18 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: rspec
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - '>='
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - '>='
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ~>
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.3'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ~>
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.3'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
description: Rspec matchers for structured JSON responses. Compare expected keys,
|
56
|
+
value types, or even match values against regular expressions.
|
57
|
+
email:
|
58
|
+
- tony@new-bamboo.co.uk
|
59
|
+
executables: []
|
60
|
+
extensions: []
|
61
|
+
extra_rdoc_files: []
|
62
|
+
files:
|
63
|
+
- .gitignore
|
64
|
+
- Gemfile
|
65
|
+
- LICENSE.txt
|
66
|
+
- README.md
|
67
|
+
- Rakefile
|
68
|
+
- lib/have_structure_matcher.rb
|
69
|
+
- lib/optionally_be_matcher.rb
|
70
|
+
- lib/rspec_structure_matcher.rb
|
71
|
+
- lib/version.rb
|
72
|
+
- rspec_structure_matcher.gemspec
|
73
|
+
homepage: ''
|
74
|
+
licenses:
|
75
|
+
- MIT
|
76
|
+
metadata: {}
|
77
|
+
post_install_message:
|
78
|
+
rdoc_options: []
|
79
|
+
require_paths:
|
80
|
+
- lib
|
81
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
82
|
+
requirements:
|
83
|
+
- - '>='
|
84
|
+
- !ruby/object:Gem::Version
|
85
|
+
version: '0'
|
86
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
87
|
+
requirements:
|
88
|
+
- - '>='
|
89
|
+
- !ruby/object:Gem::Version
|
90
|
+
version: '0'
|
91
|
+
requirements: []
|
92
|
+
rubyforge_project:
|
93
|
+
rubygems_version: 2.0.5
|
94
|
+
signing_key:
|
95
|
+
specification_version: 4
|
96
|
+
summary: Rspec matchers for structured JSON responses.
|
97
|
+
test_files: []
|