Skip to content

Non-optional sectioning #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stephencelis merged 1 commit into from
Jul 29, 2026
+155 −24
Merged

Non-optional sectioning #515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 46 additions & 12 deletions Sources/SQLiteData/FetchAll+Sections.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1463,19 +1463,54 @@ public struct _Sectioning<Key>: Hashable, Sendable {
let select: QueryFragment
let order: QueryFragment

package init(_ expression: some QueryExpression<some _OptionalPromotable<Key>>) {
package init(_ expression: some QueryExpression) {
self.select = expression.queryFragment
self.order = expression.queryFragment
}

package init(_ orderingTerm: _OrderingTerm<some _OptionalPromotable<Key>>) {
package init<Value>(_ orderingTerm: _OrderingTerm<Value>) {
self.select = orderingTerm.baseQueryFragment
self.order = orderingTerm.queryFragment
}
}

@resultBuilder
public enum _SectionBuilder<Key> {
public static func buildExpression(
_ expression: some QueryExpression<Key>
) -> _Sectioning<Key> {
_Sectioning(expression)
}

public static func buildExpression(
_ orderingTerm: _OrderingTerm<Key>
) -> _Sectioning<Key> {
_Sectioning(orderingTerm)
}

public static func buildBlock(_ component: _Sectioning<Key>) -> _Sectioning<Key> {
component
}

@available(
*,
unavailable,
message: "Sectioning is required here. Add an 'else' branch, or section by an optional key."
)
public static func buildOptional(_ component: _Sectioning<Key>?) -> _Sectioning<Key> {
fatalError()
}

public static func buildEither(first component: _Sectioning<Key>) -> _Sectioning<Key> {
component
}

public static func buildEither(second component: _Sectioning<Key>) -> _Sectioning<Key> {
component
}
}

extension _SectionBuilder where Key: _OptionalProtocol {
public static func buildExpression(
_ expression: Never?
) -> _Sectioning<Key>? {
Expand All @@ -1485,34 +1520,33 @@ public enum _SectionBuilder<Key> {
@_disfavoredOverload
public static func buildExpression(
_ expression: some QueryExpression<some _OptionalPromotable<Key>>
) -> _Sectioning<Key> {
) -> _Sectioning<Key>? {
_Sectioning(expression)
}

@_disfavoredOverload
public static func buildExpression(
_ orderingTerm: _OrderingTerm<some _OptionalPromotable<Key>>
) -> _Sectioning<Key> {
) -> _Sectioning<Key>? {
_Sectioning(orderingTerm)
}

public static func buildBlock(_ component: _Sectioning<Key>) -> _Sectioning<Key> {
component
}

@_disfavoredOverload
public static func buildBlock(_ component: _Sectioning<Key>?) -> _Sectioning<Key>? {
component
}

public static func buildOptional(_ component: _Sectioning<Key>?) -> _Sectioning<Key>? {
component
public static func buildOptional(_ component: _Sectioning<Key>??) -> _Sectioning<Key>? {
component ?? nil
}

public static func buildEither(first component: _Sectioning<Key>) -> _Sectioning<Key> {
@_disfavoredOverload
public static func buildEither(first component: _Sectioning<Key>?) -> _Sectioning<Key>? {
component
}

public static func buildEither(second component: _Sectioning<Key>) -> _Sectioning<Key> {
@_disfavoredOverload
public static func buildEither(second component: _Sectioning<Key>?) -> _Sectioning<Key>? {
component
}
}
Expand Down
4 changes: 2 additions & 2 deletions Sources/SQLiteData/StructuredQueries+GRDB/Statement+Sections.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ extension SelectStatement where QueryValue == (), Joins == () {
public func fetchAll<Key: QueryRepresentable>(
_ db: Database,
sectionBy sectionKeyPath: KeyPath<
From.TableColumns, some QueryExpression<some _OptionalPromotable<Key>>
From.TableColumns, some QueryExpression<Key>
>
) throws -> ResultsSectionCollection<From.QueryOutput, Key.QueryOutput>
where Key.QueryOutput: Hashable {
Expand Down Expand Up @@ -108,7 +108,7 @@ extension Select {
public func fetchAll<Key: QueryRepresentable>(
_ db: Database,
sectionBy sectionKeyPath: KeyPath<
From.TableColumns, some QueryExpression<some _OptionalPromotable<Key>>
From.TableColumns, some QueryExpression<Key>
>
) throws -> ResultsSectionCollection<QueryValue.QueryOutput, Key.QueryOutput>
where QueryValue: QueryRepresentable, Joins == (), Key.QueryOutput: Hashable {
Expand Down
117 changes: 107 additions & 10 deletions Tests/SQLiteDataTests/FetchAllSectionsTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,77 @@ struct FetchAllSectionsTests {
)
}

@Test(arguments: [true, false]) func ifElseNilSectionBy(byCategory: Bool) async throws {
@FetchAll(
SectionedReminder.order(by: \.id),
sectionBy: {
if byCategory {
$0.category
} else {
nil
}
}
)
var reminders
try await $reminders.load()

#expect(
$reminders.sections.sectionNames == (byCategory ? ["Errands", "Home", "Work"] : [nil])
)
}

@Test(arguments: [true, false]) func nestedOptionalSectionBy(isSectioned: Bool) async throws {
let byCategory = true
@FetchAll(
SectionedReminder.order(by: \.id),
sectionBy: { columns in
if isSectioned {
if byCategory {
columns.category
}
}
}
)
var reminders
try await $reminders.load()

#expect(
$reminders.sections.sectionNames == (isSectioned ? ["Errands", "Home", "Work"] : [nil])
)
}

@Test(arguments: [SectionedReminderSectioning.unsectioned, .category, .priority])
func switchNestedOptionalSectionBy(sectioning: SectionedReminderSectioning) async throws {
let byCategory = true
@FetchAll(
SectionedReminder.order(by: \.id),
sectionBy: { columns in
switch sectioning {
case .unsectioned:
nil
case .category:
if byCategory {
columns.category
} else {
nil
}
case .priority:
columns.priority.desc(nulls: .last)
}
}
)
var reminders
try await $reminders.load()

let expected: [String?] =
switch sectioning {
case .unsectioned: [nil]
case .category: ["Errands", "Home", "Work"]
case .priority: ["low", "high", nil]
}
#expect($reminders.sections.sectionNames == expected)
}

@Test func keyPathSectionBy() async throws {
@FetchAll(SectionedReminder.order(by: \.id), sectionBy: \.category) var reminders
try await $reminders.load()
Expand All @@ -143,14 +214,6 @@ struct FetchAllSectionsTests {
#expect($reminders.sections.sectionNames == ["Errands", "Home", "Work"])
}

@Test func storedSectioning() async throws {
let sectioning: (SectionedReminder.TableColumns) -> _Sectioning? = { _Sectioning($0.category) }
@FetchAll(SectionedReminder.order(by: \.id), sectionBy: sectioning) var reminders
try await $reminders.load()

#expect($reminders.sections.sectionNames == ["Errands", "Home", "Work"])
}

@Test func sectionLookup() async throws {
@FetchAll(SectionedReminder.order(by: \.id), sectionBy: \.category) var reminders
try await $reminders.load()
Expand Down Expand Up @@ -531,6 +594,34 @@ struct FetchAllSectionsTests {
#expect(sections[sectionName: "high"]?.map(\.title) == ["Dishes", "Standup"])
}

@Test func nonNullSectionsAreNotOptional() async throws {
let sections = try await database.read { db in
try SectionedReminder.order(by: \.id).fetchAll(db, sectionBy: { $0.category })
}

let sectionNames: [String] = sections.sectionNames
#expect(sectionNames == ["Errands", "Home", "Work"])
#expect(sections[sectionName: "Home"]?.name == "Home")
}

@Test func nonNullSectionsAreNotOptionalWithOrdering() async throws {
let sections = try await database.read { db in
try SectionedReminder.order(by: \.id).fetchAll(db, sectionBy: { $0.category.desc() })
}

let sectionNames: [String] = sections.sectionNames
#expect(sectionNames == ["Work", "Home", "Errands"])
}

@Test func nullableSectionsStayOptional() async throws {
let sections = try await database.read { db in
try SectionedReminder.order(by: \.id).fetchAll(db, sectionBy: { $0.priority })
}

let sectionNames: [String?] = sections.sectionNames
#expect(sectionNames == [nil, "high", "low"])
}

@Test func integerSections() async throws {
let sections = try await database.read { db in
try SectionedReminder
Expand Down Expand Up @@ -613,12 +704,12 @@ struct FetchAllSectionsTests {

@Test func fetchKeyRequest() async throws {
struct Request: FetchKeyRequest {
func fetch(_ db: Database) throws -> ResultsSectionCollection<SectionedReminder, String?> {
func fetch(_ db: Database) throws -> ResultsSectionCollection<SectionedReminder, String> {
try SectionedReminder.order(by: \.id).fetchAll(db, sectionBy: { $0.category })
}
}

@Fetch(Request()) var sections = ResultsSectionCollection<SectionedReminder, String?>()
@Fetch(Request()) var sections = ResultsSectionCollection<SectionedReminder, String>()
try await $sections.load()

#expect(sections.sectionNames == ["Errands", "Home", "Work"])
Expand All @@ -641,6 +732,12 @@ private struct SectionedRow: Equatable {
var label = ""
}

enum SectionedReminderSectioning: Sendable {
case unsectioned
case category
case priority
}

@Table
private struct SectionedValue: Equatable, Identifiable {
let id: Int
Expand Down