master..c421af7 · typeable/file-embed

git.iko.soy/typeable/file-embed

on c421af7 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+60

@@ -0,0 +1,60 @@

1+# This file has been generated

2+language: c

3+sudo: false

5+matrix:

6+ include:

7+ # Have to use newer cabal, 1.16 passes -XHaskell98 to GHC

8+ - env: CABALVER=1.22 GHCVER=6.12.3

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

10+ - env: CABALVER=1.16 GHCVER=7.0.4

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

12+ - env: CABALVER=1.16 GHCVER=7.2.2

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

14+ - env: CABALVER=1.16 GHCVER=7.4.2

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

16+ - env: CABALVER=1.16 GHCVER=7.6.3

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

18+ - env: CABALVER=1.18 GHCVER=7.8.4

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

20+ - env: CABALVER=1.22 GHCVER=7.10.1

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

22+ - env: CABALVER=head GHCVER=head

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

24+

25+ allow_failures:

26+ - env: CABALVER=head GHCVER=head

27+

28+before_install:

29+ - export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$PATH

30+

31+install:

32+ - cabal --version

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

34+ - travis_retry cabal update

35+ - sed -i 's/^jobs:/-- jobs:/' ${HOME}/.cabal/config

36+ - if [ $GHCVER = "6.12.3" ]; then

37+ cabal install --only-dependencies;

38+ else

39+ cabal install --only-dependencies --enable-tests --enable-benchmarks;

40+ fi

41+

42+script:

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

44+ - if [ $GHCVER = "6.12.3" ]; then

45+ cabal configure -v2;

46+ else

47+ cabal configure --enable-tests --enable-benchmarks -v2;

48+ fi

49+ - cabal build # this builds all libraries and executables (including tests/benchmarks)

50+ - if [ $GHCVER != "6.12.3" ]; then cabal test; fi

51+ - cabal check

52+ - cabal sdist # tests that a source-distribution can be generated

53+

54+# Check that the resulting source distribution can be built & installed.

55+# If there are no other `.tar.gz` files in `dist`, this can be even simpler:

56+# `cabal install --force-reinstalls dist/*-*.tar.gz`

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

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

59+

60+# EOF

ChangeLog.md−42

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

36−

37−* `makeRelativeToProject`

38−

39−## 0.0.9

40−

