spkl / xor-persist Goto Github PK

The XorPersist.xsd file is too permissive in "prop" and "ref" elements. The following snippet can be part of a valid schema instance:

<obj cn="RootClass">
    <prop mn="String">this is a string <obj cn="A"></obj>bla bla bla</prop>
    <ref mn="Reference">abc<null/>abc</ref>
</obj>

Free text/mixed content should not be allowed in "prop" and "ref" tags with element content.

Native support for dictionaries is missing. Currently, the key and value collections have to be marked as separate XorProperties, and the dictionary has to be initialized by utilizing the XorInitialize method.

Currently, all user implemented classes must be derived from the class XorObject. This is to give all classes the XorId/"_XorId" property, but it is possible to assign all objects IDs i another way:
A central ID manager class creates, assigns and reports the IDs of all objects during the loading and saving progress.

Properties with a type like Nullable/int? should be supported.

As of now, reference lists can only be typed in one of the following ways:

public IEnumerable<XorObject> References { get; set; }
public XorObject[] References { get; set; }

It should be possible to used stronger typed IEnumerables, as it is already possible with XorProperty lists:

public class Foo : XorObject { ... }
public interface IFoo { ... }
...
public IEnumerable<Foo> { get; set; }
public IEnumerable<IFoo> { get; set; }

1. In some cases, the exceptions thrown by the .NET framework are handed to the user or no exceptions are thrown, even if helpful Exceptions with useful information could be thrown.
2. The use of custom exception classes for this library is generally preferred and should be implemented.

Example for 1:

No exception is thrown if a reference cannot be resolved after the model was loaded.

Example for 2.

The parameterless constructor is missing at an XorObject type. A System.Exception is thrown instead of a (e.g.) LateNightStupidities.XorPersist.CtorMissingException.

If an object tree is loaded from a file, and the used classes assign values to properties/fields on construction, XorProperties and XorReferences that are "null" in the saved file, will not be null after loading. Instead, they will have the values, that are assigned on construction.

class Test { [XorProperty(nameof(TestField))] public string TestField = "WrongValue"; }

Currently, it is only possible to use a IEnumerable (XorReference list) or a IEnumerable (XorProperty list, where T : XorObject or interface) for lists.

Other collection classes should also be supported, so a private "translation" property is not necessary.

The following types should be supported:

• System.Collections.ArrayList
• System.Collections.ICollection (using an ArrayList)
• System.Collections.IList (using ArrayList)
• System.Collections.Generic.HashSet
• System.Collections.Generic.List
• System.Collections.Generic.SortedSet
• System.Collections.Generic.ICollection (using a List)
• System.Collections.Generic.IList (using a List)
• System.Collections.Generic.ISet (using a HashSet)

Support for the following typed would be appreciated but is of a lower priority:

• System.Collections.Queue
• System.Collections.Stack
• System.Collections.Generic.LinkedList
• System.Collections.Generic.Queue
• System.Collections.Generic.SortedList
• System.Collections.Generic.Stack

Classes without a public parameterless constructor should be supported.

Documentation should be created for all features.