- cal10n-dev - mailman3.qos.ch

[cai18n-dev] [GIT] Compiler assisted internalization library branch, master, updated. a0ec2890e80cdde734f81be242b5a23ff3cd147c
by git-noreply＠pixie.qos.ch 26 Aug '09

26 Aug '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 internalization library". The branch, master has been updated via a0ec2890e80cdde734f81be242b5a23ff3cd147c (commit) from b522d133160c1fa486bfc3021b856ec088e57a9f (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=cai18n.git;a=commit;h=a0ec2890e80cdde734f81be24… http://github.com/ceki/cai18n/commit/a0ec2890e80cdde734f81be242b5a23ff3cd14… commit a0ec2890e80cdde734f81be242b5a23ff3cd147c Author: Ceki Gulcu <ceki(a)qos.ch> Date: Wed Aug 26 23:31:51 2009 +0200 annotation extraction does not quite work diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java b/cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java index 73119e0..776bf19 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java @@ -25,7 +25,7 @@ import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; - + @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) public @interface LocaleNames { diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleName.java b/cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleName.java index 449aebd..e1e8b3c 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleName.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleName.java @@ -30,4 +30,4 @@ import java.lang.annotation.Target; @Target(ElementType.TYPE) public @interface ResourceBundleName { String value(); -} +} diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java b/cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java index e8bff49..fc051dd 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java @@ -42,8 +42,10 @@ public class AnnotationExtractor { } static public <E extends Enum<?>> String[] getLocaleNames(Class<E> enumClass) { + System.out.println("xx****enumClass="+enumClass.getName()); LocaleNames localeNamesAnnotation = (LocaleNames) enumClass .getAnnotation(LocaleNames.class); + System.out.println("localeNamesAnnotation="+localeNamesAnnotation); if (localeNamesAnnotation == null) { return null; } diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java b/cai18n-api/src/test/java/ch/qos/cai18n/AllCai18nTest.java similarity index 79% copy from cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java copy to cai18n-api/src/test/java/ch/qos/cai18n/AllCai18nTest.java index 73119e0..0047679 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java +++ b/cai18n-api/src/test/java/ch/qos/cai18n/AllCai18nTest.java @@ -19,15 +19,16 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ + package ch.qos.cai18n; -import java.lang.annotation.ElementType; -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; -import java.lang.annotation.Target; +import org.junit.runner.RunWith; +import org.junit.runners.Suite; +import org.junit.runners.Suite.SuiteClasses; + +(a)RunWith(Suite.class) +(a)SuiteClasses({ch.qos.cai18n.util.PackageTest.class, + ch.qos.cai18n.sample.PackageTest.class}) +public class AllCai18nTest { -(a)Retention(RetentionPolicy.RUNTIME) -(a)Target(ElementType.TYPE) -public @interface LocaleNames { - String[] value(); } diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/util/AnnatationExtractorTest.java b/cai18n-api/src/test/java/ch/qos/cai18n/util/AnnotationExtractorTest.java similarity index 95% rename from cai18n-api/src/test/java/ch/qos/cai18n/util/AnnatationExtractorTest.java rename to cai18n-api/src/test/java/ch/qos/cai18n/util/AnnotationExtractorTest.java index 9766236..5d7efb2 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/util/AnnatationExtractorTest.java +++ b/cai18n-api/src/test/java/ch/qos/cai18n/util/AnnotationExtractorTest.java @@ -29,7 +29,7 @@ import java.util.Arrays; import org.junit.Test; -public class AnnatationExtractorTest { +public class AnnotationExtractorTest { @Test public void resourcceBundleName() { diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java b/cai18n-api/src/test/java/ch/qos/cai18n/util/PackageTest.java similarity index 77% copy from cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java copy to cai18n-api/src/test/java/ch/qos/cai18n/util/PackageTest.java index 73119e0..128dfc0 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java +++ b/cai18n-api/src/test/java/ch/qos/cai18n/util/PackageTest.java @@ -19,15 +19,14 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n; -import java.lang.annotation.ElementType; -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; -import java.lang.annotation.Target; +package ch.qos.cai18n.util; -(a)Retention(RetentionPolicy.RUNTIME) -(a)Target(ElementType.TYPE) -public @interface LocaleNames { - String[] value(); +import org.junit.runner.RunWith; +import org.junit.runners.Suite; +import org.junit.runners.Suite.SuiteClasses; + +(a)RunWith(Suite.class) +@SuiteClasses( { AnnotationExtractorTest.class }) +public class PackageTest { } diff --git a/maven-cai18n-plugin-smoke/pom.xml b/maven-cai18n-plugin-smoke/pom.xml index 3c7acf4..45a1215 100644 --- a/maven-cai18n-plugin-smoke/pom.xml +++ b/maven-cai18n-plugin-smoke/pom.xml @@ -29,15 +29,15 @@ <version>${project.version}</version> <executions> <execution> - <id>colors</id> + <id>countries</id> <phase>verify</phase> <goals> - <goal>verify</goal> + <goal>vv</goal> </goals> - <configuration> - <enumClasses> - <enumClass>ch.qos.cai18n.smoke.Countries</enumClass> - </enumClasses> + <configuration> + <enumTypes> + <enumType>ch.qos.cai18n.smoke.Countries</enumType> + </enumTypes> </configuration> </execution> </executions> diff --git a/maven-cai18n-plugin-smoke/src/main/java/ch/qos/cai18n/smoke/Countries.java b/maven-cai18n-plugin-smoke/src/main/java/ch/qos/cai18n/smoke/Countries.java index 01bd269..48f97a1 100644 --- a/maven-cai18n-plugin-smoke/src/main/java/ch/qos/cai18n/smoke/Countries.java +++ b/maven-cai18n-plugin-smoke/src/main/java/ch/qos/cai18n/smoke/Countries.java @@ -1,5 +1,10 @@ package ch.qos.cai18n.smoke; +import ch.qos.cai18n.LocaleNames; +import ch.qos.cai18n.ResourceBundleName; + +@ResourceBundleName("countries") +@LocaleNames({"en", "fr"}) public enum Countries { CH, CN, diff --git a/maven-cai18n-plugin-smoke/src/main/resources/ch/qos/cai18n/smoke/Countries_en.properties b/maven-cai18n-plugin-smoke/src/main/resources/countries_en.properties similarity index 100% rename from maven-cai18n-plugin-smoke/src/main/resources/ch/qos/cai18n/smoke/Countries_en.properties rename to maven-cai18n-plugin-smoke/src/main/resources/countries_en.properties diff --git a/maven-cai18n-plugin-smoke/src/main/resources/ch/qos/cai18n/smoke/Countries_fr.properties b/maven-cai18n-plugin-smoke/src/main/resources/countries_fr.properties similarity index 100% rename from maven-cai18n-plugin-smoke/src/main/resources/ch/qos/cai18n/smoke/Countries_fr.properties rename to maven-cai18n-plugin-smoke/src/main/resources/countries_fr.properties diff --git a/maven-cai18n-plugin/pom.xml b/maven-cai18n-plugin/pom.xml index 3e937a6..bcafd58 100644 --- a/maven-cai18n-plugin/pom.xml +++ b/maven-cai18n-plugin/pom.xml @@ -14,7 +14,7 @@ <groupId>ch.qos.cai18n.plugins</groupId> <artifactId>maven-cai18n-plugin</artifactId> -  + <version>0.0-SNAPSHOT</version> <packaging>maven-plugin</packaging> @@ -33,18 +33,6 @@ <artifactId>cai18n-api</artifactId> </dependency> - - <dependency> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-compiler-plugin</artifactId> - <version>2.0.2</version> - </dependency> - - <dependency> - <groupId>org.codehaus.mojo</groupId> - <artifactId>exec-maven-plugin</artifactId> - <version>1.1</version> - </dependency> <dependency> <groupId>junit</groupId> diff --git a/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/VerifyMojo.java b/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/VerifyMojo.java index a685f6f..5839535 100644 --- a/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/VerifyMojo.java +++ b/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/VerifyMojo.java @@ -40,7 +40,7 @@ import ch.qos.cai18n.verifier.MessageCodeVerifier; /** * Verifies resources bundles * - * + * @goal vv * @phase verify * @requiresProject true */ @@ -52,11 +52,10 @@ public class VerifyMojo extends AbstractMojo { + "#missingEnumClass"; /** - * @parameter alias="enumClass" + * @parameter * @required */ - private String[] enumClassStrArray; - + private String[] enumTypes; /** * The directory for compiled classes. @@ -70,15 +69,14 @@ public class VerifyMojo extends AbstractMojo { ClassLoader classLoader; public void execute() throws MojoExecutionException, MojoFailureException { - - System.out.println("outputDir=" + outputDirectory); - if (enumClassStrArray == null) { + if (enumTypes == null) { throw new MojoFailureException( "<enumClass> must be specified. Please see " + MISSING_ENUM_CLASS); } - for(String enumClassAsStr: enumClassStrArray) { - Class<? extends Enum<?>> enumClass = loadEnumClass(enumClassAsStr); - getLog().info("Checking codes for enum class ["+enumClassAsStr+"]"); + for (String enumTypeAsStr : enumTypes) { + Class<? extends Enum<?>> enumClass = loadEnumClass(enumTypeAsStr); + System.out.println("***enumClass=" + enumClass.getName()); + getLog().info("Checking codes for enum class [" + enumTypeAsStr + "]"); checkAllLocales(enumClass); } } @@ -86,11 +84,11 @@ public class VerifyMojo extends AbstractMojo { public void checkAllLocales(Class<? extends Enum<?>> enumClass) throws MojoFailureException { String enumClassAsStr = enumClass.getName(); - + String[] localeNameArray = AnnotationExtractor.getLocaleNames(enumClass); if (localeNameArray == null || localeNameArray.length == 0) { String errMsg = "Missing @LocaleNames annotation in enum [" - + enumClass.getClass().getName() + "]"; + + enumClassAsStr + "]"; getLog().error(errMsg); throw new MojoFailureException(errMsg); } @@ -107,14 +105,17 @@ public class VerifyMojo extends AbstractMojo { + "] for locale [" + locale + "]"); } else { failure = true; - getLog().error("FAILURE during verification of resource bundle for locale ["+locale+"] enum class ["+enumClassAsStr+"]"); + getLog().error( + "FAILURE during verification of resource bundle for locale [" + + locale + "] enum class [" + enumClassAsStr + "]"); for (Cai18nError s : errorList) { getLog().error(s.toString()); } } } - if(failure) { - throw new MojoFailureException("FAIL Verification of ["+enumClassAsStr+"] codes."); + if (failure) { + throw new MojoFailureException("FAIL Verification of [" + enumClassAsStr + + "] codes."); } } ----------------------------------------------------------------------- Summary of changes: .../src/main/java/ch/qos/cai18n/LocaleNames.java | 2 +- .../java/ch/qos/cai18n/ResourceBundleName.java | 2 +- .../ch/qos/cai18n/util/AnnotationExtractor.java | 2 + .../PackageTest.java => AllCai18nTest.java} | 10 ++++-- ...actorTest.java => AnnotationExtractorTest.java} | 2 +- .../qos/cai18n/{sample => util}/PackageTest.java | 4 +- maven-cai18n-plugin-smoke/pom.xml | 12 ++++---- .../main/java/ch/qos/cai18n/smoke/Countries.java | 5 +++ ...tries_en.properties => countries_en.properties} | 0 ...tries_fr.properties => countries_fr.properties} | 0 maven-cai18n-plugin/pom.xml | 14 +-------- .../src/main/java/ch/qos/cai18n/VerifyMojo.java | 31 ++++++++++--------- 12 files changed, 41 insertions(+), 43 deletions(-) copy cai18n-api/src/test/java/ch/qos/cai18n/{sample/PackageTest.java => AllCai18nTest.java} (87%) rename cai18n-api/src/test/java/ch/qos/cai18n/util/{AnnatationExtractorTest.java => AnnotationExtractorTest.java} (95%) copy cai18n-api/src/test/java/ch/qos/cai18n/{sample => util}/PackageTest.java (90%) rename maven-cai18n-plugin-smoke/src/main/resources/{ch/qos/cai18n/smoke/Countries_en.properties => countries_en.properties} (100%) rename maven-cai18n-plugin-smoke/src/main/resources/{ch/qos/cai18n/smoke/Countries_fr.properties => countries_fr.properties} (100%) hooks/post-receive -- Compiler assisted internalization library

