Merge pull request #65 from haskell-servant/swagger2-2.4

Allow swagger2-2.4; Update swagger-ui to 3.22.2
haskell-servant · May 30, 2019 · fb9c34b · fb9c34b
2 parents 1c7286d + cf23144
commit fb9c34b
Show file tree

Hide file tree

Showing 25 changed files with 538 additions and 523 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -4,21 +4,20 @@
 #
 # For more information, see https://github.com/haskell-CI/haskell-ci
 #
+# version: 0.3.20190521
+#
 language: c
 dist: xenial
-
 git:
-  submodules: false  # whether to recursively clone submodules
-
+  # whether to recursively clone submodules
+  submodules: false
 branches:
   only:
     - master
-
 cache:
   directories:
     - $HOME/.cabal/packages
     - $HOME/.cabal/store
-
 before_cache:
   - rm -fv $CABALHOME/packages/hackage.haskell.org/build-reports.log
   # remove files that are regenerated by 'cabal update'
@@ -27,125 +26,147 @@ before_cache:
   - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.cache
   - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar
   - rm -fv $CABALHOME/packages/hackage.haskell.org/01-index.tar.idx
-
   - rm -rfv $CABALHOME/packages/head.hackage
-
 matrix:
   include:
-    - compiler: "ghc-8.6.3"
-      addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-8.6.3], sources: [hvr-ghc]}}
-    - compiler: "ghc-8.4.4"
-      addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-8.4.4], sources: [hvr-ghc]}}
-    - compiler: "ghc-8.2.2"
-      addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-8.2.2], sources: [hvr-ghc]}}
-    - compiler: "ghc-8.0.2"
-      addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-8.0.2], sources: [hvr-ghc]}}
-    - compiler: "ghc-7.10.3"
-      addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-7.10.3], sources: [hvr-ghc]}}
-    - compiler: "ghc-7.8.4"
-      addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.4,ghc-7.8.4], sources: [hvr-ghc]}}
-
+    - compiler: ghc-8.6.5
+      addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.6.5","cabal-install-2.4"]}}
+    - compiler: ghc-8.4.4
+      addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.4.4","cabal-install-2.4"]}}
+    - compiler: ghc-8.2.2
+      addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.2.2","cabal-install-2.4"]}}
+    - compiler: ghc-8.0.2
+      addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-8.0.2","cabal-install-2.4"]}}
+    - compiler: ghc-7.10.3
+      addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-7.10.3","cabal-install-2.4"]}}
+    - compiler: ghc-7.8.4
+      addons: {"apt":{"sources":["hvr-ghc"],"packages":["ghc-7.8.4","cabal-install-2.4"]}}
 before_install:
-  - HC=/opt/ghc/bin/${CC}
-  - HCVER=$(echo "$TRAVIS_COMPILER" | sed 's/ghc-//')
-  - echo $HCVER
-  - HCPKG=${HC/ghc/ghc-pkg}
+  - HC=$(echo "/opt/$CC/bin/ghc" | sed 's/-/\//')
+  - HCPKG="$HC-pkg"
   - unset CC
   - CABAL=/opt/ghc/bin/cabal
   - CABALHOME=$HOME/.cabal
   - export PATH="$CABALHOME/bin:$PATH"
-  - ROOTDIR=$(pwd)
+  - TOP=$(pwd)
   - HCNUMVER=$(( $(${HC} --numeric-version|sed -E 's/([0-9]+)\.([0-9]+)\.([0-9]+).*/\1 * 10000 + \2 * 100 + \3/') ))
   - echo $HCNUMVER
