- Code refactoring for Validation while writing(exporting) CSV file.

- Improved the code standards to handle the error status.
- Split framework source files into three file.
   -  CSVExport.swift.
   -  CSVValidateProtocol.swift
   -  CSVConstants.swift.
- Added test code into OSX test target.

Author: vigneshuvi

Examples/SampleSwift/SampleSwift/ViewController.swift

@@ -61,6 +61,7 @@ class ViewController: UIViewController {
         // Create a object for write CSV
         let writeCSVObj = CSV()
         writeCSVObj.rows = data
+        writeCSVObj.delimiter = DividerType.semicolon.rawValue
         writeCSVObj.fields = header as NSArray
         writeCSVObj.name = "userlist"
 

README.md

@@ -12,6 +12,7 @@
 - Able to give CSV file name, headers and rows using property keys.
 - Able to convert JSON string into CSV.
 - Able to Read the CSV file and convert to NSDictionary.
+- Enable/Disable strict validation while write CSV file.
 - Able to Read the CSV file and convert to CSV class(Object Oriented Approach).
 - Support CocoaPods, mac OS and Vapor framework(Swift Package Manager).
 - Able to encoding CSV based on String.Encoding Type(utf8, ascii, unicode, utf16, etc) Refer: String.Encoding.
@@ -129,18 +130,31 @@ data.add(user2);
 // Create a object for write CSV
 let writeCSVObj = CSV()
 writeCSVObj.rows = data
+writeCSVObj.delimiter = DividerType.comma.rawValue
 writeCSVObj.fields = header as NSArray
 writeCSVObj.name = "userlist"
 
 // Write File using CSV class object
-let filePath:String = SwiftCSVExport.exportCSV(writeCSVObj);
-print("File Path: \(filePath)")
+let result = exportCSV(writeCSVObj);
+if result.isSuccess {
+    guard let filePath =  result.value else {
+        print("Export Error: \(String(describing: result.value))")
+        return
+    }
+    self.testWithFilePath(filePath, rowCount: data.count, columnCount: header.count)
+    print("File Path: \(filePath)")
+
+    // Read File and convert as CSV class object
+    let readCSVObj = readCSVObject(filePath);
+     
+    // Use 'SwiftLoggly' pod framework to print the Dictionary
+    loggly(LogType.Info, text: readCSVObj.name)
+} else {
+    print("Export Error: \(String(describing: result.value))")
+}
+
+
 
-// Read File and convert as CSV class object
-let readCSVObj = readCSVObject(filePath);
- 
-// Use 'SwiftLoggly' pod framework to print the Dictionary
-loggly(LogType.Info, text: readCSVObj.name)
 
 ```
 
@@ -161,14 +175,29 @@ userid,name,email,message,isValidUser,balance
 
 ```
 
-### Example 3  - Swift
+### Example 3  - Swift - Enable Strict Validation
 
 ```swift
 
+// Enable Strict Validation
+CSVExport.export.enableStrictValidation = true
+
 // Able to convert JSON string into CSV.
 let string = "[{\"name\":\"vignesh\",\"email\":\"[email protected]\"},{\"name\":\"vinoth\",\"email\":\"[email protected]\"}]";
-let filePath:String = exportCSV("userlist", fields:["name","email"], values:string);
-print(filePath)
+
+// Write File using CSV class object
+let result1 = exportCSV("userlist", fields:["userid","name","email"], values:string);
+XCTAssertEqual(false, result1.isSuccess)
+if result1.isSuccess {
+    guard let filePath =  result1.value else {
+        print("Export Error: \(String(describing: result1.value))")
+        return
+    }
+    print("File Path: \(filePath)")
+    
+} else {
+    print("Export Error: \(String(describing: result1.value))")
+}
 
 
 ```
@@ -177,7 +206,7 @@ print(filePath)
 
 ```swift
 
-File Path: xxxxxx/xxxxxxx/Documents/Exports/userlist.csv
+Export Error: Optional("Expected 3 columns, But Parsed 2 columns on row 1")
 
 ```
 
@@ -259,6 +288,10 @@ CSVExport.export.fileName = "Sample" //default is "csvfile"
 //Set the directory in which the csv files will be written
 CSVExport.export.directory = "/Library/XXX-folder-name-XXX" //default is the standard exporting directory for each platform.
 
+// Able to set strict validation while create a new CSV file.
+CSVExport.export.enableStrictValidation = true
+
+
 ```
 
 ## Installation

Sources/CSVConstants.swift

@@ -0,0 +1,119 @@
+//
+//  CSVConstants.swift
+//  SwiftCSVExport
+//
+//  Created by Vignesh on 12/01/18.
+//  Copyright © 2018 vigneshuvi. All rights reserved.
+//
+
+import Foundation
+
+//MARK: -  CSV output dictionay keys - Constants
+public struct FieldName {
+    public static let fields = "fields"
+    public static let rows = "rows"
+    public static let name = "name"
+    public static let divider = "divider"
+}
+
+//MARK: -  Divider type - Enumeration
+public enum DividerType: String {
+    case comma = ","
+    case semicolon = ";"
+}
+
+// MARK: -  CSV Class
+@objc public class CSV:NSObject {
+    open var fields:NSArray = []
+    open var rows:NSArray = []
+    open var name:String = ""
+    open var delimiter:String = DividerType.comma.rawValue
+}
+
+// MARK: -  Extension for NSMutableDictionary
+public extension NSMutableDictionary {
+    
+    public var hasData:Bool {
+        return  self.allKeys.count > 0 && self.allValues.count > 0
+    }
+    
+    public var fields: [Any] {
+        guard let fields =  self.object(forKey:FieldName.fields) else {
+            return []
+        }
+        return fields as! [Any];
+    }
+    
+    public var rows: [Any] {
+        guard let rows =  self.object(forKey:FieldName.rows)  else {
+            return []
+        }
+        return rows as! [Any]
+    }
+    
+    public var name: String {
+        guard let name =  self.object(forKey:FieldName.name) else {
+            return ""
+        }
+        return name as! String
+    }
+    
+    public var delimiter: String {
+        guard let delimiter =  self.object(forKey:FieldName.divider) else {
+            return ""
+        }
+        return delimiter as! String
+    }
+}
+
+// MARK: -  Extension for String
+extension String {
+    
+    /// Get lines split by Newline delimiter.
+    var lines: [String] {
+        var result: [String] = []
+        enumerateLines { line, _ in result.append(line) }
+        return result
+    }
+    
+    func split(regex pattern: String) -> [String] {
+        
+        guard let re = try? NSRegularExpression(pattern: pattern, options: [])
+            else { return [] }
+        
+        let nsString = self as NSString // needed for range compatibility
+        let stop = "<SomeStringThatYouDoNotExpectToOccurInSelf>"
+        let modifiedString = re.stringByReplacingMatches(
+            in: self,
+            options: [],
+            range: NSRange(location: 0, length: nsString.length),
+            withTemplate: stop)
+        return modifiedString.components(separatedBy: stop)
+    }
+    
+    /// Getting the characters length
+    var length: Int {
+        return self.count
+    }
+    
+    /// Replace the escape characters
+    func replaceEscapeCharacters() -> String {
+        return self.replacingOccurrences(of: "\n", with: "\\n").replacingOccurrences(of: "\t", with: "\\t").replacingOccurrences(of: "\r", with: "\\r")
+    }
+    
+    /// Create CSV Row
+    func formatCSVRow(_ div:String, value:Any) -> String {
+        if let string = value as? String {
+            // Wrap around double quotes
+            let fString = "\"\(string)\""
+            return self.length == 0 ? fString  : "\(self)\(div)  \(fString)"
+        } else {
+            return self.length == 0 ? "\(value)" : "\(self)\(div)  \(value)"
+        }
+    }
+    
+    func stringByAppendingPathComponent(path: String) -> String {
+        let nsSt = self as NSString
+        return nsSt.appendingPathComponent(path)
+    }
+}