Removing render type functions that are no longer needed now that layouts use CDTS setup function.

Author: plup2

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 [Download and/or Installation instructions](https://github.com/wet-boew/cdts-JavaTemplates/wiki/Installation)
 
+## v3.0.0
+
+- **IMPORTANT** ALL LAYOUT DEFINITIONS UPDATED - All inline scripts and occurences of `document.write` were removed. 
+    - Spring Version: This change should be transparent unless custom layouts were created in client applications. 
+    - Struts/JSP Version: All tiles templates must be updated from sample project (src/main/webapp/templates/*.
+- **IMPORTTANT** Functions that were deprecated long ago were removed in this version.
+
 ## v2.6.0
 
 - **IMPORTANT** The GCWeb site footer has been updated to reflect the changes introduced in WET footer version 4. These changes will be applied automatically. For more information, please visit the WET documentation: https://wet-boew.github.io/GCWeb/sites/footers/footers-en.html

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/AbstractCoreBean.java

@@ -12,6 +12,10 @@
 import goc.webtemplate.InfoBanner;
 import goc.webtemplate.MenuItem;
 
+/**
+ * This contains tests for RenderAppSetup in relation with the AppTop attributes,
+ * see the other RenderXXX classes for further tests.
+ */
 public class RenderAppTopTest {
 
     @Test
@@ -26,7 +30,7 @@ public void testCustomMenuItem() {
         menuLinks.add(item);
         sut.setMenuLinks(menuLinks);
 
-        assertTrue(sut.getRenderAppTop().contains("\"menuLinks\":[{\"href\":\"https//google.ca\",\"text\":\"Custom Menu Link\",\"acronym\":\"acronym\""),
+        assertTrue(sut.getRenderAppSetup().contains("\"menuLinks\":[{\"href\":\"https//google.ca\",\"text\":\"Custom Menu Link\",\"acronym\":\"acronym\""),
         		"RenderTop: Custom MenuItem not rendered as expected.");
     }
 
@@ -37,7 +41,7 @@ public void testInfoBanner() {
         InfoBanner banner = new InfoBanner("Main Text", new HeaderLink("google", "Link"), new HeaderLink("yahoo", "Button"));
         sut.setInfoBanner(banner);
 
-        assertTrue(sut.getRenderAppTop().contains("\"infoBanner\":{\"mainHTML\":\"Main Text\",\"link\":{\"newWindow\":false,\"href\":\"google\",\"text\":\"Link\"},\"button\":{\"newWindow\":false,\"href\":\"yahoo\",\"text\":\"Button\"}"),
+        assertTrue(sut.getRenderAppSetup().contains("\"infoBanner\":{\"mainHTML\":\"Main Text\",\"link\":{\"newWindow\":false,\"href\":\"google\",\"text\":\"Link\"},\"button\":{\"newWindow\":false,\"href\":\"yahoo\",\"text\":\"Button\"}"),
         		"\"RenderTop: InfoBanner not rendered as expected.\"");
     }
 

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/jsonentities/CdnEnvironment.java

@@ -10,6 +10,10 @@
 import goc.webtemplate.ContextualFooter;
 import goc.webtemplate.FooterLink;
 
+/**
+ * This contains tests for RenderSetup in relation with the Footer attributes,
+ * see the other RenderXXX classes for further tests.
+ */
 public class RenderFooterTest {
 
     @Test
@@ -19,7 +23,7 @@ public void testHideMainCorporateFooter() {
         sut.setHideMainFooter(true);
         sut.setHideCorporateFooter(true);
 
-        assertTrue(sut.getRenderFooter().contains("\"hideFooterMain\":true,\"hideFooterCorporate\":true"),
+        assertTrue(sut.getRenderSetup().contains("\"hideFooterMain\":true,\"hideFooterCorporate\":true"),
                 "RenderFooter: HideMainFooter/HideCorporateFooter not rendered as expected.");
     }
 
@@ -33,7 +37,7 @@ public void testShowContextualFooter() {
         l.add(new FooterLink("google", "Link 2", true));
         sut.setContextualFooter(new ContextualFooter("Contextual", l));
 
-        assertTrue(sut.getRenderFooter().contains("\"contextualFooter\":{\"title\":\"Contextual\",\"links\":[{\"newWindow\":false,\"href\":\"google\",\"text\":\"Link 1\"},{\"newWindow\":true,\"href\":\"google\",\"text\":\"Link 2\"}]"),
+        assertTrue(sut.getRenderSetup().contains("\"contextualFooter\":{\"title\":\"Contextual\",\"links\":[{\"newWindow\":false,\"href\":\"google\",\"text\":\"Link 1\"},{\"newWindow\":true,\"href\":\"google\",\"text\":\"Link 2\"}]"),
                 "RenderFooter: ContextualFooter not rendered as expected.");
     }
 
@@ -47,7 +51,7 @@ public void testModifyTermsPrivacyLink() {
         sut.setPrivacyLink(new FooterLink("google"));
         sut.setTermsConditionsLink(new FooterLink("google"));
 
-        assertTrue(sut.getRenderFooter().contains("\"privacyLink\":{\"newWindow\":false,\"href\":\"google\",\"text\":\"\"},\"termsLink\":{\"newWindow\":false,\"href\":\"google\",\"text\":\"\"}"),
+        assertTrue(sut.getRenderSetup().contains("\"privacyLink\":{\"newWindow\":false,\"href\":\"google\",\"text\":\"\"},\"termsLink\":{\"newWindow\":false,\"href\":\"google\",\"text\":\"\"}"),
                 "RenderFooter: PrivacyLink/TermsLinks not rendered as expected.");
     }
 
@@ -61,7 +65,7 @@ public void testModifyTermsProvacyLinkTransactionalFooter() {
         sut.setPrivacyLink(new FooterLink("google"));
         sut.setTermsConditionsLink(new FooterLink("google"));
 
-        assertTrue(sut.getRenderTransactionalFooter().contains("\"privacyLink\":[{\"newWindow\":false,\"href\":\"google\",\"text\":\"\"}],\"termsLink\":[{\"newWindow\":false,\"href\":\"google\",\"text\":\"\"}]"),
+        assertTrue(sut.getRenderTransactionalSetup().contains("\"privacyLink\":[{\"newWindow\":false,\"href\":\"google\",\"text\":\"\"}],\"termsLink\":[{\"newWindow\":false,\"href\":\"google\",\"text\":\"\"}]"),
                 "RenderTransactionalFooter: PrivacyLink/TermsLinks not rendered as expected.");
     }
 }

gocwebtemplate-core/gocwebtemplate-core-base/src/test/java/goc/webtemplate/component/abstractcorebeantest/RenderAppTopTest.java

@@ -5,17 +5,21 @@
 import org.junit.jupiter.api.Test;
 import goc.webtemplate.Constants;
 
+/**
+ * This contains tests for RenderSetup in relation with the preFooter attributes,
+ * see the other RenderXXX classes for further tests.
+ */
 public class RenderPreFooterTest {
 	@Test
     public void testRenderShareSocialSites() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
-        
+
         ArrayList<Constants.SocialMediaSites> sites = new ArrayList<Constants.SocialMediaSites>();
         sites.add(Constants.SocialMediaSites.blogger);
         sites.add(Constants.SocialMediaSites.diigo);
         sut.setSharePageMediaSites(sites);
-        
-        assertTrue(sut.getRenderPreFooter().contains("\"showShare\":[\"blogger\",\"diigo\"]"),
-                "PreFooter rendering: Not rendered as expected. (" + sut.getRenderPreFooter() + ")");
+
+        assertTrue(sut.getRenderSetup().contains("\"showShare\":[\"blogger\",\"diigo\"]"),
+                "PreFooter rendering: Not rendered as expected. (" + sut.getRenderSetup() + ")");
     }
 }

gocwebtemplate-core/gocwebtemplate-core-base/src/test/java/goc/webtemplate/component/abstractcorebeantest/RenderFooterTest.java

@@ -5,61 +5,65 @@
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.fail;
 
+/**
+ * This contains tests for RenderSetup in relation with the refFooter attributes (which are now in the "SetupBase" object),
+ * see the other RenderXXX classes for further tests.
+ */
 public class RenderRefFooterTest {
 
     @Test
     public void testRenderWithoutSecureSite() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
-        
-        assertTrue(!sut.getRenderRefFooter().contains("\"exitScript\":false,\"displayModal\":false"),
-        		"RefFooter rendering: Not rendered as expected. (" + sut.getRenderRefFooter() + ")");
+
+        assertTrue(!sut.getRenderSetup().contains("\"exitScript\":false,\"displayModal\":false"),
+        		"RefFooter rendering: Not rendered as expected. (" + sut.getRenderSetup() + ")");
     }
-    
+
     @Test
     public void testRenderWithSecureSite() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
-        
+
         sut.getLeavingSecureSiteWarning().setEnabled(true);
-        
-        assertTrue(sut.getRenderRefFooter().contains("\"exitSecureSite\":{\"exitScript\":true,\"displayModal\":true,\"displayModalForNewWindow\":true,\"exitMsg\":\"\""),
-        		"RefFooter rendering: LeavingSecureSite not rendered as expected. (" + sut.getRenderRefFooter() + ")");
+
+        assertTrue(sut.getRenderSetup().contains("\"exitSecureSite\":{\"exitScript\":true,\"displayModal\":true,\"displayModalForNewWindow\":true,\"exitMsg\":\"\""),
+        		"RefFooter rendering: LeavingSecureSite not rendered as expected. (" + sut.getRenderSetup() + ")");
     }
-    
+
     @Test
     public void testRenderWithSecureSiteAndYesCancelMessages() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
-        
+
         sut.getLeavingSecureSiteWarning().setEnabled(true);
         sut.getLeavingSecureSiteWarning().setCancelMessage("Test Cancel Message");
         sut.getLeavingSecureSiteWarning().setYesMessage("Test Yes Message");
         sut.getLeavingSecureSiteWarning().setTargetWarning("Test Target Warning");
-        
-        assertTrue(sut.getRenderRefFooter().contains("\"cancelMsg\":\"Test Cancel Message\",\"yesMsg\":\"Test Yes Message\",\"targetWarning\":\"Test Target Warning\""),
-        		"RefFooter rendering: LeavingSecureSite not rendered as expected. (" + sut.getRenderRefFooter() + ")");
+
+        assertTrue(sut.getRenderSetup().contains("\"cancelMsg\":\"Test Cancel Message\",\"yesMsg\":\"Test Yes Message\",\"targetWarning\":\"Test Target Warning\""),
+        		"RefFooter rendering: LeavingSecureSite not rendered as expected. (" + sut.getRenderSetup() + ")");
     }
-    
+
     @Test
     public void testWebAnalyticsRenders() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
-        
+
         sut.getWebAnalytics().setActive(false);
-        assertTrue(sut.getRenderRefFooter().contains("\"webAnalytics\":false"), 
+        assertTrue(!sut.getRenderSetup().contains("\"webAnalytics\":"),
         		"RefFooter rendering: WebAnalytics not rendered as expected.");
     }
-    
+
     @Test
     public void testWebAnalyticsOnlyIfSupportedInEnv() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
-        
+
         sut.getWebAnalytics().setActive(true);
         sut.setCDNEnvironment("PROD_SSL"); //this environment doesn't suppport analytics
-        
+
         try {
-            sut.getRenderRefFooter(); //will throw exception
+            sut.getRenderSetup(); //will throw exception
             fail("Expected RuntimeException thrown.");
         }
         catch (IllegalArgumentException ex) {
-            assertTrue(ex.getMessage().contains("WebAnalytics feature is not supported"), 
+            assertTrue(ex.getMessage().contains("WebAnalytics feature is not supported"),
             		"Unexpected exception message.");
         }
     }
@@ -70,45 +74,45 @@ public void testDisplayModalNewWinTrueWhenExitscriptDisabled() {
 
         sut.getLeavingSecureSiteWarning().setEnabled(false);
 
-        assertTrue(!sut.getRenderRefFooter().contains("\"displayModalForNewWindow\""),
-        		"RefFooter rendering: LeavingSecureSite not rendered as expected. (" + sut.getRenderRefFooter() + ")");
+        assertTrue(!sut.getRenderSetup().contains("\"displayModalForNewWindow\""),
+        		"RefFooter rendering: LeavingSecureSite not rendered as expected. (" + sut.getRenderSetup() + ")");
     }
-    
+
     @Test
     public void testDisplayModalNewWinFalse() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
 
         sut.getLeavingSecureSiteWarning().setEnabled(true);
         sut.getLeavingSecureSiteWarning().setDisplayModalForNewWindow(false);
 
-        assertTrue(sut.getRenderRefFooter().contains("\"displayModalForNewWindow\":false"),
-        		"RefFooter rendering: LeavingSecureSite not rendered as expected. (" + sut.getRenderRefFooter() + ")");
+        assertTrue(sut.getRenderSetup().contains("\"displayModalForNewWindow\":false"),
+        		"RefFooter rendering: LeavingSecureSite not rendered as expected. (" + sut.getRenderSetup() + ")");
     }
-    
+
     @Test
     public void testMsgBoxHeader() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
 
         sut.getLeavingSecureSiteWarning().setEnabled(true);
         sut.getLeavingSecureSiteWarning().setMsgBoxHeader("Warning, you are leaving a secure site!");
 
-        assertTrue(sut.getRenderRefFooter().contains("\"msgBoxHeader\":\"Warning, you are leaving a secure site!\""),
-        		"RefFooter rendering: LeavingSecureSite not rendered as expected. (" + sut.getRenderRefFooter() + ")");
+        assertTrue(sut.getRenderSetup().contains("\"msgBoxHeader\":\"Warning, you are leaving a secure site!\""),
+        		"RefFooter rendering: LeavingSecureSite not rendered as expected. (" + sut.getRenderSetup() + ")");
     }
 
     @Test
     public void testIsApplicationFalse() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
 
-        assertTrue(sut.getRenderRefFooter().contains("\"isApplication\":false"),
-        		"RefFooter rendering: Not rendered as expected. (" + sut.getRenderRefFooter() + ")");
+        assertTrue(sut.getRenderAppSetup().contains("\"mode\":\"app\""),
+        		"RefFooter rendering: Not rendered as expected. (" + sut.getRenderAppSetup() + ")");
     }
 
     @Test
     public void testIsApplicationTrue() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
 
-        assertTrue(sut.getRenderRefFooterForApp().contains("\"isApplication\":true"),
-        		"RefFooter rendering: Not rendered as expected. (" + sut.getRenderRefFooter() + ")");
+        assertTrue(sut.getRenderAppSetup().contains("\"mode\":\"app\""),
+        		"RefFooter rendering: Not rendered as expected. (" + sut.getRenderAppSetup() + ")");
     }
 }

gocwebtemplate-core/gocwebtemplate-core-base/src/test/java/goc/webtemplate/component/abstractcorebeantest/RenderPreFooterTest.java

@@ -6,37 +6,41 @@
 
 import goc.webtemplate.WebAnalyticsInfo;
 
+/**
+ * This contains tests for RenderSetup in relation with the refTop attributes,
+ * see the other RenderXXX classes for further tests.
+ */
 public class RenderRefTopTest {
 
     @Test
     public void testWebAnalyticsRenders() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
-        
+
         sut.setWebAnalytics(new WebAnalyticsInfo(true, WebAnalyticsInfo.EnvironmentOption.STAGING, 1));
-        
-        assertTrue(sut.getRenderRefTop().contains("\"webAnalytics\":[{\"environment\":\"staging\",\"version\":1}]"),
-        		"RefFooter rendering: WebAnalytics not rendered as expected (" + sut.getRenderRefTop() + ").");
-        
-        assertTrue(!sut.getRenderRefTop().contains("custom"),
-        		"RefFooter rendering: WebAnalytics not rendered as expected (" + sut.getRenderRefTop() + ").");
+
+        assertTrue(sut.getRenderSetup().contains("\"webAnalytics\":[{\"environment\":\"staging\",\"version\":1}]"),
+        		"RefFooter rendering: WebAnalytics not rendered as expected (" + sut.getRenderSetup() + ").");
+
+        assertTrue(!sut.getRenderSetup().contains("custom"),
+        		"RefFooter rendering: WebAnalytics not rendered as expected (" + sut.getRenderSetup() + ").");
     }
-    
+
     @Test
     public void testWebAnalyticsVersion3Renders() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
-        
+
         sut.setWebAnalytics(new WebAnalyticsInfo(true, "launch-EN0cf6c2810a2b48f8a4c36502a1b09541.min.js"));
-        
-        assertTrue(sut.getRenderRefTop().contains("\"custom\":\"launch-EN0cf6c2810a2b48f8a4c36502a1b09541.min.js\"}]"),
-        		"RefFooter rendering: WebAnalytics not rendered as expected (" + sut.getRenderRefTop() + ").");
+
+        assertTrue(sut.getRenderSetup().contains("\"custom\":\"launch-EN0cf6c2810a2b48f8a4c36502a1b09541.min.js\"}]"),
+        		"RefFooter rendering: WebAnalytics not rendered as expected (" + sut.getRenderSetup() + ").");
     }
