forked from StanfordSpezi/SpeziTemplateApplication
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
implement sheet listing all package dependencies from SPM; (StanfordS…
…pezi#36) <!-- This source file is part of the Stanford Spezi open-source project SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md) SPDX-License-Identifier: MIT --> # *Add an Open-Source Contributions Screen* ## ♻️ Current situation & Problem The application currently does not provide any way to see all open-source tools used within the app, nor does it give access to all licenses used. See: [StanfordSpezi#29 ## ⚙️ Release Notes - add a info button to the top right corner of Home view that opens the Contributions sheet - add Contributions sheet that lists all package dependencies used - package dependencies are read via SwiftPackageList API (using a build phase script, the view is always up do date with the latest dependencies). For more info check out the repo: [Swift-Package-List](https://github.com/FelixHerrmann/swift-package-list) - each dependency item in the list shows the package name, version/branch, a license label as well as a link to the GitHub repo - currently detected licenses (shown as tags in the UI) of packages are MIT, Apache-2.0, GPL-2.0, GPL-3.0. Could still be extended in the future. Here is how it looks like:   ## 📚 Documentation TBA ## ✅ Testing - Simple UI test added that tests the info button and the subsequent existence of the contributions sheet ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md). --------- Co-authored-by: Andi <[email protected]> Co-authored-by: Paul Schmiedmayer <[email protected]> Co-authored-by: Philipp, Zagar <[email protected]>
- Loading branch information
4 people
committed
Oct 18, 2023
1 parent
5f4e95c
commit cf19568
Showing
12 changed files
with
511 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| // | ||
| // This source file is part of the Stanford Spezi Template Application project | ||
| // | ||
| // SPDX-FileCopyrightText: 2023 Stanford University | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
| // | ||
|
|
||
| import SwiftPackageList | ||
| import SwiftUI | ||
|
|
||
|
|
||
| struct ContributionsList: View { | ||
| var packages: [Package] = PackageHelper.getPackageList() | ||
|
|
||
| var body: some View { | ||
| List { | ||
| Section(footer: Text("PROJECT_LICENSE_DESCRIPTION")) { | ||
| Text("CONTRIBUTIONS_LIST_DESCRIPTION") | ||
| } | ||
| Section( | ||
| header: Text("CONTRIBUTIONS_LIST_HEADER"), | ||
| footer: Text("CONTRIBUTIONS_LIST_FOOTER") | ||
| ) { | ||
| ForEach(packages.sorted(by: { $0.name < $1.name }), id: \.name) { package in | ||
| PackageCell(package: package) | ||
| } | ||
| } | ||
| } | ||
| .navigationTitle("LICENSE_INFO_TITLE") | ||
| .navigationBarTitleDisplayMode(.inline) | ||
| } | ||
| } | ||
|
|
||
|
|
||
| #if DEBUG | ||
| struct ContributionsList_Previews: PreviewProvider { | ||
| static var previews: some View { | ||
| let mockPackages = [ | ||
| Package( | ||
| name: "MockPackage", | ||
| version: "1.0", | ||
| branch: nil, | ||
| revision: "0", | ||
| // We use a force unwrap in the preview as we can not recover from an error here | ||
| // and the code will never end up in a production environment. | ||
| // swiftlint:disable:next force_unwrapping | ||
| repositoryURL: URL(string: "github.com")!, | ||
| license: "MIT License" | ||
| ) | ||
| ] | ||
| return ContributionsList(packages: mockPackages) | ||
| } | ||
| } | ||
| #endif |
104 changes: 104 additions & 0 deletions
104
TemplateApplication/Contributions/Package+LicenseType.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| // | ||
| // This source file is part of the Stanford Spezi Template Application project | ||
| // | ||
| // SPDX-FileCopyrightText: 2023 Stanford University | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
| // | ||
|
|
||
| import Foundation | ||
| import SwiftPackageList | ||
|
|
||
|
|
||
| // This section of code is based on the SwiftPackageList package: | ||
| // - Original code: https://github.com/FelixHerrmann/swift-package-list/issues/43 | ||
| enum LicenseType { | ||
| case mit | ||
| case apachev2 | ||
| case gplv2 | ||
| case gplv3 | ||
| case bsd2 | ||
| case bsd3 | ||
| case bsd4 | ||
| case zlib | ||
|
|
||
| /// SPDX-License-Identifier for the UI | ||
| var spdxIdentifier: String { | ||
| switch self { | ||
| case .mit: return "MIT" | ||
| case .apachev2: return "Apache-2.0" | ||
| case .gplv2: return "GPL-2.0" | ||
| case .gplv3: return "GPL-3.0" | ||
| case .bsd2: return "BSD-2-Clause" | ||
| case .bsd3: return "BSD-3-Clause" | ||
| case .bsd4: return "BSD-4-Clause" | ||
| case .zlib: return "Zlib" | ||
| } | ||
| } | ||
|
|
||
| /// Initializer that scans the license document for common licenses and versions | ||
| init?(license: String) { | ||
| let license = license | ||
| .replacingOccurrences(of: "\\s+|\\n", with: " ", options: .regularExpression) | ||
|
|
||
| if license.contains(mitText) { | ||
| self = .mit | ||
| } else if license.contains(apacheText) && license.contains("Version 2.0") { | ||
| self = .apachev2 | ||
| } else if license.contains(gnuText) && license.contains("Version 2") { | ||
| self = .gplv2 | ||
| } else if license.contains(gnuText) && license.contains("Version 3") { | ||
| self = .gplv3 | ||
| } else if license.contains(bsdFourClauseText) { | ||
| self = .bsd4 | ||
| } else if license.range(of: bsdThreeClausePattern, options: .regularExpression) != nil { | ||
| self = .bsd3 | ||
| } else if license.contains(bsdTwoClauseText) { | ||
| self = .bsd2 | ||
| } else if license.range(of: zlibPattern, options: .regularExpression) != nil { | ||
| self = .zlib | ||
| } else { | ||
| return nil | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| // Constants representing typical text and regular expression patterns often found in license files. | ||
| // They are used for matching and identifying different types of licenses within text documents. | ||
| let mitText = "MIT License" | ||
| let apacheText = "Apache License" | ||
| let gnuText = "GNU GENERAL PUBLIC LICENSE" | ||
| let bsdTwoClauseText = | ||
| """ | ||
| Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met | ||
| """ | ||
| let bsdThreeClausePattern = | ||
| """ | ||
| Neither the name of (.+) nor the names of (.+) may be used to endorse or promote products derived from this software \ | ||
| without specific prior written permission | ||
| """ | ||
| let bsdFourClauseText = | ||
| """ | ||
| All advertising materials mentioning features or use of this software must display the following acknowledgement: \ | ||
| this product includes software developed by | ||
| """ | ||
| let zlibPattern = | ||
| """ | ||
| The origin of this software must not be misrepresented; you must not claim that you wrote the original software. \ | ||
| If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.(.*) \ | ||
| Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.(.*) \ | ||
| This notice may not be removed or altered from any source distribution. | ||
| """ | ||
|
|
||
|
|
||
| extension Package { | ||
| /// Generates the `LicenseType` from a license document of `String` | ||
| func getLicenseType(license: String?) -> LicenseType? { | ||
| if let license = license { | ||
| let licenseType = LicenseType(license: license) | ||
| return licenseType | ||
| } | ||
| return nil | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| // | ||
| // This source file is part of the Stanford Spezi Template Application project | ||
| // | ||
| // SPDX-FileCopyrightText: 2023 Stanford University | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
| // | ||
|
|
||
| import SwiftPackageList | ||
| import SwiftUI | ||
|
|
||
|
|
||
| struct PackageCell: View { | ||
| let package: Package | ||
|
|
||
| var body: some View { | ||
| HStack { | ||
| VStack(alignment: .leading, spacing: 4) { | ||
| Text(package.name).font(.headline) | ||
| HStack { | ||
| Text(getPackageDetails(package: package)) | ||
| .font(.caption) | ||
| if let licenseType = package.getLicenseType(license: package.license) { | ||
| Text(licenseType.spdxIdentifier) | ||
| .font(.caption) | ||
| .fontWeight(.semibold) | ||
| .padding(2) | ||
| .background(Color(.systemGray5)) | ||
| .cornerRadius(4) | ||
| } | ||
| } | ||
| } | ||
| Spacer() | ||
| Button(action: { | ||
| UIApplication.shared.open(package.repositoryURL) | ||
| }) { | ||
| Image(systemName: "safari.fill") | ||
| .imageScale(.large) | ||
| }.buttonStyle(PlainButtonStyle()) | ||
| .foregroundColor(.blue) | ||
| .accessibilityLabel(Text("Repository Link")) | ||
| } | ||
| } | ||
|
|
||
| func getPackageDetails(package: Package) -> String { | ||
| if let branch = package.branch { | ||
| return "Branch: \(branch)" | ||
| } else if let version = package.version { | ||
| return "Version: \(version)" | ||
| } else { | ||
| return "Revision: \(package.revision)" | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| #if DEBUG | ||
| struct PackageCell_Previews: PreviewProvider { | ||
| static var previews: some View { | ||
| let mockPackage = Package( | ||
| name: "MockPackage", | ||
| version: "1.0", | ||
| branch: nil, | ||
| revision: "0", | ||
| // We use a force unwrap in the preview as we can not recover from an error here | ||
| // and the code will never end up in a production environment. | ||
| // swiftlint:disable:next force_unwrapping | ||
| repositoryURL: URL(string: "github.com")!, | ||
| license: "MIT License" | ||
| ) | ||
| return PackageCell(package: mockPackage).previewLayout(.sizeThatFits) | ||
| } | ||
| } | ||
| #endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| // | ||
| // This source file is part of the Stanford Spezi Template Application project | ||
| // | ||
| // SPDX-FileCopyrightText: 2023 Stanford University | ||
| // | ||
| // SPDX-License-Identifier: MIT | ||
| // | ||
|
|
||
| import Foundation | ||
| import SwiftPackageList | ||
|
|
||
|
|
||
| enum PackageHelper { | ||
| /// Helper function that calls the corrensponding API of `SwiftPackageList`to fetch the list of packages | ||
| static func getPackageList() -> [Package] { | ||
| do { | ||
| let packages = try packageList() | ||
| return packages | ||
| } catch PackageListError.noPackageList { | ||
| print("There is no package-list file") | ||
| } catch { | ||
| print(error) | ||
| } | ||
| return [] | ||
| } | ||
| } |
Oops, something went wrong.