Add Format to the Scala CAPI client

client/src/main/scala/com.gu.contentapi.client/utils/CapiModelEnrichment.scala

@@ -1,44 +1,50 @@
 package com.gu.contentapi.client.utils
 
 import com.gu.contentapi.client.model.v1._
+import com.gu.contentapi.client.utils.format._
+
 import java.time.OffsetDateTime
 import java.time.format.DateTimeFormatter
 
 object CapiModelEnrichment {
 
-  implicit class RichCapiDateTime(val cdt: CapiDateTime) extends AnyVal {
-    def toOffsetDateTime: OffsetDateTime = OffsetDateTime.parse(cdt.iso8601)
-  }
+  type ContentFilter = Content => Boolean
 
-  implicit class RichOffsetDateTime(val dt: OffsetDateTime) extends AnyVal {
-    def toCapiDateTime: CapiDateTime = CapiDateTime.apply(dt.toInstant.toEpochMilli, DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(dt))
-  }
+  def getFromPredicate[T](content: Content, predicates: List[(ContentFilter, T)]): Option[T] =
+    predicates.collectFirst { case (predicate, t) if predicate(content) => t }
 
-  implicit class RichContent(val content: Content) extends AnyVal {
+  def tagExistsWithId(tagId: String): ContentFilter = content => content.tags.exists(tag => tag.id == tagId)
 
-    def designType: DesignType = {
+  def displayHintExistsWithName(displayHintName: String): ContentFilter = content => content.fields.flatMap(_.displayHint).contains(displayHintName)
 
-      val defaultDesignType = Article
+  def isLiveBloggingNow: ContentFilter = content => content.fields.flatMap(_.liveBloggingNow).contains(true)
 
-      type ContentFilter = Content => Boolean
+  val isImmersive: ContentFilter = content => displayHintExistsWithName("immersive")(content)
 
-      val isImmersive: ContentFilter = c => c.fields.flatMap(_.displayHint).contains("immersive")
+  val isMedia: ContentFilter = content => tagExistsWithId("type/audio")(content) || tagExistsWithId("type/video")(content) || tagExistsWithId("type/gallery")(content)
 
-      def tagExistsWithId(tagId: String): ContentFilter = c => c.tags.exists(tag => tag.id == tagId)
+  val isReview: ContentFilter = content => tagExistsWithId("tone/reviews")(content) || tagExistsWithId("tone/livereview")(content) || tagExistsWithId("tone/albumreview")(content)
 
-      val isMedia: ContentFilter = c => tagExistsWithId("type/audio")(c) || tagExistsWithId("type/video")(c) || tagExistsWithId("type/gallery")(c)
+  val isLiveBlog: ContentFilter = content => isLiveBloggingNow(content) && tagExistsWithId("tone/minutebyminute")(content)
 
-      val isReview: ContentFilter = c => tagExistsWithId("tone/reviews")(c) || tagExistsWithId("tone/livereview")(c) || tagExistsWithId("tone/albumreview")(c)
+  val isDeadBlog: ContentFilter = content => !isLiveBloggingNow(content) && tagExistsWithId("tone/minutebyminute")(content)
 
-      def isComment: ContentFilter = c => tagExistsWithId("tone/comment")(c) || tagExistsWithId("tone/letters")(c)
+  implicit class RichCapiDateTime(val cdt: CapiDateTime) extends AnyVal {
+    def toOffsetDateTime: OffsetDateTime = OffsetDateTime.parse(cdt.iso8601)
+  }
+
+  implicit class RichOffsetDateTime(val dt: OffsetDateTime) extends AnyVal {
+    def toCapiDateTime: CapiDateTime = CapiDateTime.apply(dt.toInstant.toEpochMilli, DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(dt))
+  }
 
-      def liveBloggingNow: Boolean = content.fields.flatMap(_.liveBloggingNow).contains(true)
+  implicit class RichContent(val content: Content) extends AnyVal {
 
-      val liveBlog: ContentFilter = liveBloggingNow && tagExistsWithId("tone/minutebyminute")(_)
+    def designType: DesignType = {
 
-      val deadBlog: ContentFilter = !liveBloggingNow && tagExistsWithId("tone/minutebyminute")(_)
+      val isComment: ContentFilter = content => tagExistsWithId("tone/comment")(content) || tagExistsWithId("tone/letters")(content)
+      val defaultDesignType: DesignType = Article
 
-      val predicates: List[(ContentFilter, DesignType)] = List (
+      val predicates: List[(ContentFilter, DesignType)] = List(
         tagExistsWithId("tone/advertisement-features") -> AdvertisementFeature,
         tagExistsWithId("tone/matchreports") -> MatchReport,
         tagExistsWithId("tone/quizzes") -> Quiz,
@@ -51,12 +57,146 @@ object CapiModelEnrichment {
         tagExistsWithId("tone/analysis") -> Analysis,
         isComment -> Comment,
         tagExistsWithId("tone/features") -> Feature,
-        liveBlog -> Live,
-        deadBlog -> Article
+        isLiveBlog -> Live,
+        isDeadBlog -> Article
       )
 
-      val result = predicates.collectFirst { case (predicate, design) if predicate(content) => design }
+      val result = getFromPredicate(content, predicates)
       result.getOrElse(defaultDesignType)
     }
   }
+
+  implicit class RenderingFormat(val content: Content) extends AnyVal {
+
+
+    def design: Design = {
+
+      val defaultDesign: Design = ArticleDesign
+
+      val isPhotoEssay: ContentFilter = content => content.fields.flatMap(_.displayHint).contains("photoessay")
+
+      val isInteractive: ContentFilter = content => content.`type` == ContentType.Interactive
+
+      val predicates: List[(ContentFilter, Design)] = List(
+        tagExistsWithId("artanddesign/series/guardian-print-shop") -> PrintShopDesign,
+        isMedia -> MediaDesign,
+        isReview -> ReviewDesign,
+        tagExistsWithId("tone/analysis") -> AnalysisDesign,
+        tagExistsWithId("tone/comment") -> CommentDesign,
+        tagExistsWithId("tone/letters") -> LetterDesign,
+        tagExistsWithId("tone/features") -> FeatureDesign,
+        tagExistsWithId("tone/recipes") -> RecipeDesign,
+        tagExistsWithId("tone/matchreports") -> MatchReportDesign,
+        tagExistsWithId("tone/interview") -> InterviewDesign,
+        tagExistsWithId("tone/editorials") -> EditorialDesign,
+        tagExistsWithId("tone/quizzes") -> QuizDesign,
+        isInteractive -> InteractiveDesign,
+        isPhotoEssay -> PhotoEssayDesign,
+        isLiveBlog -> LiveBlogDesign,
+        isDeadBlog -> DeadBlogDesign
+      )
+
+      val result = getFromPredicate(content, predicates)
+      result.getOrElse(defaultDesign)
+    }
+
+    def theme: Theme = {
+      val defaultTheme: Theme = NewsPillar
+
+      val specialReportTags: Set[String] = Set(
+        "business/series/undercover-in-the-chicken-industry",
+        "business/series/britains-debt-timebomb",
+        "world/series/this-is-europe",
+        "environment/series/the-polluters",
+        "news/series/hsbc-files",
+        "news/series/panama-papers",
+        "us-news/homan-square",
+        "uk-news/series/the-new-world-of-work",
+        "world/series/the-new-arrivals",
+        "news/series/nauru-files",
+        "us-news/series/counted-us-police-killings",
+        "australia-news/series/healthcare-in-detention",
+        "society/series/this-is-the-nhs"
+      )
+
+      def isPillar(pillar: String): ContentFilter = content => content.pillarName.contains(pillar)
+
+      val isSpecialReport: ContentFilter = content => content.tags.exists(t => specialReportTags(t.id))
+      val isOpinion: ContentFilter = content => (tagExistsWithId("tone/comment")(content) && isPillar("News")(content)) ||
+        isPillar("Opinion")(content)
+      val isCulture: ContentFilter = content => isPillar("Arts")(content) || isPillar("Books")(content)
+
+      val predicates: List[(ContentFilter, Theme)] = List(
+        isOpinion -> OpinionPillar,
+        isPillar("Sport") -> SportPillar,
+        isCulture -> CulturePillar,
+        isPillar("Lifestyle") -> LifestylePillar,
+        isSpecialReport -> SpecialReportTheme,
+        tagExistsWithId("tone/advertisement-features") -> Labs,
+      )
+
+      val result = getFromPredicate(content, predicates)
+      result.getOrElse(defaultTheme)
+    }
+
+    def display: Display = {
+
+      val defaultDisplay = StandardDisplay
+
+      def hasShowcaseImage: ContentFilter = content => {
+        val hasShowcaseImage = for {
+          blocks <- content.blocks
+          main <- blocks.main
+          mainMedia = main.elements.head
+          imageTypeData <- mainMedia.imageTypeData
+          imageRole <- imageTypeData.role
+        } yield {
+          imageRole == "showcase"
+        }
+        hasShowcaseImage.getOrElse(false)
+      }
+
+      def hasShowcaseEmbed: ContentFilter = content => {
+
+        def isMainEmbed(elem: Element): Boolean = elem.relation == "main" && elem.`type` == ElementType.Embed
+
+        def hasShowcaseAsset(assets: scala.collection.Seq[Asset]): Boolean = {
+          val isShowcaseAsset = for {
+            embedAsset <- assets.find(asset => asset.`type` == AssetType.Embed)
+            typeData <- embedAsset.typeData
+            role <- typeData.role
+          } yield {
+            role == "showcase"
+          }
+          isShowcaseAsset.getOrElse(false)
+        }
+
+        val hasShowcaseEmbed = for {
+          elements <- content.elements
+          mainEmbed <- elements.find(isMainEmbed)
+        } yield {
+          hasShowcaseAsset(mainEmbed.assets)
+        }
+
+        hasShowcaseEmbed.getOrElse(false)
+      }
+
+      val isShowcase: ContentFilter = content => displayHintExistsWithName("column")(content) ||
+        displayHintExistsWithName("showcase")(content) ||
+        hasShowcaseImage(content) ||
+        hasShowcaseEmbed(content)
+
+      val isNumberedList: ContentFilter = displayHintExistsWithName("numberedList")
+
+      val predicates: List[(ContentFilter, Display)] = List(
+        isImmersive -> ImmersiveDisplay,
+        isShowcase -> ShowcaseDisplay,
+        isNumberedList -> NumberedListDisplay
+      )
+
+      val result = getFromPredicate(content, predicates)
+      result.getOrElse(defaultDisplay)
+    }
+  }
+
 }

client/src/main/scala/com.gu.contentapi.client/utils/format/Design.scala

@@ -0,0 +1,21 @@
+package com.gu.contentapi.client.utils.format
+
+sealed trait Design
+
+case object ArticleDesign extends Design
+case object MediaDesign extends Design
+case object ReviewDesign extends Design
+case object AnalysisDesign extends Design
+case object CommentDesign extends Design
+case object LetterDesign extends Design
+case object FeatureDesign extends Design
+case object LiveBlogDesign extends Design
+case object DeadBlogDesign extends Design
+case object RecipeDesign extends Design
+case object MatchReportDesign extends Design
+case object InterviewDesign extends Design
+case object EditorialDesign extends Design
+case object QuizDesign extends Design
+case object InteractiveDesign extends Design
+case object PhotoEssayDesign extends Design
+case object PrintShopDesign extends Design

client/src/main/scala/com.gu.contentapi.client/utils/format/Display.scala

@@ -0,0 +1,9 @@
+package com.gu.contentapi.client.utils.format
+
+sealed trait Display
+
+case object StandardDisplay extends Display
+case object ImmersiveDisplay extends Display
+case object ShowcaseDisplay extends Display
+case object NumberedListDisplay extends Display
+case object ColumnDisplay extends Display

client/src/main/scala/com.gu.contentapi.client/utils/format/Theme.scala

@@ -0,0 +1,14 @@
+package com.gu.contentapi.client.utils.format
+
+sealed trait Theme
+
+sealed trait Pillar extends Theme
+sealed trait Special extends Theme
+
+case object NewsPillar extends Pillar
+case object OpinionPillar extends Pillar
+case object SportPillar extends Pillar
+case object CulturePillar extends Pillar
+case object LifestylePillar extends Pillar
+case object SpecialReportTheme extends Special
+case object Labs extends Special