From 524912b5381149e55ab976b092f5ee6e8e1b24f1 Mon Sep 17 00:00:00 2001
From: Abhishek Malvadkar <abhi@dev.com>
Date: Sun, 9 Mar 2025 12:33:29 +0530
Subject: [PATCH 1/4] GH-1 : Refactored pom file and created StringUtils along
 with basic functions and unit test for them

---
 pom.xml                                       | 82 +++++++++++++------
 .../utils/AmCommonsUtilsApplication.java      | 13 ---
 .../utils/constants/StringConstants.java      | 11 +++
 .../exceptions/InvalidStringException.java    | 10 +++
 .../commons/utils/string/StringUtils.java     | 71 ++++++++++++++++
 src/main/resources/application.properties     |  1 -
 .../utils/AmCommonsUtilsApplicationTests.java | 13 ---
 .../commons/utils/string/StringUtilsTest.java | 59 +++++++++++++
 src/test/java/common/AbstractUnitTest.java    |  7 ++
 9 files changed, 214 insertions(+), 53 deletions(-)
 delete mode 100644 src/main/java/com/amalvadkar/commons/utils/AmCommonsUtilsApplication.java
 create mode 100644 src/main/java/com/amalvadkar/commons/utils/constants/StringConstants.java
 create mode 100644 src/main/java/com/amalvadkar/commons/utils/exceptions/InvalidStringException.java
 create mode 100644 src/main/java/com/amalvadkar/commons/utils/string/StringUtils.java
 delete mode 100644 src/main/resources/application.properties
 delete mode 100644 src/test/java/com/amalvadkar/commons/utils/AmCommonsUtilsApplicationTests.java
 create mode 100644 src/test/java/com/amalvadkar/commons/utils/string/StringUtilsTest.java
 create mode 100644 src/test/java/common/AbstractUnitTest.java

diff --git a/pom.xml b/pom.xml
index 32ad84d..a4ec15f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -2,51 +2,81 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
-	<parent>
-		<groupId>org.springframework.boot</groupId>
-		<artifactId>spring-boot-starter-parent</artifactId>
-		<version>3.4.3</version>
-		<relativePath/> <!-- lookup parent from repository -->
-	</parent>
+
 	<groupId>com.amalvadkar</groupId>
 	<artifactId>am-commons-utils</artifactId>
 	<version>0.0.1-SNAPSHOT</version>
+	<packaging>jar</packaging>
 	<name>am-commons-utils</name>
-	<description>Common Utilities</description>
-	<url/>
-	<licenses>
-		<license/>
-	</licenses>
-	<developers>
-		<developer/>
-	</developers>
-	<scm>
-		<connection/>
-		<developerConnection/>
-		<tag/>
-		<url/>
-	</scm>
+	<description>Common Utility Library</description>
+
 	<properties>
+		<!-- Dependency versions management -->
 		<java.version>21</java.version>
+		<junit-jupiter.version>5.10.2</junit-jupiter.version>
+		<assertj-core.version>3.25.3</assertj-core.version>
+
+		<!-- Plugin versions management -->
+		<maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
+		<maven-surefire-plugin.version>3.1.2</maven-surefire-plugin.version>
 	</properties>
+
 	<dependencies>
+		<!-- JUnit 5 API for writing tests -->
+		<dependency>
+			<groupId>org.junit.jupiter</groupId>
+			<artifactId>junit-jupiter-api</artifactId>
+			<version>${junit-jupiter.version}</version>
+			<scope>test</scope>
+		</dependency>
+
+		<!-- JUnit 5 Engine for running tests -->
 		<dependency>
-			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter</artifactId>
+			<groupId>org.junit.jupiter</groupId>
+			<artifactId>junit-jupiter-engine</artifactId>
+			<version>${junit-jupiter.version}</version>
+			<scope>test</scope>
 		</dependency>
 
+		<!-- AssertJ for fluent assertions -->
 		<dependency>
-			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-test</artifactId>
+			<groupId>org.assertj</groupId>
+			<artifactId>assertj-core</artifactId>
+			<version>${assertj-core.version}</version>
 			<scope>test</scope>
 		</dependency>
