Merge pull request #13 from nuzcraft/part_10

Part 10

Author: nuzcraft

.gitignore

@@ -134,3 +134,6 @@ dmypy.json
 .vscode/
 
 RLTut_Python3.code-workspace
+
+# saved games
+*.sav

README.md

@@ -12,6 +12,24 @@ I want to use this as an opportunity to:
 4. make a roguelike
 5. practice with git
 
+## Part 10 Dev Notes
+
+### Saving and Loading
+
+https://rogueliketutorials.com/tutorials/tcod/v2/part-10/
+
+Holy crap, this is quite the refactor. I can see this having SIGNIFICANT impacts on the unit tests I've written. Beyond that, I'm looking forward to putting some polishing touches in! Things like a menu + saving and loading will make it feel more like a proper gain and less like a tech demo.
+
+Okay...as of right now, I've finished the event_handler refactor and I'm actually kind of afraid to run my unit test suite. Fingers crossed it's not as bad as I expect...
+
+Wow, way better than I expected! 228/248 unit tests passed! Only 20 failures means the changes didn't actually break too many things...though it's possible (and likely) that I'll need to update/add tests to cover the changed situations.
+
+And unit test updates are complete! It wasn't nearly as bad as I expected, though I'm a bit concerned there's a bit of built up technical debt for unit tests that continue to reference the event_handler of the engine.
+
+OH SHIT, the next part has us remove that reference...we'll see what the damage is...no damage! Whew! Onwards to some actual good and new development.
+
+Heyo, adding in the saving and loading was a bit fun! We also refactored and added a title screen which makes things look and feel way better. Towards the end of the chapter I skimped a bit on some unit tests around loading saves...hopefully that doesn't come back to bite me! It feels really good to have this section finished and I'm looking forward to the end of the tutorial! I already have some ideas for taking the finished product and giving it a new theme and features.
+
 ## Part 9 Dev Notes
 
 ### Ranged Scrolls and Targeting
@@ -20,7 +38,7 @@ https://rogueliketutorials.com/tutorials/tcod/v2/part-9/
 
 Woot! No additional refactoring yet! This section should be fun because it will give us the opportunity to use the code we just built to add more items that do unique things. Hopefully (outside of targeting) the additional things should be relatively minor and relatively atomic.
 
-This part was really insightful to develop as I believe it will pave the way for a significant amount of future development. We developed some unique spells that function in very different ways; one that automatically targets the nearest actor and 2 the require additional user input mid-cast. This additional input is implemented in an interesting way and by watching it get out in place I think I understand the code flow. 
+This part was really insightful to develop as I believe it will pave the way for a significant amount of future development. We developed some unique spells that function in very different ways; one that automatically targets the nearest actor and 2 the require additional user input mid-cast. This additional input is implemented in an interesting way and by watching it get out in place I think I understand the code flow.
 
 From a unit testing standpoint, this part was intense. Adding new handlers for user input meant a significant amount of unit testing. I'm also noticing that there is a lot id dependencies around the player, engine, and game map objects that makes it cumbersome to set up tests on other objects. All in, unit testing is becoming more comfortable and I'm looking forward to a time when I feel like I can push what I know to make it more organized and more performant.
 

Tests/test_consumable.py

@@ -104,10 +104,8 @@ def test_get_action(self):
         cm.parent = item
         with patch('message_log.MessageLog.add_message') as patch_add_message:
             action = cm.get_action(consumer=actor)
-        self.assertIsNone(action)
         patch_add_message.assert_called_once()
