94ab29f...master · jrec

.github/workflows/ci.yaml+7−13

@@ -4,20 +4,14 @@ on:

44 push:

55jobs:

66 build:

7− runs-on: ${{ matrix.os }}

8− strategy:

9− matrix:

10− ghc: ['ghc884', 'ghc8101']

11− os: [ubuntu-latest]

12− name: GHC ${{ matrix.ghc }}

7+ runs-on: ubuntu-latest

138 steps:

149 - uses: actions/checkout@v2

15− - uses: cachix/install-nix-action@v10

16− - uses: cachix/cachix-action@v6

10+ - uses: nixbuild/nix-quick-install-action@v21

1711 with:

18− name: juspay-nau

19− signingKey: '${{ secrets.CACHIX_SIGNING_KEY }}'

20− # Only needed for private caches

21− authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'

12+ nix_conf: |

13+ experimental-features = nix-command flakes

2214 - name: Build and test 🔧

23− run: nix-build -j4 --argstr compiler ${{ matrix.ghc }}

15+ run: nix build -j 4 -L

16+ - name: Build and test (GHC 8.8) 🔧

17+ run: nix build -j 4 -L .#jrec-ghc88

.vscode/extensions.jsonnew file+11

@@ -0,0 +1,11 @@

1+{

2+ // See https://go.microsoft.com/fwlink/?LinkId=827846

3+ // for the documentation about the extensions.json format

4+ "recommendations": [

5+ "haskell.haskell",

6+ "arrterian.nix-env-selector",

7+ "bbenoist.nix",

8+ "jnoortheen.nix-ide",

9+ "tamasfe.even-better-toml"

10+ ]

11+}

.vscode/settings.json+5−4

@@ -1,5 +1,6 @@

11{

2− "nixEnvSelector.nixShellConfig": "${workspaceRoot}/default.nix",

3− "editor.formatOnType": true,

4− "editor.formatOnSave": true

5−}

2+ "editor.formatOnType": true,

3+ "editor.formatOnSave": true,

4+ "nixEnvSelector.nixFile": "${workspaceRoot}/shell.nix",

5+ "haskell.manageHLS": "PATH"

6+}

CHANGELOG.md+4

@@ -1,5 +1,9 @@

11# Revision history for rec

22

3+## Unreleased

4+

5+- GHC 9.2 + Aeson 2.0 support

6+

37## 0.1.0.0 -- YYYY-mm-dd

48

59* First version. Released on an unsuspecting world.

Setup.hsdeleted−2

@@ -1,2 +0,0 @@

1−import Distribution.Simple

2−main = defaultMain

bin/test+1−1

@@ -2,4 +2,4 @@

22set -xe

33

44# NOTE: ghcid should be run with -W to allow warnings from should-not-typecheck

5−nix-shell --pure --run "ghcid $* -W -c 'cabal new-repl test:jrec-test' -T \":main $*\""

5+nix develop -c sh -c "ghcid $* -W -c 'cabal new-repl test:jrec-test' -T \":main $*\""

default.nixdeleted−36

@@ -1,36 +0,0 @@

1−let

2− nixpkgsSrc = builtins.fetchTarball {

3− url = "https://github.com/nixos/nixpkgs/archive/76f2e271a2ef.tar.gz";

4− sha256 = "1r4da3kyghqq7vzya5yb295jpnha1fgp755bi6wda4fmhyaynnsp";

5− };

6− gitignoreSrc = builtins.fetchTarball {

7− url = "https://github.com/hercules-ci/gitignore/archive/c4662e6.tar.gz";

8− sha256 = "1npnx0h6bd0d7ql93ka7azhj40zgjp815fw2r6smg8ch9p7mzdlx";

9− };

10− inherit (import gitignoreSrc { inherit (pkgs); }) gitignoreSource;

11−in {

12− compiler ? "default",

13− pkgs ? import nixpkgsSrc {},

14−}:

15− let

