add backward compatibility property

417-72KI · Apr 14, 2024 · 5e0f77e · 5e0f77e
1 parent d164db3
commit 5e0f77e
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/Sources/MockUserDefaults/MockUserDefaults.m b/Sources/MockUserDefaults/MockUserDefaults.m
@@ -185,6 +185,11 @@ + (NSUserDefaults *)mockedUserDefaults
     return userDefaluts;
 }
 
++ (NSUserDefaults *)deprecatedMockedUserDefaults
+{
+    return [self mockedUserDefaults];
+}
+
 + (void)resetMockedUserDefaults
 {
     [mockDictionary removeAllObjects];

diff --git a/Sources/MockUserDefaults/include/MockUserDefaults.h b/Sources/MockUserDefaults/include/MockUserDefaults.h
@@ -18,6 +18,9 @@ NS_ASSUME_NONNULL_BEGIN
 /** Mock object for `NSUserDefaults` */
 @property (class, readonly) NSUserDefaults *mockedUserDefaults NS_SWIFT_NAME(mock);
 
+/** Backward compatibility for Swift. Will be removed on next major version. */
+@property (class, readonly) NSUserDefaults *deprecatedMockedUserDefaults NS_SWIFT_NAME(mocked) DEPRECATED_MSG_ATTRIBUTE("Renamed to `mock`");
+
 /** Clear all data inside mock. */
 + (void)resetMockedUserDefaults NS_SWIFT_NAME(resetMock());
 

diff --git a/Tests/MockUserDefaultsSwiftTests/MockUserDefaultsSwiftTests.swift b/Tests/MockUserDefaultsSwiftTests/MockUserDefaultsSwiftTests.swift
@@ -173,6 +173,13 @@ class MockUserDefaultsSwiftTests: XCTestCase {
         XCTAssertFalse(userDefaults.synchronize())
         // XCTAssertTrue(UserDefaults.standard.synchronize())
     }
+
+    @available(*, deprecated, message: "Drop when `mocked` is removed")
+    func testDeprecated() {
+        let replaced = UserDefaults.mock
+        let deprecated = UserDefaults.mocked
+        XCTAssertEqual(replaced, deprecated)
+    }
 }
 
 private func XCTAssertEqualWithoutXCTKeys(_ a: [String: Any], _ b: [String: Any], file: StaticString = #file, line: UInt = #line) {