master..14a678c · typeable/file-embed

git.iko.soy/typeable/file-embed

on 14a678c help sign in

.github/workflows/tests.ymldeleted−32

since splitsnapshots

unifiedsplit

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

1−name: Tests

2−

3−on: [pull_request, push]

4−

5−jobs:

6− build:

7− name: CI

8− runs-on: ${{ matrix.os }}

9− strategy:

10− fail-fast: false

11− matrix:

12− os: [ubuntu-latest, macos-latest, windows-latest]

13− resolver: [nightly, lts-15, lts-14, lts-12, lts-11, lts-9]

14−

15− steps:

16− - name: Clone project

17− uses: actions/checkout@v2

18−

19− - name: Cache dependencies

20− uses: actions/cache@v1

21− with:

22− path: ~/.stack

23− key: ${{ runner.os }}-${{ matrix.resolver }}-${{ hashFiles('stack.yaml') }}

24− restore-keys: |

25− ${{ runner.os }}-${{ matrix.resolver }}-

26−

27− - name: Build and run tests

28− shell: bash

29− run: |

30− set -ex

31− stack upgrade || curl -sSL https://get.haskellstack.org/ | sh -s - -f

32− stack test --fast --no-terminal --resolver=${{ matrix.resolver }}

.gitignore−1

@@ -1,4 +1,3 @@

1dist

2*.swp

3.stack-work

4−/tarballs/

.travis.ymlnew file+146

@@ -0,0 +1,146 @@

1+# Copy these contents into the root directory of your Github project in a file

2+# named .travis.yml

4+# Use new container infrastructure to enable caching

5+sudo: false

7+# Choose a lightweight base image; we provide our own build tools.

8+language: c

10+# Caching so the next build will be fast too.

11+cache:

12+ directories:

13+ - $HOME/.ghc

14+ - $HOME/.cabal

15+ - $HOME/.stack

16+

17+# The different configurations we want to test. We have BUILD=cabal which uses

18+# cabal-install, and BUILD=stack which uses Stack. More documentation on each

19+# of those below.

20+#

21+# We set the compiler values here to tell Travis to use a different

22+# cache file per set of arguments.

23+#

24+# If you need to have different apt packages for each combination in the

25+# matrix, you can use a line such as:

26+# addons: {apt: {packages: [libfcgi-dev,libgmp-dev]}}

27+matrix:

28+ include:

29+ # We grab the appropriate GHC and cabal-install versions from hvr's PPA. See:

30+ # https://github.com/hvr/multi-ghc-travis

31+ - env: BUILD=cabal GHCVER=7.0.4 CABALVER=1.16

32+ compiler: ": #GHC 7.0.4"

33+ addons: {apt: {packages: [cabal-install-1.16,ghc-7.0.4], sources: [hvr-ghc]}}

34+ - env: BUILD=cabal GHCVER=7.2.2 CABALVER=1.16

35+ compiler: ": #GHC 7.2.2"

36+ addons: {apt: {packages: [cabal-install-1.16,ghc-7.2.2], sources: [hvr-ghc]}}

37+ - env: BUILD=cabal GHCVER=7.4.2 CABALVER=1.16

38+ compiler: ": #GHC 7.4.2"

39+ addons: {apt: {packages: [cabal-install-1.16,ghc-7.4.2], sources: [hvr-ghc]}}

40+ - env: BUILD=cabal GHCVER=7.6.3 CABALVER=1.16

41+ compiler: ": #GHC 7.6.3"

42+ addons: {apt: {packages: [cabal-install-1.16,ghc-7.6.3], sources: [hvr-ghc]}}

43+ - env: BUILD=cabal GHCVER=7.8.4 CABALVER=1.18

44+ compiler: ": #GHC 7.8.4"

45+ addons: {apt: {packages: [cabal-install-1.18,ghc-7.8.4], sources: [hvr-ghc]}}

46+ - env: BUILD=cabal GHCVER=7.10.3 CABALVER=1.22

47+ compiler: ": #GHC 7.10.3"

48+ addons: {apt: {packages: [cabal-install-1.22,ghc-7.10.3], sources: [hvr-ghc]}}

49+

50+ # Build with the newest GHC and cabal-install. This is an accepted failure,

