json_matchers 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1250ed73bac0e52561bb4baa7e7b958779d5c2a1
-  data.tar.gz: ade002c883d6169ba73c97a5a229517bc2162ef5
+SHA256:
+  metadata.gz: 915cc934b6081cff12a854f252864b3e6a563b638a2852872ea5e50d9373832e
+  data.tar.gz: f580d61fdbd56461ffe9fc13295adbac531492ddf66abb33f875bdfc7f31bf74
 SHA512:
-  metadata.gz: 78f30c21320d99d2be196f3b73bdf5fd4ac1bc74c692a5d55d51ba612ee2056896928acdbd71e6bed80ab224da5c3db6d85a63fd888a59bdb35eb0d3c3b4420b
-  data.tar.gz: a9cd0086a5c39491b47cfdddab86e8dc9a326373476d9b53dbf64801db49360bdc87d5bc3361e3ac11dcc376af352234f3442a4d532cee6ee74ec0086478db9e
+  metadata.gz: 94538a59b1dce067f741957af0c1d7c1057004dde8dfd887253de6cfb6f586de917ac73a9c8e9649e9175c477dc7e5cc98f093d8d17973c3814d5666ecb0aa7e
+  data.tar.gz: 6a63c1185707740da0498e7b9962fc8edc15fd7a6915f927a5c7d0d582334cde79d74fecaa31634974f43dd869400dd939b090a5e383819acf75c1eaaddcfa52

data/.rubocop.yml

@@ -4,14 +4,25 @@ inherit_from:
 Style/BlockDelimiters:
   Enabled: true
   Exclude:
+    - 'test/**/*_test.rb'
     - 'spec/**/*_spec.rb'
 
 Style/BracesAroundHashParameters:
   Enabled: true
   Exclude:
+    - 'test/**/*_test.rb'
     - 'spec/**/*_spec.rb'
+    - 'spec/factories.rb'
+
+Style/SymbolArray:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  Enabled: false
 
 Layout/IndentHash:
   Enabled: true
   Exclude:
+    - 'test/**/*_test.rb'
     - 'spec/**/*_spec.rb'
+    - 'spec/factories.rb'

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.5.0

data/.thoughtbot.rubocop.yml

@@ -352,8 +352,18 @@ Style/TrailingCommaInArguments:
     - no_comma
   Enabled: true
 
-Style/TrailingCommaInLiteral:
-  Description: 'Checks for trailing comma in array and hash literals.'
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  Enabled: true
+
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
   EnforcedStyleForMultiline: comma
   SupportedStylesForMultiline:
@@ -450,7 +460,7 @@ Lint/CircularArgumentReference:
   Description: "Don't refer to the keyword argument in the default value."
   Enabled: false
 
-Lint/ConditionPosition:
+Layout/ConditionPosition:
   Description: >-
                  Checks for condition placed in a confusing position relative to
                  the keyword.

data/.travis.yml

@@ -4,4 +4,4 @@ language: ruby
 notifications:
   email: false
 rvm:
-- 2.3.0
+- 2.5.0

data/CONTRIBUTING.md

