Merge pull request #17 from nepster-web/consume

1.0.0-Alpha-2

Author: DenySolomakha

.docker/Dockerfile

@@ -1,5 +1,6 @@
-FROM php:7.4-fpm-alpine
+FROM php:7.4.16-fpm-alpine
 
+ARG LOCAL_ENV
 ARG USER_ID
 ARG GROUP_ID
 
@@ -19,14 +20,20 @@ RUN apk update && apk add --no-cache \
     shadow
 
 RUN docker-php-ext-install \
-        pdo_sqlite
+    pdo_sqlite
+
+RUN apk add --no-cache $PHPIZE_DEPS \
+    && pecl install xdebug-3.0.3  \
+    && docker-php-ext-enable xdebug;
 
 RUN mkdir /db && chown -R ${USER_ID}:${GROUP_ID} /db && /usr/bin/sqlite3 /db/queue.db
 
-RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --version=2.0.11 --filename=composer
 
 # Set IDs from our local user
 RUN usermod -u ${USER_ID} www-data && groupmod -g ${GROUP_ID} www-data || true
 USER "${USER_ID}:${GROUP_ID}"
 
+COPY php.ini         /usr/local/etc/php/conf.d/php.ini
+
 WORKDIR /app

.docker/Makefile

@@ -4,7 +4,7 @@ USER_ID = $(shell id -u)
 GROUP_ID=$(shell id -g)
 APP_DIR="${PWD}/.."
 
-app_run := docker exec -t --user="${USER_ID}" $(PROJECT_NAME)
+app_run := docker exec -it --user="${USER_ID}" $(PROJECT_NAME)
 
 .PHONY : help build start stop restart composer php test test-coverage
 

.docker/php.ini

@@ -0,0 +1,2 @@
+[PHP]
+xdebug.mode=coverage

.gitignore

@@ -3,4 +3,5 @@
 /phpcs.xml
 /vendor/
 /.phpunit.result.cache
-/.php_cs.cache
+/.php_cs.cache
+/docs/tmp/

CHANGELOG.md

@@ -8,11 +8,32 @@ A changelog of all notable changes made to this library.
 
 
 1.0.0 under development
--------------------
+----------------------
+
+
+1.0.0-RC under development
+----------------------
 
 
 1.0.0-Beta under development
--------------------
+----------------------
+
+
+1.0.0-Alpha-3 ??.??.2021
+------------------------
+
+
+1.0.0-Alpha-2 17.03.2021
+------------------------
+- *ENH*: added work with jobs
+- *ENH*: added work with processors
+- *ENH*: added serializer fo message body
+- *ENH*: added [MessageHydrator](./src/MessageHydrator.php) (for change system properties)
+- *ENH*: added base [Config](./src/Config.php)
+- *ENH*: expanded consumer work algorithms
+- *ENH*: increased test coverage
+- *ENH*: improved documentation
+- *ENH*: updated Dockerfile in example (strict version for: php, composer, xdebug)
 
 
 1.0.0-Alpha 13.02.2021

README.md

@@ -1,3 +1,5 @@
+> This package is under development. Api classes of this application can be changed.
+
 <p align="center">
     <h1 align="center">PHP Simple Queue</h1>
 </p>
@@ -50,7 +52,20 @@ or add
 :computer: Basic Usage
 ----------------------
 
-### Send to queue (producing)
+Create a database connection:
+
+```php
+$connection = \Doctrine\DBAL\DriverManager::getConnection([
+    'dbname' => 'my_db',
+    'user' => 'root',
+    'password' => '*******',
+    'host' => 'localhost',
+    'port' => '54320',
+    'driver' => 'pdo_pgsql',
+]);
+```
+
+### Send a message to queue (producing)
 
 ```php
 // $connection - create doctrine connection
@@ -61,20 +76,34 @@ $message = new Message('my_queue', json_decode($data));
 $producer->send($message);
 ```
 
-### Read from queue (consuming)
+### Job dispatching (producing)
+
+```php
+// $connection - create doctrine connection
+
+$producer = new \Simple\Queue\Producer($connection);
+
+$producer->dispatch(MyJob::class, ['key' => 'value']);
+```
+
+### Processing messages from queue (consuming)
 
 ```php
 // $connection - create doctrine connection
 
 $producer = new \Simple\Queue\Producer($connection);
 $consumer = new \Simple\Queue\Consumer($connection, $producer);
 
-while (true) {
-    if ($message = $consumer->fetchMessage('my_queue')) {
-        // your message handling logic
-        $consumer->acknowledge($message);
-    }
-}
+// process all messages from queue
+$consumer->bind('my_queue', static function(\Simple\Queue\Message $message, \Simple\Queue\Producer $producer): string {
+
+    // Your message handling logic
+    var_dump($message->getBody() . PHP_EOL);
+
+    return \Simple\Queue\Consumer::STATUS_ACK;
+});
+
+$consumer->consume();
 ```
 
 For more details see the [example code](./example) and read the [guide](./docs/guide/example.md).
@@ -99,7 +128,6 @@ make comoposer cmd='test'
 
 ---------------------------------
 
-
 ## :book: Documentation
 
 See [the official guide](./docs/guide/README.md).

composer.json

@@ -26,7 +26,8 @@
     "ext-json": "*",
     "doctrine/dbal": "^3.0",
     "laminas/laminas-hydrator": "^4.1",
-    "ramsey/uuid": "^4.1"
+    "ramsey/uuid": "^4.1",
+    "symfony/serializer": "^5.2"
   },
   "require-dev": {
     "roave/security-advisories": "dev-master",

docs/guide/README.md

@@ -10,11 +10,11 @@ It supports queues based on **DB**.
 
 * **[Guide](./README.md)**
 * [Install](./install.md)
-* [Usage basics](./usage.md)
+* [Send message](./send_message.md)
+* [Consuming](./consuming.md)
 * [Example](./example.md)
 * [Cookbook](./cookbook.md)
 
-
 <br>
 
 [Go back](https://github.com/nepster-web/php-simple-queue)