Merge pull request DevelopersDelicias#27 from DevelopersDelicias/enha…

…ncement/26-add-prettier-plugin 🎨 DevelopersDelicias#26 Add prettier plugin and format code for all classes
Salonikansal2 · Sep 27, 2023 · 1c12f42 · 1c12f42
2 parents 9788a72 + 88dd782
commit 1c12f42
Show file tree

Hide file tree

Showing 14 changed files with 141 additions and 62 deletions.
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,6 @@
+{
+    "printWidth": 80,
+    "tabWidth": 4,
+    "useTabs": false,
+    "endOfLine": "lf"
+}
diff --git a/pom.xml b/pom.xml
@@ -17,6 +17,7 @@
         <maven-surefire-plugin.version>2.19.1</maven-surefire-plugin.version>
         <maven-failsafe-plugin.version>2.21.0</maven-failsafe-plugin.version>
         <maven-jar-plugin.version>3.1.0</maven-jar-plugin.version>
+        <plugin.prettier.goal>write</plugin.prettier.goal>
     </properties>
     <name>task-timer</name>
     <url>http://maven.apache.org</url>
@@ -202,6 +203,32 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>com.hubspot.maven.plugins</groupId>
+                <artifactId>prettier-maven-plugin</artifactId>
+                <version>0.16</version>
+                <configuration>
+                    <prettierJavaVersion>1.5.0</prettierJavaVersion>
+                    <ignoreConfigFile>false</ignoreConfigFile>
+                    <ignoreEditorConfig>true</ignoreEditorConfig>
+                    <fail>true</fail>
+                    <generateDiff>true</generateDiff>
+                    <!-- Use <inputGlobs> to override the default input patterns -->
+                    <inputGlobs>
+                        <!-- These are the default patterns, you can omit <inputGlobs> entirely unless you want to override them -->
+                        <inputGlob>src/main/java/**/*.java</inputGlob>
+                        <inputGlob>src/test/java/**/*.java</inputGlob>
+                    </inputGlobs>
+                </configuration>
+                <executions>
+                    <execution>
+                        <phase>validate</phase>
+                        <goals>
+                            <goal>${plugin.prettier.goal}</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 </project>
diff --git a/src/main/java/com/developersdelicias/tasktimer/TaskTimerApplication.java b/src/main/java/com/developersdelicias/tasktimer/TaskTimerApplication.java
@@ -1,8 +1,7 @@
 package com.developersdelicias.tasktimer;
 
-import javax.swing.WindowConstants;
-
 import com.developersdelicias.tasktimer.ui.TaskTimerScreen;
