yaml-schema 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 579d1085952dfe8a826de14f05a2af2073da12bf45ef5d5959155447a02a9c0d
-  data.tar.gz: 165be9ca5619b56f47f54ba456e31213662a35fff3f41a21b9d03e0e400feae5
+  metadata.gz: 162c65cfdc841b1a41db7d8f5d865b51a145361bfd1623723d73ad8c8fd7030a
+  data.tar.gz: 6a64e47154f5ed2c8910c588add2c5ff4bceeadea4240ccd3469b52277f5fe9f
 SHA512:
-  metadata.gz: eadb3ccf99d89937351e506a95dc95d3527e19569e1e89b6dad29f66a2b5f9ade673015838526494a7a3c5c2b4f487bb5b386236505542759f0330e60207dd44
-  data.tar.gz: 79132f662fe6b73bed894481f10df139b89839fd7cf97ccd972c8e66bbbaaea6184ef248735c4d5b2695609d72826fa0ff247894f468030a02e1d2548b6d9ee3
+  metadata.gz: 1223fa2441b84f33b57c1f826658de489b2d36a4d76de7dd9770832f4a5c12e815aeabbc242d557a76c6f074ab1d344610e1131dd9ea86144ded4c54ac740e23
+  data.tar.gz: 3c6758c8c5efec97b10d02ade2bc25c8fe9f7f4301b01602333c0178bd57804f4db3fbb24c390139a8e12981a88a85de72686d1efc628e1ddd086ca8e4b7952c

data/.github/workflows/ci.yml

@@ -7,6 +7,8 @@ on:
 jobs:
   ruby-versions:
     uses: ruby/actions/.github/workflows/ruby_versions.yml@master
+    with:
+      engine: cruby
 
   test:
     needs: ruby-versions

data/README.md

