c26b074...master · haskell-servant/servant-elm

.github/workflows/build.yaml+5

since splitsnapshots

unifiedsplit

@@ -17,6 +17,11 @@ jobs:

17 steps:

18 - uses: actions/checkout@v3

19

20+ - name: Install Nix

21+ uses: cachix/install-nix-action@v20

22+ with:

23+ nix_path: nixpkgs=channel:nixos-unstable

24+

20 - name: Cache

25 - name: Cache

21 uses: actions/cache@v3

26 uses: actions/cache@v3

22 env:

27 env:

servant-elm.cabal+1−1

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

1name: servant-elm

2−version: 0.7.2

2+version: 0.7.3

3synopsis: Automatically derive Elm functions to query servant webservices.

4description: Please see README.md

5homepage: http://github.com/mattjbray/servant-elm#readme

src/Servant/Elm/Internal/Generate.hs+25−11

@@ -53,16 +53,22 @@ data ElmOptions = ElmOptions

53 argument.

54 -}

55 urlPrefix :: UrlPrefix

56− , elmTypeAlterations :: (EType -> EType)

56+ , elmTypeAlterations :: (EType -> EType)

57 -- ^ Alterations to perform on ETypes before code generation.

58 , elmAlterations :: (ETypeDef -> ETypeDef)

59 -- ^ Alterations to perform on ETypeDefs before code generation.

60− , elmToString :: (EType -> Text)

60+ , elmToString :: (EType -> Text)

61 -- ^ Elm functions creating a string from a given type.

62 , emptyResponseElmTypes :: [EType]

63 -- ^ Types that represent an empty Http response.

64 , stringElmTypes :: [EType]

65 -- ^ Types that represent a String.

66+ , expectJsonMethod :: Text

67+ -- ^ The function to use for JSON responses.

68+ , expectStringMethod :: Text

69+ -- ^ The function to use for string responses.

70+ , httpErrorType :: Text

71+ -- ^ The type to use for Http errors.

66 }

72 }

67

73

68

74

@@ -86,6 +92,9 @@ The default options are:

86> , stringElmTypes =

92> , stringElmTypes =

87> [ getType (Proxy :: Proxy String)

93> [ getType (Proxy :: Proxy String)

88> , getType (Proxy :: Proxy T.Text) ]

94> , getType (Proxy :: Proxy T.Text) ]

95+> , expectJsonMethod = "Http.expectJson"

96+> , expectStringMethod = "Http.expectString"

97+> , httpErrorType = "Http.Error"

89> }

98> }

90-}

99-}

91defElmOptions :: ElmOptions

100defElmOptions :: ElmOptions

@@ -101,6 +110,9 @@ defElmOptions = ElmOptions

101 [ toElmType (Proxy :: Proxy String)

110 [ toElmType (Proxy :: Proxy String)

102 , toElmType (Proxy :: Proxy T.Text)

111 , toElmType (Proxy :: Proxy T.Text)

103 ]

112 ]

113+ , expectJsonMethod = "Http.expectJson"

114+ , expectStringMethod = "Http.expectString"

115+ , httpErrorType = "Http.Error"

104 }

116 }

105

117

106

118

@@ -119,6 +131,7 @@ The default required imports are:

119> import Set

131> import Set

120> import Http

132> import Http

121> import String

133> import String

134+> import Url

122> import Url.Builder

135> import Url.Builder

123-}

136-}

124defElmImports :: Text

137defElmImports :: Text

@@ -132,6 +145,7 @@ defElmImports =

132 , "import Set"

145 , "import Set"

133 , "import Http"

146 , "import Http"

134 , "import String"

147 , "import String"

148+ , "import Url"

135 , "import Url.Builder"

149 , "import Url.Builder"

136 ]

150 ]

137

151

@@ -245,7 +259,7 @@ generateElmForRequest opts request =

245 fnName =

259 fnName =

246 request ^. F.reqFuncName . to (replace . F.camelCase) . to stext

260 request ^. F.reqFuncName . to (replace . F.camelCase) . to stext

247

261

248− replace = T.replace "-" "" . T.replace "." ""

262+ replace = T.replace "-" "" . T.replace "." "" . T.replace " " ""

249

263

250 typeSignature =

264 typeSignature =

