branch develop updated (286c227 -> bfd0ddd)
This is an automated email from the git hooks/post-receive script. New change to branch develop in repository eugene. See https://gitlab.nuiton.org/nuiton/eugene.git from 286c227 reintroduce old api for some extra cases but should improve this new f1d1f36 fix javadoc new 8485469 remove stereotype report new 47256d5 review tag value report new c0558f4 review doc new bfd0ddd fix renderer typo The 5 revisions listed above as "new" are entirely new to this repository and will be described in separate emails. The revisions listed as "adds" were already present in the repository and have only been added to this reference. Detailed log of new commits: commit bfd0dddf551ee3d89a52128c58f7f69265390820 Author: Tony CHEMIT <chemit@codelutin.com> Date: Sat Oct 8 16:26:22 2016 +0200 fix renderer typo commit c0558f4429e989ef707cfb55305d161455fd1493 Author: Tony CHEMIT <chemit@codelutin.com> Date: Sat Oct 8 16:21:01 2016 +0200 review doc commit 47256d50f0c07e370da2c2eaf75c99544d86077e Author: Tony CHEMIT <chemit@codelutin.com> Date: Sat Oct 8 16:20:57 2016 +0200 review tag value report commit 8485469e2314e012dacb3d5c09550d039e467da9 Author: Tony CHEMIT <chemit@codelutin.com> Date: Sat Oct 8 16:20:22 2016 +0200 remove stereotype report commit f1d1f36bed7169e5a4cf52aecaa60be2e40c5c7d Author: Tony CHEMIT <chemit@codelutin.com> Date: Sat Oct 8 16:19:17 2016 +0200 fix javadoc Summary of changes: eugene-java-templates/pom.xml | 3 +- .../nuiton/eugene/plugin/AbstractEugeneReport.java | 150 --------- .../org/nuiton/eugene/plugin/TagValuesReport.java | 111 ++++++- .../renderer/AbstractEugeneReportRenderer.java | 338 -------------------- .../plugin/renderer/TagValuesReportRenderer.java | 353 ++++++++++++++++----- .../main/resources/stereotypes-report.properties | 52 --- .../resources/stereotypes-report_en.properties | 21 -- .../resources/stereotypes-report_fr.properties | 52 --- .../main/resources/tag-values-report.properties | 3 +- .../main/resources/tag-values-report_fr.properties | 2 +- .../models/extension/tagvalue/TagValueUtil.java | 9 +- eugene/src/site/fr/rst/stereotypes.rst.vm | 61 +--- eugene/src/site/fr/rst/tagValues.rst.vm | 8 +- eugene/src/site/rst/stereotypes.rst.vm | 61 +--- eugene/src/site/rst/tagValues.rst.vm | 14 +- 15 files changed, 413 insertions(+), 825 deletions(-) delete mode 100644 eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/AbstractEugeneReport.java delete mode 100644 eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/renderer/AbstractEugeneReportRenderer.java delete mode 100644 eugene-maven-plugin/src/main/resources/stereotypes-report.properties delete mode 100644 eugene-maven-plugin/src/main/resources/stereotypes-report_en.properties delete mode 100644 eugene-maven-plugin/src/main/resources/stereotypes-report_fr.properties -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository eugene. See https://gitlab.nuiton.org/nuiton/eugene.git commit f1d1f36bed7169e5a4cf52aecaa60be2e40c5c7d Author: Tony CHEMIT <chemit@codelutin.com> Date: Sat Oct 8 16:19:17 2016 +0200 fix javadoc --- .../nuiton/eugene/models/extension/tagvalue/TagValueUtil.java | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/eugene/src/main/java/org/nuiton/eugene/models/extension/tagvalue/TagValueUtil.java b/eugene/src/main/java/org/nuiton/eugene/models/extension/tagvalue/TagValueUtil.java index 6f09dbf..90d350d 100644 --- a/eugene/src/main/java/org/nuiton/eugene/models/extension/tagvalue/TagValueUtil.java +++ b/eugene/src/main/java/org/nuiton/eugene/models/extension/tagvalue/TagValueUtil.java @@ -149,12 +149,13 @@ public class TagValueUtil { * always starts from specialized to more general level (for example from attribute, * to classifier or model). * - * @param tagName tag name to find - * @param elements not null elements to test - * @return found tag value or {@code null} if not found + * @param tagName tag name to find + * @param defaultValue default value to use if not found + * @param elements not null elements to test + * @return found tag value or {@code defaultValue} if not found * @since 3.0 */ - public static String findTagValue(String tagName,String defaultValue, WithTagValuesOrStereotypes... elements) { + public static String findTagValue(String tagName, String defaultValue, WithTagValuesOrStereotypes... elements) { String result = findDirectTagValue(tagName, elements); if (result != null) { -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository eugene. See https://gitlab.nuiton.org/nuiton/eugene.git commit 8485469e2314e012dacb3d5c09550d039e467da9 Author: Tony CHEMIT <chemit@codelutin.com> Date: Sat Oct 8 16:20:22 2016 +0200 remove stereotype report --- eugene-java-templates/pom.xml | 3 +- .../nuiton/eugene/plugin/AbstractEugeneReport.java | 150 --------- .../renderer/AbstractEugeneReportRenderer.java | 338 --------------------- .../main/resources/stereotypes-report.properties | 52 ---- .../resources/stereotypes-report_en.properties | 21 -- .../resources/stereotypes-report_fr.properties | 52 ---- 6 files changed, 1 insertion(+), 615 deletions(-) diff --git a/eugene-java-templates/pom.xml b/eugene-java-templates/pom.xml index d86f56a..631f67e 100644 --- a/eugene-java-templates/pom.xml +++ b/eugene-java-templates/pom.xml @@ -171,7 +171,6 @@ <reportSet> <reports> <report>tag-values-report</report> - <report>stereotypes-report</report> </reports> </reportSet> </reportSets> @@ -187,7 +186,7 @@ <plugin> <groupId>org.nuiton.eugene</groupId> <artifactId>eugene-maven-plugin</artifactId> - <version>3.0-alpha-1</version> + <version>3.0-alpha-7</version> <dependencies> <dependency> <groupId>${project.groupId}</groupId> diff --git a/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/AbstractEugeneReport.java b/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/AbstractEugeneReport.java deleted file mode 100644 index 870233b..0000000 --- a/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/AbstractEugeneReport.java +++ /dev/null @@ -1,150 +0,0 @@ -package org.nuiton.eugene.plugin; - -/* - * #%L - * EUGene :: Maven plugin - * %% - * Copyright (C) 2012 - 2013 CodeLutin - * %% - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Lesser Public License for more details. - * - * You should have received a copy of the GNU General Lesser Public - * License along with this program. If not, see - * <http://www.gnu.org/licenses/lgpl-3.0.html>. - * #L% - */ - -import org.apache.maven.doxia.siterenderer.Renderer; -import org.apache.maven.plugins.annotations.Component; -import org.apache.maven.plugins.annotations.Parameter; -import org.apache.maven.project.MavenProject; -import org.apache.maven.reporting.AbstractMavenReport; -import org.apache.maven.reporting.AbstractMavenReportRenderer; -import org.apache.maven.reporting.MavenReportException; -import org.codehaus.plexus.i18n.I18N; - -import java.io.File; -import java.util.Locale; - -/** - * Abstract application config report used by normal and aggregate report. - * - * @author Tony Chemit - chemit@codelutin.com - * @since 2.10 - */ -public abstract class AbstractEugeneReport<D> extends AbstractMavenReport { - - /** - * Report output directory. Note that this parameter is only relevant if the goal is run from the command line or - * from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output - * directory configured in the Maven Site Plugin is used instead. - */ - @Parameter(property = "config.outputDirectory", - defaultValue = "${project.reporting.outputDirectory}", - required = true) - protected File outputDirectory; - - /** - * Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or - * from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output - * encoding configured in the Maven Site Plugin is used instead. - */ - @Parameter(property = "config.outputEncoding", - defaultValue = "${project.reporting.outputEncoding}", - required = true) - protected String outputEncoding; - - /** - * Skip to generate the report. - */ - @Parameter(property = "config.skip") - protected boolean skip; - - /** - * Location of javadoc report. - */ - @Parameter(property = "eugene.javaDocDestDir", defaultValue = "apidocs") - protected String javaDocDestDir; - - /** - * Location of xref report. - */ - @Parameter(property = "eugene.jxrDestDir", defaultValue = "xref") - protected String jxrDestDir; - - /** - * The Maven Project. - */ - @Parameter(defaultValue = "${project}", readonly = true) - protected MavenProject project; - - /** - * Doxia Site Renderer component. - */ - @Component - protected Renderer siteRenderer; - - /** - * Internationalization component. - */ - @Component - protected I18N i18n; - - protected abstract AbstractMavenReportRenderer createRenderer(Locale locale, D data); - - protected abstract D initData(Locale locale) throws MavenReportException; - - @Override - public String getDescription(Locale locale) { - return i18n.getString(getOutputName(), locale, "report.description"); - } - - @Override - public String getName(Locale locale) { - return i18n.getString(getOutputName(), locale, "report.title"); - } - - @Override - public String getCategoryName() { - return CATEGORY_PROJECT_REPORTS; - } - - @Override - public boolean canGenerateReport() { - return !skip; - } - - @Override - protected Renderer getSiteRenderer() { - return siteRenderer; - } - - @Override - protected String getOutputDirectory() { - return outputDirectory.getAbsolutePath(); - } - - @Override - protected MavenProject getProject() { - return project; - } - - @Override - protected void executeReport(Locale locale) throws MavenReportException { - - D data = initData(locale); - - AbstractMavenReportRenderer renderer = createRenderer(locale, data); - renderer.render(); - - } - -} diff --git a/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/renderer/AbstractEugeneReportRenderer.java b/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/renderer/AbstractEugeneReportRenderer.java deleted file mode 100644 index 5a69f35..0000000 --- a/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/renderer/AbstractEugeneReportRenderer.java +++ /dev/null @@ -1,338 +0,0 @@ -package org.nuiton.eugene.plugin.renderer; - -/* - * #%L - * EUGene :: Maven plugin - * %% - * Copyright (C) 2012 - 2013 CodeLutin - * %% - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Lesser Public License for more details. - * - * You should have received a copy of the GNU General Lesser Public - * License along with this program. If not, see - * <http://www.gnu.org/licenses/lgpl-3.0.html>. - * #L% - */ - -import org.apache.commons.collections4.CollectionUtils; -import org.apache.maven.doxia.sink.Sink; -import org.apache.maven.doxia.sink.SinkEventAttributeSet; -import org.apache.maven.doxia.sink.SinkEventAttributes; -import org.apache.maven.reporting.AbstractMavenReportRenderer; -import org.codehaus.plexus.i18n.I18N; -import org.nuiton.eugene.models.object.ObjectModel; -import org.nuiton.eugene.models.object.ObjectModelAttribute; -import org.nuiton.eugene.models.object.ObjectModelClass; -import org.nuiton.eugene.models.object.ObjectModelClassifier; -import org.nuiton.eugene.models.object.ObjectModelElement; -import org.nuiton.eugene.models.object.ObjectModelEnumeration; -import org.nuiton.eugene.models.object.ObjectModelInterface; -import org.nuiton.eugene.models.object.ObjectModelOperation; -import org.nuiton.eugene.models.object.ObjectModelPackage; -import org.nuiton.eugene.models.object.ObjectModelParameter; - -import java.util.Locale; -import java.util.Set; - -/** - * @author Tony Chemit - chemit@codelutin.com - * @since 2.10 - */ -public abstract class AbstractEugeneReportRenderer<D, DD> extends AbstractMavenReportRenderer { - - /** - * Internationalization component. - */ - protected final I18N i18n; - - /** - * The locale we are rendering for. - */ - protected final Locale locale; - - /** - * The name of the bundle containing our I18n resources. - */ - protected final String bundleName; - - /** - * Data to describe. - */ - protected final D data; - - protected final String javaDocDestDir; - - protected final String jxrDestDir; - - protected abstract Set<DD> getDataDetails(); - - protected abstract String getProviderDescription(D data); - - public AbstractEugeneReportRenderer(Sink sink, - I18N i18n, - Locale locale, - String bundleName, - String javaDocDestDir, - String jxrDestDir, - D data) { - super(sink); - this.i18n = i18n; - this.locale = locale; - this.bundleName = bundleName; - this.javaDocDestDir = javaDocDestDir; - this.jxrDestDir = jxrDestDir; - this.data = data; - this.sink = sink; - } - - @Override - public String getTitle() { - return getText("report.title"); - } - - @Override - public void renderBody() { - - String implementation = data.getClass().getName(); - - sink.section1(); - - sink.sectionTitle1(); - sink.text(getText("report.overview.title")); - sink.sectionTitle1_(); - - sink.lineBreak(); - - sink.paragraph(); - sink.text(getText("report.overview.text")); - sink.text(" "); - sink.italic(); - sink.text(getProviderDescription(data)); - sink.italic_(); - sink.bold(); - sink.text(implementation); - sink.bold_(); - sink.text(" "); - sink.link("./" + javaDocDestDir + "/" + implementation.replace('.', '/') + ".html"); - sink.text("javadoc"); - sink.link_(); - sink.link("./" + jxrDestDir + "/" + implementation.replace('.', '/') + ".html"); - sink.text(" "); - sink.text("xref"); - sink.link_(); - sink.text("."); - sink.paragraph_(); - - sink.paragraph(); - sink.link(getEugeneDocLink()); - sink.text(getText("report.overview.more.information")); - sink.link_(); - sink.paragraph_(); - - Set<DD> detailEntries = getDataDetails(); - - renderSummaryTable(data, detailEntries); - - sink.section1_(); - - if (CollectionUtils.isNotEmpty(detailEntries)) { - - sink.section1(); - - sink.sectionTitle1(); - sink.text(getText("report.detail.title")); - sink.sectionTitle1_(); - - sink.lineBreak(); - - sink.paragraph(); - sink.text(getText("report.detail.text")); - sink.paragraph_(); - - for (DD detailEntry : detailEntries) { - - renderDetail(detailEntry); - - } - - sink.section1_(); - - } - - } - - protected abstract String getEugeneDocLink(); - - protected abstract void renderSummaryTable(D provider, Set<DD> detailEntries); - - protected abstract void renderDetail(DD detail); - - protected String getText(boolean key) { - return getText("report." + String.valueOf(key)); - } - - /** - * Gets the localized message for this report. - * - * @param key the message key. - * @return the message. - */ - protected String getText(String key) { - return i18n.getString(bundleName, locale, key); - } - - protected void renderWarningIcon() { - sink.figure(); - sink.figureGraphics("images/icon_warning_sml.gif"); - sink.figure_(); - } - - protected void renderErrorIcon() { - sink.figure(); - sink.figureGraphics("images/icon_error_sml.gif"); - sink.figure_(); - } - - protected void renderSuccessIcon() { - sink.figure(); - sink.figureGraphics("images/icon_success_sml.gif"); - sink.figure_(); - } - - protected void renderInfoIcon() { - sink.figure(); - sink.figureGraphics("images/icon_info_sml.gif"); - sink.figure_(); - } - - protected void sinkHeaderCellText(String text) { - sink.tableHeaderCell(); - sink.text(text); - sink.tableHeaderCell_(); - } - - protected void sinkHeaderCellText(SinkEventAttributes width, String text) { - sink.tableHeaderCell(width); - sink.text(text); - sink.tableHeaderCell_(); - } - - protected void sinkCellText(SinkEventAttributes width, String text) { - sink.tableCell(width); - sink.text(text); - sink.tableCell_(); - } - - protected void sinkCellText(String text) { - sink.tableCell(); - sink.text(text); - sink.tableCell_(); - } - - protected void sinkCellVerbatimText(String text) { - sink.tableCell(); - sink.verbatim(SinkEventAttributeSet.MONOSPACED); - sink.text(text); - sink.verbatim_(); - sink.tableCell_(); - } - - protected void sinkCellLink(String text, String url) { - sink.tableCell(); - sink.link(url); - sink.text(text); - sink.link_(); - sink.tableCell_(); - } - - protected void renderTargets(Set<Class<?>> targets) { - - boolean moreThanOne = targets.size() > 1; - - if (moreThanOne) { - - sink.list_(); - - } - - for (Class<?> target : targets) { - - if (moreThanOne) { - - sink.listItem(); - - } - - renderDetailTarget(target); - - if (moreThanOne) { - - sink.listItem_(); - - } - - } - - if (moreThanOne) { - - sink.list_(); - - } - - } - - protected void renderDetailTarget(Class<?> target) { - - if (ObjectModel.class.isAssignableFrom(target)) { - - sink.text(getText("report.detail.target.model")); - - } else if (ObjectModelPackage.class.isAssignableFrom(target)) { - - sink.text(getText("report.detail.target.package")); - - } else if (ObjectModelClassifier.class.isAssignableFrom(target)) { - - sink.text(getText("report.detail.target.classifier")); - - } else if (ObjectModelClass.class.isAssignableFrom(target)) { - - sink.text(getText("report.detail.target.class")); - - } else if (ObjectModelInterface.class.isAssignableFrom(target)) { - - sink.text(getText("report.detail.target.interface")); - - } else if (ObjectModelEnumeration.class.isAssignableFrom(target)) { - - sink.text(getText("report.detail.target.enumeration")); - - } else if (ObjectModelAttribute.class.isAssignableFrom(target)) { - - sink.text(getText("report.detail.target.attribute")); - - } else if (ObjectModelParameter.class.isAssignableFrom(target)) { - - sink.text(getText("report.detail.target.parameter")); - - } else if (ObjectModelOperation.class.isAssignableFrom(target)) { - - sink.text(getText("report.detail.target.operation")); - - } else if (ObjectModelElement.class.isAssignableFrom(target)) { - - sink.text(getText("report.detail.target.element")); - - } - - } - -} diff --git a/eugene-maven-plugin/src/main/resources/stereotypes-report.properties b/eugene-maven-plugin/src/main/resources/stereotypes-report.properties deleted file mode 100644 index 27e6139..0000000 --- a/eugene-maven-plugin/src/main/resources/stereotypes-report.properties +++ /dev/null @@ -1,52 +0,0 @@ -### -# #%L -# EUGene :: Maven plugin -# %% -# Copyright (C) 2006 - 2014 CodeLutin -# %% -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License as -# published by the Free Software Foundation, either version 3 of the -# License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Lesser Public License for more details. -# -# You should have received a copy of the GNU General Lesser Public -# License along with this program. If not, see -# <http://www.gnu.org/licenses/lgpl-3.0.html>. -# #L% -### -report.title=EUGene Stereotypes -report.description=Provides details of stereotypes available in a given class -report.overview.title=Overview -report.overview.text=This report summarizes all stereotypes available ith the class -report.overview.more.information=More information about Stereotypes in EUGene -tagValueProvider.not.found=Could not find stereotype provider named ''{0}'' - -report.detail.title=Detail of stereotype -report.detail.text=We give details of each stereotype - -report.summary.stereotypes=Stereotypes found -report.noStereotypes=No stereotype defined in this provider. -report.stereotype.name=Name -report.stereotype.description=Description -report.stereotype.target=Target(s) - -report.detail.stereotype.title=Stereotype -report.detail.stereotype.name=Name -report.detail.stereotype.description=Description -report.detail.stereotype.target=Target(s) -report.detail.target.model=on a model -report.detail.target.package=on a package -report.detail.target.classifier=on a classifier -report.detail.target.class=on a class -report.detail.target.interface=on a interface -report.detail.target.enumeration=on a enumeration -report.detail.target.attribute=on a attribute -report.detail.target.parameter=on a parameter -report.detail.target.operation=on a operation -report.detail.target.element=on a element -report.detail.stereotype.usage.title=Usage diff --git a/eugene-maven-plugin/src/main/resources/stereotypes-report_en.properties b/eugene-maven-plugin/src/main/resources/stereotypes-report_en.properties deleted file mode 100644 index 4745c8a..0000000 --- a/eugene-maven-plugin/src/main/resources/stereotypes-report_en.properties +++ /dev/null @@ -1,21 +0,0 @@ -### -# #%L -# EUGene :: Maven plugin -# %% -# Copyright (C) 2006 - 2014 CodeLutin -# %% -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License as -# published by the Free Software Foundation, either version 3 of the -# License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Lesser Public License for more details. -# -# You should have received a copy of the GNU General Lesser Public -# License along with this program. If not, see -# <http://www.gnu.org/licenses/lgpl-3.0.html>. -# #L% -### diff --git a/eugene-maven-plugin/src/main/resources/stereotypes-report_fr.properties b/eugene-maven-plugin/src/main/resources/stereotypes-report_fr.properties deleted file mode 100644 index b76380e..0000000 --- a/eugene-maven-plugin/src/main/resources/stereotypes-report_fr.properties +++ /dev/null @@ -1,52 +0,0 @@ -### -# #%L -# EUGene :: Maven plugin -# %% -# Copyright (C) 2006 - 2014 CodeLutin -# %% -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License as -# published by the Free Software Foundation, either version 3 of the -# License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Lesser Public License for more details. -# -# You should have received a copy of the GNU General Lesser Public -# License along with this program. If not, see -# <http://www.gnu.org/licenses/lgpl-3.0.html>. -# #L% -### -report.title=EUGene St\u00E9r\u00E9otypes -report.description=Documente les st\u00E9r\u00E9otypes d'un provider donn\u00E9. -report.overview.title=Pr\u00E9ambule -report.overview.text=Ce rapport d\u00E9crit les st\u00E9r\u00E9otypes d\u00E9finies dans la classe -stereotypeProvider.not.found=Impossible de trouver le st\u00E9r\u00E9otype prodiver nomm\u00E9 ''{0}'' -report.overview.more.information=Pour plus d'informations sur les St\u00E9r\u00E9otypes dans EUGene - -report.detail.title=D\u00E9tail des st\u00E9r\u00E9otypes -report.detail.text=On d\u00E9taille ici les st\u00E9r\u00E9otypes trouv\u00E9s. - -report.noStereotypes=Pas de st\u00E9r\u00E9otype d\u00E9finie dans ce provider. -report.summary.stereotype=St\u00E9r\u00E9otypes d\u00E9tect\u00E9es -report.stereotype.name=Nom -report.stereotype.description=Description -report.stereotype.target=Cible(s) - -report.detail.stereotype.title=St\u00E9r\u00E9otype -report.detail.stereotype.name=Nom -report.detail.stereotype.description=Description -report.detail.stereotype.target=Cible(s) -report.detail.target.model=sur un mod\u00E8le -report.detail.target.package=sur un paquetage -report.detail.target.classifier=sur un classifier -report.detail.target.class=sur une classe -report.detail.target.interface=sur une interface -report.detail.target.enumeration=sur une \u00E9numeration -report.detail.target.attribute=sur un attribut -report.detail.target.parameter=sur un param\u00E8tre -report.detail.target.operation=sur une op\u00E9ration -report.detail.target.element=sur un \u00E9l\u00E9ment -report.detail.stereotype.usage.title=Utilisation -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository eugene. See https://gitlab.nuiton.org/nuiton/eugene.git commit 47256d50f0c07e370da2c2eaf75c99544d86077e Author: Tony CHEMIT <chemit@codelutin.com> Date: Sat Oct 8 16:20:57 2016 +0200 review tag value report --- .../org/nuiton/eugene/plugin/TagValuesReport.java | 111 ++++++- .../plugin/renderer/TagValuesReportRenderer.java | 359 ++++++++++++++++----- .../main/resources/tag-values-report.properties | 3 +- .../main/resources/tag-values-report_fr.properties | 2 +- 4 files changed, 382 insertions(+), 93 deletions(-) diff --git a/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/TagValuesReport.java b/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/TagValuesReport.java index fef45e5..6b3c775 100644 --- a/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/TagValuesReport.java +++ b/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/TagValuesReport.java @@ -22,14 +22,20 @@ package org.nuiton.eugene.plugin; * #L% */ +import org.apache.maven.doxia.siterenderer.Renderer; import org.apache.maven.plugins.annotations.Component; import org.apache.maven.plugins.annotations.Mojo; import org.apache.maven.plugins.annotations.Parameter; import org.apache.maven.plugins.annotations.ResolutionScope; +import org.apache.maven.project.MavenProject; +import org.apache.maven.reporting.AbstractMavenReport; import org.apache.maven.reporting.MavenReportException; +import org.codehaus.plexus.i18n.I18N; import org.nuiton.eugene.models.extension.tagvalue.provider.TagValueMetadatasProvider; import org.nuiton.eugene.plugin.renderer.TagValuesReportRenderer; +import java.io.File; +import java.util.Collection; import java.util.Locale; import java.util.Map; @@ -41,9 +47,8 @@ import java.util.Map; * @author Tony Chemit - chemit@codelutin.com * @since 2.10 */ -@Mojo(name = "tag-values-report", requiresProject = true, requiresReports = true, - requiresDependencyResolution = ResolutionScope.COMPILE) -public class TagValuesReport extends AbstractEugeneReport<TagValueMetadatasProvider> { +@Mojo(name = "tag-values-report", requiresReports = true, requiresDependencyResolution = ResolutionScope.COMPILE) +public class TagValuesReport extends AbstractMavenReport { /** * Name of the tagValue provider. @@ -53,30 +58,110 @@ public class TagValuesReport extends AbstractEugeneReport<TagValueMetadatasProvi @Parameter(property = "eugene.providerName", defaultValue = "${project.artifactId}", required = true) protected String providerName; + /** + * Report output directory. Note that this parameter is only relevant if the goal is run from the command line or + * from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output + * directory configured in the Maven Site Plugin is used instead. + */ + @Parameter(property = "config.outputDirectory", + defaultValue = "${project.reporting.outputDirectory}", + required = true) + protected File outputDirectory; + + /** + * Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or + * from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output + * encoding configured in the Maven Site Plugin is used instead. + */ + @Parameter(property = "config.outputEncoding", + defaultValue = "${project.reporting.outputEncoding}", + required = true) + protected String outputEncoding; + + /** + * Skip to generate the report. + */ + @Parameter(property = "config.skip") + protected boolean skip; + + /** + * Location of javadoc report. + */ + @Parameter(property = "eugene.javaDocDestDir", defaultValue = "apidocs") + protected String javaDocDestDir; + + /** + * Location of xref report. + */ + @Parameter(property = "eugene.jxrDestDir", defaultValue = "xref") + protected String jxrDestDir; + + /** + * The Maven Project. + */ + @Parameter(defaultValue = "${project}", readonly = true) + protected MavenProject project; + + /** + * Doxia Site Renderer component. + */ + @Component + protected Renderer siteRenderer; + + /** + * Internationalization component. + */ + @Component + protected I18N i18n; + @Component(role = TagValueMetadatasProvider.class) protected Map<String, TagValueMetadatasProvider> providers; + @Override - protected TagValueMetadatasProvider initData(Locale locale) throws MavenReportException { + public String getDescription(Locale locale) { + return i18n.getString(getOutputName(), locale, "report.description"); + } - TagValueMetadatasProvider provider = providers.get(providerName); - if (provider == null) { + @Override + public String getName(Locale locale) { + return i18n.getString(getOutputName(), locale, "report.title"); + } - String errorMessage = i18n.format(getOutputName(), locale, "tagValueProvider.not.found", providerName); - throw new MavenReportException(errorMessage); + @Override + public String getCategoryName() { + return CATEGORY_PROJECT_REPORTS; + } - } + @Override + public boolean canGenerateReport() { + return !skip; + } - return provider; + @Override + protected Renderer getSiteRenderer() { + return siteRenderer; + } + @Override + protected String getOutputDirectory() { + return outputDirectory.getAbsolutePath(); } @Override - protected TagValuesReportRenderer createRenderer(Locale locale, TagValueMetadatasProvider data) { + protected MavenProject getProject() { + return project; + } + + @Override + protected void executeReport(Locale locale) throws MavenReportException { + + Collection<TagValueMetadatasProvider> providers = this.providers.values(); - return new TagValuesReportRenderer( - getSink(), i18n, locale, getOutputName(), javaDocDestDir, jxrDestDir, data); + TagValuesReportRenderer reportRenderer = new TagValuesReportRenderer( + getSink(), i18n, locale, getOutputName(), javaDocDestDir, jxrDestDir, providers); + reportRenderer.render(); } diff --git a/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/renderer/TagValuesReportRenderer.java b/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/renderer/TagValuesReportRenderer.java index 1e502e8..6c7ab56 100644 --- a/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/renderer/TagValuesReportRenderer.java +++ b/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/renderer/TagValuesReportRenderer.java @@ -24,10 +24,23 @@ package org.nuiton.eugene.plugin.renderer; import org.apache.commons.collections4.CollectionUtils; import org.apache.maven.doxia.sink.Sink; +import org.apache.maven.doxia.sink.SinkEventAttributes; +import org.apache.maven.reporting.AbstractMavenReportRenderer; import org.codehaus.plexus.i18n.I18N; import org.nuiton.eugene.models.extension.tagvalue.TagValueMetadata; import org.nuiton.eugene.models.extension.tagvalue.provider.TagValueMetadatasProvider; - +import org.nuiton.eugene.models.object.ObjectModel; +import org.nuiton.eugene.models.object.ObjectModelAttribute; +import org.nuiton.eugene.models.object.ObjectModelClass; +import org.nuiton.eugene.models.object.ObjectModelClassifier; +import org.nuiton.eugene.models.object.ObjectModelElement; +import org.nuiton.eugene.models.object.ObjectModelEnumeration; +import org.nuiton.eugene.models.object.ObjectModelInterface; +import org.nuiton.eugene.models.object.ObjectModelOperation; +import org.nuiton.eugene.models.object.ObjectModelPackage; +import org.nuiton.eugene.models.object.ObjectModelParameter; + +import java.util.Collection; import java.util.Locale; import java.util.Set; @@ -37,52 +50,74 @@ import java.util.Set; * @author Tony Chemit - chemit@codelutin.com * @since 2.10 */ -public class TagValuesReportRenderer extends AbstractEugeneReportRenderer<TagValueMetadatasProvider, TagValueMetadata> { +public class TagValuesReportRenderer extends AbstractMavenReportRenderer { - public TagValuesReportRenderer(Sink sink, - I18N i18n, - Locale locale, - String bundleName, - String javaDocDestDir, - String jxrDestDir, - TagValueMetadatasProvider data) { - super(sink, i18n, locale, bundleName, javaDocDestDir, jxrDestDir, data); - } + /** + * Internationalization component. + */ + protected final I18N i18n; - @Override - protected Set<TagValueMetadata> getDataDetails() { - return data.getTagValues(); - } + /** + * The locale we are rendering for. + */ + protected final Locale locale; + + /** + * The name of the bundle containing our I18n resources. + */ + protected final String bundleName; + + /** + * Data to describe. + */ + protected final Collection<TagValueMetadatasProvider> data; + + protected final String javaDocDestDir; @Override - protected String getProviderDescription(TagValueMetadatasProvider data) { - return data.getDescription(); + public String getTitle() { + return getText("report.title"); } @Override - protected void renderSummaryTable(TagValueMetadatasProvider provider, Set<TagValueMetadata> details) { - - sink.section2(); + public void renderBody() { - sink.sectionTitle2(); - sink.text(getText("report.provider.tagvalue.name")); - sink.text(provider.getDescription()); - sink.sectionTitle2_(); + sink.section1(); + sink.sectionTitle1(); + sink.text(getText("report.overview.title")); + sink.sectionTitle1_(); - if (CollectionUtils.isEmpty(details)) { + sink.paragraph(); + sink.link(getEugeneDocLink()); + sink.text(getText("report.overview.more.information")); + sink.link_(); + sink.paragraph_(); - sink.text(getText("report.noTagValues")); + for (TagValueMetadatasProvider provider : data) { - } else { - - sink.section3(); + String implementation = provider.getClass().getName(); - sink.sectionTitle3(); - sink.text(getText("report.summary.tagValues")); - sink.sectionTitle3_(); + sink.section2(); + sink.sectionTitle2(); + sink.text(provider.getDescription()); + sink.sectionTitle2_(); sink.lineBreak(); + sink.paragraph(); + sink.bold(); + sink.text(implementation); + sink.bold_(); + sink.text(" "); + sink.link("./" + javaDocDestDir + "/" + implementation.replace('.', '/') + ".html"); + sink.text("javadoc"); + sink.link_(); + sink.link("./" + jxrDestDir + "/" + implementation.replace('.', '/') + ".html"); + sink.text(" "); + sink.text("xref"); + sink.link_(); + sink.text("."); + sink.paragraph_(); sink.table(); @@ -91,7 +126,7 @@ public class TagValuesReportRenderer extends AbstractEugeneReportRenderer<TagVal sinkHeaderCellText(getText("report.tagValue.description")); sink.tableRow_(); - for (TagValueMetadata entry : details) { + for (TagValueMetadata entry : provider.getTagValues()) { String tagValueName = entry.getName(); @@ -104,72 +139,118 @@ public class TagValuesReportRenderer extends AbstractEugeneReportRenderer<TagVal sink.table_(); - sink.section3_(); + sink.section2_(); } - sink.section2_(); - } + sink.section1(); + sink.sectionTitle1(); + sink.text(getText("report.overview.detail")); + sink.sectionTitle1_(); - @Override - protected void renderDetail(TagValueMetadata detail) { + for (TagValueMetadatasProvider provider : data) { - sink.section2(); - sink.sectionTitle2(); - sink.anchor("detail_" + detail.getName()); - sink.text(getText("report.detail.tagValue.title") + " " + detail.getName()); - sink.anchor_(); - sink.sectionTitle2_(); + if (CollectionUtils.isNotEmpty(provider.getTagValues())) { - sink.lineBreak(); + sink.section2(); - sink.table(); + sink.sectionTitle2(); + sink.text(getText("report.detail.title")); + sink.sectionTitle2_(); - sink.tableRow(); - sinkHeaderCellText(getText("report.detail.tagValue.name")); - sinkCellText(detail.getName()); - sink.tableRow_(); + sink.lineBreak(); - sink.tableRow(); - sinkHeaderCellText(getText("report.detail.tagValue.description")); - sinkCellText(detail.getDescription()); - sink.tableRow_(); + sink.paragraph(); + sink.text(getText("report.detail.text")); + sink.paragraph_(); - sink.tableRow(); - sinkHeaderCellText(getText("report.detail.tagValue.defaultValue")); - sinkCellText(detail.getDefaultValue()); - sink.tableRow_(); + for (TagValueMetadata detail : provider.getTagValues()) { - sink.tableRow(); - sinkHeaderCellText(getText("report.detail.tagValue.matcherClass")); - sinkCellText(detail.getMatcherClass().getName()); - sink.tableRow_(); + sink.section2(); + sink.sectionTitle2(); + sink.anchor("detail_" + detail.getName()); + sink.text(getText("report.detail.tagValue.title") + " " + detail.getName()); + sink.anchor_(); + sink.sectionTitle2_(); - sink.tableRow(); - sinkHeaderCellText(getText("report.detail.tagValue.target")); - sink.tableCell(); + sink.lineBreak(); - renderTargets(detail.getTargets()); + sink.table(); - sink.tableCell_(); - sink.tableRow_(); + sink.tableRow(); + sinkHeaderCellText(getText("report.detail.tagValue.name")); + sinkCellText(detail.getName()); + sink.tableRow_(); + + sink.tableRow(); + sinkHeaderCellText(getText("report.detail.tagValue.description")); + sinkCellText(detail.getDescription()); + sink.tableRow_(); + + sink.tableRow(); + sinkHeaderCellText(getText("report.detail.tagValue.defaultValue")); + sinkCellText(detail.getDefaultValue()); + sink.tableRow_(); + + sink.tableRow(); + sinkHeaderCellText(getText("report.detail.tagValue.matcherClass")); + sinkCellText(detail.getMatcherClass().getName()); + sink.tableRow_(); + + sink.tableRow(); + sinkHeaderCellText(getText("report.detail.tagValue.target")); + sink.tableCell(); + + renderTargets(detail.getTargets()); + + sink.tableCell_(); + sink.tableRow_(); + + sink.table_(); + + sink.section3(); + sink.sectionTitle3(); + sink.text(getText("report.detail.tagValue.usage.title")); + sink.sectionTitle3_(); - sink.table_(); + sink.text("//TODO Example of usage of this tag value"); - sink.section3(); - sink.sectionTitle3(); - sink.text(getText("report.detail.tagValue.usage.title")); - sink.sectionTitle3_(); + sink.section3_(); - sink.text("//TODO Example of usage of this tag value"); + sink.section2_(); - sink.section3_(); + } - sink.section2_(); + sink.section2_(); + + } + + } + + sink.section1_(); } - @Override + protected final String jxrDestDir; + + public TagValuesReportRenderer(Sink sink, + I18N i18n, + Locale locale, + String bundleName, + String javaDocDestDir, + String jxrDestDir, + Collection<TagValueMetadatasProvider> data) { + super(sink); + this.i18n = i18n; + this.locale = locale; + this.bundleName = bundleName; + this.javaDocDestDir = javaDocDestDir; + this.jxrDestDir = jxrDestDir; + this.data = data; + this.sink = sink; + } + + protected String getEugeneDocLink() { String url; @@ -184,4 +265,128 @@ public class TagValuesReportRenderer extends AbstractEugeneReportRenderer<TagVal } + /** + * Gets the localized message for this report. + * + * @param key the message key. + * @return the message. + */ + protected String getText(String key) { + return i18n.getString(bundleName, locale, key); + } + + protected void sinkHeaderCellText(String text) { + sink.tableHeaderCell(); + sink.text(text); + sink.tableHeaderCell_(); + } + + protected void sinkHeaderCellText(SinkEventAttributes width, String text) { + sink.tableHeaderCell(width); + sink.text(text); + sink.tableHeaderCell_(); + } + + protected void sinkCellText(SinkEventAttributes width, String text) { + sink.tableCell(width); + sink.text(text); + sink.tableCell_(); + } + + protected void sinkCellText(String text) { + sink.tableCell(); + sink.text(text); + sink.tableCell_(); + } + + protected void sinkCellLink(String text, String url) { + sink.tableCell(); + sink.link(url); + sink.text(text); + sink.link_(); + sink.tableCell_(); + } + + protected void renderTargets(Set<Class<?>> targets) { + + boolean moreThanOne = targets.size() > 1; + + if (moreThanOne) { + + sink.list_(); + + } + + for (Class<?> target : targets) { + + if (moreThanOne) { + + sink.listItem(); + + } + + renderDetailTarget(target); + + if (moreThanOne) { + + sink.listItem_(); + + } + + } + + if (moreThanOne) { + + sink.list_(); + + } + + } + + protected void renderDetailTarget(Class<?> target) { + + if (ObjectModel.class.isAssignableFrom(target)) { + + sink.text(getText("report.detail.target.model")); + + } else if (ObjectModelPackage.class.isAssignableFrom(target)) { + + sink.text(getText("report.detail.target.package")); + + } else if (ObjectModelClassifier.class.isAssignableFrom(target)) { + + sink.text(getText("report.detail.target.classifier")); + + } else if (ObjectModelClass.class.isAssignableFrom(target)) { + + sink.text(getText("report.detail.target.class")); + + } else if (ObjectModelInterface.class.isAssignableFrom(target)) { + + sink.text(getText("report.detail.target.interface")); + + } else if (ObjectModelEnumeration.class.isAssignableFrom(target)) { + + sink.text(getText("report.detail.target.enumeration")); + + } else if (ObjectModelAttribute.class.isAssignableFrom(target)) { + + sink.text(getText("report.detail.target.attribute")); + + } else if (ObjectModelParameter.class.isAssignableFrom(target)) { + + sink.text(getText("report.detail.target.parameter")); + + } else if (ObjectModelOperation.class.isAssignableFrom(target)) { + + sink.text(getText("report.detail.target.operation")); + + } else if (ObjectModelElement.class.isAssignableFrom(target)) { + + sink.text(getText("report.detail.target.element")); + + } + + } + } diff --git a/eugene-maven-plugin/src/main/resources/tag-values-report.properties b/eugene-maven-plugin/src/main/resources/tag-values-report.properties index 848bd19..c5c0913 100644 --- a/eugene-maven-plugin/src/main/resources/tag-values-report.properties +++ b/eugene-maven-plugin/src/main/resources/tag-values-report.properties @@ -24,8 +24,7 @@ report.description=Provides details of tag values available in a given class report.overview.title=Overview report.overview.text=This report summarizes all tag values available ith the class report.overview.more.information=More information about Tag values in EUGene -tagValueProvider.not.found=Could not find tag value provider named ''{0}'' - +report.overview.detail=Details of all tag values report.detail.title=Detail of tag values report.detail.text=We give details of each tag value diff --git a/eugene-maven-plugin/src/main/resources/tag-values-report_fr.properties b/eugene-maven-plugin/src/main/resources/tag-values-report_fr.properties index f75f9f0..d78e7d4 100644 --- a/eugene-maven-plugin/src/main/resources/tag-values-report_fr.properties +++ b/eugene-maven-plugin/src/main/resources/tag-values-report_fr.properties @@ -25,7 +25,7 @@ report.overview.title=Pr\u00E9ambule report.overview.text=Ce rapport d\u00E9crit les tag values d\u00E9finies dans la classe tagValueProvider.not.found=Impossible de trouver le tag value prodiver nomm\u00E9 ''{0}'' report.overview.more.information=Pour plus d'informations sur les Tag values dans EUGene - +report.overview.detail=D\u00E9tail de tous les tag values report.detail.title=D\u00E9tail des tag values report.detail.text=On d\u00E9taille ici chaque tag value -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository eugene. See https://gitlab.nuiton.org/nuiton/eugene.git commit c0558f4429e989ef707cfb55305d161455fd1493 Author: Tony CHEMIT <chemit@codelutin.com> Date: Sat Oct 8 16:21:01 2016 +0200 review doc --- eugene/src/site/fr/rst/stereotypes.rst.vm | 61 +++++-------------------------- eugene/src/site/fr/rst/tagValues.rst.vm | 8 ++-- eugene/src/site/rst/stereotypes.rst.vm | 61 +++++-------------------------- eugene/src/site/rst/tagValues.rst.vm | 14 ++++--- 4 files changed, 31 insertions(+), 113 deletions(-) diff --git a/eugene/src/site/fr/rst/stereotypes.rst.vm b/eugene/src/site/fr/rst/stereotypes.rst.vm index 53e4152..7056ddf 100644 --- a/eugene/src/site/fr/rst/stereotypes.rst.vm +++ b/eugene/src/site/fr/rst/stereotypes.rst.vm @@ -5,8 +5,6 @@ Stereotypes :Authors: Tony CHEMIT :Contact: chemit@codelutin.com -:Revision: $Revision$ -:Date: $Date$ .. contents:: @@ -65,58 +63,19 @@ Have a look for example to the report for the `eugene core api`_ or `java templa How to write stereotypes ======================== -This section describe how to write safe stereotype using the EUGene stereotype API. +Stereotypes are now parts of the EUGene tag value API. + +Stereotype is a boolean tag value, so you can also write it like a tag value with **false** or **true** values. + +One advantage of this is to be able to set a stereotype at high level and then skip his usage for a specific child +which you could not do using a standalone stereotype mecanism. See `JavaDocs API`_ or `API Sources`_ for more details. -Once this is done, use the `EUGene stereotypes-report`_ to expose them in your site:: - - <build> - - <plugins> - - <plugin> - <groupId>org.nuiton.eugene</groupId> - <artifactId>eugene-maven-plugin</artifactId> - <version>${project.version}</version> - <dependencies> - <!-- To make your stereotypes and tag values available in the report plugin --> - <dependency> - <groupId>\${project.groupId}</groupId> - <artifactId>\${project.artifactId}</artifactId> - <version>\${project.version}</version> - </dependency> - </dependencies> - </plugin> - - </plugins> - </build> - - ... - - <reporting> - <plugins> - - <plugin> - <groupId>org.nuiton.eugene</groupId> - <artifactId>eugene-maven-plugin</artifactId> - <reportSets> - <reportSet> - <reports> - <report>stereotypes-report</report> - </reports> - </reportSet> - </reportSets> - </plugin> - - </plugins> - </reporting> - -.. _eugene core api: ./stereotypes-report.html -.. _java templates: ../eugene-java-templates/stereotypes-report.html -.. _JavaDocs API: ./apidocs/index.html?org/nuiton/eugene/models/stereotype/package-summary.html -.. _API Sources: ./xref/org/nuiton/eugene/models/stereotype/package-summary.html -.. _EUGene stereotypes-report: ../eugene-maven-plugin/stereotypes-report-mojo.html +.. _eugene core api: ./tag-values-report.html +.. _java templates: ../eugene-java-templates/tag-values-report.html +.. _JavaDocs API: ./apidocs/index.html?org/nuiton/eugene/models/extension/tagvalue/package-summary.html +.. _API Sources: ./xref/org/nuiton/eugene/models/extension/tagvalue/package-summary.html diff --git a/eugene/src/site/fr/rst/tagValues.rst.vm b/eugene/src/site/fr/rst/tagValues.rst.vm index fc66e4b..cf2e882 100644 --- a/eugene/src/site/fr/rst/tagValues.rst.vm +++ b/eugene/src/site/fr/rst/tagValues.rst.vm @@ -5,8 +5,6 @@ Tag values :Authors: Tony CHEMIT :Contact: chemit@codelutin.com -:Revision: $Revision: 1349 $ -:Date: $Date: 2014-05-04 12:58:54 +0200 (Sun, 04 May 2014) $ .. contents:: @@ -73,7 +71,7 @@ Once this is done, use the `EUGene tag-values-report`_ to expose them in your si <plugins> <plugin> - <groupId>org.nuiton.eugene</groupId> + <groupId>${project.groupId}</groupId> <artifactId>eugene-maven-plugin</artifactId> <version>${project.version}</version> <dependencies> @@ -111,6 +109,6 @@ Once this is done, use the `EUGene tag-values-report`_ to expose them in your si .. _eugene core api: ./tag-values-report.html .. _java templates: ../eugene-java-templates/tag-values-report.html -.. _JavaDocs API: ./apidocs/index.html?org/nuiton/eugene/models/tagvalue/package-summary.html -.. _API Sources: ./xref/org/nuiton/eugene/models/tagvalue/package-summary.html +.. _JavaDocs API: ./apidocs/index.html?org/nuiton/eugene/models/textension/agvalue/package-summary.html +.. _API Sources: ./xref/org/nuiton/eugene/models/textension/tagvalue/package-summary.html .. _EUGene tag-values-report: ../eugene-maven-plugin/tag-values-report-mojo.html \ No newline at end of file diff --git a/eugene/src/site/rst/stereotypes.rst.vm b/eugene/src/site/rst/stereotypes.rst.vm index 6d3319b..7056ddf 100644 --- a/eugene/src/site/rst/stereotypes.rst.vm +++ b/eugene/src/site/rst/stereotypes.rst.vm @@ -5,8 +5,6 @@ Stereotypes :Authors: Tony CHEMIT :Contact: chemit@codelutin.com -:Revision: $Revision: 1349 $ -:Date: $Date: 2014-05-04 12:58:54 +0200 (Sun, 04 May 2014) $ .. contents:: @@ -65,58 +63,19 @@ Have a look for example to the report for the `eugene core api`_ or `java templa How to write stereotypes ======================== -This section describe how to write safe stereotype using the EUGene stereotype API. +Stereotypes are now parts of the EUGene tag value API. + +Stereotype is a boolean tag value, so you can also write it like a tag value with **false** or **true** values. + +One advantage of this is to be able to set a stereotype at high level and then skip his usage for a specific child +which you could not do using a standalone stereotype mecanism. See `JavaDocs API`_ or `API Sources`_ for more details. -Once this is done, use the `EUGene stereotypes-report`_ to expose them in your site:: - - <build> - - <plugins> - - <plugin> - <groupId>org.nuiton.eugene</groupId> - <artifactId>eugene-maven-plugin</artifactId> - <version>${project.version}</version> - <dependencies> - <!-- To make your stereotypes and tag values available in the report plugin --> - <dependency> - <groupId>\${project.groupId}</groupId> - <artifactId>\${project.artifactId}</artifactId> - <version>\${project.version}</version> - </dependency> - </dependencies> - </plugin> - - </plugins> - </build> - - ... - - <reporting> - <plugins> - - <plugin> - <groupId>org.nuiton.eugene</groupId> - <artifactId>eugene-maven-plugin</artifactId> - <reportSets> - <reportSet> - <reports> - <report>stereotypes-report</report> - </reports> - </reportSet> - </reportSets> - </plugin> - - </plugins> - </reporting> - -.. _eugene core api: ./stereotypes-report.html -.. _java templates: ../eugene-java-templates/stereotypes-report.html -.. _JavaDocs API: ./apidocs/index.html?org/nuiton/eugene/models/stereotype/package-summary.html -.. _API Sources: ./xref/org/nuiton/eugene/models/stereotype/package-summary.html -.. _EUGene stereotypes-report: ../eugene-maven-plugin/stereotypes-report-mojo.html +.. _eugene core api: ./tag-values-report.html +.. _java templates: ../eugene-java-templates/tag-values-report.html +.. _JavaDocs API: ./apidocs/index.html?org/nuiton/eugene/models/extension/tagvalue/package-summary.html +.. _API Sources: ./xref/org/nuiton/eugene/models/extension/tagvalue/package-summary.html diff --git a/eugene/src/site/rst/tagValues.rst.vm b/eugene/src/site/rst/tagValues.rst.vm index 1108250..540b36e 100644 --- a/eugene/src/site/rst/tagValues.rst.vm +++ b/eugene/src/site/rst/tagValues.rst.vm @@ -5,8 +5,6 @@ Tag values :Authors: Tony CHEMIT :Contact: chemit@codelutin.com -:Revision: $Revision: 1349 $ -:Date: $Date: 2014-05-04 12:58:54 +0200 (Sun, 04 May 2014) $ .. contents:: @@ -43,7 +41,6 @@ We describe here the format of a tag value when written in the *model properties model.tagvalue.myTagValueKey=myTagValueValue - - On a specific element of the model :: @@ -65,6 +62,11 @@ How to write tag values This section describe how to write safe tag values using the EUGene tag values API. +You need to define a provider of tag values in a new class: + +:: + + See `JavaDocs API`_ or `API Sources`_ for more details. Once this is done, use the `EUGene tag-values-report`_ to expose them in your site:: @@ -74,7 +76,7 @@ Once this is done, use the `EUGene tag-values-report`_ to expose them in your si <plugins> <plugin> - <groupId>org.nuiton.eugene</groupId> + <groupId>${project.groupId}</groupId> <artifactId>eugene-maven-plugin</artifactId> <version>${project.version}</version> <dependencies> @@ -112,6 +114,6 @@ Once this is done, use the `EUGene tag-values-report`_ to expose them in your si .. _eugene core api: ./tag-values-report.html .. _java templates: ../eugene-java-templates/tag-values-report.html -.. _JavaDocs API: ./apidocs/index.html?org/nuiton/eugene/models/tagvalue/package-summary.html -.. _API Sources: ./xref/org/nuiton/eugene/models/tagvalue/package-summary.html +.. _JavaDocs API: ./apidocs/index.html?org/nuiton/eugene/models/textension/agvalue/package-summary.html +.. _API Sources: ./xref/org/nuiton/eugene/models/textension/tagvalue/package-summary.html .. _EUGene tag-values-report: ../eugene-maven-plugin/tag-values-report-mojo.html \ No newline at end of file -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository eugene. See https://gitlab.nuiton.org/nuiton/eugene.git commit bfd0dddf551ee3d89a52128c58f7f69265390820 Author: Tony CHEMIT <chemit@codelutin.com> Date: Sat Oct 8 16:26:22 2016 +0200 fix renderer typo --- .../nuiton/eugene/plugin/renderer/TagValuesReportRenderer.java | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/renderer/TagValuesReportRenderer.java b/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/renderer/TagValuesReportRenderer.java index 6c7ab56..109f9d1 100644 --- a/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/renderer/TagValuesReportRenderer.java +++ b/eugene-maven-plugin/src/main/java/org/nuiton/eugene/plugin/renderer/TagValuesReportRenderer.java @@ -155,15 +155,9 @@ public class TagValuesReportRenderer extends AbstractMavenReportRenderer { sink.section2(); sink.sectionTitle2(); - sink.text(getText("report.detail.title")); + sink.text(getText("report.detail.title") + provider.getDescription()); sink.sectionTitle2_(); - - sink.lineBreak(); - - sink.paragraph(); - sink.text(getText("report.detail.text")); - sink.paragraph_(); - + for (TagValueMetadata detail : provider.getTagValues()) { sink.section2(); -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.
participants (1)
-
nuiton.org scm