diff --git a/.travis.yml b/.travis.yml --- a/.travis.yml +++ b/.travis.yml @@ -1,62 +1,82 @@ -# NB: don't set `language: haskell` here +# This file has been generated -- see https://github.com/hvr/multi-ghc-travis +language: c +sudo: false -# See also https://github.com/hvr/multi-ghc-travis for more information -env: - # we have to use CABALVER=1.16 for GHC<7.6 as well, as there's - # no package for earlier cabal versions in the PPA - - GHCVER=7.4.2 CABALVER=1.16 - - GHCVER=7.6.3 CABALVER=1.16 - - GHCVER=7.8.4 CABALVER=1.18 - - GHCVER=7.10.1 CABALVER=1.22 - - GHCVER=head CABALVER=head +cache: + directories: + - $HOME/.cabsnap + - $HOME/.cabal/packages +before_cache: + - rm -fv $HOME/.cabal/packages/hackage.haskell.org/build-reports.log + - rm -fv $HOME/.cabal/packages/hackage.haskell.org/00-index.tar + matrix: - allow_failures: - - env: GHCVER=head CABALVER=head + include: + - env: CABALVER=head GHCVER=7.8.4 + compiler: ": #GHC 7.8.4" + addons: {apt: {packages: [cabal-install-head,ghc-7.8.4], sources: [hvr-ghc]}} + - env: CABALVER=head GHCVER=7.10.3 + compiler: ": #GHC 7.10.3" + addons: {apt: {packages: [cabal-install-head,ghc-7.10.3], sources: [hvr-ghc]}} + - env: CABALVER=head GHCVER=8.0.2 + compiler: ": #GHC 8.0.2" + addons: {apt: {packages: [cabal-install-head,ghc-8.0.2], sources: [hvr-ghc]}} -# Note: the distinction between `before_install` and `install` is not -# important. before_install: - - travis_retry sudo add-apt-repository -y ppa:hvr/ghc - - travis_retry sudo apt-get update - - travis_retry sudo apt-get install cabal-install-$CABALVER ghc-$GHCVER + - unset CC - export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$PATH - - export CABAL=cabal-$CABALVER - - $CABAL --version + - TEST=${TEST---enable-tests} install: - - travis_retry cabal update - - $CABAL install --only-dependencies --enable-tests + - 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 $TEST --dry -v > installplan.txt + - sed -i -e '1,/^Resolving /d' installplan.txt; cat installplan.txt -# 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: - # -v2 provides useful information for debugging - - $CABAL clean - - $CABAL configure -v2 --enable-tests +# check whether current requested install-plan matches cached package-db snapshot + - if diff -u $HOME/.cabsnap/installplan.txt 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 -j --only-dependencies $TEST; + fi - # this builds all libraries and executables - # (including tests/benchmarks) - - $CABAL build +# 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 - # tests that a source-distribution can be generated - - $CABAL sdist +# 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 $TEST -v2 # -v2 provides useful information for debugging + - cabal build # this builds all libraries and executables (including tests/benchmarks) + - if [ $TEST = "--enable-tests" ]; then cabal test; fi + - cabal sdist # tests that a source-distribution can be generated - # check that the generated source-distribution can be built & installed - - export SRC_TGZ=$($CABAL info . | awk '{print $2 ".tar.gz";exit}') ; - cd dist/; - if [ -f "$SRC_TGZ" ]; then - $CABAL install --force-reinstalls "$SRC_TGZ"; - else - echo "expected '$SRC_TGZ' not found"; - exit 1; - fi +# 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") -notifications: - irc: - channels: - - "irc.freenode.org#haskell-lens" - skip_join: true - template: - - "\x0313hyperloglog\x03/\x0306%{branch}\x03 \x0314%{commit}\x03 %{build_url} %{message}" +# EOF diff --git a/CHANGELOG.markdown b/CHANGELOG.markdown --- a/CHANGELOG.markdown +++ b/CHANGELOG.markdown @@ -1,3 +1,12 @@ +0.4.1 +----- +* Revamp `Setup.hs` to use `cabal-doctest`. This makes it build + with `Cabal-2.0`, and makes the `doctest`s work with `cabal new-build` and + sandboxes. +* Drop (unused) `hashable-extras` dependency +* Add `NFData` instance for `HyperLogLog` +* Require GHC 7.8 or later + 0.4.0.4 ------- * Support `cereal` 0.5 and `safecopy` 0.9. diff --git a/Setup.lhs b/Setup.lhs --- a/Setup.lhs +++ b/Setup.lhs @@ -1,55 +1,34 @@ -#!/usr/bin/runhaskell \begin{code} +{-# LANGUAGE CPP #-} {-# OPTIONS_GHC -Wall #-} module Main (main) where -import Data.List ( nub ) -import Data.Version ( showVersion ) -import Distribution.Package ( PackageName(PackageName), Package, PackageId, InstalledPackageId, packageVersion, packageName ) -import Distribution.PackageDescription ( PackageDescription(), TestSuite(..) ) -import Distribution.Simple ( defaultMainWithHooks, UserHooks(..), simpleUserHooks ) -import Distribution.Simple.Utils ( rewriteFile, createDirectoryIfMissingVerbose, copyFiles ) -import Distribution.Simple.BuildPaths ( autogenModulesDir ) -import Distribution.Simple.Setup ( BuildFlags(buildVerbosity), Flag(..), fromFlag, HaddockFlags(haddockDistPref)) -import Distribution.Simple.LocalBuildInfo ( withLibLBI, withTestLBI, LocalBuildInfo(), ComponentLocalBuildInfo(componentPackageDeps) ) -import Distribution.Text ( display ) -import Distribution.Verbosity ( Verbosity, normal ) -import System.FilePath ( () ) +#ifndef MIN_VERSION_cabal_doctest +#define MIN_VERSION_cabal_doctest(x,y,z) 0 +#endif +#if MIN_VERSION_cabal_doctest(1,0,0) + +import Distribution.Extra.Doctest ( defaultMainWithDoctests ) main :: IO () -main = defaultMainWithHooks simpleUserHooks - { buildHook = \pkg lbi hooks flags -> do - generateBuildModule (fromFlag (buildVerbosity flags)) pkg lbi - buildHook simpleUserHooks pkg lbi hooks flags - , postHaddock = \args flags pkg lbi -> do - copyFiles normal (haddockOutputDir flags pkg) [] - postHaddock simpleUserHooks args flags pkg lbi - } +main = defaultMainWithDoctests "doctests" -haddockOutputDir :: Package p => HaddockFlags -> p -> FilePath -haddockOutputDir flags pkg = destDir where - baseDir = case haddockDistPref flags of - NoFlag -> "." - Flag x -> x - destDir = baseDir "doc" "html" display (packageName pkg) +#else -generateBuildModule :: Verbosity -> PackageDescription -> LocalBuildInfo -> IO () -generateBuildModule verbosity pkg lbi = do - let dir = autogenModulesDir lbi - createDirectoryIfMissingVerbose verbosity True dir - withLibLBI pkg lbi $ \_ libcfg -> do - withTestLBI pkg lbi $ \suite suitecfg -> do - rewriteFile (dir "Build_" ++ testName suite ++ ".hs") $ unlines - [ "module Build_" ++ testName suite ++ " where" - , "deps :: [String]" - , "deps = " ++ (show $ formatdeps (testDeps libcfg suitecfg)) - ] - where - formatdeps = map (formatone . snd) - formatone p = case packageName p of - PackageName n -> n ++ "-" ++ showVersion (packageVersion p) +#ifdef MIN_VERSION_Cabal +-- If the macro is defined, we have new cabal-install, +-- but for some reason we don't have cabal-doctest in package-db +-- +-- Probably we are running cabal sdist, when otherwise using new-build +-- workflow +import Warning () +#endif -testDeps :: ComponentLocalBuildInfo -> ComponentLocalBuildInfo -> [(InstalledPackageId, PackageId)] -testDeps xs ys = nub $ componentPackageDeps xs ++ componentPackageDeps ys +import Distribution.Simple + +main :: IO () +main = defaultMain + +#endif \end{code} diff --git a/Warning.hs b/Warning.hs new file mode 100644 --- /dev/null +++ b/Warning.hs @@ -0,0 +1,5 @@ +module Warning + {-# WARNING ["You are configuring this package without cabal-doctest installed.", + "The doctests test-suite will not work as a result.", + "To fix this, install cabal-doctest before configuring."] #-} + () where diff --git a/hyperloglog.cabal b/hyperloglog.cabal --- a/hyperloglog.cabal +++ b/hyperloglog.cabal @@ -1,6 +1,6 @@ name: hyperloglog category: Numeric -version: 0.4.0.4 +version: 0.4.1 license: BSD3 cabal-version: >= 1.8 license-file: LICENSE @@ -11,7 +11,7 @@ bug-reports: http://github.com/analytics/hyperloglog/issues copyright: Copyright (C) 2013-2015 Edward A. Kmett build-type: Custom -tested-with: GHC == 7.4.2, GHC == 7.6.3, GHC == 7.8.4, GHC == 7.10.1 +tested-with: GHC == 7.8.4, GHC == 7.10.3, GHC == 8.0.2 synopsis: An approximate streaming (constant space) unique object counter description: This package provides an approximate streaming (constant space) unique object counter. @@ -32,7 +32,14 @@ AUTHORS.markdown README.markdown CHANGELOG.markdown + Warning.hs +custom-setup + setup-depends: + base >= 4.3 && <5, + Cabal >= 1.10, + cabal-doctest >= 1 && <1.1 + source-repository head type: git location: git://github.com/analytics/hyperloglog.git @@ -49,17 +56,16 @@ library build-depends: approximate >= 0.2.1 && < 1, - base >= 4.3 && < 5, - binary >= 0.5 && < 0.8, + base >= 4.7 && < 5, + binary >= 0.5 && < 0.9, bits >= 0.2 && < 1, bytes >= 0.7 && < 1, cereal >= 0.3.5 && < 0.6, cereal-vector >= 0.2 && < 0.3, - comonad >= 4 && < 5, + comonad >= 4 && < 6, deepseq >= 1.3 && < 1.5, distributive >= 0.3 && < 1, hashable >= 1.1.2.3 && < 1.3, - hashable-extras >= 0.1 && < 1, lens >= 4 && < 5, reflection >= 1.3 && < 3, semigroupoids >= 4 && < 6, @@ -67,7 +73,7 @@ safecopy >= 0.8.1 && < 0.10, siphash >= 1.0.3 && < 2, tagged >= 0.4.5 && < 1, - vector >= 0.9 && < 0.12 + vector >= 0.9 && < 0.13 if flag(herbie) build-depends: HerbiePlugin >= 0.1 && < 0.2 @@ -75,7 +81,7 @@ ghc-options: -fplugin=Herbie if impl(ghc < 7.6) - build-depends: generic-deriving >= 1.4 && < 1.9 + build-depends: ghc-prim exposed-modules: Data.HyperLogLog diff --git a/src/Data/HyperLogLog/Config.hs b/src/Data/HyperLogLog/Config.hs --- a/src/Data/HyperLogLog/Config.hs +++ b/src/Data/HyperLogLog/Config.hs @@ -77,7 +77,7 @@ bucketMask :: Integer -> Word32 bucketMask b = fromIntegral (numBuckets b) - 1 - + ------------------------------------------------------------------------------ -- Util ------------------------------------------------------------------------------ diff --git a/src/Data/HyperLogLog/Type.hs b/src/Data/HyperLogLog/Type.hs --- a/src/Data/HyperLogLog/Type.hs +++ b/src/Data/HyperLogLog/Type.hs @@ -4,6 +4,7 @@ {-# LANGUAGE FlexibleContexts #-} {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE FunctionalDependencies #-} +{-# LANGUAGE GeneralizedNewtypeDeriving#-} {-# LANGUAGE MultiParamTypeClasses #-} {-# LANGUAGE RankNTypes #-} {-# LANGUAGE ScopedTypeVariables #-} @@ -55,6 +56,7 @@ import Control.Applicative #endif +import Control.DeepSeq (NFData (..)) import Control.Lens import Control.Monad import Crypto.MAC.SipHash @@ -74,11 +76,7 @@ #if __GLASGOW_HASKELL__ < 710 import Data.Word #endif -#if __GLASGOW_HASKELL__ < 706 -import Generics.Deriving hiding (D, to) -#else import GHC.Generics hiding (D, to) -#endif import GHC.Int #if __GLASGOW_HASKELL__ >= 708 import Data.Type.Coercion (Coercion(..)) @@ -116,7 +114,7 @@ -- Note how 'insert' can be used to add new observations to the -- approximate counter. newtype HyperLogLog p = HyperLogLog { runHyperLogLog :: V.Vector Rank } - deriving (Eq, Show, Generic) + deriving (Eq, Show, Generic, NFData) #if __GLASGOW_HASKELL__ >= 708 -- | If two types @p@ and @q@ reify the same configuration, then we can coerce diff --git a/tests/doctests.hs b/tests/doctests.hs new file mode 100644 --- /dev/null +++ b/tests/doctests.hs @@ -0,0 +1,25 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Main (doctests) +-- Copyright : (C) 2012-14 Edward Kmett +-- License : BSD-style (see the file LICENSE) +-- Maintainer : Edward Kmett +-- Stability : provisional +-- Portability : portable +-- +-- This module provides doctests for a project based on the actual versions +-- of the packages it was built with. It requires a corresponding Setup.lhs +-- to be added to the project +----------------------------------------------------------------------------- +module Main where + +import Build_doctests (flags, pkgs, module_sources) +import Data.Foldable (traverse_) +import Test.DocTest + +main :: IO () +main = do + traverse_ putStrLn args + doctest args + where + args = flags ++ pkgs ++ module_sources diff --git a/tests/doctests.hsc b/tests/doctests.hsc deleted file mode 100644 --- a/tests/doctests.hsc +++ /dev/null @@ -1,83 +0,0 @@ -{-# LANGUAGE CPP #-} -{-# LANGUAGE ForeignFunctionInterface #-} ------------------------------------------------------------------------------ --- | --- Module : Main (doctests) --- Copyright : (C) 2012-13 Edward Kmett --- License : BSD-style (see the file LICENSE) --- Maintainer : Edward Kmett --- Stability : provisional --- Portability : portable --- --- This module provides doctests for a project based on the actual versions --- of the packages it was built with. It requires a corresponding Setup.lhs --- to be added to the project ------------------------------------------------------------------------------ -module Main where - -import Build_doctests (deps) -#if __GLASGOW_HASKELL__ < 710 -import Control.Applicative -#endif -import Control.Monad -import Data.List -import System.Directory -import System.FilePath -import Test.DocTest - -##ifdef mingw32_HOST_OS -##ifdef i386_HOST_ARCH -##define USE_CP -import Control.Applicative -import Control.Exception -import Foreign.C.Types -foreign import stdcall "windows.h SetConsoleCP" c_SetConsoleCP :: CUInt -> IO Bool -foreign import stdcall "windows.h GetConsoleCP" c_GetConsoleCP :: IO CUInt -##elif defined(x86_64_HOST_ARCH) -##define USE_CP -#if __GLASGOW_HASKELL__ < 710 -import Control.Applicative -#endif -import Control.Exception -import Foreign.C.Types -foreign import ccall "windows.h SetConsoleCP" c_SetConsoleCP :: CUInt -> IO Bool -foreign import ccall "windows.h GetConsoleCP" c_GetConsoleCP :: IO CUInt -##endif -##endif - --- | Run in a modified codepage where we can print UTF-8 values on Windows. -withUnicode :: IO a -> IO a -##ifdef USE_CP -withUnicode m = do - cp <- c_GetConsoleCP - (c_SetConsoleCP 65001 >> m) `finally` c_SetConsoleCP cp -##else -withUnicode m = m -##endif - -main :: IO () -main = withUnicode $ getSources >>= \sources -> doctest $ - "-isrc" - : "-idist/build/autogen" - : "-idist/build" - : "-optP-include" - : "-optPdist/build/autogen/cabal_macros.h" - : "dist/build/cbits/crc32.o" - : "dist/build/cbits/debruijn.o" - : "dist/build/cbits/fast.o" - : "dist/build/cbits/rolling.o" - : "dist/build/cbits/storage.o" - : "-hide-all-packages" - : map ("-package="++) deps ++ sources - -getSources :: IO [FilePath] -getSources = filter (isSuffixOf ".hs") <$> go "src" - where - go dir = do - (dirs, files) <- getFilesAndDirectories dir - (files ++) . concat <$> mapM go dirs - -getFilesAndDirectories :: FilePath -> IO ([FilePath], [FilePath]) -getFilesAndDirectories dir = do - c <- map (dir ) . filter (`notElem` ["..", "."]) <$> getDirectoryContents dir - (,) <$> filterM doesDirectoryExist c <*> filterM doesFileExist c