251 mkTypeSignature opts request

265 mkTypeSignature opts request

@@ -307,7 +321,7 @@ mkTypeSignature opts request =

307 toMsgType :: Maybe Doc

321 toMsgType :: Maybe Doc

308 toMsgType = do

322 toMsgType = do

309 result <- fmap elmTypeRef $ request ^. F.reqReturnType

323 result <- fmap elmTypeRef $ request ^. F.reqReturnType

310− Just ("(Result Http.Error " <+> parens result <+> " -> msg)")

324+ Just ("(Result" <+> stext (httpErrorType opts) <+> parens result <+> "-> msg)")

311

325

312 returnType :: Maybe Doc

326 returnType :: Maybe Doc

313 returnType = do

327 returnType = do

@@ -325,7 +339,7 @@ elmCaptureArg segment =

325 "capture_" <>

339 "capture_" <>

326 F.captureArg segment ^. F.argName . to (stext . replace . F.unPathSegment)

340 F.captureArg segment ^. F.argName . to (stext . replace . F.unPathSegment)

327 where

341 where

328− replace = T.replace "-" "_"

342+ replace = T.replace "-" "_" . T.replace " " "_"

329

343

330

344

331elmQueryArg :: F.QueryArg EType -> Doc

345elmQueryArg :: F.QueryArg EType -> Doc

@@ -499,11 +513,11 @@ mkRequest opts request =

499 | isEmptyType opts $ (elmTypeAlterations opts) elmTypeExpr

513 | isEmptyType opts $ (elmTypeAlterations opts) elmTypeExpr

500 -- let elmConstructor = T.pack (renderElm elmTypeExpr)

514 -- let elmConstructor = T.pack (renderElm elmTypeExpr)

501 ->

515 ->

502− "Http.expectString " <> line <+> indent i "(\\x -> case x of" <> line <+>

516+ stext (expectStringMethod opts) <> line <+> indent i "(\\x -> case x of" <> line <+>

503 indent i "Err e -> toMsg (Err e)" <> line <+>

517 indent i "Err e -> toMsg (Err e)" <> line <+>

504 indent i "Ok _ -> toMsg (Ok ()))"

518 indent i "Ok _ -> toMsg (Ok ()))"

505 Just elmTypeExpr ->

519 Just elmTypeExpr ->

506− "Http.expectJson toMsg" <+> renderDecoderName ((elmTypeAlterations opts) elmTypeExpr)

520+ stext (expectJsonMethod opts) <+> "toMsg" <+> renderDecoderName ((elmTypeAlterations opts) elmTypeExpr)

507 Nothing -> error "mkHttpRequest: no reqReturnType?"

521 Nothing -> error "mkHttpRequest: no reqReturnType?"

508 -- case request ^. F.reqReturnType of

522 -- case request ^. F.reqReturnType of

509 -- Just elmTypeExpr | isEmptyType opts elmTypeExpr ->

523 -- Just elmTypeExpr | isEmptyType opts elmTypeExpr ->

@@ -561,9 +575,9 @@ mkUrl opts segments =

561 F.Cap arg ->

575 F.Cap arg ->

562 let

576 let

563 toStringSrc =

577 toStringSrc =

564− toString opts (maybeOf (arg ^. F.argType))

578+ toString opts (elmTypeAlterations opts (maybeOf (arg ^. F.argType)))

565 in

579 in

566− pipeRight [elmCaptureArg s, toStringSrc]

580+ "Url.percentEncode " <> pipeRight [elmCaptureArg s, toStringSrc]

567

581

568

582

569mkQueryParams

583mkQueryParams

@@ -581,7 +595,7 @@ response body.

581-}

595-}

582isEmptyType :: ElmOptions -> EType -> Bool

596isEmptyType :: ElmOptions -> EType -> Bool

583isEmptyType opts elmTypeExpr =

597isEmptyType opts elmTypeExpr =

584− elmTypeExpr `elem` emptyResponseElmTypes opts

598+ (elmTypeAlterations opts elmTypeExpr) `elem` emptyResponseElmTypes opts

585

599

586

600

587{- | Determines whether we call `toString` on URL captures and query params of

601{- | Determines whether we call `toString` on URL captures and query params of

@@ -589,7 +603,7 @@ this type in Elm.

589-}

603-}

