Merge pull request #98 from bbatsche/deprecate-attribute

Deprecate Attribute

.editorconfig

@@ -6,20 +6,23 @@ trim_trailing_whitespace = true
 charset = utf-8
 indent_style = space
 
-[*.yml]
-indent_size = 2
-
 [*.php]
 indent_size = 4
 
-[*.xml]
+[*.{xml,xml.dist}]
 indent_size = 4
 
+[*.{yml,yaml}]
+indent_size = 2
+
 [*.{neon,neon.dist}]
 indent_size = 2
 
 [*.json]
 indent_size = 4
 
+[*.md]
+indent_size = 2
+
 [Makefile]
 indent_style = tab

.gitattributes

@@ -2,11 +2,13 @@
 # https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
 
 # Ignore all test and miscellaneous support files with "export-ignore".
-/.*                export-ignore
-/dev               export-ignore
-/docs              export-ignore
-/captainhook.json  export-ignore
-/phpstan.neon.dist export-ignore
-/phpstan           export-ignore
-/phpunit.xml       export-ignore
-/test              export-ignore
+/.*                 export-ignore
+/dev                export-ignore
+/docs               export-ignore
+/captainhook.json   export-ignore
+/CHANGELOG.md       export-ignore
+/CODE_OF_CONDUCT.md export-ignore
+/CONTRIBUTING.md    export-ignore
+/phpstan.neon.dist  export-ignore
+/phpunit.xml.dist   export-ignore
+/test               export-ignore

.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,39 @@
+<!--
+    Thank you for your contribution to BeBat\Verify!
+
+    Complete this template and the project maintainers will do
+    their best to review your pull request in a timely manner.
+-->
+
+<!--
+    Make sure you are targeting the correct branch with this pull request.
+    Changes to the current release version should go into the `main` branch.
+    If this is a fix for a prior version make sure to target the correct version branch.
+-->
+
+<!-- Please give this pull request a meaningful title that briefly summarizes its content -->
+
+## Description
+
+<!--
+    Describe the contents of this change in as much detail as possible.
+    Please include *why* this change is important and what benefit it provides.
+
+    If this change relates to an open issue be sure to reference it here as well.
+-->
+
+## Contribution Checklist
+
+- [ ] The contents of this pull request are my own work and may be distributed under the terms of the project license
+- [ ] I have read and agree to the Contributing guidelines and the Code of Conduct
+- [ ] All new changes are covered by tests
+- [ ] All previous tests and checks are passing
+- [ ] I have included documentation about this change
+- [ ] The details of this change have been added to the `Unreleased` section of the CHANGELOG.md
+
+**This pull request includes:**
+
+- [ ] Breaking changes to existing functionality (major release)
+- [ ] New functionality (minor release)
+- [ ] Fixes for existing functionality (patch release)
+- [ ] Fixes to an earlier major or minor release version

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,55 @@
+name: Bug Report
+description: Report an issue with BeBat\Verify
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: Thank you for taking the time to fill out this bug report!
+
+  - type: textarea
+    attributes:
+      label: Description
+      description: A brief description of the bug
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to Reproduce
+      description: What was the process that led to this bug?
+      value: |
+        1.
+        2.
+        3.
+        ...
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected Result
+      description: What did you expect to happen when following the steps to reproduce?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Actual Result
+      description: What actually happened?
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: "<Project Name> Version"
+      placeholder: "1.2.3"
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: PHP Version
+      placeholder: "7.x.x or 8.x.x"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,34 @@
+name: Feature Request
+description: Propose a new feature for BeBat\Verify
+title: "[Feature]: "
+labels: ["feature"]
+body:
+  - type: markdown
+    attributes:
+      value: Thank you for taking the time to propose a new feature!
+
+  - type: textarea
+    attributes:
+      label: Description
+      description: A brief description of the feature you'd like to propose
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Example Code
+      description: |
+        One or more examples of how you think the feature should work and what
+        its results would be
+      render: php
+
+  - type: dropdown
+    attributes:
+      label: Release Target
+      description: |
+        Would this feature be a major (breaking) change to existing
+        functionality or can it go into a minor release?
+      options:
+        - Unknown
+        - Minor
+        - Major

.github/workflows/acceptance.yml

@@ -13,14 +13,15 @@ on:
 
 jobs:
   acceptance-tests:
-    name: Acceptance Tests PHP ${{ matrix.versions.php }} / PHPUnit ${{ matrix.phpunit_version }}
+    name: PHP ${{ matrix.versions.php }} / PHPUnit ${{ matrix.phpunit_version }}
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
         phpunit_version:
           - 8
           - 9
+          - 10
         versions:
           - php: "7.2"
             composer: 1
@@ -32,13 +33,37 @@ jobs:
             composer: 2
           - php: "8.1"
             composer: 2
+          - php: "8.2"
+            composer: 2
         exclude:
+          - versions:
+              php: "8.0"
+            phpunit_version: 8
+          - versions:
+              php: "8.1"
+            phpunit_version: 8
+          - versions:
+              php: "8.2"
+            phpunit_version: 8
           - versions:
               php: "7.2"
             phpunit_version: 9
+          - versions:
+              php: "7.2"
+            phpunit_version: 10
+          - versions:
+              php: "7.3"
+            phpunit_version: 10
+          - versions:
+              php: "7.4"
+            phpunit_version: 10
+          - versions:
+              php: "8.0"
+            phpunit_version: 10
 
     steps:
       - uses: actions/checkout@v3
+
       - name: Setup PHP ${{ matrix.versions.php }}
         uses: shivammathur/setup-php@v2
         with:
@@ -48,7 +73,7 @@ jobs:
 
       - name: Get Composer Cache Directory
         id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
 
       - name: Cache Dependencies
         uses: actions/cache@v3
@@ -60,19 +85,22 @@ jobs:
             ${{ runner.os }}-composer-
 
       - name: Update PHPUnit Version
-        run: composer require --no-update --no-interaction --no-progress --prefer-dist --update-with-all-dependencies phpunit/phpunit:^${{ matrix.phpunit_version }}.0
+        run: composer require --no-update --no-interaction --no-progress --update-with-all-dependencies phpunit/phpunit:^${{ matrix.phpunit_version }}.0
 
       - name: Install Dependencies
         run: composer install --no-interaction --no-progress
 
+      - name: Check composer.json Format
+        run: composer normalize --diff --dry-run --no-interaction --ansi
+
       - name: Check Code Style
         run: composer style:check
 
       - name: Run Static Analysis
         run: composer test:static -- --no-progress
 
       - name: Run Unit & Functional Tests
-        run: composer test:coverage -- -v
+        run: composer test:coverage
 
       - name: Upload Coverage
         uses: codecov/codecov-action@v3

.gitignore

@@ -1,5 +1,5 @@
-# Created by https://www.toptal.com/developers/gitignore/api/linux,macos,phpunit,composer,intellij+all,visualstudiocode
-# Edit at https://www.toptal.com/developers/gitignore?templates=linux,macos,phpunit,composer,intellij+all,visualstudiocode
+# Created by https://www.toptal.com/developers/gitignore/api/linux,macos,phpunit,composer,intellij+all,php-cs-fixer,visualstudiocode
+# Edit at https://www.toptal.com/developers/gitignore?templates=linux,macos,phpunit,composer,intellij+all,php-cs-fixer,visualstudiocode
 
 ### Composer ###
 composer.phar
@@ -73,6 +73,9 @@ atlassian-ide-plugin.xml
 # Cursive Clojure plugin
 .idea/replstate.xml
 
+# SonarLint plugin
+.idea/sonarlint/
+
 # Crashlytics plugin (for Android Studio and IntelliJ)
 com_crashlytics_export_strings.xml
 crashlytics.properties
@@ -86,20 +89,13 @@ fabric.properties
 .idea/caches/build_file_checksums.ser
 
 ### Intellij+all Patch ###
-# Ignores the whole .idea folder and all .iml files
-# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
-
-.idea/
-
-# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+# Ignore everything but code style settings and run configurations
+# that are supposed to be shared within teams.
 
-*.iml
-modules.xml
-.idea/misc.xml
-*.ipr
+.idea/*
 
-# Sonarlint plugin
-.idea/sonarlint
+!.idea/codeStyles
+!.idea/runConfigurations
 
 ### Linux ###
 *~
@@ -144,6 +140,20 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### PHP-CS-Fixer ###
+# Covers PHP CS Fixer
+# Reference: https://cs.symfony.com/
+
+# Generated files
+.php-cs-fixer.cache
+
+# Local config See: https://cs.symfony.com/doc/config.html
+.php-cs-fixer.php
+
 ### PHPUnit ###
 # Covers PHPUnit
 # Reference: https://phpunit.de/
@@ -165,23 +175,21 @@ Temporary Items
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
-*.code-workspace
+!.vscode/*.code-snippets
 
 # Local History for Visual Studio Code
 .history/
 
+# Built Visual Studio Code Extensions
+*.vsix
+
 ### VisualStudioCode Patch ###
 # Ignore all local history of files
 .history
 .ionide
 
-# Support for Project snippet scope
-!.vscode/*.code-snippets
-
-# End of https://www.toptal.com/developers/gitignore/api/linux,macos,phpunit,composer,intellij+all,visualstudiocode
+# End of https://www.toptal.com/developers/gitignore/api/linux,macos,phpunit,composer,intellij+all,php-cs-fixer,visualstudiocode
 
-/.php-cs-fixer.cache
-/.php-cs-fixer.php
 /coverage.xml
 /phpstan.neon
 /captainhook.config.json