Skip to content

Commit 8c84863

Browse files
stephencelismbrandonw
stephencelis
and
mbrandonw
committed
SharingGRDB
Co-authored-by: Brandon Williams <[email protected]>
0 parents  commit 8c84863

File tree

101 files changed

+9281
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

101 files changed

+9281
-0
lines changed

‎.github/CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
<[email protected]>.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: Bug Report
2+
description: Something isn't working as expected
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for contributing to the SharingGRDB!
9+
10+
Before you submit your issue, please complete each text area below with the relevant details for your bug, and complete the steps in the checklist
11+
- type: textarea
12+
attributes:
13+
label: Description
14+
description: |
15+
A short description of the incorrect behavior.
16+
17+
If you think this issue has been recently introduced and did not occur in an earlier version, please note that. If possible, include the last version that the behavior was correct in addition to your current version.
18+
validations:
19+
required: true
20+
- type: checkboxes
21+
attributes:
22+
label: Checklist
23+
options:
24+
- label: I have determined whether this bug is also reproducible in a vanilla SwiftUI project.
25+
required: false
26+
- label: I have determined whether this bug is also reproducible in a vanilla GRDB project.
27+
required: false
28+
- label: If possible, I've reproduced the issue using the `main` branch of this package.
29+
required: false
30+
- label: This issue hasn't been addressed in an [existing GitHub issue](https://github.com/pointfreeco/sharing-grdb/issues) or [discussion](https://github.com/pointfreeco/sharing-grdb/discussions).
31+
required: true
32+
- type: textarea
33+
attributes:
34+
label: Expected behavior
35+
description: Describe what you expected to happen.
36+
validations:
37+
required: false
38+
- type: textarea
39+
attributes:
40+
label: Actual behavior
41+
description: Describe or copy/paste the behavior you observe.
42+
validations:
43+
required: false
44+
- type: textarea
45+
attributes:
46+
label: Reproducing project
47+
description: |
48+
Provide a full SPM package or Xcode project that demonstrates the problem you are seeing. If you cannot reproduce the problem in a standalone project, then provide a detailed explanation of how to reproduce the incorrect behavior.
49+
50+
Note that without a project that reproduces the problem we are likely to close this issue and convert it to a discussion until more details are provided.
51+
placeholder: |
52+
Drag and drop a full SPM package or Xcode project into this text field that demonstrates the problem you are seeing.
53+
validations:
54+
required: false
55+
- type: input
56+
attributes:
57+
label: SharingGRDB version information
58+
description: The version of SharingGRDB used to reproduce this issue.
59+
placeholder: "'0.1.0' for example, or a commit hash"
60+
- type: input
61+
attributes:
62+
label: Sharing version information
63+
description: The version of Sharing used to reproduce this issue.
64+
placeholder: "'2.3.0' for example, or a commit hash"
65+
- type: input
66+
attributes:
67+
label: GRDB version information
68+
description: The version of GRDB used to reproduce this issue.
69+
placeholder: "'7.1.0' for example, or a commit hash"
70+
- type: input
71+
attributes:
72+
label: Destination operating system
73+
description: The OS running your application.
74+
placeholder: "'iOS 18' for example"
75+
- type: input
76+
attributes:
77+
label: Xcode version information
78+
description: The version of Xcode used to reproduce this issue.
79+
placeholder: "The version displayed from 'Xcode 〉About Xcode'"
80+
- type: textarea
81+
attributes:
82+
label: Swift Compiler version information
83+
description: The version of Swift used to reproduce this issue.
84+
placeholder: Output from 'xcrun swiftc --version'
85+
render: shell

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: Project Discussion
5+
url: https://github.com/pointfreeco/sharing-grdb/discussions
6+
about: SharingGRDB Q&A, ideas, and more
7+
- name: Documentation
8+
url: https://pointfreeco.github.io/sharing-grdb/main/documentation/sharinggrdb/
9+
about: Read Sharing's documentation
10+
- name: Videos
11+
url: https://www.pointfree.co/
12+
about: Watch videos to get a behind-the-scenes look at how SharingGRDB was motivated and built
13+
- name: Slack
14+
url: https://www.pointfree.co/slack-invite
15+
about: Community chat

‎.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.DS_Store
2+
/.build
3+
/Packages
4+
xcuserdata/
5+
DerivedData/
6+
.swiftpm
7+
.netrc

