From b28b3482637fa14dd656703bec1c3041d17ad86c Mon Sep 17 00:00:00 2001 From: Modernization Agent Date: Mon, 30 Mar 2026 23:05:18 +0000 Subject: [PATCH 1/5] Add Maven project scaffolding with Maven Wrapper Set up the Java 17 Maven project structure for the email slicer migration including pom.xml with JUnit 5 dependency, Maven Wrapper scripts, .gitignore, and standard src/main/java + src/test/java layout. --- .gitignore | 24 ++ .mvn/wrapper/maven-wrapper.properties | 2 + mvnw | 308 ++++++++++++++++++++++++++ mvnw.cmd | 205 +++++++++++++++++ pom.xml | 62 ++++++ 5 files changed, 601 insertions(+) create mode 100644 .gitignore create mode 100644 .mvn/wrapper/maven-wrapper.properties create mode 100755 mvnw create mode 100644 mvnw.cmd create mode 100644 pom.xml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5e0a4ad --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +# Maven build output +target/ + +# IDE files +.idea/ +*.iml +.vscode/ +.settings/ +.project +.classpath +*.swp +*.swo + +# OS files +.DS_Store +Thumbs.db + +# Python test artifacts (functional testing environment) +.venv/ +venv/ +__pycache__/ +.pytest_cache/ +*.pyc +*.pyo diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..e70e7bc --- /dev/null +++ b/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,2 @@ +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.6/apache-maven-3.9.6-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar diff --git a/mvnw b/mvnw new file mode 100755 index 0000000..37e0a57 --- /dev/null +++ b/mvnw @@ -0,0 +1,308 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version @@project.version@@ +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "$(uname)" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && + JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin ; then + javaHome="$(dirname "\"$javaExecutable\"")" + javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "\"$javaExecutable\"")" + fi + javaHome="$(dirname "\"$javaExecutable\"")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$(cd "$wdir/.." || exit 1; pwd) + fi + # end of workaround + done + printf '%s' "$(cd "$basedir" || exit 1; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' < "$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/@@project.version@@/maven-wrapper-@@project.version@@.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/@@project.version@@/maven-wrapper-@@project.version@@.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; + esac + done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget > /dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; + esac +done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 0000000..917381d --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,205 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version @@project.version@@ +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/@@project.version@@/maven-wrapper-@@project.version@@.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/@@project.version@@/maven-wrapper-@@project.version@@.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..151921e --- /dev/null +++ b/pom.xml @@ -0,0 +1,62 @@ + + + 4.0.0 + + com.emailslicer + email-slicer + 1.0-SNAPSHOT + jar + + Email Slicer + A CLI tool that slices an email address into username and domain + + + 17 + 17 + UTF-8 + 5.10.2 + + + + + org.junit.jupiter + junit-jupiter + ${junit.version} + test + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.11.0 + + 17 + 17 + + + + org.apache.maven.plugins + maven-surefire-plugin + 3.2.5 + + + org.apache.maven.plugins + maven-jar-plugin + 3.3.0 + + + + com.emailslicer.Main + + + email-slicer + + + + + From dc4d71c32e516090ab97f2141948e4565fec2dd8 Mon Sep 17 00:00:00 2001 From: Modernization Agent Date: Mon, 30 Mar 2026 23:05:51 +0000 Subject: [PATCH 2/5] Add EmailSliceResult record and EmailSlicer parsing logic Implement the core email slicing: EmailSliceResult Java 17 record for the parsed result, and EmailSlicer.slice() static method that trims input and splits on '@'. Throws IllegalArgumentException for null, blank, or missing-@ inputs, matching the original Python validation. --- .../com/emailslicer/EmailSliceResult.java | 10 +++++ .../java/com/emailslicer/EmailSlicer.java | 43 +++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 src/main/java/com/emailslicer/EmailSliceResult.java create mode 100644 src/main/java/com/emailslicer/EmailSlicer.java diff --git a/src/main/java/com/emailslicer/EmailSliceResult.java b/src/main/java/com/emailslicer/EmailSliceResult.java new file mode 100644 index 0000000..27f56f3 --- /dev/null +++ b/src/main/java/com/emailslicer/EmailSliceResult.java @@ -0,0 +1,10 @@ +package com.emailslicer; + +/** + * Immutable data carrier for a parsed email address. + * + * @param username the local part of the email (before the {@code @}) + * @param domain the domain part of the email (after the {@code @}) + */ +public record EmailSliceResult(String username, String domain) { +} diff --git a/src/main/java/com/emailslicer/EmailSlicer.java b/src/main/java/com/emailslicer/EmailSlicer.java new file mode 100644 index 0000000..120831a --- /dev/null +++ b/src/main/java/com/emailslicer/EmailSlicer.java @@ -0,0 +1,43 @@ +package com.emailslicer; + +/** + * Pure parsing logic for slicing an email address into username and domain. + *