-
+  - CABAL="$CABAL -vnormal+nowrap+markoutput"
+  - set -o pipefail
+  - |
+    echo 'function blue(s) { printf "\033[0;34m" s "\033[0m " }'           >> .colorful.awk
+    echo 'BEGIN { state = "output"; }'                                     >> .colorful.awk
+    echo '/^-----BEGIN CABAL OUTPUT-----$/ { state = "cabal" }'            >> .colorful.awk
+    echo '/^-----END CABAL OUTPUT-----$/ { state = "output" }'             >> .colorful.awk
+    echo '!/^(-----BEGIN CABAL OUTPUT-----|-----END CABAL OUTPUT-----)/ {' >> .colorful.awk
+    echo '  if (state == "cabal") {'                                       >> .colorful.awk
+    echo '    print blue($0)'                                              >> .colorful.awk
+    echo '  } else {'                                                      >> .colorful.awk
+    echo '    print $0'                                                    >> .colorful.awk
+    echo '  }'                                                             >> .colorful.awk
+    echo '}'                                                               >> .colorful.awk
+  - cat .colorful.awk
+  - |
+    color_cabal_output () {
+      awk -f $TOP/.colorful.awk
+    }
+  - echo text | color_cabal_output
 install:
   - ${CABAL} --version
   - echo "$(${HC} --version) [$(${HC} --print-project-git-commit-id 2> /dev/null || echo '?')]"
   - TEST=--enable-tests
   - BENCH=--enable-benchmarks
   - GHCHEAD=${GHCHEAD-false}
-  - if [ "$TRAVIS_OS_NAME" = "windows" ]; then export CABALHOME=$APPDATA/cabal; else export CABALHOME=$HOME/.cabal; fi
-  - travis_retry ${CABAL} update -v
-  - sed -i.bak 's/^jobs:/-- jobs:/' $CABALHOME/config
-  - rm -fv cabal.project cabal.project.local
-  - grep -Ev -- '^\s*--' $CABALHOME/config | grep -Ev '^\s*$'
-  - rm -f cabal.project
+  - rm -f $CABALHOME/config
+  - |
+    echo "verbose: normal +nowrap +markoutput"          >> $CABALHOME/config
+    echo "remote-build-reporting: anonymous"            >> $CABALHOME/config
+    echo "remote-repo-cache: $CABALHOME/packages"       >> $CABALHOME/config
+    echo "logs-dir:          $CABALHOME/logs"           >> $CABALHOME/config
+    echo "world-file:        $CABALHOME/world"          >> $CABALHOME/config
+    echo "extra-prog-path:   $CABALHOME/bin"            >> $CABALHOME/config
+    echo "symlink-bindir:    $CABALHOME/bin"            >> $CABALHOME/config
+    echo "installdir:        $CABALHOME/bin"            >> $CABALHOME/config
+    echo "build-summary:     $CABALHOME/logs/build.log" >> $CABALHOME/config
+    echo "store-dir:         $CABALHOME/store"          >> $CABALHOME/config
+    echo "install-dirs user"                            >> $CABALHOME/config
+    echo "  prefix: $CABALHOME"                         >> $CABALHOME/config
+    echo "repository hackage.haskell.org"               >> $CABALHOME/config
+    echo "  url: http://hackage.haskell.org/"           >> $CABALHOME/config
+  - cat $CABALHOME/config
+  - rm -fv cabal.project cabal.project.local cabal.project.freeze
+  - travis_retry ${CABAL} v2-update -v
+  # Generate cabal.project
+  - rm -rf cabal.project cabal.project.local cabal.project.freeze
   - touch cabal.project
-  - "printf 'packages: \"servant-swagger-ui\"\\n' >> cabal.project"
-  - "printf 'packages: \"servant-swagger-ui-core\"\\n' >> cabal.project"
-  - "printf 'packages: \"servant-swagger-ui-example\"\\n' >> cabal.project"
-  - "printf 'packages: \"servant-swagger-ui-jensoleg\"\\n' >> cabal.project"
-  - "printf 'packages: \"servant-swagger-ui-redoc\"\\n' >> cabal.project"
-  - "printf 'write-ghc-environment-files: always\\n' >> cabal.project"
-  - touch cabal.project.local
-  - "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"
+  - |
+    echo 'packages: "servant-swagger-ui"' >> cabal.project
+    echo 'packages: "servant-swagger-ui-core"' >> cabal.project
+    echo 'packages: "servant-swagger-ui-example"' >> cabal.project
+    echo 'packages: "servant-swagger-ui-jensoleg"' >> cabal.project
+    echo 'packages: "servant-swagger-ui-redoc"' >> cabal.project
+  - |
+    echo "write-ghc-environment-files: always" >> cabal.project
+  - "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"
   - cat cabal.project || true
   - cat cabal.project.local || true
   - if [ -f "servant-swagger-ui/configure.ac" ]; then (cd "servant-swagger-ui" && autoreconf -i); fi
   - if [ -f "servant-swagger-ui-core/configure.ac" ]; then (cd "servant-swagger-ui-core" && autoreconf -i); fi
   - if [ -f "servant-swagger-ui-example/configure.ac" ]; then (cd "servant-swagger-ui-example" && autoreconf -i); fi
   - if [ -f "servant-swagger-ui-jensoleg/configure.ac" ]; then (cd "servant-swagger-ui-jensoleg" && autoreconf -i); fi
   - if [ -f "servant-swagger-ui-redoc/configure.ac" ]; then (cd "servant-swagger-ui-redoc" && autoreconf -i); fi
