[Feature] Custom display name support (#22)

michaelhenry · Jan 17, 2023 · 940401d · 940401d
1 parent 01fb795
commit 940401d
Show file tree

Hide file tree

Showing 10 changed files with 193 additions and 186 deletions.
diff --git a/Demo/DemoTests/MockConfigs.swift b/Demo/DemoTests/MockConfigs.swift
@@ -40,10 +40,10 @@ struct MockConfigs: XConfigsSpec {
     @XConfig(key: "width", defaultValue: 320, group: .feature2)
     var width: Double
 
-    @XConfig(key: "accountType", defaultValue: .guest, group: .feature3)
+    @XConfig(key: "accountType", displayName: "Account Type", defaultValue: .guest, group: .feature3)
     var accountType: AccountType
 
-    @XConfig(key: "contact", defaultValue: .default, group: .feature3)
+    @XConfig(key: "contact", displayName: "Contact", defaultValue: .default, group: .feature3)
     var contact: Contact
 }
 

diff --git a/Demo/DemoTests/SnapshotTests.swift b/Demo/DemoTests/SnapshotTests.swift
@@ -40,23 +40,23 @@ final class SnapshotTests: XCTestCase {
     }
 
     func testInputValueViewController() throws {
-        let vc = InputValueViewController(viewModel: .init(model: .init(key: "Hello", value: "World"))).wrapInsideNavVC()
+        let vc = InputValueViewController(viewModel: .init(model: .init(key: "Hello", value: "World", displayName: "Hello"))).wrapInsideNavVC()
         assertSnapshot(matching: vc, as: .image)
     }
 
     func testInputValueViewControllerJSON() throws {
-        let vc = InputValueViewController(viewModel: .init(model: .init(key: "JSON", value: "{\"name\":\"Kel\", \"city\": \"Melbourne\"        }"))).wrapInsideNavVC()
+        let vc = InputValueViewController(viewModel: .init(model: .init(key: "JSON", value: "{\"name\":\"Kel\", \"city\": \"Melbourne\"        }", displayName: "Contact"))).wrapInsideNavVC()
         assertSnapshot(matching: vc, as: .image)
     }
 
     func testInputValueViewControllerURL() throws {
-        let vc = InputValueViewController(viewModel: .init(model: .init(key: "URL", value: "https://google.com"))).wrapInsideNavVC()
+        let vc = InputValueViewController(viewModel: .init(model: .init(key: "URL", value: "https://google.com", displayName: "URL"))).wrapInsideNavVC()
         assertSnapshot(matching: vc, as: .image)
     }
 
     func testOptionViewController() throws {
         let choices = [1, 2, 3, 4].map { "Value\($0)" }.map { Choice(displayName: $0, value: $0) }
-        let vc = OptionViewController(viewModel: .init(model: .init(key: "Name", value: "Value1", choices: choices))).wrapInsideNavVC()
+        let vc = OptionViewController(viewModel: .init(model: .init(key: "Name", value: "Value1", choices: choices, displayName: "Name"))).wrapInsideNavVC()
         assertSnapshot(matching: vc, as: .image(precision: 0.95))
     }
 

diff --git a/Demo/DemoTests/XConfigsTests.swift b/Demo/DemoTests/XConfigsTests.swift
diff --git a/Sources/XConfigs/Models/InputModel.swift b/Sources/XConfigs/Models/InputModel.swift
@@ -3,4 +3,5 @@ import Foundation
 struct TextInputModel: Hashable {
     let key: String
     let value: String
+    let displayName: String
 }
diff --git a/Sources/XConfigs/Models/OptionSelectionModel.swift b/Sources/XConfigs/Models/OptionSelectionModel.swift
@@ -9,4 +9,5 @@ struct OptionSelectionModel: Hashable {
     let key: String
     let value: String
     let choices: [Choice]
+    let displayName: String
 }
diff --git a/Sources/XConfigs/Models/ToggleModel.swift b/Sources/XConfigs/Models/ToggleModel.swift
@@ -3,4 +3,5 @@ import Foundation
 struct ToggleModel: Hashable {
     let key: String
     let value: Bool
+    let displayName: String
 }
diff --git a/Sources/XConfigs/PropertyWrappers/XConfig.swift b/Sources/XConfigs/PropertyWrappers/XConfig.swift
@@ -3,15 +3,17 @@ import Foundation
 @propertyWrapper
 public struct XConfig<Value: RawStringValueRepresentable>: ConfigInfo {
     public let key: String
+    public let displayName: String?
     public let defaultValue: Value
     public let group: XConfigGroup
 
     public var wrappedValue: Value {
         defaultConfigUseCase.get(for: key, defaultValue: defaultValue, group: group)
     }
 
-    public init(key: String, defaultValue: Value, group: XConfigGroup = .default) {
+    public init(key: String, displayName: String? = nil, defaultValue: Value, group: XConfigGroup = .default) {
         self.key = key
+        self.displayName = displayName
         self.defaultValue = defaultValue
         self.group = group
     }

diff --git a/Sources/XConfigs/Protocols/ConfigInfo.swift b/Sources/XConfigs/Protocols/ConfigInfo.swift
@@ -2,6 +2,7 @@ import Foundation
 
 public protocol ConfigInfo {
     var configKey: String { get }
+    var displayName: String? { get }
     var configValue: RawStringValueRepresentable { get }
 
     var group: XConfigGroup { get }

diff --git a/Sources/XConfigs/ViewControllers/XConfigsViewController.swift b/Sources/XConfigs/ViewControllers/XConfigsViewController.swift
@@ -18,7 +18,7 @@ final class XConfigsViewController: UITableViewController {
             switch item {
             case let .toggle(vm):
                 let cell = tableView.dequeueCell(UIViewTableWrapperCell<ToggleView>.self, for: indexPath)
-                cell.configure(with: (vm.key, vm.value))
+                cell.configure(with: (vm.displayName, vm.value))
                 cell.mainView.valueChangedPublisher
                     .map { KeyValue(key: vm.key, value: $0) }
                     .bind(to: self.updateValueSubject)
@@ -27,11 +27,11 @@ final class XConfigsViewController: UITableViewController {
                 return cell
             case let .textInput(vm):
                 let cell = tableView.dequeueCell(UIViewTableWrapperCell<KeyValueView>.self, for: indexPath)
-                cell.configure(with: (vm.key, vm.value))
+                cell.configure(with: (vm.displayName, vm.value))
                 return cell
             case let .optionSelection(vm):
                 let cell = tableView.dequeueCell(UIViewTableWrapperCell<KeyValueView>.self, for: indexPath)
-                cell.configure(with: (vm.key, vm.value))
+                cell.configure(with: (vm.displayName, vm.value))
                 return cell
             case let .actionButton(title, _):
                 let cell = tableView.dequeueCell(UIViewTableWrapperCell<ActionView>.self, for: indexPath)

diff --git a/Sources/XConfigs/ViewModels/XConfigsViewModel.swift b/Sources/XConfigs/ViewModels/XConfigsViewModel.swift
@@ -116,15 +116,16 @@ struct XConfigsViewModel: ViewModelType {
         let key = info.configKey
         switch info.configValue {
         case let val as Bool:
-            return .toggle(.init(key: key, value: val))
+            return .toggle(.init(key: key, value: val, displayName: info.displayName ?? info.configKey))
         case let val as any CaseIterable & RawStringValueRepresentable:
             return .optionSelection(.init(
                 key: key,
                 value: (val as? CustomStringConvertible)?.description ?? val.rawString,
-                choices: val.allChoices
+                choices: val.allChoices,
+                displayName: info.displayName ?? info.configKey
             ))
         default:
-            return .textInput(.init(key: key, value: info.configValue.rawString))
+            return .textInput(.init(key: key, value: info.configValue.rawString, displayName: info.displayName ?? info.configKey))
         }
     }
 }