Merge pull request #27 from avaje/feature/locale-initial

Initial Locale support

Author: rob-bygrave

validator/pom.xml

@@ -12,6 +12,12 @@
 
   <dependencies>
 
+    <dependency>
+      <groupId>io.avaje</groupId>
+      <artifactId>avaje-lang</artifactId>
+      <version>1.0</version>
+    </dependency>
+
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>avaje-inject</artifactId>

validator/src/main/java/io/avaje/validation/Validator.java

@@ -7,12 +7,27 @@
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Type;
 import java.util.Iterator;
+import java.util.Locale;
 import java.util.ServiceLoader;
 
 public interface Validator {
 
+  /**
+   * Validate the object using the default locale.
+   */
   void validate(Object any) throws ConstraintViolationException;
 
+  /**
+   * Validate the object with a given locale.
+   *
+   * <p>If the locale is not one of the supported locales then the
+   * default locale will be used.
+   *
+   * <p>This is expected to be used when the Validator is configured
+   * to support multiple locales.
+   */
+  void validate(Object any, Locale locale) throws ConstraintViolationException;
+
   static Builder builder() {
     final Iterator<Bootstrap> bootstrapService = ServiceLoader.load(Bootstrap.class).iterator();
     if (bootstrapService.hasNext()) {

validator/src/main/java/io/avaje/validation/adapter/ValidationContext.java

@@ -28,6 +28,18 @@ public interface ValidationContext {
      */
     String message(String key, Map<String, Object> attributes);
 
+  /**
+   * Return the message object held by a validation adapter
+   */
+  Message message2(String key, Map<String, Object> attributes);
+
+    interface Message {
+
+      String template();
+
+      Map<String, Object> attributes();
+    }
+
     /**
      * Factory for creating a ValidationAdapter for a given type.
      */

validator/src/main/java/io/avaje/validation/adapter/ValidationRequest.java

@@ -1,64 +1,15 @@
 package io.avaje.validation.adapter;
 
-import io.avaje.validation.ConstraintViolation;
-import io.avaje.validation.ConstraintViolationException;
-
-import java.util.ArrayDeque;
-import java.util.LinkedHashSet;
-import java.util.Set;
-import java.util.StringJoiner;
-
 public interface ValidationRequest {
 
-    static ValidationRequest create() {
-        return new DRequest();
-    }
-
-    void addViolation(String msg, String propertyName);
-
-    void pushPath(String path);
-
-    void popPath();
-
-    void throwWithViolations();
-
-    class DRequest implements ValidationRequest {
-
-        private final ArrayDeque<String> pathStack = new ArrayDeque<>();
-
-        private final Set<ConstraintViolation> violations = new LinkedHashSet<>();
-
-
-        private String currentPath() {
-            StringJoiner joiner = new StringJoiner(".");
-            final var descendingIterator = pathStack.descendingIterator();
-            while (descendingIterator.hasNext()) {
-                joiner.add(descendingIterator.next());
-            }
-            return joiner.toString();
-        }
+  void addViolation(String msg, String propertyName);
 
+  void addViolation(ValidationContext.Message msg, String propertyName);
 
-        @Override
-        public void addViolation(String msg, String propertyName) {
-            violations.add(new ConstraintViolation(currentPath(), propertyName, msg));
-        }
+  void pushPath(String path);
 
-        @Override
-        public void pushPath(String path) {
-            pathStack.push(path);
-        }
+  void popPath();
 
-        @Override
-        public void popPath() {
-            pathStack.pop();
-        }
+  void throwWithViolations();
 
-        @Override
-        public void throwWithViolations() {
-            if (!violations.isEmpty()) {
-                throw new ConstraintViolationException(violations);
-            }
-        }
-    }
 }

validator/src/main/java/io/avaje/validation/core/BasicAdapters.java

@@ -39,7 +39,7 @@ private BasicAdapters() {}
                 context.message("Future", attributes));
             case "Pattern" -> new PatternAdapter(
                 context.message("Pattern", attributes), attributes);
-            case "Size" -> new SizeAdapter(context.message("Size", attributes), attributes);
+            case "Size" -> new SizeAdapter(context.message2("{avaje.Size.message}", attributes), attributes);
             default -> null;
           };
 
@@ -71,11 +71,11 @@ public boolean validate(CharSequence value, ValidationRequest req, String proper
 
   private static final class SizeAdapter implements ValidationAdapter<Object> {
 
-    private final String message;
+    private final ValidationContext.Message message;
     private final int min;
     private final int max;
 
-    public SizeAdapter(String message, Map<String, Object> attributes) {
+    public SizeAdapter(ValidationContext.Message message, Map<String, Object> attributes) {
       this.message = message;
       this.min = (int) attributes.get("min");
       this.max = (int) attributes.get("max");

validator/src/main/java/io/avaje/validation/core/DLocaleResolver.java

@@ -0,0 +1,38 @@
+package io.avaje.validation.core;
+
+import io.avaje.lang.Nullable;
+
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Locale;
+import java.util.Set;
+
+final class DLocaleResolver implements LocaleResolver {
+
+  private final Locale defaultLocale;
+  private final Set<Locale> otherLocales = new HashSet<>();
+
+  public DLocaleResolver(Locale defaultLocale, Locale... others) {
+    this.defaultLocale = defaultLocale;
+    Collections.addAll(otherLocales, others);
+  }
+
+  @Override
+  public Locale defaultLocale() {
+    return defaultLocale;
+  }
+
+  @Override
+  public Set<Locale> otherLocales() {
+    return otherLocales;
+  }
+
+  @Override
+  public Locale resolve(@Nullable Locale requestLocale) {
+    if (requestLocale == null || !otherLocales.contains(requestLocale)) {
+      return defaultLocale;
+    } else {
+      return requestLocale;
+    }
+  }
+}

validator/src/main/java/io/avaje/validation/core/DMessage.java

@@ -0,0 +1,28 @@
+package io.avaje.validation.core;
+
+import io.avaje.validation.adapter.ValidationContext;
+
+import java.util.Map;
+
+final class DMessage implements ValidationContext.Message {
+
+  private final String template;
+  private final Map<String, Object> attributes;
+
+  // when true ... template includes ${validatedValue} the actual value, must be rendered at runtime
+  boolean includesConstraintValue;
+  DMessage(String template, Map<String, Object> attributes) {
+    this.template = template;
+    this.attributes = attributes;
+  }
+
+  @Override
+  public String template() {
+    return template;
+  }
+
+  @Override
+  public Map<String, Object> attributes() {
+    return attributes;
+  }
+}

validator/src/main/java/io/avaje/validation/core/DRequest.java

@@ -0,0 +1,63 @@
+package io.avaje.validation.core;
+
+import io.avaje.lang.Nullable;
+import io.avaje.validation.ConstraintViolation;
+import io.avaje.validation.ConstraintViolationException;
+import io.avaje.validation.adapter.ValidationContext;
+import io.avaje.validation.adapter.ValidationRequest;
+
+import java.util.*;
+
+final class DRequest implements ValidationRequest {
+
+  private final ArrayDeque<String> pathStack = new ArrayDeque<>();
+
+  private final Set<ConstraintViolation> violations = new LinkedHashSet<>();
+
+  private final DValidator validator;
+  @Nullable
+  private final Locale locale;
+
+  DRequest(DValidator validator, @Nullable Locale locale) {
+    this.validator = validator;
+    this.locale = locale;
+  }
+
+  private String currentPath() {
+    StringJoiner joiner = new StringJoiner(".");
+    final var descendingIterator = pathStack.descendingIterator();
+    while (descendingIterator.hasNext()) {
+      joiner.add(descendingIterator.next());
+    }
+    return joiner.toString();
+  }
+
+
+  @Override
+  public void addViolation(String msg, String propertyName) {
+    violations.add(new ConstraintViolation(currentPath(), propertyName, msg));
+  }
+
+  @Override
+  public void addViolation(ValidationContext.Message msg, String propertyName) {
+    String message = validator.interpolate(msg, locale);
+    violations.add(new ConstraintViolation(currentPath(), propertyName, message));
+  }
+
+  @Override
+  public void pushPath(String path) {
+    pathStack.push(path);
+  }
+
+  @Override
+  public void popPath() {
+    pathStack.pop();
+  }
+
+  @Override
+  public void throwWithViolations() {
+    if (!violations.isEmpty()) {
+      throw new ConstraintViolationException(violations);
+    }
+  }
+}

validator/src/main/java/io/avaje/validation/core/DResourceBundleManager.java

@@ -0,0 +1,29 @@
+package io.avaje.validation.core;
+
+import io.avaje.lang.Nullable;
+
+import java.util.*;
+
+final class DResourceBundleManager {
+
+
+  private final Map<Locale, ResourceBundle> map = new HashMap<>();
+
+  DResourceBundleManager(String name, LocaleResolver localeResolver) {
+    map.put(localeResolver.defaultLocale(), bundle(name, localeResolver.defaultLocale()));
+    for (Locale locale : localeResolver.otherLocales()) {
+      map.put(locale, bundle(name, locale));
+    }
+  }
+
+  private static ResourceBundle bundle(String name, Locale locale) {
+    return ResourceBundle.getBundle(name, locale);
+  }
+
+  @Nullable
+  public String message(String template, Locale resolvedLocale) {
+    ResourceBundle bundle = map.get(resolvedLocale);
+    boolean exists = bundle.containsKey(template);
+    return !exists ? null : bundle.getString(template);
+  }
+}

validator/src/main/java/io/avaje/validation/core/DTemplateLookup.java

@@ -0,0 +1,36 @@
+package io.avaje.validation.core;
+
+import java.util.Locale;
+
+final class DTemplateLookup {
+  private final DResourceBundleManager defaultBundle;
+
+  DTemplateLookup(DResourceBundleManager defaultBundle) {
+    this.defaultBundle = defaultBundle;
+  }
+
+  String lookup(String template, Locale resolvedLocale) {
+    if (!isBundleKey(template)) {
+      return template;
+    }
+    String key = template.substring(1, template.length() - 1);
+    // ??? update algorithm to recursively search bundles ??? Probably not ...
+    // todo: read user supplied override bundles first
+    // todo: read contributor bundles second
+    // read default bundle last
+    String msg = defaultBundle.message(key, resolvedLocale);
+    if (msg != null) {
+      return msg;
+    }
+    return template;
+  }
+
+  private boolean isBundleKey(String template) {
+    int pos = template.indexOf('{');
+    if (pos != 0) {
+      return false;
+    }
+    // is it a bundle lookup?
+    return template.charAt(template.length() - 1) == '}' && template.indexOf('{', 1) == -1;
+  }
+}

validator/src/main/java/io/avaje/validation/core/DValidationType.java

@@ -4,18 +4,21 @@
 import io.avaje.validation.adapter.ValidationRequest;
 
 import java.lang.reflect.Type;
+import java.util.Locale;
 
 final class DValidationType<T> implements ValidationType<T> {
 
+  private final DValidator validator;
   private final ValidationAdapter<T> adapter;
 
-  DValidationType(ValidationAdapter<T> adapter) {
+  DValidationType(DValidator validator, ValidationAdapter<T> adapter) {
+    this.validator = validator;
     this.adapter = adapter;
   }
 
   @Override
-  public void validate(T object) {
-    final var req = ValidationRequest.create();
+  public void validate(T object, Locale locale) {
+    final var req = validator.request(locale);
     adapter.validate(object, req);
     req.throwWithViolations();
   }