feat: add i18n support

Close #43

Author: Felipe Lang

pom.xml

@@ -193,6 +193,12 @@
                 <artifactId>jetty-maven-plugin</artifactId>
                 <version>${jetty.version}</version>
                 <configuration>
+                	<systemProperties>
+                		<systemProperty>
+                			<key>vaadin.i18n.provider</key>
+                			<value>com.flowingcode.vaadin.addons.errorwindow.TranslationProvider</value>
+                		</systemProperty>
+                	</systemProperties>
                     <scanIntervalSeconds>3</scanIntervalSeconds>
                     <!-- Use test scope because the UI/demo classes are in
                             the test package. -->

src/main/java/com/flowingcode/vaadin/addons/errorwindow/ErrorWindowI18n.java

@@ -21,6 +21,8 @@
 
 package com.flowingcode.vaadin.addons.errorwindow;
 
+import com.vaadin.flow.function.SerializableFunction;
+
 /**
  * Internationalization object for customizing the component UI texts. An instance with the default
  * messages can be obtained using {@link ErrorWindowI18n#createDefault()}
@@ -45,11 +47,26 @@ private ErrorWindowI18n() {
     this.clipboard = "Copy details to clipboard";
   }
 
+  private ErrorWindowI18n(SerializableFunction<String, String> i18nTranslator) {
+    this.caption = i18nTranslator.apply("com.flowingcode.vaadin.addons.errorwindow.caption");
+    this.instructions =
+        i18nTranslator.apply("com.flowingcode.vaadin.addons.errorwindow.instructions");
+    this.close = i18nTranslator.apply("com.flowingcode.vaadin.addons.errorwindow.close");
+    this.details = i18nTranslator.apply("com.flowingcode.vaadin.addons.errorwindow.details");
+    this.defaultErrorMessage =
+        i18nTranslator.apply("com.flowingcode.vaadin.addons.errorwindow.defaultErrorMessage");
+    this.clipboard = i18nTranslator.apply("com.flowingcode.vaadin.addons.errorwindow.clipboard");
+  }
+
   /** @return a new instance with the default messages */
   public static ErrorWindowI18n createDefault() {
     return new ErrorWindowI18n();
   }
 
