git.iko.soy/typeable/file-embed
on c6297e1 help sign in
10 files changed+164−139
since splitsnapshots
unifiedsplit
.azure/azure-linux-template.yml+38 .azure/azure-osx-template.yml+38 .azure/azure-pipelines.yml+30 .azure/azure-windows-template.yml+33 .github/workflows/tests.yml−32 ChangeLog.md−26 Data/FileEmbed.hs+17−65 README.md+3−1 file-embed.cabal+3−6 test/main.hs+2−9
.azure/azure-linux-template.ymlnew file+38
@@ -0,0 +1,38 @@
1+jobs:
2+- job: ${{ parameters.name }}
3+ timeoutInMinutes: 180
4+ pool:
5+ vmImage: ${{ parameters.vmImage }}
6+ strategy:
7+ matrix:
8+ stack-lts-9:
9+ BUILD: stack
10+ STACK_YAML: stack.yaml
11+ ARGS: "--resolver lts-9"
12+ stack-lts-11:
13+ BUILD: stack
14+ STACK_YAML: stack.yaml
15+ ARGS: "--resolver lts-11"
16+ stack-lts-12:
17+ BUILD: stack
18+ STACK_YAML: stack.yaml
19+ ARGS: "--resolver lts-12"
20+ stack-lts-14:
21+ BUILD: stack
22+ STACK_YAML: stack.yaml
23+ ARGS: "--resolver lts-14"
24+ nightly:
25+ BUILD: stack
26+ STACK_YAML: stack.yaml
27+ ARGS: "--resolver nightly"
28+ maxParallel: 6
29+ steps:
30+ - script: |
31+ export STACK_ROOT="$(Build.SourcesDirectory)"/.stack-root;
32+ export PATH=$HOME/.local/bin:$PATH
33+ mkdir -p ~/.local/bin
34+ curl -L https://get.haskellstack.org/stable/linux-x86_64.tar.gz | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'
35+ stack $ARGS test --bench --no-run-benchmarks --haddock --no-haddock-deps
36+ env:
37+ OS_NAME: ${{ parameters.os }}
38+ displayName: 'Build and test'
.azure/azure-osx-template.ymlnew file+38
@@ -0,0 +1,38 @@
1+jobs:
2+- job: ${{ parameters.name }}
3+ timeoutInMinutes: 120
4+ pool:
5+ vmImage: ${{ parameters.vmImage }}
6+ strategy:
7+ matrix:
8+ stack-lts-9:
9+ BUILD: stack
10+ STACK_YAML: stack.yaml
11+ ARGS: "--resolver lts-9"
12+ stack-lts-11:
13+ BUILD: stack
14+ STACK_YAML: stack.yaml
15+ ARGS: "--resolver lts-11"
16+ stack-lts-12:
17+ BUILD: stack
18+ STACK_YAML: stack.yaml
19+ ARGS: "--resolver lts-12"
20+ stack-lts-14:
21+ BUILD: stack
22+ STACK_YAML: stack.yaml
23+ ARGS: "--resolver lts-14"
24+ stack-nightly:
25+ BUILD: stack
26+ STACK_YAML: stack.yaml
27+ ARGS: "--resolver nightly"
28+ maxParallel: 3
29+ steps:
30+ - script: |
31+ export PATH=$HOME/.local/bin:$PATH
32+ export STACK_ROOT="$(Build.SourcesDirectory)"/.stack-root;
33+ mkdir -p ~/.local/bin
34+ curl -skL https://get.haskellstack.org/stable/osx-x86_64.tar.gz | tar xz --strip-components=1 --include '*/stack' -C ~/.local/bin;
35+ stack $ARGS test --bench --no-run-benchmarks --haddock --no-haddock-deps
36+ env:
37+ OS_NAME: ${{ parameters.os }}
38+ displayName: 'Build and test'
.azure/azure-pipelines.ymlnew file+30
@@ -0,0 +1,30 @@
1+# This is the complex Azure 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/azure_ci/
7+#
8+# Copy these contents into the root directory of your Github project in a file
9+# named azure-pipelines.yml
10+#
11+# For better organization, you split various jobs into seprate parts
12+# and each of them are controlled via individual file.
13+jobs:
14+- template: azure-linux-template.yml
15+ parameters:
16+ name: Linux
17+ vmImage: ubuntu-16.04
18+ os: linux
19+
20+- template: azure-osx-template.yml
21+ parameters:
22+ name: macOS
23+ vmImage: macOS-10.13
24+ os: osx
25+
26+- template: azure-windows-template.yml
27+ parameters:
28+ name: Windows
29+ vmImage: vs2017-win2016
30+ os: windows
.azure/azure-windows-template.ymlnew file+33
@@ -0,0 +1,33 @@
1+jobs:
2+- job: ${{ parameters.name }}
3+ timeoutInMinutes: 120
4+ pool:
5+ vmImage: ${{ parameters.vmImage }}
6+ strategy:
7+ matrix:
8+ stack-lts-11:
9+ BUILD: stack
10+ STACK_YAML: stack.yaml
11+ ARGS: "--resolver lts-11"
12+ stack-lts-12:
13+ BUILD: stack
14+ STACK_YAML: stack.yaml
15+ ARGS: "--resolver lts-12"
16+ stack-lts-14:
17+ BUILD: stack
18+ STACK_YAML: stack.yaml
19+ ARGS: "--resolver lts-14"
20+ stack-nightly:
21+ BUILD: stack
22+ STACK_YAML: stack.yaml
23+ ARGS: "--resolver nightly"
24+ maxParallel: 3
25+ steps:
26+ - bash: |
27+ export STACK_ROOT="$(Build.SourcesDirectory)"/.stack-root;
28+ curl -sSkL http://www.stackage.org/stack/windows-x86_64 -o /usr/bin/stack.zip
29+ unzip -o /usr/bin/stack.zip -d /usr/bin/
30+ stack $ARGS test --bench --no-run-benchmarks
31+ env:
32+ OS_NAME: ${{ parameters.os }}
33+ displayName: 'Build and test'
.github/workflows/tests.ymldeleted−32
@@ -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 }}
ChangeLog.md−26
@@ -1,29 +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−
271## 0.0.11
282
293* embedDirListing [#26](https://github.com/snoyberg/file-embed/pull/26)
Data/FileEmbed.hs+17−65
@@ -19,7 +19,6 @@
1919module Data.FileEmbed
2020 ( -- * Embed at compile time
2121 embedFile
22− , embedFileIfExists
2322 , embedOneFileOf
2423 , embedDir
2524 , embedDirListing
@@ -39,7 +38,6 @@ module Data.FileEmbed
3938 , injectFileWith
4039 -- * Relative path manipulation
4140 , makeRelativeToProject
42− , makeRelativeToLocationPredicate
4341 -- * Internal
4442 , stringToBs
4543 , bsToExp
@@ -48,7 +46,11 @@ module Data.FileEmbed
4846
4947import Language.Haskell.TH.Syntax
5048 ( Exp (AppE, ListE, LitE, TupE, SigE, VarE)
51− , Lit (..)
49+#if MIN_VERSION_template_haskell(2,5,0)
50+ , Lit (StringL, StringPrimL, IntegerL)
51+#else
52+ , Lit (StringL, IntegerL)
53+#endif
5254 , Q
5355 , runIO
5456 , qLocation, loc_filename
@@ -56,26 +58,19 @@ import Language.Haskell.TH.Syntax
5658 , Quasi(qAddDependentFile)
5759#endif
5860 )
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
6361import System.Directory (doesDirectoryExist, doesFileExist,
6462 getDirectoryContents, canonicalizePath)
65−import Control.Exception (throw, tryJust, ErrorCall(..))
66−import Control.Monad (filterM, guard)
63+import Control.Exception (throw, ErrorCall(..))
64+import Control.Monad (filterM)
6765import qualified Data.ByteString as B
6866import qualified Data.ByteString.Char8 as B8
6967import Control.Arrow ((&&&), second)
7068import Control.Applicative ((<$>))
7169import Data.ByteString.Unsafe (unsafePackAddressLen)
72−import System.IO.Error (isDoesNotExistError)
7370import System.IO.Unsafe (unsafePerformIO)
7471import System.FilePath ((</>), takeDirectory, takeExtension)
7572import Data.String (fromString)
7673import Prelude as P
77−import Data.List (sortBy)
78−import Data.Ord (comparing)
7974
8075-- | Embed a single file in your source code.
8176--
@@ -90,33 +85,6 @@ embedFile fp =
9085#endif
9186 (runIO $ B.readFile fp) >>= bsToExp
9287
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−
12088-- | Embed a single existing file in your source code
12189-- out of list a list of paths supplied.
12290--
@@ -175,11 +143,7 @@ pairToExp _root (path, bs) = do
175143 qAddDependentFile $ _root ++ '/' : path
176144#endif
177145 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']
146+ return $! TupE [LitE $ StringL path, exp']
183147
184148bsToExp :: B.ByteString -> Q Exp
185149#if MIN_VERSION_template_haskell(2, 5, 0)
@@ -187,11 +151,7 @@ bsToExp bs =
187151 return $ VarE 'unsafePerformIO
188152 `AppE` (VarE 'unsafePackAddressLen
189153 `AppE` LitE (IntegerL $ fromIntegral $ B8.length bs)
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)
154+#if MIN_VERSION_template_haskell(2, 8, 0)
195155 `AppE` LitE (StringPrimL $ B.unpack bs))
196156#else
197157 `AppE` LitE (StringPrimL $ B8.unpack bs))
@@ -266,7 +226,7 @@ fileList' realTop top = do
266226 mapM (liftPair2 . second B.readFile)
267227 dirs <- filterM (doesDirectoryExist . snd) all' >>=
268228 mapM (fileList' realTop . fst)
269− return $ sortBy (comparing fst) $ concat $ files : dirs
229+ return $ concat $ files : dirs
270230
271231liftPair2 :: Monad m => (a, m b) -> m (a, b)
272232liftPair2 (a, b) = b >>= \b' -> return (a, b')
@@ -405,23 +365,13 @@ available, you can use the non-@With@ variants.
405365-- finds the first parent directory with a .cabal file, and uses that as the
406366-- root directory for fixing the relative path.
407367--
408−-- @$(makeRelativeToProject "data/foo.txt" >>= embedFile)@
368+-- @@@
369+-- $(makeRelativeToProject "data/foo.txt" >>= embedFile)
370+-- @@@
409371--
410372-- @since 0.0.10
411373makeRelativeToProject :: 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
374+makeRelativeToProject rel = do
425375 loc <- qLocation
426376 runIO $ do
427377 srcFP <- canonicalizePath $ loc_filename loc
@@ -436,6 +386,8 @@ makeRelativeToLocationPredicate isTargetFile rel = do
436386 then return Nothing
437387 else do
438388 contents <- getDirectoryContents dir
439− if any isTargetFile contents
389+ if any isCabalFile contents
440390 then return (Just dir)
441391 else findProjectDir dir
392+
393+ isCabalFile fp = takeExtension fp == ".cabal"
README.md+3−1
@@ -1,6 +1,8 @@
11## file-embed
22
3−![Tests](https://github.com/snoyberg/file-embed/workflows/Tests/badge.svg)
3+[![Build Status](https://travis-ci.org/snoyberg/file-embed.svg?branch=master)](https://travis-ci.org/snoyberg/file-embed)
4+[![Build status](https://ci.appveyor.com/api/projects/status/vlgo8uudpt374uoy/branch/master?svg=true)](https://ci.appveyor.com/project/snoyberg/file-embed/branch/master)
5+
46
57Use Template Haskell to read a file or all the files in a directory, and turn
68them into (path, bytestring) pairs embedded in your haskell code.
file-embed.cabal+3−6
@@ -1,6 +1,6 @@
11name: file-embed
2−version: 0.0.15.0
3−license: BSD2
2+version: 0.0.11
3+license: BSD3
44license-file: LICENSE
55author: Michael Snoyman <michael@snoyman.com>
66maintainer: Michael Snoyman <michael@snoyman.com>
@@ -10,7 +10,7 @@ description: Use Template Haskell to read a file or all the files in a
1010 embedded in your Haskell code.
1111category: Data
1212stability: Stable
13−cabal-version: >= 1.10
13+cabal-version: >= 1.8
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,6 @@ extra-source-files: test/main.hs, test/sample/foo, test/sample/bar/baz,
1818 README.md
1919
2020library
21− default-language: Haskell2010
2221 build-depends: base >= 4.9.1 && < 5
2322 , bytestring >= 0.9.1.4
2423 , directory >= 1.0.0.3
@@ -28,12 +27,10 @@ library
2827 ghc-options: -Wall
2928
3029test-suite test
31− default-language: Haskell2010
3230 type: exitcode-stdio-1.0
3331 main-is: main.hs
3432 hs-source-dirs: test
3533 build-depends: base
36− , bytestring
3734 , file-embed
3835 , filepath
3936
test/main.hs+2−9
@@ -2,7 +2,6 @@
22{-# LANGUAGE OverloadedStrings #-}
33
44import Control.Monad (unless)
5−import qualified Data.ByteString as B (ByteString, filter)
65import Data.FileEmbed
76import System.FilePath ((</>))
87
@@ -15,14 +14,8 @@ main :: IO ()
1514main = do
1615 let received = $(embedDir "test/sample")
1716 received @?=
18− [ ("bar" </> "baz", "baz\r\n")
19− , ("foo", "foo\r\n")
17+ [ ("foo", "foo\r\n")
18+ , ("bar" </> "baz", "baz\r\n")
2019 ]
2120 let str = $(embedStringFile "test/sample/foo") :: String
2221 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