Merge release 0.5.0 into 1.0.x

.doctrine-project.json

@@ -10,11 +10,41 @@
             "slug": "latest",
             "upcoming": true
         },
+        {
+            "name": "0.5",
+            "branchName": "0.5.x",
+            "slug": "0.5",
+            "upcoming": true
+        },
+        {
+            "name": "0.4",
+            "branchName": "0.4.x",
+            "slug": "0.4",
+            "current": true
+        },
+        {
+            "name": "0.3",
+            "branchName": "0.3.x",
+            "slug": "0.3",
+            "maintained": false
+        },
+        {
+            "name": "0.2",
+            "branchName": "0.2.x",
+            "slug": "0.2",
+            "maintained": false
+        },
+        {
+            "name": "0.2",
+            "branchName": "0.2.x",
+            "slug": "0.2",
+            "maintained": false
+        },
         {
             "name": "0.1",
             "branchName": "0.1.x",
             "slug": "0.1",
-            "current": true
+            "maintained": false
         }
     ]
 }

.github/workflows/coding-standards.yml

@@ -12,34 +12,4 @@ on:
 jobs:
   coding-standards:
     name: "Coding Standards"
-    runs-on: "ubuntu-20.04"
-
-    strategy:
-      matrix:
-        php-version:
-          - "7.4"
-
-    steps:
-      - name: "Checkout"
-        uses: "actions/checkout@v2"
-
-      - name: "Install PHP"
-        uses: "shivammathur/setup-php@v2"
-        with:
-          coverage: "none"
-          php-version: "${{ matrix.php-version }}"
-          tools: "cs2pr"
-
-      - name: "Cache dependencies installed with Composer"
-        uses: "actions/cache@v2"
-        with:
-          path: "~/.composer/cache"
-          key: "php-${{ matrix.php-version }}-composer-locked-${{ hashFiles('composer.lock') }}"
-          restore-keys: "php-${{ matrix.php-version }}-composer-locked-"
-
-      - name: "Install dependencies with Composer"
-        run: "composer install --no-interaction --no-progress --no-suggest"
-
-      # https://github.com/doctrine/.github/issues/3
-      - name: "Run PHP_CodeSniffer"
-        run: "vendor/bin/phpcs -q --no-colors --report=checkstyle | cs2pr"
+    uses: "doctrine/.github/.github/workflows/coding-standards.yml@1.1.0"

.github/workflows/continuous-integration.yml

@@ -12,87 +12,6 @@ env:
 jobs:
   phpunit:
     name: "PHPUnit"
-    runs-on: "ubuntu-20.04"
-
-    strategy:
-      matrix:
-        php-version:
-          - "7.1"
-          - "7.2"
-          - "7.3"
-          - "7.4"
-          - "8.0"
-        deps:
-          - "normal"
-        include:
-          # Tests the lowest set of dependencies
-          - deps: "low"
-            php-version: "7.1"
-
-    steps:
-      - name: "Checkout"
-        uses: "actions/checkout@v2"
-        with:
-          fetch-depth: 2
-
-      - name: "Install PHP with XDebug"
-        uses: "shivammathur/setup-php@v2"
-        if: "${{ matrix.php-version == '7.1' }}"
-        with:
-          php-version: "${{ matrix.php-version }}"
-          coverage: "xdebug"
-          ini-values: "zend.assertions=1"
-
-      - name: "Install PHP with PCOV"
-        uses: "shivammathur/setup-php@v2"
-        if: "${{ matrix.php-version != '7.1' }}"
-        with:
-          php-version: "${{ matrix.php-version }}"
-          coverage: "pcov"
-          ini-values: "zend.assertions=1"
-
-      - name: "Cache dependencies installed with composer"
-        uses: "actions/cache@v2"
-        with:
-          path: "~/.composer/cache"
-          key: "php-${{ matrix.php-version }}-composer-locked-${{ hashFiles('composer.lock') }}"
-          restore-keys: "php-${{ matrix.php-version }}-composer-locked-"
-
-      - name: "Install dependencies with composer"
-        run: "composer update --no-interaction --prefer-stable"
-        if: "${{ matrix.deps == 'normal' }}"
-
-      - name: "Install lowest possible dependencies with composer"
-        run: "composer update --no-interaction --prefer-dist --prefer-lowest"
-        if: "${{ matrix.deps == 'low' }}"
-
-      - name: "Run PHPUnit"
-        run: "vendor/bin/phpunit --coverage-clover=coverage.xml"
-
-      - name: "Upload coverage file"
-        uses: "actions/upload-artifact@v2"
-        with:
-          name: "phpunit-${{ matrix.php-version }}-${{ matrix.deps }}-${{ hashFiles('composer.lock') }}.coverage"
-          path: "coverage.xml"
-
-  upload_coverage:
-    name: "Upload coverage to Codecov"
-    runs-on: "ubuntu-20.04"
-    needs:
-      - "phpunit"
-
-    steps:
-      - name: "Checkout"
-        uses: "actions/checkout@v2"
-        with:
-          fetch-depth: 2
-
-      - name: "Download coverage files"
-        uses: "actions/download-artifact@v2"
-        with:
-          path: "reports"
-
-      - name: "Upload to Codecov"
-        uses: "codecov/codecov-action@v1"
-        with:
-          directory: reports
+    uses: "doctrine/.github/.github/workflows/continuous-integration.yml@1.1.0"
+    with:
+      php-versions: '["7.2", "7.3", "7.4", "8.0"]'

