yaml-schema 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c8b8b2332c8bfbf1061b7082c1fc4d5df88ce365d6f9ff4796561abfb25a3af
-  data.tar.gz: e91a4093b75138771c8a78f64a2de9beb4a55dd6727a3604f1863c3a130907b6
+  metadata.gz: e7079554145bf81aef3f0fb89dfa5ad5e0867336866989da48e9217cbae1f114
+  data.tar.gz: e6bc2b714f98cce44632e17fc6b9d4d8bbaebea4583427897019ce8d28f81293
 SHA512:
-  metadata.gz: 0fe1aba2b8398416020a28757d3b00e05927fa55c1c44d410bbf285d26ef0577fc186161c98a5daa87622604d20708d415a0b7231018842b199573906998d615
-  data.tar.gz: 3e2f19f68706ef4404b6d7fc4cad4087f183518fade8158fbdb519cc14d530965a973efeaaf354397db3359030c4d72be0a3d93a937a79b6116ed1e29de42ded
+  metadata.gz: 347fe6c4f3a01eefc61b4f6a18570893c472fa815f942b9ec57ac9ccd8abd6d7f06d73b0f757dd38dee5c9da5f6e01d8c4dd76e5e726d4b92aa0e4a966126f89
+  data.tar.gz: 62a7ec295631d838f06c8932f4c1ae614650cfb635b1bd9bb2539425a53575e1bf87a9af748d1632e082c0f25dc93c7cc311173300c5bf47bfbf3cd11dbc6d41

data/lib/yaml-schema.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module YAMLSchema
-  VERSION = "1.0.1"
+  VERSION = "1.2.0"
 
   class Pointer
     include Enumerable
@@ -68,8 +68,10 @@ 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
     class MissingRequiredField < Exception; end
 
     Valid = Struct.new(:exception).new.freeze
@@ -77,8 +79,8 @@ 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:
@@ -96,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, {}, ["root"], aliases)
       if val.exception
         raise val
       else
@@ -108,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, {}, ["root"], aliases)
       if Valid == res
         false
       else
@@ -125,11 +127,12 @@ module YAMLSchema
       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
@@ -141,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
@@ -177,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
 
@@ -188,7 +191,8 @@ module YAMLSchema
                 return make_error UnexpectedProperty, "unknown property #{key.value.dump}", path
               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
@@ -203,45 +207,15 @@ 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
             raise InvalidSchema, "objects must specify items or properties"
           end
         end
-      when "string"
-        unless node.scalar?
-          return make_error UnexpectedType, "expected Scalar, got #{node.class.name.dump}", path
-        end
-
-        unless node.quoted || node.tag == "!str"
-          if node.value == "false" || node.value == "true"
-            return make_error UnexpectedValue, "expected string, got boolean", path
-          end
-
-          if node.value == ""
-            return make_error UnexpectedValue, "expected string, got null", path
-          end
-
-          if node.value.match?(/^[-+]?(?:0|[1-9](?:[0-9]|,[0-9]|_[0-9])*)$/)
-            return make_error UnexpectedValue, "expected string, got integer", path
-          end
-        end
-
-        if schema["maxLength"] && node.value.bytesize > schema["maxLength"]
-          return make_error InvalidString, "expected string length to be <= #{schema["maxLength"]}", path
-        end
-
-        if schema["minLength"] && node.value.bytesize < schema["minLength"]
-          return make_error InvalidString, "expected string length to be >= #{schema["minLength"]}", path
-        end
-
-        if schema["pattern"] && !(node.value.match?(schema["pattern"]))
-          return make_error InvalidString, "expected string to match #{schema["pattern"]}", path
-        end
       when "array"
         unless node.sequence?
           return make_error UnexpectedType, "expected Sequence, got #{node.class.name.dump}", path
@@ -258,46 +232,134 @@ 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
         end
-      when "null"
+      else
         unless node.scalar?
           return make_error UnexpectedType, "expected Scalar, got #{node.class.name.dump}", path
         end
 