1 0

[cai18n-dev] [GIT] Compiler assisted internalization library branch, master, updated. b522d133160c1fa486bfc3021b856ec088e57a9f
by git-noreply＠pixie.qos.ch 26 Aug '09

26 Aug '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 internalization library". The branch, master has been updated via b522d133160c1fa486bfc3021b856ec088e57a9f (commit) from c0d26e1af985ee4212fc38b341dd624ced42b7b3 (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=cai18n.git;a=commit;h=b522d133160c1fa486bfc3021… http://github.com/ceki/cai18n/commit/b522d133160c1fa486bfc3021b856ec088e57a… commit b522d133160c1fa486bfc3021b856ec088e57a9f Author: Ceki Gulcu <ceki(a)qos.ch> Date: Wed Aug 26 17:30:52 2009 +0200 ongoing work on the mojo diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/IMessageConveyor.java b/cai18n-api/src/main/java/ch/qos/cai18n/IMessageConveyor.java index 7a98e2e..521bfe4 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/IMessageConveyor.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/IMessageConveyor.java @@ -22,11 +22,43 @@ package ch.qos.cai18n; +import java.text.MessageFormat; // note that the getMessage method does not take a Locale. // It is supposed that the MessageConveyor instance knows // which locale to use. +/** + * Retrieve a message by its code as specified by an enum. + * + * <p> + * The strategy in retrieving messages may vary from implementation to + * implementation. + * + * @author Ceki Gülcü + */ public interface IMessageConveyor { - <E extends Enum<?>> String getMessage(E e, Object... args); + + /** + * Retrieve a message by its code 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 + * conventions of {@link MessageFormat}. + * + * @param <E> + * an enum type + * @param e + * an enum instance + * @param args + * optional arguments + * @return + * + * @param <E> + * @param e + * @param args + * @return + */ + <E extends Enum<?>> String getMessage(E e, Object... args); } diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java b/cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java index 28763c7..e8bff49 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java @@ -24,20 +24,27 @@ package ch.qos.cai18n.util; import ch.qos.cai18n.LocaleNames; import ch.qos.cai18n.ResourceBundleName; +/** + * + * @author Ceki Gülcü + * + */ public class AnnotationExtractor { - - static public <E extends Enum<?>> String getResourceBundleName(Class<E> someClass) { - ResourceBundleName rbnAnnotation = (ResourceBundleName) someClass.getAnnotation(ResourceBundleName.class); - if(rbnAnnotation == null) { + + static public <E extends Enum<?>> String getResourceBundleName( + Class<E> enumClass) { + ResourceBundleName rbnAnnotation = (ResourceBundleName) enumClass + .getAnnotation(ResourceBundleName.class); + if (rbnAnnotation == null) { return null; } return rbnAnnotation.value(); } - - static public <E extends Enum<?>> String[] getLocaleNames(Class<E> someClass) { - LocaleNames localeNamesAnnotation = (LocaleNames) someClass.getAnnotation(LocaleNames.class); - if(localeNamesAnnotation == null) { + static public <E extends Enum<?>> String[] getLocaleNames(Class<E> enumClass) { + LocaleNames localeNamesAnnotation = (LocaleNames) enumClass + .getAnnotation(LocaleNames.class); + if (localeNamesAnnotation == null) { return null; } return localeNamesAnnotation.value(); diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/Cai18nError.java b/cai18n-api/src/main/java/ch/qos/cai18n/verifier/Cai18nError.java index 3243345..f75420b 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/Cai18nError.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/verifier/Cai18nError.java @@ -23,9 +23,18 @@ package ch.qos.cai18n.verifier; import java.util.Locale; +/** + * + * Aggregates various parameters of a verification error in a single place + * (class). + * + * @author Ceki Gülcü + */ public class Cai18nError { enum ErrorType { + // MISSING_LOCALE_NAMES_ANNOTATION + MISSING_RBN_ANNOTATION, FAILED_TO_FIND_RB, EMPTY_RB, EMPTY_ENUM, ABSENT_IN_RB, ABSENT_IN_ENUM; } @@ -66,8 +75,12 @@ public class Cai18nError { public String toString() { switch (errorType) { case MISSING_RBN_ANNOTATION: - return "Missing @ResourceBundleName annotation in enun class [" + return "Missing @ResourceBundleName annotation in enum class [" + enumClassName + "]"; + // case MISSING_LOCALE_NAMES_ANNOTATION: + // return "Missing @LocaleNames annotation in enum class [" + + // enumClassName + // + "]"; case FAILED_TO_FIND_RB: return "Failed to locate resource bundle [" + resouceBundleName + "]for locale [" + locale + "] for enum class [" + enumClassName @@ -83,7 +96,8 @@ public class Cai18nError { + "] but absent in enum class [" + enumClassName + "]"; case ABSENT_IN_RB: return "Code [" + code + "] present in enum class [" + enumClassName - + "] but absent in resource bundle named ["+resouceBundleName+"] for locale [" + locale + "]"; + + "] but absent in resource bundle named [" + resouceBundleName + + "] for locale [" + locale + "]"; default: throw new IllegalStateException("Impossible to reach here"); } diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java b/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java index 8fb2d2f..d7907ff 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java @@ -32,8 +32,8 @@ import ch.qos.cai18n.util.AnnotationExtractor; import ch.qos.cai18n.verifier.Cai18nError.ErrorType; /** - * Given an enum class, verify that the corresponding resource bundles contain - * the correct codes. + * Given an enum class, verify that the resource bundles corresponding to a + * given locale contains the correct codes. * * @author Ceki Gulcu */ diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/MessageCodeVerifierTest.java b/cai18n-api/src/test/java/ch/qos/cai18n/sample/MessageCodeVerifierTest.java index 99dc4bd..346f66a 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/MessageCodeVerifierTest.java +++ b/cai18n-api/src/test/java/ch/qos/cai18n/sample/MessageCodeVerifierTest.java @@ -32,7 +32,10 @@ import org.junit.Test; import ch.qos.cai18n.verifier.Cai18nError; import ch.qos.cai18n.verifier.MessageCodeVerifier; - +/** + * + * @author Ceki Gülcü + */ public class MessageCodeVerifierTest { diff --git a/maven-cai18n-plugin-smoke/pom.xml b/maven-cai18n-plugin-smoke/pom.xml index e795081..3c7acf4 100644 --- a/maven-cai18n-plugin-smoke/pom.xml +++ b/maven-cai18n-plugin-smoke/pom.xml @@ -35,13 +35,10 @@ <goal>verify</goal> </goals> <configuration> - <enumClass>ch.qos.cai18n.smoke.Countries</enumClass> - <locales> - <locale>en</locale> - <locale>fr</locale> - <locale>de</locale> - </locales> - </configuration> + <enumClasses> + <enumClass>ch.qos.cai18n.smoke.Countries</enumClass> + </enumClasses> + </configuration> </execution> </executions> </plugin> diff --git a/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/VerifyMojo.java b/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/VerifyMojo.java index 15db43f..a685f6f 100644 --- a/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/VerifyMojo.java +++ b/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/VerifyMojo.java @@ -33,6 +33,7 @@ import org.apache.maven.plugin.AbstractMojo; import org.apache.maven.plugin.MojoExecutionException; import org.apache.maven.plugin.MojoFailureException; +import ch.qos.cai18n.util.AnnotationExtractor; import ch.qos.cai18n.verifier.Cai18nError; import ch.qos.cai18n.verifier.MessageCodeVerifier; @@ -45,19 +46,17 @@ import ch.qos.cai18n.verifier.MessageCodeVerifier; */ public class VerifyMojo extends AbstractMojo { - final static String MISSING_LOCALE = Cai18nConstants.CODE_URL_PREFIX+"#missingLocale"; - final static String MISSING_ENUM_CLASS = Cai18nConstants.CODE_URL_PREFIX+"#missingEnumClass"; + final static String MISSING_LOCALE = Cai18nConstants.CODE_URL_PREFIX + + "#missingLocale"; + final static String MISSING_ENUM_CLASS = Cai18nConstants.CODE_URL_PREFIX + + "#missingEnumClass"; /** * @parameter alias="enumClass" * @required */ - private String enumClassAsStr; + private String[] enumClassStrArray; - /** - * @parameter A set of locales to check. - */ - private String[] locales; /** * The directory for compiled classes. @@ -68,47 +67,64 @@ public class VerifyMojo extends AbstractMojo { */ private File outputDirectory; - ClassLoader classLoader; - + public void execute() throws MojoExecutionException, MojoFailureException { System.out.println("outputDir=" + outputDirectory); - if (enumClassAsStr == null) { + if (enumClassStrArray == null) { throw new MojoFailureException( "<enumClass> must be specified. Please see " + MISSING_ENUM_CLASS); } + for(String enumClassAsStr: enumClassStrArray) { + Class<? extends Enum<?>> enumClass = loadEnumClass(enumClassAsStr); + getLog().info("Checking codes for enum class ["+enumClassAsStr+"]"); + checkAllLocales(enumClass); + } + } - Class<? extends Enum<?>> enumClass = loadEnumClass(enumClassAsStr); + public void checkAllLocales(Class<? extends Enum<?>> enumClass) + throws MojoFailureException { + String enumClassAsStr = enumClass.getName(); + + String[] localeNameArray = AnnotationExtractor.getLocaleNames(enumClass); + if (localeNameArray == null || localeNameArray.length == 0) { + String errMsg = "Missing @LocaleNames annotation in enum [" + + enumClass.getClass().getName() + "]"; + getLog().error(errMsg); + throw new MojoFailureException(errMsg); + } - if (locales == null) { - throw new MojoFailureException("<locales> cannot be empty. Please see " - + MISSING_LOCALE); - } else { - for (String l : locales) { - getLog().info("Checking locale " + l); - check(enumClass, l); + boolean failure = false; + for (String localeName : localeNameArray) { + Locale locale = new Locale(localeName); + List<Cai18nError> errorList = check(enumClass, locale); + if (errorList.size() == 0) { + String resouceBundleName = AnnotationExtractor + .getResourceBundleName(enumClass); + getLog().info( + "SUCCESSFUL verification for resource bundle [" + resouceBundleName + + "] for locale [" + locale + "]"); + } else { + failure = true; + getLog().error("FAILURE during verification of resource bundle for locale ["+locale+"] enum class ["+enumClassAsStr+"]"); + for (Cai18nError s : errorList) { + getLog().error(s.toString()); + } } } - getLog().info("enumClass= " + enumClassAsStr); + if(failure) { + throw new MojoFailureException("FAIL Verification of ["+enumClassAsStr+"] codes."); + } } - public void check(Class<? extends Enum<?>> enumClass, String localeAsStr) - throws MojoFailureException { - Locale locale = new Locale(localeAsStr); - MessageCodeVerifier mcv = new MessageCodeVerifier(enumClass, getClassLoader()); + public List<Cai18nError> check(Class<? extends Enum<?>> enumClass, + Locale locale) throws MojoFailureException { + + MessageCodeVerifier mcv = new MessageCodeVerifier(enumClass, + getClassLoader()); List<Cai18nError> errorList = mcv.verify(locale); - if (errorList.size() == 0) { - getLog().info("Verification succeeded for locale [" + locale + "]"); - } else { - getLog().error(" Verification errors occurred"); - for (Cai18nError s : errorList) { - getLog().error(s.toString()); - } - getLog().error(" "); - throw new MojoFailureException("Verification failures for locale [" - + locale + "]"); - } + return errorList; } @SuppressWarnings("unchecked") @@ -126,24 +142,24 @@ public class VerifyMojo extends AbstractMojo { } ClassLoader getClassLoader() { - if(classLoader == null) { + if (classLoader == null) { classLoader = buildClassLoader(); } return classLoader; } - - ClassLoader buildClassLoader() { + + ClassLoader buildClassLoader() { ArrayList<URL> classpathURLArray = new ArrayList<URL>(); classpathURLArray.add(toURL(outputDirectory)); return new URLClassLoader(classpathURLArray.toArray(new URL[] {})); } - URL toURL(File file) { + URL toURL(File file) { try { return file.toURI().toURL(); } catch (MalformedURLException e) { // this should never happen - getLog().error("Failed to convert file ["+file+"] to a URL", e); + getLog().error("Failed to convert file [" + file + "] to a URL", e); return null; } } ----------------------------------------------------------------------- Summary of changes: .../main/java/ch/qos/cai18n/IMessageConveyor.java | 34 +++++++- .../ch/qos/cai18n/util/AnnotationExtractor.java | 23 +++-- .../java/ch/qos/cai18n/verifier/Cai18nError.java | 18 ++++- .../qos/cai18n/verifier/MessageCodeVerifier.java | 4 +- .../qos/cai18n/sample/MessageCodeVerifierTest.java | 5 +- maven-cai18n-plugin-smoke/pom.xml | 11 +-- .../src/main/java/ch/qos/cai18n/VerifyMojo.java | 94 ++++++++++++-------- 7 files changed, 129 insertions(+), 60 deletions(-) hooks/post-receive -- Compiler assisted internalization library

