1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
|
{-# LANGUAGE OverloadedStrings #-}
module Text.Markdown.UnlitSpec (main, spec) where
import Test.Hspec
import Test.QuickCheck
import Data.String.Builder
import System.Environment
import Control.Exception
import System.Exit
import System.IO.Silently
import System.IO
import System.IO.Temp (withSystemTempFile)
import System.Directory
import qualified Control.Exception as E
import Text.Markdown.Unlit
main :: IO ()
main = hspec spec
withTempFile :: (FilePath -> IO ()) -> IO ()
withTempFile action = withSystemTempFile "hspec" $ \f h -> do
hClose h
action f `E.finally` removeFile f
spec :: Spec
spec = do
describe "run" $ do
it "prints a usage message" $ do
withProgName "foo" $ do
(r, Left (ExitFailure 1)) <- hCapture [stderr] (try $ run [])
r `shouldBe` "usage: foo [selector] -h SRC CUR DST\n"
it "unlits code marked with .haskell by default (unless it is marked with .ignore as well)" $ do
withTempFile $ \infile -> withTempFile $ \outfile -> do
writeFile infile . build $ do
"```haskell"
"some code"
"```"
"```haskell ignore"
"some other code"
"```"
run ["-h", "Foo.lhs", infile, outfile]
readFile outfile `shouldReturn` (build $ do
"#line 2 \"Foo.lhs\""
"some code"
)
it "moves code that is marked with .top to the beginning of the file" $ do
withTempFile $ \infile -> withTempFile $ \outfile -> do
writeFile infile . build $ do
"```haskell top"
"module Foo where"
"```"
""
"```haskell"
"foo :: Int"
"foo = 23"
"```"
""
"```haskell top"
"import Bar"
"```"
run ["-h", "Foo.lhs", infile, outfile]
readFile outfile `shouldReturn` (build $ do
"#line 2 \"Foo.lhs\""
"module Foo where"
"#line 11 \"Foo.lhs\""
"import Bar"
"#line 6 \"Foo.lhs\""
"foo :: Int"
"foo = 23"
)
it "can be customized" $ do
withTempFile $ \infile -> withTempFile $ \outfile -> do
writeFile infile . build $ do
"```foo"
"some code"
""
"```"
"``` {.bar}"
"some other code"
"```"
run ["bar", "-h", "Foo.lhs", infile, outfile]
readFile outfile `shouldReturn` (build $ do
"#line 6 \"Foo.lhs\""
"some other code"
)
describe "parseReorderingKey" $ do
it "returns 0" $ do
parseReorderingKey [] `shouldBe` 0
context "with .top" $ do
it "returns minBound" $ do
parseReorderingKey ["top"] `shouldBe` minBound
context "with top:n" $ do
it "returns (minBound + n)" $ do
parseReorderingKey ["top:20"] `shouldBe` minBound + 20
describe "parseSelector" $ do
it "parses + as :&:" $ do
parseSelector "foo+bar+baz" `shouldBe` Just ("foo" :&: "bar" :&: "baz")
it "parses whitespace as :|:" $ do
parseSelector "foo bar baz" `shouldBe` Just ("foo" :|: "bar" :|: "baz")
it "parses ! as Not" $ do
parseSelector "foo+!bar+baz" `shouldBe` Just ("foo" :&: Not "bar" :&: "baz")
it "can handle a combination of :&: and :|:" $ do
parseSelector "foo+bar baz+bar" `shouldBe` Just ("foo" :&: "bar" :|: "baz" :&: "bar")
it "is total" $ do
property $ \xs -> parseSelector xs `seq` True
describe "unlit" $ do
it "can be used to unlit everything with a specified class" $ do
unlit "Foo.lhs" "foo" . build $ do
"~~~ {.foo}"
"foo"
"~~~"
"~~~ {.bar}"
"bar"
"~~~"
`shouldBe` (build $ do
"#line 2 \"Foo.lhs\""
"foo"
)
it "can handle Not" $ do
unlit "Foo.lhs" (Not "foo") . build $ do
"~~~ {.foo}"
"1"
"~~~"
"~~~ {.bar}"
"2"
"~~~"
`shouldBe` (build $ do
"#line 5 \"Foo.lhs\""
"2"
)
it "can handle :&:" $ do
unlit "Foo.lhs" ("foo" :&: "bar") . build $ do
"~~~ {.foo}"
"some code"
"~~~"
"~~~ {.foo .bar}"
"some other code"
"~~~"
`shouldBe` (build $ do
"#line 5 \"Foo.lhs\""
"some other code"
)
it "can handle :|:" $ do
unlit "Foo.lhs" ("foo" :|: "bar") . build $ do
"~~~ {.foo}"
"foo"
"~~~"
"~~~ {.bar}"
"bar"
"~~~"
`shouldBe` (build $ do
"#line 2 \"Foo.lhs\""
"foo"
"#line 5 \"Foo.lhs\""
"bar"
)
it "can handle a combination of :&: and :|:" $ do
unlit "Foo.lhs" ("foo" :&: "bar" :|: "foo" :&: "baz") . build $ do
"~~~ {.foo .bar}"
"one"
"~~~"
"~~~ {.foo .baz}"
"two"
"~~~"
"~~~ {.bar .baz}"
"two"
"~~~"
`shouldBe` (build $ do
"#line 2 \"Foo.lhs\""
"one"
"#line 5 \"Foo.lhs\""
"two"
)
it "can handle a combination of :&: and Not" $ do
unlit "Foo.lhs" ("foo" :&: Not "bar" :&: "baz") . build $ do
"~~~ {.foo}"
"1"
"~~~"
"~~~ {.foo .bar}"
"2"
"~~~"
"~~~ {.foo .baz}"
"3"
"~~~"
"~~~ {.foo .bar .baz}"
"4"
"~~~"
`shouldBe` (build $ do
"#line 8 \"Foo.lhs\""
"3"
)
describe "parse" $ do
it "yields an empty list on empty input" $ do
parse "" `shouldBe` []
it "parses a code block" $ do
map codeBlockContent . parse . build $ do
"some text"
"~~~"
"some"
"code"
"~~~"
"some other text"
`shouldBe` [["some", "code"]]
it "accepts backticks as fence" $ do
parse . build $ do
"``` {.haskell .ignore}"
"some"
"code"
"```"
`shouldBe` [CodeBlock ["haskell", "ignore"] ["some", "code"] 2]
it "parses an indented code block" $ do
map codeBlockContent . parse . build $ do
"1. some text"
" ~~~"
" some"
" code"
" ~~~"
"2. some other text"
`shouldBe` [["some", " code"]]
it "parses an empty code block" $ do
map codeBlockContent . parse . build $ do
"some text"
"~~~"
"~~~"
"some other text"
`shouldBe` [[]]
it "attaches classes to code blocks" $ do
map codeBlockClasses . parse . build $ do
"~~~ {.haskell .literate}"
"some code"
"~~~"
`shouldBe` [["haskell", "literate"]]
it "attaches classes to indented code blocks" $ do
map codeBlockClasses . parse . build $ do
"1. some text"
" ~~~ {.haskell .literate}"
" some code"
" ~~~"
"2. some other text"
`shouldBe` [["haskell", "literate"]]
it "attaches source locations to code blocks" $ do
map codeBlockStartLine . parse . build $ do
"some text"
""
"~~~"
"some"
"code"
"~~~"
"some other text"
`shouldBe` [4]
describe "parseClasses" $ do
it "drops a leading dot" $ do
parseClasses "~~~ {.foo .bar}" `shouldBe` ["foo", "bar"]
it "treats dots as whitespace" $ do
parseClasses "~~~ {foo.bar. ..}" `shouldBe` ["foo", "bar"]
context "without {...}" $ do
it "accepts single class" $ do
parseClasses "```haskell" `shouldBe` ["haskell"]
it "accepts multiple classes" $ do
parseClasses "```.haskell .ignore" `shouldBe` ["haskell", "ignore"]
|