Add a velocity template based generator #269

gnodet · 2022-10-23T20:01:38Z

extracted from Maven 4.0.0-alpha-2 https://github.com/apache/maven/tree/c07700ffc97d3967a8de77d5a1065f5e6115c00e/api/modello-plugin-velocity

https://maven.apache.org/ref/4.0.0-alpha-2/maven-api/modello-plugin-velocity/index.html

templates: https://github.com/apache/maven/tree/c07700ffc97d3967a8de77d5a1065f5e6115c00e/maven-model/src/main/mdo
plugin configuration: https://github.com/apache/maven/blob/c07700ffc97d3967a8de77d5a1065f5e6115c00e/maven-model/pom.xml#L77

sonatype-lift · 2022-10-23T20:06:11Z

⚠️ 14 God Classes were detected by Lift in this project. Visit the Lift web console for more details.

...lo-plugin-velocity/src/main/java/org/codehaus/modello/plugin/velocity/VelocityGenerator.java

modello-maven-plugin/src/main/java/org/codehaus/modello/maven/ModelloVelocityMojo.java

...lo-plugin-velocity/src/main/java/org/codehaus/modello/plugin/velocity/VelocityGenerator.java

modello-plugins/modello-plugin-velocity/src/main/resources/META-INF/plexus/components.xml

hboutemy · 2022-10-26T10:45:39Z

I'm trying to guess what this does Modello generator does, to be able to at least describe it before going more in depth into documenting it

it was created in Maven, used for Maven model:

https://github.com/apache/maven/blame/master/maven-model/pom.xml#L78
uses .vm templates https://github.com/apache/maven/tree/master/maven-model/src/main/mdo
to replace previous fully generated content https://github.com/apache/maven/blame/1ca65c79fa4e25c4b7da027c8f8eef1b95ceced4/maven-model/pom.xml

hboutemy · 2022-10-26T10:51:30Z

it's not clear to me why this is a new Maven plugin instead of a Modello plugin that can be used by Modello Maven plugin https://codehaus-plexus.github.io/modello/

gnodet · 2022-10-26T11:00:59Z

it's not clear to me why this is a new Maven plugin instead of a Modello plugin that can be used by Modello Maven plugin https://codehaus-plexus.github.io/modello/

It's not a new maven plugin, but s a new modello plugin. It is used with the modello maven plugin. See https://github.com/apache/maven/pull/848/files to see how it will be used.
In maven 4.x, it is currently a standalone plugin, but if we want to integrate it into the modello, a modello plugin makes more sense, and that's what this PR is about.

modello-maven-plugin/src/main/java/org/codehaus/modello/maven/ModelloVelocityMojo.java

gnodet · 2022-10-26T11:39:55Z

I've added some javadocs.
Note that using the velocity generator is more like writing a generator. And modello has not much documentation about how to use its model. The Helper helps a bit for accessing a few common things.

modello-maven-plugin/src/main/java/org/codehaus/modello/maven/ModelloVelocityMojo.java

…ModelloVelocityMojo.java Co-authored-by: Konrad Windszus <konrad_w@gmx.de>

… them relative to the basedir so that Velocity can find them

# Conflicts: # pom.xml

modello-maven-plugin/src/main/java/org/codehaus/modello/maven/ModelloVelocityMojo.java

kwin

Thanks for all the updates. LGTM now.

gnodet · 2022-10-27T20:06:11Z

@hboutemy are you ok ?

hboutemy · 2022-10-31T07:14:49Z

modello-maven-plugin/src/main/java/org/codehaus/modello/maven/ModelloVelocityMojo.java

