Compare commits

..
15 Commits
Author SHA1 Message Date
Barry vd. Heuvel 494d594733 Move Context / ContextFactory to correct location
Other location isn't autoloaded correctly.
2015-06-07 14:47:11 +02:00
Mike van Riel afd2520734 Merge pull request #53 from mvriel/feature/refactor-to-v2
Make Context leaner and enable third parties to create them
2015-06-06 21:40:28 +02:00
Mike van Riel ef39243160 Make Context leaner and enable third parties to create them
Contexts are necessary for factories to resolve QSEN into FQSENs based
on partial namespaces and namespace aliases. These provide DocBlocks
with the namespace name and namespace aliases.

The new ContextFactory will enable third parties who don't use
phpDocumentor's Reflection component to construct a Context based on
a class reflector or namespace name (and file contents).
2015-06-06 20:03:59 +02:00
Mike van Riel ae15da2ce2 [#52] Removed dflydev/markdown from suggested list
The markdown package by DFlyDev is deprecated and is not recommended
anymore due to the provided alternatives (parsedown or commonmark).
2015-05-12 09:21:12 +02:00
Mike van Riel d1da796ba5 Merge pull request #47 from TomasVotruba/patch-1
travis: PHP 7.0 nightly added
2015-02-27 10:28:18 +01:00
Tomáš Votruba 868311451b travis: PHP 7.0 nightly added
See http://docs.travis-ci.com/user/languages/php/#PHP-7
2015-02-27 10:18:02 +01:00
Mike van Riel 5a87e6edaa Merge pull request #46 from colinodell/remove-composer-lock
Remove composer.lock
2015-02-25 18:26:05 +01:00
Mike van Riel b79f9f311d Merge pull request #45 from colinodell/commonmark-support
Add support for the league/commonmark Markdown parser
2015-02-25 18:24:05 +01:00
Colin O'Dell 702c5682ae Remove composer.lock
Per the Composer documentation:

> Note: For libraries it is not necessarily recommended to commit the lock file (...)

https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
2015-02-23 15:03:39 -05:00
Colin O'Dell 0d324618be Add support for the league/commonmark Markdown parser 2015-02-23 14:50:38 -05:00
Mike van Riel ff902a0beb Merge pull request #44 from dunglas/patch-1
minor: typo fix in PHPDoc
2015-02-12 13:17:11 +01:00
Kévin Dunglas a8ebd67e2a minor: typo fix in PHPDoc 2015-02-12 13:08:38 +01:00
Mike van Riel 09352d3406 Remove external code coverage 2015-02-03 21:57:02 +01:00
Mike van Riel 7b8092e37f Remove external code coverage and fix scrutinizer issues 2015-02-03 21:43:12 +01:00
Mike van Riel f8bb8d74ae Add scrutinizer config 2015-02-03 13:17:25 +01:00
56 changed files with 838 additions and 1048 deletions
-10
View File
@@ -1,10 +0,0 @@
# Path-based git attributes
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
# Ignore all test and documentation with "export-ignore".
/.gitignore export-ignore
/.gitattributes export-ignore
/.travis.yml export-ignore
/composer.lock export-ignore
/phpunit.xml.dist export-ignore
/tests export-ignore
-43
View File
@@ -1,43 +0,0 @@
name: Unit Tests
on:
push:
branches:
- master
pull_request:
branches:
- "*"
schedule:
- cron: '0 0 * * *'
jobs:
php-tests:
runs-on: ubuntu-latest
timeout-minutes: 15
env:
COMPOSER_NO_INTERACTION: 1
strategy:
matrix:
php: [8.1, 8.0, 7.4, 7.3, 7.2]
dependency-version: [prefer-lowest, prefer-stable]
name: P${{ matrix.php }} - ${{ matrix.dependency-version }}
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
coverage: none
tools: composer:v2
- name: Install dependencies
run: |
composer update --${{ matrix.dependency-version }} --prefer-dist --no-progress
- name: Execute Unit Tests
run: vendor/bin/phpunit
+45
View File
@@ -0,0 +1,45 @@
before_commands:
- "composer install --no-dev --prefer-source"
tools:
external_code_coverage:
enabled: false
timeout: 300
filter:
excluded_paths: ["tests", "vendor"]
php_code_coverage:
enabled: false
test_command: phpunit -c phpunit.xml.dist
php_code_sniffer:
enabled: true
config:
standard: PSR2
filter:
paths: ["src/*", "tests/*"]
php_cpd:
enabled: true
excluded_dirs: ["tests", "vendor"]
php_cs_fixer:
enabled: true
config:
level: all
filter:
paths: ["src/*", "tests/*"]
php_loc:
enabled: true
excluded_dirs: ["tests", "vendor"]
php_mess_detector:
enabled: true
config:
ruleset: phpmd.xml.dist
design_rules: { eval_expression: false }
filter:
paths: ["src/*"]
php_pdepend:
enabled: true
excluded_dirs: ["tests", "vendor"]
php_analyzer:
enabled: true
filter:
paths: ["src/*", "tests/*"]
sensiolabs_security_checker: true
+33
View File
@@ -0,0 +1,33 @@
language: php
php:
- 5.3.3
- 5.3
- 5.4
- 5.5
- 5.6
- 7.0
- hhvm
- hhvm-nightly
matrix:
allow_failures:
- php: hhvm
- php: hhvm-nightly
script:
- vendor/bin/phpunit
before_script:
- sudo apt-get -qq update > /dev/null
- phpenv rehash > /dev/null
- composer selfupdate --quiet
- composer install --no-interaction --prefer-source --dev
- vendor/bin/phpunit
- composer update --no-interaction --prefer-source --dev
notifications:
irc: "irc.freenode.org#phpdocumentor"
email:
- [email protected]
- [email protected]
- [email protected]
+5 -5
View File
@@ -1,5 +1,5 @@
{ {
"name": "barryvdh/reflection-docblock", "name": "phpdocumentor/reflection-docblock",
"type": "library", "type": "library",
"license": "MIT", "license": "MIT",
"authors": [ "authors": [
@@ -9,14 +9,14 @@
"php": ">=5.3.3" "php": ">=5.3.3"
}, },
"autoload": { "autoload": {
"psr-0": {"Barryvdh": ["src/"]} "psr-0": {"phpDocumentor": ["src/"]}
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": "^8.5.14|^9" "phpunit/phpunit": "~4.0"
}, },
"suggest": { "suggest": {
"dflydev/markdown": "~1.0", "erusev/parsedown": "~1.0",
"erusev/parsedown": "~1.0" "league/commonmark": "*"
}, },
"extra": { "extra": {
"branch-alias": { "branch-alias": {
+23
View File
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
<ruleset
name="ProxyManager rules"
xmlns="http://pmd.sf.net/ruleset/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"
>
<rule ref="rulesets/codesize.xml"/>
<rule ref="rulesets/unusedcode.xml"/>
<rule ref="rulesets/design.xml">
<!-- eval is needed to generate runtime classes -->
<exclude name="EvalExpression"/>
</rule>
<rule ref="rulesets/naming.xml">
<exclude name="LongVariable"/>
</rule>
<rule ref="rulesets/naming.xml/LongVariable">
<properties>
<property name="minimum">40</property>
</properties>
</rule>
</ruleset>
+7 -6
View File
@@ -1,13 +1,14 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" bootstrap="vendor/autoload.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
<coverage> <phpunit colors="true" strict="true" bootstrap="vendor/autoload.php">
<include>
<directory suffix=".php">./src/</directory>
</include>
</coverage>
<testsuites> <testsuites>
<testsuite name="phpDocumentor\Reflection\DocBlock"> <testsuite name="phpDocumentor\Reflection\DocBlock">
<directory>./tests/</directory> <directory>./tests/</directory>
</testsuite> </testsuite>
</testsuites> </testsuites>
<filter>
<whitelist>
<directory suffix=".php">./src/</directory>
</whitelist>
</filter>
</phpunit> </phpunit>
@@ -1,154 +0,0 @@
<?php
/**
* phpDocumentor
*
* PHP Version 5.3
*
* @author Vasil Rangelov <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
namespace Barryvdh\Reflection\DocBlock;
/**
* The context in which a DocBlock occurs.
*
* @author Vasil Rangelov <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
class Context
{
/** @var string The current namespace. */
protected $namespace = '';
/** @var array List of namespace aliases => Fully Qualified Namespace. */
protected $namespace_aliases = array();
/** @var string Name of the structural element, within the namespace. */
protected $lsen = '';
/**
* Cteates a new context.
* @param string $namespace The namespace where this DocBlock
* resides in.
* @param array $namespace_aliases List of namespace aliases => Fully
* Qualified Namespace.
* @param string $lsen Name of the structural element, within
* the namespace.
*/
public function __construct(
$namespace = '',
array $namespace_aliases = array(),
$lsen = ''
) {
if (!empty($namespace)) {
$this->setNamespace($namespace);
}
$this->setNamespaceAliases($namespace_aliases);
$this->setLSEN($lsen);
}
/**
* @return string The namespace where this DocBlock resides in.
*/
public function getNamespace()
{
return $this->namespace;
}
/**
* @return array List of namespace aliases => Fully Qualified Namespace.
*/
public function getNamespaceAliases()
{
return $this->namespace_aliases;
}
/**
* Returns the Local Structural Element Name.
*
* @return string Name of the structural element, within the namespace.
*/
public function getLSEN()
{
return $this->lsen;
}
/**
* Sets a new namespace.
*
* Sets a new namespace for the context. Leading and trailing slashes are
* trimmed, and the keywords "global" and "default" are treated as aliases
* to no namespace.
*
* @param string $namespace The new namespace to set.
*
* @return $this
*/
public function setNamespace($namespace)
{
if ('global' !== $namespace
&& 'default' !== $namespace
) {
// Srip leading and trailing slash
$this->namespace = trim((string)$namespace, '\\');
} else {
$this->namespace = '';
}
return $this;
}
/**
* Sets the namespace aliases, replacing all previous ones.
*
* @param array $namespace_aliases List of namespace aliases => Fully
* Qualified Namespace.
*
* @return $this
*/
public function setNamespaceAliases(array $namespace_aliases)
{
$this->namespace_aliases = array();
foreach ($namespace_aliases as $alias => $fqnn) {
$this->setNamespaceAlias($alias, $fqnn);
}
return $this;
}
/**
* Adds a namespace alias to the context.
*
* @param string $alias The alias name (the part after "as", or the last
* part of the Fully Qualified Namespace Name) to add.
* @param string $fqnn The Fully Qualified Namespace Name for this alias.
* Any form of leading/trailing slashes are accepted, but what will be
* stored is a name, prefixed with a slash, and no trailing slash.
*
* @return $this
*/
public function setNamespaceAlias($alias, $fqnn)
{
$this->namespace_aliases[$alias] = '\\' . trim((string)$fqnn, '\\');
return $this;
}
/**
* Sets a new Local Structural Element Name.
*
* Sets a new Local Structural Element Name. A local name also contains
* punctuation determining the kind of structural element (e.g. trailing "("
* and ")" for functions and methods).
*
* @param string $lsen The new local name of a structural element.
*
* @return $this
*/
public function setLSEN($lsen)
{
$this->lsen = (string)$lsen;
return $this;
}
}
@@ -1,30 +0,0 @@
<?php
/**
* phpDocumentor
*
* PHP Version 5.3
*
* @author Andrew Smith <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
namespace Barryvdh\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Tag;
/**
* Reflection class for a @SuppressWarnings tag in a Docblock.
*
* @author Andrew Smith <[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
class SuppressWarningsTag extends Tag
{
public function __toString()
{
return "@{$this->getName()}{$this->getContent()}";
}
}
@@ -10,11 +10,11 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection; namespace phpDocumentor\Reflection;
use Barryvdh\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Context; use phpDocumentor\Reflection\DocBlock\Context;
use Barryvdh\Reflection\DocBlock\Location; use phpDocumentor\Reflection\DocBlock\Location;
/** /**
* Parses the DocBlock for any structure. * Parses the DocBlock for any structure.
@@ -57,17 +57,14 @@ class DocBlock implements \Reflector
* *
* The constructor may also receive namespace information such as the * The constructor may also receive namespace information such as the
* current namespace and aliases. This information is used by some tags * current namespace and aliases. This information is used by some tags
* (e.g. @return, @param, etc.) to turn a relative Type into a FQCN. * (e.g. return, param, etc.) to turn a relative Type into a FQCN.
* *
* @param \Reflector|string $docblock A docblock comment (including * @param \Reflector|string $docblock A docblock comment (including asterisks) or reflector supporting the
* asterisks) or reflector supporting the getDocComment method.
* @param Context $context The context in which the DocBlock
* occurs.
* @param Location $location The location within the file that this
* DocBlock occurs in.
*
* @throws \InvalidArgumentException if the given argument does not have the
* getDocComment method. * getDocComment method.
* @param Context $context The context in which the DocBlock occurs.
* @param Location $location The location within the file that this DocBlock occurs in.
*
* @throws \InvalidArgumentException if the given argument does not have the getDocComment method.
*/ */
public function __construct( public function __construct(
$docblock, $docblock,
@@ -77,8 +74,7 @@ class DocBlock implements \Reflector
if (is_object($docblock)) { if (is_object($docblock)) {
if (!method_exists($docblock, 'getDocComment')) { if (!method_exists($docblock, 'getDocComment')) {
throw new \InvalidArgumentException( throw new \InvalidArgumentException(
'Invalid object passed; the given reflector must support ' 'Invalid object passed; the given reflector must support the getDocComment method'
. 'the getDocComment method'
); );
} }
@@ -266,14 +262,13 @@ class DocBlock implements \Reflector
} }
/** /**
* Set the text portion of the doc block. * Set the text portion of the DocBlock.
* *
* Sets the text portion (short and long description combined) of the doc * Sets the text portion (short and long description combined) of the DocBlock.
* block.
* *
* @param string $docblock The new text portion of the doc block. * @param string $comment The new text portion of the DocBlock.
* *
* @return $this This doc block. * @return $this
*/ */
public function setText($comment) public function setText($comment)
{ {
@@ -439,23 +434,6 @@ class DocBlock implements \Reflector
return $tag; return $tag;
} }
/**
* Deletes a tag from the list of tags.
*
* @param Tag $tag The tag to be deleted.
*
* @return bool True if the tag was deleted.
*/
public function deleteTag(Tag $tag)
{
if (($key = array_search($tag, $this->tags)) !== false) {
unset($this->tags[$key]);
return true;
}
return false;
}
/** /**
* Builds a string representation of this object. * Builds a string representation of this object.
@@ -0,0 +1,75 @@
<?php
/**
* This file is part of phpDocumentor.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @copyright 2010-2015 Mike van Riel<[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
namespace phpDocumentor\Reflection\DocBlock;
/**
* Provides information about the Context in which the DocBlock occurs that receives this context.
*
* A DocBlock does not know of its own accord in which namespace it occurs and which namespace aliases are applicable
* for the block of code in which it is in. This information is however necessary to resolve Class names in tags since
* you can provide a short form or make use of namespace aliases.
*
* The phpDocumentor Reflection component knows how to create this class but if you use the DocBlock parser from your
* own application it is possible to generate a Context class using the ContextFactory; this will analyze the file in
* which an associated class resides for its namespace and imports.
*
* @see ContextFactory::createFromClassReflector()
* @see ContextFactory::createForNamespace()
*/
final class Context
{
/** @var string The current namespace. */
private $namespace = '';
/** @var array List of namespace aliases => Fully Qualified Namespace. */
private $namespaceAliases = [];
/**
* Initializes the new context and normalizes all passed namespaces to be in Qualified Namespace Name (QNN)
* format (without a preceding `\`).
*
* @param string $namespace The namespace where this DocBlock resides in.
* @param array $namespaceAliases List of namespace aliases => Fully Qualified Namespace.
*/
public function __construct($namespace, array $namespaceAliases = [])
{
$this->namespace = ('global' !== $namespace && 'default' !== $namespace)
? trim((string)$namespace, '\\')
: '';
foreach ($namespaceAliases as $alias => $fqnn) {
$this->namespaceAliases[$alias] = trim((string)$fqnn, '\\');
}
}
/**
* Returns the Qualified Namespace Name (thus without `\` in front) where the associated element is in.
*
* @return string
*/
public function getNamespace()
{
return $this->namespace;
}
/**
* Returns a list of Qualified Namespace Names (thus without `\` in front) that are imported, the keys represent
* the alias for the imported Namespace.
*
* @return string[]
*/
public function getNamespaceAliases()
{
return $this->namespaceAliases;
}
}
@@ -0,0 +1,174 @@
<?php
/**
* This file is part of phpDocumentor.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @copyright 2010-2015 Mike van Riel<[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
namespace phpDocumentor\Reflection\DocBlock;
/**
* Convenience class to create a Context for DocBlocks when not using the Reflection Component of phpDocumentor.
*
* For a DocBlock to be able to resolve types that use partial namespace names or rely on namespace imports we need to
* provide a bit of context so that the DocBlock can read that and based on it decide how to resolve the types to
* Fully Qualified names.
*
* @see Context for more information.
*/
final class ContextFactory
{
/** The literal used at the end of a use statement. */
const T_LITERAL_END_OF_USE = ';';
/** The literal used between sets of use statements */
const T_LITERAL_USE_SEPARATOR = ',';
/**
* Build a Context given a Class Reflection.
*
* @param \ReflectionClass $class
*
* @see Context for more information on Contexts.
*
* @return Context
*/
public function createFromClassReflector(\ReflectionClass $class)
{
return $this->createForNamespace(
$class->getNamespaceName(),
file_get_contents($class->getFileName())
);
}
/**
* Build a Context for a namespace in the provided file contents.
*
* @param string $namespace It does not matter if a `\` precedes the namespace name, this method first normalizes.
* @param string $fileContents the file's contents to retrieve the aliases from with the given namespace.
*
* @see Context for more information on Contexts.
*
* @return Context
*/
public function createForNamespace($namespace, $fileContents)
{
$namespace = trim($namespace, '\\');
$useStatements = [];
$currentNamespace = '';
$tokens = new \ArrayIterator(token_get_all($fileContents));
while ($tokens->valid()) {
switch ($tokens->current()[0]) {
case T_NAMESPACE:
$currentNamespace = $this->parseNamespace($tokens);
break;
case T_USE:
if ($currentNamespace === $namespace) {
$useStatements = array_merge($useStatements, $this->parseUseStatement($tokens));
}
break;
}
$tokens->next();
}
return new Context($namespace, $useStatements);
}
/**
* Deduce the name from tokens when we are at the T_NAMESPACE token.
*
* @param \ArrayIterator $tokens
*
* @return string
*/
private function parseNamespace(\ArrayIterator $tokens)
{
// skip to the first string or namespace separator
$this->skipToNextStringOrNamespaceSeparator($tokens);
$name = '';
while ($tokens->valid() && ($tokens->current()[0] === T_STRING || $tokens->current()[0] === T_NS_SEPARATOR)
) {
$name .= $tokens->current()[1];
$tokens->next();
}
return $name;
}
/**
* Deduce the names of all imports when we are at the T_USE token.
*
* @param \ArrayIterator $tokens
*
* @return string[]
*/
private function parseUseStatement(\ArrayIterator $tokens)
{
$uses = [];
$continue = true;
while ($continue) {
$this->skipToNextStringOrNamespaceSeparator($tokens);
list($alias, $fqnn) = $this->extractUseStatement($tokens);
$uses[$alias] = $fqnn;
if ($tokens->current()[0] === self::T_LITERAL_END_OF_USE) {
$continue = false;
}
}
return $uses;
}
/**
* Fast-forwards the iterator as longs as we don't encounter a T_STRING or T_NS_SEPARATOR token.
*
* @param \ArrayIterator $tokens
*
* @return void
*/
private function skipToNextStringOrNamespaceSeparator(\ArrayIterator $tokens)
{
while ($tokens->valid() && ($tokens->current()[0] !== T_STRING) && ($tokens->current()[0] !== T_NS_SEPARATOR)) {
$tokens->next();
}
}
/**
* Deduce the namespace name and alias of an import when we are at the T_USE token or have not reached the end of
* a USE statement yet.
*
* @param \ArrayIterator $tokens
*
* @return string
*/
private function extractUseStatement(\ArrayIterator $tokens)
{
$result = [''];
while ($tokens->valid()
&& ($tokens->current()[0] !== self::T_LITERAL_USE_SEPARATOR)
&& ($tokens->current()[0] !== self::T_LITERAL_END_OF_USE)
) {
if ($tokens->current()[0] === T_AS) {
$result[] = '';
}
if ($tokens->current()[0] === T_STRING || $tokens->current()[0] === T_NS_SEPARATOR) {
$result[count($result) - 1] .= $tokens->current()[1];
}
$tokens->next();
}
if (count($result) == 1) {
$result[] = substr($result[0], strrpos($result[0], '\\') + 1);
}
return array_reverse($result);
}
}
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock; namespace phpDocumentor\Reflection\DocBlock;
use Barryvdh\Reflection\DocBlock; use phpDocumentor\Reflection\DocBlock;
/** /**
* Parses a Description of a DocBlock or tag. * Parses a Description of a DocBlock or tag.
@@ -26,7 +26,7 @@ class Description implements \Reflector
/** @var string */ /** @var string */
protected $contents = ''; protected $contents = '';
/** @var array The contents, as an array of strings and Tag objects. */ /** @var array|null The contents, as an array of strings and Tag objects or null if it is not parsed yet. */
protected $parsedContents = null; protected $parsedContents = null;
/** @var DocBlock The DocBlock which this description belongs to. */ /** @var DocBlock The DocBlock which this description belongs to. */
@@ -35,7 +35,7 @@ class Description implements \Reflector
/** /**
* Populates the fields of a description. * Populates the fields of a description.
* *
* @param string $content The description's conetnts. * @param string $content The description's content.
* @param DocBlock $docblock The DocBlock which this description belongs to. * @param DocBlock $docblock The DocBlock which this description belongs to.
*/ */
public function __construct($content, DocBlock $docblock = null) public function __construct($content, DocBlock $docblock = null)
@@ -109,7 +109,7 @@ class Description implements \Reflector
) )
\}/Sux', \}/Sux',
$this->contents, $this->contents,
-1, null,
PREG_SPLIT_DELIM_CAPTURE PREG_SPLIT_DELIM_CAPTURE
); );
@@ -167,6 +167,9 @@ class Description implements \Reflector
} elseif (class_exists('dflydev\markdown\MarkdownExtraParser')) { } elseif (class_exists('dflydev\markdown\MarkdownExtraParser')) {
$markdown = new \dflydev\markdown\MarkdownExtraParser(); $markdown = new \dflydev\markdown\MarkdownExtraParser();
$result = $markdown->transformMarkdown($result); $result = $markdown->transformMarkdown($result);
} elseif (class_exists('League\CommonMark\CommonMarkConverter')) {
$markdown = new \League\CommonMark\CommonMarkConverter();
$result = $markdown->convertToHtml($result);
} }
return trim($result); return trim($result);
@@ -10,7 +10,7 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock; namespace phpDocumentor\Reflection\DocBlock;
/** /**
* The location a DocBlock occurs within a file. * The location a DocBlock occurs within a file.
@@ -27,15 +27,15 @@ class Location
/** @var int Column where the DocBlock text starts. */ /** @var int Column where the DocBlock text starts. */
protected $columnNumber = 0; protected $columnNumber = 0;
public function __construct( public function __construct($lineNumber = 0, $columnNumber = 0)
$lineNumber = 0, {
$columnNumber = 0
) {
$this->setLineNumber($lineNumber)->setColumnNumber($columnNumber); $this->setLineNumber($lineNumber)->setColumnNumber($columnNumber);
} }
/** /**
* @return int Line where the DocBlock text starts. * Returns the line number that is covered by this location.
*
* @return integer
*/ */
public function getLineNumber() public function getLineNumber()
{ {
@@ -43,8 +43,10 @@ class Location
} }
/** /**
* Registers which line number is covered by this location object.
*
* @param integer $lineNumber
* *
* @param type $lineNumber
* @return $this * @return $this
*/ */
public function setLineNumber($lineNumber) public function setLineNumber($lineNumber)
@@ -55,7 +57,9 @@ class Location
} }
/** /**
* @return int Column where the DocBlock text starts. * Returns the column number (character position on a line) for this location object.
*
* @return integer
*/ */
public function getColumnNumber() public function getColumnNumber()
{ {
@@ -63,8 +67,10 @@ class Location
} }
/** /**
* Registers the column number (character position on a line) for this location object.
*
* @param integer $columnNumber
* *
* @param int $columnNumber
* @return $this * @return $this
*/ */
public function setColumnNumber($columnNumber) public function setColumnNumber($columnNumber)
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock; namespace phpDocumentor\Reflection\DocBlock;
use Barryvdh\Reflection\DocBlock; use phpDocumentor\Reflection\DocBlock;
/** /**
* Serializes a DocBlock instance. * Serializes a DocBlock instance.
@@ -23,7 +23,6 @@ use Barryvdh\Reflection\DocBlock;
*/ */
class Serializer class Serializer
{ {
/** @var string The string to indent the comment with. */ /** @var string The string to indent the comment with. */
protected $indentString = ' '; protected $indentString = ' ';
@@ -36,9 +35,6 @@ class Serializer
/** @var int|null The max length of a line. */ /** @var int|null The max length of a line. */
protected $lineLength = null; protected $lineLength = null;
/** @var bool Separate tag groups. */
protected $separateTags = false;
/** /**
* Create a Serializer instance. * Create a Serializer instance.
* *
@@ -48,32 +44,30 @@ class Serializer
* @param bool $indentFirstLine Whether to indent the first line. * @param bool $indentFirstLine Whether to indent the first line.
* @param int|null $lineLength The max length of a line or NULL to * @param int|null $lineLength The max length of a line or NULL to
* disable line wrapping. * disable line wrapping.
* @param bool $separateTags Separate tag groups.
*/ */
public function __construct( public function __construct(
$indent = 0, $indent = 0,
$indentString = ' ', $indentString = ' ',
$indentFirstLine = true, $indentFirstLine = true,
$lineLength = null, $lineLength = null
$separateTags = false
) { ) {
$this->setIndentationString($indentString); $this->setIndentationString($indentString);
$this->setIndent($indent); $this->setIndent($indent);
$this->setIsFirstLineIndented($indentFirstLine); $this->setIsFirstLineIndented($indentFirstLine);
$this->setLineLength($lineLength); $this->setLineLength($lineLength);
$this->setSeparateTags($separateTags);
} }
/** /**
* Sets the string to indent comments with. * Sets the string to indent comments with.
* *
* @param string $indentationString The string to indent comments with. * @param string $indentString The string to indent comments with.
* *
* @return $this This serializer object. * @return $this This serializer object.
*/ */
public function setIndentationString($indentString) public function setIndentationString($indentString)
{ {
$this->indentString = (string)$indentString; $this->indentString = (string)$indentString;
return $this; return $this;
} }
@@ -164,29 +158,6 @@ class Serializer
return $this->lineLength; return $this->lineLength;
} }
/**
* Sets whether there should be an empty line between tag groups.
*
* @param bool $separateTags The new value for this setting.
*
* @return $this This serializer object.
*/
public function setSeparateTags($separateTags)
{
$this->separateTags = (bool)$separateTags;
return $this;
}
/**
* Gets whether there should be an empty line between tag groups.
*
* @return bool Whether there should be an empty line between tag groups.
*/
public function getSeparateTags()
{
return $this->separateTags;
}
/** /**
* Generate a DocBlock comment. * Generate a DocBlock comment.
* *
@@ -199,6 +170,7 @@ class Serializer
$indent = str_repeat($this->indentString, $this->indent); $indent = str_repeat($this->indentString, $this->indent);
$firstIndent = $this->isFirstLineIndented ? $indent : ''; $firstIndent = $this->isFirstLineIndented ? $indent : '';
$wrapLength = 80;
$text = $docblock->getText(); $text = $docblock->getText();
if ($this->lineLength) { if ($this->lineLength) {
//3 === strlen(' * ') //3 === strlen(' * ')
@@ -209,12 +181,8 @@ class Serializer
$comment = "{$firstIndent}/**\n{$indent} * {$text}\n{$indent} *\n"; $comment = "{$firstIndent}/**\n{$indent} * {$text}\n{$indent} *\n";
$tags = array_values($docblock->getTags());
/** @var Tag $tag */ /** @var Tag $tag */
foreach ($tags as $key => $tag) { foreach ($docblock->getTags() as $tag) {
$nextTag = isset($tags[$key + 1]) ? $tags[$key + 1] : null;
$tagText = (string) $tag; $tagText = (string) $tag;
if ($this->lineLength) { if ($this->lineLength) {
$tagText = wordwrap($tagText, $wrapLength); $tagText = wordwrap($tagText, $wrapLength);
@@ -222,10 +190,6 @@ class Serializer
$tagText = str_replace("\n", "\n{$indent} * ", $tagText); $tagText = str_replace("\n", "\n{$indent} * ", $tagText);
$comment .= "{$indent} * {$tagText}\n"; $comment .= "{$indent} * {$tagText}\n";
if ($this->separateTags && $nextTag !== null && ! $tag->inSameGroup($nextTag)) {
$comment .= "{$indent} *\n";
}
} }
$comment .= $indent . ' */'; $comment .= $indent . ' */';
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock; namespace phpDocumentor\Reflection\DocBlock;
use Barryvdh\Reflection\DocBlock; use phpDocumentor\Reflection\DocBlock;
/** /**
* Parses a tag definition for a DocBlock. * Parses a tag definition for a DocBlock.
@@ -59,45 +59,43 @@ class Tag implements \Reflector
*/ */
private static $tagHandlerMappings = array( private static $tagHandlerMappings = array(
'author' 'author'
=> '\Barryvdh\Reflection\DocBlock\Tag\AuthorTag', => '\phpDocumentor\Reflection\DocBlock\Tag\AuthorTag',
'covers' 'covers'
=> '\Barryvdh\Reflection\DocBlock\Tag\CoversTag', => '\phpDocumentor\Reflection\DocBlock\Tag\CoversTag',
'deprecated' 'deprecated'
=> '\Barryvdh\Reflection\DocBlock\Tag\DeprecatedTag', => '\phpDocumentor\Reflection\DocBlock\Tag\DeprecatedTag',
'example' 'example'
=> '\Barryvdh\Reflection\DocBlock\Tag\ExampleTag', => '\phpDocumentor\Reflection\DocBlock\Tag\ExampleTag',
'link' 'link'
=> '\Barryvdh\Reflection\DocBlock\Tag\LinkTag', => '\phpDocumentor\Reflection\DocBlock\Tag\LinkTag',
'method' 'method'
=> '\Barryvdh\Reflection\DocBlock\Tag\MethodTag', => '\phpDocumentor\Reflection\DocBlock\Tag\MethodTag',
'param' 'param'
=> '\Barryvdh\Reflection\DocBlock\Tag\ParamTag', => '\phpDocumentor\Reflection\DocBlock\Tag\ParamTag',
'property-read' 'property-read'
=> '\Barryvdh\Reflection\DocBlock\Tag\PropertyReadTag', => '\phpDocumentor\Reflection\DocBlock\Tag\PropertyReadTag',
'property' 'property'
=> '\Barryvdh\Reflection\DocBlock\Tag\PropertyTag', => '\phpDocumentor\Reflection\DocBlock\Tag\PropertyTag',
'property-write' 'property-write'
=> '\Barryvdh\Reflection\DocBlock\Tag\PropertyWriteTag', => '\phpDocumentor\Reflection\DocBlock\Tag\PropertyWriteTag',
'return' 'return'
=> '\Barryvdh\Reflection\DocBlock\Tag\ReturnTag', => '\phpDocumentor\Reflection\DocBlock\Tag\ReturnTag',
'see' 'see'
=> '\Barryvdh\Reflection\DocBlock\Tag\SeeTag', => '\phpDocumentor\Reflection\DocBlock\Tag\SeeTag',
'since' 'since'
=> '\Barryvdh\Reflection\DocBlock\Tag\SinceTag', => '\phpDocumentor\Reflection\DocBlock\Tag\SinceTag',
'source' 'source'
=> '\Barryvdh\Reflection\DocBlock\Tag\SourceTag', => '\phpDocumentor\Reflection\DocBlock\Tag\SourceTag',
'throw' 'throw'
=> '\Barryvdh\Reflection\DocBlock\Tag\ThrowsTag', => '\phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag',
'throws' 'throws'
=> '\Barryvdh\Reflection\DocBlock\Tag\ThrowsTag', => '\phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag',
'uses' 'uses'
=> '\Barryvdh\Reflection\DocBlock\Tag\UsesTag', => '\phpDocumentor\Reflection\DocBlock\Tag\UsesTag',
'var' 'var'
=> '\Barryvdh\Reflection\DocBlock\Tag\VarTag', => '\phpDocumentor\Reflection\DocBlock\Tag\VarTag',
'version' 'version'
=> '\Barryvdh\Reflection\DocBlock\Tag\VersionTag', => '\phpDocumentor\Reflection\DocBlock\Tag\VersionTag'
'SuppressWarnings'
=> '\Barryvdh\Reflection\DocBlock\Tag\SuppressWarningsTag'
); );
/** /**
@@ -116,15 +114,7 @@ class Tag implements \Reflector
DocBlock $docblock = null, DocBlock $docblock = null,
Location $location = null Location $location = null
) { ) {
if (!preg_match( $matches = self::extractTagParts($tag_line);
'/^@(' . self::REGEX_TAGNAME . ')(?:\s*([^\s].*)|$)?/us',
$tag_line,
$matches
)) {
throw new \InvalidArgumentException(
'Invalid tag_line detected: ' . $tag_line
);
}
$handler = __CLASS__; $handler = __CLASS__;
if (isset(self::$tagHandlerMappings[$matches[1]])) { if (isset(self::$tagHandlerMappings[$matches[1]])) {
@@ -219,16 +209,13 @@ class Tag implements \Reflector
* *
* @param string $name The new name of this tag. * @param string $name The new name of this tag.
* *
* @return $this
* @throws \InvalidArgumentException When an invalid tag name is provided. * @throws \InvalidArgumentException When an invalid tag name is provided.
*
* @return $this
*/ */
public function setName($name) public function setName($name)
{ {
if (!preg_match('/^' . self::REGEX_TAGNAME . '$/u', $name)) { $this->validateTagName($name);
throw new \InvalidArgumentException(
'Invalid tag name supplied: ' . $name
);
}
$this->tag = $name; $this->tag = $name;
@@ -354,39 +341,6 @@ class Tag implements \Reflector
return $this; return $this;
} }
/**
* If the given tags should be together or apart.
*
* @param Tag $tag
*
* @return bool
*/
public function inSameGroup(Tag $tag)
{
$firstName = $this->getName();
$secondName = $tag->getName();
if ($firstName === $secondName) {
return true;
}
$groups = array(
array('deprecated', 'link', 'see', 'since'),
array('author', 'copyright', 'license'),
array('category', 'package', 'subpackage'),
array('property', 'property-read', 'property-write'),
array('param', 'return'),
);
foreach ($groups as $group) {
if (in_array($firstName, $group, true) && in_array($secondName, $group, true)) {
return true;
}
}
return false;
}
/** /**
* Builds a string representation of this object. * Builds a string representation of this object.
* *
@@ -409,4 +363,40 @@ class Tag implements \Reflector
{ {
return "@{$this->getName()} {$this->getContent()}"; return "@{$this->getName()} {$this->getContent()}";
} }
/**
* Extracts all components for a tag.
*
* @param string $tagLine
*
* @return string[]
*/
private static function extractTagParts($tagLine)
{
$matches = array();
if (! preg_match('/^@(' . self::REGEX_TAGNAME . ')(?:\s*([^\s].*)|$)?/us', $tagLine, $matches)) {
throw new \InvalidArgumentException(
'The tag "' . $tagLine . '" does not seem to be wellformed, please check it for errors'
);
}
return $matches;
}
/**
* Validates if the tag name matches the expected format, otherwise throws an exception.
*
* @param string $name
*
* @return void
*/
private function validateTagName($name)
{
if (!preg_match('/^' . self::REGEX_TAGNAME . '$/u', $name)) {
throw new \InvalidArgumentException(
'The tag name "' . $name . '" is not wellformed. Tags may only consist of letters, underscores, '
. 'hyphens and backslashes.'
);
}
}
} }
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for an @author tag in a Docblock. * Reflection class for an @author tag in a Docblock.
@@ -10,7 +10,7 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @covers tag in a Docblock. * Reflection class for a @covers tag in a Docblock.
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Tag\VersionTag; use phpDocumentor\Reflection\DocBlock\Tag\VersionTag;
/** /**
* Reflection class for a @deprecated tag in a Docblock. * Reflection class for a @deprecated tag in a Docblock.
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @example tag in a Docblock. * Reflection class for a @example tag in a Docblock.
@@ -41,19 +41,11 @@ class ExampleTag extends SourceTag
public function getContent() public function getContent()
{ {
if (null === $this->content) { if (null === $this->content) {
$filePath = '';
if ($this->isURI) {
if (false === strpos($this->filePath, ':')) {
$filePath = str_replace(
'%2F',
'/',
rawurlencode($this->filePath)
);
} else {
$filePath = $this->filePath;
}
} else {
$filePath = '"' . $this->filePath . '"'; $filePath = '"' . $this->filePath . '"';
if ($this->isURI) {
$filePath = $this->isUriRelative($this->filePath)
? str_replace('%2F', '/', rawurlencode($this->filePath))
:$this->filePath;
} }
$this->content = $filePath . ' ' . parent::getContent(); $this->content = $filePath . ' ' . parent::getContent();
@@ -61,6 +53,7 @@ class ExampleTag extends SourceTag
return $this->content; return $this->content;
} }
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
@@ -131,26 +124,35 @@ class ExampleTag extends SourceTag
* Sets the file path as an URI. * Sets the file path as an URI.
* *
* This function is equivalent to {@link setFilePath()}, except that it * This function is equivalent to {@link setFilePath()}, except that it
* convers an URI to a file path before that. * converts an URI to a file path before that.
* *
* There is no getFileURI(), as {@link getFilePath()} is compatible. * There is no getFileURI(), as {@link getFilePath()} is compatible.
* *
* @param type $uri The new file URI to use as an example. * @param string $uri The new file URI to use as an example.
*
* @return $this
*/ */
public function setFileURI($uri) public function setFileURI($uri)
{ {
$this->isURI = true; $this->isURI = true;
if (false === strpos($uri, ':')) {
//Relative URL
$this->filePath = rawurldecode(
str_replace(array('/', '\\'), '%2F', $uri)
);
} else {
//Absolute URL or URI.
$this->filePath = $uri;
}
$this->content = null; $this->content = null;
$this->filePath = $this->isUriRelative($uri)
? rawurldecode(str_replace(array('/', '\\'), '%2F', $uri))
: $this->filePath = $uri;
return $this; return $this;
} }
/**
* Returns true if the provided URI is relative or contains a complete scheme (and thus is absolute).
*
* @param string $uri
*
* @return bool
*/
private function isUriRelative($uri)
{
return false === strpos($uri, ':');
}
} }
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @link tag in a Docblock. * Reflection class for a @link tag in a Docblock.
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @method in a Docblock. * Reflection class for a @method in a Docblock.
@@ -76,17 +76,7 @@ class MethodTag extends ReturnTag
)? )?
# Return type # Return type
(?: (?:
( ([\w\|_\\\\]+)
(?:[\w\|_\\\\]*\$this[\w\|_\\\\]*)
|
(?:
(?:[\w\|_\\\\]+(?:<[\s\S]*>)?)
# array notation
(?:\[\])*
)*
|
(?:\([\s\S]*\))?
)
\s+ \s+
)? )?
# Legacy method name (not captured) # Legacy method name (not captured)
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @param tag in a Docblock. * Reflection class for a @param tag in a Docblock.
@@ -46,37 +46,12 @@ class ParamTag extends ReturnTag
public function setContent($content) public function setContent($content)
{ {
Tag::setContent($content); Tag::setContent($content);
$parts = preg_split(
$parts = []; '/(\s+)/Su',
$rest = $this->description; $this->description,
3,
// parsing generics and closures to detect types PREG_SPLIT_DELIM_CAPTURE
for($pos = 0, $stacks = []; $pos < strlen($rest); $pos++) { );
$char = $rest[$pos];
if($char === '<') {
array_unshift($stacks, $char);
}
if($char === '(') {
array_unshift($stacks, $char);
}
if($char === '>' && isset($stacks[0]) && $stacks[0] === '<') {
array_shift($stacks);
}
if($char === ')' && isset($stacks[0]) && $stacks[0] === '(') {
array_shift($stacks);
}
if(!$stacks && preg_match('/\A(\s+)(.*)/su', substr($rest, $pos), $matches)) {
$parts[0] = substr($rest, 0, $pos);
$parts[1] = $matches[1];
$rest = $matches[2];
break;
}
}
array_push($parts, ...preg_split('/(\s+)/u', $rest, 2, PREG_SPLIT_DELIM_CAPTURE));
// if the first item that is encountered is not a variable; it is a type // if the first item that is encountered is not a variable; it is a type
if (isset($parts[0]) if (isset($parts[0])
@@ -10,7 +10,7 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @property-read tag in a Docblock. * Reflection class for a @property-read tag in a Docblock.
@@ -10,7 +10,7 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @property tag in a Docblock. * Reflection class for a @property tag in a Docblock.
@@ -10,7 +10,7 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @property-write tag in a Docblock. * Reflection class for a @property-write tag in a Docblock.
@@ -10,10 +10,10 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Type\Collection; use phpDocumentor\Reflection\DocBlock\Type\Collection;
/** /**
* Reflection class for a @return tag in a Docblock. * Reflection class for a @return tag in a Docblock.
@@ -36,7 +36,7 @@ class ReturnTag extends Tag
public function getContent() public function getContent()
{ {
if (null === $this->content) { if (null === $this->content) {
$this->content = "{$this->getType()} {$this->description}"; $this->content = "{$this->type} {$this->description}";
} }
return $this->content; return $this->content;
@@ -49,7 +49,7 @@ class ReturnTag extends Tag
{ {
parent::setContent($content); parent::setContent($content);
$parts = preg_split('/(?<!,)\s+/Su', $this->description, 2); $parts = preg_split('/\s+/Su', $this->description, 2);
// any output is considered a type // any output is considered a type
$this->type = $parts[0]; $this->type = $parts[0];
@@ -81,35 +81,6 @@ class ReturnTag extends Tag
return (string) $this->getTypesCollection(); return (string) $this->getTypesCollection();
} }
/**
* Set the type section of the variable
*
* @param string $type
* @return $this
*/
public function setType($type)
{
$this->type = $type;
$this->types = null;
$this->content = null;
return $this;
}
/**
* Add a type to the type section of the variable
*
* @param string $type
* @return $this
*/
public function addType($type)
{
$this->type = $this->type . Collection::OPERATOR_OR . $type;
$this->types = null;
$this->content = null;
return $this;
}
/** /**
* Returns the type collection. * Returns the type collection.
* *
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @see tag in a Docblock. * Reflection class for a @see tag in a Docblock.
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Tag\VersionTag; use phpDocumentor\Reflection\DocBlock\Tag\VersionTag;
/** /**
* Reflection class for a @since tag in a Docblock. * Reflection class for a @since tag in a Docblock.
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @source tag in a Docblock. * Reflection class for a @source tag in a Docblock.
@@ -10,7 +10,7 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @throws tag in a Docblock. * Reflection class for a @throws tag in a Docblock.
@@ -10,7 +10,7 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @uses tag in a Docblock. * Reflection class for a @uses tag in a Docblock.
@@ -10,7 +10,7 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @var tag in a Docblock. * Reflection class for a @var tag in a Docblock.
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Tag; use phpDocumentor\Reflection\DocBlock\Tag;
/** /**
* Reflection class for a @version tag in a Docblock. * Reflection class for a @version tag in a Docblock.
@@ -10,9 +10,9 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Type; namespace phpDocumentor\Reflection\DocBlock\Type;
use Barryvdh\Reflection\DocBlock\Context; use phpDocumentor\Reflection\DocBlock\Context;
/** /**
* Collection * Collection
@@ -106,7 +106,7 @@ class Collection extends \ArrayObject
} }
// separate the type by the OR operator // separate the type by the OR operator
$type_parts = $this->explode($type); $type_parts = explode(self::OPERATOR_OR, $type);
foreach ($type_parts as $part) { foreach ($type_parts as $part) {
$expanded_type = $this->expand($part); $expanded_type = $this->expand($part);
if ($expanded_type) { if ($expanded_type) {
@@ -126,40 +126,6 @@ class Collection extends \ArrayObject
return implode(self::OPERATOR_OR, $this->getArrayCopy()); return implode(self::OPERATOR_OR, $this->getArrayCopy());
} }
/**
* Analyzes the given union of types and returns separated by OR operator
* single types.
*
* @param string $type The type or union of types
*
* @return array
*/
protected function explode($type)
{
$type_parts = [];
$curr_type = '';
$nest_level = 0;
foreach (str_split($type) as $char) {
if ($char === self::OPERATOR_OR && $nest_level === 0) {
$type_parts[] = $curr_type;
$curr_type = '';
} else {
if ($char === '<' || $char === '(') {
$nest_level++;
} else if ($char === '>' || $char === ')') {
$nest_level--;
}
$curr_type .= $char;
}
}
$type_parts[] = $curr_type;
return $type_parts;
}
/** /**
* Analyzes the given type and returns the FQCN variant. * Analyzes the given type and returns the FQCN variant.
* *
@@ -185,31 +151,17 @@ class Collection extends \ArrayObject
return ''; return '';
} }
if (substr($type, 0, 6) === 'array<' && substr($type, -1) === '>') {
return $type;
}
if($type[0] === '(') {
return $type;
}
if ($this->isTypeAnArray($type)) { if ($this->isTypeAnArray($type)) {
return $this->expand(substr($type, 0, -2)) . self::OPERATOR_ARRAY; return $this->expand(substr($type, 0, -2)) . self::OPERATOR_ARRAY;
} }
if ($this->isRelativeType($type) && !$this->isTypeAKeyword($type)) { if ($this->isRelativeType($type) && !$this->isTypeAKeyword($type)) {
if($this->shouldBeAbsolute($type)){
return self::OPERATOR_NAMESPACE . $type;
}
$type_parts = explode(self::OPERATOR_NAMESPACE, $type, 2); $type_parts = explode(self::OPERATOR_NAMESPACE, $type, 2);
$namespace_aliases = $this->context->getNamespaceAliases(); $namespace_aliases = $this->context->getNamespaceAliases();
// if the first segment is not an alias; prepend namespace name and // if the first segment is not an alias; prepend namespace name and
// return // return
if (!isset($namespace_aliases[$type_parts[0]]) && if (!isset($namespace_aliases[$type_parts[0]])) {
!isset($namespace_aliases[strstr($type_parts[0], '::', true)])) {
$namespace = $this->context->getNamespace(); $namespace = $this->context->getNamespace();
if ('' !== $namespace) { if ('' !== $namespace) {
$namespace .= self::OPERATOR_NAMESPACE; $namespace .= self::OPERATOR_NAMESPACE;
@@ -217,12 +169,6 @@ class Collection extends \ArrayObject
return self::OPERATOR_NAMESPACE . $namespace . $type; return self::OPERATOR_NAMESPACE . $namespace . $type;
} }
if (strpos($type_parts[0], '::')) {
$type_parts[] = strstr($type_parts[0], '::');
$type_parts[0] = $namespace_aliases[strstr($type_parts[0], '::', true)];
return implode('', $type_parts);
}
$type_parts[0] = $namespace_aliases[$type_parts[0]]; $type_parts[0] = $namespace_aliases[$type_parts[0]];
$type = implode(self::OPERATOR_NAMESPACE, $type_parts); $type = implode(self::OPERATOR_NAMESPACE, $type_parts);
} }
@@ -272,16 +218,4 @@ class Collection extends \ArrayObject
return ($type[0] !== self::OPERATOR_NAMESPACE) return ($type[0] !== self::OPERATOR_NAMESPACE)
|| $this->isTypeAKeyword($type); || $this->isTypeAKeyword($type);
} }
/**
* Detects if the type should actually be absolute, by checking if it exists.
*
* @param string $type A relative or absolute type as defined in the
* phpDocumentor documentation.
*
* @return bool
*/
protected function shouldBeAbsolute($type){
return class_exists($type);
}
} }
@@ -1,75 +0,0 @@
<?php
/**
* phpDocumentor SuppressWarnings Tag Test
*
* PHP version 5.3
*
* @author Andrew Smith <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
namespace Barryvdh\Reflection\DocBlock\Tag;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
/**
* Test class for \Barryvdh\Reflection\DocBlock\Tag\SuppressWarningsTag
*
* @author Andrew Smith <[email protected]>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
class SuppressWarningsTagTest extends TestCase
{
/**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\SuppressWarningsTag can
* understand the @SuppressWarnings doc block.
*
* @param string $type
* @param string $content
* @param string $exType
* @param string $exVariable
* @param string $exDescription
*
* @covers \Barryvdh\Reflection\DocBlock\Tag\SuppressWarningsTag
* @dataProvider provideDataForConstuctor
*
* @return void
*/
public function testConstructorParesInputsIntoCorrectFields(
$type,
$content,
$description
) {
$tag = new SuppressWarningsTag($type, $content);
$this->assertEquals($type, $tag->getName());
$this->assertEquals($description, $tag->getDescription());
}
/**
* Data provider for testConstructorParesInputsIntoCorrectFields
*
* @return array
*/
public function provideDataForConstuctor()
{
// $type, $content, $description
return array(
array(
'SuppressWarnings',
'SuppressWarnings(PHPMD)',
'SuppressWarnings(PHPMD)',
),
array(
'SuppressWarnings',
'SuppressWarnings(PHPMD.TooManyMethods)',
'SuppressWarnings(PHPMD.TooManyMethods)',
),
);
}
}
@@ -0,0 +1,94 @@
<?php
/**
* This file is part of phpDocumentor.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @copyright 2010-2015 Mike van Riel<[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
namespace phpDocumentor\Reflection\DocBlock {
// Added imports on purpose as mock for the unit tests, please do not remove.
use Mockery as m;
use phpDocumentor\Reflection\DocBlock,
phpDocumentor\Reflection\DocBlock\Tag;
use \ReflectionClass; // yes, the slash is part of the test
/**
* @coversDefaultClass \phpDocumentor\Reflection\DocBlock\ContextFactory
* @covers ::<private>
*/
class ContextFactoryTest extends \PHPUnit_Framework_TestCase
{
/**
* @covers ::createFromClassReflector
* @covers ::createForNamespace
* @uses phpDocumentor\Reflection\DocBlock\Context
*/
public function testReadsNamespaceFromClassReflection()
{
$fixture = new ContextFactory();
$context = $fixture->createFromClassReflector(new ReflectionClass($this));
$this->assertSame(__NAMESPACE__, $context->getNamespace());
}
/**
* @covers ::createFromClassReflector
* @covers ::createForNamespace
* @uses phpDocumentor\Reflection\DocBlock\Context
*/
public function testReadsAliasesFromClassReflection()
{
$fixture = new ContextFactory();
$expected = [
'm' => 'Mockery',
'DocBlock' => 'phpDocumentor\Reflection\DocBlock',
'Tag' => 'phpDocumentor\Reflection\DocBlock\Tag',
'ReflectionClass' => 'ReflectionClass'
];
$context = $fixture->createFromClassReflector(new ReflectionClass($this));
$this->assertSame($expected, $context->getNamespaceAliases());
}
/**
* @covers ::createForNamespace
* @uses phpDocumentor\Reflection\DocBlock\Context
*/
public function testReadsNamespaceFromProvidedNamespaceAndContent()
{
$fixture = new ContextFactory();
$context = $fixture->createForNamespace(__NAMESPACE__, file_get_contents(__FILE__));
$this->assertSame(__NAMESPACE__, $context->getNamespace());
}
/**
* @covers ::createForNamespace
* @uses phpDocumentor\Reflection\DocBlock\Context
*/
public function testReadsAliasesFromProvidedNamespaceAndContent()
{
$fixture = new ContextFactory();
$expected = [
'm' => 'Mockery',
'DocBlock' => 'phpDocumentor\Reflection\DocBlock',
'Tag' => 'phpDocumentor\Reflection\DocBlock\Tag',
'ReflectionClass' => 'ReflectionClass'
];
$context = $fixture->createForNamespace(__NAMESPACE__, file_get_contents(__FILE__));
$this->assertSame($expected, $context->getNamespaceAliases());
}
}
}
namespace phpDocumentor\Reflection\DocBlock\Mock {
// the following import should not show in the tests above
use phpDocumentor\Reflection\DocBlock\Description;
}
@@ -0,0 +1,61 @@
<?php
/**
* This file is part of phpDocumentor.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @copyright 2010-2015 Mike van Riel<[email protected]>
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org
*/
namespace phpDocumentor\Reflection\DocBlock;
use Mockery as m;
/**
* @coversDefaultClass \phpDocumentor\Reflection\DocBlock\Context
*/
class ContextTest extends \PHPUnit_Framework_TestCase
{
/**
* @covers ::__construct
* @covers ::getNamespace
*/
public function testProvidesANormalizedNamespace()
{
$fixture = new Context('\My\Space');
$this->assertSame('My\Space', $fixture->getNamespace());
}
/**
* @covers ::__construct
* @covers ::getNamespace
*/
public function testInterpretsNamespaceNamedGlobalAsRootNamespace()
{
$fixture = new Context('global');
$this->assertSame('', $fixture->getNamespace());
}
/**
* @covers ::__construct
* @covers ::getNamespace
*/
public function testInterpretsNamespaceNamedDefaultAsRootNamespace()
{
$fixture = new Context('default');
$this->assertSame('', $fixture->getNamespace());
}
/**
* @covers ::__construct
* @covers ::getNamespaceAliases
*/
public function testProvidesNormalizedNamespaceAliases()
{
$fixture = new Context('', ['Space' => '\My\Space']);
$this->assertSame(['Space' => 'My\Space'], $fixture->getNamespaceAliases());
}
}
@@ -10,19 +10,17 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock; namespace phpDocumentor\Reflection\DocBlock;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Description * Test class for \phpDocumentor\Reflection\DocBlock\Description
* *
* @author Vasil Rangelov <boen.robot@gmail.com> * @author Vasil Rangelov <boen.robot@gmail.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class DescriptionTest extends TestCase class DescriptionTest extends \PHPUnit_Framework_TestCase
{ {
public function testConstruct() public function testConstruct()
{ {
@@ -108,7 +106,7 @@ LONGDESC;
$parsedDescription = $parsedContents[1]->getParsedDescription(); $parsedDescription = $parsedContents[1]->getParsedDescription();
$this->assertCount(3, $parsedDescription); $this->assertCount(3, $parsedDescription);
$this->assertSame("inline tag with", trim($parsedDescription[0])); $this->assertSame("inline tag with\n", $parsedDescription[0]);
$this->assertInstanceOf( $this->assertInstanceOf(
__NAMESPACE__ . '\Tag\LinkTag', __NAMESPACE__ . '\Tag\LinkTag',
$parsedDescription[1] $parsedDescription[1]
@@ -10,22 +10,20 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Tag\CoversTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\CoversTag
* *
* @author Daniel O'Connor <daniel.oconnor@gmail.com> * @author Daniel O'Connor <daniel.oconnor@gmail.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class CoversTagTest extends TestCase class CoversTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\CoversTag can create * Test that the \phpDocumentor\Reflection\DocBlock\Tag\CoversTag can create
* a link for the covers doc block. * a link for the covers doc block.
* *
* @param string $type * @param string $type
@@ -33,7 +31,7 @@ class CoversTagTest extends TestCase
* @param string $exContent * @param string $exContent
* @param string $exReference * @param string $exReference
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\CoversTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\CoversTag
* @dataProvider provideDataForConstuctor * @dataProvider provideDataForConstuctor
* *
* @return void * @return void
@@ -10,22 +10,20 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Tag\DeprecatedTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\DeprecatedTag
* *
* @author Vasil Rangelov <boen.robot@gmail.com> * @author Vasil Rangelov <boen.robot@gmail.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class DeprecatedTagTest extends TestCase class DeprecatedTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\LinkTag can create * Test that the \phpDocumentor\Reflection\DocBlock\Tag\LinkTag can create
* a link for the @deprecated doc block. * a link for the @deprecated doc block.
* *
* @param string $type * @param string $type
@@ -34,7 +32,7 @@ class DeprecatedTagTest extends TestCase
* @param string $exDescription * @param string $exDescription
* @param string $exVersion * @param string $exVersion
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\DeprecatedTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\DeprecatedTag
* @dataProvider provideDataForConstuctor * @dataProvider provideDataForConstuctor
* *
* @return void * @return void
@@ -10,22 +10,20 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Tag\ExampleTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\ExampleTag
* *
* @author Vasil Rangelov <boen.robot@gmail.com> * @author Vasil Rangelov <boen.robot@gmail.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class ExampleTagTest extends TestCase class ExampleTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\SourceTag can * Test that the \phpDocumentor\Reflection\DocBlock\Tag\SourceTag can
* understand the @source DocBlock. * understand the @source DocBlock.
* *
* @param string $type * @param string $type
@@ -35,7 +33,7 @@ class ExampleTagTest extends TestCase
* @param string $exLineCount * @param string $exLineCount
* @param string $exFilepath * @param string $exFilepath
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\ExampleTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\ExampleTag
* @dataProvider provideDataForConstuctor * @dataProvider provideDataForConstuctor
* *
* @return void * @return void
@@ -10,22 +10,20 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Tag\LinkTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\LinkTag
* *
* @author Ben Selby <benmatselby@gmail.com> * @author Ben Selby <benmatselby@gmail.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class LinkTagTest extends TestCase class LinkTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\LinkTag can create * Test that the \phpDocumentor\Reflection\DocBlock\Tag\LinkTag can create
* a link for the @link doc block. * a link for the @link doc block.
* *
* @param string $type * @param string $type
@@ -34,7 +32,7 @@ class LinkTagTest extends TestCase
* @param string $exDescription * @param string $exDescription
* @param string $exLink * @param string $exLink
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\LinkTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\LinkTag
* @dataProvider provideDataForConstuctor * @dataProvider provideDataForConstuctor
* *
* @return void * @return void
@@ -10,19 +10,17 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Tag\MethodTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\MethodTag
* *
* @author Mike van Riel <mike.vanriel@naenius.com> * @author Mike van Riel <mike.vanriel@naenius.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class MethodTagTest extends TestCase class MethodTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* @param string $signature The signature to test. * @param string $signature The signature to test.
@@ -36,7 +34,7 @@ class MethodTagTest extends TestCase
* @param string $description The short description mentioned in the * @param string $description The short description mentioned in the
* signature. * signature.
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\MethodTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\MethodTag
* @dataProvider getTestSignatures * @dataProvider getTestSignatures
* *
* @return void * @return void
@@ -142,25 +140,7 @@ class MethodTagTest extends TestCase
array( array(
'static static foo()', 'static static foo()',
true, 'foo', 'static', true, 0, '' true, 'foo', 'static', true, 0, ''
), )
// generic array
array(
'array<int, string> foo()',
true, 'foo', 'array<int, string>', false, 0, ''
),
// nested generics
array(
'array<int, array<string, mixed>> foo()',
true, 'foo', 'array<int, array<string, mixed>>', false, 0, ''
),
// closure
array(
'(\Closure(int, string): bool) foo()',
true, 'foo', '(\Closure(int, string): bool)', false, 0, ''
),
); );
} }
} }
@@ -10,22 +10,20 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\ParamTag * Test class for \phpDocumentor\Reflection\DocBlock\ParamTag
* *
* @author Mike van Riel <mike.vanriel@naenius.com> * @author Mike van Riel <mike.vanriel@naenius.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class ParamTagTest extends TestCase class ParamTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\ParamTag can * Test that the \phpDocumentor\Reflection\DocBlock\Tag\ParamTag can
* understand the @param DocBlock. * understand the @param DocBlock.
* *
* @param string $type * @param string $type
@@ -35,7 +33,7 @@ class ParamTagTest extends TestCase
* @param string $extractedVarName * @param string $extractedVarName
* @param string $extractedDescription * @param string $extractedDescription
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\ParamTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\ParamTag
* @dataProvider provideDataForConstructor * @dataProvider provideDataForConstructor
* *
* @return void * @return void
@@ -114,75 +112,7 @@ class ParamTagTest extends TestCase
array('int'), array('int'),
'$bob', '$bob',
"Type on a new line" "Type on a new line"
), )
// generic array
array(
'param',
'array<int, string> $names',
'array<int, string>',
array('array<int, string>'),
'$names',
''
),
// nested generics
array(
'param',
'array<int, array<string, mixed>> $arrays',
'array<int, array<string, mixed>>',
array('array<int, array<string, mixed>>'),
'$arrays',
''
),
// closure
array(
'param',
'(\Closure(int, string): bool) $callback',
'(\Closure(int, string): bool)',
array('(\Closure(int, string): bool)'),
'$callback',
''
),
// generic array in closure
array(
'param',
'(\Closure(array<int, string>): bool) $callback',
'(\Closure(array<int, string>): bool)',
array('(\Closure(array<int, string>): bool)'),
'$callback',
''
),
// union types in closure
array(
'param',
'(\Closure(int|string): bool)|bool $callback',
'(\Closure(int|string): bool)|bool',
array('(\Closure(int|string): bool)', 'bool'),
'$callback',
''
),
// example from Laravel Framework - Eloquent Builder)
array(
'param',
'array<array-key, array|(\Closure(\Illuminate\Database\Eloquent\Relations\Relation<*,*,*>): mixed)|string>|string $relations',
'array<array-key, array|(\Closure(\Illuminate\Database\Eloquent\Relations\Relation<*,*,*>): mixed)|string>|string',
array('array<array-key, array|(\Closure(\Illuminate\Database\Eloquent\Relations\Relation<*,*,*>): mixed)|string>', 'string'),
'$relations',
''
),
array(
'param',
'(\Closure(\Illuminate\Database\Eloquent\Relations\Relation<*,*,*>): mixed)|string|null $callback',
'(\Closure(\Illuminate\Database\Eloquent\Relations\Relation<*,*,*>): mixed)|string|null',
array('(\Closure(\Illuminate\Database\Eloquent\Relations\Relation<*,*,*>): mixed)', 'string', 'null'),
'$callback',
''
),
); );
} }
} }
@@ -10,22 +10,20 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\ReturnTag * Test class for \phpDocumentor\Reflection\DocBlock\ReturnTag
* *
* @author Mike van Riel <mike.vanriel@naenius.com> * @author Mike van Riel <mike.vanriel@naenius.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class ReturnTagTest extends TestCase class ReturnTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\ReturnTag can * Test that the \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag can
* understand the @return DocBlock. * understand the @return DocBlock.
* *
* @param string $type * @param string $type
@@ -34,7 +32,7 @@ class ReturnTagTest extends TestCase
* @param string $extractedTypes * @param string $extractedTypes
* @param string $extractedDescription * @param string $extractedDescription
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\ReturnTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\ReturnTag
* @dataProvider provideDataForConstructor * @dataProvider provideDataForConstructor
* *
* @return void * @return void
@@ -98,27 +96,6 @@ class ReturnTagTest extends TestCase
'int', 'int',
array('int'), array('int'),
"Number of Bobs" "Number of Bobs"
),
array(
'return',
'array<int, string> Types of Bobs',
'array<int, string>',
array('array<int, string>'),
'Types of Bobs'
),
array(
'return',
'array<int, string>|string Types of Bobs',
'array<int, string>|string',
array('array<int, string>', 'string'),
'Types of Bobs'
),
array(
'return',
'array<int, string|bool>|string Types of Bobs',
'array<int, string|bool>|string',
array('array<int, string|bool>', 'string'),
'Types of Bobs'
) )
); );
} }
@@ -10,19 +10,17 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Tag\SeeTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\SeeTag
* *
* @author Daniel O'Connor <daniel.oconnor@gmail.com> * @author Daniel O'Connor <daniel.oconnor@gmail.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class SeeTagTest extends TestCase class SeeTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the phpDocumentor_Reflection_DocBlock_Tag_See can create a link * Test that the phpDocumentor_Reflection_DocBlock_Tag_See can create a link
@@ -33,7 +31,7 @@ class SeeTagTest extends TestCase
* @param string $exContent * @param string $exContent
* @param string $exReference * @param string $exReference
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\SeeTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\SeeTag
* @dataProvider provideDataForConstuctor * @dataProvider provideDataForConstuctor
* *
* @return void * @return void
@@ -10,22 +10,20 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Tag\SinceTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\SinceTag
* *
* @author Vasil Rangelov <boen.robot@gmail.com> * @author Vasil Rangelov <boen.robot@gmail.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class SinceTagTest extends TestCase class SinceTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\LinkTag can create * Test that the \phpDocumentor\Reflection\DocBlock\Tag\LinkTag can create
* a link for the @since doc block. * a link for the @since doc block.
* *
* @param string $type * @param string $type
@@ -34,7 +32,7 @@ class SinceTagTest extends TestCase
* @param string $exDescription * @param string $exDescription
* @param string $exVersion * @param string $exVersion
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\SinceTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\SinceTag
* @dataProvider provideDataForConstuctor * @dataProvider provideDataForConstuctor
* *
* @return void * @return void
@@ -10,22 +10,20 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Tag\SourceTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\SourceTag
* *
* @author Vasil Rangelov <boen.robot@gmail.com> * @author Vasil Rangelov <boen.robot@gmail.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class SourceTagTest extends TestCase class SourceTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\SourceTag can * Test that the \phpDocumentor\Reflection\DocBlock\Tag\SourceTag can
* understand the @source DocBlock. * understand the @source DocBlock.
* *
* @param string $type * @param string $type
@@ -34,7 +32,7 @@ class SourceTagTest extends TestCase
* @param string $exStartingLine * @param string $exStartingLine
* @param string $exLineCount * @param string $exLineCount
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\SourceTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\SourceTag
* @dataProvider provideDataForConstuctor * @dataProvider provideDataForConstuctor
* *
* @return void * @return void
@@ -10,22 +10,20 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\ThrowsTag * Test class for \phpDocumentor\Reflection\DocBlock\ThrowsTag
* *
* @author Mike van Riel <mike.vanriel@naenius.com> * @author Mike van Riel <mike.vanriel@naenius.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class ThrowsTagTest extends TestCase class ThrowsTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\ThrowsTag can * Test that the \phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag can
* understand the @throws DocBlock. * understand the @throws DocBlock.
* *
* @param string $type * @param string $type
@@ -34,7 +32,7 @@ class ThrowsTagTest extends TestCase
* @param string $extractedTypes * @param string $extractedTypes
* @param string $extractedDescription * @param string $extractedDescription
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\ThrowsTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\ThrowsTag
* @dataProvider provideDataForConstructor * @dataProvider provideDataForConstructor
* *
* @return void * @return void
@@ -10,23 +10,20 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Tag\UsesTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\UsesTag
* *
* @author Daniel O'Connor <daniel.oconnor@gmail.com> * @author Daniel O'Connor <daniel.oconnor@gmail.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class UsesTagTest extends TestCase class UsesTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\UsesTag can create * Test that the \phpDocumentor\Reflection\DocBlock\Tag\UsesTag can create
* a link for the @uses doc block. * a link for the @uses doc block.
* *
* @param string $type * @param string $type
@@ -34,7 +31,7 @@ class UsesTagTest extends TestCase
* @param string $exContent * @param string $exContent
* @param string $exReference * @param string $exReference
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\UsesTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\UsesTag
* @dataProvider provideDataForConstuctor * @dataProvider provideDataForConstuctor
* *
* @return void * @return void
@@ -10,23 +10,20 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\Test;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Tag\VarTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\VarTag
* *
* @author Daniel O'Connor <daniel.oconnor@gmail.com> * @author Daniel O'Connor <daniel.oconnor@gmail.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class VarTagTest extends TestCase class VarTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\VarTag can * Test that the \phpDocumentor\Reflection\DocBlock\Tag\VarTag can
* understand the @var doc block. * understand the @var doc block.
* *
* @param string $type * @param string $type
@@ -35,7 +32,7 @@ class VarTagTest extends TestCase
* @param string $exVariable * @param string $exVariable
* @param string $exDescription * @param string $exDescription
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\VarTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\VarTag
* @dataProvider provideDataForConstuctor * @dataProvider provideDataForConstuctor
* *
* @return void * @return void
@@ -10,22 +10,20 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Tag; namespace phpDocumentor\Reflection\DocBlock\Tag;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Tag\VersionTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\VersionTag
* *
* @author Vasil Rangelov <boen.robot@gmail.com> * @author Vasil Rangelov <boen.robot@gmail.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class VersionTagTest extends TestCase class VersionTagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\LinkTag can create * Test that the \phpDocumentor\Reflection\DocBlock\Tag\LinkTag can create
* a link for the @version doc block. * a link for the @version doc block.
* *
* @param string $type * @param string $type
@@ -34,7 +32,7 @@ class VersionTagTest extends TestCase
* @param string $exDescription * @param string $exDescription
* @param string $exVersion * @param string $exVersion
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag\VersionTag * @covers \phpDocumentor\Reflection\DocBlock\Tag\VersionTag
* @dataProvider provideDataForConstuctor * @dataProvider provideDataForConstuctor
* *
* @return void * @return void
@@ -10,35 +10,34 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock; namespace phpDocumentor\Reflection\DocBlock;
use Barryvdh\Reflection\DocBlock; use phpDocumentor\Reflection\DocBlock;
use Barryvdh\Reflection\DocBlock\Context; use phpDocumentor\Reflection\DocBlock\Context;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Tag\VarTag * Test class for \phpDocumentor\Reflection\DocBlock\Tag\VarTag
* *
* @author Daniel O'Connor <daniel.oconnor@gmail.com> * @author Daniel O'Connor <daniel.oconnor@gmail.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class TagTest extends TestCase class TagTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* @expectedException \InvalidArgumentException
* *
* @return void * @return void
*/ */
public function testInvalidTagLine() public function testInvalidTagLine()
{ {
$this->expectException(\InvalidArgumentException::class);
Tag::createInstance('Invalid tag line'); Tag::createInstance('Invalid tag line');
} }
/** /**
* @covers \Barryvdh\Reflection\DocBlock\Tag::registerTagHandler * @covers \phpDocumentor\Reflection\DocBlock\Tag::registerTagHandler
* *
* @return void * @return void
*/ */
@@ -71,13 +70,13 @@ class TagTest extends TestCase
} }
/** /**
* @covers \Barryvdh\Reflection\DocBlock\Tag::registerTagHandler * @covers \phpDocumentor\Reflection\DocBlock\Tag::registerTagHandler
* *
* @return void * @return void
*/ */
public function testTagHandlerCorrectRegistration() public function testTagHandlerCorrectRegistration()
{ {
if (!ini_get('allow_url_include')) { if (0 == ini_get('allow_url_include')) {
$this->markTestSkipped('"data" URIs for includes are required.'); $this->markTestSkipped('"data" URIs for includes are required.');
} }
$currentHandler = __NAMESPACE__ . '\Tag\VarTag'; $currentHandler = __NAMESPACE__ . '\Tag\VarTag';
@@ -94,7 +93,7 @@ class TagTest extends TestCase
include 'data:text/plain;base64,'. base64_encode( include 'data:text/plain;base64,'. base64_encode(
<<<TAG_HANDLER <<<TAG_HANDLER
<?php <?php
class MyTagHandler extends \Barryvdh\Reflection\DocBlock\Tag {} class MyTagHandler extends \phpDocumentor\Reflection\DocBlock\Tag {}
TAG_HANDLER TAG_HANDLER
); );
@@ -119,8 +118,8 @@ TAG_HANDLER
/** /**
* @depends testTagHandlerCorrectRegistration * @depends testTagHandlerCorrectRegistration
* @covers \Barryvdh\Reflection\DocBlock\Tag::registerTagHandler * @covers \phpDocumentor\Reflection\DocBlock\Tag::registerTagHandler
* @covers \Barryvdh\Reflection\DocBlock\Tag::createInstance * @covers \phpDocumentor\Reflection\DocBlock\Tag::createInstance
* *
* @return void * @return void
*/ */
@@ -163,8 +162,8 @@ TAG_HANDLER
/** /**
* @depends testTagHandlerCorrectRegistration * @depends testTagHandlerCorrectRegistration
* @covers \Barryvdh\Reflection\DocBlock\Tag::registerTagHandler * @covers \phpDocumentor\Reflection\DocBlock\Tag::registerTagHandler
* @covers \Barryvdh\Reflection\DocBlock\Tag::createInstance * @covers \phpDocumentor\Reflection\DocBlock\Tag::createInstance
* *
* @return void * @return void
*/ */
@@ -202,7 +201,7 @@ TAG_HANDLER
} }
/** /**
* @covers \Barryvdh\Reflection\DocBlock\Tag::registerTagHandler * @covers \phpDocumentor\Reflection\DocBlock\Tag::registerTagHandler
* *
* @return void * @return void
*/ */
@@ -233,7 +232,7 @@ TAG_HANDLER
} }
/** /**
* @covers \Barryvdh\Reflection\DocBlock\Tag::registerTagHandler * @covers \phpDocumentor\Reflection\DocBlock\Tag::registerTagHandler
* *
* @return void * @return void
*/ */
@@ -266,14 +265,14 @@ TAG_HANDLER
} }
/** /**
* Test that the \Barryvdh\Reflection\DocBlock\Tag\VarTag can * Test that the \phpDocumentor\Reflection\DocBlock\Tag\VarTag can
* understand the @var doc block. * understand the @var doc block.
* *
* @param string $type * @param string $type
* @param string $content * @param string $content
* @param string $exDescription * @param string $exDescription
* *
* @covers \Barryvdh\Reflection\DocBlock\Tag * @covers \phpDocumentor\Reflection\DocBlock\Tag
* @dataProvider provideDataForConstuctor * @dataProvider provideDataForConstuctor
* *
* @return void * @return void
@@ -10,26 +10,25 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection\DocBlock\Type; namespace phpDocumentor\Reflection\DocBlock\Type;
use Barryvdh\Reflection\DocBlock\Context; use phpDocumentor\Reflection\DocBlock\Context;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for \Barryvdh\Reflection\DocBlock\Type\Collection * Test class for \phpDocumentor\Reflection\DocBlock\Type\Collection
* *
* @covers Barryvdh\Reflection\DocBlock\Type\Collection * @covers phpDocumentor\Reflection\DocBlock\Type\Collection
* *
* @author Mike van Riel <mike.vanriel@naenius.com> * @author Mike van Riel <mike.vanriel@naenius.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class CollectionTest extends TestCase class CollectionTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* @covers Barryvdh\Reflection\DocBlock\Type\Collection::__construct * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
* @covers Barryvdh\Reflection\DocBlock\Type\Collection::getContext * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::getContext
* *
* @return void * @return void
*/ */
@@ -42,7 +41,7 @@ class CollectionTest extends TestCase
} }
/** /**
* @covers Barryvdh\Reflection\DocBlock\Type\Collection::__construct * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
* *
* @return void * @return void
*/ */
@@ -53,7 +52,7 @@ class CollectionTest extends TestCase
} }
/** /**
* @covers Barryvdh\Reflection\DocBlock\Type\Collection::__construct * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
* *
* @return void * @return void
*/ */
@@ -70,7 +69,7 @@ class CollectionTest extends TestCase
} }
/** /**
* @covers Barryvdh\Reflection\DocBlock\Type\Collection::__construct * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::__construct
* *
* @return void * @return void
*/ */
@@ -89,7 +88,7 @@ class CollectionTest extends TestCase
* @param array $expected * @param array $expected
* *
* @dataProvider provideTypesToExpand * @dataProvider provideTypesToExpand
* @covers Barryvdh\Reflection\DocBlock\Type\Collection::add * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add
* *
* @return void * @return void
*/ */
@@ -109,7 +108,7 @@ class CollectionTest extends TestCase
* @param array $expected * @param array $expected
* *
* @dataProvider provideTypesToExpandWithoutNamespace * @dataProvider provideTypesToExpandWithoutNamespace
* @covers Barryvdh\Reflection\DocBlock\Type\Collection::add * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add
* *
* @return void * @return void
*/ */
@@ -125,33 +124,13 @@ class CollectionTest extends TestCase
} }
/** /**
* @param string $fixture * @covers phpDocumentor\Reflection\DocBlock\Type\Collection::add
* @param array $expected * @expectedException InvalidArgumentException
*
* @dataProvider provideTypesToExpandWithPropertyOrMethod
* @covers Barryvdh\Reflection\DocBlock\Type\Collection::add
*
* @return void
*/
public function testAddMethodsAndProperties($fixture, $expected)
{
$collection = new Collection(
array(),
new Context(null, array('LinkDescriptor' => '\phpDocumentor\LinkDescriptor'))
);
$collection->add($fixture);
$this->assertSame($expected, $collection->getArrayCopy());
}
/**
* @covers Barryvdh\Reflection\DocBlock\Type\Collection::add
* *
* @return void * @return void
*/ */
public function testAddWithInvalidArgument() public function testAddWithInvalidArgument()
{ {
$this->expectException(\InvalidArgumentException::class);
$collection = new Collection(); $collection = new Collection();
$collection->add(array()); $collection->add(array());
} }
@@ -198,30 +177,6 @@ class CollectionTest extends TestCase
'DocBlock[]|int[]', 'DocBlock[]|int[]',
array($namespace.'DocBlock[]', 'int[]') array($namespace.'DocBlock[]', 'int[]')
), ),
array(
'array<int, string>',
array('array<int, string>')
),
array(
'array<int, string>|string',
array('array<int, string>', 'string')
),
array(
'array<int, float|bool>|string',
array('array<int, float|bool>', 'string')
),
array(
'array<int, string|array<int, bool>>|array<int, float>|string',
array('array<int, string|array<int, bool>>', 'array<int, float>', 'string')
),
array(
'LinkDescriptor::setLink()',
array($namespace.'LinkDescriptor::setLink()')
),
array(
'Alias\LinkDescriptor::setLink()',
array('\My\Space\Aliasing\LinkDescriptor::setLink()')
),
); );
} }
@@ -237,34 +192,4 @@ class CollectionTest extends TestCase
{ {
return $this->provideTypesToExpand($method, '\\'); return $this->provideTypesToExpand($method, '\\');
} }
/**
* Returns the method and property types and their expected values to test
* the retrieval of types.
*
* @param string $method Name of the method consuming this data provider.
*
* @return string[]
*/
public function provideTypesToExpandWithPropertyOrMethod($method)
{
return array(
array(
'LinkDescriptor::setLink()',
array('\phpDocumentor\LinkDescriptor::setLink()')
),
array(
'phpDocumentor\LinkDescriptor::setLink()',
array('\phpDocumentor\LinkDescriptor::setLink()')
),
array(
'LinkDescriptor::$link',
array('\phpDocumentor\LinkDescriptor::$link')
),
array(
'phpDocumentor\LinkDescriptor::$link',
array('\phpDocumentor\LinkDescriptor::$link')
),
);
}
} }
@@ -10,25 +10,24 @@
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
namespace Barryvdh\Reflection; namespace phpDocumentor\Reflection;
use Barryvdh\Reflection\DocBlock\Context; use phpDocumentor\Reflection\DocBlock\Context;
use Barryvdh\Reflection\DocBlock\Location; use phpDocumentor\Reflection\DocBlock\Location;
use Barryvdh\Reflection\DocBlock\Tag\ReturnTag; use phpDocumentor\Reflection\DocBlock\Tag\ReturnTag;
use PHPUnit\Framework\TestCase;
/** /**
* Test class for Barryvdh\Reflection\DocBlock * Test class for phpDocumentor\Reflection\DocBlock
* *
* @author Mike van Riel <mike.vanriel@naenius.com> * @author Mike van Riel <mike.vanriel@naenius.com>
* @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com) * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
* @license http://www.opensource.org/licenses/mit-license.php MIT * @license http://www.opensource.org/licenses/mit-license.php MIT
* @link http://phpdoc.org * @link http://phpdoc.org
*/ */
class DocBlockTest extends TestCase class DocBlockTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* @covers \Barryvdh\Reflection\DocBlock * @covers \phpDocumentor\Reflection\DocBlock
* *
* @return void * @return void
*/ */
@@ -71,7 +70,7 @@ DOCBLOCK;
} }
/** /**
* @covers \Barryvdh\Reflection\DocBlock::splitDocBlock * @covers \phpDocumentor\Reflection\DocBlock::splitDocBlock
* *
* @return void * @return void
*/ */
@@ -93,7 +92,7 @@ DOCBLOCK;
} }
/** /**
* @covers \Barryvdh\Reflection\DocBlock::isTemplateStart * @covers \phpDocumentor\Reflection\DocBlock::isTemplateStart
*/ */
public function testIfStartOfTemplateIsDiscovered() public function testIfStartOfTemplateIsDiscovered()
{ {
@@ -114,7 +113,7 @@ DOCBLOCK;
} }
/** /**
* @covers \Barryvdh\Reflection\DocBlock::isTemplateEnd * @covers \phpDocumentor\Reflection\DocBlock::isTemplateEnd
*/ */
public function testIfEndOfTemplateIsDiscovered() public function testIfEndOfTemplateIsDiscovered()
{ {
@@ -128,7 +127,7 @@ DOCBLOCK;
} }
/** /**
* @covers \Barryvdh\Reflection\DocBlock::cleanInput * @covers \phpDocumentor\Reflection\DocBlock::cleanInput
* *
* @return void * @return void
*/ */
@@ -145,7 +144,7 @@ DOCBLOCK;
} }
/** /**
* @covers \Barryvdh\Reflection\DocBlock::__construct * @covers \phpDocumentor\Reflection\DocBlock::__construct
* *
* @return void * @return void
*/ */
@@ -153,7 +152,7 @@ DOCBLOCK;
{ {
$object = new DocBlock(new \ReflectionClass($this)); $object = new DocBlock(new \ReflectionClass($this));
$this->assertEquals( $this->assertEquals(
'Test class for Barryvdh\Reflection\DocBlock', 'Test class for phpDocumentor\Reflection\DocBlock',
$object->getShortDescription() $object->getShortDescription()
); );
$this->assertEquals('', $object->getLongDescription()->getContents()); $this->assertEquals('', $object->getLongDescription()->getContents());
@@ -166,12 +165,12 @@ DOCBLOCK;
} }
/** /**
* @expectedException \InvalidArgumentException
* *
* @return void * @return void
*/ */
public function testExceptionOnInvalidObject() public function testExceptionOnInvalidObject()
{ {
$this->expectException(\InvalidArgumentException::class);
new DocBlock($this); new DocBlock($this);
} }
@@ -197,22 +196,21 @@ DOCBLOCK;
} }
/** /**
* @covers \Barryvdh\Reflection\DocBlock::parseTags * @covers \phpDocumentor\Reflection\DocBlock::parseTags
* @expectedException \LogicException * @expectedException \LogicException
* *
* @return void * @return void
*/ */
public function testInvalidTagBlock() public function testInvalidTagBlock()
{ {
if (!ini_get('allow_url_include')) { if (0 == ini_get('allow_url_include')) {
$this->markTestSkipped('"data" URIs for includes are required.'); $this->markTestSkipped('"data" URIs for includes are required.');
return;
} }
include 'data:text/plain;base64,'. base64_encode( include 'data:text/plain;base64,'. base64_encode(
<<<DOCBLOCK_EXTENSION <<<DOCBLOCK_EXTENSION
<?php <?php
class MyReflectionDocBlock extends \Barryvdh\Reflection\DocBlock { class MyReflectionDocBlock extends \phpDocumentor\Reflection\DocBlock {
protected function splitDocBlock(\$comment) { protected function splitDocBlock(\$comment) {
return array('', '', 'Invalid tag block'); return array('', '', 'Invalid tag block');
} }
@@ -264,7 +262,7 @@ DOCBLOCK;
/** /**
* @depends testConstructFromReflector * @depends testConstructFromReflector
* @covers \Barryvdh\Reflection\DocBlock::getTagsByName * @covers \phpDocumentor\Reflection\DocBlock::getTagsByName
* *
* @return void * @return void
*/ */
@@ -277,7 +275,7 @@ DOCBLOCK;
/** /**
* @depends testConstructWithTagsOnly * @depends testConstructWithTagsOnly
* @covers \Barryvdh\Reflection\DocBlock::parseTags * @covers \phpDocumentor\Reflection\DocBlock::parseTags
* *
* @return void * @return void
*/ */
@@ -295,7 +293,7 @@ DOCBLOCK;
/** /**
* @depends testConstructWithTagsOnly * @depends testConstructWithTagsOnly
* @covers \Barryvdh\Reflection\DocBlock::parseTags * @covers \phpDocumentor\Reflection\DocBlock::parseTags
* *
* @return void * @return void
*/ */
@@ -318,7 +316,7 @@ DOCBLOCK;
/** /**
* @depends testConstructWithTagsOnly * @depends testConstructWithTagsOnly
* @covers \Barryvdh\Reflection\DocBlock::getTagsByName * @covers \phpDocumentor\Reflection\DocBlock::getTagsByName
* *
* @return void * @return void
*/ */