Support units of measure in JsonParse (#170)

Bumps [actions/attest-build-provenance](https://github.com/actions/attest-build-provenance) from 1.0.0 to 1.3.2.
- [Release notes](https://github.com/actions/attest-build-provenance/releases)
- [Changelog](https://github.com/actions/attest-build-provenance/blob/main/RELEASE.md)
- [Commits](897ed5eab6...bdd51370e0)

---
updated-dependencies:
- dependency-name: actions/attest-build-provenance
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/workflows/assert-contents.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+echo "Unzipping version from NuGet"
+ls from-nuget.nupkg
+mkdir from-nuget && cp from-nuget.nupkg from-nuget/zip.zip && cd from-nuget && unzip zip.zip && rm zip.zip && cd - || exit 1
+
+echo "Unzipping version from local build"
+ls packed/
+mkdir from-local && cp packed/*.nupkg from-local/zip.zip && cd from-local && unzip zip.zip && rm zip.zip && cd - || exit 1
+
+cd from-local && find . -type f -exec sha256sum {} \; | sort > ../from-local.txt && cd .. || exit 1
+cd from-nuget && find . -type f -and -not -name '.signature.p7s' -exec sha256sum {} \; | sort > ../from-nuget.txt && cd .. || exit 1
+
+diff from-local.txt from-nuget.txt

.github/workflows/dotnet.yaml

@@ -221,11 +221,53 @@ jobs:
     steps:
       - run: echo "All required checks complete."
 
-  nuget-publish:
+  attestation-attribute:
+    runs-on: ubuntu-latest
+    needs: [all-required-checks-complete]
+    if: ${{ !github.event.repository.fork && github.ref == 'refs/heads/main' }}
+    permissions:
+      id-token: write
+      attestations: write
+      contents: read
+    steps:
+      - name: Download NuGet artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: nuget-package-attribute
+          path: packed
+      - name: Attest Build Provenance
+        uses: actions/attest-build-provenance@bdd51370e0416ac948727f861e03c2f05d32d78e # v1.3.2
+        with:
+          subject-path: "packed/*.nupkg"
+
+  attestation-plugin:
+    runs-on: ubuntu-latest
+    needs: [all-required-checks-complete]
+    if: ${{ !github.event.repository.fork && github.ref == 'refs/heads/main' }}
+    permissions:
+      id-token: write
+      attestations: write
+      contents: read
+    steps:
+      - name: Download NuGet artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: nuget-package-plugin
+          path: packed
+      - name: Attest Build Provenance
+        uses: actions/attest-build-provenance@bdd51370e0416ac948727f861e03c2f05d32d78e # v1.3.2
+        with:
+          subject-path: "packed/*.nupkg"
+
+  nuget-publish-attribute:
     runs-on: ubuntu-latest
     if: ${{ !github.event.repository.fork && github.ref == 'refs/heads/main' }}
     needs: [all-required-checks-complete]
     environment: main-deploy
+    permissions:
+      id-token: write
+      attestations: write
+      contents: read
     steps:
       - uses: actions/checkout@v4
       - name: Install Nix
@@ -233,20 +275,73 @@ jobs:
         with:
           extra_nix_config: |
             access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
-      - name: Download NuGet artifact (plugin)
-        uses: actions/download-artifact@v4
-        with:
-          name: nuget-package-plugin
-          path: packed-plugin
-      - name: Publish to NuGet (plugin)
-        run: nix develop --command dotnet nuget push "packed-plugin/WoofWare.Myriad.Plugins.*.nupkg" --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicate
-      - name: Download NuGet artifact (attribute)
+      - name: Download NuGet artifact
         uses: actions/download-artifact@v4
         with:
           name: nuget-package-attribute
-          path: packed-attribute
-      - name: Publish to NuGet (attribute)
-        run: nix develop --command dotnet nuget push "packed-attribute/WoofWare.Myriad.Plugins.Attributes.*.nupkg" --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicate
+          path: packed
+      - name: Publish to NuGet
+        id: publish-success
+        env:
+          NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
+        run: 'nix develop --command bash ./.github/workflows/nuget-push.sh "packed/WoofWare.Myriad.Plugins.Attributes.*.nupkg"'
+      - name: Wait for availability
+        if: steps.publish-success.outputs.result == 'published'
+        env:
+          PACKAGE_VERSION: ${{ steps.publish-success.outputs.version }}
+        run: 'echo "$PACKAGE_VERSION" && while ! curl -L --fail -o from-nuget.nupkg "https://www.nuget.org/api/v2/package/WoofWare.Myriad.Plugins.Attributes/$PACKAGE_VERSION" ; do sleep 10; done'
+      # Astonishingly, NuGet.org considers it to be "more secure" to tamper with my package after upload (https://devblogs.microsoft.com/nuget/introducing-repository-signatures/).
+      # So we have to *re-attest* it after it's uploaded. Mind-blowing.
+      - name: Assert package contents
+        if: steps.publish-success.outputs.result == 'published'
+        run: 'bash ./.github/workflows/assert-contents.sh'
+      - name: Attest Build Provenance
+        if: steps.publish-success.outputs.result == 'published'
+        uses: actions/attest-build-provenance@bdd51370e0416ac948727f861e03c2f05d32d78e # v1.3.2
+        with:
+          subject-path: "from-nuget.nupkg"
+
+  nuget-publish-plugin:
+    runs-on: ubuntu-latest
+    if: ${{ !github.event.repository.fork && github.ref == 'refs/heads/main' }}
+    needs: [all-required-checks-complete]
+    environment: main-deploy
+    permissions:
+      id-token: write
+      attestations: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Nix
+        uses: cachix/install-nix-action@V27
+        with:
+          extra_nix_config: |
+            access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
+      - name: Download NuGet artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: nuget-package-plugin
+          path: packed
+      - name: Publish to NuGet
+        id: publish-success
+        env:
+          NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
+        run: 'nix develop --command bash ./.github/workflows/nuget-push.sh "packed/WoofWare.Myriad.Plugins.*.nupkg"'
+      - name: Wait for availability
+        if: steps.publish-success.outputs.result == 'published'
+        env:
+          PACKAGE_VERSION: ${{ steps.publish-success.outputs.version }}
+        run: 'echo "$PACKAGE_VERSION" && while ! curl -L --fail -o from-nuget.nupkg "https://www.nuget.org/api/v2/package/WoofWare.Myriad.Plugins/$PACKAGE_VERSION" ; do sleep 10; done'
+      # Astonishingly, NuGet.org considers it to be "more secure" to tamper with my package after upload (https://devblogs.microsoft.com/nuget/introducing-repository-signatures/).
+      # So we have to *re-attest* it after it's uploaded. Mind-blowing.
+      - name: Assert package contents
+        if: steps.publish-success.outputs.result == 'published'
+        run: 'bash ./.github/workflows/assert-contents.sh'
+      - name: Attest Build Provenance
+        if: steps.publish-success.outputs.result == 'published'
+        uses: actions/attest-build-provenance@bdd51370e0416ac948727f861e03c2f05d32d78e # v1.3.2
+        with:
+          subject-path: "from-nuget.nupkg"
 
   github-release-plugin:
     runs-on: ubuntu-latest

.github/workflows/nuget-push.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+SOURCE_NUPKG=$(find . -type f -name '*.nupkg')
+
+PACKAGE_VERSION=$(basename "$SOURCE_NUPKG" | rev | cut -d '.' -f 2-4 | rev)
+
+echo "version=$PACKAGE_VERSION" >> "$GITHUB_OUTPUT"
+
+tmp=$(mktemp)
+
+if ! dotnet nuget push "$SOURCE_NUPKG" --api-key "$NUGET_API_KEY" --source https://api.nuget.org/v3/index.json > "$tmp" ; then
+    cat "$tmp"
+    if grep 'already exists and cannot be modified' "$tmp" ; then
+        echo "result=skipped" >> "$GITHUB_OUTPUT"
+        exit 0
+    else
+        echo "Unexpected failure to upload"
+        exit 1
+    fi
+fi
+
+cat "$tmp"
+
+echo "result=published" >> "$GITHUB_OUTPUT"

.gitignore

@@ -1,12 +1,12 @@
-bin/
-obj/
-/packages/
-riderModule.iml
-/_ReSharper.Caches/
-.idea/
-*.sln.DotSettings.user
-.DS_Store
-result
-.analyzerpackages/
-analysis.sarif
-.direnv/
+bin/
+obj/
+/packages/
+riderModule.iml
+/_ReSharper.Caches/
+.idea/
+*.sln.DotSettings.user
+.DS_Store
+result
+.analyzerpackages/
+analysis.sarif
+.direnv/

CHANGELOG.md

@@ -1,5 +1,10 @@
 Notable changes are recorded here.
 
+# WoofWare.Myriad.Plugins 2.1.45, WoofWare.Myriad.Plugins.Attributes 3.1.7
+
+The NuGet packages are now attested to through [GitHub Attestations](https://github.blog/2024-05-02-introducing-artifact-attestations-now-in-public-beta/).
+You can run `gh attestation verify ~/.nuget/packages/woofware.myriad.plugins/2.1.45/woofware.myriad.plugins.2.1.45.nupkg -o Smaug123`, for example, to verify with GitHub that the GitHub Actions pipeline on this repository produced a nupkg file with the same hash as the one you were served from NuGet.
+
 # WoofWare.Myriad.Plugins 2.1.33
 
 `JsonParse` can now deserialize the discriminated unions which `JsonSerialize` wrote out.

ConsumePlugin/GeneratedPureGymDto.fs

@@ -148,6 +148,7 @@ module GymLocation =
                         reraise ()
                 else
                     reraise ()
+            |> LanguagePrimitives.FloatWithMeasure
 
         let arg_0 =
             try

ConsumePlugin/PureGymDto.fs

@@ -19,13 +19,16 @@ type GymAccessOptions =
         QrCodeAccess : bool
     }
 
+[<Measure>]
+type measure
+
 [<WoofWare.Myriad.Plugins.JsonParse>]
 type GymLocation =
     {
         [<JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)>]
         Longitude : float
         [<JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)>]
-        Latitude : float
+        Latitude : float<measure>
     }
 
 [<WoofWare.Myriad.Plugins.JsonParse>]

README.md

@@ -8,23 +8,20 @@
 
 Some helpers in [Myriad](https://github.com/MoiraeSoftware/myriad/) which might be useful.
 
-These are currently somewhat experimental, and I personally am their primary customer.
-The `RemoveOptions` generator in particular is extremely half-baked.
+Currently implemented:
+
+* `JsonParse` (to stamp out `jsonParse : JsonNode -> 'T` methods).
+* `JsonSerialize` (to stamp out `toJsonNode : 'T -> JsonNode` methods).
+* `HttpClient` (to stamp out a [RestEase](https://github.com/canton7/RestEase)-style HTTP client).
+* `GenerateMock` (to stamp out a record type corresponding to an interface, like a compile-time [Foq](https://github.com/fsprojects/Foq)).
+* `CreateCatamorphism` (to stamp out a non-stack-overflowing [catamorphism](https://fsharpforfunandprofit.com/posts/recursive-types-and-folds/) for a discriminated union).
+* `RemoveOptions` (to strip `option` modifiers from a type) - this one is particularly half-baked!
 
 If you would like to ensure that your particular use-case remains unbroken, please do contribute tests to this repository.
 The `ConsumePlugin` assembly contains a number of invocations of these source generators,
 so you just need to add copies of your types to that assembly to ensure that I will at least notice if I break the build;
 and if you add tests to `WoofWare.Myriad.Plugins.Test` then I will also notice if I break the runtime semantics of the generated code.
 
-Currently implemented:
-
-* `JsonParse` (to stamp out `jsonParse : JsonNode -> 'T` methods);
-* `JsonSerialize` (to stamp out `toJsonNode : 'T -> JsonNode` methods);
-* `RemoveOptions` (to strip `option` modifiers from a type).
-* `HttpClient` (to stamp out a [RestEase](https://github.com/canton7/RestEase)-style HTTP client).
-* `GenerateMock` (to stamp out a record type corresponding to an interface).
-* `CreateCatamorphism` (to stamp out a non-stack-overflowing [catamorphism](https://fsharpforfunandprofit.com/posts/recursive-types-and-folds/) for a discriminated union).
-
 ## `JsonParse`
 
 Takes records like this:

WoofWare.Myriad.Plugins.Test/PureGymDtos.fs

@@ -58,7 +58,7 @@ module PureGymDtos =
         [
             """{"latitude": 1.0, "longitude": 3.0}""",
             {
-                GymLocation.Latitude = 1.0
+                GymLocation.Latitude = 1.0<measure>
                 Longitude = 3.0
             }
         ]
@@ -96,7 +96,7 @@ module PureGymDtos =
                 Location =
                     {
                         Longitude = -0.110252
-                        Latitude = 51.480401
+                        Latitude = 51.480401<measure>
                     }
                 TimeZone = "Europe/London"
                 ReopenDate = "2021-04-12T00:00:00+01 Europe/London"

WoofWare.Myriad.Plugins/JsonParseGenerator.fs

@@ -140,6 +140,47 @@ module internal JsonParseGenerator =
             failwithf
                 $"Unable to parse the key type %+A{desiredType} of a JSON object. Keys are strings, and this plugin does not know how to convert to that from a string."
 
+    let private parseNumberType
+        (options : JsonParseOption)
+        (propertyName : SynExpr option)
+        (node : SynExpr)
+        (typeName : string)
+        =
+        let basic = asValueGetValue propertyName typeName node
+
+        match options.JsonNumberHandlingArg with
+        | None -> basic
+        | Some option ->
+            let cond =
+                SynExpr.DotGet (SynExpr.createIdent "exc", range0, SynLongIdent.createS "Message", range0)
+                |> SynExpr.callMethodArg "Contains" (SynExpr.CreateConst "cannot be converted to")
+
+            let handler =
+                asValueGetValue propertyName "string" node
+                |> SynExpr.pipeThroughFunction (SynExpr.createLongIdent' (parseFunction typeName))
+                |> SynExpr.ifThenElse
+                    (SynExpr.equals
+                        option
+                        (SynExpr.createLongIdent
+                            [
+                                "System"
+                                "Text"
+                                "Json"
+                                "Serialization"
+                                "JsonNumberHandling"
+                                "AllowReadingFromString"
+                            ]))
+                    SynExpr.reraise
+                |> SynExpr.ifThenElse cond SynExpr.reraise
+
+            basic
+            |> SynExpr.pipeThroughTryWith
+                (SynPat.IsInst (
+                    SynType.LongIdent (SynLongIdent.createS' [ "System" ; "InvalidOperationException" ]),
+                    range0
+                ))
+                handler
+
     /// Given `node.["town"]`, for example, choose how to obtain a JSON value from it.
     /// The property name is used in error messages at runtime to show where a JSON
     /// parse error occurred; supply `None` to indicate "don't validate".
@@ -168,41 +209,7 @@ module internal JsonParseGenerator =
             node
             |> asValueGetValue propertyName "string"
             |> SynExpr.pipeThroughFunction (SynExpr.createLongIdent [ "System" ; "DateTime" ; "Parse" ])
-        | NumberType typeName ->
-            let basic = asValueGetValue propertyName typeName node
-
-            match options.JsonNumberHandlingArg with
-            | None -> basic
-            | Some option ->
-                let cond =
-                    SynExpr.DotGet (SynExpr.createIdent "exc", range0, SynLongIdent.createS "Message", range0)
-                    |> SynExpr.callMethodArg "Contains" (SynExpr.CreateConst "cannot be converted to")
-
-                let handler =
-                    asValueGetValue propertyName "string" node
-                    |> SynExpr.pipeThroughFunction (SynExpr.createLongIdent' (parseFunction typeName))
-                    |> SynExpr.ifThenElse
-                        (SynExpr.equals
-                            option
-                            (SynExpr.createLongIdent
-                                [
-                                    "System"
-                                    "Text"
-                                    "Json"
-                                    "Serialization"
-                                    "JsonNumberHandling"
-                                    "AllowReadingFromString"
-                                ]))
-                        SynExpr.reraise
-                    |> SynExpr.ifThenElse cond SynExpr.reraise
-
-                basic
-                |> SynExpr.pipeThroughTryWith
-                    (SynPat.IsInst (
-                        SynType.LongIdent (SynLongIdent.createS' [ "System" ; "InvalidOperationException" ]),
-                        range0
-                    ))
-                    handler
+        | NumberType typeName -> parseNumberType options propertyName node typeName
         | PrimitiveType typeName -> asValueGetValueIdent propertyName typeName node
         | OptionType ty ->
             parseNode None options ty (SynExpr.createIdent "v")
@@ -261,6 +268,14 @@ module internal JsonParseGenerator =
             |> SynExpr.callMethod "ToJsonString"
             |> SynExpr.paren
             |> SynExpr.applyFunction (SynExpr.createLongIdent [ "System" ; "Numerics" ; "BigInteger" ; "Parse" ])
+        | Measure (_measure, primType) ->
+            let qualified =
+                match Primitives.qualifyType primType with
+                | None -> failwith $"did not recognise type %s{primType} to assign measure"
+                | Some t -> t
+
+            parseNumberType options propertyName node primType
+            |> SynExpr.pipeThroughFunction (Measure.getLanguagePrimitivesMeasure qualified)
         | _ ->
             // Let's just hope that we've also got our own type annotation!
             let typeName =

WoofWare.Myriad.Plugins/Measure.fs

@@ -0,0 +1,24 @@
+namespace WoofWare.Myriad.Plugins
+
+open Fantomas.FCS.Syntax
+
+[<RequireQualifiedAccess>]
+module internal Measure =
+
+    let getLanguagePrimitivesMeasure (typeName : LongIdent) : SynExpr =
+        match typeName |> List.map _.idText with
+        | [ "System" ; "Single" ] -> [ "LanguagePrimitives" ; "Float32WithMeasure" ]
+        | [ "System" ; "Double" ] -> [ "LanguagePrimitives" ; "FloatWithMeasure" ]
+        | [ "System" ; "Byte" ] -> [ "LanguagePrimitives" ; "ByteWithMeasure" ]
+        | [ "System" ; "SByte" ] -> [ "LanguagePrimitives" ; "SByteWithMeasure" ]
+        | [ "System" ; "Int16" ] -> [ "LanguagePrimitives" ; "Int16WithMeasure" ]
+        | [ "System" ; "Int32" ] -> [ "LanguagePrimitives" ; "Int32WithMeasure" ]
+        | [ "System" ; "Int64" ] -> [ "LanguagePrimitives" ; "Int64WithMeasure" ]
+        | [ "System" ; "UInt16" ] -> [ "LanguagePrimitives" ; "UInt16WithMeasure" ]
+        | [ "System" ; "UInt32" ] -> [ "LanguagePrimitives" ; "UInt32WithMeasure" ]
+        | [ "System" ; "UInt64" ] -> [ "LanguagePrimitives" ; "UInt64WithMeasure" ]
+        | l ->
+            let l = String.concat "." l
+            failwith $"unrecognised type for measure: %s{l}"
+
+        |> SynExpr.createLongIdent

WoofWare.Myriad.Plugins/SynExpr/SynExpr.fs

@@ -87,6 +87,20 @@ module internal SynExpr =
         )
         |> applyTo b
 
+    /// {a} * {b}
+    let times (a : SynExpr) (b : SynExpr) =
+        SynExpr.CreateAppInfix (
+            SynExpr.CreateLongIdent (
+                SynLongIdent.SynLongIdent (
+                    Ident.CreateLong "op_Multiply",
+                    [],
+                    [ Some (IdentTrivia.OriginalNotation "*") ]
+                )
+            ),
+            a
+        )
+        |> applyTo b
+
     let rec stripOptionalParen (expr : SynExpr) : SynExpr =
         match expr with
         | SynExpr.Paren (expr, _, _, _) -> stripOptionalParen expr

WoofWare.Myriad.Plugins/SynExpr/SynType.fs

@@ -197,6 +197,17 @@ module internal SynTypePatterns =
             | _ -> None
         | _ -> None
 
+    let (|Measure|_|) (fieldType : SynType) : (Ident * string) option =
+        match fieldType with
+        | SynType.App (NumberType outer,
+                       _,
+                       [ SynType.LongIdent (SynLongIdent.SynLongIdent ([ ident ], _, _)) ],
+                       _,
+                       _,
+                       _,
+                       _) -> Some (ident, outer)
+        | _ -> None
+
     let (|DateOnly|_|) (fieldType : SynType) =
         match fieldType with
         | SynType.LongIdent (SynLongIdent.SynLongIdent (ident, _, _)) ->

WoofWare.Myriad.Plugins/WoofWare.Myriad.Plugins.fsproj

@@ -46,6 +46,7 @@
     <Compile Include="SynExpr\SynAttribute.fs" />
     <Compile Include="SynExpr\SynModuleDecl.fs" />
     <Compile Include="SynExpr\SynModuleOrNamespace.fs" />
+    <Compile Include="Measure.fs" />
     <Compile Include="AstHelper.fs" />
     <Compile Include="RemoveOptionsGenerator.fs"/>
     <Compile Include="InterfaceMockGenerator.fs"/>