From aa720edae5baa1e23461a7b66321e479cffa3024 Mon Sep 17 00:00:00 2001 From: Jared Miller Date: Wed, 11 Feb 2026 20:47:56 -0500 Subject: [PATCH] Add enter command for portal zone transitions Implements portal-based zone transitions with the enter command. Players can enter portals at their position to move to target zones with specified coordinates. Includes departure/arrival messaging to nearby players and automatic look output in the destination zone. Portals are matched by partial name or exact alias match. --- src/mudlib/commands/portals.py | 76 +++++++++ tests/test_enter_portal.py | 284 +++++++++++++++++++++++++++++++++ tests/test_two_way_portals.py | 117 ++++++++++++++ 3 files changed, 477 insertions(+) create mode 100644 src/mudlib/commands/portals.py create mode 100644 tests/test_enter_portal.py create mode 100644 tests/test_two_way_portals.py diff --git a/src/mudlib/commands/portals.py b/src/mudlib/commands/portals.py new file mode 100644 index 0000000..30c6ff4 --- /dev/null +++ b/src/mudlib/commands/portals.py @@ -0,0 +1,76 @@ +"""Portal commands for zone transitions.""" + +from mudlib.commands import CommandDefinition, register +from mudlib.commands.movement import send_nearby_message +from mudlib.player import Player +from mudlib.portal import Portal +from mudlib.zone import Zone +from mudlib.zones import get_zone + + +async def cmd_enter(player: Player, args: str) -> None: + """Enter a portal to transition to another zone. + + Args: + player: The player executing the command + args: Portal name or alias to enter + """ + if not args.strip(): + await player.send("Enter what?\r\n") + return + + zone = player.location + if not isinstance(zone, Zone): + await player.send("You are nowhere.\r\n") + return + + # Find portal at player's position + portals_here = [ + obj for obj in zone.contents_at(player.x, player.y) if isinstance(obj, Portal) + ] + + # Match by name or alias (exact match only) + target_name = args.strip().lower() + portal = None + for p in portals_here: + if p.name.lower() == target_name: + portal = p + break + if target_name in (a.lower() for a in p.aliases): + portal = p + break + + if not portal: + await player.send("You don't see that here.\r\n") + return + + # Look up target zone + target_zone = get_zone(portal.target_zone) + if not target_zone: + await player.send("The portal doesn't lead anywhere.\r\n") + return + + # Send departure message to nearby players in old zone + await send_nearby_message( + player, player.x, player.y, f"{player.name} enters {portal.name}.\r\n" + ) + + # Move player to target zone + player.move_to(target_zone, x=portal.target_x, y=portal.target_y) + + # Send arrival message to nearby players in new zone + await send_nearby_message( + player, + player.x, + player.y, + f"{player.name} arrives from {portal.name}.\r\n", + ) + + # Show new zone to player + from mudlib.commands.look import cmd_look + + await cmd_look(player, "") + + +# Register the enter command +register(CommandDefinition("enter", cmd_enter)) diff --git a/tests/test_enter_portal.py b/tests/test_enter_portal.py new file mode 100644 index 0000000..af0c0bf --- /dev/null +++ b/tests/test_enter_portal.py @@ -0,0 +1,284 @@ +"""Tests for portal enter command.""" + +from unittest.mock import AsyncMock, MagicMock + +import pytest + +from mudlib.commands import _registry +from mudlib.player import Player +from mudlib.portal import Portal +from mudlib.zone import Zone +from mudlib.zones import register_zone, zone_registry + + +@pytest.fixture +def mock_writer(): + writer = MagicMock() + writer.write = MagicMock() + writer.drain = AsyncMock() + return writer + + +@pytest.fixture +def mock_reader(): + return MagicMock() + + +@pytest.fixture +def test_zone(): + terrain = [["." for _ in range(10)] for _ in range(10)] + return Zone( + name="testzone", + width=10, + height=10, + toroidal=True, + terrain=terrain, + ) + + +@pytest.fixture +def target_zone(): + terrain = [["." for _ in range(10)] for _ in range(10)] + return Zone( + name="targetzone", + width=10, + height=10, + toroidal=True, + terrain=terrain, + ) + + +@pytest.fixture +def player(mock_reader, mock_writer, test_zone): + p = Player( + name="TestPlayer", + x=5, + y=5, + reader=mock_reader, + writer=mock_writer, + location=test_zone, + ) + return p + + +@pytest.fixture(autouse=True) +def clear_zones(): + """Clear zone registry before and after each test.""" + zone_registry.clear() + yield + zone_registry.clear() + + +# --- cmd_enter --- + + +@pytest.mark.asyncio +async def test_enter_moves_to_target_zone(player, test_zone, target_zone): + """enter portal moves player to target zone.""" + from mudlib.commands.portals import cmd_enter + + register_zone("targetzone", target_zone) + Portal( + name="shimmering doorway", + aliases=["doorway"], + location=test_zone, + x=5, + y=5, + target_zone="targetzone", + target_x=3, + target_y=7, + ) + + await cmd_enter(player, "doorway") + assert player.location is target_zone + assert player.x == 3 + assert player.y == 7 + assert player in target_zone.contents + assert player not in test_zone.contents + + +@pytest.mark.asyncio +async def test_enter_sends_departure_message( + player, test_zone, target_zone, mock_writer +): + """enter portal sends departure message to old zone.""" + from mudlib.commands.portals import cmd_enter + + register_zone("targetzone", target_zone) + Portal( + name="portal", + location=test_zone, + x=5, + y=5, + target_zone="targetzone", + target_x=3, + target_y=7, + ) + other_player = Player( + name="OtherPlayer", + x=5, + y=5, + reader=MagicMock(), + writer=MagicMock(write=MagicMock(), drain=AsyncMock()), + location=test_zone, + ) + + await cmd_enter(player, "portal") + + # Check that other player received departure message + other_writer = other_player.writer + calls = [call[0][0] for call in other_writer.write.call_args_list] + assert any("TestPlayer" in call and "enter" in call.lower() for call in calls) + + +@pytest.mark.asyncio +async def test_enter_sends_arrival_message(player, test_zone, target_zone): + """enter portal sends arrival message to new zone.""" + from mudlib.commands.portals import cmd_enter + + register_zone("targetzone", target_zone) + Portal( + name="portal", + location=test_zone, + x=5, + y=5, + target_zone="targetzone", + target_x=3, + target_y=7, + ) + other_player = Player( + name="OtherPlayer", + x=3, + y=7, + reader=MagicMock(), + writer=MagicMock(write=MagicMock(), drain=AsyncMock()), + location=target_zone, + ) + + await cmd_enter(player, "portal") + + # Check that other player in target zone received arrival message + other_writer = other_player.writer + calls = [call[0][0] for call in other_writer.write.call_args_list] + assert any("TestPlayer" in call and "arrive" in call.lower() for call in calls) + + +@pytest.mark.asyncio +async def test_enter_shows_look_in_new_zone( + player, test_zone, target_zone, mock_writer +): + """enter portal triggers look command in new zone.""" + from mudlib.commands.portals import cmd_enter + + register_zone("targetzone", target_zone) + Portal( + name="portal", + location=test_zone, + x=5, + y=5, + target_zone="targetzone", + target_x=3, + target_y=7, + ) + + await cmd_enter(player, "portal") + + # Check that look output was sent (viewport grid should be in output) + output = "".join([call[0][0] for call in mock_writer.write.call_args_list]) + # Should have the @ symbol for player position + assert "@" in output + + +@pytest.mark.asyncio +async def test_enter_no_args(player, mock_writer): + """enter with no arguments gives usage hint.""" + from mudlib.commands.portals import cmd_enter + + await cmd_enter(player, "") + output = mock_writer.write.call_args_list[-1][0][0] + assert "enter what" in output.lower() or "usage" in output.lower() + + +@pytest.mark.asyncio +async def test_enter_portal_not_found(player, test_zone, mock_writer): + """enter with portal not at position gives feedback.""" + from mudlib.commands.portals import cmd_enter + + await cmd_enter(player, "doorway") + output = mock_writer.write.call_args_list[-1][0][0] + assert "don't see" in output.lower() + + +@pytest.mark.asyncio +async def test_enter_target_zone_not_found(player, test_zone, mock_writer): + """enter with invalid target zone gives graceful error.""" + from mudlib.commands.portals import cmd_enter + + Portal( + name="portal", + location=test_zone, + x=5, + y=5, + target_zone="nonexistent", + target_x=3, + target_y=7, + ) + + await cmd_enter(player, "portal") + output = mock_writer.write.call_args_list[-1][0][0] + assert "doesn't lead anywhere" in output.lower() or "nowhere" in output.lower() + # Player should still be in original zone + assert player.location is test_zone + + +@pytest.mark.asyncio +async def test_enter_matches_aliases(player, test_zone, target_zone): + """enter matches portal aliases.""" + from mudlib.commands.portals import cmd_enter + + register_zone("targetzone", target_zone) + Portal( + name="shimmering doorway", + aliases=["door", "doorway"], + location=test_zone, + x=5, + y=5, + target_zone="targetzone", + target_x=3, + target_y=7, + ) + + await cmd_enter(player, "door") + assert player.location is target_zone + + +@pytest.mark.asyncio +async def test_enter_portal_elsewhere_in_zone(player, test_zone, mock_writer): + """enter doesn't find portals not at player position.""" + from mudlib.commands.portals import cmd_enter + + Portal( + name="distant portal", + location=test_zone, + x=8, + y=8, + target_zone="targetzone", + target_x=3, + target_y=7, + ) + + await cmd_enter(player, "portal") + output = mock_writer.write.call_args_list[-1][0][0] + assert "don't see" in output.lower() + # Player should still be in original zone + assert player.location is test_zone + + +# --- command registration --- + + +def test_enter_command_registered(): + """enter command is registered.""" + import mudlib.commands.portals # noqa: F401 + + assert "enter" in _registry diff --git a/tests/test_two_way_portals.py b/tests/test_two_way_portals.py new file mode 100644 index 0000000..2e043ae --- /dev/null +++ b/tests/test_two_way_portals.py @@ -0,0 +1,117 @@ +"""Tests for two-way portal transitions.""" + +from unittest.mock import AsyncMock, MagicMock + +import pytest + +from mudlib.player import Player +from mudlib.portal import Portal +from mudlib.zone import Zone +from mudlib.zones import register_zone, zone_registry + + +@pytest.fixture +def mock_writer(): + writer = MagicMock() + writer.write = MagicMock() + writer.drain = AsyncMock() + return writer + + +@pytest.fixture +def mock_reader(): + return MagicMock() + + +@pytest.fixture +def zone_a(): + terrain = [["." for _ in range(10)] for _ in range(10)] + return Zone( + name="zone_a", + width=10, + height=10, + toroidal=True, + terrain=terrain, + ) + + +@pytest.fixture +def zone_b(): + terrain = [["." for _ in range(10)] for _ in range(10)] + return Zone( + name="zone_b", + width=10, + height=10, + toroidal=True, + terrain=terrain, + ) + + +@pytest.fixture +def player(mock_reader, mock_writer, zone_a): + p = Player( + name="TestPlayer", + x=2, + y=2, + reader=mock_reader, + writer=mock_writer, + location=zone_a, + ) + return p + + +@pytest.fixture(autouse=True) +def clear_zones(): + """Clear zone registry before and after each test.""" + zone_registry.clear() + yield + zone_registry.clear() + + +@pytest.mark.asyncio +async def test_two_way_portal_transitions(player, zone_a, zone_b): + """Portals work bidirectionally between zones.""" + from mudlib.commands.portals import cmd_enter + + # Register zones + register_zone("zone_a", zone_a) + register_zone("zone_b", zone_b) + + # Create portal in zone A pointing to zone B + Portal( + name="doorway to B", + location=zone_a, + x=2, + y=2, + target_zone="zone_b", + target_x=7, + target_y=7, + ) + + # Create portal in zone B pointing to zone A + Portal( + name="doorway to A", + location=zone_b, + x=7, + y=7, + target_zone="zone_a", + target_x=2, + target_y=2, + ) + + # Player starts in zone A at (2, 2) + assert player.location is zone_a + assert player.x == 2 + assert player.y == 2 + + # Enter portal to zone B + await cmd_enter(player, "doorway to B") + assert player.location is zone_b + assert player.x == 7 + assert player.y == 7 + + # Enter portal back to zone A + await cmd_enter(player, "doorway to A") + assert player.location is zone_a + assert player.x == 2 + assert player.y == 2