Support arbitrary charsets

Author: jknack

handlebars-guava-cache/src/main/java/com/github/jknack/handlebars/io/GuavaCachedTemplateLoader.java

@@ -18,6 +18,7 @@
 package com.github.jknack.handlebars.io;
 
 import java.io.IOException;
+import java.nio.charset.Charset;
 import java.util.concurrent.Callable;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
@@ -125,4 +126,11 @@ public void setSuffix(final String suffix) {
     delegate.setSuffix(suffix);
   }
 
+  @Override public void setCharset(Charset charset) {
+   delegate.setCharset(charset);
+  }
+
+  @Override public Charset getCharset() {
+    return delegate.getCharset();
+  }
 }

handlebars-springmvc/src/main/java/com/github/jknack/handlebars/springmvc/HandlebarsViewResolver.java

@@ -25,6 +25,8 @@
 import java.io.InputStream;
 import java.io.Reader;
 import java.net.URI;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Enumeration;
 import java.util.List;
@@ -122,6 +124,9 @@ public class HandlebarsViewResolver extends AbstractTemplateViewResolver
   /** Template cache. */
   private TemplateCache templateCache = new HighConcurrencyTemplateCache();
 
+  /** Charset. */
+  private Charset charset = StandardCharsets.UTF_8;
+
   /**
    * Creates a new {@link HandlebarsViewResolver}.
    *
@@ -256,6 +261,8 @@ public void afterPropertiesSet() {
 
     // set delete partial after merge
     handlebars.setDeletePartialAfterMerge(deletePartialAfterMerge);
+
+    handlebars.setCharset(charset);
   }
 
   /**
@@ -598,4 +605,9 @@ public HandlebarsViewResolver registerDecorator(final String name, final Decorat
     registry.registerDecorator(name, decorator);
     return this;
   }
+
+  @Override public HandlebarsViewResolver setCharset(final Charset charset) {
+    this.charset = notNull(charset, "Charset required.");
+    return this;
+  }
 }

handlebars/src/main/java/com/github/jknack/handlebars/Handlebars.java

@@ -29,6 +29,8 @@
 import java.lang.reflect.Array;
 import java.net.URI;
 import java.net.URL;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
@@ -342,6 +344,9 @@ public static CharSequence escapeExpression(final CharSequence input) {
    */
   private boolean preEvaluatePartialBlocks = true;
 
+  /** Standard charset. */
+  private Charset charset = StandardCharsets.UTF_8;
+
   /**
    * Creates a new {@link Handlebars} with no cache.
    *
@@ -795,7 +800,6 @@ public boolean stringParams() {
     return stringParams;
   }
 
-
   /**
    * If true, unnecessary spaces and new lines will be removed from output. Default is: false.
    *
@@ -1208,7 +1212,9 @@ public Handlebars parentScopeResolution(final boolean parentScopeResolution) {
    *         If false, you will have to evaluate and render partial blocks explitly (this
    *         option is *much* faster).
    */
-  public boolean preEvaluatePartialBlocks() { return preEvaluatePartialBlocks; }
+  public boolean preEvaluatePartialBlocks() {
+    return preEvaluatePartialBlocks;
+  }
 
   /**
    * If true, partial blocks will implicitly be evaluated before the partials will actually
@@ -1358,4 +1364,18 @@ public Handlebars registerDecorator(final String name, final Decorator decorator
     return this;
   }
 
+  @Override
+  public Handlebars setCharset(final Charset charset) {
+    this.charset = notNull(charset, "Charset required.");
+    registry.setCharset(charset);
+    loader.setCharset(charset);
+    return this;
+  }
+
+  /**
+   * @return Charset.
+   */
+  public Charset getCharset() {
+    return charset;
+  }
 }

handlebars/src/main/java/com/github/jknack/handlebars/HelperRegistry.java

@@ -35,6 +35,7 @@
 import java.io.InputStream;
 import java.io.Reader;
 import java.net.URI;
+import java.nio.charset.Charset;
 import java.util.Map.Entry;
 import java.util.Set;
 
@@ -323,4 +324,13 @@ HelperRegistry registerHelpers(String filename, InputStream source)
    */
   HelperRegistry registerDecorator(String name, Decorator decorator);
 
+  /**
+   * Set the charset to use.
+   *
+   * @param charset Charset.
+   * @return This registry.
+   * @since 4.0.6
+   */
+  HelperRegistry setCharset(Charset charset);
+
 }

handlebars/src/main/java/com/github/jknack/handlebars/helper/DefaultHelperRegistry.java

@@ -15,20 +15,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/**
- * This copy of Woodstox XML processor is licensed under the
- * Apache (Software) License, version 2.0 ("the License").
- * See the License for details about distribution rights, and the
- * specific rights regarding derivate works.
- *
- * You may obtain a copy of the License at:
- *
- * http://www.apache.org/licenses/
- *
- * A copy is also included in the downloadable source code package
- * containing Woodstox, in file "ASL2.0", under the same directory
- * as this file.
- */
 package com.github.jknack.handlebars.helper;
 
 import static org.apache.commons.lang3.Validate.isTrue;
@@ -41,6 +27,8 @@
 import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
 import java.net.URI;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
