master..61614ba · typeable/file-embed

git.iko.soy/typeable/file-embed

on 61614ba help sign in

.github/workflows/tests.yml+1−1

since splitsnapshots

unifiedsplit

@@ -28,5 +28,5 @@ jobs:

28 shell: bash

29 run: |

30 set -ex

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

31+ curl -sSL https://get.haskellstack.org/ | sh -s - -f

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

ChangeLog.md−16

@@ -1,21 +1,5 @@

1# ChangeLog for file-embed

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

3## 0.0.11.2

21* Haddock markup fix

5* Haddock markup fix

Data/FileEmbed.hs+7−49

@@ -19,7 +19,6 @@

19module Data.FileEmbed

20 ( -- * Embed at compile time

21 embedFile

22− , embedFileIfExists

23 , embedOneFileOf

22 , embedOneFileOf

24 , embedDir

23 , embedDir

25 , embedDirListing

24 , embedDirListing

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

39 , injectFileWith

38 , injectFileWith

40 -- * Relative path manipulation

39 -- * Relative path manipulation

41 , makeRelativeToProject

40 , makeRelativeToProject

42− , makeRelativeToLocationPredicate

43 -- * Internal

41 -- * Internal

44 , stringToBs

42 , stringToBs

45 , bsToExp

43 , bsToExp

@@ -62,20 +60,17 @@ import qualified Data.ByteString.Internal as B

62#endif

60#endif

63import System.Directory (doesDirectoryExist, doesFileExist,

61import System.Directory (doesDirectoryExist, doesFileExist,

64 getDirectoryContents, canonicalizePath)

62 getDirectoryContents, canonicalizePath)

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

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

66−import Control.Monad (filterM, guard)

64+import Control.Monad (filterM)

67import qualified Data.ByteString as B

65import qualified Data.ByteString as B

68import qualified Data.ByteString.Char8 as B8

66import qualified Data.ByteString.Char8 as B8

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

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

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

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

71import Data.ByteString.Unsafe (unsafePackAddressLen)

69import Data.ByteString.Unsafe (unsafePackAddressLen)

72−import System.IO.Error (isDoesNotExistError)

73import System.IO.Unsafe (unsafePerformIO)

70import System.IO.Unsafe (unsafePerformIO)

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

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

75import Data.String (fromString)

72import Data.String (fromString)

76import Prelude as P

73import Prelude as P

77−import Data.List (sortBy)

78−import Data.Ord (comparing)

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

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

81--

76--

@@ -90,33 +85,6 @@ embedFile fp =

90#endif

85#endif

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

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

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

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

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

122--

90--

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

266 mapM (liftPair2 . second B.readFile)

234 mapM (liftPair2 . second B.readFile)

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

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

268 mapM (fileList' realTop . fst)

236 mapM (fileList' realTop . fst)

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

237+ return $ concat $ files : dirs

270

238

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

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

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

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

@@ -409,19 +377,7 @@ available, you can use the non-@With@ variants.

409--

377--

410-- @since 0.0.10

378-- @since 0.0.10

411makeRelativeToProject :: FilePath -> Q FilePath

379makeRelativeToProject :: FilePath -> Q FilePath

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

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

381 loc <- qLocation

426 runIO $ do

382 runIO $ do

427 srcFP <- canonicalizePath $ loc_filename loc

383 srcFP <- canonicalizePath $ loc_filename loc

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

436 then return Nothing

392 then return Nothing

437 else do

393 else do

438 contents <- getDirectoryContents dir

394 contents <- getDirectoryContents dir

439− if any isTargetFile contents

395+ if any isCabalFile contents

440 then return (Just dir)

396 then return (Just dir)

441 else findProjectDir dir

397 else findProjectDir dir

398+

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

file-embed.cabal+3−6

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

1name: file-embed

2−version: 0.0.15.0

2+version: 0.0.11.2

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,7 +18,6 @@ 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.9.1 && < 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

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

test/main.hs+2−9

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