41−* embedStringFile [#14](https://github.com/snoyberg/file-embed/pull/14)

42−

43## 0.0.8.2

1## 0.0.8.2

45* Improve inject documentation [#11](https://github.com/snoyberg/file-embed/issues/11)

3* Improve inject documentation [#11](https://github.com/snoyberg/file-embed/issues/11)

Data/FileEmbed.hs+14−121

@@ -3,7 +3,7 @@

3{-# LANGUAGE OverloadedStrings #-}

4-- | This module uses template Haskell. Following is a simplified explanation of usage for those unfamiliar with calling Template Haskell functions.

5--

6−-- The function @embedFile@ in this modules embeds a file into the executable

6+-- The function @embedFile@ in this modules embeds a file into the exceutable

7-- that you can use it at runtime. A file is represented as a @ByteString@.

8-- However, as you can see below, the type signature indicates a value of type

9-- @Q Exp@ will be returned. In order to convert this into a @ByteString@, you

@@ -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

@@ -37,9 +35,6 @@ module Data.FileEmbed

37 , injectFile

35 , injectFile

38 , injectWith

36 , injectWith

39 , injectFileWith

37 , injectFileWith

40− -- * Relative path manipulation

41− , makeRelativeToProject

42− , makeRelativeToLocationPredicate

43 -- * Internal

38 -- * Internal

44 , stringToBs

39 , stringToBs

45 , bsToExp

40 , bsToExp

@@ -48,34 +43,30 @@ module Data.FileEmbed

49import Language.Haskell.TH.Syntax

44import Language.Haskell.TH.Syntax

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

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

51− , Lit (..)

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

47+ , Lit (StringL, StringPrimL, IntegerL)

48+#else

49+ , Lit (StringL, IntegerL)

50+#endif

52 , Q

51 , Q

53 , runIO

52 , runIO

54− , qLocation, loc_filename

55#if MIN_VERSION_template_haskell(2,7,0)

53#if MIN_VERSION_template_haskell(2,7,0)

56 , Quasi(qAddDependentFile)

54 , Quasi(qAddDependentFile)

57#endif

55#endif

58 )

56 )

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,

57import System.Directory (doesDirectoryExist, doesFileExist,

64− getDirectoryContents, canonicalizePath)

58+ getDirectoryContents)

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

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

66−import Control.Monad (filterM, guard)

60+import Control.Monad (filterM)

67import qualified Data.ByteString as B

61import qualified Data.ByteString as B

68import qualified Data.ByteString.Char8 as B8

62import qualified Data.ByteString.Char8 as B8

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

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

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

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

71import Data.ByteString.Unsafe (unsafePackAddressLen)

65import Data.ByteString.Unsafe (unsafePackAddressLen)

72−import System.IO.Error (isDoesNotExistError)

73import System.IO.Unsafe (unsafePerformIO)

66import System.IO.Unsafe (unsafePerformIO)

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

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

75import Data.String (fromString)

68import Data.String (fromString)

76import Prelude as P

69import Prelude as P

77−import Data.List (sortBy)

78−import Data.Ord (comparing)

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

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

81--

72--

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

90#endif

81#endif

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

82 (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

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

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

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

122--

86--

123-- > import qualified Data.ByteString

87-- > import qualified Data.ByteString

124-- >

88-- >

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

89-- > myFile :: Data.ByteString.ByteString

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

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

127embedOneFileOf :: [FilePath] -> Q Exp

91embedOneFileOf :: [FilePath] -> Q Exp

128embedOneFileOf ps =

92embedOneFileOf ps =

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

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

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

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

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

152 return $ SigE e typ

116 return $ SigE e typ

153

117

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.

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

167--

119--

168-- This is the workhorse of 'embedDir'

120-- This is the workhorse of 'embedDir'

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

175 qAddDependentFile $ _root ++ '/' : path

127 qAddDependentFile $ _root ++ '/' : path

176#endif

128#endif

177 exp' <- bsToExp bs

129 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']

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

183

131

184bsToExp :: B.ByteString -> Q Exp

132bsToExp :: B.ByteString -> Q Exp

185#if MIN_VERSION_template_haskell(2, 5, 0)

133#if MIN_VERSION_template_haskell(2, 5, 0)

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

187 return $ VarE 'unsafePerformIO

135 return $ VarE 'unsafePerformIO

188 `AppE` (VarE 'unsafePackAddressLen

136 `AppE` (VarE 'unsafePackAddressLen

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

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

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

138+#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))

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

196#else

140#else

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

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

@@ -212,8 +156,6 @@ stringToBs = B8.pack

212-- >

156-- >

213-- > myFile :: IsString a => a

157-- > myFile :: IsString a => a

214-- > myFile = $(embedStringFile "dirName/fileName")

158-- > myFile = $(embedStringFile "dirName/fileName")

215−--

216−-- Since 0.0.9

217embedStringFile :: FilePath -> Q Exp

159embedStringFile :: FilePath -> Q Exp

218embedStringFile fp =

160embedStringFile fp =

219#if MIN_VERSION_template_haskell(2,7,0)

161#if MIN_VERSION_template_haskell(2,7,0)

@@ -223,8 +165,6 @@ embedStringFile fp =

223

165

224-- | Embed a single existing string file in your source code

166-- | Embed a single existing string file in your source code

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

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

226−--

227−-- Since 0.0.9

228embedOneStringFileOf :: [FilePath] -> Q Exp

168embedOneStringFileOf :: [FilePath] -> Q Exp

229embedOneStringFileOf ps =

169embedOneStringFileOf ps =

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

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

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

266 mapM (liftPair2 . second B.readFile)

206 mapM (liftPair2 . second B.readFile)

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

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

268 mapM (fileList' realTop . fst)

208 mapM (fileList' realTop . fst)

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

209+ return $ concat $ files : dirs

270

210

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

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

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

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

@@ -392,50 +332,3 @@ the magic key. If you know for certain that there will only be one dummy space

392available, you can use the non-@With@ variants.

332available, you can use the non-@With@ variants.

393

333

394-}

334-}

395−

396−-- | Take a relative file path and attach it to the root of the current

397−-- project.

398−--

399−-- The idea here is that, when building with Stack, the build will always be

400−-- executed with a current working directory of the root of the project (where

401−-- your .cabal file is located). However, if you load up multiple projects with

402−-- @stack ghci@, the working directory may be something else entirely.

403−--

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

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

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

407−--

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

409−--

410−-- @since 0.0.10

411−makeRelativeToProject :: FilePath -> Q FilePath

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

425− loc <- qLocation

426− runIO $ do

427− srcFP <- canonicalizePath $ loc_filename loc

428− mdir <- findProjectDir srcFP

429− case mdir of

430− Nothing -> error $ "Could not find .cabal file for path: " ++ srcFP

431− Just dir -> return $ dir </> rel

432− where

433− findProjectDir x = do

434− let dir = takeDirectory x

435− if dir == x

436− then return Nothing

437− else do

438− contents <- getDirectoryContents dir

439− if any isTargetFile contents

440− then return (Just dir)

441− else findProjectDir dir

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+6−8

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

1name: file-embed

2−version: 0.0.15.0

2+version: 0.0.8.2

3−license: BSD2

3+license: BSD3

4license-file: LICENSE

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

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

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

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

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

10− embedded in your Haskell code.

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,13 +27,12 @@ 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

35+ , HUnit

38 , filepath

36 , filepath

40source-repository head

38source-repository head

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+4−16

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

1{-# LANGUAGE TemplateHaskell #-}

2{-# LANGUAGE OverloadedStrings #-}

4−import Control.Monad (unless)

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

6import Data.FileEmbed

4import Data.FileEmbed

5+import Test.HUnit ((@?=))

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

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

9−infix 1 @?=

10−

11−(@?=) :: (Eq a, Show a) => a -> a -> IO ()

12−actual @?= expected = unless (actual == expected) (error $ "expected: " ++ show expected ++ "\n but got: " ++ show actual)

13−

14main :: IO ()

8main :: IO ()

15main = do

9main = do

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

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

17 received @?=

11 received @?=

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

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

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

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

20 ]

14 ]

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

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

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

16+ 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