- I18n-commits - mailman.cloud.codelutin.com

r1807 - in trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin: bundle parser/impl
by tchemit＠users.nuiton.org 12 Nov '10

12 Nov '10

Author: tchemit Date: 2010-11-12 12:48:31 +0100 (Fri, 12 Nov 2010) New Revision: 1807 Url: http://nuiton.org/repositories/revision/i18n/1807 Log: add headers + keywords Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/AbstractMakeI18nBundleMojo.java trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/JspFileProcessor.java trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserJspMojo.java Property changes on: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/AbstractMakeI18nBundleMojo.java ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/JspFileProcessor.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/JspFileProcessor.java 2010-11-12 11:41:48 UTC (rev 1806) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/JspFileProcessor.java 2010-11-12 11:48:31 UTC (rev 1807) @@ -1,3 +1,27 @@ +/* + * #%L + * I18n :: Maven Plugin + * + * $Id$ + * $HeadURL$ + * %% + * Copyright (C) 2007 - 2010 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% + */ package org.nuiton.i18n.plugin.parser.impl; import org.nuiton.processor.Processor; Property changes on: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/JspFileProcessor.java ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserJspMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserJspMojo.java 2010-11-12 11:41:48 UTC (rev 1806) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserJspMojo.java 2010-11-12 11:48:31 UTC (rev 1807) @@ -2,8 +2,8 @@ * #%L * I18n :: Maven Plugin * - * $Id: ParserValidationMojo.java 1800 2010-11-11 13:02:21Z tchemit $ - * $HeadURL: http://svn.nuiton.org/svn/i18n/trunk/maven-i18n-plugin/src/main/java/org/nu… $ + * $Id$ + * $HeadURL$ * %% * Copyright (C) 2007 - 2010 CodeLutin * %% Property changes on: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserJspMojo.java ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL

1 0

r1806 - trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl
by tchemit＠users.nuiton.org 12 Nov '10

12 Nov '10

Author: tchemit Date: 2010-11-12 12:41:48 +0100 (Fri, 12 Nov 2010) New Revision: 1806 Url: http://nuiton.org/repositories/revision/i18n/1806 Log: Evolution #1041: Introduce ParserJspMojo Added: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/JspFileProcessor.java trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserJspMojo.java Added: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/JspFileProcessor.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/JspFileProcessor.java (rev 0) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/JspFileProcessor.java 2010-11-12 11:41:48 UTC (rev 1806) @@ -0,0 +1,143 @@ +package org.nuiton.i18n.plugin.parser.impl; + +import org.nuiton.processor.Processor; +import org.nuiton.processor.ProcessorUtil; +import org.nuiton.processor.filters.DefaultFilter; +import org.nuiton.processor.filters.Filter; + +import java.io.File; +import java.io.IOException; + +/** + * To transform jsp files to valid xml files. + * + * Says : + * <ul> + * <li>Remove jsp directive</li> + * <li>Remove jsp comment</li> + * <li>Remove any tags in attributes (used for example in struts)</li> + * <li>? Other thing</li> + * </ul> + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.0 + */ +public class JspFileProcessor extends Processor { + + public JspFileProcessor() { + setInputFilter( + new Filter[]{ + new JspDirectiveFilter(), + new JspCommentFilter(), + new JspAttributeWithTagFilter() + } + ); + } + + /** + * @param filein the source file to process + * @param fileout the output file to generate + * @param encoding encoding used to read and write files + * @throws IOException if any io problems while processing + * @since 1.0.4 + */ + public void process(File filein, + File fileout, + String encoding) throws IOException { + ProcessorUtil.doProcess(this, filein, fileout, encoding); + } + + /** + * To remove in attributes any sub tags inside it (used for example in + * struts) from jsp files. + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.0 + */ + public static class JspAttributeWithTagFilter extends DefaultFilter { + + private String header = "=" + "\"" + "<"; + + private String footer = "\"" + "/" + ">" + "\""; + + @Override + protected String performInFilter(String ch) { + return "=\"\""; + } + + @Override + protected String performOutFilter(String ch) { + return ch; + } + + protected String getHeader() { + return header; + } + + protected String getFooter() { + return footer; + } + } + + /** + * To remove jsp comment from files. + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.0 + */ + public static class JspCommentFilter extends DefaultFilter { + + private String header = "<" + "%" + "-" + "-"; + + private String footer = "-" + "-" + "%" + ">"; + + @Override + protected String performInFilter(String ch) { + return ""; + } + + @Override + protected String performOutFilter(String ch) { + return ch; + } + + protected String getHeader() { + return header; + } + + protected String getFooter() { + return footer; + } + } + + /** + * To remove jsp directive from files. + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.0 + */ + public static class JspDirectiveFilter extends DefaultFilter { + + private String header = "<" + "%"; + + private String footer = "%" + ">"; + + @Override + protected String performInFilter(String ch) { + return ""; + } + + @Override + protected String performOutFilter(String ch) { + return ch; + } + + protected String getHeader() { + return header; + } + + protected String getFooter() { + return footer; + } + } +} Added: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserJspMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserJspMojo.java (rev 0) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserJspMojo.java 2010-11-12 11:41:48 UTC (rev 1806) @@ -0,0 +1,196 @@ +/* + * #%L + * I18n :: Maven Plugin + * + * $Id: ParserValidationMojo.java 1800 2010-11-11 13:02:21Z tchemit $ + * $HeadURL: http://svn.nuiton.org/svn/i18n/trunk/maven-i18n-plugin/src/main/java/org/nu… $ + * %% + * Copyright (C) 2007 - 2010 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% + */ + +package org.nuiton.i18n.plugin.parser.impl; + +import org.nuiton.i18n.plugin.parser.I18nSourceEntry; +import org.nuiton.i18n.plugin.parser.SourceEntry; +import org.nuiton.io.FileUpdater; +import org.nuiton.io.MirroredFileUpdater; + +import javax.xml.parsers.DocumentBuilder; +import javax.xml.xpath.XPath; +import java.io.File; +import java.io.IOException; + +/** + * Find i18n keys from jsp files. + * + * Note: this goal must always be invoked before the {@code process-resources} + * phase, otherwise all files will be considered as uptodate. + * + * @author tchemit <chemit(a)codelutin.com> + * @goal parserJsp + * @phase generate-resources + * @since 2.0 + */ +public class ParserJspMojo extends AbstractParserXmlMojo { + + /** + * Root directory of the default entry. + * + * @parameter expression="${i18n.defaultBasedir}" default-value="${basedir}/src/main/webapp" + * @required + */ + protected File defaultBasedir; + + /** + * Default included files to process (ant-like expression). + * + * @parameter expression="${i18n.defaultIncludes}" default-value="**\/**.jsp" + */ + protected String defaultIncludes; + + /** + * Defines the core rules file used to detect i18n keys in jsp files. + * + * Note : If you do not want to use it, set it to empty and fill the + * {@link #userRulesFiles} parameter. + * + * @parameter expression="${i18n.coreRuleFile}" + * @since 2.0 + */ + protected String coreRuleFile; + + /** + * Defines the file name of the getter where to put detected i18n keys + * while getter phase. + * + * @parameter expression="${i18n.outputGetter}" default-value="jsp.getter" + * @since 2.0 + */ + protected String outputGetter; + + /** + * Where to generated temporary processed files. + * + * @parameter expression="${i18n.workdir}" default-value="${basedir}/target/i18n-workdir" + * @since 2.0 + */ + protected File workdir; + + @Override + public String[] getDefaultIncludes() { + return new String[]{defaultIncludes}; + } + + @Override + public String[] getDefaultExcludes() { + return I18nSourceEntry.EMPTY_STRING_ARRAY; + } + + @Override + public File getDefaultBasedir() { + return defaultBasedir; + } + + MirroredFileUpdater entryUpdater; + + @Override + protected boolean onEnterEntry(I18nSourceEntry entry) { + boolean b = super.onEnterEntry(entry); + if (!b) { + + // no skipped entry + // keep the file updater + entryUpdater = (MirroredFileUpdater) entry.getUpdater(); + } + return b; + } + + @Override + public FileUpdater newFileUpdater(SourceEntry entry) { + return new MirroredFileUpdater("", "", entry.getBasedir(), workdir) { + + @Override + public File getMirrorFile(File f) { + String file = + f.getAbsolutePath().substring(prefixSourceDirecotory); + return new File(destinationDirectory + File.separator + file + "~"); + } + }; + } + + @Override + protected String getOutGetter() { + return outputGetter; + } + + @Override + protected String getCoreRuleFile() { + return coreRuleFile; + } + + protected XmlFileParser newXmlFileParser(final XPath xpath, + final DocumentBuilder builder) { + + return new XmlFileParser(getLog(), + getEncoding(), + oldParser, + showTouchedFiles, + rules, + xpath, + builder, namespaces) { + + @Override + public File prepareFile(File file) throws IOException { + + // clean the jsp to make it xml + + File result = entryUpdater.getMirrorFile(file); + createDirectoryIfNecessary(result.getParentFile()); + JspFileProcessor processor = new JspFileProcessor(); + processor.process(file, result, getEncoding()); + return result; + } + + @Override + public String extract(String i18nString) { + String s = null; + if (!i18nString.trim().isEmpty()) { + s = i18nString.trim(); + } + if (getLog().isDebugEnabled()) { + getLog().debug(i18nString + " = " + s); + } + return s; + } + + }; + } + + + @Override + @Deprecated + protected String getKeyModifierStart() { + return "=\\s*[\"\']"; + } + + @Override + @Deprecated + protected String getKeyModifierEnd() { + return "[\"\']"; + } +}

