Replace implementation of WeakSet with WeakSequence

antranapp · antranapp · commit 0322454aab97 · 2022-11-13T13:40:52.000+07:00
diff --git a/LeakDetectorDemo/Leak/Coordinator/BaseCoordinator.swift b/LeakDetectorDemo/Leak/Coordinator/BaseCoordinator.swift
@@ -11,7 +11,7 @@ open class BaseCoordinator<T>: UINavigationController, Coordinator {
     public let dependency: T
     private var cancellables = Set<AnyCancellable>()
 
-    private var trackingViewControllers = WeakSet<UIViewController>()
+    private var trackingViewControllers = WeakSequenceOf<AnyObject>()
 
     public init(with dependency: T) {
         self.dependency = dependency
diff --git a/LeakDetectorDemo/Leak/Delegate/DelegateRootViewController.swift b/LeakDetectorDemo/Leak/Delegate/DelegateRootViewController.swift
@@ -2,10 +2,10 @@
 // Copyright © 2021 An Tran. All rights reserved.
 //
 
+import Combine
 import Foundation
-import UIKit
 import LeakDetectorCombine
-import Combine
+import UIKit
 
 final class DelegateRootViewController: LeakDetectableTableViewController {
     
diff --git a/LeakDetectorDemo/Leak/LeakDetectorRxSwift/LeakDetectorRxSwiftChildViewControllers.swift b/LeakDetectorDemo/Leak/LeakDetectorRxSwift/LeakDetectorRxSwiftChildViewControllers.swift
@@ -26,7 +26,6 @@ final class LeakDetectorRxSwiftViewController1: ChildViewController {
     }
 }
 
-
 // MARK: - No Leak
 
 final class NoLeakLeakDetectorRxSwiftViewController1: ChildViewController {
diff --git a/LeakDetectorDemo/Leak/LeakDetectorRxSwift/LeakDetectorRxSwiftMultiVCRootViewController.swift b/LeakDetectorDemo/Leak/LeakDetectorRxSwift/LeakDetectorRxSwiftMultiVCRootViewController.swift
@@ -3,13 +3,13 @@
 //
 
 import Foundation
-import UIKit
 import LeakDetectorCore
 import LeakDetectorRxSwift
+import UIKit
 
 final class LeakDetectorRxSwiftMultiVCRootViewController: UITableViewController {
     
-    private var viewControllers = WeakSet<UIViewController>()
+    private var viewControllers = WeakSequenceOf<UIViewController>()
     private var leakSubscription: LeakDetectionHandle?
 
     private enum Scenarios {
@@ -35,9 +35,7 @@ final class LeakDetectorRxSwiftMultiVCRootViewController: UITableViewController
     }
 
     override func viewDidAppear(_ animated: Bool) {
-        if !viewControllers.isEmpty {
-            executeLeakDetector()
-        }
+        executeLeakDetector()
     }
 
     override func numberOfSections(in tableView: UITableView) -> Int {
diff --git a/LeakDetectorDemo/Leak/RxSwift/RxViewController.swift b/LeakDetectorDemo/Leak/RxSwift/RxViewController.swift
@@ -79,9 +79,7 @@ class NoLeakRxSwiftViewController1: ChildViewController {
 class NoLeakRxSwiftViewController2: ChildViewController {
     
     private let disposeBag = DisposeBag()
-    private lazy var button = {
-        UIButton()
-    }()
+    private lazy var button = UIButton()
 
     override func viewDidLoad() {
         super.viewDidLoad()
diff --git a/LeakDetectorDemo/Leak/UICollectionView/UICollectionViewControllers.swift b/LeakDetectorDemo/Leak/UICollectionView/UICollectionViewControllers.swift
@@ -1,8 +1,5 @@
 //
-//  UICollectionViewControllers.swift
-//  LeakDetectorDemo
-//
-//  Created by An Tran on 2/11/22.
+// Copyright © 2021 An Tran. All rights reserved.
 //
 
 import Foundation
@@ -69,7 +66,6 @@ class BaseUICollectionViewController: UIViewController {
         return NSCollectionLayoutSection(group: group)
     }
     
-    
     func makeDataSource() -> UICollectionViewDiffableDataSource<Section, Product> {
         let cellRegistration = makeCellRegistration()
         
@@ -95,7 +91,6 @@ class BaseUICollectionViewController: UIViewController {
     }
 }
 
-
 @available(iOS 14.0, *)
 final class LeakUICollectionViewController: BaseUICollectionViewController {
     
diff --git a/LeakDetectorDemo/Leak/UICollectionView/UICollectionViewRootViewController.swift b/LeakDetectorDemo/Leak/UICollectionView/UICollectionViewRootViewController.swift
@@ -1,14 +1,11 @@
 //
-//  UICollectionViewRootViewController.swift
-//  LeakDetectorDemo
-//
-//  Created by An Tran on 2/11/22.
+// Copyright © 2021 An Tran. All rights reserved.
 //
 
-import Foundation
-import UIKit
 import Combine
+import Foundation
 import LeakDetectorCombine
+import UIKit
 
 final class UICollectionViewRootViewController: LeakDetectableTableViewController {
     private enum Scenarios {
diff --git a/LeakDetectorDemo/Utils/LeakDetectableRxSwiftTableViewController.swift b/LeakDetectorDemo/Utils/LeakDetectableRxSwiftTableViewController.swift
@@ -1,14 +1,11 @@
 //
-//  LeakDetectableRxSwiftTableViewController.swift
-//  LeakDetectorDemo
-//
-//  Created by Binh An Tran on 1/9/21.
+// Copyright © 2021 An Tran. All rights reserved.
 //
 
 import Foundation
 import LeakDetectorRxSwift
-import UIKit
 import RxSwift
+import UIKit
 
 class LeakDetectableRxSwiftTableViewController: UITableViewController {
 
@@ -43,4 +40,3 @@ class LeakDetectableRxSwiftTableViewController: UITableViewController {
         }
     }
 }
-
diff --git a/LeakDetectorDemo/Utils/UIViewController+Alert.swift b/LeakDetectorDemo/Utils/UIViewController+Alert.swift
@@ -1,8 +1,5 @@
 //
-//  UIViewController+Alert.swift
-//  LeakDetectorDemo
-//
-//  Created by An Tran on 2/11/22.
+// Copyright © 2021 An Tran. All rights reserved.
 //
 
 import Foundation
diff --git a/LeakDetectorDemoUITests/LeakTests.swift b/LeakDetectorDemoUITests/LeakTests.swift
@@ -112,7 +112,6 @@ final class LeakTests: XCTestCase {
         )
     }
 
-
     private func assert(testCase: String, subcase: String? = nil, exitAction: () -> Void, timeout: TimeInterval = .viewDisappearExpectation + LeakTests.bufferInternal) {
         app.tables.firstMatch.scrollTo(element: app.tables.staticTexts[testCase])
         app.tables.staticTexts[testCase].tap()
diff --git a/LeakDetectorDemoUITests/XCUIElement+Extensions.swift b/LeakDetectorDemoUITests/XCUIElement+Extensions.swift
@@ -1,8 +1,5 @@
 //
-//  XCUIElement+Extensions.swift
-//  LeakDetectorDemoUITests
-//
-//  Created by An Tran on 2/11/22.
+// Copyright © 2021 An Tran. All rights reserved.
 //
 
 import Foundation
diff --git a/Package.swift b/Package.swift
@@ -40,7 +40,7 @@ let package = Package(
                 "LeakDetectorCore",
             ]
         ),
-
+        
         .target(
             name: "LeakDetectorRxSwift",
             dependencies: [
@@ -49,7 +49,7 @@ let package = Package(
                 .product(name: "RxCocoa", package: "RxSwift"),
             ]
         ),
-
+        
         .testTarget(
             name: "LeakDetectorTests",
             dependencies: [
diff --git a/Sources/LeakDetectorCombine/LeakDetector.swift b/Sources/LeakDetectorCombine/LeakDetector.swift
@@ -33,7 +33,7 @@ public class LeakDetector {
     
     // MARK: - Private Interface
     
-    private(set) var trackingObjects = WeakSet<AnyObject>()
+    private(set) var trackingObjects = WeakSequenceOf<AnyObject>()
     @Published var expectationCount: Int = 0 {
         didSet {
             if expectationCount == 0 {
@@ -50,11 +50,11 @@ public class LeakDetector {
     /// - parameter objects: The weak set of objects to track for deallocation.
     /// - parameter inTime: The time the given object is expected to be deallocated within.
     /// - returns: `Publishers.First` that outputs after delay.
-    public func expectDeallocate<Element>(
-        objects: WeakSet<Element>,
+    public func expectDeallocate<T>(
+        objects: WeakSequenceOf<T>,
         inTime time: TimeInterval = .deallocationExpectation
     ) -> AnyPublisher<Void, Never> {
-        guard !objects.isEmpty else { return Empty().eraseToAnyPublisher() }
+        guard !objects.asArray.isEmpty else { return Empty().eraseToAnyPublisher() }
         return Timer
             .execute(withDelay: time)
             .receive(on: DispatchQueue.main)
@@ -64,7 +64,7 @@ public class LeakDetector {
                     self.expectationCount += 1
                 },
                 receiveOutput: {
-                    if !objects.isEmpty {
+                    if !objects.asArray.isEmpty {
                         let message = "\(objects) have leaked. Objects are expected to be deallocated at this time: \(self.trackingObjects)"
                         if self.isEnabled {
                             assertionFailure(message)
@@ -107,7 +107,7 @@ public class LeakDetector {
                 },
                 receiveOutput: { [weak object] in
                     if let object = object {
-                        let message = "<\(memoryAddressDescription(for: object))> has leaked. Objects are expected to be deallocated at this time: \(self.trackingObjects)"
+                        let message = "<\(object)> has leaked. Objects are expected to be deallocated at this time: \(self.trackingObjects)"
                         
                         if self.isEnabled {
                             assertionFailure(message)
@@ -138,12 +138,12 @@ public class LeakDetector {
     
     public var isLeaked = CurrentValueSubject<String?, Never>(nil)
     
-#if DEBUG
+    #if DEBUG
     /// Reset the state of Leak Detector, internal for UI test only.
     func reset() {
         trackingObjects.removeAll()
         expectationCount = 0
         isLeaked.send(nil)
     }
-#endif
+    #endif
 }
diff --git a/Sources/LeakDetectorCombine/Timer.swift b/Sources/LeakDetectorCombine/Timer.swift
@@ -1,17 +1,5 @@
 //
-//  Copyright (c) 2021. Adam Share
-//
-//  Licensed under the Apache License, Version 2.0 (the "License");
-//  you may not use this file except in compliance with the License.
-//  You may obtain a copy of the License at
-//
-//  http://www.apache.org/licenses/LICENSE-2.0
-//
-//  Unless required by applicable law or agreed to in writing, software
-//  distributed under the License is distributed on an "AS IS" BASIS,
-//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-//  See the License for the specific language governing permissions and
-//  limitations under the License.
+// Copyright © 2021 An Tran. All rights reserved.
 //
 
 #if canImport(Combine)
diff --git a/Sources/LeakDetectorCore/LeakDetectorStatus.swift b/Sources/LeakDetectorCore/LeakDetectorStatus.swift
@@ -1,8 +1,5 @@
 //
-//  File.swift
-//  
-//
-//  Created by Binh An Tran on 1/9/21.
+// Copyright © 2021 An Tran. All rights reserved.
 //
 
 import Foundation
diff --git a/Sources/LeakDetectorCore/WeakSequence.swift b/Sources/LeakDetectorCore/WeakSequence.swift
diff --git a/Sources/LeakDetectorCore/WeakSet.swift b/Sources/LeakDetectorCore/WeakSet.swift
diff --git a/Sources/LeakDetectorRxSwift/LeakDetector+UIViewController.swift b/Sources/LeakDetectorRxSwift/LeakDetector+UIViewController.swift
diff --git a/Sources/LeakDetectorRxSwift/LeakDetector.swift b/Sources/LeakDetectorRxSwift/LeakDetector.swift
diff --git a/Tests/LeakDetectorTests/LeakDetectorRxSwiftTests.swift b/Tests/LeakDetectorTests/LeakDetectorRxSwiftTests.swift
diff --git a/Tests/LeakDetectorTests/WeakSequenceTests.swift b/Tests/LeakDetectorTests/WeakSequenceTests.swift

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,6 @@ final class LeakDetectorRxSwiftViewController1: ChildViewController {`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
`29`		`-`
`30`	`29`	`// MARK: - No Leak`
`31`	`30`
`32`	`31`	`final class NoLeakLeakDetectorRxSwiftViewController1: ChildViewController {`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,5 @@`
`1`	`1`	`//`
`2`		`-// UICollectionViewControllers.swift`
`3`		`-// LeakDetectorDemo`
`4`		`-//`
`5`		`-// Created by An Tran on 2/11/22.`
	`2`	`+// Copyright © 2021 An Tran. All rights reserved.`
`6`	`3`	`//`
`7`	`4`
`8`	`5`	`import Foundation`
`@@ -69,7 +66,6 @@ class BaseUICollectionViewController: UIViewController {`
`69`	`66`	`return NSCollectionLayoutSection(group: group)`
`70`	`67`	`}`
`71`	`68`
`72`		`-`
`73`	`69`	`func makeDataSource() -> UICollectionViewDiffableDataSource<Section, Product> {`
`74`	`70`	`let cellRegistration = makeCellRegistration()`
`75`	`71`
`@@ -95,7 +91,6 @@ class BaseUICollectionViewController: UIViewController {`
`95`	`91`	`}`
`96`	`92`	`}`
`97`	`93`
`98`		`-`
`99`	`94`	`@available(iOS 14.0, *)`
`100`	`95`	`final class LeakUICollectionViewController: BaseUICollectionViewController {`
`101`	`96`
Original file line number	Diff line number	Diff line change
`@@ -1,14 +1,11 @@`
`1`	`1`	`//`
`2`		`-// LeakDetectableRxSwiftTableViewController.swift`
`3`		`-// LeakDetectorDemo`
`4`		`-//`
`5`		`-// Created by Binh An Tran on 1/9/21.`
	`2`	`+// Copyright © 2021 An Tran. All rights reserved.`
`6`	`3`	`//`
`7`	`4`
`8`	`5`	`import Foundation`
`9`	`6`	`import LeakDetectorRxSwift`
`10`		`-import UIKit`
`11`	`7`	`import RxSwift`
	`8`	`+import UIKit`
`12`	`9`
`13`	`10`	`class LeakDetectableRxSwiftTableViewController: UITableViewController {`
`14`	`11`
`@@ -43,4 +40,3 @@ class LeakDetectableRxSwiftTableViewController: UITableViewController {`
`43`	`40`	`}`
`44`	`41`	`}`
`45`	`42`	`}`
`46`		`-`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,6 @@ final class LeakTests: XCTestCase {`
`112`	`112`	`)`
`113`	`113`	`}`
`114`	`114`
`115`		`-`
`116`	`115`	`private func assert(testCase: String, subcase: String? = nil, exitAction: () -> Void, timeout: TimeInterval = .viewDisappearExpectation + LeakTests.bufferInternal) {`
`117`	`116`	`app.tables.firstMatch.scrollTo(element: app.tables.staticTexts[testCase])`
`118`	`117`	`app.tables.staticTexts[testCase].tap()`