Skip to content

Commit

Permalink
Updates the Project to be Part of the Spezi Organization (StanfordSpe…
Browse files Browse the repository at this point in the history
  • Loading branch information
PSchmiedmayer authored May 12, 2023
1 parent 650a4af commit 8547b11
Show file tree
Hide file tree
Showing 66 changed files with 179 additions and 181 deletions.
14 changes: 7 additions & 7 deletions .github/workflows/build-and-test.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# This source file is part of the CardinalKit open source project
# This source file is part of the Spezi open source project
#
# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
#
Expand All @@ -18,14 +18,14 @@ on:
jobs:
buildandtest:
name: Build and Test Swift Package
uses: StanfordBDHG/.github/.github/workflows/xcodebuild-or-fastlane.yml@v2
uses: StanfordSpezi/.github/.github/workflows/xcodebuild-or-fastlane.yml@v2
with:
artifactname: CardinalKitAccount.xcresult
artifactname: SpeziAccount.xcresult
runsonlabels: '["macOS", "self-hosted"]'
scheme: CardinalKitAccount
scheme: SpeziAccount
buildandtestuitests:
name: Build and Test UI Tests
uses: StanfordBDHG/.github/.github/workflows/xcodebuild-or-fastlane.yml@v2
uses: StanfordSpezi/.github/.github/workflows/xcodebuild-or-fastlane.yml@v2
with:
artifactname: TestApp.xcresult
runsonlabels: '["macOS", "self-hosted"]'
Expand All @@ -34,6 +34,6 @@ jobs:
uploadcoveragereport:
name: Upload Coverage Report
needs: [buildandtest, buildandtestuitests]
uses: StanfordBDHG/.github/.github/workflows/create-and-upload-coverage-report.yml@v2
uses: StanfordSpezi/.github/.github/workflows/create-and-upload-coverage-report.yml@v2
with:
coveragereports: CardinalKitAccount.xcresult TestApp.xcresult
coveragereports: SpeziAccount.xcresult TestApp.xcresult
6 changes: 3 additions & 3 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# This source file is part of the CardinalKit open source project
# This source file is part of the Spezi open source project
#
# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
#
Expand All @@ -15,7 +15,7 @@ on:
jobs:
reuse_action:
name: REUSE Compliance Check
uses: StanfordBDHG/.github/.github/workflows/reuse.yml@v2
uses: StanfordSpezi/.github/.github/workflows/reuse.yml@v2
swiftlint:
name: SwiftLint
uses: StanfordBDHG/.github/.github/workflows/swiftlint.yml@v2
uses: StanfordSpezi/.github/.github/workflows/swiftlint.yml@v2
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# This source file is part of the CardinalKit open source project
# This source file is part of the Spezi open source project
#
# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
#
Expand Down
4 changes: 2 additions & 2 deletions .spi.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# This source file is part of the CardinalKit open source project
# This source file is part of the Spezi open source project
#
# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
#
Expand All @@ -11,4 +11,4 @@ builder:
configs:
- platform: ios
documentation_targets:
- CardinalKitAccount
- SpeziAccount
2 changes: 1 addition & 1 deletion .swiftlint.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# This source file is part of the CardinalKit open source project
# This source file is part of the Spezi open source project
#
# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
#
Expand Down
6 changes: 3 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#
# This source file is part of the CardinalKit open source project
# This source file is part of the Spezi open source project
#
# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
#
Expand All @@ -18,6 +18,6 @@ authors:
- family-names: "Aalami"
given-names: "Oliver"
orcid: "https://orcid.org/0000-0002-7799-2429"
title: "CardinalKitAccount"
title: "SpeziAccount"
doi: 10.5281/zenodo.7796499
url: "https://github.com/StanfordBDHG/CardinalKitAccount"
url: "https://github.com/StanfordSpezi/SpeziAccount"
18 changes: 8 additions & 10 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
<!--
#
# This source file is part of the CardinalKit open source project
#
# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
#
# SPDX-License-Identifier: MIT
#
This source file is part of the Spezi open-source project.
SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
SPDX-License-Identifier: MIT
-->

CardinalKit Account Contributors
Spezi Account Contributors
====================

* [Paul Schmiedmayer](https://github.com/PSchmiedmayer)
20 changes: 10 additions & 10 deletions Package.swift
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// swift-tools-version:5.7

//
// This source file is part of the CardinalKit open source project
// This source file is part of the Spezi open source project
//
// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
//
Expand All @@ -12,30 +12,30 @@ import PackageDescription


let package = Package(
name: "CardinalKitAccount",
name: "SpeziAccount",
defaultLocalization: "en",
platforms: [
.iOS(.v16)
],
products: [
.library(name: "CardinalKitAccount", targets: ["CardinalKitAccount"])
.library(name: "SpeziAccount", targets: ["SpeziAccount"])
],
dependencies: [
.package(url: "https://github.com/StanfordBDHG/CardinalKit", .upToNextMinor(from: "0.4.1")),
.package(url: "https://github.com/StanfordBDHG/CardinalKitViews", .upToNextMinor(from: "0.2.1"))
.package(url: "https://github.com/StanfordSpezi/Spezi", .upToNextMinor(from: "0.5.0")),
.package(url: "https://github.com/StanfordSpezi/SpeziViews", .upToNextMinor(from: "0.3.0"))
],
targets: [
.target(
name: "CardinalKitAccount",
name: "SpeziAccount",
dependencies: [
.product(name: "CardinalKit", package: "CardinalKit"),
.product(name: "CardinalKitViews", package: "CardinalKitViews")
.product(name: "Spezi", package: "Spezi"),
.product(name: "SpeziViews", package: "SpeziViews")
]
),
.testTarget(
name: "CardinalKitAccountTests",
name: "SpeziAccountTests",
dependencies: [
.target(name: "CardinalKitAccount")
.target(name: "SpeziAccount")
]
)
]
Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,39 @@
<!--
This source file is part of the CardinalKit open-source project.
This source file is part of the Spezi open-source project.
SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
SPDX-License-Identifier: MIT
-->

# CardinalKit Account
# Spezi Account

[![Build and Test](https://github.com/StanfordBDHG/CardinalKitAccount/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/StanfordBDHG/CardinalKitAccount/actions/workflows/build-and-test.yml)
[![codecov](https://codecov.io/gh/StanfordBDHG/CardinalKitAccount/branch/main/graph/badge.svg?token=IAfXOmGenQ)](https://codecov.io/gh/StanfordBDHG/CardinalKitAccount)
[![Build and Test](https://github.com/StanfordSpezi/SpeziAccount/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/StanfordSpezi/SpeziAccount/actions/workflows/build-and-test.yml)
[![codecov](https://codecov.io/gh/StanfordSpezi/SpeziAccount/branch/main/graph/badge.svg?token=IAfXOmGenQ)](https://codecov.io/gh/StanfordSpezi/SpeziAccount)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7796499.svg)](https://doi.org/10.5281/zenodo.7796499)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FStanfordBDHG%2FCardinalKitAccount%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/StanfordBDHG/CardinalKitAccount)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FStanfordBDHG%2FCardinalKitAccount%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/StanfordBDHG/CardinalKitAccount)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FStanfordSpezi%2FSpeziAccount%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/StanfordSpezi/SpeziAccount)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FStanfordSpezi%2FSpeziAccount%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/StanfordSpezi/SpeziAccount)

The Account module allows users to incorporate account-related functionality for CardinalKit-based applications.
The Account module allows users to incorporate account-related functionality for Spezi-based applications.

For more information, please refer to the [API documentation](https://swiftpackageindex.com/StanfordBDHG/CardinalKitAccount/documentation).
For more information, please refer to the [API documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziAccount/documentation).


## The CardinalKit Template Application
## The Spezi Template Application

The [CardinalKit Template Application](https://github.com/StanfordBDHG/CardinalKitTemplateApplication) provides a great starting point and example using the CardinalKit Account module.
The [Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication) provides a great starting point and example using the Spezi Account module.


## Contributing

Contributions to this project are welcome. Please make sure to read the [contribution guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md) and the [contributor covenant code of conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md) first.
Contributions to this project are welcome. Please make sure to read the [contribution guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md) and the [contributor covenant code of conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) first.


## License

This project is licensed under the MIT License. See [Licenses](https://github.com/StanfordBDHG/CardinalKitAccount/tree/main/LICENSES) for more information.
This project is licensed under the MIT License. See [Licenses](https://github.com/StanfordSpezi/SpeziAccount/tree/main/LICENSES) for more information.

![Stanford Byers Center for Biodesign Logo](https://raw.githubusercontent.com/StanfordBDHG/.github/main/assets/biodesign-footer-light.png#gh-light-mode-only)
![Stanford Byers Center for Biodesign Logo](https://raw.githubusercontent.com/StanfordBDHG/.github/main/assets/biodesign-footer-dark.png#gh-dark-mode-only)
![Spezi Footer](https://raw.githubusercontent.com/StanfordSpezi/.github/main/assets/FooterLight.png#gh-light-mode-only)
![Spezi Footer](https://raw.githubusercontent.com/StanfordSpezi/.github/main/assets/FooterDark.png#gh-dark-mode-only)
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
//
// This source file is part of the CardinalKit open-source project
// This source file is part of the Spezi open-source project
//
// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
//
// SPDX-License-Identifier: MIT
//

import CardinalKit
import Spezi
import SwiftUI


/// Account-related CardinalKit module managing a collection of ``AccountService``s.
/// Account-related Spezi module managing a collection of ``AccountService``s.
///
/// The ``Account/Account`` type also enables interaction with the ``AccountService``s from anywhere in the view hierachy.
public actor Account: ObservableObject {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// This source file is part of the CardinalKit open-source project
// This source file is part of the Spezi open-source project
//
// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
//
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
//
// This source file is part of the CardinalKit open-source project
// This source file is part of the Spezi open-source project
//
// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
//
// SPDX-License-Identifier: MIT
//

import CardinalKit
import Spezi
import SwiftUI


Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
//
// This source file is part of the CardinalKit open-source project
// This source file is part of the Spezi open-source project
//
// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
//
// SPDX-License-Identifier: MIT
//

import CardinalKit
import CardinalKitViews
import RegexBuilder
import Spezi
import SpeziViews
import SwiftUI


Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
//
// This source file is part of the CardinalKit open-source project
// This source file is part of the Spezi open-source project
//
// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
//
// SPDX-License-Identifier: MIT
//

import CardinalKit
import Spezi
import SwiftUI


Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// This source file is part of the CardinalKit open-source project
// This source file is part of the Spezi open-source project
//
// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
//
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// This source file is part of the CardinalKit open-source project
// This source file is part of the Spezi open-source project
//
// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
//
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
//
// This source file is part of the CardinalKit open-source project
// This source file is part of the Spezi open-source project
//
// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
//
// SPDX-License-Identifier: MIT
//

import CardinalKit
import Spezi
import SwiftUI


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<!--
This source file is part of the CardinalKit open-source project
This source file is part of the Spezi open-source project
SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# ``CardinalKitAccount``
# ``SpeziAccount``

<!--
This source file is part of the CardinalKit open-source project
This source file is part of the Spezi open-source project
SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
Expand All @@ -21,11 +21,11 @@ populate the views.
More specialized views like the ``UsernamePasswordLoginView``, ``UsernamePasswordSignUpView``, ``UsernamePasswordResetPasswordView`` which are automatically provided if you use the
``Login`` view. It uses individual ``AccountService``s like the ``UsernamePasswordAccountService`` to populate the view content and react to user interactions.

You can use the following example using a CardinalKit Component and the configuration as a mechanism to inject the ``Account/Account`` actor into the SwiftUI
You can use the following example using a Spezi Component and the configuration as a mechanism to inject the ``Account/Account`` actor into the SwiftUI
environment. Alternatively, you can use the `environmentObject(_:)` view modifier to manually inject the ``Account/Account`` actor into the SwiftUI environment.


The following example shows a CardinalKit component that creates a `User` class/actor defined within the project to store user-related information and passes it down to an
The following example shows a Spezi component that creates a `User` class/actor defined within the project to store user-related information and passes it down to an
`ExampleUsernamePasswordAccountService` ``AccountService`` that can then modify the `User` instance based on the login or sign up procedure.
The `Component` injects the `Account` and `User` instances into the SwiftUI environment so they can be used by SwiftUI views:
```swift
Expand All @@ -52,12 +52,12 @@ final class ExampleAccountConfiguration<ComponentStandard: Standard>: Component,
}
```

The `ExampleAccountConfiguration` must be added to an instance of `CardinalKitAppDelegate` to inform CardinalKit about your configuration and allow CardinalKit
The `ExampleAccountConfiguration` must be added to an instance of `SpeziAppDelegate` to inform Spezi about your configuration and allow Spezi
to take the `observableObjects`, including the ``Account/Account`` actor, into the SwiftUI environment to make it available for your custom views
and, e.g., the ``Login`` and ``SignUp`` views:

```swift
class TestAppDelegate: CardinalKitAppDelegate {
class TestAppDelegate: SpeziAppDelegate {
override var configuration: Configuration {
Configuration(standard: TestAppStandard()) {
ExampleAccountConfiguration()
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// This source file is part of the CardinalKit open-source project
// This source file is part of the Spezi open-source project
//
// SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
//
Expand Down
Loading

0 comments on commit 8547b11

Please sign in to comment.