Merge remote-tracking branch 'origin/master'

antouhou · Jul 4, 2020 · e959e3d · e959e3d
2 parents 9e304c0 + 8a7792a
commit e959e3d
Show file tree

Hide file tree

Showing 17 changed files with 417 additions and 109 deletions.
diff --git a/HexCore.Tests/HexGraph/AStarSearch.Test.cs → HexCore.Tests/AStarSearch.Test.cs b/HexCore.Tests/HexGraph/AStarSearch.Test.cs → HexCore.Tests/AStarSearch.Test.cs
@@ -3,7 +3,7 @@
 using HexCoreTests.Fixtures;
 using NUnit.Framework;
 
-namespace HexCoreTests.HexGraph
+namespace HexCoreTests
 {
     [TestFixture]
     public class AStarSearchTest

diff --git a/...Tests/DataStructures/Coordinate2D.Test.cs → HexCore.Tests/Coordinate2D.Test.cs b/...Tests/DataStructures/Coordinate2D.Test.cs → HexCore.Tests/Coordinate2D.Test.cs
@@ -1,9 +1,8 @@
-using System.Collections.Generic;
 using HexCore;
 using HexCoreTests.Fixtures;
 using NUnit.Framework;
 
-namespace HexCoreTests.DataStructures
+namespace HexCoreTests
 {
     [TestFixture]
     public class Coordinate2DTest
@@ -18,7 +17,7 @@ public void ConvertsOffsetCoordinatesToCubeCoordinatesCorrectly()
             //Down and right: Y - 1, Z + 1
             //Down and left:  X - 1, Z + 1
             //Right: X + 1, Y - 1;
-            var expectedCubeCoordinates = new []
+            var expectedCubeCoordinates = new[]
             {
                 new Coordinate3D(0, 0, 0),
                 // Down right:
@@ -38,7 +37,7 @@ public void ConvertsOffsetCoordinatesToCubeCoordinatesCorrectly()
                 // Down and left:
                 new Coordinate3D(1, -3, 2)
             };
-            
+
             Assert.That(cubeCoordinates, Is.EqualTo(expectedCubeCoordinates));
         }
 
@@ -77,5 +76,13 @@ public void To3D_ShouldConvertOddRowsRight()
             var actualCoordinate3D = coordinate2D.To3D();
             Assert.That(actualCoordinate3D, Is.EqualTo(expectedCoordinate3D));
         }
+
+        [Test]
+        public void ToString_ShouldSerializeToString()
+        {
+            var coordinate2D = new Coordinate2D(1, 1, OffsetTypes.OddRowsRight);
+
+            Assert.That(coordinate2D.ToString(), Is.EqualTo("(1, 1)"));
+        }
     }
 }
diff --git a/...Tests/DataStructures/Coordinate3D.Test.cs → HexCore.Tests/Coordinate3D.Test.cs b/...Tests/DataStructures/Coordinate3D.Test.cs → HexCore.Tests/Coordinate3D.Test.cs
@@ -2,7 +2,7 @@
 using HexCore;
 using NUnit.Framework;
 
-namespace HexCoreTests.DataStructures
+namespace HexCoreTests
 {
     [TestFixture]
     public class Coordinate3DTest
@@ -119,5 +119,13 @@ public void To2D_ShouldConvertTo2DOddRowsRight()
             var expectedCoordinate2D = new Coordinate2D(1, 1, OffsetTypes.OddRowsRight);
             Assert.That(actualCoordinate2D, Is.EqualTo(expectedCoordinate2D));
         }
+
+        [Test]
+        public void ToString_ShouldSerializeToString()
+        {
+            var coordinate3D = new Coordinate3D(1, -2, 1);
+
+            Assert.That(coordinate3D.ToString(), Is.EqualTo("(1, -2, 1)"));
+        }
     }
 }
diff --git a/HexCore.Tests/HexGraph/Graph.Test.cs → HexCore.Tests/Graph.Test.cs b/HexCore.Tests/HexGraph/Graph.Test.cs → HexCore.Tests/Graph.Test.cs
diff --git a/HexCore.Tests/HexGraph/GraphFactory.Test.cs → HexCore.Tests/GraphFactory.Test.cs b/HexCore.Tests/HexGraph/GraphFactory.Test.cs → HexCore.Tests/GraphFactory.Test.cs
@@ -2,7 +2,7 @@
 using HexCoreTests.Fixtures;
 using NUnit.Framework;
 
