Implementation and test for horizontal rule

OList and UList line parsing to us it

app/Main.hs

@@ -1,8 +1,27 @@
 module Main where
 
 import MdToHTML
+import System.Environment
+import System.IO
+
+readLinesHelper :: [String] -> IO [String]
+readLinesHelper xs = do
+  done <- isEOF
+  if done
+    then return xs
+    else do
+      line <- getLine
+      let xs' = line : xs
+      readLinesHelper xs'
+
+readLines :: IO [String]
+readLines = reverse <$> readLinesHelper []
 
 main :: IO ()
 main = do
-   let res = fst $ leftmostLongestParse parseDocument "# _Hello_\n"
+  args <- getArgs
-   putStrLn (show res)
+  fileContents <- case args of
+    [] -> getContents
+    x : _ -> readFile x
+  let res = fst $ leftmostLongestParse parseDocument fileContents
+  print res

md-to-html.cabal

@@ -56,6 +56,7 @@ common warnings
 library
    hs-source-dirs:   src
    exposed-modules: MdToHTML
+   other-modules: MdToHtmlTest
    build-depends:    base ^>=4.19.1.0,
                       HUnit
 
@@ -66,8 +67,6 @@ executable md-to-html-runner
     -- .hs or .lhs file containing the Main module.
     main-is:          Main.hs
 
-    -- Modules included in this executable, other than Main.
-    -- other-modules:
 
     -- LANGUAGE extensions used by modules in this package.
     -- other-extensions:

src/MdToHTML.hs

