Update Method pattern (#1106)

* Add update method pattern

* Add unit tests

* Add README.md

* Resolve conflict

update-method/src/test/java/com/iluwatar/updatemethod/AppTest.java

@@ -0,0 +1,35 @@
+/*
+ * The MIT License
+ * Copyright © 2014-2019 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.iluwatar.updatemethod;
+
+import org.junit.Test;
+
+public class AppTest {
+
+  @Test
+  public void testMain() {
+    String[] args = {};
+    App.main(args);
+  }
+}

update-method/src/test/java/com/iluwatar/updatemethod/SkeletonTest.java

@@ -0,0 +1,78 @@
+/*
+ * The MIT License
+ * Copyright © 2014-2019 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.iluwatar.updatemethod;
+
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+public class SkeletonTest {
+
+  private Skeleton skeleton;
+
+  @Before
+  public void setup() {
+    skeleton = new Skeleton(1);
+  }
+
+  @After
+  public void tearDown() {
+    skeleton = null;
+  }
+
+  @Test
+  public void testUpdateForPatrollingLeft() {
+    skeleton.patrollingLeft = true;
+    skeleton.setPosition(50);
+    skeleton.update();
+    Assert.assertEquals(49, skeleton.getPosition());
+  }
+
+  @Test
+  public void testUpdateForPatrollingRight() {
+    skeleton.patrollingLeft = false;
+    skeleton.setPosition(50);
+    skeleton.update();
+    Assert.assertEquals(51, skeleton.getPosition());
+  }
+
+  @Test
+  public void testUpdateForReverseDirectionFromLeftToRight() {
+    skeleton.patrollingLeft = true;
+    skeleton.setPosition(1);
+    skeleton.update();
+    Assert.assertEquals(0, skeleton.getPosition());
+    Assert.assertEquals(false, skeleton.patrollingLeft);
+  }
+
+  @Test
+  public void testUpdateForReverseDirectionFromRightToLeft() {
+    skeleton.patrollingLeft = false;
+    skeleton.setPosition(99);
+    skeleton.update();
+    Assert.assertEquals(100, skeleton.getPosition());
+    Assert.assertEquals(true, skeleton.patrollingLeft);
+  }
+}

update-method/src/test/java/com/iluwatar/updatemethod/StatueTest.java

@@ -0,0 +1,58 @@
+/*
+ * The MIT License
+ * Copyright © 2014-2019 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.iluwatar.updatemethod;
+
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+public class StatueTest {
+
+  private Statue statue;
+
+  @Before
+  public void setup() {
+    statue = new Statue(1, 20);
+  }
+
+  @After
+  public void tearDown() {
+    statue = null;
+  }
+
+  @Test
+  public void testUpdateForPendingShoot() {
+    statue.frames = 10;
+    statue.update();
+    Assert.assertEquals(11, statue.frames);
+  }
+
+  @Test
+  public void testUpdateForShooting() {
+    statue.frames = 19;
+    statue.update();
+    Assert.assertEquals(0, statue.frames);
+  }
+}

update-method/src/test/java/com/iluwatar/updatemethod/WorldTest.java

@@ -0,0 +1,63 @@
+/*
+ * The MIT License
+ * Copyright © 2014-2019 Ilkka Seppälä
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.iluwatar.updatemethod;
+
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+public class WorldTest {
+
+  private World world;
+
+  @Before
+  public void setup() {
+    world = new World();
+  }
+
+  @After
+  public void tearDown() {
+    world = null;
+  }
+
+  @Test
+  public void testRun() {
+    world.run();
+    Assert.assertEquals(true, world.isRunning);
+  }
+
+  @Test
+  public void testStop() {
+    world.stop();
+    Assert.assertEquals(false, world.isRunning);
+  }
+
+  @Test
+  public void testAddEntity() {
+    var entity = new Skeleton(1);
+    world.addEntity(entity);
+    Assert.assertEquals(entity, world.entities.get(0));
+  }
+}