Rework cabal and travis files

phadej · phadej · commit 4a463049269f · 2016-01-04T00:14:22.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,4 @@ cabal.sandbox.config
 *~
 *.hi
 *.o
+.stack-work
diff --git a/.travis.yml b/.travis.yml
@@ -6,6 +6,7 @@ cache:
   directories:
     - $HOME/.cabsnap
     - $HOME/.cabal/packages
+    - $HOME/.stack
 
 before_cache:
   - rm -fv $HOME/.cabal/packages/hackage.haskell.org/build-reports.log
@@ -17,77 +18,41 @@ env:
 
 matrix:
   include:
-    - env: CABALVER=1.18 GHCVER=7.8.4
+    - env: BUILD=cabal CABALVER=1.18 GHCVER=7.8.4
       compiler: ": #GHC 7.8.4"
       addons: {apt: {packages: [cabal-install-1.18,ghc-7.8.4], sources: [hvr-ghc]}}
-    - env: CABALVER=1.18 GHCVER=7.8.4 STACKAGESNAPSHOT=lts-2.22
+    - env: BUILD=cabal CABALVER=1.18 GHCVER=7.8.4 STACKAGESNAPSHOT=lts-2.22
       compiler: ": #GHC 7.8.4 lts-2.22"
       addons: {apt: {packages: [cabal-install-1.18,ghc-7.8.4], sources: [hvr-ghc]}}
-    - env: CABALVER=1.22 GHCVER=7.10.2
+    - env: BUILD=cabal CABALVER=1.22 GHCVER=7.10.2
       compiler: ": #GHC 7.10.2"
       addons: {apt: {packages: [cabal-install-1.22,ghc-7.10.2], sources: [hvr-ghc]}}
-    - env: CABALVER=1.22 GHCVER=7.10.2 STACKAGESNAPSHOT=lts-3
+    - env: BUILD=cabal CABALVER=1.22 GHCVER=7.10.2 STACKAGESNAPSHOT=lts-3
       compiler: ": #GHC 7.10.2 lts-3"
       addons: {apt: {packages: [cabal-install-1.22,ghc-7.10.2], sources: [hvr-ghc]}}
+    - env: BUILD=stack STACK_YAML=stack-lts-2.yaml
+      compiler: ": #STACK LTS2"
+      addons: {apt: {packages: [ghc-7.8.4], sources: [hvr-ghc]}}
+    - env: BUILD=stack STACK_YAML=stack-lts-3.yaml
+      compiler: ": #STACK LTS3"
+      addons: {apt: {packages: [ghc-7.10.2], sources: [hvr-ghc]}}
+    - env: BUILD=stack STACK_YAML=stack-nightly.yaml
+      compiler: ": #STACK nightly"
+      addons: {apt: {packages: [ghc-7.10.3], sources: [hvr-ghc]}}
+    - env: BUILD=stack STACK_YAML=stack-lts-3.yaml
+      compiler: ": #stack LTS3 OSX"
+      os: osx
 
 before_install:
- - unset CC
- - export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$PATH
+  - unset CC
+  - export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$HOME/.local/bin:$PATH
 
 install:
