[RELEASE] Major Spoon Release 6.0.0: done.

[surli]

Hi all,

we plan to do a release of Spoon 6.0.0 next week probably the 15th or the 16th.
This will be a major release potentially breaking API for some clients.

I will post later a changelog with specification of what exactly could be break with the new API.

[surli]

So, here comes the changelog. It contains a lot of bug fixes, but also some new features. I prefixed in the changelog the different changes that may break compatibility with previous Spoon release. Please note that a break in compatibility is not necessarily a breaking compatibility between binaries, but it can also be a change in the behaviour.

For example, I say here that the change

[BREAKING] GetBoundingType returns Object by default. (PR: #1672)

is breaking: previous behaviour was to return null by default.
Please also note that even we report here the exhaustive list of changes, I may have forget to tag some of them as breaking, as I did it manually.
We will work on the future to be able to tag the breaking behaviour automatically.

Spoon continues to grow thanks to all our contributor who did again an amazing job for this release, so thanks to them!

New features

• Roles
  • Add method CtElement#getRoleInParent(). (PR: review: feature: CtElement#getRoleInParent() #1669)
  • CtScanner supports scanning based on roles. (PR: review: refactor: CtScanner to report CtRole of scanned element #1632)
  • Add CtRole to CtReference. (PR: feat(role): add CtRole to CtReference #1586)
  • One can get and set children of elements based on roles. (PR: review: feat: Spoon CtRole based attributes access #1582)
  • Spoon GUI shows roles of nodes. (PR: feature: Spoon GUI - SpoonModelTree - shows roles of nodes #1715)
• Introduction of TokenWriter to support custom formatting of pretty-printed code. (PR: review: feat: TokenWriter - support for custom pretty printed formatting #1494)
• Spoon runs on Java9 JVM with JDK9. (PR: review feat: Support (partially) JDK9 in Spoon #1585)
• Add TypeFactory LIST, SET, MAP, ... constant type references. (PR: feature: TypeFactory LIST, SET, MAP, ... constant type references #1660)
• Add new create method in Factory. (PR: review: feat: add missing create method in Factory #1659)
• Add CtPackage#getQualifiedName. (PR: review: feat: add CtPackage#getQualifiedName  #1652)
• The cloning behavior can be subclassed. (PR: review: feat: CloneMaker can be used to listen on cloning process #1580)
• Add a static method to getting started with one single line of code. (PR: feat: add a static method to getting started with one single line of code #1559)
• Add support for analyzing whether a type reference is generic or not (method isGeneric). (PR: feat: add support for analyzing whether a type reference is generic or not (method isGeneric) #1562)
• Add support for implicit / explicit modifiers (CtExtendedModifier). (PR: review: feature: add support for implicit / explicit modifiers (CtExtendedModifier) #1649)
• Add simple support for enter/exit in DJPP as in CtScanner. (PR: add simple support for enter/exit in DJPP as in CtScanner #1538)
• Create a launcher to analyze maven projects. (PR: feat(maven): create a launcher from a maven pom #1533)
• Add utility methods in CtModifiable. (PR: review feat: Add helpers methods in CtModifiable #1726)

Bug Fixes

• ⚠️ [BREAKING] Fix ClassTypingContext#isSameSignature for generic methods. (PR: fix: ClassTypingContext#isSameSignature for generic methods #1639)
• ⚠️ [BREAKING] SetVisibility should only be used with private, public or protected. (PR: review: fix: setVisibility should only be used with private, public or protected #1705)
• ⚠️ [MAYBE BREAKING] Less hashcode collisions for CtReference. (PR: review fix: CtExecutableReference have all the same hashcode #1717)
• ⚠️ [BREAKING] Move deprecated classes to spoon.legacy. (PR: review: Remove deprecated from Spoon 5.9.0 #1518)
• ⚠️ [BREAKING] Template: Replacing of field access by refining behaviour of String parameter. (PR: review: fix replacing of field access by relaxed Parameter value contract #1476)
• ⚠️ [BREAKING] Remove the useless factory in Environment. (PR: fix(env): remove the useless factory in the env #1673)
• ⚠️ Fix bug with repeatable annotations. (PR: review fix: fix bug with repeatable annotations #1724)
• Typo in RoleHandlersGenerator. (PR: URGENT review: Fix typo in RoleHandlersGenerator #1709)
• Method with varargs should never be transient. (PR: review fix: method should never be transient  #1701)
• JDTImportBuilder should not import all public methods from interfaces. (PR: review: fix: JDTImportBuilder should not import all public method from Interfaces #1620)
• Explicit "final" modifier are possible in catch variables and should be kept when pretty-printing. (PR: review: Fix: explicit final modifier should be kept in CtCatchVariable #1690)
• CtVariableAccess#getVariable() sets the type of "super". (PR: review: fix: CtVariableAccess#getVariable() #1684)
• MavenLauncher warns when a provided dependency is not loaded. (PR: feat: MavenLauncher Warning when a provided dependency is not loaded  #1681)
• Add position for implicit blocks. (PR: feat: add position to implicit block in CtIf #1678)
• Bug related with cloning newClass invocation with anonymous class. (PR: review: alternative to #1589 #1667)
• Improve contract+test of CtScanner and it relation to roles. (PR: review: fix: better tests for CtScanner #1642)
• In CtCatchVariable set/getType is derived from multiType. (PR: review1: fix: CtCatchVariable merge type and multiType #1668)
• AbstractTypingContext should set consistent parents. (PR: review: fix: AbstractTypingContext inconsitent parents #1664)
• [BREAKING] CtTypeParameterReference#getBoundingType() consistently returns null when Object is the bound. (PR: review1: fix: CtTypeParameterReference#getBoundingType() Object -> null #1661)
• Remove useless code on CtElement#setParent. (PR: fix: Remove useless code on CtElement#setParent #1662)
• Change default log level. (PR: chore: Change default log level to error #1646)
• Fix StackOverflow in MethodTypingContext on <T, U extends T>. (PR: review1: fix: StackOverflowError in MethodTypingContext on <T, U extends T> #1640)
• Fix NPE in MavenLauncher when there is no build section. (PR: review: fix NPE in MavenLauncher when there is no build section #1720)
• CtTypeInformationTest now use patch JDK version for the expected test number. (PR: review fix: CtTypeInformationTest now use patch JDK version for the expected test number #1721)
• Optional maven dependencies should not be passed to SpoonMavenLauncher. (PR: fix: Optional maven dependencies should not be pass in SpoonMavenLauncher #1619)
• Fix bug related to generics in CtTypeReference in noclasspath. (PR: review: Fix: bug related with TypeReference generics in noclasspath #1609)
• Auto-imports works for package-info. (PR: review: fix: imports in package-info #1611)
• CtNewClassImpl#setAnonymousClass has CtRole.NESTED_TYPE not CtRole.EXECUTABLE. (PR: fix: wrong CtRole.EXECUTABLE in CtNewClassImpl#setAnonymousClass #1605)
• Pretty printer adds no space before comma in new array expression. (PR: fix: pretty printer adds no space before comma in new array expression #1602)
• Spoon model is a tree not a lattice. (PR: fix: Spoon model is a tree not a latice #1592)
• ImportBuilder checks visibility when importing starred imports. (PR: review: fix: ImportBuilder to check visibility when importing starred imports #1588)
• The query engine also works on JVMs where lambdas are not in stack trace elements. (PR: alternative fix: the query engine is broken on some JVM because it relies on stack trace elements #1579)
• Cleaning of method signature computation. (PR: fix: cleaning of method signature computation #1561)
• DJPP sends "class" as keyword and wildcard "?" as separator token. (PR: fix: DJPP sends "class" as keyword and wildcard "?" as separator token #1568)
• PotentialVariableDeclarationFunction should consider static scopes. (PR: review: fix PotentialVariableDeclarationFunction ignoring the static scope #1536)
• Fix issue with recursively defined annotation in shadow class. (PR: review fix: issue when using recursively defined annotation in shadow class #1711)
• Remove an hardcoded encoding value in CompilationUnitWrapper. (PR: review: fix: Remove an hardcoded encoding value #1544)
• SetSimpleName of CtRootPackage if now fail-silent to simplify client code. (PR: review: fix: prevent renaming CtRootPackage #1523)
• File resource leak in pretty printing. (PR: Fixes file resource leak #1521)
• Bump commons-io version. (PR: Fix potential issue regarding commonsio version #1530)
• prettyprinter
  • Invalid use of type access generics. (PR: review fix: Invalid use of type access generics #1454)
  • Bug related with "--lines" argument. (PR: review: Fix new bug related with "--lines" argument #1558)
• role
  • CtPackage.types is CtRole.CONTAINED_TYPE. (PR: fix(role): CtPackage.types is CtRole.CONTAINED_TYPE #1600)
  • CtTypeAccess getTypeAccess uses CtRole.ACCESSED_TYPE. (PR: review1: fix(role): CtTypeAccess getTypeAccess uses CtRole.TYPE_ACCESS #1637)
  • CtTypeAccess.getAccessedType has CtRole.TYPE. (PR: review1: fix(role): CtTypeAccess.getAccessedType has CtRole.TYPE #1630)
• template
  • Relax template parameter constraint. (PR: review: Fix template parameter constraint #1535)

Refactoring

• ⚠️ [BREAKING] Get rid of snapshotLength and hasNewContent. (PR: get rid of snapshotLength and hasNewContent #1576)
• ⚠️ [BREAKING] CompilationUnit#create renamed to getOrCreate. (PR: refactor: CompilationUnit create renamed to getOrCreate #1645)
• ⚠️ [BREAKING] CtModifiable add/removeModifier stick to convention on returned object. (PR: review refactor: CtModifiable add/removeModifier #1706)
• ⚠️ [BREAKING] Remove ant related code and dependency. (PR: remove ant related code and dependency #1540)
• ⚠️ [BREAKING] Move ElementPrinterHelper to the appropriate package. (PR: refactor: Move ElementPrinterHelper #1551)
• ⚠️ [BREAKING] GetBoundingType returns Object by default. (PR: review refactor: getBoundingType now returns Object by default #1672)
• All non-leaf interfaces of the metamodel should be visited by CtInheritanceScanner. (PR: review refactor: all non-leaf interfaces of the metamodel should be visited by CtInheritanceScanner #1703)
• Remove replace methods which pollute code completion and do not provide additional behavior. (PR: review refactor: Remove replace methods which were using CtElement#replace #1704)
• Move package spoon.generating.* from src/main to src/test. (PR: review: refactor: move package spoon.generating.* from src/main to src/test #1647)
• Introduce CommentHelper, LiteralHelper and OperatorHelper. (PR: review: refactor: PrinterHelper to CommentHelper, LiteralHelper and OperatorHelper #1525)
• Compute CtRole#forName automatically based on enum value names. (PR: review refactor: compute CtRole#forName without synonym #1702)
• PrinterHelper prints tabs automatically. (PR: review: refactor: PrinterHelper prints tabs automatically #1566)
• DefaultJavaPrettyPrinter better uses OperatorHelper. (PR: refactor: DefaultJavaPrettyPrinter better uses OperatorHelper #1553)
• Delete old/useless config files. (PR: review: refactor: Delete old/useless config files #1548)
• Launcher#buildModel returns a CtModel. (PR: review: refactor: Launcher#buildModel return a CtModel #1549)
• Add constant for code compliance level. (PR: review: feat: Create launcher constant for code compliance level #1543)
• Test code assumes java 8 compliance so as to allow lambdas in spoon code. (PR: fix: java compliance to 8 - allow lambdas in spoon code #1539)
• Use LiteralHelper in DefaultJavaPrettyPrinter. (PR: review: refactor: use LiteralHelper in DefaultJavaPrettyPrinter #1529)
• modifier: CreateCtModifierHandler that handles the modifiers. (PR: refactor(modifier): createCtModifierHandler that handles the modifiers #1677)
• role
  • New CtRoles ARGUMENT_TYPE and TYPE_ARGUMENT. (PR: refactor(role): add CtRole ARGUMENT_TYPE and TYPE_ARGUMENT #1622)
  • Add CtRole.TYPE_MEMBER. (PR: review1: refactor(role): add CtRole.TYPE_MEMBER #1625)
  • CtThrows uses EXPRESSION now. Rolls back usage of THROWN. (PR: refactor(role): CtThrows uses EXPRESSION now. Rolls back usage of THROWN #1624)
  • CtCodeSnippet has CtRole.SNIPPET. (PR: refactor(role): CtCodeSnippet has CtRole.SOURCE_CODE #1623)
  • Add and refactor CtRole annotations of model. (PR: refactor(role): add and refactor CtRole annotations of model #1606)

Performance

• MainTest#checkModelIsTree needs less memory. (PR: fix: MainTest#checkModelIsTree needs less memory #1596)
• Avoid slow CCE. Check acceptable type when possible. (PR: review: perf: Avoid slow CCE. Check acceptable type when possible #1541)

Tests

• Add a test about the behavior of PropertySetter. (PR: test: add a test about the behavior of PropertySetter #1612)
• SpoonMetaModel checks whether provided model is complete. (PR: feature: SpoonMetaModel checks whether provided model is complete #1714)
• Add an architectural test to catch package creation during code review. (PR: test: add an architectural test to catch package creation during code review #1696)
• Fix typo in MMType. (PR: review: refactor: typo in MMType #1708)
• Check that CtComment works with \r separator. (PR: test: CtComment with \r separator #1679)
• Add explicit Spoon metamodel to facilitate consistency checks and code generation. (PR: review: feature: Spoon meta-model #1627)
• Declares missing packages for new architecture enforcing test. (PR: URGENT review: test: Add missing packages in enforcer test #1710)
• Adds a test on roles for CtReference fields. (PR: test: adds a test on roles for CtReference fields #1601)
• Don't use Junit3 classes in test suite, only use Junit4 org.junit.*. (PR: review: test: don't use Junit3 classes in test suite, only use Junit4 org.junit.* #1577)
• Add a test to verify an important contract of setParent. (PR: test: add a test to verify an important contract of setParent #1591)
• Add a new test to check if static imports are placed after type imports. (PR: review: test: check if static imports are placed after type imports #1572)
• Enforce test naming discipline. (PR: test: enforce test naming discipline  #1554)
• The ant dependency was removed so the test should be changed. (PR: fix(test): wrong number of dependency MavenLauncherTest #1547)
• Fix test assertion with JDK8 1.8.0_15 on Travis. (PR: review: Fix test assertion with JDK8 on Travis #1718)
• Refactor: Faster test execution. (PR: test: faster test execution  #1552)

Documentation

• Improve getting started. (PR: doc: improve getting started #1676)
• Clarify CtType#getAllMethods documentation. (PR: doc: Clarify CtType#getAllMethods documentation #1644)
• End-of-life for mailing list spoon-discuss. (PR: doc: end-of-life for mailing list spoon-discuss #1643)
• Clarifies contracts of @DerivedProperty. (PR: doc: clarifies contracts of @DerivedProperty #1613)
• Move around some documentation items for easier finding. (PR: doc: move around some documentation items for easier finding #1564)
• Add recent papers that use Spoon. (PR: doc: add recent papers that use Spoon #1556)
• Update version number after the new release 5.9.0. (PR: doc: Update version number for the new release #1517)

Other

• Change Revapi template to have class name shortening by a bunch of Freemarker macros. (PR: chore: Implement class name shortening by a bunch of Freemarker macros. #1697)
• Revapi reports are smaller on screen to save space on the corresponding Github page. (PR: chore: revapi reports are smaller on screen to save space on the corresponding Github page #1692)
• Revapi now deletes its own comments before commenting. (PR: chore: Revapi now deletes its own comments before commenting #1683)
• Improve Travis configuration for parallel jobs. (PR: review chore: improve Travis configuration and speed-up builds #1655)
• Bump revapi version. (PR: chore: bump revapi version #1665)
• Upgrade to org.eclipse.tycho:org.eclipse.jdt.core:3.13.0. (PR: chore: Upgrade to org.eclipse.jdt:org.eclipse.jdt.core:3.12.3 #1492)
• Now depends on Java8/JDK8. (PR: Change to use JDK8 for compilation #1528)
• maven: Remove maven reporting plugins that we never use. (PR: chore: remove maven reporting plugins that we never use #1560)
• Prepare for next development iteration.

Authors

Name	Nb Commit
Simon Urli	49
Pavel Vojtechovsky	44
Martin Monperrus	22
Thomas Durieux	4
tiagodrcarvalho	1
Lukas Krejci	1

[monperrus]

impressive changelog! made some minor changes.

[surli]

FYI we postpone this release for next week: this will give us some time to merge #1707 and ensure it does not bring regression.

[surli]

@pvojtechovsky @monperrus Finally I propose to do the release of Spoon now - without CtImport - and we'll put ctimport and ctmodule in next release which will also be a major release then. WDYT?

[msteinbeck]

I don't mind waiting one more week for Spoon 6.

[surli]

I don't mind waiting one more week for Spoon 6.

If we also wait for CtModule it might be a lot more than one week :)
And I'd prefer to wait a while after merging the PR with CtImport, to be sure it does not bring new bugs.

[msteinbeck]

When adding CtModule, is Spoon fully Java 9 compatible?

[surli]

When adding CtModule, is Spoon fully Java 9 compatible?

It's the idea. On current snapshot Spoon already compiles with JDK9 but it does not process module-info.java information.

[pvojtechovsky]

Finally I propose to do the release of Spoon now - without CtImport

Do it as you prefer. I agree, that 6.0 will be more stable if CtImport will be not in it. It is quite new ...

[monperrus]

Thank you very much @surli and @pvojtechovsky for all the effort put in this impressive release.