16− haskellPackages =

17− if compiler == "default"

18− then pkgs.haskellPackages

19− else pkgs.haskell.packages.${compiler};

20− projectDrv =

21− haskellPackages.override {

22− overrides = self: super: with pkgs.haskell.lib; {

23− jrec = self.callCabal2nix "jrec" (gitignoreSource ./.) {};

24− # https://github.com/lspitzner/data-tree-print/pull/2

25− data-tree-print = doJailbreak super.data-tree-print;

26− };

27− };

28− projectShell =

29− projectDrv.shellFor {

30− packages = p: [ p.jrec ];

31− buildInputs = with projectDrv; [

32− cabal-install

33− ];

34− };

35− in

36− if pkgs.lib.inNixShell then projectShell else projectDrv.jrec

flake.locknew file+81

@@ -0,0 +1,81 @@

1+{

2+ "nodes": {

3+ "flake-parts": {

4+ "inputs": {

5+ "nixpkgs-lib": "nixpkgs-lib"

6+ },

7+ "locked": {

8+ "lastModified": 1678379998,

9+ "narHash": "sha256-TZdfNqftHhDuIFwBcN9MUThx5sQXCTeZk9je5byPKRw=",

10+ "owner": "hercules-ci",

11+ "repo": "flake-parts",

12+ "rev": "c13d60b89adea3dc20704c045ec4d50dd964d447",

13+ "type": "github"

14+ },

15+ "original": {

16+ "owner": "hercules-ci",

17+ "repo": "flake-parts",

18+ "type": "github"

19+ }

20+ },

21+ "nixpkgs": {

22+ "locked": {

23+ "lastModified": 1678594102,

24+ "narHash": "sha256-OHAHYiMWJFPNxuW/PcOMlSD2tvXnEYC1jxREBADHwwQ=",

25+ "owner": "nixos",

26+ "repo": "nixpkgs",

27+ "rev": "796b4a3c1d903c4b9270cd2548fe46f524eeb886",

28+ "type": "github"

29+ },

30+ "original": {

31+ "owner": "nixos",

32+ "ref": "nixpkgs-unstable",

33+ "repo": "nixpkgs",

34+ "type": "github"

35+ }

36+ },

37+ "nixpkgs-ghc88": {

38+ "locked": {

39+ "lastModified": 1596466290,

40+ "narHash": "sha256-V1vrlYfVEdW4iauUc58LCtorSxLLF+X/PhjD5+dQjeQ=",

41+ "owner": "nixos",

42+ "repo": "nixpkgs",

43+ "rev": "76f2e271a2ef9de3734dcc9d366a42d6bfb18e82",

44+ "type": "github"

45+ },

46+ "original": {

47+ "owner": "nixos",

48+ "ref": "76f2e271a2ef",

49+ "repo": "nixpkgs",

50+ "type": "github"

51+ }

52+ },

53+ "nixpkgs-lib": {

54+ "locked": {

55+ "dir": "lib",

56+ "lastModified": 1678375444,

57+ "narHash": "sha256-XIgHfGvjFvZQ8hrkfocanCDxMefc/77rXeHvYdzBMc8=",

58+ "owner": "NixOS",

59+ "repo": "nixpkgs",

60+ "rev": "130fa0baaa2b93ec45523fdcde942f6844ee9f6e",

61+ "type": "github"

62+ },

63+ "original": {

64+ "dir": "lib",

65+ "owner": "NixOS",

66+ "ref": "nixos-unstable",

67+ "repo": "nixpkgs",

68+ "type": "github"

69+ }

70+ },

71+ "root": {

72+ "inputs": {

73+ "flake-parts": "flake-parts",

74+ "nixpkgs": "nixpkgs",

75+ "nixpkgs-ghc88": "nixpkgs-ghc88"

76+ }

77+ }

78+ },

79+ "root": "root",

80+ "version": 7

81+}

flake.nixnew file+34