+
 	</dependencies>
 
 	<build>
+		<finalName>${project.artifactId}</finalName>
 		<plugins>
+			<!-- Compiler Plugin to Ensure Java 21 Compatibility -->
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-compiler-plugin</artifactId>
+				<version>${maven-compiler-plugin.version}</version>
+				<configuration>
+					<source>${java.version}</source>
+					<target>${java.version}</target>
+				</configuration>
+			</plugin>
+
+			<!-- JAR Plugin for Packaging the Library -->
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-jar-plugin</artifactId>
+				<version>3.2.2</version>
+			</plugin>
+
+			<!-- Surefire Plugin for Running JUnit 5 Tests -->
 			<plugin>
-				<groupId>org.springframework.boot</groupId>
-				<artifactId>spring-boot-maven-plugin</artifactId>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-surefire-plugin</artifactId>
+				<version>${maven-surefire-plugin.version}</version>
+				<configuration>
+					<useModulePath>false</useModulePath>
+				</configuration>
 			</plugin>
 		</plugins>
 	</build>
diff --git a/src/main/java/com/amalvadkar/commons/utils/AmCommonsUtilsApplication.java b/src/main/java/com/amalvadkar/commons/utils/AmCommonsUtilsApplication.java
deleted file mode 100644
index 3509f1c..0000000
--- a/src/main/java/com/amalvadkar/commons/utils/AmCommonsUtilsApplication.java
+++ /dev/null
@@ -1,13 +0,0 @@
-package com.amalvadkar.commons.utils;
-
-import org.springframework.boot.SpringApplication;
-import org.springframework.boot.autoconfigure.SpringBootApplication;
-
-@SpringBootApplication
-public class AmCommonsUtilsApplication {
-
-	public static void main(String[] args) {
-		SpringApplication.run(AmCommonsUtilsApplication.class, args);
-	}
-
-}
diff --git a/src/main/java/com/amalvadkar/commons/utils/constants/StringConstants.java b/src/main/java/com/amalvadkar/commons/utils/constants/StringConstants.java
new file mode 100644
index 0000000..1f3d27d
--- /dev/null
+++ b/src/main/java/com/amalvadkar/commons/utils/constants/StringConstants.java
@@ -0,0 +1,11 @@
+package com.amalvadkar.commons.utils.constants;
+
+public class StringConstants {
+
+    public static final String EMPTY_STRING = "";
+
+    private StringConstants() {
+        throw new UnsupportedOperationException("Constants class");
+    }
+
+}
diff --git a/src/main/java/com/amalvadkar/commons/utils/exceptions/InvalidStringException.java b/src/main/java/com/amalvadkar/commons/utils/exceptions/InvalidStringException.java
new file mode 100644
index 0000000..25bd7f9
--- /dev/null
+++ b/src/main/java/com/amalvadkar/commons/utils/exceptions/InvalidStringException.java
@@ -0,0 +1,10 @@
+package com.amalvadkar.commons.utils.exceptions;
+
+/**
+ * Custom exception for invalid string operations.
+ */
+public class InvalidStringException extends RuntimeException {
+    public InvalidStringException(String message) {
+        super(message);
+    }
+}
\ No newline at end of file
diff --git a/src/main/java/com/amalvadkar/commons/utils/string/StringUtils.java b/src/main/java/com/amalvadkar/commons/utils/string/StringUtils.java
new file mode 100644
index 0000000..5e041d4
--- /dev/null
+++ b/src/main/java/com/amalvadkar/commons/utils/string/StringUtils.java
@@ -0,0 +1,71 @@
+package com.amalvadkar.commons.utils.string;
+
+import com.amalvadkar.commons.utils.constants.StringConstants;
+import com.amalvadkar.commons.utils.exceptions.InvalidStringException;
+
+/**
+ * Utility class for common string operations.
+ */
+public final class StringUtils {
+
+    private StringUtils() {
+        throw new UnsupportedOperationException("Utility class");
+    }
+
+    /**
+     * Capitalizes the first letter of the input string.
+     *
+     * @param input The string to capitalize.
+     * @return Capitalized string or an empty string if input is null/empty.
+     * @throws InvalidStringException if the input is null or empty.
+     */
+    public static String capitalize(String input) {
+        if (isEmpty(input)) {
+            throw new InvalidStringException("Input string cannot be null or empty.");
+        }
+        return input.substring(0, 1).toUpperCase() + input.substring(1);
+    }
+
+    /**
+     * Checks if a string is null or empty.
+     *
+     * @param input The string to check.
+     * @return True if the string is null or empty, otherwise false.
+     */
+    public static boolean isEmpty(String input) {
+        return input == null || input.trim().isEmpty();
+    }
+
+    /**
+     * Reverses a given string.
+     *
+     * @param input The string to reverse.
+     * @return The reversed string.
+     */
+    public static String reverse(String input) {
+        if (isEmpty(input)) {
+            return StringConstants.EMPTY_STRING;
+        }
+        return new StringBuilder(input).reverse().toString();
+    }
+
+    /**
+     * Trims spaces from both ends of the string.
+     *
+     * @param input The string to trim.
+     * @return The trimmed string.
+     */
+    public static String trim(String input) {
+        return isEmpty(input) ? StringConstants.EMPTY_STRING : input.trim();
+    }
+
+    /**
+     * Checks if a string contains only letters.
+     *
+     * @param input The string to check.
+     * @return True if the string contains only letters, otherwise false.
+     */
+    public static boolean containsOnlyLetters(String input) {
+        return !isEmpty(input) && input.matches("[a-zA-Z]+");
+    }
+}
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
deleted file mode 100644
index e255222..0000000
--- a/src/main/resources/application.properties
+++ /dev/null
@@ -1 +0,0 @@
-spring.application.name=am-commons-utils
diff --git a/src/test/java/com/amalvadkar/commons/utils/AmCommonsUtilsApplicationTests.java b/src/test/java/com/amalvadkar/commons/utils/AmCommonsUtilsApplicationTests.java
deleted file mode 100644
index 4aa48e4..0000000
--- a/src/test/java/com/amalvadkar/commons/utils/AmCommonsUtilsApplicationTests.java
+++ /dev/null
@@ -1,13 +0,0 @@
-package com.amalvadkar.commons.utils;
-
-import org.junit.jupiter.api.Test;
-import org.springframework.boot.test.context.SpringBootTest;
-
-@SpringBootTest
-class AmCommonsUtilsApplicationTests {
-
-	@Test
-	void contextLoads() {
-	}
-
-}
diff --git a/src/test/java/com/amalvadkar/commons/utils/string/StringUtilsTest.java b/src/test/java/com/amalvadkar/commons/utils/string/StringUtilsTest.java
new file mode 100644
index 0000000..7d0e53b
--- /dev/null
+++ b/src/test/java/com/amalvadkar/commons/utils/string/StringUtilsTest.java
@@ -0,0 +1,59 @@
+package com.amalvadkar.commons.utils.string;
+
+import com.amalvadkar.commons.utils.exceptions.InvalidStringException;
+import common.AbstractUnitTest;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+
+class StringUtilsTest extends AbstractUnitTest {
+
+    @Test
+    void capitalize_should_capitalize_first_letter() {
+        assertThat(StringUtils.capitalize("hello")).isEqualTo("Hello");
+    }
+
+    @Test
+    void capitalize_should_throw_exception_when_input_is_null() {
+        assertThatThrownBy(() -> StringUtils.capitalize(null))
+                .isInstanceOf(InvalidStringException.class)
+                .hasMessage("Input string cannot be null or empty.");
+    }
+
+    @Test
+    void is_empty_should_return_true_when_string_is_empty() {
+        assertThat(StringUtils.isEmpty("")).isTrue();
+    }
+
+    @Test
+    void is_empty_should_return_false_when_string_is_not_empty() {
+        assertThat(StringUtils.isEmpty("test")).isFalse();
+    }
+
+    @Test
+    void reverse_should_return_reversed_string() {
+        assertThat(StringUtils.reverse("hello")).isEqualTo("olleh");
+    }
+
+    @Test
+    void reverse_should_return_empty_when_input_is_empty() {
+        assertThat(StringUtils.reverse("")).isEqualTo("");
+    }
+
+    @Test
+    void trim_should_remove_leading_and_trailing_spaces() {
+        assertThat(StringUtils.trim("  hello  ")).isEqualTo("hello");
+    }
+
+    @Test
+    void contains_only_letters_should_return_true_when_only_letters() {
+        assertThat(StringUtils.containsOnlyLetters("Hello")).isTrue();
+    }
+
+    @Test
+    void contains_only_letters_should_return_false_when_contains_numbers() {
+        assertThat(StringUtils.containsOnlyLetters("Hello123")).isFalse();
+    }
+
+}
\ No newline at end of file
diff --git a/src/test/java/common/AbstractUnitTest.java b/src/test/java/common/AbstractUnitTest.java
new file mode 100644
index 0000000..e134db1
--- /dev/null
+++ b/src/test/java/common/AbstractUnitTest.java
@@ -0,0 +1,7 @@
+package common;
+
+import org.junit.jupiter.api.Tag;
+
+@Tag("unit")
+public class AbstractUnitTest {
+}

