Merge pull request #48 from yumaoka/rfe-44-reviewed-only

Added new maven plugin output content options

Author: yumaoka

gp-maven-plugin.md

@@ -308,7 +308,7 @@ versions in parallel language directories.
 localized version will use the same file name with source, but placed in a directory
 for the language. `<languageIdStyle>` specifies the style of language ID used for
 file/path name. **BCP47** specifies the BCP 47 language tag. In this case, '-' (Hyphen)
-is used for subtag separtors, such as 'zh-Hans'.
+is used for subtag separators, such as 'zh-Hans'.
 
 With this example, if you have English JSON resource file at `src/main/webapp/res/en/MyStrings.json`,
 French version is generated at `target/MyApp/res/fr/MyStrings.json`, and Simplified Chinese
@@ -495,6 +495,13 @@ resource strings. This option might not be implemented by some format types. In
 When translated string value is not available, the value in the source language is used.
 * **TRANSLATED_ONLY** Emits only resource strings (with a simple header if applicable).
 When translated string value is not available, do not include the key in the output.
+* **MERGE_REVIEWED_TO_SOURCE** Duplicate the contents of the source bundle and replaces only
+translated resource strings marked as reviewed. This option might not be implemented by some
+format types. In this case, **REVIEWED_WITH_FALLBACK** is used instead.
+* **REVIEWED_WITH_FALLBACK** Emits only resource strings marked as reviewed. When translated string
+value is not available, or not marked as reviewed, the value in the source language is used.
+* **REVIEWED_ONLY** Emits only resource strings marked as reviewed. When translated string value
+is not available, or translated not marked as reviewed, do not include the key in the output.
 
 The default value is **MERGE_TO_SOURCE**.
 

gp-maven-plugin/src/main/java/com/ibm/g11n/pipeline/maven/GPDownloadMojo.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.
@@ -211,15 +211,37 @@ private void exportLanguageResource(ServiceClient client, SourceBundleFile bf, S
             outputFile.getParentFile().mkdirs();
         }
 
+        Bundle bundle;
+
         switch (outContntOpt) {
         case MERGE_TO_SOURCE:
-            mergeTranslation(client, bf.getBundleId(), language, bf.getType(), bf.getFile(), outputFile);
+            bundle = getBundle(client, bf.getBundleId(), language, false, true);
+            mergeTranslation(bundle, language, bf.getType(), bf.getFile(), outputFile);
             break;
+
         case TRANSLATED_WITH_FALLBACK:
-            exportTranslation(client, bf.getBundleId(), language, bf.getType(), outputFile, true);
+            bundle = getBundle(client, bf.getBundleId(), language, false, true);
+            exportTranslation(bundle, language, bf.getType(), outputFile);
             break;
+
         case TRANSLATED_ONLY:
-            exportTranslation(client, bf.getBundleId(), language, bf.getType(), outputFile, false);
+            bundle = getBundle(client, bf.getBundleId(), language, false, false);
+            exportTranslation(bundle, language, bf.getType(), outputFile);
+            break;
+
+        case MERGE_REVIEWED_TO_SOURCE:
+            bundle = getBundle(client, bf.getBundleId(), language, true, true);
+            mergeTranslation(bundle, language, bf.getType(), bf.getFile(), outputFile);
+            break;
+
+        case REVIEWED_WITH_FALLBACK:
+            bundle = getBundle(client, bf.getBundleId(), language, true, true);
+            exportTranslation(bundle, language, bf.getType(), outputFile);
+            break;
+
+        case REVIEWED_ONLY:
+            bundle = getBundle(client, bf.getBundleId(), language, true, false);
+            exportTranslation(bundle, language, bf.getType(), outputFile);
             break;
         }
     }
@@ -244,63 +266,61 @@ private String getLanguageId(String gpLanguageTag, LanguageIdStyle langIdStyle,
         return languageId;
     }
 
