Issues in FileDescriptorTest.php - Fixed Issues - Inspection of "Merge pull request #1924 from mbed67/marieke-featu..." - phpDocumentor/phpDocumentor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 4b49c4...89d32a )

by Jaap

created 2017-12-30 14:07 UTC

phpDocumentor/Descriptor/FileDescriptorTest.php (1 issue)

Labels

Documentation 1

Severity

Minor 1

slaubi schlau 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * phpDocumentor
 *
 * PHP Version 5.3
 *
 * @copyright 2010-2013 Mike van Riel / Naenius (http://www.naenius.com)
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Descriptor;

use \Mockery as m;

/**
 * Tests the functionality for the FileDescriptor class.
 */
class FileDescriptorTest extends \Mockery\Adapter\Phpunit\MockeryTestCase
{
    const EXAMPLE_HASH   = 'a-hash-string';
    const EXAMPLE_PATH   = 'a-path-string';
    const EXAMPLE_SOURCE = 'a-source-string';

    /** @var FileDescriptor $fixture */
    protected $fixture;

    /**
     * Creates a new (empty) fixture object.
     */
    protected function setUp()
    {
        $this->fixture = new FileDescriptor(self::EXAMPLE_HASH);
    }

    /**
     * Tests whether all collection objects and hash are properly initialized
     *
     * @covers phpDocumentor\Descriptor\FileDescriptor::__construct
     */
    public function testInitialize()
    {
        $this->assertAttributeEquals(self::EXAMPLE_HASH, 'hash', $this->fixture);

        $this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'namespaceAliases', $this->fixture);
        $this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'includes', $this->fixture);
        $this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'constants', $this->fixture);
        $this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'functions', $this->fixture);
        $this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'classes', $this->fixture);
        $this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'interfaces', $this->fixture);
        $this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'traits', $this->fixture);
        $this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'markers', $this->fixture);
    }

    /**
     * @covers phpDocumentor\Descriptor\FileDescriptor::__construct
     * @covers phpDocumentor\Descriptor\FileDescriptor::getHash
     */
    public function testGetHash()
    {
        $this->assertSame(self::EXAMPLE_HASH, $this->fixture->getHash());
    }

    /**
     * @covers phpDocumentor\Descriptor\FileDescriptor::setPath
     * @covers phpDocumentor\Descriptor\FileDescriptor::getPath
     */
    public function testSetAndGetPath()
    {
        $this->assertSame('', $this->fixture->getPath());

        $this->fixture->setPath(self::EXAMPLE_PATH);

        $this->assertSame(self::EXAMPLE_PATH, $this->fixture->getPath());
    }

    /**
     * @covers phpDocumentor\Descriptor\FileDescriptor::setSource
     * @covers phpDocumentor\Descriptor\FileDescriptor::getSource
     */
    public function testSetAndGetSource()
    {
        $this->assertNull($this->fixture->getSource());

        $this->fixture->setSource(self::EXAMPLE_SOURCE);

        $this->assertSame(self::EXAMPLE_SOURCE, $this->fixture->getSource());
    }

    /**
     * @covers phpDocumentor\Descriptor\FileDescriptor::setNamespaceAliases
     * @covers phpDocumentor\Descriptor\FileDescriptor::getNamespaceAliases
     */
    public function testSetAndGetNamespaceAliases()
    {
        $this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getNamespaceAliases());

        $mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
        $mock = $mockInstance;

        $this->fixture->setNamespaceAliases($mock);

        $this->assertSame($mockInstance, $this->fixture->getNamespaceAliases());
    }

    /**
     * @covers phpDocumentor\Descriptor\FileDescriptor::setIncludes
     * @covers phpDocumentor\Descriptor\FileDescriptor::getIncludes
     */
    public function testSetAndGetIncludes()
    {
        $this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getIncludes());

        $mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
        $mock = $mockInstance;

        $this->fixture->setIncludes($mock);

        $this->assertSame($mockInstance, $this->fixture->getIncludes());
    }

    /**
     * @covers phpDocumentor\Descriptor\FileDescriptor::setConstants
     * @covers phpDocumentor\Descriptor\FileDescriptor::getConstants
     */
    public function testSetAndGetConstants()
    {
        $this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getConstants());

        $mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
        $mock = $mockInstance;

        $this->fixture->setConstants($mock);

        $this->assertSame($mockInstance, $this->fixture->getConstants());
    }

    /**
     * @covers phpDocumentor\Descriptor\FileDescriptor::setFunctions
     * @covers phpDocumentor\Descriptor\FileDescriptor::getFunctions
     */
    public function testSetAndGetFunctions()
    {
        $this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getFunctions());

        $mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
        $mock = $mockInstance;

        $this->fixture->setFunctions($mock);

        $this->assertSame($mockInstance, $this->fixture->getFunctions());
    }

    /**
     * @covers phpDocumentor\Descriptor\FileDescriptor::setClasses
     * @covers phpDocumentor\Descriptor\FileDescriptor::getClasses
     */
    public function testSetAndGetClasses()
    {
        $this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getClasses());

        $mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
        $mock = $mockInstance;

        $this->fixture->setClasses($mock);

        $this->assertSame($mockInstance, $this->fixture->getClasses());
    }

    /**
     * @covers phpDocumentor\Descriptor\FileDescriptor::setInterfaces
     * @covers phpDocumentor\Descriptor\FileDescriptor::getInterfaces
     */
    public function testSetAndGetInterfaces()
    {
        $this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getInterfaces());

        $mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
        $mock = $mockInstance;

        $this->fixture->setInterfaces($mock);

        $this->assertSame($mockInstance, $this->fixture->getInterfaces());
    }

    /**
     * @covers phpDocumentor\Descriptor\FileDescriptor::setTraits
     * @covers phpDocumentor\Descriptor\FileDescriptor::getTraits
     */
    public function testSetAndGetTraits()
    {
        $this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getTraits());

        $mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
        $mock = $mockInstance;

        $this->fixture->setTraits($mock);

        $this->assertSame($mockInstance, $this->fixture->getTraits());
    }

    /**
     * @covers phpDocumentor\Descriptor\FileDescriptor::setMarkers
     * @covers phpDocumentor\Descriptor\FileDescriptor::getMarkers
     */
    public function testSetAndGetMarkers()
    {
        $this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getMarkers());

        $mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
        $mock = $mockInstance;

        $this->fixture->setMarkers($mock);

        $this->assertSame($mockInstance, $this->fixture->getMarkers());
    }

    /**
     * @covers phpDocumentor\Descriptor\FileDescriptor::__construct
     * @covers phpDocumentor\Descriptor\FileDescriptor::getAllErrors
     */
    public function testIfErrorsAreInitializedToAnEmptyCollectionOnInstantiation()
    {
        // construct
        $this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getAllErrors());

        // default returns empty array
        $this->assertObjectHasAttribute('items', $this->fixture->getAllErrors());

        $items = $this->fixture->getAllErrors()->items;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->assertEmpty($items);
    }

    /**
     * @covers phpDocumentor\Descriptor\FileDescriptor::__construct
     * @covers phpDocumentor\Descriptor\FileDescriptor::getAllErrors
     */
    public function testGetAllErrors()
    {
        /*
         * constant
         * function
         * class
         *     property
         *     constant
         *     method
         * interface
         *     constant
         *     method
         * traits
         *     property
         *     method
         */

        // setup error list
        $errorGlobal              = array('error-global');
        $errorClasses             = array('error-class');
        $errorClassMethods        = array('error-class-method');
        $errorClassConstants      = array('error-class-constant');
        $errorClassProperties     = array('error-class-property');
        $errorInterfaces          = array('error-interface');
        $errorInterfacesConstants = array('error-interface-constant');
        $errorInterfacesMethods   = array('error-interface-method');
        $errorTraits              = array('error-traits');
        $errorTraitsProperties    = array('error-traits-property');
        $errorTraitsMethods       = array('error-traits-method');
        $errorFunctions           = array('error-functions');

        // setup global check
        $collection = new Collection($errorGlobal);
        $this->fixture->setErrors($collection);

        // setup class-property check
        $mockClassProperties = m::mock('phpDocumentor\Descriptor\PropertyDescriptor');
        $mockClassProperties->shouldReceive('getErrors')->andReturn(new Collection($errorClassProperties));

        // setup class-constant check
        $mockClassConstants = m::mock('phpDocumentor\Descriptor\ConstantDescriptor');
        $mockClassConstants->shouldReceive('getErrors')->andReturn(new Collection($errorClassConstants));

        // setup class-method check
        $mockClassMethods = m::mock('phpDocumentor\Descriptor\MethodDescriptor');
        $mockClassMethods->shouldReceive('getErrors')->andReturn(new Collection($errorClassMethods));

        // setup class check
        $mockClasses = m::mock('phpDocumentor\Descriptor\ClassDescriptor');
        $mockClasses->shouldReceive('getProperties')->andReturn(new Collection(array($mockClassProperties)));
        $mockClasses->shouldReceive('getConstants')->andReturn(new Collection(array($mockClassConstants)));
        $mockClasses->shouldReceive('getMethods')->andReturn(new Collection(array($mockClassMethods)));
        $mockClasses->shouldReceive('getErrors')->andReturn(new Collection($errorClasses));

        $this->fixture->getClasses()->set('my-test-class', $mockClasses);

        // setup interface-constant check
        $mockInterfaceConstants = m::mock('phpDocumentor\Descriptor\ConstantDescriptor');
        $mockInterfaceConstants->shouldReceive('getErrors')->andReturn(new Collection($errorInterfacesConstants));

        // setup interface-method check
        $mockInterfaceMethods = m::mock('phpDocumentor\Descriptor\MethodDescriptor');
        $mockInterfaceMethods->shouldReceive('getErrors')->andReturn(new Collection($errorInterfacesMethods));

        // setup interface check
        $mockInterfaces = m::mock('phpDocumentor\Descriptor\ClassDescriptor');
        $mockInterfaces->shouldReceive('getProperties')->andReturn(array());
        $mockInterfaces->shouldReceive('getConstants')->andReturn(new Collection(array($mockInterfaceConstants)));
        $mockInterfaces->shouldReceive('getMethods')->andReturn(new Collection(array($mockInterfaceMethods)));
        $mockInterfaces->shouldReceive('getErrors')->andReturn(new Collection($errorInterfaces));

        $this->fixture->getClasses()->set('my-test-interface', $mockInterfaces);

        // setup traits-constant check
        $mockTraitsProperties = m::mock('phpDocumentor\Descriptor\ConstantDescriptor');
        $mockTraitsProperties->shouldReceive('getErrors')->andReturn(new Collection($errorTraitsProperties));

        // setup traits-method check
        $mockTraitsMethods = m::mock('phpDocumentor\Descriptor\MethodDescriptor');
        $mockTraitsMethods->shouldReceive('getErrors')->andReturn(new Collection($errorTraitsMethods));

        // setup traits check
        $mockTraits = m::mock('phpDocumentor\Descriptor\ClassDescriptor');
        $mockTraits->shouldReceive('getConstants')->andReturn(array());
        $mockTraits->shouldReceive('getProperties')->andReturn(new Collection(array($mockTraitsProperties)));
        $mockTraits->shouldReceive('getMethods')->andReturn(new Collection(array($mockTraitsMethods)));
        $mockTraits->shouldReceive('getErrors')->andReturn(new Collection($errorTraits));

        $this->fixture->getClasses()->set('my-test-traits', $mockTraits);

        // setup functions check
        $mockFunctions = m::mock('phpDocumentor\Descriptor\FunctionDescriptor');

        // create dummy instances of constants/methods
        $mockFunctions->shouldReceive('getConstants')->andReturn(array());
        $mockFunctions->shouldReceive('getProperties')->andReturn(array());
        $mockFunctions->shouldReceive('getMethods')->andReturn(array());
        $mockFunctions->shouldReceive('getErrors')->andReturn(new Collection($errorFunctions));

        $this->fixture->getClasses()->set('my-test-function', $mockFunctions);

        // final merge and check
        $expectedErrors = array_merge(
            $errorGlobal,
            $errorClasses,
            $errorInterfaces,
            $errorTraits,
            $errorFunctions,
            $errorClassMethods,
            $errorClassConstants,
            $errorClassProperties,
            $errorInterfacesMethods,
            $errorInterfacesConstants,
            $errorTraitsMethods,
            $errorTraitsProperties
        );

        $this->assertSame($expectedErrors, $this->fixture->getAllErrors()->getAll());
    }
}


1			<?php
2			/**
3			* phpDocumentor
4			*
5			* PHP Version 5.3
6			*
7			* @copyright 2010-2013 Mike van Riel / Naenius (http://www.naenius.com)
8			* @license http://www.opensource.org/licenses/mit-license.php MIT
9			* @link http://phpdoc.org
10			*/
11
12			namespace phpDocumentor\Descriptor;
13
14			use \Mockery as m;
15
16			/**
17			* Tests the functionality for the FileDescriptor class.
18			*/
19			class FileDescriptorTest extends \Mockery\Adapter\Phpunit\MockeryTestCase
20			{
21			const EXAMPLE_HASH = 'a-hash-string';
22			const EXAMPLE_PATH = 'a-path-string';
23			const EXAMPLE_SOURCE = 'a-source-string';
24
25			/** @var FileDescriptor $fixture */
26			protected $fixture;
27
28			/**
29			* Creates a new (empty) fixture object.
30			*/
31			protected function setUp()
32			{
33			$this->fixture = new FileDescriptor(self::EXAMPLE_HASH);
34			}
35
36			/**
37			* Tests whether all collection objects and hash are properly initialized
38			*
39			* @covers phpDocumentor\Descriptor\FileDescriptor::__construct
40			*/
41			public function testInitialize()
42			{
43			$this->assertAttributeEquals(self::EXAMPLE_HASH, 'hash', $this->fixture);
44
45			$this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'namespaceAliases', $this->fixture);
46			$this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'includes', $this->fixture);
47			$this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'constants', $this->fixture);
48			$this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'functions', $this->fixture);
49			$this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'classes', $this->fixture);
50			$this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'interfaces', $this->fixture);
51			$this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'traits', $this->fixture);
52			$this->assertAttributeInstanceOf('phpDocumentor\Descriptor\Collection', 'markers', $this->fixture);
53			}
54
55			/**
56			* @covers phpDocumentor\Descriptor\FileDescriptor::__construct
57			* @covers phpDocumentor\Descriptor\FileDescriptor::getHash
58			*/
59			public function testGetHash()
60			{
61			$this->assertSame(self::EXAMPLE_HASH, $this->fixture->getHash());
62			}
63
64			/**
65			* @covers phpDocumentor\Descriptor\FileDescriptor::setPath
66			* @covers phpDocumentor\Descriptor\FileDescriptor::getPath
67			*/
68			public function testSetAndGetPath()
69			{
70			$this->assertSame('', $this->fixture->getPath());
71
72			$this->fixture->setPath(self::EXAMPLE_PATH);
73
74			$this->assertSame(self::EXAMPLE_PATH, $this->fixture->getPath());
75			}
76
77			/**
78			* @covers phpDocumentor\Descriptor\FileDescriptor::setSource
79			* @covers phpDocumentor\Descriptor\FileDescriptor::getSource
80			*/
81			public function testSetAndGetSource()
82			{
83			$this->assertNull($this->fixture->getSource());
84
85			$this->fixture->setSource(self::EXAMPLE_SOURCE);
86
87			$this->assertSame(self::EXAMPLE_SOURCE, $this->fixture->getSource());
88			}
89
90			/**
91			* @covers phpDocumentor\Descriptor\FileDescriptor::setNamespaceAliases
92			* @covers phpDocumentor\Descriptor\FileDescriptor::getNamespaceAliases
93			*/
94			public function testSetAndGetNamespaceAliases()
95			{
96			$this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getNamespaceAliases());
97
98			$mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
99			$mock = $mockInstance;
100
101			$this->fixture->setNamespaceAliases($mock);
102
103			$this->assertSame($mockInstance, $this->fixture->getNamespaceAliases());
104			}
105
106			/**
107			* @covers phpDocumentor\Descriptor\FileDescriptor::setIncludes
108			* @covers phpDocumentor\Descriptor\FileDescriptor::getIncludes
109			*/
110			public function testSetAndGetIncludes()
111			{
112			$this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getIncludes());
113
114			$mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
115			$mock = $mockInstance;
116
117			$this->fixture->setIncludes($mock);
118
119			$this->assertSame($mockInstance, $this->fixture->getIncludes());
120			}
121
122			/**
123			* @covers phpDocumentor\Descriptor\FileDescriptor::setConstants
124			* @covers phpDocumentor\Descriptor\FileDescriptor::getConstants
125			*/
126			public function testSetAndGetConstants()
127			{
128			$this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getConstants());
129
130			$mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
131			$mock = $mockInstance;
132
133			$this->fixture->setConstants($mock);
134
135			$this->assertSame($mockInstance, $this->fixture->getConstants());
136			}
137
138			/**
139			* @covers phpDocumentor\Descriptor\FileDescriptor::setFunctions
140			* @covers phpDocumentor\Descriptor\FileDescriptor::getFunctions
141			*/
142			public function testSetAndGetFunctions()
143			{
144			$this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getFunctions());
145
146			$mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
147			$mock = $mockInstance;
148
149			$this->fixture->setFunctions($mock);
150
151			$this->assertSame($mockInstance, $this->fixture->getFunctions());
152			}
153
154			/**
155			* @covers phpDocumentor\Descriptor\FileDescriptor::setClasses
156			* @covers phpDocumentor\Descriptor\FileDescriptor::getClasses
157			*/
158			public function testSetAndGetClasses()
159			{
160			$this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getClasses());
161
162			$mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
163			$mock = $mockInstance;
164
165			$this->fixture->setClasses($mock);
166
167			$this->assertSame($mockInstance, $this->fixture->getClasses());
168			}
169
170			/**
171			* @covers phpDocumentor\Descriptor\FileDescriptor::setInterfaces
172			* @covers phpDocumentor\Descriptor\FileDescriptor::getInterfaces
173			*/
174			public function testSetAndGetInterfaces()
175			{
176			$this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getInterfaces());
177
178			$mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
179			$mock = $mockInstance;
180
181			$this->fixture->setInterfaces($mock);
182
183			$this->assertSame($mockInstance, $this->fixture->getInterfaces());
184			}
185
186			/**
187			* @covers phpDocumentor\Descriptor\FileDescriptor::setTraits
188			* @covers phpDocumentor\Descriptor\FileDescriptor::getTraits
189			*/
190			public function testSetAndGetTraits()
191			{
192			$this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getTraits());
193
194			$mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
195			$mock = $mockInstance;
196
197			$this->fixture->setTraits($mock);
198
199			$this->assertSame($mockInstance, $this->fixture->getTraits());
200			}
201
202			/**
203			* @covers phpDocumentor\Descriptor\FileDescriptor::setMarkers
204			* @covers phpDocumentor\Descriptor\FileDescriptor::getMarkers
205			*/
206			public function testSetAndGetMarkers()
207			{
208			$this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getMarkers());
209
210			$mockInstance = m::mock('phpDocumentor\Descriptor\Collection');
211			$mock = $mockInstance;
212
213			$this->fixture->setMarkers($mock);
214
215			$this->assertSame($mockInstance, $this->fixture->getMarkers());
216			}
217
218			/**
219			* @covers phpDocumentor\Descriptor\FileDescriptor::__construct
220			* @covers phpDocumentor\Descriptor\FileDescriptor::getAllErrors
221			*/
222			public function testIfErrorsAreInitializedToAnEmptyCollectionOnInstantiation()
223			{
224			// construct
225			$this->assertInstanceOf('phpDocumentor\Descriptor\Collection', $this->fixture->getAllErrors());
226
227			// default returns empty array
228			$this->assertObjectHasAttribute('items', $this->fixture->getAllErrors());
229
230			$items = $this->fixture->getAllErrors()->items;
			0 ignored issues – show Documentation introduced 2015-12-02 21:15 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `$items` is declared protected in `phpDocumentor\Descriptor\Collection`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
231			$this->assertEmpty($items);
232			}
233
234			/**
235			* @covers phpDocumentor\Descriptor\FileDescriptor::__construct
236			* @covers phpDocumentor\Descriptor\FileDescriptor::getAllErrors
237			*/
238			public function testGetAllErrors()
239			{
240			/*
241			* constant
242			* function
243			* class
244			* property
245			* constant
246			* method
247			* interface
248			* constant
249			* method
250			* traits
251			* property
252			* method
253			*/
254
255			// setup error list
256			$errorGlobal = array('error-global');
257			$errorClasses = array('error-class');
258			$errorClassMethods = array('error-class-method');
259			$errorClassConstants = array('error-class-constant');
260			$errorClassProperties = array('error-class-property');
261			$errorInterfaces = array('error-interface');
262			$errorInterfacesConstants = array('error-interface-constant');
263			$errorInterfacesMethods = array('error-interface-method');
264			$errorTraits = array('error-traits');
265			$errorTraitsProperties = array('error-traits-property');
266			$errorTraitsMethods = array('error-traits-method');
267			$errorFunctions = array('error-functions');
268
269			// setup global check
270			$collection = new Collection($errorGlobal);
271			$this->fixture->setErrors($collection);
272
273			// setup class-property check
274			$mockClassProperties = m::mock('phpDocumentor\Descriptor\PropertyDescriptor');
275			$mockClassProperties->shouldReceive('getErrors')->andReturn(new Collection($errorClassProperties));
276
277			// setup class-constant check
278			$mockClassConstants = m::mock('phpDocumentor\Descriptor\ConstantDescriptor');
279			$mockClassConstants->shouldReceive('getErrors')->andReturn(new Collection($errorClassConstants));
280
281			// setup class-method check
282			$mockClassMethods = m::mock('phpDocumentor\Descriptor\MethodDescriptor');
283			$mockClassMethods->shouldReceive('getErrors')->andReturn(new Collection($errorClassMethods));
284
285			// setup class check
286			$mockClasses = m::mock('phpDocumentor\Descriptor\ClassDescriptor');
287			$mockClasses->shouldReceive('getProperties')->andReturn(new Collection(array($mockClassProperties)));
288			$mockClasses->shouldReceive('getConstants')->andReturn(new Collection(array($mockClassConstants)));
289			$mockClasses->shouldReceive('getMethods')->andReturn(new Collection(array($mockClassMethods)));
290			$mockClasses->shouldReceive('getErrors')->andReturn(new Collection($errorClasses));
291
292			$this->fixture->getClasses()->set('my-test-class', $mockClasses);
293
294			// setup interface-constant check
295			$mockInterfaceConstants = m::mock('phpDocumentor\Descriptor\ConstantDescriptor');
296			$mockInterfaceConstants->shouldReceive('getErrors')->andReturn(new Collection($errorInterfacesConstants));
297
298			// setup interface-method check
299			$mockInterfaceMethods = m::mock('phpDocumentor\Descriptor\MethodDescriptor');
300			$mockInterfaceMethods->shouldReceive('getErrors')->andReturn(new Collection($errorInterfacesMethods));
301
302			// setup interface check
303			$mockInterfaces = m::mock('phpDocumentor\Descriptor\ClassDescriptor');
304			$mockInterfaces->shouldReceive('getProperties')->andReturn(array());
305			$mockInterfaces->shouldReceive('getConstants')->andReturn(new Collection(array($mockInterfaceConstants)));
306			$mockInterfaces->shouldReceive('getMethods')->andReturn(new Collection(array($mockInterfaceMethods)));
307			$mockInterfaces->shouldReceive('getErrors')->andReturn(new Collection($errorInterfaces));
308
309			$this->fixture->getClasses()->set('my-test-interface', $mockInterfaces);
310
311			// setup traits-constant check
312			$mockTraitsProperties = m::mock('phpDocumentor\Descriptor\ConstantDescriptor');
313			$mockTraitsProperties->shouldReceive('getErrors')->andReturn(new Collection($errorTraitsProperties));
314
315			// setup traits-method check
316			$mockTraitsMethods = m::mock('phpDocumentor\Descriptor\MethodDescriptor');
317			$mockTraitsMethods->shouldReceive('getErrors')->andReturn(new Collection($errorTraitsMethods));
318
319			// setup traits check
320			$mockTraits = m::mock('phpDocumentor\Descriptor\ClassDescriptor');
321			$mockTraits->shouldReceive('getConstants')->andReturn(array());
322			$mockTraits->shouldReceive('getProperties')->andReturn(new Collection(array($mockTraitsProperties)));
323			$mockTraits->shouldReceive('getMethods')->andReturn(new Collection(array($mockTraitsMethods)));
324			$mockTraits->shouldReceive('getErrors')->andReturn(new Collection($errorTraits));
325
326			$this->fixture->getClasses()->set('my-test-traits', $mockTraits);
327
328			// setup functions check
329			$mockFunctions = m::mock('phpDocumentor\Descriptor\FunctionDescriptor');
330
331			// create dummy instances of constants/methods
332			$mockFunctions->shouldReceive('getConstants')->andReturn(array());
333			$mockFunctions->shouldReceive('getProperties')->andReturn(array());
334			$mockFunctions->shouldReceive('getMethods')->andReturn(array());
335			$mockFunctions->shouldReceive('getErrors')->andReturn(new Collection($errorFunctions));
336
337			$this->fixture->getClasses()->set('my-test-function', $mockFunctions);
338
339			// final merge and check
340			$expectedErrors = array_merge(
341			$errorGlobal,
342			$errorClasses,
343			$errorInterfaces,
344			$errorTraits,
345			$errorFunctions,
346			$errorClassMethods,
347			$errorClassConstants,
348			$errorClassProperties,
349			$errorInterfacesMethods,
350			$errorInterfacesConstants,
351			$errorTraitsMethods,
352			$errorTraitsProperties
353			);
354
355			$this->assertSame($expectedErrors, $this->fixture->getAllErrors()->getAll());
356			}
357			}
358

phpDocumentor / phpDocumentor

Push — develop ( 4b49c4...89d32a )

phpDocumentor/Descriptor/FileDescriptorTest.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like