From 12a066d96332b40f346621c9376c5c7328c92a0b Mon Sep 17 00:00:00 2001
From: Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>
Date: Tue, 9 Dec 2014 07:00:07 +0000
Subject: Allow the parser to spit out meta-info
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Currently we only use it only for ‘since’ annotations but with these
patches it should be fairly simple to add new attributes if we wish to.

Closes #26. It seems to work fine but due to 7.10 rush I don't have the
chance to do more exhaustive testing right now. The way the meta is
output (emphasis at the end of the whole comment) is fairly arbitrary
and subject to bikeshedding.

Note that this makes test for Bug310 fail due to interface version bump:
it can't find the docs for base with this interface version so it fails.
There is not much we can do to help this because it tests for ’built-in’
identifier, not something we can provide ourselves.
---
 .../test/Documentation/Haddock/ParserSpec.hs       | 23 +++++++++++++++-------
 1 file changed, 16 insertions(+), 7 deletions(-)

(limited to 'haddock-library/test/Documentation/Haddock')

diff --git a/haddock-library/test/Documentation/Haddock/ParserSpec.hs b/haddock-library/test/Documentation/Haddock/ParserSpec.hs
index 7b0ef78d..44ec2988 100644
--- a/haddock-library/test/Documentation/Haddock/ParserSpec.hs
+++ b/haddock-library/test/Documentation/Haddock/ParserSpec.hs
@@ -22,8 +22,8 @@ instance IsString (Doc String) where
 instance IsString a => IsString (Maybe a) where
   fromString = Just . fromString
 
-parseParas :: String -> (Maybe Version, Doc String)
-parseParas = fmap Parse.toRegular . Parse.parseParas
+parseParas :: String -> MetaDoc () String
+parseParas = overDoc Parse.toRegular . Parse.parseParas
 
 parseString :: String -> Doc String
 parseString = Parse.toRegular . Parse.parseString
@@ -358,7 +358,7 @@ spec = do
   describe "parseParas" $ do
     let infix 1 `shouldParseTo`
         shouldParseTo :: String -> Doc String -> Expectation
-        shouldParseTo input ast = snd (parseParas input) `shouldBe` ast
+        shouldParseTo input ast = _doc (parseParas input) `shouldBe` ast
 
     it "is total" $ do
       property $ \xs ->
@@ -366,13 +366,20 @@ spec = do
 
     context "when parsing @since" $ do
       it "adds specified version to the result" $ do
-        parseParas "@since 0.5.0" `shouldBe` (Just [0,5,0], DocEmpty)
+        parseParas "@since 0.5.0" `shouldBe`
+          MetaDoc { _meta = Meta { _version = Just [0,5,0] }
+                  , _doc = DocEmpty }
 
       it "ignores trailing whitespace" $ do
-        parseParas "@since 0.5.0 \t " `shouldBe` (Just [0,5,0], DocEmpty)
+        parseParas "@since 0.5.0 \t " `shouldBe`
+          MetaDoc { _meta = Meta { _version = Just [0,5,0] }
+                  , _doc = DocEmpty }
 
       it "does not allow trailing input" $ do
-        parseParas "@since 0.5.0 foo" `shouldBe` (Nothing, DocParagraph "@since 0.5.0 foo")
+        parseParas "@since 0.5.0 foo" `shouldBe`
+          MetaDoc { _meta = Meta { _version = Nothing }
+                  , _doc = DocParagraph "@since 0.5.0 foo" }
+
 
       context "when given multiple times" $ do
         it "gives last occurrence precedence" $ do
@@ -380,7 +387,9 @@ spec = do
               "@since 0.5.0"
             , "@since 0.6.0"
             , "@since 0.7.0"
-            ] `shouldBe` (Just [0,7,0], DocEmpty)
+            ] `shouldBe` MetaDoc { _meta = Meta { _version = Just [0,7,0] }
+                                 , _doc = DocEmpty }
+
 
     context "when parsing text paragraphs" $ do
       let filterSpecial = filter (`notElem` (".(=#-[*`\v\f\n\t\r\\\"'_/@<> " :: String))
-- 
cgit v1.2.3