master..1973bf3 · hakyll

.circleci/config.yml+11−5

since splitsnapshots

unifiedsplit

@@ -6,14 +6,20 @@ jobs:

6 steps:

7 - checkout

8 - restore_cache:

9− key: 'v3-hakyll-{{ arch }}-{{ .Branch }}'

9+ key: 'v2-hakyll-{{ arch }}-{{ .Branch }}'

10+ - run:

11+ name: 'Update cabal indices'

12+ command: 'cabal update'

10 - run:

13 - run:

11 # We set jobs to 1 here because that prevents Out-Of-Memory exceptions

14 # We set jobs to 1 here because that prevents Out-Of-Memory exceptions

12 # while compiling dependencies.

15 # while compiling dependencies.

13 name: 'Install dependencies'

16 name: 'Install dependencies'

14− command: '.circleci/tickle.sh stack build --test --copy-bins --jobs=1'

17+ command: '.circleci/tickle.sh cabal install --only-dependencies --enable-tests --jobs=1 --flags="+buildWebsite"'

18+ - run:

19+ name: 'Build and run tests'

20+ command: 'cabal test'

15 - save_cache:

21 - save_cache:

16− key: 'v3-hakyll-{{ arch }}-{{ .Branch }}-{{ .Revision }}'

22+ key: 'v2-hakyll-{{ arch }}-{{ .Branch }}-{{ .Revision }}'

17 paths:

23 paths:

18− - '~/.stack-work'

24+ - '~/.cabal'

19− - '~/.stack'

25+ - '~/.ghc'

CHANGELOG.md−71

@@ -4,77 +4,6 @@ title: Releases

4

5# Releases

6

7−## Hakyll 4.13.0.0 (2019-08-30)

8−

9−- Improved documentation in many places (contribution by Bergi)

10−- Significantly improve error messages when reading and applying templates

11− (contribution by Bergi)

12− * `empty` and `fail` for `Compiler` now fail without or with a message,

13− allowing for much better debug output

14− * `renderFeed`, `renderRssWithTemplates` and `renderAtomWithTemplates` now

15− take `Template` rather than `String` arguments

16−- Add option to specify date in directory structure,e.g.

17− `posts/2019/05/10/tomorrow.md` (contribution by Taeer Bar-Ya)

18−- Bump QuickCheck to 2.13

19−

20−## Hakyll 4.12.5.2 (2019-05-09)

21−

22−- Bump pandoc to 2.7

23−- Add `srcset` to the list of URL attributes (contribution by c50a326)

24−- Expose `getCategory` in `Hakyll.Web.Tags` (contribution by Ng Wei En)

25−- Fix issue where `published` overwrites the user's context (contribution by

26− ncaq)

27−

28−## Hakyll 4.12.5.1 (2019-02-03)

29−

30−- Bump pandoc to 2.6

31−- Bump pandoc-citeproc to 0.16

32−

33−## Hakyll 4.12.5.0 (2019-01-12)

34−

35−- Update dependencies (contribution by Hexirp):

36− * Bump containers to 0.6

37− * Bump yaml to 0.11

38− * Bump pandoc to 2.5

39− * Bump pandoc-citeproc to 0.15

40− * Bump tasty to 1.2

41−- Correct assertion in unixFilterError test

42− (contribution by Jim McStanton)

43−- Add renderRssWithTemplates, renderAtomWithTemplates

44− (contribution by Abhinav Sarkar)

45−- Speed up hashing in cache (contribution by 0xd34df00d)

46−- Update type of fromFilePath to use FilePath instead of String

47− (contribution by Jim McStanton)

48−- Drop extension when parsing dates in filepaths (contribution by

49− Gabriel Aumala)

50−

51−## Hakyll 4.12.4.0 (2018-08-13)

52−

53−- Bump yaml to 0.10

54−- Bump file-embed to 0.0.11

55−- Bump QuickCheck to 2.12

56−- Use makeRelativeToProject with embedFile for stack ghci (contribution by

57− Michael Sloan)

58−

59−## Hakyll 4.12.3.0 (2018-05-29)

60−

61−- Bump tasty to 1.1

62−- Bump fsnotify to 0.3

63−

64−## Hakyll 4.12.2.0

65−

66−- Bump pandoc to 2.2

67−- Fix path resolution in Pandoc.Biblio (contribution by knih)

68−

69−## Hakyll 4.12.1.0

70−

71−- Fix hakyll-init on older GHC versions

72−- Make the Pandoc dependency optional

73−

74−## Hakyll 4.12.0.1

75−

76−- Bump resourcet to 1.2 in test section

77−

78## Hakyll 4.12.0.0

7## Hakyll 4.12.0.0

79

8

80- Add Semigroup instances for existing Monoids (contribution by

9- Add Semigroup instances for existing Monoids (contribution by

Makefile+6−6

@@ -1,9 +1,9 @@

1−PACKAGE="$(shell stack list-dependencies --separator='-' | grep hakyll)"

2−LOCAL_DOC_ROOT="$(shell stack path --local-doc-root)"

3−

4# Generate the docs and copy them to the website dir

1# Generate the docs and copy them to the website dir

5haddock:

2haddock:

6− stack build --haddock --no-haddock-deps

3+ cabal haddock --hyperlink-source

7− rsync -r "$(LOCAL_DOC_ROOT)/$(PACKAGE)/" web/reference/

4+ rm -rf web/reference/

5+ cp -r dist/doc/html/hakyll/ web/reference/

8

6

9−.PHONY: haddock

7+# Run the tests

8+test:

9+ runghc -isrc -itests tests/TestSuite.hs

hakyll.cabal+57−39

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

1Name: hakyll

2−Version: 4.13.0.0

2+Version: 4.12.0.0

3

4Synopsis: A static website compiler library

5Description:

@@ -68,7 +68,6 @@ Extra-source-files:

68 tests/data/partial.html

69 tests/data/partial.html.out

70 tests/data/posts/2010-08-26-birthday.md

71− tests/data/posts/2018-09-26.md

72 tests/data/russian.md

71 tests/data/russian.md

73 tests/data/strip.html

72 tests/data/strip.html

74 tests/data/strip.html.out

73 tests/data/strip.html.out

@@ -100,11 +99,6 @@ Flag buildWebsite

100 Default: False

99 Default: False

101 Manual: True

100 Manual: True

102

101

103−Flag usePandoc

104− Description: Include Pandoc support

105− Default: True

106− Manual: True

107−

108Library

102Library

109 Ghc-Options: -Wall

103 Ghc-Options: -Wall

110 Hs-Source-Dirs: lib

104 Hs-Source-Dirs: lib

@@ -140,6 +134,9 @@ Library

140 Hakyll.Web.Html

134 Hakyll.Web.Html

141 Hakyll.Web.Html.RelativizeUrls

135 Hakyll.Web.Html.RelativizeUrls

142 Hakyll.Web.Paginate

136 Hakyll.Web.Paginate

137+ Hakyll.Web.Pandoc

138+ Hakyll.Web.Pandoc.Biblio

139+ Hakyll.Web.Pandoc.FileType

143 Hakyll.Web.Redirect

140 Hakyll.Web.Redirect

144 Hakyll.Web.Tags

141 Hakyll.Web.Tags

145 Hakyll.Web.Template

142 Hakyll.Web.Template

@@ -159,6 +156,7 @@ Library

159 Hakyll.Core.Provider.Internal

156 Hakyll.Core.Provider.Internal

160 Hakyll.Core.Provider.MetadataCache

157 Hakyll.Core.Provider.MetadataCache

161 Hakyll.Core.Util.Parser

158 Hakyll.Core.Util.Parser

159+ Hakyll.Web.Pandoc.Binary

162 Paths_hakyll

160 Paths_hakyll

163

161

164 Build-Depends:

162 Build-Depends:

@@ -167,31 +165,34 @@ Library

167 blaze-html >= 0.5 && < 0.10,

165 blaze-html >= 0.5 && < 0.10,

168 blaze-markup >= 0.5.1 && < 0.9,

166 blaze-markup >= 0.5.1 && < 0.9,

169 bytestring >= 0.9 && < 0.11,

167 bytestring >= 0.9 && < 0.11,

170− containers >= 0.3 && < 0.7,

168+ containers >= 0.3 && < 0.6,

171 cryptohash >= 0.7 && < 0.12,

169 cryptohash >= 0.7 && < 0.12,

172 data-default >= 0.4 && < 0.8,

170 data-default >= 0.4 && < 0.8,

173 deepseq >= 1.3 && < 1.5,

171 deepseq >= 1.3 && < 1.5,

174 directory >= 1.0 && < 1.4,

172 directory >= 1.0 && < 1.4,

175− file-embed >= 0.0.10.1 && < 0.0.12,

176 filepath >= 1.0 && < 1.5,

173 filepath >= 1.0 && < 1.5,

177 lrucache >= 1.1.1 && < 1.3,

174 lrucache >= 1.1.1 && < 1.3,

178 mtl >= 1 && < 2.3,

175 mtl >= 1 && < 2.3,

176+ network >= 2.6 && < 2.7,

179 network-uri >= 2.6 && < 2.7,

177 network-uri >= 2.6 && < 2.7,

180− optparse-applicative >= 0.12 && < 0.15,

178+ pandoc >= 2.0.5 && < 2.2,

179+ pandoc-citeproc >= 0.14 && < 0.15,

181 parsec >= 3.0 && < 3.2,

180 parsec >= 3.0 && < 3.2,

182 process >= 1.6 && < 1.7,

181 process >= 1.6 && < 1.7,

183 random >= 1.0 && < 1.2,

182 random >= 1.0 && < 1.2,

183+ regex-base >= 0.93 && < 0.94,

184 regex-tdfa >= 1.1 && < 1.3,

185 resourcet >= 1.1 && < 1.3,

186 scientific >= 0.3.4 && < 0.4,

187 tagsoup >= 0.13.1 && < 0.15,

188− template-haskell >= 2.14 && < 2.15,

189 text >= 0.11 && < 1.3,

188 text >= 0.11 && < 1.3,

190 time >= 1.8 && < 1.10,

189 time >= 1.8 && < 1.10,

191 time-locale-compat >= 0.1 && < 0.2,

190 time-locale-compat >= 0.1 && < 0.2,

192 unordered-containers >= 0.2 && < 0.3,

191 unordered-containers >= 0.2 && < 0.3,

193 vector >= 0.11 && < 0.13,

192 vector >= 0.11 && < 0.13,

194− yaml >= 0.8.11 && < 0.12

193+ yaml >= 0.8.11 && < 0.9,

194+ optparse-applicative >= 0.12 && < 0.15,

195+ file-embed >= 0.0.10.1 && < 0.0.11

195

196

196 If flag(previewServer)

197 If flag(previewServer)

197 Build-depends:

198 Build-depends:

@@ -199,7 +200,7 @@ Library

199 warp >= 3.2 && < 3.3,

200 warp >= 3.2 && < 3.3,

200 wai-app-static >= 3.1 && < 3.2,

201 wai-app-static >= 3.1 && < 3.2,

201 http-types >= 0.9 && < 0.13,

202 http-types >= 0.9 && < 0.13,

202− fsnotify >= 0.2 && < 0.4

203+ fsnotify >= 0.2 && < 0.3

203 Cpp-options:

204 Cpp-options:

204 -DPREVIEW_SERVER

205 -DPREVIEW_SERVER

205 Other-modules:

206 Other-modules:

@@ -208,7 +209,7 @@ Library

208

209

209 If flag(watchServer)

210 If flag(watchServer)

210 Build-depends:

211 Build-depends:

211− fsnotify >= 0.2 && < 0.4

212+ fsnotify >= 0.2 && < 0.3

212 Cpp-options:

213 Cpp-options:

213 -DWATCH_SERVER

214 -DWATCH_SERVER

214 Other-modules:

215 Other-modules:

@@ -221,19 +222,6 @@ Library

221 Cpp-options:

222 Cpp-options:

222 -DCHECK_EXTERNAL

223 -DCHECK_EXTERNAL

223

224

224− If flag(usePandoc)

225− Exposed-Modules:

226− Hakyll.Web.Pandoc

227− Hakyll.Web.Pandoc.Biblio

228− Hakyll.Web.Pandoc.FileType

229− Other-Modules:

230− Hakyll.Web.Pandoc.Binary

231− Build-Depends:

232− pandoc >= 2.0.5 && < 2.8,

233− pandoc-citeproc >= 0.14 && < 0.17

234− Cpp-options:

235− -DUSE_PANDOC

236−

237Test-suite hakyll-tests

225Test-suite hakyll-tests

238 Type: exitcode-stdio-1.0

226 Type: exitcode-stdio-1.0

239 Hs-source-dirs: tests

227 Hs-source-dirs: tests

@@ -255,44 +243,74 @@ Test-suite hakyll-tests

255 Hakyll.Web.CompressCss.Tests

243 Hakyll.Web.CompressCss.Tests

256 Hakyll.Web.Html.RelativizeUrls.Tests

244 Hakyll.Web.Html.RelativizeUrls.Tests

257 Hakyll.Web.Html.Tests

245 Hakyll.Web.Html.Tests

258− Hakyll.Web.Tags.Tests

246+ Hakyll.Web.Pandoc.FileType.Tests

259 Hakyll.Web.Template.Context.Tests

247 Hakyll.Web.Template.Context.Tests

260 Hakyll.Web.Template.Tests

248 Hakyll.Web.Template.Tests

261 TestSuite.Util

249 TestSuite.Util

262

250

263 Build-Depends:

251 Build-Depends:

264 hakyll,

252 hakyll,

265− QuickCheck >= 2.8 && < 2.14,

253+ QuickCheck >= 2.8 && < 2.12,

266− tasty >= 0.11 && < 1.3,

254+ tasty >= 0.11 && < 1.1,

267 tasty-hunit >= 0.9 && < 0.11,

255 tasty-hunit >= 0.9 && < 0.11,

268 tasty-quickcheck >= 0.8 && < 0.11,

256 tasty-quickcheck >= 0.8 && < 0.11,

269 -- Copy pasted from hakyll dependencies:

257 -- Copy pasted from hakyll dependencies:

270 base >= 4.8 && < 5,

258 base >= 4.8 && < 5,

259+ binary >= 0.5 && < 0.10,

260+ blaze-html >= 0.5 && < 0.10,

261+ blaze-markup >= 0.5.1 && < 0.9,

271 bytestring >= 0.9 && < 0.11,

262 bytestring >= 0.9 && < 0.11,

272− containers >= 0.3 && < 0.7,

263+ containers >= 0.3 && < 0.6,

264+ cryptohash >= 0.7 && < 0.12,

265+ data-default >= 0.4 && < 0.8,

266+ deepseq >= 1.3 && < 1.5,

267+ directory >= 1.0 && < 1.4,

273 filepath >= 1.0 && < 1.5,

268 filepath >= 1.0 && < 1.5,

269+ lrucache >= 1.1.1 && < 1.3,

270+ mtl >= 1 && < 2.3,

271+ network >= 2.6 && < 2.7,

272+ network-uri >= 2.6 && < 2.7,

273+ pandoc >= 2.0.5 && < 2.2,

274+ pandoc-citeproc >= 0.14 && < 0.15,

275+ parsec >= 3.0 && < 3.2,

276+ process >= 1.6 && < 1.7,

277+ random >= 1.0 && < 1.2,

278+ regex-base >= 0.93 && < 0.94,

279+ regex-tdfa >= 1.1 && < 1.3,

280+ resourcet >= 1.1 && < 1.3,

281+ scientific >= 0.3.4 && < 0.4,

282+ tagsoup >= 0.13.1 && < 0.15,

274 text >= 0.11 && < 1.3,

283 text >= 0.11 && < 1.3,

284+ time >= 1.8 && < 1.10,

285+ time-locale-compat >= 0.1 && < 0.2,

275 unordered-containers >= 0.2 && < 0.3,

286 unordered-containers >= 0.2 && < 0.3,

287+ vector >= 0.11 && < 0.13,

276− yaml >= 0.8.11 && < 0.12

288+ yaml >= 0.8.11 && < 0.9,

289+ optparse-applicative >= 0.12 && < 0.15

277

290

278 If flag(previewServer)

291 If flag(previewServer)

292+ Build-depends:

293+ wai >= 3.2 && < 3.3,

294+ warp >= 3.2 && < 3.3,

295+ wai-app-static >= 3.1 && < 3.2,

296+ http-types >= 0.9 && < 0.13,

297+ fsnotify >= 0.2 && < 0.3

279 Cpp-options:

298 Cpp-options:

280 -DPREVIEW_SERVER

299 -DPREVIEW_SERVER

281

300

282 If flag(watchServer)

301 If flag(watchServer)

302+ Build-depends:

303+ fsnotify >= 0.2 && < 0.3

283 Cpp-options:

304 Cpp-options:

284 -DWATCH_SERVER

305 -DWATCH_SERVER

285

306

286 If flag(checkExternal)

307 If flag(checkExternal)

308+ Build-depends:

309+ http-conduit >= 2.2 && < 2.4,

310+ http-types >= 0.7 && < 0.13

287 Cpp-options:

311 Cpp-options:

288 -DCHECK_EXTERNAL

312 -DCHECK_EXTERNAL

289

313

290− If flag(usePandoc)

291− Other-modules:

292− Hakyll.Web.Pandoc.FileType.Tests

293− Cpp-options:

294− -DUSE_PANDOC

295−

296Executable hakyll-init

314Executable hakyll-init

297 Main-is: Init.hs

315 Main-is: Init.hs

298 Ghc-options: -Wall -threaded

316 Ghc-options: -Wall -threaded

@@ -324,4 +342,4 @@ Executable hakyll-website

324 base >= 4 && < 5,

342 base >= 4 && < 5,

325 directory >= 1.0 && < 1.4,

343 directory >= 1.0 && < 1.4,

326 filepath >= 1.0 && < 1.5,

344 filepath >= 1.0 && < 1.5,

327− pandoc >= 2.0.5 && < 2.8

345+ pandoc >= 2.0.5 && < 2.2

lib/Hakyll.hs+1−5

@@ -20,12 +20,10 @@ module Hakyll

20 , module Hakyll.Web.Feed

21 , module Hakyll.Web.Html

22 , module Hakyll.Web.Html.RelativizeUrls

23− , module Hakyll.Web.Paginate

24−#ifdef USE_PANDOC

25 , module Hakyll.Web.Pandoc

23 , module Hakyll.Web.Pandoc

24+ , module Hakyll.Web.Paginate

26 , module Hakyll.Web.Pandoc.Biblio

25 , module Hakyll.Web.Pandoc.Biblio

27 , module Hakyll.Web.Pandoc.FileType

26 , module Hakyll.Web.Pandoc.FileType

28−#endif

29 , module Hakyll.Web.Redirect

27 , module Hakyll.Web.Redirect

30 , module Hakyll.Web.Tags

28 , module Hakyll.Web.Tags

31 , module Hakyll.Web.Template

29 , module Hakyll.Web.Template

@@ -54,11 +52,9 @@ import Hakyll.Web.Feed

54import Hakyll.Web.Html

52import Hakyll.Web.Html

55import Hakyll.Web.Html.RelativizeUrls

53import Hakyll.Web.Html.RelativizeUrls

56import Hakyll.Web.Paginate

54import Hakyll.Web.Paginate

57−#ifdef USE_PANDOC

58import Hakyll.Web.Pandoc

55import Hakyll.Web.Pandoc

59import Hakyll.Web.Pandoc.Biblio

56import Hakyll.Web.Pandoc.Biblio

60import Hakyll.Web.Pandoc.FileType

57import Hakyll.Web.Pandoc.FileType

61−#endif

62import Hakyll.Web.Redirect

58import Hakyll.Web.Redirect

63import Hakyll.Web.Tags

59import Hakyll.Web.Tags

64import Hakyll.Web.Template

60import Hakyll.Web.Template

lib/Hakyll/Core/Compiler.hs+2−35

@@ -24,16 +24,13 @@ module Hakyll.Core.Compiler

24 , cached

25 , unsafeCompiler

26 , debugCompiler

27− , noResult

28− , withErrorMessage

29 ) where

27 ) where

30

28

31

29