1 0

[cai18n-dev] [GIT] Compiler assisted internalization library branch, master, updated. c0d26e1af985ee4212fc38b341dd624ced42b7b3
by git-noreply＠pixie.qos.ch 26 Aug '09

26 Aug '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 internalization library". The branch, master has been updated via c0d26e1af985ee4212fc38b341dd624ced42b7b3 (commit) from 1e4c54f2cb4f90ed5af9d40afe9573d2dd9f7a76 (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=cai18n.git;a=commit;h=c0d26e1af985ee4212fc38b34… http://github.com/ceki/cai18n/commit/c0d26e1af985ee4212fc38b341dd624ced42b7… commit c0d26e1af985ee4212fc38b341dd624ced42b7b3 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Wed Aug 26 16:36:38 2009 +0200 ongoing work diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Countries.java b/cai18n-api/src/test/java/ch/qos/cai18n/sample/Countries.java index d5c3ca6..8cab228 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Countries.java +++ b/cai18n-api/src/test/java/ch/qos/cai18n/sample/Countries.java @@ -21,8 +21,12 @@ */ package ch.qos.cai18n.sample; -public enum Countries { +import ch.qos.cai18n.LocaleNames; +import ch.qos.cai18n.ResourceBundleName; +@ResourceBundleName("countries") +@LocaleNames({"en", "fr"}) +public enum Countries { CH, // Switzerland (Confederation Helvetique) CN, // China FR, // France diff --git a/cai18n-api/src/test/resources/ch/qos/cai18n/sample/Countries_en.properties b/cai18n-api/src/test/resources/countries_en.properties similarity index 100% rename from cai18n-api/src/test/resources/ch/qos/cai18n/sample/Countries_en.properties rename to cai18n-api/src/test/resources/countries_en.properties diff --git a/cai18n-api/src/test/resources/ch/qos/cai18n/sample/Countries_fr.properties b/cai18n-api/src/test/resources/countries_fr.properties similarity index 100% rename from cai18n-api/src/test/resources/ch/qos/cai18n/sample/Countries_fr.properties rename to cai18n-api/src/test/resources/countries_fr.properties diff --git a/cai18n-site/src/site/pages/manual.html b/cai18n-site/src/site/pages/manual.html index 7c6060c..c1b515d 100644 --- a/cai18n-site/src/site/pages/manual.html +++ b/cai18n-site/src/site/pages/manual.html @@ -40,9 +40,13 @@ <p>For the sake of argument, assume you wish to internationalize color names, in CAI18N you could write a color enum.</p> - <pre class="prettyprint source"> -package com.foo.somePackage; + <pre class="prettyprint source">package com.foo.somePackage; +import ch.qos.cai18n.LocaleNames; +import ch.qos.cai18n.ResourceBundleName; + +@ResourceBundleName("colors") // mandatory annonation +@LocaleNames({"en_UK", "fr"}) // optional list of locale names public enum Colors { BLUE, RED, @@ -51,12 +55,13 @@ public enum Colors { <p>Once you define a few color names, you can create a regular - resource bundle named after the Colors enum and its 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 - "com/foo/somePackage" folder of the appropriate jar file.</p> + resource bundle named after value of the @ResourceBundleName + 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 + root of folder of the appropriate jar file.</p> - <p>Here is a sample a <em>Colors_en_UK.properties</em> file:</p> + <p>Here is a sample a <em>colors_en_UK.properties</em> file:</p> <pre class="source"> BLUE=violets are blue @@ -64,7 +69,7 @@ RED=roses are red GREEN={0} are green </pre> <p>For the french locale, the resource bundle would be named - <em>Colors_fr.properties</em>. Here are possible contents.</p> + <em>colors_fr.properties</em>. Here are possible contents.</p> <pre class="source"> BLUE=les violettes sont bleues @@ -77,7 +82,7 @@ GREEN=les {0} sont verts</pre> <p>In your application, you would retreive the localized message as follows: </p> - <pre class="prettyprint source">// obtain a message convetor for France + <pre class="prettyprint source">// obtain a message conveyor for France MessageConveyor mc = new MessageConveyor(Locale.FRANCE); // use it to retrieve internationalized messages ----------------------------------------------------------------------- Summary of changes: .../test/java/ch/qos/cai18n/sample/Countries.java | 6 ++++- ...tries_en.properties => countries_en.properties} | 0 ...tries_fr.properties => countries_fr.properties} | 0 cai18n-site/src/site/pages/manual.html | 23 ++++++++++++------- 4 files changed, 19 insertions(+), 10 deletions(-) rename cai18n-api/src/test/resources/{ch/qos/cai18n/sample/Countries_en.properties => countries_en.properties} (100%) rename cai18n-api/src/test/resources/{ch/qos/cai18n/sample/Countries_fr.properties => countries_fr.properties} (100%) hooks/post-receive -- Compiler assisted internalization library