1 0

r1805 - trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl
by tchemit＠users.nuiton.org 12 Nov '10

12 Nov '10

Author: tchemit Date: 2010-11-12 12:41:34 +0100 (Fri, 12 Nov 2010) New Revision: 1805 Url: http://nuiton.org/repositories/revision/i18n/1805 Log: introduce prepareFile method to be able to do things before scanning it Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/AbstractParserXmlMojo.java Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/AbstractParserXmlMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/AbstractParserXmlMojo.java 2010-11-12 11:41:16 UTC (rev 1804) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/AbstractParserXmlMojo.java 2010-11-12 11:41:34 UTC (rev 1805) @@ -316,7 +316,6 @@ NamespaceContext ctx = new NamespaceContext() { public String getNamespaceURI(String prefix) { return XmlFileParser.this.namespaces.get(prefix); -// return getNamespaceForPrefix(prefix, doc); } @Override @@ -336,21 +335,38 @@ } } + /** + * To prepare the file (if any thing to be done before scanning it). + * + * @param file the incoming file + * @return the real file to process + * @throws IOException if any IO problem while preparing file + * @since 2.0 + */ + public File prepareFile(File file) throws IOException { + + // by default, do nothing + return file; + } + @Override public void parseFile(File file) throws IOException { + File fileToProcess = prepareFile(file); try { // Recherche des clés à partir d'un xpath - Document doc = builder.parse(file.getAbsolutePath()); + Document doc = builder.parse(fileToProcess.getAbsolutePath()); XPathExpression expression = xpath.compile(rules); NodeList list = (NodeList) expression.evaluate(doc, XPathConstants.NODESET); - getLog().info("Detected nodes [" + file + "] : " + list.getLength()); + if (getLog().isDebugEnabled()) { + getLog().debug("Detected nodes [" + file + "] : " + list.getLength()); + } for (int index = 0; index < list.getLength(); index++) { Node node = list.item(index); - parseLine(file, node.getTextContent()); + parseLine(fileToProcess, node.getTextContent()); } } catch (Exception e) { throw new ParserException(e);

1 0

r1804 - trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser
by tchemit＠users.nuiton.org 12 Nov '10

12 Nov '10

Author: tchemit Date: 2010-11-12 12:41:16 +0100 (Fri, 12 Nov 2010) New Revision: 1804 Url: http://nuiton.org/repositories/revision/i18n/1804 Log: introduce prepareFile method to be able to do things before scanning it Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/AbstractI18nParserMojo.java Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/AbstractI18nParserMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/AbstractI18nParserMojo.java 2010-11-11 16:48:13 UTC (rev 1803) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/AbstractI18nParserMojo.java 2010-11-12 11:41:16 UTC (rev 1804) @@ -87,7 +87,7 @@ * @parameter expression="${i18n.cp}" default-value="${basedir}/target/classes" */ protected File cp; - + /** * To activate the modification of keys * @@ -202,6 +202,11 @@ parserExecutor = new ParserExecutor(this); } + protected boolean onEnterEntry(I18nSourceEntry entry) { + boolean skip = entry.init(this); + return skip; + } + @Override protected void doAction() throws Exception { if (keysModifier) { @@ -241,7 +246,7 @@ for (I18nSourceEntry entry : entries) { - boolean skip = entry.init(this); + boolean skip = onEnterEntry(entry); if (skip) { if (!silent && verbose) {

1 0

r1803 - trunk
by tchemit＠users.nuiton.org 11 Nov '10

11 Nov '10

Author: tchemit Date: 2010-11-11 17:48:13 +0100 (Thu, 11 Nov 2010) New Revision: 1803 Url: http://nuiton.org/repositories/revision/i18n/1803 Log: use m-helper-plugin stable version Modified: trunk/pom.xml Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2010-11-11 14:55:02 UTC (rev 1802) +++ trunk/pom.xml 2010-11-11 16:48:13 UTC (rev 1803) @@ -241,7 +241,7 @@ <projectId>i18n</projectId>  - <helperPluginVersion>1.2.9-SNAPSHOT</helperPluginVersion> + <helperPluginVersion>1.2.9</helperPluginVersion> <processorVersion>1.0.4-SNAPSHOT</processorVersion>

1 0

r1802 - trunk
by tchemit＠users.nuiton.org 11 Nov '10

11 Nov '10

