[Issue #75] Add support for field/case renames via flags #252

arainko · 2025-03-08T09:01:16Z

Closes #75

Field and case renames are now possible with the newly introduced config options:

Field.modifySourceNames
Field.modifyDestNames
Case.modifySourceNames
Case.modifyDestNames

All of them can be further configured in 3 ways:

.regional(_.path.to.field) - this will apply renames to all transformations 'below' the path you've picked (this is the default)
.typeSpecific[SomeType] - this will apply the renames to subtypes of a type you've picked
.local(_.path.to.field) - this will apply renames to the field corresponding to that field/enum subcase (but not the field and the enum subcase themselves!)

Examples of regional configs:

 test("dest field regional flag covers the selected case class and everything below it") {
    case class Source(int: Int, str: String, level1: SourceLevel1)
    case class SourceLevel1(INT: Int, STR: String, LEVEL2: SourceLevel2)
    case class SourceLevel2(INT: Int, STR: String)

    case class Dest(int: Int, str: String, level1: DestLevel1)
    case class DestLevel1(INT: Int, STR: String, LEVEL2: DestLevel2)
    case class DestLevel2(INT: Int, STR: String)

    val source = Source(1, "1", SourceLevel1(2, "2", SourceLevel2(3, "3")))
    val expected = Dest(1, "1", DestLevel1(2, "2", DestLevel2(3, "3")))

    assertTransformsConfigured(source, expected)(
      Field.modifyDestNames(_.toUpperCase).regional(_.level1)
    )
  }

  test("source case regional flag covers the selected subtype and everything below (picked as a field in case class)") {
    case class Source(int: Int, level1: SourceEnum)
    case class Dest(int: Int, level1: DestEnum)

    enum DestEnum {
      case one(int: Int, str: String)
      case two(int: Int, str: String, level1: DestLevel1, level2: DestLevel1Enum)
      case three(int: Int, str: String)
    }

    enum SourceEnum {
      case ONE(int: Int, str: String)
      case TWO(int: Int, str: String, level1: SourceLevel1, level2: SourceLevel1Enum)
      case THREE(int: Int, str: String)
    }

    enum SourceLevel1Enum {
      case One
      case Two
    }

    enum DestLevel1Enum {
      case one
      case two
    }

    case class SourceLevel1(int: Int)
    case class DestLevel1(int: Int)

    assertTransformsConfigured(
      Source(1, SourceEnum.TWO(2, "2", SourceLevel1(3), SourceLevel1Enum.Two)),
      Dest(1, DestE
8000
num.two(2, "2", DestLevel1(3), DestLevel1Enum.two))
    )(
      Case.modifySourceNames(_.toLowerCase).regional(_.level1)
    )
  }

Examples of local flags:

test("dest field local flag covers the selected case class and nothing else") {
    case class Source(int: Int, str: String, level1: SourceLevel1)
    case class SourceLevel1(INT: Int, STR: String, LEVEL2: SourceLevel2)
    case class SourceLevel2(int: Int, str: String)

    case class Dest(int: Int, str: String, level1: DestLevel1)
    case class DestLevel1(int: Int, str: String, level2: DestLevel2)
    case class DestLevel2(int: Int, str: String)

    val source = Source(1, "1", SourceLevel1(2, "2", SourceLevel2(3, "3")))
    val expected = Dest(1, "1", DestLevel1(2, "2", DestLevel2(3, "3")))

    assertTransformsConfigured(source, expected)(
      Field.modifyDestNames(_.toUpperCase).local(_.level1)
    )
  }

and an example of a type specific flags:

 test("source field type specific flag covers all subtypes of an enum and nothing else (even when the enum is nested)") {
    case class Source(int: Int, level1: SourceEnum)
    case class Dest(int: Int, level1: DestEnum)

    sealed trait SourceEnum

    object SourceEnum {
      sealed trait NestLevel1 extends SourceEnum
      sealed trait NestLevel2 extends SourceEnum

      case class One(int: Int, str: String) extends NestLevel2
      case class Two(int: Int, str: String, level1: SourceLevel1) extends NestLevel1
      case class Three(int: Int, str: String) extends NestLevel2
    }

    sealed trait DestEnum

    object DestEnum {
      sealed trait NestLevel1 extends DestEnum
      sealed trait NestLevel2 extends DestEnum

      case class One(INT: Int, STR: String) extends NestLevel2
      case class Two(INT: Int, STR: String, LEVEL1: DestLevel1) extends NestLevel1
      case class Three(INT: Int, STR: String) extends NestLevel2
    }

    case class SourceLevel1(int: Int)
    case class DestLevel1(int: Int)

    assertTransformsConfigured(
      Source(1, SourceEnum.Two(2, "2", SourceLevel1(3))),
      Dest(1, DestEnum.Two(2, "2", DestLevel1(3)))
    )(
      Field.modifySourceNames(_.toUpperCase).typeSpecific[SourceEnum]
    )
  }

The renames themselves can be mixed and matched with the limitation of being expressible at compiletime using this DSL:

sealed trait Renamer {
  def toUpperCase: Renamer

  def toLowerCase: Renamer

  def rename(from: String, to: String): Renamer

  def replace(target: String, replacement: String): Renamer

  def regexReplace(pattern: String, replacement: String): Renamer
}

(adding new operations is pretty trivial)

…getOrElse to work on a partial function instead

This reverts commit 5b973b1.

This reverts commit 1f9b55b.

…anner" This reverts commit 5e8a8d7.

… let's not do it, alright?

…ng and wire it up with flags and the config parser

…n if it's a sealed trait with next sealed traits underneath)

…ble, add tests

ducktape/src/main/scala/io/github/arainko/ducktape/Case.scala

ducktape/src/main/scala/io/github/arainko/ducktape/Field.scala

ducktape/src/main/scala/io/github/arainko/ducktape/Regional.scala

ducktape/src/main/scala/io/github/arainko/ducktape/internal/ConfigParser.scala

ducktape/src/main/scala/io/github/arainko/ducktape/internal/Configuration.scala

ducktape/src/main/scala/io/github/arainko/ducktape/internal/ParseRenamer.scala

ducktape/src/main/scala/io/github/arainko/ducktape/internal/PlanFlags.scala

ducktape/src/main/scala/io/github/arainko/ducktape/internal/Planner.scala

ducktape/src/main/scala/io/github/arainko/ducktape/internal/Test.scala

arainko added 29 commits January 26, 2025 20:16

initial work

a0fe697

actually exciting for once

0387185

a nicer dsl is needed, or just pass stuff as explicit params? boooring

b9a6143

use steps as opposed to segments

e98bee7

propagate flags everywhere in Planner, slightly refactor .get(_).map.…

02fbb06

…getOrElse to work on a partial function instead

POC impl of Defaults with flags

0f205f4

propagate priorities

77b8e91

fix compilation errors

d8eeda5

add parser for defaults and nones, thread flags through to Planner

5e8a8d7

rough poc of defaults for product to product only for now

1f9b55b

take priority into consideration

5b973b1

Revert "take priority into consideration"

8a77bc6

This reverts commit 5b973b1.

Revert "rough poc of defaults for product to product only for now"

d1d3f8d

This reverts commit 1f9b55b.

remove Priority from Plan.Configured

6d3e266

Revert "add parser for defaults and nones, thread flags through to Pl…

e6c9bb5

…anner" This reverts commit 5e8a8d7.

actually, rebuilding defaults and nones as a flag is a godawful idea,…

79bb4b7

… let's not do it, alright?

at long last - an actually working field renames POC

d3835e4

crudely implemented coproduct renaming

bf56d41

add local and typeSpecific modifiers

e7e4317

e2e poc - implement Renamer parsing into a compiletime String => Stri…

4604d07

…ng and wire it up with flags and the config parser

fix a small oopsie

b0eb2d9

transfer Local flags to all the enum children (and children's childre…

1c2de3c

…n if it's a sealed trait with next sealed traits underneath)

propagate flag span in ambiguity error messages

9d12987

add some very basic tests

ac51d52

another set of tests

d796713

more test for local flags

4ce083b

fix handling of flags in BetweenFallibles and BetweenFallibleNonFalli…

19d3a59

…ble, add tests

add tests for regional flags, finish up general flag tests

421ca42

finish up all tests

d0b2890

arainko mentioned this pull request Mar 8, 2025

Mapping field names based on a constant function #75

Closed