master...a67cbbc · typeable/servant

git.iko.soy/typeable/servant

25 files changed+169−66

since splitsnapshots

unifiedsplit

.gitignore+5−5 scripts/bump-versions.sh+8−21 scripts/lib/common.sh+32 scripts/start-sandbox.sh+1−5 scripts/test-all.sh+2−6 scripts/update-defaults-nix.sh+1−5 scripts/upload.sh+52 servant-blaze/servant-blaze.cabal+1−1 servant-client/servant-client.cabal+1−1 servant-docs/CHANGELOG.md+4 servant-docs/servant-docs.cabal+2−1 servant-docs/src/Servant/Docs/Internal.hs+1−1 servant-docs/test/Servant/DocsSpec.hs+26−3 servant-examples/CHANGELOG.md+3 servant-examples/servant-examples.cabal+1−1 servant-examples/tutorial/T4.hs+7−7 servant-jquery/CHANGELOG.md+4 servant-jquery/servant-jquery.cabal+1−1 servant-jquery/src/Servant/JQuery.hs+3−2 servant-lucid/servant-lucid.cabal+1−1 servant-server/servant-server.cabal+2−2 servant/CHANGELOG.md+4 servant/servant.cabal+2−2 servant/src/Servant/API/ContentTypes.hs+1−1 servant/src/Servant/Utils/Links.hs+4

.gitignore+5−5

@@ -1,8 +1,8 @@

1−dist

2−bin

3−lib

4−share

5−packages

1+/dist

2+/bin

3+/lib

4+/share

5+/packages

66*-packages.conf.d

77cabal-dev

88add-source-timestamps

scripts/bump-versions.sh+8−21

@@ -16,33 +16,17 @@

1616set -o nounset

1717set -o errexit

1818

19−DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )

20−DRY_RUN=false

21−POSITION="none"

22−SOURCES_TXT="$( dirname $DIR)/sources.txt"

23−

24−declare -a SOURCES

25−readarray -t SOURCES < "$SOURCES_TXT"

19+DIR=$( dirname $( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ))

20+. "${DIR}/scripts/lib/common.sh"

2621

2722usage () {

28− echo " bump-versions <POSITION> [-d|--dry-run]"

23+ echo " bump-versions.sh <POSITION> [-d|--dry-run]"

2924 echo " | [-h|--help]"

3025 echo " Bumps the specified positional version of all servant packages."

3126 echo " POSITION is a number between 0 and 3, inclusive."

3227 exit 0

3328}

3429

35−join () { local IFS="$1"; shift; echo "$*"; }

36−

37−versions_equal () {

38− local NUM=$(find . -name 'servant*.cabal' | xargs grep "^version:" | awk '{ print $2 }' | uniq -c | wc -l)

39− if [ 1 -eq $NUM ] ; then

40− return 0

41− else

42− echo "versions of packages are not all the same!" && exit 1

43− fi

44−}

45−

4630if [ $# -eq 0 ] ; then

4731 echo "expecting one or more arguments. Got 0"

4832 usage

@@ -71,8 +55,11 @@ while [ "${1:-unset}" != "unset" ] ; do

7155done

7256

7357if $DRY_RUN ; then

74− bumper --dry-run -"$POSITION" $(join , "${SOURCES[@]}")

58+ echo "Would have bumped position ${POSITION} on these packages:"

59+ ( cd "$ROOT" && bumper --dry-run -"$POSITION" $(join , "${SOURCES[@]}") )

7560else

76− bumper -"$POSITION" $(join , "${SOURCES[@]}")

61+ ( cd "$ROOT" && bumper -"$POSITION" $(join , "${SOURCES[@]}") )

7762fi

7863

64+# Trailing newline, bumper does not ship with its own.

65+echo

scripts/lib/common.shnew file+32

@@ -0,0 +1,32 @@

1+#!/bin/bash -

2+#===============================================================================

3+#

4+# FILE: lib/common.sh

5+#

6+# DESCRIPTION: Common functions for servant's shell scripts

7+# Meant to be sourced rather than run.

8+#

9+# REQUIREMENTS: bash >= 4

10+#===============================================================================

11+

12+

13+DIR=$( dirname $( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ))

14+ROOT=$( dirname $DIR )

15+DRY_RUN=false

16+POSITION="none"

17+SOURCES_TXT="$( dirname $DIR)/sources.txt"

18+CABAL=${CABAL:-cabal}

19+

20+declare -a SOURCES

21+readarray -t SOURCES < "$SOURCES_TXT"

22+

23+join () { local IFS="$1"; shift; echo "$*"; }

24+

25+versions_equal () {

26+ local NUM=$(cd "$ROOT" && find . -name 'servant*.cabal' | xargs grep "^version:" | awk '{ print $2 }' | uniq -c | wc -l)

27+ if [ 1 -eq $NUM ] ; then

28+ return 0

29+ else

30+ echo "versions of packages are not all the same!" && exit 1

31+ fi

32+}

scripts/start-sandbox.sh+1−5

@@ -14,11 +14,7 @@ set -o nounset

1414set -o errexit

1515

1616DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )

