OptionalTest - Code Metrics - Inspection of "Merge pull request #43 from Ocramius/dependabot/co..." - Ocramius/ocramius.util.Optional - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b367d7...03bf23 )

by Marco

created 2020-06-26 13:43 UTC

OptionalTest B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	413
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
wmc	45
lcom	1
cbo	2
dl	0
loc	413
rs	8.8
c	0
b	0
f	0

29 Methods

Rating	Name	Size	Complexity
A	testNewEmptyAlwaysProducesSameInstance()	4	1
A	testNewEmptyProducesEmptyInstance()	4	1
A	testOfNullableFromEmptyValueProducesAnEmptyInstance()	4	1
A	testOfNullableFromNonEmptyValueProducesNonEmptyInstance()	9	1
A	testOfFromEmptyValueCausesExceptionWhenDisallowed()	6	1
A	testOfFromNonEmptyValueProducesNonEmptyInstance()	9	1
A	testEmptyValueDisallowsGettingWrappedValue()	6	1
A	testIfPresentIsNotExecutedIfValueIsNotPresent()	11	2
A	testIfPresentIsExecutedWhenValueIsPresent()	11	2
A	testFilterIsNotExecutedIfValueIsNotPresent()	11	2
A	testFilteringProducesEmptyOptionalWhenValueIsNotAccepted()	11	2
A	testFilteringProducesSameOptionalInstanceWhenValueIsAccepted()	12	2
A	testMappingEmptyOptionalProducesEmptyOptional()	11	2
A	testMappingNonEmptyValuesProducesOptionalWithMapMethodReturnValue()	15	2
A	testMappingNonEmptyValuesMayProduceEmptyOptional()	11	2
A	testFlatMappingEmptyOptionalProducesEmptyOptional()	11	2
A	testFlatMappingNonEmptyOptionalProducesNonEmptyOptional()	12	2
A	testFlatMappingNonEmptyOptionalDisallowsEmptyMapperResult()	13	2
A	testOrElseRetrievesGivenValueOnEmptyOptional()	4	1
A	testOrElseRetrievesOptionalValueWhenValueIsPresent()	4	1
A	testOrElseGetRetrievesCallableReturnValueOnEmptyOptional()	11	2
A	testOrElseThrowRetrievesGivenValueWhenValueIsAvailable()	11	2
A	testOrElseThrowThrowsExceptionOnEmptyOptional()	18	3
A	testOrElseGetRetrievesOptionalValueIfValueIsPresent()	11	2
A	testInequality()	10	1
A	testEquals()	4	1
A	testInequalityWithEmptyOptional()	5	1
A	testStringCast()	5	1
A	getValidValues()	13	1

How to fix Complexity

<?php

declare(strict_types=1);

namespace ocramius\utilTest;

use Exception;
use ocramius\util\exception\NoSuchElementException;
use ocramius\util\exception\NullPointerException;
use ocramius\util\Optional;
use PHPUnit\Framework\TestCase;
use ReflectionException;
use stdClass;
use Throwable;

use function assert;
use function is_callable;

/**
 * Tests for {@see \ocramius\util\Optional}
 *
 * @covers \ocramius\util\Optional
 */
class OptionalTest extends TestCase
{
    public function testNewEmptyAlwaysProducesSameInstance(): void
    {
        $this->assertSame(Optional::newEmpty(), Optional::newEmpty());
    }

    public function testNewEmptyProducesEmptyInstance(): void
    {
        $this->assertFalse(Optional::newEmpty()->isPresent());
    }

    public function testOfNullableFromEmptyValueProducesAnEmptyInstance(): void
    {
        $this->assertSame(Optional::newEmpty(), Optional::ofNullable(null));
    }

    /**
     * @param mixed $value
     *
     * @dataProvider getValidValues
     */
    public function testOfNullableFromNonEmptyValueProducesNonEmptyInstance($value): void
    {
        $optional = Optional::ofNullable($value);

        $this->assertNotSame(Optional::newEmpty(), $optional);

        $this->assertTrue($optional->isPresent());
        $this->assertSame($value, $optional->get());
    }

    public function testOfFromEmptyValueCausesExceptionWhenDisallowed(): void
    {
        $this->expectException(NullPointerException::class);

        Optional::of(null);
    }

    /**
     * @param mixed $value
     *
     * @dataProvider getValidValues
     */
    public function testOfFromNonEmptyValueProducesNonEmptyInstance($value): void
    {
        $optional = Optional::of($value);

        $this->assertNotSame(Optional::newEmpty(), $optional);

        $this->assertTrue($optional->isPresent());
        $this->assertSame($value, $optional->get());
    }

    public function testEmptyValueDisallowsGettingWrappedValue(): void
    {
        $this->expectException(NoSuchElementException::class);

        Optional::newEmpty()->get();
    }

    /**
     * @throws ReflectionException
     */
    public function testIfPresentIsNotExecutedIfValueIsNotPresent(): void
    {
        $neverCalled = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($neverCalled) || $neverCalled instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $neverCalled->expects($this->never())->method('__invoke');

        Optional::newEmpty()->ifPresent($neverCalled);
    }