@@ -0,0 +1,34 @@

1+{

2+ inputs = {

3+ nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable";

4+ nixpkgs-ghc88.url = "github:nixos/nixpkgs/76f2e271a2ef";

5+ flake-parts.url = "github:hercules-ci/flake-parts";

6+ };

7+ outputs = inputs@{ nixpkgs, flake-parts, ... }:

8+ flake-parts.lib.mkFlake { inherit inputs; } {

9+ systems = nixpkgs.lib.systems.flakeExposed;

10+ perSystem = { self', inputs', pkgs, system, ... }:

11+ let

12+ overlay = self: super: {

13+ jrec = self.callCabal2nix "jrec" ./. { };

14+ };

15+ ghcVersions = {

16+ ghc88 = inputs.nixpkgs-ghc88.legacyPackages.${system}.haskellPackages.extend overlay;

17+ ghc92 = pkgs.haskellPackages.extend overlay;

18+ };

19+ in

20+ {

21+ packages.default = ghcVersions.ghc92.jrec;

22+ devShells.default = ghcVersions.ghc92.shellFor {

23+ packages = p: [ p.jrec ];

24+ buildInputs = with ghcVersions.ghc92; [

25+ cabal-install

26+ ghcid

27+ haskell-language-server

28+ ];

29+ };

30+ # Expose jrec built with GHC 8.8 so it can be tested in CI.

31+ packages.jrec-ghc88 = ghcVersions.ghc88.jrec;

32+ };

33+ };

34+}

jrec.cabal+15−3

@@ -1,6 +1,6 @@

11cabal-version: 2.4

22name: jrec

3−version: 0.1.0.0

3+version: 0.1.0.1

44synopsis: anonymous records for busy people

55

66-- description:

@@ -24,13 +24,20 @@ flag with-aeson

2424 -- with instances by default

2525 default: True

2626

27+flag with-generics

28+ description: Enable GHC.Generics instances

29+ -- don't let the solver fiddle with the flag

30+ manual: True

31+ -- with instances by default

32+ default: True

33+

2734-- A common stanza to share with tests, so that ghcid (bin/test) will reload

2835-- instantly when the library sources change (without us having to restart it).

2936common library-common

3037 default-language: Haskell2010

3138 build-depends:

3239 aeson

33− , base >=4.13 && <4.15

40+ , base >=4.13 && <4.17

3441 , constraints

3542 , deepseq

3643 , generic-data

@@ -81,13 +88,18 @@ library

8188 JRec.Field

8289 if flag(with-aeson)

8390 cpp-options: -DWITH_AESON

91+ if flag(with-generics)

92+ cpp-options: -DWITH_GENERICS

8493

8594test-suite jrec-test

8695 import: library-common

8796 type: exitcode-stdio-1.0

8897 hs-source-dirs: test, src

8998 main-is: Spec.hs

90− cpp-options: -DWITH_AESON

99+ cpp-options: -DWITH_AESON -DWITH_GENERICS

100+ other-modules:

101+ JRecShouldNotTypecheckSpec

102+ JRecSpec

91103 build-depends:

92104 base,

93105 hspec,

shell.nixnew file+1

@@ -0,0 +1 @@

1+(builtins.getFlake ("git+file://" + toString ./.)).devShells.${builtins.currentSystem}.default

src/JRec.hs+3

@@ -1,3 +1,4 @@