Author: tchemit Date: 2010-11-11 15:55:02 +0100 (Thu, 11 Nov 2010) New Revision: 1802 Url: http://nuiton.org/repositories/revision/i18n/1802 Log: do NOT use mavenpom dependencies since it does not work on windows os Modified: trunk/pom.xml Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2010-11-11 14:44:54 UTC (rev 1801) +++ trunk/pom.xml 2010-11-11 14:55:02 UTC (rev 1802) @@ -58,6 +58,12 @@ </dependency> <dependency> + <groupId>commons-lang</groupId> + <artifactId>commons-lang</artifactId> + <version>2.5</version> + </dependency> + + <dependency> <groupId>commons-beanutils</groupId> <artifactId>commons-beanutils</artifactId> <version>1.8.2</version> @@ -199,10 +205,11 @@ <scope>compile</scope> </dependency> -  + <version>1.2.16</version> + </dependency> <dependency> <groupId>org.apache.ant</groupId>

1 0

r1801 - in trunk: . ant-i18n-task/src/license
by tchemit＠users.nuiton.org 11 Nov '10

11 Nov '10

Author: tchemit Date: 2010-11-11 15:44:54 +0100 (Thu, 11 Nov 2010) New Revision: 1801 Url: http://nuiton.org/repositories/revision/i18n/1801 Log: do NOT use mavenpom dependencies since it does not work on windows os + update ant to 1.8.0 Modified: trunk/ant-i18n-task/src/license/THIRD-PARTY.properties trunk/pom.xml Modified: trunk/ant-i18n-task/src/license/THIRD-PARTY.properties =================================================================== --- trunk/ant-i18n-task/src/license/THIRD-PARTY.properties 2010-11-11 13:02:21 UTC (rev 1800) +++ trunk/ant-i18n-task/src/license/THIRD-PARTY.properties 2010-11-11 14:44:54 UTC (rev 1801) @@ -1,38 +1,14 @@ -### -# #%L -# I18n :: Ant task -# -# $Id$ -# $HeadURL$ -# %% -# Copyright (C) 2010 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% -### # Generated by org.nuiton.license.plugin.AddThirdPartyMojo #------------------------------------------------------------------------------- # Already used licenses in project : +# - BSD License # - Common Public License Version 1.0 -# - Lesser General Public License (LGPL) # - Lesser General Public License (LGPL) v 3.0 # - The Apache Software License, Version 2.0 #------------------------------------------------------------------------------- # Please fill the missing licenses for dependencies : # # -#Sun Jun 27 08:59:58 CEST 2010 -org.apache.ant--ant--1.7.1=The Apache Software License, Version 2.0 -org.apache.ant--ant-launcher--1.7.1=The Apache Software License, Version 2.0 +#Thu Nov 11 15:08:04 CET 2010 +org.apache.ant--ant--1.8.0==The Apache Software License, Version 2.0 +org.apache.ant--ant-launcher--1.8.0=The Apache Software License, Version 2.0 Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2010-11-11 13:02:21 UTC (rev 1800) +++ trunk/pom.xml 2010-11-11 14:44:54 UTC (rev 1801) @@ -51,20 +51,23 @@ <dependencyManagement> <dependencies> -  + <version>1.4</version> + </dependency> <dependency> <groupId>org.nuiton.processor</groupId> @@ -159,11 +162,12 @@  -  + </dependency>  <dependency> @@ -203,7 +207,7 @@ <dependency> <groupId>org.apache.ant</groupId> <artifactId>ant</artifactId> - <version>1.7.1</version> + <version>1.8.0</version> <scope>compile</scope> </dependency> @@ -230,9 +234,11 @@ <projectId>i18n</projectId>  - <helperPluginVersion>1.3-SNAPSHOT</helperPluginVersion> + <helperPluginVersion>1.2.9-SNAPSHOT</helperPluginVersion> <processorVersion>1.0.4-SNAPSHOT</processorVersion> + + <mavenVersion>2.2.1</mavenVersion>  <locales>fr,en</locales>

1 0

r1800 - in trunk/maven-i18n-plugin: . src/main/java/org/nuiton/i18n/plugin src/main/java/org/nuiton/i18n/plugin/bundle src/main/java/org/nuiton/i18n/plugin/parser src/main/java/org/nuiton/i18n/plugin/parser/impl
by tchemit＠users.nuiton.org 11 Nov '10

11 Nov '10

