Merge pull request #80 from Art4/79-reuse-tool-and-spdx-copyright-com…

…ments

Use reuse tool for spdx copyright comments

.docker/Dockerfile-php82

@@ -8,6 +8,7 @@ RUN apt-get --yes --no-install-recommends install \
     vim \
     curl \
     build-essential \
+    pipx \
     locales \
     zip unzip \
     libfreetype6-dev \

.gitattributes

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 /.docker            export-ignore
 /.gitattributes     export-ignore
 /.gitignore         export-ignore

.gitignore

@@ -1,7 +1,5 @@
 .idea
 .php-cs-fixer.cache
 .phpunit.cache
-composer.phar
 composer.lock
-php-cs-fixer.phar
 vendor

.php-cs-fixer.dist.php

@@ -1,5 +1,9 @@
 <?php
 
+// SPDX-FileCopyrightText: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
+
 $finder = (new PhpCsFixer\Finder())
     ->in('src')
     ->in('tests')

.phpstan.neon

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 parameters:
 	level: 8
 

.reuse/dep5

@@ -0,0 +1,65 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: art4/json-api-client
+Upstream-Contact: Artur Weigandt <[email protected]>
+Source: https://github.com/Art4/json-api-client
+
+# Sample paragraph, commented out:
+#
+# Files: src/*
+# Copyright: $YEAR $NAME <$CONTACT>
+# License: ...
+
+Files: .docker/*
+Copyright: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+License: GPL-3.0-or-later
+
+Files: .github/*
+Copyright: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+License: GPL-3.0-or-later
+
+Files: .gitignore
+Copyright: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+License: GPL-3.0-or-later
+
+Files: CHANGELOG.md
+Copyright: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+License: GPL-3.0-or-later
+
+Files: composer.json
+Copyright: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+License: GPL-3.0-or-later
+
+Files: composer.lock
+Copyright: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+License: GPL-3.0-or-later
+
+Files: docs/*
+Copyright: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+License: GPL-3.0-or-later
+
+Files: phpunit.xml
+Copyright: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+License: GPL-3.0-or-later
+
+Files: README.md
+Copyright: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+License: GPL-3.0-or-later
+
+Files: tests/files/*
+Copyright: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+License: GPL-3.0-or-later
+
+# Ignore following folders
+# for some reason reuse does not ignore files defined in .gitignore
+
+Files: .phpunit.cache/*
+Copyright: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+License: GPL-3.0-or-later
+
+Files: .php-cs-fixer.cache
+Copyright: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+License: GPL-3.0-or-later
+
+Files: vendor/*
+Copyright: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+License: GPL-3.0-or-later

README.md

@@ -115,15 +115,57 @@ Need more functionality? Want to directly inject your model? Easily extend JsonA
 
 Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
 
-## :white_check_mark: Testing
+## :wrench: Contributing
+
+Please feel free to fork and sending Pull Requests. This project follows [Semantic Versioning 2](http://semver.org) and [PSR-2](http://www.php-fig.org/psr/psr-2/).
+
+This projects comes with a `docker-compose.yml` where all tools for development are available.
+
+Run `docker compose build` to build the image. Once you've build it, run `docker compose up -d` to start the container in the background.
+
+Run `docker compose exec -u 1000 php bash` to use the bash inside the running container. There you can use all tools, e.g. composer with `composer --version`
+
+Use `exit` to logout from the container and `docker compose stop` to stop the running container.
+
+All following commands can be run inside the running docker container.
+
+### :white_check_mark: Testing
+
+Run PHPUnit for all tests:
 
 ``` bash
-$ phpunit
+$ composer run phpunit
 ```
 
-## :wrench: Contributing
+Run PHPStan for static code analysis:
 
-Please feel free to fork and sending Pull Requests. This project follows [Semantic Versioning 2](http://semver.org) and [PSR-2](http://www.php-fig.org/psr/psr-2/).
+``` bash
+$ composer run phpstan
+```
+
+Let PHPUnit generate a HTLM code coverage report:
+
+``` bash
+$ composer run coverage
+```
+
+You can find the code coverage report in `.phpunit.cache/code-coverage/index.html`.
+
+### :white_check_mark: REUSE
+
+The [REUSE Helper tool](https://reuse.software/dev/) makes licensing easy for humans and machines alike. It downloads the full license texts, adds copyright and license information to file headers, and contains a linter to identify problems.
+
+Check all files for REUSE spec compliance:
+
+``` bash
+composer run reuse-lint
+```
+
+Run this command to annotate PHP files in src and tests folders:
+
+``` bash
+composer run reuse-annotate
+```
 
 ## :heart: Credits
 

composer.json

@@ -33,7 +33,9 @@
     "scripts": {
         "coverage": "phpunit --coverage-html=\".phpunit.cache/code-coverage\"",
         "phpstan": "phpstan analyze --memory-limit 512M --configuration .phpstan.neon",
-        "phpunit": "phpunit"
+        "phpunit": "phpunit",
+        "reuse-annotate": "pipx run reuse annotate src tests --license=\"GPL-3.0-or-later\" --copyright=\"2015-2023 Artur Weigandt https://wlabs.de/kontakt\" --recursive --exclude-year --copyright-style=\"spdx\"",
+        "reuse-lint": "pipx run reuse --suppress-deprecation lint"
     },
     "config": {
         "sort-packages": true

docker-compose.yml

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 version: "3.7"
 
 services:

src/Accessable.php

@@ -1,21 +1,8 @@
 <?php
-/*
- * A PHP Library to handle a JSON API body in an OOP way.
- * Copyright (C) 2015-2021  Artur Weigandt  https://wlabs.de/kontakt
 
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
+// SPDX-FileCopyrightText: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
 
 namespace Art4\JsonApiClient;
 

src/Element.php

@@ -1,21 +1,8 @@
 <?php
-/*
- * A PHP Library to handle a JSON API body in an OOP way.
- * Copyright (C) 2015-2021  Artur Weigandt  https://wlabs.de/kontakt
 
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
+// SPDX-FileCopyrightText: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
 
 namespace Art4\JsonApiClient;
 

src/Exception/AccessException.php

@@ -1,21 +1,8 @@
 <?php
-/*
- * A PHP Library to handle a JSON API body in an OOP way.
- * Copyright (C) 2015-2021  Artur Weigandt  https://wlabs.de/kontakt
 
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
+// SPDX-FileCopyrightText: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
 
 namespace Art4\JsonApiClient\Exception;
 

src/Exception/Exception.php

@@ -1,21 +1,8 @@
 <?php
-/*
- * A PHP Library to handle a JSON API body in an OOP way.
- * Copyright (C) 2015-2021  Artur Weigandt  https://wlabs.de/kontakt
 
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
+// SPDX-FileCopyrightText: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
 
 namespace Art4\JsonApiClient\Exception;
 

src/Exception/FactoryException.php

@@ -1,21 +1,8 @@
 <?php
-/*
- * A PHP Library to handle a JSON API body in an OOP way.
- * Copyright (C) 2015-2021  Artur Weigandt  https://wlabs.de/kontakt
 
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
+// SPDX-FileCopyrightText: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
 
 namespace Art4\JsonApiClient\Exception;
 

src/Exception/InputException.php

@@ -1,21 +1,8 @@
 <?php
-/*
- * A PHP Library to handle a JSON API body in an OOP way.
- * Copyright (C) 2015-2021  Artur Weigandt  https://wlabs.de/kontakt
 
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
+// SPDX-FileCopyrightText: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
 
 namespace Art4\JsonApiClient\Exception;
 

src/Exception/ValidationException.php

@@ -1,21 +1,8 @@
 <?php
-/*
- * A PHP Library to handle a JSON API body in an OOP way.
- * Copyright (C) 2015-2021  Artur Weigandt  https://wlabs.de/kontakt
 
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
+// SPDX-FileCopyrightText: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
 
 namespace Art4\JsonApiClient\Exception;
 

src/Factory.php

@@ -1,21 +1,8 @@
 <?php
-/*
- * A PHP Library to handle a JSON API body in an OOP way.
- * Copyright (C) 2015-2021  Artur Weigandt  https://wlabs.de/kontakt
 
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
+// SPDX-FileCopyrightText: 2015-2023 Artur Weigandt https://wlabs.de/kontakt
+//
+// SPDX-License-Identifier: GPL-3.0-or-later
 
 namespace Art4\JsonApiClient;