Skip to content

Commit c6281e9

Browse files
makasimmakasim
authored
Merge pull request #47 from php-enqueue/client-producer-rename
[client] Rename MessageProducer classes to Producer
2 parents 890fe52 + 424e3f7 commit c6281e9

30 files changed

+429
-379
lines changed

Diff for: ‎docs/bundle/debuging.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,16 @@ Now suppose you have this code in an action:
2424
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
2525
use Symfony\Component\HttpFoundation\Request;
2626
use Enqueue\Client\Message;
27-
use Enqueue\Client\MessageProducerInterface;
27+
use Enqueue\Client\ProducerInterface;
2828

2929
class DefaultController extends Controller
3030
/**
3131
* @Route("/", name="homepage")
3232
*/
3333
public function indexAction(Request $request)
3434
{
35-
/** @var MessageProducerInterface $producer */
36-
$producer = $this->get('enqueue.message_producer');
35+
/** @var ProducerInterface $producer */
36+
$producer = $this->get('enqueue.producer');
3737

3838
$producer->send('foo_topic', 'Hello world');
3939

Diff for: ‎docs/bundle/functional_testing.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ If you did so, you can use its methods `getTraces`, `getTopicTraces` or `clearTr
4242
```php
4343
<?php
4444
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
45-
use Enqueue\Client\TraceableMessageProducer;
45+
use Enqueue\Client\TraceableProducer;
4646
4747
class FooTest extends WebTestCase
4848
{
@@ -61,18 +61,18 @@ class FooTest extends WebTestCase
6161
// the method calls inside $producer->send('fooTopic', 'messageBody');
6262
$service->do();
6363
64-
$traces = $this->getMessageProducer()->getTopicTraces('fooTopic');
64+
$traces = $this->getProducer()->getTopicTraces('fooTopic');
6565
6666
$this->assertCount(1, $traces);
6767
$this->assertEquals('messageBody', $traces[0]['message']);
6868
}
6969
7070
/**
71-
* @return TraceableMessageProducer
71+
* @return TraceableProducer
7272
*/
73-
private function getMessageProducer()
73+
private function getProducer()
7474
{
75-
return $this->client->getContainer()->get('enqueue.client.message_producer');
75+
return $this->client->getContainer()->get('enqueue.producer');
7676
}
7777
}
7878
```

Diff for: ‎docs/bundle/job_queue.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Run several sub jobs in parallel.
5555
<?php
5656
use Enqueue\JobQueue\JobRunner;
5757
use Enqueue\JobQueue\Job;
58-
use Enqueue\Client\MessageProducerInterface;
58+
use Enqueue\Client\ProducerInterface;
5959
use Enqueue\Util\JSON;
6060
use Enqueue\Psr\Message;
6161
use Enqueue\Psr\Context;
@@ -69,7 +69,7 @@ class Step1Processor implements Processor
6969
private $jobRunner;
7070

7171
/**
72-
* @var MessageProducerInterface
72+
* @var ProducerInterface
7373
*/
7474
private $producer;
7575

Diff for: ‎docs/bundle/quick_tour.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ Once you configured everything you can start producing messages:
5959
6060
```php
6161
<?php
62-
use Enqueue\Client\MessageProducer;
62+
use Enqueue\Client\Producer;
6363

64-
/** @var MessageProducer $messageProducer **/
65-
$messageProducer = $container->get('enqueue.message_producer');
64+
/** @var Producer $producer **/
65+
$producer = $container->get('enqueue.producer');
6666

67-
$messageProducer->send('aFooTopic', 'Something has happened');
67+
$producer->send('aFooTopic', 'Something has happened');
6868
```
6969

7070
To consume messages you have to first create a message processor:

Diff for: ‎docs/client/message_examples.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ use Enqueue\Client\Message;
1414
$message = new Message();
1515
$message->setDelay(60); // seconds
1616

17-
/** @var \Enqueue\Client\MessageProducerInterface $producer */
17+
/** @var \Enqueue\Client\ProducerInterface $producer */
1818
$producer->send('aTopic', $message);
1919
```
2020

@@ -32,7 +32,7 @@ use Enqueue\Client\Message;
3232
$message = new Message();
3333
$message->setExpire(60); // seconds
3434

