check_please_rspec_matcher 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +13 -0
- data/.rspec +3 -0
- data/.travis.yml +6 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +39 -0
- data/LICENSE.txt +21 -0
- data/README.md +99 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/check_please_rspec_matcher.gemspec +30 -0
- data/lib/check_please_rspec_matcher.rb +3 -0
- data/lib/check_please_rspec_matcher/matcher.rb +40 -0
- data/lib/check_please_rspec_matcher/rspec_hooks.rb +3 -0
- data/lib/check_please_rspec_matcher/version.rb +4 -0
- metadata +90 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: e700b9a95c0d7a72a68e328d4eb6f8261d60b13b7fc9a877427bec74a8366c3d
|
4
|
+
data.tar.gz: 2a28dc2750f4d13511372badd9ee743f2075d1096de92e71afc7240cef5c7afc
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 5e5b2f798e818c640b12c7fc97e3fef473e03eab221969e957ff7ebbd5064aa74d6e37be2e631d304f4e77d4f2e40eef11effd216a794f76192893156ac36db2
|
7
|
+
data.tar.gz: a19788c86be5ae522bdb55a37045f5244999c2bcaf7d2fd9413f07b2aa37ecffcbe8e9771357706a81fd7470050655579f69786777dd0d70169c90a3d81d80fa
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at geeksam@gmail.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [https://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: https://contributor-covenant.org
|
74
|
+
[version]: https://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
check_please_rspec_matcher (0.1.0)
|
5
|
+
check_please (~> 0.1.0)
|
6
|
+
rspec (~> 3.9)
|
7
|
+
|
8
|
+
GEM
|
9
|
+
remote: https://rubygems.org/
|
10
|
+
specs:
|
11
|
+
check_please (0.1.0)
|
12
|
+
table_print
|
13
|
+
diff-lcs (1.4.4)
|
14
|
+
rake (12.3.3)
|
15
|
+
rspec (3.10.0)
|
16
|
+
rspec-core (~> 3.10.0)
|
17
|
+
rspec-expectations (~> 3.10.0)
|
18
|
+
rspec-mocks (~> 3.10.0)
|
19
|
+
rspec-core (3.10.0)
|
20
|
+
rspec-support (~> 3.10.0)
|
21
|
+
rspec-expectations (3.10.0)
|
22
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
23
|
+
rspec-support (~> 3.10.0)
|
24
|
+
rspec-mocks (3.10.0)
|
25
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
26
|
+
rspec-support (~> 3.10.0)
|
27
|
+
rspec-support (3.10.0)
|
28
|
+
table_print (1.5.7)
|
29
|
+
|
30
|
+
PLATFORMS
|
31
|
+
ruby
|
32
|
+
|
33
|
+
DEPENDENCIES
|
34
|
+
check_please_rspec_matcher!
|
35
|
+
rake (~> 12.0)
|
36
|
+
rspec (~> 3.0)
|
37
|
+
|
38
|
+
BUNDLED WITH
|
39
|
+
2.1.4
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2020 Sam Livingston-Gray
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,99 @@
|
|
1
|
+
# check_please_rspec_matcher
|
2
|
+
|
3
|
+
RSpec matcher to check for differences between two JSON strings (or Ruby data
|
4
|
+
structures parsed from them). Most of the heavy lifting is done by the
|
5
|
+
[check_please](https://github.com/RealGeeks/check_please) gem; this is merely
|
6
|
+
an RSpec wrapper that I didn't want to include in the main gem.
|
7
|
+
|
8
|
+
## Installation
|
9
|
+
|
10
|
+
Add this line to your application's Gemfile:
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
gem 'check_please_rspec_matcher'
|
14
|
+
```
|
15
|
+
|
16
|
+
And then execute:
|
17
|
+
|
18
|
+
$ bundle install
|
19
|
+
|
20
|
+
Or install it yourself as:
|
21
|
+
|
22
|
+
$ gem install check_please_rspec_matcher
|
23
|
+
|
24
|
+
## Usage
|
25
|
+
|
26
|
+
The following code will raise a RSpec::Expectations::ExpectationNotMetError:
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
reference = '{ "foo": 42 }'
|
30
|
+
candidate = '{ "foo": 43 }'
|
31
|
+
expect( candidate ).to check_please( reference )
|
32
|
+
```
|
33
|
+
|
34
|
+
### Failure Messages
|
35
|
+
|
36
|
+
**For more information on understanding the diffs in the failure message, see
|
37
|
+
[check_please](https://github.com/RealGeeks/check_please/README.md).**
|
38
|
+
|
39
|
+
The failure message should look something like this:
|
40
|
+
|
41
|
+
```
|
42
|
+
Expected two JSON data structures to match, but found the following diffs:
|
43
|
+
|
44
|
+
TYPE | PATH | REFERENCE | CANDIDATE
|
45
|
+
---------|------|-----------|----------
|
46
|
+
mismatch | /foo | 42 | 43
|
47
|
+
```
|
48
|
+
|
49
|
+
### Options
|
50
|
+
|
51
|
+
The `check_please` helper method currently accepts a single keyword argument:
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
reference = '{ "foo": 42 }'
|
55
|
+
candidate = '{ "foo": 43 }'
|
56
|
+
expect( candidate ).to check_please( reference, format_diffs: :json )
|
57
|
+
```
|
58
|
+
|
59
|
+
Using `:json` as above will output the diffs in JSON instead of a table:
|
60
|
+
|
61
|
+
```
|
62
|
+
Expected two JSON data structures to match, but found the following diffs:
|
63
|
+
|
64
|
+
[
|
65
|
+
{ "type": "mismatch", "path": "/foo", "reference": 42, "candidate": 43 }
|
66
|
+
]
|
67
|
+
```
|
68
|
+
|
69
|
+
## Development
|
70
|
+
|
71
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run
|
72
|
+
`rake spec` to run the tests. You can also run `bin/console` for an interactive
|
73
|
+
prompt that will allow you to experiment.
|
74
|
+
|
75
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To
|
76
|
+
release a new version, update the version number in `version.rb`, and then run
|
77
|
+
`bundle exec rake release`, which will create a git tag for the version, push
|
78
|
+
git commits and tags, and push the `.gem` file to
|
79
|
+
[rubygems.org](https://rubygems.org).
|
80
|
+
|
81
|
+
## Contributing
|
82
|
+
|
83
|
+
Bug reports and pull requests are welcome on GitHub at
|
84
|
+
https://github.com/[USERNAME]/check_please_rspec_matcher. This project is
|
85
|
+
intended to be a safe, welcoming space for collaboration, and contributors are
|
86
|
+
expected to adhere to the [code of
|
87
|
+
conduct](https://github.com/[USERNAME]/check_please_rspec_matcher/blob/master/CODE_OF_CONDUCT.md).
|
88
|
+
|
89
|
+
|
90
|
+
## License
|
91
|
+
|
92
|
+
The gem is available as open source under the terms of the [MIT
|
93
|
+
License](https://opensource.org/licenses/MIT).
|
94
|
+
|
95
|
+
## Code of Conduct
|
96
|
+
|
97
|
+
Everyone interacting in the CheckPleaseRspecMatcher project's codebases, issue
|
98
|
+
trackers, chat rooms and mailing lists is expected to follow the [code of
|
99
|
+
conduct](https://github.com/[USERNAME]/check_please_rspec_matcher/blob/master/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "check_please_rspec_matcher"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
require_relative 'lib/check_please_rspec_matcher/version'
|
2
|
+
|
3
|
+
Gem::Specification.new do |spec|
|
4
|
+
spec.name = "check_please_rspec_matcher"
|
5
|
+
spec.version = CheckPleaseRspecMatcher::VERSION
|
6
|
+
spec.authors = ["Sam Livingston-Gray"]
|
7
|
+
spec.email = ["geeksam@gmail.com"]
|
8
|
+
|
9
|
+
spec.summary = %q{Check for differences between two JSON strings (or Ruby data structures parsed from them), now in an RSpec matcher}
|
10
|
+
spec.description = %q{Check for differences between two JSON strings (or Ruby data structures parsed from them), now in an RSpec matcher}
|
11
|
+
spec.homepage = "https://github.com/RealGeeks/check_please_rspec_matcher"
|
12
|
+
spec.license = "MIT"
|
13
|
+
spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
|
14
|
+
|
15
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
16
|
+
# spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
|
17
|
+
# spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
|
18
|
+
|
19
|
+
# Specify which files should be added to the gem when it is released.
|
20
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
21
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
22
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
23
|
+
end
|
24
|
+
spec.bindir = "exe"
|
25
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
26
|
+
spec.require_paths = ["lib"]
|
27
|
+
|
28
|
+
spec.add_dependency "check_please", "~> #{CheckPleaseRspecMatcher::VERSION}" # this may turn out to be a bad idea?
|
29
|
+
spec.add_dependency "rspec", "~> 3.9"
|
30
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
require 'check_please'
|
2
|
+
|
3
|
+
module CheckPleaseRspecMatcher
|
4
|
+
|
5
|
+
module RSpecHelper
|
6
|
+
def check_please(expected, format_diffs: nil)
|
7
|
+
CheckPleaseRspecMatcher::Matcher.new(expected, format_diffs: format_diffs)
|
8
|
+
end
|
9
|
+
end
|
10
|
+
|
11
|
+
class Matcher
|
12
|
+
def initialize(expected, opts = {})
|
13
|
+
@expected = expected
|
14
|
+
@opts = opts || {}
|
15
|
+
end
|
16
|
+
|
17
|
+
def matches?(actual)
|
18
|
+
@actual = actual
|
19
|
+
diffs.empty?
|
20
|
+
end
|
21
|
+
|
22
|
+
def failure_message
|
23
|
+
format = opts[:format_diffs]
|
24
|
+
diff_text = CheckPlease::Printers.render(diffs, format)
|
25
|
+
<<~EOF
|
26
|
+
Expected two JSON data structures to match, but found the following diffs:
|
27
|
+
|
28
|
+
#{diff_text}
|
29
|
+
EOF
|
30
|
+
end
|
31
|
+
|
32
|
+
private
|
33
|
+
attr_reader :expected, :opts, :actual
|
34
|
+
|
35
|
+
def diffs
|
36
|
+
@_diffs ||= ::CheckPlease.diff(@expected, @actual)
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
end
|
metadata
ADDED
@@ -0,0 +1,90 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: check_please_rspec_matcher
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Sam Livingston-Gray
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-11-06 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: check_please
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 0.1.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.1.0
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rspec
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '3.9'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '3.9'
|
41
|
+
description: Check for differences between two JSON strings (or Ruby data structures
|
42
|
+
parsed from them), now in an RSpec matcher
|
43
|
+
email:
|
44
|
+
- geeksam@gmail.com
|
45
|
+
executables: []
|
46
|
+
extensions: []
|
47
|
+
extra_rdoc_files: []
|
48
|
+
files:
|
49
|
+
- ".gitignore"
|
50
|
+
- ".rspec"
|
51
|
+
- ".travis.yml"
|
52
|
+
- CODE_OF_CONDUCT.md
|
53
|
+
- Gemfile
|
54
|
+
- Gemfile.lock
|
55
|
+
- LICENSE.txt
|
56
|
+
- README.md
|
57
|
+
- Rakefile
|
58
|
+
- bin/console
|
59
|
+
- bin/setup
|
60
|
+
- check_please_rspec_matcher.gemspec
|
61
|
+
- lib/check_please_rspec_matcher.rb
|
62
|
+
- lib/check_please_rspec_matcher/matcher.rb
|
63
|
+
- lib/check_please_rspec_matcher/rspec_hooks.rb
|
64
|
+
- lib/check_please_rspec_matcher/version.rb
|
65
|
+
homepage: https://github.com/RealGeeks/check_please_rspec_matcher
|
66
|
+
licenses:
|
67
|
+
- MIT
|
68
|
+
metadata:
|
69
|
+
homepage_uri: https://github.com/RealGeeks/check_please_rspec_matcher
|
70
|
+
post_install_message:
|
71
|
+
rdoc_options: []
|
72
|
+
require_paths:
|
73
|
+
- lib
|
74
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
75
|
+
requirements:
|
76
|
+
- - ">="
|
77
|
+
- !ruby/object:Gem::Version
|
78
|
+
version: 2.3.0
|
79
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
80
|
+
requirements:
|
81
|
+
- - ">="
|
82
|
+
- !ruby/object:Gem::Version
|
83
|
+
version: '0'
|
84
|
+
requirements: []
|
85
|
+
rubygems_version: 3.0.3
|
86
|
+
signing_key:
|
87
|
+
specification_version: 4
|
88
|
+
summary: Check for differences between two JSON strings (or Ruby data structures parsed
|
89
|
+
from them), now in an RSpec matcher
|
90
|
+
test_files: []
|