Merge pull request #59 from JCEmmons/issue42

Add logic to write comments from Java properties. Fixes #42.

Author: yumaoka

gp-res-filter/src/main/java/com/ibm/g11n/pipeline/resfilter/JavaPropertiesResource.java

@@ -1,5 +1,5 @@
 /*
- * Copyright IBM Corp. 2015, 2016
+ * Copyright IBM Corp. 2015, 2017
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@
 import java.text.BreakIterator;
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.Date;
 import java.util.Enumeration;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -41,7 +42,7 @@
 /**
  * Java properties resource filter implementation.
  *
- * @author Yoshito Umaoka
+ * @author Yoshito Umaoka, JCEmmons
  */
 public class JavaPropertiesResource implements ResourceFilter {
 
@@ -161,11 +162,19 @@ public void write(OutputStream outStream, String language, Bundle resource) thro
         TreeSet<ResourceString> sortedResources = new TreeSet<>(new ResourceStringComparator());
         sortedResources.addAll(resource.getResourceStrings());
 
-        LinkedProperties props = new LinkedProperties();
+        PrintWriter pw = new PrintWriter(new OutputStreamWriter(outStream, PROPS_ENC));
+        for (String note : resource.getNotes()) {
+            pw.println("#"+note);
+        }
+        if (!resource.getNotes().isEmpty()) {
+            pw.println();
+        }
+        pw.println("#"+new Date().toString());
         for (ResourceString res : sortedResources) {
-            props.setProperty(res.getKey(), res.getValue());
+            PropDef pd = new PropDef(res.getKey(),res.getValue(),PropDef.PropSeparator.EQUAL,res.getNotes());
+            pd.print(pw, language);
         }
-        props.store(outStream, null);
+        pw.close();
     }
 
     private static final String PROPS_ENC = "ISO-8859-1";