35-
/** @var \Enqueue\Client\MessageProducerInterface $producer */
35+
/** @var \Enqueue\Client\ProducerInterface $producer */
3636
$producer->send('aTopic', $message);
3737
```
3838

@@ -51,7 +51,7 @@ use Enqueue\Client\MessagePriority;
5151
$message = new Message();
5252
$message->setPriority(MessagePriority::HIGH);
5353

54-
/** @var \Enqueue\Client\MessageProducerInterface $producer */
54+
/** @var \Enqueue\Client\ProducerInterface $producer */
5555
$producer->send('aTopic', $message);
5656
```
5757

@@ -71,7 +71,7 @@ $message->setMessageId('aCustomMessageId');
7171
$message->setTimestamp(time());
7272
$message->setContentType('text/plain');
7373

74-
/** @var \Enqueue\Client\MessageProducerInterface $producer */
74+
/** @var \Enqueue\Client\ProducerInterface $producer */
7575
$producer->send('aTopic', $message);
7676
```
7777

Diff for: ‎docs/job_queue/run_sub_job.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ They will be executed in parallel.
66

77
```php
88
<?php
9-
use Enqueue\Client\MessageProducerInterface;
9+
use Enqueue\Client\ProducerInterface;
1010
use Enqueue\Psr\Message;
1111
use Enqueue\Psr\Context;
1212
use Enqueue\Psr\Processor;
@@ -19,7 +19,7 @@ class RootJobProcessor implements Processor
1919
/** @var JobRunner */
2020
private $jobRunner;
2121

22-
/** @var MessageProducerInterface */
22+
/** @var ProducerInterface */
2323
private $producer;
2424

2525
public function process(Message $message, Context $context)

Diff for: ‎pkg/enqueue-bundle/DependencyInjection/EnqueueExtension.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
namespace Enqueue\Bundle\DependencyInjection;
44

5-
use Enqueue\Client\TraceableMessageProducer;
5+
use Enqueue\Client\TraceableProducer;
66
use Enqueue\JobQueue\Job;
77
use Enqueue\Symfony\TransportFactoryInterface;
88
use Symfony\Component\Config\FileLocator;
@@ -83,8 +83,8 @@ public function load(array $configs, ContainerBuilder $container)
8383

8484
if (false == empty($config['client']['traceable_producer'])) {
8585
$producerId = 'enqueue.client.traceable_message_producer';
86-
$container->register($producerId, TraceableMessageProducer::class)
87-
->setDecoratedService('enqueue.client.message_producer')
86+
$container->register($producerId, TraceableProducer::class)
87+
->setDecoratedService('enqueue.client.producer')
8888
->addArgument(new Reference('enqueue.client.traceable_message_producer.inner'))
8989
;
9090
}

Diff for: ‎pkg/enqueue-bundle/Profiler/MessageQueueCollector.php

+9-9
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,25 @@
33
namespace Enqueue\Bundle\Profiler;
44

55
use Enqueue\Client\MessagePriority;
6-
use Enqueue\Client\MessageProducerInterface;
7-
use Enqueue\Client\TraceableMessageProducer;
6+
use Enqueue\Client\ProducerInterface;
7+
use Enqueue\Client\TraceableProducer;
88
use Symfony\Component\HttpFoundation\Request;
99
use Symfony\Component\HttpFoundation\Response;
1010
use Symfony\Component\HttpKernel\DataCollector\DataCollector;
1111