51+ # see below.

52+ - env: BUILD=cabal GHCVER=head CABALVER=head

53+ compiler: ": #GHC HEAD"

54+ addons: {apt: {packages: [cabal-install-head,ghc-head], sources: [hvr-ghc]}}

55+

56+ # The Stack builds. We can pass in arbitrary Stack arguments via the ARGS

57+ # variable, such as using --stack-yaml to point to a different file.

58+ - env: BUILD=stack ARGS="--resolver lts-2"

59+ compiler: ": #stack 7.8.4"

60+ addons: {apt: {packages: [ghc-7.8.4], sources: [hvr-ghc]}}

61+

62+ - env: BUILD=stack ARGS="--resolver lts-3"

63+ compiler: ": #stack 7.10.2"

64+ addons: {apt: {packages: [ghc-7.10.2], sources: [hvr-ghc]}}

65+

66+ - env: BUILD=stack ARGS="--resolver lts-5"

67+ compiler: ": #stack 7.10.3"

68+ addons: {apt: {packages: [ghc-7.10.3], sources: [hvr-ghc]}}

69+

70+ # Nightly builds are allowed to fail

71+ - env: BUILD=stack ARGS="--resolver nightly"

72+ compiler: ": #stack nightly"

73+ addons: {apt: {packages: [libgmp-dev]}}

74+

75+ # Build on OS X in addition to Linux

76+ - env: BUILD=stack ARGS="--resolver lts-2"

77+ compiler: ": #stack 7.8.4 osx"

78+ os: osx

79+

80+ - env: BUILD=stack ARGS="--resolver lts-3"

81+ compiler: ": #stack 7.10.2 osx"

82+ os: osx

83+

84+ - env: BUILD=stack ARGS="--resolver lts-5"

85+ compiler: ": #stack 7.10.3 osx"

86+ os: osx

87+

88+ - env: BUILD=stack ARGS="--resolver nightly"

89+ compiler: ": #stack nightly osx"

90+ os: osx

91+

92+ allow_failures:

93+ - env: BUILD=cabal GHCVER=head CABALVER=head

94+ - env: BUILD=stack ARGS="--resolver nightly"

95+

96+before_install:

97+# Using compiler above sets CC to an invalid value, so unset it

98+- unset CC

99+

100+# We want to always allow newer versions of packages when building on GHC HEAD

101+- CABALARGS=""

102+- if [ "x$GHCVER" = "xhead" ]; then CABALARGS=--allow-newer; fi

103+

104+# Download and unpack the stack executable

105+- export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$HOME/.local/bin:$PATH

106+- mkdir -p ~/.local/bin

107+- |

108+ if [ `uname` = "Darwin" ]

109+ then

110+ curl --insecure -L https://www.stackage.org/stack/osx-x86_64 | tar xz --strip-components=1 --include '*/stack' -C ~/.local/bin

111+ else

112+ curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'

113+ fi

114+

115+install:

116+- echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo '?')]"

117+- if [ -f configure.ac ]; then autoreconf -i; fi

118+- |

119+ case "$BUILD" in

120+ stack)

121+ stack --no-terminal --install-ghc $ARGS test --only-dependencies

122+ ;;

123+ cabal)

124+ cabal --version

125+ travis_retry cabal update

126+ cabal install --only-dependencies --enable-tests --enable-benchmarks --force-reinstalls --ghc-options=-O0 --reorder-goals --max-backjumps=-1 $CABALARGS

127+ ;;

128+ esac

129+

130+script:

131+- |

132+ case "$BUILD" in

133+ stack)

134+ stack --no-terminal $ARGS test --haddock --no-haddock-deps

135+ ;;

136+ cabal)

137+ cabal configure --enable-tests --enable-benchmarks -v2 --ghc-options="-O0 -Werror"

138+ cabal build

139+ cabal check || [ "$CABALVER" == "1.16" ]

140+ cabal test

141+ cabal sdist

142+ cabal copy

143+ SRC_TGZ=$(cabal info . | awk '{print $2;exit}').tar.gz && \

144+ (cd dist && cabal install --force-reinstalls "$SRC_TGZ")

145+ ;;

146+ esac

ChangeLog.md−34