@@ -81,6 +69,9 @@ public class DefaultHelperRegistry implements HelperRegistry {
    */
   private HandlebarsJs handlebarsJs;
 
+  /** Charset. */
+  private Charset charset = StandardCharsets.UTF_8;
+
   {
     Integer optimizationLevel = Integer.valueOf(Integer.parseInt(
                 System.getProperty("handlebars.rhino.optmizationLevel", "-1")));
@@ -156,12 +147,12 @@ public HelperRegistry registerHelpers(final Class<?> helperSource) {
 
   @Override
   public HelperRegistry registerHelpers(final URI location) throws Exception {
-    return registerHelpers(location.getPath(), Files.read(location.toString()));
+    return registerHelpers(location.getPath(), Files.read(location.toString(), charset));
   }
 
   @Override
   public HelperRegistry registerHelpers(final File input) throws Exception {
-    return registerHelpers(input.getAbsolutePath(), Files.read(input));
+    return registerHelpers(input.getAbsolutePath(), Files.read(input, charset));
   }
 
   @Override
@@ -173,7 +164,7 @@ public HelperRegistry registerHelpers(final String filename, final Reader source
   @Override
   public HelperRegistry registerHelpers(final String filename, final InputStream source)
       throws Exception {
-    return registerHelpers(filename, Files.read(source));
+    return registerHelpers(filename, Files.read(source, charset));
   }
 
   @Override
@@ -271,4 +262,8 @@ public DefaultHelperRegistry with(final HandlebarsJs handlebarsJs) {
     return this;
   }
 
+  @Override public DefaultHelperRegistry setCharset(Charset charset) {
+    this.charset = notNull(charset, "Charset required.");
+    return this;
+  }
 }

handlebars/src/main/java/com/github/jknack/handlebars/internal/Files.java

@@ -46,33 +46,36 @@ private Files() {
    * Read a file from a classpath location.
    *
    * @param location The classpath location.
+   * @param charset Charset.
    * @return The file content.
    * @throws IOException If the file can't be read.
    */
-  public static String read(final String location) throws IOException {
-    return read(Files.class.getResourceAsStream(location));
+  public static String read(final String location,  final Charset charset) throws IOException {
+    return read(Files.class.getResourceAsStream(location),  charset);
   }
 
   /**
    * Read a file content.
    *
    * @param source The file.
+   * @param charset Charset.
    * @return The file content.
    * @throws IOException If the file can't be read.
    */
-  public static String read(final File source) throws IOException {
-    return read(new FileInputStream(source));
+  public static String read(final File source,  final Charset charset) throws IOException {
+    return read(new FileInputStream(source), charset);
   }
 
   /**
    * Read a file source.
    *
    * @param source The file source.
+   * @param charset Charset.
    * @return The file content.
    * @throws IOException If the file can't be read.
    */
-  public static String read(final InputStream source) throws IOException {
-    return read(new InputStreamReader(source, Charset.forName("UTF-8")));
+  public static String read(final InputStream source, final Charset charset) throws IOException {
+    return read(new InputStreamReader(source, charset));
   }
 
   /**

handlebars/src/main/java/com/github/jknack/handlebars/internal/HbsParserFactory.java

@@ -71,7 +71,7 @@ public Template parse(final TemplateSource source) throws IOException {
         final ANTLRErrorListener errorReporter = new HbsErrorReporter(source.filename());
 
         // 1. Lexer
-        final HbsLexer lexer = newLexer(newStream(source.filename(), source.content()),
+        final HbsLexer lexer = newLexer(newStream(source.filename(), source.content(handlebars.getCharset())),
             startDelimiter, endDelimiter);
         configure(lexer, errorReporter);
 

handlebars/src/main/java/com/github/jknack/handlebars/internal/JSEngine.java

@@ -15,23 +15,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/**
- * This copy of Woodstox XML processor is licensed under the
- * Apache (Software) License, version 2.0 ("the License").
- * See the License for details about distribution rights, and the
- * specific rights regarding derivate works.
- *
- * You may obtain a copy of the License at:
- *
- * http://www.apache.org/licenses/
- *
- * A copy is also included in the downloadable source code package
- * containing Woodstox, in file "ASL2.0", under the same directory
- * as this file.
- */
 package com.github.jknack.handlebars.internal;
 
 import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 
 import org.mozilla.javascript.Context;
 import org.mozilla.javascript.Scriptable;
@@ -124,7 +111,7 @@ private Scriptable sharedScope(final String hbslocation, final Context ctx) {
      */
     private String handlebarsScript(final String location) {
       try {
-        return Files.read(location);
+        return Files.read(location, StandardCharsets.UTF_8);
       } catch (IOException ex) {
         throw new IllegalArgumentException("Unable to read file: " + location, ex);
       }

handlebars/src/main/java/com/github/jknack/handlebars/internal/Partial.java

@@ -23,6 +23,8 @@
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.Writer;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
@@ -238,8 +240,8 @@ public String filename() {
       }
 
       @Override
-      public String content() throws IOException {
-        return partialInput(source.content(), indent);
+      public String content(Charset charset) throws IOException {
+        return partialInput(source.content(charset), indent);
       }
 
       @Override

handlebars/src/main/java/com/github/jknack/handlebars/internal/js/RhinoHandlebars.java

@@ -18,6 +18,7 @@
 package com.github.jknack.handlebars.internal.js;
 
 import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
@@ -367,7 +368,7 @@ private Scriptable helpersEnvScope(final org.mozilla.javascript.Context ctx) {
    */
   private static String envSource(final String location) {
     try {
-      return Files.read(location);
+      return Files.read(location, StandardCharsets.UTF_8);
     } catch (IOException ex) {
       throw new IllegalStateException("Unable to read " + location, ex);
     }