Use json_schema instead of json-schema #31

malandrina · 2015-12-18T23:59:20Z

The problem

json_matchers cannot easily be used concurrently with Heroku's JSON API tools, i.e. prmd and committee, because json_matchers makes different assumptions about the structure of the user's schemata. An example of an incompatibility can be found in Having an id parameter in the schema messes up schema nesting #25: json_matchers breaks when the id property is present within a schema, but the Heroku tools require the presence of the id property (reference).
This is happening because the libraries used to dereference JSON pointers behave differently. json-schema, the library we're currently using, appears to conform less strictly to the JSON Schema specification than the library the Heroku tools use, json_schema.

The solution

One solution to this problem is to update json_matchers to use the same approach to validating schemata as the Heroku tools. This will require the following changes:
1. Use json_schema instead of json-schema to validate schemata
2. Update documentation to instruct readers to follow Heroku's
  guidelines for structuring schemata:
  https://github.com/interagent/prmd/blob/master/docs/schemata.md
3. Update documentation to reflect that the strict option is no longer supported
In this commit I've replaced json-schema with json_schema and updated the schemata fixtures in the specs. Per this json_schema issue, in order to dereference JSON pointers referencing schemata in other files we need to access the gem's DocumentStore API directly. This is done in Matcher#add_schemata_to_document_store.

houndci-bot · 2015-12-18T23:59:24Z

spec/json_matchers/match_response_schema_spec.rb

