refactor: Separate the InstantSearchSwiftUI product (#193)

VladislavFitz · web-flow · commit a321c41b69dc · 2021-10-01T16:50:48.000+02:00
* make a separate InstantSearchSwiftUI product

* update project structure in the readme file
diff --git a/InstantSearch.podspec b/InstantSearch.podspec
@@ -9,7 +9,7 @@ Pod::Spec.new do |s|
   s.author = { "Algolia" => "contact@algolia.com" }
   s.source = { :git => 'https://github.com/algolia/instantsearch-ios.git', :tag => s.version }
 
-  s.swift_version = "5.1"
+  s.swift_version = "5.2"
   
   s.default_subspec = 'UI'
   
@@ -24,7 +24,6 @@ Pod::Spec.new do |s|
   
   s.subspec "Core" do |ss|
       ss.source_files = 'Sources/InstantSearchCore/**/*.{swift}'
-      ss.exclude_files = 'Sources/InstantSearchCore/SwiftUI/**/*.{swift}'
       ss.dependency 'AlgoliaSearchClient', '~> 8.10'
       ss.dependency 'InstantSearch/Insights'
       ss.ios.deployment_target = '9.0'
@@ -36,7 +35,6 @@ Pod::Spec.new do |s|
   
   s.subspec "UI" do |ss|
       ss.source_files = 'Sources/InstantSearch/**/*.{swift}'
-      ss.exclude_files = 'Sources/InstantSearch/SwiftUI/**/*.{swift}'
       ss.dependency 'InstantSearch/Core'
       ss.ios.deployment_target = '9.0'
       ss.osx.deployment_target = '10.10'
@@ -46,7 +44,7 @@ Pod::Spec.new do |s|
   end
   
   s.subspec "SwiftUI" do |ss|
-      ss.source_files = 'Sources/InstantSearchCore/SwiftUI/**/*.{swift}', 'Sources/InstantSearch/SwiftUI/**/*.{swift}'
+      ss.source_files = 'Sources/InstantSearchSwiftUI/**/*.{swift}'
       ss.dependency 'InstantSearch/Core'
       ss.ios.deployment_target = '13.0'
       ss.osx.deployment_target = '10.15'
diff --git a/Package.swift b/Package.swift
@@ -20,29 +20,40 @@ let package = Package(
       targets: ["InstantSearchCore"]),
     .library(
       name: "InstantSearchInsights",
-      targets: ["InstantSearchInsights"])
+      targets: ["InstantSearchInsights"]),
+    .library(
+      name: "InstantSearchSwiftUI",
+      targets: ["InstantSearchSwiftUI"])
   ],
   dependencies: [
-    .package(name: "AlgoliaSearchClient", url: "https://github.com/algolia/algoliasearch-client-swift", from: "8.10.0")
+    .package(name: "AlgoliaSearchClient",
+             url: "https://github.com/algolia/algoliasearch-client-swift", from: "8.10.0")
   ],
   targets: [
     .target(
       name: "InstantSearchInsights",
       dependencies: ["AlgoliaSearchClient"]),
-    .target(
-      name: "InstantSearchCore",
-      dependencies: ["AlgoliaSearchClient", "InstantSearchInsights"]),
-    .target(
-      name: "InstantSearch",
-      dependencies: ["InstantSearchCore"]),
     .testTarget(
       name: "InstantSearchInsightsTests",
       dependencies: ["InstantSearchInsights", "AlgoliaSearchClient"]),
+    .target(
+      name: "InstantSearchCore",
+      dependencies: ["AlgoliaSearchClient", "InstantSearchInsights"]),
     .testTarget(
       name: "InstantSearchCoreTests",
       dependencies: ["InstantSearchCore", "AlgoliaSearchClient", "InstantSearchInsights"]),
+    .target(
+      name: "InstantSearch",
+      dependencies: ["InstantSearchCore"]),
     .testTarget(
       name: "InstantSearchTests",
-      dependencies: ["InstantSearch"])
+      dependencies: ["InstantSearch"]),
+    .target(
+      name: "InstantSearchSwiftUI",
+      dependencies: ["InstantSearchCore"]),
+    .testTarget(
+      name: "InstantSearchSwiftUITests",
+      dependencies: ["InstantSearchSwiftUI"])
+
   ]
 )
