[extras-circe] Add renameFields for Codec to rename circe Json fields

[kevin-lee]

Task

Summary

[extras-circe] Add renameFields for Codec to rename circe Json fields

Project Details

Version: 0.32.0

Description

final case class Something(a: Int, b: String, price: BigDecimal, c: Boolean)
object Something {
  import extras.circe.codecs.codec._
  implicit val somethingEncoder: Codec[Something] =
    deriveCodec[Something].renameFields(
      "a"  -> "productNumber",
      "b"  -> "name",
      "c" -> "inStock",
    )
}

val something = Something(1, "Vibranium Shield", BidDecimal(9999999), false)

Encoding:

import io.circe.syntax._
something.asJson.spaces2

{
  "id": 1,
  "name": "Vibranium Shield",
  "price": 9999999,
  "inStock": false
}

Decoding:

val json = """{
  "productNumber": 1,
  "name": "Vibranium Shield",
  "price": 9999999,
  "inStock": false
}"""

import io.circe.parser._
decode[Something](json)
// Either[Error, Something] = Right(Something(a = 1, b = "Vibranium Shield", price = 9999999, c = false))