IteratorApplySalesman::__invoke() - Code Metrics - Inspection of "Merge branch 'release/2.1.1'" - GermaniaKG/Salesmen - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Push — master ( c03d3f...88f4a8 )

by Carsten

created 2018-02-08 12:23 UTC

IteratorApplySalesman::__invoke() A

↳ Parent: IteratorApplySalesman

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	1

<?php
namespace Germania\Salesmen;

/**
 * IteratorApplySalesman
 *
 * Usage:
 *
 *     <?php
 *     $salesman_name_factory = function( $retailer ) { return "First name" };
 *
 *     $retailers = new \ArrayIterator([ instance1, instance2 ]);
 *     iterator_apply($retailers, new IteratorApplySalesman( $salesman_name_factory ), [ $retailers ]);
 */
class IteratorApplySalesman
{

    /**
     * @var Callable
     */
    public $salesman_factory;


    /**
     * @var Callable
     */
    public $apply;


    /**
     * @param callable          $salesman_factory  Callable that takes a Salesman ID and returns a Salesman instance.
     * @param SalesmanInterface $salesman_fallback Optional SalesmanInterface fallback instance
     * @param callable          $apply             Optional Callable that takes the current item on iteration.
     */
    public function __construct( callable $salesman_factory, SalesmanInterface $salesman_fallback = null, callable $apply = null )
    {
        $this->salesman_factory = $salesman_factory;
        $this->apply = $apply ?: new ApplySalesman( $salesman_factory, $salesman_fallback );
    }


    /**
     * Must return TRUE, according to PHP's iterator_applay.
     *
     * @see  http://php.net/manual/de/function.iterator-apply.php
     */
    public function __invoke( \Traversable $iterator )
    {

        $current = ($iterator instanceOf \IteratorAggregate)
        ? $iterator->getIterator()->current()
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.
    }
}
        : $iterator->current();
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.
    }
}

        // Perform
        $apply = $this->apply;
        $apply( $current );

        // Must return true for iterator_apply
        return true;
    }


}