1212
class MessageQueueCollector extends DataCollector
1313
{
1414
/**
15-
* @var MessageProducerInterface
15+
* @var ProducerInterface
1616
*/
17-
private $messageProducer;
17+
private $producer;
1818

1919
/**
20-
* @param MessageProducerInterface $messageProducer
20+
* @param ProducerInterface $producer
2121
*/
22-
public function __construct(MessageProducerInterface $messageProducer)
22+
public function __construct(ProducerInterface $producer)
2323
{
24-
$this->messageProducer = $messageProducer;
24+
$this->producer = $producer;
2525
}
2626

2727
/**
@@ -33,8 +33,8 @@ public function collect(Request $request, Response $response, \Exception $except
3333
'sent_messages' => [],
3434
];
3535

36-
if ($this->messageProducer instanceof TraceableMessageProducer) {
37-
$this->data['sent_messages'] = $this->messageProducer->getTraces();
36+
if ($this->producer instanceof TraceableProducer) {
37+
$this->data['sent_messages'] = $this->producer->getTraces();
3838
}
3939
}
4040

Diff for: ‎pkg/enqueue-bundle/Resources/config/client.yml

+11-1
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,22 @@ services:
33
class: 'Enqueue\Client\Config'
44
public: false
55

6+
#deprecated
67
enqueue.client.message_producer:
8+
deprecated: 'The "%service_id%" service is deprecated. Use "enqueue.client.producer" instead'
79
class: 'Enqueue\Client\MessageProducer'
810
arguments: ['@enqueue.client.driver']
911

12+
#deprecated
1013
enqueue.message_producer:
11-
alias: 'enqueue.client.message_producer'
14+
alias: 'enqueue.client.producer'
15+
16+
enqueue.client.producer:
17+
class: 'Enqueue\Client\Producer'
18+
arguments: ['@enqueue.client.driver']
19+
20+
enqueue.producer:
21+
alias: 'enqueue.client.producer'
1222

1323
enqueue.client.router_processor:
1424
class: 'Enqueue\Client\RouterProcessor'

Diff for: ‎pkg/enqueue-bundle/Resources/config/job.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ services:
1313
class: 'Enqueue\JobQueue\JobProcessor'
1414
arguments:
1515
- '@enqueue.job.storage'
16-
- '@enqueue.client.message_producer'
16+
- '@enqueue.client.producer'
1717

1818
enqueue.job.runner:
1919
class: 'Enqueue\JobQueue\JobRunner'
@@ -30,7 +30,7 @@ services:
3030
arguments:
3131
- '@enqueue.job.storage'
3232
- '@enqueue.job.calculate_root_job_status_service'
33-
- '@enqueue.client.message_producer'
33+
- '@enqueue.client.producer'
3434
- '@logger'
3535
tags:
3636
- { name: 'enqueue.client.processor' }
@@ -39,7 +39,7 @@ services:
3939
class: 'Enqueue\JobQueue\DependentJobProcessor'
4040
arguments:
4141
- '@enqueue.job.storage'
42-
- '@enqueue.client.message_producer'
42+
- '@enqueue.client.producer'
4343
- '@logger'
4444
tags:
4545
- { name: 'enqueue.client.processor' }

Diff for: ‎pkg/enqueue-bundle/Tests/Functional/Client/MessageProducerTest.php renamed to ‎pkg/enqueue-bundle/Tests/Functional/Client/ProducerTest.php

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@
33
namespace Enqueue\Bundle\Tests\Functional\Client;
44

55
use Enqueue\Bundle\Tests\Functional\WebTestCase;
6-
use Enqueue\Client\MessageProducerInterface;
6+
use Enqueue\Client\ProducerInterface;
77

88
/**
99
* @group functional
1010
*/
11-
class MessageProducerTest extends WebTestCase
11+
class ProducerTest extends WebTestCase
1212
{
1313
public function testCouldBeGetFromContainerAsService()
1414
{
15-
$messageProducer = $this->container->get('enqueue.client.message_producer');
15+
$messageProducer = $this->container->get('enqueue.client.producer');
1616

17-
$this->assertInstanceOf(MessageProducerInterface::class, $messageProducer);
17+
$this->assertInstanceOf(ProducerInterface::class, $messageProducer);
1818
}
1919

2020
public function testCouldBeGetFromContainerAsShortenAlias()
2121
{
22-
$messageProducer = $this->container->get('enqueue.client.message_producer');
22+
$messageProducer = $this->container->get('enqueue.client.producer');
2323
$aliasMessageProducer = $this->container->get('enqueue.message_producer');
2424

2525
$this->assertSame($messageProducer, $aliasMessageProducer);

Diff for: ‎pkg/enqueue-bundle/Tests/Functional/ConsumeMessagesCommandTest.php

+5-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
use Enqueue\AmqpExt\AmqpMessage;
66
use Enqueue\Bundle\Tests\Functional\App\AmqpAppKernel;
7+
use Enqueue\Client\ProducerInterface;
78
use Enqueue\Symfony\Client\ConsumeMessagesCommand;
89
use Enqueue\Test\RabbitmqManagmentExtensionTrait;
910
use Symfony\Component\Console\Tester\CommandTester;
@@ -98,8 +99,11 @@ public static function getKernelClass()
9899
return AmqpAppKernel::class;
99100
}
100101

102+
/**
103+
* @return ProducerInterface|object
104+
*/
101105
private function getMessageProducer()
102106
{
103-
return $this->container->get('enqueue.client.message_producer');
107+
return $this->container->get('enqueue.client.producer');
104108
}
105109
}

Diff for: ‎pkg/enqueue-bundle/Tests/Unit/DependencyInjection/EnqueueExtensionTest.php

+14-14
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
use Enqueue\Bundle\DependencyInjection\Configuration;
66
use Enqueue\Bundle\DependencyInjection\EnqueueExtension;
77
use Enqueue\Bundle\Tests\Unit\Mocks\FooTransportFactory;
8-
use Enqueue\Client\MessageProducer;
9-
use Enqueue\Client\TraceableMessageProducer;
8+
use Enqueue\Client\Producer;
9+
use Enqueue\Client\TraceableProducer;
1010
use Enqueue\Symfony\DefaultTransportFactory;
1111
use Enqueue\Symfony\NullTransportFactory;
1212
use Enqueue\Test\ClassExtensionTrait;
@@ -157,10 +157,10 @@ public function testShouldLoadClientServicesWhenEnabled()
157157
]], $container);
158158

