Update to Swift 6 (#6)

vsanthanam · vsanthanam · commit d8d058b22c00 · 2025-03-30T15:52:55.000+01:00
* Update to Swift 6

* Move to Swift Testing from XCTest

* Update .swiftformat to use Swift 6 ruleset
diff --git a/.github/workflows/publish-website.yml b/.github/workflows/publish-website.yml
@@ -0,0 +1,68 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: publish-website
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build-docc:
+    runs-on: macos-15
+    outputs:
+      artifact-name: docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build Documentation
+        run: ./.scripts/build-docs
+      - name: Compress Documentation
+        run: zip -r docs.zip docs
+      - name: Upload Documentation
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: docs.zip
+  build:
+    needs: build-docc
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Download Documentation
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: .
+      - name: Decompress Documentation
+        run: unzip docs.zip
+      - name: Fix README
+        run: ./.scripts/clean-readme
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/.github/workflows/spm-build-test.yml b/.github/workflows/spm-build-test.yml
@@ -8,9 +8,7 @@ on:
 
 jobs:
   build:
-
-    runs-on: macos-12
-
+    runs-on: macos-15
     steps:
     - uses: actions/checkout@v3
     - name: Build
diff --git a/.scripts/build-docs b/.scripts/build-docs
@@ -0,0 +1,6 @@
+swift package --allow-writing-to-directory docs \
+    generate-documentation --target WeakReference \
+    --disable-indexing \
+    --transform-for-static-hosting \
+    --hosting-base-path docs \
+    --output-path docs
diff --git a/.scripts/clean-readme b/.scripts/clean-readme
@@ -0,0 +1 @@
+tail -n +2 README.md > README-2.md && rm README.md && mv README-2.md README.md
diff --git a/.swiftformat b/.swiftformat
@@ -1,4 +1,4 @@
 --enable isEmpty
 --disable blankLinesAtEndOfScope, blankLinesAtStartOfScope, redundantNilInit, unusedArguments, redundantParens, wrapMultilineStatementBraces, trailingCommas, braces
---swiftversion 5.6
---header "WeakReference\n{file}\n\nMIT License\n\nCopyright (c) 2021 Varun Santhanam\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the "Software"), to deal\n\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE."
+--swiftversion 6.0
+--header "WeakReference\n{file}\n\nMIT License\n\nCopyright (c) 2025 Varun Santhanam\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the "Software"), to deal\n\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE."
diff --git a/Package.resolved b/Package.resolved
diff --git a/Package.swift b/Package.swift
@@ -1,29 +1,31 @@
-// swift-tools-version: 5.6
+// swift-tools-version: 6.0
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
 
 let package = Package(
     name: "WeakReference",
     platforms: [
-        .iOS(.v11),
-        .macOS(.v10_13),
-        .tvOS(.v11),
-        .watchOS(.v4)
+        .iOS(.v12),
+        .macOS(.v10_14),
+        .macCatalyst(.v13),
+        .tvOS(.v12),
+        .watchOS(.v5),
+        .visionOS(.v1)
     ],
     products: [
-        // Products define the executables and libraries a package produces, and make them visible to other packages.
         .library(
             name: "WeakReference",
             targets: ["WeakReference"]
         ),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")
+        .package(
+            url: "https://github.com/swiftlang/swift-docc-plugin.git",
+            from: "1.4.3"
+        )
     ],
     targets: [
-        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
-        // Targets can depend on other targets in this package, and on products in packages this package depends on.
         .target(
             name: "WeakReference",
             dependencies: []
diff --git a/README.md b/README.md
@@ -2,9 +2,9 @@
 
 [![MIT License](https://img.shields.io/github/license/vsanthanam/WeakReference)](https://github.com/vsanthanam/WeakReference/blob/main/LICENSE)
 [![Package Releases](https://img.shields.io/github/v/release/vsanthanam/WeakReference)](https://github.com/vsanthanam/WeakReference/releases)
-[![Build Results](https://img.shields.io/github/workflow/status/vsanthanam/WeakReference/spm-build-test)](https://img.shields.io/github/workflow/status/vsanthanam/WeakReference/spm-build-test)
-[![Swift Version](https://img.shields.io/badge/swift-5.6-critical)](https://swift.org)
-[![Supported Platforms](https://img.shields.io/badge/platform-iOS%2011%20%7C%20macOS%2010.13%20%7C%20tvOS%2011%20%7C%20watchOS%204-lightgrey)](https://developer.apple.com)
+[![Build Status](https://img.shields.io/github/check-runs/vsanthanam/WeakReference/main)](https://github.com/vsanthanam/WeakReference/actions)
+[![Swift Version](https://img.shields.io/badge/swift-6.0-critical)](https://swift.org)
+[![Supported Platforms](https://img.shields.io/badge/platform-iOS%2012%20%7C%20macOS%2010.14%20%7C%20tvOS%2012%20%7C%20watchOS%205%20%7C%20visionOS%201-lightgrey)](https://developer.apple.com)
 
 An existential weak reference.
 Use this wrapper class to pass around weakly-referenced instances of an object.
@@ -17,22 +17,24 @@ To add WeakReference as a dependency to an existing Swift package, add the follo
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/vsanthanam/WeakReference.git", .upToNextMajor(from: "1.0.0"))
+    .package(
+        url: "https://github.com/vsanthanam/WeakReference.git",
+        from: "1.0.0"
+    )
 ]
 ```
 
-To add AnyAsyncSequence as a dependency to an Xcode Project:
+To add WeakReference as a dependency to an Xcode Project:
 
-* Choose File → Add Packages...
-* Enter package URL https://github.com/vsanthanam/WeakReference.git and select your release and of choice.
+* Choose `File` → `Add Packages...`
+* Enter package URL `https://github.com/vsanthanam/WeakReference.git` and select your release and of choice.
 
 Other distribution mechanisms like CocoaPods or Carthage may be added in the future.
 
 Additional installation instructions are available on the [Swift Package Index](https://swiftpackageindex.com/vsanthanam/WeakReference)
 
-[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fvsanthanam%2FAnyAsyncSequence%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/vsanthanam/AnyAsyncSequence)
-[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fvsanthanam%2FAnyAsyncSequence%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/vsanthanam/AnyAsyncSequence)
-
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fvsanthanam%2FWeakReference%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/vsanthanam/WeakReference)
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fvsanthanam%2FWeakReference%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/vsanthanam/WeakReference)
 
 ## Usage
 
diff --git a/Sources/WeakReference/WeakReference.swift b/Sources/WeakReference/WeakReference.swift
@@ -3,7 +3,7 @@
 //
 // MIT License
 //
-// Copyright (c) 2021 Varun Santhanam
+// Copyright (c) 2025 Varun Santhanam
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the  Software), to deal
 //
@@ -23,7 +23,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
-/// An existential weak reference.
+/// A portable weak reference
 ///
 /// Use this wrapper class to pass around weakly-referenced instances of an object.
 ///
@@ -39,6 +39,7 @@
 ///
 /// assert(weakReference.obj == nil)
 /// ```
+@available(macOS 10.14, macCatalyst 13.0, iOS 12.0, watchOS 5.0, tvOS 5.0, visionOS 1.0, *)
 public final class WeakReference<T: AnyObject> {
 
     /// Create a weak reference to the provided object instance
@@ -49,11 +50,15 @@ public final class WeakReference<T: AnyObject> {
 
     /// A weak reference to the object
     public weak var obj: T?
+
 }
 
 /// Create a ``WeakReference`` from an object
 /// - Parameter obj: An instance to weakify
 /// - Returns: a ``WeakReference`` wrapper containing the provided object
-public func weak<T: AnyObject>(_ obj: T) -> WeakReference<T> {
+@available(macOS 10.14, macCatalyst 13.0, iOS 12.0, watchOS 5.0, tvOS 5.0, visionOS 1.0, *)
+public func weak<T>(
+    _ obj: T
+) -> WeakReference<T> where T: AnyObject {
     .init(obj)
 }
diff --git a/Tests/WeakReferenceTests/WeakReferenceTests.swift b/Tests/WeakReferenceTests/WeakReferenceTests.swift
@@ -3,7 +3,7 @@
 //
 // MIT License
 //
-// Copyright (c) 2021 Varun Santhanam
+// Copyright (c) 2025 Varun Santhanam
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the  Software), to deal
 //
@@ -23,23 +23,21 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
-@testable import WeakReference
-import XCTest
+import Testing
+import WeakReference
 
-final class WeakTests: XCTestCase {
+@Test
+func test() throws {
 
-    func test() throws {
+    class MyObject {}
 
-        class MyObject {}
+    var myObject: MyObject? = .init()
 
-        var myObject: MyObject? = .init()
+    let weakReference = weak(myObject!)
 
-        let weakReference = weak(myObject!)
+    #expect(weakReference.obj != nil)
 
-        XCTAssertNotNil(weakReference.obj)
+    myObject = nil
 
-        myObject = nil
-
-        XCTAssertNil(weakReference.obj)
-    }
+    #expect(weakReference.obj == nil)
 }
diff --git a/generate-static-site.sh b/generate-static-site.sh

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+tail -n +2 README.md > README-2.md && rm README.md && mv README-2.md README.md`