Updated documentation

ekazaev · Apr 11, 2023 · a0245b6 · a0245b6
1 parent c978b85
commit a0245b6
Show file tree

Hide file tree

Showing 325 changed files with 709 additions and 681 deletions.
diff --git a/Example/Podfile.lock b/Example/Podfile.lock
@@ -1,5 +1,5 @@
 PODS:
-  - RouteComposer (2.10.2)
+  - RouteComposer (2.10.3)
   - SwiftFormat/CLI (0.43.5)
 
 DEPENDENCIES:
@@ -15,7 +15,7 @@ EXTERNAL SOURCES:
     :path: "../"
 
 SPEC CHECKSUMS:
-  RouteComposer: 37f0a7dfe42fd1200a857cd6bf8582f0b6113e4e
+  RouteComposer: f185d410da2c67bc90d93fc4618842fe47d92bca
   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/Target Support Files/RouteComposer/RouteComposer-Info.plist b/Example/Pods/Target Support Files/RouteComposer/RouteComposer-Info.plist
diff --git a/Example/RouteComposer/Configuration/ExampleConfiguration.swift b/Example/RouteComposer/Configuration/ExampleConfiguration.swift
@@ -81,9 +81,13 @@ extension ExampleScreenConfiguration {
         StepAssembly(
             finder: ColorViewControllerFinder(),
             factory: ColorViewControllerFactory())
-            .adding(DismissalMethodProvidingContextTask(dismissalBlock: { viewController, context, animated, completion in
+            .adding(DismissalMethodProvidingContextTask<ColorViewController, String>(dismissalBlock: { viewController, context, animated, completion in
                 // Demonstrates ability to provide a dismissal method in the configuration using `DismissalMethodProvidingContextTask`
-                UIViewController.router.commitNavigation(to: GeneralStep.custom(using: PresentingFinder()), with: context, animated: animated, completion: completion)
+                UIViewController.router.commitNavigation(to: GeneralStep.custom(using: PresentingFinder(startingPoint: .custom(viewController))),
+                                                         with: context,
+                                                         animated: animated,
+                                                         completion: completion)
+                // You can just call `viewController.dismiss(animated: true) if needed.`
             }))
             .adding(ExampleGenericContextTask<ColorViewController, String>())
             .using(ExampleNavigationController.push())

diff --git a/Example/RouteComposer/View Controllers/SwiftUIContentView.swift b/Example/RouteComposer/View Controllers/SwiftUIContentView.swift
@@ -37,7 +37,7 @@ struct SwiftUIContentView: View, ContextInstantiatable, ContextChecking, Context
                 Text("Go to Square Tab")
             }).accessibility(identifier: "SwiftUI+\(context)")
         }.onAppear {
-            self.context = self.currentContext
+            context = currentContext
         }
     }
 

diff --git a/Example/Tests/ActionTests.swift b/Example/Tests/ActionTests.swift
@@ -148,7 +148,7 @@ class ActionTests: XCTestCase {
         }
 
         wasInCompletion = false
