Add machine comfort settings and tighten the document schemas

Machine-based exercises now carry ordered name/value comfort settings
(seat height, back-rest position, ...) on both ExerciseDocument and, as a
plan-time snapshot, WorkoutLogDocument — the optional array doubles as the
machine flag. Editable from the exercise editor's new Machine section and
from the workout row's settings sheet, whose mid-workout edits write back
to the originating split (workout saved first, so seed clone-on-edit
repointing can't clobber the log edit).

Schema tightening rides the same rev: splits bump to v2 (weight-reminder
fields and the unused exercise category removed), workouts to v3 (the
derived `completed` flag removed; status is the single source). Starter
seeds regenerated at v2 with unchanged ULIDs; SwiftData cache schema
bumped to rebuild. SCHEMA.md documents the shapes.

Claude-Session: https://claude.ai/code/session_01LEoff8bXGBS83tK1c55Mf7
This commit is contained in:
2026-07-06 16:29:44 -04:00
parent fce8fa4c17
commit 2c1e4759ae
33 changed files with 1132 additions and 586 deletions
+111 -13
View File
@@ -3,9 +3,12 @@ import Testing
import IndieSync
@testable import Workouts
/// Round-trips `SplitDocument` through `DocumentCoder` the exact JSON codec
/// (ISO-8601 dates, sorted keys, pretty-printed) `DocumentFileStore` uses to
/// write and read every document in this app's iCloud container.
/// Round-trips `SplitDocument` (and the embedded exercise / log shapes) through
/// `DocumentCoder` the exact JSON codec (ISO-8601 dates, sorted keys,
/// pretty-printed) `DocumentFileStore` uses to write and read every document in
/// this app's iCloud container. Also pins the schema-v2 migration: an old v1
/// split file (with the removed weight-reminder / category keys) must still decode
/// and round-trip at the current version.
struct SplitDocumentCodableTests {
/// A whole-second epoch so ISO-8601 round-trips (no fractional-second loss).
private static let stableTimestamp = Date(timeIntervalSince1970: 1_700_000_000)
@@ -13,16 +16,17 @@ struct SplitDocumentCodableTests {
@Test func encodeDecodeRoundTrip() throws {
let exercise = ExerciseDocument(
id: ULID.make(),
name: "Bench Press",
name: "Leg Press",
order: 0,
sets: 4,
reps: 10,
weight: 135,
loadType: 0,
durationSeconds: 0,
weightLastUpdated: Self.stableTimestamp,
weightReminderWeeks: 4,
category: ExerciseCategory.warmup.rawValue
machineSettings: [
MachineSetting(name: "Seat Height", value: "4"),
MachineSetting(name: "Back Rest Incline", value: "45°")
]
)
let original = SplitDocument(
schemaVersion: SplitDocument.currentSchemaVersion,
@@ -41,12 +45,65 @@ struct SplitDocumentCodableTests {
let decoded = try DocumentCoder.decode(SplitDocument.self, from: data)
#expect(decoded == original)
#expect(decoded.schemaVersion == 2)
#expect(decoded.relativePath == "Splits/\(original.id).json")
#expect(decoded.exercises.first?.machineSettings?.count == 2)
}
/// A pre-category exercise (no `category` key) must still decode the field is
/// optional and deliberately not schema-bumped, defaulting to the main circuit.
@Test func decodesLegacyExerciseWithoutCategory() throws {
/// An `ExerciseDocument` with no machine settings encodes without a
/// `machineSettings` key (nil optionals are omitted) and decodes back to nil
/// the "not a machine exercise" state.
@Test func nonMachineExerciseOmitsMachineSettings() throws {
let exercise = ExerciseDocument(
id: ULID.make(), name: "Plank", order: 0, sets: 3, reps: 0,
weight: 0, loadType: 2, durationSeconds: 45
)
let data = try DocumentCoder.encode(exercise)
let json = String(decoding: data, as: UTF8.self)
#expect(!json.contains("machineSettings"))
let decoded = try DocumentCoder.decode(ExerciseDocument.self, from: data)
#expect(decoded.machineSettings == nil)
}
/// `machineSettings` round-trips on `ExerciseDocument`, including the empty case
/// ("machine-based, nothing recorded yet") which must stay distinct from nil.
@Test func machineSettingsRoundTripOnExercise() throws {
for settings: [MachineSetting] in [
[MachineSetting(name: "Pin", value: "3rd hole")],
[] // empty nil: a machine exercise with nothing recorded
] {
let exercise = ExerciseDocument(
id: ULID.make(), name: "Chest Press", order: 0, sets: 4, reps: 10,
weight: 40, loadType: 1, durationSeconds: 0, machineSettings: settings
)
let data = try DocumentCoder.encode(exercise)
let decoded = try DocumentCoder.decode(ExerciseDocument.self, from: data)
#expect(decoded.machineSettings == settings)
}
}
/// `machineSettings` round-trips on `WorkoutLogDocument` the plan-time snapshot.
@Test func machineSettingsRoundTripOnWorkoutLog() throws {
let log = WorkoutLogDocument(
id: ULID.make(), exerciseName: "Leg Press", order: 0, sets: 4, reps: 10,
weight: 140, loadType: 1, durationSeconds: 0, currentStateIndex: 0,
status: WorkoutStatus.notStarted.rawValue, notes: nil,
date: Self.stableTimestamp,
machineSettings: [MachineSetting(name: "Seat Height", value: "4")]
)
let data = try DocumentCoder.encode(log)
let decoded = try DocumentCoder.decode(WorkoutLogDocument.self, from: data)
#expect(decoded == log)
#expect(decoded.machineSettings == [MachineSetting(name: "Seat Height", value: "4")])
}
/// A v1 split file carrying the since-removed keys (`weightLastUpdated`,
/// `weightReminderWeeks`, `category`) must still decode Codable ignores the
/// extra keys, and every remaining field is present in old files. Re-stamping
/// `schemaVersion` to the current value (what the app does on any rewrite via the
/// cachedocument mapper) round-trips cleanly at v2.
@Test func decodesLegacyV1SplitAndRoundTripsAtV2() throws {
let json = """
{
"schemaVersion": 1,
@@ -66,11 +123,52 @@ struct SplitDocumentCodableTests {
"weight": 135,
"loadType": 1,
"durationSeconds": 0,
"weightReminderWeeks": 4
"weightLastUpdated": "2023-11-14T22:13:20Z",
"weightReminderWeeks": 4,
"category": 1
}]
}
"""
let decoded = try DocumentCoder.decode(SplitDocument.self, from: Data(json.utf8))
#expect(decoded.exercises.first?.category == nil)
var decoded = try DocumentCoder.decode(SplitDocument.self, from: Data(json.utf8))
// Removed keys are ignored; the surviving fields decode and machineSettings
// defaults to nil (the file predates it).
#expect(decoded.schemaVersion == 1)
#expect(decoded.exercises.count == 1)
#expect(decoded.exercises.first?.name == "Bench Press")
#expect(decoded.exercises.first?.weight == 135)
#expect(decoded.exercises.first?.machineSettings == nil)
// The app re-stamps to the current version on rewrite; that must round-trip.
decoded.schemaVersion = SplitDocument.currentSchemaVersion
let reData = try DocumentCoder.encode(decoded)
let reDecoded = try DocumentCoder.decode(SplitDocument.self, from: reData)
#expect(reDecoded == decoded)
#expect(reDecoded.schemaVersion == 2)
}
/// A workout-log file written before `completed` was removed still carries the
/// key. It must decode fine (Codable ignores it) completion is now derived
/// from `status`.
@Test func decodesLegacyWorkoutLogWithCompletedKey() throws {
let json = """
{
"id": "01HZZZZZZZZZZZZZZZZZZZZZZW",
"exerciseName": "Bench Press",
"order": 0,
"sets": 4,
"reps": 10,
"weight": 135,
"loadType": 1,
"durationSeconds": 0,
"currentStateIndex": 4,
"completed": true,
"status": "completed",
"date": "2023-11-14T22:13:20Z"
}
"""
let decoded = try DocumentCoder.decode(WorkoutLogDocument.self, from: Data(json.utf8))
#expect(decoded.status == WorkoutStatus.completed.rawValue)
#expect(decoded.exerciseName == "Bench Press")
#expect(decoded.machineSettings == nil)
}
}
@@ -0,0 +1,62 @@
import Foundation
import Testing
import IndieSync
@testable import Workouts
/// Pins the plan-time snapshot (`WorkoutLogDocument(planFrom:order:date:)`) the
/// single helper every "start workout" / "add exercise" path funnels through. The
/// machine comfort settings must ride along with the other plan fields, and the
/// nil-vs-empty distinction (not-a-machine vs machine-with-nothing-recorded) must
/// be preserved exactly.
struct WorkoutLogSnapshotTests {
private static let ts = Date(timeIntervalSince1970: 1_700_000_000)
@Test func snapshotCopiesMachineSettingsAndPlanFields() {
let exercise = ExerciseDocument(
id: ULID.make(), name: "Leg Press", order: 2, sets: 4, reps: 10,
weight: 140, loadType: 1, durationSeconds: 0,
machineSettings: [
MachineSetting(name: "Seat Height", value: "4"),
MachineSetting(name: "Back Rest Incline", value: "45°")
]
)
let log = WorkoutLogDocument(planFrom: exercise, order: 5, date: Self.ts)
#expect(log.machineSettings == exercise.machineSettings)
#expect(log.exerciseName == "Leg Press")
#expect(log.order == 5) // the passed order, not the exercise's
#expect(log.sets == 4)
#expect(log.reps == 10)
#expect(log.weight == 140)
#expect(log.loadType == 1)
#expect(log.durationSeconds == 0)
#expect(log.date == Self.ts)
#expect(log.currentStateIndex == 0)
#expect(log.status == WorkoutStatus.notStarted.rawValue)
}
@Test func snapshotPreservesNilForNonMachineExercise() {
let exercise = ExerciseDocument(
id: ULID.make(), name: "Plank", order: 0, sets: 3, reps: 0,
weight: 0, loadType: 2, durationSeconds: 45
)
let log = WorkoutLogDocument(planFrom: exercise, order: 0, date: Self.ts)
#expect(log.machineSettings == nil)
}
@Test func snapshotPreservesEmptyMachineSettings() {
// Empty nil: a machine exercise with nothing recorded yet must stay empty,
// not collapse to "not a machine exercise".
let exercise = ExerciseDocument(
id: ULID.make(), name: "Chest Press", order: 0, sets: 4, reps: 10,
weight: 40, loadType: 1, durationSeconds: 0, machineSettings: []
)
let log = WorkoutLogDocument(planFrom: exercise, order: 0, date: Self.ts)
#expect(log.machineSettings == [])
}
}