Add option to generate Java private setters (#212)

Plank models should be immutable, but certain project configurations may require that models have setters that can be accessed package-privately.
pinterest · Jun 6, 2019 · 32f2fe5 · 32f2fe5
1 parent 8d23c9b
commit 32f2fe5
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/Sources/Core/FileGenerator.swift b/Sources/Core/FileGenerator.swift
@@ -20,6 +20,7 @@ public enum GenerationParameterType {
     case indent
     case packageName
     case javaNullabilityAnnotationType
+    case javaGeneratePackagePrivateSetters
 }
 
 // Most of these are derived from https://www.binpress.com/tutorial/objective-c-reserved-keywords/43

diff --git a/Sources/Core/JavaModelRenderer.swift b/Sources/Core/JavaModelRenderer.swift
@@ -117,6 +117,22 @@ public struct JavaModelRenderer: JavaFileRenderer {
         return getters
     }
 
+    // Package-private setters are generated with if the flag --java_generate_package_private_setters is set
+    func renderModelPropertySetters() -> [JavaIR.Method] {
+        if params[.javaGeneratePackagePrivateSetters] == nil {
+            return []
+        }
+
+        let setters = transitiveProperties.map { param, schemaObj in
+            JavaIR.method([], "void set\(Languages.java.snakeCaseToCapitalizedPropertyName(param))(\(self.typeFromSchema(param, schemaObj)) value)") { [
+                "this." + Languages.java.snakeCaseToPropertyName(param) + " = value;",
+            ] }
+        }
+        return setters + [JavaIR.method([], "set_bits(int bits)") { [
+            "this._bits = bits;",
+        ] }]
+    }
+
     func renderModelIsSetCheckers(modifiers: JavaModifier = [.public]) -> [JavaIR.Method] {
         let getters = transitiveProperties.map { param, _ in
             JavaIR.method(modifiers, "boolean get" + Languages.java.snakeCaseToCapitalizedPropertyName(param) + "IsSet()") { [
@@ -440,6 +456,7 @@ public struct JavaModelRenderer: JavaFileRenderer {
                     self.renderModelHashCode(),
                 ] +
                     renderModelPropertyGetters() +
+                    renderModelPropertySetters() +
                     renderModelIsSetCheckers(),
                 enums: enumProps,
                 innerClasses: [

diff --git a/Sources/plank/Cli.swift b/Sources/plank/Cli.swift
@@ -18,6 +18,7 @@ enum FlagOptions: String {
     case objectiveCClassPrefix = "objc_class_prefix"
     case javaPackageName = "java_package_name"
     case javaNullabilityAnnotationType = "java_nullability_annotation_type"
+    case javaGeneratePackagePrivateSetters = "java_generate_package_private_setters_beta"
     case printDeps = "print_deps"
     case noRecursive = "no_recursive"
     case noRuntime = "no_runtime"
@@ -41,6 +42,7 @@ enum FlagOptions: String {
         case .version: return false
         case .javaPackageName: return true
         case .javaNullabilityAnnotationType: return true
+        case .javaGeneratePackagePrivateSetters: return false
         }
     }
 }
@@ -64,6 +66,7 @@ extension FlagOptions: HelpCommandOutput {
             "    Java:",
             "    --\(FlagOptions.javaPackageName.rawValue) - The package name to associate with generated Java sources",
             "    --\(FlagOptions.javaNullabilityAnnotationType.rawValue) - The type of nullability annotations to use. Can be either \"android-support\" (default) or \"androidx\".",
+            "    --\(FlagOptions.javaGeneratePackagePrivateSetters.rawValue) - Generate package-private setter methods (beta)",
         ].joined(separator: "\n")
     }
 }
@@ -148,6 +151,7 @@ func handleGenerateCommand(withArguments arguments: [String]) {
     let indent: String? = flags[.indent]
     let packageName: String? = flags[.javaPackageName]
     let javaNullabilityAnnotationType: String? = flags[.javaNullabilityAnnotationType]
+    let javaGeneratePackagePrivateSetters: String? = (flags[.javaGeneratePackagePrivateSetters] == nil) ? .none : .some("")
 
     let generationParameters: GenerationParameters = [
         (.recursive, recursive),
@@ -156,6 +160,7 @@ func handleGenerateCommand(withArguments arguments: [String]) {
         (.indent, indent),
         (.packageName, packageName),
         (.javaNullabilityAnnotationType, javaNullabilityAnnotationType),
+        (.javaGeneratePackagePrivateSetters, javaGeneratePackagePrivateSetters),
     ].reduce([:]) { (dict: GenerationParameters, tuple: (GenerationParameterType, String?)) in
         var mutableDict = dict
         if let val = tuple.1 {