Merge pull request #26 from nepster-web/alpha-4

enh: close #22

Author: nepster-web

.gitignore

@@ -4,4 +4,5 @@
 /vendor/
 /.phpunit.result.cache
 /.php_cs.cache
-/docs/tmp/
+/docs/tmp/
+/.coverage.clover

CHANGELOG.md

@@ -19,9 +19,10 @@ A changelog of all notable changes made to this library.
 ----------------------
 
 
-1.0.0-Alpha-4 ???? ??, 2021
+1.0.0-Alpha-4 April 7, 2021
 ---------------------------
-
+- *ENH*: [#22](https://github.com/nepster-web/php-simple-queue/issues/22) - implementation [Context](./src/Context.php) for jobs and processors
+- *ENH*: Improved documentation
 
 
 1.0.0-Alpha-3 March 31, 2021

README.md

@@ -59,24 +59,15 @@ $transport = new \Simple\Queue\Transport\DoctrineDbalTransport($connection);
 ```
 
 
-Create configuration ([see more information](./docs/guide/configuration.md)):
+### Send a new message to queue (producing)
 
 ```php
 $config = \Simple\Queue\Config::getDefault()
-    ->changeRedeliveryTimeInSeconds(100)
-    ->changeNumberOfAttemptsBeforeFailure(3)
-    ->registerJob(MyJob::class, new MyJob())
-    ->registerProcessor('my_queue', static function(\Simple\Queue\Message $message, \Simple\Queue\Producer $producer): string {
-   
+    ->registerProcessor('my_queue', static function(\Simple\Queue\Context $context): string {
         // Your message handling logic
-        
         return \Simple\Queue\Consumer::STATUS_ACK;
     });
-```
-
-### Send a new message to queue (producing)
-
-```php
+    
 $producer = new \Simple\Queue\Producer($transport, $config);
 
 $message = $producer->createMessage('my_queue', ['key' => 'value']);
@@ -88,6 +79,9 @@ $producer->send($message);
 ### Job dispatching (producing)
 
 ```php
+$config = \Simple\Queue\Config::getDefault()
+    ->registerJob(MyJob::class, new MyJob());
+
 $producer = new \Simple\Queue\Producer($transport, $config);
 
 $producer->dispatch(MyJob::class, ['key' => 'value']);

coverage.clover

@@ -81,7 +81,7 @@ class SendInfoToTelegramJob extends \Simple\Queue\Job
         return 5;
     }
 
-    public function handle(\Simple\Queue\Message $message, \Simple\Queue\Producer $producer): string
+    public function handle(\Simple\Queue\Context $context): string
     {
         // your logic 
 

docs/guide/consuming.md

@@ -115,9 +115,7 @@ protected function processing(Message $message): void
         if ($message->isJob()) {
             try {
                 $job = $this->config->getJob($message->getEvent());
-
-                $result = $job->handle($message, $this->producer);
-
+                $result = $job->handle($this->getContext($message));
                 $this->processSuccessResult($result, $message);
             } catch (Throwable $exception) {
                 $this->processFailureResult($exception, $message);
@@ -128,8 +126,7 @@ protected function processing(Message $message): void
 
         if ($this->config->hasProcessor($message->getQueue())) {
             try {
-                $result = $this->config->getProcessor($message->getQueue())($message, $this->producer);
-
+                $result = $this->config->getProcessor($message->getQueue())($this->getContext($message));
                 $this->processSuccessResult($result, $message);
             } catch (Throwable $exception) {
                 $this->processFailureResult($exception, $message);
@@ -205,4 +202,19 @@ protected function processSuccessResult(string $status, Message $message): void
 
         throw new InvalidArgumentException(sprintf('Unsupported result status: "%s".', $status));
     }
+
+    /**
+     * @param Message $message
+     * @return Context
+     */
+    protected function getContext(Message $message): Context
+    {
+        $data = $this->config->getSerializer()->deserialize($message->getBody());
+
+        return new Context(
+            $this->producer,
+            $message,
+            is_array($data) ? $data : [$data]
+        );
+    }
 }

src/Consumer.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Simple\Queue;
+
+/**
+ * Class Context
+ * @package Simple\Queue
+ */
+class Context
+{
+    /** @var Producer */
+    private Producer $producer;
+
+    /** @var array */
+    private array $data;
+
+    /** @var Message */
+    private Message $message;
+
+    /**
+     * Context constructor.
+     * @param Producer $producer
+     * @param Message $message
+     * @param array $data
+     */
+    public function __construct(Producer $producer, Message $message, array $data)
+    {
+        $this->producer = $producer;
+        $this->data = $data;
+        $this->message = $message;
+    }
+
+    /**
+     * @return Producer
+     */
+    public function getProducer(): Producer
+    {
+        return $this->producer;
+    }
+
+    /**
+     * @return Message
+     */
+    public function getMessage(): Message
+    {
+        return $this->message;
+    }
+
+    /**
+     * @return array
+     */
+    public function getData(): array
+    {
+        return $this->data;
+    }
+}

src/Context.php

@@ -11,11 +11,10 @@
 abstract class Job
 {
     /**
-     * @param Message $message
-     * @param Producer $producer
-     * @return mixed
+     * @param Context $context
+     * @return string
      */
-    abstract public function handle(Message $message, Producer $producer): string;
+    abstract public function handle(Context $context): string;
 
     /**
      * @return string

src/Job.php

@@ -6,9 +6,8 @@
 
 use Simple\Queue\Job;
 use Simple\Queue\Config;
-use Simple\Queue\Message;
+use Simple\Queue\Context;
 use Simple\Queue\Consumer;
-use Simple\Queue\Producer;
 use PHPUnit\Framework\TestCase;
 use Simple\Queue\QueueException;
 use Simple\Queue\ConfigException;
@@ -58,14 +57,14 @@ public function testDefaultGetJobs(): void
     public function testSeveralGetJobs(): void
     {
         $job1 = new class extends Job {
-            public function handle(Message $message, Producer $producer): string
+            public function handle(Context $context): string
             {
                 return Consumer::STATUS_ACK;
             }
         };
 
         $job2 = new class extends Job {
-            public function handle(Message $message, Producer $producer): string
+            public function handle(Context $context): string
             {
                 return Consumer::STATUS_ACK;
             }
@@ -99,7 +98,7 @@ public function testHasNotRegistrationJob(): void
     public function testRegistrationJob(): void
     {
         $job = new class extends Job {
-            public function handle(Message $message, Producer $producer): string
+            public function handle(Context $context): string
             {
                 return Consumer::STATUS_ACK;
             }
@@ -119,7 +118,7 @@ public function testRegistrationExistJob(): void
         $this->expectExceptionMessage(sprintf('Job "%s" is already registered.', 'myJob'));
 
         $job = new class extends Job {
-            public function handle(Message $message, Producer $producer): string
+            public function handle(Context $context): string
             {
                 return Consumer::STATUS_ACK;
             }
@@ -136,7 +135,7 @@ public function testRegistrationJobWithIncorrectAlias(): void
         $this->expectExceptionMessage(sprintf('Job alias "%s" contains invalid characters.', '!@#$%^&*()_+'));
 
         $job = new class extends Job {
-            public function handle(Message $message, Producer $producer): string
+            public function handle(Context $context): string
             {
                 return Consumer::STATUS_ACK;
             }
@@ -149,7 +148,7 @@ public function handle(Message $message, Producer $producer): string
     public function testGetAliasInRegistrationJob(): void
     {
         $job = new class extends Job {
-            public function handle(Message $message, Producer $producer): string
+            public function handle(Context $context): string
             {
                 return Consumer::STATUS_ACK;
             }

tests/ConfigTest.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Simple\QueueTest;
+
+use Simple\Queue\Context;
+use Simple\Queue\Message;
+use Simple\Queue\Producer;
+use PHPUnit\Framework\TestCase;
+use Simple\QueueTest\Helper\MockConnection;
+use Simple\Queue\Transport\DoctrineDbalTransport;
+
+/**
+ * Class ContextTest
+ * @package Simple\QueueTest
+ */
+class ContextTest extends TestCase
+{
+    public function testDefault(): void
+    {
+        $connection = new MockConnection();
+
+        $transport = new class($connection) extends DoctrineDbalTransport {
+            public static Message $message;
+
+            public function send(Message $message): void
+            {
+                self::$message = $message;
+            }
+        };
+
+        $producer = new Producer($transport);
+        $message = $producer->createMessage('my_queue', '');
+
+        $context = new Context($producer, $message, []);
+
+        self::assertEquals($producer, $context->getProducer());
+        self::assertEquals($message, $context->getMessage());
+        self::assertEquals([], $context->getData());
+    }
+}

tests/ContextTest.php

@@ -5,9 +5,8 @@
 namespace Simple\QueueTest;
 
 use Simple\Queue\Job;
-use Simple\Queue\Message;
+use Simple\Queue\Context;
 use Simple\Queue\Consumer;
-use Simple\Queue\Producer;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -36,7 +35,7 @@ public function testDefaultAttempts(): void
     private function generateBaseJob(): Job
     {
         return new class extends Job {
-            public function handle(Message $message, Producer $producer): string
+            public function handle(Context $context): string
             {
                 return Consumer::STATUS_ACK;
             }

tests/JobTest.php

@@ -9,6 +9,7 @@
 use DateTimeImmutable;
 use Simple\Queue\Config;
 use Simple\Queue\Status;
+use Simple\Queue\Context;
 use Simple\Queue\Message;
 use Simple\Queue\Consumer;
 use Simple\Queue\Producer;
@@ -118,7 +119,7 @@ public function testDispatch(): void
         $transport = new DoctrineDbalTransport($connection);
 
         $job = new class() extends Job {
-            public function handle(Message $message, Producer $producer): string
+            public function handle(Context $context): string
             {
                 return Consumer::STATUS_ACK;
             }