Merge IOHK fork

.envrc

@@ -1 +1,3 @@
+watch_file flake.lock
+watch_file flake.nix
 use flake

.github/workflows/haskell.yml

@@ -1,6 +1,10 @@
 # modified from https://github.com/jgm/pandoc/blob/master/.github/workflows/ci.yml
 name: Haskell library and example
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   push:
     branches:
@@ -17,16 +21,12 @@ jobs:
       fail-fast: false
       matrix:
         versions:
-          - ghc: '8.6.5'
-            cabal: '3.6'
-          - ghc: '8.8.4'
-            cabal: '3.6'
-          - ghc: '8.10.4'
-            cabal: '3.6'
-          - ghc: '9.0.2'
-            cabal: '3.6'
           - ghc: '9.2.4'
             cabal: '3.6'
+          - ghc: '9.4.6'
+            cabal: '3.6'
+          # - ghc: '9.6.3'
+          #   cabal: '3.6'
     steps:
     - uses: actions/checkout@v2
 
@@ -58,13 +58,49 @@ jobs:
           dist-newstyle
         key: ${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-local
 
+    # - name: Set up a PureScript toolchain
+    #   uses: purescript-contrib/setup-purescript@main
+    #   with: # https://github.com/purescript-contrib/setup-purescript#specify-versions
+    #     spago: "latest"
+    #     purescript: "0.15.13"
+
+    - name: Set up new Spago
+      run: npm install -g spago@next purescript
+
+    - name: Cache PureScript dependencies
+      uses: actions/cache@v2
+      with:
+        key: ${{ runner.os }}-spago-${{ hashFiles('**/*.dhall') }}
+        path: |
+          .spago
+          output
+          test/RoundTripArgonautAesonGeneric/app/output
+          test/RoundTripJsonHelpers/app/output
+
     - name: Install dependencies
       run: |
-          cabal update
-          cabal build all --dependencies-only --enable-tests --disable-optimization
-    - name: Build
+        cabal update
+        cabal build all --dependencies-only --enable-tests --disable-optimization
+    - name: Build Haskell
+      run: |
+        cabal build all --enable-tests --disable-optimization 2>&1 | tee build.log
+    - name: Build PureScript Argonaut test project
+      run: |
+        cd test/RoundTripArgonautAesonGeneric/app
+        spago build
+    - name: Build PureScript JsonHelpers test project
       run: |
-          cabal build all --enable-tests --disable-optimization 2>&1 | tee build.log
+        cd test/RoundTripJsonHelpers/app
+        spago build
     - name: Test
       run: |
-          cabal test all --disable-optimization
+        # There are two PureScript projects which the Haskell tests build and run.
+        # The first build produces warnings which cause the Haskell tests to fail;
+        # pre-building these two projects clears these warnings.
+        cd test/RoundTripArgonautAesonGeneric/app
+        spago build
+        cd ../../../
+        cd test/RoundTripJsonHelpers/app
+        spago build
+        cd ../../../
+        cabal test all --disable-optimization

.github/workflows/nix-flake.yml

@@ -6,7 +6,10 @@ jobs:
   tests:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: cachix/install-nix-action@v20
-    - run: nix build
-    # - run: nix flake check
+      - uses: actions/checkout@v3
+      - uses: DeterminateSystems/nix-installer-action@main
+      - uses: DeterminateSystems/magic-nix-cache-action@main
+      - name: "Check `nix develop` shell"
+        run: nix develop --check
+      - run: nix build
+      - run: nix flake check

.github/workflows/purescript.yml

@@ -19,10 +19,14 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Set up a PureScript toolchain
-        uses: purescript-contrib/setup-purescript@main
-        with: # https://github.com/purescript-contrib/setup-purescript#specify-versions
-          purescript: "0.15.4"
+      # - name: Set up a PureScript toolchain
+      #   uses: purescript-contrib/setup-purescript@main
+      #   with: # https://github.com/purescript-contrib/setup-purescript#specify-versions
+      #     spago: "latest"
+      #     purescript: "0.15.13"
+
+      - name: Set up new Spago
+        run: npm install -g spago@next purescript
 
       - name: Cache PureScript dependencies
         uses: actions/cache@v2
@@ -38,10 +42,10 @@ jobs:
           spago install
 
       - name: Build source
-        run: spago build --no-install
+        run: spago build
 
       - name: Bundle app
-        run: spago bundle-app --to static/index.js
+        run: spago bundle --bundle-type app --outfile static/index.js
 
       - name: Run tests
-        run: spago test --no-install
+        run: spago test

.gitignore

@@ -20,7 +20,6 @@ cabal.sandbox.config
 dist
 dist-*
 shell.nix
-stack.yaml
 .dir-locals.el
 .psc-ide-port
 

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog for purescript-bridge
+
+## 0.16.0.0 (unreleased)
+* merge https://github.com/input-output-hk/purescript-bridge
+* support https://github.com/input-output-hk/purescript-bridge-json-helpers
+* `CodeGenSwitches` no longer used
+* `Proxy` no longer used
+* `Printer` uses `Leijen.Text` instead of `Text`
+* `genericShow` PureScript instance from IOHK
+  * I think the same as https://github.com/eskimor/purescript-bridge/pull/85
+    * PR 85 has been replaced with IOHK's implementation
+* some unit tests replaced with IOHK's tests
+* all printer imports are combined into one function `instanceToImportLines` instead of being divided between two modules
+* excellent `RoundTrip` tests implemented by IOHK
+  * greatly improves test coverage for both Argonaut and `json-helpers` and exposes issues

README.md

@@ -1,32 +1,99 @@
 # purescript-bridge
-
-
-[![Haskell library and example](https://github.com/eskimor/purescript-bridge/actions/workflows/haskell.yml/badge.svg)](https://github.com/eskimor/purescript-bridge/actions/workflows/haskell.yml) [![Purescript example](https://github.com/eskimor/purescript-bridge/actions/workflows/purescript.yml/badge.svg)](https://github.com/eskimor/purescript-bridge/actions/workflows/purescript.yml) [![Nix Flake](https://github.com/eskimor/purescript-bridge/actions/workflows/nix-flake.yml/badge.svg)](https://github.com/eskimor/purescript-bridge/actions/workflows/nix-flake.yml)
-
-
+[![Haskell library and example](https://github.com/eskimor/purescript-bridge/actions/workflows/haskell.yml/badge.svg)](https://github.com/eskimor/purescript-bridge/actions/workflows/haskell.yml) [![PureScript example](https://github.com/eskimor/purescript-bridge/actions/workflows/purescript.yml/badge.svg)](https://github.com/eskimor/purescript-bridge/actions/workflows/purescript.yml) [![Nix Flake](https://github.com/eskimor/purescript-bridge/actions/workflows/nix-flake.yml/badge.svg)](https://github.com/eskimor/purescript-bridge/actions/workflows/nix-flake.yml)
 
 Translate your Haskell types to PureScript types. It should in theory work for almost all Haskell types, including type constructors!
 You just have to instantiate it with dummy parameters from e.g. "Language.PureScript.Bridge.TypeParameters".
 
 Data type translation is fully and easily customizable by providing your own `BridgePart` instances!
 
-The latest version of this project requires **Purescript 0.15**.
+The latest version of this project requires **PureScript 0.15**.
 
 ## JSON encoding / decoding
+### Haskell
+Use [`aeson`](http://hackage.haskell.org/package/aeson)'s generic encoding/decoding with default options
+
+### PureScript
+There are three PureScript libraries which can interface with Aeson through PureScript bridge. The second, `purescript-argonaut-aeson-generic`, has issues.
 
-For compatible JSON representations:
+#### [`input-output-hk/purescript-bridge-json-helpers`](https://github.com/input-output-hk/purescript-bridge-json-helpers.git)
+
+Enable this on the Haskell side with `Language.PureScript.Bridge.SumType.jsonHelpers`.
+
+
+* this library is demonstrated by the `example`; see `./example/readme.md`.
+* see `./test/RoundTripJsonHelpers` for an additional example
+* sample Dhall config (for [spago-legacy](https://github.com/purescript/spago-legacy)):
+```
+, json-helpers =
+  { dependencies =
+    [ "aff"
+    , "argonaut-codecs"
+    , "argonaut-core"
+    , "arrays"
+    , "bifunctors"
+    , "contravariant"
+    , "control"
+    , "effect"
+    , "either"
+    , "enums"
+    , "foldable-traversable"
+    , "foreign-object"
+    , "maybe"
+    , "newtype"
+    , "ordered-collections"
+    , "prelude"
+    , "profunctor"
+    , "psci-support"
+    , "quickcheck"
+    , "record"
+    , "spec"
+    , "spec-quickcheck"
+    , "transformers"
+    , "tuples"
+    , "typelevel-prelude"
+    ]
+  , repo =
+      "https://github.com/input-output-hk/purescript-bridge-json-helpers.git"
+  , version = "486db9ee62882baa42cca24f556848c5f6bec565"
+  }
+```
+#### [`purescript-argonaut-aeson-generic >=0.4.1`](https://pursuit.purescript.org/packages/purescript-argonaut-aeson-generic/0.4.1) ([GitHub](https://github.com/coot/purescript-argonaut-aeson-generic))
 
-* On Haskell side:
-  * Use [`aeson`](http://hackage.haskell.org/package/aeson)'s generic encoding/decoding with default options
-* On Purescript side:
-  * Use [`purescript-argonaut-aeson-generic >=0.4.1`](https://pursuit.purescript.org/packages/purescript-argonaut-aeson-generic/0.4.1) ([GitHub](https://github.com/coot/purescript-argonaut-aeson-generic))
-  * Or use [`purescript-foreign-generic`](https://pursuit.purescript.org/packages/purescript-foreign-generic).
-    * [This branch](https://github.com/paf31/purescript-foreign-generic/pull/76) is updated for Purescript 0.15.
+Enable this on the Haskell side with `Language.PureScript.Bridge.SumType.argonautAesonGeneric`.
+
+**TODO**: [resolve incompatibility between Argonaut and Aeson](https://github.com/purescript-contrib/purescript-argonaut-codecs/issues/115)
+
+**Additional requirement**: [`peterbecich/purescript-argonaut-codecs`](https://github.com/peterbecich/purescript-argonaut-codecs.git)
+* commit `04abb3eb24a4deafe125be0eb23e2786c642e66b`
+* this library is demonstrated by the `example`; see `./example/readme.md`.
+* see `./test/RoundTripArgonautAesonGeneric` for additional example
+  * note that some types have been disabled from the `RoundTripArgonautAesonGeneric` test
+    * `RoundTripJsonHelpers` tests more types
+  * the types tested can be expanded when the incompatibility issue is resolved
+* sample Dhall config:
+```
+      , argonaut-codecs =
+        { dependencies = [ "console" ]
+        , repo = "https://github.com/peterbecich/purescript-argonaut-codecs.git"
+        , version = "04abb3eb24a4deafe125be0eb23e2786c642e66b"
+        }
+```
+* forked from [`purescript-contrib/purescript-argonaut-codecs`](https://github.com/purescript-contrib/purescript-argonaut-codecs)
+
+#### [`paf31/purescript-foreign-generic`](https://github.com/paf31/purescript-foreign-generic)
+
+See `ForeignObject` in `Language.PureScript.Bridge.SumType`.
+
+This may need to be fixed.
+
+The test coverage is less than the other two libraries.
 
 ## Documentation
 
 Usage of this library is documented in `Language.Purescript.Bridge`, with `writePSTypes` you should have everything to get started. Documentation can be found [here](https://www.stackage.org/nightly/package/purescript-bridge).
 
+There is an example; see `./example/readme.md`.
+
 ## Status
 
 It works for my use case and is used in production. PRs for more `PSType`s definitions and bridges are very welcome! 

cabal.project

@@ -1,3 +1,5 @@
 packages:
   .
   example/.
+
+tests: true

development.md

@@ -0,0 +1,14 @@
+# Regenerate everything
+reset && stack run generate-purescript && mv src/Argonaut/* example/src/Argonaut && mv src/JsonHelpers/* example/src/JsonHelpers;  cd example && spago bundle --bundle-type app --outfile static/index.js; cd ..
+
+# Regenerate purescript files
+reset && cd example && spago bundle --bundle-type app --outfile static/index.js; cd ..
+
+# Roundtrip server example
+
+## Tab 1
+stack run example
+
+## Tab 2
+cd example/static
+parcel serve index.html

example/app/GeneratePurescript.hs

@@ -3,21 +3,22 @@ module Main where
 import           Control.Lens
 import           Data.Text (pack)
 import           Language.PureScript.Bridge
-import           Language.PureScript.Bridge.CodeGenSwitches (ForeignOptions (ForeignOptions),
-                                                             genForeign,
-                                                             useGenRep)
 
+import           ArgonautTypes
+import           JsonHelpersTypes
 import qualified MyLib
-import           Types
-
-frontEndRoot :: String
-frontEndRoot = "src"
+import           Types (myBridge)
 
 -- https://discourse.purescript.org/t/latest-and-greatest-haskell-purescript-serialization/1640/6
 main :: IO ()
 main = do
-  writePSTypesWith
-    (useGenRep <> genForeign (ForeignOptions False False))
-    frontEndRoot
+  writePSTypesWithNamespace
+    (Just . PackageName $ pack "Argonaut")
+    "src"
+    (buildBridge myBridge)
+    myArgonautTypes
+  writePSTypesWithNamespace
+    (Just . PackageName $ pack "JsonHelpers")
+    "src"
     (buildBridge myBridge)
-    myTypes
+    myJsonHelpersTypes

example/app/Main.hs

@@ -1,8 +1,25 @@
 module Main where
 
+import           ArgonautTypes
+import           Control.Lens
+import           Data.Text (pack)
+import           JsonHelpersTypes
+import           Language.PureScript.Bridge
 import qualified MyLib (main)
+import           Types
 
 main :: IO ()
 main = do
-  putStrLn "Hello, Haskell!"
+  -- generate PureScript before server starts
+  writePSTypesWithNamespace
+    (Just . PackageName $ pack "Argonaut")
+    "src"
+    (buildBridge myBridge)
+    myArgonautTypes
+  writePSTypesWithNamespace
+    (Just . PackageName $ pack "JsonHelpers")
+    "src"
+    (buildBridge myBridge)
+    myJsonHelpersTypes
+
   MyLib.main

example/example.cabal

@@ -9,7 +9,7 @@ build-type:          Simple
 extra-source-files:  CHANGELOG.md
 
 library
-  exposed-modules:     MyLib, Types
+  exposed-modules:     MyLib, Types, ArgonautTypes, JsonHelpersTypes
   hs-source-dirs:      src
   build-depends:       base >=4.8 && <5
                      , aeson >= 1.5.5.0
@@ -23,12 +23,17 @@ library
                      , text
                      , warp
                      , purescript-bridge
+                     , QuickCheck
   default-language:    Haskell2010
 
 executable example
   main-is:             Main.hs
   hs-source-dirs:      app
-  build-depends:       base >=4.8 && <5, example
+  build-depends:       base >=4.8 && <5
+                     , example
+                     , purescript-bridge
+                     , text
+                     , lens
   default-language:    Haskell2010
 
 executable generate-purescript