🌱 StateTree v0.1.0

This commit marks the end of initial feature-set development.
StateTree does what it's meant to.

Changes since v0.0.99 include:
- @route reimplementation to allow non-optional routes and
  a much more natural syntax.
- Behavior reimplementation to ensure deterministic interception
  and registration before start.
- URL encoded Intent payloads for simple deeplinking.
- State application/playback reimplementation for stability.
- Third Party dependency removals.
- Tree lifecycle API changes to remove implementation details
  from the API. (i.e. The Disposable and Emitter libraries.)
- Test hooks for update counts to allow performance/behavior
  assertions.
- UI-layer module API improvements for ease of use.
- Significant changes to lifecycle Rules to integrate Behaviors
  as their actions, and so to allow runtime implementation
  swapping.
- Linux testing and stabilization.
- Custom @treeactor testing and stabilization.
- Xcode 15 / Swift 5.9 fixes.
- Example app migrations.

And more.

🌅

-adamz

.gitignore

@@ -1,3 +1,4 @@
+.vscode
 .DS_Store
 /.build
 /Packages
@@ -8,3 +9,4 @@ DerivedData/
 .swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
 .netrc
 .swiftpm
+docs/

.swift-version

@@ -1 +1 @@
-5.7
+5.9

.swiftformat

@@ -26,7 +26,6 @@
 --rules numberFormatting
 --rules opaqueGenericParameters
 --rules organizeDeclarations
---rules preferDouble
 --rules preferKeyPath
 --rules redundantBackticks
 --rules redundantBreak
@@ -41,7 +40,6 @@
 --rules redundantParens
 --rules redundantPattern
 --rules redundantRawValues
---rules redundantReturn
 --rules redundantSelf
 --rules redundantType
 --rules redundantVoidReturnType

Workspace/StateTree.xcworkspace/xcshareddata/swiftpm/Package.resolved → Examples/Counter/Counter.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -5,17 +5,17 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/GoodHatsLLC/Disposable.git",
       "state" : {
-        "revision" : "7529c939ffa7e2d3f635d709ff7b14307173916f",
-        "version" : "0.4.0"
+        "revision" : "2b6db4e812dc2dddb7743251224c29308976b3e3",
+        "version" : "0.8.0"
       }
     },
     {
       "identity" : "emitter",
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/GoodHatsLLC/Emitter.git",
       "state" : {
-        "revision" : "2736f37612a8cb86a65eaf4a59f98e0df242c63c",
-        "version" : "0.1.4"
+        "revision" : "84614b2f05e51deb1ada3bd9fc36bf431bc25e44",
+        "version" : "0.8.5"
       }
     },
     {
@@ -24,7 +24,7 @@
       "location" : "https://github.com/apple/swift-collections.git",
       "state" : {
         "branch" : "release/1.1",
-        "revision" : "8c7b8536ea0d21faeeb05229aa7537e9e2636794"
+        "revision" : "992e0f3446b4f608f5ead9dd6edc92f6bbc0b0a0"
       }
     }
   ],

Examples/Counter/Counter/AppDelegate.swift

@@ -0,0 +1,30 @@
+import UIKit
+
+/// Standard UIKit boilerplate.
+@main
+class AppDelegate: UIResponder, UIApplicationDelegate {
+
+  func application(
+    _: UIApplication,
+    didFinishLaunchingWithOptions _: [UIApplication.LaunchOptionsKey: Any]?
+  )
+    -> Bool
+  {
+    true
+  }
+
+  // MARK: UISceneSession Lifecycle
+
+  func application(
+    _: UIApplication,
+    configurationForConnecting connectingSceneSession: UISceneSession,
+    options _: UIScene.ConnectionOptions
+  )
+    -> UISceneConfiguration
+  {
+    UISceneConfiguration(name: "Default Configuration", sessionRole: connectingSceneSession.role)
+  }
+
+  func application(_: UIApplication, didDiscardSceneSessions _: Set<UISceneSession>) { }
+
+}

Workspace/Examples/TicTacToe/TicTacToe/Assets.xcassets/AccentColor.colorset/Contents.json → Examples/Counter/Counter/Assets.xcassets/AccentColor.colorset/Contents.json

