Support for pandoc 3 (#58)

Author: LaurentRDC

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 pandoc-plot uses [Semantic Versioning](http://semver.org/spec/v2.0.0.html)
 
+## Release 1.6.0
+
+* Support for pandoc 3. Support for older pandoc version has also been dropped (pandoc 2.19 and earlier).
+
 ## Release 1.5.5
 
 * Fixed an issue where there was a race condition when rendering multiple identical figures (#53).

executable/Main.hs

@@ -262,7 +262,7 @@ showFullVersion = do
   putStrLn $
     mconcat
       [ "Compiled with pandoc ",
-        unpack pandocVersion,
+        V.showVersion pandocVersion,
         " and pandoc-types ",
         V.showVersion pandocTypesVersion,
         " using GHC ",

pandoc-plot.cabal

@@ -1,6 +1,6 @@
 cabal-version:  2.2
 name:           pandoc-plot
-version:        1.5.5
+version:        1.6.0
 synopsis:       A Pandoc filter to include figures generated from code blocks using your plotting toolkit of choice.
 description:    A Pandoc filter to include figures generated from code blocks. 
                 Keep the document and code in the same location. Output is 
@@ -99,8 +99,8 @@ library
         , directory          >= 1.2.7 && < 2
         , filepath           >= 1.4   && < 2
         , hashable           >= 1     && < 2
-        , pandoc             >= 2.11  && < 3
-        , pandoc-types       >= 1.22  && < 1.23
+        , pandoc             >= 3     && < 4
+        , pandoc-types       >= 1.23  && < 1.24
         , lifted-async       >= 0.10  && < 1
         , lifted-base        >= 0.2   && < 1
         , shakespeare        >= 2.0   && < 3

src/Text/Pandoc/Filter/Plot.hs

@@ -219,7 +219,7 @@ makeEither block =
   parseFigureSpec block
     >>= \case
       NotAFigure -> return $ Right block
-      Figure fs -> runScriptIfNecessary fs >>= handleResult fs
+      PFigure fs -> runScriptIfNecessary fs >>= handleResult fs
       MissingToolkit tk -> return $ Left $ ToolkitNotInstalledError tk
       UnsupportedSaveFormat tk sv -> return $ Left $ IncompatibleSaveFormatError sv tk
   where

src/Text/Pandoc/Filter/Plot/Clean.hs

@@ -31,6 +31,7 @@ import System.FilePath (takeExtension)
 import Text.Pandoc.Class (runIO)
 import Text.Pandoc.Definition (Block, Pandoc)
 import Text.Pandoc.Error (handleError)
+import Text.Pandoc.Format (FlavoredFormat(..))
 import Text.Pandoc.Filter.Plot.Monad
 import Text.Pandoc.Filter.Plot.Parse
 import qualified Text.Pandoc.Options as P
@@ -61,10 +62,10 @@ outputDirs ::
   Walkable Block b =>
   b ->
   PlotM [FilePath]
-outputDirs = fmap (catMaybes . nub) . sequence . query (\b -> [hasDirectory <$> parseFigureSpec b])
+outputDirs = fmap (nub . catMaybes) . sequence . query (\b -> [hasDirectory <$> parseFigureSpec b])
   where
     hasDirectory :: ParseFigureResult -> Maybe FilePath
-    hasDirectory (Figure fs) = Just $ directory fs
+    hasDirectory (PFigure fs) = Just $ directory fs
     hasDirectory _ = Nothing
 
 -- | PlotM version of @cleanOutputDirs@
@@ -91,7 +92,7 @@ readDoc fp =
     =<< runIO
       ( do
           let fmt = fromMaybe mempty (formatFromFilePath fp)
-          (reader, exts) <- P.getReader fmt
+          (reader, exts) <- P.getReader $ FlavoredFormat fmt mempty
           let readerOpts = def {P.readerExtensions = exts}
           case reader of
             P.TextReader fct -> do

src/Text/Pandoc/Filter/Plot/Embed.hs

@@ -30,15 +30,14 @@ import Text.HTML.TagSoup
     (~/=),
     (~==),
   )
-import Text.Pandoc.Builder
+import Text.Pandoc.Builder as Builder
   ( Inlines,
     fromList,
-    imageWith,
+    simpleFigureWith,
     link,
-    para,
     str,
     toList,
-  )
+  ) 
 import Text.Pandoc.Class (runPure)
 import Text.Pandoc.Definition (Attr, Block (..), Format, Pandoc (..))
 import Text.Pandoc.Error (handleError)
@@ -63,10 +62,9 @@ toFigure fmt spec = do
   sourceLabel <- asksConfig sourceCodeLabel -- Allow the possibility for non-english labels
   let srcLink = link scp mempty (str sourceLabel)
       attrs' = blockAttrs spec
-      withSource' = withSource spec
       captionText = fromList $ fromMaybe mempty (captionReader fmt $ caption spec)
       captionLinks = mconcat [" (", srcLink, ")"]
-      caption' = if withSource' then captionText <> captionLinks else captionText
+      caption' = if withSource spec then captionText <> captionLinks else captionText
   builder attrs' target caption'
   where
     builder = case saveFormat spec of
@@ -80,14 +78,8 @@ figure ::
   Inlines ->
   PlotM Block
 figure as fp caption' =
-  return . head . toList . para $
-    imageWith as (pack fp) title caption'
-  where
-    -- To render images as figures with captions, the target title
-    -- must be "fig:"
-    -- Janky? yes
-    -- In case there is no caption, make this an image instead of a figure
-    title = if caption' /= mempty then "fig:" else mempty
+  return . head . toList $
+    simpleFigureWith as caption' (pack fp) mempty
 
 -- TODO: also add the case where SVG plots can be
 --       embedded in HTML output

src/Text/Pandoc/Filter/Plot/Parse.hs

@@ -39,6 +39,7 @@ import Text.Pandoc.Definition
     Inline,
     Pandoc (..),
   )
+import Text.Pandoc.Format (parseFlavoredFormat)
 import Text.Pandoc.Filter.Plot.Monad
 import Text.Pandoc.Filter.Plot.Renderers
 import Text.Pandoc.Options (ReaderOptions (..))
@@ -51,7 +52,7 @@ data ParseFigureResult
   -- | The block is not meant to become a figure
   = NotAFigure
   -- | The block is meant to become a figure
-  | Figure FigureSpec
+  | PFigure FigureSpec
   -- | The block is meant to become a figure, but the plotting toolkit is missing
   | MissingToolkit Toolkit
   -- | The block is meant to become a figure, but the figure format is incompatible 
@@ -126,7 +127,7 @@ parseFigureSpec block@(CodeBlock (id', classes, attrs) _) = do
               in err msg
 
           -- Ensure that the save format makes sense given the final conversion format, if known
-          return $ Figure (FigureSpec {..})
+          return $ PFigure (FigureSpec {..})
 -- Base case: block is not a CodeBlock
 parseFigureSpec _ = return NotAFigure
 
@@ -162,7 +163,8 @@ plotToolkit _ = Nothing
 captionReader :: Format -> Text -> Maybe [Inline]
 captionReader (Format f) t = either (const Nothing) (Just . extractFromBlocks) $
   runPure $ do
-    (reader, exts) <- getReader f
+    fmt <- parseFlavoredFormat f
+    (reader, exts) <- getReader fmt
     let readerOpts = def {readerExtensions = exts}
     -- Assuming no ByteString readers...
     case reader of

tests/Common.hs

@@ -179,20 +179,16 @@ testWithSource tk =
             addDirectory tempDir $
               addCaption expected $
                 codeBlock tk (trivialContent tk)
-    blockNoSource <- runPlotM Nothing defaultTestConfig $ make noSource
+    blockNoSource   <- runPlotM Nothing defaultTestConfig $ make noSource
     blockWithSource <- runPlotM Nothing defaultTestConfig $ make withSource
 
     -- In the case where source=false, the caption is used verbatim.
     -- Otherwise, links will be appended to the caption; hence, the caption
     -- is no longer equal to the initial value
-    assertEqual "" (B.toList $ fromString expected) (extractCaption blockNoSource)
-    assertNotEqual "" (B.toList $ fromString expected) (extractCaption blockWithSource)
+    assertEqual    "" [B.Plain $ B.toList (fromString expected)] (extractCaption blockNoSource)
+    assertNotEqual "" [B.Plain $ B.toList (fromString expected)] (extractCaption blockWithSource)
   where
-    extractCaption (B.Para blocks) = extractImageCaption . head $ blocks
-    extractCaption _ = mempty
-
-    extractImageCaption (Image _ c _) = c
-    extractImageCaption _ = mempty
+    extractCaption (B.Figure _ (Caption _ caption) _) = caption 
 
 -------------------------------------------------------------------------------
 -- Test that it is possible to change the source code label in captions
@@ -212,17 +208,12 @@ testSourceLabel tk =
                 codeBlock tk (trivialContent tk)
     blockWithSource <- runPlotM Nothing defaultTestConfig {sourceCodeLabel = "Test label"} $ make withSource
 
-    -- The caption will look like [Space, Str "(", Link ... ]. Hence, we skip the first elements with (!!)
-    let resultCaption = linkLabel $ (!! 2) . B.toList $ extractCaption blockWithSource
-    assertEqual "" (B.str "Test label") resultCaption
+    let [Plain [Space, _, B.Link _ ils _, _]] = extractCaption blockWithSource
+    assertEqual "" (B.toList $ B.str "Test label") ils
   where
-    extractCaption (B.Para blocks) = extractImageCaption . head $ blocks
-    extractCaption _ = mempty
-
-    extractImageCaption (Image _ c _) = B.fromList c
-    extractImageCaption _ = mempty
+    extractCaption (B.Figure _ (Caption _ caption) _) = caption 
 
-    linkLabel (B.Link _ ils _) = B.fromList ils
+    linkLabel (B.Plain [B.Link _ ils _]) = B.fromList ils
     linkLabel _ = mempty
 
 -------------------------------------------------------------------------------
@@ -276,7 +267,7 @@ testMarkdownFormattingCaption1 tk =
 
     -- Note that this test is fragile, in the sense that the expected result must be carefully
     -- constructed
-    let expected = [B.Strong [B.Str "caption"]]
+    let expected = [B.Plain [B.Strong [B.Str "caption"]]]
         cb =
           addDirectory tempDir $
             addCaption "**caption**" $
@@ -285,11 +276,7 @@ testMarkdownFormattingCaption1 tk =
     result <- runPlotM Nothing (defaultTestConfig {captionFormat = fmt}) $ make cb
     assertIsInfix expected (extractCaption result)
   where
-    extractCaption (B.Para blocks) = extractImageCaption . head $ blocks
-    extractCaption _ = mempty
-
-    extractImageCaption (Image _ c _) = c
-    extractImageCaption _ = mempty
+    extractCaption (B.Figure _ (Caption _ caption) _) = caption 
 
 -------------------------------------------------------------------------------
 -- Test that Markdown bold formatting in captions is correctly rendered
@@ -302,7 +289,7 @@ testMarkdownFormattingCaption2 tk =
 
     -- Note that this test is fragile, in the sense that the expected result must be carefully
     -- constructed
-    let expected = [Link ("", [], []) [Str "title"] ("https://google.com", "")]
+    let expected = [B.Plain [Link ("", [], []) [Str "title"] ("https://google.com", "")]]
         cb =
           addDirectory tempDir $
             addCaption "[title](https://google.com)" $
@@ -311,35 +298,7 @@ testMarkdownFormattingCaption2 tk =
     result <- runPlotM Nothing (defaultTestConfig {captionFormat = fmt}) $ make cb
     assertIsInfix expected (extractCaption result)
   where
-    extractCaption (B.Para blocks) = extractImageCaption . head $ blocks
-    extractCaption _ = mempty
-
-    extractImageCaption (Image _ c _) = c
-    extractImageCaption _ = mempty
-
--------------------------------------------------------------------------------
--- Test that Markdown bold formatting in captions is correctly rendered
-testFigureWithoutCaption :: Toolkit -> TestTree
-testFigureWithoutCaption tk =
-  testCase "appropriately build an image if no caption" $ do
-    let postfix = unpack . cls $ tk
-    tempDir <- (</> "test-image-if-no-caption-" <> postfix) <$> getTemporaryDirectory
-    ensureDirectoryExistsAndEmpty tempDir
-
-    -- Note that this test is fragile, in the sense that the expected result must be carefully
-    -- constructed
-    let cb =
-          addDirectory tempDir $ codeBlock tk (trivialContent tk)
-        fmt = B.Format "markdown"
-    result <- runPlotM Nothing (defaultTestConfig {captionFormat = fmt}) $ make cb
-    assertEqual "" (Just mempty) (extractTitle result)
-  where
-    extractTitle (B.Para blocks) = extractImageCaption . head $ blocks
-    extractTitle _ = Nothing
-
-    extractImageCaption (Image _ _ (_, title)) = Just title
-    extractImageCaption _ = Nothing
-
+    extractCaption (B.Figure _ (Caption _ caption) _) = caption 
 
 -------------------------------------------------------------------------------
 -- Test that cleanOutpuDirs correctly cleans the output directory specified in a block.

tests/Main.hs

@@ -58,7 +58,6 @@ toolkitSuite tk =
       testOverrideConfiguration,
       testMarkdownFormattingCaption1,
       testMarkdownFormattingCaption2,
-      testFigureWithoutCaption,
       testCleanOutputDirs,
       testChecksFail
     ]
@@ -109,7 +108,7 @@ testCaptionReader =
     -- Note that this test is fragile, in the sense that the expected result must be carefully
     -- constructed
     let caption = "Here is a [link](https://www.google.com) in a caption."
-        expected = Just $ [Str "Here", Space, Str "is", Space, Str "a", Space, Link ("", [], []) [Str "link"] ("https://www.google.com", ""), Space, Str "in", Space, Str "a", Space, Str "caption."]
+        expected = Just [Str "Here", Space, Str "is", Space, Str "a", Space, Link ("", [], []) [Str "link"] ("https://www.google.com", ""), Space, Str "in", Space, Str "a", Space, Str "caption."]
         fmt = B.Format "markdown+tex_math_dollars"
         parsed = captionReader fmt caption