Implement 16 core event projections for domain events #305

Closed
opened 2026-03-16 01:59:26 +00:00 by freemo · 0 comments
Owner

Metadata

Key Value
Branch feature/m2-core-projections
Commit Message feat: implement 16 core event projections for domain events
Parent Epic #302 — Event Projection System

Background and Context

With the EventProjection base class and RenderOp model in place, the system needs concrete projections for all major domain events. These 16 projections cover the core gameplay loop: movement, communication, combat, stats, environment, inventory, progression, and system messages.

Expected Behavior

Each projection maps a specific domain event to one or more RenderOps:

# Domain Event Target Window RenderOp Type Description
1 RoomEntered :main + :map :text_append + :map_refresh Show room description and refresh map
2 EntityArrived :main :text_append "X arrives from the north."
3 EntityDeparted :main :text_append "X leaves to the south."
4 Speech :main :text_append "X says, 'Hello!'"
5 Whisper :main :text_append "X whispers to you, '...'"
6 StatChanged :status :bar_update Update stat bar
7 HealthChanged :status :bar_update Update HP bar
8 CombatStart :main :text_append Combat initiation message
9 CombatTurn :main + :status :text_append + :bar_update Turn results and HP update
10 CombatEnd :main :text_append Combat resolution message
11 TimeAdvanced :status :bar_update Update time display
12 WeatherChanged :main :text_append Weather description change
13 ItemPickedUp :main :text_append "You pick up X."
14 ItemDropped :main :text_append "You drop X."
15 SkillGained :main :text_append + :overlay_show Skill-up notification
16 SystemMessage :main :text_append System/server announcement

Acceptance Criteria

  • All 16 projections are implemented as EventProjection subclasses.
  • Each projection is registered in the ProjectionRegistry.
  • RoomEntered produces both :text_append and :map_refresh ops.
  • CombatTurn produces both :text_append and :bar_update ops.
  • SkillGained produces both :text_append and :overlay_show ops.
  • Text content is player-friendly and correctly formatted.
  • Projections handle edge cases (nil entity, missing data) gracefully.

Subtasks

Code

  • Create RoomProjection handling RoomEntered, EntityArrived, EntityDeparted.
  • Create CommunicationProjection handling Speech, Whisper.
  • Create StatsProjection handling StatChanged, HealthChanged.
  • Create CombatProjection handling CombatStart, CombatTurn, CombatEnd.
  • Create EnvironmentProjection handling TimeAdvanced, WeatherChanged.
  • Create InventoryProjection handling ItemPickedUp, ItemDropped.
  • Create ProgressionProjection handling SkillGained.
  • Create SystemProjection handling SystemMessage.
  • Register all projections in ProjectionRegistry.

Quality

  • Docs: Update YARD comments on affected classes and methods. Update relevant Docusaurus documentation pages if applicable.
  • Tests (Cucumber): Add tests/unit/core_projections.feature covering each of the 16 domain events producing correct RenderOps, multi-op events (RoomEntered, CombatTurn, SkillGained), edge cases with nil/missing data, all projections registered in registry.
  • Tests (Cucumber Integration): Add integration feature in tests/integration/ for 16 core projections transforming domain events into RenderOps end-to-end.
  • Tests (Profiling): Run bundle exec rake unit_profile and verify no performance regressions.
  • Quality: Verify coverage >=97% via bundle exec rake unit. If coverage is <97% then review the current unit test coverage report at build/tests/unit/coverage/ and use it to write new Cucumber based unit tests to improve coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun bundle exec rake unit to verify all tests pass and coverage is above >=97%. Only mark this as complete once coverage is >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%.
  • Quality: Run bundle exec rake (default task: unit tests with coverage) and bundle exec rake integration, fix any errors if needed ensuring both pass across entire code base, do not ignore any failure even if it seems unrelated to this commit, fix it.

Definition of Done

This issue is complete when:

  • All subtasks above are completed and checked off.
  • A Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation.
  • The commit is pushed to the remote on the branch matching the Branch in Metadata exactly.
  • The commit is submitted as a pull request to master, reviewed, and merged before this issue is marked done.
