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

r1938 - in trunk/nuiton-i18n/src: main/java/org/nuiton/i18n test/java/org/nuiton/i18n test/resources/META-INF
by athimel＠users.nuiton.org Aug. 3, 2011

Aug. 3, 2011

Author: athimel Date: 2011-08-03 09:27:28 +0200 (Wed, 03 Aug 2011) New Revision: 1938 Url: http://nuiton.org/repositories/revision/i18n/1938 Log: #1653 : Be able to check is some key is present Modified: trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18n.java trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18nLanguage.java trunk/nuiton-i18n/src/test/java/org/nuiton/i18n/I18nTest.java trunk/nuiton-i18n/src/test/resources/META-INF/I18nStoreTest_fr_FR.properties Modified: trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18n.java =================================================================== --- trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18n.java 2011-08-03 06:47:08 UTC (rev 1937) +++ trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18n.java 2011-08-03 07:27:28 UTC (rev 1938) @@ -191,6 +191,61 @@ } /** + * Look into the default {@link I18nLanguage} if the given {@code message} + * can be found. + * + * @param message the message to check presence + * @return true/false whether the message is present in the default language + * @see #getDefaultLocale() + * @see #hasKey(java.util.Locale, String) + * @since 2.4.1 + */ + public static boolean hasKey(String message) { + + boolean result = false; + + // if the key to find is null, just return false + if (message != null) { + + // checkInit() will be done by 'getDefaultLocale' or 'hasKey' method + + // get current locale (from the language in the store) + Locale locale = getDefaultLocale(); + result = hasKey(locale, message); + } + + return result; + } + + + /** + * Look into the {@link I18nLanguage} associated to the {@code locale} if + * the given {@code message} can be found. + * + * @param locale the locale to be used to get the I18nLanguage + * @param message the message to check presence + * @return true/false whether the message is present for the given locale + * @since 2.4.1 + */ + public static boolean hasKey(Locale locale, String message) { + + boolean result = false; + + // if the key to find is null, just return false + if (message != null) { + + checkInit(); + + // Get the language associated to this locale... + I18nLanguage language = getLanguage(locale); + // ... and check key presence + result = language.hasRecord(message); + } + + return result; + } + + /** * Retourne la chaine traduite si possible dans la locale demandée. * * @param locale la locale dans lequel on souhaite la traduction Modified: trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18nLanguage.java =================================================================== --- trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18nLanguage.java 2011-08-03 06:47:08 UTC (rev 1937) +++ trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18nLanguage.java 2011-08-03 07:27:28 UTC (rev 1938) @@ -180,6 +180,7 @@ } try { String result = resource.getProperty(sentence); + // Empty String is also considered as missing if (result == null || "".equals(result)) { recordNotFound(sentence); if (missingKeyReturnNull) { @@ -281,6 +282,17 @@ } } + public boolean hasRecord(String sentence) { + boolean result = false; + if (sentence != null) { + result = resource.containsKey(sentence); + // Empty String is considered as missing + String value = resource.getProperty(sentence); + result &= !"".equals(value); + } + return result; + } + @Override protected void finalize() throws Throwable { super.finalize(); Modified: trunk/nuiton-i18n/src/test/java/org/nuiton/i18n/I18nTest.java =================================================================== --- trunk/nuiton-i18n/src/test/java/org/nuiton/i18n/I18nTest.java 2011-08-03 06:47:08 UTC (rev 1937) +++ trunk/nuiton-i18n/src/test/java/org/nuiton/i18n/I18nTest.java 2011-08-03 07:27:28 UTC (rev 1938) @@ -226,6 +226,8 @@ @Test public void testMissingKeyReturnNull() { + DefaultI18nInitializer initializer = new DefaultI18nInitializer( + I18nStoreTest.class.getSimpleName()); initializer.setMissingKeyReturnNull(false); I18n.init(initializer, Locale.FRANCE); @@ -234,6 +236,8 @@ Assert.assertNotNull(text); Assert.assertEquals(key, text); + initializer = new DefaultI18nInitializer( + I18nStoreTest.class.getSimpleName()); initializer.setMissingKeyReturnNull(true); I18n.init(initializer, Locale.FRANCE); @@ -241,4 +245,23 @@ Assert.assertNull(text); } + @Test + public void testHasKey() { + + I18n.init(initializer, Locale.FRANCE); + + Assert.assertFalse(I18n.hasKey("key.fr.only.missing")); + Assert.assertFalse(I18n.hasKey("key.fr.only.empty")); + Assert.assertTrue(I18n.hasKey("key.fr.only.filled")); + + Assert.assertFalse(I18n.hasKey(Locale.FRANCE, "key.fr.only.missing")); + Assert.assertFalse(I18n.hasKey(Locale.FRANCE, "key.fr.only.empty")); + Assert.assertTrue(I18n.hasKey(Locale.FRANCE, "key.fr.only.filled")); + + Assert.assertFalse(I18n.hasKey(Locale.JAPAN, "key.fr.only.missing")); + Assert.assertFalse(I18n.hasKey(Locale.JAPAN, "key.fr.only.empty")); + Assert.assertFalse(I18n.hasKey(Locale.JAPAN, "key.fr.only.filled")); + + } + } Modified: trunk/nuiton-i18n/src/test/resources/META-INF/I18nStoreTest_fr_FR.properties =================================================================== --- trunk/nuiton-i18n/src/test/resources/META-INF/I18nStoreTest_fr_FR.properties 2011-08-03 06:47:08 UTC (rev 1937) +++ trunk/nuiton-i18n/src/test/resources/META-INF/I18nStoreTest_fr_FR.properties 2011-08-03 07:27:28 UTC (rev 1938) @@ -26,3 +26,5 @@ key.two=Seconde key.with.param=Clé avec %s key.with.date=Clé avec {0,date} +key.fr.only.empty= +key.fr.only.filled=Hello