-        GeneralAction.presentModally(startingFrom: .custom(try testThrow())).perform(with: UIViewController(), on: UIViewController(), animated: true, completion: { result in
+        try GeneralAction.presentModally(startingFrom: .custom(testThrow())).perform(with: UIViewController(), on: UIViewController(), animated: true, completion: { result in
             wasInCompletion = true
             if result.isSuccessful {
                 XCTAssert(false)

diff --git a/Example/Tests/FinderTests.swift b/Example/Tests/FinderTests.swift
@@ -136,7 +136,7 @@ class FinderTest: XCTestCase {
             throw RoutingError.generic(.init("Test Error"))
         }
 
-        XCTAssertNotEqual(DefaultStackIterator.StartingPoint.custom(try throwsException()), DefaultStackIterator.StartingPoint.custom(currentViewController1))
+        XCTAssertNotEqual(try DefaultStackIterator.StartingPoint.custom(throwsException()), DefaultStackIterator.StartingPoint.custom(currentViewController1))
         XCTAssertNotEqual(DefaultStackIterator.StartingPoint.topmost, DefaultStackIterator.StartingPoint.root)
         XCTAssertNotEqual(DefaultStackIterator.StartingPoint.topmost, DefaultStackIterator.StartingPoint.custom(currentViewController))
     }

diff --git a/RouteComposer/Classes/Extra/DispatchQueue+Action.swift b/RouteComposer/Classes/Extra/DispatchQueue+Action.swift
@@ -69,7 +69,7 @@ public struct DispatchQueueWrappedAction<A: Action>: Action {
                 completion(result)
                 return
             }
-            DispatchQueue.main.asyncAfter(deadline: DispatchTime.now() + self.timeInterval) {
+            DispatchQueue.main.asyncAfter(deadline: DispatchTime.now() + timeInterval) {
                 completion(result)
             }
         })
@@ -112,7 +112,7 @@ public struct DispatchQueueWrappedContainerAction<A: ContainerAction>: Container
                 completion(result)
                 return
             }
-            DispatchQueue.main.asyncAfter(deadline: DispatchTime.now() + self.timeInterval) {
+            DispatchQueue.main.asyncAfter(deadline: DispatchTime.now() + timeInterval) {
                 completion(result)
             }
         })

diff --git a/RouteComposer/Classes/Extra/NavigationDelayInterceptor.swift b/RouteComposer/Classes/Extra/NavigationDelayInterceptor.swift
@@ -81,7 +81,7 @@ public struct NavigationDelayingInterceptor<Context>: RoutingInterceptor {
         logger?.log(.info("\(topmostViewController) is changing its state. Navigation has been postponed."))
         let deadline = DispatchTime.now() + .milliseconds(100)
         DispatchQueue.main.asyncAfter(deadline: deadline) {
-            self.perform(with: context, completion: completion)
+            perform(with: context, completion: completion)
         }
     }
 

diff --git a/RouteComposer/Classes/Extra/SingleNavigationRouter.swift b/RouteComposer/Classes/Extra/SingleNavigationRouter.swift
@@ -71,7 +71,7 @@ public struct SingleNavigationRouter<R>: Router where R: Router {
         lock.startNavigation()
         do {
             try router.navigate(to: step, with: context, animated: animated, completion: { success in
-                self.lock.stopNavigation()
+                lock.stopNavigation()
                 completion?(success)
             })
         } catch {

diff --git a/RouteComposer/Classes/Router/DefaultRouter.swift b/RouteComposer/Classes/Router/DefaultRouter.swift
@@ -182,7 +182,7 @@ public struct DefaultRouter: InterceptableRouter, MainThreadChecking {
         // continue navigation process. This operation is async.
         let initialControllerDescription = String(describing: viewController)
         taskStack.performInterceptors { [weak viewController] result in
-            self.assertIfNotMainThread(logger: logger)
+            assertIfNotMainThread(logger: logger)
 
             if case let .failure(error) = result {
                 completion(.failure(error))
@@ -259,7 +259,7 @@ public struct DefaultRouter: InterceptableRouter, MainThreadChecking {
                                                    with: postponedIntegrationHandler,
                                                    nextAction: nextAction,
                                                    animated: animated) { result in
-                        self.assertIfNotMainThread(logger: logger)
+                        assertIfNotMainThread(logger: logger)
                         guard result.isSuccessful else {
                             logger?.log(.info("\(String(describing: factory.factory.action)) has stopped the navigation process " +
                                     "as it was not able to build a view controller into a stack."))

diff --git a/RouteComposer/Classes/Router/Helpers/DefaultStackPresentationHandler.swift b/RouteComposer/Classes/Router/Helpers/DefaultStackPresentationHandler.swift
@@ -41,7 +41,7 @@ public struct DefaultStackPresentationHandler: StackPresentationHandler, MainThr
         if let presentedController = viewController.presentedViewController {
             if !presentedController.isBeingDismissed {
                 viewController.dismiss(animated: animated) {
-                    self.logger?.log(.info("Dismissed all the view controllers presented from \(String(describing: viewController))"))
+                    logger?.log(.info("Dismissed all the view controllers presented from \(String(describing: viewController))"))
                     completion(.success)
                 }
             } else {
@@ -81,7 +81,7 @@ public struct DefaultStackPresentationHandler: StackPresentationHandler, MainThr
                             completion(result)
                             return
                         }
-                        self.logger?.log(.info("Made \(String(describing: viewController)) visible in \(String(describing: container))"))
+                        logger?.log(.info("Made \(String(describing: viewController)) visible in \(String(describing: container))"))
                         makeVisible(viewController: parentViewController, completion: completion)
                     })
                 } else {

diff --git a/RouteComposer/Classes/Router/Multiplexers/InterceptorMultiplexer.swift b/RouteComposer/Classes/Router/Multiplexers/InterceptorMultiplexer.swift
@@ -39,7 +39,7 @@ struct InterceptorMultiplexer: AnyRoutingInterceptor, MainThreadChecking, Custom
         func runInterceptor(interceptor: AnyRoutingInterceptor) {
             assertIfNotMainThread()
             interceptor.perform(with: context) { result in
-                self.assertIfNotMainThread()
+                assertIfNotMainThread()
                 if case .failure = result {
                     completion(result)
                 } else if interceptors.isEmpty {

diff --git a/RouteComposer/Classes/Router/Type Erasure/Boxes/ActionBox.swift b/RouteComposer/Classes/Router/Type Erasure/Boxes/ActionBox.swift
@@ -39,8 +39,8 @@ struct ActionBox<A: Action>: AnyAction, AnyActionBox, CustomStringConvertible, M
                 completion(result)
                 return
             }
-            self.action.perform(with: viewController, on: typedExistingViewController, animated: animated) { result in
-                self.assertIfNotMainThread()
+            action.perform(with: viewController, on: typedExistingViewController, animated: animated) { result in
+                assertIfNotMainThread()
                 completion(result)
             }
         })

diff --git a/RouteComposer/Classes/Router/Type Erasure/Boxes/ContainerActionBox.swift b/RouteComposer/Classes/Router/Type Erasure/Boxes/ContainerActionBox.swift
@@ -35,12 +35,12 @@ struct ContainerActionBox<A: ContainerAction>: AnyAction, AnyActionBox, CustomSt
                         completion(result)
                         return
                     }
-                    self.perform(with: viewController,
-                                 on: existingController,
-                                 with: postponedIntegrationHandler,
-                                 nextAction: nextAction,
-                                 animated: animated,
-                                 completion: completion)
+                    perform(with: viewController,
+                            on: existingController,
+                            with: postponedIntegrationHandler,
+                            nextAction: nextAction,
+                            animated: animated,
+                            completion: completion)
                 })
                 return
             }
@@ -60,16 +60,16 @@ struct ContainerActionBox<A: ContainerAction>: AnyAction, AnyActionBox, CustomSt
                         completion(result)
                         return
                     }
-                    self.embed(viewController: viewController, with: postponedIntegrationHandler, completion: completion)
+                    embed(viewController: viewController, with: postponedIntegrationHandler, completion: completion)
                 })
             } else {
                 postponedIntegrationHandler.purge(animated: animated, completion: { result in
                     guard result.isSuccessful else {
                         completion(result)
                         return
                     }
-                    self.action.perform(with: viewController, on: containerController, animated: animated) { result in
-                        self.assertIfNotMainThread()
+                    action.perform(with: viewController, on: containerController, animated: animated) { result in
+                        assertIfNotMainThread()
                         completion(result)
                     }
                 })

diff --git a/RouteComposer/Classes/Router/Type Erasure/Boxes/RoutingInterceptorBox.swift b/RouteComposer/Classes/Router/Type Erasure/Boxes/RoutingInterceptorBox.swift
@@ -34,7 +34,7 @@ struct RoutingInterceptorBox<RI: RoutingInterceptor>: AnyRoutingInterceptor, Pre
             assertIfNotPrepared()
             assertIfNotMainThread()
             routingInterceptor.perform(with: typedContext) { result in
-                self.assertIfNotMainThread()
+                assertIfNotMainThread()
                 completion(result)
             }
         } catch {

diff --git a/RouteComposer/Classes/SearchOptions.swift b/RouteComposer/Classes/SearchOptions.swift
@@ -71,7 +71,7 @@ public struct SearchOptions: OptionSet, CaseIterable, CustomStringConvertible {
 
     public var description: String {
         SearchOptions.allCases.compactMap { option in
-            guard self.contains(option) else {
+            guard contains(option) else {
                 return nil
             }
             switch option {

diff --git a/docs/Additional Assemblies.html b/docs/Additional Assemblies.html
@@ -21,7 +21,7 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="index.html">
-          RouteComposer 2.10.2 Docs
+          RouteComposer 2.10.3 Docs
         </a>
          (100% documented)
       </p>
@@ -620,7 +620,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2022-12-21)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2023-04-11)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Assemblies.html b/docs/Assemblies.html
@@ -21,7 +21,7 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="index.html">
-          RouteComposer 2.10.2 Docs
+          RouteComposer 2.10.3 Docs
         </a>
          (100% documented)
       </p>
@@ -747,7 +747,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2022-12-21)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2023-04-11)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/ActionToStepIntegrator.html b/docs/Classes/ActionToStepIntegrator.html
@@ -21,7 +21,7 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          RouteComposer 2.10.2 Docs
+          RouteComposer 2.10.3 Docs
         </a>
          (100% documented)
       </p>
@@ -786,7 +786,7 @@ <h4>Parameters</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2022-12-21)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2023-04-11)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/CompleteFactoryAssembly.html b/docs/Classes/CompleteFactoryAssembly.html
@@ -21,7 +21,7 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          RouteComposer 2.10.2 Docs
+          RouteComposer 2.10.3 Docs
         </a>
          (100% documented)
       </p>
@@ -1109,7 +1109,7 @@ <h4>Return Value</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2022-12-21)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2023-04-11)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/CompleteFactoryChainAssembly.html b/docs/Classes/CompleteFactoryChainAssembly.html
@@ -21,7 +21,7 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          RouteComposer 2.10.2 Docs
+          RouteComposer 2.10.3 Docs
         </a>
          (100% documented)
       </p>
@@ -1102,7 +1102,7 @@ <h4>Return Value</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2022-12-21)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2023-04-11)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/GenericStepAssembly.html b/docs/Classes/GenericStepAssembly.html
@@ -21,7 +21,7 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          RouteComposer 2.10.2 Docs
+          RouteComposer 2.10.3 Docs
         </a>
          (100% documented)
       </p>
@@ -786,7 +786,7 @@ <h4>Parameters</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2022-12-21)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2023-04-11)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/InlineContextTransformer.html b/docs/Classes/InlineContextTransformer.html
@@ -21,7 +21,7 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          RouteComposer 2.10.2 Docs
+          RouteComposer 2.10.3 Docs
         </a>
          (100% documented)
       </p>
@@ -652,7 +652,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2022-12-21)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/ekazaev" target="_blank" rel="external noopener">Evgeny Kazaev</a>. All rights reserved. (Last updated: 2023-04-11)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>