Issues in CollectionTest.php - New Issues - Inspection of "Adds test and fix for #1915" - phpDocumentor/phpDocumentor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 37deef...f45442 )

by Jaap

created 2017-12-24 21:40 UTC

unit/phpDocumentor/Descriptor/CollectionTest.php (1 issue)

Labels

Bug 1

Severity

Minor 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;

/**
 * Tests the functionality for the Collection class.
 */
class CollectionTest extends \Mockery\Adapter\Phpunit\MockeryTestCase
{
    /** @var Collection $fixture */
    protected $fixture;

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

    /**
     * @covers phpDocumentor\Descriptor\Collection::__construct
     */
    public function testInitialize()
    {
        $fixture = new Collection();

        $this->assertAttributeEquals(array(), 'items', $fixture);
    }

    /**
     * @covers phpDocumentor\Descriptor\Collection::__construct
     */
    public function testInitializeWithExistingArray()
    {
        $expected = array(1, 2);
        $fixture = new Collection($expected);

        $this->assertAttributeEquals($expected, 'items', $fixture);
    }

    /**
     * @covers phpDocumentor\Descriptor\Collection::add
     */
    public function testAddNewItem()
    {
        $expected          = array('abc');
        $expectedSecondRun = array('abc','def');

        $this->assertAttributeEquals(array(), 'items', $this->fixture);

        $this->fixture->add('abc');

        $this->assertAttributeEquals($expected, 'items', $this->fixture);

        $this->fixture->add('def');

        $this->assertAttributeEquals($expectedSecondRun, 'items', $this->fixture);
    }

    /**
     * @covers phpDocumentor\Descriptor\Collection::set
     * @covers phpDocumentor\Descriptor\Collection::offsetSet
     */
    public function testSetItemsWithKey()
    {
        $expected          = array('z' => 'abc');
        $expectedSecondRun = array('z' => 'abc', 'y' => 'def');

        $this->assertAttributeEquals(array(), 'items', $this->fixture);

        $this->fixture->set('z', 'abc');

        $this->assertAttributeEquals($expected, 'items', $this->fixture);

        $this->fixture->set('y', 'def');

        $this->assertAttributeEquals($expectedSecondRun, 'items', $this->fixture);
    }

    /**
     * @covers phpDocumentor\Descriptor\Collection::set
     * @expectedException \InvalidArgumentException
     */
    public function testSetItemsWithEmptyKeyShouldThrowException()
    {
        $this->fixture->set('', 'abc');
    }

    /**
     * @covers phpDocumentor\Descriptor\Collection::offsetSet
     * @expectedException \InvalidArgumentException
     */
    public function testSetItemsUsingOffsetSetWithEmptyKeyShouldThrowException()
    {
        $this->fixture->offsetSet('', 'abc');
    }

    /**
     * @covers phpDocumentor\Descriptor\Collection::get
     * @covers phpDocumentor\Descriptor\Collection::__get
     * @covers phpDocumentor\Descriptor\Collection::offsetGet
     */
    public function testRetrievalOfItems()
    {
        $this->fixture['a'] = 'abc';
        $this->assertEquals('abc', $this->fixture->a);
        $this->assertEquals('abc', $this->fixture['a']);
        $this->assertEquals('abc', $this->fixture->get('a'));
        $this->assertCount(1, $this->fixture);

        $this->assertEquals('def', $this->fixture->get(1, 'def'));
        $this->assertCount(2, $this->fixture);
    }

    /**
     * @covers phpDocumentor\Descriptor\Collection::getAll
     */
    public function testRetrieveAllItems()
    {
        $this->fixture['a'] = 'abc';
        $this->assertSame(array('a' => 'abc'), $this->fixture->getAll());
    }

