prosody
a8b4e04bc044

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

Changeset

11460:a8b4e04bc044

util.jsonschema: Rename types for improved readability
author Kim Alvefur <zash@zash.se>
date Thu, 18 Mar 2021 23:57:03 +0100
parents 11459:86904555bffc
children 11461:766b0eddd12c
files teal-src/util/json.d.tl teal-src/util/jsonschema.tl util/jsonschema.lua
diffstat 3 files changed, 56 insertions(+), 30 deletions(-) [+]
line wrap: on
line diff
--- a/teal-src/util/json.d.tl	Thu Mar 18 23:16:41 2021 +0100
+++ b/teal-src/util/json.d.tl	Thu Mar 18 23:57:03 2021 +0100
@@ -1,5 +1,18 @@
 local record lib
 	encode : function (any) : string
 	decode : function (string) : any, string
+
+	enum json_type_name
+		"null"
+		"boolean"
+		"object"
+		"array"
+		"number"
+		"string"
+		"integer"
+	end
+
+	type null_type = (nil)
+	null : null_type
 end
 return lib
--- a/teal-src/util/jsonschema.tl	Thu Mar 18 23:16:41 2021 +0100
+++ b/teal-src/util/jsonschema.tl	Thu Mar 18 23:57:03 2021 +0100
@@ -8,18 +8,19 @@
 -- https://json-schema.org/draft/2020-12/json-schema-validation.html
 --
 
-local record schema_t
-	enum type_e
-		"null"
-		"boolean"
-		"object"
-		"array"
-		"number"
-		"string"
-		"integer"
-	end
+local json = require"util.json"
+local null = json.null;
+
+local type json_type_name = json.json_type_name
 
-	type : type_e
+-- json_type_name here is non-standard
+local type schema_t = boolean | json_type_name | json_schema_object
+
+local record json_schema_object
+	type json_type_name = json.json_type_name
+	type schema_object = json_schema_object
+
+	type : json_type_name
 	enum : { any }
 	const : any
 
@@ -56,7 +57,7 @@
 	minContains : integer
 
 	-- objects
-	properties : { string : schema_t | type_e }
+	properties : { string : schema_t }
 	maxProperties : integer
 	minProperties : integer
 	required : { string }
@@ -87,26 +88,30 @@
 	deprecated : boolean
 	readOnly : boolean
 	writeOnly : boolean
+
+	-- methods
+	validate : function ( schema_t, any) : boolean
 end
-local type_e = schema_t.type_e
 
 -- TODO validator function per schema property
 
-local type_validators : { type_e : function (schema_t, any) : boolean } = {}
+local type_validators : { json_type_name : function (schema_t, any) : boolean } = {}
 
-local function simple_validate(schema : type_e, data : any) : boolean
+local function simple_validate(schema : json_type_name, data : any) : boolean
 	if schema == "object" and data is table then
 		return type(data) == "table" and (next(data)==nil or type((next(data, nil))) == "string")
 	elseif schema == "array" and data is table then
 		return type(data) == "table" and (next(data)==nil or type((next(data, nil))) == "number")
 	elseif schema == "integer" then
 		return math.type(data) == schema
+	elseif schema == "null" then
+		return data == null
 	else
 		return type(data) == schema
 	end
 end
 
-type_validators.string = function (schema : schema_t, data : any) : boolean
+type_validators.string = function (schema : json_schema_object, data : any) : boolean
 	-- XXX this is measured in byte, while JSON measures in ... bork
 	-- TODO use utf8.len?
 	if data is string then
@@ -121,7 +126,7 @@
 	return false
 end
 
-type_validators.number = function (schema : schema_t, data : number) : boolean
+type_validators.number = function (schema : json_schema_object, data : number) : boolean
 	if schema.multipleOf and data % schema.multipleOf ~= 0 then
 		return false
 	end
@@ -147,14 +152,14 @@
 
 type_validators.integer = type_validators.number
 
-local function validate(schema : schema_t | type_e | boolean, data : any) : boolean
+local function validate(schema : schema_t, data : any) : boolean
 	if schema is boolean then
 		return schema
 	end
-	if schema is type_e then
+	if schema is json_type_name then
 		return simple_validate(schema, data)
 	end
-	if schema is schema_t then
+	if schema is json_schema_object then
 		if schema.allOf then
 			for _, sub in ipairs(schema.allOf) do
 				if not validate(sub, data) then
@@ -228,7 +233,7 @@
 	end
 end
 
-type_validators.table = function (schema : schema_t, data : any) : boolean
+type_validators.table = function (schema : json_schema_object, data : any) : boolean
 	if data is table then
 
 		if schema.maxItems and #data > schema.maxItems then
@@ -248,12 +253,12 @@
 		end
 
 		if schema.properties then
-			local additional : schema_t | boolean = schema.additionalProperties or true
+			local additional : schema_t = schema.additionalProperties or true
 			for k, v in pairs(data) do
 				if schema.propertyNames and not validate(schema.propertyNames, k) then
 					return false
 				end
-				local s = schema.properties[k as string] or additional as schema_t
+				local s = schema.properties[k as string] or additional
 				if not validate(s, v) then
 					return false
 				end
@@ -345,7 +350,6 @@
 	return false
 end
 
-return {
-	validate = validate;
-	schema_t = schema_t;
-}
+json_schema_object.validate = validate;
+
+return json_schema_object;
--- a/util/jsonschema.lua	Thu Mar 18 23:16:41 2021 +0100
+++ b/util/jsonschema.lua	Thu Mar 18 23:57:03 2021 +0100
@@ -1,6 +1,11 @@
-local schema_t = {xml_t = {}}
+local json = require("util.json")
+local null = json.null;
 
-local type_e = schema_t.type_e
+local json_type_name = json.json_type_name
+
+local schema_t = {}
+
+local json_schema_object = {xml_t = {}}
 
 local type_validators = {}
 
@@ -11,6 +16,8 @@
 		return type(data) == "table" and (next(data) == nil or type((next(data, nil))) == "number")
 	elseif schema == "integer" then
 		return math.type(data) == schema
+	elseif schema == "null" then
+		return data == null
 	else
 		return type(data) == schema
 	end
@@ -253,4 +260,6 @@
 	return false
 end
 
-return {validate = validate; schema_t = schema_t}
+json_schema_object.validate = validate;
+
+return json_schema_object