September 2009 - cal10n-dev

branch, master, updated. v0.5.1-2-g6486da0
by git-noreply＠pixie.qos.ch 01 Sep '09

01 Sep '09

The branch, master has been updated via 6486da0be0e36b83a9bf0fb013446bc630e77611 (commit) from afd6865749bfcdef8132c154c2519e18cc9426c6 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://git.qos.ch/gitweb/?p=cal10n.git;a=commit;h=6486da0be0e36b83a9bf0fb01… http://github.com/ceki/cal10n/commit/6486da0be0e36b83a9bf0fb013446bc630e776… commit 6486da0be0e36b83a9bf0fb013446bc630e77611 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Tue Sep 1 21:22:20 2009 +0200 Added CAL-1 to the list of bugs fixed in 0.5.2 diff --git a/cal10n-site/src/site/pages/news.html b/cal10n-site/src/site/pages/news.html index 0a65770..0e42b24 100644 --- a/cal10n-site/src/site/pages/news.html +++ b/cal10n-site/src/site/pages/news.html @@ -27,6 +27,14 @@ href="http://www.qos.ch/mailman/listinfo/cal10n-announce">cal10n-announce</a> mailing list.</p> + <hr width="80%" align="center" /> + + <h3>x of September 2009 - Release of CAL10N version 0.5.2</h3> + + <p>Fixed issue <a href="http://jira.qos.ch/browse/CAL-1">CAL-1</a> + as reported by Takeshi Kondo. <code>MessageConveyor</code> will + now correctly handle enums which are nested within other classes + or enums which are nested within another enum.</p> <hr width="80%" align="center" /> ----------------------------------------------------------------------- Summary of changes: cal10n-site/src/site/pages/news.html | 8 ++++++++ 1 files changed, 8 insertions(+), 0 deletions(-) hooks/post-receive -- Compiler assisted localization library

1 0

[JIRA] Created: (CAL-1) Enum#getClass() not always correct
by Ceki Gulcu (JIRA) 01 Sep '09

01 Sep '09

Enum#getClass() not always correct ---------------------------------- Key: CAL-1 URL: http://jira.qos.ch/browse/CAL-1 Project: CAL10N Issue Type: Bug Reporter: Ceki Gulcu Assignee: Ceki Gulcu As reported by Takeshi Kondo in http://www.qos.ch/pipermail/cal10n-dev/2009-September/000280.html Quoting Takeshi: I found a trivial bug. >> MessageConveyor #68 > String resouceBundleName = AnnotationExtractor.getResourceBundleName(key > .getClass()); Enum#getClass() is specific as follows. ---- public enum MSG{ A, B{ // override method } } public static void main(String[] args){ System.out.println(MSG.A.getClass()); // -> $MSG System.out.println(MSG.B.getClass()); // -> $MSG$1 System.out.println(MSG.B.getDeclaringClass()); // $MSG } ---- If we need to get enum class form instance, we have to call Enum#getDeclaringClass(). -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.qos.ch/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira

1 1

branch, master, updated. v0.5.1-1-gafd6865
by git-noreply＠pixie.qos.ch 01 Sep '09

01 Sep '09

