private import ::serialization::engine_tools
private import static
private import string_parser
+import poset
# Deserializer from a Json string.
class JsonDeserializer
# Json text to deserialize from.
private var text: Text
+ # Accepted parameterized classes to deserialize
+ #
+ # If `whitelist.empty`, all types are accepted.
+ #
+ # ~~~nitish
+ # import json::serialization
+ #
+ # class MyClass
+ # serialize
+ # end
+ #
+ # var json_string = """
+ # {"__class" = "MyClass"}
+ # """
+ #
+ # var deserializer = new JsonDeserializer(json_string)
+ # var obj = deserializer.deserialize
+ # assert deserializer.errors.is_empty
+ # assert obj isa MyClass
+ #
+ # deserializer = new JsonDeserializer(json_string)
+ # deserializer.whitelist.add "Array[String]"
+ # deserializer.whitelist.add "AnotherAcceptedClass"
+ # obj = deserializer.deserialize
+ # assert deserializer.errors.length == 1
+ # assert obj == null
+ # ~~~
+ var whitelist = new Array[Text]
+
+ # Should objects be checked if they a subtype of the static type before deserialization?
+ #
+ # Defaults to `true`, as it should always be activated.
+ # It can be turned off to implement the subtype check itself.
+ var check_subtypes = true is writable
+
# Root json object parsed from input text.
private var root: nullable Object is noinit
if class_name == null and static_type != null then
# Fallack to the static type, strip the `nullable` prefix
var prefix = "nullable "
- if static_type.has(prefix) then
+ if static_type.has_prefix(prefix) then
class_name = static_type.substring_from(prefix.length)
else class_name = static_type
end
return object
end
+ if whitelist.not_empty and not whitelist.has(class_name) then
+ errors.add new Error("Deserialization Error: '{class_name}' not in whitelist")
+ return null
+ end
+
+ if static_type != null and check_subtypes then
+ var static_class = static_type.strip_nullable_and_params
+ var dynamic_class = class_name.strip_nullable_and_params
+ if not class_inheritance_metamodel.has_edge(dynamic_class, static_class) then
+ errors.add new Error("Deserialization Error: `{class_name}` is not a subtype of the static type `{static_type}`")
+ return null
+ end
+ end
+
# advance on path
path.push object
# Current array open for deserialization, used by `SimpleCollection::from_deserializer`
private var opened_array: nullable Array[nullable Object] = null
- redef fun deserialize
+ redef fun deserialize(static_type)
do
errors.clear
- return convert_object(root)
+ return convert_object(root, static_type)
end
# User customizable heuristic to infer the name of the Nit class to deserialize `json_object`
end
return res
end
+
+ # Strip the `nullable` prefix and the params from the class name `self`
+ #
+ # ~~~nitish
+ # assert "String".strip_nullable_and_params == "String"
+ # assert "Array[Int]".strip_nullable_and_params == "Array"
+ # assert "Map[Set[String], Set[Int]]".strip_nullable_and_params == "Map"
+ # ~~~
+ private fun strip_nullable_and_params: String
+ do
+ var class_name = to_s
+
+ var prefix = "nullable "
+ if class_name.has_prefix(prefix) then class_name = class_name.substring_from(prefix.length)
+
+ var bracket_index = class_name.index_of('[')
+ if bracket_index == -1 then return class_name
+ return class_name.substring(0, bracket_index)
+ end
end
redef class SimpleCollection[E]
open_array = arr
end
- # Try to get the name of the single parameter type assuming it is E.
- # This does not work in non-generic subclasses,
- # when the first parameter is not E, or
- # when there is more than one parameter. (The last one could be fixed)
- var class_name = class_name
- var items_type = null
- var bracket_index = class_name.index_of('[')
- if bracket_index != -1 then
- var start = bracket_index + 1
- var ending = class_name.last_index_of(']')
- items_type = class_name.substring(start, ending-start)
- end
+ # Name of the dynamic name of E
+ var items_type_name = (new GetName[E]).to_s
# Fill array
for o in open_array do
- var obj = v.convert_object(o, items_type)
+ var obj = v.convert_object(o, items_type_name)
if obj isa E then
add obj
- else v.errors.add new AttributeTypeError(self, "items", obj, "E")
+ else v.errors.add new AttributeTypeError(self, "items", obj, items_type_name)
end
end
end
v.notify_of_creation self
init
+ var keys_type_name = (new GetName[K]).to_s
+ var values_type_name = (new GetName[V]).to_s
+
var length = v.deserialize_attribute("__length")
var keys = v.path.last.get_or_null("__keys")
var values = v.path.last.get_or_null("__values")
+ if keys == null and values == null then
+ # Fallback to a plain object
+ for key, value_src in v.path.last do
+
+ var value = v.convert_object(value_src, values_type_name)
+
+ if not key isa K then
+ v.errors.add new AttributeTypeError(self, "keys", key, keys_type_name)
+ continue
+ end
+
+ if not value isa V then
+ v.errors.add new AttributeTypeError(self, "values", value, values_type_name)
+ continue
+ end
+
+ self[key] = value
+ end
+ return
+ end
+
# Length is optional
if length == null and keys isa SequenceRead[nullable Object] then length = keys.length
return
end
+ # First, convert all keys to follow the order of the serialization
+ var converted_keys = new Array[K]
for i in length.times do
- var key = v.convert_object(keys[i])
- var value = v.convert_object(values[i])
+ var key = v.convert_object(keys[i], keys_type_name)
if not key isa K then
- v.errors.add new AttributeTypeError(self, "keys", key, "K")
+ v.errors.add new AttributeTypeError(self, "keys", key, keys_type_name)
continue
end
+ converted_keys.add key
+ end
+
+ # Then convert the values and build the map
+ for i in length.times do
+ var key = converted_keys[i]
+ var value = v.convert_object(values[i], values_type_name)
+
if not value isa V then
- v.errors.add new AttributeTypeError(self, "values", value, "V")
+ v.errors.add new AttributeTypeError(self, "values", value, values_type_name)
continue
end
end
end
end
+
+# ---
+# Metamodel
+
+# Class inheritance graph as a `POSet[String]` serialized to JSON
+private fun class_inheritance_metamodel_json: CString is intern
+
+redef class Sys
+ # Class inheritance graph
+ #
+ # ~~~
+ # var hierarchy = class_inheritance_metamodel
+ # assert hierarchy.has_edge("String", "Object")
+ # assert not hierarchy.has_edge("Object", "String")
+ # ~~~
+ var class_inheritance_metamodel: POSet[String] is lazy do
+ var engine = new JsonDeserializer(class_inheritance_metamodel_json.to_s)
+ engine.check_subtypes = false
+ engine.whitelist.add_all(
+ ["String", "POSet[String]", "POSetElement[String]", "HashSet[String]", "HashMap[String, POSetElement[String]]"])
+ var poset = engine.deserialize
+ if engine.errors.not_empty then
+ print_error engine.errors.join("\n")
+ return new POSet[String]
+ end
+ if poset isa POSet[String] then return poset
+ return new POSet[String]
+ end
+end
+
+redef class Deserializer
+ redef fun deserialize_class(name)
+ do
+ if name == "POSet[String]" then return new POSet[String].from_deserializer(self)
+ if name == "POSetElement[String]" then return new POSetElement[String].from_deserializer(self)
+ if name == "HashSet[String]" then return new HashSet[String].from_deserializer(self)
+ if name == "HashMap[String, POSetElement[String]]" then return new HashMap[String, POSetElement[String]].from_deserializer(self)
+
+ return super
+ end
+end
nitlanguage / nit.git / blobdiff