Merge pull request 'dev' (#39) from dev into main

Reviewed-on: #39

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Журнал изменений
+
+Все заметные изменения проекта будут документироваться в этом файле.
+
+Формат основан на [Keep a Changelog](https://keepachangelog.com/ru/1.0.0/),
+и этот проект придерживается [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0] - 2025-05-29
+
+### Добавлено
+- Базовая функциональность для управления задачами
+- Команды: create, list, delete
+- Консольный интерфейс для взаимодействия с приложением
+- In-memory хранилище задач 

README.md

@@ -0,0 +1,34 @@
+# TodoApp
+
+## Описание
+TodoApp - это консольное приложение для управления списком задач, разработанное на Java в качестве учебного проекта. Приложение позволяет создавать, просматривать, отмечать как выполненные и удалять задачи через интерфейс командной строки.
+
+## Требования
+- Java 24 или выше
+- Maven 3.8.x или выше
+
+## Установка и запуск
+```bash
+cd ./todo
+mvn clean package
+java -jar ./target/todo.jar
+```
+
+### Доступные команды
+- `create <название_задачи>` - Создать новую задачу
+- `list` - Показать список всех задач
+- `complete <id>` - Отметить задачу как выполненную
+- `delete <id>` - Удалить задачу
+- `exit` - Выйти из приложения
+
+## Структура проекта
+- `model` - Модели данных (Task, SimpleTask)
+- `repo` - Репозитории для хранения задач
+- `service` - Бизнес-логика
+- `cli` - Компоненты интерфейса командной строки
+
+## Версии
+Актуальная версия: 2.0
+
+## Лицензия
+[MIT](LICENSE) 

todo/pom.xml

@@ -6,10 +6,40 @@
 
     <groupId>ru.kamask.pet</groupId>
     <artifactId>todo</artifactId>
-    <version>1.0-SNAPSHOT</version>
+    <version>2.0-SNAPSHOT</version>
 
     <properties>
         <maven.compiler.release>24</maven.compiler.release>
+        <maven.compiler.target>24</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
 
+    <build>
+        <finalName>todo</finalName>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <version>3.4.2</version>
+                <configuration>
+                    <archive>
+                        <manifest>
+                            <mainClass>ru.kamask.pet.todo.TodoApp</mainClass>
+                        </manifest>
+                    </archive>
+                </configuration>
+            </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.14.0</version>
+                <configuration>
+                    <source>24</source>
+                    <target>24</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
 </project>

todo/src/main/java/ru/kamask/pet/Task.java

@@ -1,23 +0,0 @@
-package ru.kamask.pet;
-
-public class Task {
-    int id;
-    String title;
-    String description;
-    boolean completed;
-
-    Task(String title, String description){
-        this.id = 0;
-        this.title = title;
-        this.description = description;
-        this.completed = false;
-    }
-
-    void printInfo(){
-        System.out.println(this.title + ": " + (this.completed ? "выполнена." : "в процессе"));
-    }
-
-    void markAsCompleted(){
-        this.completed = true;
-    }
-}

todo/src/main/java/ru/kamask/pet/TodoApp.java

@@ -1,13 +0,0 @@
-package ru.kamask.pet;
-
-public class TodoApp {
-    public static void main(String[] args) {
-        Task t1 = new Task("Первая задача", "Уррааа! Первая задача!");
-        Task t2 = new Task("Вторя задача", "Ну, вторая уже не первая)))");
-        t1.printInfo();
-        t2.printInfo();
-        t1.markAsCompleted();
-        t1.printInfo();
-        t2.printInfo();
-    }
-}

todo/src/main/java/ru/kamask/pet/todo/TodoApp.java

@@ -0,0 +1,17 @@
+package ru.kamask.pet.todo;
+
+import java.io.IOException;
+
+import ru.kamask.pet.todo.cli.CliEngine;
+import ru.kamask.pet.todo.repo.InMemoryTaskRepository;
+import ru.kamask.pet.todo.service.TaskService;
+
+public class TodoApp {
+    public static void main(String[] args) throws IOException {
+        var service = new TaskService(new InMemoryTaskRepository());
+        var cli = new CliEngine(service);
+
+        cli.start();
+    }
+
+}

todo/src/main/java/ru/kamask/pet/todo/cli/CliEngine.java

@@ -0,0 +1,69 @@
+package ru.kamask.pet.todo.cli;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Optional;
+
+import ru.kamask.pet.todo.service.TaskService;
+
+public class CliEngine {
+    private HashMap<String, Command> registry = new HashMap<>();
+    private TaskService service;
+    private BufferedReader reader;
+
+    public CliEngine(TaskService service) {
+        this.service = service;
+        reader = new BufferedReader(new InputStreamReader(System.in));
+        initializeCommands();
+    }
+
+    public void start() throws IOException {
+        System.out.println("\nДобро пожаловать в Список задач 2.0!");
+        System.out.println("Введите help для просмтора доступных команд или exit для выхода.");
+        while (true) {
+            System.out.print("\ntodo> ");
+            var input = reader.readLine().trim();
+            System.out.println();
+            switch (input) {
+                case "help" -> handleHelp();
+                case "exit" -> System.exit(0);
+                default -> handleCommand(input).ifPresentOrElse(System.out::println, () -> {
+                    System.out.println("Не известная команда. Повторите ввод.\n");
+                    handleHelp();
+                });
+            }
+        }
+    }
+
+    void registerCommand(Command command) {
+        registry.put(command.name(), command);
+    }
+
+    void initializeCommands() {
+        registerCommand(new CreateCommand());
+        registerCommand(new ListCommand());
+        registerCommand(new CompleteCommand());
+        registerCommand(new DeleteCommand());
+    }
+
+    void handleHelp() {
+        registry.values().stream().map(handler -> handler.usage()).forEach(System.out::println);
+        System.out.printf(Command.templateUsage, "help", "Вот этот список команд\n");
+        System.out.printf(Command.templateUsage, "exit", "Выход, но лучше не надо)\n");
+
+    }
+
+    Optional<String> handleCommand(String input) {
+        var parts = input.split("\\s+");
+        var command = parts[0];
+        var args = Arrays.copyOfRange(parts, 1, parts.length);
+
+        var handlerOpt = Optional.ofNullable(registry.get(command));
+        if (handlerOpt.isPresent())
+            return handlerOpt.get().handle(args, service);
+        return Optional.empty();
+    }
+}

todo/src/main/java/ru/kamask/pet/todo/cli/Command.java

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

todo/src/main/java/ru/kamask/pet/todo/cli/CompleteCommand.java

@@ -0,0 +1,34 @@
+package ru.kamask.pet.todo.cli;
+
+import java.util.Optional;
+
+import ru.kamask.pet.todo.service.TaskService;
+
+public class CompleteCommand implements Command {
+    @Override
+    public String name() {
+        return "complete";
+    }
+
+    @Override
+    public String usage() {
+        return String.format(Command.templateUsage, name() + " <ID>", "Отметить задачу как \"выполнена\".");
+    }
+
+    @Override
+    public Optional<String> handle(String[] args, TaskService service) {
+        if (args.length != 1)
+            return Optional.of(Command.errorMessage);
+
+        try {
+            int id = Integer.parseInt(args[0]);
+
+            return Optional.of(service.complete(id)
+                    ? "Задача ID-%d выполнена.".formatted(id)
+                    : "Задача ID-%d не найдена.".formatted(id));
+
+        } catch (NumberFormatException e) {
+            return Optional.of("ID - должен быть числом.");
+        }
+    }
+}

todo/src/main/java/ru/kamask/pet/todo/cli/CreateCommand.java

@@ -0,0 +1,29 @@
+package ru.kamask.pet.todo.cli;
+
+import java.util.Optional;
+
+import ru.kamask.pet.todo.service.TaskService;
+
+public class CreateCommand implements Command {
+    @Override
+    public String name() {
+        return "create";
+    }
+
+    @Override
+    public Optional<String> handle(String[] args, TaskService service) {
+        if (args.length > 0) {
+            var title = String.join(" ", args);
+            if (title.length() > 30)
+                return Optional.of("Ошибка: максимальная длинна названия задачи 30 символов.");
+            service.create(title);
+            return Optional.of(String.format("Задача \"%s\" успешно добавлена!", title));
+        }
+        return Optional.of(Command.errorMessage);
+    }
+
+    @Override
+    public String usage() {
+        return String.format(templateUsage, name() + " <название_задачи>", "Добавление новой задачи");
+    }
+}

todo/src/main/java/ru/kamask/pet/todo/cli/DeleteCommand.java

@@ -0,0 +1,35 @@
+package ru.kamask.pet.todo.cli;
+
+import java.util.Optional;
+
+import ru.kamask.pet.todo.service.TaskService;
+
+public class DeleteCommand implements Command {
+    @Override
+    public String name() {
+        return "delete";
+    }
+
+    @Override
+    public String usage() {
+        return String.format(Command.templateUsage, name() + " <ID>", "Удалить задачу.");
+    }
+
+    @Override
+    public Optional<String> handle(String[] args, TaskService service) {
+        if (args.length != 1)
+            return Optional.of(Command.errorMessage);
+
+        try {
+            int id = Integer.parseInt(args[0]);
+            if (!service.has(id))
+                return Optional.of("Задача ID-%d не найдена.".formatted(id));
+            service.remove(id);
+            return Optional.of("Задача ID-%d удалена.".formatted(id));
+
+        } catch (NumberFormatException e) {
+            return Optional.of("ID - должен быть числом.");
+        }
+    }
+
+}

todo/src/main/java/ru/kamask/pet/todo/cli/ListCommand.java

@@ -0,0 +1,39 @@
+package ru.kamask.pet.todo.cli;
+
+import java.util.Optional;
+
+import ru.kamask.pet.todo.model.SimpleTask;
+import ru.kamask.pet.todo.model.Task;
+import ru.kamask.pet.todo.service.TaskService;
+
+public class ListCommand implements Command {
+    @Override
+    public String name() {
+        return "list";
+    }
+
+    @Override
+    public Optional<String> handle(String[] args, TaskService service) {
+        if (args.length > 0)
+            return Optional.of(Command.errorMessage);
+
+        String template = "%-2s | %-30s | %s\n";
+        String res = "";
+        res += String.format(template, "ID", "Название задачи", "Статус");
+        res += "-".repeat(50) + "\n";
+
+        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
+    public String usage() {
+        return String.format(templateUsage, name(), "Список всех задач.");
+    }
+}

todo/src/main/java/ru/kamask/pet/todo/model/DataBuilder.java

@@ -0,0 +1,5 @@
+package ru.kamask.pet.todo.model;
+
+public interface DataBuilder<T> {
+    T data();
+}

todo/src/main/java/ru/kamask/pet/todo/model/SimpleTask.java

@@ -0,0 +1,35 @@
+package ru.kamask.pet.todo.model;
+
+public class SimpleTask extends Task implements DataBuilder<SimpleTask.Data> {
+    private boolean done = false;
+
+    public SimpleTask(String title) {
+        super(title);
+    }
+
+    @Override
+    public void markAsCompleted() {
+        done();
+    }
+
+    @Override
+    public boolean isCompleted() {
+        return isDone();
+    }
+
+    void done() {
+        done = true;
+    }
+
+    boolean isDone() {
+        return done;
+    }
+
+    @Override
+    public Data data() {
+        return new Data(id, title, done);
+    }
+
+    public record Data(int id, String title, boolean done) {
+    }
+}

todo/src/main/java/ru/kamask/pet/todo/model/Task.java

@@ -0,0 +1,27 @@
+package ru.kamask.pet.todo.model;
+
+public abstract class Task {
+    private static int nextId = 1;
+
+    protected int id;
+    protected String title;
+
+    Task(String title) {
+        this.id = nextId++;
+        this.title = title;
+    }
+
+    public int id() {
+        return id;
+    }
+
+    @Override
+    public String toString() {
+        return String.format("Задача: id - %d, title: \"%s\"", id, title);
+    }
+
+    abstract public void markAsCompleted();
+
+    abstract public boolean isCompleted();
+
+}

todo/src/main/java/ru/kamask/pet/todo/repo/InMemoryTaskRepository.java

@@ -0,0 +1,37 @@
+package ru.kamask.pet.todo.repo;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+
+import ru.kamask.pet.todo.model.Task;
+
+public class InMemoryTaskRepository implements TaskRepository {
+    private Map<Integer, Task> storage = new HashMap<>();
+
+    @Override
+    public void save(Task task) {
+        storage.put(task.id(), task);
+    }
+
+    @Override
+    public Optional<Task> findById(int id) {
+        return Optional.ofNullable(storage.get(id));
+    }
+
+    @Override
+    public List<Task> findAll() {
+        return new ArrayList<>(storage.values());
+    }
+
+    @Override
+    public void delete(int id) {
+        storage.remove(id);
+    }
+
+    public boolean has(int id) {
+        return storage.containsKey(id);
+    }
+}

todo/src/main/java/ru/kamask/pet/todo/repo/TaskRepository.java

@@ -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);
+}

todo/src/main/java/ru/kamask/pet/todo/service/TaskService.java

@@ -0,0 +1,45 @@
+package ru.kamask.pet.todo.service;
+
+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.repo.TaskRepository;
+
+public class TaskService {
+    private final TaskRepository repo;
+
+    public TaskService(TaskRepository repo) {
+        this.repo = repo;
+    }
+
+    public void create(String title) {
+        repo.save(new SimpleTask(title));
+    }
+
+    public Optional<Task> getById(int id) {
+        return repo.findById(id);
+    }
+
+    public boolean complete(int id) {
+        var taskOpt = repo.findById(id);
+        if (taskOpt.isPresent()) {
+            taskOpt.get().markAsCompleted();
+            return true;
+        }
+        return false;
+    }
+
+    public List<Task> list() {
+        return repo.findAll();
+    }
+
+    public void remove(int id) {
+        repo.delete(id);
+    }
+
+    public boolean has(int id) {
+        return repo.has(id);
+    }
+}