Issue 393 Notification Pattern #1912

NatalieSty · 2021-11-17T10:08:36Z

Add Notification pattern (issue pattern #393）
A Notification is an object that collects information about errors during validation of data. When an error appears the Notification is sent back to the view to display further information about the errors.

Pull request description

included Junit tests with 100% coverage
ReadMe.md, UML diagram included

…ster for a course. This a working version of the app.

iluwatar · 2021-11-28T05:15:54Z

notification/README.md

+categories: Behavioural
+language: en
+tags:
+- Notification


For tags, I would put Decoupling and Presentation

Please remove the tag Notification

iluwatar · 2021-11-28T05:21:37Z

notification/pom.xml

+    <properties>
+        <maven.compiler.source>17</maven.compiler.source>
+        <maven.compiler.target>17</maven.compiler.target>
+    </properties>


I don't think these are needed. We use Java 11 language level for the whole project.

notification/pom.xml

iluwatar · 2021-11-28T05:24:16Z

notification/src/main/java/com/iluwatar/notification/App.java

+/**
+* With the DAO pattern, we can use various method calls to
+* retrieve/add/delete/update data without directly interacting
+* with the data source. The below example demonstrates basic CRUD
+* operations: select, add, update, and delete.
+*/


The text seems to be copied from another pattern. Please update it to introduce the notification pattern briefly and describe how the example code implements it.

iluwatar · 2021-11-28T05:27:41Z

notification/src/main/java/com/iluwatar/notification/App.java

+  /**
+   * This is not called.
+   */


Instead, please describe the class

iluwatar · 2021-11-28T05:29:56Z

notification/src/main/java/com/iluwatar/notification/App.java

+    final String courseId = "CSE427";
+    final String semester = "Fall21";
+    final String department = "Engineering";
+    final FormRegisterCourse form = new FormRegisterCourse(courseId, semester, department);
+    form.submit();


It's possible to use local variable type inference (keyword var) here. Additionally, it would be nice to have some comments that describe what happens. This is an example code for others to read, after all.

iluwatar · 2021-11-28T05:31:58Z

notification/src/main/java/com/iluwatar/notification/DataTransferObject.java

+  /**
+  * Get a Notification object.
+  *
+  * @return Notification object.
+  */
+  public Notification getNotification() {
+    return notification;
+  }


Use Lombok to get rid of boilerplate code

Please check this throughout the code

iluwatar · 2021-11-28T05:34:08Z

notification/src/main/java/com/iluwatar/notification/Error.java

@@ -0,0 +1,23 @@
+package com.iluwatar.notification;
+
+public class Error {


It's good practice to provide Javadoc for each class

Error as a name can be a little bit too generic. Please consider alternatives.

iluwatar · 2021-11-28T05:37:04Z

notification/src/main/java/com/iluwatar/notification/FormRegisterCourse.java

+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
+public class FormRegisterCourse {


I find the name a little strange. Wouldn't RegisterCourseForm sound better?

iluwatar · 2021-11-28T05:44:17Z

notification/src/test/java/com/iluwatar/notification/CourseServiceTest.java

+    @Test
+    void testCourseServiceTest() {
+        RegisterCourseDto registerDTO = new RegisterCourseDto();
+        registerDTO.setDepartment("English");
+        registerDTO.setCourseId("CS444");
+        registerDTO.setSemester("Fall21");
+        CourseService course = new CourseService();
+        Boolean isRegistered = course.registerCourse(registerDTO);
+        assertTrue(isRegistered);
+    }


This probably tests that the happy scenario for registering for a course succeeds. The naming of the test could be better. Additionally, there should be more tests that check the negative cases (course registration does not succeed).

NatalieSty · 2021-11-30T08:15:54Z

@iluwatar thanks for the comments. I have made some changes and committed the change

sonarcloud · 2021-12-05T11:14:23Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
22 Code Smells

98.1% Coverage
0.0% Duplication

iluwatar · 2021-12-11T15:14:47Z

abstract-factory/README.md

@@ -210,7 +210,7 @@ Example use cases

 ## Consequences

-* Dependency injection in java hides the service class dependencies that can lead to runtime errors that would have been caught at compile time.
+* Dependency injection in java hides the service class dependencies that can lead to runtime notificationErrors that would have been caught at compile time.


It seems that some text has been accidentally replaced in many other patterns. Please revert the changes.

iluwatar · 2021-12-11T15:16:18Z

notification/README.md

+categories: Behavioural
+language: en
+tags:
+- Notification


Please remove the tag Notification

iluwatar · 2021-12-11T15:18:25Z

notification/README.md

+
+## Intent
+
+A Notification is an object that collects information about notificationErrors during validation of data. When an notificationError appears the Notification is sent back to the view to display further information about the notificationErrors.


Suggested change

A Notification is an object that collects information about notificationErrors during validation of data. When an notificationError appears the Notification is sent back to the view to display further information about the notificationErrors.

Notification is an object that collects information about notification errors during the validation of data. When a notification error appears, the notification is sent back to the view to display further information about the notification errors.

iluwatar · 2021-12-11T15:19:58Z

notification/README.md

+> There's a form to register for a course. We need to validate the inputs to make sure 
+> the inputs are valid.


Please use passive voice (see https://www.grammarly.com/blog/passive-voice/)

iluwatar · 2021-12-11T15:21:06Z

notification/README.md

+
+In plain words
+
+> An object that collects together information about notificationErrors and other information and communicates it to the presentation.


Suggested change

> An object that collects together information about notificationErrors and other information and communicates it to the presentation.

> Notification is an object that collects together information about notification errors and communicates it to the presentation layer.

Natalie So and others added 18 commits October 31, 2021 22:33

added notification module

9e7e374

added classes for notification, DTO, and registerCourseDTO

54ed441

added App.java, RegisterCourse.java, ServerCommand.java

533e98c

added Error.java, implemented validate in RegisterCourse.java

0f8a8fd

Added Error.java, ErrorProvider.java, FormRegisterCourse.java to regi…

69308c1

…ster for a course. This a working version of the app.

Create README.md

4a969f8

added Test files

d355085

cleaning up

00f9cba

Added Logger

bcf73fb

Added NotificationTest

f474a0c

Added test for formregistercourse

01a6ee1

Merge branch 'iluwatar:master' into issue-393

c98ddf1

changed snapshot in pom

3c13b27

added comments to public methods

44a8f4c

added UML diagram

35d075c

added UML diagram

601e54b

Added test for formregistercourse

adf04a3

tests and clean up

b00c8fa

NatalieSty closed this Nov 17, 2021

NatalieSty reopened this Nov 17, 2021

Natalie So added 2 commits November 17, 2021 14:43

correct indentations

cddb232

correct inaccording to checkstyle

3e5f574

iluwatar requested changes Nov 28, 2021

View reviewed changes

iluwatar self-assigned this Nov 28, 2021

iluwatar added the status: under review label Nov 28, 2021

change according to PR comments

5b7a5a5

Natalie So added 3 commits November 30, 2021 13:48

change according to checkstyle

3343c2d

change according to checkstyle

452aa12

change according to PMD

5bd6aaf

Natalie So and others added 6 commits December 2, 2021 22:39

change according to PMD

a25dd89

change according to PMD

e802f46

change according to checkstyle

65e8db2

change according to checkstyle

079b77f

change according to PMD

f069e77

change according to checkstyle

a204cc4

dctrue2 mentioned this pull request Dec 5, 2021

Added application-controller pattern (#346) #1917

Closed

iluwatar requested changes Dec 11, 2021

View reviewed changes

iluwatar added the status: stale issues and pull requests that have not had recent interaction label Sep 21, 2022

iluwatar added this to the 1.26.0 milestone Sep 21, 2022

iluwatar closed this Sep 21, 2022

sugan0tech mentioned this pull request Oct 10, 2023

#392 added Notification Pattern #2629

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue 393 Notification Pattern #1912

Issue 393 Notification Pattern #1912

NatalieSty commented Nov 17, 2021

iluwatar Nov 28, 2021

iluwatar Dec 11, 2021

iluwatar Nov 28, 2021

iluwatar Nov 28, 2021

iluwatar Nov 28, 2021

iluwatar Nov 28, 2021

iluwatar Nov 28, 2021

iluwatar Nov 28, 2021

iluwatar Nov 28, 2021

iluwatar Nov 28, 2021

iluwatar Nov 28, 2021

iluwatar Nov 28, 2021

NatalieSty commented Nov 30, 2021

sonarcloud bot commented Dec 5, 2021

iluwatar Dec 11, 2021

iluwatar Dec 11, 2021

iluwatar Dec 11, 2021

iluwatar Dec 11, 2021

iluwatar Dec 11, 2021

		@@ -0,0 +1,23 @@
		package com.iluwatar.notification;

		public class Error {


		## Intent

		A Notification is an object that collects information about notificationErrors during validation of data. When an notificationError appears the Notification is sent back to the view to display further information about the notificationErrors.

	A Notification is an object that collects information about notificationErrors during validation of data. When an notificationError appears the Notification is sent back to the view to display further information about the notificationErrors.
	Notification is an object that collects information about notification errors during the validation of data. When a notification error appears, the notification is sent back to the view to display further information about the notification errors.

		> There's a form to register for a course. We need to validate the inputs to make sure
		> the inputs are valid.


		In plain words

		> An object that collects together information about notificationErrors and other information and communicates it to the presentation.

	> An object that collects together information about notificationErrors and other information and communicates it to the presentation.
	> Notification is an object that collects together information about notification errors and communicates it to the presentation layer.

Issue 393 Notification Pattern #1912

Issue 393 Notification Pattern #1912

Conversation

NatalieSty commented Nov 17, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NatalieSty commented Nov 30, 2021

sonarcloud bot commented Dec 5, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment