From 8afbb62ed5e969d78d8664df205646504f52f278 Mon Sep 17 00:00:00 2001 From: "Laurent P. René de Cotret" Date: Sat, 30 May 2020 08:14:21 -0400 Subject: Miscellaneous Windows-specific fixes and CI --- .github/workflows/main.yml | 8 +++++++- README.markdown | 2 +- lib/Hakyll/Core/Identifier/Pattern.hs | 11 +++-------- lib/Hakyll/Core/Routes.hs | 8 ++++++-- lib/Hakyll/Core/Util/String.hs | 7 +++++++ lib/Hakyll/Web/Html.hs | 12 ++++++++---- tests/Hakyll/Core/Routes/Tests.hs | 4 ++-- tests/Hakyll/Core/Rules/Tests.hs | 4 ++-- tests/Hakyll/Core/UnixFilter/Tests.hs | 8 ++++++++ tests/Hakyll/Web/Html/Tests.hs | 1 + tests/Hakyll/Web/Template/Tests.hs | 6 +++++- 11 files changed, 50 insertions(+), 21 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index b6c424e..9253d60 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -2,7 +2,13 @@ name: 'CI' on: ['push'] jobs: build: - runs-on: 'ubuntu-latest' + strategy: + matrix: + os: [ubuntu-latest, windows-latest] + + name: ${{ matrix.os }} + runs-on: $${{ matrix.os }} + steps: - uses: 'actions/checkout@v1' - uses: 'mstksg/setup-stack@v1' diff --git a/README.markdown b/README.markdown index f870226..e0a7604 100644 --- a/README.markdown +++ b/README.markdown @@ -1,6 +1,6 @@ # hakyll -[![Build Status](https://img.shields.io/circleci/project/github/jaspervdj/hakyll.svg)](https://circleci.com/gh/jaspervdj/hakyll) +![CI](https://github.com/jaspervdj/hakyll/workflows/CI/badge.svg) Hakyll is a static site generator library in Haskell. More information (including a tutorial) can be found on diff --git a/lib/Hakyll/Core/Identifier/Pattern.hs b/lib/Hakyll/Core/Identifier/Pattern.hs index 5e2597b..d07402d 100644 --- a/lib/Hakyll/Core/Identifier/Pattern.hs +++ b/lib/Hakyll/Core/Identifier/Pattern.hs @@ -75,6 +75,7 @@ import Text.Regex.TDFA ((=~)) -------------------------------------------------------------------------------- import Hakyll.Core.Identifier import Hakyll.Core.Identifier.Pattern.Internal +import Hakyll.Core.Util.String (removeWinPathSeparator) -------------------------------------------------------------------------------- @@ -183,7 +184,7 @@ matches (Complement p) i = not $ matches p i matches (And x y) i = matches x i && matches y i matches (Glob p) i = isJust $ capture (Glob p) i matches (List l) i = i `S.member` l -matches (Regex r) i = (normaliseRegex $ toFilePath i) =~ r +matches (Regex r) i = (removeWinPathSeparator $ toFilePath i) =~ r matches (Version v) i = identifierVersion i == v @@ -205,7 +206,7 @@ splits = inits &&& tails >>> uncurry zip >>> reverse capture :: Pattern -> Identifier -> Maybe [String] capture (Glob p) i = capture' p (toFilePath i) capture (Regex pat) i = Just groups - where (_, _, _, groups) = ((normaliseRegex $ toFilePath i) =~ pat) :: (String, String, String, [String]) + where (_, _, _, groups) = ((removeWinPathSeparator $ toFilePath i) =~ pat) :: (String, String, String, [String]) capture _ _ = Nothing @@ -263,9 +264,3 @@ fromCaptures' (m : ms) [] = case m of fromCaptures' (m : ms) ids@(i : is) = case m of Literal l -> l `mappend` fromCaptures' ms ids _ -> i `mappend` fromCaptures' ms is - - --------------------------------------------------------------------------------- --- | Normalise filepaths to have '/' as a path separator for Regex matching -normaliseRegex :: FilePath -> FilePath -normaliseRegex = concatMap (\c -> if c == '\\' then ['/'] else [c]) \ No newline at end of file diff --git a/lib/Hakyll/Core/Routes.hs b/lib/Hakyll/Core/Routes.hs index 06bf633..2411db9 100644 --- a/lib/Hakyll/Core/Routes.hs +++ b/lib/Hakyll/Core/Routes.hs @@ -46,7 +46,7 @@ module Hakyll.Core.Routes #if MIN_VERSION_base(4,9,0) import Data.Semigroup (Semigroup (..)) #endif -import System.FilePath (replaceExtension) +import System.FilePath (replaceExtension, normalise) -------------------------------------------------------------------------------- @@ -174,7 +174,11 @@ gsubRoute :: String -- ^ Pattern -> (String -> String) -- ^ Replacement -> Routes -- ^ Resulting route gsubRoute pattern replacement = customRoute $ - replaceAll pattern replacement . toFilePath + normalise . replaceAll pattern (replacement . removeWinPathSeparator) . removeWinPathSeparator . toFilePath + where + -- Filepaths on Windows containing `\\' will trip Regex matching, which + -- is used in replaceAll. We normalise filepaths to have '/' as a path separator + -- using removeWinPathSeparator -------------------------------------------------------------------------------- diff --git a/lib/Hakyll/Core/Util/String.hs b/lib/Hakyll/Core/Util/String.hs index f848369..67c436f 100644 --- a/lib/Hakyll/Core/Util/String.hs +++ b/lib/Hakyll/Core/Util/String.hs @@ -6,6 +6,7 @@ module Hakyll.Core.Util.String , replaceAll , splitAll , needlePrefix + , removeWinPathSeparator ) where @@ -76,3 +77,9 @@ needlePrefix needle haystack = go [] haystack go acc xss@(x:xs) | needle `isPrefixOf` xss = Just $ reverse acc | otherwise = go (x : acc) xs + + +-------------------------------------------------------------------------------- +-- | Translate native Windows path separators '\\' to '/' if present. +removeWinPathSeparator :: String -> String +removeWinPathSeparator = concatMap (\c -> if c == '\\' then ['/'] else [c]) \ No newline at end of file diff --git a/lib/Hakyll/Web/Html.hs b/lib/Hakyll/Web/Html.hs index 23ad78b..8cbfaa3 100644 --- a/lib/Hakyll/Web/Html.hs +++ b/lib/Hakyll/Web/Html.hs @@ -26,7 +26,7 @@ import Data.Char (digitToInt, intToDigit, isDigit, toLower) import Data.List (isPrefixOf) import qualified Data.Set as S -import System.FilePath.Posix (joinPath, splitPath, +import System.FilePath (joinPath, splitPath, takeDirectory) import Text.Blaze.Html (toHtml) import Text.Blaze.Html.Renderer.String (renderHtml) @@ -34,6 +34,10 @@ import qualified Text.HTML.TagSoup as TS import Network.URI (isUnreserved, escapeURIString) +-------------------------------------------------------------------------------- +import Hakyll.Core.Util.String (removeWinPathSeparator) + + -------------------------------------------------------------------------------- -- | Map over all tags in the document withTags :: (TS.Tag String -> TS.Tag String) -> String -> String @@ -116,7 +120,7 @@ parseTags' = TS.parseTagsOptions (TS.parseOptions :: TS.ParseOptions String) -- -- This also sanitizes the URL, e.g. converting spaces into '%20' toUrl :: FilePath -> String -toUrl url = case url of +toUrl url = case (removeWinPathSeparator url) of ('/' : xs) -> '/' : sanitize xs xs -> '/' : sanitize xs where @@ -130,8 +134,8 @@ toUrl url = case url of -------------------------------------------------------------------------------- -- | Get the relative url to the site root, for a given (absolute) url toSiteRoot :: String -> String -toSiteRoot = emptyException . joinPath . map parent - . filter relevant . splitPath . takeDirectory +toSiteRoot = removeWinPathSeparator . emptyException . joinPath + . map parent . filter relevant . splitPath . takeDirectory where parent = const ".." emptyException [] = "." diff --git a/tests/Hakyll/Core/Routes/Tests.hs b/tests/Hakyll/Core/Routes/Tests.hs index fc3d676..a3e1736 100644 --- a/tests/Hakyll/Core/Routes/Tests.hs +++ b/tests/Hakyll/Core/Routes/Tests.hs @@ -10,7 +10,7 @@ import Data.Maybe (fromMaybe) import Hakyll.Core.Identifier import Hakyll.Core.Metadata import Hakyll.Core.Routes -import System.FilePath (()) +import System.FilePath ((), normalise) import Test.Tasty (TestTree, testGroup) import Test.Tasty.HUnit (Assertion, (@=?)) import TestSuite.Util @@ -46,5 +46,5 @@ testRoutes expected r id' = do store <- newTestStore provider <- newTestProvider store (route, _) <- runRoutes r provider id' - Just expected @=? route + Just (normalise expected) @=? route cleanTestEnv diff --git a/tests/Hakyll/Core/Rules/Tests.hs b/tests/Hakyll/Core/Rules/Tests.hs index 24b5b8c..80baf02 100644 --- a/tests/Hakyll/Core/Rules/Tests.hs +++ b/tests/Hakyll/Core/Rules/Tests.hs @@ -17,7 +17,7 @@ import Hakyll.Core.Metadata import Hakyll.Core.Routes import Hakyll.Core.Rules import Hakyll.Core.Rules.Internal -import System.FilePath (()) +import System.FilePath ((), normalise) import Test.Tasty (TestTree, testGroup) import Test.Tasty.HUnit (Assertion, (@=?)) import TestSuite.Util @@ -39,7 +39,7 @@ case01 = do let identifiers = S.fromList $ map fst $ rulesCompilers ruleSet routes = rulesRoutes ruleSet checkRoute ex i = - runRoutes routes provider i >>= \(r, _) -> Just ex @=? r + runRoutes routes provider i >>= \(r, _) -> Just (normalise ex) @=? r -- Test that we have some identifiers and that the routes work out S.fromList expected @=? identifiers diff --git a/tests/Hakyll/Core/UnixFilter/Tests.hs b/tests/Hakyll/Core/UnixFilter/Tests.hs index e4e0f23..314967e 100644 --- a/tests/Hakyll/Core/UnixFilter/Tests.hs +++ b/tests/Hakyll/Core/UnixFilter/Tests.hs @@ -1,5 +1,6 @@ -------------------------------------------------------------------------------- {-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE CPP #-} module Hakyll.Core.UnixFilter.Tests ( tests ) where @@ -22,10 +23,17 @@ import TestSuite.Util -------------------------------------------------------------------------------- tests :: TestTree tests = testGroup "Hakyll.Core.UnixFilter.Tests" +#ifdef mingw32_HOST_OS + -- The `rev` utility is not present by default on Windows + [ testCase "unixFilter false" unixFilterFalse + , testCase "unixFilter error" unixFilterError + ] +#else [ testCase "unixFilter rev" unixFilterRev , testCase "unixFilter false" unixFilterFalse , testCase "unixFilter error" unixFilterError ] +#endif testMarkdown :: Identifier testMarkdown = "russian.md" diff --git a/tests/Hakyll/Web/Html/Tests.hs b/tests/Hakyll/Web/Html/Tests.hs index 3d0a887..cd362f4 100644 --- a/tests/Hakyll/Web/Html/Tests.hs +++ b/tests/Hakyll/Web/Html/Tests.hs @@ -44,6 +44,7 @@ tests = testGroup "Hakyll.Web.Html.Tests" $ concat , fromAssertions "toUrl" [ "/foo/bar.html" @=? toUrl "foo/bar.html" + , "/foo/bar.html" @=? toUrl "foo\\bar.html" -- Windows-specific , "/" @=? toUrl "/" , "/funny-pics.html" @=? toUrl "/funny-pics.html" , "/funny%20pics.html" @=? toUrl "funny pics.html" diff --git a/tests/Hakyll/Web/Template/Tests.hs b/tests/Hakyll/Web/Template/Tests.hs index a73b92d..1c7c571 100644 --- a/tests/Hakyll/Web/Template/Tests.hs +++ b/tests/Hakyll/Web/Template/Tests.hs @@ -12,6 +12,7 @@ import Test.Tasty.HUnit (Assertion, assertBool, testCase, (@=?), (@?=)) import Data.Either (isLeft) +import System.IO (nativeNewline, Newline(..)) -------------------------------------------------------------------------------- import Hakyll.Core.Compiler @@ -149,8 +150,11 @@ testEmbeddedTemplate = do str <- testCompilerDone store provider "item3" $ applyTemplate embeddedTemplate defaultContext item - itemBody str @?= "

Hello, world

\n" + itemBody str @?= ("

Hello, world

" ++ (newline nativeNewline)) cleanTestEnv where item = Item "item1" "Hello, world" + + newline LF = "\n" + newline CRLF = "\r\n" -- cgit v1.2.3