From 5081f6c0e2816c9ac7f1e39031830ef003854412 Mon Sep 17 00:00:00 2001
From: Abhishek Malvadkar <abhi@dev.com>
Date: Sun, 9 Mar 2025 12:39:17 +0530
Subject: [PATCH 2/4] GH-1 : Added GitHub action workflow for CI

---
 .github/workflows/Dev-CI.yml | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 .github/workflows/Dev-CI.yml

diff --git a/.github/workflows/Dev-CI.yml b/.github/workflows/Dev-CI.yml
new file mode 100644
index 0000000..cde9585
--- /dev/null
+++ b/.github/workflows/Dev-CI.yml
@@ -0,0 +1,29 @@
+name: Dev CI
+
+on:
+  push:
+    branches:
+      - '**'
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Java 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'temurin'
+          cache: 'maven'
+
+      - name: Make Maven wrapper executable
+        run: chmod +x mvnw
+
+      - name: Build with Maven
+        run: ./mvnw --no-transfer-progress clean verify
+

From 7159143d5923b1f16b0ba97d270ffebb2747f0ea Mon Sep 17 00:00:00 2001
From: Abhishek Malvadkar <abhi@dev.com>
Date: Sun, 9 Mar 2025 14:04:11 +0530
Subject: [PATCH 3/4] GH-1 : Added GitHub action workflow for CI and CD

