check_please_rspec_matcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e700b9a95c0d7a72a68e328d4eb6f8261d60b13b7fc9a877427bec74a8366c3d
+  data.tar.gz: 2a28dc2750f4d13511372badd9ee743f2075d1096de92e71afc7240cef5c7afc
+SHA512:
+  metadata.gz: 5e5b2f798e818c640b12c7fc97e3fef473e03eab221969e957ff7ebbd5064aa74d6e37be2e631d304f4e77d4f2e40eef11effd216a794f76192893156ac36db2
+  data.tar.gz: a19788c86be5ae522bdb55a37045f5244999c2bcaf7d2fd9413f07b2aa37ecffcbe8e9771357706a81fd7470050655579f69786777dd0d70169c90a3d81d80fa

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# rspec failure tracking
+.rspec_status
+spec/examples.txt

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at geeksam@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in check_please_rspec_matcher.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    check_please_rspec_matcher (0.1.0)
+      check_please (~> 0.1.0)
+      rspec (~> 3.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    check_please (0.1.0)
+      table_print
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    table_print (1.5.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  check_please_rspec_matcher!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sam Livingston-Gray
+
+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,99 @@
+# check_please_rspec_matcher
+
+RSpec matcher to check for differences between two JSON strings (or Ruby data
+structures parsed from them).  Most of the heavy lifting is done by the
+[check_please](https://github.com/RealGeeks/check_please) gem; this is merely
+an RSpec wrapper that I didn't want to include in the main gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'check_please_rspec_matcher'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install check_please_rspec_matcher
+
+## Usage
+
+The following code will raise a RSpec::Expectations::ExpectationNotMetError:
+
+```ruby
+reference = '{ "foo": 42 }'
+candidate = '{ "foo": 43 }'
+expect( candidate ).to check_please( reference )
+```
+
+### Failure Messages
+
+**For more information on understanding the diffs in the failure message, see
+[check_please](https://github.com/RealGeeks/check_please/README.md).**
+
+The failure message should look something like this:
+
+```
+Expected two JSON data structures to match, but found the following diffs:
+
+TYPE     | PATH | REFERENCE | CANDIDATE
+---------|------|-----------|----------
+mismatch | /foo | 42        | 43
+```
+
+### Options
+
+The `check_please` helper method currently accepts a single keyword argument:
+
+```ruby
+reference = '{ "foo": 42 }'
+candidate = '{ "foo": 43 }'
+expect( candidate ).to check_please( reference, format_diffs: :json )
+```
+
+Using `:json` as above will output the diffs in JSON instead of a table:
+
+```
+Expected two JSON data structures to match, but found the following diffs:
+
+[
+  { "type": "mismatch", "path": "/foo", "reference": 42, "candidate": 43 }
+]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` 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/[USERNAME]/check_please_rspec_matcher. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the [code of
+conduct](https://github.com/[USERNAME]/check_please_rspec_matcher/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CheckPleaseRspecMatcher project's codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/[USERNAME]/check_please_rspec_matcher/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "check_please_rspec_matcher"
+
+# 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(__FILE__)

data/bin/setup

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

data/check_please_rspec_matcher.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/check_please_rspec_matcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "check_please_rspec_matcher"
+  spec.version       = CheckPleaseRspecMatcher::VERSION
+  spec.authors       = ["Sam Livingston-Gray"]
+  spec.email         = ["geeksam@gmail.com"]
+
+  spec.summary       = %q{Check for differences between two JSON strings (or Ruby data structures parsed from them), now in an RSpec matcher}
+  spec.description   = %q{Check for differences between two JSON strings (or Ruby data structures parsed from them), now in an RSpec matcher}
+  spec.homepage      = "https://github.com/RealGeeks/check_please_rspec_matcher"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "check_please", "~> #{CheckPleaseRspecMatcher::VERSION}" # this may turn out to be a bad idea?
+  spec.add_dependency "rspec", "~> 3.9"
+end

data/lib/check_please_rspec_matcher.rb

@@ -0,0 +1,3 @@
+require "check_please_rspec_matcher/version"
+require 'check_please_rspec_matcher/matcher'
+require 'check_please_rspec_matcher/rspec_hooks' # leave this at the end

data/lib/check_please_rspec_matcher/matcher.rb

@@ -0,0 +1,40 @@
+require 'check_please'
+
+module CheckPleaseRspecMatcher
+
+  module RSpecHelper
+    def check_please(expected, format_diffs: nil)
+      CheckPleaseRspecMatcher::Matcher.new(expected, format_diffs: format_diffs)
+    end
+  end
+
+  class Matcher
+    def initialize(expected, opts = {})
+      @expected = expected
+      @opts = opts || {}
+    end
+
+    def matches?(actual)
+      @actual = actual
+      diffs.empty?
+    end
+
+    def failure_message
+      format = opts[:format_diffs]
+      diff_text = CheckPlease::Printers.render(diffs, format)
+      <<~EOF
+        Expected two JSON data structures to match, but found the following diffs:
+
+        #{diff_text}
+      EOF
+    end
+
+    private
+    attr_reader :expected, :opts, :actual
+
+    def diffs
+      @_diffs ||= ::CheckPlease.diff(@expected, @actual)
+    end
+  end
+
+end

data/lib/check_please_rspec_matcher/rspec_hooks.rb

@@ -0,0 +1,3 @@
+RSpec::configure do |config|
+  config.include CheckPleaseRspecMatcher::RSpecHelper
+end

data/lib/check_please_rspec_matcher/version.rb

@@ -0,0 +1,4 @@
+module CheckPleaseRspecMatcher
+  # NOTE: the gemspec declares its dependency on 'check_please' as '~>' to this
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: check_please_rspec_matcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Livingston-Gray
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: check_please
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: Check for differences between two JSON strings (or Ruby data structures
+  parsed from them), now in an RSpec matcher
+email:
+- geeksam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- check_please_rspec_matcher.gemspec
+- lib/check_please_rspec_matcher.rb
+- lib/check_please_rspec_matcher/matcher.rb
+- lib/check_please_rspec_matcher/rspec_hooks.rb
+- lib/check_please_rspec_matcher/version.rb
+homepage: https://github.com/RealGeeks/check_please_rspec_matcher
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/RealGeeks/check_please_rspec_matcher
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Check for differences between two JSON strings (or Ruby data structures parsed
+  from them), now in an RSpec matcher
+test_files: []