Updated documentation. Reformatted the code.

ekazaev · Dec 21, 2022 · 7ef173d · 7ef173d
1 parent fbf1718
commit 7ef173d
Show file tree

Hide file tree

Showing 393 changed files with 2,505 additions and 2,257 deletions.
diff --git a/Example/Podfile.lock b/Example/Podfile.lock
@@ -1,5 +1,5 @@
 PODS:
-  - RouteComposer (2.10.0)
+  - RouteComposer (2.10.2)
   - SwiftFormat/CLI (0.43.5)
 
 DEPENDENCIES:
@@ -15,7 +15,7 @@ EXTERNAL SOURCES:
     :path: "../"
 
 SPEC CHECKSUMS:
-  RouteComposer: 124c6765ec7013509f7d3d9b58854a77d9d61a65
+  RouteComposer: 37f0a7dfe42fd1200a857cd6bf8582f0b6113e4e
   SwiftFormat: 352ea545e3e13cfd7a449e621c1f3c2e244d4906
 
 PODFILE CHECKSUM: fc9566202a2f646e3cbb198c10cf157d9dd60f4f

diff --git a/Example/Pods/Local Podspecs/RouteComposer.podspec.json b/Example/Pods/Local Podspecs/RouteComposer.podspec.json
diff --git a/Example/Pods/Manifest.lock b/Example/Pods/Manifest.lock
diff --git a/Example/Pods/Pods.xcodeproj/project.pbxproj b/Example/Pods/Pods.xcodeproj/project.pbxproj
diff --git a/Example/Pods/Target Support Files/RouteComposer/RouteComposer-Info.plist b/Example/Pods/Target Support Files/RouteComposer/RouteComposer-Info.plist
diff --git a/Example/RouteComposer/Configuration/AnalyticsRouterDecorator.swift b/Example/RouteComposer/Configuration/AnalyticsRouterDecorator.swift
@@ -22,10 +22,10 @@ struct AnalyticsRouterDecorator: Router {
         self.router = router
     }
 
