-
Notifications
You must be signed in to change notification settings - Fork 122
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4347 from eelpie/cropspec-metadata-none
CropSpec metadata can handle optional non String values
- Loading branch information
Showing
3 changed files
with
112 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| package lib | ||
|
|
||
| import com.gu.mediaservice.lib.formatting.printDateTime | ||
| import com.gu.mediaservice.model.{Bounds, Crop, CropSpec, Dimensions, ExportType} | ||
|
|
||
| trait CropSpecMetadata { | ||
|
|
||
| def metadataForCrop(crop: Crop, dimensions: Dimensions): Map[String, String] = { | ||
| val CropSpec(sourceUri, Bounds(x, y, w, h), r, t) = crop.specification | ||
| val metadata = Map("source" -> sourceUri, | ||
| "bounds-x" -> x, | ||
| "bounds-y" -> y, | ||
| "bounds-width" -> w, | ||
| "bounds-height" -> h, | ||
| "type" -> t.name, | ||
| "author" -> crop.author, | ||
| "date" -> crop.date.map(printDateTime), | ||
| "width" -> dimensions.width, | ||
| "height" -> dimensions.height, | ||
| "aspect-ratio" -> r) | ||
|
|
||
| metadata.collect { | ||
| case (key, Some(value)) => key -> value.toString | ||
| case (key, value) if value != None => key -> value.toString | ||
| } | ||
| } | ||
|
|
||
| def cropSpecFromMetadata(userMetadata: Map[String, String]): Option[CropSpec] = { | ||
| for { | ||
| source <- userMetadata.get("source") | ||
| // we've moved to kebab-case as localstack doesn't like `_` | ||
| // fallback to reading old values for older crops | ||
| // see https://github.com/localstack/localstack/issues/459 | ||
| x <- getOrElseOrNone(userMetadata, "bounds-x", "bounds_x").map(_.toInt) | ||
| y <- getOrElseOrNone(userMetadata, "bounds-y", "bounds_y").map(_.toInt) | ||
| w <- getOrElseOrNone(userMetadata, "bounds-width", "bounds_w").map(_.toInt) | ||
| h <- getOrElseOrNone(userMetadata, "bounds-height", "bounds_h").map(_.toInt) | ||
| ratio = getOrElseOrNone(userMetadata, "aspect-ratio", "aspect_ratio") | ||
| exportType = userMetadata.get("type").map(ExportType.valueOf).getOrElse(ExportType.default) | ||
| } yield { | ||
| CropSpec(source, Bounds(x, y, w, h), ratio, exportType) | ||
| } | ||
| } | ||
|
|
||
| private def getOrElseOrNone(theMap: Map[String, String], preferredKey: String, fallbackKey: String): Option[String] = { | ||
| // Return the `preferredKey` value in `theMap` or the `fallbackKey` or `None` | ||
| theMap.get(preferredKey).orElse(theMap.get(fallbackKey)) | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| package lib | ||
|
|
||
| import com.gu.mediaservice.model._ | ||
| import org.joda.time.DateTime | ||
| import org.scalatest.funspec.AnyFunSpec | ||
| import org.scalatest.matchers.should.Matchers | ||
|
|
||
| class CropSpecMetadataTest extends AnyFunSpec with Matchers with CropSpecMetadata { | ||
|
|
||
| private val cropSpec = CropSpec( | ||
| uri = "/test", | ||
| bounds = Bounds(1, 2, 3, 4), aspectRatio = Some("16:9"), `type` = ExportType.default | ||
| ) | ||
| private val crop = Crop( | ||
| id = Some("123"), | ||
| specification = cropSpec, | ||
| author = Some("Tony McCrae"), | ||
| date = Some(DateTime.now), | ||
| master = None, | ||
| assets = List.empty, | ||
| ) | ||
| private val dimensions = Dimensions(640, 480) | ||
|
|
||
| describe("metadata for crop spec") { | ||
| it("should serialize crop spec to key value pairs") { | ||
| val metadata = metadataForCrop(crop, dimensions) | ||
|
|
||
| metadata("width") shouldBe "640" | ||
| metadata("height") shouldBe "480" | ||
| metadata.get("aspect-ratio") shouldBe Some("16:9") | ||
| metadata.get("author") shouldBe Some("Tony McCrae") | ||
| } | ||
|
|
||
| it("should handle empty optional fields") { | ||
| val withEmptyField = cropSpec.copy(aspectRatio = None) | ||
|
|
||
| val metadata = metadataForCrop(crop.copy(specification = withEmptyField, author = None), dimensions) | ||
|
|
||
| metadata.get("aspect-ratio") shouldBe None | ||
| metadata.get("author") shouldBe None | ||
| } | ||
|
|
||
| it("should round trip metadata back to crop spec") { | ||
| val metadata = metadataForCrop(crop, dimensions) | ||
|
|
||
| val roundTripped = cropSpecFromMetadata(metadata) | ||
|
|
||
| roundTripped shouldBe Some(cropSpec) | ||
| } | ||
| } | ||
|
|
||
| } |