-  - rm -f cabal.project.freeze
-  - ${CABAL} new-freeze -w ${HC} ${TEST} ${BENCH} --project-file="cabal.project" --dry
-  - "cat \"cabal.project.freeze\" | sed -E 's/^(constraints: *| *)//' | sed 's/any.//'"
-  - rm  "cabal.project.freeze"
-  - ${CABAL} new-build -w ${HC} ${TEST} ${BENCH} --project-file="cabal.project" --dep -j2 all
-  - ${CABAL} new-build -w ${HC} --disable-tests --disable-benchmarks --project-file="cabal.project" --dep -j2 all
-  - 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
-  - DISTDIR=$(mktemp -d /tmp/dist-test.XXXX)
-
-# Here starts the actual work to be performed for the package under test;
-# any command which exits with a non-zero exit code causes the build to fail.
+  - ${CABAL} v2-freeze -w ${HC} ${TEST} ${BENCH} | color_cabal_output
+  - "cat cabal.project.freeze | sed -E 's/^(constraints: *| *)//' | sed 's/any.//'"
+  - rm  cabal.project.freeze
+  - ${CABAL} v2-build -w ${HC} ${TEST} ${BENCH} --dep -j2 all | color_cabal_output
+  - ${CABAL} v2-build -w ${HC} --disable-tests --disable-benchmarks --dep -j2 all | color_cabal_output
 script:
-  # test that source-distributions can be generated
-  - ${CABAL} new-sdist all
+  - DISTDIR=$(mktemp -d /tmp/dist-test.XXXX)
+  # Packaging...
+  - ${CABAL} v2-sdist all | color_cabal_output
+  # Unpacking...
   - mv dist-newstyle/sdist/*.tar.gz ${DISTDIR}/
   - cd ${DISTDIR} || false
   - find . -maxdepth 1 -name '*.tar.gz' -exec tar -xvf '{}' \;
-  - rm -f cabal.project
+  # Generate cabal.project
+  - rm -rf cabal.project cabal.project.local cabal.project.freeze
   - touch cabal.project
-  - "printf 'packages: \"servant-swagger-ui-*/*.cabal\"\\n' >> cabal.project"
-  - "printf 'packages: \"servant-swagger-ui-core-*/*.cabal\"\\n' >> cabal.project"
-  - "printf 'packages: \"servant-swagger-ui-example-*/*.cabal\"\\n' >> cabal.project"
-  - "printf 'packages: \"servant-swagger-ui-jensoleg-*/*.cabal\"\\n' >> cabal.project"
-  - "printf 'packages: \"servant-swagger-ui-redoc-*/*.cabal\"\\n' >> cabal.project"
-  - "printf 'write-ghc-environment-files: always\\n' >> cabal.project"
-  - touch cabal.project.local
-  - "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"
+  - |
+    echo 'packages: "servant-swagger-ui-*/*.cabal"' >> cabal.project
+    echo 'packages: "servant-swagger-ui-core-*/*.cabal"' >> cabal.project
+    echo 'packages: "servant-swagger-ui-example-*/*.cabal"' >> cabal.project
+    echo 'packages: "servant-swagger-ui-jensoleg-*/*.cabal"' >> cabal.project
+    echo 'packages: "servant-swagger-ui-redoc-*/*.cabal"' >> cabal.project
+  - |
+    echo "write-ghc-environment-files: always" >> cabal.project
+  - "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"
   - cat cabal.project || true
   - cat cabal.project.local || true