-        unless node.value == ""
-          return make_error UnexpectedValue, "expected empty string, got #{node.value.dump}", path
-        end
-      when "boolean"
-        unless node.scalar?
-          return make_error UnexpectedType, "expected Scalar, got #{node.class.name.dump}", path
-        end
-        unless node.value == "false" || node.value == "true"
-          return make_error UnexpectedValue, "expected 'true' or 'false' for boolean", path
-        end
-      when "integer"
-        unless node.scalar?
-          return make_error UnexpectedType, "expected Scalar, got #{node.class.name.dump}", path
+        if type == "string"
+          unless node.quoted || node.tag == "!str"
+            type = extract_type(node.value)
+
+            if type != :string
+              return make_error UnexpectedValue, "expected string, got #{type}", path
+            end
+          end
+
+          if schema["maxLength"] && node.value.bytesize > schema["maxLength"]
+            return make_error InvalidString, "expected string length to be <= #{schema["maxLength"]}", path
+          end
+
+          if schema["minLength"] && node.value.bytesize < schema["minLength"]
+            return make_error InvalidString, "expected string length to be >= #{schema["minLength"]}", path
+          end
+
+          if schema["pattern"] && !(node.value.match?(schema["pattern"]))
+            return make_error InvalidPattern, "expected string '#{node.value.dump}' to match #{schema["pattern"]}", path
+          end
+        else
+          if node.quoted
+            return make_error UnexpectedValue, "expected #{type}, got string", path
+          end
+
+          if type == "null"
+            unless node.value == ""
+              return make_error UnexpectedValue, "expected empty string, got #{node.value.dump}", path
+            end
+          else
+            if schema["pattern"] && !(node.value.match?(schema["pattern"]))
+              return make_error InvalidPattern, "expected '#{node.value.dump}' to match #{schema["pattern"]}", path
+            end
+
+            case type
+            when "boolean"
+              unless node.value == "false" || node.value == "true"
+                return make_error UnexpectedValue, "expected 'true' or 'false' for boolean", path
+              end
+            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
+              end
+            else
+              raise "unknown type #{schema["type"]}"
+            end
+          end
         end
