Merge pull request #47 from php-enqueue/client-producer-rename

[client] Rename MessageProducer classes to Producer

Author: makasim

docs/bundle/debuging.md

@@ -24,16 +24,16 @@ Now suppose you have this code in an action:
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Symfony\Component\HttpFoundation\Request;
 use Enqueue\Client\Message;
-use Enqueue\Client\MessageProducerInterface;
+use Enqueue\Client\ProducerInterface;
 
 class DefaultController extends Controller 
     /**
      * @Route("/", name="homepage")
      */
     public function indexAction(Request $request)
     {
-        /** @var MessageProducerInterface $producer */
-        $producer = $this->get('enqueue.message_producer'); 
+        /** @var ProducerInterface $producer */
+        $producer = $this->get('enqueue.producer'); 
 
         $producer->send('foo_topic', 'Hello world');
 

docs/bundle/functional_testing.md

@@ -42,7 +42,7 @@ If you did so, you can use its methods `getTraces`, `getTopicTraces` or `clearTr
 ```php
 <?php
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
-use Enqueue\Client\TraceableMessageProducer;
+use Enqueue\Client\TraceableProducer;
 
 class FooTest extends WebTestCase
 {
@@ -61,18 +61,18 @@ class FooTest extends WebTestCase
         // the method calls inside $producer->send('fooTopic', 'messageBody');
         $service->do();
         
-        $traces = $this->getMessageProducer()->getTopicTraces('fooTopic');
+        $traces = $this->getProducer()->getTopicTraces('fooTopic');
         
         $this->assertCount(1, $traces);
         $this->assertEquals('messageBody', $traces[0]['message']);
     }
     
     /**
-     * @return TraceableMessageProducer 
+     * @return TraceableProducer 
      */
-    private function getMessageProducer()
+    private function getProducer()
     {
-        return $this->client->getContainer()->get('enqueue.client.message_producer');
+        return $this->client->getContainer()->get('enqueue.producer');
     }
 }
 ```

docs/bundle/job_queue.md

@@ -55,7 +55,7 @@ Run several sub jobs in parallel.
 <?php
 use Enqueue\JobQueue\JobRunner;
 use Enqueue\JobQueue\Job;
-use Enqueue\Client\MessageProducerInterface;
+use Enqueue\Client\ProducerInterface;
 use Enqueue\Util\JSON;
 use Enqueue\Psr\Message;
 use Enqueue\Psr\Context;
@@ -69,7 +69,7 @@ class Step1Processor implements Processor
     private $jobRunner;
 
     /**
-     * @var MessageProducerInterface
+     * @var ProducerInterface
      */
     private $producer;
 

docs/bundle/quick_tour.md

@@ -59,12 +59,12 @@ Once you configured everything you can start producing messages:
 
 ```php
 <?php
-use Enqueue\Client\MessageProducer;
+use Enqueue\Client\Producer;
 
-/** @var MessageProducer $messageProducer **/
-$messageProducer = $container->get('enqueue.message_producer');
+/** @var Producer $producer **/
+$producer = $container->get('enqueue.producer');
 
-$messageProducer->send('aFooTopic', 'Something has happened');
+$producer->send('aFooTopic', 'Something has happened');
 ```
 
 To consume messages you have to first create a message processor:

docs/client/message_examples.md

@@ -14,7 +14,7 @@ use Enqueue\Client\Message;
 $message = new Message();
 $message->setDelay(60); // seconds
 
-/** @var \Enqueue\Client\MessageProducerInterface $producer */
+/** @var \Enqueue\Client\ProducerInterface $producer */
 $producer->send('aTopic', $message);
 ```
 
@@ -32,7 +32,7 @@ use Enqueue\Client\Message;
 $message = new Message();
 $message->setExpire(60); // seconds
 
-/** @var \Enqueue\Client\MessageProducerInterface $producer */
+/** @var \Enqueue\Client\ProducerInterface $producer */
 $producer->send('aTopic', $message);
 ```
 
@@ -51,7 +51,7 @@ use Enqueue\Client\MessagePriority;
 $message = new Message();
 $message->setPriority(MessagePriority::HIGH);
 
-/** @var \Enqueue\Client\MessageProducerInterface $producer */
+/** @var \Enqueue\Client\ProducerInterface $producer */
 $producer->send('aTopic', $message);
 ```
 
@@ -71,7 +71,7 @@ $message->setMessageId('aCustomMessageId');
 $message->setTimestamp(time());
 $message->setContentType('text/plain');
 
-/** @var \Enqueue\Client\MessageProducerInterface $producer */
+/** @var \Enqueue\Client\ProducerInterface $producer */
 $producer->send('aTopic', $message);
 ```
 

docs/job_queue/run_sub_job.md

@@ -6,7 +6,7 @@ They will be executed in parallel.
 
 ```php
 <?php
-use Enqueue\Client\MessageProducerInterface;
+use Enqueue\Client\ProducerInterface;
 use Enqueue\Psr\Message;
 use Enqueue\Psr\Context;
 use Enqueue\Psr\Processor;
@@ -19,7 +19,7 @@ class RootJobProcessor implements Processor
     /** @var JobRunner */
     private $jobRunner;
 
