DocsSpec.hs

{-# LANGUAGE ExtendedDefaultRules, OverloadedStrings, QuasiQuotes #-}
module Nirum.DocsSpec where

import Data.List.NonEmpty (NonEmpty ((:|)))

import Data.Text (Text, snoc)
import Test.Hspec.Meta
import Text.InterpolatedString.Perl6 (q)

import Nirum.Docs

sampleSource :: Text
sampleSource = [q|
Hello
=====

Tight list:

- List test
- test2

Loose list:

1. a

2. b

A [complex *link*][1].

Table example                                                   {#table-section}
-------------

| A     | B      | C            | D     |
| ----- | :----- | :----------: | ----: |
| foo   | bar    | baz          | bim   |
| qux   | quux   | ![](img.jpg) | quuz  |
| corge | grault | garply       | waldo |
| ga    | na     | da           | ra    |

[1]: http://nirum.org/ "Nirum"

|]

sampleHeading :: Block
sampleHeading =
    Heading H1 ["Hello"] Nothing

sampleDocument :: Block
sampleDocument =
    sampleDocument' (sampleHeading :)

sampleDocument' :: ([Block] -> [Block]) -> Block
sampleDocument' adjust =
    sampleDocument_ adjust "http://nirum.org/" (Image "img.jpg" "")

sampleDocument_ :: ([Block] -> [Block]) -> Url -> Inline -> Block
sampleDocument_ adjust url img =
    (Document . adjust)
        [ Paragraph ["Tight list:"]
        , List BulletList $ TightItemList [ [Paragraph ["List test"]]
                                          , [Paragraph ["test2"]]
                                          ]
        , Paragraph ["Loose list:"]
        , List (OrderedList 1 Period) $
               LooseItemList [ [Paragraph ["a"]]
                             , [Paragraph ["b"]]
                             ]
        , Paragraph
              [ "A "
              , Link url "Nirum"
                     ["complex ", Emphasis ["link"]]
              , "."
              ]
        , Heading H2 ["Table example"] (Just "table-section")
        , Table
              (NotAligned :| [LeftAligned, CenterAligned, RightAligned])
              ( (["A"] :| [["B"], ["C"], ["D"]])
              :| [ ["foo"] :| [["bar"], ["baz"], ["bim"]]
                 , ["qux"] :| [["quux"], [img], ["quuz"]]
                 , ["corge"] :| [["grault"], ["garply"], ["waldo"]]
                 , ["ga"] :| [["na"], ["da"], ["ra"]]
                 ]
              )
        ]

spec :: Spec
spec = do
    describe "HeadingLevel" $
        specify "headingLevelFromInt" $ do
            headingLevelFromInt (-1) `shouldBe` H1
            headingLevelFromInt 0 `shouldBe` H1
            headingLevelFromInt 1 `shouldBe` H1
            headingLevelFromInt 2 `shouldBe` H2
            headingLevelFromInt 3 `shouldBe` H3
            headingLevelFromInt 4 `shouldBe` H4
            headingLevelFromInt 5 `shouldBe` H5
            headingLevelFromInt 6 `shouldBe` H6
            headingLevelFromInt 7 `shouldBe` H6
            headingLevelFromInt 99 `shouldBe` H6
    specify "parse" $
        parse sampleSource `shouldBe` sampleDocument
    specify "filterReferences" $
        filterReferences [ "A paragraph that consists of a "
                         , Link "http://nirum.org/" ""
                                [ Emphasis ["hyper"], " link" ]
                         , " and an "
                         , Image "./img.png" "image"
                         , "."
                         ]
            `shouldBe`
                [ "A paragraph that consists of a "
                , Emphasis ["hyper"]
                , " link"
                , " and an "
                , "image"
                , "."
                ]
    specify "extractTitle" $ do
        let Heading lv inlines _ = sampleHeading
        extractTitle sampleDocument `shouldBe` Just (lv, inlines)
        extractTitle (sampleDocument' id) `shouldBe` Nothing
    specify "trimTitle" $ do
        -- Remove the top-level heading if it exists:
        trimTitle sampleDocument `shouldBe` sampleDocument' id
        -- No-op if there is no top-level heading:
        trimTitle (sampleDocument' id) `shouldBe` sampleDocument' id
    specify "transformReferences" $
        transformReferences (`snoc` '?') sampleDocument `shouldBe`
            sampleDocument_
                (sampleHeading :)
                "http://nirum.org/?"
                (Image "img.jpg?" "")