60a0adc...master · typeable/file-embed

git.iko.soy/typeable/file-embed

on master 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− curl -sSL https://get.haskellstack.org/ | sh -s - -f

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

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

ChangeLog.md+12

@@ -1,5 +1,17 @@

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+

3## 0.0.12.0

15## 0.0.12.0

5* Use the `Bytes` literal on newer GHCs to reduce memory usage during compilation [#36](https://github.com/snoyberg/file-embed/pull/36)

17* Use the `Bytes` literal on newer GHCs to reduce memory usage during compilation [#36](https://github.com/snoyberg/file-embed/pull/36)

Data/FileEmbed.hs+49−7

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

19module Data.FileEmbed

20 ( -- * Embed at compile time

21 embedFile

22+ , embedFileIfExists

22 , embedOneFileOf

23 , embedOneFileOf

23 , embedDir

24 , embedDir

24 , embedDirListing

25 , embedDirListing

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

38 , injectFileWith

39 , injectFileWith

39 -- * Relative path manipulation

40 -- * Relative path manipulation

40 , makeRelativeToProject

41 , makeRelativeToProject

42+ , makeRelativeToLocationPredicate

41 -- * Internal

43 -- * Internal

42 , stringToBs

44 , stringToBs

43 , bsToExp

45 , bsToExp

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

60#endif

62#endif

61import System.Directory (doesDirectoryExist, doesFileExist,

63import System.Directory (doesDirectoryExist, doesFileExist,

62 getDirectoryContents, canonicalizePath)

64 getDirectoryContents, canonicalizePath)

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

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

64−import Control.Monad (filterM)

66+import Control.Monad (filterM, guard)

65import qualified Data.ByteString as B

67import qualified Data.ByteString as B

66import qualified Data.ByteString.Char8 as B8

68import qualified Data.ByteString.Char8 as B8

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

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

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

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

69import Data.ByteString.Unsafe (unsafePackAddressLen)

71import Data.ByteString.Unsafe (unsafePackAddressLen)

72+import System.IO.Error (isDoesNotExistError)

70import System.IO.Unsafe (unsafePerformIO)

73import System.IO.Unsafe (unsafePerformIO)

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

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

72import Data.String (fromString)

75import Data.String (fromString)

73import Prelude as P

76import Prelude as P

77+import Data.List (sortBy)

78+import Data.Ord (comparing)

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

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

76--

81--

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

85#endif

90#endif

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

91 (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+

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

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

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

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

90--

122--

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

234 mapM (liftPair2 . second B.readFile)

266 mapM (liftPair2 . second B.readFile)

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

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

236 mapM (fileList' realTop . fst)

268 mapM (fileList' realTop . fst)

237− return $ concat $ files : dirs

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

238

270

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

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

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

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

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

377--

409--

378-- @since 0.0.10

410-- @since 0.0.10

379makeRelativeToProject :: FilePath -> Q FilePath

411makeRelativeToProject :: FilePath -> Q FilePath

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

381 loc <- qLocation

425 loc <- qLocation

382 runIO $ do

426 runIO $ do

383 srcFP <- canonicalizePath $ loc_filename loc

427 srcFP <- canonicalizePath $ loc_filename loc

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

392 then return Nothing

436 then return Nothing

393 else do

437 else do

394 contents <- getDirectoryContents dir

438 contents <- getDirectoryContents dir

395− if any isCabalFile contents

439+ if any isTargetFile contents

396 then return (Just dir)

440 then return (Just dir)

397 else findProjectDir dir

441 else findProjectDir dir

398−

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

file-embed.cabal+3−2

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

1name: file-embed

2−version: 0.0.12.0

2+version: 0.0.15.0

3−license: BSD3

3+license: BSD2

4license-file: LICENSE

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

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

@@ -33,6 +33,7 @@ test-suite test

33 main-is: main.hs

34 hs-source-dirs: test

35 build-depends: base

36+ , bytestring

36 , file-embed

37 , file-embed

37 , filepath

38 , filepath

test/main.hs+9−2

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

2{-# LANGUAGE OverloadedStrings #-}

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 ((</>))

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