Author: tchemit Date: 2010-11-11 14:02:21 +0100 (Thu, 11 Nov 2010) New Revision: 1800 Url: http://nuiton.org/repositories/revision/i18n/1800 Log: use {@code ...} instead of <code>...</code> + Anomalie #1030: All mojo configuration documentation must be in english. + improve parser mojos Added: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/AbstractMakeI18nBundleMojo.java Modified: trunk/maven-i18n-plugin/pom.xml trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/AbstractI18nMojo.java trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/GenerateMojo.java trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/GetterMojo.java trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/BundleMojo.java trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/CollectI18nArtifactsMojo.java trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/TapestryBundleMojo.java trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/AbstractI18nParserMojo.java trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserJavaMojo.java trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserValidationMojo.java trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserXmlUserMojo.java Modified: trunk/maven-i18n-plugin/pom.xml =================================================================== --- trunk/maven-i18n-plugin/pom.xml 2010-11-11 13:01:26 UTC (rev 1799) +++ trunk/maven-i18n-plugin/pom.xml 2010-11-11 13:02:21 UTC (rev 1800) @@ -113,9 +113,8 @@  <name>I18n :: Maven Plugin</name> <description> - Plugin pour maven 2 de génération des bundles pour - l'internationalisation (i18n) des applications java - basé sur nuiton-i18n-api. + Maven plugin to deal with i18n stuff in a project, mainly base on the + nuiton-i18n api (but not only). </description> <inceptionYear>2007</inceptionYear> Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/AbstractI18nMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/AbstractI18nMojo.java 2010-11-11 13:01:26 UTC (rev 1799) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/AbstractI18nMojo.java 2010-11-11 13:02:21 UTC (rev 1800) @@ -34,14 +34,18 @@ import java.io.File; import java.io.IOException; import java.util.Locale; +import java.util.Map; import java.util.Properties; import java.util.SortedSet; +import java.util.TreeSet; /** - * Classe permettant d'obenir les parametres pendant les différentes phases du - * plugin. + * Lower level i18n mojo abstraction. + * + * We defines here all commons parameters and shared behaviour. * - * @author julien + * @author tchemit <chemit(a)codelutin.com> + * @author jruchaud <ruchaud(a)codelutin.com> */ public abstract class AbstractI18nMojo extends AbstractPlugin implements PluginWithEncoding { @@ -58,7 +62,9 @@ protected MavenProject project; /** - * Nom du projet. + * Name to use as prefix of generated files. + * + * Note : By default, use the artifact id. * * @parameter expression="${i18n.artifactId}" default-value="${project.artifactId}" * @readonly @@ -66,8 +72,10 @@ protected String artifactId; /** - * Langues des bundles generes. + * Locales to treate, separated by comma. * + * Example : + * <pre>fr_FR,en_GB</pre> * * @parameter expression="${i18n.bundles}" default-value="fr_FR,en_GB" * @required @@ -75,7 +83,7 @@ protected String bundles; /** - * Repertoire sources des fichiers i18n. + * Directory where to find project i18n files. * * @parameter expression="${i18n.src}" default-value="${basedir}/src/main/resources/i18n" * @required @@ -83,7 +91,7 @@ protected File src; /** - * Repertoire des fichiers generes i18n. + * Directory where to generate i18n files. * * @parameter expression="${i18n.out}" default-value="${basedir}/target/generated-sources/i18n" * @required @@ -91,7 +99,7 @@ protected File out; /** - * encoding a utiliser pour charger et sauver les bundles + * Encoding used to load and store files. * * Note: If nothing is filled here, we will use the system * property {@code file.encoding}. @@ -102,26 +110,26 @@ protected String encoding; /** - * Met les fichiers generes dans le repertoire des sources i18n. + * To update generated files to user i18n files. * - * Note: Par défaut active, pour pouvoir paquager avec les bundles mis a - * jour. + * Note : By default, this is active, in order to have a project uptodate + * with last i18n bundles detected. * * @parameter expression="${i18n.genSrc}" default-value="true" */ protected boolean genSrc; /** - * verbose flag + * Verbose flag. * - * Note: si non renseigne, on utilise la propiété <code>maven.verbose</code>. + * Note : if not setted, we used the {@code maven.verbose} property. * * @parameter expression="${i18n.verbose}" default-value="${maven.verbose}" */ protected boolean verbose; /** - * silent flag + * Silent flag to see only errors in console. * * @parameter expression="${i18n.silent}" default-value="false" * @since 1.0.0-rc-5 @@ -129,21 +137,22 @@ protected boolean silent; /** - * ne conserve que les clef scannees (et donc traite tous les fichiers) + * Strict mode to only keep in user i18n detected i18n keys and remove obsolete keys. * - * - * Note : par default, on ne l'active car rescanne tous les fichiers. s + * Note : By default not active. Use this with care since it can + * delete keys. Moreover if this flag is activated, then all files will be parsed. * * @parameter expression="${i18n.strictMode}" default-value="false" */ protected boolean strictMode; - /** les locales a traiter */ + /** locales to process */ protected Locale[] locales; @Override protected boolean checkPackaging() { + // nothing to do on a pom module return !acceptPackaging(Packaging.pom); } @@ -169,8 +178,8 @@ } /** - * @return <code>true</code> si des getters ont etes enregistres pendant le - * cycle de vie, <code>false</code> sinon. + * @return {@code true} si des getters ont etes enregistres pendant le + * cycle de vie, {@code false} sinon. */ protected boolean needGeneration() { boolean needGeneration = NB_GETTER_FILES > 0; @@ -191,7 +200,7 @@ * @param root le repertoire ou sont stockes les fichiers i18n * @param artifactId le nom de l'artifact * @param locale le nom du bundle - * @param create <code>true</code> pour creer le fichier si non present + * @param create {@code true} pour creer le fichier si non present * @return le fichier i18n * @throws IOException si probleme lors de la creation du fichier */ @@ -209,7 +218,7 @@ /** * @param root le repertoire ou sont stockes les fichiers getter * @param getter le nom du getter - * @param create <code>true</code> pour creer le fichier si non present + * @param create {@code true} pour creer le fichier si non present * @return le fichier i18n * @throws IOException si probleme lors de la creation du fichier */ @@ -223,14 +232,24 @@ return file; } - protected boolean checkBundle(Locale locale, Properties propertiesOut, - boolean showEmpty) { + protected void checkBundle(Locale locale, + Properties propertiesOut, + boolean showEmpty, + Map<Locale, SortedSet<String>> unsafeHolder) { - boolean safe = true; // on verifie qu'il n'y a pas de traduction vide SortedSet<String> emptyEntries = PluginHelper.getEmptyKeys(propertiesOut); if (!emptyEntries.isEmpty()) { - safe=false; + if (unsafeHolder != null) { + + // push empties i18n keys in the holder + SortedSet<String> empties = unsafeHolder.get(locale); + if (empties == null) { + empties = new TreeSet<String>(); + unsafeHolder.put(locale, empties); + } + empties.addAll(emptyEntries); + } StringBuilder buffer = new StringBuilder(); int size = emptyEntries.size(); buffer.append("bundle "); @@ -261,7 +280,6 @@ " entries)."); } } - return safe; } Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/GenerateMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/GenerateMojo.java 2010-11-11 13:01:26 UTC (rev 1799) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/GenerateMojo.java 2010-11-11 13:02:21 UTC (rev 1800) @@ -33,9 +33,10 @@ import java.util.Locale; /** - * Merge des fichiers de propriétés avec les anciens. + * Merge new generated i18n bundles with older existing ones. * - * @author julien + * @author jruchaud <ruchaud(a)codelutin.com> + * @author chemit <chemit(a)codelutin.com> * @goal gen * @phase generate-resources * @execute goal=get @@ -43,8 +44,7 @@ public class GenerateMojo extends AbstractI18nMojo { /** - * Un drapeau pour vérifier que les bundles ne contiennent pas d'entrées - * vides. + * A flag to check that bundles are complete (no missing i18n translations). * * @parameter expression="${i18n.checkBundle}" default-value="true" * @required @@ -53,8 +53,9 @@ protected boolean checkBundle; /** - * Un drapeau pour afficher les entrées vides. (nécessite {@link - * #checkBundle} activé). + * A flag to show missing i18n translation. + * + * Note : Need the {@link #checkBundle} to be activated). * * @parameter expression="${i18n.showEmpty}" default-value="false" * @required @@ -63,16 +64,18 @@ protected boolean showEmpty; /** - * conserve les anciens fichiers de traduction avec un suffix ~ + * To keep a backup of old i18n bundles (suffiex by a {@code ~}). * - * Note: par defaut, on ne l'active pas. + * Note: By default, this property is not active. * * @parameter expression="${i18n.keepBackup}" default-value="false" */ protected boolean keepBackup; /** - * Conserve les fichiers de getters. + * To keep generated getter files. + * + * Note: By default, this property is not active. * * @parameter expression="${i18n.keepGetters}" default-value="false" */ @@ -153,7 +156,7 @@ } if (checkBundle) { - checkBundle(locale, propertiesOut, showEmpty); + checkBundle(locale, propertiesOut, showEmpty, null); } if (genSrc) { Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/GetterMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/GetterMojo.java 2010-11-11 13:01:26 UTC (rev 1799) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/GetterMojo.java 2010-11-11 13:02:21 UTC (rev 1800) @@ -43,7 +43,9 @@ public class GetterMojo extends AbstractI18nMojo { /** - * Conserve les fichiers de getters. + * To keep generated getter files. + * + * Note: By default, this property is not active. * * @parameter expression="${i18n.keepGetters}" default-value="false" */ Added: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/AbstractMakeI18nBundleMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/AbstractMakeI18nBundleMojo.java (rev 0) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/AbstractMakeI18nBundleMojo.java 2010-11-11 13:02:21 UTC (rev 1800) @@ -0,0 +1,130 @@ +/* + * #%L + * I18n :: Maven Plugin + * + * $Id$ + * $HeadURL$ + * %% + * Copyright (C) 2007 - 2010 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% + */ +package org.nuiton.i18n.plugin.bundle; + +import org.apache.maven.plugin.MojoFailureException; + +import java.io.File; +import java.util.HashMap; +import java.util.Locale; +import java.util.Map; +import java.util.SortedSet; + +/** + * Common mojo to all final bundle maker. + * + * @author tchemit <chemit(a)codelutin.com> + * @since 2.0 + */ +public abstract class AbstractMakeI18nBundleMojo extends AbstractI18nBundleMojo { + + /** + * Directory where to generate aggregated bundles. + * + * @parameter expression="${i18n.bundleOutputDir}" default-value="${basedir}/target/generated-sources/resources/META-INF" + * @required + * @since 1.0.0 + */ + protected File bundleOutputDir; + + /** + * Name of the bundle to generate. + * + * @parameter expression="${i18n.bundleOutputName}" default-value="${project.artifactId}-i18n" + * @required + * @since 1.0.2 + */ + protected String bundleOutputName; + + /** + * A flag to check that bundles are complete (no missing i18n translations). + * + * Note : This behaviour will be activated is {@link #failsIfWarning} is on. + * + * @parameter expression="${i18n.checkBundle}" default-value="true" + * @since 1.0.0 + */ + protected boolean checkBundle; + + /** + * A flag to show missing i18n translation. + * + * Note : Need the {@link #checkBundle} to be activated). + * + * @parameter expression="${i18n.showEmpty}" default-value="false" + * @since 1.0.0 + */ + protected boolean showEmpty; + + /** + * A flag to make the build fails if there is some warnings while generating + * bundle, says when it misses some translations. + * + * Note : This parameter should be used in a release profile to + * ensure bundles are complete. + * + * @parameter expression="${i18n.failsIfWarning}" default-value="false" + * @since 2.0 + */ + protected boolean failsIfWarning; + + /** to keep all none translated i18n keys by locale. */ + protected Map<Locale, SortedSet<String>> unsafeMapping; + + @Override + public void init() throws Exception { + super.init(); + + if (failsIfWarning) { + + // check bundle if wants to fail on unsafe bundles + checkBundle = true; + + unsafeMapping = new HashMap<Locale, SortedSet<String>>(); + } else { + unsafeMapping = null; + } + + createDirectoryIfNecessary(bundleOutputDir); + } + + protected void failsIfWarning() throws MojoFailureException { + if (!failsIfWarning) { + + // no check + return; + } + + if (unsafeMapping != null && !unsafeMapping.isEmpty()) { + + // there is at least one not complete bundle, faisl the build + throw new MojoFailureException( + "Bundles for locale(s) " + unsafeMapping.keySet() + + " are not complete. Use the -Di18n.showEmpty to see " + + "missing translations."); + } + } + +} Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/BundleMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/BundleMojo.java 2010-11-11 13:01:26 UTC (rev 1799) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/BundleMojo.java 2010-11-11 13:02:21 UTC (rev 1800) @@ -25,7 +25,6 @@ package org.nuiton.i18n.plugin.bundle; -import org.apache.maven.plugin.MojoFailureException; import org.nuiton.i18n.bundle.I18nBundleEntry; import org.nuiton.i18n.bundle.I18nBundleUtil; import org.nuiton.i18n.init.DefaultI18nInitializer; @@ -45,25 +44,18 @@ import java.util.Map.Entry; /** - * Créer un bundle pour une application finale. + * Generate an aggregate i18n bundle for all dependencies of the project. * - * Cela génère un merge de tous les fichiers i18n utilisés en un seul. + * The main idea is to have a final unique i18n bundle for a application to + * launch, this really improve i18n loading time to have a unique named bundle, + * no need to seek in all dependencies... * - * On utilise la dépendance sur les artifacts pour connaitre l'ordre le - * chargement des bundles. + * Moreover, this permits also to deal with order of i18n keys, more precisly, + * we want to use the higher level i18n key for an application. If the i18n + * key is present on a library, we want to be able to override it in + * application (or user wants it:)). * - * Si dans un bundle childs, la valeur de la clef est vide, on conserve alors - * celui du parent, - * - * Ainsi on obtient un bundle dont toutes les clefs sont traduites. - * - * Le but aussi d'utiliser un unique bundle est de gagner du temps au runtime - * car la recherche des bundles devient trop couteuse en temps lorsque l'on a de - * nombreuses dépendances (au dessus de 100 deps cela peut prendre plusieurs - * secondes, ce qui 'est pas acceptable). - * - * On a ajoute un second mode d'initialisation dans la clesse I18n pour - * n'utiliser qu'un seul bundle et courcircuiter le chargement couteux... + * This goal permits this using the dependencies graph order of artifacts. * * @author tchemit <chemit(a)codelutin.com> * @goal bundle @@ -73,49 +65,17 @@ * @requiresDependencyResolution runtime * @since 0.12 */ -public class BundleMojo extends AbstractI18nBundleMojo { +public class BundleMojo extends AbstractMakeI18nBundleMojo { /** - * Repertoire ou generer les bundles. - * - * @parameter expression="${i18n.bundleOutputDir}" default-value="${basedir}/target/generated-sources/resources/META-INF" - * @required - * @since 1.0.0 - */ - protected File bundleOutputDir; - - /** - * Nom du bundle a generer. - * - * @parameter expression="${i18n.bundleOutputName}" default-value="${project.artifactId}-i18n" - * @required - * @since 1.0.2 - */ - protected String bundleOutputName; - - /** - * Un drapeau pour vérifier que les bundles ne contiennent pas d'entrées - * vides. - * - * @parameter expression="${i18n.checkBundle}" default-value="true" - * @since 1.0.0 - */ - protected boolean checkBundle; - - /** - * Un drapeau pour afficher les entrées vides. (nécessite {@link - * #checkBundle} activé). - * - * @parameter expression="${i18n.showEmpty}" default-value="false" - * @since 1.0.0 - */ - protected boolean showEmpty; - - /** - * Un drapeau pour utiliser le répertoire parent du {@link #bundleOutputDir} - * comme répertoire de ressources à ajouter au build. + * A flag to use the parent of directory {@link #bundleOutputDir} + * as directory to add in build ressources. * - * Si ce drapeau n'est pas activé, alors on utilise directement le répertoire donné. + * If the flag is not activated, the, we use directly the given + * {@link #bundleOutputDir} directory. + * + * Note : By default we use the parent directory, since this is more + * natural, only special cases should desactivate this parameter. * * @parameter expression="${i18n.addBundleOuputDirParent}" default-value="true" * @since 2.0 @@ -123,35 +83,20 @@ protected boolean addBundleOuputDirParent; /** - * Un drapeau pour générer le fichier de définition i18n. + * A flag to generate the i18n definition file. * - * Ce fichier permet d'avoir les locales utilisables par I18n ainsi que les - * chemins (dans le classpath) des resources i18n utilisées pour construire - * le bundle final. + * This file contains all generated bundles and the paths of all i18n + * artifacts used to make it. * * @parameter expression="${i18n.generateDefinitionFile}" default-value="true" * @since 2.0 */ protected boolean generateDefinitionFile; - /** - * A flag to make the build fails if there is some warnings while generating - * bundle, says when it misses some translations. - * - * Note : This parameter should be used in a release profile to - * ensure bundles are complete. - * - * @parameter expression="${i18n.failsIfWarning}" default-value="false" - * @since 2.0 - */ - protected boolean failsIfWarning; - @Override public void init() throws Exception { super.init(); - createDirectoryIfNecessary(bundleOutputDir); - // ajout de repertoire de generation (le parent en fait) // dans les resources du projet @@ -180,13 +125,15 @@ Map<Locale, String> bundleDico = new LinkedHashMap<Locale, String>(locales.length); - List<Locale> unsafeLocales = new ArrayList<Locale>(); for (Locale locale : locales) { long t0 = System.nanoTime(); - File bundleOut = getI18nFile(bundleOutputDir, bundleOutputName, - locale, false); + File bundleOut = getI18nFile(bundleOutputDir, + bundleOutputName, + locale, + false + ); SortedProperties propertiesOut = new SortedProperties(encoding, false); @@ -241,47 +188,16 @@ PluginHelper.convertTime(t0, System.nanoTime()) + " (detected sentences : " + propertiesOut.size() + ")"); } - if (checkBundle || failsIfWarning) { - boolean localSafe = - checkBundle(locale, propertiesOut, showEmpty); - if (!localSafe) { - unsafeLocales.add(locale); - } + if (checkBundle) { + checkBundle(locale, propertiesOut, showEmpty, unsafeMapping); } } - if (failsIfWarning && !unsafeLocales.isEmpty()) { + failsIfWarning(); - // there is at least one not complete bundle, faisl the build - throw new MojoFailureException("Bundles for locale(s) " + unsafeLocales + " are not complete"); - } - if (generateDefinitionFile) { - // ecriture du ficher des definitions i18n (permet de faire une - // recherche exacte sur un fichier puis d'en deduire les bundles a - // charger - String f = String.format(DefaultI18nInitializer.UNIQUE_BUNDLE_DEF, - bundleOutputName); - File defOut = new File(bundleOutputDir, f); - if (!silent) { - getLog().info("prepare i18n definition " + - defOut.getAbsolutePath()); - } - SortedProperties p = new SortedProperties(encoding, false); - p.setProperty(DefaultI18nInitializer.BUNDLE_DEF_LOCALES, bundles); - p.setProperty(DefaultI18nInitializer.BUNDLE_DEF_VERSION, version); - for (Entry<Locale, String> e : bundleDico.entrySet()) { - p.setProperty(DefaultI18nInitializer.BUNDLES_FOR_LOCALE + - e.getKey().toString(), e.getValue()); - } - FileOutputStream out = new FileOutputStream(defOut); - try { - p.store(out, null); - } finally { - out.close(); - } - + generateDefinitionFile(version, bundleDico); } if (!silent && verbose) { getLog().info("done in " + @@ -289,6 +205,34 @@ } } + protected void generateDefinitionFile(String version, + Map<Locale, String> bundleDico) throws IOException { + + // ecriture du ficher des definitions i18n (permet de faire une + // recherche exacte sur un fichier puis d'en deduire les bundles a + // charger + String f = String.format(DefaultI18nInitializer.UNIQUE_BUNDLE_DEF, + bundleOutputName); + File defOut = new File(bundleOutputDir, f); + if (!silent) { + getLog().info("prepare i18n definition file in " + + defOut.getAbsolutePath()); + } + SortedProperties p = new SortedProperties(encoding, false); + p.setProperty(DefaultI18nInitializer.BUNDLE_DEF_LOCALES, bundles); + p.setProperty(DefaultI18nInitializer.BUNDLE_DEF_VERSION, version); + for (Entry<Locale, String> e : bundleDico.entrySet()) { + p.setProperty(DefaultI18nInitializer.BUNDLES_FOR_LOCALE + + e.getKey().toString(), e.getValue()); + } + FileOutputStream out = new FileOutputStream(defOut); + try { + p.store(out, null); + } finally { + out.close(); + } + } + @Override protected URL[] getCollectI18nResources(Locale locale) throws IOException { File file = getCollectOutputFile(locale, false); Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/CollectI18nArtifactsMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/CollectI18nArtifactsMojo.java 2010-11-11 13:01:26 UTC (rev 1799) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/CollectI18nArtifactsMojo.java 2010-11-11 13:02:21 UTC (rev 1800) @@ -48,9 +48,11 @@ import java.util.Map; /** - * Detects any i18n artifacts and store the result as a file. + * Detects any i18n artifacts in the dependencies of the project and store + * their references in a file. * - * Created: 24 déc. 2009 + * The generated file will be used by {@code bundle} mojo to generate the final + * aggregated bundle. * * @author tchemit <chemit(a)codelutin.com> * @goal collect-i18n-artifacts Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/TapestryBundleMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/TapestryBundleMojo.java 2010-11-11 13:01:26 UTC (rev 1799) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/bundle/TapestryBundleMojo.java 2010-11-11 13:02:21 UTC (rev 1800) @@ -40,25 +40,10 @@ /** - * Créer un bundle pour une application finale. + * Generates a unique bundle for a tapestry application. * - * Cela génère un merge de tous les fichiers i18n utilisés en un seul. - * - * On utilise la dépendance sur les artifacts pour connaitre l'ordre le - * chargement des bundles. - * - * Si dans un bundle childs, la valeur de la clef est vide, on conserve alors - * celui du parent, - * - * Ainsi on obtient un bundle dont toutes les clefs sont traduites. - * - * Le but aussi d'utiliser un unique bundle est de gagner du temps au runtime - * car la recherche des bundles devient trop couteuse en temps lorsque l'on a de - * nombreuses dépendances (au dessus de 100 deps cela peut prendre plusieurs - * secondes, ce qui 'est pas acceptable). - * - * On a ajoute un second mode d'initialisation dans la clesse I18n pour - * n'utiliser qu'un seul bundle et courcircuiter le chargement couteux... + * Note : The mojo has nothing specific to tapestry and should be renamed + * (or removed since the {@code bundle} mojo do the same with more options)... * * @author tchemit <chemit(a)codelutin.com> * @goal tapestry-bundle @@ -68,54 +53,9 @@ * @requiresDependencyResolution runtime * @since 1.2 */ -public class TapestryBundleMojo extends AbstractI18nBundleMojo { +public class TapestryBundleMojo extends AbstractMakeI18nBundleMojo { - /** - * Repertoire ou generer les bundles. - * - * @parameter expression="${i18n.bundleOutputDir}" default-value="${basedir}/src/main/webapp/WEB-INF" - * @required - * @since 1.0.0 - */ - protected File bundleOutputDir; - - /** - * Nom du bundle a generer. - * - * @parameter expression="${i18n.bundleOutputName}" default-value="app" - * @required - * @since 1.0.2 - */ - protected String bundleOutputName; - - /** - * Un drapeau pour vérifier que les bundles ne contiennent pas d'entrées - * vides. - * - * @parameter expression="${i18n.checkBundle}" default-value="true" - * @required - * @since 1.0.0 - */ - protected boolean checkBundle; - - /** - * Un drapeau pour afficher les entrées vides. (nécessite {@link - * #checkBundle} activé). - * - * @parameter expression="${i18n.showEmpty}" default-value="false" - * @required - * @since 1.0.0 - */ - protected boolean showEmpty; - @Override - public void init() throws Exception { - super.init(); - - createDirectoryIfNecessary(bundleOutputDir); - } - - @Override protected void doAction() throws Exception { long t00 = System.nanoTime(); @@ -185,21 +125,24 @@ " (detected sentences : " + propertiesOut.size() + ")"); } if (checkBundle) { - checkBundle(locale, propertiesOut, showEmpty); + checkBundle(locale, propertiesOut, showEmpty, unsafeMapping); } } + failsIfWarning(); + if (!silent && verbose) { getLog().info("done in " + PluginHelper.convertTime(t00, System.nanoTime())); } } + /** * @param root le repertoire ou sont stockes les fichiers i18n * @param artifactId le nom de l'artifact * @param locale le nom du bundle - * @param create <code>true</code> pour creer le fichier si non present + * @param create {@code true} pour creer le fichier si non present * @return le fichier i18n * @throws IOException si probleme lors de la creation du fichier */ Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/AbstractI18nParserMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/AbstractI18nParserMojo.java 2010-11-11 13:01:26 UTC (rev 1799) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/AbstractI18nParserMojo.java 2010-11-11 13:02:21 UTC (rev 1800) @@ -82,12 +82,20 @@ public abstract FileUpdater newFileUpdater(SourceEntry entry); /** - * Active la modification de cle. + * Build directory (used to know if files in sources are up-to-date). + * + * @parameter expression="${i18n.cp}" default-value="${basedir}/target/classes" + */ + protected File cp; + + /** + * To activate the modification of keys * - * Note: par defaut, on ne l'active pas (build sur serveur non ui). + * Note : By default not active, since it requires to have UI available + * and this is not acceptable for server build. * - * Note: Ce paramètre n'est plus actif, la fonctionnalité n'est plus - * disponible et sera remplacé par un autre goal. + * Note : At the moment the fully fonctionnality is no more available + * and will be recode in a separated goal (one day...) * * @parameter expression="${i18n.keysModifier}" default-value="false" * @deprecated since 1.2, will no more used @@ -96,24 +104,24 @@ protected boolean keysModifier; /** - * treate default entry + * To treate default entry offered by the mojo. * * @parameter expression="${i18n.treateDefaultEntry}" default-value="true" */ protected boolean treateDefaultEntry; /** - * Source entries (src+includes+excludes) . + * Source entries (src+includes+excludes) to process. * * @parameter expression="${i18n.entries}" */ protected I18nSourceEntry[] entries; /** - * flag to display touched files while parsing. + * Flag to display touched files while parsing. * - * Note: the value will be always <code>true</code> if {@link #verbose} is - * set at <code>true</code>. + * Note: the value will be always {@code true} if {@link #verbose} is + * set at {@code true}. * * @parameter expression="${i18n.showTouchedFiles}" default-value="${maven.verbose}" * @since 0.9 @@ -121,7 +129,7 @@ protected boolean showTouchedFiles; /** - * flag to save previous getter in a backup before doing parsing. + * Flag to save previous getter in a backup before doing parsing. * * Note: by default, do not perform backup (but it was here originaly so let * it possible...) Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserJavaMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserJavaMojo.java 2010-11-11 13:01:26 UTC (rev 1799) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserJavaMojo.java 2010-11-11 13:02:21 UTC (rev 1800) @@ -44,35 +44,40 @@ import java.io.LineNumberReader; /** - * Récupération des chaine a traduire depuis les fichiers java. + * To parse java files to detect new i18n keys. * - * @author julien + * Note: this goal must always be invoked before the {@code process-resources} + * phase, otherwise all files will be considered as uptodate. + * + * @author jruchaud <ruchaud(a)codelutin.com> + * @author tchemit <tchemit(a)codelutin.com> * @goal parserJava * @phase generate-resources */ public class ParserJavaMojo extends AbstractI18nParserMojo { /** - * Source entries (src+includes+excludes) . + * Root directory of the default entry. * - * @parameter expression="${i18n.defaultIncludes}" default-value="**\/*.java" + * @parameter expression="${i18n.defaultBasedir}" default-value="${basedir}/src/main/java" */ - protected String defaultIncludes; + protected File defaultBasedir; /** - * default src for an entry. + * Default included files to process (ant-like expression). * - * @parameter expression="${i18n.defaultBasedir}" default-value="${basedir}/src/main/java" + * @parameter expression="${i18n.defaultIncludes}" default-value="**\/*.java" */ - protected File defaultBasedir; + protected String defaultIncludes; /** - * Repertoire sources des fichiers i18n. + * Defines the file name of the getter where to put detected i18n keys + * while getter phase. * - * @parameter expression="${i18n.cp}" default-value="${basedir}/target/classes" - * @required + * @parameter expression="${i18n.outputGetter}" default-value="java.getter" + * @since 2.0 */ - protected File cp; + protected String outputGetter; @Override public String[] getDefaultIncludes() { @@ -108,7 +113,7 @@ @Override protected String getOutGetter() { - return "java.getter"; + return outputGetter; } @Override Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserValidationMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserValidationMojo.java 2010-11-11 13:01:26 UTC (rev 1799) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserValidationMojo.java 2010-11-11 13:02:21 UTC (rev 1800) @@ -42,9 +42,9 @@ /** * Find i18n keys from xworks xml validation files. - * + * * Note: this goal must always be invoked before the {@code process-resources} - * phase, otherwise all files will be considered as uptodate. + * phase, otherwise all files will be considered as uptodate. * * @author tchemit <chemit(a)codelutin.com> * @goal parserValidation @@ -55,18 +55,19 @@ final URL xworksResource = getClass().getResource("/xwork-validator-1.0.2.dtd"); /** - * Source entries (src+includes+excludes) . + * Root directory of the default entry. * - * @parameter expression="${i18n.defaultIncludes}" default-value="**\/**-validation.xml" + * @parameter expression="${i18n.defaultBasedir}" default-value="${basedir}/src/main/resources" + * @required */ - protected String defaultIncludes; + protected File defaultBasedir; /** - * Where jaxx files should have been generated. + * Default included files to process (ant-like expression). * - * @parameter expression="${i18n.cp}" default-value="${basedir}/target/classes" + * @parameter expression="${i18n.defaultIncludes}" default-value="**\/**-validation.xml" */ - protected File cp; + protected String defaultIncludes; /** * Defines the core rules file used to detect i18n keys in xml validation @@ -81,14 +82,6 @@ protected String coreRuleFile; /** - * default src for an entry. - * - * @parameter expression="${i18n.defaultBasedir}" default-value="${basedir}/src/main/resources" - * @required - */ - protected File defaultBasedir; - - /** * Always use the local xowrks dtd to increase performance. * * @parameter expression="${i18n.useLocalResolver}" default-value="true" @@ -97,7 +90,8 @@ protected boolean useLocalResolver; /** - * Defines the file name of the getter where to put detected i18n keys while getter phase. + * Defines the file name of the getter where to put detected i18n keys + * while getter phase. * * @parameter expression="${i18n.outputGetter}" default-value="validation.getter" * @since 2.0 Modified: trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserXmlUserMojo.java =================================================================== --- trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserXmlUserMojo.java 2010-11-11 13:01:26 UTC (rev 1799) +++ trunk/maven-i18n-plugin/src/main/java/org/nuiton/i18n/plugin/parser/impl/ParserXmlUserMojo.java 2010-11-11 13:02:21 UTC (rev 1800) @@ -76,17 +76,6 @@ protected String coreRuleFile; /** - * Defines where included files will be copied. - * - * Knowing this permits us to parse included xml files only if they were - * modified from a previous build. - * - * @parameter expression="${i18n.cp}" default-value="${basedir}/target/classes" - * @since 2.0 - */ - protected File cp; - - /** * Defines the file name of the getter where to put detected i18n keys while getter phase. * * @parameter expression="${i18n.outputGetter}" default-value="xmlUser.getter"

