Skip to content

Commit 660c01d

Browse files
josecelanojosecelano
committed
feat(clock): rename crate torrust-tracker-clock to torrust-clock torrust#1821
Rename the `torrust-tracker-clock` crate to `torrust-clock` as specified in issue torrust#1821 (sub-issue SI-09 of EPIC torrust#1669). - Rename `name` in `packages/clock/Cargo.toml` - Update root workspace dependency key - Update all 12 dependent package `Cargo.toml` files - Replace all `torrust_tracker_clock::` references in Rust source files - Update prose in README, AGENTS.md, docs/release_process.md, skills Crates.io publish/deprecation/yank steps are deferred to SI-13. All CI checks pass: `cargo build --workspace`, `cargo test --workspace`, `linter all`.
1 parent 6f49a22 commit 660c01d

139 files changed

Lines changed: 257 additions & 256 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/skills/dev/git-workflow/release-new-version/SKILL.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ ran successfully and the following crates were published:
103103
- `torrust-tracker-contrib-bencode`
104104
- `torrust-tracker-located-error`
105105
- `torrust-tracker-primitives`
106-
- `torrust-tracker-clock`
106+
- `torrust-clock`
107107
- `torrust-tracker-configuration`
108108
- `torrust-tracker-torrent-repository`
109109
- `torrust-tracker-test-helpers`

‎.github/skills/dev/testing/write-unit-test/SKILL.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -141,17 +141,17 @@ automatically selects `Working` in production and `Stopped` in tests:
141141
```rust
142142
/// Working version, for production.
143143
#[cfg(not(test))]
144-
pub(crate) type CurrentClock = torrust_tracker_clock::clock::Working;
144+
pub(crate) type CurrentClock = torrust_clock::clock::Working;
145145

146146
/// Stopped version, for testing.
147147
#[cfg(test)]
148-
pub(crate) type CurrentClock = torrust_tracker_clock::clock::Stopped;
148+
pub(crate) type CurrentClock = torrust_clock::clock::Stopped;
149149
```
150150

151151
In production code, obtain the current time via the `Time` trait:
152152

153153
```rust
154-
use torrust_tracker_clock::clock::Time as _;
154+
use torrust_clock::clock::Time as _;
155155

156156
pub fn is_peer_expired(last_seen: std::time::Duration, ttl: u32) -> bool {
157157
let now = CurrentClock::now(); // returns DurationSinceUnixEpoch (= std::time::Duration)
@@ -169,8 +169,8 @@ thread-local, so tests are isolated from each other by default.
169169
mod tests {
170170
use std::time::Duration;
171171

172-
use torrust_tracker_clock::clock::{stopped::Stopped as _, Time as _};
173-
use torrust_tracker_clock::clock::Stopped;
172+
use torrust_clock::clock::{stopped::Stopped as _, Time as _};
173+
use torrust_clock::clock::Stopped;
174174

175175
use super::*;
176176

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ All packages live under `packages/`. The workspace version is `3.0.0-develop`.
6464
| `axum-http-tracker-server` | `torrust-tracker-axum-http-server` | `axum-*` | BitTorrent HTTP tracker server (BEP 3/23) |
6565
| `axum-rest-tracker-api-server` | `torrust-tracker-axum-rest-api-server` | `axum-*` | Management REST API server |
6666
| `axum-server` | `torrust-tracker-axum-server` | `axum-*` | Base Axum HTTP server infrastructure |
67-
| `clock` | `torrust-tracker-clock` | utilities | Mockable time source for deterministic testing |
67+
| `clock` | `torrust-clock` | utilities | Mockable time source for deterministic testing |
6868
| `configuration` | `torrust-tracker-configuration` | domain | Config file parsing, environment variables |
6969
| `events` | `torrust-tracker-events` | domain | Domain event definitions |
7070
| `http-protocol` | `bittorrent-http-tracker-protocol` | `*-protocol` | HTTP tracker protocol (BEP 3/23) parsing |

‎Cargo.lock‎

Lines changed: 21 additions & 21 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ torrust-tracker-axum-server = { version = "3.0.0-develop", path = "packages/axum
6161
torrust-tracker-rest-api-client = { version = "3.0.0-develop", path = "packages/rest-tracker-api-client" }
6262
torrust-tracker-rest-api-core = { version = "3.0.0-develop", path = "packages/rest-tracker-api-core" }
6363
torrust-server-lib = { version = "3.0.0-develop", path = "packages/server-lib" }
64-
torrust-tracker-clock = { version = "3.0.0-develop", path = "packages/clock" }
64+
torrust-clock = { version = "3.0.0-develop", path = "packages/clock" }
6565
torrust-tracker-configuration = { version = "3.0.0-develop", path = "packages/configuration" }
6666
torrust-tracker-swarm-coordination-registry = { version = "3.0.0-develop", path = "packages/swarm-coordination-registry" }
6767
torrust-tracker-udp-server = { version = "3.0.0-develop", path = "packages/udp-tracker-server" }

‎contrib/dev-tools/analysis/workspace-coupling/src/main.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -289,9 +289,9 @@ fn write_observations(out: &mut String) {
289289
writeln!(out).unwrap();
290290
writeln!(out, "### Known thin dependencies (pre-existing)").unwrap();
291291
writeln!(out).unwrap();
292-
writeln!(out, "- `torrust-tracker-clock` → `torrust-tracker-primitives`: only").unwrap();
292+
writeln!(out, "- `torrust-clock` → `torrust-tracker-primitives`: only").unwrap();
293293
writeln!(out, " `DurationSinceUnixEpoch` imported. Addressed by SI-02.").unwrap();
294-
writeln!(out, "- `torrust-tracker-configuration` → `torrust-tracker-clock`: only").unwrap();
294+
writeln!(out, "- `torrust-tracker-configuration` → `torrust-clock`: only").unwrap();
295295
writeln!(out, " `DEFAULT_TIMEOUT` imported. Addressed by SI-03.").unwrap();
296296
writeln!(out).unwrap();
297297
writeln!(out, "### New findings").unwrap();

‎docs/issues/open/1669-overhaul-packages/EPIC.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ The workspace currently contains **27 packages** (including the root `torrust-tr
6060