-        self.assertIsInstance(cm.engine.event_handler,
-                              SingleRangedAttackHandler)
+        self.assertIsInstance(action, SingleRangedAttackHandler)
 
     def test_activate_good_target(self):
         '''
@@ -136,10 +134,10 @@ def test_activate_good_target(self):
         item.parent = actor.inventory
         cm.parent = item
         # get_action will initiate user input phase
-        cm.get_action(consumer=actor)
+        handler = cm.get_action(consumer=actor)
         # calling the callback with the target tile will return
         # the action we need
-        action = cm.engine.event_handler.callback((1, 1))
+        action = handler.callback((1, 1))
 
         with patch('message_log.MessageLog.add_message') as patch_add_message:
             with patch('components.consumable.Consumable.consume') as patch_consume:
@@ -175,10 +173,10 @@ def test_activate_not_visible(self):
         item.parent = actor.inventory
         cm.parent = item
         # get_action will initiate user input phase
-        cm.get_action(consumer=actor)
+        handler = cm.get_action(consumer=actor)
         # calling the callback with the target tile will return
         # the action we need
-        action = cm.engine.event_handler.callback((1, 1))
+        action = handler.callback((1, 1))
 
         with self.assertRaises(Impossible):
             cm.activate(action=action)
@@ -209,10 +207,10 @@ def test_activate_no_target(self):
         item.parent = actor.inventory
         cm.parent = item
         # get_action will initiate user input phase
-        cm.get_action(consumer=actor)
+        handler = cm.get_action(consumer=actor)
         # calling the callback with the target tile will return
         # the action we need NOTE target does not match ent location
-        action = cm.engine.event_handler.callback((2, 2))
+        action = handler.callback((2, 2))
 
         with self.assertRaises(Impossible):
             cm.activate(action=action)
@@ -236,10 +234,10 @@ def test_activate_self(self):
         item.parent = actor.inventory
         cm.parent = item
         # get_action will initiate user input phase
-        cm.get_action(consumer=actor)
+        handler = cm.get_action(consumer=actor)
         # calling the callback with the target tile will return
         # the action we need NOTE target does not match ent location
-        action = cm.engine.event_handler.callback((0, 0))
+        action = handler.callback((0, 0))
 
         with self.assertRaises(Impossible):
             cm.activate(action=action)
@@ -298,6 +296,7 @@ def test_activate_without_recovery(self):
         with self.assertRaises(Impossible):
             consumable.activate(action=action)
 
+
 class TestFireballDamageConsumable(unittest.TestCase):
     def test_init(self):
         '''
@@ -326,10 +325,8 @@ def test_get_action(self):
         cm.parent = item
         with patch('message_log.MessageLog.add_message') as patch_add_message:
             action = cm.get_action(consumer=actor)
-        self.assertIsNone(action)
         patch_add_message.assert_called_once()
-        self.assertIsInstance(cm.engine.event_handler,
-                              AreaRangedAttackHandler)
+        self.assertIsInstance(action, AreaRangedAttackHandler)
 
     def test_activate_hit_actor(self):
         '''
@@ -358,10 +355,10 @@ def test_activate_hit_actor(self):
         item.parent = actor.inventory
         cm.parent = item
         # get_action will initiate user input phase
-        cm.get_action(consumer=actor)
+        handler = cm.get_action(consumer=actor)
         # calling the callback with the target tile will return
         # the action we need
-        action = cm.engine.event_handler.callback((6, 6))
+        action = handler.callback((6, 6))
 
         with patch('message_log.MessageLog.add_message') as patch_add_message:
             with patch('components.consumable.Consumable.consume') as patch_consume:
@@ -405,10 +402,10 @@ def test_activate_hit_actors(self):
         item.parent = actor.inventory
         cm.parent = item
         # get_action will initiate user input phase
-        cm.get_action(consumer=actor)
+        handler = cm.get_action(consumer=actor)
         # calling the callback with the target tile will return
         # the action we need
-        action = cm.engine.event_handler.callback((6, 6))
+        action = handler.callback((6, 6))
 
         with patch('message_log.MessageLog.add_message') as patch_add_message:
             with patch('components.consumable.Consumable.consume') as patch_consume:
@@ -453,10 +450,10 @@ def test_activate_not_visible(self):
         item.parent = actor.inventory
         cm.parent = item
         # get_action will initiate user input phase
-        cm.get_action(consumer=actor)
+        handler = cm.get_action(consumer=actor)
         # calling the callback with the target tile will return
         # the action we need
-        action = cm.engine.event_handler.callback((6, 6))
+        action = handler.callback((6, 6))
 
         with self.assertRaises(Impossible):
             cm.activate(action=action)
@@ -481,14 +478,15 @@ def test_activate_no_targets(self):
         item.parent = actor.inventory
         cm.parent = item
         # get_action will initiate user input phase
-        cm.get_action(consumer=actor)
+        handler = cm.get_action(consumer=actor)
         # calling the callback with the target tile will return
         # the action we need
-        action = cm.engine.event_handler.callback((6, 6))
+        action = handler.callback((6, 6))
 
         with self.assertRaises(Impossible):
             cm.activate(action=action)
 
+
 class TestLightningDamageConsumable(unittest.TestCase):
     def test_init(self):
         '''