1 0

[cai18n-dev] [GIT] Compiler assisted internalization library branch, master, updated. 1e4c54f2cb4f90ed5af9d40afe9573d2dd9f7a76
by git-noreply＠pixie.qos.ch 26 Aug '09

26 Aug '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 internalization library". The branch, master has been updated via 1e4c54f2cb4f90ed5af9d40afe9573d2dd9f7a76 (commit) from 2d5189416acbfd4acbdcfa98a74eb31ded7ae4e8 (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=cai18n.git;a=commit;h=1e4c54f2cb4f90ed5af9d40af… http://github.com/ceki/cai18n/commit/1e4c54f2cb4f90ed5af9d40afe9573d2dd9f7a… commit 1e4c54f2cb4f90ed5af9d40afe9573d2dd9f7a76 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Wed Aug 26 16:19:42 2009 +0200 x- Enum class can now be annotated which makes it much easier during verification diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/Cai18nConstants.java b/cai18n-api/src/main/java/ch/qos/cai18n/Cai18nConstants.java new file mode 100644 index 0000000..7568ff0 --- /dev/null +++ b/cai18n-api/src/main/java/ch/qos/cai18n/Cai18nConstants.java @@ -0,0 +1,8 @@ +package ch.qos.cai18n; + +public class Cai18nConstants { + + final public static String CODE_URL_PREFIX = "http://cai18n.qos.ch/codes.html"; + final public static String MISSING_RB_ANNOTATION_URL = Cai18nConstants.CODE_URL_PREFIX+"#missingRBAnnotation"; + +} diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java b/cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java similarity index 77% copy from cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java copy to cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java index fda5f1f..73119e0 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/LocaleNames.java @@ -19,11 +19,15 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ +package ch.qos.cai18n; -package ch.qos.cai18n.sample; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; -public enum Colors { - RED, - BLUE, - GREEN; +(a)Retention(RetentionPolicy.RUNTIME) +(a)Target(ElementType.TYPE) +public @interface LocaleNames { + String[] value(); } diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java b/cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java index 1edc794..d471b5a 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java @@ -20,13 +20,14 @@ * SOFTWARE. */ - package ch.qos.cai18n; import java.text.MessageFormat; import java.util.Locale; import java.util.ResourceBundle; +import ch.qos.cai18n.util.AnnotationExtractor; + public class MessageConveyor implements IMessageConveyor { Locale locale; @@ -35,17 +36,23 @@ public class MessageConveyor implements IMessageConveyor { this.locale = locale; } - public <E extends Enum<?>> String getMessage(E e, Object... args) { - String code = e.toString(); - ResourceBundle rb = ResourceBundle - .getBundle(e.getClass().getName(), locale); + String code = e.toString(); + + String resouceBundleName = AnnotationExtractor.getResourceBundleName(e + .getClass()); + if (resouceBundleName == null) { + throw new IllegalArgumentException( + "Missing ResourceBundleAnnotation in [" + e.getClass().getName() + + "]. See also " + Cai18nConstants.MISSING_RB_ANNOTATION_URL); + } + ResourceBundle rb = ResourceBundle.getBundle(resouceBundleName, locale); String value = rb.getString(code); if (value == null) { return "No key found for " + code; } else { - if (args.length == 0) { + if (args == null || args.length == 0) { return value; } else { return MessageFormat.format(value, args); diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java b/cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleName.java similarity index 77% copy from cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java copy to cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleName.java index fda5f1f..449aebd 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleName.java @@ -19,11 +19,15 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ +package ch.qos.cai18n; -package ch.qos.cai18n.sample; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; -public enum Colors { - RED, - BLUE, - GREEN; +(a)Retention(RetentionPolicy.RUNTIME) +(a)Target(ElementType.TYPE) +public @interface ResourceBundleName { + String value(); } diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java b/cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java similarity index 60% copy from cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java copy to cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java index 1edc794..28763c7 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/util/AnnotationExtractor.java @@ -19,38 +19,28 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ +package ch.qos.cai18n.util; +import ch.qos.cai18n.LocaleNames; +import ch.qos.cai18n.ResourceBundleName; -package ch.qos.cai18n; - -import java.text.MessageFormat; -import java.util.Locale; -import java.util.ResourceBundle; - -public class MessageConveyor implements IMessageConveyor { - - Locale locale; - - public MessageConveyor(Locale locale) { - this.locale = locale; +public class AnnotationExtractor { + + static public <E extends Enum<?>> String getResourceBundleName(Class<E> someClass) { + ResourceBundleName rbnAnnotation = (ResourceBundleName) someClass.getAnnotation(ResourceBundleName.class); + if(rbnAnnotation == null) { + return null; + } + return rbnAnnotation.value(); } - - public <E extends Enum<?>> String getMessage(E e, Object... args) { - String code = e.toString(); - ResourceBundle rb = ResourceBundle - .getBundle(e.getClass().getName(), locale); - - String value = rb.getString(code); - if (value == null) { - return "No key found for " + code; - } else { - if (args.length == 0) { - return value; - } else { - return MessageFormat.format(value, args); - } + + static public <E extends Enum<?>> String[] getLocaleNames(Class<E> someClass) { + LocaleNames localeNamesAnnotation = (LocaleNames) someClass.getAnnotation(LocaleNames.class); + if(localeNamesAnnotation == null) { + return null; } + return localeNamesAnnotation.value(); } } diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/Cai18nError.java b/cai18n-api/src/main/java/ch/qos/cai18n/verifier/Cai18nError.java index 92f8134..3243345 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/Cai18nError.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/verifier/Cai18nError.java @@ -26,19 +26,24 @@ import java.util.Locale; public class Cai18nError { enum ErrorType { - EMPTY_RB, EMPTY_ENUM, ABSENT_IN_RB, ABSENT_IN_ENUM; + MISSING_RBN_ANNOTATION, FAILED_TO_FIND_RB, EMPTY_RB, EMPTY_ENUM, ABSENT_IN_RB, ABSENT_IN_ENUM; } final ErrorType errorType; final String code; final Locale locale; + final Class<?> enumClass; final String enumClassName; + final String resouceBundleName; - Cai18nError(ErrorType errorType, String code, String enumClassName, Locale locale) { + Cai18nError(ErrorType errorType, String code, Class<?> enumClass, + Locale locale, String resourceBundleName) { this.errorType = errorType; this.code = code; - this.enumClassName = enumClassName; + this.enumClass = enumClass; + this.enumClassName = enumClass.getName(); this.locale = locale; + this.resouceBundleName = resourceBundleName; } public ErrorType getErrorType() { @@ -53,23 +58,32 @@ public class Cai18nError { return locale; } - public String getEnumClassName() { - return enumClassName; + public Class<?> getEnumClass() { + return enumClass; } @Override public String toString() { switch (errorType) { + case MISSING_RBN_ANNOTATION: + return "Missing @ResourceBundleName annotation in enun class [" + + enumClassName + "]"; + case FAILED_TO_FIND_RB: + return "Failed to locate resource bundle [" + resouceBundleName + + "]for locale [" + locale + "] for enum class [" + enumClassName + + "]"; case EMPTY_RB: - return "Empty resource bundle for locale [" + locale + "]"; + return "Empty resource bundle named [" + resouceBundleName + + "] for locale [" + locale + "]"; case EMPTY_ENUM: return "Empty enum class [" + enumClassName + "]"; case ABSENT_IN_ENUM: - return "Code [" + code + "] present in resource bundle locale [" + locale + return "Code [" + code + "] present in resource bundle named [" + + resouceBundleName + "] for locale [" + locale + "] but absent in enum class [" + enumClassName + "]"; case ABSENT_IN_RB: return "Code [" + code + "] present in enum class [" + enumClassName - + "] but absent in resource bundle locale [" + locale + "]"; + + "] but absent in resource bundle named ["+resouceBundleName+"] for locale [" + locale + "]"; default: throw new IllegalStateException("Impossible to reach here"); } diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/ErrorFactory.java b/cai18n-api/src/main/java/ch/qos/cai18n/verifier/ErrorFactory.java index b9af952..2f74f53 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/ErrorFactory.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/verifier/ErrorFactory.java @@ -28,14 +28,16 @@ import ch.qos.cai18n.verifier.Cai18nError.ErrorType; public class ErrorFactory { final Locale locale; - final String enumClassName; - - public ErrorFactory(String enumClassName, Locale locale) { + final Class<?> enumClass; + final String resourceBundleName; + + public ErrorFactory(Class<?> enumClass, Locale locale, String resourceBundleName) { this.locale = locale; - this.enumClassName = enumClassName; + this.enumClass = enumClass; + this.resourceBundleName = resourceBundleName; } Cai18nError buildError(ErrorType errorType, String code) { - return new Cai18nError(errorType, code, enumClassName, locale); + return new Cai18nError(errorType, code, enumClass, locale, resourceBundleName); } } diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java b/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java index a1c2aca..8fb2d2f 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java @@ -28,12 +28,14 @@ import java.util.Locale; import java.util.ResourceBundle; import java.util.Set; +import ch.qos.cai18n.util.AnnotationExtractor; import ch.qos.cai18n.verifier.Cai18nError.ErrorType; /** + * Given an enum class, verify that the corresponding resource bundles contain + * the correct codes. * * @author Ceki Gulcu - * */ public class MessageCodeVerifier { @@ -59,24 +61,41 @@ public class MessageCodeVerifier { */ public List<Cai18nError> verify(Locale locale) { List<Cai18nError> errorList = new ArrayList<Cai18nError>(); - ResourceBundle rb = ResourceBundle.getBundle(enumClass.getName(), locale, + + String resouceBundleName = AnnotationExtractor + .getResourceBundleName(enumClass); + + if (resouceBundleName == null) { + errorList.add(new Cai18nError(ErrorType.MISSING_RBN_ANNOTATION, "", + enumClass, locale, "")); + // no point in continuing + return errorList; + } + + ResourceBundle rb = ResourceBundle.getBundle(resouceBundleName, locale, classLoader); - ErrorFactory errorFactory = new ErrorFactory(enumClass.getName(), locale); + ErrorFactory errorFactory = new ErrorFactory(enumClass, locale, + resouceBundleName); + + if (rb == null) { + errorList.add(errorFactory.buildError(ErrorType.FAILED_TO_FIND_RB, "")); + } + Set<String> rbKeySet = rb.keySet(); if (rbKeySet.size() == 0) { errorList.add(errorFactory.buildError(ErrorType.EMPTY_RB, "")); } Enum<?>[] enumArray = enumClass.getEnumConstants(); - if(enumArray == null || enumArray.length == 0) { + if (enumArray == null || enumArray.length == 0) { errorList.add(errorFactory.buildError(ErrorType.EMPTY_ENUM, "")); } - - if(errorList.size() != 0) { + + if (errorList.size() != 0) { return errorList; } - + for (Enum<?> e : enumArray) { String enumKey = e.toString(); if (rbKeySet.contains(enumKey)) { diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java b/cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java index fda5f1f..3dc468a 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java +++ b/cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java @@ -22,8 +22,9 @@ package ch.qos.cai18n.sample; +import ch.qos.cai18n.ResourceBundleName; + +@ResourceBundleName("colors") public enum Colors { - RED, - BLUE, - GREEN; + RED, BLUE, GREEN; } diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/ResourceBunleBasedMC_Test.java b/cai18n-api/src/test/java/ch/qos/cai18n/sample/MessageConveyorTest.java similarity index 94% rename from cai18n-api/src/test/java/ch/qos/cai18n/sample/ResourceBunleBasedMC_Test.java rename to cai18n-api/src/test/java/ch/qos/cai18n/sample/MessageConveyorTest.java index 93a8289..94bb2e2 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/ResourceBunleBasedMC_Test.java +++ b/cai18n-api/src/test/java/ch/qos/cai18n/sample/MessageConveyorTest.java @@ -30,7 +30,7 @@ import org.junit.Test; import ch.qos.cai18n.MessageConveyor; -public class ResourceBunleBasedMC_Test { +public class MessageConveyorTest { @Test public void smoke_EN() { diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/PackageTest.java b/cai18n-api/src/test/java/ch/qos/cai18n/sample/PackageTest.java index 70c8a34..499c65e 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/PackageTest.java +++ b/cai18n-api/src/test/java/ch/qos/cai18n/sample/PackageTest.java @@ -27,6 +27,6 @@ import org.junit.runners.Suite; import org.junit.runners.Suite.SuiteClasses; @RunWith(Suite.class) -@SuiteClasses( { MessageCodeVerifierTest.class, ResourceBunleBasedMC_Test.class }) +@SuiteClasses( { MessageCodeVerifierTest.class, MessageConveyorTest.class }) public class PackageTest { } diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/ErrorFactory.java b/cai18n-api/src/test/java/ch/qos/cai18n/util/AnnatationExtractorTest.java similarity index 65% copy from cai18n-api/src/main/java/ch/qos/cai18n/verifier/ErrorFactory.java copy to cai18n-api/src/test/java/ch/qos/cai18n/util/AnnatationExtractorTest.java index b9af952..9766236 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/ErrorFactory.java +++ b/cai18n-api/src/test/java/ch/qos/cai18n/util/AnnatationExtractorTest.java @@ -19,23 +19,29 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -package ch.qos.cai18n.verifier; +package ch.qos.cai18n.util; -import java.util.Locale; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; -import ch.qos.cai18n.verifier.Cai18nError.ErrorType; +import java.util.Arrays; -public class ErrorFactory { +import org.junit.Test; - final Locale locale; - final String enumClassName; - - public ErrorFactory(String enumClassName, Locale locale) { - this.locale = locale; - this.enumClassName = enumClassName; + +public class AnnatationExtractorTest { + + @Test + public void resourcceBundleName() { + String result = AnnotationExtractor.getResourceBundleName(Fruit.class); + assertEquals("fruits", result); } - - Cai18nError buildError(ErrorType errorType, String code) { - return new Cai18nError(errorType, code, enumClassName, locale); + + @Test + public void localeNames() { + String[] result = AnnotationExtractor.getLocaleNames(Fruit.class); + assertTrue(Arrays.equals(new String[] {"fr", "en"}, result)); } + + } diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java b/cai18n-api/src/test/java/ch/qos/cai18n/util/Fruit.java similarity index 83% copy from cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java copy to cai18n-api/src/test/java/ch/qos/cai18n/util/Fruit.java index fda5f1f..610077b 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/Colors.java +++ b/cai18n-api/src/test/java/ch/qos/cai18n/util/Fruit.java @@ -19,11 +19,14 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ +package ch.qos.cai18n.util; -package ch.qos.cai18n.sample; +import ch.qos.cai18n.LocaleNames; +import ch.qos.cai18n.ResourceBundleName; -public enum Colors { - RED, - BLUE, - GREEN; +@ResourceBundleName("fruits") +@LocaleNames({"fr", "en"}) +public enum Fruit { + APPLE, + ORANGE; } diff --git a/cai18n-api/src/test/resources/ch/qos/cai18n/sample/Colors_en.properties b/cai18n-api/src/test/resources/colors_en.properties similarity index 100% rename from cai18n-api/src/test/resources/ch/qos/cai18n/sample/Colors_en.properties rename to cai18n-api/src/test/resources/colors_en.properties diff --git a/cai18n-api/src/test/resources/ch/qos/cai18n/sample/Colors_fr.properties b/cai18n-api/src/test/resources/colors_fr.properties similarity index 100% rename from cai18n-api/src/test/resources/ch/qos/cai18n/sample/Colors_fr.properties rename to cai18n-api/src/test/resources/colors_fr.properties diff --git a/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/VerifyMojo.java b/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/VerifyMojo.java index 90e19b0..15db43f 100644 --- a/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/VerifyMojo.java +++ b/maven-cai18n-plugin/src/main/java/ch/qos/cai18n/VerifyMojo.java @@ -45,8 +45,8 @@ import ch.qos.cai18n.verifier.MessageCodeVerifier; */ public class VerifyMojo extends AbstractMojo { - final static String MISSING_LOCALE = "http://cai18n.qos.ch/codes.html#missingLocale"; - final static String MISSING_ENUM_CLASS = "http://cai18n.qos.ch/codes.html#missingEnumClass"; + final static String MISSING_LOCALE = Cai18nConstants.CODE_URL_PREFIX+"#missingLocale"; + final static String MISSING_ENUM_CLASS = Cai18nConstants.CODE_URL_PREFIX+"#missingEnumClass"; /** * @parameter alias="enumClass" ----------------------------------------------------------------------- Summary of changes: .../main/java/ch/qos/cai18n/Cai18nConstants.java | 8 ++++ .../{IMessageConveyor.java => LocaleNames.java} | 15 ++++--- .../main/java/ch/qos/cai18n/MessageConveyor.java | 19 ++++++--- ...essageConveyor.java => ResourceBundleName.java} | 15 ++++--- .../AnnotationExtractor.java} | 44 ++++++++------------ .../java/ch/qos/cai18n/verifier/Cai18nError.java | 30 ++++++++++---- .../java/ch/qos/cai18n/verifier/ErrorFactory.java | 12 +++-- .../qos/cai18n/verifier/MessageCodeVerifier.java | 33 ++++++++++++--- .../src/test/java/ch/qos/cai18n/sample/Colors.java | 7 ++- ...eBasedMC_Test.java => MessageConveyorTest.java} | 2 +- .../java/ch/qos/cai18n/sample/PackageTest.java | 2 +- .../qos/cai18n/util/AnnatationExtractorTest.java} | 32 ++++++++------ .../cai18n/{sample/Colors.java => util/Fruit.java} | 13 ++++-- .../Colors_en.properties => colors_en.properties} | 0 .../Colors_fr.properties => colors_fr.properties} | 0 .../src/main/java/ch/qos/cai18n/VerifyMojo.java | 4 +- 16 files changed, 144 insertions(+), 92 deletions(-) create mode 100644 cai18n-api/src/main/java/ch/qos/cai18n/Cai18nConstants.java copy cai18n-api/src/main/java/ch/qos/cai18n/{IMessageConveyor.java => LocaleNames.java} (79%) copy cai18n-api/src/main/java/ch/qos/cai18n/{IMessageConveyor.java => ResourceBundleName.java} (78%) copy cai18n-api/src/main/java/ch/qos/cai18n/{MessageConveyor.java => util/AnnotationExtractor.java} (60%) rename cai18n-api/src/test/java/ch/qos/cai18n/sample/{ResourceBunleBasedMC_Test.java => MessageConveyorTest.java} (94%) copy cai18n-api/src/{main/java/ch/qos/cai18n/verifier/ErrorFactory.java => test/java/ch/qos/cai18n/util/AnnatationExtractorTest.java} (65%) copy cai18n-api/src/test/java/ch/qos/cai18n/{sample/Colors.java => util/Fruit.java} (83%) rename cai18n-api/src/test/resources/{ch/qos/cai18n/sample/Colors_en.properties => colors_en.properties} (100%) rename cai18n-api/src/test/resources/{ch/qos/cai18n/sample/Colors_fr.properties => colors_fr.properties} (100%) hooks/post-receive -- Compiler assisted internalization library

