JobExchangePublishMapper::mapMethod() - Code Metrics - Inspection of "Added basic abillity to publish messages to exchan..." - mcorten/rabbitmq_api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3f58aa...01cbeb )

by Mathijs

created 2017-01-23 11:22 UTC

JobExchangePublishMapper::mapMethod() A

↳ Parent: JobExchangePublishMapper

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

namespace mcorten87\rabbitmq_api\mappers;

use mcorten87\rabbitmq_api\jobs\JobBase;
use mcorten87\rabbitmq_api\jobs\JobExchangeDelete;
use mcorten87\rabbitmq_api\jobs\JobExchangeList;
use mcorten87\rabbitmq_api\jobs\JobExchangePublish;
use mcorten87\rabbitmq_api\jobs\JobUserList;
use mcorten87\rabbitmq_api\objects\Method;
use mcorten87\rabbitmq_api\objects\Url;
use mcorten87\rabbitmq_api\services\MqManagementConfig;

class JobExchangePublishMapper  extends BaseMapper

{

    protected function mapMethod() : Method {
        return new Method(Method::METHOD_POST);
    }

    /**
     * @param JobExchangeDelete $job
     * @return Url
     */
    protected function mapUrl(JobBase $job) : Url {
        if (!$job instanceof JobExchangePublish) {
            throw new WrongArgumentException($job, JobExchangePublish::class);
        }

        $url = 'exchanges';
        $url .= '/'.urlencode($job->getVirtualHost());
        $url .= '/'.urlencode($job->getExchangeName());
        $url .= '/publish';
        return new Url($url);
    }

    /**
     * @param JobExchangePublish $job
     * @return array
     */
    protected function mapConfig(JobBase $job) : array {
        $body = [
            'payload' => (string)$job->getMessage(),
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            'payload_encoding' => 'string', // TODO
            'routing_key' => (string)$job->getRoutingKey(),
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            'properties' => [
                'delivery_mode' =>  (int)$job->getDeliveryMode(),
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
                'headers' => []         // TODO
            ]
        ];

        return array_merge(parent::mapConfig($job), [
            'json'      =>  $body,
        ]);
    }
}


Push — master ( 3f58aa...01cbeb )

JobExchangePublishMapper::mapMethod() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			namespace mcorten87\rabbitmq_api\mappers;
4
5			use mcorten87\rabbitmq_api\jobs\JobBase;
6			use mcorten87\rabbitmq_api\jobs\JobExchangeDelete;
7			use mcorten87\rabbitmq_api\jobs\JobExchangeList;
8			use mcorten87\rabbitmq_api\jobs\JobExchangePublish;
9			use mcorten87\rabbitmq_api\jobs\JobUserList;
10			use mcorten87\rabbitmq_api\objects\Method;
11			use mcorten87\rabbitmq_api\objects\Url;
12			use mcorten87\rabbitmq_api\services\MqManagementConfig;
13
14			class JobExchangePublishMapper extends BaseMapper
			0 ignored issues – show Coding Style introduced 2017-01-23 11:27 UTC by Report Bug Copy Issue Report Expected 1 space after class name; 2 found Loading history... Coding Style introduced 2017-01-23 11:27 UTC by Report Bug Copy Issue Report Expected 1 space before extends keyword; 2 found Loading history...
15			{
16
17			protected function mapMethod() : Method {
18			return new Method(Method::METHOD_POST);
19			}
20
21			/**
22			* @param JobExchangeDelete $job
23			* @return Url
24			*/
25			protected function mapUrl(JobBase $job) : Url {
26			if (!$job instanceof JobExchangePublish) {
27			throw new WrongArgumentException($job, JobExchangePublish::class);
28			}
29
30			$url = 'exchanges';
31			$url .= '/'.urlencode($job->getVirtualHost());
32			$url .= '/'.urlencode($job->getExchangeName());
33			$url .= '/publish';
34			return new Url($url);
35			}
36
37			/**
38			* @param JobExchangePublish $job
39			* @return array
40			*/
41			protected function mapConfig(JobBase $job) : array {
42			$body = [
43			'payload' => (string)$job->getMessage(),
			0 ignored issues – show Bug introduced 2017-01-23 11:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `mcorten87\rabbitmq_api\jobs\JobBase` as the method `getMessage()` does only exist in the following sub-classes of `mcorten87\rabbitmq_api\jobs\JobBase`: `mcorten87\rabbitmq_api\jobs\JobExchangePublish`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
44			'payload_encoding' => 'string', // TODO
45			'routing_key' => (string)$job->getRoutingKey(),
			0 ignored issues – show Bug introduced 2017-01-23 11:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `mcorten87\rabbitmq_api\jobs\JobBase` as the method `getRoutingKey()` does only exist in the following sub-classes of `mcorten87\rabbitmq_api\jobs\JobBase`: `mcorten87\rabbitmq_api\j...BindingToExchangeCreate`, `mcorten87\rabbitmq_api\j...BindingToExchangeDelete`, `mcorten87\rabbitmq_api\j...JobBindingToQueueCreate`, `mcorten87\rabbitmq_api\j...JobBindingToQueueDelete`, `mcorten87\rabbitmq_api\jobs\JobExchangePublish`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
46			'properties' => [
47			'delivery_mode' => (int)$job->getDeliveryMode(),
			0 ignored issues – show Bug introduced 2017-01-23 11:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `mcorten87\rabbitmq_api\jobs\JobBase` as the method `getDeliveryMode()` does only exist in the following sub-classes of `mcorten87\rabbitmq_api\jobs\JobBase`: `mcorten87\rabbitmq_api\jobs\JobExchangePublish`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
48			'headers' => [] // TODO
49			]
50			];
51
52			return array_merge(parent::mapConfig($job), [
53			'json' => $body,
54			]);
55			}
56			}
57

mcorten / rabbitmq_api

Push — master ( 3f58aa...01cbeb )

JobExchangePublishMapper::mapMethod() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like