Add resource bundle adapter.

gk-brown · gk-brown · commit 626f17d4d1ba · 2020-11-19T17:45:16.000-05:00
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 [![Maven Central](https://img.shields.io/maven-central/v/org.httprpc/httprpc-server.svg)](https://repo1.maven.org/maven2/org/httprpc/httprpc-server/)
 
 # Introduction
-HTTP-RPC is an open-source framework for creating and consuming RESTful and REST-like web services in Java. It is extremely lightweight and requires only a Java runtime environment and a servlet container. The entire framework is less than 90KB in size, making it an ideal choice for applications where a minimal footprint is desired.
+HTTP-RPC is an open-source framework for creating and consuming RESTful and REST-like web services in Java. It is extremely lightweight and requires only a Java runtime environment and a servlet container. The entire framework is less than 100KB in size, making it an ideal choice for applications where a minimal footprint is desired.
 
 This guide introduces the HTTP-RPC framework and provides an overview of its key features.
 
@@ -33,6 +33,7 @@ Classes provided by the HTTP-RPC framework include:
 * [BeanAdapter](#beanadapter) - map adapter for Java beans
 * [ResultSetAdapter and Parameters](#resultsetadapter-and-parameters) - iterable adapter for JDBC result sets/applies named parameter values to prepared statements
 * [ElementAdapter](#elementadapter) - map adapter for XML elements
+* [ResourceBundleAdapter](#resourcebundleadapter) - map adapter for resource bundles
 * [StreamAdapter](#streamadapter) - iterable adapter for streams
 * [Collections](#collections) - utility methods for working with collections
 
@@ -852,6 +853,40 @@ System.out.println(credit.get("amount").toString());
 System.out.println(credit.get("date").toString());
 ```
 
+## ResourceBundleAdapter
+The `ResourceBundleAdapter` class provides access to the contents of a resource bundle via the `Map` interface. It can be used to localize the contents of a template document, for example:
+
+```html
+<table>
+    <!-- {{?headings}} -->
+    <tr>
+        <td>{{name}}</td>
+        <td>{{description}}</td>
+        <td>{{quantity}}</td>
+    </tr>
+    <!-- {{/headings}} -->
+
+    <!-- {{#items}} -->
+    <tr>
+        <td>{{name}}</td>
+        <td>{{description}}</td>
+        <td>{{quantity}}</td>
+    </tr>
+    <!-- {{/items}} -->
+</table>
+```
+
+```java
+TemplateEncoder templateEncoder = new TemplateEncoder(getClass().getResource("list.html"));
+
+ResourceBundle resourceBundle = ResourceBundle.getBundle(getClass().getPackage().getName() + ".headings");
+
+templateEncoder.write(mapOf(
+    entry("headings", new ResourceBundleAdapter(resourceBundle)),
+    entry("items", items)
+), System.out);
+```
+
 ## StreamAdapter
 The `StreamAdapter` class provides access to the contents of a stream via the `Iterable` interface. For example, it can be used to serialize the result of a stream operation without needing to first collect the results, which could be expensive if the stream is large:
 
diff --git a/httprpc-client/src/main/java/org/httprpc/util/ResourceBundleAdapter.java b/httprpc-client/src/main/java/org/httprpc/util/ResourceBundleAdapter.java
@@ -0,0 +1,54 @@
+/*
+ * 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.
+ */
+
+package org.httprpc.util;
+
+import java.util.AbstractMap;
+import java.util.Map;
+import java.util.MissingResourceException;
+import java.util.ResourceBundle;
+import java.util.Set;
+
+/**
+ * {@link Map} adapter for resource bundles.
+ */
+public class ResourceBundleAdapter extends AbstractMap<String, String> {
+    private ResourceBundle resourceBundle;
+
+    public ResourceBundleAdapter(ResourceBundle resourceBundle) {
+        if (resourceBundle == null) {
+            throw new IllegalArgumentException();
+        }
+
+        this.resourceBundle = resourceBundle;
+    }
+
+    @Override
+    public String get(Object key) {
+        if (key == null) {
+            throw new IllegalArgumentException();
+        }
+
+        try {
+            return resourceBundle.getString(key.toString());
+        } catch (MissingResourceException exception) {
+            return null;
+        }
+    }
+
+    @Override
+    public Set<Entry<String, String>> entrySet() {
+        throw new UnsupportedOperationException();
+    }
+}
diff --git a/httprpc-client/src/main/java/org/httprpc/xml/ElementAdapter.java b/httprpc-client/src/main/java/org/httprpc/xml/ElementAdapter.java
@@ -65,6 +65,10 @@ public ElementAdapter(Element element) {
 
     @Override
     public Object get(Object key) {
+        if (key == null) {
+            throw new IllegalArgumentException();
+        }
+
         String name = key.toString();
 
         Object value;
diff --git a/httprpc-client/src/test/java/org/httprpc/util/ResourceBundleAdapterTest.java b/httprpc-client/src/test/java/org/httprpc/util/ResourceBundleAdapterTest.java
@@ -0,0 +1,37 @@
+/*
+ * 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.
+ */
+
+package org.httprpc.util;
+
+import org.junit.jupiter.api.Test;
+
+import java.util.ResourceBundle;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+public class ResourceBundleAdapterTest {
+    @Test
+    public void testResourceBundleAdapter() {
+        ResourceBundle resourceBundle = ResourceBundle.getBundle(getClass().getPackage().getName() + ".test");
+
+        ResourceBundleAdapter resourceBundleAdapter = new ResourceBundleAdapter(resourceBundle);
+
+        assertEquals(resourceBundle.getString("a"), resourceBundleAdapter.get("a"));
+        assertEquals(resourceBundle.getString("b"), resourceBundleAdapter.get("b"));
+        assertEquals(resourceBundle.getString("c"), resourceBundleAdapter.get("c"));
+
+        assertNull(resourceBundleAdapter.get("d"));
+    }
+}
diff --git a/httprpc-client/src/test/resources/org/httprpc/util/test.properties b/httprpc-client/src/test/resources/org/httprpc/util/test.properties
@@ -0,0 +1,3 @@
+a = A
+b = B
+c = C
diff --git a/httprpc-test/src/main/java/org/httprpc/test/PetService.java b/httprpc-test/src/main/java/org/httprpc/test/PetService.java
@@ -23,6 +23,7 @@
 import org.httprpc.io.TemplateEncoder;
 import org.httprpc.sql.Parameters;
 import org.httprpc.sql.ResultSetAdapter;
+import org.httprpc.util.ResourceBundleAdapter;
 
 import javax.naming.Context;
 import javax.naming.InitialContext;
@@ -36,6 +37,7 @@
 import java.sql.SQLException;
 import java.sql.Statement;
 import java.util.Date;
+import java.util.ResourceBundle;
 import java.util.stream.Stream;
 
 import static org.httprpc.util.Collections.entry;
@@ -95,7 +97,12 @@ public void getPets(String owner, String format) throws SQLException, IOExceptio
 
                     TemplateEncoder templateEncoder = new TemplateEncoder(getClass().getResource("pets.html"));
 
-                    templateEncoder.write(resultSetAdapter, getResponse().getOutputStream());
+                    ResourceBundle resourceBundle = ResourceBundle.getBundle(getClass().getPackage().getName() + ".pets", getRequest().getLocale());
+
+                    templateEncoder.write(mapOf(
+                        entry("headings", new ResourceBundleAdapter(resourceBundle)),
+                        entry("data", resultSetAdapter)
+                    ), getResponse().getOutputStream());
                 } else {
                     throw new IllegalArgumentException();
                 }
diff --git a/httprpc-test/src/main/resources/org/httprpc/test/pets.html b/httprpc-test/src/main/resources/org/httprpc/test/pets.html
@@ -5,21 +5,23 @@
 <body>
 
 <table>
+    <!-- {{?headings}} -->
     <tr>
-        <td>Name</td>
-        <td>Species</td>
-        <td>Sex</td>
-        <td>Birth</td>
+        <td>{{name}}</td>
+        <td>{{species}}</td>
+        <td>{{sex}}</td>
+        <td>{{birth}}</td>
     </tr>
+    <!-- {{/headings}} -->
 
-    <!-- {{#.}} -->
+    <!-- {{#data}} -->
     <tr>
         <td>{{name}}</td>
         <td>{{species}}</td>
         <td>{{sex}}</td>
         <td>{{birth}}</td>
     </tr>
-    <!-- {{/.}} -->
+    <!-- {{/data}} -->
 </table>
 
 </body>
diff --git a/httprpc-test/src/main/resources/org/httprpc/test/pets.properties b/httprpc-test/src/main/resources/org/httprpc/test/pets.properties
@@ -0,0 +1,4 @@
+name = Name
+species = Species
+sex = Sex
+birth = Birth
