https://github.com/aib/magicconfig
MagicConfig is a .NET library for creating a hierarchy of change-aware classes with subscribable events.
https://github.com/aib/magicconfig
Last synced: 19 days ago
JSON representation
MagicConfig is a .NET library for creating a hierarchy of change-aware classes with subscribable events.
- Host: GitHub
- URL: https://github.com/aib/magicconfig
- Owner: aib
- License: apache-2.0
- Created: 2018-05-14T10:20:47.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-03T21:55:44.000Z (about 8 years ago)
- Last Synced: 2025-10-29T10:38:07.569Z (9 months ago)
- Language: C#
- Homepage:
- Size: 130 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MagicConfig
MagicConfig is a .NET library for creating a hierarchy of change-aware classes with subscribable events.
## Classes
### ConfigItem
`ConfigItem` is the base class for all other classes. It has two methods; `Equals(ConfigItem)` and `Assign(ConfigItem)`. `Assign` updates the item with another item's values, generating events where appropriate. `Equals` is called first to determine whether an update is necessary in the first place. `Assign` can throw a couple of exceptions:
* `InvalidAssignmentException` is the base class of these exceptions.
* `InvalidTypeAssignmentException` is thrown if an item is being assigned an item of incompatible type or `null`.
* `InvalidChildAssignmentException` is thrown by classes that contain other `ConfigItem`s, such as `StaticMap` and `DynamicMap`. It is thrown at the end of `Assign`, after everything else has completed, with the a of `InvalidAssignmentException`s generated by the children.
### SingleItem
`SingleItem` is a simple wrapper around the (reference) class `T`. It holds a reference to a `T` value and has implicit casts back and forth. (A `null` `SingleItem` converts to a `null` `T`.) `Assign` changes the reference and fires an `Update` event with both old and new references. `Equals` delegates to `T.Equals`.
### SingleValue
`SingleValue` is the unrestricted version of `SingleItem`, designed for value types. It works the same as `SingleItem` except a `null` value converts to `default(T)` and `Equals` delegates to `object.Equals`.
### ItemList
`ItemList` is a list of items of type `T`, which should be `IEquatable`. `Assign` compares every existing element to every new element in a Cartesian fashion, firing `ItemAdded` and `ItemDeleted` events where appropriate. `Updated` is fired if any elements are added or deleted, or the order of the list changes. References to existing items are kept where possible, removals starting from the end of the list.
### StaticMap
`StaticMap` is a wrapper around a type `T`; a strongly-typed map or dictionary, if you will. The type `T` itself should be derived from `StaticMap` (think `class Foo: IEquatable`). `StaticMap` detects the public members of `T` which are of the type `ConfigItem` using reflection. Only these fields are of interest to `StaticMap`. `Assign` updates these fields, firing `ItemUpdated` for individual items and `Updated` once, where appropriate.
### DynamicMap
`DynamicMap` is an untyped map or dictionary from `string`s to `T`s. The type `T` should be derived from `ConfigItem`. Unlike `StaticMap`, `DynamicMap` does not inspect its instance and is not meant to be inherited by user classes. In this regard it is much more similar to a `Dictionary`. `Assign` uses the keys to determine whether an item needs to be added, updated or deleted, firing `ItemAdded`, `ItemUpdated` and `ItemDeleted` where appropriate, as well as an overall `Updated` event.
### KeyedItemList
`KeyedItemList` is a hack around configurations where a map was intended but a list was used. It is a list of items of type `T`, which should be derived from `ConfigItem` and implement `IKeyedItem`. `KeyedItemList` is very similar to `DynamicMap` (it is, in fact, a direct subclass) but uses an item's `GetKeyedItemKey` method to determine its key. Duplicate and dynamic keys are handled poorly.
## Examples ##
For usage examples please see the `UseCase#.cs` files under `tests/`.