‎.spi.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 1
2+
builder:
3+
configs:
4+
- documentation_targets:
5+
- SharingGRDB
6+
swift_version: 6.0

‎Examples/CaseStudies/Animations.swift

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
import Dependencies
2+
import SharingGRDB
3+
import SwiftUI
4+
5+
struct AnimationsCaseStudy: SwiftUICaseStudy {
6+
let readMe = """
7+
This demonstrates how to animate fetching data from the database, or when data changes in \
8+
the database. Simply provide the `animation` argument to `fetchAll` (or the other querying \
9+
tools, such as `fetch` and `fetchOne`).
10+
11+
This is analagous to how animations work in SwiftData in which one provides an `animation` \
12+
argument to the `@Query` macro.
13+
"""
14+
let caseStudyTitle = "Animations"
15+
16+
@SharedReader(.fetchAll(sql: #"SELECT * FROM "facts" ORDER BY "id" DESC"#, animation: .default))
17+
private var facts: [Fact]
18+
19+
@Dependency(\.defaultDatabase) var database
20+
21+
var body: some View {
22+
List {
23+
ForEach(facts) { fact in
24+
Text(fact.body)
25+
}
26+
}
27+
.task {
28+
do {
29+
var number = 0
30+
while true {
31+
try await Task.sleep(for: .seconds(1))
32+
number += 1
33+
let fact = try await String(
34+
decoding: URLSession.shared
35+
.data(from: URL(string: "http://numberapi.com/\(number)")!).0,
36+
as: UTF8.self
37+
)
38+
try await database.write { db in
39+
_ = try Fact(body: fact).inserted(db)
40+
}
41+
}
42+
} catch {}
43+
}
44+
}
45+
}
46+
47+
private struct Fact: Codable, FetchableRecord, Identifiable, MutablePersistableRecord {
48+
static let databaseTableName = "facts"
49+
var id: Int64?
50+
var body: String
51+
mutating func didInsert(_ inserted: InsertionSuccess) {
52+
id = inserted.rowID
53+
}
54+
}
55+
56+
extension DatabaseWriter where Self == DatabaseQueue {
57+
static var animationDatabase: Self {
58+
let databaseQueue = try! DatabaseQueue()
59+
var migrator = DatabaseMigrator()
60+
migrator.registerMigration("Create 'facts' table") { db in
61+
try db.create(table: Fact.databaseTableName) { table in
62+
table.autoIncrementedPrimaryKey("id")
63+
table.column("body", .text).notNull()
64+
}
65+
}
66+
try! migrator.migrate(databaseQueue)
67+
return databaseQueue
68+
}
69+
}
70+
71+
#Preview {
72+
let _ = prepareDependencies {
73+
$0.defaultDatabase = .animationDatabase
74+
}
75+
NavigationStack {
76+
CaseStudyView {
77+
AnimationsCaseStudy()
78+
}
79+
}
80+
}

‎Examples/CaseStudies/App.swift

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import SharingGRDB
2+
import SwiftUI
3+
4+
@main
5+
struct CaseStudiesApp: App {
6+
var body: some Scene {
7+
WindowGroup {
8+
Form {
9+
Text("""
10+
Open the preview in each case study file to run a case study.
11+
""")
12+
}
13+
}
14+
}
15+
}

‎Examples/CaseStudies/Assets.xcassets/AccentColor.colorset/Contents.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"colors" : [
3+
{
4+
"idiom" : "universal"
5+
}
6+
],
7+
"info" : {
8+
"author" : "xcode",
9+
"version" : 1
10+
}
11+
}

‎Examples/CaseStudies/Assets.xcassets/AppIcon.appiconset/Contents.json

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"images" : [
3+
{
4+
"idiom" : "universal",
5+
"platform" : "ios",
6+
"size" : "1024x1024"
7+
},
8+
{
9+
"appearances" : [
10+
{
11+
"appearance" : "luminosity",
12+
"value" : "dark"
13+
}
14+
],
15+
"idiom" : "universal",
16+
"platform" : "ios",
17+
"size" : "1024x1024"
18+
},
19+
{
20+
"appearances" : [
21+
{
22+
"appearance" : "luminosity",
23+
"value" : "tinted"
24+
}
25+
],
26+
"idiom" : "universal",
27+
"platform" : "ios",
28+
"size" : "1024x1024"
29+
}
30+
],
31+
"info" : {
32+
"author" : "xcode",
33+
"version" : 1
34+
}
35+
}

0 commit comments

Comments
 (0)