@@ -174,7 +183,8 @@ static class PropDef {
         private String key;
         private String value;
         private PropSeparator separator;
-
+        private List<String> notes;
+        
         public enum PropSeparator {
             EQUAL('='), COLON(':'), SPACE(' ');
 
@@ -192,10 +202,23 @@ public char getCharacter() {
         private static final String INDENT = "    ";
         private static final int COLMAX = 80;
 
+        public PropDef(String key, String value, PropSeparator separator, List<String> notes) {
+            this.key = key;
+            this.value = value;
+            this.separator = separator;
+            if (notes != null) {
+                this.notes = new ArrayList<>();
+                this.notes.addAll(notes);
+            } else {
+                this.notes = null;
+            }
+        };
+        
         public PropDef(String key, String value, PropSeparator separator) {
             this.key = key;
             this.value = value;
             this.separator = separator;
+            this.notes = null;
         };
 
         public static PropDef parseLine(String line) {
@@ -239,7 +262,7 @@ public static PropDef parseLine(String line) {
             String key = unescapePropKey(line.substring(0, sepIdx).trim());
             String value = unescapePropValue(stripLeadingSpaces(line.substring(sepIdx + 1)));
 
-            PropDef pl = new PropDef(key, value, sep);
+            PropDef pl = new PropDef(key, value, sep, null);
             return pl;
         }
 
@@ -255,11 +278,22 @@ public PropSeparator getSeparator() {
             return separator;
         }
 
+        public List<String> getNotes() {
+            return Collections.unmodifiableList(notes);
+        }
+        
         public void print(PrintWriter pw, String language) throws IOException {
             StringBuilder buf = new StringBuilder(100);
             int len = key.length() + value.length()
                     + 3; /* 3 - length of separator plus two SPs */
 
+            // Write out any notes (comments) associated with this resource.
+            if (notes != null) {
+                for (String note : notes) {
+                    pw.println("#" + note);
+                }
+            }
+            
             if (len <= COLMAX) {
                 // Print this property in a single line
                 if (separator.getCharacter() == PropSeparator.SPACE.getCharacter()) {
@@ -290,7 +324,9 @@ public void print(PrintWriter pw, String language) throws IOException {
                 buf.append(INDENT);
             }
 
-            BreakIterator brk = BreakIterator.getWordInstance(Locale.forLanguageTag(language));
+            
+            BreakIterator brk = BreakIterator.getWordInstance(
+                    language == null ? Locale.getDefault() : Locale.forLanguageTag(language));
             brk.setText(value);
 
             int start = 0;
@@ -355,6 +391,8 @@ public String toString() {
             builder.append(getValue());
             builder.append(" Sep=");
             builder.append("'" + getSeparator().getCharacter() + "'");
+            builder.append(" Notes=");
+            builder.append(getNotes().toString());
             return builder.toString();
         }
     }
@@ -611,7 +649,7 @@ public void merge(InputStream base, OutputStream outStream, String language, Bun
                     }
                     // Write the property key and value
                     String key = pd.getKey();
-                    PropDef modPd = new PropDef(key, resMap.get(key), pd.getSeparator());
+                    PropDef modPd = new PropDef(key, resMap.get(key), pd.getSeparator(), null);
                     modPd.print(outWriter, language);
                 } else {
                     if (orgLines.isEmpty()) {

gp-res-filter/src/test/java/com/ibm/g11n/pipeline/resfilter/JavaPropertiesResourceTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright IBM Corp. 2016
+ * Copyright IBM Corp. 2016, 2017
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@
 import com.ibm.g11n.pipeline.resfilter.ResourceString.ResourceStringComparator;
 
 /**
- * @author Farhan Arshad
+ * @author Farhan Arshad, JCEmmons
  *
  */
 public class JavaPropertiesResourceTest {
@@ -95,14 +95,28 @@ public class JavaPropertiesResourceTest {
         WRITE_BUNDLE = new Bundle();
         WRITE_BUNDLE.addResourceString("language", "Not-English", 2);
         WRITE_BUNDLE.addResourceString("key with spaces",
-                "Translated - This is the value that could be looked up with the key \"key with spaces\".", 4);
+                "Translated - This is the value that could be looked up with the key \"key with spaces\".", 4,
+                Arrays.asList(" Add spaces to the key"));
         WRITE_BUNDLE.addResourceString("website", "http://en.wikipedia.org/translated", 1);
-        WRITE_BUNDLE.addResourceString("message", "Translated - Welcome to Wikipedia!", 3);
-        WRITE_BUNDLE.addResourceString("tab", "Translated - pick up the\u00A5 tab", 5);
-        WRITE_BUNDLE.addResourceString("leadSPs", "leading SPs", 6);
-        WRITE_BUNDLE.addResourceString("leadTabs", "localized leading tabs", 7);
-        WRITE_BUNDLE.addResourceString("trailSPs", "localized trailing SPs  ", 8);
-        WRITE_BUNDLE.addResourceString("withTabs", "localized Tab1\tTab2\tTab3\t", 9);
+        WRITE_BUNDLE.addResourceString("message", "Translated - Welcome to Wikipedia!", 3,
+                Arrays.asList(" The backslash below tells the application to continue reading",
+                        " the value onto the next line."));
+        WRITE_BUNDLE.addResourceString("tab", "Translated - pick up the\u00A5 tab", 5,
+                Arrays.asList(" Unicode"));
+        WRITE_BUNDLE.addResourceString("leadSPs", "leading SPs", 6,
+                Arrays.asList(" leading SPs"));
+        WRITE_BUNDLE.addResourceString("leadTabs", "localized leading tabs", 7,
+                Arrays.asList(" leading tabs"));
+        WRITE_BUNDLE.addResourceString("trailSPs", "localized trailing SPs  ", 8,
+                Arrays.asList(" trailing SPs"));
+        WRITE_BUNDLE.addResourceString("withTabs", "localized Tab1\tTab2\tTab3\t", 9,
+                Arrays.asList(" tabs"));
+        WRITE_BUNDLE.addNotes(Arrays.asList(
+                " You are reading the \".properties\" entry.",
+                " The exclamation mark can also mark text as comments.",
+                " The key and element characters #, !, =, and : are written with",
+                " a preceding backslash to ensure that they are properly loaded."));
+
     }
 
     private static LinkedList<PropDef> EXPECTED_PROP_DEF_LIST;
@@ -145,7 +159,8 @@ public void testWrite() throws IOException {
             os.flush();
             // Properties.store() puts a comment with date and time
             // on the first line, ignore it by passing n=1 to compareFiles()
-            assertTrue(ResourceTestUtil.compareFiles(EXPECTED_WRITE_FILE, tempFile, 1));
+            assertTrue(ResourceTestUtil.compareFilesUpTo(EXPECTED_WRITE_FILE, tempFile, 5));
+            assertTrue(ResourceTestUtil.compareFiles(EXPECTED_WRITE_FILE, tempFile, 6));
         }
     }
 

gp-res-filter/src/test/java/com/ibm/g11n/pipeline/resfilter/ResourceTestUtil.java

@@ -1,5 +1,5 @@
 /*
- * Copyright IBM Corp. 2016
+ * Copyright IBM Corp. 2016, 2017
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@
 import java.nio.file.Paths;
 
 /**
- * @author farhan
+ * @author farhan, JCEmmons
  *
  */
 public class ResourceTestUtil {
@@ -76,6 +76,34 @@ public static boolean compareFiles(File expected, File actual, int n) throws Fil
 
         return true;
     }
+    /**
+     * Returns true if the two files match exactly up to the number of lines
+     * specified in n 
+     */
+    public static boolean compareFilesUpTo(File expected, File actual, int n) throws FileNotFoundException, IOException {
+        try (BufferedReader expectedRdr = new BufferedReader(new FileReader(expected));
+                BufferedReader actualRdr = new BufferedReader(new FileReader(actual))) {
+
+            String expectedLine;
+            String actualLine;
+            int lineNum = 0;
+            while ((expectedLine = expectedRdr.readLine()) != null && lineNum < n) {
+                actualLine = actualRdr.readLine();
+
+                lineNum++;
+
+                if (!expectedLine.equals(actualLine)) {
+                    fail("Comparing file <" + actual.getAbsolutePath() + "> with file <" + expected.getAbsolutePath()
+                            + "> ..." + "\nContent differs on line " + lineNum + "\nExpected content: \n"
+                            + fileToString(expected) + "\nActual content:\n" + fileToString(actual) + "\n");
+                    return false;
+                }
+            }
+
+        }
+
+        return true;
+    }
 
     /**
      * Returns true if the two files match exactly.

gp-res-filter/src/test/resource/resfilter/properties/write-output.properties

@@ -1,10 +1,24 @@
+# You are reading the ".properties" entry.
+# The exclamation mark can also mark text as comments.
+# The key and element characters #, !, =, and : are written with
+# a preceding backslash to ensure that they are properly loaded.
+
 #Fri Apr 22 11:07:23 EDT 2016
-website=http\://en.wikipedia.org/translated
-language=Not-English
-message=Translated - Welcome to Wikipedia\!
-key\ with\ spaces=Translated - This is the value that could be looked up with the key "key with spaces".
-tab=Translated - pick up the\u00A5 tab
-leadSPs=leading SPs
-leadTabs=localized leading tabs
-trailSPs=localized trailing SPs  
-withTabs=localized Tab1\tTab2\tTab3\t
+website = http\://en.wikipedia.org/translated
+language = Not-English
+# The backslash below tells the application to continue reading
+# the value onto the next line.
+message = Translated - Welcome to Wikipedia\!
+# Add spaces to the key
+key\ with\ spaces = Translated - This is the value that could be looked up \
+    with the key "key with spaces".
+# Unicode
+tab = Translated - pick up the\u00A5 tab
+# leading SPs
+leadSPs = leading SPs
+# leading tabs
+leadTabs = localized leading tabs
+# trailing SPs
+trailSPs = localized trailing SPs  
+# tabs
+withTabs = localized Tab1\tTab2\tTab3\t