json_matchers 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03b79f9a5c8394f6e8ccbd26d6c066519e5d2a25ad6b623765a48f524ba38bf0
-  data.tar.gz: 00421a6718fff3b21d1c50382ea5b9d5f855dbfe4d2522dbf50db217f2993b8f
+  metadata.gz: 9fecae5a2677672d70b145cd3414a8bdb8026322d45ce5f1ec823cb5215a2b5f
+  data.tar.gz: 1e0c74062d1a5070fad748bc5c07014429dc9bfae7854df6b9ccaa68b52ab4e4
 SHA512:
-  metadata.gz: 9b4cc33ad05676e0ac2133c79d627ece2994d0a21878ad6269c3145081d3cf1fe0e193928e1ca312660baa418b69f5cd33661aa0f070301d50f51436b72d3c0a
-  data.tar.gz: 830aa3570c9ae06fcd3986323d2dd0a3763c7fd91c62e09cf7029e184612ec15c5227fa706afbfe3cb8471c61c4f8dd85fa2cea68f9fd5edb704f7c7bfdbfffc
+  metadata.gz: cd933b24a0e345c0b7499d8eecf03edb49d0eef23a1ae1b7225bd4e9a9fa288483df4823e71668b846ed7f95a4416b9662e86a611ae311acc446acdd5ea59013
+  data.tar.gz: '0815f896a0015905b2945588b234e0e6e5947641bc1b55f4d9cbae6bc4141e26f6d6c9b661001900a7a5fc179cc55e1efbcc8105dd060df922c7a7f39c8178af'

data/.rubocop.yml

@@ -17,6 +17,20 @@ Style/BracesAroundHashParameters:
 Style/SymbolArray:
   Enabled: false
 
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  Exclude:
+    - 'test/**/*_test.rb'
+    - 'spec/**/*_spec.rb'
+    - 'spec/factories.rb'
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  Exclude:
+    - 'test/**/*_test.rb'
+    - 'spec/**/*_spec.rb'
+    - 'spec/factories.rb'
+
 Layout/IndentHeredoc:
   Enabled: false
 

data/NEWS.md

@@ -1,6 +1,14 @@
 master
 ======
 
