Skip to content

Changelog

Jump to bottom Edit New page
Stephan Pauxberger edited this page Mar 28, 2024 · 60 revisions

2.0.0 (unreleased)

  • New Features

    • New Field Type: BUILDER: Getters are protected or private in model, but dsl methods are public
    • Compatibility with Groovy 3 and 4. KlumAST is currently still built with Groovy 2.4 (for compatibility with Jenkins). Tests are run with Groovy 3 and 4 as well.
    • Replace basic jackson transformation with a dedicated (beta) JacksonModule (see Jackson Integration)).
    • First steps for Layer3 models. (see Layer3)
    • Split model creation into distinct phases (see #156, #155,#187 and Model Phases)
    • New Phases:
      • PostTree: is run after the model is completely realized (#280
      • AutoCreate: automatic creation of null fields (#275
      • Owner: Sets owners and calls owner methods (#284)
      • AutoLink: Links fields to other fields in the model (#275
      • Defaults: sets default values (#196
      • Validate: Validation of the model
    • In addition to lifecycle methods, fields of type Closure can now be used to define model provided (instead of schema provided) lifecycle methods. These closures will be executed in their respective Lifecycle phases.
    • default implementation: by providing the attribute defaultImpl on either @DSL or @Field, one can allow the creation of non-polymorphic field methods even for interfaces and abstract types. (see Default Implementations)
    • Creator methods have been moved to a separate creator class (see #76), creator methods on the model class have been deprecated (see Migration).
    • Custom creator classes can be provided (see Factory Classes)
    • Methods of creator classes (including custom creators) are included in collection factories (see #300 and Factory Classes)
    • Creator class also supports creating templates from scripts (files or URLS) (see Templates and #322)
    • Switch annotation validation to KlumCast Framework (see #312))

  • Improvements

    • Creator classes also support methods creating multiple instances at once (see #319)
    • CopyFrom now creates deep clones (see #36)
    • boolean fields are never validated (makes no sense), Boolean fields are evaluated against not null, not against Groovy Truth (i.e. the field must have an explicit value assigned) (see #223)
    • Provide @Required as an alternative to an empty @Validate annotation (see #221)
    • EnumSet fields are now supported. Note that for enum sets a copy of the underlying set is returned as opposed to a readonly instance. (see #249)
    • Converter methods are now honored for Alternatives methods as well. (see #270)
    • @Validate now can be placed on classes. This effectively replaces @Validate(option=Validation.Option.VALIDATE_UNMARKED), which is internally converted to the new format (see #276). The @Validation annotation is deprecated.
    • Sanity check: Key Fields must not have @Owner or @Field annotations.

  • Deprecations (see Migration):

    • The @Validation annotation is deprecated. Use @Validate on class level instead.
    • creator methods on the model class have been deprecated.

  • Breaking changes ((see Migration)

    • it is a compile error to place the @Validate annotation on a boolean field.
    • KlumAST is split into different modules, klum-ast-compile is compile-time only, klum-ast-runtime is needed for runtime as well. This completes the changes started in 1.2.0
    • In order for the serialization in jackson to work, the new klum-ast-jackson module needs to be included in the project (see Jackson Integration))))
    • The naming of virtual fields is changed, now the virtual field is identical to the method name (previously, the first element of the camel cased method name was removed).
    • methods named doValidate are no longer considered Validate methods by default.
    • Static Type Checking for Configuration Scripts does not (yet) work under Groovy 3
    • The @Validation annotation is deprecated, any use except for @Validate(option=Validation.Option.VALIDATE_UNMARKED) will have no effect.
    • Previously, only public methods were checked for illegal write access. This has been changed to include all visibilities. Protected methods that are conceptually write access methods must now also be annotated with @Mutator, otherwise a compile error is thrown.
    • The generated validate() method is now deprecated, use KlumInstanceProxy.validate() instead. This means that creating own validate methods is legal again.
    • Owner fields are now set in a later phase, meaning that they are not yet set when apply closures are resolved. This logic must be moved to a later phase (postTree), for example using lifecycle closures.
    • Default values are no longer a modification of the getter but rather explicitly set during the 'default' phase. This might result in subtle differences in the behavior, especially when using a non-template as template / target for copyFrom. Make sure to create template instances with Create.Template if you want to use them as templates.

  • Fixes

    • since rc.13
      • Fix polymorphic virtual setters (see #250)
      • Converter methods should honor default values (see #268)
    • since rc.12
      • More fixes to nested generics (see #248)
    • since rc.11
      • Converter methods not working for maps of DSL objects (see #242)
      • Created class is invalid if field type is generic and contains generic factories (like List.of) (see #243)
      • Default delegate failed if delegate was a getter instead of a real field (see #244)
      • apply did not accept a Map only call (see #241)
    • since rc.9
      • Handling of key fields in hierarchies (see #238)
    • since rc.5
      • Visibility for creator methods was wrong (see #232)

  • Dependency changes/Internal

    • since rc.14
      • Update Jackson to 2.13.3 (see #260)

1.2.2

  • Changes/Improvements
    • Allow coercion of RW instance to superclass of model instance (see #225)

1.2.1

  • Changes/Improvements
    • Compatibility with Groovy 3. KlumAST is currently still built with Groovy 2.4 (for compatibility with Jenkins). Note that this is not yet automatically tested.

1.2.0

  • New Features

    • Allow manual IDE hints for delegation to the RW class (see #101)
    • Collection factories can now include templates (see #77)
    • Field Types:
      • Replaced the @ReadOnly annotation with a @Field(FieldType.PROTECTED) (see #108)
      • Included a TRANSIENT field type to allow fields that are not part of the model (see #102)
      • PROTECTED (former ReadOnly) fields now DO create adder methods, although protected (see #78)
      • IGNORED fields don't get DSL methods, but their setters are still only in the RW Model (see #126)
      • LINK fields only get reuse DSL methods, but no creation methods. (see #172)
    • New optional classloader parameter for createFrom(String|File|Url) (see #123)
    • For map fields, arbitrary key values (derived from the element) can be used with a new Field.keyMapping value (see #127 and #128)
    • Setter-like methods (with exactly one parameter) can be declared as virtual fields using the @Field annotation (see #19)
    • Using converters, additional setters / adders with different parameter sets can be generated (see #148, #152 and #154)
    • allow any number of owner fields across the hierarchy (see #171)
    • Experimental support for JsonIgnore Annotations. Currently, this is hard baked in the lib and activates if Jackson is found on the classpath during compilation. This will eventually be moved into a separate module (klum-ast-jackson and later klum-ast-json)
    • Allow custom parameters to be injected to DSL method parameters (esp. DelegatesTo and ClosureParams for closure fields) (see Advanced Techniques and #150)
    • Allow owner methods in addition to owner fields (see Owner methods and #176)
    • Added option to auto set the key value on a single dsl field with a keyed parameter (see #186)
    • Added experimental gdsl file to fix code completion for polymorphic methods (at least in IntelliJ IDEA)
    • Convenience factory for multiple scripts at once (see #198)

  • Changes/Improvements

    • Issue a warning if a field is named owner
    • interfaces can also be annotated with @DSL. While they won't be converted in any way, field with DSL interface types will get DSL methods generated. Note that in this case verification of the inheritance tree is incomplete which might lead to issues in specific corner cases (DSL interface <- non DSL class <- DSL class). (see #121)
    • Allow non-keyed abstract ancestors for key hierarchies. (see #143)
    • All single object setter/adder for existing objects now return the added object (see #131)
    • Allow convenience factories for abstract classes as well (see #195)

  • Fixes

    • Fix delegating script factory for keyed objects
    • Execute Post-apply for delegating scripts as well
    • Fixed a bug that occurred when the name of a field dsl methods was identical to the name of the target's key field
    • Fixed a bug concerning reused class nodes

  • (Potentially) breaking changes:

    • Templates do not get PostApply Lifecycle methods called. This was fixes some problems with complex template structures and should never have been done anyway (postCreate was never called) #194)
    • Introduce a new createFromClasspath method (see #110)
    • this means that either klum-ast or future klum-util package needs to be present in the classpath during runtime
    • Closures are all DelegateOnly instead of the previous DelegateFirst. This means that you cannot access methods of an outer object directly (which would not be very intuitive). If you need this functionality, you need to access the outer object directly, using the owner property of Closure or an @Owner field of the outer instance. See Migration for details. (#72)
    • Inner objects are now validated as part of the validation of outer objects (see #120)
    • Failed validations now throw an AssertionError instead of an IllegalStateException
    • Changed RW class to a static inner class (formerly non-static). This fixes a some issues with Groovy handling of inner classes but might introduce some issues in corner cases (methodMissing methods from Model is not reachable from RW class)

1.1.1

  • access to owner from inner closures failed with static type checking (see #99)

1.1

  • Changed supported groovy version to 2.4
  • removed deprecated methods (createTemplate and createFrom*)

1.0

  • RW classes can be coerced back to model (see #89)
  • Key and Owner can be accessed via standard methods (see #55)
  • small bugfix with methodMissing corner cases

0.99.2

  • apply and collectionFactory creation should not have default values for closure (see #82)
  • create new ReadOnly annotation, which replaces the deprecated Ignore annotation (see #80)

0.99.1

  • RW-classes must be Serializable as well (see #85)

0.99

  • Alternatives are back. There are three ways to customize the name of alternatives, see Alternatives Syntax for details.

0.98.1

  • Fix accidental setting of properties to final
  • additional convenience factory for delegating scripts

0.98.0

  • Breaking changes:

    • Models are now read only. This means all mutation methods are constrained to the content of the apply() / create() closures. Unfortunately, there is no deprecation path for this change, which means that in order to use this version, you might have to change code to fix compilation errors.

      see Static Models and #56

    • Additional methods that change state must/should now be marked with @Mutator, which effectively moves them to the RW class. This is currently partially validated. An example usage for this are pseudo setters (i.e. methods named as setters, but relying on other methods)

  • Lifecycle methods are moved to the rw-class and made protected, which effectively makes them invisible when instantiating and using the model. This means more reduction of interface clutter.

  • Model classes are now made TypeChecked by default. This can be disabled for single methods or the whole model using @TypeChecked(TypeCheckingMode.SKIP).

  • Javadocs

  • renamed makeTemplate to createAsTemplate (see #61)

  • include source code pointer to base field for setter methods (see #69)

0.97.5

  • Fix: DelegatesTo annotations for polymorphic setters where not correct (see #67)

0.97.2

  • remove gdsl file from jar file for now. It's neither up to date, nor does it work with current IntelliJ IDEA versions

0.97.1

  • Critical Bugfix: all methods were marked as deprecated
  • Fix: PostCreate was not called on inner objects (see #64)
  • reduced to bare-bone hashcodes for models (constant 0 for non-Keyed, hash of the key for keyed)
  • lots of JavaDoc

0.97

  • methods derived from a deprecated field are now themselves deprecated. Note that this has only an impact when using the compiled classes, the gdsl does currently not support creating deprecated methods (see #54)
  • Allow more collection types instead of only List (i.e. Set, SortedSet, Stack, etc.). Custom collections are allowed, provided they have a constructor taking an Iterable, a custom coercion method or initial values.
  • Allow SortedMap in place of Maps. Note that other Map implementations are currently NOT supported

0.96.1

  • createFromScript was deprecated, without creating a matching createFrom method, corrected

0.96

No code changes, renamed project coordinates and URLs to new name

0.95

  • withTemplates now supports Lists as argument
  • withTemplates supports anonymous templates (actually, it always did, now there is a testcase and documentation for that)
  • new makeTemplate method, which only creates template, without assigning it
  • Lifecycle methods can be created using the @PostCreate and @PostApply annotations (see #38)
  • DSL classes are now Serializable (see #35)
  • @Default now also supports delegate members (see #46)

0.20

0.19

  • Implemented Default values (see #29)

  • Implemented better Convenience Factories, (see #33)

  • Deprecation:

    • createFromSnippet has been renamed to simply createFrom, createFromSnippet will eventually be dropped.

0.18.1

  • Named parameters should be available for inner objects as well

0.18.0

  • Breaking changes:
    • removed the creation of _create and _apply if the original methods are already present. This will be replaced with a lifecycle mechanism (see #38)
  • new Features:
    • create and apply now support named parameters (MyObject.Create.With(value: 'x') {...)
  • Closures for create method are now optional (This is especially useful in combination with named parameters) (#20)
  • Resolved a potential Stackoverflow in GDSL (which happened in a two-step recursion, i.e. A contains B and B contains A)

0.17.0

  • Breaking changes:
    • alternatives syntax has been dropped
    • named map elements have been dropped
    • the outer closure for collections is now optional
    • field member names (either implicit or explicit) must now be unique across the whole hierarchy
  • transient fields are not enriched

0.16.1

  • Convenience factory for URLs

0.16.0

0.15.2

  • Fixed: validation of nested elements does not work (#25)

0.15.1

  • Fixed: Validation changes broke template behaviour. Previously, each call of createTemplate created a new instance as the template. Now the new template was accidentally created based on the previous template.

0.15.0

0.14.13

  • Fixed Compilation fails on final fields (#21)
  • Fixed Helper Methods for $TEMPLATE fields are created (#22)

0.14.12

  • allow fields to be marked as ignored using an annotation (#18)

0.14.11

  • apply did override values with template values. Fixed

0.14.10

  • Shortcut syntax for boolean setters. Now the boolean setter can be called without argument, defaulting to true. (e.g. you could write "skipSonar()" instead of "skipSonar(true)")

0.14.9

  • GDSL improvements
  • Changed Retention of DSL annotations to class to allow extending DSLs from a jar (i.e. have a dependency on a jar containing parent DSL classes).

0.14.8

  • created methods should not be synthetic to allow proper code completion when using precompiled DSLs.

0.14.7

  • Bugfix: equals/hashcode did not take parent classes into account

0.14.6

  • gdsl improvements

0.14.4

  • no functional changes
  • Fixed nested gdsl cases
  • Reduced groovy dependency to 2.3

0.14.3

Changed Source/Target compatibility to 1.6

0.14.2

  • Fixed a ClassCast Exception when reusing an Object in a different structure
  • Owner fields are now set before applying the closure itself, allow to access the owner inside the closure
  • Simple list field elements can now also be added using a list instead of varargs.

0.14.1

Fixed small typing bug with synthetic template class

0.14.0

  • Allow templates for abstract classes

0.13.0

Minor breaking change

  • Completely dropped _use() and _reuse() (they never looked nice anyway).
  • Both are now replaced with an element adder method taking a single existing object.
  • Owner is only overridden if not yet set (previously, use() did set the owner, while _reuse()` did not, attempting to override existing owner threw exception.

0.12.4

Fixed a StackOverflowError with which occurred when using Owner fields with inheritance

0.12.3

NPE Guard in GDSL

0.12.2

No functional changes, only gdsl improvements

  • alternatives
  • typed closures

0.12.1

  • Fixed a corner case of template inheritance
  • Now, if Child extends Parent and a template is created for Parent only, this template will also be applied to all created instances of Child

0.12.0

  • Breaking change
  • Major renaming of annotations:
    • DSLConfig -> DSL
  • Owner and Keys are now decorated by own annotations
  • Removed Ability to rename fields using the field annotation
  • The ability to rename the inner values is retained.

0.11.0

  • Introduced template objects to configure default values.

0.10.0

  • reuse changes/improvements #6
    • reuse() renamed to _reuse(), does NOT set owner field
    • new _use() method which does set the owner field
    • overwriting the owner field content leads to IllegalStateException
    • inner collection closures (bars -> bar) now return the created object to allow easier reuse

0.9.5

  • Fixed a StackOverflowError in toString() methods with owner fields

0.9.4

  • gdsl improvements
    • NPE Guards
    • Documentation for generated methods
    • Fixed most cases for single object closures

0.9.3

  • Code refactorings (extracted method creating code to separate class MethodBuilder)
  • Introduced owner fields
  • Allow inheritance in DSLObjects

KlumAST - turn your models into supermodels

Clone this wiki locally