Author: chatellier Date: 2009-02-05 17:30:06 +0000 (Thu, 05 Feb 2009) New Revision: 254 Modified: maven-jrst-plugin/trunk/changelog.txt maven-jrst-plugin/trunk/pom.xml maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/GenerationJRstException.java maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/JRstPlugin.java maven-jrst-plugin/trunk/src/site/fr/rst/index.rst Log: Set default locale to 'en' Remove some required setting for parameter with default values Write javadoc in english Modified: maven-jrst-plugin/trunk/changelog.txt =================================================================== --- maven-jrst-plugin/trunk/changelog.txt 2009-01-16 18:21:20 UTC (rev 253) +++ maven-jrst-plugin/trunk/changelog.txt 2009-02-05 17:30:06 UTC (rev 254) @@ -1,3 +1,8 @@ +ver-0-8-4 chatellier 200902xx + * 20090205 Set default locale to 'en' + * 20090205 Remove some required setting for parameter with default values + * 20090205 Write javadoc in english + ver-0-8-3 thimel 200810XX * 20081008 [chemit] refactor plugin to generate ony when required * 20081008 [chemit] Using lutinpluginproject 3.0 in a better way :) Modified: maven-jrst-plugin/trunk/pom.xml =================================================================== --- maven-jrst-plugin/trunk/pom.xml 2009-01-16 18:21:20 UTC (rev 253) +++ maven-jrst-plugin/trunk/pom.xml 2009-02-05 17:30:06 UTC (rev 254) @@ -36,7 +36,7 @@ <name>Maven JRST Plugin</name> <version>0.8.4-SNAPSHOT</version> <description> - Plugin pour maven2 pour la génération de xdoc à partir de fichiers RST. + Maven2 plugin to generate reStructuredText file into xDoc. </description> <inceptionYear>2006</inceptionYear> @@ -54,6 +54,7 @@ <!-- Site en et fr --> <maven.site.locales>fr,en</maven.site.locales> + <jrst.version>0.8.4-SNAPSHOT</jrst.version> </properties> <!-- ************************************************************* --> Modified: maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/GenerationJRstException.java =================================================================== --- maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/GenerationJRstException.java 2009-01-16 18:21:20 UTC (rev 253) +++ maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/GenerationJRstException.java 2009-02-05 17:30:06 UTC (rev 254) @@ -1,5 +1,5 @@ /* *##% Plugin maven JRst - * Copyright (C) 2006 - 2008 CodeLutin + * Copyright (C) 2006 - 2009 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 @@ -15,22 +15,10 @@ * License along with this program. If not, see * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%*/ -/* * - * GenerationJRstException.java - * - * Created: 14 avril 2006 - * - * @author ruchaud - * @version $Revision$ - * - * Last update: $Date$ - * by : $Author$ - */ - package org.codelutin.jrst.plugin; /** - * GenerationJRstException + * GenerationJRstException. * * @author ruchaud * @version $Revision$ @@ -42,9 +30,9 @@ /** serialVersionUID */ private static final long serialVersionUID = 7121169280356405413L; - - static private String filesErrors = ""; + protected static String filesErrors = ""; + public GenerationJRstException(String fileIn) { filesErrors += fileIn + "\n"; } Modified: maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/JRstPlugin.java =================================================================== --- maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/JRstPlugin.java 2009-01-16 18:21:20 UTC (rev 253) +++ maven-jrst-plugin/trunk/src/main/java/org/codelutin/jrst/plugin/JRstPlugin.java 2009-02-05 17:30:06 UTC (rev 254) @@ -1,5 +1,5 @@ /* *##% Plugin maven JRst - * Copyright (C) 2006 - 2008 CodeLutin + * Copyright (C) 2006 - 2009 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 @@ -15,18 +15,6 @@ * License along with this program. If not, see * <http://www.gnu.org/licenses/lgpl-3.0.html>. ##%*/ -/* * - * JRstPlugin.java - * - * Created: 14 avril 2006 - * - * @author ruchaud - * @version $Revision$ - * - * Last update: $Date$ - * by : $Author$ - */ - package org.codelutin.jrst.plugin; import org.apache.maven.plugin.AbstractMojo; @@ -58,111 +46,125 @@ * * @goal jrst * @phase pre-site + * + * Created: 14 avril 2006 + * + * @author ruchaud + * @version $Revision$ + * + * Last update: $Date$ + * by : $Author$ */ public class JRstPlugin extends AbstractMojo { - /** La liste des ressource a copier si rien n'est specifie via la propriete includeResources */ + /** + * Default copy patterns if {@link #includeResources} + * is <tt>null</tt>. + */ protected static final String[] DEFAULT_INCLUDE_RESOURCES = { - "**\\/*.png", - "**\\/*.jpeg", - "**\\/*.jpg", - "**\\/*.gif" + "**\\/*.png", + "**\\/*.jpeg", + "**\\/*.jpg", + "**\\/*.gif" }; - /** - * Répertoire source des fichiers Rst + * Site source directory. * * @parameter default-value="src/site" - * @required + * @since 0.8 */ protected File directoryIn; /** - * Encoding en entrée + * Site source encoding. * * @parameter default-value="UTF-8" + * @since 0.8 */ protected String inputEncoding = "UTF-8"; /** - * Encoding en sortie + * Site generated directory. * - * @parameter default-value="UTF-8" + * @parameter default-value="target/generated-site" + * @since 0.8 */ - protected String outputEncoding = "UTF-8"; - + protected File directoryOut; + /** - * Répertoire cible des fichiers xdoc générée + * Site generated encoding. * - * @parameter default-value="target/generated-site" - * @required + * @parameter default-value="UTF-8" + * @since 0.8 */ - protected File directoryOut; + protected String outputEncoding = "UTF-8"; /** - * Répertoire cible des fichiers resources générée + * Copied resource destination directory. * * @parameter default-value="target/generated-site/resources" - * @required + * @since 0.8 */ protected File resourceDirectoryOut; /** - * Arréte la génération en cas d'erreurs + * Ignore errors. * * @parameter default-value="true" + * @since 0.8 */ protected boolean ignoreErrors = true; /** - * Ecrase les fichiers générés + * Overwrite already existing generated files. * * @parameter default-value="ifnewer" + * @since 0.8 */ protected String overwrite = "ifnewer"; /** - * La locale par defaut a utiliser. + * Default locale for generated files structure. * - * @parameter default-value="fr" + * @parameter default-value="en" + * @since 0.8 */ - protected String defaultLocale = "fr"; + protected String defaultLocale = "en"; /** - * Permet d'obtenir plus d'information + * Verbose. * - * @parameter expression="${jrst.verbose}" default-value="${maven.verbose}" + * @parameter default-value="${maven.verbose}" expression="${jrst.verbose}" + * @since 0.8 */ protected boolean verbose; /** - * Flag pour forcer la generation des rst et la copie des resources. + * Overwrite resources. * - * @parameter expression="${jrst.force}" default-value="false" + * @parameter default-value="false" expression="${jrst.force}" + * @since 0.8 */ protected boolean force; /** - * La liste des ressources a recopier + * Resources patterns to copy. * * @parameter expression="${jrst.includeResources}" + * @since 0.8.3 */ protected String[] includeResources; /** Number of generated files. */ protected int numberFilesGenerates; - /** - * Retourne la langue par defaut precisé dans le pom.xml - * - * @return la langue par defaut precisé dans le pom.xml + /** + * Get overwrite. + * + * @see JRST.Overwrite + * @return the overwrite */ - protected String getDefaultLocale() { - return defaultLocale; - } - - /** @return the overwrite */ public JRST.Overwrite getOverwrite() { JRST.Overwrite result = JRST.Overwrite.NEVER; if (this.overwrite.contains("new")) { @@ -174,28 +176,33 @@ return result; } + /** + * Execute mojo. + */ public void execute() throws MojoExecutionException { try { actionGenerate(); } catch (GenerationJRstException e) { - getLog().error("Error during generation for :\n" - + GenerationJRstException.getFilesErrors()); + getLog().error( + "Error during generation for :\n" + + GenerationJRstException.getFilesErrors()); if (!ignoreErrors) { - throw new MojoExecutionException("Erreur lors de l'execution"); + throw new MojoExecutionException("Error during generation"); } } actionCopy(); } - private void actionGenerate() { - getLog().info("Génération des fichier xdocs à partir des fichiers rst"); + protected void actionGenerate() { + getLog().info("Generating reStructuredText files into xDoc"); - MirroredFileUpdater rstUpdater = new RstUpdater(directoryIn, directoryOut, defaultLocale); - + MirroredFileUpdater rstUpdater = new RstUpdater(directoryIn, + directoryOut, defaultLocale); + numberFilesGenerates = 0; DirectoryScanner ds = new DirectoryScanner(); ds.setBasedir(directoryIn); - ds.setIncludes(new String[]{"**\\/*.rst"}); + ds.setIncludes(new String[] { "**\\/*.rst" }); ds.scan(); String[] files = ds.getIncludedFiles(); @@ -204,7 +211,7 @@ if (!force && rstUpdater.isFileUpToDate(in)) { if (verbose) { - getLog().info("skip up-to-date rst file : " + in); + getLog().info("Skip up-to-date reStructuredText file : " + in); } continue; } @@ -212,7 +219,8 @@ doAction(in, rstUpdater.getMirrorFile(in)); } - getLog().info("Generating " + numberFilesGenerates + " files to " + directoryOut); + getLog().info("Generating " + numberFilesGenerates + " files to " + + directoryOut); } public boolean doAction(File in, File out) { @@ -220,8 +228,8 @@ getLog().info("Using " + in); try { - JRST.generate(JRST.TYPE_XDOC, in, inputEncoding, - out, outputEncoding, getOverwrite()); + JRST.generate(JRST.TYPE_XDOC, in, inputEncoding, out, + outputEncoding, getOverwrite()); numberFilesGenerates++; } catch (Exception e) { getLog().error(e); @@ -238,27 +246,30 @@ } protected void actionCopy() { - getLog().info("Copie des fichiers images"); + getLog().info("Copy resources files"); - MirroredFileUpdater resourceUpdater = new RessourceUpdater(directoryIn, resourceDirectoryOut, defaultLocale); - + MirroredFileUpdater resourceUpdater = new RessourceUpdater(directoryIn, + resourceDirectoryOut, defaultLocale); + DirectoryScanner ds = new DirectoryScanner(); ds.setBasedir(directoryIn); - ds.setIncludes(includeResources == null || includeResources.length == 0 ? DEFAULT_INCLUDE_RESOURCES : includeResources); + ds.setIncludes(includeResources == null + || includeResources.length == 0 ? DEFAULT_INCLUDE_RESOURCES + : includeResources); ds.scan(); for (String file : ds.getIncludedFiles()) { File in = new File(directoryIn, file); if (!force && resourceUpdater.isFileUpToDate(in)) { if (verbose) { - getLog().info("skip up-to-date resource file : " + in); + getLog().info("Skip up-to-date resource file : " + in); } // do not copy the resource continue; } File out = resourceUpdater.getMirrorFile(in); if (verbose) { - getLog().info("copy resource " + in + " to " + out); + getLog().info("Copy resource " + in + " to " + out); } try { FileUtil.copy(in, out); @@ -269,7 +280,7 @@ } /** - * An updater for rst files + * An updater for rst files. * * @author chemit */ @@ -277,23 +288,26 @@ protected String defaultLocale; - protected RstUpdater(File sourceDirectory, File destinationDirectory, String defaultLocale) { + protected RstUpdater(File sourceDirectory, File destinationDirectory, + String defaultLocale) { super(sourceDirectory, destinationDirectory); this.defaultLocale = defaultLocale; } public File getMirrorFile(File f) { String file = f.getAbsolutePath().substring(prefixSourceDirecotory); - file = file.replace(".rst", ".xml").replaceFirst("([/\\\\])rst([/\\\\])", "$1xdoc$2"); + file = file.replace(".rst", ".xml").replaceFirst( + "([/\\\\])rst([/\\\\])", "$1xdoc$2"); if (defaultLocale != null && !"".equals(defaultLocale)) { - file = file.replaceFirst("([/\\\\])" + defaultLocale + "([/\\\\])", "$1"); + file = file.replaceFirst("([/\\\\])" + defaultLocale + + "([/\\\\])", "$1"); } return new File(destinationDirectory, file); } } /** - * An updater for resources files + * An updater for resources files. * * @author chemit */ @@ -301,7 +315,8 @@ protected String defaultLocale; - protected RessourceUpdater(File sourceDirectory, File destinationDirectory, String defaultLocale) { + protected RessourceUpdater(File sourceDirectory, + File destinationDirectory, String defaultLocale) { super(sourceDirectory, destinationDirectory); this.defaultLocale = defaultLocale; } @@ -310,7 +325,8 @@ String file = f.getAbsolutePath().substring(prefixSourceDirecotory); file = file.replaceFirst("([/\\\\])rst([/\\\\])", "$1$2"); if (defaultLocale != null && !"".equals(defaultLocale)) { - file = file.replaceFirst("([/\\\\])" + defaultLocale + "([/\\\\])", "$1"); + file = file.replaceFirst("([/\\\\])" + defaultLocale + + "([/\\\\])", "$1"); } return new File(destinationDirectory, file); } Modified: maven-jrst-plugin/trunk/src/site/fr/rst/index.rst =================================================================== --- maven-jrst-plugin/trunk/src/site/fr/rst/index.rst 2009-01-16 18:21:20 UTC (rev 253) +++ maven-jrst-plugin/trunk/src/site/fr/rst/index.rst 2009-02-05 17:30:06 UTC (rev 254) @@ -6,12 +6,12 @@ Présentation ------------ -Le plugin maven pour utiliser la librairie jrst. +Le plugin maven2 pour utiliser la librairie jrst. Fonctionnement -------------- -Maven ne gere pas le RST par defaut, voilà pourquoi le plugin +Maven ne gère pas le RST par défaut, voilà pourquoi le plugin maven-jrst-plugin a été développé. Il utilise donc une structure similaire des sources des sites @@ -34,7 +34,7 @@ <plugin> <groupId>org.codelutin</groupId> <artifactId>maven-jrst-plugin</artifactId> - <version>${jrst.version}</version> + <version>${maven-jrst-plugin.version}</version> <configuration> <directoryIn>${basedir}/src/site</directoryIn> <directoryOut>${project.build.directory}/generated-site</directoryOut> @@ -56,8 +56,8 @@ pre-site : maven-antrun-plugin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Ce plugin est utilisé pour copier les fichier "non-rst" -dans le répertoire de generation de site. +Ce plugin est utilisé pour copier les fichiers "non-rst" +dans le répertoire de génération de site. :: @@ -69,7 +69,9 @@ <configuration> <tasks> <mkdir dir="${basedir}/src/site"/> - <copy todir="${project.build.directory}/generated-site" verbose="${maven.verbose}" overwrite="false"> + <copy todir="${project.build.directory}/generated-site" + verbose="${maven.verbose}" + overwrite="false"> <fileset dir="${basedir}/src/site"> <exclude name="**/rst/**"/> </fileset> @@ -91,7 +93,6 @@ <plugin> <artifactId>maven-site-plugin</artifactId> - <version>2.0-beta-7</version> <configuration> <siteDirectory>${project.build.directory}/generated-site</siteDirectory> <inputEncoding>UTF-8</inputEncoding>