Merge pull request #5 from Teknasyon-Teknoloji/master

Added isMyJob method to job handler interface - BC Break

.gitignore

@@ -1,4 +1,5 @@
 .idea/
 composer.lock
+composer.phar
 vendor/
 logs/

README.md

@@ -85,7 +85,10 @@ The job interface is used to manage the job received in the queue. It must manag
 business logic and **define the STOP job**.
 
 The job is abstracted form the queue system, so the same job definition is able to work with
-different queues interfaces. The job always receive the message body from the queue,
+different queues interfaces. The job always receive the message body from the queue.
+
+If you have different job types ( send mail, crop images, etc. ) and you use one queue, you can define **isMyJob**. 
+If job is not expected type, you can send back job to queue.
 
 Install
 -------
@@ -135,6 +138,11 @@ class MyJob implements Job {
         return FALSE;
     }
 
+    public function isMyJob($job) {
+            if ( ... )
+                return TRUE;
+            return FALSE;
+    }
     ...
 
 }

src/Simpleue/Job/Job.php

@@ -10,4 +10,5 @@
 interface Job {
     public function manage($job);
     public function isStopJob($job);
+    public function isMyJob($job);
 }

src/Simpleue/Worker/QueueWorker.php

@@ -74,7 +74,7 @@ public function start()
                 $this->queueHandler->error(false, $exception);
                 continue;
             }
-            if ($this->isValidJob($job)) {
+            if ($this->isValidJob($job) && $this->jobHandler->isMyJob($this->queueHandler->getMessageBody($job))) {
                 if ($this->jobHandler->isStopJob($this->queueHandler->getMessageBody($job))) {
                     $this->queueHandler->stopped($job);
                     $this->log('debug', 'STOP instruction received.');

tests/Simpleue/Mocks/JobSpy.php

@@ -31,6 +31,10 @@ public function isStopJob($job) {
         return ($job === 'STOP');
     }
 
+    public function isMyJob($job) {
+        return ($job !== false);
+    }
+
     public function setQuitCount($num) {
         $this->quitCount = $num;
     }

tests/Simpleue/Unitary/Worker/QueueWorkerTest.php

@@ -44,7 +44,7 @@ public function testRunManageSuccessfulJob() {
         $this->assertEquals(0, $this->sourceQueueMock->errorCounter, 'Error counter');
         $this->assertEquals(0, $this->sourceQueueMock->nothingToDoCounter, 'Nothing to do counter');
         $this->assertEquals(0, $this->sourceQueueMock->stoppedCounter, 'Stop inst. management counter');
-        $this->assertEquals(20, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
+        $this->assertEquals(30, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
     }
 
     public function testStopInstruction() {
@@ -62,7 +62,7 @@ public function testStopInstruction() {
         $this->assertEquals(0, $this->sourceQueueMock->errorCounter, 'Error counter');
         $this->assertEquals(0, $this->sourceQueueMock->nothingToDoCounter, 'Nothing to do counter');
         $this->assertEquals(1, $this->sourceQueueMock->stoppedCounter, 'Stop inst. management counter');
-        $this->assertEquals(5, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
+        $this->assertEquals(8, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
     }
 
     public function testNothingToDo() {
@@ -73,16 +73,21 @@ public function testNothingToDo() {
         $this->sourceQueueMock->expects($this->at(3))->method('getNext')->willReturn(0);
         $this->sourceQueueMock->expects($this->at(4))->method('getNext')->willReturn('');
 
+        $this->jobHandlerMock = $this->getMock('Simpleue\Mocks\JobSpy', array('isMyJob'));
+        $this->jobHandlerMock->expects($this->at(0))->method('isMyJob')->willReturn(true);
+        $this->jobHandlerMock->expects($this->at(1))->method('isMyJob')->willReturn(false);
+        $this->jobHandlerMock->expects($this->at(2))->method('isMyJob')->willReturn(true);
+
         $this->queueWorkerSpy = new QueueWorkerSpy($this->sourceQueueMock, $this->jobHandlerMock);
         $this->queueWorkerSpy->setMaxIterations(5);
         $this->queueWorkerSpy->start();
         $this->assertEquals(5, $this->queueWorkerSpy->getIterations());
-        $this->assertEquals(3, $this->sourceQueueMock->successfulCounter, 'Successful counter');
+        $this->assertEquals(2, $this->sourceQueueMock->successfulCounter, 'Successful counter');
         $this->assertEquals(0, $this->sourceQueueMock->failedCounter, 'Failed counter');
         $this->assertEquals(0, $this->sourceQueueMock->errorCounter, 'Error counter');
-        $this->assertEquals(2, $this->sourceQueueMock->nothingToDoCounter, 'Nothing to do counter');
+        $this->assertEquals(3, $this->sourceQueueMock->nothingToDoCounter, 'Nothing to do counter');
         $this->assertEquals(0, $this->sourceQueueMock->stoppedCounter, 'Stop inst. management counter');
-        $this->assertEquals(6, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
+        $this->assertEquals(7, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
     }
 
     public function testRunManagedFailedJobs() {
@@ -102,7 +107,7 @@ public function testRunManagedFailedJobs() {
         $this->assertEquals(0, $this->sourceQueueMock->errorCounter, 'Error counter');
         $this->assertEquals(0, $this->sourceQueueMock->nothingToDoCounter, 'Nothing to do counter');
         $this->assertEquals(0, $this->sourceQueueMock->stoppedCounter, 'Stop inst. management counter');
-        $this->assertEquals(10, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
+        $this->assertEquals(15, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
     }
 
     public function testHandlerManageExceptions() {
@@ -121,7 +126,7 @@ public function testHandlerManageExceptions() {
         $this->assertEquals(2, $this->sourceQueueMock->errorCounter, 'Error counter');
         $this->assertEquals(0, $this->sourceQueueMock->nothingToDoCounter, 'Nothing to do counter');
         $this->assertEquals(0, $this->sourceQueueMock->stoppedCounter, 'Stop inst. management counter');
-        $this->assertEquals(8, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
+        $this->assertEquals(12, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
     }
 
     public function testSourceQueueGetNextExceptions() {
@@ -139,7 +144,7 @@ public function testSourceQueueGetNextExceptions() {
         $this->assertEquals(2, $this->sourceQueueMock->errorCounter, 'Error counter');
         $this->assertEquals(0, $this->sourceQueueMock->nothingToDoCounter, 'Nothing to do counter');
         $this->assertEquals(0, $this->sourceQueueMock->stoppedCounter, 'Stop inst. management');
-        $this->assertEquals(2, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
+        $this->assertEquals(3, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
     }
 
     public function testSourceQueueSuccessfulAndFailedExceptions() {
@@ -161,7 +166,7 @@ public function testSourceQueueSuccessfulAndFailedExceptions() {
         $this->assertEquals(2, $this->sourceQueueMock->errorCounter, 'Error counter');
         $this->assertEquals(0, $this->sourceQueueMock->nothingToDoCounter, 'Nothing to do counter');
         $this->assertEquals(0, $this->sourceQueueMock->stoppedCounter, 'Stop inst. management counter');
-        $this->assertEquals(8, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
+        $this->assertEquals(12, $this->sourceQueueMock->getMessageBodyCounter, 'Message body counter');
     }
 
     public function testWorkerExitsGracefullyOnSigINT() {