refinery29/test-util

View on GitHub
src/TestHelper.php

Summary

Maintainability
A
3 hrs
Test Coverage

Method assertClassesSatisfy has 73 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function assertClassesSatisfy(callable $specification, $path, array $excludeDirectories = [], $message = null)
    {
        if (!\is_string($path)) {
            throw new \InvalidArgumentException(\sprintf(
                'Path needs to be specified as a string, got "%s".',
Severity: Major
Found in src/TestHelper.php - About 2 hrs to fix

    Function provideCombinedDataFrom has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        final protected function provideCombinedDataFrom(DataProvider\DataProviderInterface ...$dataProviders)
        {
            /**
             * @link https://stackoverflow.com/a/15973172
             */
    Severity: Minor
    Found in src/TestHelper.php - About 25 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    The method assertClassesSatisfy() has an NPath complexity of 432. The configured NPath complexity threshold is 200.
    Open

        public function assertClassesSatisfy(callable $specification, $path, array $excludeDirectories = [], $message = null)
        {
            if (!\is_string($path)) {
                throw new \InvalidArgumentException(\sprintf(
                    'Path needs to be specified as a string, got "%s".',
    Severity: Minor
    Found in src/TestHelper.php by phpmd

    NPathComplexity

    Since: 0.1

    The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

    Example

    class Foo {
        function bar() {
            // lots of complicated code
        }
    }

    Source https://phpmd.org/rules/codesize.html#npathcomplexity

    The method assertClassesSatisfy() has a Cyclomatic Complexity of 11. The configured cyclomatic complexity threshold is 10.
    Open

        public function assertClassesSatisfy(callable $specification, $path, array $excludeDirectories = [], $message = null)
        {
            if (!\is_string($path)) {
                throw new \InvalidArgumentException(\sprintf(
                    'Path needs to be specified as a string, got "%s".',
    Severity: Minor
    Found in src/TestHelper.php by phpmd

    CyclomaticComplexity

    Since: 0.1

    Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

    Example

    // Cyclomatic Complexity = 11
    class Foo {
    1   public function example() {
    2       if ($a == $b) {
    3           if ($a1 == $b1) {
                    fiddle();
    4           } elseif ($a2 == $b2) {
                    fiddle();
                } else {
                    fiddle();
                }
    5       } elseif ($c == $d) {
    6           while ($c == $d) {
                    fiddle();
                }
    7        } elseif ($e == $f) {
    8           for ($n = 0; $n < $h; $n++) {
                    fiddle();
                }
            } else {
                switch ($z) {
    9               case 1:
                        fiddle();
                        break;
    10              case 2:
                        fiddle();
                        break;
    11              case 3:
                        fiddle();
                        break;
                    default:
                        fiddle();
                        break;
                }
            }
        }
    }

    Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

    Missing class import via use statement (line '138', column '27').
    Open

            $reflection = new \ReflectionClass($childName);
    Severity: Minor
    Found in src/TestHelper.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Missing class import via use statement (line '274', column '31').
    Open

                $reflection = new \ReflectionClass($className);
    Severity: Minor
    Found in src/TestHelper.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Missing class import via use statement (line '220', column '27').
    Open

                    throw new \InvalidArgumentException(\sprintf(
    Severity: Minor
    Found in src/TestHelper.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Missing class import via use statement (line '27', column '23').
    Open

                throw new \InvalidArgumentException('Locale should be a string');
    Severity: Minor
    Found in src/TestHelper.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Missing class import via use statement (line '203', column '23').
    Open

                throw new \InvalidArgumentException(\sprintf(
    Severity: Minor
    Found in src/TestHelper.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Missing class import via use statement (line '227', column '27').
    Open

                    throw new \InvalidArgumentException(\sprintf(
    Severity: Minor
    Found in src/TestHelper.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Missing class import via use statement (line '163', column '27').
    Open

            $reflection = new \ReflectionClass($className);
    Severity: Minor
    Found in src/TestHelper.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Missing class import via use statement (line '114', column '27').
    Open

            $reflection = new \ReflectionClass($className);
    Severity: Minor
    Found in src/TestHelper.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Missing class import via use statement (line '210', column '23').
    Open

                throw new \InvalidArgumentException(\sprintf(
    Severity: Minor
    Found in src/TestHelper.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
        return new \stdClass();
    }

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Avoid using static access to class '\Faker\Factory' in method 'getFaker'.
    Open

                $faker = Factory::create($locale);
    Severity: Minor
    Found in src/TestHelper.php by phpmd

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
    {
        public function bar()
        {
            Bar::baz();
        }
    }

    Source https://phpmd.org/rules/cleancode.html#staticaccess

    Avoid excessively long variable names like $classNamesNotSatisfyingSpecification. Keep variable name length under 20.
    Open

            $classNamesNotSatisfyingSpecification = \array_filter($classNames, function ($className) use ($specification) {
    Severity: Minor
    Found in src/TestHelper.php by phpmd

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
        protected $reallyLongIntName = -3; // VIOLATION - Field
        public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
            $otherReallyLongName = -5; // VIOLATION - Local
            for ($interestingIntIndex = 0; // VIOLATION - For
                 $interestingIntIndex < 10;
                 $interestingIntIndex++ ) {
            }
        }
    }

    Source https://phpmd.org/rules/naming.html#longvariable

    There are no issues that match your filters.

    Category
    Status