Compare commits

..

No commits in common. "main" and "2.0.0" have entirely different histories.
main ... 2.0.0

20 changed files with 95 additions and 281 deletions

1
.gitignore vendored
View File

@ -1,3 +1,2 @@
todo/target/ todo/target/
.vscode/ .vscode/
.lingma/

View File

@ -1,47 +1,14 @@
# Журнал изменений # Журнал изменений
Все заметные изменения проекта будут документироваться в этом файле. Все заметные изменения проекта будут документироваться в этом файле.
Формат основан на [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
### Добавлено
- Команда `search <текст>` для поиска задач по тексту (реализован класс `SearchCommand`)
- Метод `search(String query)` в `TaskService` для поддержки поиска задач
- Рефакторинг: вынесение общего функционала отображения задач в отдельный метод `formatWithTable()` в классе `ListCommand`
### Изменено
- Обновлены внутренние зависимости между компонентами CLI (`SearchCommand`, `ListCommand`) и моделью данных (`Task`, `SimpleTask`)
- Добавлена обработка минимальной длины поискового запроса (3 символа) в `SearchCommand`
## [2.0.0] - 2025-05-29 ## [2.0.0] - 2025-05-29
### Добавлено ### Добавлено
- Базовая функциональность для управления задачами - Базовая функциональность для управления задачами
- Команды: create, list, delete, complete - Команды: create, list, delete
- Консольный интерфейс для взаимодействия с приложением - Консольный интерфейс для взаимодействия с приложением
- In-memory хранилище задач - In-memory хранилище задач

View File

@ -1,92 +1,34 @@
# 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>` - Удалить задачу по ID - `delete <id>` - Удалить задачу
- `search <текст>` - Найти задачи по тексту (минимум 3 символа)
- `help` - Показать список всех команд
- `exit` - Выйти из приложения - `exit` - Выйти из приложения
## Структура проекта
## Пример использования - `model` - Модели данных (Task, SimpleTask)
- `repo` - Репозитории для хранения задач
```shell - `service` - Бизнес-логика
todo> create Изучить Java generics - `cli` - Компоненты интерфейса командной строки
Задача "Изучить Java generics" успешно добавлена!
todo> create Написать документацию
Задача "Написать документацию" успешно добавлена!
todo> list
ID │ Название задачи │ Статус
--------------------------------------------------
1 │ Изучить Java generics │ В процессе
2 │ Написать документацию │ В процессе
todo> complete 1
Задача ID-1 выполнена.
todo> search Java
ID │ Название задачи │ Статус
--------------------------------------------------
1 │ Изучить Java generics │ Выполнена
```
## Версии ## Версии
Актуальная версия: 2.0
Актуальная версия: 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</version> <version>2.0-SNAPSHOT</version>
<properties> <properties>
<maven.compiler.release>24</maven.compiler.release> <maven.compiler.release>24</maven.compiler.release>

View File

@ -3,13 +3,12 @@ package ru.kamask.pet.todo;
import java.io.IOException; import java.io.IOException;
import ru.kamask.pet.todo.cli.CliEngine; import ru.kamask.pet.todo.cli.CliEngine;
import ru.kamask.pet.todo.model.SimpleTask; import ru.kamask.pet.todo.repo.InMemoryTaskRepository;
import ru.kamask.pet.todo.repo.InMemoryRepository;
import ru.kamask.pet.todo.service.TaskService; import ru.kamask.pet.todo.service.TaskService;
public class TodoApp { public class TodoApp {
public static void main(String[] args) throws IOException { public static void main(String[] args) throws IOException {
var service = new TaskService(new InMemoryRepository<SimpleTask>()); var service = new TaskService(new InMemoryTaskRepository());
var cli = new CliEngine(service); var cli = new CliEngine(service);
cli.start(); cli.start();

View File

@ -7,22 +7,21 @@ import java.util.Arrays;
import java.util.HashMap; import java.util.HashMap;
import java.util.Optional; import java.util.Optional;
import ru.kamask.pet.todo.model.Identifiable; import ru.kamask.pet.todo.service.TaskService;
import ru.kamask.pet.todo.service.EntityService;
public class CliEngine { public class CliEngine {
private HashMap<String, Command> registry = new HashMap<>(); private HashMap<String, Command> registry = new HashMap<>();
private EntityService<? extends Identifiable> service; private TaskService service;
private BufferedReader reader; private BufferedReader reader;
public CliEngine(EntityService<? extends Identifiable> service) { public CliEngine(TaskService service) {
this.service = service; this.service = service;
reader = new BufferedReader(new InputStreamReader(System.in)); reader = new BufferedReader(new InputStreamReader(System.in));
initializeCommands(); initializeCommands();
} }
public void start() throws IOException { public void start() throws IOException {
System.out.println("\обро пожаловать в Список задач 2.2!"); System.out.println("\обро пожаловать в Список задач 2.0!");
System.out.println("Введите help для просмтора доступных команд или exit для выхода."); System.out.println("Введите help для просмтора доступных команд или exit для выхода.");
while (true) { while (true) {
System.out.print("\ntodo> "); System.out.print("\ntodo> ");
@ -47,7 +46,6 @@ public class CliEngine {
registerCommand(new CreateCommand()); registerCommand(new CreateCommand());
registerCommand(new ListCommand()); registerCommand(new ListCommand());
registerCommand(new CompleteCommand()); registerCommand(new CompleteCommand());
registerCommand(new SearchCommand());
registerCommand(new DeleteCommand()); registerCommand(new DeleteCommand());
} }

View File

@ -2,14 +2,13 @@ package ru.kamask.pet.todo.cli;
import java.util.Optional; import java.util.Optional;
import ru.kamask.pet.todo.model.Identifiable; import ru.kamask.pet.todo.service.TaskService;
import ru.kamask.pet.todo.service.EntityService;
public interface Command { public interface Command {
String templateUsage = " %-30s // %s"; String templateUsage = " %-30s // %s";
String errorMessage = "Не корректно введена команда. Введите help для спарвки."; String errorMessage = "Не корректно введена команда. Введите help для спарвки.";
Optional<String> handle(String[] args, EntityService<? extends Identifiable> service); Optional<String> handle(String[] args, TaskService service);
String name(); String name();

View File

@ -2,8 +2,6 @@ package ru.kamask.pet.todo.cli;
import java.util.Optional; import java.util.Optional;
import ru.kamask.pet.todo.model.Identifiable;
import ru.kamask.pet.todo.service.EntityService;
import ru.kamask.pet.todo.service.TaskService; import ru.kamask.pet.todo.service.TaskService;
public class CompleteCommand implements Command { public class CompleteCommand implements Command {
@ -18,16 +16,14 @@ public class CompleteCommand implements Command {
} }
@Override @Override
public Optional<String> handle(String[] args, EntityService<? extends Identifiable> service) { public Optional<String> handle(String[] args, TaskService service) {
if (args.length != 1) if (args.length != 1)
return Optional.of(Command.errorMessage); return Optional.of(Command.errorMessage);
TaskService taskService = (TaskService) service;
try { try {
int id = Integer.parseInt(args[0]); int id = Integer.parseInt(args[0]);
return Optional.of(taskService.complete(id) return Optional.of(service.complete(id)
? "Задача ID-%d выполнена.".formatted(id) ? "Задача ID-%d выполнена.".formatted(id)
: "Задача ID-%d не найдена.".formatted(id)); : "Задача ID-%d не найдена.".formatted(id));

View File

@ -2,8 +2,6 @@ package ru.kamask.pet.todo.cli;
import java.util.Optional; import java.util.Optional;
import ru.kamask.pet.todo.model.Identifiable;
import ru.kamask.pet.todo.service.EntityService;
import ru.kamask.pet.todo.service.TaskService; import ru.kamask.pet.todo.service.TaskService;
public class CreateCommand implements Command { public class CreateCommand implements Command {
@ -13,13 +11,12 @@ public class CreateCommand implements Command{
} }
@Override @Override
public Optional<String> handle(String[] args, EntityService<? extends Identifiable> service) { public Optional<String> handle(String[] args, TaskService service) {
if (args.length > 0) { if (args.length > 0) {
var title = String.join(" ", args); var title = String.join(" ", args);
if (title.length() > 30) if (title.length() > 30)
return Optional.of("Ошибка: максимальная длинна названия задачи 30 символов."); return Optional.of("Ошибка: максимальная длинна названия задачи 30 символов.");
TaskService taskService = (TaskService) service; service.create(title);
taskService.create(title);
return Optional.of(String.format("Задача \"%s\" успешно добавлена!", title)); return Optional.of(String.format("Задача \"%s\" успешно добавлена!", title));
} }
return Optional.of(Command.errorMessage); return Optional.of(Command.errorMessage);

View File

@ -2,8 +2,7 @@ package ru.kamask.pet.todo.cli;
import java.util.Optional; import java.util.Optional;
import ru.kamask.pet.todo.model.Identifiable; import ru.kamask.pet.todo.service.TaskService;
import ru.kamask.pet.todo.service.EntityService;
public class DeleteCommand implements Command { public class DeleteCommand implements Command {
@Override @Override
@ -17,7 +16,7 @@ public class DeleteCommand implements Command{
} }
@Override @Override
public Optional<String> handle(String[] args, EntityService<? extends Identifiable> service) { public Optional<String> handle(String[] args, TaskService service) {
if (args.length != 1) if (args.length != 1)
return Optional.of(Command.errorMessage); return Optional.of(Command.errorMessage);

View File

@ -2,10 +2,9 @@ package ru.kamask.pet.todo.cli;
import java.util.Optional; import java.util.Optional;
import ru.kamask.pet.todo.model.Identifiable; import ru.kamask.pet.todo.model.SimpleTask;
import ru.kamask.pet.todo.service.EntityService; import ru.kamask.pet.todo.model.Task;
import ru.kamask.pet.todo.service.TaskService; import ru.kamask.pet.todo.service.TaskService;
import ru.kamask.pet.todo.util.Formatter;
public class ListCommand implements Command { public class ListCommand implements Command {
@Override @Override
@ -14,13 +13,23 @@ public class ListCommand implements Command {
} }
@Override @Override
public Optional<String> handle(String[] args, EntityService<? extends Identifiable> service) { public Optional<String> handle(String[] args, TaskService service) {
if (args.length > 0) if (args.length > 0)
return Optional.of(Command.errorMessage); return Optional.of(Command.errorMessage);
TaskService taskService = (TaskService) service; String template = "%-2s | %-30s | %s\n";
String res = "";
res += String.format(template, "ID", "Название задачи", "Статус");
res += "-".repeat(50) + "\n";
return Optional.of(Formatter.asTable(taskService.getAll())); if (service.list().size() == 0)
return Optional.of(res + "\nСписок задач пуст.");
for (Task task : service.list()) {
SimpleTask.Data data = ((SimpleTask) task).data();
res += String.format(template, data.id(), data.title(), data.done() ? "выполнено" : "не выполнено");
}
return Optional.of(res);
} }
@Override @Override

View File

@ -1,34 +0,0 @@
package ru.kamask.pet.todo.cli;
import java.util.Optional;
import ru.kamask.pet.todo.model.Identifiable;
import ru.kamask.pet.todo.service.EntityService;
import ru.kamask.pet.todo.service.TaskService;
import ru.kamask.pet.todo.util.Formatter;
public class SearchCommand implements Command {
@Override
public String name() {
return "search";
}
@Override
public String usage() {
return String.format(templateUsage, name() + " <текст>", "Поиск задач по тексту (минимум 3 символа)");
}
@Override
public Optional<String> handle(String[] args, EntityService<? extends Identifiable> service) {
if (args.length != 1)
return Optional.of(Command.errorMessage);
if (args[0].length() < 3)
return Optional.of("Длина запроса должна быть не менее 3 символов.");
TaskService taskService = (TaskService) service;
var matchTask = taskService.search(args[0]);
return Optional.of(Formatter.asTable(matchTask, "Не найдено задач, соответствующих запросу."));
}
}

View File

@ -1,5 +0,0 @@
package ru.kamask.pet.todo.model;
public interface Identifiable {
int getId();
}

View File

@ -1,6 +1,6 @@
package ru.kamask.pet.todo.model; package ru.kamask.pet.todo.model;
public abstract class Task implements Identifiable{ public abstract class Task {
private static int nextId = 1; private static int nextId = 1;
protected int id; protected int id;
@ -11,13 +11,8 @@ public abstract class Task implements Identifiable{
this.title = title; this.title = title;
} }
@Override
public int getId() {
return id;
}
public int id() { public int id() {
return getId(); return id;
} }
@Override @Override

View File

@ -6,23 +6,23 @@ import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Optional; import java.util.Optional;
import ru.kamask.pet.todo.model.Identifiable; import ru.kamask.pet.todo.model.Task;
public class InMemoryRepository<T extends Identifiable> implements Repository<T> { public class InMemoryTaskRepository implements TaskRepository {
private Map<Integer, T> storage = new HashMap<>(); private Map<Integer, Task> storage = new HashMap<>();
@Override @Override
public void save(T obj) { public void save(Task task) {
storage.put(obj.getId(), obj); storage.put(task.id(), task);
} }
@Override @Override
public Optional<T> findById(int id) { public Optional<Task> findById(int id) {
return Optional.ofNullable(storage.get(id)); return Optional.ofNullable(storage.get(id));
} }
@Override @Override
public List<T> findAll() { public List<Task> findAll() {
return new ArrayList<>(storage.values()); return new ArrayList<>(storage.values());
} }

View File

@ -1,14 +0,0 @@
package ru.kamask.pet.todo.repo;
import java.util.List;
import java.util.Optional;
import ru.kamask.pet.todo.model.Identifiable;
public interface Repository<T extends Identifiable> {
void save(T obj);
Optional<T> findById(int id);
List<T> findAll();
void delete(int id);
boolean has(int id);
}

View File

@ -0,0 +1,18 @@
package ru.kamask.pet.todo.repo;
import java.util.List;
import java.util.Optional;
import ru.kamask.pet.todo.model.Task;
public interface TaskRepository {
void save(Task task);
Optional<Task> findById(int id);
List<Task> findAll();
void delete(int id);
boolean has(int id);
}

View File

@ -1,35 +0,0 @@
package ru.kamask.pet.todo.service;
import java.util.List;
import java.util.Optional;
import ru.kamask.pet.todo.model.Identifiable;
import ru.kamask.pet.todo.repo.Repository;
public class EntityService<T extends Identifiable> {
private final Repository<T> repo;
protected EntityService(Repository<T> repo) {
this.repo = repo;
}
public void save(T obj) {
repo.save(obj);
}
public Optional<T> getById(int id) {
return repo.findById(id);
}
public List<T> getAll() {
return repo.findAll();
}
public void remove(int id) {
repo.delete(id);
}
public boolean has(int id) {
return repo.has(id);
}
}

View File

@ -1,23 +1,29 @@
package ru.kamask.pet.todo.service; package ru.kamask.pet.todo.service;
import java.util.List; import java.util.List;
import java.util.Optional;
import ru.kamask.pet.todo.model.Task;
import ru.kamask.pet.todo.model.SimpleTask; import ru.kamask.pet.todo.model.SimpleTask;
import ru.kamask.pet.todo.repo.Repository; import ru.kamask.pet.todo.repo.TaskRepository;
public class TaskService extends EntityService<SimpleTask> { public class TaskService {
private final TaskRepository repo;
public TaskService(Repository<SimpleTask> repo) { public TaskService(TaskRepository repo) {
super(repo); this.repo = repo;
} }
public void create(String title) { public void create(String title) {
super.save(new SimpleTask(title)); repo.save(new SimpleTask(title));
} }
public Optional<Task> getById(int id) {
return repo.findById(id);
}
public boolean complete(int id) { public boolean complete(int id) {
var taskOpt = super.getById(id); var taskOpt = repo.findById(id);
if (taskOpt.isPresent()) { if (taskOpt.isPresent()) {
taskOpt.get().markAsCompleted(); taskOpt.get().markAsCompleted();
return true; return true;
@ -25,10 +31,15 @@ public class TaskService extends EntityService<SimpleTask> {
return false; return false;
} }
public List<Task> list() {
return repo.findAll();
}
public List<SimpleTask> search(String query) { public void remove(int id) {
return super.getAll().stream() repo.delete(id);
.filter(task -> task.data().title().contains(query)) }
.toList();
public boolean has(int id) {
return repo.has(id);
} }
} }

View File

@ -1,27 +0,0 @@
package ru.kamask.pet.todo.util;
import java.util.List;
import ru.kamask.pet.todo.model.SimpleTask;
public class Formatter {
public static String asTable(List<SimpleTask> tasks){
return asTable(tasks, "Список задач пуст.");
}
public static String asTable(List<SimpleTask> tasks, String msgIfEmpty){
String template = "%-2s | %-30s | %s\n";
var res = new StringBuilder(String.format(template, "ID", "Название задачи", "Статус"));
res.append("-".repeat(50) + "\n");
if (tasks.size() == 0)
return res.append("\n" + msgIfEmpty).toString();
for (SimpleTask task : tasks) {
SimpleTask.Data data = task.data();
res.append(String.format(template, data.id(), data.title(), data.done() ? "выполнено" : "не выполнено"));
}
return res.toString();
}
}