mirrors/barryvdh_ReflectionDocBlock
1
0
Fork 0
mirror of https://github.com/barryvdh/ReflectionDocBlock.git synced 2026-08-18 01:57:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #143 from TomasVotruba/ecs-fix

Browse Source 
EasyCodingStandard - config path fixes + apply coding style
This commit is contained in:
Jaap van Otterdijk
2018-01-03 09:19:52 +01:00
committed by GitHub
parent 996d0fb0e5 d613cfc6ea
commit c8a91684d6
48 changed files with 307 additions and 416 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.travis.yml
+6 -6
View File
@@ -7,7 +7,9 @@ php:
matrix:
include:
- php: 7.1
env: STATIC_ANALYSIS=true
env: ECS=true
- php: 7.1
env: PHPSTAN=true
cache:
directories:
@@ -15,14 +17,12 @@ cache:
install:
- composer install --no-interaction
# coding style
- if [[ $STATIC_ANALYSIS != "" ]]; then composer create-project symplify/easy-coding-standard temp/ecs; fi
- if [[ $ECS != "" ]]; then composer create-project symplify/easy-coding-standard temp/ecs; fi
script:
- vendor/bin/phpunit --coverage-clover=coverage.xml -v
# coding style
- if [[ $STATIC_ANALYSIS != "" ]]; then temp/ecs/bin/ecs check src tests; fi
- if [[ $STATIC_ANALYSIS != "" ]]; then vendor/bin/phpstan analyse src --level max --configuration phpstan.neon; fi
- if [[ $ECS != "" ]]; then temp/ecs/bin/ecs check src tests; fi
- if [[ $PHPSTAN != "" ]]; then vendor/bin/phpstan analyse src --level max --configuration phpstan.neon; fi
after_script:
- wget https://github.com/satooshi/php-coveralls/releases/download/v1.0.1/coveralls.phar;
composer.lock
Generated
+88 -192
View File
@@ -261,20 +261,20 @@
},
{
"name": "jean85/pretty-package-versions",
"version": "1.0.2",
"version": "1.0.3",
"source": {
"type": "git",
"url": "https://github.com/Jean85/pretty-package-versions.git",
"reference": "cda6ed1bfbcf7a3736b8943466ad8b1b5c0cc7c9"
"reference": "3c8487fdd6c750ff3f10c32ddfdd2a7803c1d461"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/Jean85/pretty-package-versions/zipball/cda6ed1bfbcf7a3736b8943466ad8b1b5c0cc7c9",
"reference": "cda6ed1bfbcf7a3736b8943466ad8b1b5c0cc7c9",
"url": "https://api.github.com/repos/Jean85/pretty-package-versions/zipball/3c8487fdd6c750ff3f10c32ddfdd2a7803c1d461",
"reference": "3c8487fdd6c750ff3f10c32ddfdd2a7803c1d461",
"shasum": ""
},
"require": {
"ocramius/package-versions": "^1.1.3",
"ocramius/package-versions": "^1.2.0",
"php": "^7.0"
},
"require-dev": {
@@ -300,7 +300,7 @@
"keywords": [
"package versions"
],
"time": "2017-09-06T15:48:57+00:00"
"time": "2017-11-30T22:02:29+00:00"
},
{
"name": "mockery/mockery",
@@ -875,16 +875,16 @@
},
{
"name": "nikic/php-parser",
"version": "v3.1.2",
"version": "v3.1.3",
"source": {
"type": "git",
"url": "https://github.com/nikic/PHP-Parser.git",
"reference": "08131e7ff29de6bb9f12275c7d35df71f25f4d89"
"reference": "579f4ce846734a1cf55d6a531d00ca07a43e3cda"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/08131e7ff29de6bb9f12275c7d35df71f25f4d89",
"reference": "08131e7ff29de6bb9f12275c7d35df71f25f4d89",
"url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/579f4ce846734a1cf55d6a531d00ca07a43e3cda",
"reference": "579f4ce846734a1cf55d6a531d00ca07a43e3cda",
"shasum": ""
},
"require": {
@@ -922,20 +922,20 @@
"parser",
"php"
],
"time": "2017-11-04T11:48:34+00:00"
"time": "2017-12-26T14:43:21+00:00"
},
{
"name": "ocramius/package-versions",
"version": "1.1.3",
"version": "1.2.0",
"source": {
"type": "git",
"url": "https://github.com/Ocramius/PackageVersions.git",
"reference": "72b226d2957e9e6a9ed09aeaa29cabd840d1a3b7"
"reference": "ad8a245decad4897cc6b432743913dad0d69753c"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/Ocramius/PackageVersions/zipball/72b226d2957e9e6a9ed09aeaa29cabd840d1a3b7",
"reference": "72b226d2957e9e6a9ed09aeaa29cabd840d1a3b7",
"url": "https://api.github.com/repos/Ocramius/PackageVersions/zipball/ad8a245decad4897cc6b432743913dad0d69753c",
"reference": "ad8a245decad4897cc6b432743913dad0d69753c",
"shasum": ""
},
"require": {
@@ -946,7 +946,7 @@
"composer/composer": "^1.3",
"ext-zip": "*",
"humbug/humbug": "dev-master",
"phpunit/phpunit": "^5.7.5"
"phpunit/phpunit": "^6.4"
},
"type": "composer-plugin",
"extra": {
@@ -971,7 +971,7 @@
}
],
"description": "Composer plugin that provides efficient querying for installed package versions (no runtime IO)",
"time": "2017-09-06T15:24:43+00:00"
"time": "2017-11-24T11:07:03+00:00"
},
{
"name": "phar-io/manifest",
@@ -1180,20 +1180,20 @@
},
{
"name": "phpstan/phpstan",
"version": "0.9",
"version": "0.9.1",
"source": {
"type": "git",
"url": "https://github.com/phpstan/phpstan.git",
"reference": "f8cccde009c856e42704b7e4c250d5c73c60d00d"
"reference": "ef60e5cc0a32ddb2637523dafef966e0aac1e16f"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/phpstan/phpstan/zipball/f8cccde009c856e42704b7e4c250d5c73c60d00d",
"reference": "f8cccde009c856e42704b7e4c250d5c73c60d00d",
"url": "https://api.github.com/repos/phpstan/phpstan/zipball/ef60e5cc0a32ddb2637523dafef966e0aac1e16f",
"reference": "ef60e5cc0a32ddb2637523dafef966e0aac1e16f",
"shasum": ""
},
"require": {
"jean85/pretty-package-versions": "^1.0.2",
"jean85/pretty-package-versions": "^1.0.3",
"nette/bootstrap": "^2.4 || ^3.0",
"nette/di": "^2.4.7 || ^3.0",
"nette/robot-loader": "^3.0.1",
@@ -1211,7 +1211,7 @@
"phpstan/phpstan-php-parser": "^0.9",
"phpstan/phpstan-phpunit": "^0.9",
"phpstan/phpstan-strict-rules": "^0.9",
"phpunit/phpunit": "^6.3",
"phpunit/phpunit": "^6.5.2",
"slevomat/coding-standard": "4.0.0"
},
"bin": [
@@ -1236,20 +1236,20 @@
"MIT"
],
"description": "PHPStan - PHP Static Analysis Tool",
"time": "2017-11-29T11:25:41+00:00"
"time": "2017-12-02T19:34:06+00:00"
},
{
"name": "phpunit/php-code-coverage",
"version": "5.2.3",
"version": "5.3.0",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/php-code-coverage.git",
"reference": "8e1d2397d8adf59a3f12b2878a3aaa66d1ab189d"
"reference": "661f34d0bd3f1a7225ef491a70a020ad23a057a1"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/8e1d2397d8adf59a3f12b2878a3aaa66d1ab189d",
"reference": "8e1d2397d8adf59a3f12b2878a3aaa66d1ab189d",
"url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/661f34d0bd3f1a7225ef491a70a020ad23a057a1",
"reference": "661f34d0bd3f1a7225ef491a70a020ad23a057a1",
"shasum": ""
},
"require": {
@@ -1258,14 +1258,13 @@
"php": "^7.0",
"phpunit/php-file-iterator": "^1.4.2",
"phpunit/php-text-template": "^1.2.1",
"phpunit/php-token-stream": "^2.0",
"phpunit/php-token-stream": "^2.0.1",
"sebastian/code-unit-reverse-lookup": "^1.0.1",
"sebastian/environment": "^3.0",
"sebastian/version": "^2.0.1",
"theseer/tokenizer": "^1.1"
},
"require-dev": {
"ext-xdebug": "^2.5",
"phpunit/phpunit": "^6.0"
},
"suggest": {
@@ -1274,7 +1273,7 @@
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "5.2.x-dev"
"dev-master": "5.3.x-dev"
}
},
"autoload": {
@@ -1289,7 +1288,7 @@
"authors": [
{
"name": "Sebastian Bergmann",
"email": "sb@sebastian-bergmann.de",
"email": "sebastian@phpunit.de",
"role": "lead"
}
],
@@ -1300,20 +1299,20 @@
"testing",
"xunit"
],
"time": "2017-11-03T13:47:33+00:00"
"time": "2017-12-06T09:29:45+00:00"
},
{
"name": "phpunit/php-file-iterator",
"version": "1.4.3",
"version": "1.4.5",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/php-file-iterator.git",
"reference": "8ebba84e5bd74fc5fdeb916b38749016c7232f93"
"reference": "730b01bc3e867237eaac355e06a36b85dd93a8b4"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/8ebba84e5bd74fc5fdeb916b38749016c7232f93",
"reference": "8ebba84e5bd74fc5fdeb916b38749016c7232f93",
"url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/730b01bc3e867237eaac355e06a36b85dd93a8b4",
"reference": "730b01bc3e867237eaac355e06a36b85dd93a8b4",
"shasum": ""
},
"require": {
@@ -1347,7 +1346,7 @@
"filesystem",
"iterator"
],
"time": "2017-11-24T15:00:59+00:00"
"time": "2017-11-27T13:52:08+00:00"
},
{
"name": "phpunit/php-text-template",
@@ -1441,16 +1440,16 @@
},
{
"name": "phpunit/php-token-stream",
"version": "2.0.1",
"version": "2.0.2",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/php-token-stream.git",
"reference": "9a02332089ac48e704c70f6cefed30c224e3c0b0"
"reference": "791198a2c6254db10131eecfe8c06670700904db"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/9a02332089ac48e704c70f6cefed30c224e3c0b0",
"reference": "9a02332089ac48e704c70f6cefed30c224e3c0b0",
"url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/791198a2c6254db10131eecfe8c06670700904db",
"reference": "791198a2c6254db10131eecfe8c06670700904db",
"shasum": ""
},
"require": {
@@ -1486,20 +1485,20 @@
"keywords": [
"tokenizer"
],
"time": "2017-08-20T05:47:52+00:00"
"time": "2017-11-27T05:48:46+00:00"
},
{
"name": "phpunit/phpunit",
"version": "6.4.4",
"version": "6.5.5",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/phpunit.git",
"reference": "562f7dc75d46510a4ed5d16189ae57fbe45a9932"
"reference": "83d27937a310f2984fd575686138597147bdc7df"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/562f7dc75d46510a4ed5d16189ae57fbe45a9932",
"reference": "562f7dc75d46510a4ed5d16189ae57fbe45a9932",
"url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/83d27937a310f2984fd575686138597147bdc7df",
"reference": "83d27937a310f2984fd575686138597147bdc7df",
"shasum": ""
},
"require": {
@@ -1513,12 +1512,12 @@
"phar-io/version": "^1.0",
"php": "^7.0",
"phpspec/prophecy": "^1.7",
"phpunit/php-code-coverage": "^5.2.2",
"phpunit/php-file-iterator": "^1.4.2",
"phpunit/php-code-coverage": "^5.3",
"phpunit/php-file-iterator": "^1.4.3",
"phpunit/php-text-template": "^1.2.1",
"phpunit/php-timer": "^1.0.9",
"phpunit/phpunit-mock-objects": "^4.0.3",
"sebastian/comparator": "^2.0.2",
"phpunit/phpunit-mock-objects": "^5.0.5",
"sebastian/comparator": "^2.1",
"sebastian/diff": "^2.0",
"sebastian/environment": "^3.1",
"sebastian/exporter": "^3.1",
@@ -1544,7 +1543,7 @@
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "6.4.x-dev"
"dev-master": "6.5.x-dev"
}
},
"autoload": {
@@ -1570,33 +1569,33 @@
"testing",
"xunit"
],
"time": "2017-11-08T11:26:09+00:00"
"time": "2017-12-17T06:31:19+00:00"
},
{
"name": "phpunit/phpunit-mock-objects",
"version": "4.0.4",
"version": "5.0.5",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/phpunit-mock-objects.git",
"reference": "2f789b59ab89669015ad984afa350c4ec577ade0"
"reference": "283b9f4f670e3a6fd6c4ff95c51a952eb5c75933"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/phpunit-mock-objects/zipball/2f789b59ab89669015ad984afa350c4ec577ade0",
"reference": "2f789b59ab89669015ad984afa350c4ec577ade0",
"url": "https://api.github.com/repos/sebastianbergmann/phpunit-mock-objects/zipball/283b9f4f670e3a6fd6c4ff95c51a952eb5c75933",
"reference": "283b9f4f670e3a6fd6c4ff95c51a952eb5c75933",
"shasum": ""
},
"require": {
"doctrine/instantiator": "^1.0.5",
"php": "^7.0",
"phpunit/php-text-template": "^1.2.1",
"sebastian/exporter": "^3.0"
"sebastian/exporter": "^3.1"
},
"conflict": {
"phpunit/phpunit": "<6.0"
},
"require-dev": {
"phpunit/phpunit": "^6.0"
"phpunit/phpunit": "^6.5"
},
"suggest": {
"ext-soap": "*"
@@ -1604,7 +1603,7 @@
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "4.0.x-dev"
"dev-master": "5.0.x-dev"
}
},
"autoload": {
@@ -1619,7 +1618,7 @@
"authors": [
{
"name": "Sebastian Bergmann",
"email": "sb@sebastian-bergmann.de",
"email": "sebastian@phpunit.de",
"role": "lead"
}
],
@@ -1629,54 +1628,7 @@
"mock",
"xunit"
],
"time": "2017-08-03T14:08:16+00:00"
},
{
"name": "psr/log",
"version": "1.0.2",
"source": {
"type": "git",
"url": "https://github.com/php-fig/log.git",
"reference": "4ebe3a8bf773a19edfe0a84b6585ba3d401b724d"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/php-fig/log/zipball/4ebe3a8bf773a19edfe0a84b6585ba3d401b724d",
"reference": "4ebe3a8bf773a19edfe0a84b6585ba3d401b724d",
"shasum": ""
},
"require": {
"php": ">=5.3.0"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "1.0.x-dev"
}
},
"autoload": {
"psr-4": {
"Psr\\Log\\": "Psr/Log/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "PHP-FIG",
"homepage": "http://www.php-fig.org/"
}
],
"description": "Common interface for logging libraries",
"homepage": "https://github.com/php-fig/log",
"keywords": [
"log",
"psr",
"psr-3"
],
"time": "2016-10-10T12:19:37+00:00"
"time": "2017-12-10T08:01:53+00:00"
},
{
"name": "sebastian/code-unit-reverse-lookup",
@@ -1725,16 +1677,16 @@
},
{
"name": "sebastian/comparator",
"version": "2.1.0",
"version": "2.1.1",
"source": {
"type": "git",
"url": "https://github.com/sebastianbergmann/comparator.git",
"reference": "1174d9018191e93cb9d719edec01257fc05f8158"
"reference": "b11c729f95109b56a0fe9650c6a63a0fcd8c439f"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/1174d9018191e93cb9d719edec01257fc05f8158",
"reference": "1174d9018191e93cb9d719edec01257fc05f8158",
"url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/b11c729f95109b56a0fe9650c6a63a0fcd8c439f",
"reference": "b11c729f95109b56a0fe9650c6a63a0fcd8c439f",
"shasum": ""
},
"require": {
@@ -1785,7 +1737,7 @@
"compare",
"equality"
],
"time": "2017-11-03T07:16:52+00:00"
"time": "2017-12-22T14:50:35+00:00"
},
{
"name": "sebastian/diff",
@@ -2239,44 +2191,44 @@
},
{
"name": "symfony/console",
"version": "v3.3.13",
"version": "v4.0.2",
"source": {
"type": "git",
"url": "https://github.com/symfony/console.git",
"reference": "63cd7960a0a522c3537f6326706d7f3b8de65805"
"reference": "de8cf039eacdec59d83f7def67e3b8ff5ed46714"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/console/zipball/63cd7960a0a522c3537f6326706d7f3b8de65805",
"reference": "63cd7960a0a522c3537f6326706d7f3b8de65805",
"url": "https://api.github.com/repos/symfony/console/zipball/de8cf039eacdec59d83f7def67e3b8ff5ed46714",
"reference": "de8cf039eacdec59d83f7def67e3b8ff5ed46714",
"shasum": ""
},
"require": {
"php": "^5.5.9|>=7.0.8",
"symfony/debug": "~2.8|~3.0",
"php": "^7.1.3",
"symfony/polyfill-mbstring": "~1.0"
},
"conflict": {
"symfony/dependency-injection": "<3.3"
"symfony/dependency-injection": "<3.4",
"symfony/process": "<3.3"
},
"require-dev": {
"psr/log": "~1.0",
"symfony/config": "~3.3",
"symfony/dependency-injection": "~3.3",
"symfony/event-dispatcher": "~2.8|~3.0",
"symfony/filesystem": "~2.8|~3.0",
"symfony/process": "~2.8|~3.0"
"symfony/config": "~3.4|~4.0",
"symfony/dependency-injection": "~3.4|~4.0",
"symfony/event-dispatcher": "~3.4|~4.0",
"symfony/lock": "~3.4|~4.0",
"symfony/process": "~3.4|~4.0"
},
"suggest": {
"psr/log": "For using the console logger",
"symfony/event-dispatcher": "",
"symfony/filesystem": "",
"symfony/lock": "",
"symfony/process": ""
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "3.3-dev"
"dev-master": "4.0-dev"
}
},
"autoload": {
@@ -2303,85 +2255,29 @@
],
"description": "Symfony Console Component",
"homepage": "https://symfony.com",
"time": "2017-11-16T15:24:32+00:00"
},
{
"name": "symfony/debug",
"version": "v3.3.13",
"source": {
"type": "git",
"url": "https://github.com/symfony/debug.git",
"reference": "74557880e2846b5c84029faa96b834da37e29810"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/debug/zipball/74557880e2846b5c84029faa96b834da37e29810",
"reference": "74557880e2846b5c84029faa96b834da37e29810",
"shasum": ""
},
"require": {
"php": "^5.5.9|>=7.0.8",
"psr/log": "~1.0"
},
"conflict": {
"symfony/http-kernel": ">=2.3,<2.3.24|~2.4.0|>=2.5,<2.5.9|>=2.6,<2.6.2"
},
"require-dev": {
"symfony/http-kernel": "~2.8|~3.0"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "3.3-dev"
}
},
"autoload": {
"psr-4": {
"Symfony\\Component\\Debug\\": ""
},
"exclude-from-classmap": [
"/Tests/"
]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Fabien Potencier",
"email": "[email protected]"
},
{
"name": "Symfony Community",
"homepage": "https://symfony.com/contributors"
}
],
"description": "Symfony Debug Component",
"homepage": "https://symfony.com",
"time": "2017-11-10T16:38:39+00:00"
"time": "2017-12-14T19:48:22+00:00"
},
{
"name": "symfony/finder",
"version": "v3.3.13",
"version": "v4.0.2",
"source": {
"type": "git",
"url": "https://github.com/symfony/finder.git",
"reference": "138af5ec075d4b1d1bd19de08c38a34bb2d7d880"
"reference": "c9cdda4dc4a3182d8d6daeebce4a25fef078ea4c"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/finder/zipball/138af5ec075d4b1d1bd19de08c38a34bb2d7d880",
"reference": "138af5ec075d4b1d1bd19de08c38a34bb2d7d880",
"url": "https://api.github.com/repos/symfony/finder/zipball/c9cdda4dc4a3182d8d6daeebce4a25fef078ea4c",
"reference": "c9cdda4dc4a3182d8d6daeebce4a25fef078ea4c",
"shasum": ""
},
"require": {
"php": "^5.5.9|>=7.0.8"
"php": "^7.1.3"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "3.3-dev"
"dev-master": "4.0-dev"
}
},
"autoload": {
@@ -2408,7 +2304,7 @@
],
"description": "Symfony Finder Component",
"homepage": "https://symfony.com",
"time": "2017-11-05T15:47:03+00:00"
"time": "2017-11-07T14:45:01+00:00"
},
{
"name": "symfony/polyfill-mbstring",
easy-coding-standard.neon
+1 -2
View File
@@ -1,7 +1,6 @@
includes:
- temp/ecs/config/clean-code.neon
- temp/ecs/config/psr2-checkers.neon
- temp/ecs/config/spaces.neon
- temp/ecs/config/psr2.neon
- temp/ecs/config/common.neon
checkers:
src/DocBlock/DescriptionFactory.php
+3 -3
View File
@@ -112,7 +112,7 @@ class DescriptionFactory
{
$count = count($tokens);
$tagCount = 0;
$tags = [];
$tags = [];
for ($i = 1; $i < $count; $i += 2) {
$tags[] = $this->tagFactory->create($tokens[$i], $context);
@@ -156,7 +156,7 @@ class DescriptionFactory
// determine how many whitespace characters need to be stripped
$startingSpaceCount = 9999999;
for ($i = 1; $i < count($lines); $i++) {
for ($i = 1; $i < count($lines); ++$i) {
// lines with a no length do not count as they are not indented at all
if (strlen(trim($lines[$i])) === 0) {
continue;
@@ -169,7 +169,7 @@ class DescriptionFactory
// strip the number of spaces from each line
if ($startingSpaceCount > 0) {
for ($i = 1; $i < count($lines); $i++) {
for ($i = 1; $i < count($lines); ++$i) {
$lines[$i] = substr($lines[$i], $startingSpaceCount);
}
}
src/DocBlock/Serializer.php
+1 -1
View File
@@ -105,7 +105,7 @@ class Serializer
private function getSummaryAndDescriptionTextBlock(DocBlock $docblock, $wrapLength): string
{
$text = $docblock->getSummary() . ((string)$docblock->getDescription() ? "\n\n" . $docblock->getDescription()
$text = $docblock->getSummary() . ((string) $docblock->getDescription() ? "\n\n" . $docblock->getDescription()
: '');
if ($wrapLength !== null) {
$text = wordwrap($text, $wrapLength);
src/DocBlock/StandardTagFactory.php
+22 -22
View File
@@ -45,25 +45,25 @@ final class StandardTagFactory implements TagFactory
* @var string[] An array with a tag as a key, and an FQCN to a class that handles it as an array value.
*/
private $tagHandlerMappings = [
'author' => '\phpDocumentor\Reflection\DocBlock\Tags\Author',
'covers' => '\phpDocumentor\Reflection\DocBlock\Tags\Covers',
'deprecated' => '\phpDocumentor\Reflection\DocBlock\Tags\Deprecated',
'author' => '\phpDocumentor\Reflection\DocBlock\Tags\Author',
'covers' => '\phpDocumentor\Reflection\DocBlock\Tags\Covers',
'deprecated' => '\phpDocumentor\Reflection\DocBlock\Tags\Deprecated',
// 'example' => '\phpDocumentor\Reflection\DocBlock\Tags\Example',
'link' => '\phpDocumentor\Reflection\DocBlock\Tags\Link',
'method' => '\phpDocumentor\Reflection\DocBlock\Tags\Method',
'param' => '\phpDocumentor\Reflection\DocBlock\Tags\Param',
'property-read' => '\phpDocumentor\Reflection\DocBlock\Tags\PropertyRead',
'property' => '\phpDocumentor\Reflection\DocBlock\Tags\Property',
'link' => '\phpDocumentor\Reflection\DocBlock\Tags\Link',
'method' => '\phpDocumentor\Reflection\DocBlock\Tags\Method',
'param' => '\phpDocumentor\Reflection\DocBlock\Tags\Param',
'property-read' => '\phpDocumentor\Reflection\DocBlock\Tags\PropertyRead',
'property' => '\phpDocumentor\Reflection\DocBlock\Tags\Property',
'property-write' => '\phpDocumentor\Reflection\DocBlock\Tags\PropertyWrite',
'return' => '\phpDocumentor\Reflection\DocBlock\Tags\Return_',
'see' => '\phpDocumentor\Reflection\DocBlock\Tags\See',
'since' => '\phpDocumentor\Reflection\DocBlock\Tags\Since',
'source' => '\phpDocumentor\Reflection\DocBlock\Tags\Source',
'throw' => '\phpDocumentor\Reflection\DocBlock\Tags\Throws',
'throws' => '\phpDocumentor\Reflection\DocBlock\Tags\Throws',
'uses' => '\phpDocumentor\Reflection\DocBlock\Tags\Uses',
'var' => '\phpDocumentor\Reflection\DocBlock\Tags\Var_',
'version' => '\phpDocumentor\Reflection\DocBlock\Tags\Version'
'return' => '\phpDocumentor\Reflection\DocBlock\Tags\Return_',
'see' => '\phpDocumentor\Reflection\DocBlock\Tags\See',
'since' => '\phpDocumentor\Reflection\DocBlock\Tags\Since',
'source' => '\phpDocumentor\Reflection\DocBlock\Tags\Source',
'throw' => '\phpDocumentor\Reflection\DocBlock\Tags\Throws',
'throws' => '\phpDocumentor\Reflection\DocBlock\Tags\Throws',
'uses' => '\phpDocumentor\Reflection\DocBlock\Tags\Uses',
'var' => '\phpDocumentor\Reflection\DocBlock\Tags\Var_',
'version' => '\phpDocumentor\Reflection\DocBlock\Tags\Version',
];
/**
@@ -186,7 +186,7 @@ final class StandardTagFactory implements TagFactory
private function createTag(string $body, string $name, TypeContext $context): ?Tag
{
$handlerClassName = $this->findHandlerClassName($name, $context);
$arguments = $this->getArgumentsForParametersFromWiring(
$arguments = $this->getArgumentsForParametersFromWiring(
$this->fetchParametersForHandlerFactoryMethod($handlerClassName),
$this->getServiceLocatorWithDynamicParameters($context, $name, $body)
);
@@ -254,7 +254,7 @@ final class StandardTagFactory implements TagFactory
private function fetchParametersForHandlerFactoryMethod(string $handlerClassName)
{
if (! isset($this->tagHandlerParameterCache[$handlerClassName])) {
$methodReflection = new \ReflectionMethod($handlerClassName, 'create');
$methodReflection = new \ReflectionMethod($handlerClassName, 'create');
$this->tagHandlerParameterCache[$handlerClassName] = $methodReflection->getParameters();
}
@@ -276,9 +276,9 @@ final class StandardTagFactory implements TagFactory
$locator = array_merge(
$this->serviceLocator,
[
'name' => $tagName,
'body' => $tagBody,
TypeContext::class => $context
'name' => $tagName,
'body' => $tagBody,
TypeContext::class => $context,
]
);
src/DocBlock/Tags/Author.php
+1 -1
View File
@@ -36,7 +36,7 @@ final class Author extends BaseTag implements Factory\StaticMethod
throw new \InvalidArgumentException('The author tag does not have a valid e-mail address');
}
$this->authorName = $authorName;
$this->authorName = $authorName;
$this->authorEmail = $authorEmail;
}
src/DocBlock/Tags/Example.php
+7 -7
View File
@@ -69,7 +69,7 @@ final class Example extends BaseTag
if ($this->isURI) {
$filePath = $this->isUriRelative($this->filePath)
? str_replace('%2F', '/', rawurlencode($this->filePath))
:$this->filePath;
: $this->filePath;
}
return trim($filePath . ' ' . parent::getDescription());
@@ -89,7 +89,7 @@ final class Example extends BaseTag
}
$filePath = null;
$fileUri = null;
$fileUri = null;
if ('' !== $matches[1]) {
$filePath = $matches[1];
} else {
@@ -97,17 +97,17 @@ final class Example extends BaseTag
}
$startingLine = 1;
$lineCount = null;
$description = null;
$lineCount = null;
$description = null;
if (array_key_exists(3, $matches)) {
$description = $matches[3];
// Starting line / Number of lines / Description
if (preg_match('/^([1-9]\d*)(?:\s+((?1))\s*)?(.*)$/sux', $matches[3], $contentMatches)) {
$startingLine = (int)$contentMatches[1];
$startingLine = (int) $contentMatches[1];
if (isset($contentMatches[2]) && $contentMatches[2] !== '') {
$lineCount = (int)$contentMatches[2];
$lineCount = (int) $contentMatches[2];
}
if (array_key_exists(3, $contentMatches)) {
@@ -117,7 +117,7 @@ final class Example extends BaseTag
}
return new static(
$filePath !== null?$filePath:$fileUri,
$filePath !== null ? $filePath : $fileUri,
$fileUri !== null,
$startingLine,
$lineCount,
src/DocBlock/Tags/Formatter/AlignFormatter.php
+1 -1
View File
@@ -39,6 +39,6 @@ class AlignFormatter implements Formatter
*/
public function format(Tag $tag): string
{
return '@' . $tag->getName() . str_repeat(' ', $this->maxLen - strlen($tag->getName()) + 1) . (string)$tag;
return '@' . $tag->getName() . str_repeat(' ', $this->maxLen - strlen($tag->getName()) + 1) . (string) $tag;
}
}
src/DocBlock/Tags/Formatter/PassthroughFormatter.php
+1 -1
View File
@@ -23,6 +23,6 @@ class PassthroughFormatter implements Formatter
*/
public function format(Tag $tag): string
{
return trim('@' . $tag->getName() . ' ' . (string)$tag);
return trim('@' . $tag->getName() . ' ' . (string) $tag);
}
}
src/DocBlock/Tags/Link.php
+1 -1
View File
@@ -40,7 +40,7 @@ final class Link extends BaseTag implements Factory\StaticMethod
/**
* {@inheritdoc}
*/
public static function create(string $body, ?DescriptionFactory $descriptionFactory = null, ?TypeContext $context = null): Link
public static function create(string $body, ?DescriptionFactory $descriptionFactory = null, ?TypeContext $context = null): self
{
Assert::notNull($descriptionFactory);
src/DocBlock/Tags/Method.php
+10 -10
View File
@@ -54,10 +54,10 @@ final class Method extends BaseTag implements Factory\StaticMethod
$returnType = new Void_();
}
$this->methodName = $methodName;
$this->arguments = $this->filterArguments($arguments);
$this->returnType = $returnType;
$this->isStatic = $static;
$this->methodName = $methodName;
$this->arguments = $this->filterArguments($arguments);
$this->returnType = $returnType;
$this->isStatic = $static;
$this->description = $description;
}
@@ -71,7 +71,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
?TypeContext $context = null
): ?self {
Assert::stringNotEmpty($body);
Assert::allNotNull([ $typeResolver, $descriptionFactory ]);
Assert::allNotNull([$typeResolver, $descriptionFactory]);
// 1. none or more whitespace
// 2. optionally the keyword "static" followed by whitespace
@@ -131,7 +131,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
$returnType = 'void';
}
$returnType = $typeResolver->resolve($returnType, $context);
$returnType = $typeResolver->resolve($returnType, $context);
$description = $descriptionFactory->create($description, $context);
if (is_string($arguments) && strlen($arguments) > 0) {
@@ -150,7 +150,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
}
}
$argument = [ 'name' => $argumentName, 'type' => $argumentType];
$argument = ['name' => $argumentName, 'type' => $argumentType];
}
} else {
$arguments = [];
@@ -198,7 +198,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
}
return trim(($this->isStatic() ? 'static ' : '')
. (string)$this->returnType . ' '
. (string) $this->returnType . ' '
. $this->methodName
. '(' . implode(', ', $arguments) . ')'
. ($this->description ? ' ' . $this->description->render() : ''));
@@ -208,7 +208,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
{
foreach ($arguments as &$argument) {
if (is_string($argument)) {
$argument = [ 'name' => $argument ];
$argument = ['name' => $argument];
}
if (! isset($argument['type'])) {
@@ -217,7 +217,7 @@ final class Method extends BaseTag implements Factory\StaticMethod
$keys = array_keys($argument);
sort($keys);
if ($keys !== [ 'name', 'type' ]) {
if ($keys !== ['name', 'type']) {
throw new \InvalidArgumentException(
'Arguments can only have the "name" and "type" fields, found: ' . var_export($keys, true)
);
src/DocBlock/Tags/Reference/Fqsen.php
+1 -1
View File
@@ -38,6 +38,6 @@ final class Fqsen implements Reference
*/
public function __toString(): string
{
return (string)$this->fqsen;
return (string) $this->fqsen;
}
}
src/DocBlock/Tags/See.php
+1 -1
View File
@@ -52,7 +52,7 @@ class See extends BaseTag implements Factory\StaticMethod
) {
Assert::allNotNull([$resolver, $descriptionFactory]);
$parts = preg_split('/\s+/Su', $body, 2);
$parts = preg_split('/\s+/Su', $body, 2);
$description = isset($parts[1]) ? $descriptionFactory->create($parts[1], $context) : null;
// https://tools.ietf.org/html/rfc2396#section-3
src/DocBlock/Tags/Since.php
+1 -1
View File
@@ -49,7 +49,7 @@ final class Since extends BaseTag implements Factory\StaticMethod
{
Assert::nullOrStringNotEmpty($version);
$this->version = $version;
$this->version = $version;
$this->description = $description;
}
src/DocBlock/Tags/Source.php
+7 -7
View File
@@ -37,9 +37,9 @@ final class Source extends BaseTag implements Factory\StaticMethod
Assert::integerish($startingLine);
Assert::nullOrIntegerish($lineCount);
$this->startingLine = (int)$startingLine;
$this->lineCount = $lineCount !== null ? (int)$lineCount : null;
$this->description = $description;
$this->startingLine = (int) $startingLine;
$this->lineCount = $lineCount !== null ? (int) $lineCount : null;
$this->description = $description;
}
/**
@@ -54,14 +54,14 @@ final class Source extends BaseTag implements Factory\StaticMethod
Assert::notNull($descriptionFactory);
$startingLine = 1;
$lineCount = null;
$description = null;
$lineCount = null;
$description = null;
// Starting line / Number of lines / Description
if (preg_match('/^([1-9]\d*)\s*(?:((?1))\s+)?(.*)$/sux', $body, $matches)) {
$startingLine = (int)$matches[1];
$startingLine = (int) $matches[1];
if (isset($matches[2]) && $matches[2] !== '') {
$lineCount = (int)$matches[2];
$lineCount = (int) $matches[2];
}
$description = $matches[3];
src/DocBlock/Tags/Throws.php
+2 -2
View File
@@ -32,7 +32,7 @@ final class Throws extends BaseTag implements Factory\StaticMethod
public function __construct(Type $type, ?Description $description = null)
{
$this->type = $type;
$this->type = $type;
$this->description = $description;
}
@@ -49,7 +49,7 @@ final class Throws extends BaseTag implements Factory\StaticMethod
$parts = preg_split('/\s+/Su', $body, 2);
$type = $typeResolver->resolve($parts[0] ?? '', $context);
$type = $typeResolver->resolve($parts[0] ?? '', $context);
$description = $descriptionFactory->create($parts[1] ?? '', $context);
return new static($type, $description);
src/DocBlock/Tags/Uses.php
+1 -1
View File
@@ -35,7 +35,7 @@ final class Uses extends BaseTag implements Factory\StaticMethod
*/
public function __construct(Fqsen $refers, ?Description $description = null)
{
$this->refers = $refers;
$this->refers = $refers;
$this->description = $description;
}
src/DocBlock/Tags/Var_.php
+4 -4
View File
@@ -37,8 +37,8 @@ class Var_ extends BaseTag implements Factory\StaticMethod
public function __construct(string $variableName, ?Type $type = null, ?Description $description = null)
{
$this->variableName = $variableName;
$this->type = $type;
$this->description = $description;
$this->type = $type;
$this->description = $description;
}
/**
@@ -53,8 +53,8 @@ class Var_ extends BaseTag implements Factory\StaticMethod
Assert::stringNotEmpty($body);
Assert::allNotNull([$typeResolver, $descriptionFactory]);
$parts = preg_split('/(\s+)/Su', $body, 3, PREG_SPLIT_DELIM_CAPTURE);
$type = null;
$parts = preg_split('/(\s+)/Su', $body, 3, PREG_SPLIT_DELIM_CAPTURE);
$type = null;
$variableName = '';
// if the first item that is encountered is not a variable; it is a type
src/DocBlockFactory.php
+1 -1
View File
@@ -41,7 +41,7 @@ final class DocBlockFactory implements DocBlockFactoryInterface
*
* @param string[] $additionalTags
*/
public static function createInstance(array $additionalTags = []): DocBlockFactory
public static function createInstance(array $additionalTags = []): self
{
$fqsenResolver = new FqsenResolver();
$tagFactory = new StandardTagFactory($fqsenResolver);
tests/integration/DocblocksWithAnnotationsTest.php
+1 -1
View File
@@ -39,7 +39,7 @@ final class DocblocksWithAnnotationsTest extends TestCase
*/
DOCCOMMENT;
$factory = DocBlockFactory::createInstance();
$factory = DocBlockFactory::createInstance();
$docblock = $factory->create($docComment);
$this->assertCount(3, $docblock->getTags());
tests/integration/InterpretingDocBlocksTest.php
+2 -2
View File
@@ -74,8 +74,8 @@ DESCRIPTION;
$this->assertInstanceOf(See::class, $seeTags[0]);
$seeTag = $seeTags[0];
$this->assertSame('\\' . StandardTagFactory::class, (string)$seeTag->getReference());
$this->assertSame('', (string)$seeTag->getDescription());
$this->assertSame('\\' . StandardTagFactory::class, (string) $seeTag->getReference());
$this->assertSame('', (string) $seeTag->getDescription());
}
public function testDescriptionsCanEscapeAtSignsAndClosingBraces(): void
tests/integration/UsingTagsTest.php
+1 -1
View File
@@ -42,7 +42,7 @@ class UsingTagsTest extends TestCase
$this->assertInstanceOf(\MyTag::class, $customTagObjects[0]);
$this->assertSame('my-tag', $customTagObjects[0]->getName());
$this->assertSame('I have a description', (string)$customTagObjects[0]->getDescription());
$this->assertSame('I have a description', (string) $customTagObjects[0]->getDescription());
$this->assertSame($docComment, $reconstitutedDocComment);
}
}
tests/unit/DocBlock/DescriptionFactoryTest.php
+9 -9
View File
@@ -43,7 +43,7 @@ class DescriptionFactoryTest extends TestCase
$tagFactory = m::mock(TagFactory::class);
$tagFactory->shouldReceive('create')->never();
$factory = new DescriptionFactory($tagFactory);
$factory = new DescriptionFactory($tagFactory);
$description = $factory->create($contents, new Context(''));
$this->assertSame($contents, $description->render());
@@ -60,7 +60,7 @@ class DescriptionFactoryTest extends TestCase
$tagFactory = m::mock(TagFactory::class);
$tagFactory->shouldReceive('create')->never();
$factory = new DescriptionFactory($tagFactory);
$factory = new DescriptionFactory($tagFactory);
$description = $factory->create($contents, new Context(''));
$this->assertSame($expected, $description->render());
@@ -77,15 +77,15 @@ class DescriptionFactoryTest extends TestCase
*/
public function testDescriptionCanParseAStringWithInlineTag(): void
{
$contents = 'This is text for a {@link http://phpdoc.org/ description} that uses an inline tag.';
$context = new Context('');
$contents = 'This is text for a {@link http://phpdoc.org/ description} that uses an inline tag.';
$context = new Context('');
$tagFactory = m::mock(TagFactory::class);
$tagFactory->shouldReceive('create')
->once()
->with('@link http://phpdoc.org/ description', $context)
->andReturn(new Link('http://phpdoc.org/', new Description('description')));
$factory = new DescriptionFactory($tagFactory);
$factory = new DescriptionFactory($tagFactory);
$description = $factory->create($contents, $context);
$this->assertSame($contents, $description->render());
@@ -102,15 +102,15 @@ class DescriptionFactoryTest extends TestCase
*/
public function testDescriptionCanParseAStringStartingWithInlineTag(): void
{
$contents = '{@link http://phpdoc.org/ This} is text for a description that starts with an inline tag.';
$context = new Context('');
$contents = '{@link http://phpdoc.org/ This} is text for a description that starts with an inline tag.';
$context = new Context('');
$tagFactory = m::mock(TagFactory::class);
$tagFactory->shouldReceive('create')
->once()
->with('@link http://phpdoc.org/ This', $context)
->andReturn(new Link('http://phpdoc.org/', new Description('This')));
$factory = new DescriptionFactory($tagFactory);
$factory = new DescriptionFactory($tagFactory);
$description = $factory->create($contents, $context);
$this->assertSame($contents, $description->render());
@@ -123,7 +123,7 @@ class DescriptionFactoryTest extends TestCase
*/
public function testIfSuperfluousStartingSpacesAreRemoved(): void
{
$factory = new DescriptionFactory(m::mock(TagFactory::class));
$factory = new DescriptionFactory(m::mock(TagFactory::class));
$descriptionText = <<<DESCRIPTION
This is a multiline
description that you commonly
tests/unit/DocBlock/DescriptionTest.php
+2 -2
View File
@@ -71,7 +71,7 @@ class DescriptionTest extends TestCase
$fixture = new Description($body, $tags);
$this->assertSame($expected, (string)$fixture);
$this->assertSame($expected, (string) $fixture);
}
/**
@@ -123,6 +123,6 @@ class DescriptionTest extends TestCase
$fixture = new Description($body, $tags);
$expected = '@JoinTable(name="table", joinColumns={@JoinColumn (name="column_id", referencedColumnName="id")}, inverseJoinColumns={@JoinColumn (name="column_id_2", referencedColumnName="id")})';
$this->assertSame($expected, (string)$fixture);
$this->assertSame($expected, (string) $fixture);
}
}
tests/unit/DocBlock/SerializerTest.php
+4 -4
View File
@@ -58,7 +58,7 @@ DOCCOMMENT;
'This is a summary',
new Description('This is a description'),
[
new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag'))
new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag')),
]
);
@@ -92,7 +92,7 @@ DOCCOMMENT;
'This is a summary',
new Description('This is a description'),
[
new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag'))
new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag')),
]
);
@@ -126,7 +126,7 @@ DOCCOMMENT;
'This is a summary',
new Description('This is a description'),
[
new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag'))
new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag')),
]
);
@@ -166,7 +166,7 @@ DOCCOMMENT;
'This is a summary',
new Description('This is a description'),
[
new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag'))
new DocBlock\Tags\Generic('unknown-tag', new Description('Test description for the unknown tag')),
]
);
tests/unit/DocBlock/StandardTagFactoryTest.php
+18 -19
View File
@@ -32,7 +32,6 @@ use PHPUnit\Framework\TestCase;
*/
class StandardTagFactoryTest extends TestCase
{
/**
* Call Mockery::close after each test.
*/
@@ -51,10 +50,10 @@ class StandardTagFactoryTest extends TestCase
*/
public function testCreatingAGenericTag(): void
{
$expectedTagName = 'unknown-tag';
$expectedTagName = 'unknown-tag';
$expectedDescriptionText = 'This is a description';
$expectedDescription = new Description($expectedDescriptionText);
$context = new Context('');
$expectedDescription = new Description($expectedDescriptionText);
$context = new Context('');
$descriptionFactory = m::mock(DescriptionFactory::class);
$descriptionFactory
@@ -83,7 +82,7 @@ class StandardTagFactoryTest extends TestCase
*/
public function testCreatingASpecificTag(): void
{
$context = new Context('');
$context = new Context('');
$tagFactory = new StandardTagFactory(m::mock(FqsenResolver::class));
/** @var Author $tag */
@@ -104,8 +103,8 @@ class StandardTagFactoryTest extends TestCase
*/
public function testAnEmptyContextIsCreatedIfNoneIsProvided(): void
{
$fqsen = '\Tag';
$resolver = m::mock(FqsenResolver::class)
$fqsen = '\Tag';
$resolver = m::mock(FqsenResolver::class)
->shouldReceive('resolve')
->with('Tag', m::type(Context::class))
->andReturn(new Fqsen($fqsen))
@@ -120,7 +119,7 @@ class StandardTagFactoryTest extends TestCase
$tag = $tagFactory->create('@see Tag');
$this->assertInstanceOf(See::class, $tag);
$this->assertSame($fqsen, (string)$tag->getReference());
$this->assertSame($fqsen, (string) $tag->getReference());
}
/**
@@ -132,7 +131,7 @@ class StandardTagFactoryTest extends TestCase
*/
public function testPassingYourOwnSetOfTagHandlers(): void
{
$context = new Context('');
$context = new Context('');
$tagFactory = new StandardTagFactory(m::mock(FqsenResolver::class), ['user' => Author::class]);
/** @var Author $tag */
@@ -162,7 +161,7 @@ class StandardTagFactoryTest extends TestCase
*/
public function testAddParameterToServiceLocator(): void
{
$resolver = m::mock(FqsenResolver::class);
$resolver = m::mock(FqsenResolver::class);
$tagFactory = new StandardTagFactory($resolver);
$tagFactory->addParameter('myParam', 'myValue');
@@ -181,7 +180,7 @@ class StandardTagFactoryTest extends TestCase
{
$service = new PassthroughFormatter();
$resolver = m::mock(FqsenResolver::class);
$resolver = m::mock(FqsenResolver::class);
$tagFactory = new StandardTagFactory($resolver);
$tagFactory->addService($service);
@@ -199,9 +198,9 @@ class StandardTagFactoryTest extends TestCase
public function testInjectConcreteServiceForInterfaceToServiceLocator(): void
{
$interfaceName = Formatter::class;
$service = new PassthroughFormatter();
$service = new PassthroughFormatter();
$resolver = m::mock(FqsenResolver::class);
$resolver = m::mock(FqsenResolver::class);
$tagFactory = new StandardTagFactory($resolver);
$tagFactory->addService($service, $interfaceName);
@@ -221,7 +220,7 @@ class StandardTagFactoryTest extends TestCase
*/
public function testRegisteringAHandlerForANewTag(): void
{
$resolver = m::mock(FqsenResolver::class);
$resolver = m::mock(FqsenResolver::class);
$tagFactory = new StandardTagFactory($resolver);
$tagFactory->registerTagHandler('my-tag', Author::class);
@@ -239,7 +238,7 @@ class StandardTagFactoryTest extends TestCase
public function testHandlerRegistrationFailsIfProvidedTagNameIsNamespaceButNotFullyQualified(): void
{
$this->expectException('InvalidArgumentException');
$resolver = m::mock(FqsenResolver::class);
$resolver = m::mock(FqsenResolver::class);
$tagFactory = new StandardTagFactory($resolver);
$tagFactory->registerTagHandler(\Name\Spaced\Tag::class, Author::class);
}
@@ -252,7 +251,7 @@ class StandardTagFactoryTest extends TestCase
public function testHandlerRegistrationFailsIfProvidedHandlerIsEmpty(): void
{
$this->expectException('InvalidArgumentException');
$resolver = m::mock(FqsenResolver::class);
$resolver = m::mock(FqsenResolver::class);
$tagFactory = new StandardTagFactory($resolver);
$tagFactory->registerTagHandler('my-tag', '');
}
@@ -265,7 +264,7 @@ class StandardTagFactoryTest extends TestCase
public function testHandlerRegistrationFailsIfProvidedHandlerIsNotAnExistingClassName(): void
{
$this->expectException('InvalidArgumentException');
$resolver = m::mock(FqsenResolver::class);
$resolver = m::mock(FqsenResolver::class);
$tagFactory = new StandardTagFactory($resolver);
$tagFactory->registerTagHandler('my-tag', 'IDoNotExist');
}
@@ -278,7 +277,7 @@ class StandardTagFactoryTest extends TestCase
public function testHandlerRegistrationFailsIfProvidedHandlerDoesNotImplementTheTagInterface(): void
{
$this->expectException('InvalidArgumentException');
$resolver = m::mock(FqsenResolver::class);
$resolver = m::mock(FqsenResolver::class);
$tagFactory = new StandardTagFactory($resolver);
$tagFactory->registerTagHandler('my-tag', 'stdClass');
}
@@ -293,7 +292,7 @@ class StandardTagFactoryTest extends TestCase
*/
public function testReturntagIsMappedCorrectly(): void
{
$context = new Context('');
$context = new Context('');
$descriptionFactory = m::mock(DescriptionFactory::class);
$descriptionFactory
tests/unit/DocBlock/Tags/CoversTest.php
+2 -3
View File
@@ -27,7 +27,6 @@ use PHPUnit\Framework\TestCase;
*/
class CoversTest extends TestCase
{
/**
* Call Mockery::close after each test.
*/
@@ -114,7 +113,7 @@ class CoversTest extends TestCase
{
$fixture = new Covers(new Fqsen('\DateTime'), new Description('Description'));
$this->assertSame('\DateTime Description', (string)$fixture);
$this->assertSame('\DateTime Description', (string) $fixture);
}
/**
@@ -141,7 +140,7 @@ class CoversTest extends TestCase
$fixture = Covers::create('DateTime My Description', $descriptionFactory, $resolver, $context);
$this->assertSame('\DateTime My Description', (string)$fixture);
$this->assertSame('\DateTime My Description', (string) $fixture);
$this->assertSame($fqsen, $fixture->getReference());
$this->assertSame($description, $fixture->getDescription());
}
tests/unit/DocBlock/Tags/DeprecatedTest.php
+2 -2
View File
@@ -111,7 +111,7 @@ class DeprecatedTest extends TestCase
{
$fixture = new Deprecated('1.0', new Description('Description'));
$this->assertSame('1.0 Description', (string)$fixture);
$this->assertSame('1.0 Description', (string) $fixture);
}
/**
@@ -133,7 +133,7 @@ class DeprecatedTest extends TestCase
$fixture = Deprecated::create('1.0 My Description', $descriptionFactory, $context);
$this->assertSame('1.0 My Description', (string)$fixture);
$this->assertSame('1.0 My Description', (string) $fixture);
$this->assertSame($version, $fixture->getVersion());
$this->assertSame($description, $fixture->getDescription());
}
tests/unit/DocBlock/Tags/ExampleTest.php
-1
View File
@@ -11,7 +11,6 @@ use PHPUnit\Framework\TestCase;
*/
class ExampleTest extends TestCase
{
/**
* Call Mockery::close after each test.
*/
tests/unit/DocBlock/Tags/Formatter/AlignFormatterTest.php
+2 -2
View File
@@ -50,14 +50,14 @@ class AlignFormatterTest extends TestCase
$tags = [
new Param('foobar', new String_()),
new Version('1.2.0'),
new Link('http://www.example.com', new Description('Examples'))
new Link('http://www.example.com', new Description('Examples')),
];
$fixture = new AlignFormatter($tags);
$expected = [
'@param string $foobar',
'@version 1.2.0',
'@link http://www.example.com Examples'
'@link http://www.example.com Examples',
];
foreach ($tags as $key => $tag) {
tests/unit/DocBlock/Tags/GenericTest.php
+3 -2
View File
@@ -32,6 +32,7 @@ class GenericTest extends TestCase
{
m::close();
}
/**
* @uses \phpDocumentor\Reflection\DocBlock\Tags\Generic::__construct
* @uses \phpDocumentor\Reflection\DocBlock\Description
@@ -98,7 +99,7 @@ class GenericTest extends TestCase
{
$fixture = new Generic('generic', new Description('Description'));
$this->assertSame('Description', (string)$fixture);
$this->assertSame('Description', (string) $fixture);
}
/**
@@ -120,7 +121,7 @@ class GenericTest extends TestCase
$fixture = Generic::create('My Description', 'generic', $descriptionFactory, $context);
$this->assertSame('My Description', (string)$fixture);
$this->assertSame('My Description', (string) $fixture);
$this->assertSame($generics, $fixture->getName());
$this->assertSame($description, $fixture->getDescription());
}
tests/unit/DocBlock/Tags/LinkTest.php
+3 -3
View File
@@ -111,7 +111,7 @@ class LinkTest extends TestCase
{
$fixture = new Link('http://this.is.my/link', new Description('Description'));
$this->assertSame('http://this.is.my/link Description', (string)$fixture);
$this->assertSame('http://this.is.my/link Description', (string) $fixture);
}
/**
@@ -133,7 +133,7 @@ class LinkTest extends TestCase
$fixture = Link::create('http://this.is.my/link My Description', $descriptionFactory, $context);
$this->assertSame('http://this.is.my/link My Description', (string)$fixture);
$this->assertSame('http://this.is.my/link My Description', (string) $fixture);
$this->assertSame($links, $fixture->getLink());
$this->assertSame($description, $fixture->getDescription());
}
@@ -152,7 +152,7 @@ class LinkTest extends TestCase
$fixture = Link::create('', $descriptionFactory, new Context(''));
$this->assertSame('', (string)$fixture);
$this->assertSame('', (string) $fixture);
$this->assertSame('', $fixture->getLink());
$this->assertSame(null, $fixture->getDescription());
}
tests/unit/DocBlock/Tags/MethodTest.php
+45 -46
View File
@@ -66,7 +66,7 @@ class MethodTest extends TestCase
{
$arguments = [
['name' => 'argument1', 'type' => new String_()],
['name' => 'argument2', 'type' => new Object_()]
['name' => 'argument2', 'type' => new Object_()],
];
$fixture = new Method('myMethod', $arguments, new Void_(), true, new Description('My Description'));
@@ -111,7 +111,7 @@ class MethodTest extends TestCase
public function testHasArguments(): void
{
$arguments = [
[ 'name' => 'argument1', 'type' => new String_() ]
['name' => 'argument1', 'type' => new String_()],
];
$fixture = new Method('myMethod', $arguments);
@@ -127,7 +127,7 @@ class MethodTest extends TestCase
{
$arguments = ['argument1'];
$expected = [
[ 'name' => $arguments[0], 'type' => new Void_() ]
['name' => $arguments[0], 'type' => new Void_()],
];
$fixture = new Method('myMethod', $arguments);
@@ -141,9 +141,9 @@ class MethodTest extends TestCase
*/
public function testArgumentTypeCanBeInferredAsVoid(): void
{
$arguments = [ [ 'name' => 'argument1' ] ];
$arguments = [['name' => 'argument1']];
$expected = [
[ 'name' => $arguments[0]['name'], 'type' => new Void_() ]
['name' => $arguments[0]['name'], 'type' => new Void_()],
];
$fixture = new Method('myMethod', $arguments);
@@ -160,15 +160,15 @@ class MethodTest extends TestCase
public function testRestArgumentIsParsedAsRegularArg(): void
{
$expected = [
[ 'name' => 'arg1', 'type' => new Void_() ],
[ 'name' => 'rest', 'type' => new Void_() ],
[ 'name' => 'rest2', 'type' => new Array_() ],
['name' => 'arg1', 'type' => new Void_()],
['name' => 'rest', 'type' => new Void_()],
['name' => 'rest2', 'type' => new Array_()],
];
$descriptionFactory = m::mock(DescriptionFactory::class);
$resolver = new TypeResolver();
$context = new Context('');
$description = new Description('');
$resolver = new TypeResolver();
$context = new Context('');
$description = new Description('');
$descriptionFactory->shouldReceive('create')->with('', $context)->andReturn($description);
$fixture = Method::create(
@@ -244,13 +244,13 @@ class MethodTest extends TestCase
{
$arguments = [
['name' => 'argument1', 'type' => new String_()],
['name' => 'argument2', 'type' => new Object_()]
['name' => 'argument2', 'type' => new Object_()],
];
$fixture = new Method('myMethod', $arguments, new Void_(), true, new Description('My Description'));
$this->assertSame(
'static void myMethod(string $argument1, object $argument2) My Description',
(string)$fixture
(string) $fixture
);
}
@@ -266,13 +266,13 @@ class MethodTest extends TestCase
public function testFactoryMethod(): void
{
$descriptionFactory = m::mock(DescriptionFactory::class);
$resolver = new TypeResolver();
$context = new Context('');
$resolver = new TypeResolver();
$context = new Context('');
$description = new Description('My Description');
$description = new Description('My Description');
$expectedArguments = [
[ 'name' => 'argument1', 'type' => new String_() ],
[ 'name' => 'argument2', 'type' => new Void_() ]
['name' => 'argument1', 'type' => new String_()],
['name' => 'argument2', 'type' => new Void_()],
];
$descriptionFactory->shouldReceive('create')->with('My Description', $context)->andReturn($description);
@@ -284,7 +284,7 @@ class MethodTest extends TestCase
$context
);
$this->assertSame('static void myMethod(string $argument1, void $argument2) My Description', (string)$fixture);
$this->assertSame('static void myMethod(string $argument1, void $argument2) My Description', (string) $fixture);
$this->assertSame('myMethod', $fixture->getMethodName());
$this->assertEquals($expectedArguments, $fixture->getArguments());
$this->assertInstanceOf(Void_::class, $fixture->getReturnType());
@@ -301,10 +301,10 @@ class MethodTest extends TestCase
public function testReturnTypeThis(): void
{
$descriptionFactory = m::mock(DescriptionFactory::class);
$resolver = new TypeResolver();
$context = new Context('');
$resolver = new TypeResolver();
$context = new Context('');
$description = new Description('');
$description = new Description('');
$descriptionFactory->shouldReceive('create')->with('', $context)->andReturn($description);
@@ -316,7 +316,7 @@ class MethodTest extends TestCase
);
$this->assertTrue($fixture->isStatic());
$this->assertSame('static $this myMethod()', (string)$fixture);
$this->assertSame('static $this myMethod()', (string) $fixture);
$this->assertSame('myMethod', $fixture->getMethodName());
$this->assertInstanceOf(This::class, $fixture->getReturnType());
}
@@ -334,15 +334,14 @@ class MethodTest extends TestCase
/**
* @dataProvider collectionReturnTypesProvider
* @covers ::create
* @uses \phpDocumentor\Reflection\DocBlock\Tags\Method::<public>
* @uses \phpDocumentor\Reflection\DocBlock\Description
* @uses \phpDocumentor\Reflection\DocBlock\DescriptionFactory
* @uses \phpDocumentor\Reflection\TypeResolver
* @uses \phpDocumentor\Reflection\Types\Array_
* @uses \phpDocumentor\Reflection\Types\Compound
* @uses \phpDocumentor\Reflection\Types\Integer
* @uses \phpDocumentor\Reflection\Types\Object_
* @param string null $expectedKeyType
* @uses phpDocumentor\Reflection\DocBlock\Tags\Method::<public>
* @uses phpDocumentor\Reflection\DocBlock\Description
* @uses phpDocumentor\Reflection\DocBlock\DescriptionFactory
* @uses phpDocumentor\Reflection\TypeResolver
* @uses phpDocumentor\Reflection\Types\Array_
* @uses phpDocumentor\Reflection\Types\Compound
* @uses phpDocumentor\Reflection\Types\Integer
* @uses phpDocumentor\Reflection\Types\Object_
*/
public function testCollectionReturnTypes(
string $returnType,
@@ -350,11 +349,11 @@ class MethodTest extends TestCase
?string $expectedValueType = null,
?string $expectedKeyType = null
): void {
$resolver = new TypeResolver();
$resolver = new TypeResolver();
$descriptionFactory = m::mock(DescriptionFactory::class);
$descriptionFactory->shouldReceive('create')->with('', null)->andReturn(new Description(''));
$fixture = Method::create("$returnType myMethod(\$arg)", $resolver, $descriptionFactory);
$fixture = Method::create("${returnType} myMethod(\$arg)", $resolver, $descriptionFactory);
$returnType = $fixture->getReturnType();
$this->assertInstanceOf($expectedType, $returnType);
@@ -433,7 +432,7 @@ class MethodTest extends TestCase
public function testCreationFailsIfArgumentRecordContainsInvalidEntry(): void
{
$this->expectException('InvalidArgumentException');
new Method('body', [ [ 'name' => 'myName', 'unknown' => 'nah' ] ]);
new Method('body', [['name' => 'myName', 'unknown' => 'nah']]);
}
/**
@@ -448,10 +447,10 @@ class MethodTest extends TestCase
public function testCreateMethodParenthesisMissing(): void
{
$descriptionFactory = m::mock(DescriptionFactory::class);
$resolver = new TypeResolver();
$context = new Context('');
$resolver = new TypeResolver();
$context = new Context('');
$description = new Description('My Description');
$description = new Description('My Description');
$descriptionFactory->shouldReceive('create')->with('My Description', $context)->andReturn($description);
@@ -462,7 +461,7 @@ class MethodTest extends TestCase
$context
);
$this->assertSame('static void myMethod() My Description', (string)$fixture);
$this->assertSame('static void myMethod() My Description', (string) $fixture);
$this->assertSame('myMethod', $fixture->getMethodName());
$this->assertEquals([], $fixture->getArguments());
$this->assertInstanceOf(Void_::class, $fixture->getReturnType());
@@ -482,10 +481,10 @@ class MethodTest extends TestCase
public function testCreateWithoutReturnType(): void
{
$descriptionFactory = m::mock(DescriptionFactory::class);
$resolver = new TypeResolver();
$context = new Context('');
$resolver = new TypeResolver();
$context = new Context('');
$description = new Description('');
$description = new Description('');
$descriptionFactory->shouldReceive('create')->with('', $context)->andReturn($description);
@@ -496,7 +495,7 @@ class MethodTest extends TestCase
$context
);
$this->assertSame('void myMethod()', (string)$fixture);
$this->assertSame('void myMethod()', (string) $fixture);
$this->assertSame('myMethod', $fixture->getMethodName());
$this->assertEquals([], $fixture->getArguments());
$this->assertInstanceOf(Void_::class, $fixture->getReturnType());
@@ -519,8 +518,8 @@ class MethodTest extends TestCase
public function testCreateWithMixedReturnTypes(): void
{
$descriptionFactory = m::mock(DescriptionFactory::class);
$resolver = new TypeResolver();
$context = new Context('');
$resolver = new TypeResolver();
$context = new Context('');
$descriptionFactory->shouldReceive('create')->andReturn(new Description(''));
@@ -531,7 +530,7 @@ class MethodTest extends TestCase
$context
);
$this->assertSame('\MyClass[]|int[] myMethod()', (string)$fixture);
$this->assertSame('\MyClass[]|int[] myMethod()', (string) $fixture);
$this->assertSame('myMethod', $fixture->getMethodName());
$this->assertEquals([], $fixture->getArguments());
tests/unit/DocBlock/Tags/ParamTest.php
+2 -2
View File
@@ -149,7 +149,7 @@ class ParamTest extends TestCase
{
$fixture = new Param('myParameter', new String_(), true, new Description('Description'));
$this->assertSame('string ...$myParameter Description', (string)$fixture);
$this->assertSame('string ...$myParameter Description', (string) $fixture);
}
/**
@@ -170,7 +170,7 @@ class ParamTest extends TestCase
$fixture = Param::create('string ...$myParameter My Description', $typeResolver, $descriptionFactory, $context);
$this->assertSame('string ...$myParameter My Description', (string)$fixture);
$this->assertSame('string ...$myParameter My Description', (string) $fixture);
$this->assertSame('myParameter', $fixture->getVariableName());
$this->assertInstanceOf(String_::class, $fixture->getType());
$this->assertTrue($fixture->isVariadic());
tests/unit/DocBlock/Tags/PropertyReadTest.php
+2 -2
View File
@@ -131,7 +131,7 @@ class PropertyReadTest extends TestCase
{
$fixture = new PropertyRead('myProperty', new String_(), new Description('Description'));
$this->assertSame('string $myProperty Description', (string)$fixture);
$this->assertSame('string $myProperty Description', (string) $fixture);
}
/**
@@ -157,7 +157,7 @@ class PropertyReadTest extends TestCase
$context
);
$this->assertSame('string $myProperty My Description', (string)$fixture);
$this->assertSame('string $myProperty My Description', (string) $fixture);
$this->assertSame('myProperty', $fixture->getVariableName());
$this->assertInstanceOf(String_::class, $fixture->getType());
$this->assertSame($description, $fixture->getDescription());
tests/unit/DocBlock/Tags/PropertyTest.php
+2 -2
View File
@@ -131,7 +131,7 @@ class PropertyTest extends TestCase
{
$fixture = new Property('myProperty', new String_(), new Description('Description'));
$this->assertSame('string $myProperty Description', (string)$fixture);
$this->assertSame('string $myProperty Description', (string) $fixture);
}
/**
@@ -152,7 +152,7 @@ class PropertyTest extends TestCase
$fixture = Property::create('string $myProperty My Description', $typeResolver, $descriptionFactory, $context);
$this->assertSame('string $myProperty My Description', (string)$fixture);
$this->assertSame('string $myProperty My Description', (string) $fixture);
$this->assertSame('myProperty', $fixture->getVariableName());
$this->assertInstanceOf(String_::class, $fixture->getType());
$this->assertSame($description, $fixture->getDescription());
tests/unit/DocBlock/Tags/PropertyWriteTest.php
+2 -2
View File
@@ -131,7 +131,7 @@ class PropertyWriteTest extends TestCase
{
$fixture = new PropertyWrite('myProperty', new String_(), new Description('Description'));
$this->assertSame('string $myProperty Description', (string)$fixture);
$this->assertSame('string $myProperty Description', (string) $fixture);
}
/**
@@ -157,7 +157,7 @@ class PropertyWriteTest extends TestCase
$context
);
$this->assertSame('string $myProperty My Description', (string)$fixture);
$this->assertSame('string $myProperty My Description', (string) $fixture);
$this->assertSame('myProperty', $fixture->getVariableName());
$this->assertInstanceOf(String_::class, $fixture->getType());
$this->assertSame($description, $fixture->getDescription());
tests/unit/DocBlock/Tags/ReturnTest.php
+2 -2
View File
@@ -113,7 +113,7 @@ class ReturnTest extends TestCase
{
$fixture = new Return_(new String_(), new Description('Description'));
$this->assertSame('string Description', (string)$fixture);
$this->assertSame('string Description', (string) $fixture);
}
/**
@@ -137,7 +137,7 @@ class ReturnTest extends TestCase
$fixture = Return_::create('string My Description', $resolver, $descriptionFactory, $context);
$this->assertSame('string My Description', (string)$fixture);
$this->assertSame('string My Description', (string) $fixture);
$this->assertEquals($type, $fixture->getType());
$this->assertSame($description, $fixture->getDescription());
}
tests/unit/DocBlock/Tags/SeeTest.php
+5 -5
View File
@@ -126,7 +126,7 @@ class SeeTest extends TestCase
{
$fixture = new See(new FqsenRef(new Fqsen('\DateTime::format()')), new Description('Description'));
$this->assertSame('\DateTime::format() Description', (string)$fixture);
$this->assertSame('\DateTime::format() Description', (string) $fixture);
}
/**
@@ -154,9 +154,9 @@ class SeeTest extends TestCase
$fixture = See::create('DateTime My Description', $resolver, $descriptionFactory, $context);
$this->assertSame('\DateTime My Description', (string)$fixture);
$this->assertSame('\DateTime My Description', (string) $fixture);
$this->assertInstanceOf(FqsenRef::class, $fixture->getReference());
$this->assertSame((string)$fqsen, (string)$fixture->getReference());
$this->assertSame((string) $fqsen, (string) $fixture->getReference());
$this->assertSame($description, $fixture->getDescription());
}
@@ -184,9 +184,9 @@ class SeeTest extends TestCase
$fixture = See::create('https://test.org My Description', $resolver, $descriptionFactory, $context);
$this->assertSame('https://test.org My Description', (string)$fixture);
$this->assertSame('https://test.org My Description', (string) $fixture);
$this->assertInstanceOf(UrlRef::class, $fixture->getReference());
$this->assertSame('https://test.org', (string)$fixture->getReference());
$this->assertSame('https://test.org', (string) $fixture->getReference());
$this->assertSame($description, $fixture->getDescription());
}
tests/unit/DocBlock/Tags/SinceTest.php
+5 -6
View File
@@ -25,7 +25,6 @@ use PHPUnit\Framework\TestCase;
*/
class SinceTest extends TestCase
{
/**
* Call Mockery::close after each test.
*/
@@ -112,7 +111,7 @@ class SinceTest extends TestCase
{
$fixture = new Since('1.0', new Description('Description'));
$this->assertSame('1.0 Description', (string)$fixture);
$this->assertSame('1.0 Description', (string) $fixture);
}
/**
@@ -125,16 +124,16 @@ class SinceTest extends TestCase
public function testFactoryMethod(): void
{
$descriptionFactory = m::mock(DescriptionFactory::class);
$context = new Context('');
$context = new Context('');
$version = '1.0';
$version = '1.0';
$description = new Description('My Description');
$descriptionFactory->shouldReceive('create')->with('My Description', $context)->andReturn($description);
$fixture = Since::create('1.0 My Description', $descriptionFactory, $context);
$this->assertSame('1.0 My Description', (string)$fixture);
$this->assertSame('1.0 My Description', (string) $fixture);
$this->assertSame($version, $fixture->getVersion());
$this->assertSame($description, $fixture->getDescription());
}
@@ -153,7 +152,7 @@ class SinceTest extends TestCase
$fixture = Since::create('', $descriptionFactory, new Context(''));
$this->assertSame('', (string)$fixture);
$this->assertSame('', (string) $fixture);
$this->assertSame(null, $fixture->getVersion());
$this->assertSame(null, $fixture->getDescription());
}
tests/unit/DocBlock/Tags/SourceTest.php
+3 -3
View File
@@ -129,7 +129,7 @@ class SourceTest extends TestCase
{
$fixture = new Source(1, 10, new Description('Description'));
$this->assertSame('1 10 Description', (string)$fixture);
$this->assertSame('1 10 Description', (string) $fixture);
}
/**
@@ -142,14 +142,14 @@ class SourceTest extends TestCase
public function testFactoryMethod(): void
{
$descriptionFactory = m::mock(DescriptionFactory::class);
$context = new Context('');
$context = new Context('');
$description = new Description('My Description');
$descriptionFactory->shouldReceive('create')->with('My Description', $context)->andReturn($description);
$fixture = Source::create('1 10 My Description', $descriptionFactory, $context);
$this->assertSame('1 10 My Description', (string)$fixture);
$this->assertSame('1 10 My Description', (string) $fixture);
$this->assertSame(1, $fixture->getStartingLine());
$this->assertSame(10, $fixture->getLineCount());
$this->assertSame($description, $fixture->getDescription());
tests/unit/DocBlock/Tags/ThrowsTest.php
+5 -5
View File
@@ -113,7 +113,7 @@ class ThrowsTest extends TestCase
{
$fixture = new Throws(new String_(), new Description('Description'));
$this->assertSame('string Description', (string)$fixture);
$this->assertSame('string Description', (string) $fixture);
}
/**
@@ -128,16 +128,16 @@ class ThrowsTest extends TestCase
public function testFactoryMethod(): void
{
$descriptionFactory = m::mock(DescriptionFactory::class);
$resolver = new TypeResolver();
$context = new Context('');
$resolver = new TypeResolver();
$context = new Context('');
$type = new String_();
$type = new String_();
$description = new Description('My Description');
$descriptionFactory->shouldReceive('create')->with('My Description', $context)->andReturn($description);
$fixture = Throws::create('string My Description', $resolver, $descriptionFactory, $context);
$this->assertSame('string My Description', (string)$fixture);
$this->assertSame('string My Description', (string) $fixture);
$this->assertEquals($type, $fixture->getType());
$this->assertSame($description, $fixture->getDescription());
}
tests/unit/DocBlock/Tags/UsesTest.php
+5 -5
View File
@@ -113,7 +113,7 @@ class UsesTest extends TestCase
{
$fixture = new Uses(new Fqsen('\DateTime'), new Description('Description'));
$this->assertSame('\DateTime Description', (string)$fixture);
$this->assertSame('\DateTime Description', (string) $fixture);
}
/**
@@ -128,10 +128,10 @@ class UsesTest extends TestCase
public function testFactoryMethod(): void
{
$descriptionFactory = m::mock(DescriptionFactory::class);
$resolver = m::mock(FqsenResolver::class);
$context = new Context('');
$resolver = m::mock(FqsenResolver::class);
$context = new Context('');
$fqsen = new Fqsen('\DateTime');
$fqsen = new Fqsen('\DateTime');
$description = new Description('My Description');
$descriptionFactory
@@ -140,7 +140,7 @@ class UsesTest extends TestCase
$fixture = Uses::create('DateTime My Description', $resolver, $descriptionFactory, $context);
$this->assertSame('\DateTime My Description', (string)$fixture);
$this->assertSame('\DateTime My Description', (string) $fixture);
$this->assertSame($fqsen, $fixture->getReference());
$this->assertSame($description, $fixture->getDescription());
}
tests/unit/DocBlock/Tags/VarTest.php
+4 -4
View File
@@ -142,7 +142,7 @@ class VarTest extends TestCase
{
$fixture = new Var_('myVariable', new String_(), new Description('Description'));
$this->assertSame('string $myVariable Description', (string)$fixture);
$this->assertSame('string $myVariable Description', (string) $fixture);
}
/**
@@ -154,16 +154,16 @@ class VarTest extends TestCase
*/
public function testFactoryMethod(): void
{
$typeResolver = new TypeResolver();
$typeResolver = new TypeResolver();
$descriptionFactory = m::mock(DescriptionFactory::class);
$context = new Context('');
$context = new Context('');
$description = new Description('My Description');
$descriptionFactory->shouldReceive('create')->with('My Description', $context)->andReturn($description);
$fixture = Var_::create('string $myVariable My Description', $typeResolver, $descriptionFactory, $context);
$this->assertSame('string $myVariable My Description', (string)$fixture);
$this->assertSame('string $myVariable My Description', (string) $fixture);
$this->assertSame('myVariable', $fixture->getVariableName());
$this->assertInstanceOf(String_::class, $fixture->getType());
$this->assertSame($description, $fixture->getDescription());
tests/unit/DocBlock/Tags/VersionTest.php
+5 -5
View File
@@ -111,7 +111,7 @@ class VersionTest extends TestCase
{
$fixture = new Version('1.0', new Description('Description'));
$this->assertSame('1.0 Description', (string)$fixture);
$this->assertSame('1.0 Description', (string) $fixture);
}
/**
@@ -124,16 +124,16 @@ class VersionTest extends TestCase
public function testFactoryMethod(): void
{
$descriptionFactory = m::mock(DescriptionFactory::class);
$context = new Context('');
$context = new Context('');
$version = '1.0';
$version = '1.0';
$description = new Description('My Description');
$descriptionFactory->shouldReceive('create')->with('My Description', $context)->andReturn($description);
$fixture = Version::create('1.0 My Description', $descriptionFactory, $context);
$this->assertSame('1.0 My Description', (string)$fixture);
$this->assertSame('1.0 My Description', (string) $fixture);
$this->assertSame($version, $fixture->getVersion());
$this->assertSame($description, $fixture->getDescription());
}
@@ -152,7 +152,7 @@ class VersionTest extends TestCase
$fixture = Version::create('', $descriptionFactory, new Context(''));
$this->assertSame('', (string)$fixture);
$this->assertSame('', (string) $fixture);
$this->assertSame(null, $fixture->getVersion());
$this->assertSame(null, $fixture->getDescription());
}
tests/unit/DocBlockFactoryTest.php
+9 -9
View File
@@ -60,7 +60,7 @@ class DocBlockFactoryTest extends TestCase
{
$fixture = new DocBlockFactory(m::mock(DescriptionFactory::class), m::mock(TagFactory::class));
$docBlock = '/** This is a DocBlock */';
$docBlock = '/** This is a DocBlock */';
$classReflector = m::mock(\ReflectionClass::class);
$classReflector->shouldReceive('getDocComment')->andReturn($docBlock);
$docblock = $fixture->create($classReflector);
@@ -121,7 +121,7 @@ class DocBlockFactoryTest extends TestCase
public function testSummaryAndDescriptionAreSeparated($given, $summary, $description): void
{
$tagFactory = m::mock(TagFactory::class);
$fixture = new DocBlockFactory(new DescriptionFactory($tagFactory), $tagFactory);
$fixture = new DocBlockFactory(new DescriptionFactory($tagFactory), $tagFactory);
$docblock = $fixture->create($given);
@@ -138,7 +138,7 @@ class DocBlockFactoryTest extends TestCase
public function testDescriptionsRetainFormatting(): void
{
$tagFactory = m::mock(TagFactory::class);
$fixture = new DocBlockFactory(new DescriptionFactory($tagFactory), $tagFactory);
$fixture = new DocBlockFactory(new DescriptionFactory($tagFactory), $tagFactory);
$given = <<<DOCBLOCK
/**
@@ -175,7 +175,7 @@ DESCRIPTION;
multiline description.
TAG;
$tag = m::mock(Tag::class);
$tag = m::mock(Tag::class);
$tagFactory = m::mock(TagFactory::class);
$tagFactory->shouldReceive('create')->with($tagString, m::type(Context::class))->andReturn($tag);
@@ -202,7 +202,7 @@ DOCBLOCK;
[
'This is a DocBlock. This should still be summary.',
'This is a DocBlock. This should still be summary.',
''
'',
],
[
<<<DOCBLOCK
@@ -211,7 +211,7 @@ This should be a Description.
DOCBLOCK
,
'This is a DocBlock.',
'This should be a Description.'
'This should be a Description.',
],
[
<<<DOCBLOCK
@@ -221,7 +221,7 @@ This should be a Description.
DOCBLOCK
,
"This is a\nmultiline Summary.",
'This should be a Description.'
'This should be a Description.',
],
[
<<<DOCBLOCK
@@ -231,7 +231,7 @@ This should be a Description.
DOCBLOCK
,
'This is a Summary without dot but with a whiteline',
'This should be a Description.'
'This should be a Description.',
],
[
<<<DOCBLOCK
@@ -241,7 +241,7 @@ This should be a Description.
DOCBLOCK
,
'This is a Summary with dot and with a whiteline.',
'This should be a Description.'
'This should be a Description.',
],
];
}
tests/unit/DocBlockTest.php
+2 -2
View File
@@ -73,7 +73,7 @@ class DocBlockTest extends TestCase
public function testDocBlockCanHaveTags(): void
{
$tags = [
m::mock(DocBlock\Tag::class)
m::mock(DocBlock\Tag::class),
];
$fixture = new DocBlock('', null, $tags);
@@ -91,7 +91,7 @@ class DocBlockTest extends TestCase
{
$this->expectException('InvalidArgumentException');
$tags = [
null
null,
];
$fixture = new DocBlock('', null, $tags);
}