strict_json_schema_generator 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dbbea843ebad164d883cb1ecfdae9185b54ed118c812f84c589f3435c512dd88
+  data.tar.gz: cb62e100998e3b58f2fb52fc249baafb532b02e78f1732c98f0844514eae9c01
+SHA512:
+  metadata.gz: 9ec272b55d8c644cef6db7ccafbd3e257c745bf9dda8ba3a5058f2eaecf6d0fd8cc48be02f1339b17ca8bee7974dde1502350a3f471e63bf4643ca5abd52ccce
+  data.tar.gz: 8ebc9c1ebb8c3c1a0679dea66b3c3d902651b2d3f1722daec3be6ce37a38ee7890aaacfcce9c917a0e9ab75d3a1cd52edb477660ae7ea14cda72e20e848549ad

data/lib/json/strict_schema_generator.rb

@@ -0,0 +1,62 @@
+module JSON
+  class StrictSchemaGenerator
+    attr_reader :schema
+
+    # beware that the provided object must have symbol keys and will be modified
+    def self.call(schema)
+      new(schema).strictify!
+    end
+
+    def initialize(schema)
+      @schema = schema
+    end
+
+    def strictify!
+      set_strict_attributes_for(schema)
+
+      schema
+    end
+
+    private
+
+    def type
+      @type ||= schema[:type].to_s
+    end
+
+    def object?
+      type == 'object'
+    end
+
+    def object_with_properties?
+      object? && schema[:properties].is_a?(Hash)
+    end
+
+    def set_strict_attributes_for(schema_subset)
+      set_object_strict_attributes(schema_subset)
+
+      schema_subset.each do |_key, subset|
+        case subset
+        when Hash
+          self.class.call(subset)
+        when Array
+          subset.each do |item|
+            self.class.call(item) if item.is_a?(Hash)
+          end
+        end
+      end
+    end
+
+    def set_object_strict_attributes(schema_subset)
+      return unless object_with_properties?
+
+      schema_subset.merge!(
+        required: schema_subset[:required] || schema_subset[:properties].keys,
+        additionalProperties: false
+      )
+
+      schema_subset[:properties].each do |_, property|
+        self.class.call(property)
+      end
+    end
+  end
+end

data/lib/rspec/strictly_match_schema.rb

@@ -0,0 +1,7 @@
+RSpec::Matchers.define :strictly_match_schema do |schema|
+  match do |data|
+    schema_dup = JSON.parse(schema.to_json, symbolize_names: true)
+
+    JSON::Validator.validate!(JSON::StrictSchemaGenerator.call(schema_dup), data)
+  end
+end

data/lib/strict_json_schema_generator.rb

@@ -0,0 +1,2 @@
+require 'json/strict_schema_generator'
+require 'rspec/strictly_match_schema' if defined?(RSpec)

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: strict_json_schema_generator
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Alexandre Bernard
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Ease the pain from manually requiring all fields in a JSON Schema when
+  no required field list is specified
+email: archiduc@alexandrebernard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/json/strict_schema_generator.rb
+- lib/rspec/strictly_match_schema.rb
+- lib/strict_json_schema_generator.rb
+homepage: https://github.com/AlexandreBernard/rb_strict_json_schema_generator
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/AlexandreBernard/rb_strict_json_schema_generator
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Transforms a JSON Schema to require all fields when not specified
+test_files: []