funeralzone / valueobject-generator
A generator for immutable Value Objects
Installs: 13 968
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 2
Open Issues: 0
Requires
- php: >=7.1.0
- funeralzone/valueobjects: 0.4.*
- prettus/laravel-validation: 1.1.*
- symfony/yaml: 3.*
- twig/twig: 2.4.*
Requires (Dev)
- mockery/mockery: ^0.9.9
- phpunit/phpunit: ^6.2
- squizlabs/php_codesniffer: ^3.0
- dev-master
- 3.1.1
- 3.1.0
- 3.0.0
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.0
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.00
- 0.0.5
- 0.0.4
- 0.0.3
- 0.0.2
- 0.0.1
- dev-fix/add-rootnamespace-as-a-valid-property
- dev-feature/allow-root-namespace-to-be-overridden
- dev-feature/ensure-child-models-are-run-through-middleware
- dev-feature/add-implements-function
- dev-feature/refactor-to-allow-recursive-vos
- dev-feature/fix-erroneous-regeneration-of-models
- dev-feature/improve-hook-flexibility
This package is auto-updated.
Last update: 2024-04-29 03:38:41 UTC
README
Upgrade notes for V0 to V1
Everything is a model
There is no longer a strong bias toward Event Sourcing so the concept of events, commands, queries and deltas has been removed and the onus of implementing these placed on the types/template library.
The practical upshots of this change are as follows:
events, commands, queries and deltas
- Top level items for events, commands, queries and deltas have been removed; every model lives under the model top-level item
- When creating events, commands, queries and deltas there is no deltas property; use must define children models that happen to implement delta behaviour
- events, commands, queries and deltas are now dedicated types - Event, Command, Query and Delta respectively
Seeding models from Prooph meta data
The Event, Command, Query and Delta types include a fromMetaDataKey property that allows you to define a Prooph metadata key to seed from
- name: ExampleEvent type: Event children: - name: ExampleEventAggregateId type: Uuid propertyName: id fromMetaDataKey: _aggregateId
Deltas seeded with the root payload
Deltas can no longer automatically receive the root payload of a command/event.
In V0 you could optionally supply a useRootData flag in the definition which meant the delta received the entire payload of the event or command rather than just its specific property. This is no longer possible.
In order to re-create this behaviour you can bundle up the necessary properties within the Prooph resolver and add a fabricated array property to the command/events payload.
Sets no longer accept child models
In V0 sets would require a single child model which inferred the type of contents the Set would accept. This is no longer possible.
In V1 you must explicitly define the type of model a Set can contain by setting the modelToEnforce property. This property must reference a valid model.
- name: OrganisationalUnitId type: Uuid - name: OrganisationalUnitIds type: Set modelToEnforce: OrganisationalUnitId
Decorators
Decorators have had a overhaul:
- you can now have multiple decorators per model
- you do not define their target, i.e. the nullDecorator, nonNUllDecorator and nullableDecerator properties are defunct
- they are hook based, allowing decorators to be tied into different actions within a model
Available hooks:
- constructor - executes during the constructor of a model and receives all arguments used to instantiate the object
decorators: - path: Funeralzone\FAS\Common\ValueObjects\Decorators\DecoratorOne hooks: - type: constructor method: methodToCallOnConstructOne - path: Funeralzone\FAS\Common\ValueObjects\Decorators\DecoratorTwo hooks: - type: constructor method: methodToCallOnConstructTwo
Example definition
namespace: ValueObjects model: # External models # ========================== - name: EntityId type: String namespace: Funeralzone\FAS\DomainEntities testing: fromNative: "'1'" constructor: "'1'" # Data models # ========================== - name: TenantId type: Uuid - name: BereavedId type: Uuid - name: ContactId type: Uuid - name: DirectoryListingId type: Uuid - name: MediaId type: String decorators: - path: Funeralzone\FAS\Common\ValueObjects\Decorators\MediaIdDecoratorTrait hooks: - type: constructor method: decoratorConstruct - name: MediaUploadRequestId type: String - name: ProductId type: Uuid - name: ServiceId type: Uuid - name: StaffMemberId type: Uuid - name: PackageId type: Uuid # Telephones # -------------------------- - name: TelephoneNumber type: String - name: TelephoneCountryCode type: String - name: Telephone type: Telephone - name: TelephoneType type: Enum values: - WORK - HOME - MOBILE - FAX # Address # -------------------------- - name: AddressLine1 type: String - name: AddressLine2 type: String - name: Town type: String - name: County type: String - name: PostCode type: String - name: CountryCode type: ISOAlpha2CountryCode - name: GeoLocation type: Composite children: - name: AddressData type: String propertyName: data - name: Geometry type: Composite propertyName: geometry children: - name: Latitude type: Float propertyName: lat decorators: - path: Funeralzone\FAS\Common\ValueObjects\Decorators\LatitudeDecoratorTrait hooks: - type: constructor method: decoratorConstruct testing: fromNative: '50.9' constructor: '50.9' - name: Longitude type: Float propertyName: lng testing: fromNative: '50.9' constructor: '50.9' decorators: - path: Funeralzone\FAS\Common\ValueObjects\Decorators\LongitudeDecoratorTrait hooks: - type: constructor method: decoratorConstruct # Identity interface # -------------------------- - name: IdentityInterfacePolicyMembership type: String - name: IdentityInterfacePolicyScope type: String - name: IdentityInterface type: Composite children: - name: IdentityInterfaceType type: Enum propertyName: type values: - STAFF_MEMBER - DEVELOPER - name: IdentityInterfaceName type: String propertyName: name - name: IdentityInterfaceImage type: String propertyName: image - name: IdentityInterfaceEmail type: Email propertyName: email - name: IdentityInterfacePolicy type: Composite propertyName: policy children: - name: IdentityInterfacePolicyMemberships type: Set propertyName: memberships modelToEnforce: IdentityInterfacePolicyMembership - name: IdentityInterfacePolicyScopes type: Set propertyName: scopes modelToEnforce: IdentityInterfacePolicyScope # Other # -------------------------- - name: Note type: Entity children: - name: EntityId propertyName: id - name: NoteTimeCreated type: RFC3339 propertyName: timeCreated - name: NoteContent type: String propertyName: content - name: NoteAuthorId type: Uuid propertyName: authorId - name: Notes type: EntitySet modelToEnforce: Note - name: Name type: Composite children: - name: NameTitle type: String propertyName: title - name: GivenName type: String propertyName: givenName - name: FamilyName type: String propertyName: familyName - name: PersonPhone type: TelephoneContact typeValues: - WORK - HOME - MOBILE - FAX - name: PersonEmail type: Email - name: Person type: Composite children: - name: Name propertyName: name - name: PersonAddress type: Address propertyName: address - name: PersonPhones type: Set propertyName: phones modelToEnforce: PersonPhone - name: PersonEmails type: Set propertyName: emails modelToEnforce: PersonEmail - name: MediaId propertyName: image - name: DirectoryListingIds type: Set modelToEnforce: DirectoryListingId - name: OrganisationalUnitId type: Uuid - name: OrganisationalUnitIds type: Set modelToEnforce: OrganisationalUnitId - name: EstimateId type: Uuid - name: EstimateIds type: Set modelToEnforce: EstimateId - name: Tag type: String decorators: - path: Funeralzone\FAS\Common\ValueObjects\Decorators\TagDecoratorTrait hooks: - type: constructor method: decoratorConstruct - name: Tags type: Set decorators: - path: Funeralzone\FAS\Common\ValueObjects\Decorators\TagsDecoratorTrait modelToEnforce: Tag - name: PaginationInput type: Composite children: - name: PaginationInputPage type: Integer propertyName: page - name: PaginationInputNodesPerPage type: Integer propertyName: nodesPerPage - name: StaffRoleId type: Uuid - name: StaffRoleIds type: Set modelToEnforce: StaffRoleId - name: DeveloperId type: Uuid - name: DeveloperIds type: Set modelToEnforce: DeveloperId - name: PersonDelta type: Delta children: - name: Name propertyName: name - name: PersonAddress propertyName: address - name: PersonPhones propertyName: phones - name: PersonEmails propertyName: emails - name: MediaId propertyName: image