Added convenience methods and subscripts to StringTable

Author: orchetect

.gitignore

@@ -1,5 +1,7 @@
+# Custom
+[Dd]ev/
+
 # Xcode
-/dev/
 
 # macOS
 .DS_Store

Sources/TextFileKit/StringArrayTableRepresentable.swift

@@ -0,0 +1,24 @@
+//
+//  StringArrayTableRepresentable.swift
+//  TextFileKit
+//
+//  Created by Steffan Andrews on 2021-03-15.
+//  Copyright © 2021 Steffan Andrews. All rights reserved.
+//
+
+/// Protocol describing file formats which can be encoded to/from a `StringTable` (String Array table of rows and columns).
+public protocol StringArrayTableRepresentable {
+	
+	/// Raw data store as an Array table addressed as `self[row][column]`, `self[row, column]` or `self[safe: row, column]`.
+	var table: StringTable { get set }
+	
+	/// (Computed property) Raw text content of the file.
+	var rawText: String { get }
+	
+	/// Initialize from an Array table addressed as `self[row][column]`, `self[row, column]` or `self[safe: row, column]`.
+	init(table: StringTable)
+	
+	/// Initialize from raw text content.
+	init(rawText: String)
+	
+}

Sources/TextFileKit/StringTable.swift

@@ -0,0 +1,62 @@
+//
+//  StringTable.swift
+//  TextFileKit
+//
+//  Created by Steffan Andrews on 2021-03-15.
+//  Copyright © 2021 Steffan Andrews. All rights reserved.
+//
+
+/// String table addressed as `self[row][column]`, `self[row, column]` or `self[safe: row, column]`.
+public typealias StringTable = [[String]]
+
+extension StringTable {
+	
+	/// Number of rows in the string table.
+	public var rowCount: Int {
+		
+		count
+		
+	}
+	
+	/// Number of rows in the columns table.
+	/// The first row determines number of columns for the entire table.
+	public var columnCount: Int {
+		
+		first?.count ?? 0
+		
+	}
+	
+	/// Access a cell of the table.
+	/// Ensure the cell exists before accessing it or an exception will be thrown, the same as standard array subscript behavior.
+	public subscript(row: Int, col: Int) -> Element.Element {
+		
+		get {
+			self[row][col]
+		}
+		set {
+			self[row][col] = newValue
+		}
+	
+	}
+	
+	/// Access a cell of the table.
+	/// Get: Cells which do not exist will return `nil`.
+	/// Set: Cells which do not exist will not be set.
+	public subscript(safe row: Int, col: Int) -> Element.Element? {
+		
+		get {
+			self[safe: row]?[safe: col]
+		}
+		set {
+			guard row < self.rowCount,
+				  col < self[row].count
+			else { return }
+			
+			if let newValue = newValue {
+				self[row][col] = newValue
+			}
+		}
+	
+	}
+	
+}

Sources/TextFileKit/TextFile CSV.swift

@@ -14,38 +14,37 @@ extension TextFile {
 
 	// tested with Google Sheets, Microsoft Excel, and Apple Numbers
 
-	/// CUSTOM SHARED:
 	/// CSV (Comma-Separated Values) text file format.
 	public struct CSV: StringArrayTableRepresentable {
 
-		// consts
+		// MARK: - Constants
 
 		internal static let sepChar: Character = ","
 		internal static let newLineChar: Character = Character.newLine
 
 		public static let fileExtension = "csv"
 
-		// vars
+		// MARK: - Variables
 
 		public var table: StringTable = []
 
-		// init
+		// MARK: - Init
 
 		public init(table: StringTable = []) {
 			self.table = table
 		}
 
-		public init(rawData: String) {
-			table = Self.parseCSV(text: rawData)
+		public init(rawText: String) {
+			table = Self.parseCSV(text: rawText)
 		}
 
-		// rawData
+		// MARK: - rawText
 
-		public var rawData: String {
+		public var rawText: String {
 
-			table.map ({ row in
+			table.map { row in
 
-				row.map ({ textString in
+				row.map { textString in
 
 					var outString = textString
 
@@ -60,9 +59,10 @@ extension TextFile {
 
 					return outString
 
-				})
+				}
 				.joined(separator: Self.sepChar.string)
-			})
+				
+			}
 			.joined(separator: Self.newLineChar.string)
 
 		}

Sources/TextFileKit/TextFile TSV.swift

@@ -12,38 +12,37 @@ extension TextFile {
 
 	// tested with Google Sheets, Microsoft Excel, and Apple Numbers
 
-	/// CUSTOM SHARED:
 	/// TSV (Tab-Separated Values) text file format.
 	public struct TSV: StringArrayTableRepresentable {
 
-		// consts
+		// MARK: - Constants
 
 		internal static let sepChar: Character = "\t"
 		internal static let newLineChar: Character = Character.newLine
 
 		public static let fileExtension = "tsv"
 
-		// vars
+		// MARK: - Variables
 
 		public var table: StringTable = []
 
-		// init
+		// MARK: - Init
 
 		public init(table: StringTable = []) {
 			self.table = table
 		}
 
-		public init(rawData: String) {
-			table = Self.parseTSV(text: rawData)
+		public init(rawText: String) {
+			table = Self.parseTSV(text: rawText)
 		}
 
-		// rawData
+		// MARK: - RawText
 
-		public var rawData: String {
+		public var rawText: String {
 
-			table.map ({ row in
+			table.map { row in
 
-				row.map ({ textString in
+				row.map { textString in
 
 					var outString = textString
 					var needsQuoteWrapping = false
@@ -67,9 +66,10 @@ extension TextFile {
 
 					return outString
 
-				})
+				}
 				.joined(separator: Self.sepChar.string)
-			})
+				
+			}
 			.joined(separator: Self.newLineChar.string)
 
 		}

Sources/TextFileKit/TextFile.swift

@@ -6,30 +6,7 @@
 //  Copyright © 2020 Steffan Andrews. All rights reserved.
 //
 
-/// CUSTOM SHARED:
 /// Family of Text File parsing and constructing entities.
 public enum TextFile {
 
 }
-
-/// CUSTOM SHARED:
-/// String table addressed as `self[row][column]`.
-public typealias StringTable = [[String]]
-
-/// CUSTOM SHARED:
-/// Protocol describing file formats which can be serialized/deserialized to/from a String Array table of rows and columns.
-public protocol StringArrayTableRepresentable {
-	
-	/// Raw data store as an Array table addressed as `self[row][column]`.
-	var table: StringTable { get set }
-	
-	/// (Computed property) Raw string content of the file.
-	var rawData: String { get }
-	
-	/// Initialize from an Array table addressed as `self[row][column]`.
-	init(table: StringTable)
-	
-	/// Initialize from raw file data.
-	init(rawData: String)
-	
-}