September 2009 - cal10n-dev

branch, master, updated. v0.5.1-5-g5b6f288
by git-noreply＠pixie.qos.ch 02 Sep '09

02 Sep '09

The branch, master has been updated via 5b6f28829e7b0c5bc8041db251c8f9de991a054e (commit) from 979578bc208c3ab05206285354845e318fa1bff9 (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=5b6f28829e7b0c5bc8041db25… http://github.com/ceki/cal10n/commit/5b6f28829e7b0c5bc8041db251c8f9de991a05… commit 5b6f28829e7b0c5bc8041db251c8f9de991a054e Author: Ceki Gulcu <ceki(a)qos.ch> Date: Wed Sep 2 19:43:59 2009 +0200 - Preparing release 0.6 diff --git a/cal10n-api/pom.xml b/cal10n-api/pom.xml index f7486f7..b1cca6e 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.1</version> + <version>0.6</version> </parent> <modelVersion>4.0.0</modelVersion> diff --git a/cal10n-site/pom.xml b/cal10n-site/pom.xml index eed061c..380f65e 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.1</version> + <version>0.6</version> </parent> <modelVersion>4.0.0</modelVersion> diff --git a/maven-cal10n-plugin-smoke/pom.xml b/maven-cal10n-plugin-smoke/pom.xml index b3f8061..7103297 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.1</version> + <version>0.6</version> </parent> <modelVersion>4.0.0</modelVersion> diff --git a/maven-cal10n-plugin/pom.xml b/maven-cal10n-plugin/pom.xml index d540cdc..755b2e6 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.1</version> + <version>0.6</version> </parent> <groupId>ch.qos.cal10n.plugins</groupId> diff --git a/pom.xml b/pom.xml index c26d7ae..b10eb01 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.1</version> + <version>0.6</version> <name>Compiler assisted localization library (CAL10N) - Parent</name> <url>http://cal10n.qos.ch</url> ----------------------------------------------------------------------- Summary of changes: cal10n-api/pom.xml | 2 +- cal10n-site/pom.xml | 2 +- maven-cal10n-plugin-smoke/pom.xml | 2 +- maven-cal10n-plugin/pom.xml | 2 +- pom.xml | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) hooks/post-receive -- Compiler assisted localization library

1 0

branch, master, updated. v0.5.1-4-g979578b
by git-noreply＠pixie.qos.ch 02 Sep '09

02 Sep '09

The branch, master has been updated via 979578bc208c3ab05206285354845e318fa1bff9 (commit) from 809f61077f605b6b8a2e9b3e3cb7eeca37306b0b (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=979578bc208c3ab0520628535… http://github.com/ceki/cal10n/commit/979578bc208c3ab05206285354845e318fa1bf… commit 979578bc208c3ab05206285354845e318fa1bff9 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Wed Sep 2 19:41:54 2009 +0200 - defined a simplified bundle lookup procedure 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 6f682ae..17069e2 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java @@ -27,6 +27,7 @@ import java.util.Locale; import java.util.ResourceBundle; import ch.qos.cal10n.util.AnnotationExtractor; +import ch.qos.cal10n.util.PropertyResourceBundleFinder; /** * The default implementation for {@link IMessageConveyor} based on resource @@ -55,9 +56,9 @@ public class MessageConveyor implements IMessageConveyor { * corresponding internationalized. * * <p> - * The name of the resource bundle is defined via the - * {@link BaseName} annotation whereas the locale is specified in - * this MessageConveyor instance's constructor. + * The name of the resource bundle is defined via the {@link BaseName} + * annotation whereas the locale is specified in this MessageConveyor + * instance's constructor. * * @param key * an enum instance used as message key @@ -66,14 +67,16 @@ public class MessageConveyor implements IMessageConveyor { public <E extends Enum<?>> String getMessage(E key, Object... args) { String keyAsStr = key.toString(); - String resouceBundleName = AnnotationExtractor.getBaseName(key - .getDeclaringClass()); - if (resouceBundleName == null) { + String baseName = AnnotationExtractor.getBaseName(key.getDeclaringClass()); + if (baseName == null) { throw new IllegalArgumentException( - "Missing @BaseName annotation in enum type [" + key.getClass().getName() - + "]. See also " + Cal10nConstants.MISSING_BN_ANNOTATION_URL); + "Missing @BaseName annotation in enum type [" + + key.getClass().getName() + "]. See also " + + Cal10nConstants.MISSING_BN_ANNOTATION_URL); } - ResourceBundle rb = ResourceBundle.getBundle(resouceBundleName, locale); + + ResourceBundle rb = PropertyResourceBundleFinder.getBundle(this.getClass() + .getClassLoader(), baseName, locale); String value = rb.getString(keyAsStr); if (value == null) { diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/WithDefaultTest.java b/cal10n-api/src/main/java/ch/qos/cal10n/util/CAL10NPropertyResourceBundle.java similarity index 72% copy from cal10n-api/src/test/java/ch/qos/cal10n/sample/WithDefaultTest.java copy to cal10n-api/src/main/java/ch/qos/cal10n/util/CAL10NPropertyResourceBundle.java index b2da013..b708cee 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/sample/WithDefaultTest.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/util/CAL10NPropertyResourceBundle.java @@ -19,26 +19,21 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cal10n.sample; +package ch.qos.cal10n.util; -import static org.junit.Assert.assertEquals; +import java.io.IOException; +import java.io.InputStream; +import java.util.PropertyResourceBundle; +import java.util.ResourceBundle; -import java.util.Locale; +public class CAL10NPropertyResourceBundle extends PropertyResourceBundle { -import org.junit.Test; - -import ch.qos.cal10n.MessageConveyor; - - -public class WithDefaultTest { - - @Test - public void smoke() { - MessageConveyor mc = new MessageConveyor(Locale.UK); - String val; - - val = mc.getMessage(Furnitures.TABLE); - assertEquals("the table", val); + public CAL10NPropertyResourceBundle(InputStream is) throws IOException { + super(is); + } + public void setParent(ResourceBundle parent) { + super.setParent(parent); } + } diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/util/PropertyResourceBundleFinder.java b/cal10n-api/src/main/java/ch/qos/cal10n/util/PropertyResourceBundleFinder.java new file mode 100644 index 0000000..7ecdf89 --- /dev/null +++ b/cal10n-api/src/main/java/ch/qos/cal10n/util/PropertyResourceBundleFinder.java @@ -0,0 +1,103 @@ +/* + * 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.util; + +import java.io.IOException; +import java.io.InputStream; +import java.net.URL; +import java.net.URLConnection; +import java.util.Locale; +import java.util.ResourceBundle; + +public class PropertyResourceBundleFinder { + + public static ResourceBundle getBundle(ClassLoader classLoader, String baseName, + Locale locale) { + + // same as the JDK convention + // + // It generates a path name from the candidate bundle name by replacing all "." + // characters with "/" and appending the string ".properties". + /// see also http: // tinyurl.com/ldgej8 + baseName = baseName.replace('.', '/'); + + String languageAndCountryCandidate = computeLanguageAndCountryCandidate( + baseName, locale); + String languageOnlyCandidate = computeLanguageOnlyCandidate(baseName, + locale); + + CAL10NPropertyResourceBundle cprbLanguageOnly = makePropertyResourceBundle( + classLoader, languageOnlyCandidate); + CAL10NPropertyResourceBundle cprbLanguageAndCountry = null; + + if (languageAndCountryCandidate != null) { + cprbLanguageAndCountry = makePropertyResourceBundle(classLoader, + languageAndCountryCandidate); + } + + if (cprbLanguageAndCountry != null) { + cprbLanguageAndCountry.setParent(cprbLanguageOnly); + return cprbLanguageAndCountry; + } + return cprbLanguageOnly; + } + + private static CAL10NPropertyResourceBundle makePropertyResourceBundle( + ClassLoader classLoader, String resourceCandiate) { + + CAL10NPropertyResourceBundle prb = null; + + URL url = classLoader.getResource(resourceCandiate); + if (url != null) { + try { + InputStream in = openConnectionForUrl(url); + prb = new CAL10NPropertyResourceBundle(in); + in.close(); + } catch (IOException e) { + } + } + return prb; + } + + private static String computeLanguageAndCountryCandidate(String baseName, + Locale locale) { + String language = locale.getLanguage(); + String country = locale.getCountry(); + if (country != null && country.length() > 0) { + return baseName + "_" + language + "_" + country + ".properties"; + } else { + return null; + } + } + + private static String computeLanguageOnlyCandidate(String baseName, Locale locale) { + String language = locale.getLanguage(); + return baseName + "_" + language + ".properties"; + } + + private static InputStream openConnectionForUrl(URL url) throws IOException { + URLConnection urlConnection = url.openConnection(); + urlConnection.setDefaultUseCaches(false); + InputStream in = urlConnection.getInputStream(); + return in; + } +} diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/WithDefaultTest.java b/cal10n-api/src/main/java/ch/qos/cal10n/util/StringToLocale.java similarity index 74% rename from cal10n-api/src/test/java/ch/qos/cal10n/sample/WithDefaultTest.java rename to cal10n-api/src/main/java/ch/qos/cal10n/util/StringToLocale.java index b2da013..1e70cf8 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/sample/WithDefaultTest.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/util/StringToLocale.java @@ -19,26 +19,21 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cal10n.sample; - -import static org.junit.Assert.assertEquals; +package ch.qos.cal10n.util; import java.util.Locale; -import org.junit.Test; - -import ch.qos.cal10n.MessageConveyor; - - -public class WithDefaultTest { - - @Test - public void smoke() { - MessageConveyor mc = new MessageConveyor(Locale.UK); - String val; +public class StringToLocale { - val = mc.getMessage(Furnitures.TABLE); - assertEquals("the table", val); + public static Locale toLocale(String localeName) { + if (localeName == null) { + } + if (localeName.contains("_")) { + String[] array = localeName.split("_"); + return new Locale(array[0], array[1]); + } else { + return new Locale(localeName); + } } } 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 6ea790b..be8e7c2 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 @@ -43,16 +43,16 @@ public class Cal10nError { final Locale locale; final Class<?> enumClass; final String enumClassName; - final String resouceBundleName; + final String baseName; Cal10nError(ErrorType errorType, String key, Class<?> enumClass, - Locale locale, String resourceBundleName) { + Locale locale, String baseName) { this.errorType = errorType; this.key = key; this.enumClass = enumClass; this.enumClassName = enumClass.getName(); this.locale = locale; - this.resouceBundleName = resourceBundleName; + this.baseName = baseName; } public ErrorType getErrorType() { @@ -82,21 +82,21 @@ public class Cal10nError { // enumClassName // + "]"; case FAILED_TO_FIND_RB: - return "Failed to locate resource bundle [" + resouceBundleName - + "]for locale [" + locale + "] for enum type [" + enumClassName + return "Failed to locate resource bundle [" + baseName + + "] for locale [" + locale + "] for enum type [" + enumClassName + "]"; case EMPTY_RB: - return "Empty resource bundle named [" + resouceBundleName + return "Empty resource bundle named [" + baseName + "] for locale [" + locale + "]"; case EMPTY_ENUM: return "Empty enum type [" + enumClassName + "]"; case ABSENT_IN_ENUM: return "Key [" + key + "] present in resource bundle named [" - + resouceBundleName + "] for locale [" + locale + + baseName + "] for locale [" + locale + "] but absent in enum type [" + enumClassName + "]"; case ABSENT_IN_RB: return "Key [" + key + "] present in enum type [" + enumClassName - + "] but absent in resource bundle named [" + resouceBundleName + + "] but absent in resource bundle named [" + baseName + "] for locale [" + locale + "]"; default: throw new IllegalStateException("Impossible to reach here"); diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageKeyVerifier.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageKeyVerifier.java index ae4b89b..14cf610 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageKeyVerifier.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageKeyVerifier.java @@ -15,9 +15,10 @@ import java.util.Locale; */ public interface IMessageKeyVerifier { + // WARNING: // WARNING: The name of this class is referenced in String form // to do class loader tricks. Do not change the name of this class - // without looking at the maven-plugin. + // without looking at the maven-cal10n-plugin. /** * Get the of enum type that this verifier is related to to. 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 ce31ace..8b78912 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 @@ -31,6 +31,8 @@ import java.util.ResourceBundle; import java.util.Set; import ch.qos.cal10n.util.AnnotationExtractor; +import ch.qos.cal10n.util.PropertyResourceBundleFinder; +import ch.qos.cal10n.util.StringToLocale; import ch.qos.cal10n.verifier.Cal10nError.ErrorType; /** @@ -73,27 +75,28 @@ public class MessageKeyVerifier implements IMessageKeyVerifier { public List<Cal10nError> verify(Locale locale) { List<Cal10nError> errorList = new ArrayList<Cal10nError>(); - String resouceBundleName = AnnotationExtractor - .getBaseName(enumType); + String baseName = AnnotationExtractor.getBaseName(enumType); - if (resouceBundleName == null) { + if (baseName == null) { errorList.add(new Cal10nError(ErrorType.MISSING_BN_ANNOTATION, "", enumType, locale, "")); // no point in continuing return errorList; } - ResourceBundle rb = ResourceBundle.getBundle(resouceBundleName, locale); + ResourceBundle rb = PropertyResourceBundleFinder.getBundle(this.getClass() + .getClassLoader(), baseName, locale); - ErrorFactory errorFactory = new ErrorFactory(enumType, locale, - resouceBundleName); + ErrorFactory errorFactory = new ErrorFactory(enumType, locale, baseName); if (rb == null) { errorList.add(errorFactory.buildError(ErrorType.FAILED_TO_FIND_RB, "")); + // no point in continuing + return errorList; } - - Set<String> rbKeySet = buildKeySetFromEnumeration(rb.getKeys()); + Set<String> rbKeySet = buildKeySetFromEnumeration(rb.getKeys()); + if (rbKeySet.size() == 0) { errorList.add(errorFactory.buildError(ErrorType.EMPTY_RB, "")); } @@ -123,14 +126,14 @@ public class MessageKeyVerifier implements IMessageKeyVerifier { } private Set<String> buildKeySetFromEnumeration(Enumeration<String> e) { - Set<String> set = new HashSet<String>(); - while(e.hasMoreElements()) { + Set<String> set = new HashSet<String>(); + while (e.hasMoreElements()) { String s = e.nextElement(); set.add(s); } return set; } - + public List<String> typeIsolatedVerify(Locale locale) { List<Cal10nError> errorList = verify(locale); List<String> strList = new ArrayList<String>(); @@ -154,7 +157,8 @@ public class MessageKeyVerifier implements IMessageKeyVerifier { throw new IllegalStateException(errMsg); } for (String localeName : localeNameArray) { - Locale locale = new Locale(localeName); + Locale locale = StringToLocale.toLocale(localeName); + System.out.println(locale); List<Cal10nError> tmpList = verify(locale); errorList.addAll(tmpList); } 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 bb5e4a0..8c026bb 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,6 +28,7 @@ import ch.qos.cal10n.BaseName; @BaseName("colors") @LocaleNames({"en_UK", "fr"}) public enum Colors { + // sub-class for testing purposes RED { }, 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 5f5014a..5af05d3 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 @@ -44,6 +44,7 @@ public class MyAllInOneColorVerificationTest { public void all() { IMessageKeyVerifier mcv = new MessageKeyVerifier(Colors.class); List<Cal10nError> errorList = mcv.verifyAllLocales(); + System.out.println(errorList); assertEquals(0, errorList.size()); } 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 6df62ba..ca1f4e2 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,7 @@ import org.junit.runners.Suite; import org.junit.runners.Suite.SuiteClasses; @RunWith(Suite.class) -@SuiteClasses( { MessageKeyVerifierTest.class, MessageConveyorTest.class, WithDefaultTest.class }) +@SuiteClasses( { MessageKeyVerifierTest.class, MessageConveyorTest.class, + MyColorVerificationTest.class, MyAllInOneColorVerificationTest.class }) public class PackageTest { } diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/util/PropertyResourceBundleFinderTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/util/PropertyResourceBundleFinderTest.java new file mode 100644 index 0000000..323f4d2 --- /dev/null +++ b/cal10n-api/src/test/java/ch/qos/cal10n/util/PropertyResourceBundleFinderTest.java @@ -0,0 +1,63 @@ +/* + * 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.util; + +import static org.junit.Assert.assertEquals; + +import java.io.IOException; +import java.util.Locale; +import java.util.ResourceBundle; + +import org.junit.Test; + +public class PropertyResourceBundleFinderTest { + ResourceBundle rb; + + @Test + public void smoke() throws IOException { + rb = PropertyResourceBundleFinder.getBundle(this.getClass().getClassLoader(), + "colors", Locale.FRENCH); + assertEquals("les roses sont rouges", rb.getString("RED")); + } + + @Test + public void withCountry() throws IOException { + rb = PropertyResourceBundleFinder.getBundle(this.getClass().getClassLoader(), + "colors", Locale.FRENCH); + assertEquals("les roses sont rouges", rb.getString("RED")); + + rb = PropertyResourceBundleFinder.getBundle(this.getClass().getClassLoader(), + "colors", Locale.FRANCE); + assertEquals("les roses sont rouges, et alors?", rb.getString("RED")); + } + + @Test + public void inDirectory() throws IOException { + rb = PropertyResourceBundleFinder.getBundle(this.getClass().getClassLoader(), + "foobar/sample", Locale.ENGLISH); + assertEquals("A is the first letter of the alphabet", rb.getString("A")); + + rb = PropertyResourceBundleFinder.getBundle(this.getClass().getClassLoader(), + "foobar.sample", Locale.ENGLISH); + assertEquals("A is the first letter of the alphabet", rb.getString("A")); + } +} diff --git a/cal10n-api/src/test/resources/colors.properties b/cal10n-api/src/test/resources/colors.properties new file mode 100644 index 0000000..6eb4378 --- /dev/null +++ b/cal10n-api/src/test/resources/colors.properties @@ -0,0 +1,4 @@ +# this bundle should be ignored +BLUE=BBBBBBB +RED=RRRRRRRRRRR +GREEN=GGGGGGGGG \ No newline at end of file diff --git a/cal10n-api/src/test/resources/colors_fr_FR.properties b/cal10n-api/src/test/resources/colors_fr_FR.properties new file mode 100644 index 0000000..8a57918 --- /dev/null +++ b/cal10n-api/src/test/resources/colors_fr_FR.properties @@ -0,0 +1 @@ +RED=les roses sont rouges, et alors? \ No newline at end of file diff --git a/cal10n-api/src/test/resources/foobar/sample_en.properties b/cal10n-api/src/test/resources/foobar/sample_en.properties new file mode 100644 index 0000000..a705e87 --- /dev/null +++ b/cal10n-api/src/test/resources/foobar/sample_en.properties @@ -0,0 +1 @@ +A=A is the first letter of the alphabet \ No newline at end of file diff --git a/cal10n-api/src/test/resources/foobar/sample_fr.properties b/cal10n-api/src/test/resources/foobar/sample_fr.properties new file mode 100644 index 0000000..401665b --- /dev/null +++ b/cal10n-api/src/test/resources/foobar/sample_fr.properties @@ -0,0 +1 @@ +A=A est la premiere letter de l'alphabet \ No newline at end of file diff --git a/cal10n-site/src/site/pages/manual.html b/cal10n-site/src/site/pages/manual.html index 685a471..e180c46 100644 --- a/cal10n-site/src/site/pages/manual.html +++ b/cal10n-site/src/site/pages/manual.html @@ -152,8 +152,55 @@ String blue = mc.getMessage(Colors.BLUE); </pre> comes with additional tooling support. </p> + <h2><a name="simplifiedLookup" href="#simplifiedLookup">Simplified + bundle lookup procedure</a></h2> + + <p>The <code>ResourceBundle</code> class defines a rather involved + <a + href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/ResourceBundle.html#getBu…">lookup + procedure</a> for finding resource bundles. While formally this + procedure is deterministic, it is too error-prone for our taste. In + CAL10N, we thus took the bold initiative to define a simplified bundle look + up procedure. + </p> + + <p>Given a locale, the simplified look up procedure only takes into + account that locale, ignoring the default locale and the resource + bundle corresponding to the naked base name, i.e. the default + resource bundle. However, if the locale has both a language + <b>and</b> a country, and corresponding bundle files exist, then + CAL10N will take into account both bundles, establishing the same + parent child relationship as the JDK <code>ResourceBundle</code> + class. + </p> + + <p>For example, for base name "colors" if the following bundles + exist on the class path: + </p> + + <pre class="source">colors.properties +colors_en_US.properties +colors_en.properties +colors_fr_FR.properties</pre> + + + <p>and the system's default locale is "fr_FR", when CAL10N is asked + to find resource bundles corresponding to the "en_US" locale, it + will ignore the <em>colors.properties</em> (~ default bundle) and + <em>colors_fr_FR.properties</em> (~ default locale), while + combining the <em>colors_en_US.properties</em> and + <em>colors_en.properties</em> bundles in the usual parent-child + relationship. + </p> + + <p>We hope that the simplified lookup procedeue, while deviating + from the conventions of the Java platform as defined in the + <code>ResourceBundle</code> class, will still cause <a + href="http://en.wikipedia.org/wiki/Principle_of_least_astonishment"> + less suprises</a>.</p> - <h2><a name="deferred" href="#deferred">Deferred localization</a></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 diff --git a/cal10n-site/src/site/pages/news.html b/cal10n-site/src/site/pages/news.html index 0e42b24..488a47f 100644 --- a/cal10n-site/src/site/pages/news.html +++ b/cal10n-site/src/site/pages/news.html @@ -29,13 +29,17 @@ <hr width="80%" align="center" /> - <h3>x of September 2009 - Release of CAL10N version 0.5.2</h3> + <h3>2nd of September 2009 - Release of CAL10N version 0.6</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> + <p>CAI10N now uses a <a + href="manual.html#simplifiedLookup">simplifed bundle lookup + procedure</a>.</p> + <hr width="80%" align="center" /> <h3>1st of September 2009 - Release of CAL10N version 0.5.1</h3> ----------------------------------------------------------------------- Summary of changes: .../main/java/ch/qos/cal10n/MessageConveyor.java | 21 +++-- .../cal10n/util/CAL10NPropertyResourceBundle.java} | 21 +++-- .../cal10n/util/PropertyResourceBundleFinder.java | 103 ++++++++++++++++++++ .../java/ch/qos/cal10n/util/StringToLocale.java} | 27 ++--- .../java/ch/qos/cal10n/verifier/Cal10nError.java | 16 ++-- .../qos/cal10n/verifier/IMessageKeyVerifier.java | 3 +- .../ch/qos/cal10n/verifier/MessageKeyVerifier.java | 28 +++--- .../src/test/java/ch/qos/cal10n/sample/Colors.java | 1 + .../sample/MyAllInOneColorVerificationTest.java | 1 + .../java/ch/qos/cal10n/sample/PackageTest.java | 3 +- .../util/PropertyResourceBundleFinderTest.java | 63 ++++++++++++ cal10n-api/src/test/resources/colors.properties | 4 + .../src/test/resources/colors_fr_FR.properties | 1 + .../src/test/resources/foobar/sample_en.properties | 1 + .../src/test/resources/foobar/sample_fr.properties | 1 + cal10n-site/src/site/pages/manual.html | 49 +++++++++- cal10n-site/src/site/pages/news.html | 6 +- 17 files changed, 293 insertions(+), 56 deletions(-) copy cal10n-api/src/{test/java/ch/qos/cal10n/util/PackageTest.java => main/java/ch/qos/cal10n/util/CAL10NPropertyResourceBundle.java} (73%) create mode 100644 cal10n-api/src/main/java/ch/qos/cal10n/util/PropertyResourceBundleFinder.java rename cal10n-api/src/{test/java/ch/qos/cal10n/sample/WithDefaultTest.java => main/java/ch/qos/cal10n/util/StringToLocale.java} (74%) create mode 100644 cal10n-api/src/test/java/ch/qos/cal10n/util/PropertyResourceBundleFinderTest.java create mode 100644 cal10n-api/src/test/resources/colors.properties create mode 100644 cal10n-api/src/test/resources/colors_fr_FR.properties create mode 100644 cal10n-api/src/test/resources/foobar/sample_en.properties create mode 100644 cal10n-api/src/test/resources/foobar/sample_fr.properties hooks/post-receive -- Compiler assisted localization library

1 0

LocaleNames
by Ralph Goers 02 Sep '09

02 Sep '09

I'm not sure what the point of LocaleNames.java is. In a "normal" environment I would expect to see colors_en_us.properties colors_en.properties colors_jp.properties cololrs.properties In a lot of cases (in the U.S. anyway) colors.properties and colors_en.properties would be identical. But if the locale is set to something like es_MX, which doesn't exist in the list above, then colors.properties is going to be used. The other aspect to this is that property files can be chained. So colors_en_us.properties might only contain the keys for us specific phrases while colors_en.properties would contain definitions of all keys. The point is that in a "properly" configured system the key verifier should only fail if there is no key in the default file.

2 2

branch, master, updated. v0.5.1-3-g809f610
by git-noreply＠pixie.qos.ch 02 Sep '09

02 Sep '09

The branch, master has been updated via 809f61077f605b6b8a2e9b3e3cb7eeca37306b0b (commit) from 6486da0be0e36b83a9bf0fb013446bc630e77611 (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=809f61077f605b6b8a2e9b3e3… http://github.com/ceki/cal10n/commit/809f61077f605b6b8a2e9b3e3cb7eeca37306b… commit 809f61077f605b6b8a2e9b3e3cb7eeca37306b0b Author: Ceki Gulcu <ceki(a)qos.ch> Date: Wed Sep 2 14:05:24 2009 +0200 - Renamed the ResourceBundleName annotation as BaseName which is simply more accurate. - Ongoing testing of resource bundle chaining and default locale diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java b/cal10n-api/src/main/java/ch/qos/cal10n/BaseName.java similarity index 87% rename from cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java rename to cal10n-api/src/main/java/ch/qos/cal10n/BaseName.java index 4dc28b1..46fa24c 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/ResourceBundleName.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/BaseName.java @@ -38,15 +38,15 @@ import ch.qos.cal10n.verifier.MessageKeyVerifier; * * <pre> * @LocaleNames({"en", "jp"}) - * @ResourceBundleName("colors"); + * @BaseName("colors"); * public class enum Colors { * RED, WHITE, BLUE; * } * </pre> * * <p> - * In the above example, @ResourceBundleName("colors") means that there exists - * resource files with the root name "colors". In conjunction with the + * In the above example, @BaseName("colors") means that there exists a family of + * resource bundle files with the base name "colors". In conjunction with the * information provided in the @LocaleNames annotation, we can assume that the * files <em>colors_en.properties</em> and <em>colors_jp.properties</em> exist. * @@ -60,6 +60,6 @@ import ch.qos.cal10n.verifier.MessageKeyVerifier; */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) -public @interface ResourceBundleName { +public @interface BaseName { String value(); } 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 d782ec1..87d5c27 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/Cal10nConstants.java @@ -10,7 +10,7 @@ package ch.qos.cal10n; 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 MISSING_BN_ANNOTATION_URL = Cal10nConstants.CODE_URL_PREFIX+"#missingBaseNameAnnotation"; final public static String MessageKeyVerifier_FQCN = "ch.qos.cal10n.verifier.MessageKeyVerifier"; } 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 db6602b..753441f 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/LocaleNames.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/LocaleNames.java @@ -37,7 +37,7 @@ import ch.qos.cal10n.verifier.MessageKeyVerifier; * * <pre> * @LocaleNames({"en", "jp"}) - * @ResourceBundleName("colors"); + * @BaseName("colors"); * public class enum Colors { * RED, WHITE, BLUE; * } 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 4815e3e..6f682ae 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/MessageConveyor.java @@ -56,7 +56,7 @@ public class MessageConveyor implements IMessageConveyor { * * <p> * The name of the resource bundle is defined via the - * {@link ResourceBundleName} annotation whereas the locale is specified in + * {@link BaseName} annotation whereas the locale is specified in * this MessageConveyor instance's constructor. * * @param key @@ -66,12 +66,12 @@ public class MessageConveyor implements IMessageConveyor { public <E extends Enum<?>> String getMessage(E key, Object... args) { String keyAsStr = key.toString(); - String resouceBundleName = AnnotationExtractor.getResourceBundleName(key + String resouceBundleName = AnnotationExtractor.getBaseName(key .getDeclaringClass()); if (resouceBundleName == null) { throw new IllegalArgumentException( - "Missing @ResourceBundleName annotation in enum type [" + key.getClass().getName() - + "]. See also " + Cal10nConstants.MISSING_RB_ANNOTATION_URL); + "Missing @BaseName annotation in enum type [" + key.getClass().getName() + + "]. See also " + Cal10nConstants.MISSING_BN_ANNOTATION_URL); } ResourceBundle rb = ResourceBundle.getBundle(resouceBundleName, locale); diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/util/AnnotationExtractor.java b/cal10n-api/src/main/java/ch/qos/cal10n/util/AnnotationExtractor.java index 0b917f4..3c555a5 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/util/AnnotationExtractor.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/util/AnnotationExtractor.java @@ -22,7 +22,7 @@ package ch.qos.cal10n.util; import ch.qos.cal10n.LocaleNames; -import ch.qos.cal10n.ResourceBundleName; +import ch.qos.cal10n.BaseName; /** * @@ -31,10 +31,10 @@ import ch.qos.cal10n.ResourceBundleName; */ public class AnnotationExtractor { - static public <E extends Enum<?>> String getResourceBundleName( + static public <E extends Enum<?>> String getBaseName( Class<E> enumClass) { - ResourceBundleName rbnAnnotation = (ResourceBundleName) enumClass - .getAnnotation(ResourceBundleName.class); + BaseName rbnAnnotation = (BaseName) enumClass + .getAnnotation(BaseName.class); if (rbnAnnotation == null) { return null; } 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 db048f3..6ea790b 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 @@ -35,7 +35,7 @@ public class Cal10nError { enum ErrorType { // MISSING_LOCALE_NAMES_ANNOTATION - MISSING_RBN_ANNOTATION, FAILED_TO_FIND_RB, EMPTY_RB, EMPTY_ENUM, ABSENT_IN_RB, ABSENT_IN_ENUM; + MISSING_BN_ANNOTATION, FAILED_TO_FIND_RB, EMPTY_RB, EMPTY_ENUM, ABSENT_IN_RB, ABSENT_IN_ENUM; } final ErrorType errorType; @@ -74,8 +74,8 @@ public class Cal10nError { @Override public String toString() { switch (errorType) { - case MISSING_RBN_ANNOTATION: - return "Missing @ResourceBundleName annotation in enum type [" + case MISSING_BN_ANNOTATION: + return "Missing @BaseName annotation in enum type [" + enumClassName + "]"; // case MISSING_LOCALE_NAMES_ANNOTATION: // return "Missing @LocaleNames annotation in enum class [" + diff --git a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageKeyVerifier.java b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageKeyVerifier.java index 5dee005..ae4b89b 100644 --- a/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageKeyVerifier.java +++ b/cal10n-api/src/main/java/ch/qos/cal10n/verifier/IMessageKeyVerifier.java @@ -69,10 +69,10 @@ public interface IMessageKeyVerifier { public String[] getLocaleNames(); /** - * Get the name of the resource bundle specified in the enumType (via + * Get the base name for the resource bundle family as specified in the enumType (via * annotations) * * @return */ - public String getResourceBundleName(); + public String getBaseName(); } \ No newline at end of file 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 48465e9..ce31ace 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 @@ -74,10 +74,10 @@ public class MessageKeyVerifier implements IMessageKeyVerifier { List<Cal10nError> errorList = new ArrayList<Cal10nError>(); String resouceBundleName = AnnotationExtractor - .getResourceBundleName(enumType); + .getBaseName(enumType); if (resouceBundleName == null) { - errorList.add(new Cal10nError(ErrorType.MISSING_RBN_ANNOTATION, "", + errorList.add(new Cal10nError(ErrorType.MISSING_BN_ANNOTATION, "", enumType, locale, "")); // no point in continuing return errorList; @@ -167,8 +167,8 @@ public class MessageKeyVerifier implements IMessageKeyVerifier { return localeNameArray; } - public String getResourceBundleName() { - String rbName = AnnotationExtractor.getResourceBundleName(enumType); + public String getBaseName() { + String rbName = AnnotationExtractor.getBaseName(enumType); return rbName; } 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 e05bb00..bb5e4a0 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 @@ -23,9 +23,9 @@ package ch.qos.cal10n.sample; import ch.qos.cal10n.LocaleNames; -import ch.qos.cal10n.ResourceBundleName; +import ch.qos.cal10n.BaseName; -@ResourceBundleName("colors") +@BaseName("colors") @LocaleNames({"en_UK", "fr"}) public enum Colors { RED { diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/Countries.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/Countries.java index 626c621..333fbfa 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/sample/Countries.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/Countries.java @@ -22,9 +22,9 @@ package ch.qos.cal10n.sample; import ch.qos.cal10n.LocaleNames; -import ch.qos.cal10n.ResourceBundleName; +import ch.qos.cal10n.BaseName; -@ResourceBundleName("countries") +@BaseName("countries") @LocaleNames({"en", "fr"}) public enum Countries { CH, // Switzerland (Confederation Helvetique) diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/Colors.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/Furnitures.java similarity index 88% copy from cal10n-api/src/test/java/ch/qos/cal10n/sample/Colors.java copy to cal10n-api/src/test/java/ch/qos/cal10n/sample/Furnitures.java index e05bb00..07e91b9 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/sample/Colors.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/Furnitures.java @@ -19,18 +19,15 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - package ch.qos.cal10n.sample; import ch.qos.cal10n.LocaleNames; -import ch.qos.cal10n.ResourceBundleName; +import ch.qos.cal10n.BaseName; -@ResourceBundleName("colors") +@BaseName("furnitures") @LocaleNames({"en_UK", "fr"}) -public enum Colors { - RED { - - }, - BLUE, - GREEN; +public enum Furnitures { + TABLE, + CHAIR, + SOFA; } diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/Host.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/Host.java new file mode 100644 index 0000000..47b7c5f --- /dev/null +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/Host.java @@ -0,0 +1,15 @@ +package ch.qos.cal10n.sample; + +import ch.qos.cal10n.BaseName; + +public class Host { + + @BaseName("colors") + enum OtherColors { + 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 4bef85d..bdd7ba8 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 @@ -37,69 +37,57 @@ public class MessageConveyorTest { @Test public void smoke_EN() { MessageConveyor rbbmc = new MessageConveyor(Locale.UK); + String val; - { - String val = rbbmc.getMessage(Colors.BLUE); - assertEquals("violets are blue", val); - } - - { - String val = rbbmc.getMessage(Colors.GREEN, "apples"); - assertEquals("apples are green", val); - } + val = rbbmc.getMessage(Colors.BLUE); + assertEquals("violets are blue", val); + val = rbbmc.getMessage(Colors.GREEN, "apples"); + assertEquals("apples are green", val); } // 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); - } + String val; + + val = rbbmc.getMessage(Colors.RED); + assertEquals("roses are red", val); + + val = rbbmc.getMessage(OtherColors.RED); + assertEquals("roses are red", val); + + val = rbbmc.getMessage(OtherColors.BLUE); + assertEquals("violets are blue", val); } @Test public void smoke_FR() { MessageConveyor rbbmc = new MessageConveyor(Locale.FRANCE); + String val; - { - 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); - } + 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 + 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); - } + MessageParameterObj mpo; + String val; + + mpo = new MessageParameterObj(Colors.BLUE); + val = rbbmc.getMessage(mpo); + assertEquals("violets are blue", val); + + mpo = new MessageParameterObj(Colors.GREEN, "apples"); + val = rbbmc.getMessage(mpo); + assertEquals("apples are green", val); } } 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 ba875ed..6df62ba 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( { MessageKeyVerifierTest.class, MessageConveyorTest.class }) +@SuiteClasses( { MessageKeyVerifierTest.class, MessageConveyorTest.class, WithDefaultTest.class }) public class PackageTest { } diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/sample/PackageTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/sample/WithDefaultTest.java similarity index 74% copy from cal10n-api/src/test/java/ch/qos/cal10n/sample/PackageTest.java copy to cal10n-api/src/test/java/ch/qos/cal10n/sample/WithDefaultTest.java index ba875ed..b2da013 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/sample/PackageTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/sample/WithDefaultTest.java @@ -19,14 +19,26 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - package ch.qos.cal10n.sample; -import org.junit.runner.RunWith; -import org.junit.runners.Suite; -import org.junit.runners.Suite.SuiteClasses; +import static org.junit.Assert.assertEquals; + +import java.util.Locale; + +import org.junit.Test; + +import ch.qos.cal10n.MessageConveyor; + + +public class WithDefaultTest { + + @Test + public void smoke() { + MessageConveyor mc = new MessageConveyor(Locale.UK); + String val; + + val = mc.getMessage(Furnitures.TABLE); + assertEquals("the table", val); -(a)RunWith(Suite.class) -@SuiteClasses( { MessageKeyVerifierTest.class, MessageConveyorTest.class }) -public class PackageTest { + } } diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/util/AnnotationExtractorTest.java b/cal10n-api/src/test/java/ch/qos/cal10n/util/AnnotationExtractorTest.java index 0d4cd40..6959476 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/util/AnnotationExtractorTest.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/util/AnnotationExtractorTest.java @@ -35,7 +35,7 @@ public class AnnotationExtractorTest { @Test public void resourcceBundleName() { - String result = AnnotationExtractor.getResourceBundleName(Fruit.class); + String result = AnnotationExtractor.getBaseName(Fruit.class); assertEquals("fruits", result); } diff --git a/cal10n-api/src/test/java/ch/qos/cal10n/util/Fruit.java b/cal10n-api/src/test/java/ch/qos/cal10n/util/Fruit.java index b0c70af..28dcab4 100644 --- a/cal10n-api/src/test/java/ch/qos/cal10n/util/Fruit.java +++ b/cal10n-api/src/test/java/ch/qos/cal10n/util/Fruit.java @@ -22,9 +22,9 @@ package ch.qos.cal10n.util; import ch.qos.cal10n.LocaleNames; -import ch.qos.cal10n.ResourceBundleName; +import ch.qos.cal10n.BaseName; -@ResourceBundleName("fruits") +@BaseName("fruits") @LocaleNames({"fr", "en"}) public enum Fruit { APPLE, diff --git a/cal10n-api/src/test/resources/furnitures.properties b/cal10n-api/src/test/resources/furnitures.properties new file mode 100644 index 0000000..b977c62 --- /dev/null +++ b/cal10n-api/src/test/resources/furnitures.properties @@ -0,0 +1,3 @@ +TABLE=the table +CHAIR=the chair +SOFA=the sofa \ No newline at end of file diff --git a/cal10n-api/src/test/resources/furnitures_fr.properties b/cal10n-api/src/test/resources/furnitures_fr.properties new file mode 100644 index 0000000..7902933 --- /dev/null +++ b/cal10n-api/src/test/resources/furnitures_fr.properties @@ -0,0 +1,3 @@ +TABLE=la table +CHAIR=la chaise +SOFA=le sofa \ No newline at end of file diff --git a/cal10n-site/src/site/pages/codes.html b/cal10n-site/src/site/pages/codes.html index 876ed88..b6e38e4 100644 --- a/cal10n-site/src/site/pages/codes.html +++ b/cal10n-site/src/site/pages/codes.html @@ -23,19 +23,19 @@ <h1>CAL10N error codes and their meanings</h1> - <h3><a name="missingRBAnnotation" - href="#missingRBAnnotation">Missing - <code>@ResourceBundleName</code> annotation in enum type [...]. + <h3><a name="missingBaseNameAnnotation" + href="#missingBaseNameAnnotation">Missing + <code>@BaseName</code> annotation in enum type [...]. </a> </h3> - <p>The @ResourceBundleName annotation is mandatory when an - enum type is used in conjuction with <a + <p>The @BaseName 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> + href="apidocs/ch/qos/cal10n/BaseName.html">BaseName</a> annotation for more details. </p> diff --git a/cal10n-site/src/site/pages/manual.html b/cal10n-site/src/site/pages/manual.html index 487ea8a..685a471 100644 --- a/cal10n-site/src/site/pages/manual.html +++ b/cal10n-site/src/site/pages/manual.html @@ -89,9 +89,9 @@ <pre class="prettyprint source">package com.foo.somePackage; import ch.qos.cal10n.LocaleNames; -import ch.qos.cal10n.ResourceBundleName; +import ch.qos.cal10n.BaseName; -@ResourceBundleName("colors") // mandatory annotation +@BaseName("colors") // mandatory annotation @LocaleNames({"en_UK", "fr"}) // list of locale names used by // verification tools public enum Colors { @@ -102,7 +102,7 @@ public enum Colors { <p>Once you define a few color keys, you can create a regular - resource bundle named after the value of the @ResourceBundleName + resource bundle named after the value of the @BaseName annotation in Colors and the appropriate locale. For example, for the UK locale, you would name your resource bundle as <em>colors_en_UK.properties</em>. It should also be placed in the diff --git a/maven-cal10n-plugin-smoke/src/main/java/ch/qos/cal10n/smoke/Countries.java b/maven-cal10n-plugin-smoke/src/main/java/ch/qos/cal10n/smoke/Countries.java index 51e31fe..ea6f271 100644 --- a/maven-cal10n-plugin-smoke/src/main/java/ch/qos/cal10n/smoke/Countries.java +++ b/maven-cal10n-plugin-smoke/src/main/java/ch/qos/cal10n/smoke/Countries.java @@ -1,9 +1,9 @@ package ch.qos.cal10n.smoke; import ch.qos.cal10n.LocaleNames; -import ch.qos.cal10n.ResourceBundleName; +import ch.qos.cal10n.BaseName; -@ResourceBundleName("countries") +@BaseName("countries") @LocaleNames({"en", "fr"}) public enum Countries { CH, 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 72d7c83..32f41b0 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 @@ -120,7 +120,7 @@ public class VerifyMojo extends AbstractMojo { Locale locale = new Locale(localeName); List<String> errorList = mcv.typeIsolatedVerify(locale); if (errorList.size() == 0) { - String resouceBundleName = mcv.getResourceBundleName(); + String resouceBundleName = mcv.getBaseName(); getLog().info( "SUCCESSFUL verification for resource bundle [" + resouceBundleName + "] for locale [" + locale + "]"); ----------------------------------------------------------------------- Summary of changes: .../{ResourceBundleName.java => BaseName.java} | 8 +- .../main/java/ch/qos/cal10n/Cal10nConstants.java | 2 +- .../src/main/java/ch/qos/cal10n/LocaleNames.java | 2 +- .../main/java/ch/qos/cal10n/MessageConveyor.java | 8 +- .../ch/qos/cal10n/util/AnnotationExtractor.java | 8 +- .../java/ch/qos/cal10n/verifier/Cal10nError.java | 6 +- .../qos/cal10n/verifier/IMessageKeyVerifier.java | 4 +- .../ch/qos/cal10n/verifier/MessageKeyVerifier.java | 8 +- .../src/test/java/ch/qos/cal10n/sample/Colors.java | 4 +- .../test/java/ch/qos/cal10n/sample/Countries.java | 4 +- .../cal10n/sample/{Colors.java => Furnitures.java} | 15 ++-- .../src/test/java/ch/qos/cal10n/sample/Host.java | 15 ++++ .../ch/qos/cal10n/sample/MessageConveyorTest.java | 78 ++++++++----------- .../java/ch/qos/cal10n/sample/PackageTest.java | 2 +- .../{Countries.java => WithDefaultTest.java} | 30 +++++--- .../qos/cal10n/util/AnnotationExtractorTest.java | 2 +- .../src/test/java/ch/qos/cal10n/util/Fruit.java | 4 +- .../src/test/resources/furnitures.properties | 3 + .../src/test/resources/furnitures_fr.properties | 3 + cal10n-site/src/site/pages/codes.html | 12 ++-- cal10n-site/src/site/pages/manual.html | 6 +- .../main/java/ch/qos/cal10n/smoke/Countries.java | 4 +- .../java/ch/qos/cal10n/plugins/VerifyMojo.java | 2 +- 23 files changed, 122 insertions(+), 108 deletions(-) rename cal10n-api/src/main/java/ch/qos/cal10n/{ResourceBundleName.java => BaseName.java} (87%) copy cal10n-api/src/test/java/ch/qos/cal10n/sample/{Colors.java => Furnitures.java} (88%) create mode 100644 cal10n-api/src/test/java/ch/qos/cal10n/sample/Host.java copy cal10n-api/src/test/java/ch/qos/cal10n/sample/{Countries.java => WithDefaultTest.java} (74%) create mode 100644 cal10n-api/src/test/resources/furnitures.properties create mode 100644 cal10n-api/src/test/resources/furnitures_fr.properties hooks/post-receive -- Compiler assisted localization library

1 0

Are the web servers down?
by Rick Beton 02 Sep '09

02 Sep '09

I can't access *.qos.ch today. Is this a problem in Switzerland or might it be a fault here in Southern England? Rick -- Big Bee Consultants Limited : Registered in England & Wales No. 6397941 Registered Office: 71 The Hundred, Romsey, Hampshire, SO51 8BZ

3 2

Are the web servers down?
by Rick Beton 02 Sep '09

02 Sep '09

I can't access *.qos.ch today. Is this a problem in Switzerland or might it be a fault here in Southern England? Rick -- Big Bee Consultants Limited : Registered in England & Wales No. 6397941 Registered Office: 71 The Hundred, Romsey, Hampshire, SO51 8BZ

2 1

Congratulations on a useful project; here's my suggestion
by Rick Beton 02 Sep '09

02 Sep '09

Hi, First of all, I'm new to this project and I'd like to congratulate you on putting it together with your typical no-nonsense approach to APIs. Particular praise is worthy for the IMessageConveyor interface hiding the ugliness of ResourceBundle and MessageFormat within a single method with varargs - inspired simplicity! Secondly, I would like to suggest a use-case that your API does not (yet?) cover. Maybe this is an idea you could consider incorporating. Within an enterprise application, especially a web-based application for example, resources frequently need to be looked up and corresponding strings returned to the user's display. But I have found that there are times in such applications where I would prefer to defer the choice of locale. For example, I may have some 'library' code not concerned with the UI yet which produces messages that are fed back to the user. These are status messages, error messages etc. The classic way to deal with these is to return separate transfer objects and later construct messages from them, but this can make the parameterisation awkward and adds complexity. Maybe it would be simpler to return the message directly. The problem with the Cal10n API as it stands is that I need to know the locale before I can construct a MessageConveyor. Only then can I call the getMessage(E e, Object... args) method to get the string, including its formatted parameters. The problem with web applications is that only the UI tier knows the locale. It is incorrect for other tiers to assume a different locale and unwieldy to pass the correct locale through as a parameter. So it would typically be wrong for the lower tiers to use MessageConveyor. This is a shame and my suggestion is simply that an additional data transfer object is required as part of the Cal10n API to fill the gap. This is essentially a Message class containing the enumeration and the args but without the resource bundle/message format lookup having yet been performed. At a later stage, a getLocalizedMessage(Locale locale) method will yield the required String for a given locale. A desirable characteristic of Message is that it be immutable because this would make it safe to hold within Exceptions or to be shared between threads. In other words, it would be better for it not to be a classic mutable JavaBean data transfer object. Therefore it is arguable that a general interface is not needed and a concrete and final Message class would be completely sufficient. So here is a possible implementation for Message: public final class Message { private final Enum<?> e; private final Object[] args; public Message(Enum<?> e, Object... args) { this.e = e; this.args = args; } public String getLocalizedMessage(Locale locale) { final IMessageConveyor mc = new MessageConveyor(locale); return mc.getMessage(e, args); } @Override public String toString() { final StringBuilder b = new StringBuilder("Message("); b.append(e.name()); b.append(", ["); if (args != null) { String comma = ""; for (Object o : args) { b.append(comma).append(o); comma = ", "; } } b.append("])"); return b.toString(); } } In use, the 'library' (non-UI) code will have its own resource bundle and corresponding enum. It will create instances of Message to return to the UI tier, where the message string for the appropriate locale can be looked up and then presented to the user. It would be beneficial to override hashcode() and equals() methods appropriately but I haven't included that here. There may also be some performance value in holding transient caches of the toString() result and the hashcode, although I omitted this also. I wish the project success and I look forward to recommending it to my clients when it reaches a sufficient level of maturity. Regards, Rick Beton -- Big Bee Consultants Limited : Registered in England & Wales No. 6397941 Registered Office: 71 The Hundred, Romsey, Hampshire, SO51 8BZ

3 10

Different IMessageConveyer implementations
by Ralph Goers 02 Sep '09

02 Sep '09

As you know, I'm no fan of java.util.ResourceBundle. Before you get too far down the road provision for alternate implementations needs to be put in place. I'm not sure how you intend to do that but it will probably affect the way SLF4J uses this. Ralph

2 1

Trivial problem about Enum#getClass()
by Takeshi Kondo 02 Sep '09

02 Sep '09

Hi 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(). Takeshi Kondo

2 1

LocaleNames
by Ralph Goers 02 Sep '09

02 Sep '09

I'm not sure what the point of LocaleNames.java is. In a "normal" environment I would expect to see colors_en_us.properties colors_en.properties colors_jp.properties cololrs.properties In a lot of cases (in the U.S. anyway) colors.properties and colors_en.properties would be identical. But if the locale is set to something like es_MX, which doesn't exist in the list above, then colors.properties is going to be used. The other aspect to this is that property files can be chained. So colors_en_us.properties might only contain the keys for us specific phrases while colors_en.properties would contain definitions of all keys. The point is that in a "properly" configured system the key verifier should only fail if there is no key in the default file.

1 0