From 1e0a3845723d36026757872cfcd60f8b8a14f693 Mon Sep 17 00:00:00 2001 From: Unay Santisteban Date: Fri, 20 May 2022 13:31:27 +0200 Subject: [PATCH 1/2] Feature/Remove codecov and add Sonarcloud --- .gitattributes | 5 + .github/workflows/test.yml | 30 ++--- LICENSE | 222 +++++++++++++++++++++++++++++++++---- README.md | 3 +- composer.json | 9 +- sonar-project.properties | 8 ++ 6 files changed, 240 insertions(+), 37 deletions(-) create mode 100644 .gitattributes create mode 100644 sonar-project.properties diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..964352c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,5 @@ +/.github export-ignore +/.gitattributes export-ignore +/phpunit.xml export-ignore +/tests export-ignore +/README.md \ No newline at end of file diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 88726c2..a96b744 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,6 +1,9 @@ name: Test on: + push: + branches: + - main pull_request: types: [ opened, synchronize, reopened ] @@ -10,15 +13,13 @@ jobs: strategy: matrix: - php-version: - - "7.4" - - "8.0" + php-version: [ 7.4, 8.0, 8.1 ] steps: - name: Checkout source code uses: actions/checkout@v2 - - name: Install PHP + - name: Set up PHP ${{ matrix.php-version }} uses: shivammathur/setup-php@v2 with: php-version: ${{ matrix.php-version }} @@ -38,16 +39,19 @@ jobs: - name: Install Dependencies run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist + - name: Execute Static Code analysis + run: composer analyse + - name: Execute Unit, Integration and Acceptance Tests run: composer test - - name: Upload coverage report - uses: codecov/codecov-action@v1.0.14 - with: - token: ${{ secrets.CODECOV_TOKEN }} - file: ./coverage.xml - flags: unittests - fail_ci_if_error: true + - name: Fix coverage.xml for Sonar + run: | + sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' coverage.xml + sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' test.xml - - name: Execute Static Code analysis - run: composer analyse + - name: SonarCloud Scan + uses: SonarSource/sonarcloud-github-action@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} diff --git a/LICENSE b/LICENSE index 3829794..261eeb9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,201 @@ -MIT License - -Copyright (c) 2021 Complex Heart - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + 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. diff --git a/README.md b/README.md index bbc8d45..c47981a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # Domain Model [![Tests](https://github.com/ComplexHeart/php-domain-model/actions/workflows/test.yml/badge.svg)](https://github.com/ComplexHeart/php-domain-model/actions/workflows/test.yml) -[![codecov](https://codecov.io/gh/ComplexHeart/php-domain-model/branch/main/graph/badge.svg?token=MFBVoMPYwi)](https://codecov.io/gh/ComplexHeart/php-domain-model) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ComplexHeart_php-domain-model&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=ComplexHeart_php-domain-model) +[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ComplexHeart_php-domain-model&metric=coverage)](https://sonarcloud.io/summary/new_code?id=ComplexHeart_php-domain-model) ## Modeling Aggregates, Entities and Value Objects diff --git a/composer.json b/composer.json index e47035a..5d69e4a 100644 --- a/composer.json +++ b/composer.json @@ -2,7 +2,7 @@ "name": "complex-heart/domain-model", "description": "Domain model toolset to properly build Value Objects, Entities, Aggregates and Services.", "type": "library", - "license": "MIT", + "license": "Apache-2.0", "authors": [ { "name": "Unay Santisteban", @@ -33,7 +33,12 @@ } }, "scripts": { - "test": "vendor/bin/pest --configuration=phpunit.xml --coverage-clover=coverage.xml", + "test": "vendor/bin/pest --configuration=phpunit.xml --coverage-clover=coverage.xml --log-junit=test.xml", "analyse": "vendor/bin/phpstan analyse src --no-progress --level=5" + }, + "config": { + "allow-plugins": { + "pestphp/pest-plugin": true + } } } diff --git a/sonar-project.properties b/sonar-project.properties new file mode 100644 index 0000000..686c0e7 --- /dev/null +++ b/sonar-project.properties @@ -0,0 +1,8 @@ +sonar.projectName=PHP Domain Model +sonar.projectKey=ComplexHeart_php-domain-model +sonar.organization=complexheart +sonar.language=php +sonar.sources=src +sonar.tests=tests +sonar.php.coverage.reportPaths=coverage.xml +sonar.php.tests.reportPath=test.xml From 13ddf713ba4c6bd0f9ac28c83612f8b615476634 Mon Sep 17 00:00:00 2001 From: Unay Santisteban Date: Fri, 20 May 2022 13:56:01 +0200 Subject: [PATCH 2/2] Feature/Remove codecov and add Sonarcloud --- .gitignore | 6 ++++-- composer.json | 2 +- src/ValueObjects/EnumValue.php | 4 ++-- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 43cae52..939b17b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,10 @@ composer.phar /vendor/ .idea/ -/infrastructure +/infrastructure/ +/coverage/ *[N|n]o[G|g]it* -*coverage* +coverage.xml +test.xml .phpunit.result.cache composer.lock diff --git a/composer.json b/composer.json index 5d69e4a..ec97dce 100644 --- a/composer.json +++ b/composer.json @@ -24,7 +24,7 @@ "mockery/mockery": "^1.4", "phpunit/phpunit": "^9.3", "fakerphp/faker": "^1.9.1", - "phpstan/phpstan": "^0.12.64", + "phpstan/phpstan": "^1.6.8", "pestphp/pest": "^1.4" }, "autoload": { diff --git a/src/ValueObjects/EnumValue.php b/src/ValueObjects/EnumValue.php index f62e0e2..dc65c1c 100644 --- a/src/ValueObjects/EnumValue.php +++ b/src/ValueObjects/EnumValue.php @@ -84,7 +84,7 @@ public static function isValid($value): bool */ public static function getLabels(): array { - return array_keys(static::cache()); + return array_keys(self::cache()); } /** @@ -94,7 +94,7 @@ public static function getLabels(): array */ public static function getValues(): array { - return array_values(static::cache()); + return array_values(self::cache()); } /**