590isElmStringType :: ElmOptions -> EType -> Bool

604isElmStringType :: ElmOptions -> EType -> Bool

591isElmStringType opts elmTypeExpr =

605isElmStringType opts elmTypeExpr =

592− elmTypeExpr `elem` stringElmTypes opts

606+ (elmTypeAlterations opts elmTypeExpr) `elem` stringElmTypes opts

593

607

594{- | Determines whether a type is 'Maybe a' where 'a' is something akin to a 'String'.

608{- | Determines whether a type is 'Maybe a' where 'a' is something akin to a 'String'.

595-}

609-}

stack.yaml+4

@@ -3,3 +3,7 @@ packages:

3- '.'

4flags: {}

5extra-package-dbs: []

6+nix:

7+ enable: true

8+ packages:

9+ - zlib

test/Common.hs+1−1

@@ -27,7 +27,7 @@ type TestApi =

27 :> Capture "id" Int

28 :> Get '[JSON] Book

29 :<|> "books"

30− :> Capture "title" Text

30+ :> Capture "title space" Text

31 :> Get '[JSON] Book

32 :<|> "books"

33 :> QueryFlag "published"

test/elm-sources/getBooksByIdSource.elm+3−2

@@ -8,7 +8,7 @@ type Book = Book

8jsonDecBook : Json.Decode.Decoder Book

9jsonDecBook = Debug.todo ""

10

11−getBooksById : Int -> (Result Http.Error (Book) -> msg) -> Cmd msg

11+getBooksById : Int -> (Result Http.Error (Book) -> msg) -> Cmd msg

12getBooksById capture_id toMsg =

13 let

14 params =

@@ -24,7 +24,8 @@ getBooksById capture_id toMsg =

24 , url =

25 Url.Builder.crossOrigin ""

26 [ "books"

27+ , Url.percentEncode (capture_id

27− , (capture_id |> String.fromInt)

28+ |> String.fromInt)

28 ]

29 ]

29 params

30 params

30 , body =

31 , body =

test/elm-sources/getBooksByTitleSource.elm+3−3

@@ -7,8 +7,8 @@ import Json.Decode as J

7type alias Book = {}

8jsonDecBook = J.succeed {}

9

10−getBooksByTitle : String -> (Result Http.Error (Book) -> msg) -> Cmd msg

10+getBooksByTitlespace : String -> (Result Http.Error (Book) -> msg) -> Cmd msg

11−getBooksByTitle capture_title toMsg =

11+getBooksByTitlespace capture_title_space toMsg =

12 let

13 params =

14 List.filterMap identity

@@ -23,7 +23,7 @@ getBooksByTitle capture_title toMsg =

23 , url =

24 Url.Builder.crossOrigin ""

25 [ "books"

26− , (capture_title)

26+ , Url.percentEncode (capture_title_space)

27 ]

28 params

29 , body =

test/elm-sources/getBooksSource.elm+1−1

@@ -9,7 +9,7 @@ type alias Book = {}

9

10jsonDecBook = J.succeed {}

11

12−getBooks : Bool -> (Maybe String) -> (Maybe Int) -> String -> (List (Maybe Bool)) -> (Result Http.Error ((List Book)) -> msg) -> Cmd msg

12+getBooks : Bool -> (Maybe String) -> (Maybe Int) -> String -> (List (Maybe Bool)) -> (Result Http.Error ((List Book)) -> msg) -> Cmd msg

13getBooks query_published query_sort query_year query_category query_filters toMsg =

14 let

15 params =

test/elm-sources/getNothingSource.elm+2−2

@@ -4,7 +4,7 @@ import Http

4import Url.Builder

5

6

7−getNothing : (Result Http.Error (()) -> msg) -> Cmd msg

7+getNothing : (Result Http.Error (()) -> msg) -> Cmd msg

8getNothing toMsg =

9 let

10 params =

@@ -25,7 +25,7 @@ getNothing toMsg =

25 , body =

26 Http.emptyBody

27 , expect =

28− Http.expectString

28+ Http.expectString

29 (\x -> case x of

30 Err e -> toMsg (Err e)

31 Ok _ -> toMsg (Ok ()))

