KeyValueIsTest::testKeyValueIsExceptionScenario() - Code Metrics - Inspection of "Test commit" - Chekote/noun-store - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Branch — scrutinizer_new_php_analysis (b739aa)

by Donald
created 2018-01-12 18:45 UTC
KeyValueIsTest::testKeyValueIsExceptionScenario() A

↳ Parent: KeyValueIsTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	15
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	15
c	0
b	0
f	0
rs	9.4285
cc	1
eloc	7
nc	1
nop	8
How to fix Many Parameters

<?php namespace Chekote\NounStore\Assert;

use Chekote\NounStore\Store\StoreTest;
use Chekote\Phake\Phake;
use InvalidArgumentException;
use OutOfBoundsException;
use RuntimeException;

/**
 * @covers \Chekote\NounStore\Assert::keyValueIs()
 */
class KeyValueIsTest extends AssertTest
{
    public function setUp()
    {
        parent::setUp();

        /* @noinspection PhpUndefinedMethodInspection */
        Phake::when($this->assert)->keyValueIs(Phake::anyParameters())->thenCallParent();
        Phake::when(/** @scrutinizer ignore-type */ $this->assert)->keyValueIs(Phake::anyParameters())->thenCallParent();
    }

    public function successScenariosDataProvider()
    {
        return [
        //  key,                      index, parsed key,     parsed index, value
            ['1st ' . StoreTest::KEY,  null, StoreTest::KEY,            0, StoreTest::FIRST_VALUE       ], // key with nth
            ['2nd ' . StoreTest::KEY,  null, StoreTest::KEY,            1, StoreTest::SECOND_VALUE      ], // key with nth
            [StoreTest::KEY,           null, StoreTest::KEY,         null, StoreTest::MOST_RECENT_VALUE ], // key without nth
            [StoreTest::KEY,              0, StoreTest::KEY,            0, StoreTest::FIRST_VALUE       ], // with index
            [StoreTest::KEY,              1, StoreTest::KEY,            1, StoreTest::SECOND_VALUE      ], // with index
        ];
    }

    public function parseExceptionDataProvider()
    {
        return [
        //   key,                     index, value, exception class,                 exception message
            ['1st ' . StoreTest::KEY,     1, null,  InvalidArgumentException::class, "1 was provided for index param when key '1st " . StoreTest::KEY . "' contains an nth value, but they do not match"],
        ];
    }

    public function keyExistsExceptionDataProvider()
    {
        return [
        //   key,                     index, parsed key,     parsed index, value, exception class,             exception message
            ['3rd ' . StoreTest::KEY,  null, StoreTest::KEY,            2, null,  OutOfBoundsException::class, "Entry '3rd " . StoreTest::KEY . "' was not found in the store." ],
            ['No Such Key',            null, StoreTest::KEY,            0, null,  OutOfBoundsException::class, "Entry 'No Such Key' was not found in the store."                ],
        ];
    }

    public function keyValueIsExceptionDataProvider()
    {
        return [
        //   key,                     index, parsed key,     parsed index, built key,               value,                   exception class,         exception message
            ['1st ' . StoreTest::KEY,  null, StoreTest::KEY,            0, '1st ' . StoreTest::KEY, StoreTest::SECOND_VALUE, RuntimeException::class, "Entry '1st " . StoreTest::KEY . "' does not match '" . StoreTest::SECOND_VALUE . "'" ],
            ['2nd ' . StoreTest::KEY,  null, StoreTest::KEY,            1, '2nd ' . StoreTest::KEY, StoreTest::FIRST_VALUE,  RuntimeException::class, "Entry '2nd " . StoreTest::KEY . "' does not match '" . StoreTest::FIRST_VALUE . "'"  ],
        ];
    }

    /**
     * Executes a success scenario against the method.
     *
     * @dataProvider successScenariosDataProvider
     * @param string $key         the key to pass to the method.
     * @param mixed  $value       the value to pass to the method.
     * @param string $parsedKey   the key that the mocked parsed method should return.
     * @param int    $parsedIndex the index that the mocked parsed method should return.
     * @param int    $index       the index to pass to the method.
     */
    public function testSuccessScenario($key, $index, $parsedKey, $parsedIndex, $value)
    {
        /* @noinspection PhpUndefinedMethodInspection */
        {
            Phake::when($this->key)->parse($key, $index)->thenReturn([$parsedKey, $parsedIndex]);
            Phake::when(/** @scrutinizer ignore-type */ $this->key)->parse($key, $index)->thenReturn([$parsedKey, $parsedIndex]);
            Phake::when($this->assert)->keyExists($parsedKey, $parsedIndex)->thenReturn(true);
            Phake::when(/** @scrutinizer ignore-type */ $this->assert)->keyExists($parsedKey, $parsedIndex)->thenReturn(true);
            Phake::when($this->store)->get($parsedKey, $parsedIndex)->thenReturn($value);
            Phake::when(/** @scrutinizer ignore-type */ $this->store)->get($parsedKey, $parsedIndex)->thenReturn($value);
        }

        $this->assert->KeyValueIs($key, $value, $index);
                       KeyValueIs($key, $value, $index);
    }

