From 51b3a9b4b2e1089b6a8915876ae8b3fe01e90fa6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andreas=20M=C3=B6ller?= <am@localheinz.com>
Date: Sat, 8 Feb 2020 16:49:44 +0100
Subject: [PATCH] Enhancement: Modernize build automation

---
 .github/workflows/ci.yml |  89 ++++++++++
 .gitignore               |   4 +-
 .php_cs.dist             | 358 ++++++++++++++++++++-------------------
 .travis.yml              |  17 --
 README.md                |  31 ++--
 5 files changed, 290 insertions(+), 209 deletions(-)
 create mode 100644 .github/workflows/ci.yml
 delete mode 100644 .travis.yml

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
new file mode 100644
index 0000000..1fcc8f2
--- /dev/null
+++ b/.github/workflows/ci.yml
@@ -0,0 +1,89 @@
+# https://help.github.com/en/categories/automating-your-workflow-with-github-actions
+
+on:
+  - "pull_request"
+  - "push"
+
+name: "CI"
+
+jobs:
+  coding-guidelines:
+    name: "Coding Guidelines"
+
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+
+      - name: "Run friendsofphp/php-cs-fixer"
+        run: "php7.3 ./tools/php-cs-fixer fix --diff-format=udiff --dry-run --show-progress=dots --using-cache=no --verbose"
+
+  type-checker:
+    name: "Type Checker"
+
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+
+      - name: "Set COMPOSER_ROOT_VERSION environment variable"
+        uses: "docker://ergebnis/composer-root-version-action:0.1.3"
+
+      - name: "Update dependencies with composer"
+        run: "php7.3 ./tools/composer update --no-ansi --no-interaction --no-progress --no-suggest"
+
+      - name: "Run vimeo/psalm"
+        run: "php7.3 ./tools/psalm --config=psalm.xml --no-progress --shepherd --show-info=false --stats"
+
+  tests:
+    name: "Tests"
+
+    runs-on: "ubuntu-latest"
+
+    strategy:
+      matrix:
+        php-version:
+          - "7.3"
+          - "7.4"
+
+        dependencies:
+          - "lowest"
+          - "highest"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+
+      - name: "Install PHP with extensions"
+        uses: "shivammathur/setup-php@v1"
+        with:
+          php-version: "${{ matrix.php-version }}"
+          coverage: "pcov"
+
+      - name: "Cache dependencies installed with composer"
+        uses: "actions/cache@v1"
+        with:
+          path: "~/.composer/cache"
+          key: "php${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('**/composer.json') }}"
+          restore-keys: "php${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-"
+
+      - name: "Set COMPOSER_ROOT_VERSION environment variable"
+        uses: "docker://ergebnis/composer-root-version-action:0.1.3"
+
+      - name: "Install lowest dependencies with composer"
+        if: "matrix.dependencies == 'lowest'"
+        run: "./tools/composer update --no-ansi --no-interaction --no-progress --no-suggest --prefer-lowest"
+
+      - name: "Install highest dependencies with composer"
+        if: "matrix.dependencies == 'highest'"
+        run: "./tools/composer update --no-ansi --no-interaction --no-progress --no-suggest"
+
+      - name: "Run tests with phpunit/phpunit"
+        run: "vendor/bin/phpunit --coverage-clover=coverage.xml"
+
+      - name: "Send code coverage report to Codecov.io"
+        env:
+          CODECOV_TOKEN: "${{ secrets.CODECOV_TOKEN }}"
+        run: "bash <(curl -s https://codecov.io/bash) || true"
diff --git a/.gitignore b/.gitignore
index 61e6e40..96c0f28 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,6 @@
 /.idea
-/composer.lock
-/vendor
 /.php_cs
 /.php_cs.cache
 /.phpunit.result.cache
