first commit

vendor/sebastian/lines-of-code/ChangeLog.md

@@ -0,0 +1,55 @@
+# ChangeLog
+
+All notable changes are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles.
+
+## [2.0.2] - 2023-12-21
+
+### Changed
+
+* This component is now compatible with `nikic/php-parser` 5.0
+
+## [2.0.1] - 2023-08-31
+
+### Changed
+
+* Improved type information
+
+## [2.0.0] - 2023-02-03
+
+### Removed
+
+* This component is no longer supported on PHP 7.3, PHP 7.4 and PHP 8.0
+
+## [1.0.3] - 2020-11-28
+
+### Fixed
+
+* Files that do not contain a newline were not handled correctly
+
+### Changed
+
+* A line of code is no longer considered to be a Logical Line of Code if it does not contain an `Expr` node
+
+## [1.0.2] - 2020-10-26
+
+### Fixed
+
+* `SebastianBergmann\LinesOfCode\Exception` now correctly extends `\Throwable`
+
+## [1.0.1] - 2020-09-28
+
+### Changed
+
+* Changed PHP version constraint in `composer.json` from `^7.3 || ^8.0` to `>=7.3`
+
+## [1.0.0] - 2020-07-22
+
+* Initial release
+
+[2.0.2]: https://github.com/sebastianbergmann/lines-of-code/compare/2.0.1...2.0.2
+[2.0.1]: https://github.com/sebastianbergmann/lines-of-code/compare/2.0.0...2.0.1
+[2.0.0]: https://github.com/sebastianbergmann/lines-of-code/compare/1.0.3...2.0.0
+[1.0.3]: https://github.com/sebastianbergmann/lines-of-code/compare/1.0.2...1.0.3
+[1.0.2]: https://github.com/sebastianbergmann/lines-of-code/compare/1.0.1...1.0.2
+[1.0.1]: https://github.com/sebastianbergmann/lines-of-code/compare/1.0.0...1.0.1
+[1.0.0]: https://github.com/sebastianbergmann/lines-of-code/compare/f959e71f00e591288acc024afe9cb966c6cf9bd6...1.0.0

vendor/sebastian/lines-of-code/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020-2023, Sebastian Bergmann
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

vendor/sebastian/lines-of-code/README.md