diff --git a/Readme.md b/Readme.md
@@ -17,8 +17,9 @@ InstantSearch family: **InstantSearch iOS** | [InstantSearch Android][instantsea
 
  **InstantSearch iOS** consists of three products
  - *InstantSearch Insights* – library that allows developers to capture search-related events
- - *InstantSearch Core* – the business logic modules of InstantSearch without provided UIKit controllers
- - *InstantSearch* – the complete InstantSearch toolset including UIKit and SwiftUI components
+ - *InstantSearch Core* – the business logic modules of InstantSearch
+ - *InstantSearch* – the complete InstantSearch toolset including UIKit components
+ - *InstantSearch SwiftUI* – the set of SwiftUI data models and views to use on top of Core components
 
 ## Demo
 
diff --git a/Sources/InstantSearchCore/Hits/HitsInteractor.swift b/Sources/InstantSearchCore/Hits/HitsInteractor.swift
@@ -82,7 +82,7 @@ public class HitsInteractor<Record: Codable>: AnyHitsInteractor {
 
   public func hit(atIndex index: Int) -> Record? {
     guard let hitsPageMap = paginator.pageMap else { return nil }
-    notifyForInfiniteScrolling(rowNumber: index)
+    notifyDidPresentRow(atIndex: index)
     return hitsPageMap[index]
   }
 
@@ -111,12 +111,12 @@ public class HitsInteractor<Record: Codable>: AnyHitsInteractor {
     return pageMap.loadedPages.flatMap { $0.items }.compactMap(toRaw)
   }
 
-  internal func notifyForInfiniteScrolling(rowNumber: Int) {
+  public func notifyDidPresentRow(atIndex rowIndex: Int) {
     guard
       case .on(let pageLoadOffset) = settings.infiniteScrolling,
       let hitsPageMap = paginator.pageMap else { return }
 
-    infiniteScrollingController.calculatePagesAndLoad(currentRow: rowNumber, offset: pageLoadOffset, pageMap: hitsPageMap)
+    infiniteScrollingController.calculatePagesAndLoad(currentRow: rowIndex, offset: pageLoadOffset, pageMap: hitsPageMap)
   }
 
 }
diff --git a/Sources/InstantSearchSwiftUI/DataModel/CurrentFiltersObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/CurrentFiltersObservableController.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 29/03/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/DynamicFacetListObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/DynamicFacetListObservableController.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 15/06/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/FacetListObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/FacetListObservableController.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 29/03/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/FilterClearObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/FilterClearObservableController.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 29/03/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/FilterListObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/FilterListObservableController.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 10/06/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/FilterToggleObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/FilterToggleObservableController.swift
@@ -1,11 +1,13 @@
 //
 //  FilterToggleObservableController.swift
-//  DemoEcommerce
+//
 //
 //  Created by Vladislav Fitc on 11/04/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/HierarchicalObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/HierarchicalObservableController.swift
@@ -1,11 +1,13 @@
 //
 //  HierarchicalObservableController.swift
-//  DemoEcommerce
+//
 //
 //  Created by Vladislav Fitc on 21/04/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/HitsObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/HitsObservableController.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 26/03/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
@@ -27,17 +29,12 @@ public class HitsObservableController<Hit: Codable>: ObservableObject, HitsContr
   }
 
   public func reload() {
-    guard let paginator = self.hitsSource?.paginator, !paginator.isInvalidated,
-          let pageMap = paginator.pageMap else {
-      hits.removeAll()
-      return
-    }
-    self.hits = pageMap.map { $0 }
+    self.hits = hitsSource?.getCurrentHits() ?? []
   }
 
   /// Function to call on hit appearance  to ensure the infinite scrolling functionality
   public func notifyAppearanceOfHit(atIndex index: Int) {
-    hitsSource?.notifyForInfiniteScrolling(rowNumber: index)
+    hitsSource?.notifyDidPresentRow(atIndex: index)
   }
 
   public init() {
diff --git a/Sources/InstantSearchSwiftUI/DataModel/LoadingObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/LoadingObservableController.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 01/06/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/NumberRangeObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/NumberRangeObservableController.swift
@@ -1,10 +1,13 @@
 //
 //  NumberRangeObservableController.swift
 //
+//
 //  Created by Vladislav Fitc on 21/04/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/QueryInputObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/QueryInputObservableController.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 29/03/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/RelevantSortObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/RelevantSortObservableController.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 04/07/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/SelectableSegmentObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/SelectableSegmentObservableController.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 04/07/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/StatsObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/StatsObservableController.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 29/03/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/StatsTextObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/StatsTextObservableController.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 29/03/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/DataModel/SwitchIndexObservableController.swift b/Sources/InstantSearchSwiftUI/DataModel/SwitchIndexObservableController.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 01/04/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/View/FacetList.swift b/Sources/InstantSearchSwiftUI/View/FacetList.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 29/03/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64)) && !os(tvOS)
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/View/FacetRow.swift b/Sources/InstantSearchSwiftUI/View/FacetRow.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 20/04/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/View/FilterList.swift b/Sources/InstantSearchSwiftUI/View/FilterList.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 21/06/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64)) && !os(tvOS)
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/View/HierarchicalFacetRow.swift b/Sources/InstantSearchSwiftUI/View/HierarchicalFacetRow.swift
@@ -5,7 +5,9 @@
 //  Created by Vladislav Fitc on 29/06/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64))
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/View/HierarchicalList.swift b/Sources/InstantSearchSwiftUI/View/HierarchicalList.swift
@@ -1,11 +1,13 @@
 //
 //  HierarchicalList.swift