---
 .github/workflows/Dev-CI.yml | 29 --------------
 .github/workflows/ci-cd.yml  | 73 ++++++++++++++++++++++++++++++++++++
 pom.xml                      | 28 +++++++++++---
 3 files changed, 96 insertions(+), 34 deletions(-)
 delete mode 100644 .github/workflows/Dev-CI.yml
 create mode 100644 .github/workflows/ci-cd.yml

diff --git a/.github/workflows/Dev-CI.yml b/.github/workflows/Dev-CI.yml
deleted file mode 100644
index cde9585..0000000
--- a/.github/workflows/Dev-CI.yml
+++ /dev/null
@@ -1,29 +0,0 @@
-name: Dev CI
-
-on:
-  push:
-    branches:
-      - '**'
-  workflow_dispatch:
-
-jobs:
-  build:
-    name: Build
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Setup Java 21
-        uses: actions/setup-java@v4
-        with:
-          java-version: '21'
-          distribution: 'temurin'
-          cache: 'maven'
-
-      - name: Make Maven wrapper executable
-        run: chmod +x mvnw
-
-      - name: Build with Maven
-        run: ./mvnw --no-transfer-progress clean verify
-
diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
new file mode 100644
index 0000000..633ecee
--- /dev/null
+++ b/.github/workflows/ci-cd.yml
@@ -0,0 +1,73 @@
+name: CI/CD Pipeline
+
+on:
+  push:
+    branches:
+      - '**'  # Runs for all branches
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build & Test
+    runs-on: ubuntu-latest
+    if: github.ref != 'refs/heads/master'  # Runs on all branches except master
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Setup Java 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'temurin'
+          cache: 'maven'
+
+      - name: Make Maven wrapper executable
+        run: chmod +x mvnw
+
+      - name: Build and Run Tests
+        run: ./mvnw --no-transfer-progress clean verify
+
+      - if: ${{ github.ref == 'refs/heads/master' }}
+        name: Publish to GitHub Packages Apache Maven
+        run: ./mvnw deploy -s $GITHUB_WORKSPACE/settings.xml
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+
+  deploy:
+    name: Build, Test & Deploy
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master'  # Runs only on master
+    permissions:
+      contents: read
+      packages: write # Needed to publish to GitHub Packages
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'temurin'
+          server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
+          settings-path: ${{ github.workspace }} # location for the settings.xml file
+          cache: 'maven'
+
+      - name: Build and Deploy to GitHub Packages
+        run: ./mvnw --no-transfer-progress clean deploy -s $GITHUB_WORKSPACE/settings.xml
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ env.VERSION }}
+          generate_release_notes: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
diff --git a/pom.xml b/pom.xml
index a4ec15f..0296be5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -11,16 +11,27 @@
 	<description>Common Utility Library</description>
 
 	<properties>
