GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.

Job::annotations()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 10
Code Lines 6

Duplication

Lines 10
Ratio 100 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 10
loc 10
rs 9.4285
c 0
b 0
f 0
ccs 0
cts 3
cp 0
cc 1
eloc 6
nc 1
nop 0
crap 2
1
<?php declare(strict_types=1);
2
3
namespace WyriHaximus\Travis\Resource\Sync;
4
5
use ApiClients\Foundation\Hydrator\CommandBus\Command\BuildAsyncFromSyncCommand;
6
use Rx\React\Promise;
7
use WyriHaximus\Travis\Resource\Job as BaseJob;
8
use WyriHaximus\Travis\Resource\JobInterface;
9
10 View Code Duplication
class Job extends BaseJob
0 ignored issues
show
Duplication introduced by
This class seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
11
{
12
    /**
13
     * @return array
14
     */
15
    public function annotations(): array
16
    {
17
        return $this->wait(
18
            $this->handleCommand(
19
                new BuildAsyncFromSyncCommand(self::HYDRATE_CLASS, $this)
20
            )->then(function (JobInterface $job) {
21
                return Promise::fromObservable($job->annotations());
0 ignored issues
show
Bug introduced by
The method annotations() does not exist on WyriHaximus\Travis\Resource\JobInterface. Did you maybe mean annotationIds()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
22
            })
23
        );
24
    }
25
26
    public function refresh() : Job
27
    {
28
        return $this->wait($this->handleCommand(
29
            new BuildAsyncFromSyncCommand(self::HYDRATE_CLASS, $this)
30
        )->then(function (JobInterface $job) {
31
            return $job->refresh();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface WyriHaximus\Travis\Resource\JobInterface as the method refresh() does only exist in the following implementations of said interface: WyriHaximus\Travis\Resource\Async\Job, WyriHaximus\Travis\Resource\Sync\Job.

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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
32
        }));
33
    }
34
}
35