master..0bee64f · typeable/file-embed

git.iko.soy/typeable/file-embed

on 0bee64f help sign in

.azure/azure-linux-template.ymlnew file+38

since splitsnapshots

unifiedsplit

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

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

20−

21−* Haddock markup fix

22−

23## 0.0.11.1

3## 0.0.11.1

25* Support GHC 8.10

5* Support GHC 8.10

Data/FileEmbed.hs+13−59

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

@@ -48,7 +46,11 @@ module Data.FileEmbed

49import Language.Haskell.TH.Syntax

47import Language.Haskell.TH.Syntax

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

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

52 , Q

54 , Q

53 , runIO

55 , runIO

54 , qLocation, loc_filename

56 , qLocation, loc_filename

@@ -56,26 +58,19 @@ import Language.Haskell.TH.Syntax

56 , Quasi(qAddDependentFile)

58 , Quasi(qAddDependentFile)

57#endif

59#endif

58 )

60 )

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,

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

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

187 return $ VarE 'unsafePerformIO

155 return $ VarE 'unsafePerformIO

188 `AppE` (VarE 'unsafePackAddressLen

156 `AppE` (VarE 'unsafePackAddressLen

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

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

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

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

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

196#else

160#else

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

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

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

266 mapM (liftPair2 . second B.readFile)

230 mapM (liftPair2 . second B.readFile)

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

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

268 mapM (fileList' realTop . fst)

232 mapM (fileList' realTop . fst)

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

233+ return $ concat $ files : dirs

270

234

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

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

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

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

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

409--

373--

410-- @since 0.0.10

374-- @since 0.0.10

411makeRelativeToProject :: FilePath -> Q FilePath

375makeRelativeToProject :: FilePath -> Q FilePath

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

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

377 loc <- qLocation

426 runIO $ do

378 runIO $ do

427 srcFP <- canonicalizePath $ loc_filename loc

379 srcFP <- canonicalizePath $ loc_filename loc

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

436 then return Nothing

388 then return Nothing

437 else do

389 else do

438 contents <- getDirectoryContents dir

390 contents <- getDirectoryContents dir

439− if any isTargetFile contents

391+ if any isCabalFile contents

440 then return (Just dir)

392 then return (Just dir)

441 else findProjectDir dir

393 else findProjectDir dir

394+

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

README.md+3−1

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

1## file-embed

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)

5Use Template Haskell to read a file or all the files in a directory, and turn

7Use 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.

8them into (path, bytestring) pairs embedded in your haskell code.

file-embed.cabal+3−6

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

1name: file-embed

2−version: 0.0.15.0

2+version: 0.0.11.1

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