Enforce mapping type when creating exits #3

Open
opened 2018-09-22 17:54:44 +00:00 by freemo · 0 comments
freemo commented 2018-09-22 17:54:44 +00:00 (Migrated from git.qoto.org)

Metadata

  • Commit Message: fix(area): enforce mapping type constraints when creating exits
  • Branch: feature/m3-enforce-mapping-exit-create

Background and Context

When creating exits via acexit, the command does not check whether the new exit is compatible with the area's mapping type. For areas using :world mapping, exits must be between adjacent rooms in the grid. For :rooms mapping, exits define the layout. Creating inconsistent exits can corrupt the map display.

Expected Behavior

When creating an exit, validate that the exit direction and target room are compatible with the source area's mapping type. For :world mapping, only allow exits between grid-adjacent rooms.

Acceptance Criteria

  • acexit validates exit compatibility with area mapping type before creation
  • Incompatible exits produce a clear error message
  • Valid exits are created normally
  • Existing exits are not affected

Subtasks

  • Code: Add mapping type validation to HandleAcexit — check if the exit direction is compatible with source area's mapping type
  • Code: For :world mapping, verify the target room is grid-adjacent in the specified direction
  • Code: Add clear error message when exit creation is rejected due to mapping incompatibility
  • Docs: Update YARD comments on HandleAcexit and update acexit.help to note mapping constraints
  • Tests (Cucumber): Add tests/unit/acexit_mapping.feature covering: valid exit creation for each mapping type, rejected exit for world mapping non-adjacent rooms
  • Tests (Cucumber Integration): Add integration feature verifying exit creation respects mapping constraints.
  • 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 code 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 - **Commit Message**: `fix(area): enforce mapping type constraints when creating exits` - **Branch**: `feature/m3-enforce-mapping-exit-create` ## Background and Context When creating exits via `acexit`, the command does not check whether the new exit is compatible with the area's mapping type. For areas using `:world` mapping, exits must be between adjacent rooms in the grid. For `:rooms` mapping, exits define the layout. Creating inconsistent exits can corrupt the map display. ## Expected Behavior When creating an exit, validate that the exit direction and target room are compatible with the source area's mapping type. For `:world` mapping, only allow exits between grid-adjacent rooms. ## Acceptance Criteria - [ ] `acexit` validates exit compatibility with area mapping type before creation - [ ] Incompatible exits produce a clear error message - [ ] Valid exits are created normally - [ ] Existing exits are not affected ## Subtasks - [ ] Code: Add mapping type validation to `HandleAcexit` — check if the exit direction is compatible with source area's mapping type - [ ] Code: For `:world` mapping, verify the target room is grid-adjacent in the specified direction - [ ] Code: Add clear error message when exit creation is rejected due to mapping incompatibility - [ ] Docs: Update YARD comments on `HandleAcexit` and update `acexit.help` to note mapping constraints - [ ] Tests (Cucumber): Add `tests/unit/acexit_mapping.feature` covering: valid exit creation for each mapping type, rejected exit for world mapping non-adjacent rooms - [ ] Tests (Cucumber Integration): Add integration feature verifying exit creation respects mapping constraints. - [ ] 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 code 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 self-assigned this 2026-03-15 04:25:21 +00:00
freemo added this to the v1.1.0 milestone 2026-03-15 04:25:44 +00:00
freemo modified the milestone from v1.1.0 to v1.2.0 2026-03-16 00:28:06 +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#3
No description provided.