Skip to content

Commit fb9c34b

Browse files
phadejphadej
authored
Merge pull request #65 from haskell-servant/swagger2-2.4
Allow swagger2-2.4; Update swagger-ui to 3.22.2
2 parents 1c7286d + cf23144 commit fb9c34b

File tree

25 files changed

+538
-523
lines changed

25 files changed

+538
-523
lines changed

‎.travis.yml

Lines changed: 107 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,20 @@
44
#
55
# For more information, see https://github.com/haskell-CI/haskell-ci
66
#
7+
# version: 0.3.20190521
8+
#
79
language: c
810
dist: xenial
9-
1011
git:
11-
submodules: false # whether to recursively clone submodules
12-
12+
# whether to recursively clone submodules
13+
submodules: false
1314
branches:
1415
only:
1516
- master
16-
1717
cache:
1818
directories:
1919
- $HOME/.cabal/packages
2020
- $HOME/.cabal/store
21-
2221
before_cache:
2322
- rm -fv $CABALHOME/packages/hackage.haskell.org/build-reports.log
2423
# remove files that are regenerated by 'cabal update'
@@ -27,125 +26,147 @@ before_cache:
2726
- rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.cache
2827
- rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar
2928
- rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar.idx
30-
3129
- rm -rfv $CABALHOME/packages/head.hackage
32-
3330
matrix:
3431
include:
35-
- compiler: "ghc-8.6.3"
36-
addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-8.6.3], sources: [hvr-ghc]}}
37-
- compiler: "ghc-8.4.4"
38-
addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-8.4.4], sources: [hvr-ghc]}}
39-
- compiler: "ghc-8.2.2"
40-
addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-8.2.2], sources: [hvr-ghc]}}
41-
- compiler: "ghc-8.0.2"
42-
addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-8.0.2], sources: [hvr-ghc]}}
43-
- compiler: "ghc-7.10.3"
44-
addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-7.10.3], sources: [hvr-ghc]}}
45-
- compiler: "ghc-7.8.4"
46-
addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-7.8.4], sources: [hvr-ghc]}}
47-
32+
- compiler: ghc-8.6.5
33+
addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.6.5","cabal-install-2.4"]}}
34+
- compiler: ghc-8.4.4
35+
addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.4.4","cabal-install-2.4"]}}
36+
- compiler: ghc-8.2.2
37+
addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.2.2","cabal-install-2.4"]}}
38+
- compiler: ghc-8.0.2
39+
addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.0.2","cabal-install-2.4"]}}
40+
- compiler: ghc-7.10.3
41+
addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-7.10.3","cabal-install-2.4"]}}
42+
- compiler: ghc-7.8.4
43+
addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-7.8.4","cabal-install-2.4"]}}
4844
before_install:
49-
- HC=/opt/ghc/bin/${CC}
50-
- HCVER=$(echo "$TRAVIS_COMPILER" | sed 's/ghc-//')
51-
- echo $HCVER
52-
- HCPKG=${HC/ghc/ghc-pkg}
45+
- HC=$(echo "/opt/$CC/bin/ghc" | sed 's/-/\//')
46+
- HCPKG="$HC-pkg"
5347
- unset CC
5448
- CABAL=/opt/ghc/bin/cabal
5549
- CABALHOME=$HOME/.cabal
5650
- export PATH="$CABALHOME/bin:$PATH"
57-
- ROOTDIR=$(pwd)
51+
- TOP=$(pwd)
5852
- HCNUMVER=$(( $(${HC} --numeric-version|sed -E 's/([0-9]+)\.([0-9]+)\.([0-9]+).*/\1 * 10000 + \2 * 100 + \3/') ))
5953
- echo $HCNUMVER
60-
54+
- CABAL="$CABAL -vnormal+nowrap+markoutput"
55+
- set -o pipefail
56+
- |
57+
echo 'function blue(s) { printf "\033[0;34m" s "\033[0m " }' >> .colorful.awk
58+
echo 'BEGIN { state = "output"; }' >> .colorful.awk
59+
echo '/^-----BEGIN CABAL OUTPUT-----$/ { state = "cabal" }' >> .colorful.awk
60+
echo '/^-----END CABAL OUTPUT-----$/ { state = "output" }' >> .colorful.awk
61+
echo '!/^(-----BEGIN CABAL OUTPUT-----|-----END CABAL OUTPUT-----)/ {' >> .colorful.awk
62+
echo ' if (state == "cabal") {' >> .colorful.awk
63+
echo ' print blue($0)' >> .colorful.awk
64+
echo ' } else {' >> .colorful.awk
65+
echo ' print $0' >> .colorful.awk
66+
echo ' }' >> .colorful.awk
67+
echo '}' >> .colorful.awk
68+
- cat .colorful.awk
69+
- |
70+
color_cabal_output () {
71+
awk -f $TOP/.colorful.awk
72+
}
73+
- echo text | color_cabal_output
6174
install:
6275
- ${CABAL} --version
6376
- echo "$(${HC} --version) [$(${HC} --print-project-git-commit-id 2> /dev/null || echo '?')]"
6477
- TEST=--enable-tests
6578
- BENCH=--enable-benchmarks
6679
- GHCHEAD=${GHCHEAD-false}
67-
- if [ "$TRAVIS_OS_NAME" = "windows" ]; then export CABALHOME=$APPDATA/cabal; else export CABALHOME=$HOME/.cabal; fi
68-
- travis_retry ${CABAL} update -v
69-
- sed -i.bak 's/^jobs:/-- jobs:/' $CABALHOME/config
70-
- rm -fv cabal.project cabal.project.local
71-
- grep -Ev -- '^\s*--' $CABALHOME/config | grep -Ev '^\s*$'
72-
- rm -f cabal.project
80+
- rm -f $CABALHOME/config
81+
- |
82+
echo "verbose: normal +nowrap +markoutput" >> $CABALHOME/config
83+
echo "remote-build-reporting: anonymous" >> $CABALHOME/config
84+
echo "remote-repo-cache: $CABALHOME/packages" >> $CABALHOME/config
85+
echo "logs-dir: $CABALHOME/logs" >> $CABALHOME/config
86+
echo "world-file: $CABALHOME/world" >> $CABALHOME/config
87+
echo "extra-prog-path: $CABALHOME/bin" >> $CABALHOME/config
88+
echo "symlink-bindir: $CABALHOME/bin" >> $CABALHOME/config
89+
echo "installdir: $CABALHOME/bin" >> $CABALHOME/config
90+
echo "build-summary: $CABALHOME/logs/build.log" >> $CABALHOME/config
91+
echo "store-dir: $CABALHOME/store" >> $CABALHOME/config
92+
echo "install-dirs user" >> $CABALHOME/config
93+
echo " prefix: $CABALHOME" >> $CABALHOME/config
94+
echo "repository hackage.haskell.org" >> $CABALHOME/config
95+
echo " url: http://hackage.haskell.org/" >> $CABALHOME/config
96+
- cat $CABALHOME/config
97+
- rm -fv cabal.project cabal.project.local cabal.project.freeze
98+
- travis_retry ${CABAL} v2-update -v
99+
# Generate cabal.project
100+
- rm -rf cabal.project cabal.project.local cabal.project.freeze
73101
- touch cabal.project
74-
- "printf 'packages: \"servant-swagger-ui\"\\n' >> cabal.project"
75-
- "printf 'packages: \"servant-swagger-ui-core\"\\n' >> cabal.project"
76-
- "printf 'packages: \"servant-swagger-ui-example\"\\n' >> cabal.project"
77-
- "printf 'packages: \"servant-swagger-ui-jensoleg\"\\n' >> cabal.project"
78-
- "printf 'packages: \"servant-swagger-ui-redoc\"\\n' >> cabal.project"
79-
- "printf 'write-ghc-environment-files: always\\n' >> cabal.project"
80-
- touch cabal.project.local
81-
- "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | grep -vE -- '^(servant-swagger-ui|servant-swagger-ui-core|servant-swagger-ui-example|servant-swagger-ui-jensoleg|servant-swagger-ui-redoc)$' | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
102+
- |
103+
echo 'packages: "servant-swagger-ui"' >> cabal.project
104+
echo 'packages: "servant-swagger-ui-core"' >> cabal.project
105+
echo 'packages: "servant-swagger-ui-example"' >> cabal.project
106+
echo 'packages: "servant-swagger-ui-jensoleg"' >> cabal.project
107+
echo 'packages: "servant-swagger-ui-redoc"' >> cabal.project
108+
- |
109+
echo "write-ghc-environment-files: always" >> cabal.project
110+
- "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(servant-swagger-ui|servant-swagger-ui-core|servant-swagger-ui-example|servant-swagger-ui-jensoleg|servant-swagger-ui-redoc)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
82111
- cat cabal.project || true
83112
- cat cabal.project.local || true
84113
- if [ -f "servant-swagger-ui/configure.ac" ]; then (cd "servant-swagger-ui" && autoreconf -i); fi
85114
- if [ -f "servant-swagger-ui-core/configure.ac" ]; then (cd "servant-swagger-ui-core" && autoreconf -i); fi
86115
- if [ -f "servant-swagger-ui-example/configure.ac" ]; then (cd "servant-swagger-ui-example" && autoreconf -i); fi
87116
- if [ -f "servant-swagger-ui-jensoleg/configure.ac" ]; then (cd "servant-swagger-ui-jensoleg" && autoreconf -i); fi
88117
- if [ -f "servant-swagger-ui-redoc/configure.ac" ]; then (cd "servant-swagger-ui-redoc" && autoreconf -i); fi
89-
- rm -f cabal.project.freeze
90-
- ${CABAL} new-freeze -w ${HC} ${TEST} ${BENCH} --project-file="cabal.project" --dry
91-
- "cat \"cabal.project.freeze\" | sed -E 's/^(constraints: *| *)//' | sed 's/any.//'"
92-
- rm "cabal.project.freeze"
93-
- ${CABAL} new-build -w ${HC} ${TEST} ${BENCH} --project-file="cabal.project" --dep -j2 all
94-
- ${CABAL} new-build -w ${HC} --disable-tests --disable-benchmarks --project-file="cabal.project" --dep -j2 all
95-
- rm -rf .ghc.environment.* "servant-swagger-ui"/dist "servant-swagger-ui-core"/dist "servant-swagger-ui-example"/dist "servant-swagger-ui-jensoleg"/dist "servant-swagger-ui-redoc"/dist
96-
- DISTDIR=$(mktemp -d /tmp/dist-test.XXXX)
97-
98-
# Here starts the actual work to be performed for the package under test;
99-
# any command which exits with a non-zero exit code causes the build to fail.
118+
- ${CABAL} v2-freeze -w ${HC} ${TEST} ${BENCH} | color_cabal_output
119+
- "cat cabal.project.freeze | sed -E 's/^(constraints: *| *)//' | sed 's/any.//'"
120+
- rm cabal.project.freeze
121+
- ${CABAL} v2-build -w ${HC} ${TEST} ${BENCH} --dep -j2 all | color_cabal_output
122+
- ${CABAL} v2-build -w ${HC} --disable-tests --disable-benchmarks --dep -j2 all | color_cabal_output
100123
script:
101-
# test that source-distributions can be generated
102-
- ${CABAL} new-sdist all
124+
- DISTDIR=$(mktemp -d /tmp/dist-test.XXXX)
125+
# Packaging...
126+
- ${CABAL} v2-sdist all | color_cabal_output
127+
# Unpacking...
103128
- mv dist-newstyle/sdist/*.tar.gz ${DISTDIR}/
104129
- cd ${DISTDIR} || false
105130
- find . -maxdepth 1 -name '*.tar.gz' -exec tar -xvf '{}' \;
106-
- rm -f cabal.project
131+
# Generate cabal.project
132+
- rm -rf cabal.project cabal.project.local cabal.project.freeze
107133
- touch cabal.project
108-
- "printf 'packages: \"servant-swagger-ui-*/*.cabal\"\\n' >> cabal.project"
109-
- "printf 'packages: \"servant-swagger-ui-core-*/*.cabal\"\\n' >> cabal.project"
110-
- "printf 'packages: \"servant-swagger-ui-example-*/*.cabal\"\\n' >> cabal.project"
111-
- "printf 'packages: \"servant-swagger-ui-jensoleg-*/*.cabal\"\\n' >> cabal.project"
112-
- "printf 'packages: \"servant-swagger-ui-redoc-*/*.cabal\"\\n' >> cabal.project"
113-
- "printf 'write-ghc-environment-files: always\\n' >> cabal.project"
114-
- touch cabal.project.local
115-
- "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | grep -vE -- '^(servant-swagger-ui|servant-swagger-ui-core|servant-swagger-ui-example|servant-swagger-ui-jensoleg|servant-swagger-ui-redoc)$' | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
134+
- |
135+
echo 'packages: "servant-swagger-ui-*/*.cabal"' >> cabal.project
136+
echo 'packages: "servant-swagger-ui-core-*/*.cabal"' >> cabal.project
137+
echo 'packages: "servant-swagger-ui-example-*/*.cabal"' >> cabal.project
138+
echo 'packages: "servant-swagger-ui-jensoleg-*/*.cabal"' >> cabal.project
139+
echo 'packages: "servant-swagger-ui-redoc-*/*.cabal"' >> cabal.project
140+
- |
141+
echo "write-ghc-environment-files: always" >> cabal.project
142+
- "for pkg in $($HCPKG list --simple-output); do echo $pkg | sed 's/-[^-]*$//' | (grep -vE -- '^(servant-swagger-ui|servant-swagger-ui-core|servant-swagger-ui-example|servant-swagger-ui-jensoleg|servant-swagger-ui-redoc)$' || true) | sed 's/^/constraints: /' | sed 's/$/ installed/' >> cabal.project.local; done"
116143
- cat cabal.project || true
117144
- cat cabal.project.local || true
145+
# Building...
118146
# this builds all libraries and executables (without tests/benchmarks)
119-
- ${CABAL} new-build -w ${HC} --disable-tests --disable-benchmarks all
120-
147+
- ${CABAL} v2-build -w ${HC} --disable-tests --disable-benchmarks all | color_cabal_output
148+
# Building with tests and benchmarks...
121149
# build & run tests, build benchmarks
122-
- ${CABAL} new-build -w ${HC} ${TEST} ${BENCH} all
123-
124-
# cabal check
125-
- (cd servant-swagger-ui-* && ${CABAL} check)
126-
- (cd servant-swagger-ui-core-* && ${CABAL} check)
127-
- (cd servant-swagger-ui-example-* && ${CABAL} check)
128-
- (cd servant-swagger-ui-jensoleg-* && ${CABAL} check)
129-
- (cd servant-swagger-ui-redoc-* && ${CABAL} check)
130-
131-
# haddock
132-
- ${CABAL} new-haddock -w ${HC} ${TEST} ${BENCH} all
133-
134-
# Build without installed constraints for packages in global-db
135-
- rm -f cabal.project.local; ${CABAL} new-build -w ${HC} --disable-tests --disable-benchmarks all;
136-
150+
- ${CABAL} v2-build -w ${HC} ${TEST} ${BENCH} all | color_cabal_output
151+
# cabal check...
152+
- (cd servant-swagger-ui-* && ${CABAL} -vnormal check)
153+
- (cd servant-swagger-ui-core-* && ${CABAL} -vnormal check)
154+
- (cd servant-swagger-ui-example-* && ${CABAL} -vnormal check)
155+
- (cd servant-swagger-ui-jensoleg-* && ${CABAL} -vnormal check)
156+
- (cd servant-swagger-ui-redoc-* && ${CABAL} -vnormal check)
157+
# haddock...
158+
- ${CABAL} v2-haddock -w ${HC} ${TEST} ${BENCH} all | color_cabal_output
159+
# Building without installed constraints for packages in global-db...
160+
- rm -f cabal.project.local
161+
- ${CABAL} v2-build -w ${HC} --disable-tests --disable-benchmarks all | color_cabal_output
137162
# Constraint sets
138163
- rm -rf cabal.project.local
139-
140164
# Constraint set servant-0.14
141-
- ${CABAL} new-build -w ${HC} --disable-tests --disable-benchmarks --constraint='servant ==0.14.*' all
142-
165+
- ${CABAL} v2-build -w ${HC} --disable-tests --disable-benchmarks --constraint='servant ==0.14.*' all | color_cabal_output
143166
# Constraint set servant-0.15
144-
- if [ $HCNUMVER -ge 80000 ] && [ $HCNUMVER -lt 80800 ] ; then ${CABAL} new-build -w ${HC} --disable-tests --disable-benchmarks --constraint='servant ==0.15.*' all ; fi
145-
167+
- if [ $HCNUMVER -ge 80000 ] && [ $HCNUMVER -lt 80800 ] ; then ${CABAL} v2-build -w ${HC} --disable-tests --disable-benchmarks --constraint='servant ==0.15.*' all | color_cabal_output ; fi
146168
# Constraint set servant-0.16
147-
- if [ $HCNUMVER -ge 80000 ] && [ $HCNUMVER -lt 80800 ] ; then ${CABAL} new-build -w ${HC} --disable-tests --disable-benchmarks --constraint='servant ==0.16.*' all ; fi
148-
169+
- if [ $HCNUMVER -ge 80000 ] && [ $HCNUMVER -lt 80800 ] ; then ${CABAL} v2-build -w ${HC} --disable-tests --disable-benchmarks --constraint='servant ==0.16.*' all | color_cabal_output ; fi
149170

