renaming PlaybookState

Author: heckj

Sources/Formic/CommandOutput.swift

@@ -24,7 +24,7 @@ public struct CommandOutput: Sendable {
         }
         return String(data: stdErr, encoding: String.Encoding.utf8)
     }
-    
+
     /// Create a new command output.
     /// - Parameters:
     ///   - returnCode: The return code

…entation.docc/Engine/PlaybookRunState.md …cumentation.docc/Engine/PlaybookState.mdSources/Formic/Documentation.docc/Engine/PlaybookRunState.md renamed to Sources/Formic/Documentation.docc/Engine/PlaybookState.md Sources/Formic/Documentation.docc/Engine/PlaybookRunState.md renamed to Sources/Formic/Documentation.docc/Engine/PlaybookState.md

@@ -1,4 +1,4 @@
-# ``PlaybookRunState``
+# ``PlaybookState``
 
 ## Topics
 

Sources/Formic/Engine/Engine.swift

@@ -2,7 +2,7 @@
 public actor Engine {
     let clock: ContinuousClock
     var playbooks: [Playbook.ID: Playbook]
-    var states: [Playbook.ID: PlaybookRunState]
+    var states: [Playbook.ID: PlaybookState]
     var commandResults: [Host: [Command.ID: CommandExecutionResult]]
     var runners: [Host: Task<Void, any Error>]
 
@@ -11,8 +11,8 @@ public actor Engine {
     /// You can request the state of a playbook by calling the ``status(_:)`` method
     /// or watch a stream of the command results as they process by reading the ``commandUpdates``
     /// stream.
-    public nonisolated let playbookUpdates: AsyncStream<(Playbook.ID, PlaybookRunState)>
-    let stateContinuation: AsyncStream<(Playbook.ID, PlaybookRunState)>.Continuation
+    public nonisolated let playbookUpdates: AsyncStream<(Playbook.ID, PlaybookState)>
+    let stateContinuation: AsyncStream<(Playbook.ID, PlaybookState)>.Continuation
 
     /// An asynchronous stream of command execution results.
     public nonisolated let commandUpdates: AsyncStream<(CommandExecutionResult)>
@@ -27,7 +27,7 @@ public actor Engine {
         playbooks = [:]
 
         // assemble the streams and continuations
-        (playbookUpdates, stateContinuation) = AsyncStream.makeStream(of: (Playbook.ID, PlaybookRunState).self)
+        (playbookUpdates, stateContinuation) = AsyncStream.makeStream(of: (Playbook.ID, PlaybookState).self)
         (commandUpdates, commandContinuation) = AsyncStream.makeStream(of: CommandExecutionResult.self)
     }
 

…ces/Formic/Engine/PlaybookRunState.swift Sources/Formic/Engine/PlaybookState.swiftSources/Formic/Engine/PlaybookRunState.swift renamed to Sources/Formic/Engine/PlaybookState.swift Sources/Formic/Engine/PlaybookRunState.swift renamed to Sources/Formic/Engine/PlaybookState.swift

@@ -1,5 +1,5 @@
 /// The state of execution for a playbook.
-public enum PlaybookRunState: Sendable, Hashable, Codable {
+public enum PlaybookState: Sendable, Hashable, Codable {
     /// The playbook is scheduled to run, but hasn't yet started.
     ///
     /// This is the initial state.

Sources/Formic/Engine/PlaybookStatus.swift

@@ -1,7 +1,7 @@
 /// A representation of the state of playbook execution.
 public struct PlaybookStatus: Sendable, Hashable, Codable {
     /// The state of the playbook.
-    public let state: PlaybookRunState
+    public let state: PlaybookState
     /// The playbook declaration.
     public let playbook: Playbook
     /// A nested dictionary of all results for this playbook, keyed by host, then by command ID.

Tests/formicTests/EngineTests.swift

@@ -403,7 +403,7 @@ func testPlaybookStateStream() async throws {
         .addSuccess(command: ["uname"], presentOutput: "Linux\n")
         .throwError(command: ["whoami"], errorToThrow: TestError.unknown(msg: "Process failed in something"))
 
-    let stateStream: AsyncStream<(Playbook.ID, PlaybookRunState)> = engine.playbookUpdates
+    let stateStream: AsyncStream<(Playbook.ID, PlaybookState)> = engine.playbookUpdates
     var streamIterator = stateStream.makeAsyncIterator()
 
     try await withDependencies { dependencyValues in