json_matchers 0.7.3 → 0.8.0

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require "json_matchers/rspec"
 
-Dir["./spec/support/*"].each { |file| require file }
+Dir["./spec/support/**/*.rb"].each { |file| require file }
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

data/spec/support/factory_bot.rb

@@ -0,0 +1,9 @@
+require "factory_bot"
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+
+  config.before(:suite) do
+    FactoryBot.find_definitions
+  end
+end

data/spec/support/fake_response.rb

@@ -0,0 +1,9 @@
+FakeResponse = Struct.new(:body) do
+  def to_h
+    JSON.parse(body)
+  end
+
+  def to_json
+    body
+  end
+end

data/spec/support/fake_schema.rb

@@ -0,0 +1,9 @@
+FakeSchema = Struct.new(:name, :json) do
+  def to_h
+    json
+  end
+
+  def to_s
+    name
+  end
+end

data/spec/support/file_helpers.rb

@@ -1,32 +1,6 @@
 require "fileutils"
-require "json"
 
 module FileHelpers
-  FakeResponse = Struct.new(:body)
-
-  def create_schema(name, json)
-    path = File.join(JsonMatchers.schema_root, "#{name}.json")
-
-    File.open(path, "w") do |file|
-      case json
-      when NilClass, String
-        file.write(json.to_s)
-      else
-        file.write(JSON.generate(json))
-      end
-    end
-  end
-
-  def response_for(json)
-    response_body = case json
-                    when String, NilClass
-                      json.to_s
-                    else
-                      json.to_json
-                    end
-    FakeResponse.new(response_body)
-  end
-
   def setup_fixtures(*pathnames)
     JSON::Validator.clear_cache
     original_schema_root = JsonMatchers.schema_root

data/test/json_matchers/minitest/assertions_test.rb

@@ -0,0 +1,177 @@
+require_relative "../../test_helper"
+require "active_support/core_ext/string"
+
+class AssertResponseMatchesSchemaTest < JsonMatchers::TestCase
+  test "fails with an invalid JSON schema" do
+    schema = create(:schema, :invalid)
+
+    json = build(:response)
+
+    assert_raises JsonMatchers::InvalidSchemaError do
+      assert_matches_json_schema(json, schema)
+    end
+  end
+
+  test "does not fail with an empty JSON body" do
+    schema = create(:schema, {})
+
+    json = build(:response, {})
+
+    assert_matches_json_schema(json, schema)
+  end
+
+  test "fails when the body contains a property with the wrong type" do
+    schema = create(:schema, :object)
+
+    json = build(:response, :invalid_object)
+
+    refute_matches_json_schema(json, schema)
+  end
+
+  test "fails when the body is missing a required property" do
+    schema = create(:schema, :object)
+
+    json = build(:response, {})
+
+    refute_matches_json_schema(json, schema)
+  end
+
+  test "when passed a Hash, validates that the schema matches" do
+    schema = create(:schema, :object)
+
+    json = build(:response, :object)
+    json_as_hash = json.to_h
+
+    assert_matches_json_schema(json_as_hash, schema)
+  end
+
+  test "when passed a Hash, fails with message when negated" do
+    schema = create(:schema, :object)
+
+    json = build(:response, :invalid_object)
+    json_as_hash = json.to_h
+
+    assert_raises_error_containing(schema) do
+      assert_matches_json_schema(json_as_hash, schema)
+    end
+  end
+
+  test "when passed a Array, validates a root-level Array in the JSON" do
+    schema = create(:schema, :array_of, :objects)
+
+    json = build(:response, :object)
+    json_as_array = [json.to_h]
+
+    assert_matches_json_schema(json_as_array, schema)
+  end
+
+  test "when passed a Array, refutes a root-level Array in the JSON" do
+    schema = create(:schema, :array_of, :objects)
+
+    json = build(:response, :invalid_object)
+    json_as_array = [json.to_h]
+
+    refute_matches_json_schema(json_as_array, schema)
+  end
+
+  test "when passed a Array, fails with message when negated" do
+    schema = create(:schema, :array_of, :object)
+
+    json = build(:response, :invalid_object)
+    json_as_array = [json.to_h]
+
+    assert_raises_error_containing(schema) do
+      assert_matches_json_schema(json_as_array, schema)
+    end
+  end
+
+  test "when JSON is a string, validates that the schema matches" do
+    schema = create(:schema, :object)
+
+    json = build(:response, :object)
+    json_as_string = json.to_json
+
+    assert_matches_json_schema(json_as_string, schema)
+  end
+
+  test "when JSON is a string, fails with message when negated" do
+    schema = create(:schema, :object)
+
+    json = build(:response, :invalid_object)
+    json_as_string = json.to_json
+
+    assert_raises_error_containing(schema) do
+      assert_matches_json_schema(json_as_string, schema)
+    end
+  end
+
+  test "the failure message contains the body" do
+    schema = create(:schema, :object)
+
+    json = build(:response, :invalid_object)
+
+    assert_raises_error_containing(json) do
+      assert_matches_json_schema(json, schema)
+    end
+  end
+
+  test "the failure message contains the schema" do
+    schema = create(:schema, :object)
+
+    json = build(:response, :invalid_object)
+
+    assert_raises_error_containing(schema) do
+      assert_matches_json_schema(json, schema)
+    end
+  end
+
+  test "the failure message when negated, contains the body" do
+    schema = create(:schema, :object)
+
+    json = build(:response, :object)
+
+    assert_raises_error_containing(json) do
+      refute_matches_json_schema(json, schema)
+    end
+  end
+
+  test "the failure message when negated, contains the schema" do
+    schema = create(:schema, :object)
+
+    json = build(:response, :object)
+
+    assert_raises_error_containing(schema) do
+      refute_matches_json_schema(json, schema)
+    end
+  end
+
+  test "asserts valid JSON against a schema that uses $ref" do
+    schema = create(:schema, :referencing_objects)
+
+    json = build(:response, :object)
+    json_as_array = [json.to_h]
+
+    assert_matches_json_schema(json_as_array, schema)
+  end
+
+  test "refutes valid JSON against a schema that uses $ref" do
+    schema = create(:schema, :referencing_objects)
+
+    json = build(:response, :invalid_object)
+    json_as_array = [json.to_h]
+
+    refute_matches_json_schema(json_as_array, schema)
+  end
+
+  def assert_raises_error_containing(schema_or_body)
+    raised_error = assert_raises(Minitest::Assertion) do
+      yield
+    end
+
+    sanitized_message = raised_error.message.squish
+    json = JSON.pretty_generate(schema_or_body.to_h)
+    error_message = json.squish
+
+    assert_includes sanitized_message, error_message
+  end
+end