1 0

r1799 - in trunk/nuiton-i18n-editor/src/main/java/org/nuiton/i18n/editor: project ui
by tchemit＠users.nuiton.org 11 Nov '10

11 Nov '10

Author: tchemit Date: 2010-11-11 14:01:26 +0100 (Thu, 11 Nov 2010) New Revision: 1799 Url: http://nuiton.org/repositories/revision/i18n/1799 Log: use {@code ...} instead of <code>...</code> Modified: trunk/nuiton-i18n-editor/src/main/java/org/nuiton/i18n/editor/project/I18nProject.java trunk/nuiton-i18n-editor/src/main/java/org/nuiton/i18n/editor/project/I18nProjectProvider.java trunk/nuiton-i18n-editor/src/main/java/org/nuiton/i18n/editor/ui/I18nEditorUIHandler.java Modified: trunk/nuiton-i18n-editor/src/main/java/org/nuiton/i18n/editor/project/I18nProject.java =================================================================== --- trunk/nuiton-i18n-editor/src/main/java/org/nuiton/i18n/editor/project/I18nProject.java 2010-11-11 12:08:48 UTC (rev 1798) +++ trunk/nuiton-i18n-editor/src/main/java/org/nuiton/i18n/editor/project/I18nProject.java 2010-11-11 13:01:26 UTC (rev 1799) @@ -48,7 +48,7 @@ /** * - * @return <code>true</code> si la definition du projet est persiste + * @return {@code true} si la definition du projet est persiste */ boolean isStoreProject(); Modified: trunk/nuiton-i18n-editor/src/main/java/org/nuiton/i18n/editor/project/I18nProjectProvider.java =================================================================== --- trunk/nuiton-i18n-editor/src/main/java/org/nuiton/i18n/editor/project/I18nProjectProvider.java 2010-11-11 12:08:48 UTC (rev 1798) +++ trunk/nuiton-i18n-editor/src/main/java/org/nuiton/i18n/editor/project/I18nProjectProvider.java 2010-11-11 13:01:26 UTC (rev 1799) @@ -101,8 +101,8 @@ * ce type de projet. * * @param model le model a valider - * @return <code>true</code> si la partie specifique a ce type de projet - * est valide, <code>false</code> autrement. + * @return {@code true} si la partie specifique a ce type de projet + * est valide, {@code false} autrement. */ boolean validateUIModel(ProjectUIModel model); @@ -114,7 +114,7 @@ * afin de verifier la coherence du projet. * * @param properties les proprietes de la definition du projet - * @return <code>true</code> si le projet est valide. + * @return {@code true} si le projet est valide. */ boolean validateDefinition(Properties properties); } Modified: trunk/nuiton-i18n-editor/src/main/java/org/nuiton/i18n/editor/ui/I18nEditorUIHandler.java =================================================================== --- trunk/nuiton-i18n-editor/src/main/java/org/nuiton/i18n/editor/ui/I18nEditorUIHandler.java 2010-11-11 12:08:48 UTC (rev 1798) +++ trunk/nuiton-i18n-editor/src/main/java/org/nuiton/i18n/editor/ui/I18nEditorUIHandler.java 2010-11-11 13:01:26 UTC (rev 1799) @@ -268,7 +268,7 @@ /** * Méthode pour changer de mode d'affichage. * - * Si <code>fullscreen</code> est à <code>true</code> alors on passe en + * Si <code>fullscreen</code> est à {@code true} alors on passe en * mode console (c'est à dire en mode plein écran exclusif), sinon on * passe en mode fenetré normal. * @@ -938,7 +938,7 @@ * Test if there is some modification on screen, * * @param rootContext the context - * @return <code>true</code> if no more modification is detected + * @return {@code true} if no more modification is detected * @throws IllegalArgumentException if rootContext is null */ protected boolean ensureModification(JAXXContext rootContext) throws IllegalArgumentException {