+/composer.lock
+/vendor
diff --git a/.php_cs.dist b/.php_cs.dist
index c072f5b..ff8a8b4 100644
--- a/.php_cs.dist
+++ b/.php_cs.dist
@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 $header = <<<'EOF'
-This file is part of exporter package.
+This file is part of sebastian/exporter.
 
 (c) Sebastian Bergmann <sebastian@phpunit.de>
 
@@ -8,183 +8,189 @@ For the full copyright and license information, please view the LICENSE
 file that was distributed with this source code.
 EOF;
 
+$finder = PhpCsFixer\Finder::create()->in(__DIR__);
+
 return PhpCsFixer\Config::create()
+    ->setFinder($finder)
     ->setRiskyAllowed(true)
-    ->setRules(
-        [
-            'align_multiline_comment' => true,
-            'array_indentation' => true,
-            'array_syntax' => ['syntax' => 'short'],
-            'binary_operator_spaces' => [
-                'operators' => [
-                    '=' => 'align',
-                    '=>' => 'align',
-                ],
+    ->setRules([
+        'align_multiline_comment' => true,
+        'array_indentation' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'binary_operator_spaces' => [
+            'operators' => [
+                '=' => 'align',
+                '=>' => 'align',
             ],
-            'blank_line_after_namespace' => true,
-            'blank_line_before_statement' => [
-                'statements' => [
-                    'break',
-                    'continue',
-                    'declare',
-                    'do',
-                    'for',
-                    'foreach',
-                    'if',
-                    'include',
-                    'include_once',
-                    'require',
-                    'require_once',
-                    'return',
-                    'switch',
-                    'throw',
-                    'try',
-                    'while',
-                    'yield',
-                ],
+        ],
+        'blank_line_after_namespace' => true,
+        'blank_line_before_statement' => [
+            'statements' => [
+                'break',
+                'continue',
+                'declare',
+                'do',
+                'for',
+                'foreach',
+                'if',
+                'include',
+                'include_once',
+                'require',
+                'require_once',
+                'return',
+                'switch',
+                'throw',
+                'try',
+                'while',
+                'yield',
             ],
-            'braces' => true,
-            'cast_spaces' => true,
-            'class_attributes_separation' => ['elements' => ['const', 'method', 'property']],
-            'combine_consecutive_issets' => true,
-            'combine_consecutive_unsets' => true,
-            'compact_nullable_typehint' => true,
-            'concat_space' => ['spacing' => 'one'],
-            'declare_equal_normalize' => ['space' => 'none'],
-            'declare_strict_types' => true,
-            'dir_constant' => true,
-            'elseif' => true,
-            'encoding' => true,
-            'full_opening_tag' => true,
-            'function_declaration' => true,
-            'header_comment' => ['header' => $header, 'separate' => 'none'],
-            'indentation_type' => true,
-            'is_null' => true,
-            'line_ending' => true,
-            'list_syntax' => ['syntax' => 'short'],
-            'logical_operators' => true,
-            'lowercase_cast' => true,
-            'lowercase_constants' => true,
-            'lowercase_keywords' => true,
-            'lowercase_static_reference' => true,
-            'magic_constant_casing' => true,
-            'method_argument_space' => ['ensure_fully_multiline' => true],
-            'modernize_types_casting' => true,
-            'multiline_comment_opening_closing' => true,
-            'multiline_whitespace_before_semicolons' => true,
-            'native_constant_invocation' => true,
-            'native_function_casing' => true,
-            'native_function_invocation' => true,
-            'new_with_braces' => false,
-            'no_alias_functions' => true,
-            'no_alternative_syntax' => true,
-            'no_blank_lines_after_class_opening' => true,
-            'no_blank_lines_after_phpdoc' => true,
-            'no_blank_lines_before_namespace' => true,
-            'no_closing_tag' => true,
-            'no_empty_comment' => true,
-            'no_empty_phpdoc' => true,
-            'no_empty_statement' => true,
-            'no_extra_blank_lines' => true,
-            'no_homoglyph_names' => true,
-            'no_leading_import_slash' => true,
-            'no_leading_namespace_whitespace' => true,
-            'no_mixed_echo_print' => ['use' => 'print'],
-            'no_multiline_whitespace_around_double_arrow' => true,
-            'no_null_property_initialization' => true,
-            'no_php4_constructor' => true,
-            'no_short_bool_cast' => true,
-            'no_short_echo_tag' => true,
-            'no_singleline_whitespace_before_semicolons' => true,
-            'no_spaces_after_function_name' => true,
-            'no_spaces_inside_parenthesis' => true,
-            'no_superfluous_elseif' => true,
-            'no_superfluous_phpdoc_tags' => true,
-            'no_trailing_comma_in_list_call' => true,
-            'no_trailing_comma_in_singleline_array' => true,
-            'no_trailing_whitespace' => true,
-            'no_trailing_whitespace_in_comment' => true,
-            'no_unneeded_control_parentheses' => true,
-            'no_unneeded_curly_braces' => true,
-            'no_unneeded_final_method' => true,
-            'no_unreachable_default_argument_value' => true,
-            'no_unset_on_property' => true,
-            'no_unused_imports' => true,
-            'no_useless_else' => true,
-            'no_useless_return' => true,
-            'no_whitespace_before_comma_in_array' => true,
-            'no_whitespace_in_blank_line' => true,
-            'non_printable_character' => true,
-            'normalize_index_brace' => true,
-            'object_operator_without_whitespace' => true,
-            'ordered_class_elements' => [
-                'order' => [
-                    'use_trait',
-                    'constant_public',
-                    'constant_protected',
-                    'constant_private',
-                    'property_public_static',
-                    'property_protected_static',
-                    'property_private_static',
-                    'property_public',
-                    'property_protected',
-                    'property_private',
-                    'method_public_static',
-                    'construct',
-                    'destruct',
-                    'magic',
-                    'phpunit',
-                    'method_public',
-                    'method_protected',
-                    'method_private',
-                    'method_protected_static',
-                    'method_private_static',
-                ],
+        ],
+        'braces' => true,
+        'cast_spaces' => true,
+        'class_attributes_separation' => ['elements' => ['const', 'method', 'property']],
+        'combine_consecutive_issets' => true,
+        'combine_consecutive_unsets' => true,
+        'compact_nullable_typehint' => true,
+        'concat_space' => ['spacing' => 'one'],
+        'declare_equal_normalize' => ['space' => 'none'],
+        'declare_strict_types' => true,
+        'dir_constant' => true,
+        'elseif' => true,
+        'encoding' => true,
+        'full_opening_tag' => true,
+        'function_declaration' => true,
+        'header_comment' => ['header' => $header, 'separate' => 'none'],
+        'indentation_type' => true,
+        'is_null' => true,
+        'line_ending' => true,
+        'list_syntax' => ['syntax' => 'short'],
+        'logical_operators' => true,
+        'lowercase_cast' => true,
+        'lowercase_constants' => true,
+        'lowercase_keywords' => true,
+        'lowercase_static_reference' => true,
+        'magic_constant_casing' => true,
+        'method_argument_space' => ['ensure_fully_multiline' => true],
+        'modernize_types_casting' => true,
+        'multiline_comment_opening_closing' => true,
+        'multiline_whitespace_before_semicolons' => true,
+        'native_constant_invocation' => true,
+        'native_function_casing' => true,
+        'native_function_invocation' => true,
+        'new_with_braces' => false,
+        'no_alias_functions' => true,
+        'no_alternative_syntax' => true,
+        'no_blank_lines_after_class_opening' => true,
+        'no_blank_lines_after_phpdoc' => true,
+        'no_blank_lines_before_namespace' => true,
+        'no_closing_tag' => true,
+        'no_empty_comment' => true,
+        'no_empty_phpdoc' => true,
+        'no_empty_statement' => true,
+        'no_extra_blank_lines' => true,
+        'no_homoglyph_names' => true,
+        'no_leading_import_slash' => true,
+        'no_leading_namespace_whitespace' => true,
+        'no_mixed_echo_print' => ['use' => 'print'],
+        'no_multiline_whitespace_around_double_arrow' => true,
+        'no_null_property_initialization' => true,
+        'no_php4_constructor' => true,
+        'no_short_bool_cast' => true,
+        'no_short_echo_tag' => true,
+        'no_singleline_whitespace_before_semicolons' => true,
+        'no_spaces_after_function_name' => true,
+        'no_spaces_inside_parenthesis' => true,
+        'no_superfluous_elseif' => true,
+        'no_superfluous_phpdoc_tags' => true,
+        'no_trailing_comma_in_list_call' => true,
+        'no_trailing_comma_in_singleline_array' => true,
+        'no_trailing_whitespace' => true,
+        'no_trailing_whitespace_in_comment' => true,
+        'no_unneeded_control_parentheses' => true,
+        'no_unneeded_curly_braces' => true,
+        'no_unneeded_final_method' => true,
+        'no_unreachable_default_argument_value' => true,
+        'no_unset_on_property' => true,
+        'no_unused_imports' => true,
+        'no_useless_else' => true,
+        'no_useless_return' => true,
+        'no_whitespace_before_comma_in_array' => true,
+        'no_whitespace_in_blank_line' => true,
+        'non_printable_character' => true,
+        'normalize_index_brace' => true,
+        'object_operator_without_whitespace' => true,
+        'ordered_class_elements' => [
+            'order' => [
+                'use_trait',
+                'constant_public',
+                'constant_protected',
+                'constant_private',
+                'property_public_static',
+                'property_protected_static',
+                'property_private_static',
+                'property_public',
+                'property_protected',
+                'property_private',
+                'method_public_static',
+                'construct',
+                'destruct',
+                'magic',
+                'phpunit',
+                'method_public',
+                'method_protected',
+                'method_private',
+                'method_protected_static',
+                'method_private_static',
             ],
-            'ordered_imports' => true,
-            'phpdoc_add_missing_param_annotation' => true,
-            'phpdoc_align' => true,
-            'phpdoc_annotation_without_dot' => true,
-            'phpdoc_indent' => true,
-            'phpdoc_no_access' => true,
-            'phpdoc_no_empty_return' => true,
-            'phpdoc_no_package' => true,
-            'phpdoc_order' => true,
-            'phpdoc_return_self_reference' => true,
-            'phpdoc_scalar' => true,
-            'phpdoc_separation' => true,
-            'phpdoc_single_line_var_spacing' => true,
-            'phpdoc_to_comment' => true,
-            'phpdoc_trim' => true,
-            'phpdoc_trim_consecutive_blank_line_separation' => true,
-            'phpdoc_types' => true,
-            'phpdoc_types_order' => true,
-            'phpdoc_var_without_name' => true,
-            'pow_to_exponentiation' => true,
-            'protected_to_private' => true,
-            'return_assignment' => true,
-            'return_type_declaration' => ['space_before' => 'none'],
-            'self_accessor' => true,
-            'semicolon_after_instruction' => true,
-            'set_type_to_cast' => true,
-            'short_scalar_cast' => true,
-            'simplified_null_return' => true,
-            'single_blank_line_at_eof' => true,
-            'single_import_per_statement' => true,
-            'single_line_after_imports' => true,
-            'single_quote' => true,
-            'standardize_not_equals' => true,
-            'ternary_to_null_coalescing' => true,
-            'trim_array_spaces' => true,
-            'unary_operator_spaces' => true,
-            'visibility_required' => true,
-            //'void_return' => true,
-            'whitespace_after_comma_in_array' => true,
-        ]
-    )
-    ->setFinder(
-        PhpCsFixer\Finder::create()
-        ->files()
-        ->in(__DIR__ . '/src')
-        ->in(__DIR__ . '/tests')
-    );
+        ],
+        'ordered_imports' => true,
+        'ordered_interfaces' => [
+            'direction' => 'ascend',
+            'order' => 'alpha',
+        ],
+        'phpdoc_add_missing_param_annotation' => true,
+        'phpdoc_align' => true,
+        'phpdoc_annotation_without_dot' => true,
+        'phpdoc_indent' => true,
+        'phpdoc_no_access' => true,
+        'phpdoc_no_empty_return' => true,
+        'phpdoc_no_package' => true,
+        'phpdoc_order' => true,
+        'phpdoc_return_self_reference' => true,
+        'phpdoc_scalar' => true,
+        'phpdoc_separation' => true,
+        'phpdoc_single_line_var_spacing' => true,
+        'phpdoc_to_comment' => true,
+        'phpdoc_trim' => true,
+        'phpdoc_trim_consecutive_blank_line_separation' => true,
+        'phpdoc_types' => ['groups' => ['simple', 'meta']],
+        'phpdoc_types_order' => true,
+        'phpdoc_var_without_name' => true,
+        'pow_to_exponentiation' => true,
+        'protected_to_private' => true,
+        'return_assignment' => true,
+        'return_type_declaration' => ['space_before' => 'none'],
+        'self_accessor' => true,
+        'semicolon_after_instruction' => true,
+        'set_type_to_cast' => true,
+        'short_scalar_cast' => true,
+        'simplified_null_return' => false,
+        'single_blank_line_at_eof' => true,
+        'single_import_per_statement' => true,
+        'single_line_after_imports' => true,
+        'single_quote' => true,
+        'standardize_not_equals' => true,
+        'ternary_to_null_coalescing' => true,
+        'trailing_comma_in_multiline_array' => true,
+        'trim_array_spaces' => true,
+        'unary_operator_spaces' => true,
+        'visibility_required' => [
+            'elements' => [
+                'const',
+                'method',
+                'property',
+            ],
+        ],
+        'void_return' => true,
+        'whitespace_after_comma_in_array' => true,
+    ]);
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index 06b0047..0000000
--- a/.travis.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-language: php
-
-php:
-  - 7.3
-  - 7.4
-
-install:
-  - travis_retry ./tools/composer update --no-interaction --no-ansi --no-progress --no-suggest --optimize-autoloader --prefer-stable
-
-script:
-  - ./vendor/bin/phpunit --coverage-clover=coverage.xml
-
-after_success:
-  - bash <(curl -s https://codecov.io/bash)
-
-notifications:
-  email: false
diff --git a/README.md b/README.md
index 4c838ab..ed8719f 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,24 @@
-Exporter
-========
+# sebastian/exporter
 
-[![Build Status](https://secure.travis-ci.org/sebastianbergmann/exporter.png?branch=master)](https://travis-ci.org/sebastianbergmann/exporter)
+[![CI Status](https://github.com/sebastianbergmann/exporter/workflows/CI/badge.svg)](https://github.com/sebastianbergmann/exporter/actions)
+[![Type Coverage](https://shepherd.dev/github/sebastianbergmann/exporter/coverage.svg)](https://shepherd.dev/github/sebastianbergmann/exporter)
 
 This component provides the functionality to export PHP variables for visualization.
 
+## Installation
+
+You can add this library as a local, per-project dependency to your project using [Composer](https://getcomposer.org/):
+
+```
+composer require sebastian/exporter
+```
+
+If you only need this library during development, for instance to run your project's test suite, then you should add it as a development-time dependency:
+
+```
+composer require --dev sebastian/exporter
+```
+
 ## Usage
 
 Exporting:
@@ -158,14 +172,3 @@ space
 LONG_STRING
 );
 ```
-
-## Installation
-
-You can add this library as a local, per-project dependency to your project using [Composer](https://getcomposer.org/):
-
-    composer require sebastian/exporter
-
-If you only need this library during development, for instance to run your project's test suite, then you should add it as a development-time dependency:
-
-    composer require --dev sebastian/exporter
-