Merge pull request #6 from leeovery/0.2

Publish config file so user can control name of WorkCommand.

Author: maxbrokman

config/safequeue.php

@@ -0,0 +1,20 @@
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Worker Command Name
+    |--------------------------------------------------------------------------
+    |
+    | Configure the signature / name of the Work Command here. The default
+    | is to rename the command to 'doctrine:queue:work', however you can
+    | rename it to whatever you want by changing this value.
+    |
+    | To override the Laravel 'queue:work' command name just set this
+    | to a false value or 'queue:work'.
+    |
+    */
+    'command_name' => 'doctrine:queue:work',
+
+];

src/Console/WorkCommand.php

@@ -8,14 +8,7 @@
 
 class WorkCommand extends IlluminateWorkCommand
 {
-    /**
-     * The console command name. This is now used to rename the laravel
-     * command. It's also used in the tests to ensure the command
-     * is renamed properly.
-     *
-     * @var string
-     */
-    protected $name = 'doctrine:queue:work';
+    const SIGNATURE_REGEX_PATTERN = '/([\w:-]+)(?=\s|\{)/i';
 
     /**
      * The console command description.
@@ -26,17 +19,30 @@ class WorkCommand extends IlluminateWorkCommand
 
     /**
      * WorkCommand constructor.
+     *
      * @param Worker $worker
+     * @param array  $config
      */
-    public function __construct(Worker $worker)
+    public function __construct(Worker $worker, $config)
     {
-        $this->renameCommandInSignature();
+        $this->renameCommandInSignature($config['command_name']);
 
         parent::__construct($worker);
     }
 
-    public function renameCommandInSignature()
+    public function renameCommandInSignature($commandName)
     {
-        $this->signature = str_replace('queue:work', $this->name, $this->signature);
+        if ($commandName) {
+            /**
+             * RegEx matches signature from the Laravel Worker Command that we're extending
+             * from. Captures 1+ word characters (a-zA-Z0-9_) and/or literal colon (:),
+             * and\or literal hyphen (-), up to the first white-space character or a
+             * literal opening curly brace ({). The match is then replaced with the
+             * command name from config, and the result is a renamed signature.
+             */
+            $this->signature = preg_replace(
+                self::SIGNATURE_REGEX_PATTERN, $commandName,  $this->signature, 1
+            );
+        }
     }
 }

src/DoctrineQueueProvider.php

@@ -11,16 +11,31 @@
  */
 class DoctrineQueueProvider extends ServiceProvider
 {
+    protected $defer = true;
+
     /**
      * Register the service provider.
      *
      * @return void
      */
     public function register()
     {
+        $this->publishes([
+            __DIR__ . '/../config/safequeue.php' => config_path('safequeue.php'),
+        ], 'safequeue');
+
+        $this->mergeConfigFrom(
+            __DIR__ . '/../config/safequeue.php', 'safequeue'
+        );
+
         $this->registerWorker();
     }
 
+    public function boot()
+    {
+        $this->commands('command.safeQueue.work');
+    }
+
     /**
      * @return void
      */
@@ -40,9 +55,23 @@ protected function registerWorker()
     protected function registerWorkCommand()
     {
         $this->app->singleton('command.safeQueue.work', function ($app) {
-            return new WorkCommand($app['safeQueue.worker']);
+            return new WorkCommand(
+                $app['safeQueue.worker'],
+                $app['config']->get('safequeue')
+            );
         });
+    }
 
-        $this->commands('command.safeQueue.work');
+    /**
+     * Get the services provided by the provider.
+     *
+     * @return array
+     */
+    public function provides()
+    {
+        return [
+            'safeQueue.worker',
+            'command.safeQueue.work'
+        ];
     }
 }

tests/Console/WorkCommandTest.php

@@ -21,42 +21,91 @@ class WorkCommandTest extends \PHPUnit_Framework_TestCase
     private $command;
 
     /**
-     * @var ReflectionClass
+     * @var string
      */
-    private $reflectedCommand;
+    private $defaultCommandName;
 
     /**
-     * @var string
+     * @var array
+     */
+    private $testNewCommandNames;
+
+    /**
+     * @var array
      */
-    private $intendedCommandName;
+    private $configStub;
 
     protected function setUp()
     {
         $this->worker = m::mock(Worker::class);
-        $this->command = new WorkCommand($this->worker);
-        $this->intendedCommandName = 'doctrine:queue:work';
-
-        // Use reflection to peek at the worker
-        $this->reflectedCommand = new ReflectionClass(get_class($this->command));
+        $this->defaultCommandName = 'doctrine:queue:work';
+        $this->configStub = ['command_name' => $this->defaultCommandName];
+        $this->command = new WorkCommand($this->worker, $this->configStub);
+        $this->testNewCommandNames = [
+            'queue:work',
+            'custom-queue:work',
+            'doctrine-queue-work',
+            'doctrine123-queue-work',
+        ];
     }
 
     public function testHasCorrectWorker()
     {
-        $reflectionProperty = $this->reflectedCommand->getProperty('worker');
-        $reflectionProperty->setAccessible(true);
-
-        $worker = $reflectionProperty->getValue($this->command);
+        $worker = $this->getPropertyViaReflection('worker');
 
         $this->assertSame($this->worker, $worker);
     }
 
-    public function testCommandNameIsCorrect()
+    /**
+     * @param $propertyName
+     * @return mixed
+     */
+    private function getPropertyViaReflection($propertyName)
     {
-        $reflectionProperty = $this->reflectedCommand->getProperty('signature');
+        // Use reflection to peek at the worker
+        $reflectedCommand = new ReflectionClass(get_class($this->command));
+        $reflectionProperty = $reflectedCommand->getProperty($propertyName);
         $reflectionProperty->setAccessible(true);
 
-        $signature = $reflectionProperty->getValue($this->command);
+        return $reflectionProperty->getValue($this->command);
+    }
+
+    public function testCommandNameIsCorrectAsDefault()
+    {
+        $signature = $this->getPropertyViaReflection('signature');
+
+        $this->assertEquals($this->defaultCommandName, $this->getCommandNameFromSignature($signature));
+    }
+
+    public function testCommandNameCanBeConfigured()
+    {
+        foreach($this->testNewCommandNames as $newCommandName) {
+
+            $this->command = new WorkCommand($this->worker, [
+                'command_name' => $newCommandName
+            ]);
+
+            $signature = $this->getPropertyViaReflection('signature');
+
+            $this->assertEquals($newCommandName, $this->getCommandNameFromSignature($signature));
+        }
+    }
+
+    public function testCommandNameCanConfiguredToLaravelDefaultBySettingConfigValueToFalse()
+    {
+        $this->command = new WorkCommand($this->worker, [
+            'command_name' => false
+        ]);
+
+        $signature = $this->getPropertyViaReflection('signature');
+
+        $this->assertEquals('queue:work', $this->getCommandNameFromSignature($signature));
+    }
+
+    private function getCommandNameFromSignature($signature)
+    {
+        preg_match(WorkCommand::SIGNATURE_REGEX_PATTERN, $signature, $matches);
 
-        $this->assertContains($this->intendedCommandName, $signature);
+        return $matches[1];
     }
 }