Adding contributors section (#82)

ahmad-shahid · web-flow · commit 7f95e1a0ac06 · 2025-09-08T14:35:16.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ## v4.0.5
 
 - [CDTS](https://github.com/wet-boew/cdts-sgdc/) v5.0.5 & [wet-boew](https://github.com/wet-boew/wet-boew) v4.0.89
+- Adding a Contributors pattern allowing users to highlight departments that have contributed to the content of the page. Please visit the sample pages for all the details.
 - Adding an optional languagePrecedence property for Splash page allowing users to decide the order of official languages
 - Updated static fallback files
 
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/AbstractCoreBean.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/AbstractCoreBean.java
@@ -122,6 +122,7 @@ private enum Themes { GCWEB, GCINTRANET }
     private Date dateModified = null;
     private String screenIdentifier = "";
     private String versionIdentifier = "";
+    private List<Link> contributors = null;
     private boolean showSearch = Boolean.parseBoolean(this.getResourceBundleString("cdn", "goc.webtemplate.showsearch"));
     private boolean showPreContent = Boolean.parseBoolean(this.getResourceBundleString("cdn", "goc.webtemplate.showprecontent"));
     private boolean showPostContent = Boolean.parseBoolean(this.getResourceBundleString("cdn", "goc.webtemplate.showpostcontent"));
@@ -1158,6 +1159,21 @@ public void setScreenIdentifier(String value) {
         this.screenIdentifier = value;
     }
 
+    /**
+     * Returns the list of contributors, null if no list is currently specified.
+     */
+    public List<Link> getContributors() {
+        this.initializeOnce();
+        return this.contributors;
+    }
+
+    /**
+     * Sets the list of contributors to the specified value.
+     */
+    public void setContributors(List<Link> value) {
+        this.contributors = value;
+    }
+
     /**
      * Returns the configuration object containing the various session timeout settings.
      *
@@ -2096,7 +2112,8 @@ private IPreFooter buildPreFooter(boolean isTransactional, boolean isUnilingualE
                         this.showPostContent,
                         buildFeedback(this.getFeedbackLink()),
                         new ShareList(this.showSharePageLink, this.sharePageMediaSites),
-                        JsonValueUtils.getNonEmptyString(this.getScreenIdentifier())
+                        JsonValueUtils.getNonEmptyString(this.getScreenIdentifier()),
+                        this.contributors
                       );
             } else { //(isUnilingualError)
                 return new UnilingualErrorPreFooter(null, false);
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/jsonentities/PreFooter.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/jsonentities/PreFooter.java
@@ -1,9 +1,12 @@
 package goc.webtemplate.component.jsonentities;
 
 import java.io.Serializable;
+import java.util.List;
 
 import com.google.gson.annotations.JsonAdapter;
 
+import goc.webtemplate.Link;
+
 /**
  * Objects of this class are meant to be serialized to a JSON object to be passed
  * as parameter to the 'wet.builder.preFooter' JavaScript function in the template
@@ -24,20 +27,27 @@ public class PreFooter implements Serializable, IPreFooter {
     private ShareList           showShare;
 
     private String              screenIdentifier;
+    private List<Link>          contributors;
 
 
     public PreFooter() {
     }
 
     public PreFooter(String cdnEnv, String versionIdentifier, String dateModified, boolean showPostContent,
             Feedback showFeedback, ShareList showShare, String screenIdentifier) {
+        this(cdnEnv, versionIdentifier, dateModified, showPostContent, showFeedback, showShare, screenIdentifier, null);
+    }
+
+    public PreFooter(String cdnEnv, String versionIdentifier, String dateModified, boolean showPostContent,
+            Feedback showFeedback, ShareList showShare, String screenIdentifier, List<Link> contributors) {
         this.cdnEnv = cdnEnv;
         this.versionIdentifier = versionIdentifier;
         this.dateModified = dateModified;
         this.showPostContent = showPostContent;
         this.showFeedback = showFeedback;
         this.showShare = showShare;
         this.screenIdentifier = screenIdentifier;
+        this.contributors = contributors;
     }
 
     public String getCdnEnv() {
@@ -95,4 +105,12 @@ public String getScreenIdentifier() {
     public void setScreenIdentifier(String screenIdentifier) {
         this.screenIdentifier = screenIdentifier;
     }
+
+    public List<Link> getContributors() {
+        return contributors;
+    }
+
+    public void setContributors(List<Link> contributors) {
+        this.contributors = contributors;
+    }
 }
diff --git a/gocwebtemplate-core/gocwebtemplate-core-base/src/test/java/goc/webtemplate/component/abstractcorebeantest/RenderPreFooterTest.java b/gocwebtemplate-core/gocwebtemplate-core-base/src/test/java/goc/webtemplate/component/abstractcorebeantest/RenderPreFooterTest.java
@@ -7,6 +7,7 @@
 import org.junit.jupiter.api.Test;
 import goc.webtemplate.Constants;
 import goc.webtemplate.FeedbackLink;
+import goc.webtemplate.Link;
 
 /**
  * This contains tests for RenderSetup in relation with the preFooter attributes,
@@ -49,4 +50,18 @@ public void testRenderFeedback() {
         assertTrue(sut.getRenderSetup().contains("\"showFeedback\":{\"enabled\":true,\"href\":\"http://www.google.ca\",\"text\":\"Contact\",\"theme\":\"Theme\",\"section\":\"Section\"}"),
                 "PreFooter rendering: Not rendered as expected. (" + sut.getRenderSetup() + ")");
     }
+
+    @Test
+    public void testRenderContributors() {
+        AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
+
+        List<Link> contributors = new ArrayList<Link>();
+        Link link = new Link("https://esdc.prv", "ESDC");
+        contributors.add(link);
+
+        sut.setContributors(contributors);
+
+        assertTrue(sut.getRenderSetup().contains("\"contributors\":[{\"href\":\"https://esdc.prv\",\"text\":\"ESDC\"}]"),
+                "PreFooter rendering: Not rendered as expected. (" + sut.getRenderSetup() + ")");
+    }
 }
diff --git a/gocwebtemplate-sample-jsp/src/main/java/goc/webtemplate/jsp/samplebeans/FeedbackAndShareThisPageSampleBean.java b/gocwebtemplate-sample-jsp/src/main/java/goc/webtemplate/jsp/samplebeans/FeedbackAndShareThisPageSampleBean.java
@@ -5,6 +5,7 @@
 
 import goc.webtemplate.Constants;
 import goc.webtemplate.FeedbackLink;
+import goc.webtemplate.Link;
 import goc.webtemplate.component.jsp.DefaultTemplateCoreBean;
 
 public class FeedbackAndShareThisPageSampleBean extends DefaultTemplateCoreBean {
@@ -26,10 +27,15 @@ public void onWebTemplateInitialize() {
         feedbackLink.setTheme("Theme");
         feedbackLink.setSection("Section");
 
+        List<Link> contributors = new ArrayList<Link>();
+        Link link = new Link("https://esdc.prv", "ESDC");
+        contributors.add(link);
+
         this.setFeedbackLink(feedbackLink);
         this.setShowSharePageLink(true);
         this.getSharePageMediaSites().add(Constants.SocialMediaSites.blogger);
         this.getSharePageMediaSites().add(Constants.SocialMediaSites.facebook);
         this.getSharePageMediaSites().add(Constants.SocialMediaSites.twitter);
+        this.setContributors(contributors);
     }
 }
diff --git a/gocwebtemplate-sample-jsp/src/main/webapp/samplecontents/feedbackandsharethispagesamplecontent.jsp b/gocwebtemplate-sample-jsp/src/main/webapp/samplecontents/feedbackandsharethispagesamplecontent.jsp
@@ -85,4 +85,21 @@ public void onWebTemplateInitialize() {
 } 
     </pre>
 </div>
+<h2>Contributors</h2>
+<p>The contributors pattern is a way for the users to pattern to highlight institutions/organizations that have contributed to the content on a webpage.</p>
+<p>Set programmatically via the <code class="wb-prettify">setContributors</code> method in your custom bean class.</p>
+<div class="wb-prettify all-pre lang-vb linenums">
+    <pre>
+@Override
+public void onWebTemplateInitialize() {
+//...
+    List&lt;Link&gt; contributors = new ArrayList&lt;Link&gt;();
+    Link link = new Link("https://esdc.prv", "ESDC");
+    contributors.add(link);
+
+    this.setContributors(contributors);
+//...
+}
+    </pre>
+</div>
 <%@ include file="_sampleslist.jsp" %>
diff --git a/gocwebtemplate-sample-spring/src/main/java/goc/webtemplate/spring/samplebeans/FeedbackAndShareThisPageSampleBean.java b/gocwebtemplate-sample-spring/src/main/java/goc/webtemplate/spring/samplebeans/FeedbackAndShareThisPageSampleBean.java
@@ -7,6 +7,7 @@
 
 import goc.webtemplate.Constants;
 import goc.webtemplate.FeedbackLink;
+import goc.webtemplate.Link;
 import goc.webtemplate.component.spring.DefaultTemplateCoreBean;
 
 @Component(value = "feedbackandsharethispagesamplebean")
@@ -29,10 +30,15 @@ public void onWebTemplateInitialize() {
         feedbackLink.setTheme("Theme");
         feedbackLink.setSection("Section");
 
+        List<Link> contributors = new ArrayList<Link>();
+        Link link = new Link("https://esdc.prv", "ESDC");
+        contributors.add(link);
+
         this.setFeedbackLink(feedbackLink);
         this.setShowSharePageLink(true);
         this.getSharePageMediaSites().add(Constants.SocialMediaSites.blogger);
         this.getSharePageMediaSites().add(Constants.SocialMediaSites.facebook);
         this.getSharePageMediaSites().add(Constants.SocialMediaSites.twitter);
+        this.setContributors(contributors);
     }
 }
diff --git a/gocwebtemplate-sample-spring/src/main/resources/samples/FeedbackAndShareThisPageSample.html b/gocwebtemplate-sample-spring/src/main/resources/samples/FeedbackAndShareThisPageSample.html
@@ -88,6 +88,23 @@ <h2>Share This Page Link</h2>
 } 
 	        </pre>
 	    </div>
+	    <h2>Contributors</h2>
+	    <p>The contributors pattern is a way for the users to pattern to highlight institutions/organizations that have contributed to the content on a webpage.</p>
+	    <p>Set programmatically via the <code class="wb-prettify">setContributors</code> method in your custom bean class.</p>
+	    <div class="wb-prettify all-pre lang-vb linenums">
+	        <pre>
+@Override
+public void onWebTemplateInitialize() {
+//...
+    List&lt;Link&gt; contributors = new ArrayList&lt;Link&gt;();
+    Link link = new Link("https://esdc.prv", "ESDC");
+    contributors.add(link);
+
+    this.setContributors(contributors);
+//...
+}
+	        </pre>
+	    </div>
 
 	<div th:replace="_samplelist :: samplelist"></div>
 </section> 