@@ -1,19 +1,23 @@
-{-# LANGUAGE InstanceSigs #-}
+{-# OPTIONS_GHC -Wno-unrecognised-pragmas #-}
+
+{-# HLINT ignore "Use lambda-case" #-}
 
 module MdToHTML where
 
 import Control.Applicative
 import Control.Monad
+import Data.Char
 import Data.List
+import Data.Ord (comparing)
 import Debug.Trace
 import Text.ParserCombinators.ReadP
 import Text.Printf
 
 type HeaderLevel = Int
 
-newtype URL = URL {getUrl :: String}
+newtype URL = URL {getUrl :: String} deriving (Eq)
 
-newtype ImgPath = ImgPath {getPath :: String}
+newtype ImgPath = ImgPath {getPath :: String} deriving (Eq)
 
 parseMany :: ReadP a -> ReadP [a]
 parseMany = Text.ParserCombinators.ReadP.many
@@ -26,64 +30,97 @@ data MdToken
   | SingleNewline -- A single newline is rendered as a space.
   | Linebreak
   | HorizontalRule
-  | Blockquote MdToken
+  | Blockquote [MdToken]
   | UnordList [MdToken]
   | OrdList [MdToken]
-  | Code String
+  | Code MdToken
   | Codeblock String
   | Link MdToken URL
   | Image MdToken ImgPath
+  | Figure MdToken ImgPath
   | Bold MdToken
   | Italic MdToken
   | Strikethrough MdToken
   | Unit String
+  deriving (Eq)
 
 -- Deriving Show for MdToken
 instance Show MdToken where
-  show :: MdToken -> String
   show (Document tokens) = concatMap show tokens
   show (Header level token) = "<h" ++ show level ++ ">" ++ show token ++ "</h" ++ show level ++ ">"
   show (Para token) = "<p>" ++ show token ++ "</p>"
   show (Line tokens) = concatMap show tokens
   show Linebreak = "<br>"
   show SingleNewline = " "
-  show HorizontalRule = "---------"
+  show HorizontalRule = "<hr>"
-  show (Blockquote token) = "<blockquote>" ++ show token ++ "</blockquote>"
+  show (Blockquote tokens) = "<blockquote>" ++ concatMap show tokens ++ "</blockquote>"
-  show (UnordList tokens) = "UNORD" ++ concatMap show tokens
+  show (UnordList tokens) = "<ul>" ++ concatMap (prepend "<li>" . append "</li>" . show) tokens ++ "</ul>"
-  show (OrdList tokens) = "ORD" ++ concatMap show tokens
+  show (OrdList tokens) = "<ol>" ++ concatMap (prepend "<li>" . append "</li>" . show) tokens ++ "</ol>"
-  show (Code code) = show code
+  show (Code code) = "<code>" ++ show code ++ "</code>"
   show (Codeblock code) = show code
   show (Link txt url) = "<a href=\"" ++ getUrl url ++ "\">" ++ show txt ++ "</a>"
-  show (Image txt imgPath) = "<img src=" ++ getPath imgPath ++ ">" ++ show txt ++ "</img>"
+  show (Image txt imgPath) = "<img src=\"" ++ getPath imgPath ++ "\"" ++ " alt=\"" ++ show txt ++ "\" />"
+  show (Figure txt imgPath) = "<figure><img src=\"" ++ getPath imgPath ++ "\" alt=\"" ++ show txt ++ "\"/><figcaption aria-hidden=\"true\">" ++ show txt ++ "</figcaption></figure>"
   show (Bold token) = "<b>" ++ show token ++ "</b>"
   show (Italic token) = "<i>" ++ show token ++ "</i>"
   show (Strikethrough token) = "<s>" ++ show token ++ "</s>"
   show (Unit unit) = printf "%s" unit
 
+instance Semigroup MdToken where
+  a <> b = Document [a, b]
+
+instance Monoid MdToken where
+  mempty = Unit ""
+
 -- ---------------
 -- Helpers
-leftmostLongest :: (Foldable t) => [(a, t b)] -> (a, t b)
+leftmostLongest :: (Foldable t) => [(a, t b)] -> Maybe (a, t b)
 leftmostLongest xs =
   let lastElem = last xs
       filteredLst = filter (\val -> length (snd val) == length (snd lastElem)) xs
-   in head filteredLst
+   in case filteredLst of
+        [] -> Nothing
+        (x : xs) -> Just x
 
 -- Get the first parse returned by readP_to_S that consumed the most input
-leftmostLongestParse :: ReadP a -> String -> (a, String)
+leftmostLongestParse :: (Monoid a) => ReadP a -> String -> (a, String)
-leftmostLongestParse parser input = leftmostLongest $ readP_to_S parser input
+leftmostLongestParse parser input =
+  let res = leftmostLongest $ readP_to_S parser input
+   in case res of
+        Nothing -> (mempty, mempty)
+        Just x -> x
 
--- Parse if the string that's left matches the string comparator function
+specialChars = "\n\\`*_{}[]()<>#+|"
-lookaheadParse :: (String -> Bool) -> ReadP Char
-lookaheadParse stringCmp = do
-  lookahead <- look
-  case stringCmp lookahead of
-    True -> get
-    False -> pfail
 
-lineToList :: MdToken -> [MdToken]
+escapableChars = "-~!." ++ specialChars
-lineToList (Line tokens) = tokens
 
-specialChars = "\\#*_[\n "
+-- Makes a parser greedy. Instead of returning all possible parses, only the longest one is returned.
+greedyParse :: ReadP a -> ReadP [a]
+greedyParse parser = do
+  greedyParse1 parser <++ return []
+
+-- Like greedyParse, but the parser must succeed atleast once.
+greedyParse1 :: ReadP a -> ReadP [a]
+greedyParse1 parser = do
+  parsed1 <- parser
+  parsed2 <- greedyParse1 parser <++ return []
+  return (parsed1 : parsed2)
+
+prepend :: [a] -> [a] -> [a]
+prepend x1 x2 = x1 ++ x2
+
+append :: [a] -> [a] -> [a]
+append x1 x2 = x2 ++ x1
+
+-- Parse until EOL or EOF
+parseTillEol :: ReadP String
+parseTillEol = manyTill get (void (char '\n') <++ eof)
+
+-- Takes a list of parsers. Returns a parser that will try them in
+-- order, moving to the next one only if the current one fails.
+fallthroughParser :: [ReadP a] -> ReadP a
+fallthroughParser [x] = x
+fallthroughParser (x : xs) = x <++ fallthroughParser xs
 
 -- ---------------
 
@@ -97,31 +134,46 @@ parseHeader = do
     pfail
   skipSpaces
   text <- munch1 (/= '\n')
-  Text.ParserCombinators.ReadP.optional (char '\n')
+  --  Text.ParserCombinators.ReadP.optional (char '\n')
+  skipSpaces
   let parsedText = fst $ leftmostLongestParse parseLine text
   return (Header (length headers) parsedText)
 
 -- Parse bold text
 parseBold :: ReadP MdToken
-parseBold = do
+parseBold = parseBoldWith "**" <|> parseBoldWith "__"
-  text <-
+  where
-    choice
+    parseBoldWith delim = do
-      [ between (string "__") (string "__") (many1 (lookaheadParse (/= "__"))),
+      string delim
-        between (string "**") (string "**") (many1 (lookaheadParse (/= "**")))
+      inside <- greedyParse1 parseLineToken
-      ]
+      string delim
-  let parsedText = fst $ leftmostLongestParse parseLine text
+      return (Bold (Line inside))
-  return (Bold parsedText)
 
 -- Parse italic text
 parseItalic :: ReadP MdToken
-parseItalic = do
+parseItalic = parseItalicWith "*" <|> parseItalicWith "_"
-  text <-
+  where
-    choice
+    parseItalicWith delim = do
-      [ between (string "_") (string "_") (munch1 (/= '_')),
+      string delim
-        between (string "*") (string "*") (munch1 (/= '*'))
+      inside <- greedyParse1 parseLineToken
-      ]
+      string delim
-  let parsedText = fst $ leftmostLongestParse parseLine text
+      return (Italic (Line inside))
-  return (Italic parsedText)
+
+-- Parse strikethrough text
+parseStrikethrough :: ReadP MdToken
+parseStrikethrough = do
+  string "~~"
+  inside <- many1 parseLineToken
+  string "~~"
+  return (Strikethrough (Line inside))
+
+-- Parse code
+parseCode :: ReadP MdToken
+parseCode = do
+  string "`"
+  inside <- many1 get
+  string "`"
+  return (Code (Unit inside))
 
 -- Parse a link
 parseLink :: ReadP MdToken
@@ -142,40 +194,80 @@ parseLinebreak = do
 parseSingleNewline :: ReadP MdToken
 parseSingleNewline = do
   char '\n'
-  return SingleNewline
+  remaining <- look
+  case remaining of
+    [] -> return $ Unit ""
+    _ -> return SingleNewline
+
+parseImage :: ReadP MdToken
+parseImage = do
+  char '!'
+  char '['
+  altText <- many1 (parseEscapedChar <++ parseUnit)
+  char ']'
+  char '('
+  path <- many1 get
+  char ')'
+  return $ Image (Line altText) (ImgPath path)
+
+parseFigure = do
+  img <- parseImage
+  void (string "\n\n") <++ eof
+  case img of
+    Image text path -> return $ Figure text path
+    _ -> return img
 
 -- Parse an escaped character
 parseEscapedChar :: ReadP MdToken
 parseEscapedChar = do
   char '\\'
-  escapedChar <- choice (map char specialChars) -- Parse any of the special chars.
+  escapedChar <- choice (map char escapableChars) -- Parse any of the special chars.
   return (Unit [escapedChar])
 
--- Parse a regular string as a Unit.
+-- Parse a character as a Unit.
-parseString :: ReadP MdToken
+parseUnit :: ReadP MdToken
-parseString = do
+parseUnit = do
-  firstChar <- satisfy (/= '\n') -- Must parse at least one non-newline character here
+  text <- satisfy (`notElem` specialChars)
-  text <- munch (`notElem` specialChars)
+  return (Unit [text])
-  return (Unit (firstChar : text))
 
 lineParsers :: [ReadP MdToken]
 lineParsers =
   [ parseLinebreak,
     parseSingleNewline,
     parseEscapedChar,
+    parseCode,
+    parseImage,
     parseBold,
     parseItalic,
+    parseStrikethrough,
     parseLink,
-    parseString
+    parseUnit
   ] -- A 'line' doesn't include a 'header'
 
+listLineParsers :: [ReadP MdToken]
+listLineParsers =
+  [ parseLinebreak,
+    parseEscapedChar,
+    parseCode,
+    parseImage,
+    parseBold,
+    parseItalic,
+    parseStrikethrough,
+    parseLink,
+    parseUnit
+  ] -- A list line cannot contain newlines.
+
 -- List of all parsers
 allParsers :: [ReadP MdToken]
 allParsers = parseHeader : lineParsers
 
--- Parse any of the above tokens.
+-- Parse any of the line tokens.
 parseLineToken :: ReadP MdToken
-parseLineToken = choice lineParsers
+parseLineToken = fallthroughParser lineParsers
+
+-- Parse any of the list line tokens.
+parseListLineToken :: ReadP MdToken
+parseListLineToken = fallthroughParser listLineParsers
 
 -- Parse a line, consisting of one or more tokens.
 parseLine :: ReadP MdToken
@@ -194,16 +286,143 @@ parsePara = do
   text <- manyTill get (string "\n\n" <|> (eof >> return ""))
   when (null text) pfail
   let parsedText = fst $ leftmostLongestParse parseLine text -- Parse a line
+  parseMany (char '\n')
   return (Para parsedText)
 
+-- Parse a line starting with '>', return the line except for the '>'.
+parseQuotedLine :: ReadP String
+parseQuotedLine = do
+  char '>'
+  greedyParse (char ' ' +++ char '\t')
+  restOfLine <- munch (/= '\n')
+  Text.ParserCombinators.ReadP.optional (char '\n') >> return ""
+  return restOfLine
+
+-- Parse many 'quoted lines' until I see a non-quoted line.
+parseQuotedLines :: ReadP [String]
+parseQuotedLines =
+  greedyParse1 $ do
+    look >>= \line ->
+      case line of
+        ('>' : _) -> parseQuotedLine
+        _ -> pfail
+
 -- Parse a blockquote, which is a greater-than sign followed by a paragraph.
 parseBlockquote :: ReadP MdToken
 parseBlockquote = do
-  char '>'
+  quotedLines <- parseQuotedLines
-  Blockquote <$> (parseBlockquote <++ parsePara) -- Parse another blockquote or a regular paragraph, wrap it in a blockquote.
+  -- remaining <- look
+  -- let quotedLines = fst $ leftmostLongestParse parseQuotedLines remaining
+  -- string (init $ unlines quotedLines)
+  let parsedQuotedLines = fst $ leftmostLongestParse (many1 (parseBlockquote <++ parsePara)) (init $ unlines quotedLines) -- unlines joins the lines together with a newline, and adds a trailing newline. init removes the trailing newline.
+  return (Blockquote parsedQuotedLines)
+
+-- Parse a nested list item.
+parseListNested :: ReadP MdToken
+parseListNested = do
+  let firstCharParser = string "    " <++ string "\t"
+  let restOfLineParser = manyTill get (void (char '\n') <++ eof)
+  lines <- greedyParse1 (firstCharParser *> restOfLineParser)
+  let linesParsed = fst $ leftmostLongestParse (parseUnorderedList <++ parseOrderedList) (init $ unlines lines)
+  when (null (show linesParsed)) pfail
+  return linesParsed
+
+-- Parse an unordered list line item.
+parseUListLineItem :: ReadP MdToken
+parseUListLineItem = do
+  firstChar <- choice (map char ['*', '+', '-'])
+  char ' ' -- At least one space between list indicator and list text.
+  parseListLineItemCommon
+
+-- Parse an ordered list line item.
+parseOListLineItem :: ReadP MdToken
+parseOListLineItem = do
+  num <- greedyParse1 (satisfy isDigit)
+  char '.'
+  char ' ' -- At least one space between list indicator and list text.
+  parseListLineItemCommon
+
+-- Common code for parsing list line items
+parseListLineItemCommon :: ReadP MdToken
+parseListLineItemCommon = do
+  skipSpaces
+  restOfLine <- many1 parseListLineToken
+  void (char '\n') <++ eof
+  nestedList <- parseListNested <++ return (Unit "")
+  return $ Line [Line restOfLine, nestedList]
+
+-- Parse an unordered list paragraph item.
+parseUListParaItem :: ReadP MdToken
+parseUListParaItem = do
+  firstLine <- parseUListLineItem
+  res <- parseListParaItemCommon
+  return $ Document (Para firstLine : res) -- I only wrap this in a document because I want some way of converting [MdToken] to MdToken, without any overhead. There is no other reason to wrap it in a Document.
+
+-- Parse an unordered list paragraph item.
+parseOListParaItem :: ReadP MdToken
+parseOListParaItem = do
+  firstLine <- parseOListLineItem
+  res <- parseListParaItemCommon
+  return $ Document (Para firstLine : res) -- I only wrap this in a document because I want some way of converting [MdToken] to MdToken, without any overhead. There is no other reason to wrap it in a Document.
+
+-- Common code for parsing list paragraph items.
+-- A list paragraph item is defined as a line item, followed by an empty line, followed by one or more
+-- lines indented by a space or tab.
+-- A list paragraph item can also be a blockquote.
+parseListParaItemCommon :: ReadP [MdToken]
+parseListParaItemCommon = do
+  char '\n'
+  lines <- greedyParse1 ((string "    " <|> string "\t") *> parseTillEol)
+  let res = fst $ leftmostLongestParse (greedyParse1 parseBlockquote <++ greedyParse1 parsePara) (init $ unlines lines)
+  char '\n'
+  return res -- I only wrap this in a document because I want some way of converting [MdToken] to MdToken, without any overhead. There is no other reason to wrap it in a Document.
+
+-- Parse an unordered list item, which can be a line item or another list.
+parseUListItem :: ReadP MdToken
+parseUListItem = parseUListParaItem <++ parseUListLineItem
+
+-- Parse an unordered list.
+parseUnorderedList :: ReadP MdToken
+parseUnorderedList = do
+  lineItems <- greedyParse1 parseUListItem
+  void (char '\n') <++ eof -- A list must end in an extra newline or eof
+  return $ UnordList lineItems
+
+-- --------
+
+parseOListItem :: ReadP MdToken
+parseOListItem = parseOListParaItem <++ parseOListLineItem
+
+-- Parses the first element of an ordered list, which must start with '1.'
+parseFirstOListItem :: ReadP MdToken
+parseFirstOListItem = do
+  remaining <- look
+  when (take 2 remaining /= "1.") pfail
+  parseOListLineItem
+
+parseOrderedList :: ReadP MdToken
+parseOrderedList = do
+  firstLine <- parseFirstOListItem
+  lineItems <- greedyParse1 parseOListItem
+  void (char '\n') <++ eof
+  return $ OrdList (firstLine : lineItems)
+
+parseHorizontalRule :: ReadP MdToken
+parseHorizontalRule = string "---" *> (void (string "\n\n") <++ eof) *> return HorizontalRule
+
+documentParsers :: [ReadP MdToken]
+documentParsers =
+  [ parseHorizontalRule,
+    parseHeader,
+    parseBlockquote,
+    parseUnorderedList,
+    parseOrderedList,
+    parseFigure,
+    parsePara
+  ]
 
 -- Parse a document, which is multiple paragraphs.
 parseDocument :: ReadP MdToken
 parseDocument = do
-  res <- manyTill (parseHeader <++ parseBlockquote <++ parsePara) eof
+  res <- manyTill (fallthroughParser documentParsers) eof
   return (Document res)

src/MdToHtmlTest.hs

@@ -0,0 +1,158 @@
+module MdToHtmlTest where
+
+import MdToHTML
+import Test.HUnit
+
+check_equal :: String -> String -> String -> Test
+check_equal desc expected actual = TestCase (assertEqual desc expected actual)
+
+convert :: String -> String
+convert md = show . fst $ leftmostLongestParse parseDocument md
+
+headerTests =
+  TestList
+    [ check_equal "Should convert H1 heading" "<h1>Hello</h1>" (convert "# Hello"),
+      check_equal "Should convert H2 heading" "<h2>Hello</h2>" (convert "## Hello"),
+      check_equal "Should convert H3 heading" "<h3>Hello</h3>" (convert "### Hello"),
+      check_equal "Should convert H4 heading" "<h4>Hello</h4>" (convert "#### Hello"),
+      check_equal "Should convert H5 heading" "<h5>Hello</h5>" (convert "##### Hello"),
+      check_equal "Should convert H6 heading" "<h6>Hello</h6>" (convert "###### Hello")
+    ]
+
+boldTests =
+  TestList
+    [ check_equal "Should convert bold" "<p><b>Hello</b></p>" (convert "__Hello__"),
+      check_equal "Should convert italic" "<p><i>Hello</i></p>" (convert "_Hello_"),
+      check_equal "Should convert bold and italic in a sentence" "<p>It <i>is</i> a <b>wonderful</b> day</p>" (convert "It _is_ a __wonderful__ day"),
+      check_equal "Should convert nested bold and italic" "<p><b>Bold then <i>Italic</i></b></p>" (convert "**Bold then *Italic***"),
+      check_equal "Should convert nested bold and italic" "<p><i>Italic then <b>Bold</b></i></p>" (convert "*Italic then **Bold***")
+    ]
+
+strikethroughTests =
+  TestList
+    [ check_equal "Should convert strikethrough" "<p><s>Hello</s></p>" (convert "~~Hello~~"),
+      check_equal "Should convert long sentence with tilde" "<p><s>The universe is ~7 days old</s>. The universe is 13 billion years old.</p>" (convert "~~The universe is ~7 days old~~. The universe is 13 billion years old.")
+    ]
+
+linkTests =
+  TestList
+    [ check_equal "Should convert normal link" "<p><a href=\"https://example.com\">This is an example link.</a></p>" (convert "[This is an example link.](https://example.com)"),
+      check_equal "Should convert styled link" "<p><a href=\"https://example.com\"><b>Fancy</b>!!!</a></p>" (convert "[__Fancy__!!!](https://example.com)")
+    ]
+
+escapedCharTests =
+  TestList
+    [ check_equal "Should print literal underscore" "<p>This is an underscore - _</p>" (convert "This is an underscore - \\_"),
+      check_equal "Should print literal asterisk" "<p>This is an asterisk - *</p>" (convert "This is an asterisk - \\*"),
+      check_equal "Should print literal asterisk in bold" "<p>This is a bolded asterisk - <b>*</b></p>" (convert "This is a bolded asterisk - **\\***")
+    ]
+
+blockquoteTests =
+  TestList
+    [ check_equal "Should wrap para in blockquote" "<blockquote><p>What a <b>truly</b> <i>lovely</i> day!!!</p></blockquote>" (convert "> What a __truly__ _lovely_ day!!!"),
+      check_equal "Simple nested blockquotes" "<blockquote><p>Hello</p><blockquote><p>World</p></blockquote></blockquote>" (convert "> Hello\n>\n>> World"),
+      check_equal
+        "Nested blockquotes"
+        "<blockquote><p>Dorothy followed her through many \
+        \of the beautiful rooms in her castle.</p><blockquote><p>The Witch \
+        \bade her clean the pots and kettles and sweep the floor and keep the fire \
+        \fed with wood.</p></blockquote></blockquote>"
+        ( convert
+            "> Dorothy followed her through many of the \
+            \beautiful rooms in her castle.\n> \n>> The Witch bade her \
+            \clean the pots and kettles and sweep the floor and keep the fire fed with wood."
+        )
+    ]
+
+unorderedListTests =
+  TestList
+    [ check_equal "Basic unordered list" "<ul><li>Item 1</li><li>Item 2</li><li>Item 3</li></ul>" (convert "* Item 1\n* Item 2\n* Item 3"),
+      check_equal "Mixing list indicators" "<ul><li>Item 1</li><li>Item 2</li><li>Item 3</li></ul>" (convert "* Item 1\n+ Item 2\n- Item 3"),
+      check_equal "Formatted lists" "<ul><li><b>Item 1</b></li><li><i>Item 2</i></li><li><b><i>Item 3</i></b></li></ul>" (convert "* __Item 1__\n+ _Item 2_\n- ***Item 3***"),
+      check_equal "Nested list" "<ul><li>Item 1</li><li>Item 2</li><li>Item 3<ul><li>Subitem 1</li><li>Subitem 2</li></ul></li></ul>" (convert "* Item 1\n* Item 2\n* Item 3\n    * Subitem 1\n    * Subitem 2"),
+      check_equal "Paragraph in list" "<ul><li>Item 1</li><li><p>Item 2</p><p>More stuff</p></li><li>Item 3</li></ul>" (convert "- Item 1\n- Item 2\n\n    More stuff\n\n- Item 3"),
+      check_equal "Paragraph before list" "<p>This is a list</p><ul><li>Item 1</li><li>Item 2</li></ul>" (convert "This is a list\n\n* Item 1\n* Item 2"),
+      check_equal "Paragraph before list" "<h3>This is a list</h3><ul><li>Item 1</li><li>Item 2</li></ul>" (convert "### This is a list\n\n* Item 1\n* Item 2"),
+      check_equal "Nested list then back" "<ul><li>Item 1</li><li>Item 2<ul><li>Item 3</li><li>Item 4</li></ul></li><li>Item 5</li></ul>" (convert "- Item 1\n- Item 2\n    - Item 3\n    - Item 4\n- Item 5"),
+      check_equal "Blockquote in list" "<ul><li>Item 1</li><li><p>Item 2</p><blockquote><p>Quote</p></blockquote></li><li>Item 3</li></ul>" (convert "- Item 1\n- Item 2\n\n    > Quote\n\n- Item 3"),
+      check_equal "Ordered list in unordered list" "<ul><li>Item 1</li><li>Item 2<ol><li>Item 1</li><li>Item 2</li></ol></li><li>Item 3</li></ul>" (convert "- Item 1\n- Item 2\n    1. Item 1\n    2. Item 2\n- Item 3")
+    ]
+
+orderedListTests =
+  TestList
+    [ check_equal "Basic ordered list" "<ol><li>Item 1</li><li>Item 2</li><li>Item 3</li></ol>" (convert "1. Item 1\n2. Item 2\n3. Item 3"),
+      check_equal "Mixing list numbering" "<ol><li>Item 1</li><li>Item 2</li><li>Item 3</li></ol>" (convert "1. Item 1\n3. Item 2\n2. Item 3"),
+      check_equal "Should not convert list without number 1" "<p>2. Item 1 1. Item 2</p>" (convert "2. Item 1\n1. Item 2"),
+      check_equal "Formatted lists" "<ol><li><b>Item 1</b></li><li><i>Item 2</i></li><li><b><i>Item 3</i></b></li></ol>" (convert "1. __Item 1__\n2. _Item 2_\n3. ***Item 3***"),
+      check_equal "Nested list" "<ol><li>Item 1</li><li>Item 2</li><li>Item 3<ol><li>Subitem 1</li><li>Subitem 2</li></ol></li></ol>" (convert "1. Item 1\n2. Item 2\n3. Item 3\n    1. Subitem 1\n    2. Subitem 2"),
+      check_equal "Paragraph in list" "<ol><li>Item 1</li><li><p>Item 2</p><p>More stuff</p></li><li>Item 3</li></ol>" (convert "1. Item 1\n2. Item 2\n\n    More stuff\n\n1. Item 3"),
+      check_equal "Paragraph before list" "<p>This is a list</p><ol><li>Item 1</li><li>Item 2</li></ol>" (convert "This is a list\n\n1. Item 1\n1. Item 2"),
+      check_equal "Paragraph before list" "<h3>This is a list</h3><ol><li>Item 1</li><li>Item 2</li></ol>" (convert "### This is a list\n\n1. Item 1\n200. Item 2"),
+      check_equal "Nested list then back" "<ol><li>Item 1</li><li>Item 2<ol><li>Item 3</li><li>Item 4</li></ol></li><li>Item 5</li></ol>" (convert "1. Item 1\n2. Item 2\n    1. Item 3\n    3. Item 4\n5. Item 5"),
+      check_equal "Blockquote in list" "<ol><li>Item 1</li><li><p>Item 2</p><blockquote><p>Quote</p></blockquote></li><li>Item 3</li></ol>" (convert "1. Item 1\n2. Item 2\n\n    > Quote\n\n3. Item 3"),
+      check_equal "Unordered list in ordered list" "<ol><li>Item 1</li><li>Item 2<ul><li>Item 1</li><li>Item 2</li></ul></li><li>Item 3</li></ol>" (convert "1. Item 1\n2. Item 2\n    - Item 1\n    * Item 2\n4. Item 3")
+    ]
+
+codeTests =
+  TestList
+    [ check_equal "Code by itself" "<p><code>Hello world!</code></p>" (convert "`Hello world!`"),
+      check_equal "Code in a paragraph" "<p>The following <code>text</code> is code</p>" (convert "The following `text` is code"),
+      check_equal "Code across paragraphs (shouldn't work" "<p></p><p></p>" (convert "`Incomplete\n\nCode`") -- At the moment, this is just treated as a syntax error, so nothing is rendered.
+    ]
+
+imageTests =
+  TestList
+    [ check_equal "Image with text" "<p>This is an image <img src=\"img.png\" alt=\"Image 1\" /></p>" (convert "This is an image ![Image 1](img.png)")
+    ]
+
+figureTests =
+  TestList
+    [ check_equal "Image by itself" "<figure><img src=\"img.png\" alt=\"Image 1\"/><figcaption aria-hidden=\"true\">Image 1</figcaption></figure>" (convert "![Image 1](img.png)")
+    ]
+
+horizontalRuleTests =
+  TestList
+    [check_equal "Horizontal Rule" "<p>a</p><hr><p>b</p>" (convert "a\n\n---\n\nb")]
+
+integrationTests =
+  TestList
+    [ check_equal "Integration 1" "<h1>Sample Markdown</h1><p>This is some basic, sample markdown.</p><h2><b>Second</b> <i>Heading</i></h2>" (convert "# Sample Markdown\n\n This is some basic, sample markdown.\n\n  ## __Second__ _Heading_"),
+      check_equal "Integration 2" "<p><b>Hello</b> <i>World</i></p>" (convert "__Hello__\n_World_"),
+      check_equal "Integration 3" "<h1>Hello</h1><p>World</p>" (convert "# Hello\nWorld"),
+      check_equal "Integration 4" "<p>a b</p>" (convert "a\nb"),
+      check_equal "Integration 5" "<h1>Hello</h1>" (convert "# Hello\n"),
+      check_equal "Integration 6" "<p>First line<br>Second line</p>" (convert "First line  \nSecond line"),
+      check_equal
+        "Integration 7"
+        "<h1>Sample Markdown</h1><p>This is some basic, sample markdown.</p><h2>Second \
+        \Heading</h2><ul><li>Unordered lists, and:<ol><li>One</li><li>Two</li><li>\
+        \Three</li></ol></li><li>More</li></ul><blockquote><p>Blockquote</p>\
+        \</blockquote><p>And <b>bold</b>, <i>italics</i>, and even <i>italics \
+        \and later <b>bold</b></i>. Even <s>strikethrough</s>. \
+        \<a href=\"https://markdowntohtml.com\">A link</a> to somewhere.</p>"
+        ( convert
+            "# Sample Markdown\n\nThis is some basic, sample markdown.\n\n## Second \
+            \Heading\n\n- Unordered lists, and:\n    1. One\n    2. Two\n    3. Three\n\
+            \- More\n\n> Blockquote\n\nAnd **bold**, *italics*, and even *italics and \
+            \later **bold***. Even ~~strikethrough~~. [A link](https://markdowntohtml.com) to somewhere."
+        )
+    ]
+
+tests =
+  TestList
+    [ headerTests,
+      boldTests,
+      strikethroughTests,
+      linkTests,
+      escapedCharTests,
+      blockquoteTests,
+      unorderedListTests,
+      orderedListTests,
+      imageTests,
+      figureTests,
+      codeTests,
+      horizontalRuleTests,
+      integrationTests
+    ]
+
+runTests = runTestTT tests

src/Test.hs

@@ -1,79 +0,0 @@
-module MdToHtmlTest where
-
-import MdToHTML
-import Test.HUnit
-
-check_equal :: String -> String -> String -> Test
-check_equal desc expected actual = TestCase (assertEqual desc expected actual)
-
-convert :: String -> String
-convert md = show . fst $ leftmostLongestParse parseDocument md
-
-headerTests =
-  TestList
-    [ check_equal "Should convert H1 heading" "<h1>Hello</h1>" (convert "# Hello"),
-      check_equal "Should convert H2 heading" "<h2>Hello</h2>" (convert "## Hello"),
-      check_equal "Should convert H3 heading" "<h3>Hello</h3>" (convert "### Hello"),
-      check_equal "Should convert H4 heading" "<h4>Hello</h4>" (convert "#### Hello"),
-      check_equal "Should convert H5 heading" "<h5>Hello</h5>" (convert "##### Hello"),
-      check_equal "Should convert H6 heading" "<h6>Hello</h6>" (convert "###### Hello")
-    ]
-
-boldTests =
-  TestList
-    [ check_equal "Should convert bold" "<p><b>Hello</b></p>" (convert "__Hello__"),
-      check_equal "Should convert italic" "<p><i>Hello</i></p>" (convert "_Hello_"),
-      check_equal "Should convert bold and italic in a sentence" "<p>It <i>is</i> a <b>wonderful</b> day</p>" (convert "It _is_ a __wonderful__ day")
-    ]
-
-linkTests =
-  TestList
-    [ check_equal "Should convert normal link" "<p><a href=\"https://example.com\">This is an example link.</a></p>" (convert "[This is an example link.](https://example.com)"),
-      check_equal "Should convert styled link" "<p><a href=\"https://example.com\"><b>Fancy</b>!!!</a></p>" (convert "[__Fancy__!!!](https://example.com)")
-    ]
-
-escapedCharTests =
-  TestList
-    [ check_equal "Should print literal underscore" "<p>This is an underscore - _</p>" (convert "This is an underscore - \\_"),
-      check_equal "Should print literal asterisk" "<p>This is an asterisk - *</p>" (convert "This is an asterisk - \\*"),
-      check_equal "Should print literal asterisk in bold" "<p>This is a bolded asterisk - <b>*</b></p>" (convert "This is a bolded asterisk - **\\***")
-    ]
-
-blockquoteTests =
-  TestList
-    [ check_equal "Should wrap para in blockquote" "<blockquote><p>What a <b>truly</b> <i>lovely</i> day!!!</p></blockquote>" (convert "> What a __truly__ _lovely_ day!!!"),
-      check_equal "Simple nested blockquotes" "<blockquote><p>Hello</p><blockquote><p>World</p></blockquote></blockquote>" (convert "> Hello\n>\n>> World"),
-      check_equal
-        "Nested blockquotes"
-        "<blockquote><p>Dorothy followed her through many \
-        \of the beautiful rooms in her castle.</p><blockquote><p>The Witch \
-        \bade her clean the pots and kettles and sweep the floor and keep the fire \
-        \fed with wood.</p></blockquote></blockquote>"
-        ( convert
-            "> Dorothy followed her through many of the \
-            \beautiful rooms in her castle.\n> \n>> The Witch bade her \
-            \clean the pots and kettles and sweep the floor and keep the fire fed with wood."
-        )
-    ]
-
-integrationTests =
-  TestList
-    [ check_equal "Integration 1" "<h1>Sample Markdown</h1><p>This is some basic, sample markdown.</p><h2><b>Second</b> <i>Heading</i></h2>" (convert "# Sample Markdown\n\n This is some basic, sample markdown.\n\n  ## __Second__ _Heading_"),
-      check_equal "Integration 2" "<p><b>Hello</b> <i>World</i></p>" (convert "__Hello__\n_World_"),
-      check_equal "Integration 3" "<h1>Hello</h1><p>World</p>" (convert "# Hello\nWorld"),
-      check_equal "Integration 4" "<p>a b</p>" (convert "a\nb"),
-      check_equal "Integration 5" "<h1>Hello</h1>" (convert "# Hello\n"),
-      check_equal "Integration 6" "<p>First line<br>Second line</p>" (convert "First line  \nSecond line")
-    ]
-
-tests =
-  TestList
-    [ headerTests,
-      boldTests,
-      linkTests,
-      escapedCharTests,
-      blockquoteTests,
-      integrationTests
-    ]
-
-runTests = runTestTT tests

test.hs

@@ -1,5 +0,0 @@
-leftmostLongest :: (Foldable t) => [t a] -> t a
-leftmostLongest xs = 
-        let lastElem = (last xs)
-            filteredLst = (filter (\val -> (length val) == (length lastElem)) xs)
-        in head filteredLst