git.iko.soy/typeable/file-embed
on master help sign in
swap
548430d36 ahead, 0 behind
.github/workflows/tests.ymlnew file+32
since splitsnapshots
unifiedsplit
@@ -0,0 +1,32 @@
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,3 +1,4 @@
1dist
1dist
2*.swp
2*.swp
3.stack-work
3.stack-work
4+/tarballs/
.travis.ymldeleted−212
@@ -1,212 +0,0 @@
1−# This is the complex Travis configuration, which is intended for use
2−# on open source libraries which need compatibility across multiple GHC
3−# versions, must work with cabal-install, and should be
4−# cross-platform. For more information and other options, see:
5−#
6−# https://docs.haskellstack.org/en/stable/travis_ci/
7−#
8−# Copy these contents into the root directory of your Github project in a file
9−# named .travis.yml
10−
11−# Use new container infrastructure to enable caching
12−sudo: false
13−
14−# Do not choose a language; we provide our own build tools.
15−language: generic
16−
17−# Caching so the next build will be fast too.
18−cache:
19− directories:
20− - $HOME/.ghc
21− - $HOME/.cabal
22− - $HOME/.stack
23−
24−# The different configurations we want to test. We have BUILD=cabal which uses
25−# cabal-install, and BUILD=stack which uses Stack. More documentation on each
26−# of those below.
27−#
28−# We set the compiler values here to tell Travis to use a different
29−# cache file per set of arguments.
30−#
31−# If you need to have different apt packages for each combination in the
32−# matrix, you can use a line such as:
33−# addons: {apt: {packages: [libfcgi-dev,libgmp-dev]}}
34−matrix:
35− include:
36− # We grab the appropriate GHC and cabal-install versions from hvr's PPA. See:
37− # https://github.com/hvr/multi-ghc-travis
38− - env: BUILD=cabal GHCVER=7.0.4 CABALVER=1.16 HAPPYVER=1.19.5 ALEXVER=3.1.7
39− compiler: ": #GHC 7.0.4"
40− addons: {apt: {packages: [cabal-install-1.16,ghc-7.0.4,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc]}}
41− - env: BUILD=cabal GHCVER=7.2.2 CABALVER=1.16 HAPPYVER=1.19.5 ALEXVER=3.1.7
42− compiler: ": #GHC 7.2.2"
43− addons: {apt: {packages: [cabal-install-1.16,ghc-7.2.2,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc]}}
44− - env: BUILD=cabal GHCVER=7.4.2 CABALVER=1.16 HAPPYVER=1.19.5 ALEXVER=3.1.7
45− compiler: ": #GHC 7.4.2"
46− addons: {apt: {packages: [cabal-install-1.16,ghc-7.4.2,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc]}}
47− - env: BUILD=cabal GHCVER=7.6.3 CABALVER=1.16 HAPPYVER=1.19.5 ALEXVER=3.1.7
48− compiler: ": #GHC 7.6.3"
49− addons: {apt: {packages: [cabal-install-1.16,ghc-7.6.3,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc]}}
50− - env: BUILD=cabal GHCVER=7.8.4 CABALVER=1.18 HAPPYVER=1.19.5 ALEXVER=3.1.7
51− compiler: ": #GHC 7.8.4"
52− addons: {apt: {packages: [cabal-install-1.18,ghc-7.8.4,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc]}}
53− - env: BUILD=cabal GHCVER=7.10.3 CABALVER=1.22 HAPPYVER=1.19.5 ALEXVER=3.1.7
54− compiler: ": #GHC 7.10.3"
55− addons: {apt: {packages: [cabal-install-1.22,ghc-7.10.3,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc]}}
56− - env: BUILD=cabal GHCVER=8.0.2 CABALVER=1.24 HAPPYVER=1.19.5 ALEXVER=3.1.7
57− compiler: ": #GHC 8.0.2"
58− addons: {apt: {packages: [cabal-install-1.24,ghc-8.0.2,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc]}}
59− - env: BUILD=cabal GHCVER=8.2.1 CABALVER=2.0
60− compiler: ": #GHC 8.2.1"
61− addons: {apt: {packages: [cabal-install-2.0,ghc-8.2.1], sources: [hvr-ghc]}}
62−
63− # Build with the newest GHC and cabal-install. This is an accepted failure,
64− # see below.
65− - env: BUILD=cabal GHCVER=head CABALVER=head HAPPYVER=1.19.5 ALEXVER=3.1.7
66− compiler: ": #GHC HEAD"
67− addons: {apt: {packages: [cabal-install-head,ghc-head,happy-1.19.5,alex-3.1.7], sources: [hvr-ghc]}}
68−
69− # The Stack builds. We can pass in arbitrary Stack arguments via the ARGS
70− # variable, such as using --stack-yaml to point to a different file.
71− - env: BUILD=stack ARGS=""
72− compiler: ": #stack default"
73− addons: {apt: {packages: [libgmp-dev]}}
74−
75− - env: BUILD=stack ARGS="--resolver lts-2"
76− compiler: ": #stack 7.8.4"
77− addons: {apt: {packages: [libgmp-dev]}}
78−
79− - env: BUILD=stack ARGS="--resolver lts-3"
80− compiler: ": #stack 7.10.2"
81− addons: {apt: {packages: [libgmp-dev]}}
82−
83− - env: BUILD=stack ARGS="--resolver lts-6"
84− compiler: ": #stack 7.10.3"
85− addons: {apt: {packages: [libgmp-dev]}}
86−
87− - env: BUILD=stack ARGS="--resolver lts-7"
88− compiler: ": #stack 8.0.1"
89− addons: {apt: {packages: [libgmp-dev]}}
90−
91− - env: BUILD=stack ARGS="--resolver lts-9"
92− compiler: ": #stack 8.0.2"
93− addons: {apt: {packages: [libgmp-dev]}}
94−
95− # Nightly builds are allowed to fail
96− - env: BUILD=stack ARGS="--resolver nightly"
97− compiler: ": #stack nightly"
98− addons: {apt: {packages: [libgmp-dev]}}
99−
100− # Build on macOS in addition to Linux
101− - env: BUILD=stack ARGS=""
102− compiler: ": #stack default osx"
103− os: osx
104−
105− # Travis includes an macOS which is incompatible with GHC 7.8.4
106− #- env: BUILD=stack ARGS="--resolver lts-2"
107− # compiler: ": #stack 7.8.4 osx"
108− # os: osx
109−
110− - env: BUILD=stack ARGS="--resolver lts-3"
111− compiler: ": #stack 7.10.2 osx"
112− os: osx
113−
114− - env: BUILD=stack ARGS="--resolver lts-6"
115− compiler: ": #stack 7.10.3 osx"
116− os: osx
117−
118− - env: BUILD=stack ARGS="--resolver lts-7"
119− compiler: ": #stack 8.0.1 osx"
120− os: osx
121−
122− - env: BUILD=stack ARGS="--resolver lts-9"
123− compiler: ": #stack 8.0.2 osx"
124− os: osx
125−
126− - env: BUILD=stack ARGS="--resolver nightly"
127− compiler: ": #stack nightly osx"
128− os: osx
129−
130− allow_failures:
131− - env: BUILD=cabal GHCVER=head CABALVER=head HAPPYVER=1.19.5 ALEXVER=3.1.7
132− - env: BUILD=stack ARGS="--resolver nightly"
133−
134−before_install:
135−# Using compiler above sets CC to an invalid value, so unset it
136−- unset CC
137−
138−# We want to always allow newer versions of packages when building on GHC HEAD
139−- CABALARGS=""
140−- if [ "x$GHCVER" = "xhead" ]; then CABALARGS=--allow-newer; fi
141−
142−# Download and unpack the stack executable
143−- export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$HOME/.local/bin:/opt/alex/$ALEXVER/bin:/opt/happy/$HAPPYVER/bin:$HOME/.cabal/bin:$PATH
144−- mkdir -p ~/.local/bin
145−- |
146− if [ `uname` = "Darwin" ]
147− then
148− travis_retry curl --insecure -L https://www.stackage.org/stack/osx-x86_64 | tar xz --strip-components=1 --include '*/stack' -C ~/.local/bin
149− else
150− travis_retry curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'
151− fi
152−
153− # Use the more reliable S3 mirror of Hackage
154− mkdir -p $HOME/.cabal
155− echo 'remote-repo: hackage.haskell.org:http://hackage.fpcomplete.com/' > $HOME/.cabal/config
156− echo 'remote-repo-cache: $HOME/.cabal/packages' >> $HOME/.cabal/config
157−
158− if [ "$CABALVER" != "1.16" ]
159− then
160− echo 'jobs: $ncpus' >> $HOME/.cabal/config
161− fi
162−
163−install:
164−- echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo '?')]"
165−- if [ -f configure.ac ]; then autoreconf -i; fi
166−- |
167− set -ex
168− case "$BUILD" in
169− stack)
170− stack --no-terminal --install-ghc $ARGS test --bench --only-dependencies
171− ;;
172− cabal)
173− cabal --version
174− travis_retry cabal update
175−
176− # Get the list of packages from the stack.yaml file
177− PACKAGES=$(stack --install-ghc query locals | grep '^ *path' | sed 's@^ *path:@@')
178−
179− cabal install --only-dependencies --enable-tests --enable-benchmarks --force-reinstalls --ghc-options=-O0 --reorder-goals --max-backjumps=-1 $CABALARGS $PACKAGES
180− ;;
181− esac
182− set +ex
183−
184−script:
185−- |
186− set -ex
187− case "$BUILD" in
188− stack)
189− stack --no-terminal $ARGS test --bench --no-run-benchmarks --haddock --no-haddock-deps
190− ;;
191− cabal)
192− cabal install --enable-tests --enable-benchmarks --force-reinstalls --ghc-options=-O0 --reorder-goals --max-backjumps=-1 $CABALARGS $PACKAGES
193−
194− ORIGDIR=$(pwd)
195− for dir in $PACKAGES
196− do
197− cd $dir
198− cabal check || [ "$CABALVER" == "1.16" ]
199− cabal sdist
200− PKGVER=$(cabal info . | awk '{print $2;exit}')
201− SRC_TGZ=$PKGVER.tar.gz
202− cd dist
203− tar zxfv "$SRC_TGZ"
204− cd "$PKGVER"
205− cabal configure --enable-tests
206− cabal build
207− cabal test
208− cd $ORIGDIR
209− done
210− ;;
211− esac
212− set +ex
ChangeLog.md+30
@@ -1,3 +1,33 @@
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+
1## 0.0.10.1
31## 0.0.10.1
2
32
3* Minor doc improvements
33* Minor doc improvements
Data/FileEmbed.hs+79−18
@@ -19,8 +19,10 @@
19module Data.FileEmbed
19module Data.FileEmbed
20 ( -- * Embed at compile time
20 ( -- * Embed at compile time
21 embedFile
21 embedFile
22+ , embedFileIfExists
22 , embedOneFileOf
23 , embedOneFileOf
23 , embedDir
24 , embedDir
25+ , embedDirListing
24 , getDir
26 , getDir
25 -- * Embed as a IsString
27 -- * Embed as a IsString
26 , embedStringFile
28 , embedStringFile
@@ -37,6 +39,7 @@ module Data.FileEmbed
37 , injectFileWith
39 , injectFileWith
38 -- * Relative path manipulation
40 -- * Relative path manipulation
39 , makeRelativeToProject
41 , makeRelativeToProject
42+ , makeRelativeToLocationPredicate
40 -- * Internal
43 -- * Internal
41 , stringToBs
44 , stringToBs
42 , bsToExp
45 , bsToExp
@@ -45,11 +48,7 @@ module Data.FileEmbed
45
48
46import Language.Haskell.TH.Syntax
49import Language.Haskell.TH.Syntax
47 ( Exp (AppE, ListE, LitE, TupE, SigE, VarE)
50 ( Exp (AppE, ListE, LitE, TupE, SigE, VarE)
48−#if MIN_VERSION_template_haskell(2,5,0)
51+ , Lit (..)
49− , Lit (StringL, StringPrimL, IntegerL)
50−#else
51− , Lit (StringL, IntegerL)
52−#endif
53 , Q
52 , Q
54 , runIO
53 , runIO
55 , qLocation, loc_filename
54 , qLocation, loc_filename
@@ -57,19 +56,26 @@ import Language.Haskell.TH.Syntax
57 , Quasi(qAddDependentFile)
56 , Quasi(qAddDependentFile)
58#endif
57#endif
59 )
58 )
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
60import System.Directory (doesDirectoryExist, doesFileExist,
63import System.Directory (doesDirectoryExist, doesFileExist,
61 getDirectoryContents, canonicalizePath)
64 getDirectoryContents, canonicalizePath)
62−import Control.Exception (throw, ErrorCall(..))
65+import Control.Exception (throw, tryJust, ErrorCall(..))
63−import Control.Monad (filterM)
66+import Control.Monad (filterM, guard)
64import qualified Data.ByteString as B
67import qualified Data.ByteString as B
65import qualified Data.ByteString.Char8 as B8
68import qualified Data.ByteString.Char8 as B8
66import Control.Arrow ((&&&), second)
69import Control.Arrow ((&&&), second)
67import Control.Applicative ((<$>))
70import Control.Applicative ((<$>))
68import Data.ByteString.Unsafe (unsafePackAddressLen)
71import Data.ByteString.Unsafe (unsafePackAddressLen)
72+import System.IO.Error (isDoesNotExistError)
69import System.IO.Unsafe (unsafePerformIO)
73import System.IO.Unsafe (unsafePerformIO)
70import System.FilePath ((</>), takeDirectory, takeExtension)
74import System.FilePath ((</>), takeDirectory, takeExtension)
71import Data.String (fromString)
75import Data.String (fromString)
72import Prelude as P
76import Prelude as P
77+import Data.List (sortBy)
78+import Data.Ord (comparing)
73
79
74-- | Embed a single file in your source code.
80-- | Embed a single file in your source code.
75--
81--
@@ -84,13 +90,40 @@ embedFile fp =
84#endif
90#endif
85 (runIO $ B.readFile fp) >>= bsToExp
91 (runIO $ B.readFile fp) >>= bsToExp
86
92
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+
87-- | Embed a single existing file in your source code
120-- | Embed a single existing file in your source code
88-- out of list a list of paths supplied.
121-- out of list a list of paths supplied.
89--
122--
90-- > import qualified Data.ByteString
123-- > import qualified Data.ByteString
91-- >
124-- >
92-- > myFile :: Data.ByteString.ByteString
125-- > myFile :: Data.ByteString.ByteString
93−-- > myFile = $(embedFile' [ "dirName/fileName", "src/dirName/fileName" ])
126+-- > myFile = $(embedOneFileOf [ "dirName/fileName", "src/dirName/fileName" ])
94embedOneFileOf :: [FilePath] -> Q Exp
127embedOneFileOf :: [FilePath] -> Q Exp
95embedOneFileOf ps =
128embedOneFileOf ps =
96 (runIO $ readExistingFile ps) >>= \ ( path, content ) -> do
129 (runIO $ readExistingFile ps) >>= \ ( path, content ) -> do
@@ -118,6 +151,18 @@ embedDir fp = do
118 e <- ListE <$> ((runIO $ fileList fp) >>= mapM (pairToExp fp))
151 e <- ListE <$> ((runIO $ fileList fp) >>= mapM (pairToExp fp))
119 return $ SigE e typ
152 return $ SigE e typ
120
153
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+
121-- | Get a directory tree in the IO monad.
166-- | Get a directory tree in the IO monad.
122--
167--
123-- This is the workhorse of 'embedDir'
168-- This is the workhorse of 'embedDir'
@@ -130,7 +175,11 @@ pairToExp _root (path, bs) = do
130 qAddDependentFile $ _root ++ '/' : path
175 qAddDependentFile $ _root ++ '/' : path
131#endif
176#endif
132 exp' <- bsToExp bs
177 exp' <- bsToExp bs
178+ return $! TupE
179+#if MIN_VERSION_template_haskell(2,16,0)
180+ $ map Just
181+#endif
133− return $! TupE [LitE $ StringL path, exp']
182+ [LitE $ StringL path, exp']
134
183
135bsToExp :: B.ByteString -> Q Exp
184bsToExp :: B.ByteString -> Q Exp
136#if MIN_VERSION_template_haskell(2, 5, 0)
185#if MIN_VERSION_template_haskell(2, 5, 0)
@@ -138,7 +187,11 @@ bsToExp bs =
138 return $ VarE 'unsafePerformIO
187 return $ VarE 'unsafePerformIO
139 `AppE` (VarE 'unsafePackAddressLen
188 `AppE` (VarE 'unsafePackAddressLen
140 `AppE` LitE (IntegerL $ fromIntegral $ B8.length bs)
189 `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)
142 `AppE` LitE (StringPrimL $ B.unpack bs))
195 `AppE` LitE (StringPrimL $ B.unpack bs))
143#else
196#else
144 `AppE` LitE (StringPrimL $ B8.unpack bs))
197 `AppE` LitE (StringPrimL $ B8.unpack bs))
@@ -213,7 +266,7 @@ fileList' realTop top = do
213 mapM (liftPair2 . second B.readFile)
266 mapM (liftPair2 . second B.readFile)
214 dirs <- filterM (doesDirectoryExist . snd) all' >>=
267 dirs <- filterM (doesDirectoryExist . snd) all' >>=
215 mapM (fileList' realTop . fst)
268 mapM (fileList' realTop . fst)
216− return $ concat $ files : dirs
269+ return $ sortBy (comparing fst) $ concat $ files : dirs
217
270
218liftPair2 :: Monad m => (a, m b) -> m (a, b)
271liftPair2 :: Monad m => (a, m b) -> m (a, b)
219liftPair2 (a, b) = b >>= \b' -> return (a, b')
272liftPair2 (a, b) = b >>= \b' -> return (a, b')
@@ -352,13 +405,23 @@ available, you can use the non-@With@ variants.
352-- finds the first parent directory with a .cabal file, and uses that as the
405-- finds the first parent directory with a .cabal file, and uses that as the
353-- root directory for fixing the relative path.
406-- root directory for fixing the relative path.
354--
407--
355−-- @@@
356−-- $(makeRelativeToProject "data/foo.txt" >>= embedFile)
408+-- @$(makeRelativeToProject "data/foo.txt" >>= embedFile)@
357−-- @@@
358--
409--
359-- @since 0.0.10
410-- @since 0.0.10
360makeRelativeToProject :: FilePath -> Q FilePath
411makeRelativeToProject :: 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
362 loc <- qLocation
425 loc <- qLocation
363 runIO $ do
426 runIO $ do
364 srcFP <- canonicalizePath $ loc_filename loc
427 srcFP <- canonicalizePath $ loc_filename loc
@@ -373,8 +436,6 @@ makeRelativeToProject rel = do
373 then return Nothing
436 then return Nothing
374 else do
437 else do
375 contents <- getDirectoryContents dir
438 contents <- getDirectoryContents dir
376− if any isCabalFile contents
439+ if any isTargetFile contents
377 then return (Just dir)
440 then return (Just dir)
378 else findProjectDir dir
441 else findProjectDir dir
379−
380− isCabalFile fp = takeExtension fp == ".cabal"
README.md+2
@@ -1,4 +1,6 @@
1## file-embed
1## file-embed
2
2
3+![Tests](https://github.com/snoyberg/file-embed/workflows/Tests/badge.svg)
4+
3Use Template Haskell to read a file or all the files in a directory, and turn
5Use Template Haskell to read a file or all the files in a directory, and turn
4them into (path, bytestring) pairs embedded in your haskell code.
6them into (path, bytestring) pairs embedded in your haskell code.
file-embed.cabal+7−4
@@ -1,6 +1,6 @@
1name: file-embed
1name: file-embed
2−version: 0.0.10.1
2+version: 0.0.15.0
3−license: BSD3
3+license: BSD2
4license-file: LICENSE
4license-file: LICENSE
5author: Michael Snoyman <michael@snoyman.com>
5author: Michael Snoyman <michael@snoyman.com>
6maintainer: 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.
10 embedded in your Haskell code.
11category: Data
11category: Data
12stability: Stable
12stability: Stable
13−cabal-version: >= 1.8
13+cabal-version: >= 1.10
14build-type: Simple
14build-type: Simple
15homepage: https://github.com/snoyberg/file-embed
15homepage: https://github.com/snoyberg/file-embed
16extra-source-files: test/main.hs, test/sample/foo, test/sample/bar/baz,
16extra-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,
18 README.md
18 README.md
19
19
20library
20library
21+ default-language: Haskell2010
21− build-depends: base >= 4 && < 5
22+ build-depends: base >= 4.9.1 && < 5
22 , bytestring >= 0.9.1.4
23 , bytestring >= 0.9.1.4
23 , directory >= 1.0.0.3
24 , directory >= 1.0.0.3
24 , template-haskell
25 , template-haskell
@@ -27,10 +28,12 @@ library
27 ghc-options: -Wall
28 ghc-options: -Wall
28
29
29test-suite test
30test-suite test
31+ default-language: Haskell2010
30 type: exitcode-stdio-1.0
32 type: exitcode-stdio-1.0
31 main-is: main.hs
33 main-is: main.hs
32 hs-source-dirs: test
34 hs-source-dirs: test
33 build-depends: base
35 build-depends: base
36+ , bytestring
34 , file-embed
37 , file-embed
35 , filepath
38 , filepath
36
39
stack.yaml+1−1
@@ -1 +1 @@
1−resolver: lts-9.3
1+resolver: lts-14.17
test/main.hs+10−3
@@ -2,6 +2,7 @@
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3
3
4import Control.Monad (unless)
4import Control.Monad (unless)
5+import qualified Data.ByteString as B (ByteString, filter)
5import Data.FileEmbed
6import Data.FileEmbed
6import System.FilePath ((</>))
7import System.FilePath ((</>))
7
8
@@ -14,8 +15,14 @@ main :: IO ()
14main = do
15main = do
15 let received = $(embedDir "test/sample")
16 let received = $(embedDir "test/sample")
16 received @?=
17 received @?=
17− [ ("foo", "foo\r\n")
18− , ("bar" </> "baz", "baz\r\n")
18+ [ ("bar" </> "baz", "baz\r\n")
19+ , ("foo", "foo\r\n")
19 ]
20 ]
20 let str = $(embedStringFile "test/sample/foo") :: String
21 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