1 0

[cai18n-dev] [GIT] Compiler assisted internalization library branch, master, updated. 2d5189416acbfd4acbdcfa98a74eb31ded7ae4e8
by git-noreply＠pixie.qos.ch 25 Aug '09

25 Aug '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 internalization library". The branch, master has been updated via 2d5189416acbfd4acbdcfa98a74eb31ded7ae4e8 (commit) from ef9dc9ce5085e3ec30f727c65337ba0b5ab3ae2b (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=cai18n.git;a=commit;h=2d5189416acbfd4acbdcfa98a… http://github.com/ceki/cai18n/commit/2d5189416acbfd4acbdcfa98a74eb31ded7ae4… commit 2d5189416acbfd4acbdcfa98a74eb31ded7ae4e8 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Wed Aug 26 00:20:09 2009 +0200 - typo fix diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/ResourceBunleBasedMC_Test.java b/cai18n-api/src/test/java/ch/qos/cai18n/sample/ResourceBunleBasedMC_Test.java index 829bc25..93a8289 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/ResourceBunleBasedMC_Test.java +++ b/cai18n-api/src/test/java/ch/qos/cai18n/sample/ResourceBunleBasedMC_Test.java @@ -57,7 +57,7 @@ public class ResourceBunleBasedMC_Test { { String val = rbbmc.getMessage(Colors.BLUE); - assertEquals("les violettes sont blues", val); + assertEquals("les violettes sont bleues", val); } ----------------------------------------------------------------------- Summary of changes: .../cai18n/sample/ResourceBunleBasedMC_Test.java | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) hooks/post-receive -- Compiler assisted internalization library

