Skip to content

Commit 585cd0f

Browse files
committed
docs: [#227] cleanup refactor plan after PR merge
- Move entry from active-refactorings.md to completed-refactorings.md - Add completion details (93 test functions, 14 helpers, 20 files, PR #228) - Delete refactoring plan document (work now in git history) - Clear active-refactorings.md table (no active refactorings)
1 parent 2709c28 commit 585cd0f

File tree

3 files changed

+24
-870
lines changed

3 files changed

+24
-870
lines changed
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Active Refactoring Plans
22

3-
| Document | Status | Issue | Target | Created |
4-
| ----------------------------------------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------- | ------------------------------------------------- | ------------ |
5-
| [Rename Test Functions to Follow Conventions](./plans/rename-test-functions-to-follow-conventions.md) | 📋 Planning | [#227](https://github.com/torrust/torrust-tracker-deployer/issues/227) | All test functions with `test_` prefix (21 files) | Dec 12, 2025 |
3+
| Document | Status | Issue | Target | Created |
4+
| -------- | ------ | ----- | ------ | ------- |
Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
11
# Completed Refactorings
22

3-
| Document | Completed | Target | Notes |
4-
| ---------------------------------------- | ------------ | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5-
| Command Code Quality Improvements | Dec 3, 2025 | `ProvisionCommand`, `ConfigureCommand` | See git history at `docs/refactors/plans/command-code-quality-improvements.md` - API simplification, state persistence, clock injection, trace writing, and test builders (5 of 9 proposals completed, 4 postponed for future work) |
6-
| User Output Architecture Improvements | Nov 13, 2025 | `src/presentation/views/` (formerly `user_output`) | See git history at `docs/refactors/plans/user-output-architecture-improvements.md` - Superseded by Presentation Layer Reorganization which renamed user_output to views and integrated it into four-layer MVC architecture |
7-
| Presentation Layer Reorganization | Nov 13, 2025 | `src/presentation/` | See git history at `docs/refactors/plans/presentation-layer-reorganization.md` - Transformed presentation layer into four-layer MVC architecture (Input → Dispatch → Controllers → Views), Epic #154 with 6 proposals, all completed |
8-
| 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) |
9-
| 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) |
10-
| 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) |
11-
| 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) |
12-
| 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) |
13-
| 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) |
14-
| 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) |
15-
| 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) |
16-
| 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) |
17-
| 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) |
18-
| 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) |
19-
| 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) |
20-
| 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 |
21-
| 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 |
22-
| 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 |
23-
| 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+
| Rename Test Functions to Follow Conventions | Dec 12, 2025 | All test functions with `test_` prefix (21 files) | See git history at `docs/refactors/plans/rename-test-functions-to-follow-conventions.md` - Renamed 93 test functions and 14 helper functions across 20 files to follow behavior-driven naming conventions (21 proposals, all completed), PR #228 |
6+
| Command Code Quality Improvements | Dec 3, 2025 | `ProvisionCommand`, `ConfigureCommand` | See git history at `docs/refactors/plans/command-code-quality-improvements.md` - API simplification, state persistence, clock injection, trace writing, and test builders (5 of 9 proposals completed, 4 postponed for future work) |
7+
| User Output Architecture Improvements | Nov 13, 2025 | `src/presentation/views/` (formerly `user_output`) | See git history at `docs/refactors/plans/user-output-architecture-improvements.md` - Superseded by Presentation Layer Reorganization which renamed user_output to views and integrated it into four-layer MVC architecture |
8+
| Presentation Layer Reorganization | Nov 13, 2025 | `src/presentation/` | See git history at `docs/refactors/plans/presentation-layer-reorganization.md` - Transformed presentation layer into four-layer MVC architecture (Input → Dispatch → Controllers → Views), Epic #154 with 6 proposals, all completed |
9+
| 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) |
10+
| 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) |
11+
| 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) |
12+
| 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) |
13+
| 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) |
14+
| 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) |
15+
| 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) |
16+
| 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) |
17+
| 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) |
18+
| 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) |
19+
| 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) |
20+
| 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) |
21+
| 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 |
22+
| 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 |
23+
| 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 |
24+
| 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)