150171
# REGENDATA ["--output",".travis.yml","--config=cabal.haskell-ci","cabal.project"]
151172
# EOF

‎servant-swagger-ui-core/Changelog.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# 0.3.3
2+
3+
- Add `swaggerSchemaUIServerImpl'`
4+
15
# 0.3.1
26

37
- Support `servant-0.14`

‎servant-swagger-ui-core/servant-swagger-ui-core.cabal

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,35 @@
1-
cabal-version: 1.12
2-
name: servant-swagger-ui-core
3-
version: 0.3.2
4-
x-revision: 4
5-
6-
synopsis: Servant swagger ui core components
7-
category: Web, Servant, Swagger
1+
cabal-version: 1.12
2+
name: servant-swagger-ui-core
3+
version: 0.3.3
4+
synopsis: Servant swagger ui core components
5+
category: Web, Servant, Swagger
86
description:
9-
Provide embedded swagger UI for servant and swagger (i.e. servant-swagger)
10-
.
11-
See servant-swagger-ui, servant-swagger-ui-jensoleg or
12-
servant-swagger-ui-redoc for "concrete" implementations.
7+
Provide embedded swagger UI for servant and swagger (i.e. servant-swagger)
8+
.
9+
See servant-swagger-ui, servant-swagger-ui-jensoleg or
10+
servant-swagger-ui-redoc for "concrete" implementations.
11+
12+
homepage: https://github.com/haskell-servant/servant-swagger-ui
13+
bug-reports:
14+
https://github.com/haskell-servant/servant-swagger-ui/issues
15+
16+
author: Oleg Grenrus <[email protected]>
17+
maintainer: [email protected]
18+
license: BSD3
19+
license-file: LICENSE
20+
build-type: Simple
21+
tested-with:
22+
GHC ==7.8.4 || ==7.10.3 || ==8.0.2 || ==8.2.2 || ==8.4.4 || ==8.6.5
1323