159159
self::assertTrue($container->hasDefinition('enqueue.client.config'));
160-
self::assertTrue($container->hasDefinition('enqueue.client.message_producer'));
160+
self::assertTrue($container->hasDefinition('enqueue.client.producer'));
161161
}
162162

163-
public function testShouldUseMessageProducerByDefault()
163+
public function testShouldUseProducerByDefault()
164164
{
165165
$container = new ContainerBuilder();
166166
$container->setParameter('kernel.debug', false);
@@ -179,8 +179,8 @@ public function testShouldUseMessageProducerByDefault()
179179
],
180180
]], $container);
181181

182-
$messageProducer = $container->getDefinition('enqueue.client.message_producer');
183-
self::assertEquals(MessageProducer::class, $messageProducer->getClass());
182+
$producer = $container->getDefinition('enqueue.client.producer');
183+
self::assertEquals(Producer::class, $producer->getClass());
184184
}
185185

186186
public function testShouldUseMessageProducerIfTraceableProducerOptionSetToFalseExplicitly()
@@ -204,8 +204,8 @@ public function testShouldUseMessageProducerIfTraceableProducerOptionSetToFalseE
204204
],
205205
]], $container);
206206

207-
$messageProducer = $container->getDefinition('enqueue.client.message_producer');
208-
self::assertEquals(MessageProducer::class, $messageProducer->getClass());
207+
$producer = $container->getDefinition('enqueue.client.producer');
208+
self::assertEquals(Producer::class, $producer->getClass());
209209
}
210210

211211
public function testShouldUseTraceableMessageProducerIfTraceableProducerOptionSetToTrueExplicitly()
@@ -229,17 +229,17 @@ public function testShouldUseTraceableMessageProducerIfTraceableProducerOptionSe
229229
],
230230
]], $container);
231231

232-
$messageProducer = $container->getDefinition('enqueue.client.traceable_message_producer');
233-
self::assertEquals(TraceableMessageProducer::class, $messageProducer->getClass());
232+
$producer = $container->getDefinition('enqueue.client.traceable_message_producer');
233+
self::assertEquals(TraceableProducer::class, $producer->getClass());
234234
self::assertEquals(
235-
['enqueue.client.message_producer', null, 0],
236-
$messageProducer->getDecoratedService()
235+
['enqueue.client.producer', null, 0],
236+
$producer->getDecoratedService()
237237
);
238238

239-
self::assertInstanceOf(Reference::class, $messageProducer->getArgument(0));
239+
self::assertInstanceOf(Reference::class, $producer->getArgument(0));
240240
self::assertEquals(
241241
'enqueue.client.traceable_message_producer.inner',
242-
(string) $messageProducer->getArgument(0)
242+
(string) $producer->getArgument(0)
243243
);
244244
}
245245

0 commit comments

Comments
 (0)