@@ -1,4 +1,4 @@
-Contributing to json_matchers:
+Contributing to `json_matchers`:
 
 1. Fork the [official repository](https://github.com/thoughtbot/json_matchers/tree/master).
 2. Make your changes in a topic branch.
@@ -6,5 +6,6 @@ Contributing to json_matchers:
 
 Notes:
 
-* Contributions without tests won't be accepted.
+* Contributions without tests covering the `RSpec` matchers _and_ the `Minitest`
+  assertions won't be accepted.
 * Please don't update the Gem version.

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-ruby "2.3.0"
+ruby "2.5.0"
 
 # Specify your gem's dependencies in shoulda-matchers-json.gemspec
 gemspec

data/NEWS.md

@@ -1,6 +1,14 @@
 master
 ======
 
+0.8.0
+=====
+
+* Add `assert_json_matches_schema` and `refute_json_matches_schema` for
+  use in `minitest` test suites [#66]
+
+[#66]: https://github.com/thoughtbot/json_matchers/pull/66
+
 0.7.3
 =====
 

data/README.md

@@ -4,7 +4,7 @@ Validate the JSON returned by your Rails JSON APIs
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
 group :test do
@@ -22,21 +22,45 @@ Or install it yourself as:
 
 ## Usage
 
-Inspired by [Validating JSON Schemas with an RSpec Matcher](http://robots.thoughtbot.com/validating-json-schemas-with-an-rspec-matcher)
+Inspired by [Validating JSON Schemas with an RSpec Matcher][original-blog-post].
 
-First, include it in your `spec_helper`:
+[original-blog-post]: (http://robots.thoughtbot.com/validating-json-schemas-with-an-rspec-matcher)
 
-```ruby
-# spec/spec_helper.rb
+First, configure it in your test suite's helper file:
+
+### Configure
+
+#### RSpec
 
+`spec/spec_helper.rb`
+
+```ruby
 require "json_matchers/rspec"
+
+JsonMatchers.schema_root = "/spec/support/api/schemas"
 ```
 
-Define your [JSON Schema](http://json-schema.org/example1.html) in the schema directory:
+#### Minitest
 
-```json
-# spec/support/api/schemas/posts.json
+`test/test_helper.rb`
+
+```ruby
+require "minitest/autorun"
+require "json_matchers/minitest/assertions"
+
+JsonMatchers.schema_root = "/test/support/api/schemas"
+
+Minitest::Test.send(:include, JsonMatchers::Minitest::Assertions)
+```
+
+### Declare
+
+Declare your [JSON Schema](http://json-schema.org/example1.html) in the schema
+directory.
 
+`spec/support/api/schemas/posts.json` or `test/support/api/schemas/posts.json`:
+
+```json
 {
   "type": "object",
   "required": ["posts"],
@@ -56,11 +80,16 @@ Define your [JSON Schema](http://json-schema.org/example1.html) in the schema di
 }
 ```
 
-Then, validate `response` against your schema with `match_json_schema`
+### Validate
 
-```ruby
-# spec/requests/posts_spec.rb
+#### RSpec
 
+Validate a JSON response, a Hash, or a String against a JSON Schema with
+`match_json_schema`:
+
+`spec/requests/posts_spec.rb`
+
+```ruby
 describe "GET /posts" do
   it "returns Posts" do
     get posts_path, format: :json
@@ -71,18 +100,19 @@ describe "GET /posts" do
 end
 ```
 
-Alternatively, `match_json_schema` accepts a string:
+#### Minitest
 
-```ruby
-# spec/requests/posts_spec.rb
+Validate a JSON response, a Hash, or a String against a JSON Schema with
+`assert_matches_json_schema`:
 
-describe "GET /posts" do
-  it "returns Posts" do
-    get posts_path, format: :json
+`test/integration/posts_test.rb`
 
-    expect(response.status).to eq 200
-    expect(response.body).to match_json_schema("posts")
-  end
+```ruby
+def test_GET_posts_returns_Posts
+  get posts_path, format: :json
+
+  assert_equal response.status, 200
+  assert_matches_json_schema response, "posts"
 end
 ```
 
@@ -90,9 +120,9 @@ end
 
 The matcher accepts options, which it passes to the validator:
 
-```ruby
-# spec/requests/posts_spec.rb
+`spec/requests/posts_spec.rb`
 
+```ruby
 describe "GET /posts" do
   it "returns Posts" do
     get posts_path, format: :json
@@ -110,11 +140,11 @@ A list of available options can be found [here][options].
 ### Global matcher options
 
 To configure the default options passed to *all* matchers, call
-`JsonMatchers.configure`:
+`JsonMatchers.configure`.
 
-```rb
-# spec/support/json_matchers.rb
+`spec/support/json_matchers.rb`:
 
+```rb
 JsonMatchers.configure do |config|
   config.options[:strict] = true
 end
@@ -133,9 +163,9 @@ To DRY up your schema definitions, use JSON schema's `$ref`.
 
 First, declare the singular version of your schema.
 
-```json
-# spec/support/api/schemas/post.json
+`spec/support/api/schemas/post.json`:
 
+```json
 {
   "type": "object",
   "required": ["id", "title", "body"],
@@ -149,9 +179,9 @@ First, declare the singular version of your schema.
 
 Then, when you declare your collection schema, reference your singular schemas.
 
-```json
-# spec/support/api/schemas/posts.json
+`spec/support/api/schemas/posts.json`:
 
+```json
 {
   "type": "object",
   "required": ["posts"],
@@ -171,19 +201,6 @@ In this case `"post.json"` will be resolved relative to
 
 To learn more about `$ref`, check out [Understanding JSON Schema Structuring](http://spacetelescope.github.io/understanding-json-schema/structuring.html)
 
-## Configuration
-
-By default, the schema directory is `spec/support/api/schemas`.
-
-This can be configured via `JsonMatchers.schema_root`.
-
-
-```ruby
-# spec/support/json_matchers.rb
-
-JsonMatchers.schema_root = "docs/api/schemas"
-```
-
 ## Contributing
 
 Please see [CONTRIBUTING].
@@ -191,7 +208,7 @@ Please see [CONTRIBUTING].
 `json_matchers` was inspired by [Validating JSON Schemas with an
 RSpec Matcher][blog post] by Laila Winner.
 
-`json_matchers` was written and is maintained by Sean Doyle.
+`json_matchers` is maintained by Sean Doyle.
 
 Many improvements and bugfixes were contributed by the [open source community].
 
@@ -201,7 +218,7 @@ Many improvements and bugfixes were contributed by the [open source community].
 
 ## License
 
-json_matchers is Copyright © 2015 Sean Doyle and thoughtbot.
+`json_matchers` is Copyright © 2018 thoughtbot.
 
 It is free software, and may be redistributed under the terms specified in the
 [LICENSE] file.

data/Rakefile

@@ -1,9 +1,14 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rake/testtask"
 
 RSpec::Core::RakeTask.new do |t|
   t.pattern = "spec/**/*_spec.rb"
 end
 
+Rake::TestTask.new do |t|
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
 task(:default).clear
-task default: [:spec]
+task default: [:spec, :test]

data/json_matchers.gemspec

@@ -24,4 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", ">= 2.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "factory_bot", ">= 4.8"
+  spec.add_development_dependency "activesupport"
 end

data/lib/json_matchers.rb

@@ -8,8 +8,6 @@ module JsonMatchers
     attr_accessor :schema_root
   end
 
-  self.schema_root = "#{Dir.pwd}/spec/support/api/schemas"
-
   def self.path_to_schema(schema_name)
     Pathname(schema_root).join("#{schema_name}.json")
   end

data/lib/json_matchers/assertion.rb

@@ -0,0 +1,68 @@
+require "json"
+require "json_matchers"
+require "json_matchers/payload"
+require "json_matchers/matcher"
+
+module JsonMatchers
+  class Assertion
+    def initialize(schema_name, **options)
+      @schema_name = schema_name
+      @schema_path = JsonMatchers.path_to_schema(schema_name)
+      @matcher = Matcher.new(schema_path, options)
+    end
+
+    def valid?(json)
+      @payload = Payload.new(json)
+
+      matcher.matches?(payload.to_s)
+    end
+
+    def valid_failure_message
+      <<-FAIL
+#{last_error_message}
+
+---
+
+expected
+
+#{format_json(payload)}
+
+to match schema "#{schema_name}":
+
+#{format_json(schema_body)}
+      FAIL
+    end
+
+    def invalid_failure_message
+      <<-FAIL
+#{last_error_message}
+
+---
+
+expected
+
+#{format_json(payload)}
+
+not to match schema "#{schema_name}":
+
+#{format_json(schema_body)}
+      FAIL
+    end
+
+    private
+
+    attr_reader :payload, :matcher, :schema_name, :schema_path
+
+    def last_error_message
+      matcher.validation_failure_message
+    end
+
+    def schema_body
+      File.read(schema_path)
+    end
+
+    def format_json(json)
+      JSON.pretty_generate(JSON.parse(json.to_s))
+    end
+  end
+end

data/lib/json_matchers/matcher.rb

@@ -8,8 +8,8 @@ module JsonMatchers
       @options = default_options.merge(options)
     end
 
-    def matches?(response)
-      validator = build_validator(response)
+    def matches?(payload)
+      validator = build_validator(payload)
 
       self.errors = validator.validate!
 
@@ -34,10 +34,10 @@ module JsonMatchers
       JsonMatchers.configuration.options || {}
     end
 
-    def build_validator(response)
+    def build_validator(payload)
       Validator.new(
         options: options,
-        response: response,
+        payload: payload,
         schema_path: schema_path,
       )
     end

data/lib/json_matchers/minitest/assertions.rb

@@ -0,0 +1,26 @@
+require "json_matchers"
+require "json_matchers/assertion"
+
+module JsonMatchers
+  self.schema_root = File.join("test", "support", "api", "schemas")
+
+  module Minitest
+    module Assertions
+      def assert_matches_json_schema(payload, schema_name)
+        assertion = Assertion.new(schema_name)
+
+        payload_is_valid = assertion.valid?(payload)
+
+        assert payload_is_valid, -> { assertion.valid_failure_message }
+      end
+
+      def refute_matches_json_schema(payload, schema_name)
+        assertion = Assertion.new(schema_name)
+
+        payload_is_valid = assertion.valid?(payload)
+
+        refute payload_is_valid, -> { assertion.invalid_failure_message }
+      end
+    end
+  end
+end