Address PR comments: fix Stats import, extract dialogue to UserInterface, improve tests

Co-authored-by: dmccoystephenson <21204351+dmccoystephenson@users.noreply.github.com>

Author: Copilot

src/location/bank.py

@@ -1,8 +1,8 @@
-from pstats import Stats
 from location.enum.locationType import LocationType
 from player.player import Player
 from prompt.prompt import Prompt
 from world.timeService import TimeService
+from stats.stats import Stats
 from ui.userInterface import UserInterface
 from npc.npc import NPC
 
@@ -113,9 +113,4 @@ def withdraw(self):
             break
 
     def talkToNPC(self):
-        self.userInterface.lotsOfSpace()
-        self.userInterface.divider()
-        print(self.npc.introduce())
-        self.userInterface.divider()
-        input(" [ CONTINUE ]")
-        self.currentPrompt.text = "What would you like to do?"
+        self.userInterface.showDialogue(self.npc.introduce())

src/location/docks.py

@@ -111,9 +111,4 @@ def fish(self):
             )
 
     def talkToNPC(self):
-        self.userInterface.lotsOfSpace()
-        self.userInterface.divider()
-        print(self.npc.introduce())
-        self.userInterface.divider()
-        input(" [ CONTINUE ]")
-        self.currentPrompt.text = "What would you like to do?"
+        self.userInterface.showDialogue(self.npc.introduce())

src/location/shop.py

@@ -74,9 +74,4 @@ def buyBetterBait(self):
             self.currentPrompt.text = "You bought some better bait!"
 
     def talkToNPC(self):
-        self.userInterface.lotsOfSpace()
-        self.userInterface.divider()
-        print(self.npc.introduce())
-        self.userInterface.divider()
-        input(" [ CONTINUE ]")
-        self.currentPrompt.text = "What would you like to do?"
+        self.userInterface.showDialogue(self.npc.introduce())

src/location/tavern.py

@@ -151,9 +151,4 @@ def changeBet(self, prompt):
             )
 
     def talkToNPC(self):
-        self.userInterface.lotsOfSpace()
-        self.userInterface.divider()
-        print(self.npc.introduce())
-        self.userInterface.divider()
-        input(" [ CONTINUE ]")
-        self.currentPrompt.text = "What would you like to do?"
+        self.userInterface.showDialogue(self.npc.introduce())

src/ui/userInterface.py

@@ -78,3 +78,11 @@ def showOptions(
                     return choice
 
             self.currentPrompt.text = "Try again!"
+
+    def showDialogue(self, text):
+        self.lotsOfSpace()
+        self.divider()
+        print(text)
+        self.divider()
+        input(" [ CONTINUE ]")
+        self.currentPrompt.text = "What would you like to do?"

tests/location/test_bank.py

@@ -120,10 +120,16 @@ def test_run_talk_to_npc_action():
 def test_talkToNPC():
     # prepare
     bankInstance = createBank()
+    bankInstance.userInterface.showDialogue = MagicMock()
+
+    # call
+    bankInstance.talkToNPC()
 
     # check
-    assert bankInstance.npc.name == "Margaret the Teller"
-    assert len(bankInstance.npc.backstory) > 0
+    bankInstance.userInterface.showDialogue.assert_called_once()
+    call_args = bankInstance.userInterface.showDialogue.call_args[0][0]
+    assert "Margaret the Teller" in call_args
+    assert len(call_args) > 0
 
 
 def test_deposit_success():

tests/location/test_docks.py

@@ -74,10 +74,16 @@ def test_run_talk_to_npc_action():
 def test_talkToNPC():
     # prepare
     docksInstance = createDocks()
+    docksInstance.userInterface.showDialogue = MagicMock()
+
+    # call
+    docksInstance.talkToNPC()
 
     # check
-    assert docksInstance.npc.name == "Sam the Dock Worker"
-    assert len(docksInstance.npc.backstory) > 0
+    docksInstance.userInterface.showDialogue.assert_called_once()
+    call_args = docksInstance.userInterface.showDialogue.call_args[0][0]
+    assert "Sam the Dock Worker" in call_args
+    assert len(call_args) > 0
 
 
 def test_run_go_to_shop_action():

tests/location/test_shop.py

@@ -88,14 +88,16 @@ def test_run_talk_to_npc_action():
 def test_talkToNPC():
     # prepare
     shopInstance = createShop()
-    shopInstance.userInterface.lotsOfSpace = MagicMock()
-    shopInstance.userInterface.divider = MagicMock()
+    shopInstance.userInterface.showDialogue = MagicMock()
 
     # call
-    # We can't fully test the input() part, but we can test the method exists
-    # and the NPC has the right data
-    assert shopInstance.npc.name == "Gilbert the Shopkeeper"
-    assert len(shopInstance.npc.backstory) > 0
+    shopInstance.talkToNPC()
+
+    # check
+    shopInstance.userInterface.showDialogue.assert_called_once()
+    call_args = shopInstance.userInterface.showDialogue.call_args[0][0]
+    assert "Gilbert the Shopkeeper" in call_args
+    assert len(call_args) > 0
 
 
 def test_sellFish():

tests/location/test_tavern.py

@@ -105,10 +105,16 @@ def test_run_talk_to_npc_action():
 def test_talkToNPC():
     # prepare
     tavernInstance = createTavern()
+    tavernInstance.userInterface.showDialogue = MagicMock()
+
+    # call
+    tavernInstance.talkToNPC()
 
     # check
-    assert tavernInstance.npc.name == "Old Tom the Barkeep"
-    assert len(tavernInstance.npc.backstory) > 0
+    tavernInstance.userInterface.showDialogue.assert_called_once()
+    call_args = tavernInstance.userInterface.showDialogue.call_args[0][0]
+    assert "Old Tom the Barkeep" in call_args
+    assert len(call_args) > 0
 
 
 def test_getDrunk():

tests/ui/test_userInterface.py

@@ -67,3 +67,22 @@ def test_showOptions():
     userInterfaceInstance.lotsOfSpace.assert_called()
     assert userInterfaceInstance.divider.call_count == 3
     userInterface.input.assert_called_with("\n> ")
+
+
+def test_showDialogue():
+    # setup
+    userInterfaceInstance = createUserInterface()
+    userInterface.print = MagicMock()
+    userInterface.input = MagicMock(return_value="")
+    userInterfaceInstance.lotsOfSpace = MagicMock()
+    userInterfaceInstance.divider = MagicMock()
+
+    # call
+    userInterfaceInstance.showDialogue("Test dialogue text")
+
+    # check
+    userInterfaceInstance.lotsOfSpace.assert_called_once()
+    assert userInterfaceInstance.divider.call_count == 2
+    userInterface.print.assert_called_with("Test dialogue text")
+    userInterface.input.assert_called_with(" [ CONTINUE ]")
+    assert userInterfaceInstance.currentPrompt.text == "What would you like to do?"