f6243b5...master · typeable/file-embed

git.iko.soy/typeable/file-embed

9 files changed+167−177

since splitsnapshots

unifiedsplit

.github/workflows/tests.yml+32 .gitignore+1 .travis.yml−146 ChangeLog.md+34 Data/FileEmbed.hs+79−18 README.md+2 file-embed.cabal+8−5 stack.yaml+1−5 test/main.hs+10−3

.github/workflows/tests.ymlnew file+32

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

1+name: Tests

3+on: [pull_request, push]

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,3 +1,4 @@

11dist

22*.swp

33.stack-work

4+/tarballs/

.travis.ymldeleted−146

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

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

2−# named .travis.yml

3−

4−# Use new container infrastructure to enable caching

5−sudo: false

6−

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

8−language: c

9−

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,3 +1,37 @@

1+# ChangeLog for file-embed

3+## 0.0.15.0

5+* Add `makeRelativeToLocationPredicate`

7+## 0.0.14.0

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+

135## 0.0.10

236

337* `makeRelativeToProject`

Data/FileEmbed.hs+79−18

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

1919module Data.FileEmbed

2020 ( -- * Embed at compile time

2121 embedFile

22+ , embedFileIfExists

2223 , embedOneFileOf

2324 , embedDir

25+ , embedDirListing

2426 , getDir

2527 -- * Embed as a IsString

2628 , embedStringFile

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

3739 , injectFileWith

3840 -- * Relative path manipulation

3941 , makeRelativeToProject

42+ , makeRelativeToLocationPredicate

4043 -- * Internal

4144 , stringToBs

4245 , bsToExp

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

4548

4649import Language.Haskell.TH.Syntax

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

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

49− , Lit (StringL, StringPrimL, IntegerL)

50−#else

51− , Lit (StringL, IntegerL)

52−#endif

51+ , Lit (..)

5352 , Q

5453 , runIO

5554 , qLocation, loc_filename

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

5756 , Quasi(qAddDependentFile)

5857#endif

5958 )

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

6063import System.Directory (doesDirectoryExist, doesFileExist,

6164 getDirectoryContents, canonicalizePath)

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

63−import Control.Monad (filterM)

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

66+import Control.Monad (filterM, guard)

6467import qualified Data.ByteString as B

6568import qualified Data.ByteString.Char8 as B8

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

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

6871import Data.ByteString.Unsafe (unsafePackAddressLen)

72+import System.IO.Error (isDoesNotExistError)

6973import System.IO.Unsafe (unsafePerformIO)

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

7175import Data.String (fromString)

7276import Prelude as P

77+import Data.List (sortBy)

78+import Data.Ord (comparing)

7379

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

7581--

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

8490#endif

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

8692

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+

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

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

89122--

90123-- > import qualified Data.ByteString

91124-- >

92125-- > myFile :: Data.ByteString.ByteString

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

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

94127embedOneFileOf :: [FilePath] -> Q Exp

95128embedOneFileOf ps =

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

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

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

119152 return $ SigE e typ

120153

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+

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

122167--

123168-- This is the workhorse of 'embedDir'

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

130175 qAddDependentFile $ _root ++ '/' : path

131176#endif

132177 exp' <- bsToExp bs

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

178+ return $! TupE

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

180+ $ map Just

181+#endif

182+ [LitE $ StringL path, exp']

134183

135184bsToExp :: B.ByteString -> Q Exp

136185#if MIN_VERSION_template_haskell(2, 5, 0)

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

138187 return $ VarE 'unsafePerformIO

139188 `AppE` (VarE 'unsafePackAddressLen

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

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

190+#if MIN_VERSION_template_haskell(2, 16, 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)

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

143196#else

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

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

213266 mapM (liftPair2 . second B.readFile)

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

215268 mapM (fileList' realTop . fst)

216− return $ concat $ files : dirs

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

217270

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

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

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

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

353406-- root directory for fixing the relative path.

354407--

355−-- @@@

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

357−-- @@@

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

358409--

359410-- @since 0.0.10

360411makeRelativeToProject :: FilePath -> Q FilePath

361−makeRelativeToProject rel = do

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

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

362425 loc <- qLocation

363426 runIO $ do

364427 srcFP <- canonicalizePath $ loc_filename loc

@@ -373,8 +436,6 @@ makeRelativeToProject rel = do

373436 then return Nothing

374437 else do

375438 contents <- getDirectoryContents dir

376− if any isCabalFile contents

439+ if any isTargetFile contents

377440 then return (Just dir)

378441 else findProjectDir dir

379−

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

README.md+2

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

11## file-embed

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

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

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

file-embed.cabal+8−5

@@ -1,16 +1,16 @@

11name: file-embed

2−version: 0.0.10

3−license: BSD3

2+version: 0.0.15.0

3+license: BSD2

44license-file: LICENSE

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

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

77synopsis: Use Template Haskell to embed file contents directly.

88description: Use Template Haskell to read a file or all the files in a

99 directory, and turn them into (path, bytestring) pairs

10− embedded in your haskell code.

10+ embedded in your Haskell code.

1111category: Data

1212stability: Stable

13−cabal-version: >= 1.8

13+cabal-version: >= 1.10

1414build-type: Simple

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

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

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

1818 README.md

1919

2020library

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

21+ default-language: Haskell2010

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

2223 , bytestring >= 0.9.1.4

2324 , directory >= 1.0.0.3

2425 , template-haskell

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

2728 ghc-options: -Wall

2829

2930test-suite test

31+ default-language: Haskell2010

3032 type: exitcode-stdio-1.0

3133 main-is: main.hs

3234 hs-source-dirs: test

3335 build-depends: base

36+ , bytestring

3437 , file-embed

3538 , filepath

3639

stack.yaml+1−5

@@ -1,5 +1 @@

1−flags: {}

2−packages:

3−- '.'

4−extra-deps: []

5−resolver: lts-3.0

1+resolver: lts-14.17

test/main.hs+10−3

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

22{-# LANGUAGE OverloadedStrings #-}

44import Control.Monad (unless)

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

56import Data.FileEmbed

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

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

1415main = do

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

1617 received @?=

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

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

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

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

1920 ]

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

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

22+ filter (/= '\r') str @?= "foo\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