- - if [ -n "$STACKAGESNAPSHOT" ]; then wget https://www.stackage.org/$STACKAGESNAPSHOT/cabal.config; fi
- - cabal --version
- - echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo '?')]"
- - if [ -f $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz ];
-   then
-     zcat $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz >
-          $HOME/.cabal/packages/hackage.haskell.org/00-index.tar;
-   fi
- - travis_retry cabal update -v
- - sed -i 's/^jobs:/-- jobs:/' ${HOME}/.cabal/config
- - cabal install --only-dependencies --enable-tests --enable-benchmarks --dry -v > installplan.txt
- - sed -i -e '1,/^Resolving /d' installplan.txt; cat installplan.txt
-
-# check whether current requested install-plan matches cached package-db snapshot
- - if diff -u installplan.txt $HOME/.cabsnap/installplan.txt;
-   then
-     echo "cabal build-cache HIT";
-     rm -rfv .ghc;
-     cp -a $HOME/.cabsnap/ghc $HOME/.ghc;
-     cp -a $HOME/.cabsnap/lib $HOME/.cabsnap/share $HOME/.cabsnap/bin $HOME/.cabal/;
-   else
-     echo "cabal build-cache MISS";
-     rm -rf $HOME/.cabsnap;
-     mkdir -p $HOME/.ghc $HOME/.cabal/lib $HOME/.cabal/share $HOME/.cabal/bin;
-     cabal install --only-dependencies --enable-tests --enable-benchmarks;
-   fi
-
-# snapshot package-db on cache miss
- - if [ ! -d $HOME/.cabsnap ];
-   then
-      echo "snapshotting package-db to build-cache";
-      mkdir $HOME/.cabsnap;
-      cp -a $HOME/.ghc $HOME/.cabsnap/ghc;
-      cp -a $HOME/.cabal/lib $HOME/.cabal/share $HOME/.cabal/bin installplan.txt $HOME/.cabsnap/;
-   fi
+  - sh travis-install.sh
 
 # 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.
 script:
- - if [ -f configure.ac ]; then autoreconf -i; fi
- - cabal configure --enable-tests --enable-benchmarks -v2  # -v2 provides useful information for debugging
- - cabal build   # this builds all libraries and executables (including tests/benchmarks)
- - cabal test --show-details=always
-
- - if [ "$CABALVER" = "1.22" ]; then cabal check; fi
- - if [ "$CABALVER" = "1.22" ]; then cabal haddock; fi
-
- - cabal sdist   # tests that a source-distribution can be generated
-
-# Check that the resulting source distribution can be built & installed.
-# If there are no other `.tar.gz` files in `dist`, this can be even simpler:
-# `cabal install --force-reinstalls dist/*-*.tar.gz`
- - SRC_TGZ=$(cabal info . | awk '{print $2;exit}').tar.gz &&
-   (cd dist && cabal install --force-reinstalls "$SRC_TGZ")
+  - sh travis-script.sh
 
 # EOF
diff --git a/github.cabal b/github.cabal
@@ -1,51 +1,22 @@
--- github.cabal auto-generated by cabal init. For additional options,
--- see
--- http://www.haskell.org/cabal/release/cabal-latest/doc/users-guide/authors.html#pkg-descr.
--- The name of the package.
 Name:                github