-        if node.quoted
-          return make_error UnexpectedValue, "expected integer, got string", path
+      end
+
+      valid
+    end
+
+    # Taken from http://yaml.org/type/timestamp.html
+    TIME = /^-?\d{4}-\d{1,2}-\d{1,2}(?:[Tt]|\s+)\d{1,2}:\d\d:\d\d(?:\.\d*)?(?:\s*(?:Z|[-+]\d{1,2}:?(?:\d\d)?))?$/
+
+    # Taken from http://yaml.org/type/float.html
+    # Base 60, [-+]inf and NaN are handled separately
+    FLOAT = /^(?:[-+]?([0-9][0-9_,]*)?\.[0-9]*([eE][-+][0-9]+)?(?# base 10))$/x
+
+    # Taken from http://yaml.org/type/int.html and modified to ensure at least one numerical symbol exists
+    INTEGER_STRICT = /^(?:[-+]?0b[_]*[0-1][0-1_]*             (?# base 2)
+                         |[-+]?0[_]*[0-7][0-7_]*              (?# base 8)
+                         |[-+]?(0|[1-9][0-9_]*)               (?# base 10)
+                         |[-+]?0x[_]*[0-9a-fA-F][0-9a-fA-F_]* (?# base 16))$/x
+
+    # Tokenize +string+ returning the Ruby object
+    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).
+      if string.match?(%r{^[^\d.:-]?[[:alpha:]_\s!@#$%\^&*(){}<>|/\\~;=]+}) || string.match?(/\n/)
+        return :string if string.length > 5
+
+        if string.match?(/^[^ytonf~]/i)
+          :string
+        elsif string == '~' || string.match?(/^null$/i)
+          :null
+        elsif string.match?(/^(yes|true|on)$/i)
+          :boolean
+        elsif string.match?(/^(no|false|off)$/i)
+          :boolean
+        else
+          :string
         end
-        unless node.value.match?(/^[-+]?(?:0|[1-9](?:[0-9]|,[0-9]|_[0-9])*)$/)
-          return make_error UnexpectedValue, "expected integer, got string", path
+      elsif string.match?(TIME)
+        :time
+      elsif string.match?(/^\d{4}-(?:1[012]|0\d|\d)-(?:[12]\d|3[01]|0\d|\d)$/)
+        :date
+      elsif string.match?(/^\+?\.inf$/i)
+        :float
+      elsif string.match?(/^-\.inf$/i)
+        :float
+      elsif string.match?(/^\.nan$/i)
+        :float
+      elsif string.match?(/^:./)
+        :symbol
+      elsif string.match?(/^[-+]?[0-9][0-9_]*(:[0-5]?[0-9]){1,2}$/)
+        :sexagesimal
+      elsif string.match?(/^[-+]?[0-9][0-9_]*(:[0-5]?[0-9]){1,2}\.[0-9_]*$/)
+        :sexagesimal
+      elsif string.match?(FLOAT)
+        if string.match?(/\A[-+]?\.\Z/)
+          :string
+        else
+          :float
         end
+      elsif string.match?(INTEGER_STRICT)
+        :integer
       else
-        raise "unknown type #{schema["type"]}"
+        :string
       end
-
-      valid
     end
   end
 end

data/test/validator_test.rb

@@ -1,10 +1,167 @@
 require "minitest/autorun"
 require "yaml-schema"
 require "psych"
+require "date"
 
 module YAMLSchema
   class Validator
     class ErrorTest < Minitest::Test
+      def test_pattern_symbol
+        ast = Psych.parse(Psych.dump({ "foo" => :foo }))
+
+        assert_raises InvalidPattern do
+          Validator.validate({
+            "type" => "object",
+            "properties" => {
+              "foo" => {
+                "type" => "symbol",
+                "pattern" => /\A:bar\z/
+              },
+            },
+          }, ast.children.first)
+        end
+      end
+
+      def test_pattern_time
+        ast = Psych.parse(Psych.dump({ "foo" => Time.now }))
+
+        assert_raises InvalidPattern do
+          Validator.validate({
+            "type" => "object",
+            "properties" => {
+              "foo" => {
+                "type" => "time",
+                "pattern" => /\Ayay\z/
+              },
+            },
+          }, ast.children.first)
+        end
+      end
+
+      def test_pattern_null
+        ast = Psych.parse(Psych.dump({ "foo" => nil }))
+
+        assert Validator.validate({
+          "type" => "object",
+          "properties" => {
+            "foo" => {
+              "type" => "null",
+              "pattern" => /\Anotnull\z/
+            },
+          },
+        }, ast.children.first)
+      end
+
+      def test_pattern_float
+        ast = Psych.parse(Psych.dump({ "foo" => 1.2 }))
+
+        assert_raises InvalidPattern do
+          Validator.validate({
+            "type" => "object",
+            "properties" => {
+              "foo" => {
+                "type" => "float",
+                "pattern" => /\A1\.3\z/
+              },
+            },
+          }, ast.children.first)
+        end
+      end
+
+      def test_pattern_boolean
+        yaml = "---\n foo: true"
+        ast = Psych.parse(yaml)
+
+        assert_raises InvalidPattern do
+          Validator.validate({
+            "type" => "object",
+            "properties" => {
+              "foo" => {
+                "type" => "boolean",
+                "pattern" => /\Atru\z/
+              },
+            },
+          }, ast.children.first)
+        end
+      end
+
+      def test_pattern_date
+        yaml = "---\n foo: 2025-11-19"
+
+        ast = Psych.parse(yaml)
+        assert Validator.validate({
+          "type" => "object",
+          "properties" => {
+            "foo" => {
+              "type" => "date",
+              "pattern" => /\A2025-11-19\z/
+            },
+          },
+        }, ast.children.first)
+
+        assert_raises InvalidPattern do
+          Validator.validate({
+            "type" => "object",
+            "properties" => {
+              "foo" => {
+                "type" => "date",
+                "pattern" => /\A2025-11-20\z/
+              },
+            },
+          }, ast.children.first)
+        end
+      end
+
+      def test_accept_non_strings
+        [Float::INFINITY, -Float::INFINITY, Float::NAN].each do |v|
+          ast = Psych.parse(Psych.dump({ "foo" => v }))
+          assert Validator.validate({
+            "type" => "object",
+            "properties" => {
+              "foo" => { "type" => "float" },
+            },
+          }, ast.children.first)
+        end
+
+        ast = Psych.parse(Psych.dump({ "foo" => Time.now }))
+        assert Validator.validate({
+          "type" => "object",
+          "properties" => {
+            "foo" => { "type" => "time" },
+          },
+        }, ast.children.first)
+
+        ast = Psych.parse(Psych.dump({ "foo" => Date.today }))
+        assert Validator.validate({
+          "type" => "object",
+          "properties" => {
+            "foo" => { "type" => "date" },
+          },
+        }, ast.children.first)
+
+        ast = Psych.parse(Psych.dump({ "foo" => :foo }))
+        assert Validator.validate({
+          "type" => "object",
+          "properties" => {
+            "foo" => { "type" => "symbol" },
+          },
+        }, ast.children.first)
+      end
+
+      def test_reject_non_strings
+        [Float::INFINITY, -Float::INFINITY, Float::NAN, Time.now, Date.today, :foo].each do |v|
+          ast = Psych.parse(Psych.dump({ "foo" => v }))
+          assert_raises UnexpectedValue do
+            Validator.validate({
+              "type" => "object",
+              "properties" => {
+                "foo" => { "type" => "string" },
+              },
+            }, ast.children.first)
+          end
+        end
+      end
+
       def test_property_max_length
         ast = Psych.parse("---\n  hello: world")
         assert_raises InvalidString do
@@ -121,7 +278,7 @@ module YAMLSchema
 
       def test_regular_expression
         ast = Psych.parse("bar")
-        assert_raises InvalidString do
+        assert_raises InvalidPattern do
           Validator.validate({
             "type" => "string",
             "pattern" => /foo/
@@ -534,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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yaml-schema
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Aaron Patterson