Merge pull request realm#339 from realm/jp-escape-csv

escape strings when using CSV reporter

CHANGELOG.md

@@ -34,6 +34,9 @@
   [Norio Nomura](https://github.com/norio-nomura)
   [#324](https://github.com/realm/SwiftLint/issues/324)
 
+* Escape strings when using CSV reporter.  
+  [JP Simard](https://github.com/jpsim)
+
 ## 0.5.5: Magic Drying Fluff Balls™
 
 <http://www.amazon.com/Magic-Drying-Fluff-Balls-Softening/dp/B001EIW1SG>

Source/SwiftLintFramework/Reporters/CSVReporter.swift

@@ -8,6 +8,16 @@
 
 import Foundation
 
+extension String {
+    private func escapedForCSV() -> String {
+        let escapedString = stringByReplacingOccurrencesOfString("\"", withString: "\\\"")
+        if escapedString.containsString(",") || escapedString.containsString("\n") {
+            return "\"\(escapedString)\""
+        }
+        return escapedString
+    }
+}
+
 public struct CSVReporter: Reporter {
     public static let identifier = "csv"
     public static let isRealtime = false
@@ -31,12 +41,12 @@ public struct CSVReporter: Reporter {
 
     private static func arrayForViolation(violation: StyleViolation) -> [String] {
         let values: [AnyObject?] = [
-            violation.location.file,
+            violation.location.file?.escapedForCSV(),
             violation.location.line,
             violation.location.character,
             violation.severity.rawValue,
-            violation.ruleDescription.name,
-            violation.reason,
+            violation.ruleDescription.name.escapedForCSV(),
+            violation.reason.escapedForCSV(),
             violation.ruleDescription.identifier
         ]
         return values.map({ $0?.description ?? "" })