Skip to content

Commit e473aef

Browse files
committed
chore: mark two refactorings as completed
Moved 2 refactoring entries from active to completed: - Presentation Commands Cleanup (11 proposals completed) - Move Config Module to Create Command (1 proposal completed) Deleted completed refactoring plan documents: - docs/refactors/plans/presentation-commands-cleanup.md - docs/refactors/plans/move-config-to-create-command.md Updated documentation: - docs/refactors/active-refactorings.md (removed completed entries) - docs/refactors/completed-refactorings.md (added completed entries) These refactorings improved code organization, eliminated duplication, and aligned the codebase with DDD principles.
1 parent 034cf9f commit e473aef

File tree

4 files changed

+21
-2444
lines changed

4 files changed

+21
-2444
lines changed
Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Active Refactoring Plans
22

3-
| Document | Status | Issue | Target | Created |
4-
| --------------------------------------------------------------------------------- | -------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------- | ------------ |
5-
| [Command Code Quality Improvements](./plans/command-code-quality-improvements.md) | 🚧 In Progress | - | `ProvisionCommand`, `ConfigureCommand` | Oct 7, 2025 |
6-
| [Presentation Commands Cleanup](./plans/presentation-commands-cleanup.md) | 📋 Planning | - | `src/presentation/commands` module | Oct 28, 2025 |
7-
| [Move Config Module to Create Command](./plans/move-config-to-create-command.md) | 📋 Planning | [#75](https://github.com/torrust/torrust-tracker-deployer/issues/75) | `src/domain/config``src/application/command_handlers/create/config` | Oct 28, 2025 |
3+
| Document | Status | Issue | Target | Created |
4+
| --------------------------------------------------------------------------------- | -------------- | ----- | -------------------------------------- | ----------- |
5+
| [Command Code Quality Improvements](./plans/command-code-quality-improvements.md) | 🚧 In Progress | - | `ProvisionCommand`, `ConfigureCommand` | Oct 7, 2025 |
Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# Completed Refactorings
22

3-
| Document | Completed | Target | Notes |
4-
| ---------------------------------------- | ------------ | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5-
| Command Handlers Refactoring | Oct 28, 2025 | All command handlers | See git history at `docs/refactors/plans/command-handlers-refactoring.md` - Comprehensive refactoring covering error handling, logging patterns, and method organization across all command handlers (7 proposals, all completed) |
6-
| Consolidate Adapters in src/adapters/ | Oct 15, 2025 | External tool adapters organization | See `docs/refactors/plans/consolidate-adapters-in-src-adapters.md` - Moved all external tool adapters to unified `src/adapters/` module for better discoverability and consistency (4 proposals, all completed) |
7-
| SSH Client Code Quality Improvements | Oct 15, 2025 | `SshClient`, `SshConfig` | See git history at `docs/refactors/ssh-client-code-quality-improvements.md` - Extracted magic numbers into SshConnectionConfig, improved test quality, enhanced error context (7 of 8 proposals completed, 2 discarded) |
8-
| SSH Server Testing Improvements | Oct 14, 2025 | `testing/integration/ssh_server/` | See git history at `docs/refactors/ssh-server-testing-improvements.md` - Refactored SSH server testing module with trait abstractions, proper error handling, and Docker client injection (13 of 15 proposals completed) |
9-
| SSH Client Integration Tests Refactor | Oct 13, 2025 | `tests/ssh_client_integration.rs` | See git history at `docs/refactors/ssh-client-integration-tests-refactor.md` - Split monolithic test file into focused modules, eliminated ~80% code duplication (4 of 5 proposals completed) |
10-
| Repository Rename to Deployer | Oct 10, 2025 | Repository and package names | Renamed from "Torrust Tracker Deploy" to "Torrust Tracker Deployer" - Updated all references, package names, and added deprecation notices to PoC repositories (5 proposals, all completed) |
11-
| Environment Context Three-Way Split | Oct 8, 2025 | `EnvironmentContext` | See git history at `docs/refactors/environment-context-three-way-split.md` - Split context into UserInputs, InternalConfig, and RuntimeOutputs (4 proposals, all completed) |
12-
| Environment Context Extraction | Oct 8, 2025 | `Environment<S>`, `AnyEnvironmentState` | See git history at `docs/refactors/environment-context-extraction.md` - Extracted EnvironmentContext from Environment to reduce pattern matching (2 phases, all completed) |
13-
| JSON File Repository Improvements | Oct 3, 2025 | `json_file_repository.rs` | See git history at `docs/refactors/json-file-repository-improvements.md` for the complete refactoring plan (9 proposals, all completed) |
14-
| File Lock Improvements | Oct 3, 2025 | `file_lock.rs` | See git history at `docs/refactors/file-lock-improvements.md` for the complete refactoring plan (10 proposals, all completed) |
15-
| Command Preparation for State Management | Oct 7, 2025 | `ProvisionCommand`, `ConfigureCommand` | See git history at `docs/refactors/command-preparation-for-state-management.md` - Refactored commands to prepare for type-state pattern integration |
16-
| Error Context with Trace Files | Oct 7, 2025 | Error handling infrastructure | See git history at `docs/refactors/error-context-with-trace-files.md` - Replaced string-based error context with structured, type-safe context and trace files |
17-
| Error Kind Classification Strategy | Oct 7, 2025 | `Traceable` trait, error types | See git history at `docs/refactors/error-kind-classification-strategy.md` - Moved error kind determination into error types via `Traceable` trait |
18-
| Step Tracking for Failure Context | Oct 7, 2025 | Command execution flow | See git history at `docs/refactors/step-tracking-for-failure-context.md` - Added explicit step tracking to eliminate reverse engineering from error types |
3+
| Document | Completed | Target | Notes |
4+
| ---------------------------------------- | ------------ | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5+
| Presentation Commands Cleanup | Oct 30, 2025 | `src/presentation/commands` module | See git history at `docs/refactors/plans/presentation-commands-cleanup.md` - Eliminated duplication, improved abstraction, enhanced testability, and ensured consistent patterns across command handlers (11 proposals, all completed) |
6+
| Move Config Module to Create Command | Oct 30, 2025 | `src/domain/config``src/application/command_handlers/create/config` | See git history at `docs/refactors/plans/move-config-to-create-command.md` - Moved config DTOs from domain to application layer to align with DDD principles (1 proposal, completed) |
7+
| Command Handlers Refactoring | Oct 28, 2025 | All command handlers | See git history at `docs/refactors/plans/command-handlers-refactoring.md` - Comprehensive refactoring covering error handling, logging patterns, and method organization across all command handlers (7 proposals, all completed) |
8+
| Consolidate Adapters in src/adapters/ | Oct 15, 2025 | External tool adapters organization | See `docs/refactors/plans/consolidate-adapters-in-src-adapters.md` - Moved all external tool adapters to unified `src/adapters/` module for better discoverability and consistency (4 proposals, all completed) |
9+
| SSH Client Code Quality Improvements | Oct 15, 2025 | `SshClient`, `SshConfig` | See git history at `docs/refactors/ssh-client-code-quality-improvements.md` - Extracted magic numbers into SshConnectionConfig, improved test quality, enhanced error context (7 of 8 proposals completed, 2 discarded) |
10+
| SSH Server Testing Improvements | Oct 14, 2025 | `testing/integration/ssh_server/` | See git history at `docs/refactors/ssh-server-testing-improvements.md` - Refactored SSH server testing module with trait abstractions, proper error handling, and Docker client injection (13 of 15 proposals completed) |
11+
| SSH Client Integration Tests Refactor | Oct 13, 2025 | `tests/ssh_client_integration.rs` | See git history at `docs/refactors/ssh-client-integration-tests-refactor.md` - Split monolithic test file into focused modules, eliminated ~80% code duplication (4 of 5 proposals completed) |
12+
| Repository Rename to Deployer | Oct 10, 2025 | Repository and package names | Renamed from "Torrust Tracker Deploy" to "Torrust Tracker Deployer" - Updated all references, package names, and added deprecation notices to PoC repositories (5 proposals, all completed) |
13+
| Environment Context Three-Way Split | Oct 8, 2025 | `EnvironmentContext` | See git history at `docs/refactors/environment-context-three-way-split.md` - Split context into UserInputs, InternalConfig, and RuntimeOutputs (4 proposals, all completed) |
14+
| Environment Context Extraction | Oct 8, 2025 | `Environment<S>`, `AnyEnvironmentState` | See git history at `docs/refactors/environment-context-extraction.md` - Extracted EnvironmentContext from Environment to reduce pattern matching (2 phases, all completed) |
15+
| JSON File Repository Improvements | Oct 3, 2025 | `json_file_repository.rs` | See git history at `docs/refactors/json-file-repository-improvements.md` for the complete refactoring plan (9 proposals, all completed) |
16+
| File Lock Improvements | Oct 3, 2025 | `file_lock.rs` | See git history at `docs/refactors/file-lock-improvements.md` for the complete refactoring plan (10 proposals, all completed) |
17+
| Command Preparation for State Management | Oct 7, 2025 | `ProvisionCommand`, `ConfigureCommand` | See git history at `docs/refactors/command-preparation-for-state-management.md` - Refactored commands to prepare for type-state pattern integration |
18+
| Error Context with Trace Files | Oct 7, 2025 | Error handling infrastructure | See git history at `docs/refactors/error-context-with-trace-files.md` - Replaced string-based error context with structured, type-safe context and trace files |
19+
| Error Kind Classification Strategy | Oct 7, 2025 | `Traceable` trait, error types | See git history at `docs/refactors/error-kind-classification-strategy.md` - Moved error kind determination into error types via `Traceable` trait |
20+
| Step Tracking for Failure Context | Oct 7, 2025 | Command execution flow | See git history at `docs/refactors/step-tracking-for-failure-context.md` - Added explicit step tracking to eliminate reverse engineering from error types |

0 commit comments

Comments
 (0)