data/test/support/factory_bot.rb

@@ -0,0 +1,5 @@
+require "factory_bot"
+
+FactoryBot.find_definitions
+
+Minitest::Test.send(:include, FactoryBot::Syntax::Methods)

data/test/support/json_matchers/test_case.rb

@@ -0,0 +1,18 @@
+require "active_support/testing/declarative"
+require_relative "../../../spec/support/file_helpers"
+
+module JsonMatchers
+  class TestCase < ::Minitest::Test
+    extend ActiveSupport::Testing::Declarative
+
+    include FileHelpers
+
+    def setup
+      @original_schema_root = setup_fixtures("test", "fixtures", "schemas")
+    end
+
+    def teardown
+      teardown_fixtures(@original_schema_root)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require "minitest/autorun"
+require "json_matchers/minitest/assertions"
+
+JsonMatchers.schema_root = "/test/support/api/schemas"
+
+Minitest::Test.send(:include, JsonMatchers::Minitest::Assertions)
+
+Dir["./test/support/**/*.rb"].each { |file| require file }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_matchers
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Sean Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -80,6 +80,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: Validate your Rails JSON API's JSON
 email:
 - sean.p.doyle24@gmail.com
@@ -102,18 +144,28 @@ files:
 - Rakefile
 - json_matchers.gemspec
 - lib/json_matchers.rb
+- lib/json_matchers/assertion.rb
 - lib/json_matchers/configuration.rb
 - lib/json_matchers/errors.rb
 - lib/json_matchers/matcher.rb
+- lib/json_matchers/minitest/assertions.rb
 - lib/json_matchers/payload.rb
 - lib/json_matchers/rspec.rb
 - lib/json_matchers/validator.rb
 - lib/json_matchers/version.rb
+- spec/factories.rb
 - spec/json_matchers/configuration_spec.rb
 - spec/json_matchers/match_json_schema_spec.rb
 - spec/spec_helper.rb
 - spec/support/configuration.rb
+- spec/support/factory_bot.rb
+- spec/support/fake_response.rb
+- spec/support/fake_schema.rb
 - spec/support/file_helpers.rb
+- test/json_matchers/minitest/assertions_test.rb
+- test/support/factory_bot.rb
+- test/support/json_matchers/test_case.rb
+- test/test_helper.rb
 homepage: https://github.com/thoughtbot/json_matchers
 licenses:
 - MIT
@@ -134,13 +186,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Validate your Rails JSON API's JSON
 test_files:
+- spec/factories.rb
 - spec/json_matchers/configuration_spec.rb
 - spec/json_matchers/match_json_schema_spec.rb
 - spec/spec_helper.rb
 - spec/support/configuration.rb
+- spec/support/factory_bot.rb
+- spec/support/fake_response.rb
+- spec/support/fake_schema.rb
 - spec/support/file_helpers.rb
+- test/json_matchers/minitest/assertions_test.rb
+- test/support/factory_bot.rb
+- test/support/json_matchers/test_case.rb
+- test/test_helper.rb