+import javax.swing.WindowConstants;
 
 /**
  * This class will be the implementation of the application.
@@ -14,7 +13,7 @@ public final class TaskTimerApplication {
      * Can't be instantiated directly.
      */
     private TaskTimerApplication() {
-
+        // empty constructor
     }
 
     /**

diff --git a/src/main/java/com/developersdelicias/tasktimer/format/BasicTimeFormat.java b/src/main/java/com/developersdelicias/tasktimer/format/BasicTimeFormat.java
@@ -14,7 +14,8 @@ public final String format(final long milliseconds) {
         final long hr = MILLISECONDS.toHours(milliseconds);
         final long min = MILLISECONDS.toMinutes(subtract(milliseconds, hr));
         final long sec = MILLISECONDS.toSeconds(
-                subtract(milliseconds, hr) - MINUTES.toMillis(min));
+            subtract(milliseconds, hr) - MINUTES.toMillis(min)
+        );
         return String.format("%02d:%02d:%02d", hr, min, sec);
     }
 

diff --git a/src/main/java/com/developersdelicias/tasktimer/format/TimeFormat.java b/src/main/java/com/developersdelicias/tasktimer/format/TimeFormat.java
@@ -4,7 +4,6 @@
  * Defines a format for Time elements.
  */
 public interface TimeFormat {
-
     /**
      * Creates a String representation of the current time given the number of
      * milliseconds elapsed.

diff --git a/src/main/java/com/developersdelicias/tasktimer/model/TaskTimer.java b/src/main/java/com/developersdelicias/tasktimer/model/TaskTimer.java
@@ -11,6 +11,7 @@
  * This class will handle the different task timer states.
  */
 public class TaskTimer {
+
     /**
      * A reference to TaskTimerView model object.
      */
@@ -70,13 +71,17 @@ public final void start() {
      */
     private void updateView() {
         timer = new Timer();
-        timer.scheduleAtFixedRate(new TimerTask() {
-            @Override
-            public void run() {
-                elapsedTime = System.currentTimeMillis() - initialTime;
-                view.updateTime(elapsedTime);
-            }
-        }, TIMER_DELAY, TIMER_PERIOD);
+        timer.scheduleAtFixedRate(
+            new TimerTask() {
+                @Override
+                public void run() {
+                    elapsedTime = System.currentTimeMillis() - initialTime;
+                    view.updateTime(elapsedTime);
+                }
+            },
+            TIMER_DELAY,
+            TIMER_PERIOD
+        );
     }
 
     /**
@@ -133,7 +138,6 @@ final boolean isRunning() {
      * @return the actualState as PAUSED.
      */
     final boolean isPaused() {
-
         return actualState == PAUSED;
     }
 

diff --git a/src/main/java/com/developersdelicias/tasktimer/model/TaskTimerAlreadyPausedException.java b/src/main/java/com/developersdelicias/tasktimer/model/TaskTimerAlreadyPausedException.java
@@ -4,4 +4,5 @@
  * Exception for Timer already paused.
  */
 class TaskTimerAlreadyPausedException extends RuntimeException {
+    // empty class
 }
diff --git a/src/main/java/com/developersdelicias/tasktimer/model/TaskTimerAlreadyStartedException.java b/src/main/java/com/developersdelicias/tasktimer/model/TaskTimerAlreadyStartedException.java
@@ -4,4 +4,5 @@
  * Exception for Timer already started.
  */
 class TaskTimerAlreadyStartedException extends RuntimeException {
+    // empty class
 }
diff --git a/src/main/java/com/developersdelicias/tasktimer/model/TaskTimerAlreadyStoppedException.java b/src/main/java/com/developersdelicias/tasktimer/model/TaskTimerAlreadyStoppedException.java
@@ -4,5 +4,5 @@
  * Exception for Timer already stopped.
  */
 class TaskTimerAlreadyStoppedException extends RuntimeException {
-
+    // empty class
 }
diff --git a/src/main/java/com/developersdelicias/tasktimer/model/TaskTimerCannotPlayException.java b/src/main/java/com/developersdelicias/tasktimer/model/TaskTimerCannotPlayException.java
@@ -4,4 +4,5 @@
  * Exception for Timer already paused.
  */
 class TaskTimerCannotPlayException extends RuntimeException {
+    // empty class
 }
diff --git a/src/main/java/com/developersdelicias/tasktimer/ui/TaskTimerScreen.java b/src/main/java/com/developersdelicias/tasktimer/ui/TaskTimerScreen.java
@@ -4,17 +4,18 @@
 import com.developersdelicias.tasktimer.format.TimeFormat;
 import com.developersdelicias.tasktimer.model.TaskTimer;
 import com.developersdelicias.tasktimer.model.TaskTimerView;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
 import javax.swing.JButton;
 import javax.swing.JFrame;
 import javax.swing.JLabel;
 import javax.swing.JOptionPane;
 import javax.swing.JPanel;
 import javax.swing.UIManager;
+import javax.swing.UIManager.LookAndFeelInfo;
 import javax.swing.UnsupportedLookAndFeelException;
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Represents the Main Screen of Task Timer Application.
@@ -155,18 +156,22 @@ private void createButtons() {
      */
     private void lookAndFeel() {
         try {
-            for (UIManager.LookAndFeelInfo info
-                    : UIManager.getInstalledLookAndFeels()) {
-                if ("Windows".equals(info.getName())) {
-                    UIManager.setLookAndFeel(info.getClassName());
+            for (LookAndFeelInfo laf : UIManager.getInstalledLookAndFeels()) {
+                if ("Windows".equals(laf.getName())) {
+                    UIManager.setLookAndFeel(laf.getClassName());
                     break;
                 }
             }
-        } catch (ClassNotFoundException | InstantiationException
-                | IllegalAccessException | UnsupportedLookAndFeelException ex) {
-            final String msg = "Could not apply look and feel style. "
-                    + "Native Style will be used";
-            logger.warn(msg, ex);
+        } catch (
+            ClassNotFoundException
+            | InstantiationException
+            | IllegalAccessException
+            | UnsupportedLookAndFeelException ex
+        ) {
+            logger.warn(
+                "Can't apply look and feel style. Native Style will be used",
+                ex
+            );
         }
     }
 
@@ -188,9 +193,12 @@ public final void startState() {
 
     @Override
     public final boolean shouldStop() {
-        int option = JOptionPane.showConfirmDialog(this,
-                "Are you sure to stop the timer?", "Task Timer",
-                JOptionPane.YES_NO_OPTION);
+        int option = JOptionPane.showConfirmDialog(
+            this,
+            "Are you sure to stop the timer?",
+            "Task Timer",
+            JOptionPane.YES_NO_OPTION
+        );
         return option == JOptionPane.YES_OPTION;
     }
 
@@ -246,8 +254,10 @@ public void actionPerformed(final ActionEvent e) {
      */
     private String askTaskDescription() {
         return JOptionPane.showInputDialog(
-                null, "Enter task description",
-                "Create Task", JOptionPane.INFORMATION_MESSAGE
+            null,
+            "Enter task description",
+            "Create Task",
+            JOptionPane.INFORMATION_MESSAGE
         );
     }
 

diff --git a/src/test/java/com/developersdelicias/tasktimer/format/BasicTimeFormatTest.java b/src/test/java/com/developersdelicias/tasktimer/format/BasicTimeFormatTest.java
@@ -1,13 +1,13 @@
 package com.developersdelicias.tasktimer.format;
 
+import static org.hamcrest.core.Is.is;
+import static org.junit.Assert.assertThat;
 
 import junitparams.JUnitParamsRunner;
 import junitparams.Parameters;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import static org.hamcrest.core.Is.is;
-import static org.junit.Assert.assertThat;
 
 @RunWith(JUnitParamsRunner.class)
 public class BasicTimeFormatTest {
@@ -20,8 +20,18 @@ public void setUp() {
     }
 
     @Test
-    @Parameters({"1000, 00:00:01", "2000, 00:00:02", "60000, 00:01:00", "3600000, 01:00:00"})
-    public void should_format_using_hh_mm_ss_format(int milliseconds, String expected) {
+    @Parameters(
+        {
+            "1000, 00:00:01",
+            "2000, 00:00:02",
+            "60000, 00:01:00",
+            "3600000, 01:00:00",
+        }
+    )
+    public void should_format_using_hh_mm_ss_format(
+        int milliseconds,
+        String expected
+    ) {
         assertThat(format.format(milliseconds), is(expected));
     }
 }
diff --git a/src/test/java/com/developersdelicias/tasktimer/model/TaskTimerTest.java b/src/test/java/com/developersdelicias/tasktimer/model/TaskTimerTest.java
@@ -1,7 +1,5 @@
 package com.developersdelicias.tasktimer.model;
 
-import org.junit.Before;
-import org.junit.Test;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 import static org.mockito.Mockito.anyLong;
@@ -10,6 +8,9 @@
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
+import org.junit.Before;
+import org.junit.Test;
+
 public class TaskTimerTest {
 
     private TaskTimer taskTimer;
@@ -102,4 +103,4 @@ public void should_throw_cannot_play_exception() {
     public void should_throw_cannot_play_exception_by_default() {
         taskTimer.play();
     }
-}
+}