The branch, master has been updated via afd6865749bfcdef8132c154c2519e18cc9426c6 (commit) from 59238843c01851b0ebfbb7971f28bf8a8c90470f (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://git.qos.ch/gitweb/?p=cal10n.git;a=commit;h=afd6865749bfcdef8132c154c… http://github.com/ceki/cal10n/commit/afd6865749bfcdef8132c154c2519e18cc9426… commit afd6865749bfcdef8132c154c2519e18cc9426c6 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Tue Sep 1 21:17:38 2009 +0200 Fixing CAL-1 diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java b/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java index dc8a95a..4815e3e 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java @@ -67,7 +67,7 @@ public class MessageConveyor implements IMessageConveyor { String keyAsStr = key.toString(); String resouceBundleName = AnnotationExtractor.getResourceBundleName(key - .getClass()); + .getDeclaringClass()); if (resouceBundleName == null) { throw new IllegalArgumentException( "Missing @ResourceBundleName annotation in enum type [" + key.getClass().getName() diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/Colors.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/Colors.java index 4248147..e05bb00 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/sample/Colors.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/Colors.java @@ -28,5 +28,9 @@ import ch.qos.cal10n.ResourceBundleName; @ResourceBundleName("colors") @LocaleNames({"en_UK", "fr"}) public enum Colors { - RED, BLUE, GREEN; + RED { + + }, + BLUE, + GREEN; } diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageConveyorTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageConveyorTest.java index f60ce2c..4bef85d 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageConveyorTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageConveyorTest.java @@ -30,6 +30,7 @@ import org.junit.Test; import ch.qos.cal10n.MessageConveyor; import ch.qos.cal10n.MessageParameterObj; +import ch.qos.cal10n.sample.Host.OtherColors; public class MessageConveyorTest { @@ -49,6 +50,26 @@ public class MessageConveyorTest { } + // see http://jira.qos.ch/browse/CAL-1 + @Test + public void nestedEnum_EN() { + MessageConveyor rbbmc = new MessageConveyor(Locale.UK); + { + String val = rbbmc.getMessage(Colors.RED); + assertEquals("roses are red", val); + } + + { + String val = rbbmc.getMessage(OtherColors.RED); + assertEquals("roses are red", val); + } + + { + String val = rbbmc.getMessage(OtherColors.BLUE); + assertEquals("violets are blue", val); + } + } + @Test public void smoke_FR() { MessageConveyor rbbmc = new MessageConveyor(Locale.FRANCE); ----------------------------------------------------------------------- Summary of changes: .../main/java/ch/qos/cal10n/MessageConveyor.java | 2 +- .../src/test/java/ch/qos/cal10n/sample/Colors.java | 6 ++++- .../ch/qos/cal10n/sample/MessageConveyorTest.java | 21 ++++++++++++++++++++ 3 files changed, 27 insertions(+), 2 deletions(-) hooks/post-receive -- Compiler assisted localization library

1 0

Release of CAL10N 0.5.1
by Ceki Gulcu 01 Sep '09

01 Sep '09

1st of September 2009 - Release of CAL10N 0.5.1 I am happy to announce the immediate availability of CAL10N version 0.5.1. Please refer to the the news page for precise details. http://cal10n.qos.ch/news.html You can download cal10n, including full source code, class files and documentation on our download page, shown below. http://cal10n.qos.ch/download.html You can receive cal10n related announcements by subscribing to the cal10n announce mailing list. To subscribe to cal10n-announce list, please visit the following URL. http://www.qos.ch/mailman/listinfo/cal10n-announce Best regards, -- Ceki Gülcü Logback: The reliable, generic, fast and flexible logging framework for Java. http://logback.qos.ch

1 0

[GIT] Compiler assisted localization library annotated tag, v0.5.1, created. v0.5.1
by git-noreply＠pixie.qos.ch 01 Sep '09

01 Sep '09

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Compiler assisted localization library". The annotated tag, v0.5.1 has been created at a7bc81c95eb4c3c7908a72f7ddf0758b4d839ba1 (tag) tagging 59238843c01851b0ebfbb7971f28bf8a8c90470f (commit) tagged by Ceki Gulcu on Tue Sep 1 18:00:39 2009 +0200 - Log ----------------------------------------------------------------- adding tag 0.5.1 Ceki Gulcu (10): - resuscitating CAL10N project - ResourceBundle.keySet is new in JDK 1.6 whereas CAL10N targets 1.5 - preparing release 0.5 - removing references to unused dependencies testing notifications Trying to find a OS independent way of constructing the artifact URL. - Cleaned up System.out residues - we now refer to message keys instead of message codes - We now talk about message "keys" instead of message "codes" - cosmetic changes Sebastien Pennec (2): - experimenting with class loading on linux - changing the way in which the URL for dependencies is constructed. ----------------------------------------------------------------------- hooks/post-receive -- Compiler assisted localization library

1 0

[GIT] Compiler assisted localization library branch, master, updated. ae0134494d3c787208b8f574fbee901db9f01c0f
by git-noreply＠pixie.qos.ch 01 Sep '09

01 Sep '09

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Compiler assisted localization library". The branch, master has been updated via ae0134494d3c787208b8f574fbee901db9f01c0f (commit) from 268749b09993fdb1487c7108b724aae54d1db2eb (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://git.qos.ch/gitweb/?p=cal10n.git;a=commit;h=ae0134494d3c787208b8f574f… http://github.com/ceki/cal10n/commit/ae0134494d3c787208b8f574fbee901db9f01c… commit ae0134494d3c787208b8f574fbee901db9f01c0f Author: Ceki Gulcu <ceki(a)qos.ch> Date: Tue Sep 1 17:35:16 2009 +0200 - We now talk about message "keys" instead of message "codes" - added link to log4j manual diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/IMessageConveyor.java b/cal10n-api/src/main/java/ch/qos/cal10n/IMessageConveyor.java index 53fb1b6..14c4275 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/IMessageConveyor.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/IMessageConveyor.java @@ -29,7 +29,7 @@ import java.text.MessageFormat; // which locale to use. /** - * Retrieve a message by its code as specified by an enum. + * Retrieve a localized message by its key as specified by an enum. * * <p> * The strategy in retrieving messages may vary from implementation to @@ -40,11 +40,11 @@ import java.text.MessageFormat; public interface IMessageConveyor { /** - * Retrieve a message by its code as specified by an enum. + * Retrieve a localized message by its key as specified by an enum. * * <p> * Note that any further arguments passed in 'args' will be interpolated using - * the translated message. The interpolation will be done according to + * the translated message. The interpolation will be done by and according to * conventions of {@link MessageFormat}. * * @param <E> @@ -59,10 +59,14 @@ public interface IMessageConveyor { /** * Syntactic sugar for the case where the massage is contained in a - * {@link MessageParameterObj}. + * {@link MessageParameterObj}. * - * <p>Equivalent to calling - * <pre>getMessage(mpo.getKey(), mpo.getArgs());</pre> + * <p> + * Equivalent to calling + * + * <pre> + * getMessage(mpo.getKey(), mpo.getArgs()); + * </pre> * * @see #getMessage(Enum, Object...) * @param mpo diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/LocaleNames.java b/cal10n-api/src/main/java/ch/qos/cal10n/LocaleNames.java index 20e2b14..db6602b 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/LocaleNames.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/LocaleNames.java @@ -45,13 +45,13 @@ import ch.qos.cal10n.verifier.MessageKeyVerifier; * * <p> * In the above example, @LocaleNames({"en", "jp"}) means that there are English - * (en) and Japanese translations for the message codes found the Colors enum. - * The name of the corresponding resource bundle named "colors". + * (en) and Japanese translations for the message keys found in the Colors enum. + * The name of the corresponding resource bundle is named "colors". * * <p> - * Verification tools such {@link MessageKeyVerifier} can thus conclude that - * the resource bundle files <em>colors_en.properties</em> and - * <em>colors_jp.properties</em> exist and should be checked against the codes + * Verification tools such {@link MessageKeyVerifier} can thus conclude that the + * resource bundle files <em>colors_en.properties</em> and + * <em>colors_jp.properties</em> should exist and checked against the keys * defined in the Colors enum. * * @author Ceki Gülcü diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java b/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java index b8670b3..dc8a95a 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java @@ -70,7 +70,7 @@ public class MessageConveyor implements IMessageConveyor { .getClass()); if (resouceBundleName == null) { throw new IllegalArgumentException( - "Missing ResourceBundleAnnotation in [" + key.getClass().getName() + "Missing @ResourceBundleName annotation in enum type [" + key.getClass().getName() + "]. See also " + Cal10nConstants.MISSING_RB_ANNOTATION_URL); } ResourceBundle rb = ResourceBundle.getBundle(resouceBundleName, locale); diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/MessageParameterObj.java b/cal10n-api/src/main/java/ch/qos/cal10n/MessageParameterObj.java index ff5101b..7dca602 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/MessageParameterObj.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/MessageParameterObj.java @@ -26,12 +26,12 @@ import java.util.Arrays; /** * Holds data relevant for a deferred message lookup. This is useful when the - * appropriate locale is unknown at the time or place where the message key and - * message args are emitted. For example, a low level library might emit a - * localized message but it is only at the UI (user interface) layer that the - * locale is known. As another example, imagine that the host where the + * appropriate locale is <em>unknown</em> at the time or place where the message + * key and message args are emitted. For example, a low level library might wish + * to emit a localized message but it is only at the UI (user interface) layer + * that the locale is known. As another example, imagine that the host where the * localized messages are presented to the user is in a different locale, e.g. - * Japan, than the source host. e.g. US. + * Japan, than the locale of the source host. e.g. US. * * <p> * Instances of this class are intended to be immutable, subject to the @@ -49,8 +49,8 @@ public class MessageParameterObj { /** * Constructs an instance. * - * @param code - * the code for the corresponding resource. + * @param key + * the key for the localized message. * @param args * any message parameters, as required. */ @@ -72,7 +72,7 @@ public class MessageParameterObj { @Override public String toString() { - final StringBuilder b = new StringBuilder("Message("); + final StringBuilder b = new StringBuilder("MessageParameterObj("); b.append(key.name()); b.append(", "); b.append(Arrays.toString(args)); diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java b/cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java index 7d730fa..4dc28b1 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java @@ -52,7 +52,8 @@ import ch.qos.cal10n.verifier.MessageKeyVerifier; * * <p> * Verification tools such as {@link MessageKeyVerifier} can then proceed to - * check that the codes defined in the enum type match those in the resource bundles. + * check that the keys defined in the enum type match those in the corresponding + * resource bundles. * * @author Ceki Gülcü * diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/Cal10nError.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/Cal10nError.java index b4ba6d8..db048f3 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/Cal10nError.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/Cal10nError.java @@ -59,7 +59,7 @@ public class Cal10nError { return errorType; } - public String getCode() { + public String getKey() { return key; } diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/ErrorFactory.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/ErrorFactory.java index 6445b2b..3a3476c 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/ErrorFactory.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/ErrorFactory.java @@ -44,8 +44,8 @@ public class ErrorFactory { this.resourceBundleName = resourceBundleName; } - Cal10nError buildError(ErrorType errorType, String code) { - return new Cal10nError(errorType, code, enumClass, locale, + Cal10nError buildError(ErrorType errorType, String key) { + return new Cal10nError(errorType, key, enumClass, locale, resourceBundleName); } } diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageKeyVerifier.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageKeyVerifier.java index 4effb60..48465e9 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageKeyVerifier.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageKeyVerifier.java @@ -131,12 +131,6 @@ public class MessageKeyVerifier implements IMessageKeyVerifier { return set; } - /* - * (non-Javadoc) - * - * @see ch.qos.cal10n.verifier.IIMessageCodeVerifier#typeIsolatedVerify(java. - * util.Locale) - */ public List<String> typeIsolatedVerify(Locale locale) { List<Cal10nError> errorList = verify(locale); List<String> strList = new ArrayList<String>(); @@ -168,11 +162,6 @@ public class MessageKeyVerifier implements IMessageKeyVerifier { return errorList; } - /* - * (non-Javadoc) - * - * @see ch.qos.cal10n.verifier.IIMessageCodeVerifier#getLocaleNames() - */ public String[] getLocaleNames() { String[] localeNameArray = AnnotationExtractor.getLocaleNames(enumType); return localeNameArray; diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageCodeVerifierTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageKeyVerifierTest.java similarity index 85% rename from cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageCodeVerifierTest.java rename to cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageKeyVerifierTest.java index e0354a6..c0d67c5 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageCodeVerifierTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageKeyVerifierTest.java @@ -37,7 +37,7 @@ import ch.qos.cal10n.verifier.MessageKeyVerifier; * * @author Ceki Gülcü */ -public class MessageCodeVerifierTest { +public class MessageKeyVerifierTest { @Test @@ -52,8 +52,8 @@ public class MessageCodeVerifierTest { IMessageKeyVerifier miv = new MessageKeyVerifier(Countries.class); List<Cal10nError> errorList = miv.verify(Locale.UK); assertEquals(2, errorList.size()); - assertEquals("CH", errorList.get(0).getCode()); - assertEquals("BR", errorList.get(1).getCode()); + assertEquals("CH", errorList.get(0).getKey()); + assertEquals("BR", errorList.get(1).getKey()); } @@ -62,8 +62,8 @@ public class MessageCodeVerifierTest { IMessageKeyVerifier miv = new MessageKeyVerifier(Countries.class); List<Cal10nError> errorList = miv.verify(Locale.FRANCE); assertEquals(3, errorList.size()); - assertEquals("CH", errorList.get(0).getCode()); - assertEquals("CN", errorList.get(1).getCode()); - assertEquals("BR", errorList.get(2).getCode()); + assertEquals("CH", errorList.get(0).getKey()); + assertEquals("CN", errorList.get(1).getKey()); + assertEquals("BR", errorList.get(2).getKey()); } } diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/PackageTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/PackageTest.java index 206b651..ba875ed 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/sample/PackageTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/PackageTest.java @@ -27,6 +27,6 @@ import org.junit.runners.Suite; import org.junit.runners.Suite.SuiteClasses; @RunWith(Suite.class) -@SuiteClasses( { MessageCodeVerifierTest.class, MessageConveyorTest.class }) +@SuiteClasses( { MessageKeyVerifierTest.class, MessageConveyorTest.class }) public class PackageTest { } diff --git a/cal10n-site/src/site/pages/codes.html b/cal10n-site/src/site/pages/codes.html new file mode 100644 index 0000000..876ed88 --- /dev/null +++ b/cal10n-site/src/site/pages/codes.html @@ -0,0 +1,70 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> + <title>Error codes</title> + <link rel="stylesheet" type="text/css" href="css/common.css" /> + <link rel="stylesheet" type="text/css" href="css/screen.css" media="screen" /> + <link rel="stylesheet" type="text/css" href="css/_print.css" media="print" /> + + </head> + <body> + <script type="text/javascript">prefix='';</script> + <script src="templates/header.js" type="text/javascript"></script> + <div id="left"> + <noscript>Please turn on Javascript to view this menu</noscript> + <script src="templates/left.js" type="text/javascript"></script> + </div> + <div id="content"> + + + <h1>CAL10N error codes and their meanings</h1> + + + <h3><a name="missingRBAnnotation" + href="#missingRBAnnotation">Missing + <code>@ResourceBundleName</code> annotation in enum type [...]. + </a> + </h3> + + <p>The @ResourceBundleName annotation is mandatory when an + enum type is used in conjuction with <a + href="apidocs/ch/qos/cal10n/MessageConveyor.html">MessageConveyor</a> + to retreive localized messages. See the <a + href="manual.html#core">user manual</a> as well as the javadocs + for <a + href="apidocs/ch/qos/cal10n/ResourceBundleName.html">ResourceBundleName</a> + annotation for more details. + </p> + + <hr/> + + <h3><a name="missingEnumType" href="#missingEnumType">Missing + <code><enumTypes></code> element.</a> + </h3> + + <p>The <code><enumTypes></code> is a required parameter of the + <em>maven-cal10n-plugin</em>. Please refer to the section on <a + href="manual.html#mavenPlugin"><em>maven-cal10n-plugin</em></a> in + the user manual for more details. + </p> + + + <hr/> + + <h3><a name="missingLocale" href="#missingLocale">Missing + @LocaleNames annotation in enum type [...].</a> + </h3> + + <p>If an enum type and its associated bundles are to be verified + via the <em>maven-cal10n-plugin</em>, then the enum type needs to + be annotated with <a + href="apidocs/ch/qos/cal10n/LocaleNames.html">LocaleNames</a>. + </p> + + <script src="templates/footer.js" type="text/javascript"></script> +</div> +</body> +</html> diff --git a/cal10n-site/src/site/pages/css/screen.css b/cal10n-site/src/site/pages/css/screen.css index 65d6987..bea6eeb 100644 --- a/cal10n-site/src/site/pages/css/screen.css +++ b/cal10n-site/src/site/pages/css/screen.css @@ -34,16 +34,21 @@ p.menu { #left { position: absolute; left: 0px; - width: 15em; - color: #564b47; + width: 15em; margin: 4px 0px 0px 4px; padding: 0px; + font-size: 80%; + background-color: #ffffff; +} + +.menuGroup { border: 1px solid #cccccc; background-color: #ffffff; - font-size: 80%; + color: #564b47; + border: 1px solid #cccccc; } -#left a, #right a { +.menuGroup a { display: block; width: 95.5%; margin: 0px; @@ -53,6 +58,16 @@ p.menu { text-decoration: none; } +.menuGroup a:hover { + border: solid 1px #FFFFFF; + background-color: #3333CC; + color: #ffffff; +} + +.pub { + text-align: center; +} + p.menu_header { margin: 0px; padding: 2px; @@ -62,21 +77,6 @@ p.menu_header { border-bottom: solid 1px #CCCCCC; } -#left img { - display: block; - margin: 20px 0 20px 17px; - border: none; -} - -#left a:hover, #right a:hover { - border: solid 1px #FFFFFF; - background-color: #3333CC; - color: #ffffff; -} - -#left a:hover.x { - background-color: #fff; -} #right { position: absolute; diff --git a/cal10n-site/src/site/pages/documentation.html b/cal10n-site/src/site/pages/documentation.html index d1386ea..0d6dde7 100644 --- a/cal10n-site/src/site/pages/documentation.html +++ b/cal10n-site/src/site/pages/documentation.html @@ -27,6 +27,7 @@ <ul> <li><a href="manual.html"><b>The CAL10N manual</b></a></li> + <li><a href="codes.html">Error codes and their meanings</a></li> </ul> <p>Source code related documentation:</p> diff --git a/cal10n-site/src/site/pages/index.html b/cal10n-site/src/site/pages/index.html index a1fbe85..0d1c527 100644 --- a/cal10n-site/src/site/pages/index.html +++ b/cal10n-site/src/site/pages/index.html @@ -17,6 +17,7 @@ <noscript>Please turn on Javascript to view this menu</noscript> <script src="templates/left.js" type="text/javascript"></script> </div> + <div id="content"> diff --git a/cal10n-site/src/site/pages/manual.html b/cal10n-site/src/site/pages/manual.html index 9d62b09..487ea8a 100644 --- a/cal10n-site/src/site/pages/manual.html +++ b/cal10n-site/src/site/pages/manual.html @@ -76,7 +76,7 @@ </p> - <h3>Core idea</h3> + <h2><a name="code" href="#core">Core idea</a></h2> <p>Instead of using values of type String as the key for each message, CAL10N uses <code>enums</code>.</p> @@ -126,12 +126,14 @@ RED=les roses sont rouges GREEN=les {0} sont verts</pre> - <h2>Retrieving internationalized messages</h2> + <h2><a name="retrieving" href="#retrieving">Retrieving + internationalized messages</a></h2> <p>In your application, you would retrieve the localized message via an <a href="apidocs/ch/qos/cal10n/IMessageConveyor.html">IMessageConveyor</a> - instance. </p> + instance. + </p> <pre class="prettyprint source">// obtain a message conveyor for France IMessageConveyor mc = new MessageConveyor(Locale.FRANCE); @@ -150,7 +152,33 @@ String blue = mc.getMessage(Colors.BLUE); </pre> comes with additional tooling support. </p> - <h2>Verification as a test case</h2> + + <h2><a name="deferred" href="#deferred">Deferred localization</a></h2> + + <p>Under certain circumstances, the appropriate locale is + <em>unknown</em> at the time or place where the message key and + message args are emitted. For example, a low level library might + wish to emit a localized message but it is only at the UI (user + interface) layer that the locale is known. As another example, + imagine that the host where the localized messages are presented to + the user is in a different locale, e.g. Japan, than the locale of + the source host. e.g. US. + </p> + + <p>The <a + href="xref/ch/qos/cal10n/MessageParameterObj.html">MessageParameterObj</a> + class is intended to support this particular use case. It allows you + to bundle the message key (an enum) plus any message + arguments. At a later time, when the locale is known, you would + invoke the <a + href="apidocs/ch/qos/cal10n/IMessageConveyor.html#getMessage(ch.qos.cal10n.MessageParameterObj)">getMessage(MessageParameterObj)</a> + method in <code>IMessageConveyor</code> to obtain the localized + message. + </p> + + + <h2><a name="verification" href="#verification">Verification as a + test case</a></h2> <p>A convenient and low hassle method for checking for mismatches between a given enum type and the corresponding resource bundles is @@ -255,7 +283,7 @@ public class MyAllInOneColorVerificationTest { } </pre> - <h2>Maven Plugin</h2> + <h2><a name="mavenPlugin" href="#mavenPlugin">Maven Plugin</a></h2> <p>The CAL10N project ships with a maven plugin designed to verify that the keys specified in a given enum type match those found in @@ -313,7 +341,7 @@ public class MyAllInOneColorVerificationTest { annotation. </p> - <h2>Eclipse plug-in</h2> + <h2><a name="eclipsePlugin" href="#eclipsePlugin">Eclipse plug-in</a></h2> <p>We are looking for volunteers willing to implement IDE support for CAL10N. Below is a litst of possible features of this IDE which @@ -349,7 +377,7 @@ public class MyAllInOneColorVerificationTest { <p>If interested please contact the cal10n-dev mailing list.</p> - <h2>Ant task</h2> + <h2><a name="antTask" href="#antTask">Ant task</a></h2> <p>We are looking for volunteers to implement an Ant task to verify resource bundles. The Ant task could be modeled after the diff --git a/cal10n-site/src/site/pages/news.html b/cal10n-site/src/site/pages/news.html index dac2e1d..0a65770 100644 --- a/cal10n-site/src/site/pages/news.html +++ b/cal10n-site/src/site/pages/news.html @@ -33,9 +33,16 @@ <h3>1st of September 2009 - Release of CAL10N version 0.5.1</h3> <p>Fixed a bug causing the <em>maven-cal10n-plugin</em> to fail on - Linux. The plug-in is not tested on both Windows and Linux. + Linux. The plug-in is now tested on both Windows and Linux to work + as expected. </p> + <p>Added support for <a href="manual.html#deferred">deferred + localization</a>.</p> + + <p>Added page on CAL10N <a href="codes.html">error codes</a> and + their meanings.</p> + <hr width="80%" align="center" /> diff --git a/cal10n-site/src/site/pages/templates/left.js b/cal10n-site/src/site/pages/templates/left.js index ab10619..85428dc 100644 --- a/cal10n-site/src/site/pages/templates/left.js +++ b/cal10n-site/src/site/pages/templates/left.js @@ -1,19 +1,18 @@ -document.write('<p class="menu_header">CAL10N project</p>'); -document.write('<p class="menu"><a href="' + prefix + 'index.html">Introduction</a></p>'); -document.write('<p class="menu"><a href="' + prefix + 'news.html">News</a></p>'); -document.write('<p class="menu"><a href="' + prefix + 'download.html">Download</a></p>'); -document.write('<p class="menu"><a href="' + prefix + 'documentation.html">Documentation</a></p>'); -document.write('<p class="menu"><a href="' + prefix + 'mailinglist.html">Mailing Lists</a></p>'); -document.write('<p class="menu"><a href="' + prefix + 'repos.html">Source Repository</a></p>'); -document.write('<p class="menu"><a href="' + prefix + 'bugreport.html">Bug Report</a></p>'); -document.write('<p class="menu"><a href="' + prefix + 'license.html">License</a></p>'); - - -// document.write('<p>Sponsored by:'); -// document.write('<a href="http://www.qos.ch/"><img src="' + prefix + 'images/qoslogo.gif" border="1"/></a></p>'); - - - - - +document.write('<div class="menuGroup">'); +document.write(' <p class="menu_header">CAL10N project</p>'); +document.write(' <p class="menu"><a href="' + prefix + 'index.html">Introduction</a></p>'); +document.write(' <p class="menu"><a href="' + prefix + 'news.html">News</a></p>'); +document.write(' <p class="menu"><a href="' + prefix + 'download.html">Download</a></p>'); +document.write(' <p class="menu"><a href="' + prefix + 'documentation.html">Documentation</a></p>'); +document.write(' <p class="menu"><a href="' + prefix + 'mailinglist.html">Mailing Lists</a></p>'); +document.write(' <p class="menu"><a href="' + prefix + 'repos.html">Source Repository</a></p>'); +document.write(' <p class="menu"><a href="' + prefix + 'bugreport.html">Bug Report</a></p>'); +document.write(' <p class="menu"><a href="' + prefix + 'license.html">License</a></p>'); +document.write('</div>'); + +document.write('<p class="pub">'); +document.write(' <a href="https://www.qos.ch/shop/products/log4j/log4j-Manual.jsp">'); +document.write(' <img src="images/buyDirect.jpg" border="0" title="" alt="buy direct from the developer"/>'); +document.write(' </a>'); +document.write('</p>'); \ No newline at end of file diff --git a/cal10n-site/src/site/resources/images/buyDirect.jpg b/cal10n-site/src/site/resources/images/buyDirect.jpg new file mode 100644 index 0000000..dd2ff4c Binary files /dev/null and b/cal10n-site/src/site/resources/images/buyDirect.jpg differ diff --git a/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java index d5d804b..72d7c83 100644 --- a/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java +++ b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java @@ -92,7 +92,7 @@ public class VerifyMojo extends AbstractMojo { + MISSING_ENUM_TYPES); } for (String enumTypeAsStr : enumTypes) { - IMessageKeyVerifier imcv = getMessageCodeVerifierInstance(enumTypeAsStr); + IMessageKeyVerifier imcv = getMessageKeyVerifierInstance(enumTypeAsStr); getLog() .info( "Checking all resource bundles for enum type [" + enumTypeAsStr @@ -110,7 +110,7 @@ public class VerifyMojo extends AbstractMojo { if (localeNameArray == null || localeNameArray.length == 0) { String errMsg = "Missing @LocaleNames annotation in enum type [" - + enumClassAsStr + "]"; + + enumClassAsStr + "]. Please see "+MISSING_LOCALE; getLog().error(errMsg); throw new MojoFailureException(errMsg); } @@ -136,13 +136,13 @@ public class VerifyMojo extends AbstractMojo { } if (failure) { throw new MojoFailureException("FAIL Verification of [" + enumClassAsStr - + "] codes."); + + "] keys."); } } - IMessageKeyVerifier getMessageCodeVerifierInstance(String enumClassAsStr) + IMessageKeyVerifier getMessageKeyVerifierInstance(String enumClassAsStr) throws MojoExecutionException { - String errMsg = "Failed to instantiate MessageCodeVerifier class"; + String errMsg = "Failed to instantiate MessageKeyVerifier class"; try { ThisFirstClassLoader thisFirstClassLoader = (ThisFirstClassLoader) buildClassLoader(); Class<?> mkvClass = Class.forName(Cal10nConstants.MessageKeyVerifier_FQCN, ----------------------------------------------------------------------- Summary of changes: .../main/java/ch/qos/cal10n/IMessageConveyor.java | 16 +++-- .../src/main/java/ch/qos/cal10n/LocaleNames.java | 10 ++-- .../main/java/ch/qos/cal10n/MessageConveyor.java | 2 +- .../java/ch/qos/cal10n/MessageParameterObj.java | 16 ++-- .../java/ch/qos/cal10n/ResourceBundleName.java | 3 +- .../java/ch/qos/cal10n/verifier/Cal10nError.java | 2 +- .../java/ch/qos/cal10n/verifier/ErrorFactory.java | 4 +- .../ch/qos/cal10n/verifier/MessageKeyVerifier.java | 11 --- ...rifierTest.java => MessageKeyVerifierTest.java} | 12 ++-- .../java/ch/qos/cal10n/sample/PackageTest.java | 2 +- cal10n-site/src/site/pages/codes.html | 70 ++++++++++++++++++++ cal10n-site/src/site/pages/css/screen.css | 38 +++++----- cal10n-site/src/site/pages/documentation.html | 1 + cal10n-site/src/site/pages/index.html | 1 + cal10n-site/src/site/pages/manual.html | 42 ++++++++++-- cal10n-site/src/site/pages/news.html | 9 ++- cal10n-site/src/site/pages/templates/left.js | 35 +++++----- .../src/site/resources/images/buyDirect.jpg | Bin 0 -> 24142 bytes .../java/ch/qos/cal10n/plugins/VerifyMojo.java | 10 ++-- 19 files changed, 192 insertions(+), 92 deletions(-) rename cal10n-api/src/test/java/ch/qos/cal10n/sample/{MessageCodeVerifierTest.java => MessageKeyVerifierTest.java} (85%) create mode 100644 cal10n-site/src/site/pages/codes.html create mode 100644 cal10n-site/src/site/resources/images/buyDirect.jpg hooks/post-receive -- Compiler assisted localization library

1 0

[GIT] Compiler assisted localization library branch, master, updated. 268749b09993fdb1487c7108b724aae54d1db2eb
by git-noreply＠pixie.qos.ch 01 Sep '09

01 Sep '09

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Compiler assisted localization library". The branch, master has been updated via 268749b09993fdb1487c7108b724aae54d1db2eb (commit) from e3551bfd202a35a9dcc796b992317d3ed2570935 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://git.qos.ch/gitweb/?p=cal10n.git;a=commit;h=268749b09993fdb1487c7108b… http://github.com/ceki/cal10n/commit/268749b09993fdb1487c7108b724aae54d1db2… commit 268749b09993fdb1487c7108b724aae54d1db2eb Author: Ceki Gulcu <ceki(a)qos.ch> Date: Tue Sep 1 14:06:37 2009 +0200 - we now refer to message keys instead of message codes - added support for MessageParameterObj based on contribution by Rick Beton diff --git a/cal10n-api/pom.xml b/cal10n-api/pom.xml index ea8c23d..f7486f7 100644 --- a/cal10n-api/pom.xml +++ b/cal10n-api/pom.xml @@ -5,7 +5,7 @@ <parent> <groupId>ch.qos.cal10n</groupId> <artifactId>cal10n-parent</artifactId> - <version>0.5</version> + <version>0.5.1</version> </parent> <modelVersion>4.0.0</modelVersion> diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java b/cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java index 05a67a4..d782ec1 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java @@ -12,5 +12,5 @@ public class Cal10nConstants { final public static String CODE_URL_PREFIX = "http://cal10n.qos.ch/codes.html"; final public static String MISSING_RB_ANNOTATION_URL = Cal10nConstants.CODE_URL_PREFIX+"#missingRBAnnotation"; - final public static String MessageCodeVerifier_FQCN = "ch.qos.cal10n.verifier.MessageCodeVerifier"; + final public static String MessageKeyVerifier_FQCN = "ch.qos.cal10n.verifier.MessageKeyVerifier"; } diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/IMessageConveyor.java b/cal10n-api/src/main/java/ch/qos/cal10n/IMessageConveyor.java index f54c19d..53fb1b6 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/IMessageConveyor.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/IMessageConveyor.java @@ -49,16 +49,25 @@ public interface IMessageConveyor { * * @param <E> * an enum type - * @param e + * @param key * an enum instance * @param args * optional arguments - * @return + * @return The translated/localized message + */ + <E extends Enum<?>> String getMessage(E key, Object... args); + + /** + * Syntactic sugar for the case where the massage is contained in a + * {@link MessageParameterObj}. * - * @param <E> - * @param e - * @param args - * @return + * <p>Equivalent to calling + * <pre>getMessage(mpo.getKey(), mpo.getArgs());</pre> + * + * @see #getMessage(Enum, Object...) + * @param mpo + * The MessageParameterObj to translate + * @return translated message */ - <E extends Enum<?>> String getMessage(E e, Object... args); + String getMessage(MessageParameterObj mpo); } diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/LocaleNames.java b/cal10n-api/src/main/java/ch/qos/cal10n/LocaleNames.java index 46c4832..20e2b14 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/LocaleNames.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/LocaleNames.java @@ -26,7 +26,7 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -import ch.qos.cal10n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.MessageKeyVerifier; /** * This annotation serves to designate a list of locale names for which resource @@ -49,7 +49,7 @@ import ch.qos.cal10n.verifier.MessageCodeVerifier; * The name of the corresponding resource bundle named "colors". * * <p> - * Verification tools such {@link MessageCodeVerifier} can thus conclude that + * Verification tools such {@link MessageKeyVerifier} can thus conclude that * the resource bundle files <em>colors_en.properties</em> and * <em>colors_jp.properties</em> exist and should be checked against the codes * defined in the Colors enum. diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java b/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java index c061195..b8670b3 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java @@ -51,32 +51,33 @@ public class MessageConveyor implements IMessageConveyor { } /** - * Given an enum e, find the corresponding resource bundle and return the - * internationalized message defined by the message code 'e'. + * Given an enum as key, find the corresponding resource bundle and return the + * corresponding internationalized. * * <p> * The name of the resource bundle is defined via the - * {@link ResourceBundleName} annotation whereas the locale was specified in + * {@link ResourceBundleName} annotation whereas the locale is specified in * this MessageConveyor instance's constructor. * - * @param e an enum instance used as message code + * @param key + * an enum instance used as message key * */ - public <E extends Enum<?>> String getMessage(E e, Object... args) { - String code = e.toString(); + public <E extends Enum<?>> String getMessage(E key, Object... args) { + String keyAsStr = key.toString(); - String resouceBundleName = AnnotationExtractor.getResourceBundleName(e + String resouceBundleName = AnnotationExtractor.getResourceBundleName(key .getClass()); if (resouceBundleName == null) { throw new IllegalArgumentException( - "Missing ResourceBundleAnnotation in [" + e.getClass().getName() + "Missing ResourceBundleAnnotation in [" + key.getClass().getName() + "]. See also " + Cal10nConstants.MISSING_RB_ANNOTATION_URL); } ResourceBundle rb = ResourceBundle.getBundle(resouceBundleName, locale); - String value = rb.getString(code); + String value = rb.getString(keyAsStr); if (value == null) { - return "No key found for " + code; + return "No key found for " + keyAsStr; } else { if (args == null || args.length == 0) { return value; @@ -86,4 +87,12 @@ public class MessageConveyor implements IMessageConveyor { } } + public String getMessage(MessageParameterObj mpo) { + if (mpo == null) { + throw new IllegalArgumentException( + "MessageParameterObj argumument cannot be null"); + } + return getMessage(mpo.getKey(), mpo.getArgs()); + } + } diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/MessageParameterObj.java b/cal10n-api/src/main/java/ch/qos/cal10n/MessageParameterObj.java new file mode 100644 index 0000000..ff5101b --- /dev/null +++ b/cal10n-api/src/main/java/ch/qos/cal10n/MessageParameterObj.java @@ -0,0 +1,104 @@ +/* + * Copyright (c) 2009 QOS.ch All rights reserved. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +package ch.qos.cal10n; + +import java.util.Arrays; + +/** + * Holds data relevant for a deferred message lookup. This is useful when the + * appropriate locale is unknown at the time or place where the message key and + * message args are emitted. For example, a low level library might emit a + * localized message but it is only at the UI (user interface) layer that the + * locale is known. As another example, imagine that the host where the + * localized messages are presented to the user is in a different locale, e.g. + * Japan, than the source host. e.g. US. + * + * <p> + * Instances of this class are intended to be immutable, subject to the + * immutability of the supplied args. + * + * @author Rick Beton + * @author Ceki Gülcü + * + */ +public class MessageParameterObj { + + private final Enum<?> key; + private final Object[] args; + + /** + * Constructs an instance. + * + * @param code + * the code for the corresponding resource. + * @param args + * any message parameters, as required. + */ + public MessageParameterObj(Enum<?> key, Object... args) { + if (key == null) { + new IllegalArgumentException("Enum argument \"key\" can't be null"); + } + this.key = key; + this.args = args; + } + + public Enum<?> getKey() { + return key; + } + + public Object[] getArgs() { + return args; + } + + @Override + public String toString() { + final StringBuilder b = new StringBuilder("Message("); + b.append(key.name()); + b.append(", "); + b.append(Arrays.toString(args)); + b.append(")"); + return b.toString(); + } + + @Override + public int hashCode() { + return key.hashCode(); + } + + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (getClass() != obj.getClass()) + return false; + + MessageParameterObj other = (MessageParameterObj) obj; + // key cannot be null by virtue of the check done within the constructor + if (!key.equals(other.key)) + return false; + + return Arrays.equals(args, other.args); + } +} diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java b/cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java index a865d1d..7d730fa 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java @@ -27,7 +27,7 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; -import ch.qos.cal10n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.MessageKeyVerifier; /** * This annotation serves to designate the name of the resource bundle @@ -51,7 +51,7 @@ import ch.qos.cal10n.verifier.MessageCodeVerifier; * files <em>colors_en.properties</em> and <em>colors_jp.properties</em> exist. * * <p> - * Verification tools such as {@link MessageCodeVerifier} can then proceed to + * Verification tools such as {@link MessageKeyVerifier} can then proceed to * check that the codes defined in the enum type match those in the resource bundles. * * @author Ceki Gülcü diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/Cal10nError.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/Cal10nError.java index 5bad0aa..b4ba6d8 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/Cal10nError.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/Cal10nError.java @@ -39,16 +39,16 @@ public class Cal10nError { } final ErrorType errorType; - final String code; + final String key; final Locale locale; final Class<?> enumClass; final String enumClassName; final String resouceBundleName; - Cal10nError(ErrorType errorType, String code, Class<?> enumClass, + Cal10nError(ErrorType errorType, String key, Class<?> enumClass, Locale locale, String resourceBundleName) { this.errorType = errorType; - this.code = code; + this.key = key; this.enumClass = enumClass; this.enumClassName = enumClass.getName(); this.locale = locale; @@ -60,7 +60,7 @@ public class Cal10nError { } public String getCode() { - return code; + return key; } public Locale getLocale() { @@ -91,11 +91,11 @@ public class Cal10nError { case EMPTY_ENUM: return "Empty enum type [" + enumClassName + "]"; case ABSENT_IN_ENUM: - return "Code [" + code + "] present in resource bundle named [" + return "Key [" + key + "] present in resource bundle named [" + resouceBundleName + "] for locale [" + locale + "] but absent in enum type [" + enumClassName + "]"; case ABSENT_IN_RB: - return "Code [" + code + "] present in enum type [" + enumClassName + return "Key [" + key + "] present in enum type [" + enumClassName + "] but absent in resource bundle named [" + resouceBundleName + "] for locale [" + locale + "]"; default: diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageCodeVerifier.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageKeyVerifier.java similarity index 90% rename from cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageCodeVerifier.java rename to cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageKeyVerifier.java index de30c9a..5dee005 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageCodeVerifier.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageKeyVerifier.java @@ -8,12 +8,12 @@ import java.util.Locale; * found in the corresponding resource bundles. * * <p> - * See also {@link MessageCodeVerifier} for a concrete implementation. + * See also {@link MessageKeyVerifier} for a concrete implementation. * * @author Ceki Gülcü * */ -public interface IMessageCodeVerifier { +public interface IMessageKeyVerifier { // WARNING: The name of this class is referenced in String form // to do class loader tricks. Do not change the name of this class diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageKeyVerifier.java similarity index 87% rename from cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java rename to cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageKeyVerifier.java index 0146e1f..4effb60 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageKeyVerifier.java @@ -35,22 +35,22 @@ import ch.qos.cal10n.verifier.Cal10nError.ErrorType; /** * Given an enum class, verify that the resource bundles corresponding to a - * given locale contains the correct codes. + * given locale contains the correct keys. * * @author Ceki Gulcu */ -public class MessageCodeVerifier implements IMessageCodeVerifier { +public class MessageKeyVerifier implements IMessageKeyVerifier { Class<? extends Enum<?>> enumType; String enumTypeAsStr; - public MessageCodeVerifier(Class<? extends Enum<?>> enumClass) { + public MessageKeyVerifier(Class<? extends Enum<?>> enumClass) { this.enumType = enumClass; this.enumTypeAsStr = enumClass.getName(); } @SuppressWarnings("unchecked") - public MessageCodeVerifier(String enumTypeAsStr) { + public MessageKeyVerifier(String enumTypeAsStr) { this.enumTypeAsStr = enumTypeAsStr; String errMsg = "Failed to find enum class [" + enumTypeAsStr + "]"; try { @@ -62,29 +62,14 @@ public class MessageCodeVerifier implements IMessageCodeVerifier { } } - /* - * (non-Javadoc) - * - * @see ch.qos.cai10n.verifier.IIMessageCodeVerifier#getEnumType() - */ public Class<? extends Enum<?>> getEnumType() { return enumType; } - /* - * (non-Javadoc) - * - * @see ch.qos.cal10n.verifier.IIMessageCodeVerifier#getEnumTypeAsStr() - */ public String getEnumTypeAsStr() { return enumTypeAsStr; } - /* - * (non-Javadoc) - * - * @see ch.qos.cal10n.verifier.IIMessageCodeVerifier#verify(java.util.Locale) - */ public List<Cal10nError> verify(Locale locale) { List<Cal10nError> errorList = new ArrayList<Cal10nError>(); diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageCodeVerifierTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageCodeVerifierTest.java index 847c368..e0354a6 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageCodeVerifierTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageCodeVerifierTest.java @@ -30,8 +30,8 @@ import java.util.Locale; import org.junit.Test; import ch.qos.cal10n.verifier.Cal10nError; -import ch.qos.cal10n.verifier.IMessageCodeVerifier; -import ch.qos.cal10n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.IMessageKeyVerifier; +import ch.qos.cal10n.verifier.MessageKeyVerifier; /** * @@ -42,14 +42,14 @@ public class MessageCodeVerifierTest { @Test public void smoke() { - IMessageCodeVerifier miv = new MessageCodeVerifier(Colors.class); + IMessageKeyVerifier miv = new MessageKeyVerifier(Colors.class); List<Cal10nError> errorList = miv.verify(Locale.UK); assertEquals(0, errorList.size()); } @Test public void withErrors_UK() { - IMessageCodeVerifier miv = new MessageCodeVerifier(Countries.class); + IMessageKeyVerifier miv = new MessageKeyVerifier(Countries.class); List<Cal10nError> errorList = miv.verify(Locale.UK); assertEquals(2, errorList.size()); assertEquals("CH", errorList.get(0).getCode()); @@ -59,7 +59,7 @@ public class MessageCodeVerifierTest { @Test public void withErrors_FR() { - IMessageCodeVerifier miv = new MessageCodeVerifier(Countries.class); + IMessageKeyVerifier miv = new MessageKeyVerifier(Countries.class); List<Cal10nError> errorList = miv.verify(Locale.FRANCE); assertEquals(3, errorList.size()); assertEquals("CH", errorList.get(0).getCode()); diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageConveyorTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageConveyorTest.java index dfc2219..f60ce2c 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageConveyorTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MessageConveyorTest.java @@ -29,44 +29,56 @@ import java.util.Locale; import org.junit.Test; import ch.qos.cal10n.MessageConveyor; +import ch.qos.cal10n.MessageParameterObj; public class MessageConveyorTest { @Test public void smoke_EN() { - MessageConveyor rbbmc = new MessageConveyor( - Locale.UK); + MessageConveyor rbbmc = new MessageConveyor(Locale.UK); { String val = rbbmc.getMessage(Colors.BLUE); assertEquals("violets are blue", val); } - { String val = rbbmc.getMessage(Colors.GREEN, "apples"); assertEquals("apples are green", val); } } - + @Test public void smoke_FR() { - MessageConveyor rbbmc = new MessageConveyor( - Locale.FRANCE); + MessageConveyor rbbmc = new MessageConveyor(Locale.FRANCE); { String val = rbbmc.getMessage(Colors.BLUE); assertEquals("les violettes sont bleues", val); } - { // lemon=citron in french. This illustrates the problem of // translating the parameters of a message String val = rbbmc.getMessage(Colors.GREEN, "pommes"); assertEquals("les pommes sont verts", val); } + } + + @Test + public void mpo() { + MessageConveyor rbbmc = new MessageConveyor(Locale.UK); + { + MessageParameterObj mpo = new MessageParameterObj(Colors.BLUE); + String val = rbbmc.getMessage(mpo); + assertEquals("violets are blue", val); + } + { + MessageParameterObj mpo = new MessageParameterObj(Colors.GREEN, "apples"); + String val = rbbmc.getMessage(mpo); + assertEquals("apples are green", val); + } } } diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/MyAllInOneColorVerificationTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MyAllInOneColorVerificationTest.java index 80b30db..5f5014a 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/sample/MyAllInOneColorVerificationTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MyAllInOneColorVerificationTest.java @@ -29,8 +29,8 @@ import java.util.List; import org.junit.Test; import ch.qos.cal10n.verifier.Cal10nError; -import ch.qos.cal10n.verifier.IMessageCodeVerifier; -import ch.qos.cal10n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.IMessageKeyVerifier; +import ch.qos.cal10n.verifier.MessageKeyVerifier; /** * @@ -42,7 +42,7 @@ public class MyAllInOneColorVerificationTest { @Test public void all() { - IMessageCodeVerifier mcv = new MessageCodeVerifier(Colors.class); + IMessageKeyVerifier mcv = new MessageKeyVerifier(Colors.class); List<Cal10nError> errorList = mcv.verifyAllLocales(); assertEquals(0, errorList.size()); } diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/MyColorVerificationTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MyColorVerificationTest.java index 3b8f7ab..1624fd4 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/sample/MyColorVerificationTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/MyColorVerificationTest.java @@ -30,14 +30,14 @@ import java.util.Locale; import org.junit.Test; import ch.qos.cal10n.verifier.Cal10nError; -import ch.qos.cal10n.verifier.IMessageCodeVerifier; -import ch.qos.cal10n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.IMessageKeyVerifier; +import ch.qos.cal10n.verifier.MessageKeyVerifier; public class MyColorVerificationTest { @Test public void en_UK() { - IMessageCodeVerifier mcv = new MessageCodeVerifier(Colors.class); + IMessageKeyVerifier mcv = new MessageKeyVerifier(Colors.class); List<Cal10nError> errorList = mcv.verify(Locale.UK); for(Cal10nError error: errorList) { System.out.println(error); @@ -47,7 +47,7 @@ public class MyColorVerificationTest { @Test public void fr() { - IMessageCodeVerifier mcv = new MessageCodeVerifier(Colors.class); + IMessageKeyVerifier mcv = new MessageKeyVerifier(Colors.class); List<Cal10nError> errorList = mcv.verify(Locale.FRANCE); for(Cal10nError error: errorList) { System.out.println(error); diff --git a/cal10n-site/pom.xml b/cal10n-site/pom.xml index 57240ca..eed061c 100644 --- a/cal10n-site/pom.xml +++ b/cal10n-site/pom.xml @@ -5,7 +5,7 @@ <parent> <groupId>ch.qos.cal10n</groupId> <artifactId>cal10n-parent</artifactId> - <version>0.5</version> + <version>0.5.1</version> </parent> <modelVersion>4.0.0</modelVersion> diff --git a/cal10n-site/src/site/pages/manual.html b/cal10n-site/src/site/pages/manual.html index a4c60b1..9d62b09 100644 --- a/cal10n-site/src/site/pages/manual.html +++ b/cal10n-site/src/site/pages/manual.html @@ -101,7 +101,7 @@ public enum Colors { }</pre> - <p>Once you define a few color codes, you can create a regular + <p>Once you define a few color keys, you can create a regular resource bundle named after the value of the @ResourceBundleName annotation in Colors and the appropriate locale. For example, for the UK locale, you would name your resource bundle as @@ -144,9 +144,9 @@ String blue = mc.getMessage(Colors.BLUE); </pre> have been accustomed to, but adds compiler verification on top.</p> - <p>An astute reader will comment that even if the messages codes are now + <p>An astute reader will comment that even if the messages keys are now verified by the compiler, it is still possible to have mismatching - message codes in the resources bundles. For this reason, CAL10N + message keys in the resources bundles. For this reason, CAL10N comes with additional tooling support. </p> @@ -170,15 +170,15 @@ import java.util.Locale; import org.junit.Test; import ch.qos.cal10n.verifier.Cal10nError; -import ch.qos.cal10n.verifier.IMessageCodeVerifier; -import ch.qos.cal10n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.IMessageKeyVerifier; +import ch.qos.cal10n.verifier.MessageKeyVerifier; public class MyColorVerificationTest { @Test public void en_UK() { - IMessageCodeVerifier mcv = new MessageCodeVerifier(Colors.class); - List<Cal10nError> errorList = mcv.verify(Locale.UK); + IMessageKeyVerifier mkv = new MessageKeyVerifier(Colors.class); + List<Cal10nError> errorList = mkv.verify(Locale.UK); for(Cal10nError error: errorList) { System.out.println(error); } @@ -187,8 +187,8 @@ public class MyColorVerificationTest { @Test public void fr() { - IMessageCodeVerifier mcv = new MessageCodeVerifier(Colors.class); - List<Cal10nError> errorList = mcv.verify(Locale.FRANCE); + IMessageKeyVerifier mkv = new MessageKeyVerifier(Colors.class); + List<Cal10nError> errorList = mkv.verify(Locale.FRANCE); for(Cal10nError error: errorList) { System.out.println(error); } @@ -197,11 +197,11 @@ public class MyColorVerificationTest { } </pre> <p>The above unit tests start by creating a - <code>MessageCodeVerifier</code> instance associated with an enum + <code>MessageKeyVerifier</code> instance associated with an enum type, <code>Colors</code> in this case. The test proceeds to invoke the <code>verify()</code> method passing a locale as an argument. The <code>verify()</code> method returns the list of - errors, that is the list of discrepancies between the codes listed + errors, that is the list of discrepancies between the keys listed in the enum type and the correspondign resource bundle. An empty list will be returned if there are no errors. </p> @@ -209,15 +209,15 @@ public class MyColorVerificationTest { <p>The unit test verifies that no errors have occured by asserting that the size of the error list is zero.</p> - <p>Suppose the code "BLUE" was misspelled as "BLEU" in the + <p>Suppose the key "BLUE" was misspelled as "BLEU" in the <em>colors_fr.properties</em> resource bundle. The unit test would print the following list of errors and throw an <code>AssertionError</code>. </p> - <pre class="source">Code [BLUE] present in enum type [ch.qos.cal10n.sample.Colors] but absent in resource bundle \ + <pre class="source">Key [BLUE] present in enum type [ch.qos.cal10n.sample.Colors] but absent in resource bundle \ named [colors] for locale [fr_FR] -Code [BLEU] present in resource bundle named [colors] for locale [fr_FR] but absent \ +Key [BLEU] present in resource bundle named [colors] for locale [fr_FR] but absent \ in enum type [ch.qos.cal10n.sample.Colors]</pre> <h3>One test to rule them all</h3> @@ -237,16 +237,16 @@ import java.util.Locale; import org.junit.Test; import ch.qos.cal10n.verifier.Cal10nError; -import ch.qos.cal10n.verifier.IMessageCodeVerifier; -import ch.qos.cal10n.verifier.MessageCodeVerifier; +import ch.qos.cal10n.verifier.IMessageKeyVerifier; +import ch.qos.cal10n.verifier.MessageKeyVerifier; public class MyAllInOneColorVerificationTest { // verify all locales in one step @Test public void all() { - IMessageCodeVerifier mcv = new MessageCodeVerifier(Colors.class); - List<Cal10nError> errorList = mcv.verifyAllLocales(); + IMessageKeyVerifier mkv = new MessageKeyVerifier(Colors.class); + List<Cal10nError> errorList = mkv.verifyAllLocales(); for(Cal10nError error: errorList) { System.out.println(error); } @@ -322,9 +322,8 @@ public class MyAllInOneColorVerificationTest { <ul> <li><b>mismatch highlighting</b> - <p>While editing a property file, - highlight any keys, a.k.a. message codes, that do not match the - keys defined in the corresponding enum type.</p> + <p>While editing a property file, highlight any keys that do not + match any keys defined in the corresponding enum type.</p> </li> diff --git a/cal10n-site/src/site/pages/news.html b/cal10n-site/src/site/pages/news.html index 5f49c4a..dac2e1d 100644 --- a/cal10n-site/src/site/pages/news.html +++ b/cal10n-site/src/site/pages/news.html @@ -27,6 +27,16 @@ href="http://www.qos.ch/mailman/listinfo/cal10n-announce">cal10n-announce</a> mailing list.</p> + + <hr width="80%" align="center" /> + + <h3>1st of September 2009 - Release of CAL10N version 0.5.1</h3> + + <p>Fixed a bug causing the <em>maven-cal10n-plugin</em> to fail on + Linux. The plug-in is not tested on both Windows and Linux. + </p> + + <hr width="80%" align="center" /> <h3>29th of August 2009 - Release of CAL10N version 0.5</h3> diff --git a/maven-cal10n-plugin-smoke/pom.xml b/maven-cal10n-plugin-smoke/pom.xml index ab0d015..b3f8061 100644 --- a/maven-cal10n-plugin-smoke/pom.xml +++ b/maven-cal10n-plugin-smoke/pom.xml @@ -4,7 +4,7 @@ <parent> <groupId>ch.qos.cal10n</groupId> <artifactId>cal10n-parent</artifactId> - <version>0.5</version> + <version>0.5.1</version> </parent> <modelVersion>4.0.0</modelVersion> diff --git a/maven-cal10n-plugin/pom.xml b/maven-cal10n-plugin/pom.xml index 322ad2d..d540cdc 100644 --- a/maven-cal10n-plugin/pom.xml +++ b/maven-cal10n-plugin/pom.xml @@ -8,7 +8,7 @@ <parent> <artifactId>cal10n-parent</artifactId> <groupId>ch.qos.cal10n</groupId> - <version>0.5</version> + <version>0.5.1</version> </parent> <groupId>ch.qos.cal10n.plugins</groupId> diff --git a/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/ThisFirstClassLoader.java b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/ThisFirstClassLoader.java index 85dfabc..0e03c2f 100644 --- a/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/ThisFirstClassLoader.java +++ b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/ThisFirstClassLoader.java @@ -57,9 +57,9 @@ public class ThisFirstClassLoader extends URLClassLoader { protected Class<?> loadClass(String name, boolean resolve) throws ClassNotFoundException { - // Treating IMessageCodeVerifier as a special case is the whole point of the + // Treating IMessageKeyVerifier as a special case is the whole point of the // exercise. - if (name.equals("ch.qos.cal10n.verifier.IMessageCodeVerifier")) { + if (name.equals("ch.qos.cal10n.verifier.IMessageKeyVerifier")) { return super.loadClass(name, resolve); } diff --git a/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java index 7b6760a..d5d804b 100644 --- a/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java +++ b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java @@ -37,7 +37,7 @@ import org.apache.maven.plugin.MojoExecutionException; import org.apache.maven.plugin.MojoFailureException; import ch.qos.cal10n.Cal10nConstants; -import ch.qos.cal10n.verifier.IMessageCodeVerifier; +import ch.qos.cal10n.verifier.IMessageKeyVerifier; /** * Verifies resources bundles in various locales against an enumType @@ -92,7 +92,7 @@ public class VerifyMojo extends AbstractMojo { + MISSING_ENUM_TYPES); } for (String enumTypeAsStr : enumTypes) { - IMessageCodeVerifier imcv = getMessageCodeVerifierInstance(enumTypeAsStr); + IMessageKeyVerifier imcv = getMessageCodeVerifierInstance(enumTypeAsStr); getLog() .info( "Checking all resource bundles for enum type [" + enumTypeAsStr @@ -101,7 +101,7 @@ public class VerifyMojo extends AbstractMojo { } } - public void checkAllLocales(IMessageCodeVerifier mcv) + public void checkAllLocales(IMessageKeyVerifier mcv) throws MojoFailureException, MojoExecutionException { String enumClassAsStr = mcv.getEnumTypeAsStr(); @@ -140,15 +140,15 @@ public class VerifyMojo extends AbstractMojo { } } - IMessageCodeVerifier getMessageCodeVerifierInstance(String enumClassAsStr) + IMessageKeyVerifier getMessageCodeVerifierInstance(String enumClassAsStr) throws MojoExecutionException { String errMsg = "Failed to instantiate MessageCodeVerifier class"; try { ThisFirstClassLoader thisFirstClassLoader = (ThisFirstClassLoader) buildClassLoader(); - Class<?> cla = Class.forName(Cal10nConstants.MessageCodeVerifier_FQCN, + Class<?> mkvClass = Class.forName(Cal10nConstants.MessageKeyVerifier_FQCN, true, thisFirstClassLoader); - Constructor<?> cons = cla.getConstructor(String.class); - IMessageCodeVerifier imcv = (IMessageCodeVerifier) cons + Constructor<?> mkvCons = mkvClass.getConstructor(String.class); + IMessageKeyVerifier imcv = (IMessageKeyVerifier) mkvCons .newInstance(enumClassAsStr); return imcv; } catch (ClassNotFoundException e) { diff --git a/pom.xml b/pom.xml index 4a64b7c..c26d7ae 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ <groupId>ch.qos.cal10n</groupId> <artifactId>cal10n-parent</artifactId> <packaging>pom</packaging> - <version>0.5</version> + <version>0.5.1</version> <name>Compiler assisted localization library (CAL10N) - Parent</name> <url>http://cal10n.qos.ch</url> ----------------------------------------------------------------------- Summary of changes: cal10n-api/pom.xml | 2 +- .../main/java/ch/qos/cal10n/Cal10nConstants.java | 2 +- .../main/java/ch/qos/cal10n/IMessageConveyor.java | 23 +++-- .../src/main/java/ch/qos/cal10n/LocaleNames.java | 4 +- .../main/java/ch/qos/cal10n/MessageConveyor.java | 29 ++++-- .../java/ch/qos/cal10n/MessageParameterObj.java | 104 ++++++++++++++++++++ .../java/ch/qos/cal10n/ResourceBundleName.java | 4 +- .../java/ch/qos/cal10n/verifier/Cal10nError.java | 12 +- ...eCodeVerifier.java => IMessageKeyVerifier.java} | 4 +- ...geCodeVerifier.java => MessageKeyVerifier.java} | 23 +---- .../qos/cal10n/sample/MessageCodeVerifierTest.java | 10 +- .../ch/qos/cal10n/sample/MessageConveyorTest.java | 26 ++++-- .../sample/MyAllInOneColorVerificationTest.java | 6 +- .../qos/cal10n/sample/MyColorVerificationTest.java | 8 +- cal10n-site/pom.xml | 2 +- cal10n-site/src/site/pages/manual.html | 41 ++++---- cal10n-site/src/site/pages/news.html | 10 ++ maven-cal10n-plugin-smoke/pom.xml | 2 +- maven-cal10n-plugin/pom.xml | 2 +- .../qos/cal10n/plugins/ThisFirstClassLoader.java | 4 +- .../java/ch/qos/cal10n/plugins/VerifyMojo.java | 14 ++-- pom.xml | 2 +- 22 files changed, 231 insertions(+), 103 deletions(-) create mode 100644 cal10n-api/src/main/java/ch/qos/cal10n/MessageParameterObj.java rename cal10n-api/src/main/java/ch/qos/cal10n/verifier/{IMessageCodeVerifier.java => IMessageKeyVerifier.java} (90%) rename cal10n-api/src/main/java/ch/qos/cal10n/verifier/{MessageCodeVerifier.java => MessageKeyVerifier.java} (87%) hooks/post-receive -- Compiler assisted localization library

1 0

Intend to delete cai18n repository on github
by Ceki Gulcu 01 Sep '09

01 Sep '09

Hello all, Given that the project was renamed, I intend to remove the git repository named cai18n on github. Any objections? In particular, removing the original tree might affect takeshi's fork [1]. Cheers, [1] http://github.com/ceki/cai18n/tree/master -- Ceki Gülcü Logback: The reliable, generic, fast and flexible logging framework for Java. http://logback.qos.ch

1 0

[GIT] Compiler assisted localization library branch, master, updated. e3551bfd202a35a9dcc796b992317d3ed2570935
by git-noreply＠pixie.qos.ch 01 Sep '09

01 Sep '09

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Compiler assisted localization library". The branch, master has been updated via e3551bfd202a35a9dcc796b992317d3ed2570935 (commit) from db09bae6b785034f075548b611fbee3f0ff7f8c2 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://git.qos.ch/gitweb/?p=cal10n.git;a=commit;h=e3551bfd202a35a9dcc796b99… http://github.com/ceki/cal10n/commit/e3551bfd202a35a9dcc796b992317d3ed25709… commit e3551bfd202a35a9dcc796b992317d3ed2570935 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Tue Sep 1 11:26:52 2009 +0200 - Cleaned up System.out residues - Removed cruft diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java index 2be14a8..0146e1f 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/MessageCodeVerifier.java @@ -49,14 +49,10 @@ public class MessageCodeVerifier implements IMessageCodeVerifier { this.enumTypeAsStr = enumClass.getName(); } - public MessageCodeVerifier() { - System.out.println("lkkkkkkkkkkkkkk="+this.getClass().getClassLoader()); - } @SuppressWarnings("unchecked") public MessageCodeVerifier(String enumTypeAsStr) { this.enumTypeAsStr = enumTypeAsStr; String errMsg = "Failed to find enum class [" + enumTypeAsStr + "]"; - System.out.println("lkkkkkkkkkkkkkk="+this.getClass().getClassLoader()); try { this.enumType = (Class<? extends Enum<?>>) Class.forName(enumTypeAsStr); } catch (ClassNotFoundException e) { diff --git a/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java index 29d18ad..7b6760a 100644 --- a/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java +++ b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java @@ -22,12 +22,10 @@ package ch.qos.cal10n.plugins; import java.io.File; -import java.io.IOException; import java.lang.reflect.Constructor; import java.net.MalformedURLException; import java.net.URL; import java.util.ArrayList; -import java.util.Arrays; import java.util.List; import java.util.Locale; import java.util.Set; @@ -87,16 +85,18 @@ public class VerifyMojo extends AbstractMojo { */ private ArtifactRepository localRepository; - public void execute() throws MojoExecutionException, MojoFailureException { if (enumTypes == null) { - throw new MojoFailureException( - "Missing <enumTypes> element. Please see " + MISSING_ENUM_TYPES); + throw new MojoFailureException("Missing <enumTypes> element. Please see " + + MISSING_ENUM_TYPES); } for (String enumTypeAsStr : enumTypes) { IMessageCodeVerifier imcv = getMessageCodeVerifierInstance(enumTypeAsStr); - getLog().info("Checking all resource bundles for enum type [" + enumTypeAsStr + "]"); + getLog() + .info( + "Checking all resource bundles for enum type [" + enumTypeAsStr + + "]"); checkAllLocales(imcv); } } @@ -144,10 +144,9 @@ public class VerifyMojo extends AbstractMojo { throws MojoExecutionException { String errMsg = "Failed to instantiate MessageCodeVerifier class"; try { - ThisFirstClassLoader thisFirstClassLoader = (ThisFirstClassLoader) buildClassLoader(); - //Class<?> cla = thisFirstClassLoader.loadClass(Cal10nConstants.MessageCodeVerifier_FQCN, true); - Class<?> cla = Class.forName(Cal10nConstants.MessageCodeVerifier_FQCN, true, thisFirstClassLoader); + Class<?> cla = Class.forName(Cal10nConstants.MessageCodeVerifier_FQCN, + true, thisFirstClassLoader); Constructor<?> cons = cla.getConstructor(String.class); IMessageCodeVerifier imcv = (IMessageCodeVerifier) cons .newInstance(enumClassAsStr); @@ -167,7 +166,6 @@ public class VerifyMojo extends AbstractMojo { classpathURLList.addAll(getDirectDependencies()); ClassLoader parentCL = this.getClass().getClassLoader(); URL[] classpathURLArray = classpathURLList.toArray(new URL[] {}); - System.out.println("classpathURLArray="+Arrays.toString(classpathURLArray)); return new ThisFirstClassLoader(classpathURLArray, parentCL); } @@ -176,13 +174,12 @@ public class VerifyMojo extends AbstractMojo { for (Artifact a : projectArtifacts) { String pathOfArtifact = localRepository.getBasedir() + "/" + localRepository.pathOf(a); - File artifactAsFile = new File(pathOfArtifact); - if(!artifactAsFile.exists()) { - getLog().error("Artifact ["+artifactAsFile+"] could not be located"); + File artifactAsFile = new File(pathOfArtifact); + if (!artifactAsFile.exists()) { + getLog() + .error("Artifact [" + artifactAsFile + "] could not be located"); } try { - //URL url = new URL("file://" + pathOfArtifact); - //URL url = new URL(urlAsStr); URL url = artifactAsFile.toURI().toURL(); urlList.add(url); } catch (MalformedURLException e) { ----------------------------------------------------------------------- Summary of changes: .../qos/cal10n/verifier/MessageCodeVerifier.java | 4 --- .../java/ch/qos/cal10n/plugins/VerifyMojo.java | 27 +++++++++----------- 2 files changed, 12 insertions(+), 19 deletions(-) hooks/post-receive -- Compiler assisted localization library

1 0

[GIT] Compiler assisted localization library branch, master, updated. db09bae6b785034f075548b611fbee3f0ff7f8c2
by git-noreply＠pixie.qos.ch 01 Sep '09

01 Sep '09

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Compiler assisted localization library". The branch, master has been updated via db09bae6b785034f075548b611fbee3f0ff7f8c2 (commit) from c6d309e74d99dd5788af73b512a2d60aeae6bef6 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://git.qos.ch/gitweb/?p=cal10n.git;a=commit;h=db09bae6b785034f075548b61… http://github.com/ceki/cal10n/commit/db09bae6b785034f075548b611fbee3f0ff7f8… commit db09bae6b785034f075548b611fbee3f0ff7f8c2 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Tue Sep 1 11:21:32 2009 +0200 Trying to find a OS independent way of constructing the artifact URL. This version works on Windows diff --git a/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java index bdfe8fb..29d18ad 100644 --- a/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java +++ b/maven-cal10n-plugin/src/main/java/ch/qos/cal10n/plugins/VerifyMojo.java @@ -22,6 +22,7 @@ package ch.qos.cal10n.plugins; import java.io.File; +import java.io.IOException; import java.lang.reflect.Constructor; import java.net.MalformedURLException; import java.net.URL; @@ -173,13 +174,16 @@ public class VerifyMojo extends AbstractMojo { List<URL> getDirectDependencies() { ArrayList<URL> urlList = new ArrayList<URL>(); for (Artifact a : projectArtifacts) { - String urlAsStr = localRepository.getUrl(); //returns a bogus URL - //String pathOfArtifact = localRepository.getBasedir() + "/" - // + localRepository.pathOf(a); - urlAsStr += "/"+localRepository.pathOf(a); + String pathOfArtifact = localRepository.getBasedir() + "/" + + localRepository.pathOf(a); + File artifactAsFile = new File(pathOfArtifact); + if(!artifactAsFile.exists()) { + getLog().error("Artifact ["+artifactAsFile+"] could not be located"); + } try { //URL url = new URL("file://" + pathOfArtifact); - URL url = new URL(urlAsStr); + //URL url = new URL(urlAsStr); + URL url = artifactAsFile.toURI().toURL(); urlList.add(url); } catch (MalformedURLException e) { getLog().info("Failed to build URL", e); ----------------------------------------------------------------------- Summary of changes: .../java/ch/qos/cal10n/plugins/VerifyMojo.java | 14 +++++++++----- 1 files changed, 9 insertions(+), 5 deletions(-) hooks/post-receive -- Compiler assisted localization library

1 0