-
--- The package version. See the Haskell package versioning policy
--- (http://www.haskell.org/haskellwiki/Package_versioning_policy) for
--- standards guiding when and how versions should be incremented.
 Version:             0.14.0
-
--- A short (one-line) description of the package.
 Synopsis:            Access to the Github API, v3.
-
--- A longer description of the package.
 Description:         The Github API provides programmatic access to the full
                      Github Web site, from Issues to Gists to repos down to the underlying git data
                      like references and trees. This library wraps all of that, exposing a basic but
                      Haskell-friendly set of functions and data structures.
                      .
                      For more of an overview please see the README: <https://github.com/jwiegley/github/blob/master/README.md>
-
--- The license under which the package is released.
 License:             BSD3
-
--- The file containing the license text.
 License-file:        LICENSE
-
--- The package author(s).
-Author:              Mike Burns, John Wiegley
-
--- An email address to which users can send suggestions, bug reports,
--- and patches.
-Maintainer:          johnw@newartisans.com
-
-Homepage:            https://github.com/jwiegley/github
-
--- A copyright notice.
-Copyright:           Copyright 2012-2013 Mike Burns, Copyright 2013-2015 John Wiegley
-
-Category:            Network APIs
-
+Author:              Mike Burns, John Wiegley, Oleg Grenrus
+Maintainer:          Oleg Grenrus <oleg.grenrus@iki.fi>
+Homepage:            https://github.com/phadej/github
+Copyright:           Copyright 2012-2013 Mike Burns, Copyright 2013-2015 John Wiegley, Copyright 2016 Oleg Grenrus
+Category:            Network
 Build-type:          Simple
-
 Tested-with:         GHC==7.8.4, GHC==7.10.2
-
--- Extra files to be distributed with the package, such as examples or
--- a README.
+Cabal-version:       >=1.10
 Extra-source-files:  README.md
                     ,samples/Gists/Comments/ShowComment.hs
                     ,samples/Gists/Comments/ShowComments.hs
@@ -124,9 +95,10 @@ Extra-source-files:  README.md
                     ,samples/Users/ShowUser.hs
                     ,LICENSE
 
-
--- Constraint on the version of Cabal needed to build this package.
-Cabal-version:       >=1.10
+flag aeson-compat
+  description: Whether to use aeson-compat or aeson-extra
+  default: True
+  manual: False
 
 source-repository head
   type: git
@@ -135,6 +107,7 @@ source-repository head
 Library
   -- Modules exported by the library.
   Default-Language: Haskell2010
+  GHC-Options: -Wall
   Exposed-modules: Github.All,
                    Github.Auth,
                    Github.Data,
@@ -186,7 +159,6 @@ Library
   Build-depends: base >= 4.0 && < 5.0,
                  time >=1.4 && <1.6,
                  aeson >= 0.6.1.0,
-                 aeson-extra >= 0.2.0.0 && <0.3,
                  attoparsec >= 0.10.3.0,
                  bytestring,
                  case-insensitive >= 0.4.0.4,
@@ -205,11 +177,10 @@ Library
                  byteable >= 0.1.0,
                  base16-bytestring >= 0.1.1.6
 
-  -- Extra tools (e.g. alex, hsc2hs, ...) needed to build the source.
-  -- Build-tools:
-
-  GHC-Options: -Wall -fno-warn-orphans
-
+  if flag(aeson-compat)
+    Build-depends: aeson-compat >= 0.3.0.0 && <0.4
+  else
+    Build-depends: aeson-extra >= 0.2.0.0 && <0.3
 
 test-suite github-test
   default-language: Haskell2010
@@ -220,11 +191,14 @@ test-suite github-test
     Github.UsersSpec
     Github.OrganizationsSpec
   main-is: Spec.hs
+  ghc-options: -Wall
   build-depends: base >= 4.0 && < 5.0,
                  base-compat,
-                 aeson-extra >= 0.2.0.0 && <0.3,
                  github,
                  file-embed,
                  hspec
+  if flag(aeson-compat)
+    build-depends: aeson-compat >= 0.3.0.0 && <0.4
+  else
+    build-depends: aeson-extra >= 0.2.0.0 && <0.3
 
-  ghc-options: -Wall -fno-warn-orphans
diff --git a/spec/Github/SearchSpec.hs b/spec/Github/SearchSpec.hs
@@ -2,7 +2,9 @@
 {-# LANGUAGE OverloadedStrings #-}
 module Github.SearchSpec where
 
-import Control.Applicative ((<$>))
+import Prelude        ()
+import Prelude.Compat
+
 import Data.Aeson.Compat   (eitherDecodeStrict)
 import Data.FileEmbed      (embedFile)
 import Test.Hspec          (Spec, describe, it, shouldBe)
diff --git a/stack-lts-2.yaml b/stack-lts-2.yaml
@@ -0,0 +1,8 @@
+packages:
+- '.'
+extra-deps:
+- aeson-extra-0.2.3.0
+resolver: lts-2.22
+flags:
+  github:
+     aeson-compat: false
diff --git a/stack-lts-3.yaml b/stack-lts-3.yaml
@@ -0,0 +1,7 @@
+packages:
+- '.'
+extra-deps: []
+resolver: lts-3.20
+flags:
+  github:
+     aeson-compat: false
diff --git a/stack-nightly.yaml b/stack-nightly.yaml
@@ -0,0 +1,7 @@
+resolver: nightly-2016-01-03
+packages:
+- '.'
+extra-deps: []
+flags:
+  github:
+     aeson-compat: true
diff --git a/stack.yaml b/stack.yaml
@@ -0,0 +1 @@
+stack-lts-3.yaml
diff --git a/travis-install.sh b/travis-install.sh
@@ -0,0 +1,44 @@
+case $BUILD in
+  stack)
+    mkdir -p ~/.local/bin;
+    if [ `uname` = "Darwin" ]; then
+      curl -kL https://www.stackage.org/stack/osx-x86_64 | tar xz --strip-components=1 --include '*/stack' -C ~/.local/bin;
+    else
+      curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack';
+    fi
+    stack --no-terminal setup
+    ;;
+  cabal)
+    if [ -n "$STACKAGESNAPSHOT" ]; then wget https://www.stackage.org/$STACKAGESNAPSHOT/cabal.config; fi
+    cabal --version
+    echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo '?')]"
+    if [ -f $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz ]; then
+      zcat $HOME/.cabal/packages/hackage.haskell.org/00-index.tar.gz > $HOME/.cabal/packages/hackage.haskell.org/00-index.tar
+    fi
+    travis_retry cabal update -v
+    sed -i 's/^jobs:/-- jobs:/' ${HOME}/.cabal/config
+    cabal install --only-dependencies --enable-tests --enable-benchmarks --dry -v > installplan.txt
+    sed -i -e '1,/^Resolving /d' installplan.txt; cat installplan.txt
+
+    # check whether current requested install-plan matches cached package-db snapshot
+    if diff -u installplan.txt $HOME/.cabsnap/installplan.txt; then
+      echo "cabal build-cache HIT";
+      rm -rfv .ghc;
+      cp -a $HOME/.cabsnap/ghc $HOME/.ghc;
+      cp -a $HOME/.cabsnap/lib $HOME/.cabsnap/share $HOME/.cabsnap/bin $HOME/.cabal/;
+    else
+      echo "cabal build-cache MISS";
+      rm -rf $HOME/.cabsnap;
+      mkdir -p $HOME/.ghc $HOME/.cabal/lib $HOME/.cabal/share $HOME/.cabal/bin;
+      cabal install --only-dependencies --enable-tests --enable-benchmarks;
+    fi
+
+    # snapshot package-db on cache miss
+    if [ ! -d $HOME/.cabsnap ]; then
+      echo "snapshotting package-db to build-cache";
+      mkdir $HOME/.cabsnap;
+      cp -a $HOME/.ghc $HOME/.cabsnap/ghc;
+      cp -a $HOME/.cabal/lib $HOME/.cabal/share $HOME/.cabal/bin installplan.txt $HOME/.cabsnap/;
+    fi
+    ;;
+esac
diff --git a/travis-script.sh b/travis-script.sh
@@ -0,0 +1,22 @@
+case $BUILD in
+  stack)
+    stack --no-terminal test --only-dependencies
+    ;;
+  cabal)
+    if [ -f configure.ac ]; then autoreconf -i; fi
+    cabal configure --enable-tests --enable-benchmarks -v2  # -v2 provides useful information for debugging
+    cabal build   # this builds all libraries and executables (including tests/benchmarks)
+    cabal test --show-details=always
+
+    if [ "$CABALVER" = "1.22" ]; then cabal check; fi
+    if [ "$CABALVER" = "1.22" ]; then cabal haddock; fi
+
+    cabal sdist   # tests that a source-distribution can be generated
+
+    # Check that the resulting source distribution can be built & installed.
+    # If there are no other `.tar.gz` files in `dist`, this can be even simpler:
+    # `cabal install --force-reinstalls dist/*-*.tar.gz`
+    SRC_TGZ=$(cabal info . | awk '{print $2;exit}').tar.gz &&
+        (cd dist && cabal install --force-reinstalls "$SRC_TGZ")
+    ;;
+esac

-Original file line number
+Diff line change
 *~
 *.hi
 *.o
 +.stack-work