1 0

r1798 - trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/bundle
by tchemit＠users.nuiton.org 11 Nov '10

11 Nov '10

Author: tchemit Date: 2010-11-11 13:08:48 +0100 (Thu, 11 Nov 2010) New Revision: 1798 Url: http://nuiton.org/repositories/revision/i18n/1798 Log: use {@code ...} instead of <code>...</code> Modified: trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/bundle/I18nBundleEntry.java trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/bundle/I18nBundleUtil.java Modified: trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/bundle/I18nBundleEntry.java =================================================================== --- trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/bundle/I18nBundleEntry.java 2010-11-11 11:16:40 UTC (rev 1797) +++ trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/bundle/I18nBundleEntry.java 2010-11-11 12:08:48 UTC (rev 1798) @@ -99,7 +99,7 @@ * * @param locale the locale to match * @param scope the highest scope to match - * @return <code>true</code> if the entry match the scope and locale * + * @return {@code true} if the entry match the scope and locale * */ public boolean matchLocale(Locale locale, I18nBundleScope scope) { if (this.locale == null) { Modified: trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/bundle/I18nBundleUtil.java =================================================================== --- trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/bundle/I18nBundleUtil.java 2010-11-11 11:16:40 UTC (rev 1797) +++ trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/bundle/I18nBundleUtil.java 2010-11-11 12:08:48 UTC (rev 1798) @@ -283,7 +283,7 @@ * Teste si un ensemble de bundles contient au moins une entrée. * * @param bundles les bundles a parcourir - * @return <code>true</code> si aucune entree trouvee, <code>false</code> + * @return {@code true} si aucune entree trouvee, {@code false} * autrement. */ public static boolean isEmpty(I18nBundle... bundles) {

1 0