+  public static ErrorWindowI18n create(SerializableFunction<String, String> i18nTranslator) {
+    return new ErrorWindowI18n(i18nTranslator);
+  }
+
   /** Sets the caption of the error window. */
   public void setCaption(final String caption) {
     this.caption = caption;

src/main/java/com/flowingcode/vaadin/addons/errorwindow/I18nErrorWindowFactory.java

@@ -0,0 +1,36 @@
+/*-
+ * #%L
+ * Error Window Add-on
+ * %%
+ * Copyright (C) 2017 - 2022 Flowing Code
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+
+package com.flowingcode.vaadin.addons.errorwindow;
+
+public class I18nErrorWindowFactory implements ErrorWindowFactory {
+
+  private final ErrorWindowI18n errorWindowI18n;
+  
+  I18nErrorWindowFactory(ErrorWindowI18n errorWindowI18n){
+    this.errorWindowI18n = errorWindowI18n;
+  }
+  
+  @Override
+  public void showError(ErrorDetails details) {
+    new ErrorWindow(details, errorWindowI18n).open();
+  }
+}

src/test/java/com/flowingcode/vaadin/addons/errorwindow/ErrorwindowDemo.java

@@ -38,6 +38,9 @@
 public class ErrorwindowDemo extends VerticalLayout {
 
   public ErrorwindowDemo() {
+    ErrorWindowI18n errorWindowI18n = ErrorWindowI18n.create(this::getTranslation);
+    ErrorManager.setErrorWindowFactory(new I18nErrorWindowFactory(errorWindowI18n));
+    
     Button errorButton =
         new Button(
             "Throw Error",
@@ -87,6 +90,17 @@ public ErrorwindowDemo() {
               }
             });
 
+    Button throwErrori18nSupport =
+        new Button(
+            "Throw Error with i18n support",
+            ev -> {
+              try {
+                Integer.parseInt("asdf");
+              } catch (NumberFormatException e) {
+                new ErrorWindow(e, "CUSTOM ERROR MESSAGE", errorWindowI18n).open();
+              }
+            });
+    
     Checkbox productionModeCb = new Checkbox("Production Mode");
     productionModeCb.addValueChangeListener(
         e -> {
@@ -106,7 +120,8 @@ public ErrorwindowDemo() {
         errorButton,
         throwErrorWithoutErrorHandler,
         throwErrorWithCustomMessageAndCustomTexts,
-        throwErrorWithCustomMessage);
+        throwErrorWithCustomMessage,
+        throwErrori18nSupport);
 
     add(new Button("Navigation error",
         ev -> UI.getCurrent().navigate(ThrowInConstructorView.class)));

src/test/java/com/flowingcode/vaadin/addons/errorwindow/TranslationProvider.java

@@ -0,0 +1,49 @@
+package com.flowingcode.vaadin.addons.errorwindow;
+
+import com.vaadin.flow.i18n.I18NProvider;
+import java.text.MessageFormat;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Locale;
+import java.util.MissingResourceException;
+import java.util.ResourceBundle;
+import org.slf4j.LoggerFactory;
+
+public class TranslationProvider implements I18NProvider {
+
+  public static final String BUNDLE_PREFIX = "messages";
+
+  public final Locale LOCALE_ES = new Locale("es");
+  public final Locale LOCALE_EN = new Locale("en");
+
+  private List<Locale> locales = Collections.unmodifiableList(Arrays.asList(LOCALE_ES, LOCALE_EN));
+
+  @Override
+  public List<Locale> getProvidedLocales() {
+    return locales;
+  }
+
+  @Override
+  public String getTranslation(String key, Locale locale, Object... params) {
+    if (key == null) {
+      LoggerFactory.getLogger(TranslationProvider.class.getName())
+          .warn("Got lang request for key with null value!");
+      return "";
+    }
+
+    final ResourceBundle bundle = ResourceBundle.getBundle(BUNDLE_PREFIX, locale);
+
+    String value;
+    try {
+      value = bundle.getString(key);
+    } catch (final MissingResourceException e) {
+      LoggerFactory.getLogger(TranslationProvider.class.getName()).warn("Missing resource", e);
+      return "!" + locale.getLanguage() + ": " + key;
+    }
+    if (params.length > 0) {
+      value = MessageFormat.format(value, params);
+    }
+    return value;
+  }
+}

src/test/resources/messages_en.properties

@@ -0,0 +1,6 @@
+com.flowingcode.vaadin.addons.errorwindow.caption=An error has occurred
+com.flowingcode.vaadin.addons.errorwindow.instructions=Please report the following code to your system administrator
+com.flowingcode.vaadin.addons.errorwindow.close=Close
+com.flowingcode.vaadin.addons.errorwindow.details=Show error details
+com.flowingcode.vaadin.addons.errorwindow.defaultErrorMessage=Please contact the system administrator for more information.
+com.flowingcode.vaadin.addons.errorwindow.clipboard=Copy details to clipboard

src/test/resources/messages_es.properties

@@ -0,0 +1,6 @@
+com.flowingcode.vaadin.addons.errorwindow.caption=Ha ocurrido un error
+com.flowingcode.vaadin.addons.errorwindow.instructions=Reporta el siguiente código al administrador del sistema
+com.flowingcode.vaadin.addons.errorwindow.close=Cerrar
+com.flowingcode.vaadin.addons.errorwindow.details=Ver detalles del error
+com.flowingcode.vaadin.addons.errorwindow.defaultErrorMessage=Para más información contacta al administrador del sistema.
+com.flowingcode.vaadin.addons.errorwindow.clipboard=Copiar detalles al portapapeles