+ * This class has no I/O dependencies and is designed to be easily unit-tested. + */ +public final class EmailSlicer { + + private EmailSlicer() { + // Utility class — prevent instantiation + } + + /** + * Slices an email address into its username and domain components. + *

+ * The input is trimmed of leading/trailing whitespace (matching the original + * Python tool's {@code strip()} behavior). Validation checks that the input + * contains an {@code @} symbol; if not, an {@link IllegalArgumentException} + * is thrown. + * + * @param email the email address to slice + * @return an {@link EmailSliceResult} containing the username and domain + * @throws IllegalArgumentException if the email is null, blank, or does not contain {@code @} + */ + public static EmailSliceResult slice(String email) { + if (email == null || email.isBlank()) { + throw new IllegalArgumentException("Please enter a valid Email Id."); + } + + String trimmed = email.strip(); + + if (!trimmed.contains("@")) { + throw new IllegalArgumentException("Please enter a valid Email Id."); + } + + int atIndex = trimmed.indexOf("@"); + String username = trimmed.substring(0, atIndex); + String domain = trimmed.substring(atIndex + 1); + + return new EmailSliceResult(username, domain); + } +} From 9f6e8966226db2a611867b459bd78ca440ad7772 Mon Sep 17 00:00:00 2001 From: Modernization Agent Date: Mon, 30 Mar 2026 23:06:25 +0000 Subject: [PATCH 3/5] Add Main class with Scanner-based console I/O Implement the CLI entry point that prompts for an email address, calls EmailSlicer.slice(), and prints the username and domain. Catches IllegalArgumentException to print the error and exit with code 1, matching the original Python tool's behavior. --- src/main/java/com/emailslicer/Main.java | 34 +++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 src/main/java/com/emailslicer/Main.java diff --git a/src/main/java/com/emailslicer/Main.java b/src/main/java/com/emailslicer/Main.java new file mode 100644 index 0000000..cbd8069 --- /dev/null +++ b/src/main/java/com/emailslicer/Main.java @@ -0,0 +1,34 @@ +package com.emailslicer; + +import java.util.Scanner; + +/** + * CLI entry point for the Email Slicer tool. + *

+ * Reads an email address from standard input, delegates parsing to + * {@link EmailSlicer}, and prints the username and domain to standard output. + * This mirrors the behavior of the original Python {@code emailSlicer.py}. + */ +public final class Main { + + private Main() { + // Entry-point class — prevent instantiation + } + + public static void main(String[] args) { + System.out.println("Please enter your Email Id:"); + + try (Scanner scanner = new Scanner(System.in)) { + String email = scanner.nextLine().strip(); + + try { + EmailSliceResult result = EmailSlicer.slice(email); + System.out.printf("Your username is: %s%n", result.username()); + System.out.printf("Your domain is: %s%n", result.domain()); + } catch (IllegalArgumentException e) { + System.out.println(e.getMessage()); + System.exit(1); + } + } + } +} From 32a4a914e714b536f573d4c56b450eab7e45e87e Mon Sep 17 00:00:00 2001 From: Modernization Agent Date: Mon, 30 Mar 2026 23:07:18 +0000 Subject: [PATCH 4/5] Add JUnit 5 unit tests for EmailSlicer 16 tests covering valid emails, whitespace trimming, missing @, null/empty/blank input, edge cases (@-only, empty username/domain, multiple @ symbols), and error message content verification. --- .../java/com/emailslicer/EmailSlicerTest.java | 160 ++++++++++++++++++ 1 file changed, 160 insertions(+) create mode 100644 src/test/java/com/emailslicer/EmailSlicerTest.java diff --git a/src/test/java/com/emailslicer/EmailSlicerTest.java b/src/test/java/com/emailslicer/EmailSlicerTest.java new file mode 100644 index 0000000..662d552 --- /dev/null +++ b/src/test/java/com/emailslicer/EmailSlicerTest.java @@ -0,0 +1,160 @@ +package com.emailslicer; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.*; + +class EmailSlicerTest { + + @Nested + @DisplayName("Valid emails") + class ValidEmails { + + @Test + @DisplayName("simple email is sliced into username and domain") + void simpleEmail() { + EmailSliceResult result = EmailSlicer.slice("user@example.com"); + assertEquals("user", result.username()); + assertEquals("example.com", result.domain()); + } + + @Test + @DisplayName("email with dotted username") + void dottedUsername() { + EmailSliceResult result = EmailSlicer.slice("first.last@domain.co.uk"); + assertEquals("first.last", result.username()); + assertEquals("domain.co.uk", result.domain()); + } + + @Test + @DisplayName("email with plus addressing") + void plusAddressing() { + EmailSliceResult result = EmailSlicer.slice("user+tag@example.com"); + assertEquals("user+tag", result.username()); + assertEquals("example.com", result.domain()); + } + } + + @Nested + @DisplayName("Whitespace handling") + class WhitespaceHandling { + + @Test + @DisplayName("leading and trailing spaces are trimmed") + void leadingTrailingSpaces() { + EmailSliceResult result = EmailSlicer.slice(" user@example.com "); + assertEquals("user", result.username()); + assertEquals("example.com", result.domain()); + } + + @Test + @DisplayName("tabs and mixed whitespace are trimmed") + void tabsAndWhitespace() { + EmailSliceResult result = EmailSlicer.slice("\t user@example.com \t"); + assertEquals("user", result.username()); + assertEquals("example.com", result.domain()); + } + } + + @Nested + @DisplayName("Invalid emails — missing @") + class MissingAt { + + @Test + @DisplayName("no @ symbol throws IllegalArgumentException") + void noAtSymbol() { + assertThrows(IllegalArgumentException.class, () -> EmailSlicer.slice("invalidemail")); + } + + @Test + @DisplayName("plain word throws IllegalArgumentException") + void plainWord() { + assertThrows(IllegalArgumentException.class, () -> EmailSlicer.slice("nodomain")); + } + } + + @Nested + @DisplayName("Invalid emails — empty or blank") + class EmptyOrBlank { + + @Test + @DisplayName("null throws IllegalArgumentException") + void nullInput() { + assertThrows(IllegalArgumentException.class, () -> EmailSlicer.slice(null)); + } + + @Test + @DisplayName("empty string throws IllegalArgumentException") + void emptyString() { + assertThrows(IllegalArgumentException.class, () -> EmailSlicer.slice("")); + } + + @Test + @DisplayName("blank string throws IllegalArgumentException") + void blankString() { + assertThrows(IllegalArgumentException.class, () -> EmailSlicer.slice(" ")); + } + } + + @Nested + @DisplayName("Edge cases") + class EdgeCases { + + @Test + @DisplayName("@ only — returns empty username and domain") + void atOnly() { + EmailSliceResult result = EmailSlicer.slice("@"); + assertEquals("", result.username()); + assertEquals("", result.domain()); + } + + @Test + @DisplayName("@ at start — empty username") + void atStart() { + EmailSliceResult result = EmailSlicer.slice("@domain.com"); + assertEquals("", result.username()); + assertEquals("domain.com", result.domain()); + } + + @Test + @DisplayName("@ at end — empty domain") + void atEnd() { + EmailSliceResult result = EmailSlicer.slice("user@"); + assertEquals("user", result.username()); + assertEquals("", result.domain()); + } + + @Test + @DisplayName("multiple @ symbols — splits on first @") + void multipleAt() { + EmailSliceResult result = EmailSlicer.slice("user@@domain.com"); + assertEquals("user", result.username()); + assertEquals("@domain.com", result.domain()); + } + + @Test + @DisplayName("a@b@c — splits on first @") + void threePartsAt() { + EmailSliceResult result = EmailSlicer.slice("a@b@c"); + assertEquals("a", result.username()); + assertEquals("b@c", result.domain()); + } + } + + @Nested + @DisplayName("Error message content") + class ErrorMessages { + + @Test + @DisplayName("error message is user-friendly") + void errorMessageContent() { + IllegalArgumentException ex = assertThrows( + IllegalArgumentException.class, + () -> EmailSlicer.slice("nope") + ); + assertEquals("Please enter a valid Email Id.", ex.getMessage()); + } + } +} From 9b1676a1d7c0999bec92772e1343d52685cf67bc Mon Sep 17 00:00:00 2001 From: Modernization Agent Date: Mon, 30 Mar 2026 23:10:02 +0000 Subject: [PATCH 5/5] Extract user-facing strings into dedicated Messages class Move all hardcoded user-facing message literals into Messages.java with public static final constants, per the error handling guidelines. Update EmailSlicer and Main to reference Messages constants. --- .../java/com/emailslicer/EmailSlicer.java | 4 +-- src/main/java/com/emailslicer/Main.java | 6 ++--- src/main/java/com/emailslicer/Messages.java | 26 +++++++++++++++++++ 3 files changed, 31 insertions(+), 5 deletions(-) create mode 100644 src/main/java/com/emailslicer/Messages.java diff --git a/src/main/java/com/emailslicer/EmailSlicer.java b/src/main/java/com/emailslicer/EmailSlicer.java index 120831a..b9fcf8b 100644 --- a/src/main/java/com/emailslicer/EmailSlicer.java +++ b/src/main/java/com/emailslicer/EmailSlicer.java @@ -25,13 +25,13 @@ private EmailSlicer() { */ public static EmailSliceResult slice(String email) { if (email == null || email.isBlank()) { - throw new IllegalArgumentException("Please enter a valid Email Id."); + throw new IllegalArgumentException(Messages.INVALID_EMAIL); } String trimmed = email.strip(); if (!trimmed.contains("@")) { - throw new IllegalArgumentException("Please enter a valid Email Id."); + throw new IllegalArgumentException(Messages.INVALID_EMAIL); } int atIndex = trimmed.indexOf("@"); diff --git a/src/main/java/com/emailslicer/Main.java b/src/main/java/com/emailslicer/Main.java index cbd8069..45c6e47 100644 --- a/src/main/java/com/emailslicer/Main.java +++ b/src/main/java/com/emailslicer/Main.java @@ -16,15 +16,15 @@ private Main() { } public static void main(String[] args) { - System.out.println("Please enter your Email Id:"); + System.out.println(Messages.PROMPT_EMAIL); try (Scanner scanner = new Scanner(System.in)) { String email = scanner.nextLine().strip(); try { EmailSliceResult result = EmailSlicer.slice(email); - System.out.printf("Your username is: %s%n", result.username()); - System.out.printf("Your domain is: %s%n", result.domain()); + System.out.printf(Messages.USERNAME_FORMAT + "%n", result.username()); + System.out.printf(Messages.DOMAIN_FORMAT + "%n", result.domain()); } catch (IllegalArgumentException e) { System.out.println(e.getMessage()); System.exit(1); diff --git a/src/main/java/com/emailslicer/Messages.java b/src/main/java/com/emailslicer/Messages.java new file mode 100644 index 0000000..abe4995 --- /dev/null +++ b/src/main/java/com/emailslicer/Messages.java @@ -0,0 +1,26 @@ +package com.emailslicer; + +/** + * Centralised store for user-facing messages. + *

+ * Keeping all messages in one place makes them easy to find, review, + * and (in the future) localise. + */ +public final class Messages { + + private Messages() { + // Constants-only class — prevent instantiation + } + + /** Prompt shown before reading the email address from stdin. */ + public static final String PROMPT_EMAIL = "Please enter your Email Id:"; + + /** Error message when the supplied email is invalid. */ + public static final String INVALID_EMAIL = "Please enter a valid Email Id."; + + /** Format string for displaying the username. */ + public static final String USERNAME_FORMAT = "Your username is: %s"; + + /** Format string for displaying the domain. */ + public static final String DOMAIN_FORMAT = "Your domain is: %s"; +}