feat: add access control selection (#121)

Author: yonihemi

Core/Constants.swift

@@ -29,6 +29,26 @@ enum ConstructType: String {
     case structType = "struct"
 }
 
+/// Various types of access control modifiers that can be applied to objects and properties.
+enum AccessControl: String, CaseIterable {
+    case `internal`
+    case `private`
+    case `public`
+
+    /// The prefix to be applied to objects and properties' declarations.
+    var declarationPrefix: String {
+        switch self {
+        case .internal:
+            // The default access control type, no need to explicitly set it
+            return ""
+        case .private:
+            return "private "
+        case .public:
+            return "public "
+        }
+    }
+}
+
 /// JSON mapping options available in the UI
 ///
 /// - Swift: Pure Swift 5 Codeable

Core/Generator/FileGeneratorExtension.swift

@@ -12,9 +12,11 @@ extension FileGenerator {
     static func generateFileContentWith(_ modelFile: ModelFile, configuration: ModelGenerationConfiguration) -> String {
         var content = try! loadFileWith("BaseTemplate")
         let singleTab = "  ", doubleTab = "    "
+        let accessPrefix = modelFile.accessControl.declarationPrefix
         content = content.replacingOccurrences(of: "{OBJECT_NAME}", with: modelFile.fileName)
         content = content.replacingOccurrences(of: "{DATE}", with: todayDateString())
         content = content.replacingOccurrences(of: "{OBJECT_KIND}", with: modelFile.type.rawValue)
+        content = content.replacingOccurrences(of: "{ACCESS_CONTROL}", with: accessPrefix)
 
         if let authorName = configuration.authorName {
             content = content.replacingOccurrences(of: "__NAME__", with: authorName)
@@ -36,7 +38,7 @@ extension FileGenerator {
             if modelFile.configuration?.shouldGenerateInitMethod == true {
                 let assignment = modelFile.component.initialiserFunctionComponent.map { doubleTab + $0.assignmentString }.joined(separator: "\n")
                 let functionParameters = modelFile.component.initialiserFunctionComponent.map { $0.functionParameter }.joined(separator: ", ")
-                let initialiserFunctionStatement = "\n\(singleTab)init (\(functionParameters)) {"
+                let initialiserFunctionStatement = "\n\(singleTab)\(accessPrefix)init (\(functionParameters)) {"
                 content = content.replacingOccurrences(of: "{INITIALIZER_FUNCTION_DECLRATION}", with: initialiserFunctionStatement)
                 content = content.replacingOccurrences(of: "{INITIALISER_FUNCTION_ASSIGNMENT}", with: assignment)
                 content = content.replacingOccurrences(of: "{INITIALISER_FUNCTION_END}", with: "\(singleTab)}\n")

Core/Generator/ModalGenerator.swift

@@ -114,7 +114,7 @@ public struct ModelGenerator {
      - returns: Notification tht was generated.
      */
     func generateNotificationFor(_ modelFiles: [ModelFile]) -> NSUserNotification {
-        let notification: NSUserNotification = NSUserNotification()
+        let notification = NSUserNotification()
         notification.title = NSLocalizedString("SwiftyJSONAccelerator", comment: "")
         if !modelFiles.isEmpty {
             let firstModel = (modelFiles.first)!

Core/Generator/Model-File-Components/ModelFile.swift

@@ -20,6 +20,9 @@ protocol ModelFile {
     /// Type of the the object, if a structure or a class.
     var type: ConstructType { get }
 
+    /// Type of access control for object and properties.
+    var accessControl: AccessControl { get }
+
     /// Storage for various components of the model, it is used to store the intermediate data.
     var component: ModelComponent { get }
 

Core/Generator/Model-File-Components/SwiftJSONModelFile.swift

@@ -13,6 +13,7 @@ import SwiftyJSON
 struct SwiftJSONModelFile: ModelFile {
     var fileName: String
     var type: ConstructType
+    var accessControl: AccessControl
     var component: ModelComponent
     var sourceJSON: JSON
     var configuration: ModelGenerationConfiguration?
@@ -24,11 +25,13 @@ struct SwiftJSONModelFile: ModelFile {
         type = ConstructType.structType
         component = ModelComponent()
         sourceJSON = JSON([])
+        accessControl = .internal
     }
 
     mutating func setInfo(_ fileName: String, _ configuration: ModelGenerationConfiguration) {
         self.fileName = fileName
         type = configuration.constructType
+        accessControl = configuration.accessControl
         self.configuration = configuration
     }
 
@@ -79,10 +82,8 @@ struct SwiftJSONModelFile: ModelFile {
     }
 
     func genPrimitiveVariableDeclaration(_ name: String, _ type: String, _ isOptional: Bool) -> String {
-        if isOptional {
-            return "var \(name): \(type)?"
-        }
-        return "var \(name): \(type)"
+        let optionalSuffix = isOptional ? "?" : ""
+        return "\(accessControl.declarationPrefix)var \(name): \(type)\(optionalSuffix)"
     }
 
     /// Generate the variable declaration string

Core/Generator/ModelGenerationConfiguration.swift

@@ -22,6 +22,8 @@ struct ModelGenerationConfiguration {
     var prefix: String?
     /// Type of the object that have to be generated.
     var constructType: ConstructType
+    /// Access control for object and properties.
+    var accessControl: AccessControl
     /// Model mapping library to be used.
     var modelMappingLibrary: JSONMappingMethod
     /// Separate coding keys into an enum and not use string.
@@ -36,6 +38,7 @@ struct ModelGenerationConfiguration {
         separateCodingKeys = true
         modelMappingLibrary = .swiftNormal
         constructType = .classType
+        accessControl = .internal
         prefix = ""
         filePath = ""
         baseClassName = ""

Core/Generator/MultipleModelGenerator.swift

@@ -149,6 +149,10 @@ struct MultipleModelGenerator {
         if let type = fromJSON["construct_type"].string, type == "struct" {
             constructType = ConstructType.structType
         }
+        var accessControl = AccessControl.internal
+        if let string = fromJSON["access_control"].string, let value = AccessControl(rawValue: string) {
+            accessControl = value
+        }
 
         let initialiserParameter = fromJSON["initaliser_needed"].bool
         let initialisersNeeded = initialiserParameter != nil ? initialiserParameter! : true
@@ -159,6 +163,7 @@ struct MultipleModelGenerator {
                                                   companyName: fromJSON["company_name"].string,
                                                   prefix: fromJSON["prefix"].string,
                                                   constructType: constructType,
+                                                  accessControl: accessControl,
                                                   modelMappingLibrary: jsonLibrary,
                                                   separateCodingKeys: fromJSON["separate_coding_keys"].boolValue,
                                                   variablesOptional: fromJSON["variable_option"].boolValue,

Core/Template/BaseTemplate.txt

@@ -7,7 +7,7 @@
 
 import Foundation
 
-{OBJECT_KIND} {OBJECT_NAME}: Codable {
+{ACCESS_CONTROL}{OBJECT_KIND} {OBJECT_NAME}: Codable {
 
   enum CodingKeys: String, CodingKey {
 {STRING_CONSTANT}
@@ -17,7 +17,7 @@ import Foundation
 {INITIALIZER_FUNCTION_DECLRATION}
 {INITIALISER_FUNCTION_ASSIGNMENT}
 {INITIALISER_FUNCTION_END}
-  {REQUIRED}init(from decoder: Decoder) throws {
+  {ACCESS_CONTROL}{REQUIRED}init(from decoder: Decoder) throws {
     let container = try decoder.container(keyedBy: CodingKeys.self)
 {INITIALIZER}
   }