+  # Building...
   # this builds all libraries and executables (without tests/benchmarks)
-  - ${CABAL} new-build -w ${HC} --disable-tests --disable-benchmarks all
-
+  - ${CABAL} v2-build -w ${HC} --disable-tests --disable-benchmarks all | color_cabal_output
+  # Building with tests and benchmarks...
   # build & run tests, build benchmarks
-  - ${CABAL} new-build -w ${HC} ${TEST} ${BENCH} all
-
-  # cabal check
-  - (cd servant-swagger-ui-* && ${CABAL} check)
-  - (cd servant-swagger-ui-core-* && ${CABAL} check)
-  - (cd servant-swagger-ui-example-* && ${CABAL} check)
-  - (cd servant-swagger-ui-jensoleg-* && ${CABAL} check)
-  - (cd servant-swagger-ui-redoc-* && ${CABAL} check)
-
-  # haddock
-  - ${CABAL} new-haddock -w ${HC} ${TEST} ${BENCH} all
-
-  # Build without installed constraints for packages in global-db
-  - rm -f cabal.project.local; ${CABAL} new-build -w ${HC} --disable-tests --disable-benchmarks all;
-
+  - ${CABAL} v2-build -w ${HC} ${TEST} ${BENCH} all | color_cabal_output
+  # cabal check...
+  - (cd servant-swagger-ui-* && ${CABAL} -vnormal check)
+  - (cd servant-swagger-ui-core-* && ${CABAL} -vnormal check)
+  - (cd servant-swagger-ui-example-* && ${CABAL} -vnormal check)
+  - (cd servant-swagger-ui-jensoleg-* && ${CABAL} -vnormal check)
+  - (cd servant-swagger-ui-redoc-* && ${CABAL} -vnormal check)
+  # haddock...
+  - ${CABAL} v2-haddock -w ${HC} ${TEST} ${BENCH} all | color_cabal_output
+  # Building without installed constraints for packages in global-db...
+  - rm -f cabal.project.local
+  - ${CABAL} v2-build -w ${HC} --disable-tests --disable-benchmarks all | color_cabal_output
   # Constraint sets
   - rm -rf cabal.project.local
-
   # Constraint set servant-0.14
-  - ${CABAL} new-build -w ${HC} --disable-tests --disable-benchmarks  --constraint='servant ==0.14.*' all
-
+  - ${CABAL} v2-build -w ${HC} --disable-tests --disable-benchmarks --constraint='servant ==0.14.*' all | color_cabal_output
   # Constraint set servant-0.15
-  - if [ $HCNUMVER -ge 80000 ] && [ $HCNUMVER -lt 80800 ] ; then ${CABAL} new-build -w ${HC} --disable-tests --disable-benchmarks  --constraint='servant ==0.15.*' all ; fi
-
+  - 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
   # Constraint set servant-0.16
-  - if [ $HCNUMVER -ge 80000 ] && [ $HCNUMVER -lt 80800 ] ; then ${CABAL} new-build -w ${HC} --disable-tests --disable-benchmarks  --constraint='servant ==0.16.*' all ; fi
-
+  - 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
 
 # REGENDATA ["--output",".travis.yml","--config=cabal.haskell-ci","cabal.project"]
 # EOF
diff --git a/servant-swagger-ui-core/Changelog.md b/servant-swagger-ui-core/Changelog.md
@@ -1,3 +1,7 @@
+# 0.3.3
+
+- Add `swaggerSchemaUIServerImpl'`
+
 # 0.3.1
 
 - Support `servant-0.14`
diff --git a/servant-swagger-ui-core/servant-swagger-ui-core.cabal b/servant-swagger-ui-core/servant-swagger-ui-core.cabal
@@ -1,36 +1,35 @@
-cabal-version:  1.12
-name:           servant-swagger-ui-core
-version:        0.3.2
-x-revision:     4
-
-synopsis:       Servant swagger ui core components
-category:       Web, Servant, Swagger
+cabal-version:      1.12
+name:               servant-swagger-ui-core
+version:            0.3.3
+synopsis:           Servant swagger ui core components
+category:           Web, Servant, Swagger
 description:
-   Provide embedded swagger UI for servant and swagger (i.e. servant-swagger)
-   .
-   See servant-swagger-ui, servant-swagger-ui-jensoleg or
-   servant-swagger-ui-redoc for "concrete" implementations.
+  Provide embedded swagger UI for servant and swagger (i.e. servant-swagger)
+  .
+  See servant-swagger-ui, servant-swagger-ui-jensoleg or
+  servant-swagger-ui-redoc for "concrete" implementations.
+
+homepage:           https://github.com/haskell-servant/servant-swagger-ui
+bug-reports:
+  https://github.com/haskell-servant/servant-swagger-ui/issues
+
+author:             Oleg Grenrus <oleg.grenrus@iki.fi>
+maintainer:         haskell-servant-maintainers@googlegroups.com
+license:            BSD3
+license-file:       LICENSE
+build-type:         Simple
+tested-with:
+  GHC ==7.8.4 || ==7.10.3 || ==8.0.2 || ==8.2.2 || ==8.4.4 || ==8.6.5
 
-homepage:       https://github.com/haskell-servant/servant-swagger-ui
-bug-reports:    https://github.com/haskell-servant/servant-swagger-ui/issues
-author:         Oleg Grenrus <oleg.grenrus@iki.fi>
-maintainer:     haskell-servant-maintainers@googlegroups.com
-license:        BSD3
-license-file:   LICENSE
-build-type:     Simple
-tested-with:    GHC ==7.8.4 || ==7.10.3 || ==8.0.2 ||  ==8.2.2 || ==8.4.4 || ==8.6.3
-extra-source-files:
-  Changelog.md
+extra-source-files: Changelog.md
 
 source-repository head
-  type: git
+  type:     git
   location: https://github.com/haskell-servant/servant-swagger-ui
 
 library
-  hs-source-dirs:
-      src
-  ghc-options: -Wall
-
+  hs-source-dirs:   src
+  ghc-options:      -Wall
   build-depends:
       base                 >=4.7      && <4.13
     , blaze-markup         >=0.7.0.2  && <0.9
@@ -39,11 +38,11 @@ library
     , servant              >=0.14     && <0.17
     , servant-blaze        >=0.8      && <0.10
     , servant-server       >=0.14     && <0.17
-    , swagger2             >=2.3.0.1  && <2.4
+    , swagger2             >=2.3.0.1  && <2.5
     , text                 >=1.2.3.0  && <1.3
     , transformers         >=0.3      && <0.6
     , transformers-compat  >=0.3      && <0.7
     , wai-app-static       >=3.0.1.1  && <3.2
-  exposed-modules:
-      Servant.Swagger.UI.Core
+
+  exposed-modules:  Servant.Swagger.UI.Core
   default-language: Haskell2010
diff --git a/servant-swagger-ui-core/src/Servant/Swagger/UI/Core.hs b/servant-swagger-ui-core/src/Servant/Swagger/UI/Core.hs
@@ -42,6 +42,7 @@ module Servant.Swagger.UI.Core (
     -- * Implementation details
     SwaggerUiHtml(..),
     swaggerSchemaUIServerImpl,
+    swaggerSchemaUIServerImpl',
     Handler,
     ) where
 
@@ -103,7 +104,15 @@ swaggerSchemaUIServerImpl
     :: (Server api ~ Handler Swagger)
     => T.Text -> [(FilePath, ByteString)]
     -> Swagger -> Server (SwaggerSchemaUI' dir api)
-swaggerSchemaUIServerImpl indexTemplate files swagger = return swagger
+swaggerSchemaUIServerImpl indexTemplate files swagger
+  = swaggerSchemaUIServerImpl' indexTemplate files $ return swagger
+
+-- | Use a custom server to serve the Swagger spec source.
+swaggerSchemaUIServerImpl'
+    :: T.Text -> [(FilePath, ByteString)]
+    -> Server api -> Server (SwaggerSchemaUI' dir api)
+swaggerSchemaUIServerImpl' indexTemplate files server
+       = server
     :<|> return (SwaggerUiHtml indexTemplate)
     :<|> return (SwaggerUiHtml indexTemplate)
     :<|> rest