diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..76bf623 --- /dev/null +++ b/build.gradle @@ -0,0 +1,31 @@ +plugins { + id 'java-library' +} + +group = 'org.writer' +version = '1.0-SNAPSHOT' + + + +java { + sourceCompatibility = '17' + targetCompatibility = '17' + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } +} + +repositories { + mavenCentral() +} + +dependencies { + compileOnly libs.lombok + annotationProcessor libs.lombok + testCompileOnly libs.lombok + testAnnotationProcessor libs.lombok + testImplementation libs.datafaker + testImplementation libs.junit.jupiterl +} + +test { useJUnitPlatform() } \ No newline at end of file diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..ab26d25 --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,9 @@ +[versions] +lombok = "1.18.30" +datafaker = "2.3.0" +junit-jupiter = "5.8.1" + +[libraries] +lombok = {module = "org.projectlombok:lombok", version.ref = "lombok"} +datafaker = {module = "net.datafaker:datafaker", version.ref = "datafaker"} +junit-jupiterl = {module = "org.junit.jupiter:junit-jupiter", version.ref = "junit-jupiter"} \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..d64cd49 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..1af9e09 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..1aa94a4 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +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 + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..6689b85 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/pom.xml b/pom.xml deleted file mode 100644 index effc1bd..0000000 --- a/pom.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - 4.0.0 - - org.writer - csv - 1.0-SNAPSHOT - - - 17 - 17 - UTF-8 - - - - - org.projectlombok - lombok - 1.18.34 - provided - - - org.junit.jupiter - junit-jupiter - 5.8.1 - test - - - - \ No newline at end of file diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..d543060 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'csv-writer' \ No newline at end of file diff --git a/src/main/java/org/writer/CSVWriterApi.java b/src/main/java/org/writer/CSVWriterApi.java new file mode 100644 index 0000000..e76c4cf --- /dev/null +++ b/src/main/java/org/writer/CSVWriterApi.java @@ -0,0 +1,11 @@ +package org.writer; + +import java.util.List; + +public class CSVWriterApi { + + public void writeToFile(List data, String fileName) { + Writable writable = new WritableImpl(); + writable.writeToFile(data, fileName); + } +} diff --git a/src/main/java/org/writer/Main.java b/src/main/java/org/writer/Main.java deleted file mode 100644 index 40e8213..0000000 --- a/src/main/java/org/writer/Main.java +++ /dev/null @@ -1,7 +0,0 @@ -package org.writer; - -public class Main { - public static void main(String[] args) { - System.out.println("Hello world!"); - } -} \ No newline at end of file diff --git a/src/main/java/org/writer/Writable.java b/src/main/java/org/writer/Writable.java index 9f60c45..d764200 100644 --- a/src/main/java/org/writer/Writable.java +++ b/src/main/java/org/writer/Writable.java @@ -3,7 +3,5 @@ import java.util.List; public interface Writable { - void writeToFile(List data, String fileName); - } diff --git a/src/main/java/org/writer/WritableImpl.java b/src/main/java/org/writer/WritableImpl.java new file mode 100644 index 0000000..7005b62 --- /dev/null +++ b/src/main/java/org/writer/WritableImpl.java @@ -0,0 +1,86 @@ +package org.writer; + +import org.writer.exception.AccessFileException; +import org.writer.exception.InvalidDataException; + +import java.io.FileWriter; +import java.io.IOException; +import java.lang.reflect.Field; +import java.util.Collection; +import java.util.List; +import java.util.logging.Logger; +import java.util.stream.Collectors; + +/** + * Класс реализации записи данных в файл в формате CSV + */ + +public class WritableImpl implements Writable { + private final Logger logger = Logger.getLogger(WritableImpl.class.getName()); + private final StringBuilder stringBuilder = new StringBuilder(); + + + /** + * Вадидация входных даннных + * @param data - список обьектов + * @param fileName - имя файла для записи + * @throws InvalidDataException - бросает исключение + */ + @Override + public void writeToFile(List data, String fileName) { + if (validateMethod(data, fileName)) { + try (FileWriter fw = new FileWriter(fileName)) + { + for (Object object : data) { + Class aClass = object.getClass(); + Field[] fields = aClass.getDeclaredFields(); + for (Field field : fields) { + field.setAccessible(true); + Object valueField = field.get(object); + resolveFieldClass(valueField); + } + } + if (!stringBuilder.isEmpty()) { + stringBuilder.setLength(stringBuilder.length() - 1); + } + fw.write(stringBuilder.toString()); + } catch (IllegalAccessException e) { + throw new InvalidDataException("Invalid data!"); + } catch (IOException e) { + throw new AccessFileException("Access file error!"); + } + } else { + throw new InvalidDataException("Invalid data!"); + } + } + + /** + * Вадидация входных даннных + * @param data - список обьектов + * @param fileName - имя файла для записи + */ + private boolean validateMethod(List data, String fileName) { + if (data == null || fileName == null) { + logger.warning("Data or File Name is null!"); + return false; + } else if (data.isEmpty() || fileName.isEmpty()) { + logger.warning("Data or File Name is empty!"); + return false; + } else { + return true; + } + } + + /** + * Проверка типа поля и заполнение stringbuilder + * @param valueField - поле обьекта + */ + private void resolveFieldClass (Object valueField) { + if (valueField instanceof Collection) { + String collect = ((Collection) valueField).stream().map(value -> value.toString()).collect(Collectors.joining("|")); + stringBuilder.append(collect).append(','); + } else { + stringBuilder.append(valueField).append(','); + } + } +} diff --git a/src/main/java/org/writer/exception/AccessFileException.java b/src/main/java/org/writer/exception/AccessFileException.java new file mode 100644 index 0000000..ce6c44f --- /dev/null +++ b/src/main/java/org/writer/exception/AccessFileException.java @@ -0,0 +1,10 @@ +package org.writer.exception; + +public class AccessFileException extends RuntimeException { + public AccessFileException(String message) { + super(message); + } + public AccessFileException(String message, Throwable cause) { + super(message, cause); + } +} diff --git a/src/main/java/org/writer/exception/InvalidDataException.java b/src/main/java/org/writer/exception/InvalidDataException.java new file mode 100644 index 0000000..1da1e87 --- /dev/null +++ b/src/main/java/org/writer/exception/InvalidDataException.java @@ -0,0 +1,11 @@ +package org.writer.exception; + +public class InvalidDataException extends RuntimeException { + + public InvalidDataException(String message) { + super(message); + } + public InvalidDataException(String message, Throwable cause) { + super(message, cause); + } +} diff --git a/src/main/java/org/writer/model/Months.java b/src/main/java/org/writer/model/Months.java index cb7b9c1..b9e6b93 100644 --- a/src/main/java/org/writer/model/Months.java +++ b/src/main/java/org/writer/model/Months.java @@ -1,5 +1,9 @@ package org.writer.model; +/** + * Enum с именами месяцев в году. + */ + public enum Months { JANUARY, FEBRUARY, diff --git a/src/main/java/org/writer/model/Person.java b/src/main/java/org/writer/model/Person.java index ba8576b..d730d58 100644 --- a/src/main/java/org/writer/model/Person.java +++ b/src/main/java/org/writer/model/Person.java @@ -4,19 +4,26 @@ import lombok.Builder; import lombok.Data; +/** + * Класс сущности Person + */ + @Data @Builder @AllArgsConstructor public class Person { - + /** Поле имя */ private String firstName; + /** Поле фамилия */ private String lastName; + /** Поле дата рождения */ private int dayOfBirth; + /** Поле месяц рождения */ private Months monthOfBirth; + /** Поле год рождения */ private int yearOfBirth; - } diff --git a/src/main/java/org/writer/model/Student.java b/src/main/java/org/writer/model/Student.java index 2b549c4..c81c6c0 100644 --- a/src/main/java/org/writer/model/Student.java +++ b/src/main/java/org/writer/model/Student.java @@ -6,12 +6,16 @@ import java.util.List; +/** + * Класс сущности Student + */ + @Data @Builder @AllArgsConstructor public class Student { - + /** Поле имя */ private String name; - + /** Поле счета, представляет из себя список String */ private List score; } \ No newline at end of file diff --git a/src/test/java/UnitTests/CSVWriterTest.java b/src/test/java/UnitTests/CSVWriterTest.java new file mode 100644 index 0000000..6f687ef --- /dev/null +++ b/src/test/java/UnitTests/CSVWriterTest.java @@ -0,0 +1,86 @@ +package UnitTests; + + +import net.datafaker.Faker; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.writer.WritableImpl; +import org.writer.exception.InvalidDataException; +import org.writer.model.Months; +import org.writer.model.Person; +import org.writer.model.Student; + +import java.io.BufferedReader; +import java.io.FileReader; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +class CSVWriterTest { + private final Faker faker = new Faker(); + private final WritableImpl writable = new WritableImpl(); + private final List persons = new ArrayList<>(); + private final List students = new ArrayList<>(); + private final String fileName = "output.csv"; + + + @BeforeEach + void setUp() { + for (int i = 0; i < 5; i++) { + persons.add(new Person(faker.name().firstName(), faker.name().lastName(), 22, Months.APRIL, 1094)); + } + persons.add(new Person("Egor", "Fillipov", 22, Months.APRIL, 1094)); + + + for (int i = 0; i < 5; i++) { + students.add(new Student(faker.name().firstName(), List.of(faker.size().adjective(), faker.size().adjective()))); + } + students.add(new Student("Egor", List.of("129", "200"))); + } + + @AfterEach + void tearDown() { + persons.clear(); + students.clear(); + } + + + @Test + void validPersonsWriteTest() throws IOException { + writable.writeToFile(persons, fileName); + Assertions.assertDoesNotThrow(() -> {}); + FileReader fileReader = new FileReader(fileName); + BufferedReader bufferedReader = new BufferedReader(fileReader); + String s = bufferedReader.readLine(); + Assertions.assertNotNull(s); + Assertions.assertTrue(s.contains("Egor")); + } + + @Test + void validStudentsWriteTest() throws IOException { + writable.writeToFile(students, fileName); + Assertions.assertDoesNotThrow(() -> {}); + FileReader fileReader = new FileReader(fileName); + BufferedReader bufferedReader = new BufferedReader(fileReader); + String s = bufferedReader.readLine(); + Assertions.assertNotNull(s); + Assertions.assertTrue(s.contains("Egor")); + } + + @Test + void invalidPersonsWriteTest() { + Assertions.assertThrows(InvalidDataException.class, () -> writable.writeToFile(null, fileName)); + } + + @Test + void invalidStudentsWriteTest() { + Assertions.assertThrows(InvalidDataException.class, () -> writable.writeToFile(null, fileName)); + } + + @Test + void invalidFileNameTest() { + Assertions.assertThrows(InvalidDataException.class, () -> writable.writeToFile(persons, null)); + } +}