-namespace HexCoreTests.HexGraph
+namespace HexCoreTests
 {
     [TestFixture]
     public class GraphFactoryTest

diff --git a/HexCore.Tests/HexGraph/GraphUtils.Test.cs → HexCore.Tests/GraphUtils.Test.cs b/HexCore.Tests/HexGraph/GraphUtils.Test.cs → HexCore.Tests/GraphUtils.Test.cs
@@ -2,7 +2,7 @@
 using HexCoreTests.Fixtures;
 using NUnit.Framework;
 
-namespace HexCoreTests.HexGraph
+namespace HexCoreTests
 {
     [TestFixture]
     public class GraphUtilsTest

diff --git a/HexCore.Tests/HexCore.Tests.csproj b/HexCore.Tests/HexCore.Tests.csproj
@@ -7,6 +7,7 @@
     </PropertyGroup>
 
     <ItemGroup>
+        <PackageReference Include="coverlet.msbuild" Version="2.9.0" />
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.1.1" />
         <PackageReference Include="NUnit" Version="3.12.0" />
         <PackageReference Include="NUnit3TestAdapter" Version="3.13.0" />

diff --git a/HexCore.Tests/MovementType.Test.cs b/HexCore.Tests/MovementType.Test.cs
@@ -0,0 +1,30 @@
+using HexCore;
+using NUnit.Framework;
+
+namespace HexCoreTests
+{
+    [TestFixture]
+    public class MovementTypeTest
+    {
+        [Test]
+        public void Equals_ShouldReturnFalse_WhenMovementTypesAreNotEqual()
+        {
+            var type1 = new MovementType(1, "Type");
+            var type2 = new MovementType(2, "Type");
+            var type3 = new MovementType(1, "Some other type");
+
+            Assert.That(type1.Equals(type2), Is.False);
+            Assert.That(type1.Equals(type3), Is.False);
+            Assert.That(type1.Equals(null), Is.False);
+        }
+
+        [Test]
+        public void Equals_ShouldReturnTrue_WhenMovementTypesAreEqual()
+        {
+            var type1 = new MovementType(1, "Type");
+            var type2 = new MovementType(1, "Type");
+
+            Assert.That(type1.Equals(type2), Is.True);
+        }
+    }
+}
diff --git a/HexCore.Tests/HexGraph/MovementTypes.Test.cs → HexCore.Tests/MovementTypes.Test.cs b/HexCore.Tests/HexGraph/MovementTypes.Test.cs → HexCore.Tests/MovementTypes.Test.cs
@@ -1,8 +1,9 @@
 using System.Collections.Generic;
 using HexCore;
+using HexCoreTests.Fixtures;
 using NUnit.Framework;
 
-namespace HexCoreTests.HexGraph
+namespace HexCoreTests
 {
     [TestFixture]
     public class MovementTypesTest
@@ -253,6 +254,30 @@ public void GetMovementCost_ShouldReturnCostFromAToB()
             Assert.That(movementTypes.GetMovementCost(flyingType, ground), Is.EqualTo(1));
         }
 
+        [Test]
+        public void GetMovementCost_ShouldThrow_WhenUnknownMovementTypeIsPassed()
+        {
+            var unknownMovementType = new MovementType(1, "Some movement type");
+
+            var movementTypes = MovementTypesFixture.GetMovementTypes();
+
+            Assert.That(() => { movementTypes.GetMovementCost(unknownMovementType, MovementTypesFixture.Ground); },
+                Throws.ArgumentException.With.Message.EqualTo(
+                    "Unknown movement type: 'Some movement type'"));
+        }
+
+        [Test]
+        public void GetMovementCost_ShouldThrow_WhenUnknownTerrainTypeIsPassed()
+        {
+            var unknownTerrainType = new TerrainType(1, "Some terrain type");
+
+            var movementTypes = MovementTypesFixture.GetMovementTypes();
+
+            Assert.That(() => { movementTypes.GetMovementCost(MovementTypesFixture.Walking, unknownTerrainType); },
+                Throws.ArgumentException.With.Message.EqualTo(
+                    "Unknown terrain type: 'Some terrain type'"));
+        }
+
         [Test]
         public void GetType_ShouldReturnTypeByTheId()
         {

diff --git a/HexCore.Tests/QuickStart.cs b/HexCore.Tests/QuickStart.cs
@@ -14,7 +14,7 @@ public static void Demo()
             var swimmingType = new MovementType(2, "Swimming");
 
             var movementTypes = new MovementTypes(
-                new ITerrainType[] { ground, water }, 
+                new ITerrainType[] {ground, water},
                 new Dictionary<IMovementType, Dictionary<ITerrainType, int>>
                 {
                     [walkingType] = new Dictionary<ITerrainType, int>
@@ -30,15 +30,16 @@ public static void Demo()
                 }
             );
 
-            var graph = new Graph(new CellState[] { 
-                new CellState(false, new Coordinate2D(0,0, OffsetTypes.OddRowsRight), ground),
-                new CellState(false, new Coordinate2D(0,1, OffsetTypes.OddRowsRight), ground),
-                new CellState(true, new Coordinate2D(1,0, OffsetTypes.OddRowsRight), water),
-                new CellState(false, new Coordinate2D(1,1, OffsetTypes.OddRowsRight), water),
-                new CellState(false, new Coordinate2D(1,2, OffsetTypes.OddRowsRight), ground)
+            var graph = new Graph(new[]
+            {
+                new CellState(false, new Coordinate2D(0, 0, OffsetTypes.OddRowsRight), ground),
+                new CellState(false, new Coordinate2D(0, 1, OffsetTypes.OddRowsRight), ground),
+                new CellState(true, new Coordinate2D(1, 0, OffsetTypes.OddRowsRight), water),
+                new CellState(false, new Coordinate2D(1, 1, OffsetTypes.OddRowsRight), water),
+                new CellState(false, new Coordinate2D(1, 2, OffsetTypes.OddRowsRight), ground)
             }, movementTypes);
 
-            var pawnPosition = new Coordinate2D(0,0, OffsetTypes.OddRowsRight).To3D();
+            var pawnPosition = new Coordinate2D(0, 0, OffsetTypes.OddRowsRight).To3D();
             // Mark pawn's position as occupied
             graph.BlockCells(pawnPosition);
 
@@ -49,9 +50,9 @@ public static void Demo()
             );
 
             var pawnGoal = new Coordinate2D(1, 2, OffsetTypes.OddRowsRight).To3D();
-            
+
             var theShortestPath = graph.GetShortestPath(
-                pawnPosition, 
+                pawnPosition,
                 pawnGoal,
                 walkingType
             );

diff --git a/HexCore.Tests/Quickstart.Test.cs b/HexCore.Tests/Quickstart.Test.cs
@@ -17,7 +17,7 @@ public void QuickstartExample_ShouldWork()
             var swimmingType = new MovementType(2, "Swimming");
 
             var movementTypes = new MovementTypes(
-                new ITerrainType[] { ground, water }, 
+                new ITerrainType[] {ground, water},
                 new Dictionary<IMovementType, Dictionary<ITerrainType, int>>
                 {
                     [walkingType] = new Dictionary<ITerrainType, int>
@@ -33,15 +33,16 @@ public void QuickstartExample_ShouldWork()
                 }
             );
 
-            var graph = new Graph(new CellState[] { 
-                new CellState(false, new Coordinate2D(0,0, OffsetTypes.OddRowsRight), ground),
-                new CellState(false, new Coordinate2D(0,1, OffsetTypes.OddRowsRight), ground),
-                new CellState(true, new Coordinate2D(1,0, OffsetTypes.OddRowsRight), water),
-                new CellState(false, new Coordinate2D(1,1, OffsetTypes.OddRowsRight), water),
-                new CellState(false, new Coordinate2D(1,2, OffsetTypes.OddRowsRight), ground)
+            var graph = new Graph(new[]
+            {
+                new CellState(false, new Coordinate2D(0, 0, OffsetTypes.OddRowsRight), ground),
+                new CellState(false, new Coordinate2D(0, 1, OffsetTypes.OddRowsRight), ground),
+                new CellState(true, new Coordinate2D(1, 0, OffsetTypes.OddRowsRight), water),
+                new CellState(false, new Coordinate2D(1, 1, OffsetTypes.OddRowsRight), water),
+                new CellState(false, new Coordinate2D(1, 2, OffsetTypes.OddRowsRight), ground)
             }, movementTypes);
 
-            var pawnPosition = new Coordinate2D(0,0, OffsetTypes.OddRowsRight).To3D();
+            var pawnPosition = new Coordinate2D(0, 0, OffsetTypes.OddRowsRight).To3D();
             // Mark pawn's position as occupied
             graph.BlockCells(pawnPosition);
 
@@ -52,9 +53,9 @@ public void QuickstartExample_ShouldWork()
             );
 
             var pawnGoal = new Coordinate2D(1, 2, OffsetTypes.OddRowsRight).To3D();
-            
+
             var theShortestPath = graph.GetShortestPath(
-                pawnPosition, 
+                pawnPosition,
                 pawnGoal,
                 walkingType
             );
@@ -64,17 +65,17 @@ public void QuickstartExample_ShouldWork()
             graph.BlockCells(pawnGoal);
 
             Assert.That(graph.IsCellBlocked(pawnPosition), Is.True);
-            Assert.That(theShortestPath, Is.EquivalentTo(new []
+            Assert.That(theShortestPath, Is.EquivalentTo(new[]
             {
                 new Coordinate2D(0, 1, OffsetTypes.OddRowsRight).To3D(),
                 pawnGoal
             }));
 
             var expectedMovementRange = new[]
             {
-                new Coordinate2D(0,1, OffsetTypes.OddRowsRight).To3D(),
-                new Coordinate2D(1,1, OffsetTypes.OddRowsRight).To3D(),
-                new Coordinate2D(1,2, OffsetTypes.OddRowsRight).To3D(),
+                new Coordinate2D(0, 1, OffsetTypes.OddRowsRight).To3D(),
+                new Coordinate2D(1, 1, OffsetTypes.OddRowsRight).To3D(),
+                new Coordinate2D(1, 2, OffsetTypes.OddRowsRight).To3D()
             };
             Assert.That(pawnMovementRange, Is.EquivalentTo(expectedMovementRange));
         }

diff --git a/HexCore.Tests/TerrainType.Test.cs b/HexCore.Tests/TerrainType.Test.cs
@@ -0,0 +1,30 @@
+using HexCore;
+using NUnit.Framework;
+
+namespace HexCoreTests
+{
+    [TestFixture]
+    public class TerrainTypeTest
+    {
+        [Test]
+        public void Equals_ShouldReturnFalse_WhenMovementTypesAreNotEqual()
+        {
+            var type1 = new TerrainType(1, "Type");
+            var type2 = new TerrainType(2, "Type");
+            var type3 = new TerrainType(1, "Some other type");
+
+            Assert.That(type1.Equals(type2), Is.False);
+            Assert.That(type1.Equals(type3), Is.False);
+            Assert.That(type1.Equals(null), Is.False);
+        }
+
+        [Test]
+        public void Equals_ShouldReturnTrue_WhenMovementTypesAreEqual()
+        {
+            var type1 = new TerrainType(1, "Type");
+            var type2 = new TerrainType(1, "Type");
+
+            Assert.That(type1.Equals(type2), Is.True);
+        }
+    }
+}
diff --git a/HexCore/Coordinate2D.cs b/HexCore/Coordinate2D.cs
@@ -51,7 +51,10 @@ public Coordinate2D(int x, int y, OffsetTypes offsetType)
             Y = y;
             OffsetType = offsetType;
         }
-
-        public override string ToString() => $"({X}, {Y})";
+
+        public override string ToString()
+        {
+            return $"({X}, {Y})";
+        }
     }
 }
diff --git a/HexCore/Coordinate3D.cs b/HexCore/Coordinate3D.cs
@@ -73,7 +73,10 @@ public Coordinate3D(int x, int y, int z)
         {
             return new Coordinate3D(a.X * scalar, a.Y * scalar, a.Z * scalar);
         }
-
-        public override string ToString() => $"({X}, {Y}, {Z})";
+
+        public override string ToString()
+        {
+            return $"({X}, {Y}, {Z})";
+        }
     }
 }