1 0

[cai18n-dev] [GIT] Compiler assisted internalization library branch, master, updated. ef9dc9ce5085e3ec30f727c65337ba0b5ab3ae2b
by git-noreply＠pixie.qos.ch 25 Aug '09

25 Aug '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 internalization library". The branch, master has been updated via ef9dc9ce5085e3ec30f727c65337ba0b5ab3ae2b (commit) from 0936b519106c49b17130fb6de8f0af9789ab1dd1 (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=cai18n.git;a=commit;h=ef9dc9ce5085e3ec30f727c65… http://github.com/ceki/cai18n/commit/ef9dc9ce5085e3ec30f727c65337ba0b5ab3ae… commit ef9dc9ce5085e3ec30f727c65337ba0b5ab3ae2b Author: Ceki Gulcu <ceki(a)qos.ch> Date: Wed Aug 26 00:16:45 2009 +0200 - IMessageConveyor is the interface, MessageConveyor is the default impl. diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleBasedMessageConveyor.java b/cai18n-api/src/main/java/ch/qos/cai18n/IMessageConveyor.java similarity index 61% rename from cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleBasedMessageConveyor.java rename to cai18n-api/src/main/java/ch/qos/cai18n/IMessageConveyor.java index 402f7a9..7a98e2e 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleBasedMessageConveyor.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/IMessageConveyor.java @@ -20,37 +20,13 @@ * SOFTWARE. */ - package ch.qos.cai18n; -import java.text.MessageFormat; -import java.util.Locale; -import java.util.ResourceBundle; - -public class ResourceBundleBasedMessageConveyor implements MessageConveyor { - - Locale locale; - - public ResourceBundleBasedMessageConveyor(Locale locale) { - this.locale = locale; - } - - - public <E extends Enum<?>> String getMessage(E e, Object... args) { - String code = e.toString(); - ResourceBundle rb = ResourceBundle - .getBundle(e.getClass().getName(), locale); - String value = rb.getString(code); - if (value == null) { - return "No key found for " + code; - } else { - if (args.length == 0) { - return value; - } else { - return MessageFormat.format(value, args); - } - } - } +// note that the getMessage method does not take a Locale. +// It is supposed that the MessageConveyor instance knows +// which locale to use. +public interface IMessageConveyor { + <E extends Enum<?>> String getMessage(E e, Object... args); } diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java b/cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java index e8722cc..1edc794 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/MessageConveyor.java @@ -20,13 +20,37 @@ * SOFTWARE. */ + package ch.qos.cai18n; +import java.text.MessageFormat; +import java.util.Locale; +import java.util.ResourceBundle; + +public class MessageConveyor implements IMessageConveyor { + + Locale locale; + + public MessageConveyor(Locale locale) { + this.locale = locale; + } + + + public <E extends Enum<?>> String getMessage(E e, Object... args) { + String code = e.toString(); + ResourceBundle rb = ResourceBundle + .getBundle(e.getClass().getName(), locale); -// note that the getMessage method does not take a Locale. -// It is supposed that the MessageConveyor instance knows -// which locale to use. + String value = rb.getString(code); + if (value == null) { + return "No key found for " + code; + } else { + if (args.length == 0) { + return value; + } else { + return MessageFormat.format(value, args); + } + } + } -public interface MessageConveyor { - <E extends Enum<?>> String getMessage(E e, Object... args); } diff --git a/cai18n-api/src/test/java/ch/qos/cai18n/sample/ResourceBunleBasedMC_Test.java b/cai18n-api/src/test/java/ch/qos/cai18n/sample/ResourceBunleBasedMC_Test.java index 743b299..829bc25 100644 --- a/cai18n-api/src/test/java/ch/qos/cai18n/sample/ResourceBunleBasedMC_Test.java +++ b/cai18n-api/src/test/java/ch/qos/cai18n/sample/ResourceBunleBasedMC_Test.java @@ -28,13 +28,13 @@ import java.util.Locale; import org.junit.Test; -import ch.qos.cai18n.ResourceBundleBasedMessageConveyor; +import ch.qos.cai18n.MessageConveyor; public class ResourceBunleBasedMC_Test { @Test public void smoke_EN() { - ResourceBundleBasedMessageConveyor rbbmc = new ResourceBundleBasedMessageConveyor( + MessageConveyor rbbmc = new MessageConveyor( Locale.UK); { @@ -52,7 +52,7 @@ public class ResourceBunleBasedMC_Test { @Test public void smoke_FR() { - ResourceBundleBasedMessageConveyor rbbmc = new ResourceBundleBasedMessageConveyor( + MessageConveyor rbbmc = new MessageConveyor( Locale.FRANCE); { diff --git a/cai18n-api/src/test/resources/ch/qos/cai18n/sample/Colors_fr.properties b/cai18n-api/src/test/resources/ch/qos/cai18n/sample/Colors_fr.properties index 968a87c..0ea9e8c 100644 --- a/cai18n-api/src/test/resources/ch/qos/cai18n/sample/Colors_fr.properties +++ b/cai18n-api/src/test/resources/ch/qos/cai18n/sample/Colors_fr.properties @@ -1,3 +1,3 @@ -BLUE=les violettes sont blues +BLUE=les violettes sont bleues RED=les roses sont rouges GREEN=les {0} sont verts \ No newline at end of file diff --git a/cai18n-site/src/site/pages/manual.html b/cai18n-site/src/site/pages/manual.html index 4218a29..7c6060c 100644 --- a/cai18n-site/src/site/pages/manual.html +++ b/cai18n-site/src/site/pages/manual.html @@ -24,21 +24,21 @@ <h1>CAI18N Manual</h1> - <p>The goal of CAI18N is to augment the internationalization - functionality offered by the Java platform with consistency and - verification operations. It is assumed that you are somewhat - familiar with <a + <p>The goal of CAI18N project is to enhance the existing + internationalization functionality offered by the Java platform + with consistency and verification primitives. It is assumed that + you are already somewhat familiar with <a href="http://java.sun.com/developer/technicalArticles/Intl/ResourceBundles/">using ResourceBundles</a>. </p> + <h3>Core idea</h3> <p>Instead of using values of type String as the key each message, - CAI18N uses <code>enums</code>. - </p> + CAI18N uses <code>enums</code>.</p> - <p>Assume you wish to internationalize color names, you could write - a color enum.</p> + <p>For the sake of argument, assume you wish to internationalize + color names, in CAI18N you could write a color enum.</p> <pre class="prettyprint source"> package com.foo.somePackage; @@ -67,7 +67,7 @@ GREEN={0} are green </pre> <em>Colors_fr.properties</em>. Here are possible contents.</p> <pre class="source"> -BLUE=les violettes sont blues +BLUE=les violettes sont bleues RED=les roses sont rouges GREEN=les {0} sont verts</pre> @@ -77,22 +77,34 @@ GREEN=les {0} sont verts</pre> <p>In your application, you would retreive the localized message as follows: </p> - <pre class="prettyprint source">//Obtain a resource bundle based message conveyor -ResourceBundleBasedMessageConveyor rbbmc = - new ResourceBundleBasedMessageConveyor(Locale.FRANCE); + <pre class="prettyprint source">// obtain a message convetor for France +MessageConveyor mc = new MessageConveyor(Locale.FRANCE); + // use it to retrieve internationalized messages -String red = rbbmc.getMessage(Colors.RED); -String blue = rbbmc.getMessage(Colors.BLUE); </pre> +String red = mc.getMessage(Colors.RED); +String blue = mc.getMessage(Colors.BLUE); </pre> <p>CAI18N leverages the existing resource bundle infrastructure you have been accustomed to, but adds compiler verification on top.</p> - <p>An astute reader will comment even if the messages codes are now + <p>An astute reader will comment that even if the messages codes are now verified by the compiler, it is still possible to have mismatching message codes in the resources bundles. For this reason, CAI18N comes with additional tooling support. </p> + + + <h2>Maven Plugin</h2> + + <p>Already implemented. Needs to be documented.</p> + + <h2>Ant task</h2> + + <p>We are looking for volunteers to implement an Ant task to verify + resource bundles. If interested please contact the cai18n-dev + mailing list.</p> + <script src="templates/footer.js" type="text/javascript"></script> </div> </body> ----------------------------------------------------------------------- Summary of changes: ...{MessageConveyor.java => IMessageConveyor.java} | 2 +- .../main/java/ch/qos/cai18n/MessageConveyor.java | 34 ++++++++++-- .../cai18n/ResourceBundleBasedMessageConveyor.java | 56 -------------------- .../cai18n/sample/ResourceBunleBasedMC_Test.java | 6 +- .../ch/qos/cai18n/sample/Colors_fr.properties | 2 +- cai18n-site/src/site/pages/manual.html | 42 +++++++++----- 6 files changed, 61 insertions(+), 81 deletions(-) copy cai18n-api/src/main/java/ch/qos/cai18n/{MessageConveyor.java => IMessageConveyor.java} (95%) delete mode 100644 cai18n-api/src/main/java/ch/qos/cai18n/ResourceBundleBasedMessageConveyor.java hooks/post-receive -- Compiler assisted internalization library

