Merge pull request #10 from sideeffect-io/feature/rename-viewstate

project: rename ViewState in ViewStateMachine

Author: twittemb

Sample/Sample/ContentView.swift

@@ -9,25 +9,27 @@ import AsyncStateMachine
 import SwiftUI
 
 struct ContentView: View {
-  @ObservedObject var viewState: ViewState<State, Event, Output>
+  @ObservedObject var viewStateMachine: ViewStateMachine<State, Event, Output>
 
   var body: some View {
-    Text(String(describing: self.viewState.state))
+    Text(String(describing: self.viewStateMachine.state))
     Button {
-      self.viewState.send(Event.loadingIsRequested)
+      self.viewStateMachine.send(Event.loadingIsRequested)
     } label: {
       Text("Load")
     }
     .task {
-      await viewState.start()
+      await self.viewStateMachine.start()
     }
   }
 }
 
 struct ContentView_Previews: PreviewProvider {
-  static let viewState = ViewState(asyncStateMachineSequence: asyncSequence)
+  static let viewStateMachine = ViewStateMachine(
+    asyncStateMachineSequence: asyncSequence
+  )
 
   static var previews: some View {
-    ContentView(viewState: viewState)
+    ContentView(viewStateMachine: viewStateMachine)
   }
 }

Sample/Sample/SampleApp.swift

@@ -10,11 +10,11 @@ import SwiftUI
 
 @main
 struct SampleApp: App {
-  let viewState = ViewState(asyncStateMachineSequence: asyncSequence)
+  let viewStateMachine = ViewStateMachine(asyncStateMachineSequence: asyncSequence)
 
   var body: some Scene {
     WindowGroup {
-      ContentView(viewState: viewState)
+      ContentView(viewStateMachine: viewStateMachine)
     }
   }
 }

Sources/ViewState.swift Sources/ViewStateMachine.swiftSources/ViewState.swift renamed to Sources/ViewStateMachine.swift

@@ -1,11 +1,11 @@
 //
-//  ViewState.swift
+//  ViewStateMachine.swift
 //
 //
 //  Created by Thibault WITTEMBERG on 02/07/2022.
 //
 
-public class ViewState<S, E, O>: ObservableObject
+public class ViewStateMachine<S, E, O>: ObservableObject
 where S: DSLCompatible & Equatable, E: DSLCompatible, O: DSLCompatible {
   @Published public var state: S
 
@@ -86,7 +86,7 @@ where S: DSLCompatible & Equatable, E: DSLCompatible, O: DSLCompatible {
 #if canImport(SwiftUI)
 import SwiftUI
 
-public extension ViewState {
+public extension ViewStateMachine {
   func binding(send event: @escaping (S) -> E) -> Binding<S> {
     Binding {
       self.state

Tests/ViewStateTests.swift Tests/ViewStateMachineTests.swiftTests/ViewStateTests.swift renamed to Tests/ViewStateMachineTests.swift

@@ -1,5 +1,5 @@
 //
-//  BindingsTests.swift
+//  ViewStateMachineTests.swift
 //
 //
 //  Created by Thibault WITTEMBERG on 20/06/2022.
@@ -9,7 +9,7 @@
 @testable import AsyncStateMachine
 import XCTest
 
-final class ViewStateTests: XCTestCase {
+final class ViewStateMachineTests: XCTestCase {
   enum State: DSLCompatible, Equatable {
     case s1
     case s2
@@ -47,7 +47,7 @@ final class ViewStateTests: XCTestCase {
       })
 
     let sequence = AsyncStateMachineSequence(stateMachine: stateMachine, runtime: runtime)
-    let sut = ViewState(asyncStateMachineSequence: sequence)
+    let sut = ViewStateMachine(asyncStateMachineSequence: sequence)
 
     Task {
       await sut.start()
@@ -86,7 +86,7 @@ final class ViewStateTests: XCTestCase {
       .map(output: .o1, to: { Event.e2 })
 
     let sequence = AsyncStateMachineSequence(stateMachine: stateMachine, runtime: runtime)
-    let sut = ViewState(asyncStateMachineSequence: sequence)
+    let sut = ViewStateMachine(asyncStateMachineSequence: sequence)
 
     Task {
       await sut.start()
@@ -123,7 +123,7 @@ final class ViewStateTests: XCTestCase {
       .map(output: .o1, to: { Event.e2 })
 
     let sequence = AsyncStateMachineSequence(stateMachine: stateMachine, runtime: runtime)
-    let sut = ViewState(asyncStateMachineSequence: sequence)
+    let sut = ViewStateMachine(asyncStateMachineSequence: sequence)
 
     Task {
       await sut.start()
@@ -160,7 +160,7 @@ final class ViewStateTests: XCTestCase {
       .map(output: .o1, to: { Event.e2 })
 
     let sequence = AsyncStateMachineSequence(stateMachine: stateMachine, runtime: runtime)
-    let sut = ViewState(asyncStateMachineSequence: sequence)
+    let sut = ViewStateMachine(asyncStateMachineSequence: sequence)
 
     Task {
       await sut.start()
@@ -197,7 +197,7 @@ final class ViewStateTests: XCTestCase {
       .map(output: .o1, to: { Event.e2 })
 
     let sequence = AsyncStateMachineSequence(stateMachine: stateMachine, runtime: runtime)
-    let sut = ViewState(asyncStateMachineSequence: sequence)
+    let sut = ViewStateMachine(asyncStateMachineSequence: sequence)
 
     Task {
       await sut.start()
@@ -225,7 +225,7 @@ final class ViewStateTests: XCTestCase {
       })
 
     let sequence = AsyncStateMachineSequence(stateMachine: stateMachine, runtime: runtime)
-    let sut = ViewState(asyncStateMachineSequence: sequence)
+    let sut = ViewStateMachine(asyncStateMachineSequence: sequence)
 
     Task {
       await sut.start()
@@ -260,7 +260,7 @@ final class ViewStateTests: XCTestCase {
       })
 
     let sequence = AsyncStateMachineSequence(stateMachine: stateMachine, runtime: runtime)
-    let sut = ViewState(asyncStateMachineSequence: sequence)
+    let sut = ViewStateMachine(asyncStateMachineSequence: sequence)
 
     Task {
       await sut.start()
@@ -300,7 +300,7 @@ final class ViewStateTests: XCTestCase {
       })
 
     let sequence = AsyncStateMachineSequence(stateMachine: stateMachine, runtime: runtime)
-    let sut = ViewState(asyncStateMachineSequence: sequence)
+    let sut = ViewStateMachine(asyncStateMachineSequence: sequence)
 
     Task {
       await sut.start()
@@ -344,7 +344,7 @@ final class ViewStateTests: XCTestCase {
       })
 
     let sequence = AsyncStateMachineSequence(stateMachine: stateMachine, runtime: runtime)
-    let sut = ViewState(asyncStateMachineSequence: sequence)
+    let sut = ViewStateMachine(asyncStateMachineSequence: sequence)
 
     Task {
       await sut.start()