Merge pull request #16 from kingjerod/develop2

Adding support for getOneOrNullResult
michaelmoussa · Mar 6, 2015 · 5ca0471 · 5ca0471
2 parents 811cc31 + 220a9f7
commit 5ca0471
Show file tree

Hide file tree

Showing 5 changed files with 94 additions and 3 deletions.
diff --git a/src/Test/ODM/MongoDB/QueryBuilderMocker.php b/src/Test/ODM/MongoDB/QueryBuilderMocker.php
@@ -205,6 +205,7 @@ class QueryBuilderMocker extends BaseQueryBuilderMocker
         'withinPolygon',
         'execute',
         'getSingleResult',
+        'getOneOrNullResult'
     );
 
     /**
@@ -220,7 +221,7 @@ public function __construct(PHPUnit_Framework_TestCase $testCase)
             ->getMock();
         $this->query = $testCase->getMockBuilder('Doctrine\ODM\MongoDB\Query\Query')
             ->disableOriginalConstructor()
-            ->setMethods(array('execute', 'getSingleResult'))
+            ->setMethods(array('execute', 'getSingleResult', 'getOneOrNullResult'))
             ->getMock();
     }
 
@@ -261,4 +262,20 @@ protected function getSingleResult(array $args)
 
         return $this;
     }
+
+    /**
+     * @param array|null $args
+     * @return $this
+     */
+    protected function getOneOrNullResult(array $args)
+    {
+        $invocationMocker = $this->query->expects($this->testCase->once())->method('getOneOrNullResult');
+
+        // QueryBuilderMocker "getOneOrNullResult" parameter is the intended final result to return.
+        if (count($args) > 0) {
+            $invocationMocker->will($this->testCase->returnValue($args[0]));
+        }
+
+        return $this;
+    }
 }
diff --git a/src/Test/ORM/QueryBuilderMocker.php b/src/Test/ORM/QueryBuilderMocker.php
@@ -81,7 +81,8 @@ class QueryBuilderMocker extends BaseQueryBuilderMocker
         'useResultCache',
         'getSingleResult',
         'getSingleScalarResult',
-        'getArrayResult'
+        'getArrayResult',
+        'getOneOrNullResult'
     );
 
     /**
@@ -97,7 +98,14 @@ public function __construct(PHPUnit_Framework_TestCase $testCase)
             ->getMock();
         $this->query = $testCase->getMockBuilder('StubQuery') // can't mock Doctrine's "Query" because it's "final"
             ->setMethods(
-                array('execute', 'useResultCache', 'getSingleResult', 'getSingleScalarResult', 'getArrayResult')
+                array(
+                    'execute',
+                    'useResultCache',
+                    'getSingleResult',
+                    'getSingleScalarResult',
+                    'getArrayResult',
+                    'getOneOrNullResult'
+                )
             )
             ->disableOriginalConstructor()
             ->getMock();
@@ -182,6 +190,22 @@ protected function getArrayResult(array $args)
         return $this;
     }
 
+    /**
+     * @param array|null $args
+     * @return $this
+     */
+    protected function getOneOrNullResult(array $args)
+    {
+        $invocationMocker = $this->query->expects($this->testCase->once())->method('getOneOrNullResult');
+
+        // QueryBuilderMocker "getOneOrNullResult" parameter is the intended final result to return.
+        if (count($args) > 0) {
+            $invocationMocker->will($this->testCase->returnValue($args[0]));
+        }
+
+        return $this;
+    }
+
     /**
      * Override for methods that are specific to ORM
      *

diff --git a/src/Test/QueryBuilderMocker.php b/src/Test/QueryBuilderMocker.php
@@ -74,6 +74,10 @@ public function __call($method, array $args)
             return $this->getSingleResult($args);
         }
 
+        if ($method === 'getOneOrNullResult') {
+            return $this->getOneOrNullResult($args);
+        }
+
         $invocationMocker = $this->queryBuilder->expects($this->testCase->at($this->at))
             ->method($method);
         $this->at++; // increment to maintain expected execution order
@@ -117,4 +121,12 @@ abstract protected function execute(array $args);
      * @return \Doctrine\ODM\MongoDB\Query\Builder|\Doctrine\ORM\QueryBuilder
      */
     abstract protected function getSingleResult(array $args);
+
+    /**
+     * Handles mocking of getOneOrNullResult calls, which are another special case
+     *
+     * @param array|null $args
+     * @return \Doctrine\ODM\MongoDB\Query\Builder|\Doctrine\ORM\QueryBuilder
+     */
+    abstract protected function getOneOrNullResult(array $args);
 }
diff --git a/test/Test/ODM/MongoDB/QueryBuilderMockerTest.php b/test/Test/ODM/MongoDB/QueryBuilderMockerTest.php
@@ -86,6 +86,25 @@ public function testMockingGetSingleResultWithNoParamWillCauseItToReturnNull()
         $this->assertNull($result);
     }
 
+    public function testValuePassedToMockingGetOneOrNullResultIsReturned()
+    {
+        $qbm = new QueryBuilderMocker($this);
+        $qbm->getQuery()->getOneOrNullResult(123);
+
+        $qb = $qbm->getQueryBuilderMock();
+        $this->assertEquals(123, $qb->getQuery()->getOneOrNullResult());
+    }
+
+    public function testMockingGetOneOrNullResultWithNoParamCauseItToReturnNull()
+    {
+        $qbm = new QueryBuilderMocker($this);
+        $qbm->getQuery()->getOneOrNullResult();
+
+        $qb = $qbm->getQueryBuilderMock();
+        $result = $qb->getQuery()->getOneOrNullResult();
+        $this->assertNull($result);
+    }
+
     public function testCanMockChainedMethodCallsToQuery()
     {
         $qbm = new QueryBuilderMocker($this);

diff --git a/test/Test/ORM/QueryBuilderMockerTest.php b/test/Test/ORM/QueryBuilderMockerTest.php
@@ -164,6 +164,25 @@ public function testMockingExecuteWithNoParamWillCauseItToReturnNull()
         $this->assertNull($result);
     }
 
+    public function testValuePassedToMockingGetOneOrNullResultIsReturned()
+    {
+        $qbm = new QueryBuilderMocker($this);
+        $qbm->getQuery()->getOneOrNullResult(123);
+
+        $qb = $qbm->getQueryBuilderMock();
+        $this->assertEquals(123, $qb->getQuery()->getOneOrNullResult());
+    }
+
+    public function testMockingGetOneOrNullResultWithNoParamCauseItToReturnNull()
+    {
+        $qbm = new QueryBuilderMocker($this);
+        $qbm->getQuery()->getOneOrNullResult();
+
+        $qb = $qbm->getQueryBuilderMock();
+        $result = $qb->getQuery()->getOneOrNullResult();
+        $this->assertNull($result);
+    }
+
     public function testCanMockChainedMethodCallsToQuery()
     {
         $qbm = new QueryBuilderMocker($this);