-    /** @var  MessageProducerInterface */
+    /** @var  ProducerInterface */
     private $producer;
 
     public function process(Message $message, Context $context)

pkg/enqueue-bundle/DependencyInjection/EnqueueExtension.php

@@ -2,7 +2,7 @@
 
 namespace Enqueue\Bundle\DependencyInjection;
 
-use Enqueue\Client\TraceableMessageProducer;
+use Enqueue\Client\TraceableProducer;
 use Enqueue\JobQueue\Job;
 use Enqueue\Symfony\TransportFactoryInterface;
 use Symfony\Component\Config\FileLocator;
@@ -83,8 +83,8 @@ public function load(array $configs, ContainerBuilder $container)
 
             if (false == empty($config['client']['traceable_producer'])) {
                 $producerId = 'enqueue.client.traceable_message_producer';
-                $container->register($producerId, TraceableMessageProducer::class)
-                    ->setDecoratedService('enqueue.client.message_producer')
+                $container->register($producerId, TraceableProducer::class)
+                    ->setDecoratedService('enqueue.client.producer')
                     ->addArgument(new Reference('enqueue.client.traceable_message_producer.inner'))
                 ;
             }

pkg/enqueue-bundle/Profiler/MessageQueueCollector.php

@@ -3,25 +3,25 @@
 namespace Enqueue\Bundle\Profiler;
 
 use Enqueue\Client\MessagePriority;
-use Enqueue\Client\MessageProducerInterface;
-use Enqueue\Client\TraceableMessageProducer;
+use Enqueue\Client\ProducerInterface;
+use Enqueue\Client\TraceableProducer;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\DataCollector\DataCollector;
 
 class MessageQueueCollector extends DataCollector
 {
     /**
-     * @var MessageProducerInterface
+     * @var ProducerInterface
      */
-    private $messageProducer;
+    private $producer;
 
     /**
-     * @param MessageProducerInterface $messageProducer
+     * @param ProducerInterface $producer
      */
-    public function __construct(MessageProducerInterface $messageProducer)
+    public function __construct(ProducerInterface $producer)
     {
-        $this->messageProducer = $messageProducer;
+        $this->producer = $producer;
     }
 
     /**
@@ -33,8 +33,8 @@ public function collect(Request $request, Response $response, \Exception $except
             'sent_messages' => [],
         ];
 
-        if ($this->messageProducer instanceof TraceableMessageProducer) {
-            $this->data['sent_messages'] = $this->messageProducer->getTraces();
+        if ($this->producer instanceof TraceableProducer) {
+            $this->data['sent_messages'] = $this->producer->getTraces();
         }
     }
 

pkg/enqueue-bundle/Resources/config/client.yml

@@ -3,12 +3,22 @@ services:
         class: 'Enqueue\Client\Config'
         public: false
 
+    #deprecated
     enqueue.client.message_producer:
+        deprecated: 'The "%service_id%" service is deprecated. Use "enqueue.client.producer" instead'
         class: 'Enqueue\Client\MessageProducer'
         arguments: ['@enqueue.client.driver']
 
+    #deprecated
     enqueue.message_producer:
-        alias: 'enqueue.client.message_producer'
+        alias: 'enqueue.client.producer'
+
+    enqueue.client.producer:
+        class: 'Enqueue\Client\Producer'
+        arguments: ['@enqueue.client.driver']
+
+    enqueue.producer:
+        alias: 'enqueue.client.producer'
 
     enqueue.client.router_processor:
         class: 'Enqueue\Client\RouterProcessor'

pkg/enqueue-bundle/Resources/config/job.yml

@@ -13,7 +13,7 @@ services:
         class: 'Enqueue\JobQueue\JobProcessor'
         arguments:
             - '@enqueue.job.storage'
-            - '@enqueue.client.message_producer'
+            - '@enqueue.client.producer'
 
     enqueue.job.runner:
         class: 'Enqueue\JobQueue\JobRunner'
@@ -30,7 +30,7 @@ services:
         arguments:
             - '@enqueue.job.storage'
             - '@enqueue.job.calculate_root_job_status_service'
-            - '@enqueue.client.message_producer'
+            - '@enqueue.client.producer'
             - '@logger'
         tags:
             - { name: 'enqueue.client.processor' }
@@ -39,7 +39,7 @@ services:
         class: 'Enqueue\JobQueue\DependentJobProcessor'
         arguments:
             - '@enqueue.job.storage'
-            - '@enqueue.client.message_producer'
+            - '@enqueue.client.producer'
             - '@logger'
         tags:
             - { name: 'enqueue.client.processor' }

pkg/enqueue-bundle/Tests/Functional/Client/MessageProducerTest.php renamed to pkg/enqueue-bundle/Tests/Functional/Client/ProducerTest.php

@@ -3,23 +3,23 @@
 namespace Enqueue\Bundle\Tests\Functional\Client;
 
 use Enqueue\Bundle\Tests\Functional\WebTestCase;
-use Enqueue\Client\MessageProducerInterface;
+use Enqueue\Client\ProducerInterface;
 
 /**
  * @group functional
  */
-class MessageProducerTest extends WebTestCase
+class ProducerTest extends WebTestCase
 {
     public function testCouldBeGetFromContainerAsService()
     {
-        $messageProducer = $this->container->get('enqueue.client.message_producer');
+        $messageProducer = $this->container->get('enqueue.client.producer');
 
-        $this->assertInstanceOf(MessageProducerInterface::class, $messageProducer);
+        $this->assertInstanceOf(ProducerInterface::class, $messageProducer);
     }
 
     public function testCouldBeGetFromContainerAsShortenAlias()
     {
-        $messageProducer = $this->container->get('enqueue.client.message_producer');
+        $messageProducer = $this->container->get('enqueue.client.producer');
         $aliasMessageProducer = $this->container->get('enqueue.message_producer');
 
         $this->assertSame($messageProducer, $aliasMessageProducer);

pkg/enqueue-bundle/Tests/Functional/ConsumeMessagesCommandTest.php

@@ -4,6 +4,7 @@
 
 use Enqueue\AmqpExt\AmqpMessage;
 use Enqueue\Bundle\Tests\Functional\App\AmqpAppKernel;
+use Enqueue\Client\ProducerInterface;
 use Enqueue\Symfony\Client\ConsumeMessagesCommand;
 use Enqueue\Test\RabbitmqManagmentExtensionTrait;
 use Symfony\Component\Console\Tester\CommandTester;
@@ -98,8 +99,11 @@ public static function getKernelClass()
         return AmqpAppKernel::class;
     }
 
+    /**
+     * @return ProducerInterface|object
+     */
     private function getMessageProducer()
     {
-        return $this->container->get('enqueue.client.message_producer');
+        return $this->container->get('enqueue.client.producer');
     }
 }

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

@@ -5,8 +5,8 @@
 use Enqueue\Bundle\DependencyInjection\Configuration;
 use Enqueue\Bundle\DependencyInjection\EnqueueExtension;
 use Enqueue\Bundle\Tests\Unit\Mocks\FooTransportFactory;
-use Enqueue\Client\MessageProducer;
-use Enqueue\Client\TraceableMessageProducer;
+use Enqueue\Client\Producer;
+use Enqueue\Client\TraceableProducer;
 use Enqueue\Symfony\DefaultTransportFactory;
 use Enqueue\Symfony\NullTransportFactory;
 use Enqueue\Test\ClassExtensionTrait;
@@ -157,10 +157,10 @@ public function testShouldLoadClientServicesWhenEnabled()
         ]], $container);
 
         self::assertTrue($container->hasDefinition('enqueue.client.config'));