1+{-# LANGUAGE CPP #-}

12{-# LANGUAGE GADTs #-}

23{-# LANGUAGE PatternSynonyms #-}

34{-# LANGUAGE TypeApplications #-}

@@ -128,6 +129,7 @@ type RecordRep fields =

128129 (Sels fields)

129130 )

130131

132+#ifdef WITH_GENERICS

131133instance

132134 (R.FromNative (RecordRep fields) fields, R.ToNative (RecordRep fields) fields) =>

133135 Generic (Rec fields)

@@ -137,6 +139,7 @@ instance

137139 RecordRep fields

138140 from r = R.toNative' r

139141 to rep = R.fromNative' rep

142+#endif

140143

141144----------------------------------------------------------------------------

142145-- generic-lens

src/JRec/Internal.hs+17−11

@@ -32,6 +32,7 @@ import qualified Control.Monad.State as S

3232import Data.Aeson

3333import Data.Aeson.Types (Parser)

3434import Data.Constraint

35+import Data.List (intercalate)

3536import Data.Maybe (catMaybes)

3637import Data.Proxy

3738import qualified Data.Text as T

@@ -42,11 +43,17 @@ import GHC.OverloadedLabels

4243import GHC.Prim

4344import GHC.ST (ST (..), runST)

4445import GHC.TypeLits

45−import Generic.Data (gshowsPrec)

46−import Generic.Data.Internal.Show (GShow)

4746import qualified Optics.Lens as OL

4847import Unsafe.Coerce

4948import Prelude

49+#if MIN_VERSION_aeson(2,0,0)

50+import Data.Aeson.Key (fromText, fromString)

51+#else

52+fromText :: a -> a

53+fromText = id

54+fromString :: String -> T.Text

55+fromString = T.pack

56+#endif

5057

5158-- | Field named @l@ labels value of type @t@ adapted from the awesome /labels/ package.

5259-- Example: @(#name := \"Chris\") :: (\"name\" := String)@

@@ -102,13 +109,12 @@ defaultJSONOptions = JSONOptions {fieldTransform = id}

102109type role Rec representational

103110

104111instance

105− ( RecApply lts lts Show,

106− GShow Proxy (Rep (Rec lts)),

107− Generic (Rec lts)

112+ ( RecApply lts lts Show

108113 ) =>

109114 Show (Rec lts)

110115 where

111− show = (\x -> if null x then "{}" else x) . unwords . drop 1 . words . flip (gshowsPrec 0) ""

116+ show rec = "{" ++ formatted ++ "}"

117+ where formatted = intercalate ", " $ map (\(k, v) -> k ++ " = " ++ v) $ showRec rec

112118

113119instance RecEq lts lts => Eq (Rec lts) where

114120 (==) (a :: Rec lts) (b :: Rec lts) = recEq a b (Proxy :: Proxy lts)

@@ -560,16 +566,16 @@ class ToJSON a => EncodeField a where

560566

561567instance ToJSON a => EncodeField a where

562568 encodeField = pure . toJSON

563− encodeKV = (.=)

569+ encodeKV k v = fromText k .= v

564570

565571instance {-# OVERLAPS #-} ToJSON a => EncodeField (Maybe a) where

566572 encodeField = fmap toJSON

567573 encodeKV _ Nothing = mempty

568− encodeKV k v = k .= v

574+ encodeKV k v = fromText k .= v

569575

570576recToValue :: forall lts. (RecApply lts lts EncodeField) => JSONOptions -> Rec lts -> Value

571577recToValue options r =

572− object $ catMaybes $ reflectRec @EncodeField Proxy (\k v -> (T.pack (fieldTransform options k),) <$> encodeField v) r

578+ object $ catMaybes $ reflectRec @EncodeField Proxy (\k v -> (fromString (fieldTransform options k),) <$> encodeField v) r

573579

574580recToEncoding :: forall lts. (RecApply lts lts EncodeField) => JSONOptions -> Rec lts -> Encoding

575581recToEncoding options r =

@@ -674,10 +680,10 @@ class FromJSON a => ParseField a where

674680 parseField :: Object -> T.Text -> Parser a

675681

676682instance FromJSON a => ParseField a where

677− parseField = (.:)

683+ parseField o k = o .: fromText k

678684

679685instance {-# OVERLAPS #-} FromJSON a => ParseField (Maybe a) where

680− parseField = (.:?)

686+ parseField o k = o .:? fromText k

681687

682688instance

683689 ( KnownSymbol l,