@@ -1,6 +1,10 @@
 {
   "colors" : [
     {
+      "color" : {
+        "platform" : "universal",
+        "reference" : "systemPinkColor"
+      },
       "idiom" : "universal"
     }
   ],

Examples/Counter/Counter/Assets.xcassets/AppIcon.appiconset/Contents.json

@@ -0,0 +1,14 @@
+{
+  "images" : [
+    {
+      "filename" : "AppIcon.png",
+      "idiom" : "universal",
+      "platform" : "ios",
+      "size" : "1024x1024"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Examples/Counter/Counter/Base.lproj/LaunchScreen.storyboard

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="13122.16" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" launchScreen="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="01J-lp-oVM">
+    <dependencies>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="13104.12"/>
+        <capability name="Safe area layout guides" minToolsVersion="9.0"/>
+        <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
+    </dependencies>
+    <scenes>
+        <!--View Controller-->
+        <scene sceneID="EHf-IW-A2E">
+            <objects>
+                <viewController id="01J-lp-oVM" sceneMemberID="viewController">
+                    <view key="view" contentMode="scaleToFill" id="Ze5-6b-2t3">
+                        <rect key="frame" x="0.0" y="0.0" width="375" height="667"/>
+                        <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
+                        <color key="backgroundColor" xcode11CocoaTouchSystemColor="systemBackgroundColor" cocoaTouchSystemColor="whiteColor"/>
+                        <viewLayoutGuide key="safeArea" id="6Tk-OE-BBY"/>
+                    </view>
+                </viewController>
+                <placeholder placeholderIdentifier="IBFirstResponder" id="iYj-Kq-Ea1" userLabel="First Responder" sceneMemberID="firstResponder"/>
+            </objects>
+            <point key="canvasLocation" x="53" y="375"/>
+        </scene>
+    </scenes>
+</document>

Examples/Counter/Counter/Info.plist

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>UIApplicationSceneManifest</key>
+	<dict>
+		<key>UIApplicationSupportsMultipleScenes</key>
+		<false/>
+		<key>UISceneConfigurations</key>
+		<dict>
+			<key>UIWindowSceneSessionRoleApplication</key>
+			<array>
+				<dict>
+					<key>UISceneConfigurationName</key>
+					<string>Default Configuration</string>
+					<key>UISceneDelegateClassName</key>
+					<string>$(PRODUCT_MODULE_NAME).SceneDelegate</string>
+				</dict>
+			</array>
+		</dict>
+	</dict>
+</dict>
+</plist>

Examples/Counter/Counter/SceneDelegate.swift

@@ -0,0 +1,44 @@
+import CounterDomain
+import CounterUI
+import StateTree
+import StateTreeImperativeUI
+import UIKit
+
+/// We use the SceneDelegate as our entry point into our StateTree
+/// defined domain logic.
+/// (The rest of the Counter example code is in the `CounterSupport` package.)
+final class SceneDelegate: UIResponder, UIWindowSceneDelegate {
+
+  var window: UIWindow?
+
+  /// The model representing our StateTree
+  ///
+  /// This Tree manages all of our models
+  let tree = try! ReportedTree(tree: Tree(root: CountersList()))
+
+  func scene(
+    _ scene: UIScene, willConnectTo _: UISceneSession, options _: UIScene.ConnectionOptions
+  ) {
+    guard let scene = (scene as? UIWindowScene) else {
+      return
+    }
+    let mainWindow = UIWindow(windowScene: scene)
+    window = mainWindow
+
+    let root = tree.root
+    mainWindow.rootViewController = RootViewController(model: root)
+
+    window?.makeKeyAndVisible()
+  }
+
+  func sceneDidDisconnect(_: UIScene) { }
+
+  func sceneDidBecomeActive(_: UIScene) { }
+
+  func sceneWillResignActive(_: UIScene) { }
+
+  func sceneWillEnterForeground(_: UIScene) { }
+
+  func sceneDidEnterBackground(_: UIScene) { }
+
+}

Examples/Counter/CounterSupport/Package.swift

@@ -0,0 +1,42 @@
+// swift-tools-version: 5.8
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+  name: "CounterSupport",
+  platforms: [.iOS(.v16)],
+  products: [
+    .library(
+      name: "CounterDomain",
+      targets: ["CounterDomain"]
+    ),
+    .library(
+      name: "CounterUI",
+      targets: ["CounterUI"]
+    ),
+  ],
+  dependencies: [
+    .package(path: "../../../"),
+    .package(
+      url: "https://github.com/apple/swift-collections.git",
+      branch: "release/1.1"
+    ),
+  ],
+  targets: [
+    .target(
+      name: "CounterUI",
+      dependencies: [
+        "CounterDomain",
+        .product(name: "StateTreeImperativeUI", package: "StateTree"),
+      ]
+    ),
+    .target(
+      name: "CounterDomain",
+      dependencies: [
+        .product(name: "StateTree", package: "StateTree"),
+        .product(name: "OrderedCollections", package: "swift-collections"),
+      ]
+    ),
+  ]
+)

Examples/Counter/CounterSupport/README.md

@@ -0,0 +1,3 @@
+# Counter
+
+A description of this package.

Examples/Counter/CounterSupport/Sources/CounterDomain/Counter.swift

@@ -0,0 +1,40 @@
+import Foundation
+import StateTree
+
+public struct Counter: Node, Identifiable {
+
+  public let id: Int
+  public let shouldDelete: () -> Void
+  @Value public var count: Int = 0
+
+  public var emoji: Emoji {
+    Emoji.hash(of: id)
+  }
+
+  public var incrementDisabled: Bool {
+    count == 10
+  }
+
+  public var decrementDisabled: Bool {
+    count == -10
+  }
+
+  public var rules: some Rules {
+    OnUpdate(count) { _ in
+      count = max(min(10, count), -10)
+    }
+  }
+
+  public func increment() {
+    count += 1
+  }
+
+  public func decrement() {
+    count -= 1
+  }
+
+  public func delete() {
+    shouldDelete()
+  }
+
+}

Examples/Counter/CounterSupport/Sources/CounterDomain/CountersList.swift

@@ -0,0 +1,43 @@
+import Foundation
+import StateTree
+
+public struct CountersList: Node {
+
+  // MARK: Lifecycle
+
+  public init() { }
+
+  // MARK: Public
+
+  @Route public var counters: [Counter] = []
+
+  public var rules: some Rules {
+    Serve(data: counterIDs, at: $counters) { datum in
+      Counter(
+        id: datum,
+        shouldDelete: {
+          delete(counter: datum)
+        }
+      )
+    }
+  }
+
+  public func addCounter() {
+    $scope.transaction {
+      let counter = nextCounter
+      counterIDs.append(counter)
+      nextCounter += 1
+    }
+  }
+
+  public func delete(counter id: Int) {
+    counterIDs.removeAll { $0 == id }
+  }
+
+  // MARK: Private
+
+  @Value private var counterIDs: [Int] = []
+  @Value private var nextCounter = 0
+  @Scope private var scope
+
+}