    /**
     * @covers phpDocumentor\Descriptor\Collection::getIterator
     */
    public function testGetIterator()
    {
        $this->fixture['a'] = 'abc';
        $this->assertInstanceOf('ArrayIterator', $this->fixture->getIterator());
        $this->assertSame(array('a' => 'abc'), $this->fixture->getIterator()->getArrayCopy());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * @covers phpDocumentor\Descriptor\Collection::count
     * @covers phpDocumentor\Descriptor\Collection::offsetUnset
     */
    public function testCountReturnsTheNumberOfElements()
    {
        $this->assertCount(0, $this->fixture);
        $this->assertEquals(0, $this->fixture->count());

        $this->fixture[0] = 'abc';

        $this->assertCount(1, $this->fixture);
        $this->assertEquals(1, $this->fixture->count());

        $this->fixture[1] = 'def';

        $this->assertCount(2, $this->fixture);
        $this->assertEquals(2, $this->fixture->count());

        unset($this->fixture[0]);

        $this->assertCount(1, $this->fixture);
        $this->assertEquals(1, $this->fixture->count());
    }

    /**
     * @covers phpDocumentor\Descriptor\Collection::clear
     */
    public function testClearingTheCollection()
    {
        $this->fixture[1] = 'a';
        $this->fixture[2] = 'b';

        $this->assertCount(2, $this->fixture);

        $this->fixture->clear();

        $this->assertCount(0, $this->fixture);
    }

    /**
     * @covers phpDocumentor\Descriptor\Collection::offsetExists
     */
    public function testIfExistingElementsAreDetected()
    {
        $this->assertFalse(isset($this->fixture[0]));
        $this->assertFalse($this->fixture->offsetExists(0));

        $this->fixture[0] = 'abc';

        $this->assertTrue(isset($this->fixture[0]));
        $this->assertTrue($this->fixture->offsetExists(0));
    }

    /**
     * @covers phpDocumentor\Descriptor\Collection::merge
     */
    public function testIfAfterMergeCollectionContainsAllItems()
    {
        $expected = array(0 => 'a', 1 => 'b', 2 => 'c');
        $this->fixture[1] = 'a';
        $this->fixture[2] = 'b';

        $collection2 = new Collection();
        $collection2[4] = 'c';

        $result = $this->fixture->merge($collection2);

        $this->assertSame($expected, $result->getAll());
    }
}


Push — develop ( 37deef...f45442 )

unit/phpDocumentor/Descriptor/CollectionTest.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

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			/**
15			* Tests the functionality for the Collection class.
16			*/
17			class CollectionTest extends \Mockery\Adapter\Phpunit\MockeryTestCase
18			{
19			/** @var Collection $fixture */
20			protected $fixture;
21
22			/**
23			* Creates a new (empty) fixture object.
24			*/
25			protected function setUp()
26			{
27			$this->fixture = new Collection();
28			}
29
30			/**
31			* @covers phpDocumentor\Descriptor\Collection::__construct
32			*/
33			public function testInitialize()
34			{
35			$fixture = new Collection();
36
37			$this->assertAttributeEquals(array(), 'items', $fixture);
38			}
39
40			/**
41			* @covers phpDocumentor\Descriptor\Collection::__construct
42			*/
43			public function testInitializeWithExistingArray()
44			{
45			$expected = array(1, 2);
46			$fixture = new Collection($expected);
47
48			$this->assertAttributeEquals($expected, 'items', $fixture);
49			}
50
51			/**
52			* @covers phpDocumentor\Descriptor\Collection::add
53			*/
54			public function testAddNewItem()
55			{
56			$expected = array('abc');
57			$expectedSecondRun = array('abc','def');
58
59			$this->assertAttributeEquals(array(), 'items', $this->fixture);
60
61			$this->fixture->add('abc');
62
63			$this->assertAttributeEquals($expected, 'items', $this->fixture);
64
65			$this->fixture->add('def');
66
67			$this->assertAttributeEquals($expectedSecondRun, 'items', $this->fixture);
68			}
69
70			/**
71			* @covers phpDocumentor\Descriptor\Collection::set
72			* @covers phpDocumentor\Descriptor\Collection::offsetSet
73			*/
74			public function testSetItemsWithKey()
75			{
76			$expected = array('z' => 'abc');
77			$expectedSecondRun = array('z' => 'abc', 'y' => 'def');
78
79			$this->assertAttributeEquals(array(), 'items', $this->fixture);
80
81			$this->fixture->set('z', 'abc');
82
83			$this->assertAttributeEquals($expected, 'items', $this->fixture);
84
85			$this->fixture->set('y', 'def');
86
87			$this->assertAttributeEquals($expectedSecondRun, 'items', $this->fixture);
88			}
89
90			/**
91			* @covers phpDocumentor\Descriptor\Collection::set
92			* @expectedException \InvalidArgumentException
93			*/
94			public function testSetItemsWithEmptyKeyShouldThrowException()
95			{
96			$this->fixture->set('', 'abc');
97			}
98
99			/**
100			* @covers phpDocumentor\Descriptor\Collection::offsetSet
101			* @expectedException \InvalidArgumentException
102			*/
103			public function testSetItemsUsingOffsetSetWithEmptyKeyShouldThrowException()
104			{
105			$this->fixture->offsetSet('', 'abc');
106			}
107
108			/**
109			* @covers phpDocumentor\Descriptor\Collection::get
110			* @covers phpDocumentor\Descriptor\Collection::__get
111			* @covers phpDocumentor\Descriptor\Collection::offsetGet
112			*/
113			public function testRetrievalOfItems()
114			{
115			$this->fixture['a'] = 'abc';
116			$this->assertEquals('abc', $this->fixture->a);
117			$this->assertEquals('abc', $this->fixture['a']);
118			$this->assertEquals('abc', $this->fixture->get('a'));
119			$this->assertCount(1, $this->fixture);
120
121			$this->assertEquals('def', $this->fixture->get(1, 'def'));
122			$this->assertCount(2, $this->fixture);
123			}
124
125			/**
126			* @covers phpDocumentor\Descriptor\Collection::getAll
127			*/
128			public function testRetrieveAllItems()
129			{
130			$this->fixture['a'] = 'abc';
131			$this->assertSame(array('a' => 'abc'), $this->fixture->getAll());
132			}
133
134			/**
135			* @covers phpDocumentor\Descriptor\Collection::getIterator
136			*/
137			public function testGetIterator()
138			{
139			$this->fixture['a'] = 'abc';
140			$this->assertInstanceOf('ArrayIterator', $this->fixture->getIterator());
141			$this->assertSame(array('a' => 'abc'), $this->fixture->getIterator()->getArrayCopy());
			0 ignored issues – show Bug introduced 2017-12-15 20:36 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Traversable` as the method `getArrayCopy()` does only exist in the following implementations of said interface: `ArrayIterator`, `ArrayObject`, `Behat\Testwork\Specifica...cificationArrayIterator`, `Issue523`, `RecursiveArrayIterator`, `Symfony\Component\Finder...rator\FilePathsIterator`, `Symfony\Component\Finder...rator\InnerNameIterator`, `Symfony\Component\Finder...rator\InnerSizeIterator`, `Symfony\Component\Finder...rator\InnerTypeIterator`, `Symfony\Component\Finder...or\MockFileListIterator`, `Zend\I18n\Translator\TextDomain`, `Zend\Stdlib\ArrayObject`, `Zend\Stdlib\ArrayStack`, `Zend\Stdlib\Parameters`, `ezcDocumentOdtFormattingProperties`, `ezcDocumentOdtPcssConverterManager`, `phpDocumentor\Fileset\Collection`, `phpDocumentor\Fileset\Collection\IgnorePatterns`, `phpDocumentor\Plugin\Scr...erter\Format\Collection`, `phpDocumentor\Plugin\Scr...nverter\Metadata\Assets`, `phpDocumentor\Plugin\Scr...erter\Metadata\Glossary`, `phpDocumentor\Plugin\Scr...etadata\TableOfContents`, `phpDocumentor\Transformer\Router\ExternalRouter`, `phpDocumentor\Transformer\Router\RouterAbstract`, `phpDocumentor\Transformer\Router\StandardRouter`, `phpDocumentor\Transformer\Template\Collection`, `phpDocumentor\Transformer\Writer\Collection`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
142			}
143
144			/**
145			* @covers phpDocumentor\Descriptor\Collection::count
146			* @covers phpDocumentor\Descriptor\Collection::offsetUnset
147			*/
148			public function testCountReturnsTheNumberOfElements()
149			{
150			$this->assertCount(0, $this->fixture);
151			$this->assertEquals(0, $this->fixture->count());
152
153			$this->fixture[0] = 'abc';
154
155			$this->assertCount(1, $this->fixture);
156			$this->assertEquals(1, $this->fixture->count());
157
158			$this->fixture[1] = 'def';
159
160			$this->assertCount(2, $this->fixture);
161			$this->assertEquals(2, $this->fixture->count());
162
163			unset($this->fixture[0]);
164
165			$this->assertCount(1, $this->fixture);
166			$this->assertEquals(1, $this->fixture->count());
167			}
168
169			/**
170			* @covers phpDocumentor\Descriptor\Collection::clear
171			*/
172			public function testClearingTheCollection()
173			{
174			$this->fixture[1] = 'a';
175			$this->fixture[2] = 'b';
176
177			$this->assertCount(2, $this->fixture);
178
179			$this->fixture->clear();
180
181			$this->assertCount(0, $this->fixture);
182			}
183
184			/**
185			* @covers phpDocumentor\Descriptor\Collection::offsetExists
186			*/
187			public function testIfExistingElementsAreDetected()
188			{
189			$this->assertFalse(isset($this->fixture[0]));
190			$this->assertFalse($this->fixture->offsetExists(0));
191
192			$this->fixture[0] = 'abc';
193
194			$this->assertTrue(isset($this->fixture[0]));
195			$this->assertTrue($this->fixture->offsetExists(0));
196			}
197
198			/**
199			* @covers phpDocumentor\Descriptor\Collection::merge
200			*/
201			public function testIfAfterMergeCollectionContainsAllItems()
202			{
203			$expected = array(0 => 'a', 1 => 'b', 2 => 'c');
204			$this->fixture[1] = 'a';
205			$this->fixture[2] = 'b';
206
207			$collection2 = new Collection();
208			$collection2[4] = 'c';
209
210			$result = $this->fixture->merge($collection2);
211
212			$this->assertSame($expected, $result->getAll());
213			}
214			}
215

phpDocumentor / phpDocumentor

Push — develop ( 37deef...f45442 )

unit/phpDocumentor/Descriptor/CollectionTest.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like