1 0

r1937 - trunk
by athimel＠users.nuiton.org Aug. 3, 2011

Aug. 3, 2011

Author: athimel Date: 2011-08-03 08:47:08 +0200 (Wed, 03 Aug 2011) New Revision: 1937 Url: http://nuiton.org/repositories/revision/i18n/1937 Log: Ignore IDE files Modified: trunk/ Property changes on: trunk ___________________________________________________________________ Modified: svn:ignore - target *.iml *.ipr + target *.iml *.iws *.ipr .settings .classpath .project

1 0

r1936 - trunk/nuiton-i18n/src/test/java/org/nuiton/i18n
by athimel＠users.nuiton.org Aug. 3, 2011

Aug. 3, 2011

Author: athimel Date: 2011-08-03 08:46:52 +0200 (Wed, 03 Aug 2011) New Revision: 1936 Url: http://nuiton.org/repositories/revision/i18n/1936 Log: Refactor testMissingKeyReturnNull Modified: trunk/nuiton-i18n/src/test/java/org/nuiton/i18n/I18nTest.java Modified: trunk/nuiton-i18n/src/test/java/org/nuiton/i18n/I18nTest.java =================================================================== --- trunk/nuiton-i18n/src/test/java/org/nuiton/i18n/I18nTest.java 2011-08-02 16:20:29 UTC (rev 1935) +++ trunk/nuiton-i18n/src/test/java/org/nuiton/i18n/I18nTest.java 2011-08-03 06:46:52 UTC (rev 1936) @@ -224,26 +224,20 @@ } @Test - public void testMissingKeyReturnNotNull() { + public void testMissingKeyReturnNull() { - I18n.init(null, Locale.FRANCE); + initializer.setMissingKeyReturnNull(false); + I18n.init(initializer, Locale.FRANCE); String key = "youhou"; String text = I18n._(key); Assert.assertNotNull(text); Assert.assertEquals(key, text); - } - @Test - public void testMissingKeyReturnNull() { - - DefaultI18nInitializer initializer = new DefaultI18nInitializer( - I18nStoreTest.class.getSimpleName()); initializer.setMissingKeyReturnNull(true); I18n.init(initializer, Locale.FRANCE); - String key = "youhou"; - String text = I18n._(key); + text = I18n._(key); Assert.assertNull(text); }

1 0

r1935 - in trunk/nuiton-i18n/src: main/java/org/nuiton/i18n main/java/org/nuiton/i18n/init test/java/org/nuiton/i18n
by athimel＠users.nuiton.org Aug. 2, 2011

Aug. 2, 2011

