Merge branch 'master' into dsn-transport

pkg/enqueue-bundle/Tests/Unit/DependencyInjection/ConfigurationTest.php

Author: makasim

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## [0.4.0](https://github.com/php-enqueue/enqueue-dev/tree/0.4.0) (2017-05-12)
+[Full Changelog](https://github.com/php-enqueue/enqueue-dev/compare/0.3.8...0.4.0)
+
+- \[fs\] add DSN support [\#82](https://github.com/php-enqueue/enqueue-dev/pull/82) ([makasim](https://github.com/makasim))
+- \[amqp\] Configure by string DSN. [\#80](https://github.com/php-enqueue/enqueue-dev/pull/80) ([makasim](https://github.com/makasim))
+
+- \[Extensions\] extensions priority [\#79](https://github.com/php-enqueue/enqueue-dev/issues/79)
+
+- \[fs\] Filesystem transport must create a storage dir if it does not exists. [\#78](https://github.com/php-enqueue/enqueue-dev/pull/78) ([makasim](https://github.com/makasim))
+- \[magento\] Add basic docs for enqueue magento extension. [\#76](https://github.com/php-enqueue/enqueue-dev/pull/76) ([makasim](https://github.com/makasim))
+
 ## [0.3.8](https://github.com/php-enqueue/enqueue-dev/tree/0.3.8) (2017-05-10)
 [Full Changelog](https://github.com/php-enqueue/enqueue-dev/compare/0.3.7...0.3.8)
 

README.md

@@ -18,12 +18,14 @@ Features:
     - [Filesystem](docs/transport/filesystem.md)
     - [Null](docs/transport/null.md).
 * Generic purpose abstraction level (the transport level).
-* "Opinionated" easy to use abstraction level (the client level).
+* Easy to use abstraction level (the client level).
+* [Symfony bundle](https://github.com/php-enqueue/enqueue-dev/blob/master/docs/bundle/quick_tour.md)
+* [Magento1 extension](https://github.com/php-enqueue/enqueue-dev/blob/master/docs/magento/quick_tour.md)
 * [Message bus](http://www.enterpriseintegrationpatterns.com/patterns/messaging/MessageBus.html) support.
 * [RPC over MQ](https://www.rabbitmq.com/tutorials/tutorial-one-php.html) support.
 * Temporary queues support.
-* Well designed components (decoupled, reusable,).
-* Tested with unit and functional tests.
+* Well designed components decoupled and reusable.
+* Carefully tested including unit and functional tests.
 * For more visit [quick tour](docs/quick_tour.md).
 
 ## Resources
@@ -42,4 +44,4 @@ If you have any questions and inquires about our open source development, this p
 
 ## License
 
-It is released under the [MIT License](LICENSE).
+It is released under the [MIT License](LICENSE).

composer.json

@@ -27,6 +27,9 @@
     "friendsofphp/php-cs-fixer": "^2",
     "empi89/php-amqp-stubs": "*@dev"
   },
+  "autoload": {
+    "files": ["pkg/enqueue/functions_include.php"]
+  },
   "config": {
     "bin-dir": "bin"
   },

docker-compose.yml

@@ -11,7 +11,6 @@ services:
       - './:/mqdev'
     environment:
       - AMQP_DSN=amqp://rabbitmq
-      - RABBITMQ_DSN=rabbitmq_amqp://rabbitmq
       - SYMFONY__RABBITMQ__HOST=rabbitmq
       - SYMFONY__RABBITMQ__USER=guest
       - SYMFONY__RABBITMQ__PASSWORD=guest

docs/bundle/config_reference.md

@@ -95,7 +95,7 @@ enqueue:
         fs:
 
             # The store directory where all queue\topics files will be created and messages are stored
-            store_dir:            ~ # Required
+            path:            ~ # Required
 
             # The option tells how many messages should be read from file at once. The feature save resources but could lead to bigger messages lose.
             pre_fetch_count:      1

docs/bundle/quick_tour.md

@@ -1,6 +1,6 @@
 # EnqueueBundle. Quick tour.
 
-The bundle integrates enqueue library.
+The [EnqueueBundle](https://github.com/php-enqueue/enqueue-bundle) integrates enqueue library.
 It adds easy to use [configuration layer](config_reference.md), register services, adds handy [cli commands](cli_commands.md).
 
 ## Install

docs/transport/filesystem.md

@@ -24,8 +24,25 @@ $ composer require enqueue/fs
 <?php
 use Enqueue\Fs\FsConnectionFactory;
 
+// stores messages in /tmp/enqueue folder
+$connectionFactory = new FsConnectionFactory();
+
+// same as above
+$connectionFactory = new FsConnectionFactory('file://');
+
+// stores in custom folder
+$connectionFactory = new FsConnectionFactory('/path/to/queue/dir');
+
+// same as above
+$connectionFactory = new FsConnectionFactory('file://path/to/queue/dir');
+
+// with options
+$connectionFactory = new FsConnectionFactory('file://path/to/queue/dir?pre_fetch_count=1');
+
+// as an array
 $connectionFactory = new FsConnectionFactory([
-    'store_dir' => '/tmp'
+    'path' => '/path/to/queue/dir',
+    'pre_fetch_count' => 1,
 ]);
 
 $psrContext = $connectionFactory->createContext();

pkg/amqp-ext/AmqpConnectionFactory.php

@@ -17,19 +17,19 @@ class AmqpConnectionFactory implements PsrConnectionFactory
     private $connection;
 
     /**
-     * The config could be an array, string DSN or null. In case of null it will attempt to connect to localhost with default credentials
+     * The config could be an array, string DSN or null. In case of null it will attempt to connect to localhost with default credentials.
      *
      * [
-     *     'host'  => amqp.host The host to connect too. Note: Max 1024 characters.
-     *     'port'  => amqp.port Port on the host.
-     *     'vhost' => amqp.vhost The virtual host on the host. Note: Max 128 characters.
-     *     'user' => amqp.user The user name to use. Note: Max 128 characters.
-     *     'pass' => amqp.password Password. Note: Max 128 characters.
-     *     'read_timeout'  => Timeout in for income activity. Note: 0 or greater seconds. May be fractional.
-     *     'write_timeout' => Timeout in for outcome activity. Note: 0 or greater seconds. May be fractional.
-     *     'connect_timeout' => Connection timeout. Note: 0 or greater seconds. May be fractional.
-     *     'persisted' => bool, Whether it use single persisted connection or open a new one for every context
-     *     'lazy' => the connection will be performed as later as possible, if the option set to true
+     *     'host'  => 'amqp.host The host to connect too. Note: Max 1024 characters.',
+     *     'port'  => 'amqp.port Port on the host.',
+     *     'vhost' => 'amqp.vhost The virtual host on the host. Note: Max 128 characters.',
+     *     'user' => 'amqp.user The user name to use. Note: Max 128 characters.',
+     *     'pass' => 'amqp.password Password. Note: Max 128 characters.',
+     *     'read_timeout'  => 'Timeout in for income activity. Note: 0 or greater seconds. May be fractional.',
+     *     'write_timeout' => 'Timeout in for outcome activity. Note: 0 or greater seconds. May be fractional.',
+     *     'connect_timeout' => 'Connection timeout. Note: 0 or greater seconds. May be fractional.',
+     *     'persisted' => 'bool, Whether it use single persisted connection or open a new one for every context',
+     *     'lazy' => 'the connection will be performed as later as possible, if the option set to true',
      * ]
      *
      * or
@@ -40,13 +40,13 @@ class AmqpConnectionFactory implements PsrConnectionFactory
      */
     public function __construct($config = 'amqp://')
     {
-        if (empty($config)) {
+        if (empty($config) || 'amqp://' === $config) {
             $config = [];
-        } else if (is_string($config)) {
+        } elseif (is_string($config)) {
             $config = $this->parseDsn($config);
-        } else if (is_array($config)) {
+        } elseif (is_array($config)) {
         } else {
-            throw new \LogicException('The config must be eaither an array of options, a DSN string or null');
+            throw new \LogicException('The config must be either an array of options, a DSN string or null');
         }
 
         $this->config = array_replace($this->defaultConfig(), $config);
@@ -82,7 +82,6 @@ private function establishConnection()
 
             $this->config['persisted'] ? $this->connection->pconnect() : $this->connection->connect();
         }
-
         if (false == $this->connection->isConnected()) {
             $this->config['persisted'] ? $this->connection->preconnect() : $this->connection->reconnect();
         }
@@ -97,10 +96,6 @@ private function establishConnection()
      */
     private function parseDsn($dsn)
     {
-        if ('amqp://' == $dsn) {
-            return [];
-        }
-
         $dsnConfig = parse_url($dsn);
         if (false === $dsnConfig) {
             throw new \LogicException(sprintf('Failed to parse DSN "%s"', $dsn));
@@ -130,9 +125,8 @@ private function parseDsn($dsn)
 
         unset($dsnConfig['scheme'], $dsnConfig['query'], $dsnConfig['fragment'], $dsnConfig['path']);
 
-
         $config = array_replace($this->defaultConfig(), $dsnConfig);
-        $config = array_map(function($value) {
+        $config = array_map(function ($value) {
             return urldecode($value);
         }, $config);
 

pkg/amqp-ext/Symfony/AmqpTransportFactory.php

@@ -34,9 +34,9 @@ public function addConfiguration(ArrayNodeDefinition $builder)
         $builder
             ->beforeNormalization()
             ->ifString()
-            ->then(function ($v) {
-                return ['dsn' => $v];
-            })
+                ->then(function ($v) {
+                    return ['dsn' => $v];
+                })
             ->end()
             ->children()
                 ->scalarNode('dsn')

pkg/amqp-ext/Tests/AmqpConnectionFactoryConfigTest.php

@@ -3,12 +3,11 @@
 namespace Enqueue\AmqpExt\Tests;
 
 use Enqueue\AmqpExt\AmqpConnectionFactory;
-use Enqueue\AmqpExt\Symfony\AmqpTransportFactory;
 use Enqueue\Test\ClassExtensionTrait;
 use PHPUnit\Framework\TestCase;
 
 /**
- * The class contains the factory tests dedicated to configuration
+ * The class contains the factory tests dedicated to configuration.
  */
 class AmqpConnectionFactoryConfigTest extends TestCase
 {
@@ -17,7 +16,7 @@ class AmqpConnectionFactoryConfigTest extends TestCase
     public function testThrowNeitherArrayStringNorNullGivenAsConfig()
     {
         $this->expectException(\LogicException::class);
-        $this->expectExceptionMessage('The config must be eaither an array of options, a DSN string or null');
+        $this->expectExceptionMessage('The config must be either an array of options, a DSN string or null');
 
         new AmqpConnectionFactory(new \stdClass());
     }
@@ -40,6 +39,9 @@ public function testThrowIfDsnCouldNotBeParsed()
 
     /**
      * @dataProvider provideConfigs
+     *
+     * @param mixed $config
+     * @param mixed $expectedConfig
      */
     public function testShouldParseConfigurationAsExpected($config, $expectedConfig)
     {
@@ -63,13 +65,13 @@ public static function provideConfigs()
                 'connect_timeout' => null,
                 'persisted' => false,
                 'lazy' => true,
-            ]
+            ],
         ];
 
         // some examples from Appendix A: Examples (https://www.rabbitmq.com/uri-spec.html)
 
         yield [
-            "amqp://user:pass@host:10000/vhost",
+            'amqp://user:pass@host:10000/vhost',
             [
                 'host' => 'host',
                 'port' => 10000,
@@ -81,11 +83,11 @@ public static function provideConfigs()
                 'connect_timeout' => null,
                 'persisted' => false,
                 'lazy' => true,
-            ]
+            ],
         ];
 
         yield [
-            "amqp://user%61:%61pass@ho%61st:10000/v%2fhost",
+            'amqp://user%61:%61pass@ho%61st:10000/v%2fhost',
             [
                 'host' => 'hoast',
                 'port' => 10000,
@@ -97,11 +99,11 @@ public static function provideConfigs()
                 'connect_timeout' => null,
                 'persisted' => false,
                 'lazy' => true,
-            ]
+            ],
         ];
 
         yield [
-            "amqp://",
+            'amqp://',
             [
                 'host' => 'localhost',
                 'port' => 5672,
@@ -113,11 +115,11 @@ public static function provideConfigs()
                 'connect_timeout' => null,
                 'persisted' => false,
                 'lazy' => true,
-            ]
+            ],
         ];
 
         yield [
-            "amqp://user:pass@host:10000/vhost?connect_timeout=2&lazy=",
+            'amqp://user:pass@host:10000/vhost?connect_timeout=2&lazy=',
             [
                 'host' => 'host',
                 'port' => 10000,
@@ -129,7 +131,7 @@ public static function provideConfigs()
                 'connect_timeout' => '2',
                 'persisted' => false,
                 'lazy' => '',
-            ]
+            ],
         ];
 
         yield [
@@ -145,7 +147,7 @@ public static function provideConfigs()
                 'connect_timeout' => null,
                 'persisted' => false,
                 'lazy' => true,
-            ]
+            ],
         ];
 
         yield [
@@ -161,7 +163,7 @@ public static function provideConfigs()
                 'connect_timeout' => null,
                 'persisted' => false,
                 'lazy' => false,
-            ]
+            ],
         ];
     }
 }

pkg/amqp-ext/composer.json

@@ -13,14 +13,14 @@
     "require": {
         "php": ">=5.6",
         "ext-amqp": "^1.6",
-        "enqueue/psr-queue": "^0.3|0.4@dev",
+        "enqueue/psr-queue": "^0.4",
         "psr/log": "^1"
     },
     "require-dev": {
         "phpunit/phpunit": "~5.4.0",
-        "enqueue/test": "^0.3|0.4@dev",
-        "enqueue/enqueue": "^0.3|0.4@dev",
-        "enqueue/null": "^0.3|0.4@dev",
+        "enqueue/test": "^0.4",
+        "enqueue/enqueue": "^0.4",
+        "enqueue/null": "^0.4",
         "empi89/php-amqp-stubs": "*@dev",
         "symfony/dependency-injection": "^2.8|^3",
         "symfony/config": "^2.8|^3"

pkg/dbal/composer.json

@@ -12,15 +12,15 @@
     ],
     "require": {
         "php": ">=5.6",
-        "enqueue/psr-queue": "^0.3|0.4@dev",
+        "enqueue/psr-queue": "^0.4",
         "doctrine/dbal": "~2.5",
         "psr/log": "^1"
     },
     "require-dev": {
         "phpunit/phpunit": "~5.4.0",
-        "enqueue/test": "^0.3|0.4@dev",
-        "enqueue/enqueue": "^0.3|0.4@dev",
-        "enqueue/null": "^0.3|0.4@dev",
+        "enqueue/test": "^0.4",
+        "enqueue/enqueue": "^0.4",
+        "enqueue/null": "^0.4",
         "symfony/dependency-injection": "^2.8|^3",
         "symfony/config": "^2.8|^3"
     },