Merge pull request #1271 from windymelt/introduce-ogp

Show meta tag for Open Graph Protocol
scalacenter · Sep 19, 2023 · 3247280 · 3247280
2 parents 722ff36 + 9a60097
commit 3247280
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 3 deletions.
diff --git a/.scalafmt.conf b/.scalafmt.conf
@@ -1,4 +1,4 @@
-version = "3.7.9"
+version = "3.7.14"
 runner.dialect = scala213source3
 maxColumn = 120
 align.preset = some

diff --git a/bin/scalafmt b/bin/scalafmt
diff --git a/modules/core/shared/src/main/scala/scaladex/core/model/HeadMetaProperty.scala b/modules/core/shared/src/main/scala/scaladex/core/model/HeadMetaProperty.scala
@@ -0,0 +1,9 @@
+package scaladex.core.model
+
+/**
+ * A meta tag in head that uses property attribute.
+ *
+ * @param property The property attribute
+ * @param content  The content attribute
+ */
+case class HeadMetaProperty(property: String, content: String)
diff --git a/modules/core/shared/src/main/scala/scaladex/core/model/OGP.scala b/modules/core/shared/src/main/scala/scaladex/core/model/OGP.scala
@@ -0,0 +1,30 @@
+package scaladex.core.model
+
+/**
+  * Open Graph Protocol, see https://ogp.me/
+  *
+  * @param title
+  * @param url
+  * @param description
+  * @param image
+  * @param imageAlt
+  */
+case class OGP(
+    title: String,
+    url: Url,
+    description: String,
+    image: Option[Url] = None,
+    imageAlt: Option[String] = None
+) {
+  val `type`: String = "article"
+  val siteName: String = "Scaladex"
+  def toHeadMetaProperty: Seq[HeadMetaProperty] = Seq(
+    HeadMetaProperty(property = "og:title", content = title),
+    HeadMetaProperty(property = "og:url", content = url.target),
+    HeadMetaProperty(property = "og:type", content = `type`),
+    HeadMetaProperty(property = "og:description", content = description),
+    HeadMetaProperty(property = "og:site_name", content = siteName)
+  ) ++ image.map(c => HeadMetaProperty(property = "og:image", content = c.target)) ++ imageAlt.map(c =>
+    HeadMetaProperty(property = "og:image:alt", c)
+  )
+}
diff --git a/modules/core/shared/src/main/scala/scaladex/core/model/Project.scala b/modules/core/shared/src/main/scala/scaladex/core/model/Project.scala
@@ -28,6 +28,16 @@ case class Project(
     githubInfo.flatMap(_.logo)
   )
 
+  /**
+    * This is used in embedding to another website to render the card of a scaladex project link.
+    */
+  def ogp: OGP = OGP(
+    title = s"Scaladex - ${organization.toString()} / ${repository.toString()}",
+    url = Url(s"https://index.scala-lang.org/${organization.toString()}/${repository.toString()}"),
+    description = githubInfo.flatMap(_.description).getOrElse(""),
+    image = githubInfo.flatMap(_.logo).orElse(Some(Url("https://index.scala-lang.org/assets/img/scaladex-brand.svg")))
+  )
+
   def scaladoc(artifact: Artifact): Option[DocumentationLink] =
     settings.customScalaDoc
       .map(DocumentationPattern("Scaladoc", _).eval(artifact))

diff --git a/modules/template/src/main/twirl/scaladex/view/main.scala.html b/modules/template/src/main/twirl/scaladex/view/main.scala.html
@@ -1,6 +1,7 @@
 @import scaladex.core.model.search.SearchParams
 @import scaladex.core.model.UserState
 @import scaladex.core.model.HeadMeta
+@import scaladex.core.model.HeadMetaProperty
 @import scaladex.core.model.Env
 
 @(
@@ -10,6 +11,7 @@
   showSearch: Boolean = true,
   params: SearchParams = SearchParams(), you: Boolean = false,
   extraMeta: Seq[HeadMeta] = Seq.empty,
+  extraMetaProperty: Seq[HeadMetaProperty] = Seq.empty,
   totalProjects: Option[Long] = None, totalArtifacts: Option[Long] = None
 )(content: Html)
 <!DOCTYPE HTML>
@@ -47,6 +49,9 @@
     @for(meta <- extraMeta) {
       <meta name="@meta.name" content="@meta.content">
     }
+    @for(meta <- extraMetaProperty) {
+      <meta property="@meta.property" content="@meta.content">
+    }
   </head>
 
   <body>

diff --git a/modules/template/src/main/twirl/scaladex/view/project/badges.scala.html b/modules/template/src/main/twirl/scaladex/view/project/badges.scala.html
@@ -15,7 +15,7 @@
   header: ProjectHeader,
   artifact: Artifact
 )
-@main(env, title = project.repository.value, user, extraMeta = project.twitterCard.toHeadMeta) {
+@main(env, title = project.repository.value, user, extraMeta = project.twitterCard.toHeadMeta, extraMetaProperty = project.ogp.toHeadMetaProperty) {
   <main id="container-project">
     @headproject(env, user, project, header, "Badges")
     <div class="container">

diff --git a/modules/template/src/main/twirl/scaladex/view/project/project.scala.html b/modules/template/src/main/twirl/scaladex/view/project/project.scala.html
@@ -17,7 +17,7 @@
   directDependencies: Map[Project.Reference, (ArtifactDependency.Scope, Seq[SemanticVersion])],
   reverseDependency: Map[Project.Reference, (ArtifactDependency.Scope, SemanticVersion)],
 )
-@main(env, title = project.repository.value, user, extraMeta = project.twitterCard.toHeadMeta) {
+@main(env, title = project.repository.value, user, extraMeta = project.twitterCard.toHeadMeta, extraMetaProperty = project.ogp.toHeadMetaProperty) {
   <main id="container-project">
     @headproject(env, user, project, header, "Project")
     <div class="container">