Merge pull request #93 from ably-labs/46-spec-coverage

[ECO-4980] Add a script to show spec coverage

.github/workflows/check.yaml

@@ -38,6 +38,21 @@ jobs:
 
       - run: swift run BuildTool lint
 
+  spec-coverage:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      # This step can be removed once the runners’ default version of Xcode is 16 or above
+      - uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: 16
+
+      - name: Spec coverage
+        run: swift run BuildTool spec-coverage
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
   generate-matrices:
     runs-on: macos-latest
     outputs:
@@ -116,6 +131,7 @@ jobs:
     runs-on: ubuntu-latest
     needs:
       - lint
+      - spec-coverage
       - check-spm
       - check-xcode
       - check-example-app

AblyChat.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -1,5 +1,5 @@
 {
-  "originHash" : "4a28f4c041628961c5cac754904f5f76c33935bbc8417b2e036e0ab6c33b7a0a",
+  "originHash" : "a296396707b7685153f4cf548f6281f483d562002fe11235f1fc3bb053be91d7",
   "pins" : [
     {
       "identity" : "ably-cocoa",
@@ -54,6 +54,15 @@
         "revision" : "3d2dc41a01f9e49d84f0a3925fb858bed64f702d",
         "version" : "1.1.2"
       }
+    },
+    {
+      "identity" : "table",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/JanGorman/Table.git",
+      "state" : {
+        "revision" : "7b8521c3b1078ba0b347964aec7c503cd6f1ff40",
+        "version" : "1.1.1"
+      }
     }
   ],
   "version" : 3

CONTRIBUTING.md

@@ -85,7 +85,7 @@ func test3 { … }
 func test4 { … }
 ```
 
-In [#46](https://github.com/ably-labs/ably-chat-swift/issues/46), we’ll write a script that uses these tags to generate a report about how much of the feature spec we’ve implemented.
+You can run `swift run BuildTool spec-coverage` to generate a report about how many spec points have been implemented and/or tested. This script is also run in CI by the `spec-coverage` job. This script will currently only detect a spec point attribution tag if it’s written exactly as shown above; that is, in a `//` comment with a single space between each component of the tag.
 
 #### Marking a spec point as untested
 

Package.resolved

@@ -1,5 +1,5 @@
 {
-  "originHash" : "48d264bc362ab438d94b78732ce83d1971c3a1264d089085edd3814083479fc6",
+  "originHash" : "f00ee2e8c80adfe8d72deb089738cdb967aeae43e71837f90d99fc602728fe45",
   "pins" : [
     {
       "identity" : "ably-cocoa",
@@ -54,6 +54,15 @@
         "revision" : "3d2dc41a01f9e49d84f0a3925fb858bed64f702d",
         "version" : "1.1.2"
       }
+    },
+    {
+      "identity" : "table",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/JanGorman/Table.git",
+      "state" : {
+        "revision" : "7b8521c3b1078ba0b347964aec7c503cd6f1ff40",
+        "version" : "1.1.1"
+      }
     }
   ],
   "version" : 3

Package.swift

@@ -31,6 +31,10 @@ let package = Package(
             url: "https://github.com/apple/swift-async-algorithms",
             from: "1.0.1"
         ),
+        .package(
+            url: "https://github.com/JanGorman/Table.git",
+            from: "1.1.1"
+        ),
     ],
     targets: [
         .target(
@@ -67,6 +71,10 @@ let package = Package(
                     name: "AsyncAlgorithms",
                     package: "swift-async-algorithms"
                 ),
+                .product(
+                    name: "Table",
+                    package: "Table"
+                ),
             ]
         ),
     ]