Rename Defaults.clear to Defaults.removeAll

sindresorhus · Sep 11, 2019 · 27c9997 · 27c9997
1 parent 90ac6f8
commit 27c9997
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 11 deletions.
diff --git a/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata b/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
diff --git a/Package.swift b/Package.swift
@@ -1,4 +1,4 @@
-// swift-tools-version:5.0
+// swift-tools-version:5.1
 import PackageDescription
 
 let package = Package(

diff --git a/Sources/Defaults/Defaults.swift b/Sources/Defaults/Defaults.swift
@@ -161,7 +161,7 @@ public final class Defaults {
 	/**
 	Remove all entries from the `UserDefaults` suite.
 	*/
-	public static func clear(suite: UserDefaults = .standard) {
+	public static func removeAll(suite: UserDefaults = .standard) {
 		for key in suite.dictionaryRepresentation().keys {
 			suite.removeObject(forKey: key)
 		}

diff --git a/Tests/DefaultsTests/DefaultsTests.swift b/Tests/DefaultsTests/DefaultsTests.swift
@@ -24,12 +24,12 @@ extension Defaults.Keys {
 final class DefaultsTests: XCTestCase {
 	override func setUp() {
 		super.setUp()
-		Defaults.clear()
+		Defaults.removeAll()
 	}
 
 	override func tearDown() {
 		super.setUp()
-		Defaults.clear()
+		Defaults.removeAll()
 	}
 
 	func testKey() {
@@ -103,12 +103,16 @@ final class DefaultsTests: XCTestCase {
 		XCTAssertEqual(Defaults[.date], newDate)
 	}
 
-	func testClear() {
-		let key = Defaults.Key<Bool>("clear", default: false)
+	func testRemoveAll() {
+		let key = Defaults.Key<Bool>("removeAll", default: false)
+		let key2 = Defaults.Key<Bool>("removeAll2", default: false)
 		Defaults[key] = true
+		Defaults[key2] = true
 		XCTAssertTrue(Defaults[key])
-		Defaults.clear()
+		XCTAssertTrue(Defaults[key2])
+		Defaults.removeAll()
 		XCTAssertFalse(Defaults[key])
+		XCTAssertFalse(Defaults[key2])
 	}
 
 	func testCustomSuite() {
@@ -119,7 +123,7 @@ final class DefaultsTests: XCTestCase {
 		Defaults[key] = true
 		XCTAssertTrue(customSuite[key])
 		XCTAssertTrue(Defaults[key])
-		Defaults.clear(suite: customSuite)
+		Defaults.removeAll(suite: customSuite)
 	}
 
 	func testObserveKey() {

diff --git a/readme.md b/readme.md
@@ -274,15 +274,15 @@ Observe changes to a key or an optional key.
 
 By default, it will also trigger an initial event on creation. This can be useful for setting default values on controls. You can override this behavior with the `options` argument.
 
-#### `Defaults.clear`
+#### `Defaults.removeAll`
 
 ```swift
-Defaults.clear(suite: UserDefaults = .standard)
+Defaults.removeAll(suite: UserDefaults = .standard)
 ```
 
 Type: `func`
 
-Clear the user defaults.
+Remove all entries from the `UserDefaults` suite.
 
 
 ## FAQ