[Update] Improve Sample Viewer search

Shared/Supporting Files/Extensions/CategoryView+Search.swift

@@ -15,13 +15,44 @@
 import SwiftUI
 
 extension CategoryView {
-    /// Searches the sample list using the query.
-    /// - Returns: A set of samples matching the query criteria.
-    func searchSamples() -> [Sample] {
-        if query.isEmpty {
-            return samples
-        } else {
-            return samples.filter { $0.name.localizedCaseInsensitiveContains(query) }
+    /// Searches through a list of samples using the sample's name and the query.
+    /// - Parameters:
+    ///   - samples: The `Array` of samples to search through.
+    ///   - query: The `String` to search with.
+    /// - Returns: The samples whose name partially matches the query.
+    func searchNames(in samples: [Sample], with query: String) -> [Sample] {
+        // Perform a partial text search using the sample's name and the query.
+        let nameSearchResults = samples.filter { sample in
+            sample.name.localizedCaseInsensitiveContains(query)
         }
+        return nameSearchResults
+    }
+
+    /// Searches through a list of samples using the sample's description and the query.
+    /// - Parameters:
+    ///   - samples: The `Array` of samples to search through.
+    ///   - query: The `String` to search with.
+    /// - Returns: The samples whose description partially matches the query.
+    func searchDescriptions(in samples: [Sample], with query: String) -> [Sample] {
+        // Perform a partial text search using the sample's description and the query.
+        let descriptionSearchResults = samples.filter { sample in
+            sample.description.localizedCaseInsensitiveContains(query)
+        }
+        return descriptionSearchResults
+    }
+
+    /// Searches through a list of samples using the sample's tags and the query.
+    /// - Parameters:
+    ///   - samples: The `Array` of samples to search through.
+    ///   - query: The `String` to search with.
+    /// - Returns: The samples which have a tag that fully matches the query.
+    func searchTags(in samples: [Sample], with query: String) -> [Sample] {
+        // Perform a full text search using the sample's tags and the query.
+        let tagsSearchResults = samples.filter { sample in
+            sample.tags.contains { tag in
+                tag.localizedCaseInsensitiveCompare(query) == .orderedSame
+            }
+        }
+        return tagsSearchResults
     }
 }

Shared/Supporting Files/Views/CategoryGridView.swift

@@ -38,8 +38,10 @@ struct CategoryGridView: View {
             LazyVGrid(columns: columns) {
                 ForEach(categories, id: \.self) { category in
                     NavigationLink {
-                        SampleListView(samples: samples.filter { $0.category == category })
-                            .navigationTitle(category)
+                        List {
+                            SampleListView(samples: samples.filter { $0.category == category })
+                        }
+                        .navigationTitle(category)
                     } label: {
                         CategoryTitleView(category: category)
                     }

Shared/Supporting Files/Views/CategoryView.swift

@@ -24,20 +24,47 @@ struct CategoryView: View {
     /// The search query in the search bar.
     @Binding private(set) var query: String
 
+    /// The samples to display in the name section of the search list.
+    @State private var nameSearchResults: [Sample] = []
+
+    /// The samples to display in the description section of the search list.
+    @State private var descriptionSearchResults: [Sample] = []
+
+    /// The samples to display in the tags section of the search list.
+    @State private var tagsSearchResults: [Sample] = []
+
     /// A Boolean value that indicates whether to present the about view.
     @State private var isAboutViewPresented = false
 
-    /// The samples to display in the search list. Searching adjusts this value.
-    private var displayedSamples: [Sample] {
-        searchSamples()
-    }
-
     var body: some View {
         Group {
             if !isSearching {
                 CategoryGridView(samples: samples)
             } else {
-                SampleListView(samples: displayedSamples)
+                // The search results list.
+                List {
+                    if !nameSearchResults.isEmpty {
+                        Section(header: Text("Name Results")) {
+                            SampleListView(samples: nameSearchResults, query: query)
+                        }
+                    }
+                    if !descriptionSearchResults.isEmpty {
+                        Section(header: Text("Description Results")) {
+                            SampleListView(samples: descriptionSearchResults, query: query)
+                        }
+                    }
+                    if !tagsSearchResults.isEmpty {
+                        Section(header: Text("Tag Results")) {
+                            SampleListView(samples: tagsSearchResults, query: query)
+                        }
+                    }
+                }
+                .onChange(of: query) { _ in
+                    searchSamples(in: samples, with: query)
+                }
+                .onAppear {
+                    searchSamples(in: samples, with: query)
+                }
             }
         }
         .navigationTitle("Samples")
@@ -54,4 +81,32 @@ struct CategoryView: View {
             }
         }
     }
+
+    /// Searches through a list of samples to find ones that match the query.
+    /// - Parameters:
+    ///   - samples: The `Array` of samples to search through.
+    ///   - query: The `String` to search with.
+    private func searchSamples(in samples: [Sample], with query: String) {
+        // Show all samples in the name section when query is empty.
+        guard !query.isEmpty else {
+            nameSearchResults = samples
+            return
+        }
+
+        // The names of the samples already found in a previous section.
+        var previousSearchResults: Set<String> = []
+
+        // Update the name section results.
+        nameSearchResults = searchNames(in: samples, with: query)
+        previousSearchResults.formUnion(nameSearchResults.map(\.name))
+
+        // Update the description section results.
+        descriptionSearchResults = searchDescriptions(in: samples, with: query)
+            .filter { !previousSearchResults.contains($0.name) }
+        previousSearchResults.formUnion(descriptionSearchResults.map(\.name))
+
+        // Update the tags section results.
+        tagsSearchResults = searchTags(in: samples, with: query)
+            .filter { !previousSearchResults.contains($0.name) }
+    }
 }

Shared/Supporting Files/Views/ContentView.swift

@@ -38,7 +38,7 @@ struct ContentView: View {
 
     var sidebar: some View {
         CategoryView(samples: samples, query: $query)
-            .searchable(text: $query, prompt: "Search By Sample Name")
+            .searchable(text: $query, prompt: "Search")
     }
 
     var detail: some View {

Shared/Supporting Files/Views/SampleListView.swift

@@ -1,4 +1,4 @@
-// Copyright 2022 Esri
+// Copyright 2023 Esri
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -18,9 +18,17 @@ struct SampleListView: View {
     /// All samples that will be displayed in the list.
     let samples: [Sample]
 
+    /// The search query from the search bar.
+    let query: String
+
+    init(samples: [Sample], query: String = "") {
+        self.samples = samples
+        self.query = query
+    }
+
     var body: some View {
-        List(samples, id: \.name) { sample in
-            SampleRow(sample: sample)
+        ForEach(samples, id: \.name) { sample in
+            SampleRow(sample: sample, boldedText: query)
         }
     }
 }
@@ -30,6 +38,9 @@ private extension SampleListView {
         /// The sample displayed in the row.
         let sample: Sample
 
+        /// The text to bold.
+        let boldedText: String
+
         /// A Boolean value that indicates whether to show the sample's description.
         @State private var isShowingDescription = false
 
@@ -39,9 +50,10 @@ private extension SampleListView {
             } label: {
                 HStack {
                     VStack(alignment: .leading, spacing: 5) {
-                        Text(sample.name)
+                        Text(.init(boldSubstring(sample.name, substring: boldedText)))
+
                         if isShowingDescription {
-                            Text(sample.description)
+                            Text(.init(boldSubstring(sample.description, substring: boldedText)))
                                 .font(.caption)
                                 .foregroundColor(.secondary)
                                 .transition(.move(edge: .top).combined(with: .opacity))
@@ -58,5 +70,34 @@ private extension SampleListView {
                 .animation(.easeOut(duration: 0.2), value: isShowingDescription)
             }
         }
+
+        /// Bolds the first occurrence of substring within a given string using markdown.
+        /// - Parameters:
+        ///   - text: The `String` containing the substring.
+        ///   - substring: The substring to bold.
+        /// - Returns: The `String` with the bolded substring.
+        func boldSubstring(_ text: String, substring: String) -> String {
+            if let range = text.localizedLowercase.range(of: substring.localizedLowercase) {
+                var boldedText = text
+
+                // Add "**" to the front of the substring.
+                let lowerIndex = boldedText.distance(from: boldedText.startIndex, to: range.lowerBound)
+                boldedText.insert(contentsOf: "**", at: boldedText.index(
+                    boldedText.startIndex,
+                    offsetBy: lowerIndex
+                ))
+
+                // Add "**" to the end of the substring.
+                let upperIndex = boldedText.distance(from: boldedText.startIndex, to: range.upperBound)
+                boldedText.insert(contentsOf: "**", at: boldedText.index(
+                    boldedText.startIndex,
+                    offsetBy: upperIndex + 2
+                ))
+
+                return boldedText
+            }
+
+            return text
+        }
     }
 }