feature: add Page Controller pattern (#2202)

* feat: create page controller * add test * add documentation * fix: delete img file * fix: modify App, SignupMode, UserController, pom.xml, and Readme * fix: modify MVC files on page controller * fix: modify readme file
2026-05-15 14:59:25 +00:00 · 2023-01-01 19:57:30 +11:00
parent b507913b5c
commit 4709922f11
19 changed files with 949 additions and 0 deletions
@@ -0,0 +1,38 @@
+/*
+ * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ *
+ * The MIT License
+ * Copyright © 2014-2022 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.page.controller;
+
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+
+/**
+ * Application test
+ */
+public class AppTest {
+  @Test
+  void shouldExecuteApplicationWithoutException() {
+    assertDoesNotThrow(() -> App.main(new String[]{}));
+  }
+}
@@ -0,0 +1,57 @@
+/*
+ * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ *
+ * The MIT License
+ * Copyright © 2014-2022 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.page.controller;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.web.servlet.mvc.support.RedirectAttributes;
+import org.springframework.web.servlet.mvc.support.RedirectAttributesModelMap;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+/**
+ * Test for Signup Controller
+ */
+public class SignupControllerTest {
+
+  /**
+   * Verify if user can sign up and redirect to user page
+   */
+  @Test
+  void testSignup() {
+    var controller = new SignupController();
+    controller.getSignup();
+
+    RedirectAttributes redirectAttributes = new RedirectAttributesModelMap();
+    String redirectPath = controller.create(retrieveSignupData(), redirectAttributes);
+    assertEquals("redirect:/user", redirectPath);
+  }
+
+  public static SignupModel retrieveSignupData() {
+    SignupModel model = new SignupModel();
+    model.setName("Lily");
+    model.setEmail("lily@email.com");
+    model.setPassword("password1234");
+    return model;
+  }
+}
@@ -0,0 +1,63 @@
+/*
+ * This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
+ *
+ * The MIT License
+ * Copyright © 2014-2022 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.page.controller;
+
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+/**
+ * Test for Signup Model
+ */
+public class SignupModelTest {
+  /**
+   * Verify if a user can set a name properly
+   */
+  @Test
+  void testSetName() {
+    SignupModel model = new SignupModel();
+    model.setName("Lily");
+    assertEquals("Lily", model.getName());
+  }
+
+  /**
+   * Verify if a user can set an email properly
+   */
+  @Test
+  void testSetEmail() {
+    SignupModel model = new SignupModel();
+    model.setEmail("Lily@email");
+    assertEquals("Lily@email", model.getEmail());
+  }
+
+  /**
+   * Verify if a user can set a password properly
+   */
+  @Test
+  void testSetPassword() {
+    SignupModel model = new SignupModel();
+    model.setPassword("password1234");
+    assertEquals("password1234", model.getPassword());
+  }
+}
@@ -0,0 +1,36 @@
+package com.iluwatar.page.controller;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
+import org.springframework.test.web.servlet.MockMvc;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.model;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@ExtendWith(SpringExtension.class)
+@SpringBootTest
+@AutoConfigureMockMvc
+public class UserControllerTest {
+  private UserController userController;
+
+  @Autowired
+  MockMvc mockMvc;
+
+  /**
+   * Verify if view and model are directed properly
+   */
+  @Test
+  void testGetUserPath () throws Exception {
+        this.mockMvc.perform(get("/user")
+                .param("name", "Lily")
+                .param("email", "Lily@email.com"))
+        .andExpect(status().isOk())
+        .andExpect(model().attribute("name", "Lily"))
+        .andExpect(model().attribute("email", "Lily@email.com"))
+        .andReturn();
+  }
+}
@@ -0,0 +1,27 @@
+package com.iluwatar.page.controller;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.junit.jupiter.api.Test;
+
+public class UserModelTest {
+  /**
+   * Verify if a user can set a name properly
+   */
+  @Test
+  void testSetName() {
+    UserModel model = new UserModel();
+    model.setName("Lily");
+    assertEquals("Lily", model.getName());
+  }
+
+  /**
+   * Verify if a user can set an email properly
+   */
+  @Test
+  void testSetEmail() {
+    UserModel model = new UserModel();
+    model.setEmail("Lily@email");
+    assertEquals("Lily@email", model.getEmail());
+  }
+}