diff --git a/.gitignore b/.gitignore index 5ff6309..9343d0a 100644 --- a/.gitignore +++ b/.gitignore @@ -35,4 +35,7 @@ build/ .vscode/ ### Mac OS ### -.DS_Store \ No newline at end of file +.DS_Store + +.gradle +.idea \ No newline at end of file diff --git a/README.md b/README.md index d6f44cb..9deea83 100644 --- a/README.md +++ b/README.md @@ -17,4 +17,10 @@ 2. Сделать ветку dev в своем проекте. Выполнять работу в ней 3. После выполнения работы открыть Pull Request в master 4. Назначить ментора ревьювером -5. Отправить ссылку на PR в тг чат ментору \ No newline at end of file +5. Отправить ссылку на PR в тг чат ментору + +**Как сгененировать javadoc:**
+Выполнить в корне проекта: +``` +mvn javadoc:javadoc +``` \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..cc92882 --- /dev/null +++ b/build.gradle @@ -0,0 +1,45 @@ +plugins { + id 'java' + id 'maven-publish' +} + +group = 'org.writer' +version = '1.0-SNAPSHOT' + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } +} + +repositories { + mavenCentral() +} + +dependencies { + compileOnly 'org.projectlombok:lombok:1.18.34' + annotationProcessor 'org.projectlombok:lombok:1.18.34' + + testImplementation platform('org.junit:junit-bom:5.11.0') + testImplementation 'org.junit.jupiter:junit-jupiter' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' + testImplementation 'net.datafaker:datafaker:2.5.1' +} + +tasks.test { + useJUnitPlatform() +} + +publishing { + publications { + mavenJava(MavenPublication) { + from components.java + } + } + repositories { + maven { + name = "localRepo" + url = layout.buildDirectory.dir("repo") + } + } +} \ No newline at end of file diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..377538c --- /dev/null +++ b/gradle.properties @@ -0,0 +1,5 @@ +# This file was generated by the Gradle 'init' task. +# https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties + +org.gradle.configuration-cache=true + diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..06affb7 --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,12 @@ +# This file was generated by the Gradle 'init' task. +# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format + +[versions] +net-datafaker-datafaker = "2.5.1" +org-junit-jupiter-junit-jupiter = "5.8.1" +org-projectlombok-lombok = "1.18.34" + +[libraries] +net-datafaker-datafaker = { module = "net.datafaker:datafaker", version.ref = "net-datafaker-datafaker" } +org-junit-jupiter-junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "org-junit-jupiter-junit-jupiter" } +org-projectlombok-lombok = { module = "org.projectlombok:lombok", version.ref = "org-projectlombok-lombok" } diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..f8e1ee3 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..23449a2 --- /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-9.2.1-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..adff685 --- /dev/null +++ b/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 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. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# 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/platforms/jvm/plugins-application/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 -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || 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 + + + +# 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" ) + + 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, 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" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# 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..e509b2d --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,93 @@ +@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 +@rem SPDX-License-Identifier: Apache-2.0 +@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. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +: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 index effc1bd..b452632 100644 --- a/pom.xml +++ b/pom.xml @@ -27,6 +27,27 @@ 5.8.1 test + + net.datafaker + datafaker + 2.5.1 + test + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 3.6.3 + + ${project.basedir}/docs + apidocs + 17 + + + + + \ No newline at end of file diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..24705ca --- /dev/null +++ b/settings.gradle @@ -0,0 +1,5 @@ +/* + * This file was generated by the Gradle 'init' task. + */ + +rootProject.name = 'csv' diff --git a/src/main/java/org/writer/Main.java b/src/main/java/org/writer/Main.java index 40e8213..3c00f30 100644 --- a/src/main/java/org/writer/Main.java +++ b/src/main/java/org/writer/Main.java @@ -1,7 +1,45 @@ package org.writer; +import org.writer.model.Months; +import org.writer.model.Person; +import org.writer.model.Student; + +import java.io.IOException; +import java.util.Arrays; +import java.util.List; + public class Main { - public static void main(String[] args) { - System.out.println("Hello world!"); + public static void main(String[] args) throws IOException { + List students = Arrays.asList( + Student.builder() + .name("Max") + .score(Arrays.asList("1", "2")) + .build(), + Student.builder() + .name("Lewis") + .score(Arrays.asList("22", "33")) + .build() + ); + + List persons = Arrays.asList( + Person.builder() + .firstName("Max") + .lastName("Verstappen") + .dayOfBirth(7) + .monthOfBirth(Months.JANUARY) + .yearOfBirth(1985) + .build(), + Person.builder() + .firstName("Lewis") + .lastName("Hamilton") + .dayOfBirth(30) + .monthOfBirth(Months.SEPTEMBER) + .yearOfBirth(1997) + .build() + ); + + Writable csvWriter = new WritableImpl(); + csvWriter.writeToFile(students, "students.csv"); + csvWriter.writeToFile(persons, "persons.csv"); } } \ 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..a7a85a1 100644 --- a/src/main/java/org/writer/Writable.java +++ b/src/main/java/org/writer/Writable.java @@ -1,9 +1,10 @@ package org.writer; +import java.io.IOException; import java.util.List; public interface Writable { - void writeToFile(List data, String fileName); + void writeToFile(List data, String fileName) throws IOException; } diff --git a/src/main/java/org/writer/WritableImpl.java b/src/main/java/org/writer/WritableImpl.java new file mode 100644 index 0000000..970fea3 --- /dev/null +++ b/src/main/java/org/writer/WritableImpl.java @@ -0,0 +1,70 @@ +package org.writer; + +import org.writer.annotation.CsvColumn; +import org.writer.exception.NoDataCSVException; + +import java.io.FileWriter; +import java.io.IOException; +import java.lang.reflect.Field; +import java.util.List; +import java.util.stream.Collectors; + +/** + * Реализация интерфейса {@link Writable}, которая позволяет сериализовать список объектов + * в CSV‑файл с использованием аннотации {@link CsvColumn}. + *

+ * Алгоритм работы: + *

    + *
  1. Проверяется, что список данных не пустой, иначе выбрасывается {@link NoDataCSVException}.
  2. + *
  3. Через Reflection извлекаются все поля класса первого объекта.
  4. + *
  5. Формируется строка заголовков CSV на основе значений {@link CsvColumn#name()}.
  6. + *
  7. Для каждого объекта формируется строка с его значениями.
  8. + *
  9. Результат записывается в указанный файл.
  10. + *
+ */ +public class WritableImpl implements Writable { + + /** + * Записывает список объектов в CSV‑файл. + *

+ * Для сериализации учитываются только те поля, которые помечены аннотацией {@link CsvColumn}. + * Если список пустой или равен {@code null}, выбрасывается {@link NoDataCSVException}. + * + * @param data список объектов для записи + * @param fileName имя файла, в который будет записан результат + * @throws IOException если произошла ошибка при записи в файл + * @throws NoDataCSVException если список {@code data} пустой или равен {@code null} + */ + @Override + public void writeToFile(List data, String fileName) throws IOException { + if (data == null || data.isEmpty()) throw new NoDataCSVException(); + + Class clazz = data.get(0).getClass(); + List fields = List.of(clazz.getDeclaredFields()); + + String header = fields.stream() + .filter(field -> field.isAnnotationPresent(CsvColumn.class)) + .map(field -> field.getAnnotation(CsvColumn.class).name()) + .collect(Collectors.joining(",")); + header += "\n"; + + String rows = data.stream() + .map(obj -> fields.stream() + .filter(field -> field.isAnnotationPresent(CsvColumn.class)) + .map(field -> { + try { + field.setAccessible(true); + var value = field.get(obj); + return String.valueOf(value); + } catch (IllegalAccessException e) { + return "NO_ACCESS"; + } + }).collect(Collectors.joining(",")) + ).collect(Collectors.joining("\n")); + String csv = header + rows; + + try (var fileWriter = new FileWriter(fileName)) { + fileWriter.write(csv); + } + } +} diff --git a/src/main/java/org/writer/annotation/CsvColumn.java b/src/main/java/org/writer/annotation/CsvColumn.java new file mode 100644 index 0000000..d631c12 --- /dev/null +++ b/src/main/java/org/writer/annotation/CsvColumn.java @@ -0,0 +1,24 @@ +package org.writer.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Аннотация {@code CsvColumn} используется для пометки полей класса, + * которые должны быть включены в CSV‑отчёт. + *

+ * Может применяться только к полям. Сохраняется во время выполнения, + * что позволяет работать с ней через Reflection. + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +public @interface CsvColumn { + /** + * Имя колонки в CSV‑файле, соответствующее данному полю. + * + * @return название столбца в CSV + */ + String name(); +} diff --git a/src/main/java/org/writer/exception/NoDataCSVException.java b/src/main/java/org/writer/exception/NoDataCSVException.java new file mode 100644 index 0000000..5d7b01b --- /dev/null +++ b/src/main/java/org/writer/exception/NoDataCSVException.java @@ -0,0 +1,13 @@ +package org.writer.exception; + +/** + * Исключение {@code NoDataCSVException} выбрасывается в случаях, + * когда отсутствуют данные для записи в CSV‑файл. + */ +public class NoDataCSVException extends RuntimeException { + public static final String MSG = "There is no data to write to CSV"; + + public NoDataCSVException() { + super(MSG); + } +} diff --git a/src/main/java/org/writer/model/Person.java b/src/main/java/org/writer/model/Person.java index ba8576b..ffd2574 100644 --- a/src/main/java/org/writer/model/Person.java +++ b/src/main/java/org/writer/model/Person.java @@ -3,20 +3,48 @@ import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Data; - +import org.writer.annotation.CsvColumn; + +/** + * Класс {@code Person} представляет модель человека, + * данные которого могут быть сериализованы в CSV‑файл. + *

+ * Для каждого поля используется аннотация {@link CsvColumn}, + * которая определяет название соответствующей колонки в CSV‑отчёте. + */ @Data @Builder @AllArgsConstructor public class Person { + /** + * Имя человека. + */ + @CsvColumn(name = "First name") private String firstName; + /** + * Фамилия человека. + */ + @CsvColumn(name = "Last name") private String lastName; + /** + * День рождения (число месяца). + */ + @CsvColumn(name = "Day of birth") private int dayOfBirth; + /** + * Месяц рождения. + */ + @CsvColumn(name = "Month of birth") private Months monthOfBirth; + /** + * Год рождения. + */ + @CsvColumn(name = "Year of birth") 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..a103fa4 100644 --- a/src/main/java/org/writer/model/Student.java +++ b/src/main/java/org/writer/model/Student.java @@ -3,15 +3,31 @@ import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Data; +import org.writer.annotation.CsvColumn; import java.util.List; +/** + * Класс {@code Student} представляет модель студента, + * данные которого могут быть сериализованы в CSV‑файл. + *

+ * Для каждого поля используется аннотация {@link CsvColumn}, + * которая определяет название соответствующей колонки в CSV‑отчёте. + */ @Data @Builder @AllArgsConstructor public class Student { + /** + * Имя студента. + */ + @CsvColumn(name = "Student name") private String name; + /** + * Список результатов (оценок) студента. + */ + @CsvColumn(name = "Student score") private List score; } \ No newline at end of file diff --git a/src/test/java/org/writer/WritableTest.java b/src/test/java/org/writer/WritableTest.java new file mode 100644 index 0000000..7a94a71 --- /dev/null +++ b/src/test/java/org/writer/WritableTest.java @@ -0,0 +1,51 @@ +package org.writer; + +import net.datafaker.Faker; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; +import org.writer.model.Months; +import org.writer.model.Person; +import org.writer.model.Student; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.List; +import java.util.stream.IntStream; + +class WritableTest { + + private final Faker faker = new Faker(); + private final Writable csvWriter = new WritableImpl(); + + @Test + void writeToFilePersonTest() throws IOException { + List persons = IntStream.range(0, 5) + .mapToObj(o -> Person.builder() + .firstName(faker.name().firstName()) + .lastName(faker.name().firstName()) + .dayOfBirth(faker.number().numberBetween(1, 28)) + .monthOfBirth(faker.options().option(Months.class)) + .yearOfBirth(faker.number().numberBetween(1990, 2010)) + .build()) + .toList(); + + csvWriter.writeToFile(persons, "persons.csv"); + + Assertions.assertTrue(Files.exists(Paths.get("persons.csv"))); + } + + @Test + void writeToFileStudentTest() throws IOException { + List students = IntStream.range(0, 5) + .mapToObj(o -> Student.builder() + .name(faker.name().firstName()) + .score(List.of(faker.number().digits(3))) + .build()) + .toList(); + + csvWriter.writeToFile(students, "students.csv"); + + Assertions.assertTrue(Files.exists(Paths.get("students.csv"))); + } +} \ No newline at end of file