17−SOURCES_TXT="$( dirname $DIR)/sources.txt"

18−CABAL=${CABAL:-cabal}

19−

20−declare -a SOURCES

21−readarray -t SOURCES < "$SOURCES_TXT"

17+. "$DIR"/lib/common.sh

2218

2319prepare_sandbox () {

2420 $CABAL sandbox init

scripts/test-all.sh+2−6

@@ -15,13 +15,9 @@ set -o nounset

1515set -o errexit

1616

1717DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )

18−GHC_FLAGS="-Werror"

19−SOURCES_TXT="$( dirname $DIR)/sources.txt"

20−CABAL=${CABAL:-cabal}

21−

22−declare -a SOURCES

23−readarray -t SOURCES < "$SOURCES_TXT"

18+. "$DIR"/lib/common.sh

2419

20+GHC_FLAGS="-Werror"

2521

2622prepare_sandbox () {

2723 $CABAL sandbox init

scripts/update-defaults-nix.sh+1−5

@@ -12,11 +12,7 @@ set -o nounset

1212set -o errexit

1313

1414DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )

15−BASE_DIR="$( dirname $DIR)"

16−SOURCES_TXT="$BASE_DIR/sources.txt"

17−

18−declare -a SOURCES

19−readarray -t SOURCES < "$SOURCES_TXT"

15+. "$DIR"/lib/common.sh

2016

2117for s in ${SOURCES[@]} ; do

2218 echo $s

scripts/upload.shnew file+52

@@ -0,0 +1,52 @@

1+#!/bin/bash -

2+#===============================================================================

3+#

4+# FILE: upload.sh

5+#

6+# USAGE: ./upload.sh <USER> <PASSWORD>

7+#

8+# DESCRIPTION: Uploads all servant packages to Hackage

9+#

10+# REQUIREMENTS: cabal, bash >= 4

11+# AUTHOR: Julian K. Arni

12+# CREATED: 05.06.2015 13:05

13+#===============================================================================

14+

15+set -o nounset

16+set -o errexit

17+

18+DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )

19+. "$DIR"/lib/common.sh

20+

21+usage () {

22+ echo " upload.sh <USER> <PASSWORD>"

23+ echo " Uploads all servant packages to Hackage"

24+ exit 0

25+}

26+

27+

28+upload_package () {

29+ local package="$1"

30+ local user="$2"

31+ local pass="$3"

32+ local cabalFile="$package.cabal"

33+ pushd "$package"

34+ local version=$(grep -i '^version:' $cabalFile | awk '{ print $2 }')

35+ local sdist="dist/${package}-${version}.tar.gz"

36+ cabal sdist

37+ echo "User is: $user"

38+ cabal upload --user="$user" --password="$pass" "$sdist"

39+ popd

40+}

41+

42+