-    func navigate<ViewController: UIViewController, Context>(to step: DestinationStep<ViewController, Context>,
-                                                             with context: Context,
-                                                             animated: Bool = true,
-                                                             completion: ((RoutingResult) -> Void)? = nil) throws {
+    func navigate<Context>(to step: DestinationStep<some UIViewController, Context>,
+                           with context: Context,
+                           animated: Bool = true,
+                           completion: ((RoutingResult) -> Void)? = nil) throws {
         var sourceScreen: ExampleScreenTypes?
 
         if let topmostViewController = UIApplication.shared.windows.first?.topmostViewController,
@@ -36,7 +36,7 @@ struct AnalyticsRouterDecorator: Router {
         }
 
         try router.navigate(to: step, with: context, animated: animated) { result in
-            if let sourceScreen = sourceScreen {
+            if let sourceScreen {
                 print("Source: \(sourceScreen)")
                 if let topmostViewController = UIApplication.shared.windows.first?.topmostViewController,
                    let analyticsViewController = try? UIViewController.findViewController(in: topmostViewController,

diff --git a/Example/RouteComposer/Configuration/BlurredBackgroundTransitionAnimator.swift b/Example/RouteComposer/Configuration/BlurredBackgroundTransitionAnimator.swift
@@ -29,7 +29,7 @@ class BlurredBackgroundTransitionAnimator: NSObject, UIViewControllerAnimatedTra
     private func blurEffectView(_ style: UIBlurEffect.Style = .light, frame: CGRect? = nil, backgroundColor: UIColor?) -> UIVisualEffectView {
         let blurEffect = UIBlurEffect(style: style)
         let blurEffectView = UIVisualEffectView(effect: blurEffect)
-        if let frame = frame {
+        if let frame {
             blurEffectView.frame = frame
         }
         blurEffectView.backgroundColor = backgroundColor

diff --git a/Example/RouteComposer/Configuration/FailingRouter.swift b/Example/RouteComposer/Configuration/FailingRouter.swift
@@ -36,10 +36,10 @@ struct FailingRouter<R>: Router where R: Router {
         self.failOnError = failOnError
     }
 
-    func navigate<ViewController: UIViewController, Context>(to step: DestinationStep<ViewController, Context>,
-                                                             with context: Context,
-                                                             animated: Bool,
-                                                             completion: ((RoutingResult) -> Void)?) throws {
+    func navigate<Context>(to step: DestinationStep<some UIViewController, Context>,
+                           with context: Context,
+                           animated: Bool,
+                           completion: ((RoutingResult) -> Void)?) throws {
         do {
             try router.navigate(to: step, with: context, animated: animated, completion: { result in
                 if let error = try? result.getError() {

diff --git a/Example/RouteComposer/Extensions/Router+Destination.swift b/Example/RouteComposer/Extensions/Router+Destination.swift
@@ -17,7 +17,7 @@ import UIKit
 /// Simple extension to support `Destination` instance directly by the `Router`.
 extension Router {
 
-    func navigate<ViewController: UIViewController, Context>(to step: DestinationStep<ViewController, Context>, with context: Context) throws {
+    func navigate<Context>(to step: DestinationStep<some UIViewController, Context>, with context: Context) throws {
         try navigate(to: step, with: context, animated: true, completion: nil)
     }
 

diff --git a/...Libraries/ContainerViewController/ContainerViewController/CustomContainerController.swift b/...Libraries/ContainerViewController/ContainerViewController/CustomContainerController.swift
@@ -46,7 +46,7 @@ public final class CustomContainerController: UIViewController {
         currentViewController?.view.removeFromSuperview()
         currentViewController?.didMove(toParent: nil)
 
-        guard let rootViewController = rootViewController else {
+        guard let rootViewController else {
             return
         }
 

diff --git a/.../Libraries/ImageDetailsController/ImageDetailsController/ImageDetailsViewController.swift b/.../Libraries/ImageDetailsController/ImageDetailsController/ImageDetailsViewController.swift
@@ -33,7 +33,7 @@ public final class ImageDetailsViewController: UIViewController {
     }
 
     private func reloadData() {
-        guard isViewLoaded, let imageID = imageID else {
+        guard isViewLoaded, let imageID else {
             return
         }
         view.accessibilityIdentifier = "image\(imageID)ViewController"

diff --git a/Example/RouteComposer/View Controllers/Cities/CitiesTableViewController.swift b/Example/RouteComposer/View Controllers/Cities/CitiesTableViewController.swift
@@ -19,7 +19,7 @@ class CityTableContextTask: ContextTask {
     // `CitiesTableViewController` can perfectly work with the `Context` object of type `Int?`, but to demonstrate the possibility of context conversion,
     // we say that the actual context is `String?`. But it is done for demonstration and testing purposes only.
     func perform(on viewController: CitiesTableViewController, with cityIdAsString: String?) throws {
-        guard let cityIdAsString = cityIdAsString else {
+        guard let cityIdAsString else {
             viewController.cityId = nil
             return
         }
@@ -39,7 +39,7 @@ class CitiesTableViewController: UITableViewController, ExampleAnalyticsSupport
 
     var cityId: Int? {
         didSet {
-            guard let cityId = cityId else {
+            guard let cityId else {
                 return
             }
             let indexPath = IndexPath(row: cityId - 1, section: 0)

diff --git a/Example/RouteComposer/View Controllers/Cities/CityDetailViewController.swift b/Example/RouteComposer/View Controllers/Cities/CityDetailViewController.swift
@@ -46,7 +46,7 @@ class CityDetailViewController: UIViewController, ExampleAnalyticsSupport {
         title = "\(city.city)"
 
         detailsTextView.text = city.city + "\n\n" + city.description
-        if let cityId = cityId {
+        if let cityId {
             view.accessibilityIdentifier = "cityDetailsViewController+\(cityId)"
         } else {
             view.accessibilityIdentifier = "cityDetailsViewController"

diff --git a/Example/RouteComposer/View Controllers/ColorViewController.swift b/Example/RouteComposer/View Controllers/ColorViewController.swift
@@ -58,7 +58,7 @@ class ColorViewController: UIViewController, DismissibleWithRuntimeStorage, Exam
 
     var colorHex: ColorDisplayModel? {
         didSet {
-            if let colorHex = colorHex, isViewLoaded {
+            if let colorHex, isViewLoaded {
                 self.view.backgroundColor = UIColor(hexString: colorHex)
             }
         }
@@ -68,7 +68,7 @@ class ColorViewController: UIViewController, DismissibleWithRuntimeStorage, Exam
         super.viewDidLoad()
         view.accessibilityIdentifier = "colorViewController"
         title = "Color"
-        if let colorHex = colorHex {
+        if let colorHex {
             view.backgroundColor = UIColor(hexString: colorHex)
         } else {
             view.backgroundColor = UIColor.white

diff --git a/...Controllers/No Library Dependency/Configuration With Library/CustomContainerFactory.swift b/...Controllers/No Library Dependency/Configuration With Library/CustomContainerFactory.swift
@@ -89,7 +89,7 @@ struct CustomContainerControllerAdapter: ConcreteContainerAdapter {
     }
 
     public func makeVisible(_ viewController: UIViewController, animated: Bool, completion: @escaping (_: RoutingResult) -> Void) {
-        guard let customContainerController = customContainerController else {
+        guard let customContainerController else {
             completion(.failure(RoutingError.compositionFailed(.init("CustomContainerController has been deallocated"))))
             return
         }
@@ -101,7 +101,7 @@ struct CustomContainerControllerAdapter: ConcreteContainerAdapter {
     }
 
     public func setContainedViewControllers(_ containedViewControllers: [UIViewController], animated: Bool, completion: @escaping (_: RoutingResult) -> Void) {
-        guard let customContainerController = customContainerController else {
+        guard let customContainerController else {
             completion(.failure(RoutingError.compositionFailed(.init("CustomContainerController has been deallocated"))))
             return
         }

diff --git a/Example/RouteComposer/View Controllers/Product/ProductViewController.swift b/Example/RouteComposer/View Controllers/Product/ProductViewController.swift
@@ -69,7 +69,7 @@ class ProductViewController: UIViewController, ExampleAnalyticsSupport, ContextA
         }
 
         productIdLabel.text = productId
-        if let productId = productId {
+        if let productId {
             view.accessibilityIdentifier = "productViewController+\(productId)"
             title = "Product \(productId)"
         } else {
@@ -95,7 +95,7 @@ class ProductViewController: UIViewController, ExampleAnalyticsSupport, ContextA
     }
 
     @IBAction func goToProductFromCircleTapped() {
-        guard let productId = productId,
+        guard let productId,
               var productIdAsInt = Int(productId) else {
             return
         }

diff --git a/Example/Tests/ExtrasTest.swift b/Example/Tests/ExtrasTest.swift
@@ -113,10 +113,10 @@ class ExtrasTest: XCTestCase {
 
     func testSingleNavigationRouterThrowingException() {
         class FaultyTestRouter: Router {
-            func navigate<ViewController: UIViewController, Context>(to step: DestinationStep<ViewController, Context>,
-                                                                     with context: Context,
-                                                                     animated: Bool,
-                                                                     completion: ((RoutingResult) -> Void)?) throws {
+            func navigate<Context>(to step: DestinationStep<some UIViewController, Context>,
+                                   with context: Context,
+                                   animated: Bool,
+                                   completion: ((RoutingResult) -> Void)?) throws {
                 throw RoutingError.generic(.init("Test"))
             }
         }
@@ -257,21 +257,21 @@ class ExtrasTest: XCTestCase {
 
     func testRouterNavigationToDestination() {
         class TestRouter: Router {
-            func navigate<ViewController: UIViewController, Context>(to step: DestinationStep<ViewController, Context>,
-                                                                     with context: Context,
-                                                                     animated: Bool,
-                                                                     completion: ((RoutingResult) -> Void)?) throws {
+            func navigate<Context>(to step: DestinationStep<some UIViewController, Context>,
+                                   with context: Context,
+                                   animated: Bool,
+                                   completion: ((RoutingResult) -> Void)?) throws {
                 XCTAssertTrue(animated)
                 XCTAssertNotNil(completion)
                 completion?(.success)
             }
         }
 
         class FaultyTestRouter: Router {
-            func navigate<ViewController: UIViewController, Context>(to step: DestinationStep<ViewController, Context>,
-                                                                     with context: Context,
-                                                                     animated: Bool,
-                                                                     completion: ((RoutingResult) -> Void)?) throws {
+            func navigate<Context>(to step: DestinationStep<some UIViewController, Context>,
+                                   with context: Context,
+                                   animated: Bool,
+                                   completion: ((RoutingResult) -> Void)?) throws {
                 XCTAssertFalse(animated)
                 XCTAssertNotNil(completion)
                 throw RoutingError.generic(.init("Test"))

diff --git a/RouteComposer.podspec b/RouteComposer.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'RouteComposer'
-  s.version          = '2.10.1'
+  s.version          = '2.10.2'
   s.summary          = 'Protocol oriented library that helps to handle view controllers composition, navigation and deep linking tasks.'
   s.swift_version    = '5.7'
 

diff --git a/RouteComposer/Classes/Actions/UITabBarController+Action.swift b/RouteComposer/Classes/Actions/UITabBarController+Action.swift
@@ -96,7 +96,7 @@ public enum TabBarControllerActions {
 
         private func setup(viewController: UIViewController,
                            at childViewControllers: inout [UIViewController], tabIndex: Int?) {
-            if let tabIndex = tabIndex, tabIndex < childViewControllers.count {
+            if let tabIndex, tabIndex < childViewControllers.count {
                 if replacing {
                     childViewControllers[tabIndex] = viewController
                 } else {

diff --git a/RouteComposer/Classes/Actions/UIViewController+Action.swift b/RouteComposer/Classes/Actions/UIViewController+Action.swift
@@ -161,24 +161,24 @@ public enum ViewControllerActions {
                         "already presenting a view controller."))))
                 return
             }
-            if let presentationStyle = presentationStyle {
+            if let presentationStyle {
                 viewController.modalPresentationStyle = presentationStyle
             }
-            if let transitionStyle = transitionStyle {
+            if let transitionStyle {
                 viewController.modalTransitionStyle = transitionStyle
             }
-            if let transitioningDelegate = transitioningDelegate {
+            if let transitioningDelegate {
                 viewController.transitioningDelegate = transitioningDelegate
             }
-            if let preferredContentSize = preferredContentSize {
+            if let preferredContentSize {
                 viewController.preferredContentSize = preferredContentSize
             }
             if let popoverPresentationController = viewController.popoverPresentationController,
-               let popoverControllerConfigurationBlock = popoverControllerConfigurationBlock {
+               let popoverControllerConfigurationBlock {
                 popoverControllerConfigurationBlock(popoverPresentationController)
             }
             if #available(iOS 13, *),
-               let isModalInPresentation = isModalInPresentation {
+               let isModalInPresentation {
                 viewController.isModalInPresentation = isModalInPresentation
             }
 
@@ -231,7 +231,7 @@ public enum ViewControllerActions {
                 return
             }
 
-            guard animated, let animationOptions = animationOptions, duration > 0 else {
+            guard animated, let animationOptions, duration > 0 else {
                 window.rootViewController = viewController
                 window.makeKeyAndVisible()
                 completion(.success)

diff --git a/RouteComposer/Classes/Adapters/NavigationControllerAdapter.swift b/RouteComposer/Classes/Adapters/NavigationControllerAdapter.swift
@@ -38,7 +38,7 @@ public struct NavigationControllerAdapter<VC: UINavigationController>: ConcreteC
     }
 
     public func makeVisible(_ viewController: UIViewController, animated: Bool, completion: @escaping (_: RoutingResult) -> Void) {
-        guard let navigationController = navigationController else {
+        guard let navigationController else {
             completion(.failure(RoutingError.compositionFailed(.init("\(String(describing: VC.self)) has been deallocated"))))
             return
         }
@@ -67,7 +67,7 @@ public struct NavigationControllerAdapter<VC: UINavigationController>: ConcreteC
     }
 
     public func setContainedViewControllers(_ containedViewControllers: [UIViewController], animated: Bool, completion: @escaping (_: RoutingResult) -> Void) {
-        guard let navigationController = navigationController else {
+        guard let navigationController else {
             completion(.failure(RoutingError.compositionFailed(.init("\(String(describing: VC.self)) has been deallocated"))))
             return
         }

diff --git a/RouteComposer/Classes/Adapters/SplitControllerAdapter.swift b/RouteComposer/Classes/Adapters/SplitControllerAdapter.swift
@@ -60,7 +60,7 @@ public struct SplitControllerAdapter<VC: UISplitViewController>: ConcreteContain
     /// **Quote:** When designing your split view interface, it is best to install primary and secondary view controllers that do not change.
     /// A common technique is to install navigation controllers in both positions and then push and pop new content as needed.
     public func setContainedViewControllers(_ containedViewControllers: [UIViewController], animated: Bool, completion: @escaping (_: RoutingResult) -> Void) {
-        guard let splitViewController = splitViewController else {
+        guard let splitViewController else {
             completion(.failure(RoutingError.compositionFailed(.init("\(String(describing: VC.self)) has been deallocated"))))
             return
         }

diff --git a/RouteComposer/Classes/Adapters/TabBarControllerAdapter.swift b/RouteComposer/Classes/Adapters/TabBarControllerAdapter.swift
@@ -41,7 +41,7 @@ public struct TabBarControllerAdapter<VC: UITabBarController>: ConcreteContainer
     }
 
     public func makeVisible(_ viewController: UIViewController, animated: Bool, completion: @escaping (_: RoutingResult) -> Void) {
-        guard let tabBarController = tabBarController else {
+        guard let tabBarController else {
             completion(.failure(RoutingError.compositionFailed(.init("\(String(describing: VC.self)) has been deallocated"))))
             return
         }
@@ -59,7 +59,7 @@ public struct TabBarControllerAdapter<VC: UITabBarController>: ConcreteContainer
     }
 
     public func setContainedViewControllers(_ containedViewControllers: [UIViewController], animated: Bool, completion: @escaping (_: RoutingResult) -> Void) {
-        guard let tabBarController = tabBarController else {
+        guard let tabBarController else {
             completion(.failure(RoutingError.compositionFailed(.init("\(String(describing: VC.self)) has been deallocated"))))
             return
         }

diff --git a/RouteComposer/Classes/Assemblies/Helpers/ActionConnectingAssembly.swift b/RouteComposer/Classes/Assemblies/Helpers/ActionConnectingAssembly.swift
@@ -33,7 +33,7 @@ public struct ActionConnectingAssembly<VC: UIViewController, C> {
     ///
     /// - Parameter action: `Action` instance to be used with a step.
     /// - Returns: `ChainAssembly` to continue building the chain.
-    public func using<A: Action>(_ action: A) -> StepChainAssembly<VC, C> {
+    public func using(_ action: some Action) -> StepChainAssembly<VC, C> {
         var previousSteps = previousSteps
         if let routingStep = stepToFullFill.routingStep(with: action) {
             previousSteps.append(routingStep)

diff --git a/RouteComposer/Classes/Assemblies/Helpers/ActionToStepIntegrator.swift b/RouteComposer/Classes/Assemblies/Helpers/ActionToStepIntegrator.swift
@@ -18,12 +18,12 @@ import UIKit
 public class IntermediateDestinationStep {
 
     // Hides action integration from library user.
-    func routingStep<A: Action>(with action: A) -> RoutingStep? {
+    func routingStep(with action: some Action) -> RoutingStep? {
         nil
     }
 
     // Hides action integration from library user.
-    func embeddableRoutingStep<A: ContainerAction>(with action: A) -> RoutingStep? {
+    func embeddableRoutingStep(with action: some ContainerAction) -> RoutingStep? {
         nil
     }