In this example, the {@link TemplateView} class provides the skeleton for rendering views + * with a header, dynamic content, and a footer. Subclasses {@link HomePageView} and + * {@link ContactPageView} define the specific dynamic content for their respective views. + * + *
The {@link App} class demonstrates the usage of the Template View Pattern by rendering + * instances of {@link HomePageView} and {@link ContactPageView}. + */ +@Slf4j +public class App { + + /** + * Program entry point. + * + * @param args command line args + */ + public static void main(String[] args) { + // Create and render the HomePageView + TemplateView homePage = new HomePageView(); + LOGGER.info("Rendering HomePage:"); + homePage.render(); + + // Create and render the ContactPageView + TemplateView contactPage = new ContactPageView(); + LOGGER.info("\nRendering ContactPage:"); + contactPage.render(); + } +} diff --git a/templateview/src/main/java/com/iluwatar/templateview/ContactPageView.java b/templateview/src/main/java/com/iluwatar/templateview/ContactPageView.java new file mode 100644 index 000000000000..980ed48fa85d --- /dev/null +++ b/templateview/src/main/java/com/iluwatar/templateview/ContactPageView.java @@ -0,0 +1,42 @@ +/* + * 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.templateview; + +import lombok.extern.slf4j.Slf4j; + +/** + * ContactPageView implements the TemplateView and provides dynamic content specific to the contact page. + */ +@Slf4j +public class ContactPageView extends TemplateView { + + /** + * Renders dynamic content for the contact page. + */ + @Override + protected void renderDynamicContent() { + LOGGER.info("Contact us at: contact@example.com"); + } +} diff --git a/templateview/src/main/java/com/iluwatar/templateview/HomePageView.java b/templateview/src/main/java/com/iluwatar/templateview/HomePageView.java new file mode 100644 index 000000000000..704f7b58f5c2 --- /dev/null +++ b/templateview/src/main/java/com/iluwatar/templateview/HomePageView.java @@ -0,0 +1,41 @@ +/* + * 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.templateview; + +import lombok.extern.slf4j.Slf4j; + +/** + * HomePageView implements the TemplateView and provides dynamic content specific to the homepage. + */ +@Slf4j +public class HomePageView extends TemplateView { + /** + * Renders dynamic content for the homepage. + */ + @Override + protected void renderDynamicContent() { + LOGGER.info("Welcome to the Home Page!"); + } +} diff --git a/templateview/src/main/java/com/iluwatar/templateview/TemplateView.java b/templateview/src/main/java/com/iluwatar/templateview/TemplateView.java new file mode 100644 index 000000000000..5d0fd36c5d00 --- /dev/null +++ b/templateview/src/main/java/com/iluwatar/templateview/TemplateView.java @@ -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.templateview; + +import lombok.extern.slf4j.Slf4j; + +/** + * TemplateView defines the skeleton for rendering views. + * Concrete subclasses will provide the dynamic content for specific views. + */ +@Slf4j +public abstract class TemplateView { + + /** + * Render the common structure of the view, delegating dynamic content to subclasses. + */ + public final void render() { + printHeader(); + renderDynamicContent(); + printFooter(); + } + + /** + * Prints the common header of the view. + */ + protected void printHeader() { + LOGGER.info("Rendering header..."); + } + + /** + * Subclasses must provide the implementation for rendering dynamic content. + */ + protected abstract void renderDynamicContent(); + + /** + * Prints the common footer of the view. + */ + protected void printFooter() { + LOGGER.info("Rendering footer..."); + } +} diff --git a/templateview/src/test/java/com/iluwatar/templateview/AppTest.java b/templateview/src/test/java/com/iluwatar/templateview/AppTest.java new file mode 100644 index 000000000000..79bd38125bc6 --- /dev/null +++ b/templateview/src/test/java/com/iluwatar/templateview/AppTest.java @@ -0,0 +1,40 @@ +/* + * 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.templateview; + +import org.junit.jupiter.api.Test; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; + +/** + * Application test + */ +class AppTest { + + @Test + void shouldExecuteWithoutException() { + // Verify that main() method executes without throwing exceptions + assertDoesNotThrow(() -> App.main(new String[]{})); + } +} diff --git a/templateview/src/test/java/com/iluwatar/templateview/ContactPageViewTest.java b/templateview/src/test/java/com/iluwatar/templateview/ContactPageViewTest.java new file mode 100644 index 000000000000..203974a48608 --- /dev/null +++ b/templateview/src/test/java/com/iluwatar/templateview/ContactPageViewTest.java @@ -0,0 +1,43 @@ +/* + * 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.templateview; + +import org.junit.jupiter.api.Test; +import static org.mockito.Mockito.*; + +class ContactPageViewTest { + + @Test + void testRenderDynamicContent() { + // Create a spy for ContactPageView + ContactPageView contactPage = spy(ContactPageView.class); + + // Render dynamic content for ContactPageView + contactPage.renderDynamicContent(); + + // Verify that the correct message is logged + verify(contactPage).renderDynamicContent(); + } +} diff --git a/templateview/src/test/java/com/iluwatar/templateview/HomePageViewTest.java b/templateview/src/test/java/com/iluwatar/templateview/HomePageViewTest.java new file mode 100644 index 000000000000..33285a50107b --- /dev/null +++ b/templateview/src/test/java/com/iluwatar/templateview/HomePageViewTest.java @@ -0,0 +1,43 @@ +/* + * 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.templateview; + +import org.junit.jupiter.api.Test; +import static org.mockito.Mockito.*; + +class HomePageViewTest { + + @Test + void testRenderDynamicContent() { + // Create a spy for HomePageView + HomePageView homePage = spy(HomePageView.class); + + // Render dynamic content for HomePageView + homePage.renderDynamicContent(); + + // Verify that the correct message is logged + verify(homePage).renderDynamicContent(); + } +} diff --git a/templateview/src/test/java/com/iluwatar/templateview/TemplateViewTest.java b/templateview/src/test/java/com/iluwatar/templateview/TemplateViewTest.java new file mode 100644 index 000000000000..ff53711583b0 --- /dev/null +++ b/templateview/src/test/java/com/iluwatar/templateview/TemplateViewTest.java @@ -0,0 +1,59 @@ +/* + * 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.templateview; + +import org.junit.jupiter.api.Test; +import static org.mockito.Mockito.*; + +class TemplateViewTest { + + @Test + void testRenderHomePage() { + // Create a spy for HomePageView + TemplateView homePage = spy(HomePageView.class); + + // Call the render method + homePage.render(); + + // Verify that the steps of rendering are executed in the correct order + verify(homePage).printHeader(); // Header is printed + verify(homePage).renderDynamicContent(); // Dynamic content specific to home page + verify(homePage).printFooter(); // Footer is printed + } + + @Test + void testRenderContactPage() { + // Create a spy for ContactPageView + TemplateView contactPage = spy(ContactPageView.class); + + // Call the render method + contactPage.render(); + + // Verify that the steps of rendering are executed in the correct order + verify(contactPage).printHeader(); // Header is printed + verify(contactPage).renderDynamicContent(); // Dynamic content specific to contact page + verify(contactPage).printFooter(); // Footer is printed + } +}