32--------------------------------------------------------------------------------

30--------------------------------------------------------------------------------

33−import Control.Monad (unless, when, (>=>))

31+import Control.Monad (when, unless)

34import Data.Binary (Binary)

32import Data.Binary (Binary)

35import Data.ByteString.Lazy (ByteString)

33import Data.ByteString.Lazy (ByteString)

36−import qualified Data.List.NonEmpty as NonEmpty

37import Data.Typeable (Typeable)

34import Data.Typeable (Typeable)

38import System.Environment (getProgName)

35import System.Environment (getProgName)

39import System.FilePath (takeExtension)

36import System.FilePath (takeExtension)

@@ -65,7 +62,6 @@ getUnderlyingExtension = takeExtension . toFilePath <$> getUnderlying

65

62

66

63

67--------------------------------------------------------------------------------

64--------------------------------------------------------------------------------

68−-- | Create an item from the underlying identifier and a given value.

69makeItem :: a -> Compiler (Item a)

65makeItem :: a -> Compiler (Item a)

70makeItem x = do

66makeItem x = do

71 identifier <- getUnderlying

67 identifier <- getUnderlying

@@ -145,10 +141,6 @@ saveSnapshot snapshot item = do

145

141

146

142

147--------------------------------------------------------------------------------

143--------------------------------------------------------------------------------

148−-- | Turn on caching for a compilation value to avoid recomputing it

149−-- on subsequent Hakyll runs.

150−-- The storage key consists of the underlying identifier of the compiled

151−-- ressource and the given name.

152cached :: (Binary a, Typeable a)

144cached :: (Binary a, Typeable a)

153 => String

145 => String

154 -> Compiler a

146 -> Compiler a

@@ -185,37 +177,12 @@ cached name compiler = do

185

177

186

178

187--------------------------------------------------------------------------------

179--------------------------------------------------------------------------------

188−-- | Run an IO computation without dependencies in a Compiler

189unsafeCompiler :: IO a -> Compiler a

180unsafeCompiler :: IO a -> Compiler a

190unsafeCompiler = compilerUnsafeIO

181unsafeCompiler = compilerUnsafeIO

191

182

192

183

193--------------------------------------------------------------------------------

184--------------------------------------------------------------------------------

194−-- | Fail so that it is treated as non-defined in an @\$if()\$@ branching

195−-- "Hakyll.Web.Template" macro, and alternative

196−-- 'Hakyll.Web.Template.Context.Context's are tried

197−--

198−-- @since 4.13.0

199−noResult :: String -> Compiler a

200−noResult = compilerNoResult . return

201−

202−

203−--------------------------------------------------------------------------------

204−-- | Prepend an error line to the error, if there is one. This allows you to

205−-- add helpful context to error messages.

206−--

207−-- @since 4.13.0

208−withErrorMessage :: String -> Compiler a -> Compiler a

209−withErrorMessage x = do

210− compilerTry >=> either (compilerResult . CompilerError . prepend) return

211− where

212− prepend (CompilationFailure es) = CompilationFailure (x `NonEmpty.cons` es)

213− prepend (CompilationNoResult es) = CompilationNoResult (x : es)

214−

215−

216−--------------------------------------------------------------------------------

217−-- | Compiler for debugging purposes.

185+-- | Compiler for debugging purposes

218−-- Passes a message to the debug logger that is printed in verbose mode.

219debugCompiler :: String -> Compiler ()

186debugCompiler :: String -> Compiler ()

220debugCompiler msg = do

187debugCompiler msg = do

221 logger <- compilerLogger <$> compilerAsk

188 logger <- compilerLogger <$> compilerAsk

lib/Hakyll/Core/Compiler/Internal.hs+41−126

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

1--------------------------------------------------------------------------------

2-- | Internally used compiler module

3{-# LANGUAGE CPP #-}

4−{-# LANGUAGE DeriveFunctor #-}

5{-# LANGUAGE FlexibleInstances #-}

4{-# LANGUAGE FlexibleInstances #-}

6{-# LANGUAGE GADTs #-}

5{-# LANGUAGE GADTs #-}

7{-# LANGUAGE GeneralizedNewtypeDeriving #-}

6{-# LANGUAGE GeneralizedNewtypeDeriving #-}

@@ -11,26 +10,19 @@ module Hakyll.Core.Compiler.Internal

11 Snapshot

10 Snapshot

12 , CompilerRead (..)

11 , CompilerRead (..)

13 , CompilerWrite (..)

12 , CompilerWrite (..)

14− , CompilerErrors (..)

15 , CompilerResult (..)

13 , CompilerResult (..)

16 , Compiler (..)

14 , Compiler (..)

17 , runCompiler

15 , runCompiler

18

16

19 -- * Core operations

17 -- * Core operations

20− , compilerResult

21 , compilerTell

18 , compilerTell

22 , compilerAsk

19 , compilerAsk

23− , compilerUnsafeIO

24−

25− -- * Error operations

26 , compilerThrow

20 , compilerThrow

27− , compilerNoResult

28 , compilerCatch

21 , compilerCatch

29− , compilerTry

22+ , compilerResult

30− , compilerErrorMessages

23+ , compilerUnsafeIO

31

24

32 -- * Utilities

25 -- * Utilities

33− , compilerDebugEntries

34 , compilerTellDependencies

26 , compilerTellDependencies

35 , compilerTellCacheHits

27 , compilerTellCacheHits

36 ) where

28 ) where

@@ -40,9 +32,7 @@ module Hakyll.Core.Compiler.Internal

40import Control.Applicative (Alternative (..))

32import Control.Applicative (Alternative (..))

41import Control.Exception (SomeException, handle)

33import Control.Exception (SomeException, handle)

42import Control.Monad (forM_)

34import Control.Monad (forM_)

43−import Control.Monad.Except (MonadError (..))

35+import Control.Monad.Except (MonadError (..))

44−import Data.List.NonEmpty (NonEmpty (..))

45−import qualified Data.List.NonEmpty as NonEmpty

46#if MIN_VERSION_base(4,9,0)

36#if MIN_VERSION_base(4,9,0)

47import Data.Semigroup (Semigroup (..))

37import Data.Semigroup (Semigroup (..))

48#endif

38#endif

@@ -55,6 +45,7 @@ import Hakyll.Core.Configuration

55import Hakyll.Core.Dependencies

45import Hakyll.Core.Dependencies

56import Hakyll.Core.Identifier

46import Hakyll.Core.Identifier

57import Hakyll.Core.Identifier.Pattern

47import Hakyll.Core.Identifier.Pattern

48+import Hakyll.Core.Logger (Logger)

58import qualified Hakyll.Core.Logger as Logger

49import qualified Hakyll.Core.Logger as Logger

59import Hakyll.Core.Metadata

50import Hakyll.Core.Metadata

60import Hakyll.Core.Provider

51import Hakyll.Core.Provider

@@ -84,7 +75,7 @@ data CompilerRead = CompilerRead

84 , -- | Compiler store

75 , -- | Compiler store

85 compilerStore :: Store

76 compilerStore :: Store

86 , -- | Logger

77 , -- | Logger

87− compilerLogger :: Logger.Logger

78+ compilerLogger :: Logger

88 }

79 }

89

80

90

81

@@ -113,29 +104,11 @@ instance Monoid CompilerWrite where

113

104

114

105

115--------------------------------------------------------------------------------

106--------------------------------------------------------------------------------

116−-- | Distinguishes reasons in a 'CompilerError'

107+data CompilerResult a where

117−data CompilerErrors a

118− -- | One or more exceptions occured during compilation

119− = CompilationFailure (NonEmpty a)

120− -- | Absence of any result, most notably in template contexts. May still

121− -- have error messages.

122− | CompilationNoResult [a]

123− deriving Functor

124−

125−

126−-- | Unwrap a `CompilerErrors`

127−compilerErrorMessages :: CompilerErrors a -> [a]

128−compilerErrorMessages (CompilationFailure x) = NonEmpty.toList x

129−compilerErrorMessages (CompilationNoResult x) = x

130−

131−

132−--------------------------------------------------------------------------------

133−-- | An intermediate result of a compilation step

134−data CompilerResult a

135− = CompilerDone a CompilerWrite

108+ CompilerDone :: a -> CompilerWrite -> CompilerResult a

136− | CompilerSnapshot Snapshot (Compiler a)

109+ CompilerSnapshot :: Snapshot -> Compiler a -> CompilerResult a

110+ CompilerError :: [String] -> CompilerResult a

137− | CompilerRequire (Identifier, Snapshot) (Compiler a)

111+ CompilerRequire :: (Identifier, Snapshot) -> Compiler a -> CompilerResult a

138− | CompilerError (CompilerErrors String)

139

112

140

113

141--------------------------------------------------------------------------------

114--------------------------------------------------------------------------------

@@ -153,14 +126,14 @@ instance Functor Compiler where

153 return $ case res of

126 return $ case res of

154 CompilerDone x w -> CompilerDone (f x) w

127 CompilerDone x w -> CompilerDone (f x) w

155 CompilerSnapshot s c' -> CompilerSnapshot s (fmap f c')

128 CompilerSnapshot s c' -> CompilerSnapshot s (fmap f c')

156− CompilerRequire i c' -> CompilerRequire i (fmap f c')

157 CompilerError e -> CompilerError e

129 CompilerError e -> CompilerError e

130+ CompilerRequire i c' -> CompilerRequire i (fmap f c')

158 {-# INLINE fmap #-}

131 {-# INLINE fmap #-}

159

132

160

133

161--------------------------------------------------------------------------------

134--------------------------------------------------------------------------------

162instance Monad Compiler where

135instance Monad Compiler where

163− return x = compilerResult $ CompilerDone x mempty

136+ return x = Compiler $ \_ -> return $ CompilerDone x mempty

164 {-# INLINE return #-}

137 {-# INLINE return #-}

165

138

166 Compiler c >>= f = Compiler $ \r -> do

139 Compiler c >>= f = Compiler $ \r -> do

@@ -173,14 +146,14 @@ instance Monad Compiler where

173 CompilerSnapshot s c' -> CompilerSnapshot s $ do

146 CompilerSnapshot s c' -> CompilerSnapshot s $ do

174 compilerTell w -- Save dependencies!

147 compilerTell w -- Save dependencies!

175 c'

148 c'

149+ CompilerError e -> CompilerError e

176 CompilerRequire i c' -> CompilerRequire i $ do

150 CompilerRequire i c' -> CompilerRequire i $ do

177 compilerTell w -- Save dependencies!

151 compilerTell w -- Save dependencies!

178 c'

152 c'

179− CompilerError e -> CompilerError e

180

153

181 CompilerSnapshot s c' -> return $ CompilerSnapshot s (c' >>= f)

154 CompilerSnapshot s c' -> return $ CompilerSnapshot s (c' >>= f)

182− CompilerRequire i c' -> return $ CompilerRequire i (c' >>= f)

183 CompilerError e -> return $ CompilerError e

155 CompilerError e -> return $ CompilerError e

156+ CompilerRequire i c' -> return $ CompilerRequire i (c' >>= f)