1			<?php
2			namespace Germania\Salesmen;
3
4			/**
5			* IteratorApplySalesman
6			*
7			* Usage:
8			*
9			* <?php
10			* $salesman_name_factory = function( $retailer ) { return "First name" };
11			*
12			* $retailers = new \ArrayIterator([ instance1, instance2 ]);
13			* iterator_apply($retailers, new IteratorApplySalesman( $salesman_name_factory ), [ $retailers ]);
14			*/
15			class IteratorApplySalesman
16			{
17
18			/**
19			* @var Callable
20			*/
21			public $salesman_factory;
22
23
24			/**
25			* @var Callable
26			*/
27			public $apply;
28
29
30			/**
31			* @param callable $salesman_factory Callable that takes a Salesman ID and returns a Salesman instance.
32			* @param SalesmanInterface $salesman_fallback Optional SalesmanInterface fallback instance
33			* @param callable $apply Optional Callable that takes the current item on iteration.
34			*/
35			public function __construct( callable $salesman_factory, SalesmanInterface $salesman_fallback = null, callable $apply = null )
36			{
37			$this->salesman_factory = $salesman_factory;
38			$this->apply = $apply ?: new ApplySalesman( $salesman_factory, $salesman_fallback );
39			}
40
41
42			/**
43			* Must return TRUE, according to PHP's iterator_applay.
44			*
45			* @see http://php.net/manual/de/function.iterator-apply.php
46			*/
47			public function __invoke( \Traversable $iterator )
48			{
49
50			$current = ($iterator instanceOf \IteratorAggregate)
51			? $iterator->getIterator()->current()
			0 ignored issues – show Bug introduced 2018-02-08 12:26 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Traversable` as the method `current()` does only exist in the following implementations of said interface: `APCUIterator`, `AppendIterator`, `ArrayIterator`, `CachingIterator`, `CallbackFilterIterator`, `DirectoryIterator`, `EmptyIterator`, `File_Iterator`, `FilesystemIterator`, `FilterIterator`, `Generator`, `Germania\Retailers\RetailerFilterIterator`, `Germania\Salesmen\SalesmanFilterIterator`, `GlobIterator`, `Guzzle\Iterator\AppendIterator`, `Guzzle\Iterator\ChunkedIterator`, `Guzzle\Iterator\FilterIterator`, `Guzzle\Iterator\MapIterator`, `Guzzle\Iterator\MethodProxyIterator`, `Guzzle\Service\Resource\ResourceIterator`, `Guzzle\Tests\Service\Moc...del\MockCommandIterator`, `HttpMessage`, `HttpRequestPool`, `Imagick`, `ImagickPixelIterator`, `InfiniteIterator`, `Issue523`, `IteratorIterator`, `LimitIterator`, `MongoCommandCursor`, `MongoCursor`, `MongoGridFSCursor`, `MultipleIterator`, `NoRewindIterator`, `PHPUnit\Framework\TestSuiteIterator`, `PHPUnit\Runner\Filter\ExcludeGroupFilterIterator`, `PHPUnit\Runner\Filter\GroupFilterIterator`, `PHPUnit\Runner\Filter\IncludeGroupFilterIterator`, `PHPUnit\Runner\Filter\NameFilterIterator`, `PHP_Token_Stream`, `ParentIterator`, `Phar`, `PharData`, `PharIo\Manifest\AuthorCollectionIterator`, `PharIo\Manifest\AuthorElementCollection`, `PharIo\Manifest\BundledComponentCollectionIterator`, `PharIo\Manifest\ComponentElementCollection`, `PharIo\Manifest\ElementCollection`, `PharIo\Manifest\ExtElementCollection`, `PharIo\Manifest\RequirementCollectionIterator`, `RecursiveArrayIterator`, `RecursiveCachingIterator`, `RecursiveCallbackFilterIterator`, `RecursiveDirectoryIterator`, `RecursiveFilterIterator`, `RecursiveIteratorIterator`, `RecursiveRegexIterator`, `RecursiveTreeIterator`, `RegexIterator`, `SQLiteResult`, `SebastianBergmann\CodeCoverage\Node\Iterator`, `SimpleXMLIterator`, `SplDoublyLinkedList`, `SplFileObject`, `SplFixedArray`, `SplHeap`, `SplMaxHeap`, `SplMinHeap`, `SplObjectStorage`, `SplPriorityQueue`, `SplQueue`, `SplStack`, `SplTempFileObject`, `TestIterator`, `TestIterator2`, `TheSeer\Tokenizer\TokenCollection`. 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...
52			: $iterator->current();
			0 ignored issues – show Bug introduced 2018-02-08 12:26 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Traversable` as the method `current()` does only exist in the following implementations of said interface: `APCUIterator`, `AppendIterator`, `ArrayIterator`, `CachingIterator`, `CallbackFilterIterator`, `DirectoryIterator`, `EmptyIterator`, `File_Iterator`, `FilesystemIterator`, `FilterIterator`, `Generator`, `Germania\Retailers\RetailerFilterIterator`, `Germania\Salesmen\SalesmanFilterIterator`, `GlobIterator`, `Guzzle\Iterator\AppendIterator`, `Guzzle\Iterator\ChunkedIterator`, `Guzzle\Iterator\FilterIterator`, `Guzzle\Iterator\MapIterator`, `Guzzle\Iterator\MethodProxyIterator`, `Guzzle\Service\Resource\ResourceIterator`, `Guzzle\Tests\Service\Moc...del\MockCommandIterator`, `HttpMessage`, `HttpRequestPool`, `Imagick`, `ImagickPixelIterator`, `InfiniteIterator`, `Issue523`, `IteratorIterator`, `LimitIterator`, `MongoCommandCursor`, `MongoCursor`, `MongoGridFSCursor`, `MultipleIterator`, `NoRewindIterator`, `PHPUnit\Framework\TestSuiteIterator`, `PHPUnit\Runner\Filter\ExcludeGroupFilterIterator`, `PHPUnit\Runner\Filter\GroupFilterIterator`, `PHPUnit\Runner\Filter\IncludeGroupFilterIterator`, `PHPUnit\Runner\Filter\NameFilterIterator`, `PHP_Token_Stream`, `ParentIterator`, `Phar`, `PharData`, `PharIo\Manifest\AuthorCollectionIterator`, `PharIo\Manifest\AuthorElementCollection`, `PharIo\Manifest\BundledComponentCollectionIterator`, `PharIo\Manifest\ComponentElementCollection`, `PharIo\Manifest\ElementCollection`, `PharIo\Manifest\ExtElementCollection`, `PharIo\Manifest\RequirementCollectionIterator`, `RecursiveArrayIterator`, `RecursiveCachingIterator`, `RecursiveCallbackFilterIterator`, `RecursiveDirectoryIterator`, `RecursiveFilterIterator`, `RecursiveIteratorIterator`, `RecursiveRegexIterator`, `RecursiveTreeIterator`, `RegexIterator`, `SQLiteResult`, `SebastianBergmann\CodeCoverage\Node\Iterator`, `SimpleXMLIterator`, `SplDoublyLinkedList`, `SplFileObject`, `SplFixedArray`, `SplHeap`, `SplMaxHeap`, `SplMinHeap`, `SplObjectStorage`, `SplPriorityQueue`, `SplQueue`, `SplStack`, `SplTempFileObject`, `TestIterator`, `TestIterator2`, `TheSeer\Tokenizer\TokenCollection`. 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...
53
54			// Perform
55			$apply = $this->apply;
56			$apply( $current );
57
58			// Must return true for iterator_apply
59			return true;
60			}
61
62
63			}
64

GermaniaKG / Salesmen

Push — master ( c03d3f...88f4a8 )

IteratorApplySalesman::__invoke() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like