Implement callback checking in the provider

Doctrine/AbstractProvider.php

@@ -6,6 +6,7 @@ use Doctrine\Common\Persistence\ManagerRegistry;
 use Elastica\Exception\Bulk\ResponseException as BulkResponseException;
 use FOS\ElasticaBundle\Persister\ObjectPersisterInterface;
 use FOS\ElasticaBundle\Provider\AbstractProvider as BaseAbstractProvider;
+use FOS\ElasticaBundle\Provider\IndexableInterface;
 
 abstract class AbstractProvider extends BaseAbstractProvider
 {
@@ -15,13 +16,19 @@ abstract class AbstractProvider extends BaseAbstractProvider
      * Constructor.
      *
      * @param ObjectPersisterInterface $objectPersister
-     * @param string                   $objectClass
-     * @param array                    $options
-     * @param ManagerRegistry          $managerRegistry
+     * @param IndexableInterface $indexable
+     * @param string $objectClass
+     * @param array $options
+     * @param ManagerRegistry $managerRegistry
      */
-    public function __construct(ObjectPersisterInterface $objectPersister, $objectClass, array $options, $managerRegistry)
-    {
-        parent::__construct($objectPersister, $objectClass, array_merge(array(
+    public function __construct(
+        ObjectPersisterInterface $objectPersister,
+        IndexableInterface $indexable,
+        $objectClass,
+        array $options,
+        ManagerRegistry $managerRegistry
+    ) {
+        parent::__construct($objectPersister, $indexable, $objectClass, array_merge(array(
             'clear_object_manager' => true,
             'debug_logging'        => false,
             'ignore_errors'        => false,
@@ -53,6 +60,10 @@ abstract class AbstractProvider extends BaseAbstractProvider
                 $stepStartTime = microtime(true);
             }
             $objects = $this->fetchSlice($queryBuilder, $batchSize, $offset);
+            if ($loggerClosure) {
+                $stepNbObjects = count($objects);
+            }
+            $objects = array_filter($objects, array($this, 'isObjectIndexable'));
 
             if (!$ignoreErrors) {
                 $this->objectPersister->insertMany($objects);
@@ -73,7 +84,6 @@ abstract class AbstractProvider extends BaseAbstractProvider
             usleep($sleep);
 
             if ($loggerClosure) {
-                $stepNbObjects = count($objects);
                 $stepCount = $stepNbObjects + $offset;
                 $percentComplete = 100 * $stepCount / $nbObjects;
                 $timeDifference = microtime(true) - $stepStartTime;

Persister/ObjectPersisterInterface.php

@@ -68,4 +68,11 @@ interface ObjectPersisterInterface
      * @param array $identifiers array of domain model object identifiers
      */
     public function deleteManyByIdentifiers(array $identifiers);
+
+    /**
+     * Returns the elastica type used by this persister
+     *
+     * @return \Elastica\Type
+     */
+    public function getType();
 }

Provider/AbstractProvider.php

@@ -24,23 +24,48 @@ abstract class AbstractProvider implements ProviderInterface
      */
     protected $options;
 
+    /**
+     * @var Indexable
+     */
+    private $indexable;
+
     /**
      * Constructor.
      *
      * @param ObjectPersisterInterface $objectPersister
-     * @param string                   $objectClass
-     * @param array                    $options
+     * @param IndexableInterface $indexable
+     * @param string $objectClass
+     * @param array $options
      */
-    public function __construct(ObjectPersisterInterface $objectPersister, $objectClass, array $options = array())
-    {
-        $this->objectPersister = $objectPersister;
+    public function __construct(
+        ObjectPersisterInterface $objectPersister,
+        IndexableInterface $indexable,
+        $objectClass,
+        array $options = array()
+    ) {
+        $this->indexable = $indexable;
         $this->objectClass = $objectClass;
+        $this->objectPersister = $objectPersister;
 
         $this->options = array_merge(array(
             'batch_size' => 100,
         ), $options);
     }
 
+    /**
+     * Checks if a given object should be indexed or not.
+     *
+     * @param object $object
+     * @return bool
+     */
+    protected function isObjectIndexable($object)
+    {
+        $typeName = $this->objectPersister->getType()->getName();
+        $indexName = $this->objectPersister->getType()->getIndex()->getName();
+
+        return $this->indexable->isObjectIndexable($indexName, $typeName, $object);
+    }
+
     /**
      * Get string with RAM usage information (current and peak)
      *

Tests/Doctrine/AbstractProviderTest.php

@@ -9,24 +9,42 @@ class AbstractProviderTest extends \PHPUnit_Framework_TestCase
     private $objectPersister;
     private $options;
     private $managerRegistry;
+    private $indexable;
 
     public function setUp()
     {
-       if (!interface_exists('Doctrine\Common\Persistence\ManagerRegistry')) {
-           $this->markTestSkipped('Doctrine Common is not available.');
-       }
+        if (!interface_exists('Doctrine\Common\Persistence\ManagerRegistry')) {
+            $this->markTestSkipped('Doctrine Common is not available.');
+        }
 
-       $this->objectClass = 'objectClass';
-       $this->options = array('debug_logging' => true);
+        $this->objectClass = 'objectClass';
+        $this->options = array('debug_logging' => true);
 
-       $this->objectPersister = $this->getMockObjectPersister();
-       $this->managerRegistry = $this->getMockManagerRegistry();
-       $this->objectManager = $this->getMockObjectManager();
+        $this->objectPersister = $this->getMockObjectPersister();
+        $this->managerRegistry = $this->getMockManagerRegistry();
+        $this->objectManager = $this->getMockObjectManager();
+        $this->indexable = $this->getMockIndexable();
 
-       $this->managerRegistry->expects($this->any())
-           ->method('getManagerForClass')
-           ->with($this->objectClass)
-           ->will($this->returnValue($this->objectManager));
+        $index = $this->getMockBuilder('Elastica\Index')->disableOriginalConstructor()->getMock();
+        $index->expects($this->any())
+            ->method('getName')
+            ->will($this->returnValue('index'));
+        $type = $this->getMockBuilder('Elastica\Type')->disableOriginalConstructor()->getMock();
+        $type->expects($this->any())
+            ->method('getName')
+            ->will($this->returnValue('type'));
+        $type->expects($this->any())
+            ->method('getIndex')
+            ->will($this->returnValue($index));
+
+        $this->objectPersister->expects($this->any())
+            ->method('getType')
+            ->will($this->returnValue($type));
+
+        $this->managerRegistry->expects($this->any())
+            ->method('getManagerForClass')
+            ->with($this->objectClass)
+            ->will($this->returnValue($this->objectManager));
     }
 
     /**
@@ -59,14 +77,13 @@ class AbstractProviderTest extends \PHPUnit_Framework_TestCase
                 ->with($queryBuilder, $batchSize, $offset)
                 ->will($this->returnValue($objects));
 
-            $this->objectPersister->expects($this->at($i))
-                ->method('insertMany')
-                ->with($objects);
-
             $this->objectManager->expects($this->at($i))
                 ->method('clear');
         }
 
+        $this->objectPersister->expects($this->exactly(count($objectsByIteration)))
+            ->method('insertMany');
+
         $provider->populate();
     }
 
@@ -159,6 +176,36 @@ class AbstractProviderTest extends \PHPUnit_Framework_TestCase
         $provider->populate(null, array('ignore-errors' => false));
     }
 
+    public function testPopulateRunsIndexCallable()
+    {
+        $nbObjects = 2;
+        $objects = array(1, 2);
+
+        $provider = $this->getMockAbstractProvider();
+        $provider->expects($this->any())
+            ->method('countObjects')
+            ->will($this->returnValue($nbObjects));
+        $provider->expects($this->any())
+            ->method('fetchSlice')
+            ->will($this->returnValue($objects));
+
+        $this->indexable->expects($this->at(0))
+            ->method('isObjectIndexable')
+            ->with('index', 'type', 1)
+            ->will($this->returnValue(false));
+        $this->indexable->expects($this->at(1))
+            ->method('isObjectIndexable')
+            ->with('index', 'type', 2)
+            ->will($this->returnValue(true));
+
+
+        $this->objectPersister->expects($this->once())
+            ->method('insertMany')
+            ->with(array(1 => 2));
+
+        $provider->populate();
+    }
+
     /**
      * @return \FOS\ElasticaBundle\Doctrine\AbstractProvider|\PHPUnit_Framework_MockObject_MockObject
      */
@@ -166,6 +213,7 @@ class AbstractProviderTest extends \PHPUnit_Framework_TestCase
     {
         return $this->getMockForAbstractClass('FOS\ElasticaBundle\Doctrine\AbstractProvider', array(
             $this->objectPersister,
+            $this->indexable,
             $this->objectClass,
             $this->options,
             $this->managerRegistry,
@@ -205,6 +253,14 @@ class AbstractProviderTest extends \PHPUnit_Framework_TestCase
     {
         return $this->getMock('FOS\ElasticaBundle\Persister\ObjectPersisterInterface');
     }
+
+    /**
+     * @return \FOS\ElasticaBundle\Provider\IndexableInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private function getMockIndexable()
+    {
+        return $this->getMock('FOS\ElasticaBundle\Provider\IndexableInterface');
+    }
 }
 
 /**