184 {-# INLINE (>>=) #-}

157 {-# INLINE (>>=) #-}

185

158

186 fail = compilerThrow . return

159 fail = compilerThrow . return

@@ -197,145 +170,87 @@ instance Applicative Compiler where

197

170

198

171

199--------------------------------------------------------------------------------

172--------------------------------------------------------------------------------

200−-- | Access provided metadata from anywhere

201instance MonadMetadata Compiler where

173instance MonadMetadata Compiler where

202 getMetadata = compilerGetMetadata

174 getMetadata = compilerGetMetadata

203 getMatches = compilerGetMatches

175 getMatches = compilerGetMatches

204

176

205

177

206--------------------------------------------------------------------------------

178--------------------------------------------------------------------------------

207−-- | Compilation may fail with multiple error messages.

208−-- 'catchError' handles errors from 'throwError', 'fail' and 'Hakyll.Core.Compiler.noResult'

209instance MonadError [String] Compiler where

179instance MonadError [String] Compiler where

210− throwError = compilerThrow

180+ throwError = compilerThrow

211− catchError c = compilerCatch c . (. compilerErrorMessages)

181+ catchError = compilerCatch

212

182

213

183

214--------------------------------------------------------------------------------

184--------------------------------------------------------------------------------

215−-- | Like 'unCompiler' but treating IO exceptions as 'CompilerError's

216runCompiler :: Compiler a -> CompilerRead -> IO (CompilerResult a)

185runCompiler :: Compiler a -> CompilerRead -> IO (CompilerResult a)

217runCompiler compiler read' = handle handler $ unCompiler compiler read'

186runCompiler compiler read' = handle handler $ unCompiler compiler read'

218 where

187 where

219 handler :: SomeException -> IO (CompilerResult a)

188 handler :: SomeException -> IO (CompilerResult a)

220− handler e = return $ CompilerError $ CompilationFailure $ show e :| []

189+ handler e = return $ CompilerError [show e]

221

190

222

191

223--------------------------------------------------------------------------------

192--------------------------------------------------------------------------------

224−-- | Trying alternative compilers if the first fails, regardless whether through

225−-- 'fail', 'throwError' or 'Hakyll.Core.Compiler.noResult'.

226−-- Aggregates error messages if all fail.

227instance Alternative Compiler where

193instance Alternative Compiler where

228− empty = compilerNoResult []

194+ empty = compilerThrow []

229− x <|> y = x `compilerCatch` (\rx -> y `compilerCatch` (\ry ->

195+ x <|> y = compilerCatch x $ \es -> do

230− case (rx, ry) of

196+ logger <- compilerLogger <$> compilerAsk

231− (CompilationFailure xs, CompilationFailure ys) ->

197+ forM_ es $ \e -> compilerUnsafeIO $ Logger.debug logger $

232− compilerThrow $ NonEmpty.toList xs ++ NonEmpty.toList ys

233− (CompilationFailure xs, CompilationNoResult ys) ->

234− debug ys >> compilerThrow (NonEmpty.toList xs)

235− (CompilationNoResult xs, CompilationFailure ys) ->

236− debug xs >> compilerThrow (NonEmpty.toList ys)

237− (CompilationNoResult xs, CompilationNoResult ys) -> compilerNoResult $ xs ++ ys

238− ))

239− where

240− debug = compilerDebugEntries "Hakyll.Core.Compiler.Internal: Alternative fail suppressed"

198+ "Hakyll.Core.Compiler.Internal: Alternative failed: " ++ e

199+ y

241 {-# INLINE (<|>) #-}

200 {-# INLINE (<|>) #-}

242

201

243

202

244--------------------------------------------------------------------------------

203--------------------------------------------------------------------------------

245−-- | Put the result back in a compiler

246−compilerResult :: CompilerResult a -> Compiler a

247−compilerResult x = Compiler $ \_ -> return x

248−{-# INLINE compilerResult #-}

249−

250−

251−--------------------------------------------------------------------------------

252−-- | Get the current environment

253compilerAsk :: Compiler CompilerRead

204compilerAsk :: Compiler CompilerRead

254compilerAsk = Compiler $ \r -> return $ CompilerDone r mempty

205compilerAsk = Compiler $ \r -> return $ CompilerDone r mempty

255{-# INLINE compilerAsk #-}

206{-# INLINE compilerAsk #-}

256

207

257

208

258--------------------------------------------------------------------------------

209--------------------------------------------------------------------------------

259−-- | Put a 'CompilerWrite'

260compilerTell :: CompilerWrite -> Compiler ()

210compilerTell :: CompilerWrite -> Compiler ()

261−compilerTell = compilerResult . CompilerDone ()

211+compilerTell deps = Compiler $ \_ -> return $ CompilerDone () deps

262{-# INLINE compilerTell #-}

212{-# INLINE compilerTell #-}

263

213

264

214

265--------------------------------------------------------------------------------

215--------------------------------------------------------------------------------

266−-- | Run an IO computation without dependencies in a Compiler

267−compilerUnsafeIO :: IO a -> Compiler a

268−compilerUnsafeIO io = Compiler $ \_ -> do

269− x <- io

270− return $ CompilerDone x mempty

271−{-# INLINE compilerUnsafeIO #-}

272−

273−

274−--------------------------------------------------------------------------------

275−-- | Throw errors in the 'Compiler'.

276−--

277−-- If no messages are given, this is considered a 'CompilationNoResult' error.

278−-- Otherwise, it is treated as a proper compilation failure.

279compilerThrow :: [String] -> Compiler a

216compilerThrow :: [String] -> Compiler a

280−compilerThrow = compilerResult . CompilerError .

217+compilerThrow es = Compiler $ \_ -> return $ CompilerError es

281− maybe (CompilationNoResult []) CompilationFailure .

218+{-# INLINE compilerThrow #-}

282− NonEmpty.nonEmpty

283−

284−-- | Put a 'CompilerError' with multiple messages as 'CompilationNoResult'

285−compilerNoResult :: [String] -> Compiler a

286−compilerNoResult = compilerResult . CompilerError . CompilationNoResult

287

219

288

220

289--------------------------------------------------------------------------------

221--------------------------------------------------------------------------------

290−-- | Allows to distinguish 'CompilerError's and branch on them with 'Either'

291−--

292−-- prop> compilerTry = (`compilerCatch` return . Left) . fmap Right

293−compilerTry :: Compiler a -> Compiler (Either (CompilerErrors String) a)

294−compilerTry (Compiler x) = Compiler $ \r -> do

295− res <- x r

296− case res of

297− CompilerDone res' w -> return (CompilerDone (Right res') w)

298− CompilerSnapshot s c -> return (CompilerSnapshot s (compilerTry c))

299− CompilerRequire i c -> return (CompilerRequire i (compilerTry c))

300− CompilerError e -> return (CompilerDone (Left e) mempty)

301−{-# INLINE compilerTry #-}

302−

303−

304−--------------------------------------------------------------------------------

305−-- | Allows you to recover from 'CompilerError's.

306−-- Uses the same parameter order as 'catchError' so that it can be used infix.

307−--

308−-- prop> c `compilerCatch` f = compilerTry c >>= either f return

309−compilerCatch :: Compiler a -> (CompilerErrors String -> Compiler a) -> Compiler a

222+compilerCatch :: Compiler a -> ([String] -> Compiler a) -> Compiler a

310compilerCatch (Compiler x) f = Compiler $ \r -> do

223compilerCatch (Compiler x) f = Compiler $ \r -> do

311 res <- x r

224 res <- x r

312 case res of

225 case res of

313 CompilerDone res' w -> return (CompilerDone res' w)

226 CompilerDone res' w -> return (CompilerDone res' w)

314 CompilerSnapshot s c -> return (CompilerSnapshot s (compilerCatch c f))

227 CompilerSnapshot s c -> return (CompilerSnapshot s (compilerCatch c f))

315− CompilerRequire i c -> return (CompilerRequire i (compilerCatch c f))

316 CompilerError e -> unCompiler (f e) r

228 CompilerError e -> unCompiler (f e) r

229+ CompilerRequire i c -> return (CompilerRequire i (compilerCatch c f))

317{-# INLINE compilerCatch #-}

230{-# INLINE compilerCatch #-}

318

231

319

232

320--------------------------------------------------------------------------------

233--------------------------------------------------------------------------------

321−compilerDebugLog :: [String] -> Compiler ()

234+-- | Put the result back in a compiler

322−compilerDebugLog ms = do

235+compilerResult :: CompilerResult a -> Compiler a

323− logger <- compilerLogger <$> compilerAsk

236+compilerResult x = Compiler $ \_ -> return x

324− compilerUnsafeIO $ forM_ ms $ Logger.debug logger

237+{-# INLINE compilerResult #-}

238+

325

239

326--------------------------------------------------------------------------------

240--------------------------------------------------------------------------------

327−-- | Pass a list of messages with a heading to the debug logger

241+compilerUnsafeIO :: IO a -> Compiler a

328−compilerDebugEntries :: String -> [String] -> Compiler ()

242+compilerUnsafeIO io = Compiler $ \_ -> do

329−compilerDebugEntries msg = compilerDebugLog . (msg:) . map indent

243+ x <- io

330− where

244+ return $ CompilerDone x mempty

331− indent = unlines . map (" "++) . lines

245+{-# INLINE compilerUnsafeIO #-}

332

246

333

247

334--------------------------------------------------------------------------------

248--------------------------------------------------------------------------------

335compilerTellDependencies :: [Dependency] -> Compiler ()

249compilerTellDependencies :: [Dependency] -> Compiler ()

336compilerTellDependencies ds = do

250compilerTellDependencies ds = do

337− compilerDebugLog $ map (\d ->

251+ logger <- compilerLogger <$> compilerAsk

252+ forM_ ds $ \d -> compilerUnsafeIO $ Logger.debug logger $

338− "Hakyll.Core.Compiler.Internal: Adding dependency: " ++ show d) ds

253+ "Hakyll.Core.Compiler.Internal: Adding dependency: " ++ show d

339 compilerTell mempty {compilerDependencies = ds}

254 compilerTell mempty {compilerDependencies = ds}

340{-# INLINE compilerTellDependencies #-}

255{-# INLINE compilerTellDependencies #-}

341

256

lib/Hakyll/Core/Compiler/Require.hs−2

@@ -91,7 +91,6 @@ loadBody id' = loadSnapshotBody id' final

91

92

93--------------------------------------------------------------------------------

94−-- | A shortcut for only requiring the body for a specific snapshot of an item

95loadSnapshotBody :: (Binary a, Typeable a)

94loadSnapshotBody :: (Binary a, Typeable a)

96 => Identifier -> Snapshot -> Compiler a

95 => Identifier -> Snapshot -> Compiler a

97loadSnapshotBody id' snapshot = fmap itemBody $ loadSnapshot id' snapshot

96loadSnapshotBody id' snapshot = fmap itemBody $ loadSnapshot id' snapshot

@@ -104,7 +103,6 @@ loadAll pattern = loadAllSnapshots pattern final

104

103

105

104

106--------------------------------------------------------------------------------

105--------------------------------------------------------------------------------

107−-- | Load a specific snapshot for each of dynamic list of items

108loadAllSnapshots :: (Binary a, Typeable a)

106loadAllSnapshots :: (Binary a, Typeable a)

109 => Pattern -> Snapshot -> Compiler [Item a]

107 => Pattern -> Snapshot -> Compiler [Item a]

110loadAllSnapshots pattern snapshot = do

108loadAllSnapshots pattern snapshot = do

lib/Hakyll/Core/Identifier.hs+1−1

@@ -62,7 +62,7 @@ instance Show Identifier where

62

63--------------------------------------------------------------------------------

64-- | Parse an identifier from a string

65−fromFilePath :: FilePath -> Identifier

65+fromFilePath :: String -> Identifier

66fromFilePath = Identifier Nothing .

67 intercalate "/" . filter (not . null) . split'

68 where

lib/Hakyll/Core/Logger.hs+3−9

@@ -18,7 +18,6 @@ import Control.Concurrent.Chan (Chan, newChan, readChan, writeChan)

18import Control.Concurrent.MVar (MVar, newEmptyMVar, putMVar, takeMVar)

19import Control.Monad (forever)

20import Control.Monad.Trans (MonadIO, liftIO)

21−import Data.List (intercalate)

22import Prelude hiding (error)

21import Prelude hiding (error)

23

22

24

23

@@ -80,7 +79,7 @@ string l v m

80

79

81--------------------------------------------------------------------------------

80--------------------------------------------------------------------------------

82error :: MonadIO m => Logger -> String -> m ()

81error :: MonadIO m => Logger -> String -> m ()

83−error l m = string l Error $ " [ERROR] " ++ indent m

82+error l m = string l Error $ " [ERROR] " ++ m

84

83

85

84

86--------------------------------------------------------------------------------

85--------------------------------------------------------------------------------

@@ -90,14 +89,9 @@ header l = string l Message

90

89

91--------------------------------------------------------------------------------

90--------------------------------------------------------------------------------

92message :: MonadIO m => Logger -> String -> m ()

91message :: MonadIO m => Logger -> String -> m ()

93−message l m = string l Message $ " " ++ indent m

92+message l m = string l Message $ " " ++ m

94

93

95

94

96--------------------------------------------------------------------------------

95--------------------------------------------------------------------------------

97debug :: MonadIO m => Logger -> String -> m ()

96debug :: MonadIO m => Logger -> String -> m ()

98−debug l m = string l Debug $ " [DEBUG] " ++ indent m

97+debug l m = string l Debug $ " [DEBUG] " ++ m

99−

100−

101−--------------------------------------------------------------------------------

102−indent :: String -> String

103−indent = intercalate "\n " . lines

lib/Hakyll/Core/Provider/Metadata.hs+2−3

@@ -27,7 +27,6 @@ import Hakyll.Core.Identifier

27import Hakyll.Core.Metadata

28import Hakyll.Core.Provider.Internal

29import System.IO as IO

30−import System.IO.Error (modifyIOError, ioeSetLocation)

31

30

32

31

33--------------------------------------------------------------------------------

32--------------------------------------------------------------------------------

@@ -52,7 +51,7 @@ loadMetadata p identifier = do

52--------------------------------------------------------------------------------

51--------------------------------------------------------------------------------

53loadMetadataHeader :: FilePath -> IO (Metadata, String)

52loadMetadataHeader :: FilePath -> IO (Metadata, String)

54loadMetadataHeader fp = do

53loadMetadataHeader fp = do

55− fileContent <- modifyIOError (`ioeSetLocation` "loadMetadataHeader") $ readFile fp

54+ fileContent <- readFile fp

56 case parsePage fileContent of

55 case parsePage fileContent of

57 Right x -> return x

56 Right x -> return x

58 Left err -> throwIO $ MetadataException fp err

57 Left err -> throwIO $ MetadataException fp err

@@ -61,7 +60,7 @@ loadMetadataHeader fp = do

61--------------------------------------------------------------------------------

60--------------------------------------------------------------------------------

62loadMetadataFile :: FilePath -> IO Metadata

61loadMetadataFile :: FilePath -> IO Metadata

63loadMetadataFile fp = do

62loadMetadataFile fp = do

64− fileContent <- modifyIOError (`ioeSetLocation` "loadMetadataFile") $ B.readFile fp

63+ fileContent <- B.readFile fp

65 let errOrMeta = Yaml.decodeEither' fileContent

64 let errOrMeta = Yaml.decodeEither' fileContent

66 either (fail . show) return errOrMeta

65 either (fail . show) return errOrMeta

67

66

lib/Hakyll/Core/Runtime.hs+3−3

@@ -199,9 +199,9 @@ chase trail id'

199 result <- liftIO $ runCompiler compiler read'

200 case result of

201 -- Rethrow error

202− CompilerError e -> throwError $ case compilerErrorMessages e of

202+ CompilerError [] -> throwError

203− [] -> "Compiler failed but no info given, try running with -v?"

203+ "Compiler failed but no info given, try running with -v?"

204− es -> intercalate "; " es

204+ CompilerError es -> throwError $ intercalate "; " es

205

206 -- Signal that a snapshot was saved ->

207 CompilerSnapshot snapshot c -> do

lib/Hakyll/Core/Store.hs+23−26

@@ -16,6 +16,7 @@ module Hakyll.Core.Store

16

17

18--------------------------------------------------------------------------------

19+import Control.Exception (IOException, handle)

19import qualified Crypto.Hash.MD5 as MD5

20import qualified Crypto.Hash.MD5 as MD5

20import Data.Binary (Binary, decode, encodeFile)

21import Data.Binary (Binary, decode, encodeFile)

21import qualified Data.ByteString as B

22import qualified Data.ByteString as B

@@ -26,13 +27,11 @@ import Data.Maybe (isJust)

26import qualified Data.Text as T

27import qualified Data.Text as T

27import qualified Data.Text.Encoding as T

28import qualified Data.Text.Encoding as T

28import Data.Typeable (TypeRep, Typeable, cast, typeOf)

29import Data.Typeable (TypeRep, Typeable, cast, typeOf)

29−import Numeric (showHex)

30import System.Directory (createDirectoryIfMissing)

31import System.Directory (doesFileExist, removeFile)

32import System.FilePath ((</>))

33import System.IO (IOMode (..), hClose, openFile)

34−import System.IO.Error (catchIOError, ioeSetFileName,

34+import Text.Printf (printf)

35− ioeSetLocation, modifyIOError)

36

35

37

36

38--------------------------------------------------------------------------------

37--------------------------------------------------------------------------------

@@ -85,14 +84,6 @@ new inMemory directory = do

85 where

84 where

86 csize = Just 500

85 csize = Just 500

87

86

88−--------------------------------------------------------------------------------

89−withStore :: Store -> String -> (String -> FilePath -> IO a) -> [String] -> IO a

90−withStore store loc run identifier = modifyIOError handle $ run key path

91− where

92− key = hash identifier

93− path = storeDirectory store </> key

94− handle e = e `ioeSetFileName` (path ++ " for " ++ intercalate "/" identifier)

95− `ioeSetLocation` ("Store." ++ loc)

96

87

97--------------------------------------------------------------------------------

88--------------------------------------------------------------------------------

98-- | Auxiliary: add an item to the in-memory cache

89-- | Auxiliary: add an item to the in-memory cache

@@ -133,16 +124,17 @@ cacheDelete (Store _ (Just lru)) key = do

133--------------------------------------------------------------------------------

124--------------------------------------------------------------------------------

134-- | Store an item

125-- | Store an item

135set :: (Binary a, Typeable a) => Store -> [String] -> a -> IO ()

126set :: (Binary a, Typeable a) => Store -> [String] -> a -> IO ()

136−set store identifier value = withStore store "set" (\key path -> do

127+set store identifier value = do

137− encodeFile path value

128+ encodeFile (storeDirectory store </> key) value

138 cacheInsert store key value

129 cacheInsert store key value

130+ where

139− ) identifier

131+ key = hash identifier

140

132

141

133

142--------------------------------------------------------------------------------

134--------------------------------------------------------------------------------

143-- | Load an item

135-- | Load an item

144get :: (Binary a, Typeable a) => Store -> [String] -> IO (Result a)

136get :: (Binary a, Typeable a) => Store -> [String] -> IO (Result a)

145−get store = withStore store "get" $ \key path -> do

137+get store identifier = do

146 -- First check the in-memory map

138 -- First check the in-memory map

147 ref <- cacheLookup store key

139 ref <- cacheLookup store key

148 case ref of

140 case ref of

@@ -154,14 +146,17 @@ get store = withStore store "get" $ \key path -> do

154 then return NotFound

146 then return NotFound

155 -- Found in the filesystem

147 -- Found in the filesystem

156 else do

148 else do

157− v <- decodeClose path

149+ v <- decodeClose

158 cacheInsert store key v

150 cacheInsert store key v

159 return $ Found v

151 return $ Found v

160 -- Found in the in-memory map (or wrong type), just return

152 -- Found in the in-memory map (or wrong type), just return

161 s -> return s

153 s -> return s

162 where

154 where

155+ key = hash identifier

156+ path = storeDirectory store </> key

157+

163 -- 'decodeFile' from Data.Binary which closes the file ASAP

158 -- 'decodeFile' from Data.Binary which closes the file ASAP

164− decodeClose path = do

159+ decodeClose = do

165 h <- openFile path ReadMode

160 h <- openFile path ReadMode

166 lbs <- BL.hGetContents h

161 lbs <- BL.hGetContents h

167 BL.length lbs `seq` hClose h

162 BL.length lbs `seq` hClose h

@@ -171,30 +166,32 @@ get store = withStore store "get" $ \key path -> do

171--------------------------------------------------------------------------------

166--------------------------------------------------------------------------------

172-- | Strict function

167-- | Strict function

173isMember :: Store -> [String] -> IO Bool

168isMember :: Store -> [String] -> IO Bool

174−isMember store = withStore store "isMember" $ \key path -> do

169+isMember store identifier = do

175 inCache <- cacheIsMember store key

170 inCache <- cacheIsMember store key

176 if inCache then return True else doesFileExist path

171 if inCache then return True else doesFileExist path

172+ where

173+ key = hash identifier

174+ path = storeDirectory store </> key

177

175

178

176

179--------------------------------------------------------------------------------

177--------------------------------------------------------------------------------

180-- | Delete an item

178-- | Delete an item

181delete :: Store -> [String] -> IO ()

179delete :: Store -> [String] -> IO ()

182−delete store = withStore store "delete" $ \key path -> do

180+delete store identifier = do

183 cacheDelete store key

181 cacheDelete store key

184− deleteFile path

182+ deleteFile $ storeDirectory store </> key

183+ where

184+ key = hash identifier

185

186

187--------------------------------------------------------------------------------

188-- | Delete a file unless it doesn't exist...

189deleteFile :: FilePath -> IO ()

190−deleteFile = (`catchIOError` \_ -> return ()) . removeFile

190+deleteFile = handle (\(_ :: IOException) -> return ()) . removeFile

191

192

193--------------------------------------------------------------------------------

194-- | Mostly meant for internal usage

195hash :: [String] -> String

196+hash = concatMap (printf "%02x") . B.unpack .

196−hash = toHex . B.unpack . MD5.hash . T.encodeUtf8 . T.pack . intercalate "/"

197+ MD5.hash . T.encodeUtf8 . T.pack . intercalate "/"

197− where

198− toHex [] = ""

199− toHex (x : xs) | x < 16 = '0' : showHex x (toHex xs)

200− | otherwise = showHex x (toHex xs)

lib/Hakyll/Core/Util/Parser.hs+1

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

2-- | Parser utilities

3module Hakyll.Core.Util.Parser

4 ( metadataKey

5+ , reservedKeys

5 ) where

6 ) where

6

7

8

lib/Hakyll/Preview/Poll.hs+18−8

@@ -14,7 +14,8 @@ import Control.Exception (AsyncException, fromException,

14import Control.Monad (forever, void, when)

15import System.Directory (canonicalizePath)

16import System.FilePath (pathSeparators)

17−import qualified System.FSNotify as FSNotify

17+import System.FSNotify (Event (..), startManager,

18+ watchTree)

18

19

19#ifdef mingw32_HOST_OS

20#ifdef mingw32_HOST_OS

20import Control.Concurrent (threadDelay)

21import Control.Concurrent (threadDelay)

@@ -43,12 +44,12 @@ watchUpdates conf update = do

43 shouldBuild <- newEmptyMVar

44 shouldBuild <- newEmptyMVar

44 pattern <- update

45 pattern <- update

45 fullProviderDir <- canonicalizePath $ providerDirectory conf

46 fullProviderDir <- canonicalizePath $ providerDirectory conf

46− manager <- FSNotify.startManager

47+ manager <- startManager

47

48

48 let allowed event = do

49 let allowed event = do

49 -- Absolute path of the changed file. This must be inside provider

50 -- Absolute path of the changed file. This must be inside provider

50 -- dir, since that's the only dir we're watching.

51 -- dir, since that's the only dir we're watching.

51− let path = FSNotify.eventPath event

52+ let path = eventPath event

52 relative = dropWhile (`elem` pathSeparators) $

53 relative = dropWhile (`elem` pathSeparators) $

53 drop (length fullProviderDir) path

54 drop (length fullProviderDir) path

54 identifier = fromFilePath relative

55 identifier = fromFilePath relative

@@ -68,7 +69,7 @@ watchUpdates conf update = do

68

69

69 -- Send an event whenever something occurs so that the thread described

70 -- Send an event whenever something occurs so that the thread described

70 -- above will do a build.

71 -- above will do a build.

71− void $ FSNotify.watchTree manager providerDir (not . isRemove) $ \event -> do

72+ void $ watchTree manager providerDir (not . isRemove) $ \event -> do

72 allowed' <- allowed event

73 allowed' <- allowed event

73 when allowed' $ void $ tryPutMVar shouldBuild event

74 when allowed' $ void $ tryPutMVar shouldBuild event

74 where

75 where

@@ -76,7 +77,7 @@ watchUpdates conf update = do

76 update' _ _ = void update

77 update' _ _ = void update

77#else

78#else

78 update' event provider = do

79 update' event provider = do

79− let path = provider </> FSNotify.eventPath event

80+ let path = provider </> eventPath event

80 -- on windows, a 'Modified' event is also sent on file deletion

81 -- on windows, a 'Modified' event is also sent on file deletion

81 fileExists <- doesFileExist path

82 fileExists <- doesFileExist path

82

83

@@ -104,6 +105,15 @@ watchUpdates conf update = do

104

105

106

106--------------------------------------------------------------------------------

107--------------------------------------------------------------------------------

108+eventPath :: Event -> FilePath

109+eventPath evt = evtPath evt

110+ where

111+ evtPath (Added p _) = p

112+ evtPath (Modified p _) = p

113+ evtPath (Removed p _) = p

114+

115+

116+--------------------------------------------------------------------------------

107−isRemove :: FSNotify.Event -> Bool

117+isRemove :: Event -> Bool

108−isRemove (FSNotify.Removed {}) = True

118+isRemove (Removed _ _) = True

109−isRemove _ = False

119+isRemove _ = False

lib/Hakyll/Web/Feed.hs+32−50

@@ -1,5 +1,4 @@

1−{-# LANGUAGE OverloadedStrings #-}

2−{-# LANGUAGE TemplateHaskell #-}

1+{-# LANGUAGE TemplateHaskell #-}

3

2

4--------------------------------------------------------------------------------

3--------------------------------------------------------------------------------

5-- | A Module that allows easy rendering of RSS feeds.

4-- | A Module that allows easy rendering of RSS feeds.

@@ -23,8 +22,6 @@ module Hakyll.Web.Feed

23 ( FeedConfiguration (..)

22 ( FeedConfiguration (..)

24 , renderRss

23 , renderRss

25 , renderAtom

24 , renderAtom

26− , renderRssWithTemplates

27− , renderAtomWithTemplates

28 ) where

25 ) where

29

26

30

27

@@ -38,25 +35,27 @@ import Hakyll.Web.Template.List

38

35

39

36

40--------------------------------------------------------------------------------

37--------------------------------------------------------------------------------

41−import Data.FileEmbed (makeRelativeToProject)

38+import Data.FileEmbed (embedFile)

39+import qualified Data.Text as T

40+import qualified Data.Text.Encoding as T

42

41

43

42

44--------------------------------------------------------------------------------

43--------------------------------------------------------------------------------

45−rssTemplate :: Template

44+rssTemplate :: String

46−rssTemplate =

45+rssTemplate = T.unpack $

47− $(makeRelativeToProject "data/templates/rss.xml" >>= embedTemplate)

46+ T.decodeUtf8 $(embedFile "data/templates/rss.xml")

48

47

49−rssItemTemplate :: Template

48+rssItemTemplate :: String

50−rssItemTemplate =

49+rssItemTemplate = T.unpack $

51− $(makeRelativeToProject "data/templates/rss-item.xml" >>= embedTemplate)

50+ T.decodeUtf8 $(embedFile "data/templates/rss-item.xml")

52

51

53−atomTemplate :: Template

52+atomTemplate :: String

54−atomTemplate =

53+atomTemplate = T.unpack $

55− $(makeRelativeToProject "data/templates/atom.xml" >>= embedTemplate)

54+ T.decodeUtf8 $(embedFile "data/templates/atom.xml")

56

55

57−atomItemTemplate :: Template

56+atomItemTemplate :: String

58−atomItemTemplate =

57+atomItemTemplate = T.unpack $

59− $(makeRelativeToProject "data/templates/atom-item.xml" >>= embedTemplate)

58+ T.decodeUtf8 $(embedFile "data/templates/atom-item.xml")

60

59

61

60

62--------------------------------------------------------------------------------

61--------------------------------------------------------------------------------

@@ -77,13 +76,16 @@ data FeedConfiguration = FeedConfiguration

77

76

78--------------------------------------------------------------------------------

77--------------------------------------------------------------------------------

79-- | Abstract function to render any feed.

78-- | Abstract function to render any feed.

80−renderFeed :: Template -- ^ Default feed template

79+renderFeed :: String -- ^ Default feed template

81− -> Template -- ^ Default item template

80+ -> String -- ^ Default item template

82 -> FeedConfiguration -- ^ Feed configuration

81 -> FeedConfiguration -- ^ Feed configuration

83 -> Context String -- ^ Context for the items

82 -> Context String -- ^ Context for the items

84 -> [Item String] -- ^ Input items

83 -> [Item String] -- ^ Input items

85 -> Compiler (Item String) -- ^ Resulting item

84 -> Compiler (Item String) -- ^ Resulting item

86−renderFeed feedTpl itemTpl config itemContext items = do

85+renderFeed defFeed defItem config itemContext items = do

86+ feedTpl <- readTemplateFile defFeed

87+ itemTpl <- readTemplateFile defItem

88+

87 protectedItems <- mapM (applyFilter protectCDATA) items

89 protectedItems <- mapM (applyFilter protectCDATA) items

88 body <- makeItem =<< applyTemplateList itemTpl itemContext' protectedItems

90 body <- makeItem =<< applyTemplateList itemTpl itemContext' protectedItems

89 applyTemplate feedTpl feedContext body

91 applyTemplate feedTpl feedContext body

@@ -117,35 +119,11 @@ renderFeed feedTpl itemTpl config itemContext items = do

117 updatedField = field "updated" $ \_ -> case items of

119 updatedField = field "updated" $ \_ -> case items of

118 [] -> return "Unknown"

120 [] -> return "Unknown"

119 (x : _) -> unContext itemContext' "updated" [] x >>= \cf -> case cf of

121 (x : _) -> unContext itemContext' "updated" [] x >>= \cf -> case cf of

122+ ListField _ _ -> fail "Hakyll.Web.Feed.renderFeed: Internal error"

120 StringField s -> return s

123 StringField s -> return s

121− _ -> fail "Hakyll.Web.Feed.renderFeed: Internal error"

122

124

123−--------------------------------------------------------------------------------

125+ readTemplateFile :: String -> Compiler Template

124−-- | Render an RSS feed using given templates with a number of items.

126+ readTemplateFile value = pure $ template $ readTemplateElems value

125−renderRssWithTemplates ::

126− Template -- ^ Feed template

127− -> Template -- ^ Item template

128− -> FeedConfiguration -- ^ Feed configuration

129− -> Context String -- ^ Item context

130− -> [Item String] -- ^ Feed items

131− -> Compiler (Item String) -- ^ Resulting feed

132−renderRssWithTemplates feedTemplate itemTemplate config context = renderFeed

133− feedTemplate itemTemplate config

134− (makeItemContext "%a, %d %b %Y %H:%M:%S UT" context)

135−

136−

137−--------------------------------------------------------------------------------

138−-- | Render an Atom feed using given templates with a number of items.

139−renderAtomWithTemplates ::

140− Template -- ^ Feed template

141− -> Template -- ^ Item template

142− -> FeedConfiguration -- ^ Feed configuration

143− -> Context String -- ^ Item context

144− -> [Item String] -- ^ Feed items

145− -> Compiler (Item String) -- ^ Resulting feed

146−renderAtomWithTemplates feedTemplate itemTemplate config context = renderFeed

147− feedTemplate itemTemplate config

148− (makeItemContext "%Y-%m-%dT%H:%M:%SZ" context)

149

127

150

128

151--------------------------------------------------------------------------------

129--------------------------------------------------------------------------------

@@ -154,7 +132,9 @@ renderRss :: FeedConfiguration -- ^ Feed configuration

154 -> Context String -- ^ Item context

132 -> Context String -- ^ Item context

155 -> [Item String] -- ^ Feed items

133 -> [Item String] -- ^ Feed items

156 -> Compiler (Item String) -- ^ Resulting feed

134 -> Compiler (Item String) -- ^ Resulting feed

135+renderRss config context = renderFeed

157−renderRss = renderRssWithTemplates rssTemplate rssItemTemplate

136+ rssTemplate rssItemTemplate config

137+ (makeItemContext "%a, %d %b %Y %H:%M:%S UT" context)

158

138

159

139

160--------------------------------------------------------------------------------

140--------------------------------------------------------------------------------

@@ -163,11 +143,13 @@ renderAtom :: FeedConfiguration -- ^ Feed configuration

163 -> Context String -- ^ Item context

143 -> Context String -- ^ Item context

164 -> [Item String] -- ^ Feed items

144 -> [Item String] -- ^ Feed items

165 -> Compiler (Item String) -- ^ Resulting feed

145 -> Compiler (Item String) -- ^ Resulting feed

146+renderAtom config context = renderFeed

166−renderAtom = renderAtomWithTemplates atomTemplate atomItemTemplate

147+ atomTemplate atomItemTemplate config

148+ (makeItemContext "%Y-%m-%dT%H:%M:%SZ" context)

167

149

168

150

169--------------------------------------------------------------------------------

151--------------------------------------------------------------------------------

170-- | Copies @$updated$@ from @$published$@ if it is not already set.

152-- | Copies @$updated$@ from @$published$@ if it is not already set.

171makeItemContext :: String -> Context a -> Context a

153makeItemContext :: String -> Context a -> Context a

172makeItemContext fmt context = mconcat

154makeItemContext fmt context = mconcat

173− [context, dateField "published" fmt, dateField "updated" fmt]

155+ [dateField "published" fmt, context, dateField "updated" fmt]

lib/Hakyll/Web/Html.hs+1−1

@@ -59,7 +59,7 @@ demoteHeaders = withTags $ \tag -> case tag of

59

60--------------------------------------------------------------------------------

61isUrlAttribute :: String -> Bool

62−isUrlAttribute = (`elem` ["src", "href", "data", "poster", "srcset"])

62+isUrlAttribute = (`elem` ["src", "href", "data", "poster"])

63

64

65--------------------------------------------------------------------------------

lib/Hakyll/Web/Pandoc/Biblio.hs+5−13

@@ -25,19 +25,17 @@ module Hakyll.Web.Pandoc.Biblio

25--------------------------------------------------------------------------------

26import Control.Monad (liftM, replicateM)

27import Data.Binary (Binary (..))

28+import Data.Default (def)

28import Data.Typeable (Typeable)

29import Data.Typeable (Typeable)

29import Hakyll.Core.Compiler

30import Hakyll.Core.Compiler

30−import Hakyll.Core.Compiler.Internal

31import Hakyll.Core.Identifier

32import Hakyll.Core.Item

33−import Hakyll.Core.Provider

34import Hakyll.Core.Writable

33import Hakyll.Core.Writable

35import Hakyll.Web.Pandoc

34import Hakyll.Web.Pandoc

36import Hakyll.Web.Pandoc.Binary ()

35import Hakyll.Web.Pandoc.Binary ()

37import qualified Text.CSL as CSL

36import qualified Text.CSL as CSL

38import Text.CSL.Pandoc (processCites)

37import Text.CSL.Pandoc (processCites)

39−import Text.Pandoc (Pandoc, ReaderOptions (..),

38+import Text.Pandoc (Pandoc, ReaderOptions (..))

40− enableExtension, Extension (..))

41

39

42

40

43--------------------------------------------------------------------------------

41--------------------------------------------------------------------------------

@@ -85,7 +83,7 @@ instance Writable Biblio where

85--------------------------------------------------------------------------------

83--------------------------------------------------------------------------------

86biblioCompiler :: Compiler (Item Biblio)

84biblioCompiler :: Compiler (Item Biblio)

87biblioCompiler = do

85biblioCompiler = do

88− filePath <- getResourceFilePath

86+ filePath <- toFilePath <$> getUnderlying

89 makeItem =<< unsafeCompiler (Biblio <$> CSL.readBiblioFile idpred filePath)

87 makeItem =<< unsafeCompiler (Biblio <$> CSL.readBiblioFile idpred filePath)

90 where

88 where

91 -- This is a filter on citations. We include all citations.

89 -- This is a filter on citations. We include all citations.

@@ -100,9 +98,7 @@ readPandocBiblio :: ReaderOptions

100 -> Compiler (Item Pandoc)

98 -> Compiler (Item Pandoc)

101readPandocBiblio ropt csl biblio item = do

99readPandocBiblio ropt csl biblio item = do

102 -- Parse CSL file, if given

100 -- Parse CSL file, if given

103− provider <- compilerProvider <$> compilerAsk

104− style <- unsafeCompiler $

105− CSL.readCSLFile Nothing . (resourceFilePath provider) . itemIdentifier $ csl

101+ style <- unsafeCompiler $ CSL.readCSLFile Nothing . toFilePath . itemIdentifier $ csl

106

102

107 -- We need to know the citation keys, add then *before* actually parsing the

103 -- We need to know the citation keys, add then *before* actually parsing the

108 -- actual page. If we don't do this, pandoc won't even consider them

104 -- actual page. If we don't do this, pandoc won't even consider them

@@ -119,8 +115,4 @@ pandocBiblioCompiler cslFileName bibFileName = do

119 csl <- load $ fromFilePath cslFileName

115 csl <- load $ fromFilePath cslFileName

120 bib <- load $ fromFilePath bibFileName

116 bib <- load $ fromFilePath bibFileName

121 liftM writePandoc

117 liftM writePandoc

122− (getResourceBody >>= readPandocBiblio ropt csl bib)

118+ (getResourceBody >>= readPandocBiblio def csl bib)

123− where ropt = defaultHakyllReaderOptions

124− { -- The following option enables citation rendering

125− readerExtensions = enableExtension Ext_citations $ readerExtensions defaultHakyllReaderOptions

126− }

lib/Hakyll/Web/Tags.hs+1−2

@@ -43,7 +43,6 @@

43module Hakyll.Web.Tags

44 ( Tags (..)

45 , getTags

46− , getCategory

47 , buildTagsWith

46 , buildTagsWith

48 , buildTags

47 , buildTags

49 , buildCategories

48 , buildCategories

@@ -113,7 +112,7 @@ getTags identifier = do

113

112

114

113

115--------------------------------------------------------------------------------

114--------------------------------------------------------------------------------

116−-- | Obtain category from a page.

115+-- | Obtain categories from a page.

117getCategory :: MonadMetadata m => Identifier -> m [String]

116getCategory :: MonadMetadata m => Identifier -> m [String]

118getCategory = return . return . takeBaseName . takeDirectory . toFilePath

117getCategory = return . return . takeBaseName . takeDirectory . toFilePath

119

118

lib/Hakyll/Web/Template.hs+2−24

@@ -138,41 +138,19 @@

138-- > 3...2...1

139-- > </p>

140--

141−{-# LANGUAGE TemplateHaskell #-}

142module Hakyll.Web.Template

141module Hakyll.Web.Template

143 ( Template

142 ( Template

143+ , template

144+ , readTemplateElems

144 , templateBodyCompiler

145 , templateBodyCompiler

145 , templateCompiler

146 , templateCompiler

146 , applyTemplate

147 , applyTemplate

147 , loadAndApplyTemplate

148 , loadAndApplyTemplate

148 , applyAsTemplate

149 , applyAsTemplate

149 , readTemplate

150 , readTemplate

150− , compileTemplateItem

151 , unsafeReadTemplateFile

152− , embedTemplate

153 ) where

152 ) where

154

153

155

154

156--------------------------------------------------------------------------------

155--------------------------------------------------------------------------------

157import Hakyll.Web.Template.Internal

156import Hakyll.Web.Template.Internal

158−

159−

160−--------------------------------------------------------------------------------

161−import Data.FileEmbed (embedFile)

162−import qualified Data.Text as T

163−import qualified Data.Text.Encoding as T

164−import Language.Haskell.TH (Exp, Q)

165−

166−

167−--------------------------------------------------------------------------------

168−-- | Embed template allows you embed a template within the Haskell binary.

169−-- Example:

170−--

171−-- > myTemplate :: Template

172−-- > myTemplate = $(embedTemplate "test.html")

173−embedTemplate :: FilePath -> Q Exp

174−embedTemplate filePath = [|

175− let source = T.unpack $ T.decodeUtf8 $(embedFile filePath) in

176− case parseTemplateElemsFile filePath source of

177− Left err -> error err

178− Right tpl -> template filePath tpl |]

lib/Hakyll/Web/Template/Context.hs+33−123

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

1−-- | This module provides 'Context's which are used to expand expressions in

2−-- templates and allow for arbitrary customisation.

3−--

4−-- 'Template's define a small expression DSL which consists of strings,

5−-- identifiers and function application. There is no type system, every value is

6−-- a string and on the top level they get substituted verbatim into the page.

7−--

8−-- For example, you can build a context that contains

9−--

10−-- > … <> functionField "concat" (const . concat) <> …

11−--

12−-- which will allow you to use the @concat@ identifier as a function that takes

13−-- arbitrarily many stings and concatenates them to a new string:

14−--

15−-- > $partial(concat("templates/categories/", category))$

16−--

17−-- This will evaluate the @category@ field in the context, then prepend he path,

18−-- and include the referenced file as a template.

19−

20−

21--------------------------------------------------------------------------------

1--------------------------------------------------------------------------------

22{-# LANGUAGE CPP #-}

2{-# LANGUAGE CPP #-}

23{-# LANGUAGE ExistentialQuantification #-}

3{-# LANGUAGE ExistentialQuantification #-}

24−{-# LANGUAGE RankNTypes #-}

25module Hakyll.Web.Template.Context

4module Hakyll.Web.Template.Context

26 ( ContextField (..)

5 ( ContextField (..)

27 , Context (..)

6 , Context (..)

@@ -49,14 +28,13 @@ module Hakyll.Web.Template.Context

49 , teaserField

28 , teaserField

50 , teaserFieldWithSeparator

29 , teaserFieldWithSeparator

51 , missingField

30 , missingField

52− , bindItem

53 ) where

31 ) where

54

32

55

33

56--------------------------------------------------------------------------------

34--------------------------------------------------------------------------------

57import Control.Applicative (Alternative (..))

35import Control.Applicative (Alternative (..))

58import Control.Monad (msum)

36import Control.Monad (msum)

59−import Data.List (intercalate, tails)

37+import Data.List (intercalate)

60#if MIN_VERSION_base(4,9,0)

38#if MIN_VERSION_base(4,9,0)

61import Data.Semigroup (Semigroup (..))

39import Data.Semigroup (Semigroup (..))

62#endif

40#endif

@@ -72,16 +50,13 @@ import Hakyll.Core.Metadata

72import Hakyll.Core.Provider

50import Hakyll.Core.Provider

73import Hakyll.Core.Util.String (needlePrefix, splitAll)

51import Hakyll.Core.Util.String (needlePrefix, splitAll)

74import Hakyll.Web.Html

52import Hakyll.Web.Html

75−import Prelude hiding (id)

76−import System.FilePath (dropExtension, splitDirectories,

53+import System.FilePath (splitDirectories, takeBaseName)

77− takeBaseName)

78

54

79

55

80--------------------------------------------------------------------------------

56--------------------------------------------------------------------------------

81-- | Mostly for internal usage

57-- | Mostly for internal usage

82data ContextField

58data ContextField

83− = EmptyField

84− | StringField String

59+ = StringField String

85 | forall a. ListField (Context a) [Item a]

60 | forall a. ListField (Context a) [Item a]

86

61

87

62

@@ -106,8 +81,6 @@ newtype Context a = Context

106

81

107

82

108--------------------------------------------------------------------------------

83--------------------------------------------------------------------------------

109−-- | Tries to find a key in the left context,

110−-- or when that fails in the right context.

111#if MIN_VERSION_base(4,9,0)

84#if MIN_VERSION_base(4,9,0)

112instance Semigroup (Context a) where

85instance Semigroup (Context a) where

113 (<>) (Context f) (Context g) = Context $ \k a i -> f k a i <|> g k a i

86 (<>) (Context f) (Context g) = Context $ \k a i -> f k a i <|> g k a i

@@ -124,105 +97,64 @@ instance Monoid (Context a) where

124

97

125--------------------------------------------------------------------------------

98--------------------------------------------------------------------------------

126field' :: String -> (Item a -> Compiler ContextField) -> Context a

99field' :: String -> (Item a -> Compiler ContextField) -> Context a

127−field' key value = Context $ \k _ i ->

100+field' key value = Context $ \k _ i -> if k == key then value i else empty

128− if k == key

129− then value i

130− else noResult $ "Tried field " ++ key

131

101

132

102

133--------------------------------------------------------------------------------

103--------------------------------------------------------------------------------

134−-- | Constructs a new field for a 'Context'.

104+-- | Constructs a new field in the 'Context.'

135−-- If the key matches, the compiler is run and its result is substituted in the

136−-- template.

137−--

138−-- If the compiler fails, the field will be considered non-existent

139−-- in an @$if()$@ macro or ultimately break the template application

140−-- (unless the key is found in another context when using '<>').

141−-- Use 'empty' or 'noResult' for intentional failures of fields used in

142−-- @$if()$@, to distinguish them from exceptions thrown with 'fail'.

143field

105field

144 :: String -- ^ Key

106 :: String -- ^ Key

145 -> (Item a -> Compiler String) -- ^ Function that constructs a value based

107 -> (Item a -> Compiler String) -- ^ Function that constructs a value based

146− -- on the item (e.g. accessing metadata)

108+ -- on the item

147 -> Context a

109 -> Context a

148field key value = field' key (fmap StringField . value)

110field key value = field' key (fmap StringField . value)

149

111

150

112

151--------------------------------------------------------------------------------

113--------------------------------------------------------------------------------

152-- | Creates a 'field' to use with the @$if()$@ template macro.

114-- | Creates a 'field' to use with the @$if()$@ template macro.

153−-- Attempting to substitute the field into the template will cause an error.

154boolField

115boolField

155 :: String

116 :: String

156 -> (Item a -> Bool)

117 -> (Item a -> Bool)

157 -> Context a

118 -> Context a

158−boolField name f = field' name (\i -> if f i

119+boolField name f = field name (\i -> if f i

159− then return EmptyField

120+ then pure (error $ unwords ["no string value for bool field:",name])

160− else noResult $ "Field " ++ name ++ " is false")

121+ else empty)

161

122

162

123

163--------------------------------------------------------------------------------

124--------------------------------------------------------------------------------

164−-- | Creates a 'field' that does not depend on the 'Item' but always yields

125+-- | Creates a 'field' that does not depend on the 'Item'

165−-- the same string

166−constField :: String -- ^ Key

126+constField :: String -> String -> Context a

167− -> String -- ^ Value

168− -> Context a

169constField key = field key . const . return

127constField key = field key . const . return

170

128

171

129

172--------------------------------------------------------------------------------

130--------------------------------------------------------------------------------

173−-- | Creates a list field to be consumed by a @$for(…)$@ expression.

174−-- The compiler returns multiple items which are rendered in the loop body

175−-- with the supplied context.

176listField :: String -> Context a -> Compiler [Item a] -> Context b

131listField :: String -> Context a -> Compiler [Item a] -> Context b

177listField key c xs = listFieldWith key c (const xs)

132listField key c xs = listFieldWith key c (const xs)

178

133

179

134

180--------------------------------------------------------------------------------

135--------------------------------------------------------------------------------

181−-- | Produces a new 'Context' which has list field 'key'. All fields from

182−-- 'c' are also accessible from the produced context.

183−-- Be careful when doing @listFieldWith k ca f <> cb@ as any fields in @ca@

184−-- will override fields in @cb@ with the same name.

185−-- Creates a list field like 'listField', but supplies the current page

186−-- to the compiler.

187listFieldWith

136listFieldWith

188 :: String -> Context a -> (Item b -> Compiler [Item a]) -> Context b

137 :: String -> Context a -> (Item b -> Compiler [Item a]) -> Context b

189listFieldWith key c f = field' key $ fmap (ListField c) . f

138listFieldWith key c f = field' key $ fmap (ListField c) . f

190

139

191

140

192--------------------------------------------------------------------------------

141--------------------------------------------------------------------------------

193−-- | Creates a variadic function field.

194−--

195−-- The function will be called with the dynamically evaluated string arguments

196−-- from the template as well as the page that is currently rendered.

197−functionField :: String -- ^ Key

198− -> ([String] -> Item a -> Compiler String) -- ^ Function

142+functionField :: String -> ([String] -> Item a -> Compiler String) -> Context a

199− -> Context a

200functionField name value = Context $ \k args i ->

143functionField name value = Context $ \k args i ->

201 if k == name

144 if k == name

202 then StringField <$> value args i

145 then StringField <$> value args i

203− else noResult $ "Tried function field " ++ name

146+ else empty

204

147

205

148

206--------------------------------------------------------------------------------

149--------------------------------------------------------------------------------

207−-- | Transform the respective string results of all fields in a context.

208−-- For example,

209−--

210−-- > mapContext (++"c") (constField "x" "a" <> constField "y" "b")

211−--

212−-- is equivalent to

213−--

214−-- > constField "x" "ac" <> constField "y" "bc"

215−--

216mapContext :: (String -> String) -> Context a -> Context a

150mapContext :: (String -> String) -> Context a -> Context a

217mapContext f (Context c) = Context $ \k a i -> do

151mapContext f (Context c) = Context $ \k a i -> do

218 fld <- c k a i

152 fld <- c k a i

219 case fld of

153 case fld of

220− EmptyField -> wrongType "boolField"

221 StringField str -> return $ StringField (f str)

154 StringField str -> return $ StringField (f str)

222− _ -> wrongType "ListField"

155+ ListField _ _ -> fail $

223− where

224− wrongType typ = fail $ "Hakyll.Web.Template.Context.mapContext: " ++

156+ "Hakyll.Web.Template.Context.mapContext: " ++

225− "can't map over a " ++ typ ++ "!"

157+ "can't map over a ListField!"

226

158

227--------------------------------------------------------------------------------

159--------------------------------------------------------------------------------

228-- | A context that allows snippet inclusion. In processed file, use as:

160-- | A context that allows snippet inclusion. In processed file, use as:

@@ -231,15 +163,15 @@ mapContext f (Context c) = Context $ \k a i -> do

231-- > $snippet("path/to/snippet/")$

163-- > $snippet("path/to/snippet/")$

232-- > ...

164-- > ...

233--

165--

234−-- The contents of the included file will not be interpolated like @partial@

166+-- The contents of the included file will not be interpolated.

235−-- does it.

236--

167--

237snippetField :: Context String

168snippetField :: Context String

238snippetField = functionField "snippet" f

169snippetField = functionField "snippet" f

239 where

170 where

240 f [contentsPath] _ = loadBody (fromFilePath contentsPath)

171 f [contentsPath] _ = loadBody (fromFilePath contentsPath)

241− f [] _ = fail "No argument to function 'snippet()'"

172+ f _ i = error $

242− f _ _ = fail "Too many arguments to function 'snippet()'"

173+ "Too many arguments to function 'snippet()' in item " ++

174+ show (itemIdentifier i)

243

175

244--------------------------------------------------------------------------------

176--------------------------------------------------------------------------------

245-- | A context that contains (in that order)

177-- | A context that contains (in that order)

@@ -259,7 +191,8 @@ defaultContext =

259 metadataField `mappend`

191 metadataField `mappend`

260 urlField "url" `mappend`

192 urlField "url" `mappend`

261 pathField "path" `mappend`

193 pathField "path" `mappend`

262− titleField "title"

194+ titleField "title" `mappend`

195+ missingField

263

196

264

197

265--------------------------------------------------------------------------------

198--------------------------------------------------------------------------------

@@ -277,20 +210,15 @@ bodyField key = field key $ return . itemBody

277-- | Map any field to its metadata value, if present

210-- | Map any field to its metadata value, if present

278metadataField :: Context a

211metadataField :: Context a

279metadataField = Context $ \k _ i -> do

212metadataField = Context $ \k _ i -> do

280− let id = itemIdentifier i

281− empty' = noResult $ "No '" ++ k ++ "' field in metadata " ++

282− "of item " ++ show id

283− value <- getMetadataField id k

213+ value <- getMetadataField (itemIdentifier i) k

284− maybe empty' (return . StringField) value

214+ maybe empty (return . StringField) value

285

215

286

216

287--------------------------------------------------------------------------------

217--------------------------------------------------------------------------------

288-- | Absolute url to the resulting item

218-- | Absolute url to the resulting item

289urlField :: String -> Context a

219urlField :: String -> Context a

290−urlField key = field key $ \i -> do

220+urlField key = field key $

291− let id = itemIdentifier i

292− empty' = fail $ "No route url found for item " ++ show id

293− fmap (maybe empty' toUrl) $ getRoute id

221+ fmap (maybe empty toUrl) . getRoute . itemIdentifier

294

222

295

223

296--------------------------------------------------------------------------------

224--------------------------------------------------------------------------------

@@ -341,12 +269,6 @@ titleField = mapContext takeBaseName . pathField

341-- that begins with @yyyy-mm-dd@ . For example:

269-- that begins with @yyyy-mm-dd@ . For example:

342-- @folder//yyyy-mm-dd-title//dist//main.extension@ .

270-- @folder//yyyy-mm-dd-title//dist//main.extension@ .

343-- In case of multiple matches, the rightmost one is used.

271-- In case of multiple matches, the rightmost one is used.

344−--

345−-- As another alternative, if none of the above matches, and the file has a

346−-- path which contains nested directories specifying a date, then that date

347−-- will be used. In other words, if the path is of the form

348−-- @**//yyyy//mm//dd//**//main.extension@ .

349−-- As above, in case of multiple matches, the rightmost one is used.

350

272

351dateField :: String -- ^ Key in which the rendered date should be placed

273dateField :: String -- ^ Key in which the rendered date should be placed

352 -> String -- ^ Format to use on the date

274 -> String -- ^ Format to use on the date

@@ -357,7 +279,7 @@ dateField = dateFieldWith defaultTimeLocale

357--------------------------------------------------------------------------------

279--------------------------------------------------------------------------------

358-- | This is an extended version of 'dateField' that allows you to

280-- | This is an extended version of 'dateField' that allows you to

359-- specify a time locale that is used for outputting the date. For more

281-- specify a time locale that is used for outputting the date. For more

360−-- details, see 'dateField' and 'formatTime'.

282+-- details, see 'dateField'.

361dateFieldWith :: TimeLocale -- ^ Output time locale

283dateFieldWith :: TimeLocale -- ^ Output time locale

362 -> String -- ^ Destination key

284 -> String -- ^ Destination key

363 -> String -- ^ Format to use on the date

285 -> String -- ^ Format to use on the date

@@ -378,13 +300,12 @@ getItemUTC :: MonadMetadata m

378getItemUTC locale id' = do

300getItemUTC locale id' = do

379 metadata <- getMetadata id'

301 metadata <- getMetadata id'

380 let tryField k fmt = lookupString k metadata >>= parseTime' fmt

302 let tryField k fmt = lookupString k metadata >>= parseTime' fmt

381− paths = splitDirectories $ (dropExtension . toFilePath) id'

303+ paths = splitDirectories $ toFilePath id'

382

304

383 maybe empty' return $ msum $

305 maybe empty' return $ msum $

384 [tryField "published" fmt | fmt <- formats] ++

306 [tryField "published" fmt | fmt <- formats] ++

385 [tryField "date" fmt | fmt <- formats] ++

307 [tryField "date" fmt | fmt <- formats] ++

386− [parseTime' "%Y-%m-%d" $ intercalate "-" $ take 3 $ splitAll "-" fnCand | fnCand <- reverse paths] ++

308+ [parseTime' "%Y-%m-%d" $ intercalate "-" $ take 3 $ splitAll "-" fnCand | fnCand <- reverse paths]

387− [parseTime' "%Y-%m-%d" $ intercalate "-" $ fnCand | fnCand <- map (take 3) $ reverse . tails $ paths]

388 where

309 where

389 empty' = fail $ "Hakyll.Web.Template.Context.getItemUTC: " ++

310 empty' = fail $ "Hakyll.Web.Template.Context.getItemUTC: " ++

390 "could not parse time for " ++ show id'

311 "could not parse time for " ++ show id'

@@ -412,16 +333,13 @@ getItemModificationTime identifier = do

412

333

413

334

414--------------------------------------------------------------------------------

335--------------------------------------------------------------------------------

415−-- | Creates a field with the last modification date of the underlying item.

416modificationTimeField :: String -- ^ Key

336modificationTimeField :: String -- ^ Key

417 -> String -- ^ Format

337 -> String -- ^ Format

418− -> Context a -- ^ Resulting context

338+ -> Context a -- ^ Resuting context

419modificationTimeField = modificationTimeFieldWith defaultTimeLocale

339modificationTimeField = modificationTimeFieldWith defaultTimeLocale

420

340

421

341

422--------------------------------------------------------------------------------

342--------------------------------------------------------------------------------

423−-- | Creates a field with the last modification date of the underlying item

424−-- in a custom localisation format (see 'formatTime').

425modificationTimeFieldWith :: TimeLocale -- ^ Time output locale

343modificationTimeFieldWith :: TimeLocale -- ^ Time output locale

426 -> String -- ^ Key

344 -> String -- ^ Key

427 -> String -- ^ Format

345 -> String -- ^ Format

@@ -460,11 +378,10 @@ teaserFieldWithSeparator separator key snapshot = field key $ \item -> do

460

378

461

379

462--------------------------------------------------------------------------------

380--------------------------------------------------------------------------------

463−-- | Constantly reports any field as missing. Mostly for internal usage,

464−-- it is the last choice in every context used in a template application.

465missingField :: Context a

381missingField :: Context a

466−missingField = Context $ \k _ _ -> noResult $

382+missingField = Context $ \k _ i -> fail $

467− "Missing field '" ++ k ++ "' in context"

383+ "Missing field $" ++ k ++ "$ in context for item " ++

384+ show (itemIdentifier i)

468

385

469parseTimeM :: Bool -> TimeLocale -> String -> String -> Maybe UTCTime

386parseTimeM :: Bool -> TimeLocale -> String -> String -> Maybe UTCTime

470#if MIN_VERSION_time(1,5,0)

387#if MIN_VERSION_time(1,5,0)

@@ -472,10 +389,3 @@ parseTimeM = TF.parseTimeM

472#else

389#else

473parseTimeM _ = TF.parseTime

390parseTimeM _ = TF.parseTime

474#endif

391#endif

475−

476−--------------------------------------------------------------------------------

477−

478−-- | Binds an 'Item' to a given 'Context', allowing it to be combined with any

479−-- other 'Context' of any type.

480−bindItem :: Context a -> Item a -> forall b. Context b

481−bindItem (Context ctx) ia = Context $ \k args _ -> ctx k args ia

lib/Hakyll/Web/Template/Internal.hs+44−103

@@ -1,18 +1,15 @@

1−{-# LANGUAGE DeriveAnyClass #-}

2−{-# LANGUAGE DeriveGeneric #-}

3{-# LANGUAGE GeneralizedNewtypeDeriving #-}

1{-# LANGUAGE GeneralizedNewtypeDeriving #-}

4{-# LANGUAGE ScopedTypeVariables #-}

2{-# LANGUAGE ScopedTypeVariables #-}

5−

6module Hakyll.Web.Template.Internal

3module Hakyll.Web.Template.Internal

7 ( Template (..)

4 ( Template (..)

8 , template

5 , template

9 , templateBodyCompiler

6 , templateBodyCompiler

10 , templateCompiler

7 , templateCompiler

11 , applyTemplate

8 , applyTemplate

9+ , applyTemplate'

12 , loadAndApplyTemplate

10 , loadAndApplyTemplate

13 , applyAsTemplate

11 , applyAsTemplate

14 , readTemplate

12 , readTemplate

15− , compileTemplateItem

16 , unsafeReadTemplateFile

13 , unsafeReadTemplateFile

17

14

18 , module Hakyll.Web.Template.Internal.Element

15 , module Hakyll.Web.Template.Internal.Element

@@ -21,19 +18,16 @@ module Hakyll.Web.Template.Internal

21

18

22

19

23--------------------------------------------------------------------------------

20--------------------------------------------------------------------------------

24−import Control.Monad (forM)

21+import Control.Monad.Except (MonadError (..))

25−import Control.Monad.Except (MonadError (..), catchError)

26import Data.Binary (Binary)

22import Data.Binary (Binary)

27import Data.List (intercalate)

23import Data.List (intercalate)

28−import qualified Data.List.NonEmpty as NonEmpty

29import Data.Typeable (Typeable)

24import Data.Typeable (Typeable)

30import GHC.Exts (IsString (..))

25import GHC.Exts (IsString (..))

31−import GHC.Generics (Generic)

26+import Prelude hiding (id)

32

27

33

28

34--------------------------------------------------------------------------------

29--------------------------------------------------------------------------------

35import Hakyll.Core.Compiler

30import Hakyll.Core.Compiler

36−import Hakyll.Core.Compiler.Internal

37import Hakyll.Core.Identifier

31import Hakyll.Core.Identifier

38import Hakyll.Core.Item

32import Hakyll.Core.Item

39import Hakyll.Core.Writable

33import Hakyll.Core.Writable

@@ -44,10 +38,9 @@ import Hakyll.Web.Template.Internal.Trim

44

38

45--------------------------------------------------------------------------------

39--------------------------------------------------------------------------------

46-- | Datatype used for template substitutions.

40-- | Datatype used for template substitutions.

47−data Template = Template

41+newtype Template = Template

48− { tplElements :: [TemplateElement]

42+ { unTemplate :: [TemplateElement]

49− , tplOrigin :: FilePath -- Only for error messages.

50− } deriving (Show, Eq, Generic, Binary, Typeable)

43+ } deriving (Show, Eq, Binary, Typeable)

51

44

52

45

53--------------------------------------------------------------------------------

46--------------------------------------------------------------------------------

@@ -63,68 +56,39 @@ instance IsString Template where

63

56

64--------------------------------------------------------------------------------

57--------------------------------------------------------------------------------

65-- | Wrap the constructor to ensure trim is called.

58-- | Wrap the constructor to ensure trim is called.

66−template :: FilePath -> [TemplateElement] -> Template

59+template :: [TemplateElement] -> Template

67−template p = flip Template p . trim

60+template = Template . trim

68

61

69

62

70--------------------------------------------------------------------------------

63--------------------------------------------------------------------------------

71−-- | Parse a string into a template.

72−-- You should prefer 'compileTemplateItem' over this.

73readTemplate :: String -> Template

64readTemplate :: String -> Template

74−readTemplate = either error (template origin) . parseTemplateElemsFile origin

65+readTemplate = Template . trim . readTemplateElems

75− where

76− origin = "{literal}"

77−{-# DEPRECATED readTemplate "Use templateCompiler instead" #-}

78−

79−--------------------------------------------------------------------------------

80−-- | Parse an item body into a template.

81−-- Provides useful error messages in the 'Compiler' monad.

82−compileTemplateItem :: Item String -> Compiler Template

83−compileTemplateItem item = let file = itemIdentifier item

84− in compileTemplateFile file (itemBody item)

85−

86−--------------------------------------------------------------------------------

87−compileTemplateFile :: Identifier -> String -> Compiler Template

88−compileTemplateFile file = either fail (return . template origin)

89− . parseTemplateElemsFile origin

90− where

91− origin = show file

92

66

93--------------------------------------------------------------------------------

67--------------------------------------------------------------------------------

94-- | Read a template, without metadata header

68-- | Read a template, without metadata header

95templateBodyCompiler :: Compiler (Item Template)

69templateBodyCompiler :: Compiler (Item Template)

96templateBodyCompiler = cached "Hakyll.Web.Template.templateBodyCompiler" $ do

70templateBodyCompiler = cached "Hakyll.Web.Template.templateBodyCompiler" $ do

97 item <- getResourceBody

71 item <- getResourceBody

98− file <- getUnderlying

72+ file <- getResourceFilePath

99− withItemBody (compileTemplateFile file) item

73+ return $ fmap (template . readTemplateElemsFile file) item

100

74

101--------------------------------------------------------------------------------

75--------------------------------------------------------------------------------

102-- | Read complete file contents as a template

76-- | Read complete file contents as a template

103templateCompiler :: Compiler (Item Template)

77templateCompiler :: Compiler (Item Template)

104templateCompiler = cached "Hakyll.Web.Template.templateCompiler" $ do

78templateCompiler = cached "Hakyll.Web.Template.templateCompiler" $ do

105 item <- getResourceString

79 item <- getResourceString

106− file <- getUnderlying

80+ file <- getResourceFilePath

107− withItemBody (compileTemplateFile file) item

81+ return $ fmap (template . readTemplateElemsFile file) item

108

82

109

83

110--------------------------------------------------------------------------------

84--------------------------------------------------------------------------------

111−-- | Interpolate template expressions from context values in a page

112applyTemplate :: Template -- ^ Template

85applyTemplate :: Template -- ^ Template

113 -> Context a -- ^ Context

86 -> Context a -- ^ Context

114 -> Item a -- ^ Page

87 -> Item a -- ^ Page

115 -> Compiler (Item String) -- ^ Resulting item

88 -> Compiler (Item String) -- ^ Resulting item

116applyTemplate tpl context item = do

89applyTemplate tpl context item = do

117− body <- applyTemplate' (tplElements tpl) context item `catchError` handler

90+ body <- applyTemplate' (unTemplate tpl) context item

118 return $ itemSetBody body item

91 return $ itemSetBody body item

119− where

120− tplName = tplOrigin tpl

121− itemName = show $ itemIdentifier item

122− handler es = fail $ "Hakyll.Web.Template.applyTemplate: Failed to " ++

123− (if tplName == itemName

124− then "interpolate template in item " ++ itemName

125− else "apply template " ++ tplName ++ " to item " ++ itemName) ++

126− ":\n" ++ intercalate ",\n" es

127−

128

92

129

93

130--------------------------------------------------------------------------------

94--------------------------------------------------------------------------------

@@ -141,6 +105,9 @@ applyTemplate' tes context x = go tes

141

105

142 go = fmap concat . mapM applyElem

106 go = fmap concat . mapM applyElem

143

107

108+ trimError = error $ "Hakyll.Web.Template.applyTemplate: template not " ++

109+ "fully trimmed."

110+

144 ---------------------------------------------------------------------------

111 ---------------------------------------------------------------------------

145

112

146 applyElem :: TemplateElement -> Compiler String

113 applyElem :: TemplateElement -> Compiler String

@@ -151,43 +118,29 @@ applyTemplate' tes context x = go tes

151

118

152 applyElem (Chunk c) = return c

119 applyElem (Chunk c) = return c

153

120

154− applyElem (Expr e) = withErrorMessage evalMsg (applyStringExpr typeMsg e)

121+ applyElem (Expr e) = applyExpr e >>= getString e

155− where

156− evalMsg = "In expr '$" ++ show e ++ "$'"

157− typeMsg = "expr '$" ++ show e ++ "$'"

158

122

159 applyElem Escaped = return "$"

123 applyElem Escaped = return "$"

160

124

161− applyElem (If e t mf) = compilerTry (applyExpr e) >>= handle

125+ applyElem (If e t mf) = (applyExpr e >> go t) `catchError` handler

162 where

126 where

163− f = maybe (return "") go mf

127+ handler _ = case mf of

164− handle (Right _) = go t

128+ Nothing -> return ""

165− handle (Left (CompilationNoResult _)) = f

129+ Just f -> go f

166− handle (Left (CompilationFailure es)) = debug (NonEmpty.toList es) >> f

130+

167− debug = compilerDebugEntries ("Hakyll.Web.Template.applyTemplate: " ++

168− "[ERROR] in 'if' condition on expr '" ++ show e ++ "':")

169−

170− applyElem (For e b s) = withErrorMessage headMsg (applyExpr e) >>= \cf -> case cf of

131+ applyElem (For e b s) = applyExpr e >>= \cf -> case cf of

171− EmptyField -> expected "list" "boolean" typeMsg

132+ StringField _ -> fail $

172− StringField _ -> expected "list" "string" typeMsg

133+ "Hakyll.Web.Template.applyTemplateWith: expected ListField but " ++

134+ "got StringField for expr " ++ show e

173− ListField c xs -> withErrorMessage bodyMsg $ do

135+ ListField c xs -> do

174 sep <- maybe (return "") go s

136 sep <- maybe (return "") go s

175− bs <- forM xs $ applyTemplate' b $ c <> bindItem context x

137+ bs <- mapM (applyTemplate' b c) xs

176 return $ intercalate sep bs

138 return $ intercalate sep bs

177− where

139+

178− headMsg = "In expr '$for(" ++ show e ++ ")$'"

179− typeMsg = "loop expr '" ++ show e ++ "'"

180− bodyMsg = "In loop context of '$for(" ++ show e ++ ")$'"

181−

182− applyElem (Partial e) = withErrorMessage headMsg $

140+ applyElem (Partial e) = do

183− applyStringExpr typeMsg e >>= \p ->

141+ p <- applyExpr e >>= getString e

184− withErrorMessage inclMsg $ do

185− tpl' <- loadBody (fromFilePath p)

142+ Template tpl' <- loadBody (fromFilePath p)

186− itemBody <$> applyTemplate tpl' context x

143+ applyTemplate' tpl' context x

187− where

188− headMsg = "In expr '$partial(" ++ show e ++ ")$'"

189− typeMsg = "partial expr '" ++ show e ++ "'"

190− inclMsg = "In inclusion of '$partial(" ++ show e ++ ")$'"

191

144

192 ---------------------------------------------------------------------------

145 ---------------------------------------------------------------------------

193

146

@@ -196,29 +149,17 @@ applyTemplate' tes context x = go tes

196 applyExpr (Ident (TemplateKey k)) = context' k [] x

149 applyExpr (Ident (TemplateKey k)) = context' k [] x

197

150

198 applyExpr (Call (TemplateKey k) args) = do

151 applyExpr (Call (TemplateKey k) args) = do

199− args' <- mapM (\e -> applyStringExpr (typeMsg e) e) args

152+ args' <- mapM (\e -> applyExpr e >>= getString e) args

200 context' k args' x

153 context' k args' x

201− where

202− typeMsg e = "argument '" ++ show e ++ "'"

203

154

204 applyExpr (StringLiteral s) = return (StringField s)

155 applyExpr (StringLiteral s) = return (StringField s)

205

156

206 ----------------------------------------------------------------------------

157 ----------------------------------------------------------------------------

207

158

208− applyStringExpr :: String -> TemplateExpr -> Compiler String

209− applyStringExpr msg expr =

210− applyExpr expr >>= getString

211− where

212− getString EmptyField = expected "string" "boolean" msg

213− getString (StringField s) = return s

159+ getString _ (StringField s) = return s

214− getString (ListField _ _) = expected "string" "list" msg

160+ getString e (ListField _ _) = fail $

215−

161+ "Hakyll.Web.Template.applyTemplateWith: expected StringField but " ++

216− expected typ act expr = fail $ unwords ["Hakyll.Web.Template.applyTemplate:",

162+ "got ListField for expr " ++ show e

217− "expected", typ, "but got", act, "for", expr]

218−

219− -- expected to never happen with all templates constructed by 'template'

220− trimError = fail $

221− "Hakyll.Web.Template.applyTemplate: template not fully trimmed."

222

163

223

164

224--------------------------------------------------------------------------------

165--------------------------------------------------------------------------------

@@ -248,14 +189,14 @@ loadAndApplyTemplate identifier context item = do

248applyAsTemplate :: Context String -- ^ Context

189applyAsTemplate :: Context String -- ^ Context

249 -> Item String -- ^ Item and template

190 -> Item String -- ^ Item and template

250 -> Compiler (Item String) -- ^ Resulting item

191 -> Compiler (Item String) -- ^ Resulting item

251−applyAsTemplate context item = do

192+applyAsTemplate context item =

252− tpl <- compileTemplateItem item

193+ let tpl = template $ readTemplateElemsFile file (itemBody item)

194+ file = toFilePath $ itemIdentifier item

253− applyTemplate tpl context item

195+ in applyTemplate tpl context item

254

196

255

197

256--------------------------------------------------------------------------------

198--------------------------------------------------------------------------------

257unsafeReadTemplateFile :: FilePath -> Compiler Template

199unsafeReadTemplateFile :: FilePath -> Compiler Template

258unsafeReadTemplateFile file = do

200unsafeReadTemplateFile file = do

259 tpl <- unsafeCompiler $ readFile file

201 tpl <- unsafeCompiler $ readFile file

260− compileTemplateFile (fromFilePath file) tpl

202+ pure $ template $ readTemplateElemsFile file tpl

261−{-# DEPRECATED unsafeReadTemplateFile "Use templateCompiler" #-}

lib/Hakyll/Web/Template/Internal/Element.hs+14−7

@@ -7,14 +7,14 @@ module Hakyll.Web.Template.Internal.Element

7 , TemplateExpr (..)

8 , TemplateElement (..)

9 , templateElems

10− , parseTemplateElemsFile

10+ , readTemplateElems

11+ , readTemplateElemsFile

11 ) where

12 ) where

12

13

14

14--------------------------------------------------------------------------------

15--------------------------------------------------------------------------------

15−import Control.Applicative ((<|>), (<*))

16+import Control.Applicative ((<|>))

16import Control.Monad (void)

17import Control.Monad (void)

17−import Control.Arrow (left)

18import Data.Binary (Binary, get, getWord8, put, putWord8)

19import Data.List (intercalate)

20import Data.Maybe (isJust)

@@ -107,10 +107,17 @@ instance Binary TemplateExpr where

107 2 -> StringLiteral <$> get

108 _ -> error "Hakyll.Web.Template.Internal: Error reading cached template"

109

110+

111+--------------------------------------------------------------------------------

112+readTemplateElems :: String -> [TemplateElement]

113+readTemplateElems = readTemplateElemsFile "{literal}"

114+

115+

110--------------------------------------------------------------------------------

116--------------------------------------------------------------------------------

111−parseTemplateElemsFile :: FilePath -> String -> Either String [TemplateElement]

117+readTemplateElemsFile :: FilePath -> String -> [TemplateElement]

118+readTemplateElemsFile file input = case P.parse templateElems file input of

112−parseTemplateElemsFile file = left (\e -> "Cannot parse template " ++ show e)

119+ Left err -> error $ "Cannot parse template: " ++ show err

113− . P.parse (templateElems <* P.eof) file

120+ Right t -> t

114

121

115

122

116--------------------------------------------------------------------------------

123--------------------------------------------------------------------------------

@@ -160,7 +167,7 @@ trimOpen = do

160--------------------------------------------------------------------------------

167--------------------------------------------------------------------------------

161trimClose :: P.Parser Bool

168trimClose :: P.Parser Bool

162trimClose = do

169trimClose = do

163− trimIfR <- P.optionMaybe $ (P.char '-')

170+ trimIfR <- P.optionMaybe $ P.try (P.char '-')

164 void $ P.char '$'

171 void $ P.char '$'

165 pure $ isJust trimIfR

172 pure $ isJust trimIfR

166

173

src/Init.hs+4−7

@@ -6,7 +6,7 @@ module Main

6

7--------------------------------------------------------------------------------

8import Control.Arrow (first)

9−import Control.Monad (forM, forM_)

9+import Control.Monad (forM_)

10import Data.Char (isAlphaNum, isNumber)

11import Data.List (foldl', intercalate, isPrefixOf)

12import Data.Version (Version (..))

@@ -22,10 +22,6 @@ import Hakyll.Core.Util.File

22import Paths_hakyll

23

24

25−--------------------------------------------------------------------------------

26−import Prelude

27−

28−

29--------------------------------------------------------------------------------

25--------------------------------------------------------------------------------

30main :: IO ()

26main :: IO ()

31main = do

27main = do

@@ -70,16 +66,17 @@ main = do

70 createCabal cabalPath name

66 createCabal cabalPath name

71 fs -> do

67 fs -> do

72 putStrLn $ "The following files will be overwritten:"

68 putStrLn $ "The following files will be overwritten:"

73− mapM_ putStrLn fs

69+ foldMap putStrLn fs

74 putStrLn $ "Use -f to overwrite them"

70 putStrLn $ "Use -f to overwrite them"

75 exitFailure

71 exitFailure

76

72

77existingFiles :: FilePath -> [FilePath] -> IO [FilePath]

73existingFiles :: FilePath -> [FilePath] -> IO [FilePath]

78−existingFiles dstDir files = fmap concat $ forM files $ \file -> do

74+existingFiles dstDir = foldMap $ \file -> do

79 let dst = dstDir </> file

75 let dst = dstDir </> file

80 exists <- doesFileExist dst

76 exists <- doesFileExist dst

81 return $ if exists then [dst] else []

77 return $ if exists then [dst] else []

82

78

79+

83-- | Figure out a good cabal package name from the given (existing) directory

80-- | Figure out a good cabal package name from the given (existing) directory

84-- name

81-- name

85makeName :: FilePath -> IO String

82makeName :: FilePath -> IO String

stack.yaml+8−22

@@ -1,33 +1,19 @@

1−resolver: lts-13.29

1+resolver: lts-11.0

2−save-hackage-creds: false

2+extra-package-dbs: []

3

4flags:

5 hakyll:

6− previewServer: true

6+ previewServer: True

7− watchServer: true

7+ watchServer: True

8− checkExternal: true

8+ checkExternal: True

9− usePandoc: true

10− buildWebsite: true

9+ buildWebsite: True

11

10

12packages:

11packages:

13 - '.'

12 - '.'

14

13

14+extra-deps: []

15+

15nix:

16nix:

16 enable: false

17 enable: false

17 packages:

18 packages:

18 - zlib

19 - zlib

19−

20−build:

21− haddock: true

22− haddock-hyperlink-source: true

23− haddock-deps: false

24−

25−extra-deps:

26−- 'cmark-gfm-0.2.0'

27−- 'hslua-module-system-0.2.1'

28−- 'ipynb-0.1'

29−- 'lrucache-1.2.0.1'

30−- 'pandoc-2.7.3'

31−- 'pandoc-citeproc-0.16.2'

32−- 'skylighting-0.8.2'

33−- 'skylighting-core-0.8.2'

tests/Hakyll/Core/Rules/Tests.hs+2−1

@@ -17,6 +17,7 @@ import Hakyll.Core.Metadata

17import Hakyll.Core.Routes

18import Hakyll.Core.Rules

19import Hakyll.Core.Rules.Internal

20+import Hakyll.Web.Pandoc

20import System.FilePath ((</>))

21import System.FilePath ((</>))

21import Test.Tasty (TestTree, testGroup)

22import Test.Tasty (TestTree, testGroup)

22import Test.Tasty.HUnit (Assertion, (@=?))

23import Test.Tasty.HUnit (Assertion, (@=?))

@@ -74,7 +75,7 @@ rules01 ioref = do

74 -- Compile some posts

75 -- Compile some posts

75 match "*.md" $ do

76 match "*.md" $ do

76 route $ setExtension "html"

77 route $ setExtension "html"

77− compile copyFileCompiler

78+ compile pandocCompiler

78

79

79 -- Yeah. I don't know how else to test this stuff?

80 -- Yeah. I don't know how else to test this stuff?

80 preprocess $ writeIORef ioref True

81 preprocess $ writeIORef ioref True

tests/Hakyll/Core/Runtime/Tests.hs+1−1

@@ -39,7 +39,7 @@ case01 = do

39 compile $ do

40 getResourceBody

41 >>= saveSnapshot "raw"

42− >>= renderParagraphs

42+ >>= renderPandoc

43

44 match (fromList ["partial.html", "partial-helper.html"]) $

45 compile templateCompiler

tests/Hakyll/Core/UnixFilter/Tests.hs+14−6

@@ -6,16 +6,18 @@ module Hakyll.Core.UnixFilter.Tests

6

7

8--------------------------------------------------------------------------------

9+import Data.List (isInfixOf)

9−import Test.Tasty (TestTree, testGroup)

10+import Test.Tasty (TestTree, testGroup)

10−import Test.Tasty.HUnit (testCase)

11+import Test.Tasty.HUnit (testCase)

11−import qualified Test.Tasty.HUnit as H

12+import qualified Test.Tasty.HUnit as H

12

13

14

14--------------------------------------------------------------------------------

15--------------------------------------------------------------------------------

15import Hakyll.Core.Compiler

16import Hakyll.Core.Compiler

16−import Hakyll.Core.Identifier

17+import Hakyll.Core.Compiler.Internal

17import Hakyll.Core.Item

18import Hakyll.Core.Item

18import Hakyll.Core.UnixFilter

19import Hakyll.Core.UnixFilter

20+import Hakyll.Core.Identifier

19import TestSuite.Util

21import TestSuite.Util

20

22

21

23

@@ -49,7 +51,10 @@ unixFilterFalse :: H.Assertion

49unixFilterFalse = do

51unixFilterFalse = do

50 store <- newTestStore

52 store <- newTestStore

51 provider <- newTestProvider store

53 provider <- newTestProvider store

52− testCompilerError store provider testMarkdown compiler "exit code"

54+ result <- testCompiler store provider testMarkdown compiler

55+ case result of

56+ CompilerError es -> True H.@=? any ("exit code" `isInfixOf`) es

57+ _ -> H.assertFailure "Expecting CompilerError"

53 cleanTestEnv

58 cleanTestEnv

54 where

59 where

55 compiler = getResourceString >>= withItemBody (unixFilter "false" [])

60 compiler = getResourceString >>= withItemBody (unixFilter "false" [])

@@ -60,7 +65,10 @@ unixFilterError :: H.Assertion

60unixFilterError = do

65unixFilterError = do

61 store <- newTestStore

66 store <- newTestStore

62 provider <- newTestProvider store

67 provider <- newTestProvider store

63− testCompilerError store provider testMarkdown compiler "option"

68+ result <- testCompiler store provider testMarkdown compiler

69+ case result of

70+ CompilerError es -> True H.@=? any ("invalid option" `isInfixOf`) es

71+ _ -> H.assertFailure "Expecting CompilerError"

64 cleanTestEnv

72 cleanTestEnv

65 where

73 where

66 compiler = getResourceString >>= withItemBody (unixFilter "head" ["-#"])

74 compiler = getResourceString >>= withItemBody (unixFilter "head" ["-#"])

tests/Hakyll/Web/Template/Context/Tests.hs+3−40

@@ -13,19 +13,16 @@ import Test.Tasty.HUnit (Assertion, testCase, (@=?))

13--------------------------------------------------------------------------------

14import Hakyll.Core.Compiler

15import Hakyll.Core.Identifier

16−import Hakyll.Core.Item

17import Hakyll.Core.Provider

16import Hakyll.Core.Provider

18import Hakyll.Core.Store (Store)

17import Hakyll.Core.Store (Store)

19import Hakyll.Web.Template.Context

18import Hakyll.Web.Template.Context

20−import Hakyll.Web.Template.Internal

21import TestSuite.Util

19import TestSuite.Util

22

20

23

21

24--------------------------------------------------------------------------------

22--------------------------------------------------------------------------------

25tests :: TestTree

23tests :: TestTree

26−tests = testGroup "Hakyll.Web.Template.Context.Tests"

24+tests = testGroup "Hakyll.Core.Template.Context.Tests"

27 [ testCase "testDateField" testDateField

25 [ testCase "testDateField" testDateField

28− , testCase "testOuerLoopContextAccess" testOuerLoopContextAccess

29 ]

26 ]

30

27

31

28

@@ -44,15 +41,6 @@ testDateField = do

44 dateField "date" "%B %e, %Y"

41 dateField "date" "%B %e, %Y"

45 date2 @=? "August 26, 2010"

42 date2 @=? "August 26, 2010"

46

43

47− date3 <- testContextDone store provider

48− "posts/2018-09-26.md" "date" $

49− dateField "date" "%B %e, %Y"

50− date3 @=? "September 26, 2018"

51−

52− date4 <- testContextDone store provider

53− "posts/2019/05/10/tomorrow.md" "date" $

54− dateField "date" "%B %e, %Y"

55− date4 @=? "May 10, 2019"

56 cleanTestEnv

44 cleanTestEnv

57

45

58

46

@@ -65,31 +53,6 @@ testContextDone store provider identifier key context =

65 cf <- unContext context key [] item

53 cf <- unContext context key [] item

66 case cf of

54 case cf of

67 StringField str -> return str

55 StringField str -> return str

68− _ -> error $

56+ ListField _ _ -> error $

69 "Hakyll.Web.Template.Context.Tests.testContextDone: " ++

57 "Hakyll.Web.Template.Context.Tests.testContextDone: " ++

70− "expected StringField"

58+ "Didn't expect ListField"

71−

72−--------------------------------------------------------------------------------

73−

74−testOuerLoopContextAccess :: Assertion

75−testOuerLoopContextAccess = do

76− store <- newTestStore

77− provider <- newTestProvider store

78− test store provider ctx "baz"

79− test store provider (ctx' <> ctx) "not baz"

80− test store provider (ctx <> ctx') "baz"

81−

82− cleanTestEnv

83− where

84− tpl = readTemplate "$for(foo)$$for(bar)$$qux$$endfor$$endfor$"

85− ctx = mconcat [

86− field "qux" $ const $ return "baz"

87− , listField "foo" (listField "bar" mempty $ return [mockItem])

88− $ return [mockItem]

89− ]

90− ctx' = field "qux" $ const $ return "not baz"

91− mockItem = Item "" ()

92− test store provider context str = do

93− str' <- testCompilerDone store provider ""

94− $ applyTemplate tpl context mockItem

95− str @=? itemBody str'

tests/Hakyll/Web/Template/Tests.hs+19−52

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

1--------------------------------------------------------------------------------

2{-# LANGUAGE OverloadedStrings #-}

3−{-# LANGUAGE TemplateHaskell #-}

4module Hakyll.Web.Template.Tests

3module Hakyll.Web.Template.Tests

5 ( tests

4 ( tests

6 ) where

5 ) where

@@ -8,16 +7,16 @@ module Hakyll.Web.Template.Tests

8

7

9--------------------------------------------------------------------------------

8--------------------------------------------------------------------------------

10import Test.Tasty (TestTree, testGroup)

9import Test.Tasty (TestTree, testGroup)

11−import Test.Tasty.HUnit (Assertion, assertBool, testCase,

10+import Test.Tasty.HUnit (Assertion, testCase, (@=?),

12− (@=?), (@?=))

11+ (@?=))

13

12

14−import Data.Either (isLeft)

15

13

16--------------------------------------------------------------------------------

14--------------------------------------------------------------------------------

17import Hakyll.Core.Compiler

15import Hakyll.Core.Compiler

18import Hakyll.Core.Identifier

16import Hakyll.Core.Identifier

19import Hakyll.Core.Item

17import Hakyll.Core.Item

20import Hakyll.Core.Provider

18import Hakyll.Core.Provider

19+import Hakyll.Web.Pandoc

21import Hakyll.Web.Template

20import Hakyll.Web.Template

22import Hakyll.Web.Template.Context

21import Hakyll.Web.Template.Context

23import Hakyll.Web.Template.Internal

22import Hakyll.Web.Template.Internal

@@ -27,20 +26,20 @@ import TestSuite.Util

27

26

28--------------------------------------------------------------------------------

27--------------------------------------------------------------------------------

29tests :: TestTree

28tests :: TestTree

30−tests = testGroup "Hakyll.Web.Template.Tests" $ concat

29+tests = testGroup "Hakyll.Core.Template.Tests" $ concat

31 [ [ testCase "case01" $ test ("template.html.out", "template.html", "example.md")

30 [ [ testCase "case01" $ test ("template.html.out", "template.html", "example.md")

32 , testCase "case02" $ test ("strip.html.out", "strip.html", "example.md")

31 , testCase "case02" $ test ("strip.html.out", "strip.html", "example.md")

33 , testCase "case03" $ test ("just-meta.html.out", "just-meta.html", "example.md")

32 , testCase "case03" $ test ("just-meta.html.out", "just-meta.html", "example.md")

34 , testCase "applyJoinTemplateList" testApplyJoinTemplateList

33 , testCase "applyJoinTemplateList" testApplyJoinTemplateList

35 ]

34 ]

36

35

37− , fromAssertions "parseTemplate"

36+ , fromAssertions "readTemplate"

38− [ Right [Chunk "Hello ", Expr (Call "guest" [])]

37+ [ [Chunk "Hello ", Expr (Call "guest" [])]

39− @=? parse "Hello $guest()$"

38+ @=? readTemplateElems "Hello $guest()$"

40− , Right [If (Call "a" [StringLiteral "bar"]) [Chunk "foo"] Nothing]

39+ , [If (Call "a" [StringLiteral "bar"]) [Chunk "foo"] Nothing]

41− @=? parse "$if(a(\"bar\"))$foo$endif$"

40+ @=? readTemplateElems "$if(a(\"bar\"))$foo$endif$"

42 -- 'If' trim check.

41 -- 'If' trim check.

43− , Right [ TrimL

42+ , [ TrimL

44 , If (Ident (TemplateKey "body"))

43 , If (Ident (TemplateKey "body"))

45 [ TrimR

44 [ TrimR

46 , Chunk "\n"

45 , Chunk "\n"

@@ -56,39 +55,29 @@ tests = testGroup "Hakyll.Web.Template.Tests" $ concat

56 ])

55 ])

57 , TrimR

56 , TrimR

58 ]

57 ]

59− @=? parse "$-if(body)-$\n$body$\n$-else-$\n$body$\n$-endif-$"

58+ @=? readTemplateElems "$-if(body)-$\n$body$\n$-else-$\n$body$\n$-endif-$"

60 -- 'For' trim check.

59 -- 'For' trim check.

61− , Right [ TrimL

60+ , [ TrimL

62 , For (Ident (TemplateKey "authors"))

61 , For (Ident (TemplateKey "authors"))

63 [TrimR, Chunk "\n body \n", TrimL]

62 [TrimR, Chunk "\n body \n", TrimL]

64 Nothing

63 Nothing

65 , TrimR

64 , TrimR

66 ]

65 ]

67− @=? parse "$-for(authors)-$\n body \n$-endfor-$"

66+ @=? readTemplateElems "$-for(authors)-$\n body \n$-endfor-$"

68 -- 'Partial' trim check.

67 -- 'Partial' trim check.

69− , Right [ TrimL

68+ , [ TrimL

70 , Partial (StringLiteral "path")

69 , Partial (StringLiteral "path")

71 , TrimR

70 , TrimR

72 ]

71 ]

73− @=? parse "$-partial(\"path\")-$"

72+ @=? readTemplateElems "$-partial(\"path\")-$"

74 -- 'Expr' trim check.

73 -- 'Expr' trim check.

75− , Right [ TrimL

74+ , [ TrimL

76 , Expr (Ident (TemplateKey "foo"))

75 , Expr (Ident (TemplateKey "foo"))

77 , TrimR

76 , TrimR

78 ]

77 ]

79− @=? parse "$-foo-$"

78+ @=? readTemplateElems "$-foo-$"

80− -- fail on incomplete template.

81− , assertBool "did not yield error" $ isLeft $

82− parse "a$b"

83− -- fail on mismatched template syntax.

84− , assertBool "did not fail to parse" $ isLeft $

85− parse "$for(xs)$\n <p>foo</p>\n$endif$"

86 ]

79 ]

87−

88− , [testCase "embeddedTemplate" testEmbeddedTemplate]

89 ]

80 ]

90− where

91− parse = parseTemplateElemsFile ""

92

81

93

82

94--------------------------------------------------------------------------------

83--------------------------------------------------------------------------------

@@ -100,9 +89,7 @@ test (outf, tplf, itemf) = do

100 out <- resourceString provider outf

89 out <- resourceString provider outf

101 tpl <- testCompilerDone store provider tplf templateBodyCompiler

90 tpl <- testCompilerDone store provider tplf templateBodyCompiler

102 item <- testCompilerDone store provider itemf $

91 item <- testCompilerDone store provider itemf $

103− getResourceBody

104− >>= renderParagraphs

105− >>= applyTemplate (itemBody tpl) testContext

92+ pandocCompiler >>= applyTemplate (itemBody tpl) testContext

106

93

107 out @=? itemBody item

94 out @=? itemBody item

108 cleanTestEnv

95 cleanTestEnv

@@ -125,8 +112,6 @@ testApplyJoinTemplateList :: Assertion

125testApplyJoinTemplateList = do

112testApplyJoinTemplateList = do

126 store <- newTestStore

113 store <- newTestStore

127 provider <- newTestProvider store

114 provider <- newTestProvider store

128− tpl <- testCompilerDone store provider "tpl" $

129− compileTemplateItem (Item "tpl" "<b>$body$</b>")

130 str <- testCompilerDone store provider "item3" $

115 str <- testCompilerDone store provider "item3" $

131 applyJoinTemplateList ", " tpl defaultContext [i1, i2]

116 applyJoinTemplateList ", " tpl defaultContext [i1, i2]

132

117

@@ -135,22 +120,4 @@ testApplyJoinTemplateList = do

135 where

120 where

136 i1 = Item "item1" "Hello"

121 i1 = Item "item1" "Hello"

137 i2 = Item "item2" "World"

122 i2 = Item "item2" "World"

138−

123+ tpl = readTemplate "<b>$body$</b>"

139−

140−--------------------------------------------------------------------------------

141−embeddedTemplate :: Template

142−embeddedTemplate = $(embedTemplate "tests/data/embed.html")

143−

144−--------------------------------------------------------------------------------

145−testEmbeddedTemplate :: Assertion

146−testEmbeddedTemplate = do

147− store <- newTestStore

148− provider <- newTestProvider store

149− str <- testCompilerDone store provider "item3" $

150− applyTemplate embeddedTemplate defaultContext item

151−

152− itemBody str @?= "<p>Hello, world</p>\n"

153− cleanTestEnv

154− where

155− item = Item "item1" "Hello, world"

156−

tests/TestSuite.hs−7

@@ -1,5 +1,4 @@

1--------------------------------------------------------------------------------

2−{-# LANGUAGE CPP #-}

3module Main

2module Main

4 ( main

3 ( main

5 ) where

4 ) where

@@ -23,12 +22,9 @@ import qualified Hakyll.Core.Util.String.Tests

23import qualified Hakyll.Web.CompressCss.Tests

22import qualified Hakyll.Web.CompressCss.Tests

24import qualified Hakyll.Web.Html.RelativizeUrls.Tests

23import qualified Hakyll.Web.Html.RelativizeUrls.Tests

25import qualified Hakyll.Web.Html.Tests

24import qualified Hakyll.Web.Html.Tests

26−#ifdef USE_PANDOC

27import qualified Hakyll.Web.Pandoc.FileType.Tests

25import qualified Hakyll.Web.Pandoc.FileType.Tests

28−#endif

29import qualified Hakyll.Web.Template.Context.Tests

26import qualified Hakyll.Web.Template.Context.Tests

30import qualified Hakyll.Web.Template.Tests

27import qualified Hakyll.Web.Template.Tests

31−import qualified Hakyll.Web.Tags.Tests

32

28

33

29

34--------------------------------------------------------------------------------

30--------------------------------------------------------------------------------

@@ -47,10 +43,7 @@ main = defaultMain $ testGroup "Hakyll"

47 , Hakyll.Web.CompressCss.Tests.tests

43 , Hakyll.Web.CompressCss.Tests.tests

48 , Hakyll.Web.Html.RelativizeUrls.Tests.tests

44 , Hakyll.Web.Html.RelativizeUrls.Tests.tests

49 , Hakyll.Web.Html.Tests.tests

45 , Hakyll.Web.Html.Tests.tests

50−#ifdef USE_PANDOC

51 , Hakyll.Web.Pandoc.FileType.Tests.tests

46 , Hakyll.Web.Pandoc.FileType.Tests.tests

52−#endif

53− , Hakyll.Web.Tags.Tests.tests

54 , Hakyll.Web.Template.Context.Tests.tests

47 , Hakyll.Web.Template.Context.Tests.tests

55 , Hakyll.Web.Template.Tests.tests

48 , Hakyll.Web.Template.Tests.tests

56 ]

49 ]

tests/TestSuite/Util.hs+2−23

@@ -6,15 +6,13 @@ module TestSuite.Util

6 , newTestProvider

7 , testCompiler

8 , testCompilerDone

9− , testCompilerError

10 , testConfiguration

9 , testConfiguration

11 , cleanTestEnv

10 , cleanTestEnv

12− , renderParagraphs

13 ) where

11 ) where

14

12

15

13

16--------------------------------------------------------------------------------

14--------------------------------------------------------------------------------

17−import Data.List (intercalate, isInfixOf)

15+import Data.List (intercalate)

18import Data.Monoid (mempty)

16import Data.Monoid (mempty)

19import qualified Data.Set as S

17import qualified Data.Set as S

20import Test.Tasty

18import Test.Tasty

@@ -31,7 +29,6 @@ import Hakyll.Core.Provider

31import Hakyll.Core.Store (Store)

29import Hakyll.Core.Store (Store)

32import qualified Hakyll.Core.Store as Store

30import qualified Hakyll.Core.Store as Store

33import Hakyll.Core.Util.File

31import Hakyll.Core.Util.File

34−import Hakyll.Core.Item

35

32

36

33

37--------------------------------------------------------------------------------

34--------------------------------------------------------------------------------

@@ -81,21 +78,13 @@ testCompilerDone store provider underlying compiler = do

81 CompilerDone x _ -> return x

78 CompilerDone x _ -> return x

82 CompilerError e -> fail $

79 CompilerError e -> fail $

83 "TestSuite.Util.testCompilerDone: compiler " ++ show underlying ++

80 "TestSuite.Util.testCompilerDone: compiler " ++ show underlying ++

84− " threw: " ++ intercalate "; " (compilerErrorMessages e)

81+ " threw: " ++ intercalate "; " e

85 CompilerRequire i _ -> fail $

82 CompilerRequire i _ -> fail $

86 "TestSuite.Util.testCompilerDone: compiler " ++ show underlying ++

83 "TestSuite.Util.testCompilerDone: compiler " ++ show underlying ++

87 " requires: " ++ show i

84 " requires: " ++ show i

88 CompilerSnapshot _ _ -> fail

85 CompilerSnapshot _ _ -> fail

89 "TestSuite.Util.testCompilerDone: unexpected CompilerSnapshot"

86 "TestSuite.Util.testCompilerDone: unexpected CompilerSnapshot"

90

87

91−testCompilerError :: Store -> Provider -> Identifier -> Compiler a -> String -> IO ()

92−testCompilerError store provider underlying compiler expectedMessage = do

93− result <- testCompiler store provider underlying compiler

94− case result of

95− CompilerError e ->

96− any (expectedMessage `isInfixOf`) (compilerErrorMessages e) @?

97− "Expecting '" ++ expectedMessage ++ "' error"

98− _ -> assertFailure "Expecting CompilerError"

99

88

100--------------------------------------------------------------------------------

89--------------------------------------------------------------------------------

101testConfiguration :: Configuration

90testConfiguration :: Configuration

@@ -113,13 +102,3 @@ cleanTestEnv = do

113 removeDirectory $ destinationDirectory testConfiguration

102 removeDirectory $ destinationDirectory testConfiguration

114 removeDirectory $ storeDirectory testConfiguration

103 removeDirectory $ storeDirectory testConfiguration

115 removeDirectory $ tmpDirectory testConfiguration

104 removeDirectory $ tmpDirectory testConfiguration

116−

117−

118−--------------------------------------------------------------------------------

119−-- | like 'Hakyll.Web.Pandoc.renderPandoc'

120−-- | but allowing to test without the @usePandoc@ flag

121−renderParagraphs :: Item String -> Compiler (Item String)

122−renderParagraphs = withItemBody (return

123− . intercalate "\n" -- no trailing line

124− . map (("<p>"++) . (++"</p>"))

125− . lines)

tests/data/embed.htmldeleted−1

@@ -1 +0,0 @@

1−<p>$body$</p>

tests/data/posts/2018-09-26.mddeleted−1

@@ -1 +0,0 @@

1−Something happened today.

tests/data/posts/2019/05/10/tomorrow.mddeleted−1

@@ -1 +0,0 @@

1−This day hasn't happened yet (as of writing this).

web/css/syntax.css+18−61

@@ -1,61 +1,18 @@

1−a.sourceLine { display: inline-block; line-height: 1.25; }

1+/* Generated by pandoc. */

2−a.sourceLine { pointer-events: none; color: inherit; text-decoration: inherit; }

2+table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode, table.sourceCode pre

3−a.sourceLine:empty { height: 1.2em; }

3+ { margin: 0; padding: 0; border: 0; vertical-align: baseline; border: none; }

4−.sourceCode { overflow: visible; }

4+td.lineNumbers { border-right: 1px solid #AAAAAA; text-align: right; color: #AAAAAA; padding-right: 5px; padding-left: 5px; }

5−code.sourceCode { white-space: pre; position: relative; }

5+td.sourceCode { padding-left: 5px; }

6−div.sourceCode { margin: 1em 0; }

7−pre.sourceCode { margin: 0; }

8−@media screen {

9−div.sourceCode { overflow: auto; }

10−}

11−@media print {

12−code.sourceCode { white-space: pre-wrap; }

13−a.sourceLine { text-indent: -1em; padding-left: 1em; }

14−}

15−pre.numberSource a.sourceLine

16− { position: relative; left: -4em; }

17−pre.numberSource a.sourceLine::before

18− { content: attr(title);

19− position: relative; left: -1em; text-align: right; vertical-align: baseline;

20− border: none; pointer-events: all; display: inline-block;

21− -webkit-touch-callout: none; -webkit-user-select: none;

22− -khtml-user-select: none; -moz-user-select: none;

23− -ms-user-select: none; user-select: none;

24− padding: 0 4px; width: 4em;

25− color: #aaaaaa;

26− }

27−pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }

28−div.sourceCode

29− { }

30−@media screen {

31−a.sourceLine::before { text-decoration: underline; }

32−}

33−code span.al { color: #ff0000; font-weight: bold; } /* Alert */

34−code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */

35−code span.at { color: #7d9029; } /* Attribute */

36−code span.bn { color: #40a070; } /* BaseN */

37−code span.bu { } /* BuiltIn */

38−code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */

6+.sourceCode span.kw { color: #007020; font-weight: bold; }

39−code span.ch { color: #4070a0; } /* Char */

40−code span.cn { color: #880000; } /* Constant */

41−code span.co { color: #60a0b0; font-style: italic; } /* Comment */

42−code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */

43−code span.do { color: #ba2121; font-style: italic; } /* Documentation */

44−code span.dt { color: #902000; } /* DataType */

7+.sourceCode span.dt { color: #902000; }

45−code span.dv { color: #40a070; } /* DecVal */

8+.sourceCode span.dv { color: #40a070; }

46−code span.er { color: #ff0000; font-weight: bold; } /* Error */

9+.sourceCode span.bn { color: #40a070; }

47−code span.ex { } /* Extension */

48−code span.fl { color: #40a070; } /* Float */

10+.sourceCode span.fl { color: #40a070; }

11+.sourceCode span.ch { color: #4070a0; }

12+.sourceCode span.st { color: #4070a0; }

13+.sourceCode span.co { color: #60a0b0; font-style: italic; }

14+.sourceCode span.ot { color: #007020; }

15+.sourceCode span.al { color: red; font-weight: bold; }

49−code span.fu { color: #06287e; } /* Function */

16+.sourceCode span.fu { color: #06287e; }

50−code span.im { } /* Import */

17+.sourceCode span.re { }

51−code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */

18+.sourceCode span.er { color: red; font-weight: bold; }

52−code span.kw { color: #007020; font-weight: bold; } /* Keyword */

53−code span.op { color: #666666; } /* Operator */

54−code span.ot { color: #007020; } /* Other */

55−code span.pp { color: #bc7a00; } /* Preprocessor */

56−code span.sc { color: #4070a0; } /* SpecialChar */

57−code span.ss { color: #bb6688; } /* SpecialString */

58−code span.st { color: #4070a0; } /* String */

59−code span.va { color: #19177c; } /* Variable */

60−code span.vs { color: #4070a0; } /* VerbatimString */

61−code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */

web/examples.markdown+22−26

@@ -45,7 +45,7 @@ directly with the default Hakyll site.

45- <http://www.regisfoucault.com/>,

46 [source](https://github.com/regisfoucault/blog)

47- <http://www.chaoxuprime.com/>,

48− [source](https://github.com/chaoxu/chaoxu.github.io/tree/develop)

48+ [source](https://github.com/Mgccl/blog)

49- <http://www.skybluetrades.net/>,

50 [source](https://github.com/ian-ross/blog)

51- <http://chromaticleaves.com/>,

@@ -68,10 +68,16 @@ directly with the default Hakyll site.

68 [source](https://github.com/walkie/WebPage)

69- <http://techblog.rosedu.org/>,

70 [source](https://github.com/rosedu/techblog)

71+- <http://abizern.org>,

72+ [source](https://github.com/Abizern/hblog)

71- <http://freizl.github.io>,

73- <http://freizl.github.io>,

72 [source](https://github.com/freizl/freizl.github.com/tree/master/build)

74 [source](https://github.com/freizl/freizl.github.com/tree/master/build)

75+- <http://covariant.me>,

76+ [source](http://hub.darcs.net/co-dan/website)

73- <http://www.gwern.net/>,

77- <http://www.gwern.net/>,

74 [source](https://github.com/gwern/gwern.net)

78 [source](https://github.com/gwern/gwern.net)

79+- <http://www.rohanjain.in/>,

80+ [source](https://github.com/crodjer/rohanjain.in)

75- <http://www.corentindupont.info/>,

81- <http://www.corentindupont.info/>,

76 [source](https://github.com/cdupont/CorentinDupont-WebPage)

82 [source](https://github.com/cdupont/CorentinDupont-WebPage)

77- <http://jelv.is>,

83- <http://jelv.is>,

@@ -80,8 +86,8 @@ directly with the default Hakyll site.

80 [source](https://github.com/plaimi/www)

86 [source](https://github.com/plaimi/www)

81- <http://duplode.github.io/>,

87- <http://duplode.github.io/>,

82 [source](https://github.com/duplode/duplode.github.io/tree/sources)

88 [source](https://github.com/duplode/duplode.github.io/tree/sources)

83−- <http://tzemanovic.github.io/>,

89+- <http://maseek.codes>,

84− [source](https://github.com/tzemanovic/tzemanovic)

90+ [source](https://github.com/maseek/maseek-codes)

85- <http://listx.github.io>,

91- <http://listx.github.io>,

86 [source](https://github.com/listx/listx_blog)

92 [source](https://github.com/listx/listx_blog)

87- <http://kyle.marek-spartz.org>,

93- <http://kyle.marek-spartz.org>,

@@ -92,20 +98,26 @@ directly with the default Hakyll site.

92 [source](https://github.com/rbros/reichertbrothers.com)

98 [source](https://github.com/rbros/reichertbrothers.com)

93- <http://alemedeiros.sdf.org>,

99- <http://alemedeiros.sdf.org>,

94 [source](https://github.com/alemedeiros/homepage)

100 [source](https://github.com/alemedeiros/homepage)

101+- <https://ruudvanasseldonk.com/>,

102+ [source](https://github.com/ruud-v-a/ruudvanasseldonk.com)

95- <http://www.haskell.mn>,

103- <http://www.haskell.mn>,

96 [source](https://github.com/HaskellMN/www.haskell.mn)

104 [source](https://github.com/HaskellMN/www.haskell.mn)

97- <https://axiomatic.neophilus.net/>,

105- <https://axiomatic.neophilus.net/>,

98 [source](https://github.com/Libbum/AxiomaticSemantics)

106 [source](https://github.com/Libbum/AxiomaticSemantics)

99−- [https://tesser.org/](http://web.archive.org/web/20161022221713/https://tesser.org/),

107+- <https://tesser.org/>,

100 [source](https://github.com/fractalcat/tesser.org)

108 [source](https://github.com/fractalcat/tesser.org)

101−- <https://weien.io/>,

109+- <https://wei2912.github.io/>,

102− [source](https://github.com/wei2912/blog-src)

110+ [source](https://github.com/wei2912/blog_src)

103- <http://www.metasepi.org/>,

111- <http://www.metasepi.org/>,

104 [source](https://github.com/metasepi/metasepi-website)

112 [source](https://github.com/metasepi/metasepi-website)

105- <http://gisli.hamstur.is/>,

113- <http://gisli.hamstur.is/>,

106 [source](https://github.com/gislik/gisli.hamstur.is)

114 [source](https://github.com/gislik/gisli.hamstur.is)

107- <http://blog.ssanj.net/>,

115- <http://blog.ssanj.net/>,

108 [source](https://github.com/ssanj/babyloncandle)

116 [source](https://github.com/ssanj/babyloncandle)

117+- <https://rockymadden.com/>,

118+ [source](https://github.com/rockymadden/rockymadden-web)

119+- <http://blog.dshevchenko.biz/>,

120+ [source](https://github.com/denisshevchenko/blog)

109- <http://ruhaskell.org/>,

121- <http://ruhaskell.org/>,

110 [source](https://github.com/ruHaskell/ruhaskell)

122 [source](https://github.com/ruHaskell/ruhaskell)

111- <http://www.haskell.od.ua/>,

123- <http://www.haskell.od.ua/>,

@@ -126,6 +138,8 @@ directly with the default Hakyll site.

126 [source](https://github.com/ismailmustafa/ismailmustafa.github.io/tree/hakyll)

138 [source](https://github.com/ismailmustafa/ismailmustafa.github.io/tree/hakyll)

127- <http://lettier.github.io/>,

139- <http://lettier.github.io/>,

128 [source](https://github.com/lettier/lettier.github.io)

140 [source](https://github.com/lettier/lettier.github.io)

141+- <http://jozefg.bitbucket.org/>,

142+ [source](https://github.com/jozefg/blog)

129- <http://raindev.io>,

143- <http://raindev.io>,

130 [source](https://github.com/raindev/raindev.github.io)

144 [source](https://github.com/raindev/raindev.github.io)

131- <http://hal2016.haskell.org/>,

145- <http://hal2016.haskell.org/>,

@@ -154,6 +168,8 @@ directly with the default Hakyll site.

154 [source](https://github.com/beerendlauwers/HaskAnything)

168 [source](https://github.com/beerendlauwers/HaskAnything)

155- <https://anler.me/>,

169- <https://anler.me/>,

156 [source](https://github.com/anler/anler.me)

170 [source](https://github.com/anler/anler.me)

171+- <https://www.brandonstil.es/>,

172+ [source](https://github.com/stilesb/brandonstil.es)

157- <http://argumatronic.com/>,

173- <http://argumatronic.com/>,

158 [source](https://gitlab.com/GinBaby/argumatronic/tree/master)

174 [source](https://gitlab.com/GinBaby/argumatronic/tree/master)

159- <http://sillybytes.net/>,

175- <http://sillybytes.net/>,

@@ -164,26 +180,6 @@ directly with the default Hakyll site.

164 [source](https://github.com/thunky-monk/spyhop-cafe)

180 [source](https://github.com/thunky-monk/spyhop-cafe)

165- <https://bendo.github.io/>,

181- <https://bendo.github.io/>,

166 [source](https://github.com/bendo/bendo.github.io)

182 [source](https://github.com/bendo/bendo.github.io)

167−- <http://adarsh.cc/>,

168− [source](https://github.com/adarshp/adarsh.cc)

169−- <http://0a.io>,

170− [source](https://github.com/arrchyy/0a.io)

171−- <https://nasy.moe/>,

172− [source](https://github.com/nasyxx/NasyMoe)

173−- <http://uniprocess.org/>,

174− [source](https://gitlab.com/uniprocess/uniprocess.org)

175−- <https://regularflolloping.com/>,

176− [source](https://github.com/techieAgnostic/rf)

177−- <http://enter-haken.github.io/>,

178− [source](https://github.com/enter-haken/blog)

179−- <https://modular.blind.guru/>,

180− [source](https://github.com/mlang/eurorack-metadata)

181−- <http://www.jonashietala.se/>,

182− [source](https://github.com/treeman/jonashietala)

183−- <https://abhinavsarkar.net/>,

184− [source](https://github.com/abhin4v/abhin4v.github.io)

185−- <https://dailyreadingnotes.com/>,

186− [source](https://github.com/hackeryarn/daily-reading-notes)

187

183

188## Hakyll 3.X

184## Hakyll 3.X

189

185

web/libraries.markdown−1

@@ -18,4 +18,3 @@ Here is a list of the ones I know of (I would be happy to hear about others).

18 a conversion tool from other blog engines to Hakyll.

19- [hakyll-elm](https://hackage.haskell.org/package/hakyll-elm),

20 Hakyll wrapper for the Elm compiler.

21−- [hakyll-sass](http://hackage.haskell.org/package/hakyll-sass), a compiler for SASS templates.

web/site.hs+32−14

@@ -1,7 +1,8 @@

1--------------------------------------------------------------------------------

2{-# LANGUAGE OverloadedStrings #-}

3import Control.Arrow (second)

4−import Control.Monad (filterM, forM_)

4+import Control.Monad (forM_)

5+import Data.Char (isDigit)

5import Data.List (isPrefixOf, sortBy)

6import Data.List (isPrefixOf, sortBy)

6import Data.Monoid ((<>))

7import Data.Monoid ((<>))

7import Data.Ord (comparing)

8import Data.Ord (comparing)

@@ -56,11 +57,17 @@ main = hakyllWith config $ do

56 create ["tutorials.html"] $ do

57 create ["tutorials.html"] $ do

57 route idRoute

58 route idRoute

58 compile $ do

59 compile $ do

59− ctx <- tutorialsCtx <$>

60+ tuts <-

60 sortBy (comparing itemIdentifier) <$> loadAll "tutorials/*"

61 sortBy (comparing itemIdentifier) <$> loadAll "tutorials/*"

62+

63+ let tutorialsCtx =

64+ constField "title" "Tutorials" `mappend`

65+ listField "tutorials" tutorialCtx (return tuts) `mappend`

66+ defaultContext

67+

61 makeItem ""

68 makeItem ""

62− >>= loadAndApplyTemplate "templates/tutorials.html" ctx

69+ >>= loadAndApplyTemplate "templates/tutorials.html" tutorialsCtx

63− >>= loadAndApplyTemplate "templates/default.html" ctx

70+ >>= loadAndApplyTemplate "templates/default.html" tutorialsCtx

64 >>= relativizeUrls

71 >>= relativizeUrls

65

72

66 -- Templates

73 -- Templates

@@ -101,17 +108,28 @@ hackage url

101 reverse $ splitPath url

108 reverse $ splitPath url

102

109

103

110

111+--------------------------------------------------------------------------------

112+data TutorialType = SeriesTutorial | ArticlesTutorial | ExternalTutorial

113+ deriving (Eq)

114+

115+

104--------------------------------------------------------------------------------

116--------------------------------------------------------------------------------

105-- | Partition tutorials into tutorial series, other articles, external articles

117-- | Partition tutorials into tutorial series, other articles, external articles

106−tutorialsCtx :: [Item String] -> Context String

118+tutorialCtx :: Context String

107−tutorialsCtx tuts =

119+tutorialCtx =

108− constField "title" "Tutorials" <>

120+ field "isSeries" (isTutorialType SeriesTutorial) <>

109− listField "main" defaultContext (ofType "main") <>

121+ field "isArticle" (isTutorialType ArticlesTutorial) <>

110− listField "articles" defaultContext (ofType "article") <>

122+ field "isExternal" (isTutorialType ExternalTutorial) <>

111− listField "externals" defaultContext (ofType "external") <>

112− listField "robertwpearce" defaultContext (ofType "robertwpearce") <>

113 defaultContext

123 defaultContext

114 where

124 where

115− ofType ty = filterM (\item -> do

125+ getTutorialType item = do

116− mbType <- getMetadataField (itemIdentifier item) "type"

126+ mbExternal <- getMetadataField (itemIdentifier item) "external"

117− return $ Just ty == mbType) tuts

127+ return $ case mbExternal of

128+ Just _ -> ExternalTutorial

129+ _ -> case splitPath (toFilePath $ itemIdentifier item) of

130+ [_, (x : _)] -> if isDigit x then SeriesTutorial else ArticlesTutorial

131+ _ -> ArticlesTutorial

132+

133+ isTutorialType ty0 item = do

134+ ty1 <- getTutorialType item

135+ if ty0 == ty1 then return "yes" else fail "no"

web/templates/tutorials.html+18−24

@@ -1,19 +1,23 @@

1<h1>Tutorials about Hakyll</h1>

2<h2 id="series">Tutorial series</h2>

3<ul>

4− $for(main)$

4+ $for(tutorials)$

5+ $if(isSeries)$

5− <li>

6+ <li>

6− <a href="$url$">$title$</a>

7+ <a href="$url$">$title$</a>

7− </li>

8+ </li>

9+ $endif$

8 $endfor$

10 $endfor$

9</ul>

11</ul>

10<h2 id="articles">Other articles</h2>

12<h2 id="articles">Other articles</h2>

11<p>In no particular order:</p>

13<p>In no particular order:</p>

12<ul>

14<ul>

13− $for(articles)$

15+ $for(tutorials)$

16+ $if(isArticle)$

14− <li>

17+ <li>

15− <a href="$url$">$title$</a> by <em>$author$</em>

18+ <a href="$url$">$title$</a> by <em>$author$</em>

16− </li>

19+ </li>

20+ $endif$

17 $endfor$

21 $endfor$

18</ul>

22</ul>

19<h2 id="external-articles">External articles</h2>

23<h2 id="external-articles">External articles</h2>

@@ -24,22 +28,12 @@

24</p>

28</p>

25<p>In no particular order:</p>

29<p>In no particular order:</p>

26<ul>

30<ul>

27− $for(externals)$

31+ $for(tutorials)$

32+ $if(isExternal)$

28− <li>

33+ <li>

29− <a href="$url$">$title$</a> by <em>$author$</em>

34+ <a href="$url$">$title$</a> by <em>$author$</em>

30− </li>

35+ </li>

31− $endfor$

36+ $endif$

32−</ul>

33−<h2 id="robertwpearce">Robert Pearce's series</h2>

34−<p>

35− <a href="https://robertwpearce.com/">Robert Pearce</a> has been writing an

36− excellent tutorial-style series on Hakyll as well. You can find those here:

37−</p>

38−<ul>

39− $for(robertwpearce)$

40− <li>

41− <a href="$url$">$title$</a>

42− </li>

43 $endfor$

37 $endfor$

44</ul>

38</ul>

45<p>

39<p>

web/tutorials/01-installation.markdown+2−4

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

1---

2title: Installation

3author: Jasper Van der Jeugt

4−type: main

5---

4---

6

5

7Installation

6Installation

@@ -18,8 +17,7 @@ different distributions. For installation from source (i.e. via Hackage),

18Linux distro packages:

17Linux distro packages:

19

18

20- [Debian unstable](http://packages.debian.org/source/sid/haskell-hakyll)

19- [Debian unstable](http://packages.debian.org/source/sid/haskell-hakyll)

21−- [Fedora](https://apps.fedoraproject.org/packages/ghc-hakyll)

20+- [Fedora](https://apps.fedoraproject.org/packages/ghc-hakyll-devel)

22−- [Nix](https://nixos.org/nixos/packages.html#hakyll): `$ nix-env -i hakyll`

23

21

24Building the example site

22Building the example site

25-------------------------

23-------------------------

@@ -28,7 +26,7 @@ Apart from the main Hakyll library, the cabal package also provides you with an

28executable `hakyll-init` to create an example site. This is an easy way to get

26executable `hakyll-init` to create an example site. This is an easy way to get

29started:

27started:

30

28

31− $ stack exec hakyll-init my-site

29+ $ hakyll-init my-site

32

30

33This creates a folder `my-site` in the current directory, with some example

31This creates a folder `my-site` in the current directory, with some example

34content and a generic configuration.

32content and a generic configuration.

web/tutorials/02-basics.markdown−1

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

1---

2title: The basics

3author: Jasper Van der Jeugt

4−type: main

5---

4---

6

5

7Building and cleaning

6Building and cleaning

web/tutorials/03-rules-routes-compilers.markdown−1

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

1---

2title: Rules, routes and compilers

3author: Jasper Van der Jeugt

4−type: main

5---

4---

6

5

7Basic rules

6Basic rules

web/tutorials/04-compilers.markdown+2−3

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

1---

2title: 'More on compilers: load, and templates'

3author: Jasper Van der Jeugt

4−type: main

5---

4---

6

5

7Loading items

6Loading items

@@ -93,7 +92,7 @@ And `$title$` like this:

93titleContext :: Context a

92titleContext :: Context a

94titleContext = field "title" $ \item -> do

93titleContext = field "title" $ \item -> do

95 metadata <- getMetadata (itemIdentifier item)

94 metadata <- getMetadata (itemIdentifier item)

96− return $ fromMaybe "No title" $ lookupString "title" metadata

95+ return $ fromMaybe "No title" $ M.lookup "title" metadata

97```

96```

98

97

99And compose them using the `Monoid` instance:

98And compose them using the `Monoid` instance:

@@ -152,7 +151,7 @@ Control flow in templates

152-------------------------

151-------------------------

153

152

154Sometimes string interpolation does not suffice, and you want a little more

153Sometimes string interpolation does not suffice, and you want a little more

155−control over how your templates are laid out. Hakyll provides a few control

154+control over how your templates are layed out. Hakyll provides a few control

156structures for this. The syntax for these structures was based on the syntax

155structures for this. The syntax for these structures was based on the syntax

157used in pandoc templates, since Hakyll already has tight integration with

156used in pandoc templates, since Hakyll already has tight integration with

158pandoc.

157pandoc.

web/tutorials/05-snapshots-feeds.markdown−1

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

1---

2title: Snapshots, and how to produce an RSS/Atom feed

3author: Jasper Van der Jeugt

4−type: main

5---

4---

6

5

7Basic feed configuration

6Basic feed configuration

web/tutorials/06-versions.markdown−1

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

1---

2title: Producing multiple versions of a single file

3author: Jasper Van der Jeugt

4−type: main

5---

4---

6

5

7Basics

6Basics

web/tutorials/a-guide-to-the-hakyll-module-zoo.markdown−1

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

1---

2title: A Guide to the Hakyll Module Zoo

3author: Brent Yorgey

4−type: article

5---

4---

6

5

7The hakyll package [contains a bewildering array](/reference/) of modules, and

6The hakyll package [contains a bewildering array](/reference/) of modules, and

web/tutorials/external-add-tags-to-your-hakyll-blog.md+1−1

@@ -2,5 +2,5 @@

2title: Add tags to your Hakyll blog

3author: Javran Cheng

4url: https://javran.github.io/posts/2014-03-01-add-tags-to-your-hakyll-blog.html

5−type: external

5+external: true

6---

web/tutorials/external-blogger-port.md+1−1

@@ -2,5 +2,5 @@

2title: Port an existing Blogger blog to Hakyll

3author: Daniel Campoverde

4url: 'http://www.sillybytes.net/posts/from_blogger_to_hakyll.html'

5−type: external

5+external: true

6---

web/tutorials/external-cassius-template.md+1−1

@@ -2,5 +2,5 @@

2title: Using Cassius templating with Hakyll

3author: Daniel Campoverde

4url: 'http://www.sillybytes.net/posts/using_hakyll_with_cassius.html'

5−type: external

5+external: true

6---

web/tutorials/external-clean-urls-with-hakyll.md+1−1

@@ -2,5 +2,5 @@

2title: Clean URLs with Hakyll

3author: Rohan Jain

4url: http://www.rohanjain.in/hakyll-clean-urls/

5−type: external

5+external: true

6---

web/tutorials/external-deploying-with-widely.md+1−1

@@ -2,5 +2,5 @@

2title: Deploying with Widely

3author: Kyle Marek-Spartz

4url: http://kyle.marek-spartz.org/posts/2013-12-09-widely-and-hakyll.html

5−type: external

5+external: true

6---

web/tutorials/external-external-code-inclusion.mddeleted−6

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

1−---

2−title: 'External code inclusion with Hakyll'

3−author: 'Tobias Pleyer'

4−url: 'http://blog.tpleyer.de/posts/2019-04-21-external-code-inclusion-with-hakyll.html'

5−type: external

6−---

web/tutorials/external-functionfield.md+1−1

@@ -2,5 +2,5 @@

2title: Hakyll's functionField

3author: Beerend Lauwers

4url: http://beerendlauwers.be/posts/2015-09-21-hakylls-functionfield.html

5−type: external

5+external: true

6---

web/tutorials/external-github-pages-circle-ci.md+1−1

@@ -2,5 +2,5 @@

2title: Create a GitHub page with Hakyll and CircleCI

3author: Juan Pedro Villa

4url: https://www.stackbuilders.com/news/dr-hakyll-create-a-github-page-with-hakyll-and-circleci

5−type: external

5+external: true

6---

web/tutorials/external-inlining-and-compressing-css.md+1−1

@@ -2,5 +2,5 @@

2title: Inlining and compressing CSS

3author: Kyle Marek-Spartz

4url: http://kyle.marek-spartz.org/posts/2014-12-09-hakyll-css-template-compiler.html

5−type: external

5+external: true

6---

web/tutorials/faq.markdown−1

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

1---

2title: FAQ

3author: Jasper Van der Jeugt

4−type: article

5---

4---

6

5

7## "hGetContents: invalid argument" or "commitBuffer: invalid argument"

6## "hGetContents: invalid argument" or "commitBuffer: invalid argument"

web/tutorials/github-pages-tutorial.md−1

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

1---

2title: Using Hakyll with GitHub Pages

3author: Erik Stevenson

4−type: article

5---

4---

6

5

7## Introduction

6## Introduction

web/tutorials/hakyll-3-to-hakyll4-migration-guide.markdown−1

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

1---

2title: Hakyll 3 to Hakyll 4 migration guide

3author: Jasper Van der Jeugt

4−type: article

5---

4---

6

5

7Introduction

6Introduction

web/tutorials/robertwpearce-01-setup-and-initial-customization.htmldeleted−5

@@ -1,5 +0,0 @@

1−---

2−title: 'Pt. 1: Setup & Initial Customization'

3−url: 'https://robertwpearce.com/hakyll-pt-1-setup-and-initial-customization.html'

4−type: robertwpearce

5−---

web/tutorials/robertwpearce-02-generating-a-sitemap-xml-file.htmldeleted−5

@@ -1,5 +0,0 @@

1−---

2−title: 'Pt. 2: Generating a Sitemap XML File'

3−url: 'https://robertwpearce.com/hakyll-pt-2-generating-a-sitemap-xml-file.html'

4−type: robertwpearce

5−---

web/tutorials/robertwpearce-03-generating-rss-and-atom-xml-feeds.htmldeleted−5

@@ -1,5 +0,0 @@

1−---

2−title: 'Pt. 3: Generating RSS and Atom XML Feeds'

3−url: 'https://robertwpearce.com/hakyll-pt-3-generating-rss-and-atom-xml-feeds.html'

4−type: robertwpearce

5−---

web/tutorials/robertwpearce-04-copying-static-files-for-your-build.htmldeleted−5

@@ -1,5 +0,0 @@

1−---

2−title: 'Pt. 4: Copying Static Files For Your Build'

3−url: 'https://robertwpearce.com/hakyll-pt-4-copying-static-files-for-your-build.html'

4−type: robertwpearce

5−---

web/tutorials/robertwpearce-05-generating-custom-post-filenames-from-a-title-slug.htmldeleted−5

@@ -1,5 +0,0 @@

1−---

2−title: 'Pt. 5 – Generating Custom Post Filenames From a Title Slug'

3−url: 'https://robertwpearce.com/hakyll-pt-5-generating-custom-post-filenames-from-a-title-slug.html'

4−type: robertwpearce

5−---

web/tutorials/using-clay-with-hakyll.markdown−1

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

1---

2title: Using Clay with Hakyll

3author: Jasper Van der Jeugt

4−type: article

5---

4---

6

5

7[Clay](http://sebastiaanvisser.github.com/clay/) is a nice CSS preprocesser

6[Clay](http://sebastiaanvisser.github.com/clay/) is a nice CSS preprocesser

web/tutorials/using-teasers-in-hakyll.markdown−1

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

1---

2title: Using teasers in Hakyll

3author: Ivan Veselov

4−type: article

5---

4---

6

5

7## Introduction

6## Introduction