+0.11.0
+======
+
+* Expand references of DocuemntStore schemas ([#93], [3b66b4d])
+
+[#93]: https://github.com/thoughtbot/json_matchers/pull/93
+[3b66b4d]: https://github.com/thoughtbot/json_matchers/commit/3b66b4ddf369ec09b50cfe39c614266b34c7f3fe
+
 0.10.0
 ======
 

data/README.md

@@ -50,7 +50,7 @@ require "json_matchers/minitest/assertions"
 
 JsonMatchers.schema_root = "test/support/api/schemas"
 
-Minitest::Test.send(:include, JsonMatchers::Minitest::Assertions)
+Minitest::Test.include(JsonMatchers::Minitest::Assertions)
 ```
 
 ### Declare

data/lib/json_matchers/matcher.rb

@@ -34,7 +34,8 @@ module JsonMatchers
       Dir.glob("#{JsonMatchers.schema_root}/**/*.json").
         map { |path| Pathname.new(path) }.
         map { |schema_path| Parser.new(schema_path).parse }.
-        each { |schema| document_store.add_schema(schema) }
+        map { |schema| document_store.add_schema(schema) }.
+        each { |schema| schema.expand_references!(store: document_store) }
 
       document_store
     end

data/lib/json_matchers/version.rb

@@ -1,3 +1,3 @@
 module JsonMatchers
-  VERSION = "0.10.0".freeze
+  VERSION = "0.11.0".freeze
 end

data/spec/factories.rb

@@ -68,6 +68,7 @@ FactoryBot.define do
 
       initialize_with do
         FakeSchema.new(name, {
+          "id": "file:/#{name}.json#",
           "$schema": "https://json-schema.org/draft-04/schema#",
           "type": "array",
           "items": { "$ref": "file:/#{items.name}.json#" },

data/spec/json_matchers/match_json_schema_spec.rb

@@ -59,6 +59,147 @@ describe JsonMatchers, "#match_json_schema" do
     expect(json).to match_json_schema("api/v1/schema")
   end
 
+  it "supports invalidating the referenced schema when using local references" do
+    create(:schema, name: "post", json: {
+      "$schema": "https://json-schema.org/draft-04/schema#",
+      "id": "file:/post.json#",
+      "definitions": {
+        "attributes": {
+          "type": "object",
+          "required": [
+            "id",
+            "name",
+          ],
+          "properties": {
+            "id": { "type": "string" },
+            "name": { "type": "string" }
+          }
+        }
+      },
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "attributes"
+      ],
+      "properties": {
+        "id": { "type": "string" },
+        "type": { "type": "string" },
+        "attributes": {
+          "$ref": "#/definitions/attributes",
+        }
+      }
+    })
+    posts_index = create(:schema, name: "posts/index", json: {
+      "$schema": "https://json-schema.org/draft-04/schema#",
+      "id": "file:/posts/index.json#",
+      "type": "object",
+      "required": [
+        "data"
+      ],
+      "definitions": {
+        "posts": {
+          "type": "array",
+          "items": {
+            "$ref": "file:/post.json#"
+          }
+        }
+      },
+      "properties": {
+        "data": {
+          "$ref": "#/definitions/posts"
+        }
+      }
+    })
+
+    json = build(:response, {
+      "data": [{
+        "id": "1",
+        "type": "Post",
+        "attributes": {
+          "id": 1,
+          "name": "The Post's Name"
+        }
+      }]
+    })
+
+    expect(json).not_to match_json_schema(posts_index)
+  end
+
+  it "can reference a schema relatively" do
+    create(:schema, name: "post", json: {
+      "$schema": "https://json-schema.org/draft-04/schema#",
+      "id": "file:/post.json#",
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "attributes"
+      ],
+      "properties": {
+        "id": { "type": "string" },
+        "type": { "type": "string" },
+        "attributes": {
+          "type": "object",
+          "required": [
+            "id",
+            "name"
+          ],
+          "properties": {
+            "id": { "type": "string" },
+            "name": { "type": "string" },
+            "user": {
+              "type": "object",
+              "required": [
+                "id"
+              ],
+              "properties": {
+                "id": { "type": "string" }
+              }
+            }
+          }
+        }
+      }
+    })
+    posts_index = create(:schema, name: "posts/index", json: {
+      "$schema": "https://json-schema.org/draft-04/schema#",
+      "id": "file:/posts/index.json#",
+      "type": "object",
+      "required": [
+        "data"
+      ],
+      "definitions": {
+        "posts": {
+          "type": "array",
+          "items": {
+            "$ref": "file:/post.json#"
+          }
+        }
+      },
+      "properties": {
+        "data": {
+          "$ref": "#/definitions/posts"
+        }
+      }
+    })
+
+    json = build(:response, {
+      "data": [{
+        "id": "1",
+        "type": "Post",
+        "attributes": {
+          "id": "1",
+          "name": "The Post's Name",
+          "user": {
+            "id": "1"
+          }
+        }
+      }]
+    })
+
+    expect(json).to match_json_schema(posts_index)
+  end
+
   context "when passed a Hash" do
     it "validates that the schema matches" do
       schema = create(:schema, :location)
@@ -202,6 +343,26 @@ describe JsonMatchers, "#match_json_schema" do
     expect(json_as_array).not_to match_json_schema(schema)
   end
 
+  it "validates against a schema that uses nested $refs" do
+    items = create(:schema, :referencing_locations)
+    schema = create(:schema, :referencing_locations, items: items)
+
+    json = build(:response, :location)
+    json_as_array = [[json.to_h]]
+
+    expect(json_as_array).to match_json_schema(schema)
+  end
+
+  it "fails against a schema that uses nested $refs" do
+    items = create(:schema, :referencing_locations)
+    schema = create(:schema, :referencing_locations, items: items)
+
+    json = build(:response, :invalid_location)
+    json_as_array = [[json.to_h]]
+
+    expect(json_as_array).not_to match_json_schema(schema)
+  end
+
   it "validates against a schema referencing with 'definitions'" do
     schema = create(:schema, :referencing_definitions)
 

data/test/json_matchers/minitest/assertions_test.rb

@@ -44,6 +44,147 @@ class AssertResponseMatchesSchemaTest < JsonMatchers::TestCase
     assert_matches_json_schema(json, "api/v1/schema")
   end
 
+  test "supports invalidating the referenced schema when using local references" do
+    create(:schema, name: "post", json: {
+      "$schema": "https://json-schema.org/draft-04/schema#",
+      "id": "file:/post.json#",
+      "definitions": {
+        "attributes": {
+          "type": "object",
+          "required": [
+            "id",
+            "name",
+          ],
+          "properties": {
+            "id": { "type": "string" },
+            "name": { "type": "string" }
+          }
+        }
+      },
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "attributes"
+      ],
+      "properties": {
+        "id": { "type": "string" },
+        "type": { "type": "string" },
+        "attributes": {
+          "$ref": "#/definitions/attributes",
+        }
+      }
+    })
+    posts_index = create(:schema, name: "posts/index", json: {
+      "$schema": "https://json-schema.org/draft-04/schema#",
+      "id": "file:/posts/index.json#",
+      "type": "object",
+      "required": [
+        "data"
+      ],
+      "definitions": {
+        "posts": {
+          "type": "array",
+          "items": {
+            "$ref": "file:/post.json#"
+          }
+        }
+      },
+      "properties": {
+        "data": {
+          "$ref": "#/definitions/posts"
+        }
+      }
+    })
+
+    json = build(:response, {
+      "data": [{
+        "id": "1",
+        "type": "Post",
+        "attributes": {
+          "id": 1,
+          "name": "The Post's Name"
+        }
+      }]
+    })
+
+    refute_matches_json_schema(json, posts_index)
+  end
+
+  test "can reference a schema relatively" do
+    create(:schema, name: "post", json: {
+      "$schema": "https://json-schema.org/draft-04/schema#",
+      "id": "file:/post.json#",
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "attributes"
+      ],
+      "properties": {
+        "id": { "type": "string" },
+        "type": { "type": "string" },
+        "attributes": {
+          "type": "object",
+          "required": [
+            "id",
+            "name"
+          ],
+          "properties": {
+            "id": { "type": "string" },
+            "name": { "type": "string" },
+            "user": {
+              "type": "object",
+              "required": [
+                "id"
+              ],
+              "properties": {
+                "id": { "type": "string" }
+              }
+            }
+          }
+        }
+      }
+    })
+    posts_index = create(:schema, name: "posts/index", json: {
+      "$schema": "https://json-schema.org/draft-04/schema#",
+      "id": "file:/posts/index.json#",
+      "type": "object",
+      "required": [
+        "data"
+      ],
+      "definitions": {
+        "posts": {
+          "type": "array",
+          "items": {
+            "$ref": "file:/post.json#"
+          }
+        }
+      },
+      "properties": {
+        "data": {
+          "$ref": "#/definitions/posts"
+        }
+      }
+    })
+
+    json = build(:response, {
+      "data": [{
+        "id": "1",
+        "type": "Post",
+        "attributes": {
+          "id": "1",
+          "name": "The Post's Name",
+          "user": {
+            "id": "1"
+          }
+        }
+      }]
+    })
+
+    assert_matches_json_schema(json, posts_index)
+  end
+
   test "when passed a Hash, validates that the schema matches" do
     schema = create(:schema, :location)
 
@@ -171,6 +312,27 @@ class AssertResponseMatchesSchemaTest < JsonMatchers::TestCase
     refute_matches_json_schema(json_as_array, schema)
   end
 
+  test "validates against a schema that uses nested $refs" do
+    items = create(:schema, :referencing_locations)
+    schema = create(:schema, :referencing_locations, items: items)
+
+    json = build(:response, :location)
+    json_as_array = [[json.to_h]]
+
+    assert_matches_json_schema(json_as_array, schema)
+  end
+
+  test "fails against a schema that uses nested $refs" do
+    items = create(:schema, :referencing_locations)
+    schema = create(:schema, :referencing_locations, items: items)
+
+    json = build(:response, :invalid_location)
+    json_as_array = [[json.to_h]]
+
+    refute_matches_json_schema(json_as_array, schema)
+  end
+
+
   test "validates against a schema referencing with 'definitions'" do
     schema = create(:schema, :referencing_definitions)
 

data/test/support/factory_bot.rb

@@ -2,4 +2,4 @@ require "factory_bot"
 
 FactoryBot.find_definitions
 
-Minitest::Test.send(:include, FactoryBot::Syntax::Methods)
+Minitest::Test.include(FactoryBot::Syntax::Methods)

data/test/test_helper.rb

@@ -3,6 +3,6 @@ require "json_matchers/minitest/assertions"
 
 JsonMatchers.schema_root = "/test/support/api/schemas"
 
-Minitest::Test.send(:include, JsonMatchers::Minitest::Assertions)
+Minitest::Test.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.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Sean Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-02 00:00:00.000000000 Z
+date: 2019-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema