Issues in SettingsArrayTest.php - All Issues - Inspection of "Merge "Skip implicit description usage with local..." - wikimedia/mediawiki-extensions-Wikibase - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 951284...b5c57e )

unknown

created 2020-11-13 12:17 UTC

lib/tests/phpunit/SettingsArrayTest.php (2 issues)

Labels

Unused Code 2

Severity

Minor 2

jeroendedauw 2

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

namespace Wikibase\Lib\Tests;

use OutOfBoundsException;
use Wikibase\Lib\SettingsArray;

/**
 * @covers \Wikibase\Lib\SettingsArray
 *
 * @group Wikibase
 *
 * @license GPL-2.0-or-later
 * @author Jeroen De Dauw < [email protected] >
 */
class SettingsArrayTest extends \PHPUnit\Framework\TestCase {

	/**
	 * @dataProvider settingProvider
	 */
	public function testGetKnownSetting( array $settings ) {
		$settingsArray = new SettingsArray( $settings );

		foreach ( $settingsArray as $settingName => $settingValue ) {
			$this->assertEquals( $settingValue, $settingsArray->getSetting( $settingName ) );
		}

		$this->assertSameSize( $settings, $settingsArray );
	}

	public function settingProvider() {
		$argLists = [];

		$argLists[] = [ [] ];

		$argLists[] = [ [
			'foo' => 'bar'
		] ];

		$argLists[] = [ [
			'foo' => 'bar',
			'baz' => 'bah',
		] ];

		$argLists[] = [ [
			'foo' => 'bar',
			'baz' => 'bah',
			'blah' => 'bah',
			'nyan' => 1337,
			'onoez' => [ 1, 2, 3 ],
			'spam' => false,
			'hax' => null,
		] ];

		return $argLists;
	}

	/**
	 * @dataProvider settingProvider
	 */
	public function testGetUnknownSetting( array $settings ) {
		$settingsArray = new SettingsArray( $settings );

		$this->expectException( OutOfBoundsException::class );

		$settingsArray->getSetting( 'NyanData ALL the way across the sky' );
	}

	/**
	 * @dataProvider settingProvider
	 */
	public function testHasSetting( array $settings ) {
		$settings = new SettingsArray( $settings );

		foreach ( array_keys( iterator_to_array( $settings ) ) as $settingName ) {
			$this->assertTrue( $settings->hasSetting( $settingName ) );
		}

		$this->assertFalse( $settings->hasSetting( 'I dont think therefore I dont exist' ) );
	}

	/**
	 * @dataProvider settingProvider
	 */
	public function testSetSetting( array $settings ) {
		$settings = new SettingsArray( $settings );

		foreach ( $settings as $settingName => $settingValue ) {
			$settings->setSetting( $settingName, $settingValue );
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
			$this->assertEquals( $settingValue, $settings->getSetting( $settingName ) );
		}

		foreach ( $settings as $settingName => $settingValue ) {
			$settings->setSetting( $settingName, $settingValue );
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
			$this->assertEquals( $settingValue, $settings->getSetting( $settingName ) );
		}

		if ( $settings->count() === 0 ) {
			$this->assertTrue( true );
		}
	}

}


1			<?php
2
3			namespace Wikibase\Lib\Tests;
4
5			use OutOfBoundsException;
6			use Wikibase\Lib\SettingsArray;
7
8			/**
9			* @covers \Wikibase\Lib\SettingsArray
10			*
11			* @group Wikibase
12			*
13			* @license GPL-2.0-or-later
14			* @author Jeroen De Dauw < [email protected] >
15			*/
16			class SettingsArrayTest extends \PHPUnit\Framework\TestCase {
17
18			/**
19			* @dataProvider settingProvider
20			*/
21			public function testGetKnownSetting( array $settings ) {
22			$settingsArray = new SettingsArray( $settings );
23
24			foreach ( $settingsArray as $settingName => $settingValue ) {
25			$this->assertEquals( $settingValue, $settingsArray->getSetting( $settingName ) );
26			}
27
28			$this->assertSameSize( $settings, $settingsArray );
29			}
30
31			public function settingProvider() {
32			$argLists = [];
33
34			$argLists[] = [ [] ];
35
36			$argLists[] = [ [
37			'foo' => 'bar'
38			] ];
39
40			$argLists[] = [ [
41			'foo' => 'bar',
42			'baz' => 'bah',
43			] ];
44
45			$argLists[] = [ [
46			'foo' => 'bar',
47			'baz' => 'bah',
48			'blah' => 'bah',
49			'nyan' => 1337,
50			'onoez' => [ 1, 2, 3 ],
51			'spam' => false,
52			'hax' => null,
53			] ];
54
55			return $argLists;
56			}
57
58			/**
59			* @dataProvider settingProvider
60			*/
61			public function testGetUnknownSetting( array $settings ) {
62			$settingsArray = new SettingsArray( $settings );
63
64			$this->expectException( OutOfBoundsException::class );
65
66			$settingsArray->getSetting( 'NyanData ALL the way across the sky' );
67			}
68
69			/**
70			* @dataProvider settingProvider
71			*/
72			public function testHasSetting( array $settings ) {
73			$settings = new SettingsArray( $settings );
74
75			foreach ( array_keys( iterator_to_array( $settings ) ) as $settingName ) {
76			$this->assertTrue( $settings->hasSetting( $settingName ) );
77			}
78
79			$this->assertFalse( $settings->hasSetting( 'I dont think therefore I dont exist' ) );
80			}
81
82			/**
83			* @dataProvider settingProvider
84			*/
85			public function testSetSetting( array $settings ) {
86			$settings = new SettingsArray( $settings );
87
88			foreach ( $settings as $settingName => $settingValue ) {
89			$settings->setSetting( $settingName, $settingValue );
			0 ignored issues – show Unused Code introduced 2020-03-06 14:12 UTC by Report Bug Copy Issue Report Show Similar Issues like this The call to the method `Wikibase\Lib\SettingsArray::setSetting()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
90			$this->assertEquals( $settingValue, $settings->getSetting( $settingName ) );
91			}
92
93			foreach ( $settings as $settingName => $settingValue ) {
94			$settings->setSetting( $settingName, $settingValue );
			0 ignored issues – show Unused Code introduced 2020-03-06 14:12 UTC by Report Bug Copy Issue Report Show Similar Issues like this The call to the method `Wikibase\Lib\SettingsArray::setSetting()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
95			$this->assertEquals( $settingValue, $settings->getSetting( $settingName ) );
96			}
97
98			if ( $settings->count() === 0 ) {
99			$this->assertTrue( true );
100			}
101			}
102
103			}
104

wikimedia / mediawiki-extensions-Wikibase

Push — master ( 951284...b5c57e )

lib/tests/phpunit/SettingsArrayTest.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like