Merge pull request #686 from PHPOffice/develop

Release 1.0.0

.github/auto_assign.yml

@@ -0,0 +1,17 @@
+# Set to true to add reviewers to pull requests
+addReviewers: true
+
+# Set to true to add assignees to pull requests
+addAssignees: true
+
+# A list of reviewers to be added to pull requests (GitHub user name)
+reviewers: 
+  - Progi1984
+
+# A list of keywords to be skipped the process that add reviewers if pull requests include it 
+skipKeywords:
+  - WIP
+
+# A number of reviewers added to the pull request
+# Set 0 to add all the reviewers (default: 0)
+numberOfReviewers: 0

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+- package-ecosystem: composer
+  directory: "/"
+  schedule:
+    interval: monthly
+    time: "11:00"
+  open-pull-requests-limit: 10
+  assignees:
+  - Progi1984

.github/workflows/deploy.yml

@@ -0,0 +1,50 @@
+name: Deploy
+
+on:
+  push:
+    branches: 
+      - develop
+  pull_request:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      ### MkDocs
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - name: Install Python Dependencies
+        run: pip install mkdocs-material autolink-references-mkdocs-plugin
+      - name: Build documentation
+        run: mkdocs build --site-dir public
+      ### PHPUnit
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+          extensions: mbstring, intl, gd, xml, dom, json, fileinfo, curl, zip, iconv
+          coverage: xdebug
+      - name: Create directory public/coverage
+        run: mkdir ./public/coverage
+      - name: Create directory public/coverage
+        run: mkdir ./public/docs
+      - name: Install PHP Dependencies
+        run: composer install --ansi --prefer-dist --no-interaction --no-progress
+      - name: Install PhpDocumentor
+        run: wget https://phpdoc.org/phpDocumentor.phar && chmod +x phpDocumentor.phar
+      - name: Build Coverage Report
+        run: XDEBUG_MODE=coverage ./vendor/bin/phpunit -c ./ --coverage-text --coverage-html ./public/coverage
+      - name: Build Documentation
+        run: ./phpDocumentor.phar -d ./src -t ./public/docs
+
+      ### Deploy
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/develop'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./public

.github/workflows/php.yml

@@ -0,0 +1,95 @@
+name: PHPPresentation
+on: [push, pull_request]
+jobs:
+  php-cs-fixer:
+    name: PHP CS Fixer
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+          extensions: mbstring, intl, gd, xml, dom, json, fileinfo, curl, zip, iconv
+      - uses: actions/checkout@v2
+
+      -   name: Validate composer config
+          run: composer validate --strict
+
+      -   name: Composer Install
+          run: composer global require friendsofphp/php-cs-fixer
+
+      -   name: Add environment path
+          run: export PATH="$PATH:$HOME/.composer/vendor/bin"
+
+      -   name: Run PHPCSFixer
+          run: php-cs-fixer fix --dry-run --diff
+
+  phpmd:
+    name: PHP Mess Detector
+    runs-on: ubuntu-latest
+    steps:
+        -   name: Setup PHP
+            uses: shivammathur/setup-php@v2
+            with:
+                php-version: '7.4'
+                extensions: gd, xml, zip
+        -   uses: actions/checkout@v2
+
+        -   name: Composer Install
+            run: composer install --ansi --prefer-dist --no-interaction --no-progress
+
+        -   name: Run phpmd
+            run: ./vendor/bin/phpmd src/,tests/ text ./phpmd.xml.dist
+
+  phpstan:
+    name: PHP Static Analysis
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1']
+    steps:
+        -   name: Setup PHP
+            uses: shivammathur/setup-php@v2
+            with:
+                php-version: ${{ matrix.php }}
+                extensions: gd, xml, zip
+        -   uses: actions/checkout@v2
+
+        -   name: Composer Install
+            run: composer install --ansi --prefer-dist --no-interaction --no-progress
+
+        -   name: Run phpstan
+            run: ./vendor/bin/phpstan analyse -c phpstan.neon.dist
+
+  phpunit:
+    name: PHPUnit
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1']
+    steps:
+      -   name: Setup PHP
+          uses: shivammathur/setup-php@v2
+          with:
+              php-version: ${{ matrix.php }}
+              extensions: gd, xml, zip
+              coverage: xdebug
+
+      -   uses: actions/checkout@v2
+
+      -   name: Composer Install
+          run: composer install --ansi --prefer-dist --no-interaction --no-progress
+
+      -   name: Run phpunit
+          run: ./vendor/bin/phpunit -c phpunit.xml.dist --coverage-clover build/clover.xml
+
+      -   name: Upload coverage results to Coveralls
+          if: matrix.php == '7.3'
+          env:
+            COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          run: |
+            wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.4.3/php-coveralls.phar
+            chmod +x php-coveralls.phar
+            php php-coveralls.phar --coverage_clover=build/clover.xml --json_path=build/coveralls-upload.json -vvv

.gitignore

@@ -6,16 +6,11 @@
 Thumbs.db
 Desktop.ini
 
-### IDE Jetbrains PhpStorm
-.idea
-### IDE Eclipse
-*.settings
-*.project
-*.buildpath
-
 ### Continuous Integration
 build/
 phpunit.xml
+.php-cs-fixer.cache
+.phpunit.result.cache
 composer.phar
 vendor
 /batch_CI.bat

.php-cs-fixer.dist.php

@@ -0,0 +1,44 @@
+<?php
+
+$config = new PhpCsFixer\Config();
+
+$config
+    ->setUsingCache(true)
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony' => true,
+        'array_indentation' => true,
+        'cast_spaces' => [
+            'space' => 'single',
+        ],
+        'combine_consecutive_issets' => true,
+        'concat_space' => [
+            'spacing' => 'one',
+        ],
+        'error_suppression' => [
+            'mute_deprecation_error' => false,
+            'noise_remaining_usages' => false,
+            'noise_remaining_usages_exclude' => [],
+        ],
+        'function_to_constant' => false,
+        'method_chaining_indentation' => true,
+        'no_alias_functions' => false,
+        'no_superfluous_phpdoc_tags' => false,
+        'non_printable_character' => [
+            'use_escape_sequences_in_strings' => true,
+        ],
+        'phpdoc_align' => [
+            'align' => 'left',
+        ],
+        'phpdoc_summary' => false,
+        'protected_to_private' => false,
+        'self_accessor' => false,
+        'yoda_style' => false,
+        'single_line_throw' => false,
+        'no_alias_language_construct_call' => false,
+    ])
+    ->getFinder()
+    ->in(__DIR__)
+    ->exclude('vendor');
+
+return $config;