fix: re-add deprecated generic variable() and variableValue() methods (…

…#191) * fix: re-add deprecated generic variable() and variableValue() methods Signed-off-by: Jonathan Norris <[email protected]> * fix: change test setup Signed-off-by: Jonathan Norris <[email protected]> --------- Signed-off-by: Jonathan Norris <[email protected]>
DevCycleHQ · Mar 28, 2024 · 1ea7fc4 · 1ea7fc4
1 parent 5afe6b0
commit 1ea7fc4
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/DevCycle/DevCycleClient.swift b/DevCycle/DevCycleClient.swift
@@ -284,6 +284,10 @@ public class DevCycleClient {
     public func variableValue(key: String, defaultValue: NSDictionary) -> NSDictionary {
         return getVariable(key: key, defaultValue: defaultValue).value
     }
+    @available(*, deprecated, renamed: "variableValue()", message: "Use strictly typed versions of variableValue() methods")
+    public func variableValue<T>(key: String, defaultValue: T) -> T {
+        return getVariable(key: key, defaultValue: defaultValue).value
+    }
 
     public func variable(key: String, defaultValue: Bool) -> DVCVariable<Bool> {
         return getVariable(key: key, defaultValue: defaultValue)
@@ -306,6 +310,10 @@ public class DevCycleClient {
     public func variable(key: String, defaultValue: NSDictionary) -> DVCVariable<NSDictionary> {
         return getVariable(key: key, defaultValue: defaultValue)
     }
+    @available(*, deprecated, renamed: "variable()", message: "Use strictly typed versions of variable() methods")
+    public func variable<T>(key: String, defaultValue: T) -> DVCVariable<T> {
+        return getVariable(key: key, defaultValue: defaultValue)
+    }
 
     func getVariable<T>(key: String, defaultValue: T) -> DVCVariable<T> {
         let regex = try? NSRegularExpression(pattern: ".*[^a-z0-9(\\-)(_)].*")

diff --git a/DevCycleTests/Models/DevCycleClientTests.swift b/DevCycleTests/Models/DevCycleClientTests.swift
@@ -211,6 +211,17 @@ class DevCycleClientTest: XCTestCase {
         client.close(callback: nil)
     }
 
+    func testVariableDeprecatedMethod() {
+        let client = try! self.builder.user(self.user).sdkKey("my_sdk_key").build(onInitialized: nil)
+        let defaultVal: Int = 1
+        let variable = client.variable(key: "key", defaultValue: defaultVal)
+        XCTAssertTrue(variable.value == defaultVal)
+        XCTAssertTrue(variable.isDefaulted)
+        let variableValue = client.variableValue(key: "key", defaultValue: defaultVal)
+        XCTAssertTrue(variableValue == defaultVal)
+        client.close(callback: nil)
+    }
+
     func testVariableReturnsDefaultForUnsupportedVariableKeys() {
         let client = try! self.builder.user(self.user).sdkKey("my_sdk_key").build(onInitialized: nil)
         let variable = client.variable(key: "UNSUPPORTED\\key%$", defaultValue: true)