.github/workflows/release-on-milestone-closed.yml

@@ -8,51 +8,10 @@ on:
 jobs:
   release:
     name: "Git tag, release & create merge-up PR"
-    runs-on: "ubuntu-20.04"
-
-    steps:
-      - name: "Checkout"
-        uses: "actions/checkout@v2"
-
-      - name: "Release"
-        uses: "laminas/automatic-releases@v1"
-        with:
-          command-name: "laminas:automatic-releases:release"
-        env:
-          "GITHUB_TOKEN": ${{ secrets.GITHUB_TOKEN }}
-          "SIGNING_SECRET_KEY": ${{ secrets.SIGNING_SECRET_KEY }}
-          "GIT_AUTHOR_NAME": ${{ secrets.GIT_AUTHOR_NAME }}
-          "GIT_AUTHOR_EMAIL": ${{ secrets.GIT_AUTHOR_EMAIL }}
-
-      - name: "Create Merge-Up Pull Request"
-        uses: "laminas/automatic-releases@v1"
-        with:
-          command-name: "laminas:automatic-releases:create-merge-up-pull-request"
-        env:
-          "GITHUB_TOKEN": ${{ secrets.GITHUB_TOKEN }}
-          "SIGNING_SECRET_KEY": ${{ secrets.SIGNING_SECRET_KEY }}
-          "GIT_AUTHOR_NAME": ${{ secrets.GIT_AUTHOR_NAME }}
-          "GIT_AUTHOR_EMAIL": ${{ secrets.GIT_AUTHOR_EMAIL }}
-
-      # Uncomment this step if the repository uses a "next minor as default
-      # branch" policy.
-      #
-      # - name: "Create and/or Switch to new Release Branch"
-      #   uses: "laminas/automatic-releases@v1"
-      #   with:
-      #     command-name: "laminas:automatic-releases:switch-default-branch-to-next-minor"
-      #   env:
-      #     "GITHUB_TOKEN": ${{ secrets.ORGANIZATION_ADMIN_TOKEN }}
-      #     "SIGNING_SECRET_KEY": ${{ secrets.SIGNING_SECRET_KEY }}
-      #     "GIT_AUTHOR_NAME": ${{ secrets.GIT_AUTHOR_NAME }}
-      #     "GIT_AUTHOR_EMAIL": ${{ secrets.GIT_AUTHOR_EMAIL }}
-
-      - name: "Create new milestones"
-        uses: "laminas/automatic-releases@v1"
-        with:
-          command-name: "laminas:automatic-releases:create-milestones"
-        env:
-          "GITHUB_TOKEN": ${{ secrets.GITHUB_TOKEN }}
-          "SIGNING_SECRET_KEY": ${{ secrets.SIGNING_SECRET_KEY }}
-          "GIT_AUTHOR_NAME": ${{ secrets.GIT_AUTHOR_NAME }}
-          "GIT_AUTHOR_EMAIL": ${{ secrets.GIT_AUTHOR_EMAIL }}
+    uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@1.1.1"
+    secrets:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      GIT_AUTHOR_EMAIL: ${{ secrets.GIT_AUTHOR_EMAIL }}
+      GIT_AUTHOR_NAME: ${{ secrets.GIT_AUTHOR_NAME }}
+      ORGANIZATION_ADMIN_TOKEN: ${{ secrets.ORGANIZATION_ADMIN_TOKEN }}
+      SIGNING_SECRET_KEY: ${{ secrets.SIGNING_SECRET_KEY }}

UPGRADE.md