43+if [ $# -ne 2 ] ; then

44+ echo "expecting two arguments."

45+ usage

46+fi

47+

48+versions_equal

49+

50+for s in ${SOURCES[@]} ; do

51+ upload_package "$s" "$1" "$2"

52+done

servant-blaze/servant-blaze.cabal+1−1

@@ -2,7 +2,7 @@

22-- documentation, see http://haskell.org/cabal/users-guide/

44name: servant-blaze

5−version: 0.4.1

5+version: 0.4.3

66synopsis: Blaze-html support for servant

77-- description:

88homepage: http://haskell-servant.github.io/

servant-client/servant-client.cabal+1−1

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

11name: servant-client

2−version: 0.4.1

2+version: 0.4.3

33synopsis: automatical derivation of querying functions for servant webservices

44description:

55 This library lets you derive automatically Haskell functions that

servant-docs/CHANGELOG.md+4

@@ -1,3 +1,7 @@

1+0.4.3

2+-----

3+* docsWith will no longer eat your documentation (https://github.com/haskell-servant/servant/pull/124)

150.4

26---

37* `Delete` now is like `Get`, `Post`, `Put`, and `Patch` and returns a response body

servant-docs/servant-docs.cabal+2−1

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

11name: servant-docs

2−version: 0.4.1

2+version: 0.4.3

33synopsis: generate API docs for your servant webservice

44description:

55 Library for generating API docs from a servant API definition.

@@ -70,6 +70,7 @@ test-suite spec

7070 base

7171 , aeson

7272 , hspec

73+ , lens

7374 , servant

7475 , servant-docs

7576 , string-conversions

servant-docs/src/Servant/Docs/Internal.hs+1−1

@@ -338,7 +338,7 @@ extraInfo p action =

338338docsWith :: HasDocs layout => [DocIntro] -> ExtraInfo layout -> Proxy layout -> API

339339docsWith intros (ExtraInfo endpoints) p =

340340 docs p & apiIntros <>~ intros

341− & apiEndpoints %~ HM.unionWith combineAction endpoints

341+ & apiEndpoints %~ HM.unionWith (flip combineAction) endpoints

342342

343343

344344-- | Generate the docs for a given API that implements 'HasDocs' with with any

servant-docs/test/Servant/DocsSpec.hs+26−3

@@ -7,7 +7,9 @@

77{-# OPTIONS_GHC -fno-warn-orphans #-}

88module Servant.DocsSpec where

10+import Control.Lens

1011import Data.Aeson

12+import Data.Monoid

1113import Data.Proxy

1214import Data.String.Conversions (cs)

1315import GHC.Generics

@@ -21,7 +23,27 @@ spec = describe "Servant.Docs" $ do

2123

2224 describe "markdown" $ do

2325 let md = markdown (docs (Proxy :: Proxy TestApi1))

24−

26+ tests md

27+

28+ describe "markdown with extra info" $ do

29+ let

30+ extra = extraInfo

31+ (Proxy :: Proxy (Get '[JSON, PlainText] Int))

32+ (defAction & notes <>~ [DocNote "Get an Integer" ["get an integer in Json or plain text"]])

33+ <>

34+ extraInfo

35+ (Proxy :: Proxy (ReqBody '[JSON] String :> Post '[JSON] Datatype1))

36+ (defAction & notes <>~ [DocNote "Post data" ["Posts some Json data"]])

37+ md = markdown (docsWith [] extra (Proxy :: Proxy TestApi1))

38+ tests md

39+ it "contains the extra info provided" $ do

40+ md `shouldContain` "Get an Integer"

41+ md `shouldContain` "Post data"

42+ md `shouldContain` "get an integer in Json or plain text"

43+ md `shouldContain` "Posts some Json data"

44+

45+ where

46+ tests md = do

2547 it "mentions supported content-types" $ do

2648 md `shouldContain` "application/json"

2749 md `shouldContain` "text/plain;charset=utf-8"

@@ -34,10 +56,11 @@ spec = describe "Servant.Docs" $ do

3456 md `shouldContain` "POST"

3557 md `shouldContain` "GET"

3658

37− it "contains response samples" $ do

59+ it "contains response samples" $

3860 md `shouldContain` "{\"dt1field1\":\"field 1\",\"dt1field2\":13}"

39− it "contains request body samples" $ do

61+ it "contains request body samples" $

4062 md `shouldContain` "17"

63+

4164-- * APIs

4265

4366data Datatype1 = Datatype1 { dt1field1 :: String

servant-examples/CHANGELOG.mdnew file+3

@@ -0,0 +1,3 @@

1+0.4.3

2+-----

3+* Clarify some variable names in the examples + semantic html pedantry

servant-examples/servant-examples.cabal+1−1

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

11name: servant-examples

2−version: 0.4.1

2+version: 0.4.3

33synopsis: Example programs for servant

44description: Example programs for servant,

55 showcasing solutions to common needs.

servant-examples/tutorial/T4.hs+7−7

@@ -25,11 +25,11 @@ instance ToJSON Person

2525

2626-- HTML serialization of a single person

2727instance ToHtml Person where

28− toHtml p =

28+ toHtml person =

2929 tr_ $ do

30− td_ (toHtml $ firstName p)

31− td_ (toHtml $ lastName p)

32− td_ (toHtml . show $ age p)

30+ td_ (toHtml $ firstName person)

31+ td_ (toHtml $ lastName person)

32+ td_ (toHtml . show $ age person)

3333

3434 toHtmlRaw = toHtml

3535

@@ -37,9 +37,9 @@ instance ToHtml Person where

3737instance ToHtml [Person] where

3838 toHtml persons = table_ $ do

3939 tr_ $ do

40− td_ "first name"

41− td_ "last name"

42− td_ "age"

40+ th_ "first name"

41+ th_ "last name"

42+ th_ "age"

4343

4444 foldMap toHtml persons

4545

servant-jquery/CHANGELOG.md+4

@@ -1,3 +1,7 @@

1+0.4.3

2+-----

3+* Content type now set to JSON when a request body is sent (#122)

150.4

26---

37* `Delete` now is like `Get`, `Post`, `Put`, and `Patch` and returns a response body

servant-jquery/servant-jquery.cabal+1−1

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

11name: servant-jquery

2−version: 0.4.1

2+version: 0.4.3

33synopsis: Automatically derive (jquery) javascript functions to query servant webservices

44description:

55 Automatically derive jquery-based javascript functions to query servant webservices.

servant-jquery/src/Servant/JQuery.hs+3−2

@@ -65,13 +65,14 @@ generateJS req = "\n" <>

6565

6666 dataBody =

6767 if req ^. reqBody

68− then "\n , data: JSON.stringify(body)\n"

68+ then " , data: JSON.stringify(body)\n" <>

69+ " , contentType: 'application/json'\n"

6970 else ""

7071

7172 reqheaders =

7273 if null hs

7374 then ""

74− else "\n , headers: { " ++ headersStr ++ " }\n"

75+ else " , headers: { " ++ headersStr ++ " }\n"

7576

7677 where headersStr = intercalate ", " $ map headerStr hs

7778 headerStr header = "\"" ++

servant-lucid/servant-lucid.cabal+1−1

@@ -2,7 +2,7 @@

22-- documentation, see http://haskell.org/cabal/users-guide/

44name: servant-lucid

5−version: 0.4.1

5+version: 0.4.3

66synopsis: Servant support for lucid

77-- description:

88homepage: http://haskell-servant.github.io/

servant-server/servant-server.cabal+2−2

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

11name: servant-server

2−version: 0.4.1

2+version: 0.4.3

33synopsis: A family of combinators for defining webservices APIs and serving them

44description:

55 A family of combinators for defining webservices APIs and serving them

@@ -51,7 +51,7 @@ library

5151 , safe >= 0.3 && < 0.4

5252 , servant == 0.4.*

5353 , split >= 0.2 && < 0.3

54− , string-conversions >= 0.3 && < 0.4

54+ , string-conversions >= 0.3 && < 0.5

5555 , system-filepath >= 0.4 && < 0.5

5656 , filepath >= 1

5757 , text >= 1.2 && < 1.3

servant/CHANGELOG.md+4

@@ -1,3 +1,7 @@

1+0.4.3

2+-----

3+* Add missing HasLink instance for Header (https://github.com/haskell-servant/servant/issues/128)

150.4.1

26-----

37* Allow whitespace after parsing JSON

servant/servant.cabal+2−2

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

11name: servant

2−version: 0.4.1

2+version: 0.4.3

33synopsis: A family of combinators for defining webservices APIs

44description:

55 A family of combinators for defining webservices APIs and serving them

@@ -55,7 +55,7 @@ library

5555 , http-media >= 0.4 && < 0.7

5656 , http-types == 0.8.*

5757 , text >= 1 && < 2

58− , string-conversions >= 0.3 && < 0.4

58+ , string-conversions >= 0.3 && < 0.5

5959 , network-uri >= 2.6

6060 hs-source-dirs: src

6161 default-language: Haskell2010

servant/src/Servant/API/ContentTypes.hs+1−1

@@ -166,7 +166,7 @@ instance ( AllMimeRender ctyps a, IsNonEmpty ctyps

166166 handleAcceptH _ (AcceptHeader accept) val = M.mapAcceptMedia lkup accept

167167 where pctyps = Proxy :: Proxy ctyps

168168 amrs = allMimeRender pctyps val

169− lkup = fmap (\(a,b) -> (a, (cs $ show a, b))) amrs

169+ lkup = fmap (\(a,b) -> (a, (fromStrict $ M.renderHeader a, b))) amrs

170170

171171

172172--------------------------------------------------------------------------

servant/src/Servant/Utils/Links.hs+4

@@ -339,6 +339,10 @@ instance (ToText v, HasLink sub)

339339 toLink (Proxy :: Proxy sub) $

340340 addSegment (escape . unpack $ toText v) l

341341

342+instance HasLink sub => HasLink (Header sym a :> sub) where

343+ type MkLink (Header sym a :> sub) = MkLink sub

344+ toLink _ = toLink (Proxy :: Proxy sub)

345+

342346-- Verb (terminal) instances

343347instance HasLink (Get y r) where

344348 type MkLink (Get y r) = URI