
org.apache.camel.maven.packaging.PrepareReadmeMojo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-package-maven-plugin Show documentation
Show all versions of camel-package-maven-plugin Show documentation
Maven plugin to help package Camel components and plugins
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.maven.packaging;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import static java.util.stream.Collectors.toSet;
import edu.emory.mathcs.backport.java.util.Collections;
import org.apache.camel.maven.packaging.model.ComponentModel;
import org.apache.camel.maven.packaging.model.DataFormatModel;
import org.apache.camel.maven.packaging.model.EipModel;
import org.apache.camel.maven.packaging.model.LanguageModel;
import org.apache.camel.maven.packaging.model.OtherModel;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.MavenProjectHelper;
import org.mvel2.templates.TemplateRuntime;
import static org.apache.camel.maven.packaging.PackageHelper.loadText;
import static org.apache.camel.maven.packaging.PackageHelper.writeText;
/**
* Prepares the readme.md files content up to date with all the artifacts that Apache Camel ships.
*
* @goal prepare-readme
*/
public class PrepareReadmeMojo extends AbstractMojo {
/**
* The maven project.
*
* @parameter property="project"
* @required
* @readonly
*/
protected MavenProject project;
/**
* The directory for EIPs (model) catalog
*
* @parameter default-value="${project.build.directory}/classes/org/apache/camel/catalog/models"
*/
protected File eipsDir;
/**
* The directory for components catalog
*
* @parameter default-value="${project.build.directory}/classes/org/apache/camel/catalog/components"
*/
protected File componentsDir;
/**
* The directory for data formats catalog
*
* @parameter default-value="${project.build.directory}/classes/org/apache/camel/catalog/dataformats"
*/
protected File dataFormatsDir;
/**
* The directory for languages catalog
*
* @parameter default-value="${project.build.directory}/classes/org/apache/camel/catalog/languages"
*/
protected File languagesDir;
/**
* The directory for others catalog
*
* @parameter default-value="${project.build.directory}/classes/org/apache/camel/catalog/others"
*/
protected File othersDir;
/**
* The directory for camel-core
*
* @parameter default-value="${project.directory}/../../../camel-core"
*/
protected File readmeCoreDir;
/**
* The directory for components
*
* @parameter default-value="${project.directory}/../../../components"
*/
protected File readmeComponentsDir;
/**
* Maven ProjectHelper.
*
* @component
* @readonly
*/
private MavenProjectHelper projectHelper;
/**
* Execute goal.
*
* @throws MojoExecutionException execution of the main class or one of the
* threads it generated failed.
* @throws MojoFailureException something bad happened...
*/
public void execute() throws MojoExecutionException, MojoFailureException {
// update readme file in camel-core
executeEipsReadme();
executeComponentsReadme(true);
executeDataFormatsReadme(true);
executeLanguagesReadme(true);
// update readme file in components
executeComponentsReadme(false);
executeOthersReadme();
executeDataFormatsReadme(false);
executeLanguagesReadme(false);
}
protected void executeEipsReadme() throws MojoExecutionException, MojoFailureException {
Set eipFiles = new TreeSet<>();
if (eipsDir != null && eipsDir.isDirectory()) {
File[] files = eipsDir.listFiles();
if (files != null) {
eipFiles.addAll(Arrays.asList(files));
}
}
try {
List models = new ArrayList<>();
for (File file : eipFiles) {
String json = loadText(new FileInputStream(file));
EipModel model = generateEipModel(json);
// we only want actual EIPs from the models
if (model.getLabel().startsWith("eip")) {
models.add(model);
}
}
// re-order the EIPs so we have them in different categories
// sort the models
Collections.sort(models, new EipComparator());
// how many deprecated
long deprecated = models.stream()
.filter(EipModel::isDeprecated)
.count();
// update the big readme file in the core dir
File file = new File(readmeCoreDir, "readme-eip.adoc");
// update regular components
boolean exists = file.exists();
String changed = templateEips(models, deprecated);
boolean updated = updateEips(file, changed);
if (updated) {
getLog().info("Updated readme-eip.adoc file: " + file);
} else if (exists) {
getLog().debug("No changes to readme-eip.adoc file: " + file);
} else {
getLog().warn("No readme-eip.adoc file: " + file);
}
} catch (IOException e) {
throw new MojoFailureException("Error due " + e.getMessage(), e);
}
}
protected void executeComponentsReadme(boolean coreOnly) throws MojoExecutionException, MojoFailureException {
Set componentFiles = new TreeSet<>();
if (componentsDir != null && componentsDir.isDirectory()) {
File[] files = componentsDir.listFiles();
if (files != null) {
componentFiles.addAll(Arrays.asList(files));
}
}
try {
List models = new ArrayList<>();
for (File file : componentFiles) {
String json = loadText(new FileInputStream(file));
ComponentModel model = generateComponentModel(json, coreOnly);
// filter out alternative schemas which reuses documentation
boolean add = true;
if (!model.getAlternativeSchemes().isEmpty()) {
String first = model.getAlternativeSchemes().split(",")[0];
if (!model.getScheme().equals(first)) {
add = false;
}
}
if (add) {
models.add(model);
// special for camel-mail where we want to refer its imap scheme to mail so its mail.adoc in the doc link
if ("imap".equals(model.getScheme())) {
model.setScheme("mail");
model.setTitle("Mail");
}
}
}
// sort the models
Collections.sort(models, new ComponentComparator());
// filter out unwanted components
List components = new ArrayList<>();
for (ComponentModel model : models) {
if (coreOnly) {
if ("camel-core".equals(model.getArtifactId())) {
// only include core components
components.add(model);
}
} else {
// we want to include everything in the big file (also from camel-core)
components.add(model);
}
}
// how many different artifacts
int count = components.stream()
.map(ComponentModel::getArtifactId)
.collect(toSet()).size();
// how many deprecated
long deprecated = components.stream()
.filter(c -> "true".equals(c.getDeprecated()))
.count();
// update the big readme file in the core/components dir
File file;
if (coreOnly) {
file = new File(readmeCoreDir, "readme.adoc");
} else {
file = new File(readmeComponentsDir, "readme.adoc");
}
// update regular components
boolean exists = file.exists();
String changed = templateComponents(components, count, deprecated);
boolean updated = updateComponents(file, changed);
if (updated) {
getLog().info("Updated readme.adoc file: " + file);
} else if (exists) {
getLog().debug("No changes to readme.adoc file: " + file);
} else {
getLog().warn("No readme.adoc file: " + file);
}
} catch (IOException e) {
throw new MojoFailureException("Error due " + e.getMessage(), e);
}
}
protected void executeOthersReadme() throws MojoExecutionException, MojoFailureException {
Set otherFiles = new TreeSet<>();
if (othersDir != null && othersDir.isDirectory()) {
File[] files = othersDir.listFiles();
if (files != null) {
otherFiles.addAll(Arrays.asList(files));
}
}
try {
List others = new ArrayList<>();
for (File file : otherFiles) {
String json = loadText(new FileInputStream(file));
OtherModel model = generateOtherModel(json);
others.add(model);
}
// sort the models
Collections.sort(others, new OtherComparator());
// how many different artifacts
int count = others.stream()
.map(OtherModel::getArtifactId)
.collect(toSet()).size();
// how many deprecated
long deprecated = others.stream()
.filter(o -> "true".equals(o.getDeprecated()))
.count();
// update the big readme file in the components dir
File file = new File(readmeComponentsDir, "readme.adoc");
// update regular components
boolean exists = file.exists();
String changed = templateOthers(others, count, deprecated);
boolean updated = updateOthers(file, changed);
if (updated) {
getLog().info("Updated readme.adoc file: " + file);
} else if (exists) {
getLog().debug("No changes to readme.adoc file: " + file);
} else {
getLog().warn("No readme.adoc file: " + file);
}
} catch (IOException e) {
throw new MojoFailureException("Error due " + e.getMessage(), e);
}
}
protected void executeDataFormatsReadme(boolean coreOnly) throws MojoExecutionException, MojoFailureException {
Set dataFormatFiles = new TreeSet<>();
if (dataFormatsDir != null && dataFormatsDir.isDirectory()) {
File[] files = dataFormatsDir.listFiles();
if (files != null) {
dataFormatFiles.addAll(Arrays.asList(files));
}
}
try {
List models = new ArrayList<>();
for (File file : dataFormatFiles) {
String json = loadText(new FileInputStream(file));
DataFormatModel model = generateDataFormatModel(json, coreOnly);
// special for bindy as we have one common file
if (model.getName().startsWith("bindy")) {
model.setName("bindy");
}
models.add(model);
}
// sort the models
Collections.sort(models, new DataFormatComparator());
// how many different artifacts
int count = models.stream()
.map(DataFormatModel::getArtifactId)
.collect(toSet()).size();
// how many deprecated
long deprecated = models.stream()
.filter(m -> "true".equals(m.getDeprecated()))
.count();
// filter out camel-core
List dataFormats = new ArrayList<>();
for (DataFormatModel model : models) {
if (coreOnly) {
if ("camel-core".equals(model.getArtifactId())) {
// only include core components
dataFormats.add(model);
}
} else {
// we want to include everything in the big file (also from camel-core)
dataFormats.add(model);
}
}
// update the big readme file in the core/components dir
File file;
if (coreOnly) {
file = new File(readmeCoreDir, "readme.adoc");
} else {
file = new File(readmeComponentsDir, "readme.adoc");
}
// update regular data formats
boolean exists = file.exists();
String changed = templateDataFormats(dataFormats, count, deprecated);
boolean updated = updateDataFormats(file, changed);
if (updated) {
getLog().info("Updated readme.adoc file: " + file);
} else if (exists) {
getLog().debug("No changes to readme.adoc file: " + file);
} else {
getLog().warn("No readme.adoc file: " + file);
}
} catch (IOException e) {
throw new MojoFailureException("Error due " + e.getMessage(), e);
}
}
protected void executeLanguagesReadme(boolean coreOnly) throws MojoExecutionException, MojoFailureException {
Set languageFiles = new TreeSet<>();
if (languagesDir != null && languagesDir.isDirectory()) {
File[] files = languagesDir.listFiles();
if (files != null) {
languageFiles.addAll(Arrays.asList(files));
}
}
try {
List models = new ArrayList<>();
for (File file : languageFiles) {
String json = loadText(new FileInputStream(file));
LanguageModel model = generateLanguageModel(json, coreOnly);
models.add(model);
}
// sort the models
Collections.sort(models, new LanguageComparator());
// filter out camel-core
List languages = new ArrayList<>();
for (LanguageModel model : models) {
if (coreOnly) {
if ("camel-core".equals(model.getArtifactId())) {
// only include core components
languages.add(model);
}
} else {
// we want to include everything in the big file (also from camel-core)
languages.add(model);
}
}
// how many different artifacts
int count = languages.stream()
.map(LanguageModel::getArtifactId)
.collect(toSet()).size();
// how many deprecated
long deprecated = languages.stream()
.filter(l -> "true".equals(l.getDeprecated()))
.count();
// update the big readme file in the core/components dir
File file;
if (coreOnly) {
file = new File(readmeCoreDir, "readme.adoc");
} else {
file = new File(readmeComponentsDir, "readme.adoc");
}
// update regular data formats
boolean exists = file.exists();
String changed = templateLanguages(languages, count, deprecated);
boolean updated = updateLanguages(file, changed);
if (updated) {
getLog().info("Updated readme.adoc file: " + file);
} else if (exists) {
getLog().debug("No changes to readme.adoc file: " + file);
} else {
getLog().warn("No readme.adoc file: " + file);
}
} catch (IOException e) {
throw new MojoFailureException("Error due " + e.getMessage(), e);
}
}
private String templateEips(List models, long deprecated) throws MojoExecutionException {
try {
String template = loadText(UpdateReadmeMojo.class.getClassLoader().getResourceAsStream("readme-eips.mvel"));
Map map = new HashMap<>();
map.put("eips", models);
map.put("numberOfDeprecated", deprecated);
String out = (String) TemplateRuntime.eval(template, map);
return out;
} catch (Exception e) {
throw new MojoExecutionException("Error processing mvel template. Reason: " + e, e);
}
}
private String templateComponents(List models, int artifacts, long deprecated) throws MojoExecutionException {
try {
String template = loadText(UpdateReadmeMojo.class.getClassLoader().getResourceAsStream("readme-components.mvel"));
Map map = new HashMap<>();
map.put("components", models);
map.put("numberOfArtifacts", artifacts);
map.put("numberOfDeprecated", deprecated);
String out = (String) TemplateRuntime.eval(template, map);
return out;
} catch (Exception e) {
throw new MojoExecutionException("Error processing mvel template. Reason: " + e, e);
}
}
private String templateOthers(List models, int artifacts, long deprecated) throws MojoExecutionException {
try {
String template = loadText(UpdateReadmeMojo.class.getClassLoader().getResourceAsStream("readme-others.mvel"));
Map map = new HashMap<>();
map.put("others", models);
map.put("numberOfArtifacts", artifacts);
map.put("numberOfDeprecated", deprecated);
String out = (String) TemplateRuntime.eval(template, map);
return out;
} catch (Exception e) {
throw new MojoExecutionException("Error processing mvel template. Reason: " + e, e);
}
}
private String templateDataFormats(List models, int artifacts, long deprecated) throws MojoExecutionException {
try {
String template = loadText(UpdateReadmeMojo.class.getClassLoader().getResourceAsStream("readme-dataformats.mvel"));
Map map = new HashMap<>();
map.put("dataformats", models);
map.put("numberOfArtifacts", artifacts);
map.put("numberOfDeprecated", deprecated);
String out = (String) TemplateRuntime.eval(template, map);
return out;
} catch (Exception e) {
throw new MojoExecutionException("Error processing mvel template. Reason: " + e, e);
}
}
private String templateLanguages(List models, int artifacts, long deprecated) throws MojoExecutionException {
try {
String template = loadText(UpdateReadmeMojo.class.getClassLoader().getResourceAsStream("readme-languages.mvel"));
Map map = new HashMap<>();
map.put("languages", models);
map.put("numberOfArtifacts", artifacts);
map.put("numberOfDeprecated", deprecated);
String out = (String) TemplateRuntime.eval(template, map);
return out;
} catch (Exception e) {
throw new MojoExecutionException("Error processing mvel template. Reason: " + e, e);
}
}
private boolean updateEips(File file, String changed) throws MojoExecutionException {
if (!file.exists()) {
return false;
}
try {
String text = loadText(new FileInputStream(file));
String existing = StringHelper.between(text, "// eips: START", "// eips: END");
if (existing != null) {
// remove leading line breaks etc
existing = existing.trim();
changed = changed.trim();
if (existing.equals(changed)) {
return false;
} else {
String before = StringHelper.before(text, "// eips: START");
String after = StringHelper.after(text, "// eips: END");
text = before + "// eips: START\n" + changed + "\n// eips: END" + after;
writeText(file, text);
return true;
}
} else {
getLog().warn("Cannot find markers in file " + file);
getLog().warn("Add the following markers");
getLog().warn("\t// eips: START");
getLog().warn("\t// eips: END");
return false;
}
} catch (Exception e) {
throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e);
}
}
private boolean updateComponents(File file, String changed) throws MojoExecutionException {
if (!file.exists()) {
return false;
}
try {
String text = loadText(new FileInputStream(file));
String existing = StringHelper.between(text, "// components: START", "// components: END");
if (existing != null) {
// remove leading line breaks etc
existing = existing.trim();
changed = changed.trim();
if (existing.equals(changed)) {
return false;
} else {
String before = StringHelper.before(text, "// components: START");
String after = StringHelper.after(text, "// components: END");
text = before + "// components: START\n" + changed + "\n// components: END" + after;
writeText(file, text);
return true;
}
} else {
getLog().warn("Cannot find markers in file " + file);
getLog().warn("Add the following markers");
getLog().warn("\t// components: START");
getLog().warn("\t// components: END");
return false;
}
} catch (Exception e) {
throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e);
}
}
private boolean updateOthers(File file, String changed) throws MojoExecutionException {
if (!file.exists()) {
return false;
}
try {
String text = loadText(new FileInputStream(file));
String existing = StringHelper.between(text, "// others: START", "// others: END");
if (existing != null) {
// remove leading line breaks etc
existing = existing.trim();
changed = changed.trim();
if (existing.equals(changed)) {
return false;
} else {
String before = StringHelper.before(text, "// others: START");
String after = StringHelper.after(text, "// others: END");
text = before + "// others: START\n" + changed + "\n// others: END" + after;
writeText(file, text);
return true;
}
} else {
getLog().warn("Cannot find markers in file " + file);
getLog().warn("Add the following markers");
getLog().warn("\t// others: START");
getLog().warn("\t// others: END");
return false;
}
} catch (Exception e) {
throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e);
}
}
private boolean updateDataFormats(File file, String changed) throws MojoExecutionException {
if (!file.exists()) {
return false;
}
try {
String text = loadText(new FileInputStream(file));
String existing = StringHelper.between(text, "// dataformats: START", "// dataformats: END");
if (existing != null) {
// remove leading line breaks etc
existing = existing.trim();
changed = changed.trim();
if (existing.equals(changed)) {
return false;
} else {
String before = StringHelper.before(text, "// dataformats: START");
String after = StringHelper.after(text, "// dataformats: END");
text = before + "// dataformats: START\n" + changed + "\n// dataformats: END" + after;
writeText(file, text);
return true;
}
} else {
getLog().warn("Cannot find markers in file " + file);
getLog().warn("Add the following markers");
getLog().warn("\t// dataformats: START");
getLog().warn("\t// dataformats: END");
return false;
}
} catch (Exception e) {
throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e);
}
}
private boolean updateLanguages(File file, String changed) throws MojoExecutionException {
if (!file.exists()) {
return false;
}
try {
String text = loadText(new FileInputStream(file));
String existing = StringHelper.between(text, "// languages: START", "// languages: END");
if (existing != null) {
// remove leading line breaks etc
existing = existing.trim();
changed = changed.trim();
if (existing.equals(changed)) {
return false;
} else {
String before = StringHelper.before(text, "// languages: START");
String after = StringHelper.after(text, "// languages: END");
text = before + "// languages: START\n" + changed + "\n// languages: END" + after;
writeText(file, text);
return true;
}
} else {
getLog().warn("Cannot find markers in file " + file);
getLog().warn("Add the following markers");
getLog().warn("\t// languages: START");
getLog().warn("\t// languages: END");
return false;
}
} catch (Exception e) {
throw new MojoExecutionException("Error reading file " + file + " Reason: " + e, e);
}
}
private static class EipComparator implements Comparator {
@Override
public int compare(EipModel o1, EipModel o2) {
// lets sort by title
return o1.getTitle().compareToIgnoreCase(o2.getTitle());
}
}
private static class ComponentComparator implements Comparator {
@Override
public int compare(ComponentModel o1, ComponentModel o2) {
// lets sort by title
return o1.getTitle().compareToIgnoreCase(o2.getTitle());
}
}
private static class OtherComparator implements Comparator {
@Override
public int compare(OtherModel o1, OtherModel o2) {
// lets sort by title
return o1.getTitle().compareToIgnoreCase(o2.getTitle());
}
}
private static class DataFormatComparator implements Comparator {
@Override
public int compare(DataFormatModel o1, DataFormatModel o2) {
// lets sort by title
return o1.getTitle().compareToIgnoreCase(o2.getTitle());
}
}
private static class LanguageComparator implements Comparator {
@Override
public int compare(LanguageModel o1, LanguageModel o2) {
// lets sort by title
return o1.getTitle().compareToIgnoreCase(o2.getTitle());
}
}
private EipModel generateEipModel(String json) {
List
© 2015 - 2025 Weber Informatics LLC | Privacy Policy