Merge pull request #57 from JCEmmons/issue41

Implement support for handling of comments in iOS strings. Fixes #41.

Author: yumaoka

.settings/org.eclipse.core.resources.prefs

@@ -1,3 +1,4 @@
 eclipse.preferences.version=1
+encoding//gp-res-filter/src/test/resource/resfilter/ios/write-output.strings=UTF-8
 encoding//src/main/java=UTF-8
 encoding//src/main/resources=UTF-8

gp-res-filter/.settings/org.eclipse.core.resources.prefs

@@ -1,3 +1,4 @@
 eclipse.preferences.version=1
 encoding//src/main/java=UTF-8
 encoding//src/test/java=UTF-8
+encoding//src/test/resource/resfilter/ios/write-output.strings=UTF-8

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

@@ -50,6 +50,10 @@ public void addResourceString(String key, String value, int sequenceNumber) {
         addResourceString(new ResourceString(key, value, sequenceNumber));
     }
 
+    public void addResourceString(String key, String value, int sequenceNumber, List<String> notes) {
+        addResourceString(new ResourceString(key, value, sequenceNumber, notes));
+    }
+
     public void addNote(String note) {
         if (notes == null) {
             notes = new ArrayList<>();

gp-res-filter/src/main/java/com/ibm/g11n/pipeline/resfilter/IOSStringsResource.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.
@@ -23,7 +23,9 @@
 import java.io.OutputStream;
 import java.io.OutputStreamWriter;
 import java.text.BreakIterator;
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.Iterator;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Locale;
@@ -40,21 +42,42 @@
 public class IOSStringsResource implements ResourceFilter {
 
     private static final String CHAR_SET = "UTF-8";
-
+    private static final String COMMENT_BEGIN = "/*";
+    private static final String COMMENT_END = "*/";
+    
     @Override
     public Bundle parse(InputStream in) throws IOException {
         Bundle bundle = new Bundle();
         BufferedReader reader = new BufferedReader(new InputStreamReader(in, CHAR_SET));
 
         int sqNum = 0;
         String line;
+        List<String> notes = new ArrayList<>();
+        Boolean commentIsGlobal = true;
         while ((line = reader.readLine()) != null) {
-            if (line.matches("^\\s*/\\*.*")) {// begins with /*
+            if (line.trim().startsWith(COMMENT_BEGIN)) {// begins with /*
                 // skip comments until line ends with */
                 // the short circuit expression evaluation handles both
                 // single and multi lined comments
-                while (!line.matches(".*\\*/$") && (line = reader.readLine()) != null)
-                    ;
+                String comment = line.substring(line.indexOf(COMMENT_BEGIN)+2);
+                Boolean commentEndProcessed = false;
+                while (!commentEndProcessed && line != null) {
+                    if (comment.trim().endsWith(COMMENT_END)) {
+                        comment = comment.substring(0, comment.lastIndexOf(COMMENT_END));
+                        commentEndProcessed = true;
+                    }
+                    notes.add(comment);
+                    if (!commentEndProcessed) {
+                        line = reader.readLine();
+                        comment = line;
+                    }
+                }
+            } else if (commentIsGlobal && line.isEmpty()) {
+                commentIsGlobal = false;
+                if (!notes.isEmpty()) {
+                    bundle.addNotes(notes);
+                    notes.clear();
+                }
             } else if (line.matches("^\\s*\".*")) { // begins with quote char
                 // new entry
                 StringBuilder entry = new StringBuilder(128);
@@ -69,7 +92,12 @@ public Bundle parse(InputStream in) throws IOException {
                 String key = parts[0].substring(parts[0].indexOf('"') + 1).trim();
                 String value = parts[1].substring(0, parts[1].lastIndexOf('"')).trim();
 
-                bundle.addResourceString(key, value, ++sqNum);
+                if (notes.isEmpty()) {
+                    bundle.addResourceString(key, value, ++sqNum);
+                } else {
+                    bundle.addResourceString(key, value, ++sqNum, notes);
+                    notes.clear();
+                }
             }
         }
 
@@ -83,9 +111,19 @@ public void write(OutputStream os, String language, Bundle bundle) throws IOExce
 
         BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(os, CHAR_SET));
 
+        boolean globalNotesWritten = false;
+        for (String globalNote : bundle.getNotes()) {
+            writer.write(COMMENT_BEGIN+globalNote+COMMENT_END);
+            writer.newLine();
+            globalNotesWritten = true;
+        }
+        if (globalNotesWritten) {
+            writer.newLine();
+        }
+
         for (ResourceString res : sortedResources) {
             // empties the buffer
-            writer.write(formatEntry(res.getKey(), res.getValue(), language));
+            writer.write(formatEntry(res.getKey(), res.getValue(), language, res.getNotes()));
         }
 
         writer.flush();
@@ -95,9 +133,9 @@ public void write(OutputStream os, String language, Bundle bundle) throws IOExce
     public void merge(InputStream base, OutputStream os, String language, Bundle bundle)
             throws IOException {
         // put res data into a map for easier searching
-        Map<String, String> resMap = new HashMap<String, String>(bundle.getResourceStrings().size() * 4 / 3 + 1);
+        Map<String, ResourceString> resMap = new HashMap<String, ResourceString>(bundle.getResourceStrings().size() * 4 / 3 + 1);
         for (ResourceString res : bundle.getResourceStrings()) {
-            resMap.put(res.getKey(), res.getValue());
+            resMap.put(res.getKey(), res);
         }
 
         BufferedReader reader = new BufferedReader(new InputStreamReader(base, CHAR_SET));
@@ -130,7 +168,7 @@ public void merge(InputStream base, OutputStream os, String language, Bundle bun
                     continue;
                 }
 
-                writer.write(formatEntry(key, resMap.get(key), language));
+                writer.write(formatEntry(key, resMap.get(key).getValue(), language, resMap.get(key).getNotes()));
             } else {
                 writer.write(line);
                 writer.newLine();
@@ -140,11 +178,23 @@ public void merge(InputStream base, OutputStream os, String language, Bundle bun
         writer.flush();
     }
 
-    static String formatEntry(String key, String value, String localeStr) {
+    static String formatEntry(String key, String value, String localeStr, List<String> notes) {
         int maxLineLen = 80;
 
         StringBuilder output = new StringBuilder();
-
+        StringBuilder comments = new StringBuilder();
+
+        if (notes.size() > 0) {
+            comments.append(COMMENT_BEGIN);
+            Iterator<String> i = notes.iterator();
+            while (i.hasNext())  {
+                comments.append(i.next());
+                if (i.hasNext()) {
+                    comments.append("\n");
+                }
+            }
+            comments.append(COMMENT_END).append("\n");
+        }
         // construct the entire entry, i.e.
         // "key" = "value";
         StringBuilder entryBuilder = new StringBuilder(key.length() + value.length() + 7);
@@ -154,7 +204,7 @@ static String formatEntry(String key, String value, String localeStr) {
         int entryLen = entry.length();
         // entry fits on one line
         if (maxLineLen > entryLen) {
-            return entry;
+            return comments.toString()+entry;
         }
 
         // entry needs to be split onto multiple lines
@@ -197,7 +247,7 @@ static String formatEntry(String key, String value, String localeStr) {
             }
         }
 
-        return output.toString();
+        return comments.toString()+output.toString();
     }
 
 }

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

@@ -25,6 +25,7 @@
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.LinkedList;
@@ -49,12 +50,19 @@ public class IOSStringsResourceTest {
     private static final File EXPECTED_MERGE_2_FILE = new File("src/test/resource/resfilter/ios/merge-output-2.strings");
 
     private static final Collection<ResourceString> EXPECTED_INPUT_RES_LIST;
+    private static final List<String> EXPECTED_GLOBAL_NOTES = Arrays.asList(
+            " This is the first global comment... ",
+            " This is the 2nd global comment... ");
 
     static {
-        List<ResourceString> lst = new LinkedList<>();
-        lst.add(new ResourceString("Insert Element", "Insert Element", 1));
-        lst.add(new ResourceString("ErrorString_1", "An unknown error occurred.", 2));
-        lst.add(new ResourceString("bear 3", "Brown Bear", 3));
+        List<ResourceString> lst = new ArrayList<>();
+        lst.add(new ResourceString("Insert Element", "Insert Element", 1,
+                Arrays.asList(" Insert = Element menu item ")));
+        lst.add(new ResourceString("ErrorString_1", "An unknown error occurred.", 2,
+                Arrays.asList(" Error string used ","    for unknown error types. ")));
+        lst.add(new ResourceString("bear 3", "Brown Bear", 3,
+        Arrays.asList(" Brown Bear has multiple comments "," Mama Bear ",
+                " Papa Bear "," Baby Bear ")));
         lst.add(new ResourceString("frog 4", "Red-eyed Tree Frog", 4));
         lst.add(new ResourceString("owl 5", "Great Horned Owl", 5));
 
@@ -66,8 +74,11 @@ public class IOSStringsResourceTest {
 
     static {
         WRITE_BUNDLE = new Bundle();
-        WRITE_BUNDLE.addResourceString("sealion 3", "California Sea Lion", 3);
-        WRITE_BUNDLE.addResourceString("otter 1", "Sea Otter", 1);
+        WRITE_BUNDLE.addResourceString("sealion 3", "California Sea Lion", 3,
+                Arrays.asList(" This is a brilliant comment","  about California Sea Lions! "));
+
+        WRITE_BUNDLE.addResourceString("otter 1", "Sea Otter", 1,
+                Arrays.asList(" The sea otter swims a lot. "));
         WRITE_BUNDLE.addResourceString("crow 2", "American Crow", 2);
         WRITE_BUNDLE.addResourceString("Lorem",
                 "Loremのイプサムは、単に印刷と植字業界のダミーテキストです。 Loremのイプサムは、未知のプリンターがタイプのゲラを取り、"
@@ -81,6 +92,10 @@ public class IOSStringsResourceTest {
                         + "1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 "
                         + "1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 ",
                 4);
+        WRITE_BUNDLE.addNote(" This is the first global comment... ");
+        WRITE_BUNDLE.addNote(" This is the 2nd global comment... ");
+
+;
     }
 
     private static Bundle MERGE_BUNDLE;
@@ -123,6 +138,8 @@ public void testParse() throws IOException {
             List<ResourceString> resStrList = new ArrayList<>(bundle.getResourceStrings());
             Collections.sort(resStrList, new ResourceStringComparator());
             assertEquals("ResourceStrings did not match.", EXPECTED_INPUT_RES_LIST, resStrList);
+            List<String> globalNotes = bundle.getNotes();
+            assertEquals("Global comments did not match.", EXPECTED_GLOBAL_NOTES, globalNotes);
         }
     }
 

gp-res-filter/src/test/resource/resfilter/ios/input.strings

@@ -1,9 +1,16 @@
+/* This is the first global comment... */
+/* This is the 2nd global comment... */
+
 /* Insert = Element menu item */
 "Insert Element" = "Insert Element";
 /* Error string used 
     for unknown error types. */
 "ErrorString_1" = "An unknown error 
     occurred.";
+/* Brown Bear has multiple comments */
+/* Mama Bear */
+/* Papa Bear */
+/* Baby Bear */
 "bear 3" = "Brown Bear";
 "frog 4" = "Red-eyed Tree Frog";
 "owl 5"= "Great Horned Owl";

gp-res-filter/src/test/resource/resfilter/ios/merge-input-1.strings

@@ -4,6 +4,10 @@
     for unknown error types. */
 "ErrorString_1" = "An unknown error 
     occurred.";
+/* Brown Bear has multiple comments */
+/* Mama Bear */
+/* Papa Bear */
+/* Baby Bear */
 "bear 3" = "Brown Bear";
 "frog 4" = "Red-eyed Tree Frog";
 "owl 5"="Great Horned Owl";

gp-res-filter/src/test/resource/resfilter/ios/merge-output-1.strings

@@ -3,6 +3,10 @@
 /* Error string used 
     for unknown error types. */
 "ErrorString_1" = "An unknown error occurred - translated.";
+/* Brown Bear has multiple comments */
+/* Mama Bear */
+/* Papa Bear */
+/* Baby Bear */
 "bear 3" = "Brown Bear - translated";
 "frog 4" = "Red-eyed Tree Frog - translated";
 "owl 5" = "Great Horned Owl - translated";

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

@@ -1,5 +1,11 @@
+/* This is the first global comment... */
+/* This is the 2nd global comment... */
+
+/* The sea otter swims a lot. */
 "otter 1" = "Sea Otter";
 "crow 2" = "American Crow";
+/* This is a brilliant comment
+  about California Sea Lions! */
 "sealion 3" = "California Sea Lion";
 "numbers" = "1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4
      5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2