release/v2.2.0 #61

Merged
KamaSK merged 2 commits from release/v2.2.0 into dev 2025-06-08 11:55:55 +03:00
4 changed files with 97 additions and 17 deletions

View File

@ -1,8 +1,32 @@
Все заметные изменения проекта будут документироваться в этом файле. # Журнал изменений
Все заметные изменения проекта будут документироваться в этом файле.
Формат основан на [Keep a Changelog](https://keepachangelog.com/ru/1.0.0/), Формат основан на [Keep a Changelog](https://keepachangelog.com/ru/1.0.0/),
и этот проект придерживается [Semantic Versioning](https://semver.org/spec/v2.0.0.html) и этот проект придерживается [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
## [2.2.0] - 2025-06-08
### Добавлено
- Универсальный интерфейс `Identifiable` для всех сущностей с ID
- Универсальный класс `EntityService` для стандартных CRUD-операций
- Универсальный интерфейс `Repository<T>` для базовых операций с данными
- Утилитарный класс `Formatter` с методом `asTable()` для форматирования таблиц
### Изменено
- **[BREAKING]** Обобщение CLI-команд для поддержки разных типов сущностей через `EntityService`
- Рефакторинг `TaskService` для расширения `EntityService` вместо собственной реализации
- Переименование `InMemoryTaskRepository``InMemoryRepository` с поддержкой generics
- Унификация работы с моделью `Task` через интерфейс `Identifiable`
- Вынесение логики форматирования таблиц из `ListCommand` в отдельный utility-класс
- Обновление `ListCommand` и `SearchCommand` для использования `Formatter.asTable()`
- Замена метода `list()` на `getAll()` в сервисном слое
### Технические улучшения
- Улучшена типобезопасность через использование generics
- Повышена переиспользуемость кода за счёт вынесения общей логики
- Упрощена архитектура через унификацию интерфейсов
- Удалено дублирование кода форматирования между командами
## [2.1.0] - 2025-06-01 ## [2.1.0] - 2025-06-01
### Добавлено ### Добавлено
@ -12,13 +36,12 @@
### Изменено ### Изменено
- Обновлены внутренние зависимости между компонентами CLI (`SearchCommand`, `ListCommand`) и моделью данных (`Task`, `SimpleTask`) - Обновлены внутренние зависимости между компонентами CLI (`SearchCommand`, `ListCommand`) и моделью данных (`Task`, `SimpleTask`)
- Добавлена обработка минимальной длины поискового запроса (3 символа) в `SearchCommand`# Журнал изменений - Добавлена обработка минимальной длины поискового запроса (3 символа) в `SearchCommand`
## [2.0.0] - 2025-05-29 ## [2.0.0] - 2025-05-29
### Добавлено ### Добавлено
- Базовая функциональность для управления задачами - Базовая функциональность для управления задачами
- Команды: create, list, delete - Команды: create, list, delete, complete
- Консольный интерфейс для взаимодействия с приложением - Консольный интерфейс для взаимодействия с приложением
- In-memory хранилище задач - In-memory хранилище задач

View File

@ -1,35 +1,92 @@
# TodoApp # TodoApp
## Описание ## Описание
TodoApp - это консольное приложение для управления списком задач, разработанное на Java в качестве учебного проекта. Приложение позволяет создавать, просматривать, отмечать как выполненные и удалять задачи через интерфейс командной строки.
TodoApp - это консольное приложение для управления списком задач, разработанное на Java в качестве учебного проекта. Приложение построено на универсальной архитектуре с использованием generics, что позволяет легко расширять функционал для работы с различными типами сущностей.
### Особенности
- Консольный интерфейс с интуитивными командами
- Универсальная архитектура на базе `EntityService` и `Repository<T>`
- Поддержка поиска задач по тексту
- Красивое табличное отображение данных
- Типобезопасность через использование generics
## Требования ## Требования
- Java 24 или выше - Java 24 или выше
- Maven 3.8.x или выше - Maven 3.8.x или выше
## Установка и запуск ## Установка и запуск
```bash ```bash
cd ./todo cd ./todo
mvn clean package mvn clean package
java -jar ./target/todo.jar java -jar ./target/todo.jar
``` ```
## Использование
### Доступные команды ### Доступные команды
- `create <названиеадачи>` - Создать новую задачу - `create <названиеадачи>` - Создать новую задачу
- `list` - Показать список всех задач - `list` - Показать список всех задач в табличном виде
- `complete <id>` - Отметить задачу как выполненную - `complete <id>` - Отметить задачу как выполненную
- `delete <id>` - Удалить задачу - `delete <id>` - Удалить задачу по ID
- `search <текст>` - Найти задачи по тексту - `search <текст>` - Найти задачи по тексту (минимум 3 символа)
- `help` - Показать список всех команд
- `exit` - Выйти из приложения - `exit` - Выйти из приложения
## Структура проекта
- `model` - Модели данных (Task, SimpleTask) ## Пример использования
- `repo` - Репозитории для хранения задач
- `service` - Бизнес-логика ```shell
- `cli` - Компоненты интерфейса командной строки todo> create Изучить Java generics
Задача "Изучить Java generics" успешно добавлена!
todo> create Написать документацию
Задача "Написать документацию" успешно добавлена!
todo> list
ID │ Название задачи │ Статус
--------------------------------------------------
1 │ Изучить Java generics │ В процессе
2 │ Написать документацию │ В процессе
todo> complete 1
Задача ID-1 выполнена.
todo> search Java
ID │ Название задачи │ Статус
--------------------------------------------------
1 │ Изучить Java generics │ Выполнена
```
## Версии ## Версии
Актуальная версия: 2.1
Актуальная версия: 2.2.0
### История изменений
- 2.2.0 - Универсальная архитектура с generics, утилиты форматирования
- 2.1.0 - Добавлена команда поиска, улучшено отображение
- 2.0.0 - Базовый функционал управления задачами
Подробная история изменений доступна в CHANGELOG.md
### Разработка
Проект использует современные подходы Java-разработки:
- Generic programming для типобезопасности
- Разделение ответственности через слоистую архитектуру
- Command pattern для CLI-команд
- Repository pattern для работы с данными
## Лицензия ## Лицензия
[MIT](LICENSE)
MIT

View File

@ -6,7 +6,7 @@
<groupId>ru.kamask.pet</groupId> <groupId>ru.kamask.pet</groupId>
<artifactId>todo</artifactId> <artifactId>todo</artifactId>
<version>2.2.0-SNAPSHOT</version> <version>2.2.0</version>
<properties> <properties>
<maven.compiler.release>24</maven.compiler.release> <maven.compiler.release>24</maven.compiler.release>

View File

@ -22,7 +22,7 @@ public class CliEngine {
} }
public void start() throws IOException { public void start() throws IOException {
System.out.println("\обро пожаловать в Список задач 2.1!"); System.out.println("\обро пожаловать в Список задач 2.2!");
System.out.println("Введите help для просмтора доступных команд или exit для выхода."); System.out.println("Введите help для просмтора доступных команд или exit для выхода.");
while (true) { while (true) {
System.out.print("\ntodo> "); System.out.print("\ntodo> ");