-//  DemoEcommerce
+//
 //
 //  Created by Vladislav Fitc on 10/04/2021.
 //
 
-import Foundation
+#if !InstantSearchCocoaPods
+import InstantSearchCore
+#endif
 #if canImport(Combine) && canImport(SwiftUI) && (arch(arm64) || arch(x86_64)) && !os(tvOS)
 import Combine
 import SwiftUI
diff --git a/Sources/InstantSearchSwiftUI/View/HitsList.swift b/Sources/InstantSearchSwiftUI/View/HitsList.swift
diff --git a/Sources/InstantSearchSwiftUI/View/SearchBar.swift b/Sources/InstantSearchSwiftUI/View/SearchBar.swift
diff --git a/Sources/InstantSearchSwiftUI/View/SuggestionRow.swift b/Sources/InstantSearchSwiftUI/View/SuggestionRow.swift
diff --git a/Sources/InstantSearchSwiftUI/View/Text+Highlighting.swift b/Sources/InstantSearchSwiftUI/View/Text+Highlighting.swift

Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ public class HitsInteractor<Record: Codable>: AnyHitsInteractor {`
`82`	`82`
`83`	`83`	`public func hit(atIndex index: Int) -> Record? {`
`84`	`84`	`guard let hitsPageMap = paginator.pageMap else { return nil }`
`85`		`- notifyForInfiniteScrolling(rowNumber: index)`
	`85`	`+ notifyDidPresentRow(atIndex: index)`
`86`	`86`	`return hitsPageMap[index]`
`87`	`87`	`}`
`88`	`88`
`@@ -111,12 +111,12 @@ public class HitsInteractor<Record: Codable>: AnyHitsInteractor {`
`111`	`111`	`return pageMap.loadedPages.flatMap { $0.items }.compactMap(toRaw)`
`112`	`112`	`}`
`113`	`113`
`114`		`- internal func notifyForInfiniteScrolling(rowNumber: Int) {`
	`114`	`+ public func notifyDidPresentRow(atIndex rowIndex: Int) {`
`115`	`115`	`guard`
`116`	`116`	`case .on(let pageLoadOffset) = settings.infiniteScrolling,`
`117`	`117`	`let hitsPageMap = paginator.pageMap else { return }`
`118`	`118`
`119`		`- infiniteScrollingController.calculatePagesAndLoad(currentRow: rowNumber, offset: pageLoadOffset, pageMap: hitsPageMap)`
	`119`	`+ infiniteScrollingController.calculatePagesAndLoad(currentRow: rowIndex, offset: pageLoadOffset, pageMap: hitsPageMap)`
`120`	`120`	`}`
`121`	`121`
`122`	`122`	`}`