Author: athimel Date: 2011-08-02 18:20:29 +0200 (Tue, 02 Aug 2011) New Revision: 1935 Url: http://nuiton.org/repositories/revision/i18n/1935 Log: Fix #1652 - Let I18n return null when i18n's key is not found Modified: trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18nLanguage.java trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18nStore.java trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/init/I18nInitializer.java trunk/nuiton-i18n/src/test/java/org/nuiton/i18n/I18nTest.java Modified: trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18nLanguage.java =================================================================== --- trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18nLanguage.java 2011-06-07 20:07:53 UTC (rev 1934) +++ trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18nLanguage.java 2011-08-02 16:20:29 UTC (rev 1935) @@ -29,6 +29,7 @@ import org.apache.commons.logging.LogFactory; import org.nuiton.i18n.bundle.I18nBundleEntry; +import java.awt.datatransfer.StringSelection; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; @@ -62,13 +63,29 @@ /** Indique le chemin du fichier dans lequel ecrire les entrees non trouvees */ protected String recordFilePath; + /** + * Used to know null should be returned when a key is not found. + * + * @since 2.4.1 + */ + protected boolean missingKeyReturnNull; + public I18nLanguage(Locale l) { this(l, null); } + public I18nLanguage(Locale l, boolean missingKeyReturnNull) { + this(l, null, missingKeyReturnNull); + } + public I18nLanguage(Locale locale, String recordFilePath) { + this(locale, recordFilePath, false); + } + + public I18nLanguage(Locale locale, String recordFilePath, boolean missingKeyReturnNull) { this.locale = locale; this.recordFilePath = recordFilePath; + this.missingKeyReturnNull = missingKeyReturnNull; } /** @@ -163,11 +180,15 @@ } try { String result = resource.getProperty(sentence); - if (null != result && !"".equals(result)) { - return result; + if (result == null || "".equals(result)) { + recordNotFound(sentence); + if (missingKeyReturnNull) { + result = null; + } else { + result = sentence; + } } - recordNotFound(sentence); - return sentence; + return result; } catch (MissingResourceException eee) { if (log.isWarnEnabled()) { log.warn("Resource " + sentence + " unavailable", eee); Modified: trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18nStore.java =================================================================== --- trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18nStore.java 2011-06-07 20:07:53 UTC (rev 1934) +++ trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/I18nStore.java 2011-08-02 16:20:29 UTC (rev 1935) @@ -304,7 +304,7 @@ } I18nLanguage result; - result = new I18nLanguage(locale); + result = new I18nLanguage(locale, resolver.isMissingKeyReturnNull()); I18nBundleEntry[] entries = getBundleEntries(locale); result.load(entries, resolver.getEncoding()); Modified: trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/init/I18nInitializer.java =================================================================== --- trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/init/I18nInitializer.java 2011-06-07 20:07:53 UTC (rev 1934) +++ trunk/nuiton-i18n/src/main/java/org/nuiton/i18n/init/I18nInitializer.java 2011-08-02 16:20:29 UTC (rev 1935) @@ -67,6 +67,14 @@ */ protected I18nMessageFormatter messageFormatter; + /** + * Used to know if the I18nLanguage has to return null when a key is not + * found. + * + * @since 2.4.1 + */ + protected boolean missingKeyReturnNull; + protected I18nInitializer() { // use the default encoding @@ -74,6 +82,9 @@ // use the default message formatter messageFormatter = I18nUtil.DEFAULT_MESSAGE_FORMATTER; + + // by default, missing key returns the key itself + missingKeyReturnNull = false; } /** @@ -150,4 +161,25 @@ } this.messageFormatter = messageFormatter; } + + /** + * Get the {@code missingKeyReturnNull} to use on missing key + * + * @return the missingKeyReturnNull parameter + * @since 2.4.1 + */ + public boolean isMissingKeyReturnNull() { + return missingKeyReturnNull; + } + + /** + * Get the {@code missingKeyReturnNull} to use on missing key + * + * @param missingKeyReturnNull missingKeyReturnNull to use + * @since 2.4.1 + */ + public void setMissingKeyReturnNull(boolean missingKeyReturnNull) { + this.missingKeyReturnNull = missingKeyReturnNull; + } + } Modified: trunk/nuiton-i18n/src/test/java/org/nuiton/i18n/I18nTest.java =================================================================== --- trunk/nuiton-i18n/src/test/java/org/nuiton/i18n/I18nTest.java 2011-06-07 20:07:53 UTC (rev 1934) +++ trunk/nuiton-i18n/src/test/java/org/nuiton/i18n/I18nTest.java 2011-08-02 16:20:29 UTC (rev 1935) @@ -222,4 +222,29 @@ actual = I18n.l_(Locale.FRANCE, "key.with.date", date); Assert.assertEquals(expected, actual); } + + @Test + public void testMissingKeyReturnNotNull() { + + I18n.init(null, Locale.FRANCE); + + String key = "youhou"; + String text = I18n._(key); + Assert.assertNotNull(text); + Assert.assertEquals(key, text); + } + + @Test + public void testMissingKeyReturnNull() { + + DefaultI18nInitializer initializer = new DefaultI18nInitializer( + I18nStoreTest.class.getSimpleName()); + initializer.setMissingKeyReturnNull(true); + I18n.init(initializer, Locale.FRANCE); + + String key = "youhou"; + String text = I18n._(key); + Assert.assertNull(text); + } + }

1 0