Review comments addressed

Improvements after review comments incorporated

config/pmd/custom-ruleset.xml

@@ -48,12 +48,4 @@
     </properties>
   </rule>
   <!--  END CODE DOCUMENTATION -->
-
-  <!-- DESIGN -->
-  <rule ref="rulesets/design.xml/ExcessiveParameterList">
-    <properties>
-      <property name="maxParameters" value="10"/>
-    </properties>
-  </rule>
-  <!-- END CODE DESIGN -->
 </ruleset>

src/main/java/com/wcc/platform/controller/ProgrammeController.java

@@ -29,7 +29,7 @@ public ProgrammeController(final ProgrammeService programmeService) {
   @Operation(summary = "API to retrieve programme page")
   @ResponseStatus(HttpStatus.OK)
   public ResponseEntity<ProgrammePage> getProgramme(
-      @RequestParam(required = false, name = "type") final ProgramType programmeType) {
+      @RequestParam(name = "type") final ProgramType programmeType) {
     return ResponseEntity.ok(service.getProgramme(programmeType));
   }
 }

src/main/java/com/wcc/platform/domain/platform/Event.java

@@ -10,6 +10,7 @@
 import lombok.Builder;
 import lombok.Data;
 
+/** Event class with all the relevant attributes for an event. */
 @Data
 @Builder
 public class Event {
@@ -26,6 +27,8 @@ public class Event {
   private SimpleLink eventLink;
   private List<EventResource> eventResources;
 
+  /** Event builder. */
+  @SuppressWarnings("PMD.ExcessiveParameterList")
   public Event(
       final UUID id,
       final String title,

src/main/java/com/wcc/platform/domain/platform/EventSection.java

@@ -5,13 +5,21 @@
 import lombok.Builder;
 import lombok.Data;
 
+/** EventSection representing list of events {@link Event}. */
 @Data
 @Builder
 public class EventSection {
   private String title;
   private SimpleLink link;
   private List<Event> events;
 
+  /**
+   * Builder for the EventSection.
+   *
+   * @param title like - "Upcoming Events" or "Past Events"
+   * @param link link to the Events page
+   * @param events list of events to show
+   */
   public EventSection(final String title, final SimpleLink link, final List<Event> events) {
     this.title = title;
     this.link = link;

src/main/java/com/wcc/platform/domain/platform/Programme.java

@@ -4,6 +4,7 @@
 import lombok.Builder;
 import lombok.Data;
 
+/** Programme class representing the structure of any programme section of a programme page. */
 @Data
 @Builder
 public class Programme {
@@ -14,6 +15,13 @@ public class Programme {
 
   private Card card;
 
+  /**
+   * Programme Builder.
+   *
+   * @param title like - heading of the programme
+   * @param description details co-relating the title
+   * @param card if any details to be represented in a card
+   */
   public Programme(final String title, final String description, final Card card) {
     this.title = title;
     this.description = description;

src/main/java/com/wcc/platform/service/CmsService.java

@@ -19,6 +19,7 @@
 import org.springframework.stereotype.Service;
 
 /** CMS service responsible for simple pages. */
+@SuppressWarnings("PMD.TooManyStaticImports")
 @Service
 public class CmsService {
   private final ObjectMapper objectMapper;

src/test/java/com/wcc/platform/domain/platform/EventSectionTest.java

@@ -0,0 +1,47 @@
+package com.wcc.platform.domain.platform;
+
+import static com.wcc.platform.factories.SetupEventFactories.createEventSection;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import com.wcc.platform.domain.cms.attributes.ProgramType;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+/** Test class for the class {@link EventSection}. */
+class EventSectionTest {
+
+  EventSection testEventSection;
+
+  @BeforeEach
+  void setup() {
+    testEventSection = createEventSection();
+  }
+
+  @Test
+  void testEquals() {
+    assertEquals(testEventSection, createEventSection(ProgramType.BOOK_CLUB));
+  }
+
+  @Test
+  void testNotEquals() {
+    assertNotEquals(testEventSection, createEventSection(ProgramType.TECH_TALK));
+  }
+
+  @Test
+  void testHashCode() {
+    assertEquals(testEventSection.hashCode(), createEventSection(ProgramType.BOOK_CLUB).hashCode());
+  }
+
+  @Test
+  void testHashCodeNotEquals() {
+    assertNotEquals(
+        testEventSection.hashCode(), createEventSection(ProgramType.TECH_TALK).hashCode());
+  }
+
+  @Test
+  void testToString() {
+    assertTrue(testEventSection.toString().contains(ProgramType.BOOK_CLUB.toString()));
+  }
+}

src/test/java/com/wcc/platform/domain/platform/EventTest.java

@@ -0,0 +1,50 @@
+package com.wcc.platform.domain.platform;
+
+import static com.wcc.platform.factories.SetupEventFactories.createEventTest;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import com.wcc.platform.domain.cms.attributes.ProgramType;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+/** Test class for the class {@link Event}. */
+class EventTest {
+
+  Event testEvent;
+
+  @BeforeEach
+  void setup() {
+    testEvent = createEventTest();
+  }
+
+  @Test
+  void testEqual() {
+    assertEquals(testEvent, createEventTest(ProgramType.BOOK_CLUB));
+  }
+
+  @Test
+  void testNotEqual() {
+    assertNotEquals(testEvent, createEventTest(ProgramType.TECH_TALK));
+    assertNotEquals(testEvent, createEventTest(ProgramType.WRITING_CLUB));
+    assertNotEquals(
+        createEventTest(ProgramType.WRITING_CLUB), createEventTest(ProgramType.TECH_TALK));
+  }
+
+  @Test
+  void testHashCode() {
+    assertEquals(testEvent.hashCode(), createEventTest(ProgramType.BOOK_CLUB).hashCode());
+  }
+
+  @Test
+  void testHashCodeNotEquals() {
+    assertNotEquals(testEvent.hashCode(), createEventTest(ProgramType.WRITING_CLUB).hashCode());
+  }
+
+  @Test
+  void testToString() {
+    assertTrue(testEvent.toString().contains(ProgramType.BOOK_CLUB.toString()));
+    assertTrue(testEvent.toString().contains(ProgramType.BOOK_CLUB.toString()));
+  }
+}

src/test/java/com/wcc/platform/domain/platform/MemberTest.java

@@ -8,6 +8,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+/** Test for class {@link Member} */
 class MemberTest {
 
   private Member member;

src/test/java/com/wcc/platform/domain/platform/ProgrammeTest.java

@@ -10,7 +10,8 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
-public class ProgrammeTest {
+/** Test class for {@link Programme}. */
+class ProgrammeTest {
 
   Programme testProgramme;
 

src/test/java/com/wcc/platform/factories/SetupEventFactories.java

@@ -10,6 +10,7 @@
 import com.wcc.platform.domain.cms.attributes.SimpleLink;
 import com.wcc.platform.domain.cms.pages.EventsPage;
 import com.wcc.platform.domain.platform.Event;
+import com.wcc.platform.domain.platform.EventSection;
 import com.wcc.platform.utils.FileUtil;
 import java.util.Collections;
 import java.util.List;
@@ -51,4 +52,30 @@ public static EventsPage createEventPageTest(final List<Event> events) {
     var hero = new HeroSection("title", "event description", createImageTest());
     return new EventsPage(events, hero, createContactTest());
   }
+
+  /**
+   * Create an EventSection object with test data.
+   *
+   * @return EventSection object
+   */
+  public static EventSection createEventSection() {
+    return EventSection.builder()
+        .title("Upcoming Events")
+        .link(new SimpleLink("view events", "/events"))
+        .events(Collections.singletonList(createEventTest()))
+        .build();
+  }
+
+  /**
+   * Create an EventSection object with test data.
+   *
+   * @return EventSection object
+   */
+  public static EventSection createEventSection(final ProgramType programType) {
+    return EventSection.builder()
+        .title("Upcoming Events")
+        .link(new SimpleLink("view events", "/events"))
+        .events(Collections.singletonList(createEventTest(programType)))
+        .build();
+  }
 }

src/test/java/com/wcc/platform/factories/SetupProgrammeFactories.java

@@ -1,6 +1,6 @@
 package com.wcc.platform.factories;
 
-import static com.wcc.platform.factories.SetupEventFactories.createEventTest;
+import static com.wcc.platform.factories.SetupEventFactories.createEventSection;
 import static com.wcc.platform.factories.SetupFactories.OBJECT_MAPPER;
 import static com.wcc.platform.factories.SetupFactories.createContactTest;
 import static com.wcc.platform.factories.SetupFactories.createPageTest;
@@ -10,7 +10,6 @@
 import com.wcc.platform.domain.cms.attributes.ProgramType;
 import com.wcc.platform.domain.cms.attributes.SimpleLink;
 import com.wcc.platform.domain.cms.pages.programme.ProgrammePage;
-import com.wcc.platform.domain.platform.EventSection;
 import com.wcc.platform.domain.platform.Programme;
 import com.wcc.platform.utils.FileUtil;
 import java.util.Collections;
@@ -84,17 +83,4 @@ public static Programme createProgrammeWithoutCard() {
         .description("Every month we vote we read a book this is current month book.")
         .build();
   }
-
-  /**
-   * Create an EventSection object with test data.
-   *
-   * @return EventSection object
-   */
-  public static EventSection createEventSection() {
-    return EventSection.builder()
-        .title("Upcoming Events")
-        .link(new SimpleLink("view events", "/events"))
-        .events(Collections.singletonList(createEventTest()))
-        .build();
-  }
 }

src/test/java/com/wcc/platform/service/ProgrammeServiceTest.java

@@ -17,7 +17,7 @@
 import org.mockito.Mockito;
 
 /** Test class for ProgrammeService. */
-public class ProgrammeServiceTest {
+class ProgrammeServiceTest {
   private ObjectMapper objectMapper;
   private ProgrammeService service;