## Metadata | Key | Value | |-----|-------| | **Branch** | `feature/m2-core-projections` | | **Commit Message** | `feat: implement 16 core event projections for domain events` | | **Parent Epic** | #302 — Event Projection System | ## Background and Context With the EventProjection base class and RenderOp model in place, the system needs concrete projections for all major domain events. These 16 projections cover the core gameplay loop: movement, communication, combat, stats, environment, inventory, progression, and system messages. ## Expected Behavior Each projection maps a specific domain event to one or more RenderOps: | # | Domain Event | Target Window | RenderOp Type | Description | |---|-------------|---------------|---------------|-------------| | 1 | `RoomEntered` | `:main` + `:map` | `:text_append` + `:map_refresh` | Show room description and refresh map | | 2 | `EntityArrived` | `:main` | `:text_append` | "X arrives from the north." | | 3 | `EntityDeparted` | `:main` | `:text_append` | "X leaves to the south." | | 4 | `Speech` | `:main` | `:text_append` | "X says, 'Hello!'" | | 5 | `Whisper` | `:main` | `:text_append` | "X whispers to you, '...'" | | 6 | `StatChanged` | `:status` | `:bar_update` | Update stat bar | | 7 | `HealthChanged` | `:status` | `:bar_update` | Update HP bar | | 8 | `CombatStart` | `:main` | `:text_append` | Combat initiation message | | 9 | `CombatTurn` | `:main` + `:status` | `:text_append` + `:bar_update` | Turn results and HP update | | 10 | `CombatEnd` | `:main` | `:text_append` | Combat resolution message | | 11 | `TimeAdvanced` | `:status` | `:bar_update` | Update time display | | 12 | `WeatherChanged` | `:main` | `:text_append` | Weather description change | | 13 | `ItemPickedUp` | `:main` | `:text_append` | "You pick up X." | | 14 | `ItemDropped` | `:main` | `:text_append` | "You drop X." | | 15 | `SkillGained` | `:main` | `:text_append` + `:overlay_show` | Skill-up notification | | 16 | `SystemMessage` | `:main` | `:text_append` | System/server announcement | ## Acceptance Criteria - [ ] All 16 projections are implemented as `EventProjection` subclasses. - [ ] Each projection is registered in the `ProjectionRegistry`. - [ ] `RoomEntered` produces both `:text_append` and `:map_refresh` ops. - [ ] `CombatTurn` produces both `:text_append` and `:bar_update` ops. - [ ] `SkillGained` produces both `:text_append` and `:overlay_show` ops. - [ ] Text content is player-friendly and correctly formatted. - [ ] Projections handle edge cases (nil entity, missing data) gracefully. ## Subtasks ### Code - [ ] Create `RoomProjection` handling `RoomEntered`, `EntityArrived`, `EntityDeparted`. - [ ] Create `CommunicationProjection` handling `Speech`, `Whisper`. - [ ] Create `StatsProjection` handling `StatChanged`, `HealthChanged`. - [ ] Create `CombatProjection` handling `CombatStart`, `CombatTurn`, `CombatEnd`. - [ ] Create `EnvironmentProjection` handling `TimeAdvanced`, `WeatherChanged`. - [ ] Create `InventoryProjection` handling `ItemPickedUp`, `ItemDropped`. - [ ] Create `ProgressionProjection` handling `SkillGained`. - [ ] Create `SystemProjection` handling `SystemMessage`. - [ ] Register all projections in `ProjectionRegistry`. ### Quality - [ ] Docs: Update YARD comments on affected classes and methods. Update relevant Docusaurus documentation pages if applicable. - [ ] Tests (Cucumber): Add `tests/unit/core_projections.feature` covering each of the 16 domain events producing correct RenderOps, multi-op events (RoomEntered, CombatTurn, SkillGained), edge cases with nil/missing data, all projections registered in registry. - [ ] Tests (Cucumber Integration): Add integration feature in `tests/integration/` for 16 core projections transforming domain events into RenderOps end-to-end. - [ ] Tests (Profiling): Run `bundle exec rake unit_profile` and verify no performance regressions. - [ ] Quality: Verify coverage >=97% via `bundle exec rake unit`. If coverage is <97% then review the current unit test coverage report at `build/tests/unit/coverage/` and use it to write new Cucumber based unit tests to improve coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun `bundle exec rake unit` to verify all tests pass and coverage is above >=97%. Only mark this as complete once coverage is >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%. - [ ] Quality: Run `bundle exec rake` (default task: unit tests with coverage) and `bundle exec rake integration`, fix any errors if needed ensuring both pass across **entire** code base, do not ignore any failure even if it seems unrelated to this commit, fix it. ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata exactly. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged** before this issue is marked done.
freemo added this to the v1.1.0 milestone 2026-03-16 01:59:26 +00:00
freemo self-assigned this 2026-03-16 01:59:26 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference: aethyr/Aethyr#305
No description provided.