-        self::assertTrue($container->hasDefinition('enqueue.client.message_producer'));
+        self::assertTrue($container->hasDefinition('enqueue.client.producer'));
     }
 
-    public function testShouldUseMessageProducerByDefault()
+    public function testShouldUseProducerByDefault()
     {
         $container = new ContainerBuilder();
         $container->setParameter('kernel.debug', false);
@@ -179,8 +179,8 @@ public function testShouldUseMessageProducerByDefault()
             ],
         ]], $container);
 
-        $messageProducer = $container->getDefinition('enqueue.client.message_producer');
-        self::assertEquals(MessageProducer::class, $messageProducer->getClass());
+        $producer = $container->getDefinition('enqueue.client.producer');
+        self::assertEquals(Producer::class, $producer->getClass());
     }
 
     public function testShouldUseMessageProducerIfTraceableProducerOptionSetToFalseExplicitly()
@@ -204,8 +204,8 @@ public function testShouldUseMessageProducerIfTraceableProducerOptionSetToFalseE
             ],
         ]], $container);
 
-        $messageProducer = $container->getDefinition('enqueue.client.message_producer');
-        self::assertEquals(MessageProducer::class, $messageProducer->getClass());
+        $producer = $container->getDefinition('enqueue.client.producer');
+        self::assertEquals(Producer::class, $producer->getClass());
     }
 
     public function testShouldUseTraceableMessageProducerIfTraceableProducerOptionSetToTrueExplicitly()
@@ -229,17 +229,17 @@ public function testShouldUseTraceableMessageProducerIfTraceableProducerOptionSe
             ],
         ]], $container);
 
-        $messageProducer = $container->getDefinition('enqueue.client.traceable_message_producer');
-        self::assertEquals(TraceableMessageProducer::class, $messageProducer->getClass());
+        $producer = $container->getDefinition('enqueue.client.traceable_message_producer');
+        self::assertEquals(TraceableProducer::class, $producer->getClass());
         self::assertEquals(
-            ['enqueue.client.message_producer', null, 0],
-            $messageProducer->getDecoratedService()
+            ['enqueue.client.producer', null, 0],
+            $producer->getDecoratedService()
         );
 
-        self::assertInstanceOf(Reference::class, $messageProducer->getArgument(0));
+        self::assertInstanceOf(Reference::class, $producer->getArgument(0));
         self::assertEquals(
             'enqueue.client.traceable_message_producer.inner',
-            (string) $messageProducer->getArgument(0)
+            (string) $producer->getArgument(0)
         );
     }