@@ -11,14 +11,14 @@ A library for validating YAML documents against a schema.
 ### Basic Validation
 
 ```ruby
-require 'yaml-schema'
+require "yaml-schema"
 
 schema = {
-  type: 'object',
-  properties: {
-    name: { type: 'string' },
-    age: { type: 'integer' },
-    active: { type: 'boolean' }
+  "type" => "object",
+  "properties" => {
+    "name" => { "type" => "string" },
+    "age" => { "type" => "integer" },
+    "active" => { "type" => "boolean" }
   }
 }
 
@@ -53,9 +53,9 @@ Specify multiple valid types for a field:
 
 ```ruby
 schema = {
-  type: 'object',
-  properties: {
-    value: { type: ['null', 'string'] }
+  "type" => "object",
+  "properties" => {
+    "value" => { "type" => ["null", "string"] }
   }
 }
 ```
@@ -64,17 +64,17 @@ schema = {
 
 ```ruby
 schema = {
-  type: 'object',
-  properties: {
-    users: {
-      type: 'array',
-      items: {
-        type: 'object',
-        properties: {
-          name: { type: 'string' },
-          tags: {
-            type: 'array',
-            items: { type: 'string' }
+  "type" => "object",
+  "properties" => {
+    "users" => {
+      "type" => "array",
+      "items" => {
+        "type" => "object",
+        "properties" => {
+          "name" => { "type" => "string" },
+          "tags" => {
+            "type" => "array",
+            "items" => { "type" => "string" }
           }
         }
       }

data/lib/yaml-schema.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module YAMLSchema
-  VERSION = "1.1.0"
+  VERSION = "1.2.1"
 
   class Pointer
     include Enumerable
@@ -68,6 +68,7 @@ module YAMLSchema
     class UnexpectedProperty < Exception; end
     class UnexpectedTag < Exception; end
     class UnexpectedValue < Exception; end
+    class UnexpectedAlias < Exception; end
     class InvalidSchema < Exception; end
     class InvalidString < Exception; end
     class InvalidPattern < Exception; end
@@ -78,17 +79,17 @@ module YAMLSchema
     ##
     # Given a particular schema, validate that the node conforms to the
     # schema. Raises an exception if it is invalid
-    def self.validate(schema, node)
-      INSTANCE.validate schema, node
+    def self.validate schema, node, aliases: true
+      INSTANCE.validate schema, node, aliases: aliases
     end
 
     module NodeInfo # :nodoc:
-      def self.read_tag(node)
+      def self.read_tag node
         node.tag
       end
     end
 
-    def initialize(node_info = NodeInfo)
+    def initialize node_info = NodeInfo
       @node_info = node_info
     end
 
@@ -97,8 +98,8 @@ module YAMLSchema
     ##
     # Given a particular schema, validate that the node conforms to the
     # schema. Raises an exception if it is invalid
-    def validate(schema, node)
-      val = _validate(schema["type"], schema, node, Valid, {}, ["root"])
+    def validate schema, node, aliases: true
+      val = _validate(schema["type"], schema, node, Valid, {}, [], aliases)
       if val.exception
         raise val
       else
@@ -109,8 +110,8 @@ module YAMLSchema
     ##
     # Given a particular schema, validate that the node conforms to the
     # schema. Returns an error object if the node is invalid, otherwise false.
-    def invalid?(schema, node)
-      res = _validate(schema["type"], schema, node, Valid, {}, ["root"])
+    def invalid? schema, node, aliases: true
+      res = _validate(schema["type"], schema, node, Valid, {}, [], aliases)
       if Valid == res
         false
       else
@@ -120,17 +121,18 @@ module YAMLSchema
 
     private
 
-    def make_error(klass, msg, path)
-      ex = klass.new msg + " path: #{path.join(" -> ")}"
+    def make_error klass, msg, path
+      ex = klass.new msg + " path: /#{path.join("/")}"
       ex.set_backtrace caller
       ex
     end
 
-    def _validate(type, schema, node, valid, aliases, path)
+    def _validate type, schema, node, valid, aliases, path, allow_aliases
       return valid if valid.exception
 
       if node.anchor
         if node.alias?
+          raise UnexpectedAlias unless allow_aliases
           node = aliases[node.anchor]
         else
           aliases[node.anchor] = node
@@ -142,7 +144,7 @@ module YAMLSchema
       if Array === type
         v = valid
         type.each do |t|
-          v = _validate t, schema, node, valid, aliases, path
+          v = _validate t, schema, node, valid, aliases, path, allow_aliases
           unless v.exception
             break
           end
@@ -178,7 +180,7 @@ module YAMLSchema
           properties = schema["properties"].dup
           key_restriction = schema["propertyNames"] || {}
           node.children.each_slice(2) do |key, val|
-            valid = _validate("string", key_restriction, key, valid, aliases, path)
+            valid = _validate("string", key_restriction, key, valid, aliases, path, allow_aliases)
 
             return valid if valid.exception
 
@@ -186,11 +188,11 @@ module YAMLSchema
               if schema["additionalProperties"]
                 schema["additionalProperties"]
               else
-                return make_error UnexpectedProperty, "unknown property #{key.value.dump}", path
+                return make_error UnexpectedProperty, "unknown property #{key.value.dump}", path + [key.value]
               end
             }
 
-            valid = _validate(sub_schema["type"], sub_schema, val, valid, aliases, path + [key.value])
+            valid = _validate(sub_schema["type"], sub_schema, val, valid, aliases, path + [key.value], allow_aliases)
 
             return valid if valid.exception
           end
@@ -205,9 +207,9 @@ module YAMLSchema
           if schema["items"]
             sub_schema = schema["items"]
             node.children.each_slice(2) do |key, val|
-              valid = _validate("string", {}, key, valid, aliases, path)
+              valid = _validate("string", {}, key, valid, aliases, path, allow_aliases)
               return valid if valid.exception
-              valid = _validate(sub_schema["type"], sub_schema, val, valid, aliases, path + [key.value])
+              valid = _validate(sub_schema["type"], sub_schema, val, valid, aliases, path + [key.value], allow_aliases)
               return valid if valid.exception
             end
           else
@@ -230,12 +232,12 @@ module YAMLSchema
         if schema["items"]
           node.children.each_with_index { |item, i|
             sub_schema = schema["items"]
-            valid = _validate sub_schema["type"], sub_schema, item, valid, aliases, path + [i]
+            valid = _validate sub_schema["type"], sub_schema, item, valid, aliases, path + [i], allow_aliases
           }
         elsif schema["prefixItems"]
           node.children.each_with_index { |item, i|
             sub_schema = schema["prefixItems"][i]
-            valid = _validate sub_schema["type"], sub_schema, item, valid, aliases, path + [i]
+            valid = _validate sub_schema["type"], sub_schema, item, valid, aliases, path + [i], allow_aliases
           }
         else
           raise NotImplementedError
@@ -287,7 +289,7 @@ module YAMLSchema
             when "integer", "float", "time", "date", "symbol"
               found_type = extract_type(node.value)
               unless found_type == type.to_sym
-                return make_error UnexpectedValue, "expected #{type}, got #{type}", path
+                return make_error UnexpectedValue, "expected #{type}, got #{found_type}", path
               end
             else
               raise "unknown type #{schema["type"]}"
@@ -313,7 +315,7 @@ module YAMLSchema
                          |[-+]?0x[_]*[0-9a-fA-F][0-9a-fA-F_]* (?# base 16))$/x
 
     # Tokenize +string+ returning the Ruby object
-    def extract_type(string)
+    def extract_type string
       return :null if string.empty?
       # Check for a String type, being careful not to get caught by hash keys, hex values, and
       # special floats (e.g., -.inf).

data/test/validator_test.rb

@@ -1,6 +1,7 @@
 require "minitest/autorun"
 require "yaml-schema"
 require "psych"
+require "date"
 
 module YAMLSchema
   class Validator
@@ -690,6 +691,24 @@ bar: *1
         }, ast.children.first)
       end
 
+      def test_optionally_disallow_aliases
+        ast = Psych.parse(<<-eoyml)
+---
+foo: &1
+- foo
+bar: *1
+        eoyml
+        assert_raises UnexpectedAlias do
+          Validator.validate({
+            "type" => "object",
+            "properties" => {
+              "foo" => { "type" => "array", "items" => { "type" => "string" } },
+              "bar" => { "type" => "array", "items" => { "type" => "string" } },
+            },
+          }, ast.children.first, aliases: false)
+        end
+      end
+
       class CustomInfo
         def read_tag(node)
           if node.tag == "!aaron"

data/yaml-schema.gemspec

@@ -15,5 +15,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'psych', '~> 5.0'
-  s.add_development_dependency 'minitest', '~> 5.15'
+  s.add_development_dependency 'minitest', '>= 5.15'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yaml-schema
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Aaron Patterson
@@ -41,14 +41,14 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.15'
 description: If you need to validate YAML against a schema, use this
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Validate YAML against a schema
 test_files: