Added opengraphs option for open graph tags on docs

Ephemera · Ephemera · commit f6ab14c369a2 · 2018-08-15T16:15:32.000+09:00
diff --git a/CHANGES.md b/CHANGES.md
@@ -24,6 +24,7 @@ To be released.
     to customize the look and feel of the result pages.
  -  Fixed an incorrect processing of [CommonMark] thight list items: it had
     crashed when a thight list item contains blocks other than paragraphs.
+ -  Added `opengraphs` option for [OpenGraph] objects on docs. [[#283] by GyuYong Jung]
 
 ### Python target
 
@@ -40,10 +41,12 @@ To be released.
 
 [#126]: https://github.com/nirum-lang/nirum/issues/126
 [#281]: https://github.com/nirum-lang/nirum/pull/281
+[#283]: https://github.com/spoqa/nirum/pull/283
 [#300]: https://github.com/nirum-lang/nirum/pull/300
 [CommonMark]: http://commonmark.org/
 [table syntax extension]: https://github.github.com/gfm/#tables-extension-
 [special attributes extension]: https://michelf.ca/projects/php-markdown/extra/#spe-attr
+[OpenGraph]: http://ogp.me/
 
 
 Version 0.4.1
diff --git a/app/nirum-docs.hs b/app/nirum-docs.hs
@@ -31,6 +31,7 @@ packageMetadata = Metadata
     , authors = [Author "Nirum team" Nothing Nothing]
     , Nirum.Package.Metadata.target = Docs
         { docsTitle = "Nirum"
+        , docsOpenGraph = []
         , docsStyle = style
         , docsHeader = ""
         , docsFooter = footer
diff --git a/docs/target/docs.md b/docs/target/docs.md
@@ -45,6 +45,11 @@ Settings
 It goes to `<title>` elements of generated HTML pages.  It's usually a name of
 the Nirum package.
 
+### `opengraphs` (optional): OpenGraph
+
+It goes to `<meta>` elements of generated HTML pages. It generate OpenGraph
+objects.
+
 
 ### `style` (optional): Custom CSS
 
diff --git a/src/Nirum/Package/Metadata.hs b/src/Nirum/Package/Metadata.hs
@@ -48,6 +48,7 @@ module Nirum.Package.Metadata ( Author (Author, email, name, uri)
                               , readMetadata
                               , stringField
                               , tableField
+                              , tableArrayField
                               , textArrayField
                               , versionField
                               ) where
diff --git a/src/Nirum/Targets/Docs.hs b/src/Nirum/Targets/Docs.hs
@@ -55,6 +55,7 @@ import Nirum.Version (versionText)
 
 data Docs = Docs
     { docsTitle :: T.Text
+    , docsOpenGraph :: [OpenGraph]
     , docsStyle :: T.Text
     , docsHeader :: T.Text
     , docsFooter :: T.Text
@@ -68,6 +69,11 @@ data CurrentPage
     | DocumentPage FilePath
     deriving (Eq, Show)
 
+data OpenGraph = OpenGraph
+    { ogTag :: T.Text
+    , ogContent :: T.Text
+    } deriving (Eq, Ord, Show)
+
 makeFilePath :: ModulePath -> FilePath
 makeFilePath modulePath' = foldl (</>) "" $
     map toNormalizedString (toList modulePath') ++ ["index.html"]
@@ -103,6 +109,8 @@ $doctype 5
         <meta name="generator" content="Nirum #{versionText}">
         $forall Author { name = name' } <- authors md
             <meta name="author" content="#{name'}">
+        $forall OpenGraph { ogTag, ogContent } <- docsOpenGraph $ target pkg
+            <meta property="#{ogTag}" content="#{ogContent}">
         <link rel="stylesheet" href="#{root}style.css">
     <body>
         #{preEscapedToMarkup $ docsHeader $ target pkg}
@@ -616,15 +624,32 @@ instance Target Docs where
     targetName _ = "docs"
     parseTarget table = do
         title <- stringField "title" table
+        opengraphs <- optional $ opengraphsField "opengraphs" table
         style <- optional $ stringField "style" table
         header <- optional $ stringField "header" table
         footer <- optional $ stringField "footer" table
         return Docs
             { docsTitle = title
+            , docsOpenGraph = fromMaybe [] opengraphs
             , docsStyle = fromMaybe "" style
             , docsHeader = fromMaybe "" header
             , docsFooter = fromMaybe "" footer
             }
     compilePackage = compilePackage'
     showCompileError _ = id
     toByteString _ = id
+
+opengraphsField :: MetadataField -> Table -> Either MetadataError [OpenGraph]
+opengraphsField field' table = do
+    array <- tableArrayField field' table
+    opengraphs' <- mapM parseOpenGraph array
+    return $ toList opengraphs'
+  where
+    parseOpenGraph :: Table -> Either MetadataError OpenGraph
+    parseOpenGraph t = do
+      tag' <- stringField "tag" t
+      content' <- stringField "content" t
+      return OpenGraph
+          { ogTag = tag'
+          , ogContent = content'
+          }