+      "$schema": "http://json-schema.org/draft-04/schema#",
+      "type": "object",
+      "properties": {
+        "a": { "$ref": "file:/#{JsonMatchers.schema_root}/nested.json#" }


Put a comma after the last item of a multiline hash.

malandrina · 2015-12-19T00:04:31Z

@seanpdoyle I'd love your feedback on my comments above when you have time. There's no rush -- this is a work in progress.

houndci-bot · 2015-12-19T00:08:10Z

spec/json_matchers/match_response_schema_spec.rb

+      },
+    })
+    create_schema("nested-schema", {
+      "$schema": "http://json-schema.org/draft-04/schema#",


Use 2 spaces for indentation in a hash, relative to the first position after the preceding left parenthesis.

@brandur

After some debug was discovered that the JSON pointers are not working [1]. This patch make the JSON Pointers working again following the recommendation from @brandur [2]. As a note json_matchers has a issue that they are doing the movement from json-schema to json_schema [3]. [1]: 0852b49#commitcomment-14792738 [2]: brandur/json_schema#41 (comment) [3]: thoughtbot/json_matchers#31

houndci-bot · 2018-04-13T14:50:36Z

spec/factories.rb

+          "required": [plural],
+          "properties": {
+            plural => {
+              "$ref": "#/definitions/#{plural}"


Style/TrailingCommaInHashLiteral: Put a comma after the last item of a multiline hash.

houndci-bot · 2018-04-13T14:50:37Z

lib/json_matchers/matcher.rb

@@ -41,5 +44,15 @@ def build_validator(payload)
        schema_path: schema_path,
      )
    end
+
+    def document_store


Lint/DuplicateMethods: Method JsonMatchers::Matcher#document_store is defined at both lib/json_matchers/matcher.rb:28 and lib/json_matchers/matcher.rb:48.

In preparation for [#31][#31], this commit removes support for global and matcher-specific options, like `strict: true`. The [`json_schema` gem][gem] does not accept similar configuration options, so we'll remove support entirely. [#31]: #31 [gem]: https://github.com/brandur/json_schema#programmatic

In preparation for [#31][#31], this commit deprecates support for global and matcher-specific options, like `strict: true`. The [`json_schema` gem][gem] does not accept similar configuration options, so in the future we'll need to remove support entirely. [#31]: #31 [gem]: https://github.com/brandur/json_schema#programmatic

In preparation for [#31][#31], this commit deprecates support for global and matcher-specific options, like `strict: true`. The [`json_schema` gem][gem] does not accept similar configuration options, so in the future we'll need to remove support entirely. Bump gem version to `0.9.0`. [#31]: #31 [gem]: https://github.com/brandur/json_schema#programmatic

In preparation for [#31][#31], this commit removes support for global and matcher-specific options, like `strict: true`. The [`json_schema` gem][gem] does not accept similar configuration options, so we'll remove support entirely. [#31]: #31 [gem]: https://github.com/brandur/json_schema#programmatic

mike-burns

Yes!

mike-burns · 2018-04-13T19:44:27Z

README.md

+To learn more about `$ref`, check out
+[Understanding JSON Schema Structuring][$ref].
+
+[$ref]: http://spacetelescope.github.io/understanding-json-schema/structuring.html


mike-burns · 2018-04-13T19:46:23Z

lib/json_matchers/matcher.rb

+      Dir.glob("#{JsonMatchers.schema_root}/**/*.json").
+        map { |path| Pathname.new(path) }.
+        map { |schema_path| Parser.new(schema_path).parse }.
+        map { |schema| document_store.add_schema(schema) }


Probably an #each here.

The problem: * `json_matchers` cannot easily be used concurrently with Heroku's JSON API tools, i.e. `prmd` and `committee`, because `json_matchers` makes different assumptions about the structure of the user's schemata. An example of an incompatibility can be found in #25: `json_matchers` breaks when the `id` property is present within a schema, but the Heroku tools require the presence of the `id` property ([reference](https://github.com/interagent/prmd/blob/master/docs/schemata.md#meta-data)). This is happening because the libraries used to dereference JSON pointers behave differently. `json-schema`, the library we're currently using, appears to conform less strictly to the JSON Schema specification than the library the Heroku tools use, `json_schema`. The solution: * One solution to this problem is to update `json_matchers` to use the same approach to validating schemata as the Heroku tools. This will require the following changes: 1. Use `json_schema` instead of `json-schema` to validate schemata 2. Update documentation to instruct readers to follow Heroku's guidelines for structuring schemata: https://github.com/interagent/prmd/blob/master/docs/schemata.md * In this commit I've replaced `json-schema` with `json_schema` and updated the schemata fixtures in the specs. Per [this json_schema issue](brandur/json_schema#22), in order to dereference JSON pointers referencing schemata in other files we need to access the gem's DocumentStore API directly. This is done in `Matcher#build_and_populate_document_store`.

houndci-bot reviewed Dec 18, 2015
View reviewed changes

houndci-bot reviewed Dec 19, 2015
View reviewed changes

thoughtbot deleted a comment from houndci-bot Apr 13, 2018

seanpdoyle force-pushed the lw-use-other-json-schema-validator branch from 5533850 to 06862a5 Compare April 13, 2018 14:50

houndci-bot reviewed Apr 13, 2018

View reviewed changes

seanpdoyle mentioned this pull request Apr 13, 2018

Remove support for configuring validation options #77

Merged

seanpdoyle mentioned this pull request Apr 13, 2018

Deprecate support for configuring validation options #78

Closed

seanpdoyle force-pushed the lw-use-other-json-schema-validator branch from 8aaaf02 to 5c4a437 Compare April 13, 2018 19:29

mike-burns reviewed Apr 13, 2018

View reviewed changes

seanpdoyle force-pushed the lw-use-other-json-schema-validator branch from d69cf35 to dfba814 Compare April 13, 2018 20:30

seanpdoyle force-pushed the lw-use-other-json-schema-validator branch from dfba814 to e8b3cc2 Compare April 13, 2018 20:31

seanpdoyle merged commit e8b3cc2 into master Apr 13, 2018

seanpdoyle deleted the lw-use-other-json-schema-validator branch April 13, 2018 20:35

seanpdoyle mentioned this pull request Nov 9, 2018

Strict option is vital #91

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use json_schema instead of json-schema #31

Use json_schema instead of json-schema #31

malandrina commented Dec 18, 2015

houndci-bot Dec 18, 2015

malandrina commented Dec 19, 2015

houndci-bot Dec 19, 2015

houndci-bot Apr 13, 2018

houndci-bot Apr 13, 2018

mike-burns left a comment

mike-burns Apr 13, 2018

mike-burns Apr 13, 2018

Use json_schema instead of json-schema #31

Use json_schema instead of json-schema #31

Conversation

malandrina commented Dec 18, 2015

houndci-bot Dec 18, 2015

Choose a reason for hiding this comment

malandrina commented Dec 19, 2015

houndci-bot Dec 19, 2015

Choose a reason for hiding this comment

houndci-bot Apr 13, 2018

Choose a reason for hiding this comment

houndci-bot Apr 13, 2018

Choose a reason for hiding this comment

mike-burns left a comment

Choose a reason for hiding this comment

mike-burns Apr 13, 2018

Choose a reason for hiding this comment

mike-burns Apr 13, 2018

Choose a reason for hiding this comment