Merge branch 'Emma-Deliverable1-Changes' into CheatsIndexOutOfBoundsFix

hhaslam11 · Nov 14, 2021 · 4c05c71 · 4c05c71
2 parents cbc3c64 + 65b0e78
commit 4c05c71
Show file tree

Hide file tree

Showing 41 changed files with 1,363 additions and 186 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,26 +1,120 @@
-# Changes in this branch
-
-## This branch addresses the following issue:
-### Critical Hits, ([issue #130](https://github.com/hhaslam11/Text-Fighter/issues/130) in the source hhaslam11/Text-Fighter repository, [issue #9](https://github.com/emmamickas/Text-Fighter/issues/9) in the forked emmamickas/Text-Fighter repository)
-
-## Desired modifications:
-### In the current implementation, selecting the weaponstash cheat involves accessing an array of weapons in which the final index being referenced is the size of the array, which is out of the bounds of the array. The changes involve updating the condition of the loop that accesses the array to prevent the violation of the index.
-
-## Modified files:
-### As viewable in the [Dependency References folder](https://github.com/emmamickas/Text-Fighter/tree/CheatsIndexOutOfBoundsFix/Dependency%20References), the following files were modified in the change:
- * [Cheats.java](https://github.com/emmamickas/Text-Fighter/blob/CheatsIndexOutOfBoundsFix/src/com/hotmail/kalebmarc/textfighter/main/Cheats.java)
-
-## Testing:
-###  The following tests were performed to ensure that behavior was preserved after refactoring/changes:
- * [Cheats](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/CheatsTest.java)
- #### See [here](https://github.com/emmamickas/Text-Fighter/blob/CheatsIndexOutOfBoundsFix/TESTING.md) for more information on testing.
-
- ## Resolution:
- ### Pending
- A [pull request](https://github.com/hhaslam11/Text-Fighter/pull/131) has been made to merge the change onto the master branch of the source repo.
-
- ## Additional resources:
- ### Please view the following to find additional documentation of the changes and the code involved in the changes.
-  * [Class Diagrams](https://github.com/emmamickas/Text-Fighter/tree/CheatsIndexOutOfBoundsFix/Class%20Diagram) of modified classes.
-  * [Dependencies](https://github.com/emmamickas/Text-Fighter/tree/CheatsIndexOutOfBoundsFix/Dependency%20References) of modified or dependent classes.
-  * [Sequence Diagrams](https://github.com/emmamickas/Text-Fighter/tree/CheatsIndexOutOfBoundsFix/Sequence%20Diagrams) of modified or dependent methods.
+# Changes in this branch (to be used in maintainability measurement work).
+
+
+## Changes in the ShowSpecificPotionStats branch
+
+### This branch addresses the following issue:
+#### Show Specific Potion Stats, ([issue #58](https://github.com/hhaslam11/Text-Fighter/issues/58) in the source hhaslam11/Text-Fighter repository, [issue #7](https://github.com/emmamickas/Text-Fighter/issues/7) in the forked emmamickas/Text-Fighter repository)
+
+### Desired modifications:
+#### In the current functionality, when a player views their stats, they are only able to view a total number of potions used, but not individual totals for different types of potions that they have used. The changes include separating the totals for individual potion types to display each total, while also keeping a total of all potions used by the player.
+
+### Modified files:
+#### As viewable in the [Dependency References folder](https://github.com/emmamickas/Text-Fighter/tree/ShowSpecificPotionStats/Dependency%20References), the following files were modified in the change:
+ * [Potion.java](https://github.com/emmamickas/Text-Fighter/blob/ShowSpecificPotionStats/src/com/hotmail/kalebmarc/textfighter/player/Potion.java)
+ * [Stats.java](https://github.com/emmamickas/Text-Fighter/blob/ShowSpecificPotionStats/src/com/hotmail/kalebmarc/textfighter/player/Stats.java)
+
+### Testing:
+####  The following tests were performed to ensure that behavior was preserved after refactoring/changes:
+ * [Potion](https://github.com/emmamickas/Text-Fighter/blob/ShowSpecificPotionStats/src/com/hotmail/kalebmarc/textfighter/player/PotionTest.java)
+ ##### See [here](https://github.com/emmamickas/Text-Fighter/blob/ShowSpecificPotionStats/TESTING.md) for more information on testing.
+
+ ### Resolution:
+ #### The branch was merged with master, closing issue #58:
+ [Pull request #125](https://github.com/hhaslam11/Text-Fighter/commit/659955becfa0eb803f4b214821f18dbef9419da8)
+
+ ### Additional resources:
+ #### Please view the following to find additional documentation of the changes and the code involved in the changes.
+  * [Class Diagrams](https://github.com/emmamickas/Text-Fighter/tree/ShowSpecificPotionStats/Class%20Diagram) of modified classes.
+  * [Dependencies](https://github.com/emmamickas/Text-Fighter/tree/ShowSpecificPotionStats/Dependency%20References) of modified or dependent classes.
+  * [Sequence Diagrams](https://github.com/emmamickas/Text-Fighter/tree/ShowSpecificPotionStats/Sequence%20Diagrams) of modified or dependent methods.
+
+## Changes in the AddConstantArrayListAccessModifiers branch
+
+### This branch addresses the following issue:
+#### Show Specific Potion Stats, ([issue #46](https://github.com/hhaslam11/Text-Fighter/issues/46) in the source hhaslam11/Text-Fighter repository, [issue #4](https://github.com/emmamickas/Text-Fighter/issues/4) in the forked emmamickas/Text-Fighter repository)
+
+### Desired modifications:
+#### In the current implementation, when accessing an array from a static class including Weapon, Enemy, and Food, the array is accessed directly. The changes include implementing an access modifier to these arrays.
+
+### Modified files:
+#### As viewable in the [Dependency References folder](https://github.com/emmamickas/Text-Fighter/tree/AddConstantArraylistAccessModifiers/Dependency%20References), the following files were modified in the change:
+ * [Armour.java](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/item/Armour.java)
+ * [Weapon.java](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/Weapon.java)
+ * [Enemy.java](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/Enemy.java)
+ * [Food.java](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/Food.java)
+
+### Testing:
+####  The following tests were performed to ensure that behavior was preserved after refactoring/changes:
+ * [Armour](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/item/ArmourTest.java)
+ * [Weapon](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/WeaponTest.java)
+ * [Enemy](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/EnemyTest.java)
+ * [Food](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/FoodTest.java)
+ * [Cheats](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/CheatsTest.java)
+ * [Debug](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/DebugTest.java)
+ ##### See [here](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/TESTING.md) for more information on testing.
+
+ ### Resolution:
+ #### The branch was merged with master:
+ [Pull request #127](https://github.com/hhaslam11/Text-Fighter/commit/555f73191bb4e5476f82c6f481dd3b8190866159)
+
+ ### Additional resources:
+ #### Please view the following to find additional documentation of the changes and the code involved in the changes.
+  * [Class Diagrams](https://github.com/emmamickas/Text-Fighter/tree/AddConstantArraylistAccessModifiers/Class%20Diagram) of modified classes.
+  * [Dependencies](https://github.com/emmamickas/Text-Fighter/tree/AddConstantArraylistAccessModifiers/Dependency%20References) of modified or dependent classes.
+  * [Sequence Diagrams](https://github.com/emmamickas/Text-Fighter/tree/AddConstantArraylistAccessModifiers/Sequence%20Diagrams) of modified or dependent methods.
+
+## Changes in the CriticalHits branch
+
+### This branch addresses the following issue:
+#### Critical Hits, ([issue #25](https://github.com/hhaslam11/Text-Fighter/issues/25) in the source hhaslam11/Text-Fighter repository, [issue #1](https://github.com/emmamickas/Text-Fighter/issues/1) in the forked emmamickas/Text-Fighter repository)
+
+### Desired modifications:
+#### In the current functionality, the damage that a weapon can do can be increased by a critical multiplier based upon the weapon's type. The changes include adding another critical modifier that increases the damage done by weapons with bullets only. This modifier has a 0.01% chance to activate and increases damage by a factor of 10.
+
+### Modified files:
+#### As viewable in the [Dependency References folder](https://github.com/emmamickas/Text-Fighter/tree/CriticalHits/Dependency%20References), the following files were modified in the change:
+ * [Weapon.java](https://github.com/emmamickas/Text-Fighter/blob/CriticalHits/src/com/hotmail/kalebmarc/textfighter/main/Weapon.java)
+
+### Testing:
+####  The following tests were performed to ensure that behavior was preserved after refactoring/changes:
+ * [Weapon](https://github.com/emmamickas/Text-Fighter/tree/CriticalHits/src/com/hotmail/kalebmarc/textfighter/main)
+ * [Enemy](https://github.com/emmamickas/Text-Fighter/tree/CriticalHits/src/com/hotmail/kalebmarc/textfighter/main)
+ ##### See [here](https://github.com/emmamickas/Text-Fighter/blob/CriticalHits/TESTING.md) for more information on testing.
+
+ ### Resolution:
+ #### Pending
+ A [pull request](https://github.com/hhaslam11/Text-Fighter/pull/129) has been made to merge the change onto the master branch of the source repo.
+
+ ### Additional resources:
+ #### Please view the following to find additional documentation of the changes and the code involved in the changes.
+  * [Class Diagrams](https://github.com/emmamickas/Text-Fighter/tree/CriticalHits/Class%20Diagram) of modified classes.
+  * [Dependencies](https://github.com/emmamickas/Text-Fighter/tree/CriticalHits/Dependency%20References) of modified or dependent classes.
+  * [Sequence Diagrams](https://github.com/emmamickas/Text-Fighter/tree/CriticalHits/Sequence%20Diagrams) of modified or dependent methods.
+
+## Changes in the CheatsIndexOutOfBoundsFix
+
+### This branch addresses the following issue:
+#### Critical Hits, ([issue #130](https://github.com/hhaslam11/Text-Fighter/issues/130) in the source hhaslam11/Text-Fighter repository, [issue #9](https://github.com/emmamickas/Text-Fighter/issues/9) in the forked emmamickas/Text-Fighter repository)
+
+### Desired modifications:
+#### In the current implementation, selecting the weaponstash cheat involves accessing an array of weapons in which the final index being referenced is the size of the array, which is out of the bounds of the array. The changes involve updating the condition of the loop that accesses the array to prevent the violation of the index.
+
+### Modified files:
+#### As viewable in the [Dependency References folder](https://github.com/emmamickas/Text-Fighter/tree/CheatsIndexOutOfBoundsFix/Dependency%20References), the following files were modified in the change:
+ * [Cheats.java](https://github.com/emmamickas/Text-Fighter/blob/CheatsIndexOutOfBoundsFix/src/com/hotmail/kalebmarc/textfighter/main/Cheats.java)
+
+### Testing:
+####  The following tests were performed to ensure that behavior was preserved after refactoring/changes:
+ * [Cheats](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/CheatsTest.java)
+ ##### See [here](https://github.com/emmamickas/Text-Fighter/blob/CheatsIndexOutOfBoundsFix/TESTING.md) for more information on testing.
+
+ ### Resolution:
+ #### Pending
+ A [pull request](https://github.com/hhaslam11/Text-Fighter/pull/131) has been made to merge the change onto the master branch of the source repo.
+
+ ### Additional resources:
+ #### Please view the following to find additional documentation of the changes and the code involved in the changes.
+  * [Class Diagrams](https://github.com/emmamickas/Text-Fighter/tree/CheatsIndexOutOfBoundsFix/Class%20Diagram) of modified classes.
+  * [Dependencies](https://github.com/emmamickas/Text-Fighter/tree/CheatsIndexOutOfBoundsFix/Dependency%20References) of modified or dependent classes.
+  * [Sequence Diagrams](https://github.com/emmamickas/Text-Fighter/tree/CheatsIndexOutOfBoundsFix/Sequence%20Diagrams) of modified or dependent methods.
diff --git a/Class Diagram/Packagecasinodiagram.png b/Class Diagram/Packagecasinodiagram.png
diff --git a/Class Diagram/Packageitemdiagram.png b/Class Diagram/Packageitemdiagram.png
diff --git a/Class Diagram/PackageitemdiagramAfterchange.png b/Class Diagram/PackageitemdiagramAfterchange.png
diff --git a/Class Diagram/PackageitemdiagramBeforechange.png b/Class Diagram/PackageitemdiagramBeforechange.png
diff --git a/Class Diagram/PackagemaindiagramAfterchange.png b/Class Diagram/PackagemaindiagramAfterchange.png
diff --git a/Class Diagram/PackagemaindiagramBeforechange.png b/Class Diagram/PackagemaindiagramBeforechange.png
diff --git a/Class Diagram/Packageplayerdiagram.png b/Class Diagram/Packageplayerdiagram.png
diff --git a/Class Diagram/Sourcestructurediagram.png b/Class Diagram/Sourcestructurediagram.png
diff --git a/Dependency References/ArmourDependencies.png b/Dependency References/ArmourDependencies.png
diff --git a/Dependency References/EnemyDependencies.png b/Dependency References/EnemyDependencies.png
diff --git a/Dependency References/FoodDependencies.png b/Dependency References/FoodDependencies.png
diff --git a/Dependency References/PotionStatsDependencies.png b/Dependency References/PotionStatsDependencies.png
diff --git a/Dependency References/Usage Slicing/ArrayArmoursUsage1.png b/Dependency References/Usage Slicing/ArrayArmoursUsage1.png
diff --git a/Dependency References/Usage Slicing/ArrayEnemyUsage1.png b/Dependency References/Usage Slicing/ArrayEnemyUsage1.png
diff --git a/Dependency References/Usage Slicing/ArrayFoodUsage1.png b/Dependency References/Usage Slicing/ArrayFoodUsage1.png
diff --git a/Dependency References/Usage Slicing/ArrayFoodUsage2.png b/Dependency References/Usage Slicing/ArrayFoodUsage2.png
diff --git a/Dependency References/Usage Slicing/ArrayFoodUsage3.png b/Dependency References/Usage Slicing/ArrayFoodUsage3.png
diff --git a/Dependency References/Usage Slicing/ArrayWeaponUsage1.png b/Dependency References/Usage Slicing/ArrayWeaponUsage1.png
diff --git a/Dependency References/Usage Slicing/ArrayWeaponUsage2.png b/Dependency References/Usage Slicing/ArrayWeaponUsage2.png
diff --git a/Dependency References/Usage Slicing/ArrayWeaponUsage3.png b/Dependency References/Usage Slicing/ArrayWeaponUsage3.png
diff --git a/Dependency References/Usage Slicing/GetArmoursUsage1.png b/Dependency References/Usage Slicing/GetArmoursUsage1.png
diff --git a/Dependency References/Usage Slicing/Potion-used_Usage1.png b/Dependency References/Usage Slicing/Potion-used_Usage1.png
diff --git a/Dependency References/Usage Slicing/RecoveryPotionsUsed_Usage1.png b/Dependency References/Usage Slicing/RecoveryPotionsUsed_Usage1.png
diff --git a/Dependency References/Usage Slicing/SurvivalPotionsUsed_Usage1.png b/Dependency References/Usage Slicing/SurvivalPotionsUsed_Usage1.png
diff --git a/Dependency References/WeaponDependencies.png b/Dependency References/WeaponDependencies.png
diff --git a/Sequence Diagrams/Armour_choose_sequenceDiagram.png b/Sequence Diagrams/Armour_choose_sequenceDiagram.png
diff --git a/Sequence Diagrams/Debug_menu_sequenceDiagram.png b/Sequence Diagrams/Debug_menu_sequenceDiagram.png
diff --git a/Sequence Diagrams/Enemy_findEnemy_sequenceDiagram.png b/Sequence Diagrams/Enemy_findEnemy_sequenceDiagram.png
diff --git a/Sequence Diagrams/Food_list_sequenceDiagram.png b/Sequence Diagrams/Food_list_sequenceDiagram.png
diff --git a/Sequence Diagrams/Potion_use_sequenceDiagram.png b/Sequence Diagrams/Potion_use_sequenceDiagram.png
diff --git a/Sequence Diagrams/Stats_view_sequenceDiagram.png b/Sequence Diagrams/Stats_view_sequenceDiagram.png
diff --git a/Sequence Diagrams/Weapon_choose_sequenceDiagram.png b/Sequence Diagrams/Weapon_choose_sequenceDiagram.png
diff --git a/TESTING.md b/TESTING.md
@@ -7,3 +7,51 @@
 ## Additional Notes on Testing:
 ### N/A
 ### All tests may be run as normal through JUnit
+
+# Testing array access modifier functionality:
+## The following tests were performed to ensure that behavior was preserved after refactoring/changes:
+ ### [Armour Tests](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/item/ArmourTest.java) including testing of the methods:
+ * choose()
+ * getArmours()
+ ### [Weapon Tests](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/WeaponTest.java) including testing of the methods:
+ * set(int i)
+ * choose()
+ * getWeapons()
+ ### [Enemy Tests](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/EnemyTest.java) including testing of the methods:
+ * set(int i)
+ * get()
+ * getIndex(Enemy i)
+ * findEnemy()
+ * getEnemies()
+ ### [Food Tests](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/FoodTest.java) including testing of the methods:
+ * choose()
+ * getFoods()
+ ### [Cheats Tests](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/CheatsTest.java) including testing of the methods:
+ * cheatGateway()
+** This method is tested for the 'givemeitall' cheat, the 'weaponstash' cheat, and the 'thirstforfood' cheat.
+ ### [Debug Tests](https://github.com/emmamickas/Text-Fighter/blob/AddConstantArraylistAccessModifiers/src/com/hotmail/kalebmarc/textfighter/main/DebugTest.java) including testing of the methods:
+ * menu()
+** This method is tested for weapon and food debugging
+
+## Additional Notes on Testing:Testing constant array access modifier functionality:
+### The testing of the Armour, Weapon, Food, Enemy, Debug, and Cheat class require UI interaction.
+### As such, each test requiring UI interaction including:
+* ArmourTest: testChooseOnly, testChooseFirst, testChooseMiddle, testChooseLast
+* CheatsTest: testCheatGatewaygivemeitall, testCheatGatewayweaponstash, testCheatGatewaythirstforfood
+* DebugTest: testMenuWeapon, testMenuFood
+* FoodTest: testListChooseFirst, testListChooseMiddle, testListChooseLast
+* WeaponTest: testChooseFirst, testChooseMiddle, testChooseLast
+### Must be run individually rather than running all tests in the class at once.
+
+# Testing potion functionality:
+## The following tests were performed to ensure that behavior was preserved after refactoring/changes:
+ ### [Potion](https://github.com/emmamickas/Text-Fighter/blob/ShowSpecificPotionStats/src/com/hotmail/kalebmarc/textfighter/player/PotionTest.java) Tests including testing of the methods:
+ * get(String kind)
+ * set(String kind, int amount, boolean add)
+ * use(String k)
+ * used(String kind)
+
+## Additional Notes on Testing:
+### The potion tests are built to work when run all at once or separately except for the testUsed() test case.
+### This test case keeps track of all previous actions of the class, and thus will be accurate when only when run with the other tests.
+### If you wish to perform only the unit test for the used function, you may reenable the testUsedAlone test and run all tests, or only the testUsedAlone test.