    /**
     * @param mixed $value
     *
     * @throws ReflectionException
     *
     * @dataProvider getValidValues
     */
    public function testIfPresentIsExecutedWhenValueIsPresent($value): void
    {
        $calledOnce = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($calledOnce) || $calledOnce instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $calledOnce->expects($this->once())->method('__invoke')->with($value);

        Optional::of($value)->ifPresent($calledOnce);
    }

    /**
     * @throws ReflectionException
     */
    public function testFilterIsNotExecutedIfValueIsNotPresent(): void
    {
        $neverCalled = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($neverCalled) || $neverCalled instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $neverCalled->expects($this->never())->method('__invoke');

        $this->assertSame(Optional::newEmpty(), Optional::newEmpty()->filter($neverCalled));
    }

    /**
     * @param mixed $value
     *
     * @throws ReflectionException
     *
     * @dataProvider getValidValues
     */
    public function testFilteringProducesEmptyOptionalWhenValueIsNotAccepted($value): void
    {
        $falseFilter = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($falseFilter) || $falseFilter instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $falseFilter->expects($this->once())->method('__invoke')->with($value)->will($this->returnValue(false));

        $this->assertSame(Optional::newEmpty(), Optional::of($value)->filter($falseFilter));
    }

    /**
     * @param mixed $value
     *
     * @throws ReflectionException
     *
     * @dataProvider getValidValues
     */
    public function testFilteringProducesSameOptionalInstanceWhenValueIsAccepted($value): void
    {
        $falseFilter = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($falseFilter) || $falseFilter instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}
        $optional = Optional::of($value);

        $falseFilter->expects($this->once())->method('__invoke')->with($value)->will($this->returnValue(true));

