json_skooma 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dce896a1a7c67eef175462387309d5635c989b6dc73feefe0b9e298008f3fe00
-  data.tar.gz: f072c2ff39c2231a7505aebc78d1825f6d1da203062c9611f5ada1dea4dc76ac
+  metadata.gz: 590937fba1ba290810ef51644d7f56126aee04b76ab7ded47b3f8175ccaa2eb5
+  data.tar.gz: 4c9c91d0ea350ad63dbec27730cbb66841e8aa54886d74ad492d7445dde3bd45
 SHA512:
-  metadata.gz: fa5e600b9a45004f9fd4fd980a2290e7fc0d4e1920e81a843b2888f26f860bfb2b4cdce2ae953f4e319ab42c6dd89eddddaf17184dd56a37e4d50f4b2dde0d8e
-  data.tar.gz: d9dde950d0fc71f0e0f5a9a8d4876ffe042cc96fc0fc801eb45f185d740de8505a551b98ddad65af60bad0421929e4f04c369a6ac88cb5bf97a93fd6ecf836cf
+  metadata.gz: fb845c9b702a338437a195ac5511b1a9abb18177a7ec7be314571f6a2c2f089495bc1449d9afd293babab77ef333c963dc1f8a49d4568f674a59e4bd8606bf23
+  data.tar.gz: 4f100d96e00e5e01cfdffe7d38192c19446f1ea901858139903a75598b1413ea5c0887b170fec16b52b1950139a1f006af0a527ec6aef6a96c91ec0b660aeddb

data/CHANGELOG.md

@@ -7,7 +7,19 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
-## [0.2.2] - 2023-04-09
+## [0.2.4] - 2024-10-31
+
+### Added
+
+- Improve error messages for missing required keys ([@alexkalderimis])
+
+## [0.2.3] - 2024-04-28
+
+### Fixed
+
+- Fix `JSONSkooma::Sources::Remote` to allow remote refs. ([@killondark])
+
+## [0.2.2] - 2024-04-09
 
 ### Fixed
 
@@ -41,9 +53,13 @@ and this project adheres to [Semantic Versioning].
 
 - Initial implementation. ([@skryukov])
 
+[@alexkalderimis]: https://github.com/alexkalderimis
+[@killondark]: https://github.com/killondark
 [@skryukov]: https://github.com/skryukov
 
-[Unreleased]: https://github.com/skryukov/json_skooma/compare/v0.2.2...HEAD
+[Unreleased]: https://github.com/skryukov/json_skooma/compare/v0.2.4...HEAD
+[0.2.4]: https://github.com/skryukov/json_skooma/compare/v0.2.3...v0.2.4
+[0.2.3]: https://github.com/skryukov/json_skooma/compare/v0.2.2...v0.2.3
 [0.2.2]: https://github.com/skryukov/json_skooma/compare/v0.2.1...v0.2.2
 [0.2.1]: https://github.com/skryukov/json_skooma/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/skryukov/json_skooma/compare/v0.1.0...v0.2.0

data/README.md

@@ -14,7 +14,7 @@ JSONSkooma is a Ruby library for validating JSONs against JSON Schemas.
 - Supports custom schema resolvers
 
 <a href="https://evilmartians.com/?utm_source=json_skooma&utm_campaign=project_page">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Built by Evil Martians" width="236" height="54">
 </a>
 
 ## Installation
@@ -117,6 +117,45 @@ result.output(:basic)
 #     "error"=>"The instance value \"bar\" must be equal to one of the elements in the defined enumeration: [\"baz\"]"}]}
 ```
 
+### Handling External `$ref`s in JSON Schemas
+
+In `JSONSkooma`, you can map `$ref` identifiers in your JSON schemas to local or remote sources.
+
+This configuration allows `JSONSkooma` to automatically link `$ref` URIs to their corresponding schemas from specified sources:
+
+```yaml
+# schema.yml
+$schema: https://json-schema.org/draft/2020-12/schema
+type: object
+properties:
+  user:
+    $ref: http://local.example/user_definition.yaml
+  product:
+    $ref: http://remote.example/product_definition.yaml
+```
+
+```ruby
+# Initialize the JSONSkooma registry
+schema_registry = JSONSkooma.create_registry("2020-12")
+
+# Add a local source for user definitions
+local_schemas_path = File.join(__dir__, "schemas", "local")
+schema_registry.add_source(
+  "http://local.example/",
+  JSONSkooma::Sources::Local.new(local_schemas_path)
+)
+
+# Add a remote source for product definitions
+schema_registry.add_source(
+  "http://remote.example/",
+  JSONSkooma::Sources::Remote.new("http://example.com/schemas/")
+)
+
+# JSONSkooma now automatically resolves `$refs` to the appropriate schemas:
+# - http://local.example/user_definition.yaml -> ./schemas/local/user_definition.yaml
+# - http://remote.example/product_definition.yaml -> http://example.com/schemas/product_definition.yaml
+```
+
 ## Alternatives
 
 - [json_schemer](https://github.com/davishmcclurg/json_schemer) – Draft 4, 6, 7, 2019-09 and 2020-12 compliant

data/lib/json_skooma/keywords/validation/required.rb

@@ -8,9 +8,20 @@ module JSONSkooma
         self.instance_types = "object"
 
         def evaluate(instance, result)
-          return if json.value.all? { |val| instance.key?(val) }
+          missing = required_keys.reject { |key| instance.key?(key) }
+          return if missing.none?
 
-          result.failure("The object is missing required properties #{json.value.join(", ")}")
+          result.failure(missing_keys_message(missing))
+        end
+
+        private
+
+        def required_keys
+          json.value
+        end
+
+        def missing_keys_message(missing)
+          "The object requires the following keys: #{required_keys.join(", ")}. Missing keys: #{missing.join(", ")}"
         end
       end
     end

data/lib/json_skooma/sources.rb

@@ -46,7 +46,7 @@ module JSONSkooma
       def read(relative_path)
         path = suffix ? relative_path + suffix : relative_path
         url = URI.join(base, path)
-        URI.parse(url).open.read
+        url.read
       rescue OpenURI::HTTPError, SocketError
         raise Error, "Could not fetch #{url}"
       end

data/lib/json_skooma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JSONSkooma
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_skooma
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Svyatoslav Kryukov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-09 00:00:00.000000000 Z
+date: 2024-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -237,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: I bring some sugar for your JSONs.