    /**
     * Executes a failure scenario caused by the parse method.
     *
     * @dataProvider parseExceptionDataProvider
     * @param string $key              the key to pass to the method.
     * @param int    $index            the index to pass to the method.
     * @param mixed  $value            the value to pass to the method.
     * @param string $exceptionClass   the expected class of the exception.
     * @param string $exceptionMessage the expected message of the exception.
     */
    public function testParseExceptionScenario($key, $index, $value, $exceptionClass, $exceptionMessage)
    {
        /* @noinspection PhpUndefinedMethodInspection */
        {
            Phake::when($this->key)->parse($key, $index)->thenThrow(new $exceptionClass($exceptionMessage));
            Phake::when(/** @scrutinizer ignore-type */ $this->key)->parse($key, $index)->thenThrow(new $exceptionClass($exceptionMessage));
        }

        $this->expectException($exceptionClass);
        $this->expectExceptionMessage($exceptionMessage);

        /* @noinspection PhpUnhandledExceptionInspection */
        $this->assert->keyValueIs($key, $value, $index);
                       keyValueIs($key, $value, $index);
    }

    /**
     * Executes a failure scenario caused by the keyExists method on the store.
     *
     * @dataProvider keyExistsExceptionDataProvider
     * @param string $key              the key to pass to the method.
     * @param int    $index            the index to pass to the method.
     * @param string $parsedKey        the key that the mocked parsed method should return.
     * @param int    $parsedIndex      the index that the mocked parsed method should return.
     * @param mixed  $value            the value to pass to the method.
     * @param string $exceptionClass   the expected class of the exception.
     * @param string $exceptionMessage the expected message of the exception.
     */
    public function testKeyExistsExceptionScenario($key, $index, $parsedKey, $parsedIndex, $value, $exceptionClass, $exceptionMessage)
    {
        /* @noinspection PhpUndefinedMethodInspection */
        {
            Phake::when($this->key)->parse($key, $index)->thenReturn([$parsedKey, $parsedIndex]);
            Phake::when(/** @scrutinizer ignore-type */ $this->key)->parse($key, $index)->thenReturn([$parsedKey, $parsedIndex]);
            Phake::when($this->assert)->keyExists($parsedKey, $parsedIndex)->thenThrow(new $exceptionClass($exceptionMessage));
            Phake::when(/** @scrutinizer ignore-type */ $this->assert)->keyExists($parsedKey, $parsedIndex)->thenThrow(new $exceptionClass($exceptionMessage));
        }

        $this->expectException($exceptionClass);
        $this->expectExceptionMessage($exceptionMessage);

        /* @noinspection PhpUnhandledExceptionInspection */
        $this->assert->keyValueIs($key, $value, $index);
    }

    /**
     * Executes a failure scenario caused by the keyExists method on the store.
     *
     * @dataProvider keyValueIsExceptionDataProvider
     * @param string $key              the key to pass to the method.
     * @param int    $index            the index to pass to the method.
     * @param string $parsedKey        the key that the mocked parsed method should return.
     * @param int    $parsedIndex      the index that the mocked parsed method should return.
     * @param mixed  $value            the value to pass to the method.
     * @param string $exceptionClass   the expected class of the exception.
     * @param string $exceptionMessage the expected message of the exception.
     */
    public function testKeyValueIsExceptionScenario($key, $index, $parsedKey, $parsedIndex, $builtKey, $value, $exceptionClass, $exceptionMessage)
    {
        /* @noinspection PhpUndefinedMethodInspection */
        {
            Phake::when($this->key)->parse($key, $index)->thenReturn([$parsedKey, $parsedIndex]);
            Phake::when(/** @scrutinizer ignore-type */ $this->key)->parse($key, $index)->thenReturn([$parsedKey, $parsedIndex]);
            Phake::when($this->assert)->keyExists($parsedKey, $parsedIndex)->thenReturn(true);
            Phake::when(/** @scrutinizer ignore-type */ $this->assert)->keyExists($parsedKey, $parsedIndex)->thenReturn(true);
            Phake::when($this->store)->get($parsedKey, $parsedIndex)->thenReturn('Something other than $value');
            Phake::when(/** @scrutinizer ignore-type */ $this->store)->get($parsedKey, $parsedIndex)->thenReturn('Something other than $value');
            Phake::when($this->key)->build($parsedKey, $parsedIndex)->thenReturn($builtKey);
        }

        $this->expectException($exceptionClass);
        $this->expectExceptionMessage($exceptionMessage);

        /* @noinspection PhpUnhandledExceptionInspection */
        $this->assert->keyValueIs($key, $value, $index);
    }
}

Chekote / noun-store

Branch — scrutinizer_new_php_analysis (b739aa)

KeyValueIsTest::testKeyValueIsExceptionScenario() A

Complexity

Size

Duplication

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like