@@ -1,3 +1,25 @@
+# Upgrade to 0.5
+
+## Property visibility changed from protected to private
+
+Some directives and node classes had protected visibility for their properties.
+That has now been changed to private.
+
+## Final classes by default
+
+Many classes have been made final because they were never actually extended.
+
+## Error handling
+
+The `Doctrine\RST\Environment::addError()` and `Doctrine\RST\Environment::addWarning()`
+have been removed.
+
+The `Doctrine\RST\ErrorManager::error()` and `Doctrine\RST\ErrorManager::warning()`
+have an updated signature to support file name and line numbers.
+
+Method `Doctrine\RST\ErrorManager::getErrors()` will return a list of `Doctrine\RST\Error`
+instead of a list of strings.
+
 # Upgrade to 0.4
 
 ## Refactored List Rendering

composer.json

@@ -17,11 +17,13 @@
         }
     ],
     "require": {
-        "php": "^7.1 || ^8.0",
+        "php": "^7.2 || ^8.0",
         "doctrine/event-manager": "^1.0",
         "symfony/filesystem": "^4.1 || ^5.0",
         "symfony/finder": "^4.1 || ^5.0",
         "symfony/polyfill-mbstring": "^1.0",
+        "symfony/string": "^5.3",
+        "symfony/translation-contracts": "^1.1 || ^2.0",
         "twig/twig": "^2.9 || ^3.3"
     },
     "require-dev": {

lib/Builder.php

@@ -24,7 +24,7 @@
 use function is_dir;
 use function sprintf;
 
-class Builder
+final class Builder
 {
     /** @var Kernel */
     private $kernel;

lib/Builder/Copier.php

@@ -10,7 +10,7 @@
 use function dirname;
 use function is_dir;
 
-class Copier
+final class Copier
 {
     /** @var Filesystem */
     private $filesystem;

lib/Builder/ParseQueueProcessor.php

@@ -11,8 +11,13 @@
 use Doctrine\RST\Parser;
 
 use function filemtime;
+use function fwrite;
+use function getenv;
+use function sprintf;
 
-class ParseQueueProcessor
+use const STDERR;
+
+final class ParseQueueProcessor
 {
     /** @var Kernel */
     private $kernel;
@@ -62,6 +67,10 @@ public function process(ParseQueue $parseQueue): void
 
     private function processFile(string $file): void
     {
+        if (getenv('SHELL_VERBOSITY') >= 1) {
+            fwrite(STDERR, sprintf("Processing file: %s\n", $file));
+        }
+
         $fileAbsolutePath = $this->buildFileAbsolutePath($file);
 
         $parser = $this->createFileParser($file);

lib/Builder/Scanner.php

@@ -13,7 +13,7 @@
 use function strlen;
 use function substr;
 
-class Scanner
+final class Scanner
 {
     /** @var string */
     private $fileExtension;

lib/Configuration.php

@@ -27,7 +27,9 @@
 
 class Configuration
 {
-    public const THEME_DEFAULT = 'default';
+    public const THEME_DEFAULT         = 'default';
+    public const OUTPUT_FORMAT_CONSOLE = 'console';
+    public const OUTPUT_FORMAT_GITHUB  = 'github';
 
     /** @var string */
     private $cacheDir;
@@ -53,6 +55,9 @@ class Configuration
     /** @var bool */
     private $warningsAsError = false;
 
+    /** @psalm-var self::OUTPUT_FORMAT_* */
+    private $outputFormat = self::OUTPUT_FORMAT_CONSOLE;
+
     /** @var bool */
     private $ignoreInvalidReferences = false;
 
@@ -227,6 +232,22 @@ public function isWarningsAsError(): bool
         return $this->warningsAsError;
     }
 
+    /**
+     * @psalm-return self::OUTPUT_FORMAT_*
+     */
+    final public function getOutputFormat(): string
+    {
+        return $this->outputFormat;
+    }
+
+    /**
+     * @psalm-param self::OUTPUT_FORMAT_* $outputFormat
+     */
+    final public function setOutputFormat(string $outputFormat): void
+    {
+        $this->outputFormat = $outputFormat;
+    }
+
     public function getIgnoreInvalidReferences(): bool
     {
         return $this->ignoreInvalidReferences;

lib/Directives/CodeBlock.php

@@ -19,7 +19,7 @@
  *
  *      echo "Hello world!\n";
  */
-class CodeBlock extends Directive
+final class CodeBlock extends Directive
 {
     public function getName(): string
     {

lib/Directives/Dummy.php

@@ -7,7 +7,7 @@
 use Doctrine\RST\Nodes\Node;
 use Doctrine\RST\Parser;
 
-class Dummy extends Directive
+final class Dummy extends Directive
 {
     public function getName(): string
     {

lib/Directives/Raw.php

@@ -15,7 +15,7 @@
  *
  *      <u>Undelined!</u>
  */
-class Raw extends Directive
+final class Raw extends Directive
 {
     public function getName(): string
     {