1 0

[cai18n-dev] [GIT] Compiler assisted internalization library branch, master, updated. 0936b519106c49b17130fb6de8f0af9789ab1dd1
by git-noreply＠pixie.qos.ch 25 Aug '09

25 Aug '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 internalization library". The branch, master has been updated via 0936b519106c49b17130fb6de8f0af9789ab1dd1 (commit) from ef586e44d3dba353723e09949e89e51ea13ce770 (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=cai18n.git;a=commit;h=0936b519106c49b17130fb6de… http://github.com/ceki/cai18n/commit/0936b519106c49b17130fb6de8f0af9789ab1d… commit 0936b519106c49b17130fb6de8f0af9789ab1dd1 Author: Ceki Gulcu <ceki(a)qos.ch> Date: Wed Aug 26 00:00:37 2009 +0200 added author tag (testing email notifications) diff --git a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java b/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java index 7583c36..a1c2aca 100644 --- a/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java +++ b/cai18n-api/src/main/java/ch/qos/cai18n/verifier/MessageCodeVerifier.java @@ -30,6 +30,11 @@ import java.util.Set; import ch.qos.cai18n.verifier.Cai18nError.ErrorType; +/** + * + * @author Ceki Gulcu + * + */ public class MessageCodeVerifier { final Class<? extends Enum<?>> enumClass; ----------------------------------------------------------------------- Summary of changes: .../qos/cai18n/verifier/MessageCodeVerifier.java | 5 +++++ 1 files changed, 5 insertions(+), 0 deletions(-) hooks/post-receive -- Compiler assisted internalization library

1 0

[Cai18n-dev] testing
by Ceki Gulcu 25 Aug '09

25 Aug '09

-- Ceki Gülcü Logback: The reliable, generic, fast and flexible logging framework for Java. http://logback.qos.ch

1 0