1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312 |
- <?php
- /*
- * This file is part of PHP CS Fixer.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- * Dariusz Rumiński <dariusz.ruminski@gmail.com>
- *
- * This source file is subject to the MIT license that is bundled
- * with this source code in the file LICENSE.
- */
- namespace PhpCsFixer\Tests\Fixer\DoctrineAnnotation;
- use PhpCsFixer\Tests\AbstractDoctrineAnnotationFixerTestCase;
- /**
- * @internal
- *
- * @covers \PhpCsFixer\AbstractDoctrineAnnotationFixer
- * @covers \PhpCsFixer\Fixer\DoctrineAnnotation\DoctrineAnnotationSpacesFixer
- */
- final class DoctrineAnnotationSpacesFixerTest extends AbstractDoctrineAnnotationFixerTestCase
- {
- /**
- * @param string $expected
- * @param string|null $input
- *
- * @dataProvider getFixAllCases
- */
- public function testFixAll($expected, $input = null)
- {
- $this->doTest($expected, $input);
- $this->fixer->configure([
- 'around_parentheses' => true,
- 'around_commas' => true,
- 'around_argument_assignments' => true,
- 'around_array_assignments' => true,
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return array
- */
- public function getFixAllCases()
- {
- return $this->createTestCases([
- ['
- /**
- * @Foo
- */'],
- ['
- /**
- * @Foo()
- */'],
- ['
- /**
- * Foo.
- *
- * @author John Doe
- *
- * @Foo(foo="foo", bar="bar")
- */', '
- /**
- * Foo.
- *
- * @author John Doe
- *
- * @Foo ( foo = "foo" ,bar = "bar" )
- */'],
- ['
- /**
- * @Foo(
- * foo="foo",
- * bar="bar"
- * )
- */', '
- /**
- * @Foo (
- * foo = "foo" ,
- * bar = "bar"
- * )
- */'],
- ['
- /**
- * @Foo(
- * @Bar("foo", "bar"),
- * @Baz
- * )
- */', '
- /**
- * @Foo(
- * @Bar ( "foo" ,"bar") ,
- * @Baz
- * )
- */'],
- ['
- /**
- * @Foo({"bar", "baz"})
- */', '
- /**
- * @Foo( {"bar" ,"baz"} )
- */'],
- ['
- /**
- * @Foo(foo="=foo", bar={"foo" : "=foo", "bar" = "=bar"})
- */', '
- /**
- * @Foo(foo = "=foo" ,bar = {"foo" : "=foo", "bar"="=bar"})
- */'],
- [
- '/** @Foo(foo="foo", bar={"foo" : "foo", "bar" = "bar"}) */',
- '/** @Foo ( foo = "foo" ,bar = {"foo" : "foo", "bar"="bar"} ) */',
- ],
- ['
- /**
- * @Foo(
- * foo="foo",
- * bar={
- * "foo" : "foo",
- * "bar" = "bar"
- * }
- * )
- */', '
- /**
- * @Foo(
- * foo = "foo"
- * ,
- * bar = {
- * "foo":"foo",
- * "bar"="bar"
- * }
- * )
- */'],
- ['
- /**
- * @Foo(
- * foo="foo",
- * bar={
- * "foo" : "foo",
- * "bar" = "bar"
- * }
- * )
- */', '
- /**
- * @Foo
- * (
- * foo
- * =
- * "foo",
- * bar
- * =
- * {
- * "foo"
- * :
- * "foo",
- * "bar"
- * =
- * "bar"
- * }
- * )
- */'],
- ['
- /**
- * @Foo(foo="foo", "bar"=@Bar\Baz({"foo" : true, "bar" = false}))
- */', '
- /**
- * @Foo ( foo = "foo", "bar" = @Bar\Baz({"foo":true, "bar"=false}) )
- */'],
- ['
- /**
- * @Foo(foo = "foo" ,bar="bar"
- */'],
- ['
- /**
- * Comment , with a comma.
- */'],
- ['
- /**
- * Description with a single " character.
- *
- * @Foo(foo="string "" with inner quote", bar="string "" with inner quote")
- *
- * @param mixed description with a single " character.
- */', '
- /**
- * Description with a single " character.
- *
- * @Foo( foo="string "" with inner quote" ,bar="string "" with inner quote" )
- *
- * @param mixed description with a single " character.
- */'],
- ['
- /**
- * // PHPDocumentor 1
- * @abstract ( foo,bar = "baz" )
- * @access ( foo,bar = "baz" )
- * @code ( foo,bar = "baz" )
- * @deprec ( foo,bar = "baz" )
- * @encode ( foo,bar = "baz" )
- * @exception ( foo,bar = "baz" )
- * @final ( foo,bar = "baz" )
- * @ingroup ( foo,bar = "baz" )
- * @inheritdoc ( foo,bar = "baz" )
- * @inheritDoc ( foo,bar = "baz" )
- * @magic ( foo,bar = "baz" )
- * @name ( foo,bar = "baz" )
- * @toc ( foo,bar = "baz" )
- * @tutorial ( foo,bar = "baz" )
- * @private ( foo,bar = "baz" )
- * @static ( foo,bar = "baz" )
- * @staticvar ( foo,bar = "baz" )
- * @staticVar ( foo,bar = "baz" )
- * @throw ( foo,bar = "baz" )
- *
- * // PHPDocumentor 2
- * @api ( foo,bar = "baz" )
- * @author ( foo,bar = "baz" )
- * @category ( foo,bar = "baz" )
- * @copyright ( foo,bar = "baz" )
- * @deprecated ( foo,bar = "baz" )
- * @example ( foo,bar = "baz" )
- * @filesource ( foo,bar = "baz" )
- * @global ( foo,bar = "baz" )
- * @ignore ( foo,bar = "baz" )
- * @internal ( foo,bar = "baz" )
- * @license ( foo,bar = "baz" )
- * @link ( foo,bar = "baz" )
- * @method ( foo,bar = "baz" )
- * @package ( foo,bar = "baz" )
- * @param ( foo,bar = "baz" )
- * @property ( foo,bar = "baz" )
- * @property-read ( foo,bar = "baz" )
- * @property-write ( foo,bar = "baz" )
- * @return ( foo,bar = "baz" )
- * @see ( foo,bar = "baz" )
- * @since ( foo,bar = "baz" )
- * @source ( foo,bar = "baz" )
- * @subpackage ( foo,bar = "baz" )
- * @throws ( foo,bar = "baz" )
- * @todo ( foo,bar = "baz" )
- * @TODO ( foo,bar = "baz" )
- * @usedBy ( foo,bar = "baz" )
- * @uses ( foo,bar = "baz" )
- * @var ( foo,bar = "baz" )
- * @version ( foo,bar = "baz" )
- *
- * // PHPUnit
- * @after ( foo,bar = "baz" )
- * @afterClass ( foo,bar = "baz" )
- * @backupGlobals ( foo,bar = "baz" )
- * @backupStaticAttributes ( foo,bar = "baz" )
- * @before ( foo,bar = "baz" )
- * @beforeClass ( foo,bar = "baz" )
- * @codeCoverageIgnore ( foo,bar = "baz" )
- * @codeCoverageIgnoreStart ( foo,bar = "baz" )
- * @codeCoverageIgnoreEnd ( foo,bar = "baz" )
- * @covers ( foo,bar = "baz" )
- * @coversDefaultClass ( foo,bar = "baz" )
- * @coversNothing ( foo,bar = "baz" )
- * @dataProvider ( foo,bar = "baz" )
- * @depends ( foo,bar = "baz" )
- * @expectedException ( foo,bar = "baz" )
- * @expectedExceptionCode ( foo,bar = "baz" )
- * @expectedExceptionMessage ( foo,bar = "baz" )
- * @expectedExceptionMessageRegExp ( foo,bar = "baz" )
- * @group ( foo,bar = "baz" )
- * @large ( foo,bar = "baz" )
- * @medium ( foo,bar = "baz" )
- * @preserveGlobalState ( foo,bar = "baz" )
- * @requires ( foo,bar = "baz" )
- * @runTestsInSeparateProcesses ( foo,bar = "baz" )
- * @runInSeparateProcess ( foo,bar = "baz" )
- * @small ( foo,bar = "baz" )
- * @test ( foo,bar = "baz" )
- * @testdox ( foo,bar = "baz" )
- * @ticket ( foo,bar = "baz" )
- * @uses ( foo,bar = "baz" )
- *
- * // PHPCheckStyle
- * @SuppressWarnings ( foo,bar = "baz" )
- *
- * // PHPStorm
- * @noinspection ( foo,bar = "baz" )
- *
- * // PEAR
- * @package_version ( foo,bar = "baz" )
- *
- * // PlantUML
- * @enduml ( foo,bar = "baz" )
- * @startuml ( foo,bar = "baz" )
- *
- * // other
- * @fix ( foo,bar = "baz" )
- * @FIXME ( foo,bar = "baz" )
- * @fixme ( foo,bar = "baz" )
- * @override
- */'],
- ['
- /**
- * @Transform /^(\d+)$/
- */'],
- ]);
- }
- /**
- * @param string $expected
- * @param string|null $input
- *
- * @dataProvider getFixAroundParenthesesOnlyCases
- */
- public function testFixAroundParenthesesOnly($expected, $input = null)
- {
- $this->fixer->configure([
- 'around_commas' => false,
- 'around_argument_assignments' => false,
- 'around_array_assignments' => false,
- ]);
- $this->doTest($expected, $input);
- $this->fixer->configure([
- 'around_parentheses' => true,
- 'around_commas' => false,
- 'around_argument_assignments' => false,
- 'around_array_assignments' => false,
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return array
- */
- public function getFixAroundParenthesesOnlyCases()
- {
- return $this->createTestCases([
- ['
- /**
- * @Foo
- */'],
- ['
- /**
- * Foo.
- *
- * @author John Doe
- *
- * @Foo()
- */', '
- /**
- * Foo.
- *
- * @author John Doe
- *
- * @Foo ( )
- */'],
- ['
- /**
- * @Foo("bar")
- */', '
- /**
- * @Foo( "bar" )
- */'],
- ['
- /**
- * @Foo("bar", "baz")
- */', '
- /**
- * @Foo( "bar", "baz" )
- */'],
- [
- '/** @Foo("bar", "baz") */',
- '/** @Foo( "bar", "baz" ) */',
- ],
- ['
- /**
- * @Foo("bar", "baz")
- */', '
- /**
- * @Foo( "bar", "baz" )
- */'],
- ['
- /**
- * @Foo("bar", "baz")
- */', '
- /**
- * @Foo ( "bar", "baz" )
- */'],
- ['
- /**
- * @Foo(
- * "bar",
- * "baz"
- * )
- */', '
- /**
- * @Foo
- * (
- * "bar",
- * "baz"
- * )
- */'],
- ['
- /**
- * @Foo(
- * @Bar("baz")
- * )
- */', '
- /**
- * @Foo
- * (
- * @Bar ( "baz" )
- * )
- */'],
- ['
- /**
- * @Foo ( @Bar ( "bar" )
- */'],
- ['
- /**
- * Foo ( Bar Baz )
- */'],
- ['
- /**
- * Description with a single " character.
- *
- * @Foo("string "" with inner quote")
- *
- * @param mixed description with a single " character.
- */', '
- /**
- * Description with a single " character.
- *
- * @Foo ( "string "" with inner quote" )
- *
- * @param mixed description with a single " character.
- */'],
- ['
- /**
- * // PHPDocumentor 1
- * @abstract ( foo,bar = "baz" )
- * @access ( foo,bar = "baz" )
- * @code ( foo,bar = "baz" )
- * @deprec ( foo,bar = "baz" )
- * @encode ( foo,bar = "baz" )
- * @exception ( foo,bar = "baz" )
- * @final ( foo,bar = "baz" )
- * @ingroup ( foo,bar = "baz" )
- * @inheritdoc ( foo,bar = "baz" )
- * @inheritDoc ( foo,bar = "baz" )
- * @magic ( foo,bar = "baz" )
- * @name ( foo,bar = "baz" )
- * @toc ( foo,bar = "baz" )
- * @tutorial ( foo,bar = "baz" )
- * @private ( foo,bar = "baz" )
- * @static ( foo,bar = "baz" )
- * @staticvar ( foo,bar = "baz" )
- * @staticVar ( foo,bar = "baz" )
- * @throw ( foo,bar = "baz" )
- *
- * // PHPDocumentor 2
- * @api ( foo,bar = "baz" )
- * @author ( foo,bar = "baz" )
- * @category ( foo,bar = "baz" )
- * @copyright ( foo,bar = "baz" )
- * @deprecated ( foo,bar = "baz" )
- * @example ( foo,bar = "baz" )
- * @filesource ( foo,bar = "baz" )
- * @global ( foo,bar = "baz" )
- * @ignore ( foo,bar = "baz" )
- * @internal ( foo,bar = "baz" )
- * @license ( foo,bar = "baz" )
- * @link ( foo,bar = "baz" )
- * @method ( foo,bar = "baz" )
- * @package ( foo,bar = "baz" )
- * @param ( foo,bar = "baz" )
- * @property ( foo,bar = "baz" )
- * @property-read ( foo,bar = "baz" )
- * @property-write ( foo,bar = "baz" )
- * @return ( foo,bar = "baz" )
- * @see ( foo,bar = "baz" )
- * @since ( foo,bar = "baz" )
- * @source ( foo,bar = "baz" )
- * @subpackage ( foo,bar = "baz" )
- * @throws ( foo,bar = "baz" )
- * @todo ( foo,bar = "baz" )
- * @TODO ( foo,bar = "baz" )
- * @usedBy ( foo,bar = "baz" )
- * @uses ( foo,bar = "baz" )
- * @var ( foo,bar = "baz" )
- * @version ( foo,bar = "baz" )
- *
- * // PHPUnit
- * @after ( foo,bar = "baz" )
- * @afterClass ( foo,bar = "baz" )
- * @backupGlobals ( foo,bar = "baz" )
- * @backupStaticAttributes ( foo,bar = "baz" )
- * @before ( foo,bar = "baz" )
- * @beforeClass ( foo,bar = "baz" )
- * @codeCoverageIgnore ( foo,bar = "baz" )
- * @codeCoverageIgnoreStart ( foo,bar = "baz" )
- * @codeCoverageIgnoreEnd ( foo,bar = "baz" )
- * @covers ( foo,bar = "baz" )
- * @coversDefaultClass ( foo,bar = "baz" )
- * @coversNothing ( foo,bar = "baz" )
- * @dataProvider ( foo,bar = "baz" )
- * @depends ( foo,bar = "baz" )
- * @expectedException ( foo,bar = "baz" )
- * @expectedExceptionCode ( foo,bar = "baz" )
- * @expectedExceptionMessage ( foo,bar = "baz" )
- * @expectedExceptionMessageRegExp ( foo,bar = "baz" )
- * @group ( foo,bar = "baz" )
- * @large ( foo,bar = "baz" )
- * @medium ( foo,bar = "baz" )
- * @preserveGlobalState ( foo,bar = "baz" )
- * @requires ( foo,bar = "baz" )
- * @runTestsInSeparateProcesses ( foo,bar = "baz" )
- * @runInSeparateProcess ( foo,bar = "baz" )
- * @small ( foo,bar = "baz" )
- * @test ( foo,bar = "baz" )
- * @testdox ( foo,bar = "baz" )
- * @ticket ( foo,bar = "baz" )
- * @uses ( foo,bar = "baz" )
- *
- * // PHPCheckStyle
- * @SuppressWarnings ( foo,bar = "baz" )
- *
- * // PHPStorm
- * @noinspection ( foo,bar = "baz" )
- *
- * // PEAR
- * @package_version ( foo,bar = "baz" )
- *
- * // PlantUML
- * @enduml ( foo,bar = "baz" )
- * @startuml ( foo,bar = "baz" )
- *
- * // other
- * @fix ( foo,bar = "baz" )
- * @FIXME ( foo,bar = "baz" )
- * @fixme ( foo,bar = "baz" )
- * @override
- */'],
- ]);
- }
- /**
- * @param string $expected
- * @param string|null $input
- *
- * @dataProvider getFixAroundCommasOnlyCases
- */
- public function testFixAroundCommasOnly($expected, $input = null)
- {
- $this->fixer->configure([
- 'around_parentheses' => false,
- 'around_argument_assignments' => false,
- 'around_array_assignments' => false,
- ]);
- $this->doTest($expected, $input);
- $this->fixer->configure([
- 'around_parentheses' => false,
- 'around_commas' => true,
- 'around_argument_assignments' => false,
- 'around_array_assignments' => false,
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return array
- */
- public function getFixAroundCommasOnlyCases()
- {
- return $this->createTestCases([
- ['
- /**
- * @Foo
- */'],
- ['
- /**
- * @Foo()
- */'],
- ['
- /**
- * @Foo ()
- */'],
- ['
- /**
- * @Foo( "bar" )
- */'],
- ['
- /**
- * Foo.
- *
- * @author John Doe
- *
- * @Foo( "bar", "baz")
- */', '
- /**
- * Foo.
- *
- * @author John Doe
- *
- * @Foo( "bar" ,"baz")
- */'],
- [
- '/** @Foo( "bar", "baz") */',
- '/** @Foo( "bar" ,"baz") */',
- ],
- ['
- /**
- * @Foo( "bar", "baz")
- */', '
- /**
- * @Foo( "bar" , "baz")
- */'],
- ['
- /**
- * @Foo(
- * "bar",
- * "baz"
- * )
- */', '
- /**
- * @Foo(
- * "bar" ,
- * "baz"
- * )
- */'],
- ['
- /**
- * @Foo(
- * "bar",
- * "baz"
- * )
- */', '
- /**
- * @Foo(
- * "bar"
- * ,
- * "baz"
- * )
- */'],
- ['
- /**
- * @Foo("bar ,", "baz,")
- */'],
- ['
- /**
- * @Foo(
- * @Bar ( "foo", "bar"),
- * @Baz
- * )
- */', '
- /**
- * @Foo(
- * @Bar ( "foo" ,"bar") ,
- * @Baz
- * )
- */'],
- ['
- /**
- * @Foo({"bar", "baz"})
- */', '
- /**
- * @Foo({"bar" ,"baz"})
- */'],
- ['
- /**
- * @Foo(foo="foo", bar="bar")
- */', '
- /**
- * @Foo(foo="foo" ,bar="bar")
- */'],
- ['
- /**
- * @Foo(foo="foo" ,bar="bar"
- */'],
- ['
- /**
- * Comment , with a comma.
- */'],
- ['
- /**
- * Description with a single " character.
- *
- * @Foo(foo="string "" with inner quote", bar="string "" with inner quote")
- *
- * @param mixed description with a single " character.
- */', '
- /**
- * Description with a single " character.
- *
- * @Foo(foo="string "" with inner quote" ,bar="string "" with inner quote")
- *
- * @param mixed description with a single " character.
- */'],
- ['
- /**
- * // PHPDocumentor 1
- * @abstract ( foo,bar = "baz" )
- * @access ( foo,bar = "baz" )
- * @code ( foo,bar = "baz" )
- * @deprec ( foo,bar = "baz" )
- * @encode ( foo,bar = "baz" )
- * @exception ( foo,bar = "baz" )
- * @final ( foo,bar = "baz" )
- * @ingroup ( foo,bar = "baz" )
- * @inheritdoc ( foo,bar = "baz" )
- * @inheritDoc ( foo,bar = "baz" )
- * @magic ( foo,bar = "baz" )
- * @name ( foo,bar = "baz" )
- * @toc ( foo,bar = "baz" )
- * @tutorial ( foo,bar = "baz" )
- * @private ( foo,bar = "baz" )
- * @static ( foo,bar = "baz" )
- * @staticvar ( foo,bar = "baz" )
- * @staticVar ( foo,bar = "baz" )
- * @throw ( foo,bar = "baz" )
- *
- * // PHPDocumentor 2
- * @api ( foo,bar = "baz" )
- * @author ( foo,bar = "baz" )
- * @category ( foo,bar = "baz" )
- * @copyright ( foo,bar = "baz" )
- * @deprecated ( foo,bar = "baz" )
- * @example ( foo,bar = "baz" )
- * @filesource ( foo,bar = "baz" )
- * @global ( foo,bar = "baz" )
- * @ignore ( foo,bar = "baz" )
- * @internal ( foo,bar = "baz" )
- * @license ( foo,bar = "baz" )
- * @link ( foo,bar = "baz" )
- * @method ( foo,bar = "baz" )
- * @package ( foo,bar = "baz" )
- * @param ( foo,bar = "baz" )
- * @property ( foo,bar = "baz" )
- * @property-read ( foo,bar = "baz" )
- * @property-write ( foo,bar = "baz" )
- * @return ( foo,bar = "baz" )
- * @see ( foo,bar = "baz" )
- * @since ( foo,bar = "baz" )
- * @source ( foo,bar = "baz" )
- * @subpackage ( foo,bar = "baz" )
- * @throws ( foo,bar = "baz" )
- * @todo ( foo,bar = "baz" )
- * @TODO ( foo,bar = "baz" )
- * @usedBy ( foo,bar = "baz" )
- * @uses ( foo,bar = "baz" )
- * @var ( foo,bar = "baz" )
- * @version ( foo,bar = "baz" )
- *
- * // PHPUnit
- * @after ( foo,bar = "baz" )
- * @afterClass ( foo,bar = "baz" )
- * @backupGlobals ( foo,bar = "baz" )
- * @backupStaticAttributes ( foo,bar = "baz" )
- * @before ( foo,bar = "baz" )
- * @beforeClass ( foo,bar = "baz" )
- * @codeCoverageIgnore ( foo,bar = "baz" )
- * @codeCoverageIgnoreStart ( foo,bar = "baz" )
- * @codeCoverageIgnoreEnd ( foo,bar = "baz" )
- * @covers ( foo,bar = "baz" )
- * @coversDefaultClass ( foo,bar = "baz" )
- * @coversNothing ( foo,bar = "baz" )
- * @dataProvider ( foo,bar = "baz" )
- * @depends ( foo,bar = "baz" )
- * @expectedException ( foo,bar = "baz" )
- * @expectedExceptionCode ( foo,bar = "baz" )
- * @expectedExceptionMessage ( foo,bar = "baz" )
- * @expectedExceptionMessageRegExp ( foo,bar = "baz" )
- * @group ( foo,bar = "baz" )
- * @large ( foo,bar = "baz" )
- * @medium ( foo,bar = "baz" )
- * @preserveGlobalState ( foo,bar = "baz" )
- * @requires ( foo,bar = "baz" )
- * @runTestsInSeparateProcesses ( foo,bar = "baz" )
- * @runInSeparateProcess ( foo,bar = "baz" )
- * @small ( foo,bar = "baz" )
- * @test ( foo,bar = "baz" )
- * @testdox ( foo,bar = "baz" )
- * @ticket ( foo,bar = "baz" )
- * @uses ( foo,bar = "baz" )
- *
- * // PHPCheckStyle
- * @SuppressWarnings ( foo,bar = "baz" )
- *
- * // PHPStorm
- * @noinspection ( foo,bar = "baz" )
- *
- * // PEAR
- * @package_version ( foo,bar = "baz" )
- *
- * // PlantUML
- * @enduml ( foo,bar = "baz" )
- * @startuml ( foo,bar = "baz" )
- *
- * // other
- * @fix ( foo,bar = "baz" )
- * @FIXME ( foo,bar = "baz" )
- * @fixme ( foo,bar = "baz" )
- * @override
- */'],
- ]);
- }
- /**
- * @param string $expected
- * @param string|null $input
- *
- * @dataProvider getFixAroundArgumentAssignmentsOnlyCases
- */
- public function testFixAroundArgumentAssignmentsOnly($expected, $input = null)
- {
- $this->fixer->configure([
- 'around_parentheses' => false,
- 'around_commas' => false,
- 'around_array_assignments' => false,
- ]);
- $this->doTest($expected, $input);
- $this->fixer->configure([
- 'around_parentheses' => false,
- 'around_commas' => false,
- 'around_argument_assignments' => true,
- 'around_array_assignments' => false,
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return array
- */
- public function getFixAroundArgumentAssignmentsOnlyCases()
- {
- return $this->createTestCases([
- ['
- /**
- * @Foo (foo="foo", bar="bar")
- */'],
- ['
- /**
- * Foo.
- *
- * @author John Doe
- *
- * @Foo(foo="foo", bar="bar")
- */', '
- /**
- * Foo.
- *
- * @author John Doe
- *
- * @Foo(foo = "foo", bar = "bar")
- */'],
- ['
- /**
- * @Foo(
- * foo="foo",
- * bar="bar"
- * )
- */', '
- /**
- * @Foo(
- * foo = "foo",
- * bar = "bar"
- * )
- */'],
- ['
- /**
- * @Foo(foo="foo", bar={"foo" : "foo", "bar"="bar"})
- */', '
- /**
- * @Foo(foo = "foo", bar = {"foo" : "foo", "bar"="bar"})
- */'],
- [
- '/** @Foo(foo="foo", bar={"foo" : "foo", "bar"="bar"}) */',
- '/** @Foo(foo = "foo", bar = {"foo" : "foo", "bar"="bar"}) */',
- ],
- ['
- /**
- * @Foo(
- * foo="foo",
- * bar={
- * "foo":"foo",
- * "bar"="bar"
- * }
- * )
- */', '
- /**
- * @Foo(
- * foo = "foo",
- * bar = {
- * "foo":"foo",
- * "bar"="bar"
- * }
- * )
- */'],
- ['
- /**
- * @Foo(
- * foo="foo",
- * bar={
- * "foo"
- * :
- * "foo",
- * "bar"
- * =
- * "bar"
- * }
- * )
- */', '
- /**
- * @Foo(
- * foo
- * =
- * "foo",
- * bar
- * =
- * {
- * "foo"
- * :
- * "foo",
- * "bar"
- * =
- * "bar"
- * }
- * )
- */'],
- ['
- /**
- * @Foo(foo="foo", "bar"=@Bar\Baz({"foo":true, "bar"=false}))
- */', '
- /**
- * @Foo(foo = "foo", "bar" = @Bar\Baz({"foo":true, "bar"=false}))
- */'],
- ['
- /**
- * Description with a single " character.
- *
- * @Foo(foo="string "" with inner quote")
- *
- * @param mixed description with a single " character.
- */', '
- /**
- * Description with a single " character.
- *
- * @Foo(foo = "string "" with inner quote")
- *
- * @param mixed description with a single " character.
- */'],
- ['
- /**
- * // PHPDocumentor 1
- * @abstract ( foo,bar = "baz" )
- * @access ( foo,bar = "baz" )
- * @code ( foo,bar = "baz" )
- * @deprec ( foo,bar = "baz" )
- * @encode ( foo,bar = "baz" )
- * @exception ( foo,bar = "baz" )
- * @final ( foo,bar = "baz" )
- * @ingroup ( foo,bar = "baz" )
- * @inheritdoc ( foo,bar = "baz" )
- * @inheritDoc ( foo,bar = "baz" )
- * @magic ( foo,bar = "baz" )
- * @name ( foo,bar = "baz" )
- * @toc ( foo,bar = "baz" )
- * @tutorial ( foo,bar = "baz" )
- * @private ( foo,bar = "baz" )
- * @static ( foo,bar = "baz" )
- * @staticvar ( foo,bar = "baz" )
- * @staticVar ( foo,bar = "baz" )
- * @throw ( foo,bar = "baz" )
- *
- * // PHPDocumentor 2
- * @api ( foo,bar = "baz" )
- * @author ( foo,bar = "baz" )
- * @category ( foo,bar = "baz" )
- * @copyright ( foo,bar = "baz" )
- * @deprecated ( foo,bar = "baz" )
- * @example ( foo,bar = "baz" )
- * @filesource ( foo,bar = "baz" )
- * @global ( foo,bar = "baz" )
- * @ignore ( foo,bar = "baz" )
- * @internal ( foo,bar = "baz" )
- * @license ( foo,bar = "baz" )
- * @link ( foo,bar = "baz" )
- * @method ( foo,bar = "baz" )
- * @package ( foo,bar = "baz" )
- * @param ( foo,bar = "baz" )
- * @property ( foo,bar = "baz" )
- * @property-read ( foo,bar = "baz" )
- * @property-write ( foo,bar = "baz" )
- * @return ( foo,bar = "baz" )
- * @see ( foo,bar = "baz" )
- * @since ( foo,bar = "baz" )
- * @source ( foo,bar = "baz" )
- * @subpackage ( foo,bar = "baz" )
- * @throws ( foo,bar = "baz" )
- * @todo ( foo,bar = "baz" )
- * @TODO ( foo,bar = "baz" )
- * @usedBy ( foo,bar = "baz" )
- * @uses ( foo,bar = "baz" )
- * @var ( foo,bar = "baz" )
- * @version ( foo,bar = "baz" )
- *
- * // PHPUnit
- * @after ( foo,bar = "baz" )
- * @afterClass ( foo,bar = "baz" )
- * @backupGlobals ( foo,bar = "baz" )
- * @backupStaticAttributes ( foo,bar = "baz" )
- * @before ( foo,bar = "baz" )
- * @beforeClass ( foo,bar = "baz" )
- * @codeCoverageIgnore ( foo,bar = "baz" )
- * @codeCoverageIgnoreStart ( foo,bar = "baz" )
- * @codeCoverageIgnoreEnd ( foo,bar = "baz" )
- * @covers ( foo,bar = "baz" )
- * @coversDefaultClass ( foo,bar = "baz" )
- * @coversNothing ( foo,bar = "baz" )
- * @dataProvider ( foo,bar = "baz" )
- * @depends ( foo,bar = "baz" )
- * @expectedException ( foo,bar = "baz" )
- * @expectedExceptionCode ( foo,bar = "baz" )
- * @expectedExceptionMessage ( foo,bar = "baz" )
- * @expectedExceptionMessageRegExp ( foo,bar = "baz" )
- * @group ( foo,bar = "baz" )
- * @large ( foo,bar = "baz" )
- * @medium ( foo,bar = "baz" )
- * @preserveGlobalState ( foo,bar = "baz" )
- * @requires ( foo,bar = "baz" )
- * @runTestsInSeparateProcesses ( foo,bar = "baz" )
- * @runInSeparateProcess ( foo,bar = "baz" )
- * @small ( foo,bar = "baz" )
- * @test ( foo,bar = "baz" )
- * @testdox ( foo,bar = "baz" )
- * @ticket ( foo,bar = "baz" )
- * @uses ( foo,bar = "baz" )
- *
- * // PHPCheckStyle
- * @SuppressWarnings ( foo,bar = "baz" )
- *
- * // PHPStorm
- * @noinspection ( foo,bar = "baz" )
- *
- * // PEAR
- * @package_version ( foo,bar = "baz" )
- *
- * // PlantUML
- * @enduml ( foo,bar = "baz" )
- * @startuml ( foo,bar = "baz" )
- *
- * // other
- * @fix ( foo,bar = "baz" )
- * @FIXME ( foo,bar = "baz" )
- * @fixme ( foo,bar = "baz" )
- * @override
- */'],
- ]);
- }
- /**
- * @param string $expected
- * @param string|null $input
- *
- * @dataProvider getFixAroundArrayAssignmentsOnlyCases
- */
- public function testFixAroundArrayAssignmentsOnly($expected, $input = null)
- {
- $this->fixer->configure([
- 'around_parentheses' => false,
- 'around_commas' => false,
- 'around_argument_assignments' => false,
- ]);
- $this->doTest($expected, $input);
- $this->fixer->configure([
- 'around_parentheses' => false,
- 'around_commas' => false,
- 'around_argument_assignments' => false,
- 'around_array_assignments' => true,
- ]);
- $this->doTest($expected, $input);
- }
- /**
- * @return array
- */
- public function getFixAroundArrayAssignmentsOnlyCases()
- {
- return $this->createTestCases([
- ['
- /**
- * @Foo (foo="foo", bar="bar")
- */'],
- ['
- /**
- * Foo.
- *
- * @author John Doe
- *
- * @Foo(foo = "foo", bar = "bar")
- */'],
- ['
- /**
- * @Foo(
- * foo = "foo",
- * bar = "bar"
- * )
- */'],
- ['
- /**
- * @Foo(foo = "foo", bar = {"foo" : "foo", "bar" = "bar"})
- */', '
- /**
- * @Foo(foo = "foo", bar = {"foo" : "foo", "bar"="bar"})
- */'],
- [
- '/** @Foo(foo = "foo", bar = {"foo" : "foo", "bar" = "bar"}) */',
- '/** @Foo(foo = "foo", bar = {"foo" : "foo", "bar"="bar"}) */',
- ],
- ['
- /**
- * @Foo(
- * foo = "foo",
- * bar = {
- * "foo" : "foo",
- * "bar" = "bar"
- * }
- * )
- */', '
- /**
- * @Foo(
- * foo = "foo",
- * bar = {
- * "foo":"foo",
- * "bar"="bar"
- * }
- * )
- */'],
- ['
- /**
- * @Foo(
- * foo
- * =
- * "foo",
- * bar
- * =
- * {
- * "foo" : "foo",
- * "bar" = "bar"
- * }
- * )
- */', '
- /**
- * @Foo(
- * foo
- * =
- * "foo",
- * bar
- * =
- * {
- * "foo"
- * :
- * "foo",
- * "bar"
- * =
- * "bar"
- * }
- * )
- */'],
- ['
- /**
- * @Foo(foo = "foo", "bar" = @Bar\Baz({"foo" : true, "bar" = false}))
- */', '
- /**
- * @Foo(foo = "foo", "bar" = @Bar\Baz({"foo":true, "bar"=false}))
- */'],
- ['
- /**
- * Description with a single " character.
- *
- * @Foo(foo = "string "" with inner quote")
- *
- * @param mixed description with a single " character.
- */'],
- ['
- /**
- * // PHPDocumentor 1
- * @abstract ( foo,bar = "baz" )
- * @access ( foo,bar = "baz" )
- * @code ( foo,bar = "baz" )
- * @deprec ( foo,bar = "baz" )
- * @encode ( foo,bar = "baz" )
- * @exception ( foo,bar = "baz" )
- * @final ( foo,bar = "baz" )
- * @ingroup ( foo,bar = "baz" )
- * @inheritdoc ( foo,bar = "baz" )
- * @inheritDoc ( foo,bar = "baz" )
- * @magic ( foo,bar = "baz" )
- * @name ( foo,bar = "baz" )
- * @toc ( foo,bar = "baz" )
- * @tutorial ( foo,bar = "baz" )
- * @private ( foo,bar = "baz" )
- * @static ( foo,bar = "baz" )
- * @staticvar ( foo,bar = "baz" )
- * @staticVar ( foo,bar = "baz" )
- * @throw ( foo,bar = "baz" )
- *
- * // PHPDocumentor 2
- * @api ( foo,bar = "baz" )
- * @author ( foo,bar = "baz" )
- * @category ( foo,bar = "baz" )
- * @copyright ( foo,bar = "baz" )
- * @deprecated ( foo,bar = "baz" )
- * @example ( foo,bar = "baz" )
- * @filesource ( foo,bar = "baz" )
- * @global ( foo,bar = "baz" )
- * @ignore ( foo,bar = "baz" )
- * @internal ( foo,bar = "baz" )
- * @license ( foo,bar = "baz" )
- * @link ( foo,bar = "baz" )
- * @method ( foo,bar = "baz" )
- * @package ( foo,bar = "baz" )
- * @param ( foo,bar = "baz" )
- * @property ( foo,bar = "baz" )
- * @property-read ( foo,bar = "baz" )
- * @property-write ( foo,bar = "baz" )
- * @return ( foo,bar = "baz" )
- * @see ( foo,bar = "baz" )
- * @since ( foo,bar = "baz" )
- * @source ( foo,bar = "baz" )
- * @subpackage ( foo,bar = "baz" )
- * @throws ( foo,bar = "baz" )
- * @todo ( foo,bar = "baz" )
- * @TODO ( foo,bar = "baz" )
- * @usedBy ( foo,bar = "baz" )
- * @uses ( foo,bar = "baz" )
- * @var ( foo,bar = "baz" )
- * @version ( foo,bar = "baz" )
- *
- * // PHPUnit
- * @after ( foo,bar = "baz" )
- * @afterClass ( foo,bar = "baz" )
- * @backupGlobals ( foo,bar = "baz" )
- * @backupStaticAttributes ( foo,bar = "baz" )
- * @before ( foo,bar = "baz" )
- * @beforeClass ( foo,bar = "baz" )
- * @codeCoverageIgnore ( foo,bar = "baz" )
- * @codeCoverageIgnoreStart ( foo,bar = "baz" )
- * @codeCoverageIgnoreEnd ( foo,bar = "baz" )
- * @covers ( foo,bar = "baz" )
- * @coversDefaultClass ( foo,bar = "baz" )
- * @coversNothing ( foo,bar = "baz" )
- * @dataProvider ( foo,bar = "baz" )
- * @depends ( foo,bar = "baz" )
- * @expectedException ( foo,bar = "baz" )
- * @expectedExceptionCode ( foo,bar = "baz" )
- * @expectedExceptionMessage ( foo,bar = "baz" )
- * @expectedExceptionMessageRegExp ( foo,bar = "baz" )
- * @group ( foo,bar = "baz" )
- * @large ( foo,bar = "baz" )
- * @medium ( foo,bar = "baz" )
- * @preserveGlobalState ( foo,bar = "baz" )
- * @requires ( foo,bar = "baz" )
- * @runTestsInSeparateProcesses ( foo,bar = "baz" )
- * @runInSeparateProcess ( foo,bar = "baz" )
- * @small ( foo,bar = "baz" )
- * @test ( foo,bar = "baz" )
- * @testdox ( foo,bar = "baz" )
- * @ticket ( foo,bar = "baz" )
- * @uses ( foo,bar = "baz" )
- *
- * // PHPCheckStyle
- * @SuppressWarnings ( foo,bar = "baz" )
- *
- * // PHPStorm
- * @noinspection ( foo,bar = "baz" )
- *
- * // PEAR
- * @package_version ( foo,bar = "baz" )
- *
- * // PlantUML
- * @enduml ( foo,bar = "baz" )
- * @startuml ( foo,bar = "baz" )
- *
- * // other
- * @fix ( foo,bar = "baz" )
- * @FIXME ( foo,bar = "baz" )
- * @fixme ( foo,bar = "baz" )
- * @override
- */'],
- ]);
- }
- /**
- * @return array
- */
- public function getInvalidConfigurationCases()
- {
- return array_merge(parent::getInvalidConfigurationCases(), [
- [[
- 'around_parentheses' => false,
- 'around_commas' => false,
- 'around_argument_assignments' => false,
- 'around_array_assignments' => false,
- ]],
- ]);
- }
- }
|