SharingGRDB

Co-authored-by: Brandon Williams <[email protected]>

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+<[email protected]>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,85 @@
+name: Bug Report
+description: Something isn't working as expected
+labels: [bug]
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thank you for contributing to the SharingGRDB!
+
+      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
+- type: textarea
+  attributes:
+    label: Description
+    description: |
+      A short description of the incorrect behavior.
+
+      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.
+  validations:
+    required: true
+- type: checkboxes
+  attributes:
+    label: Checklist
+    options:
+    - label: I have determined whether this bug is also reproducible in a vanilla SwiftUI project.
+      required: false
+    - label: I have determined whether this bug is also reproducible in a vanilla GRDB project.
+      required: false
+    - label: If possible, I've reproduced the issue using the `main` branch of this package.
+      required: false
+    - 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).
+      required: true
+- type: textarea
+  attributes:
+    label: Expected behavior
+    description: Describe what you expected to happen.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Actual behavior
+    description: Describe or copy/paste the behavior you observe.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Reproducing project
+    description: |
+      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.
+
+      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.
+    placeholder: |
+      Drag and drop a full SPM package or Xcode project into this text field that demonstrates the problem you are seeing.
+  validations:
+    required: false
+- type: input
+  attributes:
+    label: SharingGRDB version information
+    description: The version of SharingGRDB used to reproduce this issue.
+    placeholder: "'0.1.0' for example, or a commit hash"
+- type: input
+  attributes:
+    label: Sharing version information
+    description: The version of Sharing used to reproduce this issue.
+    placeholder: "'2.3.0' for example, or a commit hash"
+- type: input
+  attributes:
+    label: GRDB version information
+    description: The version of GRDB used to reproduce this issue.
+    placeholder: "'7.1.0' for example, or a commit hash"
+- type: input
+  attributes:
+    label: Destination operating system
+    description: The OS running your application.
+    placeholder: "'iOS 18' for example"
+- type: input
+  attributes:
+    label: Xcode version information
+    description: The version of Xcode used to reproduce this issue.
+    placeholder: "The version displayed from 'Xcode 〉About Xcode'"
+- type: textarea
+  attributes:
+    label: Swift Compiler version information
+    description: The version of Swift used to reproduce this issue.
+    placeholder: Output from 'xcrun swiftc --version'
+    render: shell

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,15 @@
+blank_issues_enabled: false
+
+contact_links:
+  - name: Project Discussion
+    url: https://github.com/pointfreeco/sharing-grdb/discussions
+    about: SharingGRDB Q&A, ideas, and more
+  - name: Documentation
+    url: https://pointfreeco.github.io/sharing-grdb/main/documentation/sharinggrdb/
+    about: Read Sharing's documentation
+  - name: Videos
+    url: https://www.pointfree.co/
+    about: Watch videos to get a behind-the-scenes look at how SharingGRDB was motivated and built
+  - name: Slack
+    url: https://www.pointfree.co/slack-invite
+    about: Community chat

.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+/.build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm
+.netrc

.spi.yml

@@ -0,0 +1,6 @@
+version: 1
+builder:
+  configs:
+  - documentation_targets:
+    - SharingGRDB
+    swift_version: 6.0

Examples/CaseStudies/Animations.swift

@@ -0,0 +1,80 @@
+import Dependencies
+import SharingGRDB
+import SwiftUI
+
+struct AnimationsCaseStudy: SwiftUICaseStudy {
+  let readMe = """
+    This demonstrates how to animate fetching data from the database, or when data changes in \
+    the database. Simply provide the `animation` argument to `fetchAll` (or the other querying \
+    tools, such as `fetch` and `fetchOne`). 
+    
+    This is analagous to how animations work in SwiftData in which one provides an `animation` \
+    argument to the `@Query` macro.
+    """
+  let caseStudyTitle = "Animations"
+
+  @SharedReader(.fetchAll(sql: #"SELECT * FROM "facts" ORDER BY "id" DESC"#, animation: .default))
+  private var facts: [Fact]
+
+  @Dependency(\.defaultDatabase) var database
+
+  var body: some View {
+    List {
+      ForEach(facts) { fact in
+        Text(fact.body)
+      }
+    }
+    .task {
+      do {
+        var number = 0
+        while true {
+          try await Task.sleep(for: .seconds(1))
+          number += 1
+          let fact = try await String(
+            decoding: URLSession.shared
+              .data(from: URL(string: "http://numberapi.com/\(number)")!).0,
+            as: UTF8.self
+          )
+          try await database.write { db in
+            _ = try Fact(body: fact).inserted(db)
+          }
+        }
+      } catch {}
+    }
+  }
+}
+
+private struct Fact: Codable, FetchableRecord, Identifiable, MutablePersistableRecord {
+  static let databaseTableName = "facts"
+  var id: Int64?
+  var body: String
+  mutating func didInsert(_ inserted: InsertionSuccess) {
+    id = inserted.rowID
+  }
+}
+
+extension DatabaseWriter where Self == DatabaseQueue {
+  static var animationDatabase: Self {
+    let databaseQueue = try! DatabaseQueue()
+    var migrator = DatabaseMigrator()
+    migrator.registerMigration("Create 'facts' table") { db in
+      try db.create(table: Fact.databaseTableName) { table in
+        table.autoIncrementedPrimaryKey("id")
+        table.column("body", .text).notNull()
+      }
+    }
+    try! migrator.migrate(databaseQueue)
+    return databaseQueue
+  }
+}
+
+#Preview {
+  let _ = prepareDependencies {
+    $0.defaultDatabase = .animationDatabase
+  }
+  NavigationStack {
+    CaseStudyView {
+      AnimationsCaseStudy()
+    }
+  }
+}

Examples/CaseStudies/App.swift

@@ -0,0 +1,15 @@
+import SharingGRDB
+import SwiftUI
+
+@main
+struct CaseStudiesApp: App {
+  var body: some Scene {
+    WindowGroup {
+      Form {
+        Text("""
+          Open the preview in each case study file to run a case study.
+          """)
+      }
+    }
+  }
+}

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

@@ -0,0 +1,11 @@
+{
+  "colors" : [
+    {
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

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

@@ -0,0 +1,35 @@
+{
+  "images" : [
+    {
+      "idiom" : "universal",
+      "platform" : "ios",
+      "size" : "1024x1024"
+    },
+    {
+      "appearances" : [
+        {
+          "appearance" : "luminosity",
+          "value" : "dark"
+        }
+      ],
+      "idiom" : "universal",
+      "platform" : "ios",
+      "size" : "1024x1024"
+    },
+    {
+      "appearances" : [
+        {
+          "appearance" : "luminosity",
+          "value" : "tinted"
+        }
+      ],
+      "idiom" : "universal",
+      "platform" : "ios",
+      "size" : "1024x1024"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}