+ * {@code org.apache.maven.api.model} and the variable {@code className} is set to {@code Plugin}.
+ * <p>
+ *     {@code #MODELLO-VELOCITY#REDIRECT ${package.replace('.','/')}/${className}.java}
+ */


@gnodet nice documentation, I'm starting to understand
adding an integration test in https://github.com/codehaus-plexus/modello/tree/master/modello-maven-plugin/src/it will help showing classical use cases

@gnodet looking at the only use case I know of https://github.com/apache/maven/tree/master/maven-model/src/main/mdo
I'm worried on the use case: do you really want to copy paste all the generation code from Modello and tweak it by hand?
I understand that it's easy to prototype some updates to the generated java classes, but I fear it will be unmaintainable

Those are mostly new generators not supported by modello. The v4 model is immutable which is not supported, the v3 wraps the immutable v4 model, which is not supported, the reader returns the v4 immutable model , which is not supported, the transformer did not exist in maven 3.x, and the merger was hand written... So that's not tweaking the modello code, those are really new generators.
So given those are new generators, we'd have to reimplement them all in modello.

However, there's still a problem with the current state in that the templates are duplicated instead of being reused. This need to be fixed.

I had started working on an IT a few weeks ago, but my laptop died with the unfinished work on it (and I can't even turn that laptop on anymore....). I'll see if I can give in another try in the coming weeks.

hboutemy · 2022-10-31T07:44:25Z

modello-maven-plugin/src/main/java/org/codehaus/modello/maven/ModelloVelocityMojo.java

+ *    <li>{@code Helper}: a {@link org.codehaus.modello.plugin.velocity.Helper} object instance</li>
+ *    <li>any additional parameters specified using the {@link #params} property</li>
+ * </ul>
+ * The output file is controlled from within the template using the {@code #MODELLO-VELOCITY#REDIRECT}


I find the term "redirect" confusing: makes me think HTTP redirect.
Can we rename to something like "OUTPUT"?

hboutemy · 2022-12-23T07:58:57Z

I added documentation: it helps me understand the feature sufficiently to do the release (let's consider Maven core usage is an IT for now, I'll see later about making an internal IT)

the only little thing that I would love to change is #MODELLO-VELOCITY#REDIRECT: #MODELLO-VELOCITY#SAVE-OUTPUT-TO?

michael-o · 2022-12-27T17:42:08Z

What is the benefit of this over the other components?

gnodet · 2022-12-27T18:20:31Z

What is the benefit of this over the other components?

Ease of maintenance. Each generator can be easily replaced by a simple template that is easy to understand and modify. Also, the user can easy author or modify templates, while existing generators can not.

michael-o · 2022-12-27T18:25:20Z

What is the benefit of this over the other components?

Ease of maintenance. Each generator can be easily replaced by a simple template that is easy to understand and modify. Also, the user can easy author or modify templates, while existing generators can not.

So this is a replacement for the Java code?

gnodet · 2022-12-27T18:35:07Z

What is the benefit of this over the other components?

Ease of maintenance. Each generator can be easily replaced by a simple template that is easy to understand and modify. Also, the user can easy author or modify templates, while existing generators can not.

So this is a replacement for the Java code?

Not really, unless we ship the VTL templates and lock them. The current code is in maven master and was needed in order to be able to generate the v4 model, the v4 readers, the v3 models wrapping the v4 models, the mergers, etc... I originally started by hacking the current generators, but it was too complicated and time consuming, so I ended up writing this template generator. So all the generators could be rewritten based on a template I suppose, but this PR is here due to @hboutemy request to move it from the maven master branch to the modello project where it actually belongs.

hboutemy · 2022-12-27T23:10:50Z

So this is a replacement for the Java code?

yes and no

yes, it is an ultra flexible replacement for the classical generated code by existing Velocity plugins, because the new immutable Maven API creates new constraints with its non-immutable part: I'm also describing the way this new Maven API is built apache/maven#830

but in fact, this Velocity plugin ships no real code generator, the code is in the Velocity templates: each user can choose to use the classical Velocity plugins to get classical fully-Modello generated Java code (we don't remove the classical code generators), or they can choose to create their own Velocity templates to generate the code they want

In Maven core, the new Maven API forced Guillaume to create new code generators with custom Velocity templates https://github.com/apache/maven/tree/c07700ffc97d3967a8de77d5a1065f5e6115c00e/maven-model/src/main/mdo , but classical Modello plugins are used to generate xdoc and xsd

To me, this Velocity plugin is ready to merge, we just need to rename #MODELLO-VELOCITY#REDIRECT to something like #MODELLO-VELOCITY#SAVE-OUTPUT-TO or any better idea welcome

gnodet · 2022-12-29T08:45:26Z

To me, this Velocity plugin is ready to merge, we just need to rename #MODELLO-VELOCITY#REDIRECT to something like #MODELLO-VELOCITY#SAVE-OUTPUT-TO or any better idea welcome

I don't have commit rights in this repo, so I'm not able to merge it.

kwin · 2022-12-29T10:05:47Z

I don't have commit rights in this repo, so I'm not able to merge it.

Just squashed and merged it.

Add a velocity template based plugin

04f7ef2

gnodet force-pushed the velocity branch from 6d73ee5 to 04f7ef2 Compare October 23, 2022 20:06

sonatype-lift bot reviewed Oct 23, 2022

View reviewed changes

...lo-plugin-velocity/src/main/java/org/codehaus/modello/plugin/velocity/VelocityGenerator.java Show resolved Hide resolved

gnodet mentioned this pull request Oct 23, 2022

Move the modello velocity plugin out of the API apache/maven#844

Closed

gnodet marked this pull request as draft October 24, 2022 06:40

gnodet mentioned this pull request Oct 24, 2022

Use the new velocity goal from the modello-maven-plugin apache/maven#848

Closed

gnodet marked this pull request as ready for review October 24, 2022 06:50

olamy added the enhancement label Oct 24, 2022

olamy approved these changes Oct 24, 2022

View reviewed changes

kwin reviewed Oct 24, 2022

View reviewed changes

modello-maven-plugin/src/main/java/org/codehaus/modello/maven/ModelloVelocityMojo.java Outdated Show resolved Hide resolved

modello-maven-plugin/src/main/java/org/codehaus/modello/maven/ModelloVelocityMojo.java Show resolved Hide resolved

kwin reviewed Oct 24, 2022

View reviewed changes

modello-maven-plugin/src/main/java/org/codehaus/modello/maven/ModelloVelocityMojo.java Outdated Show resolved Hide resolved

kwin reviewed Oct 24, 2022

View reviewed changes

...lo-plugin-velocity/src/main/java/org/codehaus/modello/plugin/velocity/VelocityGenerator.java Show resolved Hide resolved

hboutemy reviewed Oct 26, 2022

View reviewed changes

modello-plugins/modello-plugin-velocity/src/main/resources/META-INF/plexus/components.xml Show resolved Hide resolved

hboutemy reviewed Oct 26, 2022

View reviewed changes

modello-maven-plugin/src/main/java/org/codehaus/modello/maven/ModelloVelocityMojo.java Show resolved Hide resolved

Add some doc

40e30c8

kwin reviewed Oct 26, 2022

View reviewed changes

modello-maven-plugin/src/main/java/org/codehaus/modello/maven/ModelloVelocityMojo.java Outdated Show resolved Hide resolved

modello-maven-plugin/src/main/java/org/codehaus/modello/maven/ModelloVelocityMojo.java Outdated Show resolved Hide resolved

gnodet and others added 4 commits October 26, 2022 16:41

Update modello-maven-plugin/src/main/java/org/codehaus/modello/maven/…

f966521

…ModelloVelocityMojo.java Co-authored-by: Konrad Windszus <konrad_w@gmx.de>

Use File objets so that the templates are resolved by maven, and make…

5ba45a2

… them relative to the basedir so that Velocity can find them

Merge remote-tracking branch 'origin/master' into velocity

9210d10

# Conflicts: # pom.xml

We don't use plexus-velocity

f055226

sonatype-lift bot reviewed Oct 26, 2022

View reviewed changes

modello-maven-plugin/src/main/java/org/codehaus/modello/maven/ModelloVelocityMojo.java Show resolved Hide resolved

gnodet added 2 commits October 26, 2022 18:17

Fix javadoc

2a8ee3a

Another fix

02af0a9

gnodet changed the title ~~Add a velocity template based plugin~~ Add a velocity template based generator plugin Oct 26, 2022

gnodet changed the title ~~Add a velocity template based generator plugin~~ Add a velocity template based generator Oct 26, 2022

kwin approved these changes Oct 27, 2022

View reviewed changes

hboutemy reviewed Oct 31, 2022

View reviewed changes

improve documenattion

92c6a1d

hboutemy reviewed Oct 31, 2022

View reviewed changes

add documentation

f9ce870

add generatedBy context variable

8072734

hboutemy force-pushed the velocity branch from ac70946 to 8072734 Compare December 27, 2022 10:13

Rename #REDIRECT to #SAVE-OUTPUT-TO

ea0cf4b

hboutemy approved these changes Dec 28, 2022

View reviewed changes

kwin merged commit 394178a into codehaus-plexus:master Dec 29, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a velocity template based generator #269

Add a velocity template based generator #269

gnodet commented Oct 23, 2022 •

edited by hboutemy

sonatype-lift bot commented Oct 23, 2022

hboutemy commented Oct 26, 2022 •

edited

hboutemy commented Oct 26, 2022 •

edited

gnodet commented Oct 26, 2022

gnodet commented Oct 26, 2022

kwin left a comment

gnodet commented Oct 27, 2022

hboutemy Oct 31, 2022

hboutemy Dec 11, 2022

gnodet Dec 11, 2022

gnodet Dec 11, 2022

gnodet Dec 11, 2022

hboutemy Oct 31, 2022

hboutemy commented Dec 23, 2022

michael-o commented Dec 27, 2022

gnodet commented Dec 27, 2022 •

edited

michael-o commented Dec 27, 2022

gnodet commented Dec 27, 2022

hboutemy commented Dec 27, 2022 •

edited

gnodet commented Dec 29, 2022

kwin commented Dec 29, 2022

Add a velocity template based generator #269

Add a velocity template based generator #269

Conversation

gnodet commented Oct 23, 2022 • edited by hboutemy

sonatype-lift bot commented Oct 23, 2022

hboutemy commented Oct 26, 2022 • edited

hboutemy commented Oct 26, 2022 • edited

gnodet commented Oct 26, 2022

gnodet commented Oct 26, 2022

kwin left a comment

Choose a reason for hiding this comment

gnodet commented Oct 27, 2022

hboutemy Oct 31, 2022

Choose a reason for hiding this comment

hboutemy Dec 11, 2022

Choose a reason for hiding this comment

gnodet Dec 11, 2022

Choose a reason for hiding this comment

gnodet Dec 11, 2022

Choose a reason for hiding this comment

gnodet Dec 11, 2022

Choose a reason for hiding this comment

hboutemy Oct 31, 2022

Choose a reason for hiding this comment

hboutemy commented Dec 23, 2022

michael-o commented Dec 27, 2022

gnodet commented Dec 27, 2022 • edited

michael-o commented Dec 27, 2022

gnodet commented Dec 27, 2022

hboutemy commented Dec 27, 2022 • edited

gnodet commented Dec 29, 2022

kwin commented Dec 29, 2022

gnodet commented Oct 23, 2022 •

edited by hboutemy

hboutemy commented Oct 26, 2022 •

edited

hboutemy commented Oct 26, 2022 •

edited

gnodet commented Dec 27, 2022 •

edited

hboutemy commented Dec 27, 2022 •

edited