yaml-schema 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c8b8b2332c8bfbf1061b7082c1fc4d5df88ce365d6f9ff4796561abfb25a3af
-  data.tar.gz: e91a4093b75138771c8a78f64a2de9beb4a55dd6727a3604f1863c3a130907b6
+  metadata.gz: 579d1085952dfe8a826de14f05a2af2073da12bf45ef5d5959155447a02a9c0d
+  data.tar.gz: 165be9ca5619b56f47f54ba456e31213662a35fff3f41a21b9d03e0e400feae5
 SHA512:
-  metadata.gz: 0fe1aba2b8398416020a28757d3b00e05927fa55c1c44d410bbf285d26ef0577fc186161c98a5daa87622604d20708d415a0b7231018842b199573906998d615
-  data.tar.gz: 3e2f19f68706ef4404b6d7fc4cad4087f183518fade8158fbdb519cc14d530965a973efeaaf354397db3359030c4d72be0a3d93a937a79b6116ed1e29de42ded
+  metadata.gz: eadb3ccf99d89937351e506a95dc95d3527e19569e1e89b6dad29f66a2b5f9ade673015838526494a7a3c5c2b4f487bb5b386236505542759f0330e60207dd44
+  data.tar.gz: 79132f662fe6b73bed894481f10df139b89839fd7cf97ccd972c8e66bbbaaea6184ef248735c4d5b2695609d72826fa0ff247894f468030a02e1d2548b6d9ee3

data/lib/yaml-schema.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module YAMLSchema
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 
   class Pointer
     include Enumerable
@@ -70,6 +70,7 @@ module YAMLSchema
     class UnexpectedValue < Exception; end
     class InvalidSchema < Exception; end
     class InvalidString < Exception; end
+    class InvalidPattern < Exception; end
     class MissingRequiredField < Exception; end
 
     Valid = Struct.new(:exception).new.freeze
@@ -188,6 +189,7 @@ 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])
 
             return valid if valid.exception
@@ -212,36 +214,6 @@ module YAMLSchema
             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
@@ -268,36 +240,124 @@ module YAMLSchema
         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

@@ -5,6 +5,162 @@ require "psych"
 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 +277,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/

metadata

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