From 2b08b32a8ac0e537537321c66426d31a50c81ed2 Mon Sep 17 00:00:00 2001 From: dmitry-weirdo Date: Wed, 20 Nov 2024 22:07:40 +0100 Subject: [PATCH] chore: #99 Typos fix, javadoc minor improvements. --- .../java/ru/klavogonki/kgparser/CarTest.java | 2 +- .../PlayersBasicInfoComparator.java | 4 +- .../statistics/dto/PlayerVocabularyDto.java | 49 +++++++++++++++---- .../entity/PlayerVocabularyStatsEntity.java | 40 ++++++++++++--- .../statistics/excel/ExcelStylesMap.java | 2 +- .../statistics/excel/ExcelTemplate.java | 2 +- .../statistics/util/JacksonUtilsTest.java | 2 +- 7 files changed, 77 insertions(+), 24 deletions(-) diff --git a/kgparserSrv/src/test/java/ru/klavogonki/kgparser/CarTest.java b/kgparserSrv/src/test/java/ru/klavogonki/kgparser/CarTest.java index 67f06818..7b9d7cd8 100644 --- a/kgparserSrv/src/test/java/ru/klavogonki/kgparser/CarTest.java +++ b/kgparserSrv/src/test/java/ru/klavogonki/kgparser/CarTest.java @@ -99,7 +99,7 @@ void testCarById() { assertThat(publishedPersonalCarByPersonalId).isEqualTo(Car.TRAM); assertThatThrownBy(() -> { - Car.getById(0);// non-existing car id + Car.getById(0); // non-existing car id }) .isInstanceOf(IllegalArgumentException.class) .hasMessageContaining("0 cars") diff --git a/kgparserWeb/src/main/java/ru/klavogonki/kgparser/servlet/model/basic_info/PlayersBasicInfoComparator.java b/kgparserWeb/src/main/java/ru/klavogonki/kgparser/servlet/model/basic_info/PlayersBasicInfoComparator.java index e5a02373..682b268f 100644 --- a/kgparserWeb/src/main/java/ru/klavogonki/kgparser/servlet/model/basic_info/PlayersBasicInfoComparator.java +++ b/kgparserWeb/src/main/java/ru/klavogonki/kgparser/servlet/model/basic_info/PlayersBasicInfoComparator.java @@ -3,8 +3,8 @@ import java.util.Comparator; /** - * Упорядочивает игроков сначала по убыванию количества доездов в соревновании - * , а внутри одинакового количества заездов — по имени. + * Упорядочивает игроков сначала по убыванию количества доездов в соревновании, + * а внутри одинакового количества заездов — по имени. */ public class PlayersBasicInfoComparator implements Comparator { diff --git a/kgstatsSrv/src/main/java/ru/klavogonki/statistics/dto/PlayerVocabularyDto.java b/kgstatsSrv/src/main/java/ru/klavogonki/statistics/dto/PlayerVocabularyDto.java index 405b02e2..7cd762e5 100644 --- a/kgstatsSrv/src/main/java/ru/klavogonki/statistics/dto/PlayerVocabularyDto.java +++ b/kgstatsSrv/src/main/java/ru/klavogonki/statistics/dto/PlayerVocabularyDto.java @@ -50,27 +50,56 @@ public class PlayerVocabularyDto // данные игрока по конкретному словарю, PlayerVocabularyStatsEntity - private Integer racesCount; // пробег игрока по словарю + /** + * Пробег игрока по словарю. + */ + private Integer racesCount; - private Double averageSpeed; // средняя скорость игрока по словарю, знаков в минуту + /** + * Средняя скорость игрока по словарю, знаков в минуту. + */ + private Double averageSpeed; - private Integer bestSpeed; // рекорд игрока по словарю, знаков в минуту + /** + * Рекорд игрока по словарю, знаков в минуту. + */ + private Integer bestSpeed; - private Double averageError; // процент ошибок игрока по словарю, в процентах + /** + * Процент ошибок игрока по словарю, в процентах. + */ + private Double averageError; // - private String haul; // время, проведённое игроком в словаре, в секундах. Отформатированное для показа в UI + /** + * Время, проведённое игроком в словаре, в секундах. Отформатированное для показа в UI. + */ + private String haul; - private Integer haulInteger; // true haul, for order number + /** + * True haul, for order number. + */ + private Integer haulInteger; - private Integer qual; // на сколько пройдена квалификация по словарю. Рекорды в словаре засчитываются в пределах 1.2 * qual. + /** + * На сколько пройдена квалификация по словарю. Рекорды в словаре засчитываются в пределах 1.2 * qual. + */ + private Integer qual; // don't care about dirty // string since Java8 Date/Time formatting does not work in Freemarker // see https://stackoverflow.com/questions/32063276/java-time-java-8-support-in-freemarker - private String updated; // Время апдейта результата игроков по словарю. Московское время. + /** + * Время апдейта результата игроков по словарю. Московское время. + */ + private String updated; - // exact value of PlayerVocabularyStatsEntity#updated, for Excel + /** + * Exact value of PlayerVocabularyStatsEntity#updated, for Excel + */ private LocalDateTime updatedDateTime; - private Boolean bookDone; // пройдена ли книга. Заполнено только для словарей-книг. + /** + * Пройдена ли книга. Заполнено только для словарей-книг. + */ + private Boolean bookDone; } diff --git a/kgstatsSrv/src/main/java/ru/klavogonki/statistics/entity/PlayerVocabularyStatsEntity.java b/kgstatsSrv/src/main/java/ru/klavogonki/statistics/entity/PlayerVocabularyStatsEntity.java index 6265b011..58f0750f 100644 --- a/kgstatsSrv/src/main/java/ru/klavogonki/statistics/entity/PlayerVocabularyStatsEntity.java +++ b/kgstatsSrv/src/main/java/ru/klavogonki/statistics/entity/PlayerVocabularyStatsEntity.java @@ -85,21 +85,45 @@ public class PlayerVocabularyStatsEntity implements Serializable { */ private Integer vocabularyTextType; - private Integer racesCount; // пробег игрока по словарю + /** + * Пробег игрока по словарю. + */ + private Integer racesCount; - private Double averageSpeed; // средняя скорость игрока по словарю, знаков в минуту + /** + * Средняя скорость игрока по словарю, знаков в минуту. + */ + private Double averageSpeed; - private Integer bestSpeed; // рекорд игрока по словарю, знаков в минуту + /** + * Рекорд игрока по словарю, знаков в минуту. + */ + private Integer bestSpeed; - private Double averageError; // процент ошибок игрока по словарю, в процентах + /** + * Процент ошибок игрока по словарю, в процентах. + */ + private Double averageError; - private Integer haul; // время, проведённое игроком в словаре, в секундах + /** + * Время, проведённое игроком в словаре, в секундах + */ + private Integer haul; - private Integer qual; // на сколько пройдена квалификация по словарю. Рекорды в словаре засчитываются в пределах 1.2 * qual. + /** + * На сколько пройдена квалификация по словарю. Рекорды в словаре засчитываются в пределах 1.2 * qual. + */ + private Integer qual; private Integer dirty; // todo: wtf is this? - private LocalDateTime updated; // Время апдейта результата игроков по словарю. Московское время. + /** + * Время апдейта результата игроков по словарю. Московское время. + */ + private LocalDateTime updated; - private Boolean bookDone; // пройдена ли книга. Заполнено только для словарей-книг. + /** + * Пройдена ли книга. Заполнено только для словарей-книг. + */ + private Boolean bookDone; } diff --git a/kgstatsSrv/src/main/java/ru/klavogonki/statistics/excel/ExcelStylesMap.java b/kgstatsSrv/src/main/java/ru/klavogonki/statistics/excel/ExcelStylesMap.java index e80f42cd..e0259cc7 100644 --- a/kgstatsSrv/src/main/java/ru/klavogonki/statistics/excel/ExcelStylesMap.java +++ b/kgstatsSrv/src/main/java/ru/klavogonki/statistics/excel/ExcelStylesMap.java @@ -15,7 +15,7 @@ /** * We cannot use more than 64000 cell styles in Excel template. - * Therefore we have to pre-create all required styles and reuse them. + * Therefore, we have to pre-create all required styles and reuse them. * @see Bug in Apache POI * @see You receive a "Too many different cell formats" error message in Excel */ diff --git a/kgstatsSrv/src/main/java/ru/klavogonki/statistics/excel/ExcelTemplate.java b/kgstatsSrv/src/main/java/ru/klavogonki/statistics/excel/ExcelTemplate.java index 39505cec..19025dc2 100644 --- a/kgstatsSrv/src/main/java/ru/klavogonki/statistics/excel/ExcelTemplate.java +++ b/kgstatsSrv/src/main/java/ru/klavogonki/statistics/excel/ExcelTemplate.java @@ -14,7 +14,7 @@ public abstract class ExcelTemplate { protected List players = new ArrayList<>(); - // Sheet name in excel is limited to 31 chars, it will be to 31 characters if too long + // Sheet name in Excel is limited to 31 chars, it will be to 31 characters if too long // @see https://excel.uservoice.com/forums/304921-excel-for-windows-desktop-application/suggestions/10770162-allow-31-characters-in-a-sheet-name public abstract String getSheetName(); diff --git a/kgstatsSrv/src/test/java/ru/klavogonki/statistics/util/JacksonUtilsTest.java b/kgstatsSrv/src/test/java/ru/klavogonki/statistics/util/JacksonUtilsTest.java index d3befdb6..1f8f7978 100644 --- a/kgstatsSrv/src/test/java/ru/klavogonki/statistics/util/JacksonUtilsTest.java +++ b/kgstatsSrv/src/test/java/ru/klavogonki/statistics/util/JacksonUtilsTest.java @@ -566,7 +566,7 @@ void brandNewPlayer() { .hasBookDone(null) // bookDone set for book dictionaries only ; - // minimal 0/null info for a brand new user + // minimal 0/null info for a brand-new user GetStatsOverviewGameTypeInfo normalStatsInfo = normalStats.getInfo(); GetStatsOverviewGameTypeInfoAssert .assertThat(normalStatsInfo)