-		<!-- Dependency versions management -->
+		<!-- Dependency versions -->
 		<java.version>21</java.version>
 		<junit-jupiter.version>5.10.2</junit-jupiter.version>
 		<assertj-core.version>3.25.3</assertj-core.version>
 
-		<!-- Plugin versions management -->
-		<maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
-		<maven-surefire-plugin.version>3.1.2</maven-surefire-plugin.version>
+		<!-- Plugin versions -->
+		<maven-compiler-plugin.version>3.11.0</maven-compiler-plugin.version>
+		<maven-surefire-plugin.version>3.2.5</maven-surefire-plugin.version>
+		<maven-jar-plugin.version>3.3.0</maven-jar-plugin.version>
+		<maven-deploy-plugin.version>3.0.0-M1</maven-deploy-plugin.version>
 	</properties>
 
+	<distributionManagement>
+		<repository>
+			<id>github</id>
+			<name>GitHub Packages</name>
+			<url>https://maven.pkg.github.com/abhishekmalvadkar/${project.artifactId}</url>
+		</repository>
+	</distributionManagement>
+
+
 	<dependencies>
 		<!-- JUnit 5 API for writing tests -->
 		<dependency>
@@ -66,7 +77,7 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-jar-plugin</artifactId>
-				<version>3.2.2</version>
+				<version>${maven-jar-plugin.version}</version>
 			</plugin>
 
 			<!-- Surefire Plugin for Running JUnit 5 Tests -->
@@ -78,6 +89,13 @@
 					<useModulePath>false</useModulePath>
 				</configuration>
 			</plugin>
+
+			<!-- Deploy Plugin for GitHub Packages -->
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-deploy-plugin</artifactId>
+				<version>${maven-deploy-plugin.version}</version>
+			</plugin>
 		</plugins>
 	</build>
 

From 583396138b46a16663ccc4bad3659c82f6665b73 Mon Sep 17 00:00:00 2001
From: Abhishek Malvadkar <abhi@dev.com>
Date: Sun, 9 Mar 2025 14:04:48 +0530
Subject: [PATCH 4/4] GH-1 : Added all test run intellij configuration file

---
 .run/All Unit Tests.run.xml | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 .run/All Unit Tests.run.xml

diff --git a/.run/All Unit Tests.run.xml b/.run/All Unit Tests.run.xml
new file mode 100644
index 0000000..ab3d792
--- /dev/null
+++ b/.run/All Unit Tests.run.xml	
@@ -0,0 +1,12 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="All Unit Tests" type="JUnit" factoryName="JUnit">
+    <module name="am-commons-utils" />
+    <option name="MAIN_CLASS_NAME" value="" />
+    <option name="METHOD_NAME" value="" />
+    <option name="TEST_OBJECT" value="tags" />
+    <tag value="unit" />
+    <method v="2">
+      <option name="Make" enabled="true" />
+    </method>
+  </configuration>
+</component>
\ No newline at end of file