@@ -0,0 +1,22 @@
+[![Latest Stable Version](https://poser.pugx.org/sebastian/lines-of-code/v/stable.png)](https://packagist.org/packages/sebastian/lines-of-code)
+[![CI Status](https://github.com/sebastianbergmann/lines-of-code/workflows/CI/badge.svg)](https://github.com/sebastianbergmann/lines-of-code/actions)
+[![Type Coverage](https://shepherd.dev/github/sebastianbergmann/lines-of-code/coverage.svg)](https://shepherd.dev/github/sebastianbergmann/lines-of-code)
+[![codecov](https://codecov.io/gh/sebastianbergmann/lines-of-code/branch/main/graph/badge.svg)](https://codecov.io/gh/sebastianbergmann/lines-of-code)
+
+# sebastian/lines-of-code
+
+Library for counting the lines of code in PHP source code.
+
+## Installation
+
+You can add this library as a local, per-project dependency to your project using [Composer](https://getcomposer.org/):
+
+```
+composer require sebastian/lines-of-code
+```
+
+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/lines-of-code
+```

vendor/sebastian/lines-of-code/SECURITY.md

@@ -0,0 +1,30 @@
+# Security Policy
+
+If you believe you have found a security vulnerability in the library that is developed in this repository, please report it to us through coordinated disclosure.
+
+**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
+
+Instead, please email `sebastian@phpunit.de`.
+
+Please include as much of the information listed below as you can to help us better understand and resolve the issue:
+
+* The type of issue
+* Full paths of source file(s) related to the manifestation of the issue
+* The location of the affected source code (tag/branch/commit or direct URL)
+* Any special configuration required to reproduce the issue
+* Step-by-step instructions to reproduce the issue
+* Proof-of-concept or exploit code (if possible)
+* Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+## Web Context
+
+The library that is developed in this repository was either extracted from [PHPUnit](https://github.com/sebastianbergmann/phpunit) or developed specifically as a dependency for PHPUnit.
+
+The library is developed with a focus on development environments and the command-line. No specific testing or hardening with regard to using the library in an HTTP or web context or with untrusted input data is performed. The library might also contain functionality that intentionally exposes internal application data for debugging purposes.
+
+If the library is used in a web application, the application developer is responsible for filtering inputs or escaping outputs as necessary and for verifying that the used functionality is safe for use within the intended context.
+
+Vulnerabilities specific to the use outside a development context will be fixed as applicable, provided that the fix does not have an averse effect on the primary use case for development purposes.
+

vendor/sebastian/lines-of-code/composer.json

@@ -0,0 +1,43 @@
+{
+    "name": "sebastian/lines-of-code",
+    "description": "Library for counting the lines of code in PHP source code",
+    "type": "library",
+    "homepage": "https://github.com/sebastianbergmann/lines-of-code",
+    "license": "BSD-3-Clause",
+    "authors": [
+        {
+            "name": "Sebastian Bergmann",
+            "email": "sebastian@phpunit.de",
+            "role": "lead"
+        }
+    ],
+    "support": {
+        "issues": "https://github.com/sebastianbergmann/lines-of-code/issues",
+        "security": "https://github.com/sebastianbergmann/lines-of-code/security/policy"
+    },
+    "prefer-stable": true,
+    "require": {
+        "php": ">=8.1",
+        "nikic/php-parser": "^4.18 || ^5.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^10.0"
+    },
+    "config": {
+        "platform": {
+            "php": "8.1"
+        },
+        "optimize-autoloader": true,
+        "sort-packages": true
+    },
+    "autoload": {
+        "classmap": [
+            "src/"
+        ]
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-main": "2.0-dev"
+        }
+    }
+}

vendor/sebastian/lines-of-code/src/Counter.php

@@ -0,0 +1,90 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of sebastian/lines-of-code.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\LinesOfCode;
+
+use function assert;
+use function file_get_contents;
+use function substr_count;
+use PhpParser\Error;
+use PhpParser\Node;
+use PhpParser\NodeTraverser;
+use PhpParser\ParserFactory;
+
+final class Counter
+{
+    /**
+     * @throws RuntimeException
+     */
+    public function countInSourceFile(string $sourceFile): LinesOfCode
+    {
+        return $this->countInSourceString(file_get_contents($sourceFile));
+    }
+
+    /**
+     * @throws RuntimeException
+     */
+    public function countInSourceString(string $source): LinesOfCode
+    {
+        $linesOfCode = substr_count($source, "\n");
+
+        if ($linesOfCode === 0 && !empty($source)) {
+            $linesOfCode = 1;
+        }
+
+        assert($linesOfCode >= 0);
+
+        try {
+            $nodes = (new ParserFactory)->createForHostVersion()->parse($source);
+
+            assert($nodes !== null);
+
+            return $this->countInAbstractSyntaxTree($linesOfCode, $nodes);
+
+            // @codeCoverageIgnoreStart
+        } catch (Error $error) {
+            throw new RuntimeException(
+                $error->getMessage(),
+                $error->getCode(),
+                $error,
+            );
+        }
+        // @codeCoverageIgnoreEnd
+    }
+
+    /**
+     * @psalm-param non-negative-int $linesOfCode
+     *
+     * @param Node[] $nodes
+     *
+     * @throws RuntimeException
+     */
+    public function countInAbstractSyntaxTree(int $linesOfCode, array $nodes): LinesOfCode
+    {
+        $traverser = new NodeTraverser;
+        $visitor   = new LineCountingVisitor($linesOfCode);
+
+        $traverser->addVisitor($visitor);
+
+        try {
+            /* @noinspection UnusedFunctionResultInspection */
+            $traverser->traverse($nodes);
+            // @codeCoverageIgnoreStart
+        } catch (Error $error) {
+            throw new RuntimeException(
+                $error->getMessage(),
+                $error->getCode(),
+                $error,
+            );
+        }
+        // @codeCoverageIgnoreEnd
+
+        return $visitor->result();
+    }
+}

vendor/sebastian/lines-of-code/src/Exception/Exception.php

@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of sebastian/lines-of-code.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\LinesOfCode;
+
+use Throwable;
+
+interface Exception extends Throwable
+{
+}

vendor/sebastian/lines-of-code/src/Exception/IllogicalValuesException.php

@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of sebastian/lines-of-code.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\LinesOfCode;
+
+use LogicException;
+
+final class IllogicalValuesException extends LogicException implements Exception
+{
+}

vendor/sebastian/lines-of-code/src/Exception/NegativeValueException.php

@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of sebastian/lines-of-code.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\LinesOfCode;
+
+use InvalidArgumentException;
+
+final class NegativeValueException extends InvalidArgumentException implements Exception
+{
+}

vendor/sebastian/lines-of-code/src/Exception/RuntimeException.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of sebastian/lines-of-code.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\LinesOfCode;
+
+final class RuntimeException extends \RuntimeException implements Exception
+{
+}

vendor/sebastian/lines-of-code/src/LineCountingVisitor.php

@@ -0,0 +1,93 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of sebastian/lines-of-code.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\LinesOfCode;
+
+use function array_merge;
+use function array_unique;
+use function assert;
+use function count;
+use PhpParser\Comment;
+use PhpParser\Node;
+use PhpParser\Node\Expr;
+use PhpParser\NodeVisitorAbstract;
+
+final class LineCountingVisitor extends NodeVisitorAbstract
+{
+    /**
+     * @psalm-var non-negative-int
+     */
+    private readonly int $linesOfCode;
+
+    /**
+     * @var Comment[]
+     */
+    private array $comments = [];
+
+    /**
+     * @var int[]
+     */
+    private array $linesWithStatements = [];
+
+    /**
+     * @psalm-param non-negative-int $linesOfCode
+     */
+    public function __construct(int $linesOfCode)
+    {
+        $this->linesOfCode = $linesOfCode;
+    }
+
+    public function enterNode(Node $node): void
+    {
+        $this->comments = array_merge($this->comments, $node->getComments());
+
+        if (!$node instanceof Expr) {
+            return;
+        }
+
+        $this->linesWithStatements[] = $node->getStartLine();
+    }
+
+    public function result(): LinesOfCode
+    {
+        $commentLinesOfCode = 0;
+
+        foreach ($this->comments() as $comment) {
+            $commentLinesOfCode += ($comment->getEndLine() - $comment->getStartLine() + 1);
+        }
+
+        $nonCommentLinesOfCode = $this->linesOfCode - $commentLinesOfCode;
+        $logicalLinesOfCode    = count(array_unique($this->linesWithStatements));
+
+        assert($commentLinesOfCode >= 0);
+        assert($nonCommentLinesOfCode >= 0);
+        assert($logicalLinesOfCode >= 0);
+
+        return new LinesOfCode(
+            $this->linesOfCode,
+            $commentLinesOfCode,
+            $nonCommentLinesOfCode,
+            $logicalLinesOfCode,
+        );
+    }
+
+    /**
+     * @return Comment[]
+     */
+    private function comments(): array
+    {
+        $comments = [];
+
+        foreach ($this->comments as $comment) {
+            $comments[$comment->getStartLine() . '_' . $comment->getStartTokenPos() . '_' . $comment->getEndLine() . '_' . $comment->getEndTokenPos()] = $comment;
+        }
+
+        return $comments;
+    }
+}

vendor/sebastian/lines-of-code/src/LinesOfCode.php

@@ -0,0 +1,119 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of sebastian/lines-of-code.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\LinesOfCode;
+
+/**
+ * @psalm-immutable
+ */
+final class LinesOfCode
+{
+    /**
+     * @psalm-var non-negative-int
+     */
+    private readonly int $linesOfCode;
+
+    /**
+     * @psalm-var non-negative-int
+     */
+    private readonly int $commentLinesOfCode;
+
+    /**
+     * @psalm-var non-negative-int
+     */
+    private readonly int $nonCommentLinesOfCode;
+
+    /**
+     * @psalm-var non-negative-int
+     */
+    private readonly int $logicalLinesOfCode;
+
+    /**
+     * @psalm-param non-negative-int $linesOfCode
+     * @psalm-param non-negative-int $commentLinesOfCode
+     * @psalm-param non-negative-int $nonCommentLinesOfCode
+     * @psalm-param non-negative-int $logicalLinesOfCode
+     *
+     * @throws IllogicalValuesException
+     * @throws NegativeValueException
+     */
+    public function __construct(int $linesOfCode, int $commentLinesOfCode, int $nonCommentLinesOfCode, int $logicalLinesOfCode)
+    {
+        /** @psalm-suppress DocblockTypeContradiction */
+        if ($linesOfCode < 0) {
+            throw new NegativeValueException('$linesOfCode must not be negative');
+        }
+
+        /** @psalm-suppress DocblockTypeContradiction */
+        if ($commentLinesOfCode < 0) {
+            throw new NegativeValueException('$commentLinesOfCode must not be negative');
+        }
+
+        /** @psalm-suppress DocblockTypeContradiction */
+        if ($nonCommentLinesOfCode < 0) {
+            throw new NegativeValueException('$nonCommentLinesOfCode must not be negative');
+        }
+
+        /** @psalm-suppress DocblockTypeContradiction */
+        if ($logicalLinesOfCode < 0) {
+            throw new NegativeValueException('$logicalLinesOfCode must not be negative');
+        }
+
+        if ($linesOfCode - $commentLinesOfCode !== $nonCommentLinesOfCode) {
+            throw new IllogicalValuesException('$linesOfCode !== $commentLinesOfCode + $nonCommentLinesOfCode');
+        }
+
+        $this->linesOfCode           = $linesOfCode;
+        $this->commentLinesOfCode    = $commentLinesOfCode;
+        $this->nonCommentLinesOfCode = $nonCommentLinesOfCode;
+        $this->logicalLinesOfCode    = $logicalLinesOfCode;
+    }
+
+    /**
+     * @psalm-return non-negative-int
+     */
+    public function linesOfCode(): int
+    {
+        return $this->linesOfCode;
+    }
+
+    /**
+     * @psalm-return non-negative-int
+     */
+    public function commentLinesOfCode(): int
+    {
+        return $this->commentLinesOfCode;
+    }
+
+    /**
+     * @psalm-return non-negative-int
+     */
+    public function nonCommentLinesOfCode(): int
+    {
+        return $this->nonCommentLinesOfCode;
+    }
+
+    /**
+     * @psalm-return non-negative-int
+     */
+    public function logicalLinesOfCode(): int
+    {
+        return $this->logicalLinesOfCode;
+    }
+
+    public function plus(self $other): self
+    {
+        return new self(
+            $this->linesOfCode() + $other->linesOfCode(),
+            $this->commentLinesOfCode() + $other->commentLinesOfCode(),
+            $this->nonCommentLinesOfCode() + $other->nonCommentLinesOfCode(),
+            $this->logicalLinesOfCode() + $other->logicalLinesOfCode(),
+        );
+    }
+}