Tests/test_fighter.py

@@ -29,7 +29,8 @@ def test_entity_set(self):
         test that an entity can be set without issues
         '''
         ft = Fighter(hp=10, defense=10, power=10)
-        act = Actor(ai_cls=HostileEnemy, fighter=ft, inventory=Inventory(capacity=5))
+        act = Actor(ai_cls=HostileEnemy, fighter=ft,
+                    inventory=Inventory(capacity=5))
         ft.entity = act
         self.assertEqual(act, ft.entity)
 
@@ -55,7 +56,8 @@ def test_setter_hp_too_low(self):
         when setting below 0
         '''
         ft = Fighter(hp=10, defense=10, power=10)
-        act = Actor(ai_cls=HostileEnemy, fighter=ft, inventory=Inventory(capacity=5))
+        act = Actor(ai_cls=HostileEnemy, fighter=ft,
+                    inventory=Inventory(capacity=5))
         ft.entity = act
 
         eng = Engine(player=act)
@@ -81,7 +83,8 @@ def test_setter_die(self):
         '''
         ft = Fighter(hp=10, defense=10, power=10)
         # this will set the ai to HostileEnemy
-        act = Actor(ai_cls=HostileEnemy, fighter=ft, inventory=Inventory(capacity=5))
+        act = Actor(ai_cls=HostileEnemy, fighter=ft,
+                    inventory=Inventory(capacity=5))
         ft.parent = act
 
         eng = Engine(player=act)
@@ -101,7 +104,8 @@ def test_die_player(self, mock_add_message):
         '''
         ft = Fighter(hp=10, defense=10, power=10)
         # this will set the ai to HostileEnemy
-        act = Actor(name="player", ai_cls=HostileEnemy, fighter=ft, inventory=Inventory(capacity=5))
+        act = Actor(name="player", ai_cls=HostileEnemy,
+                    fighter=ft, inventory=Inventory(capacity=5))
         ft.parent = act
 
         eng = Engine(player=act)
@@ -117,7 +121,6 @@ def test_die_player(self, mock_add_message):
         self.assertIsNone(ft.parent.ai)
         self.assertEqual(ft.parent.name, "remains of player")
         self.assertEqual(ft.parent.render_order, RenderOrder.CORPSE)
-        self.assertIsInstance(ft.engine.event_handler, GameOverEventHandler)
         mock_add_message.assert_called_with("You died!", color.player_die)
 
     @patch('message_log.MessageLog.add_message')
@@ -126,11 +129,13 @@ def test_die_other_actor(self, mock_add_message):
         test that when an actor (not player) dies, they get set well
         '''
         ft = Fighter(hp=10, defense=10, power=10)
-        act = Actor(name="actor", ai_cls=HostileEnemy, fighter=ft, inventory=Inventory(capacity=5))
+        act = Actor(name="actor", ai_cls=HostileEnemy,
+                    fighter=ft, inventory=Inventory(capacity=5))
         ft.parent = act
 
         ft2 = Fighter(hp=10, defense=10, power=10)
-        act2 = Actor(name="player", ai_cls=HostileEnemy, fighter=ft2, inventory=Inventory(capacity=5))
+        act2 = Actor(name="player", ai_cls=HostileEnemy,
+                     fighter=ft2, inventory=Inventory(capacity=5))
         ft2.parent = act2
 
         eng = Engine(player=act2)