justin-millman / Kvasir / 13468337505

99%

master: 98%

push

github

Pre-Defined Entities

This commit implements support for Pre-Defined Entities in the Translation, Extraction, and Reconstitution layer. A
Pre-Defined Entity is an Entity type that exposes a discrete number of static instances of itself and prevents creation
of arbitrary additional instances. Data for a Pre-Defined Entity is expected to be hard-coded in-source; in this way,
Pre-Defined Entities serve a similar role to enumerations, but prevent arbitrary extension (e.g. by casting a random
integer) and allow for attached metadata. A type is made a Pre-Defined Entity with the new [PreDefined] annotation.

Pre-Defined Entities are translated much like a regular Entity, though there are some limitations. All properties of a
Pre-Defined Entity that contribute to the data model must be read-only, and a Pre-Defined Entity cannot have any public
constructors. At least 2 static instances of the Pre-Defined Entity's own type must be exposed; public ones are part of
the data model by default (but can be excluded via [CodeOnly]), and non-public ones cannot be elevated (unlike with
non-public properties for Fields). Reference-type Fields on a Pre-Defined Entity may only resolve against other
Pre-Defined Entities; this includes via Relations. The prohibition against cyclical references still applies. Other
than [CodeOnly] and [IncludeInDataModel] (the latter being redundant), no annotations are allowed on the static
propertie that identify the pre-defined instances.

Extraction of data for a Pre-Defined Entity is the same as for regular Entities. Reconstitution uses the existing
infrastructure, leveraging the KeyLookupCreator normally used for Reference resolution to ensure that instances are
placed into the appropriate depot by the select-all query in the Transaction Layer.

3757 of 3868 branches covered (97.13%)

Branch coverage included in aggregate %.

165 of 165 new or added lines in 14 files covered. (100.0%)

6019 of 6038 relevant lines covered (99.69%)

5139.22 hits per line