        $this->assertSame($optional, $optional->filter($falseFilter));
    }

    /**
     * @throws ReflectionException
     */
    public function testMappingEmptyOptionalProducesEmptyOptional(): void
    {
        $neverCalled = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($neverCalled) || $neverCalled instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $neverCalled->expects($this->never())->method('__invoke');

        $this->assertSame(Optional::newEmpty(), Optional::newEmpty()->map($neverCalled));
    }

    /**
     * @param mixed $value
     *
     * @throws ReflectionException
     *
     * @dataProvider getValidValues
     */
    public function testMappingNonEmptyValuesProducesOptionalWithMapMethodReturnValue($value): void
    {
        $mappedValue = new stdClass();
        $mapper      = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($mapper) || $mapper instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $mapper->expects($this->once())->method('__invoke')->with($value)->will($this->returnValue($mappedValue));

        $optional = Optional::of($value)->map($mapper);

        $this->assertNotSame(Optional::newEmpty(), $optional);
        $this->assertSame($mappedValue, $optional->get());
    }

    /**
     * @throws ReflectionException
     */
    public function testMappingNonEmptyValuesMayProduceEmptyOptional(): void
    {
        $mapper = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($mapper) || $mapper instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $mapper->expects($this->once())->method('__invoke')->will($this->returnValue(null));

        $this->assertSame(Optional::newEmpty(), Optional::of(new stdClass())->map($mapper));
    }

    /**
     * @throws ReflectionException
     */
    public function testFlatMappingEmptyOptionalProducesEmptyOptional(): void
    {
        $neverCalled = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($neverCalled) || $neverCalled instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $neverCalled->expects($this->never())->method('__invoke');

        $this->assertSame(Optional::newEmpty(), Optional::newEmpty()->flatMap($neverCalled));
    }

    /**
     * @param mixed $value
     *
     * @throws ReflectionException
     *
     * @dataProvider getValidValues
     */
    public function testFlatMappingNonEmptyOptionalProducesNonEmptyOptional($value): void
    {
        $mappedValue = Optional::ofNullable(new stdClass());
        $mapper      = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($mapper) || $mapper instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $mapper->expects($this->once())->method('__invoke')->with($value)->will($this->returnValue($mappedValue));

        $this->assertSame($mappedValue, Optional::of($value)->flatMap($mapper));
    }

    /**
     * @throws ReflectionException
     */
    public function testFlatMappingNonEmptyOptionalDisallowsEmptyMapperResult(): void
    {
        $mapper = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($mapper) || $mapper instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $mapper->expects($this->once())->method('__invoke')->will($this->returnValue(null));

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

        Optional::of(new stdClass())->flatMap($mapper);
    }

    /**
     * @param mixed $value
     *
     * @dataProvider getValidValues
     */
    public function testOrElseRetrievesGivenValueOnEmptyOptional($value): void
    {
        $this->assertSame($value, Optional::newEmpty()->orElse($value));
    }

    /**
     * @param mixed $value
     *
     * @dataProvider getValidValues
     */
    public function testOrElseRetrievesOptionalValueWhenValueIsPresent($value): void
    {
        $this->assertSame($value, Optional::of($value)->orElse(new stdClass()));
    }

    /**
     * @param mixed $value
     *
     * @throws ReflectionException
     *
     * @dataProvider getValidValues
     */
    public function testOrElseGetRetrievesCallableReturnValueOnEmptyOptional($value): void
    {
        $fallback = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($fallback) || $fallback instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $fallback->expects($this->once())->method('__invoke')->will($this->returnValue($value));

        $this->assertSame($value, Optional::newEmpty()->orElseGet($fallback));
    }

    /**
     * @param mixed $value
     *
     * @throws ReflectionException
     * @throws Exception
     *
     * @dataProvider getValidValues
     */
    public function testOrElseThrowRetrievesGivenValueWhenValueIsAvailable($value): void
    {
        $exceptionFactory = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($exceptionFactory) || $exceptionFactory instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $exceptionFactory->expects($this->never())->method('__invoke');

        $this->assertSame($value, Optional::of($value)->orElseThrow($exceptionFactory));
    }

    /**
     * @throws ReflectionException
     */
    public function testOrElseThrowThrowsExceptionOnEmptyOptional(): void
    {
        $exception        = new Exception();
        $exceptionFactory = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($exceptionFactory) || $exceptionFactory instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $exceptionFactory->expects($this->once())->method('__invoke')->will($this->returnValue($exception));

        try {
            Optional::newEmpty()->orElseThrow($exceptionFactory);

            $this->fail('No exception was thrown, expected Optional#orElseThrow() to throw one');
        } catch (Throwable $caught) {
            $this->assertSame($exception, $caught);
        }
    }

    /**
     * @param mixed $value
     *
     * @throws ReflectionException
     *
     * @dataProvider getValidValues
     */
    public function testOrElseGetRetrievesOptionalValueIfValueIsPresent($value): void
    {
        $fallback = $this->getMockBuilder(stdClass::class)

            ->setMethods(['__invoke'])
            ->getMock();
        assert(is_callable($fallback) || $fallback instanceof MockObject);
if ($x instanceof DoesNotExist) {
    // Do something.
}

        $fallback->expects($this->never())->method('__invoke');

        $this->assertSame($value, Optional::of($value)->orElseGet($fallback));
    }

    public function testInequality(): void
    {
        $value1 = new stdClass();
        $value2 = new stdClass();

        $this->assertFalse(Optional::of($value1)->equals(Optional::of($value2)));
        $this->assertFalse(Optional::of($value1)->equals($value1));
        $this->assertFalse(Optional::of($value1)->equals('foo'));
        $this->assertTrue(Optional::newEmpty()->equals(Optional::newEmpty()));
    }

    /**
     * @param mixed $value
     *
     * @dataProvider getValidValues
     */
    public function testEquals($value): void
    {
        $this->assertTrue(Optional::of($value)->equals(Optional::of($value)));
    }

    /**
     * @param mixed $value
     *
     * @dataProvider getValidValues
     */
    public function testInequalityWithEmptyOptional($value): void
    {
        $this->assertFalse(Optional::of($value)->equals(Optional::newEmpty()));
        $this->assertFalse(Optional::newEmpty()->equals(Optional::of($value)));
    }

    public function testStringCast(): void
    {
        $this->assertSame('Optional.empty', (string) Optional::newEmpty());
        $this->assertSame('Optional[foo]', (string) Optional::of('foo'));
    }

    /**
     * Data provider: provides valid Optional values
     *
     * @return mixed[][]
     *
     * @throws ReflectionException
     */
    public function getValidValues(): array
    {
        return [
            [new stdClass()],
            [$this->createMock(stdClass::class)],
            [''],
            ['foo'],
            [123],
            [123.456],
            [['foo', 'bar']],
            [[]],
        ];
    }
}


Push — master ( b367d7...03bf23 )

OptionalTest B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

29 Methods

How to fix Complexity

Complex Class

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			declare(strict_types=1);
4
5			namespace ocramius\utilTest;
6
7			use Exception;
8			use ocramius\util\exception\NoSuchElementException;
9			use ocramius\util\exception\NullPointerException;
10			use ocramius\util\Optional;
11			use PHPUnit\Framework\TestCase;
12			use ReflectionException;
13			use stdClass;
14			use Throwable;
15
16			use function assert;
17			use function is_callable;
18
19			/**
20			* Tests for {@see \ocramius\util\Optional}
21			*
22			* @covers \ocramius\util\Optional
23			*/
24			class OptionalTest extends TestCase
25			{
26			public function testNewEmptyAlwaysProducesSameInstance(): void
27			{
28			$this->assertSame(Optional::newEmpty(), Optional::newEmpty());
29			}
30
31			public function testNewEmptyProducesEmptyInstance(): void
32			{
33			$this->assertFalse(Optional::newEmpty()->isPresent());
34			}
35
36			public function testOfNullableFromEmptyValueProducesAnEmptyInstance(): void
37			{
38			$this->assertSame(Optional::newEmpty(), Optional::ofNullable(null));
39			}
40

Ocramius / ocramius.util.Optional

Push — master ( b367d7...03bf23 )

OptionalTest B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

29 Methods

How to fix Complexity

Complex Class

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like