6161
| Published on crates.io | Crate Name | Folder |
6262
| ---------------------- | ------------------------ | ---------------- |
63+
| Yes | `torrust-clock` | `clock` |
6364
| No | `torrust-metrics` | `metrics` |
6465
| No | `torrust-net-primitives` | `net-primitives` |
6566
| No | `torrust-server-lib` | `server-lib` |
@@ -73,7 +74,6 @@ The workspace currently contains **27 packages** (including the root `torrust-tr
7374
| No | `torrust-tracker-axum-rest-api-server` | `axum-rest-tracker-api-server` |
7475
| No | `torrust-tracker-axum-server` | `axum-server` |
7576
| No | `torrust-tracker-client` | `console/tracker-client` |
76-
| Yes | `torrust-tracker-clock` | `clock` |
7777
| Yes | `torrust-tracker-configuration` | `configuration` |
7878
| Yes | `torrust-tracker-contrib-bencode` | `contrib/bencode` |
7979
| No | `torrust-tracker-events` | `events` |
@@ -115,12 +115,12 @@ destination group with a "Renamed from …" note.
115115

116116
### `torrust-` prefix (non-`torrust-tracker-`)
117117

118-
| Published on crates.io | Crate Name | Folder | Change |
119-
| ---------------------- | ------------------------ | ---------------- | -------------------------------------------- |
120-
| Yes | `torrust-clock` | `clock` | Renamed from `torrust-tracker-clock` |
121-
| Yes | `torrust-located-error` | `located-error` | Renamed from `torrust-tracker-located-error` |
122-
| Yes | `torrust-net-primitives` | `net-primitives` | New package (created by SI-05) |
123-
| No | `torrust-metrics` | `metrics` | — |
118+
| Published on crates.io | Crate Name | Folder | Change |
119+
| ---------------------- | ------------------------ | ---------------- | ---------------------------------------------------- |
120+
| Yes | `torrust-clock` | `clock` | Renamed from `torrust-tracker-clock` ✓ (SI-09 #1821) |
121+
| Yes | `torrust-located-error` | `located-error` | Renamed from `torrust-tracker-located-error` |
122+
| Yes | `torrust-net-primitives` | `net-primitives` | New package (created by SI-05) |
123+
| No | `torrust-metrics` | `metrics` | — |
124124

125125
### `torrust-tracker-` prefix
126126

@@ -215,7 +215,7 @@ Status: TODO unless noted. `SI-XX` = recommended implementation sequence number.
215215
- [x] SI-06 — [#1813](https://github.com/torrust/torrust-tracker/issues/1813) Resolve `bittorrent-tracker-core` ↔ `torrust-tracker-rest-api-client` layer violation _(Rule M; prerequisite for `bittorrent-tracker-core` extraction)_
216216
- [x] SI-07 — [#1816](https://github.com/torrust/torrust-tracker/issues/1816) Align `torrust-` prefix: rename 7 tracker-specific packages to `torrust-tracker-` _(Rule U; no blockers)_
217217
- [x] SI-08 — [#1819](https://github.com/torrust/torrust-tracker/issues/1819) Rename `torrust-tracker-metrics` to `torrust-metrics` _(Rule U; no blockers)_
218-
- [ ] SI-09 — [#1821](https://github.com/torrust/torrust-tracker/issues/1821) Rename `torrust-tracker-clock` to `torrust-clock` _(Rule P; no blockers)_
218+
- [x] SI-09 — [#1821](https://github.com/torrust/torrust-tracker/issues/1821) Rename `torrust-tracker-clock` to `torrust-clock` _(Rule P; no blockers)_
219219
- [ ] SI-10 — Rename `torrust-tracker-located-error` to `torrust-located-error` _(Rule P; no blockers)_
220220
- [ ] SI-11 — Update all package READMEs _(documentation; after SI-07–SI-10; before SI-12)_
221221
- [ ] SI-12 — Extract and rename `torrust-tracker-contrib-bencode` to `torrust-bencode` _(Rule E; no blockers within this EPIC)_
@@ -235,7 +235,7 @@ Details:
235235
| SI-06 | [#1813](https://github.com/torrust/torrust-tracker/issues/1813) — Resolve `bittorrent-tracker-core` ↔ `torrust-tracker-rest-api-client` layer violation | [docs/issues/closed/1813-1669-06-resolve-bittorrent-tracker-core-rest-api-layer-violation.md](../../closed/1813-1669-06-resolve-bittorrent-tracker-core-rest-api-layer-violation.md) | DONE | Rule M; stale unused dev dep removed in PR #1804; unblocks `bittorrent-tracker-core` extraction |
236236
| SI-07 | [#1816](https://github.com/torrust/torrust-tracker/issues/1816) — Align `torrust-` prefix: rename 7 tracker-specific packages to `torrust-tracker-` | [docs/issues/open/1816-1669-07-align-torrust-prefix-rename-tracker-specific-packages.md](../../open/1816-1669-07-align-torrust-prefix-rename-tracker-specific-packages.md) | DONE | Rule U; none of the 7 are published; pure workspace rename; no blockers |
237237
| SI-08 | [#1819](https://github.com/torrust/torrust-tracker/issues/1819) — Rename `torrust-tracker-metrics` to `torrust-metrics` | [docs/issues/open/1819-1669-08-rename-torrust-tracker-metrics-to-torrust-metrics.md](../../open/1819-1669-08-rename-torrust-tracker-metrics-to-torrust-metrics.md) | DONE | Rule U; not yet published; no blockers; prerequisite for SI-14 |
238-
| SI-09 | [#1821](https://github.com/torrust/torrust-tracker/issues/1821) — Rename `torrust-tracker-clock` to `torrust-clock` | [docs/issues/open/1821-1669-09-rename-torrust-tracker-clock-to-torrust-clock.md](../../open/1821-1669-09-rename-torrust-tracker-clock-to-torrust-clock.md) | TODO | Rule P; published on crates.io; no blockers; prerequisite for SI-13 |
238+
| SI-09 | [#1821](https://github.com/torrust/torrust-tracker/issues/1821) — Rename `torrust-tracker-clock` to `torrust-clock` | [docs/issues/open/1821-1669-09-rename-torrust-tracker-clock-to-torrust-clock.md](../../open/1821-1669-09-rename-torrust-tracker-clock-to-torrust-clock.md) | DONE | Rule P; published on crates.io; no blockers; prerequisite for SI-13 |
239239
| SI-10 | #TBD — Rename `torrust-tracker-located-error` to `torrust-located-error` | [docs/issues/drafts/1669-10-rename-torrust-tracker-located-error-to-torrust-located-error.md](../../drafts/1669-10-rename-torrust-tracker-located-error-to-torrust-located-error.md) | TODO | Rule P; published on crates.io; no blockers |
240240
| SI-11 | #TBD — Update all package READMEs | [docs/issues/drafts/1669-11-update-all-package-readmes.md](../../drafts/1669-11-update-all-package-readmes.md) | TODO | Documentation; requires SI-07–SI-10; before SI-12 |
241241
| SI-12 | #TBD — Extract and rename `torrust-tracker-contrib-bencode` to `torrust-bencode` | [docs/issues/drafts/1669-12-extract-torrust-tracker-contrib-bencode-to-torrust-bencode.md](../../drafts/1669-12-extract-torrust-tracker-contrib-bencode-to-torrust-bencode.md) | TODO | Rule E; no workspace-dep blockers; Apache-2.0; one internal consumer |

0 commit comments

Comments
 (0)