Merge branch 'work/ignore_keys_in_code' into stable

README.md

@@ -283,7 +283,7 @@ It is recommended that you update the `-p "$PROJECT_DIR"` appearances in this sc
 
 ---
 
-### Exclude specific Views from Localization
+### Exclude specific Views / NSLocalizedStrings from Localization
 
 Sometimes you may want to **ignore some specific views** containing localizable texts e.g. because **their values are gonna be set programmatically**.
 For these cases you can simply include `#bartycrouch-ignore!` or the shorthand `#bc-ignore!` into your value within your base localized Storyboard/XIB file.
@@ -293,6 +293,15 @@ Here's an example of how a base localized view in a XIB file with partly ignored
 
 <img src="Exclusion-Example.png">
 
+You can also use `#bc-ignore!` in your `NSLocalizedString` macros comment part to ignore them so they are not added to your `Localizable.strings`. This is helpful when you are using a `.stringsdict` file to handle pluralization (see [docs](https://developer.apple.com/library/ios/documentation/MacOSX/Conceptual/BPInternational/StringsdictFileFormat/StringsdictFileFormat.html)).
+
+For example you can do something like this:
+```swift
+func updateTimeLabel(minutes: Int) {
+  String.localizedStringWithFormat(NSLocalizedString("%d minute(s) ago", comment: "pluralized and localized minutes #bc-ignore!"), minutes)
+}
+```
+The `%d minute(s) ago` key will be taken from Localizable.stringsdict file, not from Localizable.strings.
 
 ## Migration Guides
 

Sources/Code/StringsFileUpdater.swift

@@ -32,7 +32,7 @@ public class StringsFileUpdater {
 
     /// Updates the keys of this instances strings file with those of the given strings file.
     /// Note that this will add new keys, remove not-existing keys but won't touch any existing ones.
-    public func incrementallyUpdateKeys(withStringsFileAtPath otherStringFilePath: String, addNewValuesAsEmpty: Bool, ignoreBaseKeys: [String] = ["#bartycrouch-ignore!", "#bc-ignore!", "#i!"], override: Bool = false, updateCommentWithBase: Bool = true, keepExistingKeys: Bool = false) {
+    public func incrementallyUpdateKeys(withStringsFileAtPath otherStringFilePath: String, addNewValuesAsEmpty: Bool, ignoreBaseKeysAndComment ignores: [String] = ["#bartycrouch-ignore!", "#bc-ignore!", "#i!"], override: Bool = false, updateCommentWithBase: Bool = true, keepExistingKeys: Bool = false) {
 
         do {
             let newContentString = try String(contentsOfFile: otherStringFilePath)
@@ -61,7 +61,12 @@ public class StringsFileUpdater {
                 for (key, newValue, newComment) in newTranslations {
 
                     // skip keys marked for ignore
-                    guard !newValue.containsAny(ofStrings: ignoreBaseKeys) else {
+                    guard !newValue.containsAny(ofStrings: ignores) else {
+                        continue
+                    }
+
+                    // Skip keys that have been marked for ignore in comment
+                    if let newComment = newComment where newComment.containsAny(ofStrings: ignores) {
                         continue
                     }
 

Tests/Assets/CodeFiles/Subfolder/SwiftExample2.swift

@@ -14,6 +14,7 @@ class SwiftExample2 {
 
         NSLocalizedString("TestKey2", comment: "Comment for TestKey1")
         String(format: NSLocalizedString("%010d and %03.f", comment: ""), 25, 89.5)
+        String.localizableStringWithFormat(NSLocalizedString("%d ignore(s)", comment: "Ignoring stringsdict key #bc-ignore!"), 25)
 
     }
 

Tests/Code/GenStringsCommanderTests.swift

@@ -39,6 +39,9 @@ class GenStringsCommanderTests: XCTestCase {
                 "/* No comment provided by engineer. */",
                 "\"%@ and %.2f\" = \"%1$@ and %2$.2f\";",
                 "",
+                "/* Ignoring stringsdict key #bc-ignore! */",
+                "\"%d ignore(s)\" = \"%d ignore(s)\";",
+                "",
                 "/* Comment for TestKey1 */",
                 "\"TestKey1\" = \"TestKey1\";",
                 "",