test/elm-sources/getOneSource.elm+1−1

@@ -5,7 +5,7 @@ import Json.Decode exposing (..)

5import Url.Builder

6

7

8−getOne : (Result Http.Error (Int) -> msg) -> Cmd msg

8+getOne : (Result Http.Error (Int) -> msg) -> Cmd msg

9getOne toMsg =

10 let

11 params =

test/elm-sources/getOneWithDynamicUrlSource.elm+1−1

@@ -5,7 +5,7 @@ import Url.Builder

5import Json.Decode exposing (..)

6

7

8−getOne : String -> (Result Http.Error (Int) -> msg) -> Cmd msg

8+getOne : String -> (Result Http.Error (Int) -> msg) -> Cmd msg

9getOne urlBase toMsg =

10 let

11 params =

test/elm-sources/getPolymorphicData.elm+1−1

@@ -14,7 +14,7 @@ jsonDecSomeRecord : Json.Decode.Decoder SomeRecord

14jsonDecSomeRecord = Debug.todo "finish"

15

16

17−getPolymorphicData : (Result Http.Error ((PolymorphicData (List String) SomeRecord)) -> msg) -> Cmd msg

17+getPolymorphicData : (Result Http.Error ((PolymorphicData (List String) SomeRecord)) -> msg) -> Cmd msg

18getPolymorphicData toMsg =

19 let

20 params =

test/elm-sources/getWithaheaderSource.elm+1−1

@@ -5,7 +5,7 @@ import Url.Builder

5import Json.Decode exposing (..)

6

7

8−getWithaheader : (Maybe String) -> (Maybe Int) -> String -> Int -> (Result Http.Error (String) -> msg) -> Cmd msg

8+getWithaheader : (Maybe String) -> (Maybe Int) -> String -> Int -> (Result Http.Error (String) -> msg) -> Cmd msg

9getWithaheader header_myStringHeader header_MyIntHeader header_MyRequiredStringHeader header_MyRequiredIntHeader toMsg =

10 let

11 params =

test/elm-sources/getWitharesponseheaderSource.elm+1−1

@@ -5,7 +5,7 @@ import Url.Builder

5import Json.Decode exposing (..)

6

7

8−getWitharesponseheader : (Result Http.Error (String) -> msg) -> Cmd msg

8+getWitharesponseheader : (Result Http.Error (String) -> msg) -> Cmd msg

9getWitharesponseheader toMsg =

10 let

11 params =

test/elm-sources/postBooksSource.elm+2−2

@@ -7,7 +7,7 @@ import Json.Encode as Enc

7type alias Book = {}

8jsonEncBook = \b -> Enc.object []

9

10−postBooks : Book -> (Result Http.Error (()) -> msg) -> Cmd msg

10+postBooks : Book -> (Result Http.Error (()) -> msg) -> Cmd msg

11postBooks body toMsg =

12 let

13 params =

@@ -28,7 +28,7 @@ postBooks body toMsg =

28 , body =

29 Http.jsonBody (jsonEncBook body)

30 , expect =

31− Http.expectString

31+ Http.expectString

32 (\x -> case x of

33 Err e -> toMsg (Err e)

34 Ok _ -> toMsg (Ok ()))

test/elm-sources/postTwoSource.elm+1−1

@@ -6,7 +6,7 @@ import Json.Encode

6import Url.Builder

7

8

9−postTwo : String -> (Result Http.Error ((Maybe Int)) -> msg) -> Cmd msg

9+postTwo : String -> (Result Http.Error ((Maybe Int)) -> msg) -> Cmd msg

10postTwo body toMsg =

11 let

12 params =

test/elm-sources/putNothingSource.elm+2−2

@@ -4,7 +4,7 @@ import Http

4import Url.Builder

5

6

7−putNothing : (Result Http.Error (()) -> msg) -> Cmd msg

7+putNothing : (Result Http.Error (()) -> msg) -> Cmd msg

8putNothing toMsg =

9 let

10 params =

@@ -25,7 +25,7 @@ putNothing toMsg =

25 , body =

26 Http.emptyBody

27 , expect =

28− Http.expectString

28+ Http.expectString

29 (\x -> case x of

30 Err e -> toMsg (Err e)

31 Ok _ -> toMsg (Ok ()))