From bb8d2be87f5ac51da4d3deed5400867e48b0f750 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Mon, 6 Oct 2025 17:29:09 +0200 Subject: [PATCH 1/8] Defined the platforms, product, and targets to start work in the Package.swift file. --- Package.swift | 38 +++++++++++++------ .../discogs_service.swift | 0 .../discogs_serviceTests.swift | 0 3 files changed, 27 insertions(+), 11 deletions(-) rename Sources/{discogs-service => DiscogsService}/discogs_service.swift (100%) rename Tests/{discogs-serviceTests => DiscogsService}/discogs_serviceTests.swift (100%) diff --git a/Package.swift b/Package.swift index 6d7e01567..1a8f71a73 100644 --- a/Package.swift +++ b/Package.swift @@ -1,26 +1,42 @@ -// swift-tools-version: 6.2 -// The swift-tools-version declares the minimum version of Swift required to build this package. +// swift-tools-version: 5.10 import PackageDescription let package = Package( - name: "discogs-service", + name: DiscogsService.package, + platforms: [ + .iOS(.v13), + .macOS(.v10_15), + .tvOS(.v13), + .visionOS(.v1), + .watchOS(.v6) + ], products: [ - // Products define the executables and libraries a package produces, making them visible to other packages. .library( - name: "discogs-service", - targets: ["discogs-service"] + name: DiscogsService.package, + targets: [DiscogsService.target] ), ], + dependencies: [], targets: [ - // Targets are the basic building blocks of a package, defining a module or a test suite. - // Targets can depend on other targets in this package and products from dependencies. .target( - name: "discogs-service" + name: DiscogsService.target, + path: "Sources/\(DiscogsService.target)" ), .testTarget( - name: "discogs-serviceTests", - dependencies: ["discogs-service"] + name: DiscogsService.test, + dependencies: [ + .byName(name: DiscogsService.target) + ], + path: "Tests/\(DiscogsService.target)" ), ] ) + +// MARK: - Constants + +enum DiscogsService { + static let package = "discogs-service" + static let target = "DiscogsService" + static let test = "\(DiscogsService.target)Tests" +} diff --git a/Sources/discogs-service/discogs_service.swift b/Sources/DiscogsService/discogs_service.swift similarity index 100% rename from Sources/discogs-service/discogs_service.swift rename to Sources/DiscogsService/discogs_service.swift diff --git a/Tests/discogs-serviceTests/discogs_serviceTests.swift b/Tests/DiscogsService/discogs_serviceTests.swift similarity index 100% rename from Tests/discogs-serviceTests/discogs_serviceTests.swift rename to Tests/DiscogsService/discogs_serviceTests.swift From 4dac2d9308acd6f93d175ee06a452a740c471db0 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Mon, 6 Oct 2025 17:31:04 +0200 Subject: [PATCH 2/8] Defined the folders and files to ignore in the .gitignore file. --- .gitignore | 37 +++++++++++++++++++++++++++++++++---- 1 file changed, 33 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 0023a5340..8fbf40e5f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,37 @@ +# Mac OS .DS_Store -/.build -/Packages -xcuserdata/ +.netrc + +# Xcode DerivedData/ + +## User settings +xcuserdata/ + +## Obj-C/Swift specific +*.hmap + +## App packaging +*.ipa +*.dSYM.zip +*.dSYM + +# Swift Package Manager +# Add this line if you want to avoid checking in source code from Swift Package Manager dependencies. +Packages/ +# Package.pins +# Package.resolved +*.xcodeproj +.build +.devContainer +# Xcode automatically generates this directory with a .xcworkspacedata file and xcuserdata +# hence it is not needed unless you have added a package configuration file to your project +.swiftpm .swiftpm/configuration/registries.json .swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata -.netrc + +# Visual Studio Code +.vscode + +# DocC documentation +*.doccarchive \ No newline at end of file From b2031201a8ebf9b7b15a6b043fca3ead728dfeca Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Mon, 6 Oct 2025 17:33:10 +0200 Subject: [PATCH 3/8] Defined some library, packages, documentation and IDE tasks in the Makefile file. --- .env | 10 ++++++ Makefile | 92 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 102 insertions(+) create mode 100644 .env create mode 100644 Makefile diff --git a/.env b/.env new file mode 100644 index 000000000..251251be8 --- /dev/null +++ b/.env @@ -0,0 +1,10 @@ +# --- DOCUMENTATION --- + +DOCC_ARCHIVE_OUTPUT=./${SPM_LIBRARY_TARGET}.doccarchive +DOCC_GITHUB_OUTPUT=./docs +DOCC_GITHUB_BASE_PATH=discogs-service +DOCC_PREVIEW_URL=http://localhost:8080/documentation/discogsservice + +# -- SWIFT PACKAGE MANAGER --- + +SPM_LIBRARY_TARGET=DiscogsService \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 000000000..3891ab7a3 --- /dev/null +++ b/Makefile @@ -0,0 +1,92 @@ +# ENVIRONMENT VARIABLES + +environment ?= .env + +include $(environment) +export $(shell sed 's/=.*//' $(environment)) + +# LIBRARY + +lib-build: ## Builds the library + @swift build + +lib-release: ## Releases the library + @swift build -c release + +lib-test: ## Runs the unit tests for the library + @swift test \ + --disable-xctest \ + --enable-code-coverage \ + --enable-swift-testing \ + --parallel + +# SWIFT PACKAGE MANAGER + +pkg-clean: ## Deletes built SPM artifacts of the package + @swift package clean + +pkg-reset: ## Resets the complete SPM cache/build folder of the package + @swift package reset + +pkg-pristine: pkg-clean pkg-reset ## Deletes all built artifacts, caches, and documentations of the package + @rm -drf $(DOCC_ARCHIVE_OUTPUT) + @rm -drf $(DOCC_GITHUB_OUTPUT) + +pkg-outdated: ## Lists the SPM package dependencies that can be updated + @swift package update --dry-run + +pkg-update: ## Updates the SPM package dependencies + @swift package update + +# DOCUMENTATION + +doc-generate: doc-generate-archive doc-generate-github ## Generates the library documentation for both Github and Xcode + +doc-generate-archive: ## Generates the library documentation archive for Xcode + @swift package \ + --allow-writing-to-directory $(DOCC_ARCHIVE_OUTPUT) \ + generate-documentation \ + --target $(SPM_LIBRARY_TARGET) \ + --include-extended-types \ + --enable-inherited-docs \ + --output-path $(DOCC_ARCHIVE_OUTPUT) + +doc-generate-github: ## Generates the library documentation for Github + @swift package \ + --allow-writing-to-directory $(DOCC_GITHUB_OUTPUT) \ + generate-documentation \ + --target $(SPM_LIBRARY_TARGET) \ + --disable-indexing \ + --transform-for-static-hosting \ + --include-extended-types \ + --enable-inherited-docs \ + --hosting-base-path $(DOCC_GITHUB_BASE_PATH) \ + --output-path $(DOCC_GITHUB_OUTPUT) + +doc-preview: ## Previews the library documentation in Safari + @open -a safari $(DOCC_PREVIEW_URL) + @swift package \ + --disable-sandbox \ + preview-documentation \ + --target $(SPM_LIBRARY_TARGET) \ + --include-extended-types \ + --enable-inherited-docs + +# IDE + +ide-xcode: ## Opens this package with Xcode + @open -a Xcode Package.swift + +ide-vscode: ## Opens this package with Visual Studio Code + @code . + +# HELP + +# Output the documentation for each of the defined tasks when `help` is called. +# Reference: https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html +.PHONY: help + +help: ## Prints the written documentation for all the defined tasks + @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) + +.DEFAULT_GOAL := help \ No newline at end of file From 20a842c1d6a591448839c536ac732e3144274e52 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Mon, 6 Oct 2025 17:34:27 +0200 Subject: [PATCH 4/8] Added the swift-docc-plugin package as a dependency in the Package.swift file. --- Package.swift | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Package.swift b/Package.swift index 1a8f71a73..f959ad003 100644 --- a/Package.swift +++ b/Package.swift @@ -17,7 +17,9 @@ let package = Package( targets: [DiscogsService.target] ), ], - dependencies: [], + dependencies: [ + .package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.1.0") + ], targets: [ .target( name: DiscogsService.target, From 0812ee20863d7009c50ce93fc6e7dde7c3f87bfd Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Mon, 6 Oct 2025 17:37:19 +0200 Subject: [PATCH 5/8] Added the DocC documentation catalog to the library target. --- .../Catalogs/DiscogsService.docc/Library.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 Sources/DiscogsService/Catalogs/DiscogsService.docc/Library.md diff --git a/Sources/DiscogsService/Catalogs/DiscogsService.docc/Library.md b/Sources/DiscogsService/Catalogs/DiscogsService.docc/Library.md new file mode 100644 index 000000000..e5f6b90fb --- /dev/null +++ b/Sources/DiscogsService/Catalogs/DiscogsService.docc/Library.md @@ -0,0 +1,13 @@ +# ``DiscogsService`` + +Summary + +## Overview + +Text + +## Topics + +### Group + +- ``Symbol`` From 61d7fdfe0b53040f490786acf56e514cb173a40c Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Mon, 6 Oct 2025 17:38:52 +0200 Subject: [PATCH 6/8] Added a README.md file. --- README.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..db4e7d3fa --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# Discogs Service From 66fbe46c135b30ed7f15dc85f7970bd162153e7f Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Mon, 6 Oct 2025 18:06:01 +0200 Subject: [PATCH 7/8] Applied the Apache v2 license to the project, and added the CONTRIBUTORS and NOTICE files. --- CONTRIBUTORS | 14 ++++ LICENSE | 201 +++++++++++++++++++++++++++++++++++++++++++++++++++ NOTICE | 20 +++++ 3 files changed, 235 insertions(+) create mode 100644 CONTRIBUTORS create mode 100644 LICENSE create mode 100644 NOTICE diff --git a/CONTRIBUTORS b/CONTRIBUTORS new file mode 100644 index 000000000..e522c40ac --- /dev/null +++ b/CONTRIBUTORS @@ -0,0 +1,14 @@ +For the purpose of tracking copyright, this is the list of individuals and +organizations who have contributed source code to discogs-service. + +For employees of an organization/company where the copyright of work done +by employees of that company is held by the company itself, only the company +needs to be listed here. + +## COPYRIGHT HOLDERS + +- Röck+Cöde VoF. (all contributors with '@rock-n-code.com') + +## PROJECT AUTHORS + +- Javier Cicchelli \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..f49a4e16e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/NOTICE b/NOTICE new file mode 100644 index 000000000..f5bfcc42e --- /dev/null +++ b/NOTICE @@ -0,0 +1,20 @@ + Discogs Service Project + ======================= + +Please visit the Discogs Service web site for more information: + + * https://github.com/rock-n-code/discogs-service + +Copyright 2025 Röck+Cöde VoF + +The Discogs Service Project licenses this file to you under the Apache License, +version 2.0 (the "License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at: + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +License for the specific language governing permissions and limitations +under the License. \ No newline at end of file From 80ab289ae80b4aa3deb263ad143be397310c2323 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Mon, 6 Oct 2025 18:10:59 +0200 Subject: [PATCH 8/8] Added the files headers to the existing files in the project. --- .env | 14 ++++++++++++++ .gitignore | 14 ++++++++++++++ Makefile | 14 ++++++++++++++ Package.swift | 14 ++++++++++++++ 4 files changed, 56 insertions(+) diff --git a/.env b/.env index 251251be8..7d675b607 100644 --- a/.env +++ b/.env @@ -1,3 +1,17 @@ +## ===----------------------------------------------------------------------=== +## +## This source file is part of the DiscogsService open source project +## +## Copyright (c) 2025 Röck+Cöde VoF. and the DiscogsService project authors +## Licensed under Apache license v2.0 +## +## See LICENSE for license information +## See CONTRIBUTORS for the list of DiscogsService project authors +## +## SPDX-License-Identifier: Apache-2.0 +## +## ===----------------------------------------------------------------------=== + # --- DOCUMENTATION --- DOCC_ARCHIVE_OUTPUT=./${SPM_LIBRARY_TARGET}.doccarchive diff --git a/.gitignore b/.gitignore index 8fbf40e5f..fac8b4a6f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,17 @@ +## ===----------------------------------------------------------------------=== +## +## This source file is part of the DiscogsService open source project +## +## Copyright (c) 2025 Röck+Cöde VoF. and the DiscogsService project authors +## Licensed under Apache license v2.0 +## +## See LICENSE for license information +## See CONTRIBUTORS for the list of DiscogsService project authors +## +## SPDX-License-Identifier: Apache-2.0 +## +## ===----------------------------------------------------------------------=== + # Mac OS .DS_Store .netrc diff --git a/Makefile b/Makefile index 3891ab7a3..f8bd6d08f 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,17 @@ +## ===----------------------------------------------------------------------=== +## +## This source file is part of the DiscogsService open source project +## +## Copyright (c) 2025 Röck+Cöde VoF. and the DiscogsService project authors +## Licensed under Apache license v2.0 +## +## See LICENSE for license information +## See CONTRIBUTORS for the list of DiscogsService project authors +## +## SPDX-License-Identifier: Apache-2.0 +## +## ===----------------------------------------------------------------------=== + # ENVIRONMENT VARIABLES environment ?= .env diff --git a/Package.swift b/Package.swift index f959ad003..38da85187 100644 --- a/Package.swift +++ b/Package.swift @@ -1,5 +1,19 @@ // swift-tools-version: 5.10 +// ===----------------------------------------------------------------------=== +// +// This source file is part of the DiscogsService open source project +// +// Copyright (c) 2025 Röck+Cöde VoF. and the DiscogsService project authors +// Licensed under Apache license v2.0 +// +// See LICENSE for license information +// See CONTRIBUTORS for the list of DiscogsService project authors +// +// SPDX-License-Identifier: Apache-2.0 +// +// ===----------------------------------------------------------------------=== + import PackageDescription let package = Package(