Puzzle\AMQP\Messages\Message

Complexity

Total Complexity

32

Size/Duplication

Total Lines	230
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Test Coverage

Coverage

98.4%

Importance

Changes

0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
B	initializeAttributes()	0	25	1
A	generateBodyId()	0	9	2
A	addHeader()	0	6	1
A	addHeaders()	0	9	2
A	setAuthor()	0	6	1
A	packAttributes()	0	20	3
A	packHeaders()	0	6	1
A	setAttribute()	0	12	3
A	getAppId()	0	4	1
A	getHeaders()	0	6	1
A	getAttribute()	0	9	2
A	__toString()	0	9	1
A	setExpiration()	0	8	1
B	buildFromReadableMessage()	0	26	4
A	canBeDroppedSilently()	0	4	1
A	disallowSilentDropping()	0	6	1
A	getContentType()	0	4	1
A	getRoutingKey()	0	4	1
A	getBodyInTransportFormat()	0	4	1
A	setBody()	0	7	1
A	updateContentType()	0	4	1

<?php

namespace Puzzle\AMQP\Messages;

use Psr\Log\InvalidArgumentException;
use Puzzle\AMQP\WritableMessage;
use Puzzle\AMQP\ReadableMessage;
use Puzzle\AMQP\Messages\Bodies\NullBody;

class Message implements WritableMessage
{
    use BodySetter;
    
    protected
        $body;
    
    private
        $canBeDroppedSilently,

The visibility should be declared for property $canBeDroppedSilently.

        $headers,
        $attributes;

    public function __construct($routingKey = '')
    {
        $this->body = new NullBody();
        $this->canBeDroppedSilently = true;
        $this->headers = array();
        $this->initializeAttributes();
        $this->setAttribute('routing_key', $routingKey);
    }
    
    private function initializeAttributes()
    {
        $this->attributes = array(
            'routing_key' => null,
            'content_type' => $this->getContentType(),
            'content_encoding' => 'utf8',
            'message_id' => function($timestamp) {
                return sha1($this->getRoutingKey() . $timestamp . $this->generateBodyId() . mt_rand());
            },
            'user_id' => null,
            'app_id' => null,
            'delivery_mode' => self::PERSISTENT,
            'priority' => null,
            'timestamp' => function($timestamp) {
                return $timestamp;
            },
            'expiration' => null,
            'type' => null,
            'reply_to' => null,
            'correlation_id' => null,
            'headers' => function($timestamp) {
                return $this->packHeaders($timestamp);
            },
        );
    }
    
    private function generateBodyId()
    {
        if($this->body instanceof Footprintable)
        {
            return $this->body->footprint();
        }
        
        return uniqid(true);
    }
    
    public function canBeDroppedSilently()
    {
        return $this->canBeDroppedSilently;

The return type of return $this->canBeDroppedSilently; (boolean) is incompatible with the return type declared by the interface Puzzle\AMQP\WritableMessage::canBeDroppedSilently of type integer.

    }
    
    public function disallowSilentDropping()
    {
        $this->canBeDroppedSilently = false;
        
        return $this;
    }

    public function getContentType()
    {
        return $this->body->getContentType();
    }

    public function getRoutingKey()
    {
        return $this->getAttribute('routing_key');
    }

    public function getBodyInTransportFormat()
    {
        return $this->body->asTransported();
    }

    public function setBody(Body $body)
    {
        $this->body = $body;
        $this->updateContentType();
        
        return $this;
    }
    
    private function updateContentType()
    {
        $this->attributes['content_type'] = $this->body->getContentType();
    }

    public function addHeader($headerName, $value)
    {
        $this->headers[$headerName] = $value;

        return $this;
    }

    public function addHeaders(array $headers)
    {
        foreach($headers as $name => $value)
        {
            $this->addHeader($name, $value);
        }

        return $this;
    }

    public function setAuthor($author)
    {
        $this->addHeader('author', $author);

        return $this;
    }

    public function packAttributes($timestamp = false)
    {
        $this->updateContentType();
        
        if($timestamp === false)
        {
            $timestamp = (new \DateTime("now"))->getTimestamp();
        }

        return array_map(function($value) use($timestamp) {

            if($value instanceof \Closure)
            {
                $value = $value($timestamp);
            }

            return $value;

        }, $this->attributes);
    }

    private function packHeaders($timestamp)
    {
        $this->headers['message_datetime'] = date('Y-m-d H:i:s', $timestamp);

        return $this->headers;
    }

    public function setAttribute($attributeName, $value)
    {
        if($attributeName !== 'headers')
        {
            if(array_key_exists($attributeName, $this->attributes))
            {
                $this->attributes[$attributeName] = $value;
            }
        }

        return $this;
    }

    public function getAppId()
    {
        return $this->getAttribute('app_id');
    }

    public function getHeaders()
    {
        $attributes = $this->packAttributes();

        return $attributes['headers'];
    }

    public function getAttribute($attributeName)
    {
        if(array_key_exists($attributeName, $this->attributes))
        {
            return $this->attributes[$attributeName];
        }

        throw new InvalidArgumentException(sprintf('Property "%s" is unknown or is not a message property', $attributeName));
    }

    public function __toString()
    {
        return json_encode(array(
            'routing_key' => $this->getRoutingKey(),
            'body' => (string) $this->body,
            'attributes' => $this->attributes,
            'can be dropped silently' => $this->canBeDroppedSilently
        ));
    }

    public function setExpiration($expirationInSeconds)
    {
        $ttlInMs = 1000 * (int) $expirationInSeconds;

        $this->setAttribute('expiration', (string) $ttlInMs);

        return $this;
    }

    public static function buildFromReadableMessage(ReadableMessage $readableMessage, $newRoutingKey = false)
    {
        $routingKey = $readableMessage->getRoutingKey();

        if($newRoutingKey !== false)
        {
            $routingKey = $newRoutingKey;
        }

        $writableMessage = new static($routingKey);

It seems like $routingKey defined by $newRoutingKey on line 219 can also be of type boolean; however, Puzzle\AMQP\Messages\Message::__construct() does only seem to accept string, maybe add an additional type check?

        $writableMessage->setBody($readableMessage->getBody());

        $writableMessage->addHeaders($readableMessage->getHeaders());

        $attributes = $readableMessage->getAttributes();
        $skippedAttributes = array('timestamp', 'headers', 'app_id', 'routing_key');
        foreach($attributes as $attributeName => $value)
        {
            if(! in_array($attributeName, $skippedAttributes))
            {
                $writableMessage->setAttribute($attributeName, $value);
            }
        }

        return $writableMessage;
    }
}