-    private void mergeTranslation(ServiceClient client, String bundleId, String language,
-            ResourceType type, File srcFile, File outFile) throws MojoFailureException {
-        Bundle resBundle = null;
-        try {
-            resBundle = getBundle(client, bundleId, language, false);
-        } catch (ServiceException e) {
-            throw new MojoFailureException("Globalization Pipeline service error", e);
-        }
-
+    private void mergeTranslation(Bundle bundle, String language, ResourceType type,
+            File srcFile, File outFile) throws MojoFailureException {
         ResourceFilter filter = ResourceFilterFactory.get(type);
         try (FileOutputStream fos = new FileOutputStream(outFile);
                 FileInputStream fis = new FileInputStream(srcFile)) {
-            filter.merge(fis, fos, language, resBundle);
+            filter.merge(fis, fos, language, bundle);
         } catch (IOException e) {
             throw new MojoFailureException("I/O error while merging the translated values to "
                     + outFile.getAbsolutePath(), e);
         }
     }
 
-    private void exportTranslation(ServiceClient client, String bundleId, String language,
-            ResourceType type, File outFile, boolean withFallback) throws MojoFailureException {
-        Bundle resBundle = null;
-        try {
-            resBundle = getBundle(client, bundleId, language, withFallback);
-        } catch (ServiceException e) {
-            throw new MojoFailureException("Globalization Pipeline service error", e);
-        }
-
+    private void exportTranslation(Bundle bundle, String language, ResourceType type,
+            File outFile) throws MojoFailureException {
         ResourceFilter filter = ResourceFilterFactory.get(type);
         try (FileOutputStream fos = new FileOutputStream(outFile)) {
-            filter.write(fos, language, resBundle);
+            filter.write(fos, language, bundle);
         } catch (IOException e) {
             throw new MojoFailureException("Failed to write the translated resoruce data to "
                     + outFile.getAbsolutePath(), e);
         }
     }
 
-    private Bundle getBundle(ServiceClient client,
-            String bundleId, String language, boolean withFallback) throws ServiceException {
-        Map<String, ResourceEntryData> resEntries = client.getResourceEntries(bundleId, language);
-        Collection<ResourceString> resStrings = new LinkedList<>();
-        for (Entry<String, ResourceEntryData> entry : resEntries.entrySet()) {
-            String key = entry.getKey();
-            ResourceEntryData data = entry.getValue();
-            String resVal = data.getValue();
-            Integer seqNum = data.getSequenceNumber();
-            if (resVal == null && withFallback) {
-                resVal = data.getSourceValue();
-            }
-            if (resVal != null) {
-                ResourceString resString = new ResourceString(key, resVal);
-                if (seqNum != null) {
-                    resString.setSequenceNumber(seqNum.intValue());
+    private Bundle getBundle(ServiceClient client, String bundleId, String language,
+            boolean reviewedOnly, boolean withFallback) throws MojoFailureException {
+        try {
+            Map<String, ResourceEntryData> resEntries = client.getResourceEntries(bundleId, language);
+            Collection<ResourceString> resStrings = new LinkedList<>();
+            for (Entry<String, ResourceEntryData> entry : resEntries.entrySet()) {
+                String key = entry.getKey();
+                ResourceEntryData data = entry.getValue();
+                String resVal = data.getValue();
+                Integer seqNum = data.getSequenceNumber();
+
+                if (reviewedOnly) {
+                    if (!data.isReviewed()) {
+                        resVal = null;
+                    }
+                }
+
+                if (resVal == null && withFallback) {
+                    resVal = data.getSourceValue();
+                }
+
+                if (resVal != null) {
+                    ResourceString resString = new ResourceString(key, resVal);
+                    if (seqNum != null) {
+                        resString.setSequenceNumber(seqNum.intValue());
+                    }
+                    resStrings.add(resString);
                 }
-                resStrings.add(resString);
             }
+            return new Bundle(resStrings, null);
+        } catch (ServiceException e) {
+            throw new MojoFailureException("Globalization Pipeline service error", e);
         }
-        return new Bundle(resStrings, null);
     }
 }

gp-maven-plugin/src/main/java/com/ibm/g11n/pipeline/maven/OutputContentOption.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.
@@ -21,15 +21,41 @@
  * @author Yoshito Umaoka
  */
 public enum OutputContentOption {
-    // Merges translated resources into source file contents
-    // if possible. If the output resource format does not support
-    // this option, TRANSLATION_WITH_FALLBACK is used.
+    /**
+     * Merges translated resources into source file contents
+     * if possible. If the output resource format does not support
+     * this option, {@link #TRANSLATED_WITH_FALLBACK} is used.
+     */
     MERGE_TO_SOURCE,
 
-    // Exports translated resources. If translation is not available
-    // for a resource key, the value from the source bundle is used.
+    /**
+     * Exports translated resources. If translation is not available
+     * for a resource key, the value from the source bundle is used.
+     */
     TRANSLATED_WITH_FALLBACK,
 
-    // Exports only translated resources.
-    TRANSLATED_ONLY
+    /**
+     * Exports only translated resources.
+     */
+    TRANSLATED_ONLY,
+
+    /**
+     * Merges translated resources marked as reviewed into source
+     * file contents if possible. If the output resource format
+     * does not support this option, {@link #REVIEWED_WITH_FALLBACK}
+     * is used.
+     */
+    MERGE_REVIEWED_TO_SOURCE,
+
+    /**
+     * Exports translated resources marked as reviewed. If translation
+     * is not available or, not marked as reviewed, the value from the
+     * source bundle is used.
+     */
+    REVIEWED_WITH_FALLBACK,
+
+    /**
+     * Exports only translated resources marked as reviewed.
+     */
+    REVIEWED_ONLY
 }