v1.7.1

Changelog:

• bugfixes
  • increased test coverage for semiautomatic derivation methods and fixed a bug in Scala 3 implementation of TransformerDefinition.withFallbackFrom (#685)
  • enabling macro debugging for a single derivation (rather than globally) is no longer treated as an override changing behavior of some cases (#682)
  • fix some rename edge cases broken by 1.6.0 refactor (#683, fixed in #684)
• updated documentation
  • expanded section on chimney-macro-commons (#681)
  • updated Ducktape section, thanks to the first contrubution of @arainko! (the author of Ducktape) (#679)
  • fixed typos in DESIGN.md, thanks to the first contribution of @civilizeddev! (#680)

v1.7.0

This big release bring some long-awaited features: transformations, which take more than 1 case class as input (well, not only case classes 😄 ) and improved Patchers which handle: recursive patching, overriding values.

Changelog:

• merging transformations - now it's possible to start transformation DSL with 1 value, and keep adding more values as "fallbacks", so that if the field is not found in the first one, it will be looked for in the second, then third, etc, effectively allowing us to merge several input values into 1 output value (#115, fixed in #614)
  • this includes merging several tuples into 1
  • and merging several Options or Eithers using orElse (opt-in)
  • and merging several collections using ++ (opt-in)
  • and more!
• added policies for checking if some source field was not used during transformation, or that some target sealed trait subtype was not matched - (#248, fixed in #614)
  • we can set Chimney to fail compilation until we mark some source field explicitly not-used, ditto for sealed subtype
• rewritten Patchers as specialized merging transformations (#538, fixed in #614)
  • this allowed us to make Patchers recursive (fixing #119)
  • and take implicit Patcher in nested fields (fixing #133)
  • and made it east to add withFieldConst, withFieldComputed and withFieldomputedFrom to Patchers (fixing #134)
  • and, combined with policies, allowed us to ignore some fields in Patchers and updating from another instance of the same type (fixing #161 and #57)
• additionally we added (opt-in!) support for using implicit conversions and <:< during derivation (#667)
• added support for generating transformation out of implicit F ~> G in Cats integration (#666)
• improved withFieldComputedFrom to handle more expected cases (#660)
• added/expanded a few sections in our documentation (#657)
  • explained how to define transformers between String and enums
  • how to avoid using nested .into.transform when we need only 1
  • the common issue of how to change the naming convention when decoding JSON and then using Chimney
  • expanded Cats section on examples with parMapN and similar
  • updated Ducktape comparison
• updated Scala 2.13 to 2.13.16, Scala.js to 1.18.1

With this release I feel that all of my personal ambitions for Chimney has been realized.

v1.6.0

Changelog:

• now we are testing that macros in Scala 2.13 can read Scala 3 code and vice versa - while people might take it for granted, there are some differences in AST between both versions so support for e.g. default values or @BeanProperty requires additional work (done in #647)

• withFieldComputed/withFieldComputedPartial can now be used in a version that does NOT take the whole input, and so removes the need for writing nested transformers (done in #650)

  // before
  foo.into[Bar]
    .withFieldComputed(_.baz, foo => f(foo.field)) // cannot just use f, does not work with .everyItem etc
    .transform
  
  // or
  implicit val inner: Transformer[Field, Baz] = ...
  
  foo.into[Bar]
   .withFieldComputed(_.baz, _.field.transformInto[Baz]) // actually never needed -> withFieldRenamed is enough
   .transform
  
  // now
  foo.into[Bar]
    .withFieldComputedFrom(_.field)(_.baz, f) // just f, can be used as ComputedFrom(_.everyItem)(_.everyItem, f) etc
    .transform

• flags can be provided not only globally, but for nested scope as well, which further removed any need for nesting transformers (done in #653)

  // before
  foo.into[Bar]
    .withFieldComputed(_.baz, _.field.into[Baz].enableDefaultValues.transform)
    .transform
  
  // now
  foo.into[Bar]
    .withFieldRenamed(_.field, _.baz)
    .withTargetFlag(_.baz).enableDefaultValues
    .transform

• make Path DSL more consistent - now Chimney should handle more overrides where we want to rewrite e.g. from _.everyItem._1 into _.everyMapKey, .matchingSome is consistent with .matching[Some[InferredA]].value, etc (done in #654)

• for a long time when .withFieldConstPartial or .withFieldComputed(something that might throw) or .withFieldComputedPartial were used, the error Path contained the target field name - if such transformation happens in nesting you would receive an error path like sourceField.nestedSourceField.targetField which makes no sense. This is changed now, so that the Path would be <const for _.targetField>, <computed for _.targetField> or sourceField.anotherSourceField => <computed for _.targetField> to make it explicit that the failure didn't come from some value in input, but in a value provided explicitly, or returned from a function (done in #655 and #656)

• documentation improvements by @ghostdogpr (#628) - thank you for your first contribution!

v1.5.0

Changelog:

• updated Scala 2.12 to 2.12.20, Scala to 3.3.4, Scala.js to 1.17.0 and Scala Native to 0.5.5
• added the Result#fromCatchingNonFatal by @danicheg in #590 - thank you for your first contribution!
• fixed some typos by @danicheg in #593
• improved withFieldRenamed - now it supports .everyItem / .everyMapKey / .everyMapValue / .matching[Subtype] / .matchingSome / .matchingLeft / .matchingRight on the source-side of the rename path as well!- done in #616
• added a new Outer Transformers integration - allowing to tell the Chimney how to convert some outer type while Chimney takes care of converting its inner values - and used it to improve the support for Cats' NonEmpty types - fixing #569 in #624
• tested and documented the possibly surprising behavior - that writing to vars is enabled with .enableBeanSetters, and it makes sense! - done in #621
• improvements to chimney-macro-commons - module existing since Chimney 0.8.0-M1, which you probably haven't heard about yet:
  • adding Type.simplePrint and DefCache which should make it easier to use this library for writing other macro libraries (with possibly different use cases than Chimney) - done in #620
• the first release of chimney-engine:
  • it allows using chimney derivation logic inside your own macros, if what you're trying to do is very close to what Chimney does but when extending it for your use cases requires modifying macros rather than providing an implicit
  • chimney-engine has a release cycle tied to core Chimney (meaning the same version), but please consider this API experimental
• bugfix for pattern matcing fall through when the Scala 3's enum parameterless case is lowercased #479 - fixed by @jchyb in #603
• workaround against the bug in the compiler scala/scala3#21672 which would make order of cases in match nondeterministic (breaking cache)- fixed in #623

v1.4.0

Changelog:

• allow setting Chimney flags globally through -Xmacro-settings scalac flag - see the docs to be able to globally disable/enable default values, usage of defs, getters/setters, etc (done in #572)
• start supporting some simple lens-like operations officially (added testing, bugfixed uncovered cases) - see the docs and start updating your data with value.into[ValueType].withFieldConst(_.fieldName.matching[Subtype].everyItem, value).transform and how it compares to e.g. Quicklens (done in #583)
• improve the documentation about integrating other libraries with Chimney (done in #584)

v1.3.0

Changelog:

• fix issue in Scala 2 related to (probably?) Symbol initialization AND default values in constructor not relying on companion apply (#562, fixed in #563)
• improve support for singleton types - case objects and Scala 3 enums as target should always succeed and always be available as a fallback values for parameters (do not require matching input parameter) (#407, fixed in #559)
• add Cats instances (Category/Invariant) for bi-directional transformations (Codec/Iso) (#566)
• improve docs testing - test whether the Scala CLI output printed with pprint matches the expectation (#536, fixed in #567)
• improve Protobufs support for data types modeled using sealed traits:
  • implicit with automatic handling of Empty oneof for sealed_value
  • implicit with automatic handling of Unrecognized for enum
  • ability to automatically unwrap non-AnyVal value type (enabled with a flag) which can be used to unwrap oneof values (#531, fixed in #568)

v1.2.0

Changelog:

• chimney-java-collections module now contains conversions for Scala to/from Java primitives (scala.Int <-> java.lang.Integer, scala.Double <-> java.lang.Double, etc) (#535, done in #556)

• introduced Codec[Domain, Dto] and Iso[A, B] types which represents bidirectional conversions:

  • Codec "encodes" Domain into Dto using Transformer and "decodes" Dto into Domain with PartialTransformer
  • Iso represents isomorphism where both directions are handled with Transformers

  (#96, done in #547)

• allow renaming the subtype in sealed/enum conversions (#409, done in #557)

• allow enabling default values only for a specific type (e.g. scalapb.UnknownFieldSet), allow providing your own DefaultValue[A] for cases when it would be convenient to use then but where they are not defined (#408, done in #558)

v1.1.0

Changelog:

• updated Scala 2.13 to 2.13.14 (#526)

  • it's the first release implementing SIP-51
    which drops forward comparibility in standard library. It means that every library compiled with 2.13.14 or higher will
    evict standard library to higher version - and since the compiler cannot be at lower version than the .ibrary it will also force
    Scala version update. This change was reade to merge before Chimney 1.0.0 but we postponed it to give people more time to migrate to this new convention

• replaced Scala Native 0.4 with Scala Native 0.5 (#545) - while ideally we'd prefer to have a stepping-stone release cross-compiled for both 0.4 and 0.5,
  libries that Chimney depends on in its integrations (Cats, Scala Collection Compat, Scala Java Time, ScalaPB) moved directly to
  SN 0.5 dropping 0.4 on the spot

• made the order of pattern-matching in sealed trait/enum transformation deterministic (useful for avoiding cache misses) (#543) - thanks to @reimai for the first contribution!

• replaced hardcoded dependency on DSL's runtime overrides storage from macros internals (#552, fixed in #539)

  • this change unblocks the possibility to provide a different front-end to Chimneys macros (or using Chimney macros inside your macros). It would allow a development of, for instance:

    • Ducktape-like DSL without builder-API runtime overhead (value.transformInto(overrides))
    • Chimney-based lenses - currently Chimney can be used for lenses-like operations
      but it only works with .into.overrides.transform API and bears the costs of builder-API overhead
      (with different API it would be possible to update several nested fields with no overhead compared to manually written code!)
    • specialized derivations - initiatives like moia-oss/teleproto#321 would be able to call and customize Chimney macros directly,
      replace Chimney's Transformer with their own type class, add/remove derivation rules, etc. with collision with Chimney

    If you are interested in this, please contact us using GH discussions!

v1.0.0

Release 1.0.0 is the culmination of 7 years of development.

If you are curious about the migration from 0.8.x you'll find the guideline here (tl;dr there should be nothing to worry about as long as you recompile).

Changelog since 0.8.x:

• revamped Cats' instances to match existing conventions (both in Cats as well as in Chimney) (fixed in #443)
  • Transformer, PartialTransformer and partial.Result have all instances that make sense for them
  • conversions from cats.Validated to partial.Result use the same convention as other types (using AsResult type class and asResult extension method introduced in 0.8.0)
  • for partial.Result and PartialTransformer one can combine values using sequential or parallel semantics (read about them in the docs!!!)
  • all instances are tested against Cats disciplines
• further improvements to Cats' instances for Chimney types - added Alternative type class to the list of provided instances, a few missed discipline tests were added (#465)
• provided a flag to disable automatic Option unwrapping by PartialTransformer (#322, addressed by #477) (disabling that behavior by default is not planned)
• added a way to customize how source fields/subtypes are matches against target fields/subtypes (#89 and #480, fixed in #478) - thanks to @saeltz for contributing to the PR as the first contribution!
• restored the behavior from before 0.8.x series when only methods returning Unit could be considered setters (provides a better fix to #424, fixed in #485). If needed non-Unit setters can be opted-in
• detect and report ambiguities with pairing field names (#449, #461, fixed in #485)
• improve error messages when there are def methods or other inherited accessors that could be enabled with a flag (fixed in #485)
• type-level config representation and internal macros overrides get heavily refactored (#490, #491, #492) (breaking change!)
• which unblocked the development of better nested paths (#493):
  • now it is possible to use overrides like withFieldConst(_.adt.matching[ADT.Subtype].either.matchingRight.collection.everyItem.map.everyMapValue, ...)
  • in this first iteration, improved paths to overridden values support only build-in Scala types: Option (matchingSome), Either (matchingLeft, matchingRight), Scala's collections (.everyItem, .everyMapKey, .everyMapValue) but it is planned to extends support for other collections
• suppress WartRemover/Scapegoat warnings (#496, fixe),d in #497)
• deprecate withCoproductInstance in favor or withSealedSubtypeHandled and withEnumCaseHandled (fixed in #500) - old name is still available but it was @deprecated since it uses the term "coproduct" basically unknown outside of library writers crowd
• documentation now has light/dark theme toggle with the default being whatever your system uses
• fixed to internal representation of subtype-matchiung configs (#499, fixed in #504)
• format scaladoc documentation with scalafmt wrap = yes config
• fix a bug that occurred in some cases when using withConstructorPartial (fixed in #508)
• add withContructorEither in PartialTransformers to make it easier to work with smart constructors based on Either[String, Type] (done in #509)
• created an integration API for providing custom optional types and custom collections (#505)
  • extended support for _.matchingSome, _.everyItem, _.everyMapKey,_.everyMapValue to every collection provided through integrations API
• migrated chimney-java-collections through new integration API (#510)
• provided support for transformation of cats.data types like Chain, NonEmptyChain, etc through integrations API (#421, fixed in #511)
• allow providing an override to a field shared between all subtypes of an ADT (sealed, enum) (#512)
• fix rare case of StackOverflow with Scala 3 enums (#528)
• hide the last API intended for internal usage (#540)
• tests Scala CLI snippets (#523, #524, #534) and extract snippet testing to an external library ScalaCLI.md Spec (#525)

v1.0.0-RC1

This release candidate contains all the functionality intended for 1.0.0 launch. Please help us testing it for bugs. If no bugs - requiring changes to API and breaking binary/source compatibility - are found, Chimney 1.0.0 is planned to be released at 23.05.2024. Then it will move from early-semver to proper semantic versioning.

If you are curious about the migration from 0.8.x you'll find the guideline here (tl;dr there should be nothing to worry about as long as you recompile).

Changelog since 0.8.x:

• revamped Cats' instances to match existing conventions (both in Cats as well as in Chimney) (fixed in #443)
  • Transformer, PartialTransformer and partial.Result have all instances that make sense for them
  • conversions from cats.Validated to partial.Result use the same convention as other types (using AsResult type class and asResult extension method introduced in 0.8.0)
  • for partial.Result and PartialTransformer one can combine values using sequential or parallel semantics (read about them in the docs!!!)
  • all instances are tested against Cats disciplines
• further improvements to Cats' instances for Chimney types - added Alternative type class to the list of provided instances, a few missed discipline tests were added (#465)
• provided a flag to disable automatic Option unwrapping by PartialTransformer (#322, addressed by #477) (disabling that behavior by default is not planned)
• added a way to customize how source fields/subtypes are matches against target fields/subtypes (#89 and #480, fixed in #478) - thanks to @saeltz for contributing to the PR as the first contribution!
• restored the behavior from before 0.8.x series when only methods returning Unit could be considered setters (provides a better fix to #424, fixed in #485). If needed non-Unit setters can be opted-in
• detect and report ambiguities with pairing field names (#449, #461, fixed in #485)
• improve error messages when there are def methods or other inherited accessors that could be enabled with a flag (fixed in #485)
• type-level config representation and internal macros overrides get heavily refactored (#490, #491, #492) (breaking change!)
• which unblocked the development of better nested paths (#493):
  • now it is possible to use overrides like withFieldConst(_.adt.matching[ADT.Subtype].either.matchingRight.collection.everyItem.map.everyMapValue, ...)
  • in this first iteration, improved paths to overridden values support only build-in Scala types: Option (matchingSome), Either (matchingLeft, matchingRight), Scala's collections (.everyItem, .everyMapKey, .everyMapValue) but it is planned to extends support for other collections
• suppress WartRemover/Scapegoat warnings (#496, fixed in #497)
• deprecate withCoproductInstance in favor or withSealedSubtypeHandled and withEnumCaseHandled (fixed in #500) - old name is still available but it was @deprecated since it uses the term "coproduct" basically unknown outside of library writers crowd
• documentation now has light/dark theme toggle with the default being whatever your system uses
• fixed to internal representation of subtype-matchiung configs (#499, fixed in #504)
• format scaladoc documentation with scalafmt wrap = yes config
• fix a bug that occurred in some cases when using withConstructorPartial (fixed in #508)
• add withContructorEither in PartialTransformers to make it easier to work with smart constructors based on Either[String, Type] (done in #509)
• created an integration API for providing custom optional types and custom collections (#505)
  • extended support for _.matchingSome, _.everyItem, _.everyMapKey,_.everyMapValue to every collection provided through integrations API
• migrated chimney-java-collections through new integration API (#510)
• provided support for transformation of cats.data types like Chain, NonEmptyChain, etc through integrations API (#421, fixed in #511)
• allow providing an override to a field shared between all subtypes of an ADT (sealed, enum) (#512)