@@ -1,37 +1,3 @@

1−# ChangeLog for file-embed

2−

3−## 0.0.15.0

4−

5−* Add `makeRelativeToLocationPredicate`

6−

7−## 0.0.14.0

8−

9−* Add `embedFileIfExists`

10−

11−## 0.0.13.0

12−

13−* Ensure that directory listings are returned in sorted order for reproducibility [yesodweb/yesod#1684](https://github.com/yesodweb/yesod/issues/1684)

14−

15−## 0.0.12.0

16−

17−* Use the `Bytes` literal on newer GHCs to reduce memory usage during compilation [#36](https://github.com/snoyberg/file-embed/pull/36)

18−

19−## 0.0.11.2

20−

21−* Haddock markup fix

22−

23−## 0.0.11.1

24−

25−* Support GHC 8.10

26−

27−## 0.0.11

28−

29−* embedDirListing [#26](https://github.com/snoyberg/file-embed/pull/26)

30−

31−## 0.0.10.1

32−

33−* Minor doc improvements

34−

35## 0.0.10

1## 0.0.10

37* `makeRelativeToProject`

3* `makeRelativeToProject`

Data/FileEmbed.hs+18−79

@@ -19,10 +19,8 @@

19module Data.FileEmbed

20 ( -- * Embed at compile time

21 embedFile

22− , embedFileIfExists

23 , embedOneFileOf

22 , embedOneFileOf

24 , embedDir

23 , embedDir

25− , embedDirListing

26 , getDir

24 , getDir

27 -- * Embed as a IsString

25 -- * Embed as a IsString

28 , embedStringFile

26 , embedStringFile

@@ -39,7 +37,6 @@ module Data.FileEmbed

39 , injectFileWith

37 , injectFileWith

40 -- * Relative path manipulation

38 -- * Relative path manipulation

41 , makeRelativeToProject

39 , makeRelativeToProject

42− , makeRelativeToLocationPredicate

43 -- * Internal

40 -- * Internal

44 , stringToBs

41 , stringToBs

45 , bsToExp

42 , bsToExp

@@ -48,7 +45,11 @@ module Data.FileEmbed

49import Language.Haskell.TH.Syntax

46import Language.Haskell.TH.Syntax

50 ( Exp (AppE, ListE, LitE, TupE, SigE, VarE)

47 ( Exp (AppE, ListE, LitE, TupE, SigE, VarE)

51− , Lit (..)

48+#if MIN_VERSION_template_haskell(2,5,0)

49+ , Lit (StringL, StringPrimL, IntegerL)

50+#else

51+ , Lit (StringL, IntegerL)

52+#endif

52 , Q

53 , Q

53 , runIO

54 , runIO

54 , qLocation, loc_filename

55 , qLocation, loc_filename

@@ -56,26 +57,19 @@ import Language.Haskell.TH.Syntax

56 , Quasi(qAddDependentFile)

57 , Quasi(qAddDependentFile)

57#endif

58#endif

58 )

59 )

59−#if MIN_VERSION_template_haskell(2,16,0)

60−import Language.Haskell.TH ( mkBytes, bytesPrimL )

61−import qualified Data.ByteString.Internal as B

62−#endif

63import System.Directory (doesDirectoryExist, doesFileExist,

60import System.Directory (doesDirectoryExist, doesFileExist,

64 getDirectoryContents, canonicalizePath)

61 getDirectoryContents, canonicalizePath)

65−import Control.Exception (throw, tryJust, ErrorCall(..))

62+import Control.Exception (throw, ErrorCall(..))

66−import Control.Monad (filterM, guard)

63+import Control.Monad (filterM)

67import qualified Data.ByteString as B

64import qualified Data.ByteString as B

68import qualified Data.ByteString.Char8 as B8

65import qualified Data.ByteString.Char8 as B8

69import Control.Arrow ((&&&), second)

66import Control.Arrow ((&&&), second)

70import Control.Applicative ((<$>))

67import Control.Applicative ((<$>))

71import Data.ByteString.Unsafe (unsafePackAddressLen)

68import Data.ByteString.Unsafe (unsafePackAddressLen)

72−import System.IO.Error (isDoesNotExistError)

73import System.IO.Unsafe (unsafePerformIO)

69import System.IO.Unsafe (unsafePerformIO)

74import System.FilePath ((</>), takeDirectory, takeExtension)

70import System.FilePath ((</>), takeDirectory, takeExtension)

75import Data.String (fromString)

71import Data.String (fromString)

76import Prelude as P

72import Prelude as P

77−import Data.List (sortBy)

78−import Data.Ord (comparing)

80-- | Embed a single file in your source code.

74-- | Embed a single file in your source code.

81--

75--

@@ -90,40 +84,13 @@ embedFile fp =

90#endif

84#endif

91 (runIO $ B.readFile fp) >>= bsToExp

85 (runIO $ B.readFile fp) >>= bsToExp

93−-- | Maybe embed a single file in your source code depending on whether or not file exists.

94−--

95−-- Warning: When a build is compiled with the file missing, a recompile when the file exists might not trigger an embed of the file.

96−-- You might try to fix this by doing a clean build.

97−--

98−-- > import qualified Data.ByteString

99−-- >

100−-- > maybeMyFile :: Maybe Data.ByteString.ByteString

101−-- > maybeMyFile = $(embedFileIfExists "dirName/fileName")

102−--

103−-- @since 0.0.14.0

104−embedFileIfExists :: FilePath -> Q Exp

105−embedFileIfExists fp = do

106− mbs <- runIO maybeFile

107− case mbs of

108− Nothing -> [| Nothing |]

109− Just bs -> do

110−#if MIN_VERSION_template_haskell(2,7,0)

111− qAddDependentFile fp

112−#endif

113− [| Just $(bsToExp bs) |]

114− where

115− maybeFile :: IO (Maybe B.ByteString)

116− maybeFile =

117− either (const Nothing) Just <$>

118− tryJust (guard . isDoesNotExistError) (B.readFile fp)

119−

120-- | Embed a single existing file in your source code

87-- | Embed a single existing file in your source code

121-- out of list a list of paths supplied.

88-- out of list a list of paths supplied.

122--

89--

123-- > import qualified Data.ByteString

90-- > import qualified Data.ByteString

124-- >

91-- >

125-- > myFile :: Data.ByteString.ByteString

92-- > myFile :: Data.ByteString.ByteString

126−-- > myFile = $(embedOneFileOf [ "dirName/fileName", "src/dirName/fileName" ])

93+-- > myFile = $(embedFile' [ "dirName/fileName", "src/dirName/fileName" ])

127embedOneFileOf :: [FilePath] -> Q Exp

94embedOneFileOf :: [FilePath] -> Q Exp

128embedOneFileOf ps =

95embedOneFileOf ps =

129 (runIO $ readExistingFile ps) >>= \ ( path, content ) -> do

96 (runIO $ readExistingFile ps) >>= \ ( path, content ) -> do

@@ -151,18 +118,6 @@ embedDir fp = do

151 e <- ListE <$> ((runIO $ fileList fp) >>= mapM (pairToExp fp))

118 e <- ListE <$> ((runIO $ fileList fp) >>= mapM (pairToExp fp))

152 return $ SigE e typ

119 return $ SigE e typ

153

120

154−-- | Embed a directory listing recursively in your source code.

155−--

156−-- > myFiles :: [FilePath]

157−-- > myFiles = $(embedDirListing "dirName")

158−--

159−-- @since 0.0.11

160−embedDirListing :: FilePath -> Q Exp

161−embedDirListing fp = do

162− typ <- [t| [FilePath] |]

163− e <- ListE <$> ((runIO $ fmap fst <$> fileList fp) >>= mapM strToExp)

164− return $ SigE e typ

165−

166-- | Get a directory tree in the IO monad.

121-- | Get a directory tree in the IO monad.

167--

122--

168-- This is the workhorse of 'embedDir'

123-- This is the workhorse of 'embedDir'

@@ -175,11 +130,7 @@ pairToExp _root (path, bs) = do

175 qAddDependentFile $ _root ++ '/' : path

130 qAddDependentFile $ _root ++ '/' : path

176#endif

131#endif

177 exp' <- bsToExp bs

132 exp' <- bsToExp bs

178− return $! TupE

179−#if MIN_VERSION_template_haskell(2,16,0)

180− $ map Just

181−#endif

182− [LitE $ StringL path, exp']

133+ return $! TupE [LitE $ StringL path, exp']

183

134

184bsToExp :: B.ByteString -> Q Exp

135bsToExp :: B.ByteString -> Q Exp

185#if MIN_VERSION_template_haskell(2, 5, 0)

136#if MIN_VERSION_template_haskell(2, 5, 0)

@@ -187,11 +138,7 @@ bsToExp bs =

187 return $ VarE 'unsafePerformIO

138 return $ VarE 'unsafePerformIO

188 `AppE` (VarE 'unsafePackAddressLen

139 `AppE` (VarE 'unsafePackAddressLen

189 `AppE` LitE (IntegerL $ fromIntegral $ B8.length bs)

140 `AppE` LitE (IntegerL $ fromIntegral $ B8.length bs)

190−#if MIN_VERSION_template_haskell(2, 16, 0)

141+#if MIN_VERSION_template_haskell(2, 8, 0)

191− `AppE` LitE (bytesPrimL (

192− let B.PS ptr off sz = bs

193− in mkBytes ptr (fromIntegral off) (fromIntegral sz))))

194−#elif MIN_VERSION_template_haskell(2, 8, 0)

195 `AppE` LitE (StringPrimL $ B.unpack bs))

142 `AppE` LitE (StringPrimL $ B.unpack bs))

196#else

143#else

197 `AppE` LitE (StringPrimL $ B8.unpack bs))

144 `AppE` LitE (StringPrimL $ B8.unpack bs))

@@ -266,7 +213,7 @@ fileList' realTop top = do

266 mapM (liftPair2 . second B.readFile)

213 mapM (liftPair2 . second B.readFile)

267 dirs <- filterM (doesDirectoryExist . snd) all' >>=

214 dirs <- filterM (doesDirectoryExist . snd) all' >>=

268 mapM (fileList' realTop . fst)

215 mapM (fileList' realTop . fst)

269− return $ sortBy (comparing fst) $ concat $ files : dirs

216+ return $ concat $ files : dirs

270

217

271liftPair2 :: Monad m => (a, m b) -> m (a, b)

218liftPair2 :: Monad m => (a, m b) -> m (a, b)

272liftPair2 (a, b) = b >>= \b' -> return (a, b')

219liftPair2 (a, b) = b >>= \b' -> return (a, b')

@@ -405,23 +352,13 @@ available, you can use the non-@With@ variants.

405-- finds the first parent directory with a .cabal file, and uses that as the

352-- finds the first parent directory with a .cabal file, and uses that as the

406-- root directory for fixing the relative path.

353-- root directory for fixing the relative path.

407--

354--

355+-- @@@

408−-- @$(makeRelativeToProject "data/foo.txt" >>= embedFile)@

356+-- $(makeRelativeToProject "data/foo.txt" >>= embedFile)

357+-- @@@

409--

358--

410-- @since 0.0.10

359-- @since 0.0.10

411makeRelativeToProject :: FilePath -> Q FilePath

360makeRelativeToProject :: FilePath -> Q FilePath

412−makeRelativeToProject = makeRelativeToLocationPredicate $ (==) ".cabal" . takeExtension

361+makeRelativeToProject rel = do

413−

414−-- | Take a predicate to infer the project root and a relative file path, the given file path is then attached to the inferred project root

415−--

416−-- This function looks at the source location of the Haskell file calling it,

417−-- finds the first parent directory with a file matching the given predicate, and uses that as the

418−-- root directory for fixing the relative path.

419−--

420−-- @$(makeRelativeToLocationPredicate ((==) ".cabal" . takeExtension) "data/foo.txt" >>= embedFile)@

421−--

422−-- @since 0.0.15.0

423−makeRelativeToLocationPredicate :: (FilePath -> Bool) -> FilePath -> Q FilePath

424−makeRelativeToLocationPredicate isTargetFile rel = do

425 loc <- qLocation

362 loc <- qLocation

426 runIO $ do

363 runIO $ do

427 srcFP <- canonicalizePath $ loc_filename loc

364 srcFP <- canonicalizePath $ loc_filename loc

@@ -436,6 +373,8 @@ makeRelativeToLocationPredicate isTargetFile rel = do

436 then return Nothing

373 then return Nothing

437 else do

374 else do

438 contents <- getDirectoryContents dir

375 contents <- getDirectoryContents dir

439− if any isTargetFile contents

376+ if any isCabalFile contents

440 then return (Just dir)

377 then return (Just dir)

441 else findProjectDir dir

378 else findProjectDir dir

379+

380+ isCabalFile fp = takeExtension fp == ".cabal"

README.md−2

@@ -1,6 +1,4 @@

1## file-embed

3−![Tests](https://github.com/snoyberg/file-embed/workflows/Tests/badge.svg)

4−

5Use Template Haskell to read a file or all the files in a directory, and turn

3Use Template Haskell to read a file or all the files in a directory, and turn

6them into (path, bytestring) pairs embedded in your haskell code.

4them into (path, bytestring) pairs embedded in your haskell code.

file-embed.cabal+4−7

@@ -1,6 +1,6 @@

1name: file-embed

2−version: 0.0.15.0

2+version: 0.0.10

3−license: BSD2

3+license: BSD3

4license-file: LICENSE

5author: Michael Snoyman <michael@snoyman.com>

6maintainer: Michael Snoyman <michael@snoyman.com>

@@ -10,7 +10,7 @@ description: Use Template Haskell to read a file or all the files in a

10 embedded in your Haskell code.

11category: Data

12stability: Stable

13−cabal-version: >= 1.10

13+cabal-version: >= 1.8

14build-type: Simple

15homepage: https://github.com/snoyberg/file-embed

16extra-source-files: test/main.hs, test/sample/foo, test/sample/bar/baz,

@@ -18,8 +18,7 @@ extra-source-files: test/main.hs, test/sample/foo, test/sample/bar/baz,

18 README.md

20library

21− default-language: Haskell2010

22− build-depends: base >= 4.9.1 && < 5

21+ build-depends: base >= 4 && < 5

23 , bytestring >= 0.9.1.4

22 , bytestring >= 0.9.1.4

24 , directory >= 1.0.0.3

23 , directory >= 1.0.0.3

25 , template-haskell

24 , template-haskell

@@ -28,12 +27,10 @@ library

28 ghc-options: -Wall

27 ghc-options: -Wall

30test-suite test

29test-suite test

31− default-language: Haskell2010

32 type: exitcode-stdio-1.0

30 type: exitcode-stdio-1.0

33 main-is: main.hs

31 main-is: main.hs

34 hs-source-dirs: test

32 hs-source-dirs: test

35 build-depends: base

33 build-depends: base

36− , bytestring

37 , file-embed

34 , file-embed

38 , filepath

35 , filepath

stack.yaml+5−1

@@ -1 +1,5 @@

1+flags: {}

2+packages:

3+- '.'

4+extra-deps: []

1−resolver: lts-14.17

5+resolver: lts-3.0

test/main.hs+3−10

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

2{-# LANGUAGE OverloadedStrings #-}

4import Control.Monad (unless)

5−import qualified Data.ByteString as B (ByteString, filter)

6import Data.FileEmbed

5import Data.FileEmbed

7import System.FilePath ((</>))

6import System.FilePath ((</>))

@@ -15,14 +14,8 @@ main :: IO ()

15main = do

14main = do

16 let received = $(embedDir "test/sample")

15 let received = $(embedDir "test/sample")

17 received @?=

16 received @?=

17+ [ ("foo", "foo\r\n")

18− [ ("bar" </> "baz", "baz\r\n")

18+ , ("bar" </> "baz", "baz\r\n")

19− , ("foo", "foo\r\n")

20 ]

19 ]

21 let str = $(embedStringFile "test/sample/foo") :: String

20 let str = $(embedStringFile "test/sample/foo") :: String

22− filter (/= '\r') str @?= "foo\n"

21+ str @?= "foo\r\n"

23−

24− let mbs = $(embedFileIfExists "test/sample/foo")

25− fmap (B.filter (/= fromIntegral (fromEnum '\r'))) mbs @?= Just "foo\n"

26−

27− let mbs2 = $(embedFileIfExists "test/sample/foo2") :: Maybe B.ByteString

28− mbs2 @?= Nothing