-    
+
     @Test
     public void testWebAnalyticsFromConfig() {
         AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
-        
+
         //(Test test cdn.properties files default WebAnalytics to true)
-        assertTrue(sut.getRenderRefTop().contains("\"webAnalytics\":"),
-        		"RefFooter rendering: WebAnalytics not rendered as expected (" + sut.getRenderRefTop() + ").");
+        assertTrue(sut.getRenderSetup().contains("\"webAnalytics\":"),
+        		"RefFooter rendering: WebAnalytics not rendered as expected (" + sut.getRenderSetup() + ").");
     }
 }

gocwebtemplate-core/gocwebtemplate-core-base/src/test/java/goc/webtemplate/component/abstractcorebeantest/RenderRefFooterTest.java

@@ -7,7 +7,6 @@
 /**
  * This contains tests for RenderSetup in relation with the top-most attributes,
  * see the other RenderXXX classes for further tests.
- *
  */
 public class RenderSetupTest {
     @Test
@@ -72,11 +71,4 @@ public void testRenderSplashSetup() {
         //splash must be present
         assertTrue(json.contains("\"splash\":{"));
     }
-
-    //TODO: Update other tests
-    //TODO: Get rid of RefTop and RefFooter (if no longer used)... and maybe getLocalPath() and other unused functions that were used to build these objects.
-
-    //TODO: Change log
-    //TODO: Remove some Deprecated?
-    //TODO: Test with huge data
 }