14-
homepage: https://github.com/haskell-servant/servant-swagger-ui
15-
bug-reports: https://github.com/haskell-servant/servant-swagger-ui/issues
16-
author: Oleg Grenrus <[email protected]>
17-
maintainer: [email protected]
18-
license: BSD3
19-
license-file: LICENSE
20-
build-type: Simple
21-
tested-with: GHC ==7.8.4 || ==7.10.3 || ==8.0.2 || ==8.2.2 || ==8.4.4 || ==8.6.3
22-
extra-source-files:
23-
Changelog.md
24+
extra-source-files: Changelog.md
2425

2526
source-repository head
26-
type: git
27+
type: git
2728
location: https://github.com/haskell-servant/servant-swagger-ui
2829

2930
library
30-
hs-source-dirs:
31-
src
32-
ghc-options: -Wall
33-
31+
hs-source-dirs: src
32+
ghc-options: -Wall
3433
build-depends:
3534
base >=4.7 && <4.13
3635
, blaze-markup >=0.7.0.2 && <0.9
@@ -39,11 +38,11 @@ library
3938
, servant >=0.14 && <0.17
4039
, servant-blaze >=0.8 && <0.10
4140
, servant-server >=0.14 && <0.17
42-
, swagger2 >=2.3.0.1 && <2.4
41+
, swagger2 >=2.3.0.1 && <2.5
4342
, text >=1.2.3.0 && <1.3
4443
, transformers >=0.3 && <0.6
4544
, transformers-compat >=0.3 && <0.7
4645
, wai-app-static >=3.0.1.1 && <3.2
47-
exposed-modules:
48-
Servant.Swagger.UI.Core
46+
47+
exposed-modules: Servant.Swagger.UI.Core
4948
default-language: Haskell2010

‎servant-swagger-ui-core/src/Servant/Swagger/UI/Core.hs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ module Servant.Swagger.UI.Core (
4242
-- * Implementation details
4343
SwaggerUiHtml(..),
4444
swaggerSchemaUIServerImpl,
45+
swaggerSchemaUIServerImpl',
4546
Handler,
4647
) where
4748

@@ -103,7 +104,15 @@ swaggerSchemaUIServerImpl
103104
:: (Server api ~ Handler Swagger)
104105
=> T.Text -> [(FilePath, ByteString)]
105106
-> Swagger -> Server (SwaggerSchemaUI' dir api)
106-
swaggerSchemaUIServerImpl indexTemplate files swagger = return swagger
107+
swaggerSchemaUIServerImpl indexTemplate files swagger
108+
= swaggerSchemaUIServerImpl' indexTemplate files $ return swagger
109+
110+
-- | Use a custom server to serve the Swagger spec source.
111+
swaggerSchemaUIServerImpl'
112+
:: T.Text -> [(FilePath, ByteString)]
113+
-> Server api -> Server (SwaggerSchemaUI' dir api)
114+
swaggerSchemaUIServerImpl' indexTemplate files server
115+
= server
107116
:<|> return (SwaggerUiHtml indexTemplate)
108117
:<|> return (SwaggerUiHtml indexTemplate)
109118
:<|> rest

0 commit comments

Comments
 (0)