Merge pull request #1354 from Tobion/remove-propel

remove Propel support

Author: Tobion

CHANGELOG-5.0.md

@@ -6,7 +6,7 @@ in 5.0 versions.
 
 ### 5.0.0 (2017-xx-xx)
 
-* Add `ruflin/elastica` 5.x support.
+* Add `ruflin/elastica` 5.x and 6.x support.
 * Add asnychronous index update option.
 * Add ability to close an index.
 * Add support for HTTP authentication.
@@ -21,3 +21,4 @@ in 5.0 versions.
 * [BC break] Removed deprecated config options `servers`, `mappings` and `is_indexable_callback`.
 * [BC break] Add `PaginatedFinderInterface::createRawPaginatorAdapter`.
 * [BC break] Add `PaginatorAdapterInterface::getMaxScore`.
+* [BC break] Removed Propel support.

README.md

@@ -8,8 +8,6 @@ Symfony. Features include:
 - Automatically generate mappings using a serializer
 - Listeners for Doctrine events for automatic indexing
 
-> **Note** Propel support is limited and contributions fixing issues are welcome!
-
 [![Build Status](https://secure.travis-ci.org/FriendsOfSymfony/FOSElasticaBundle.png?branch=master)](http://travis-ci.org/FriendsOfSymfony/FOSElasticaBundle) [![Total Downloads](https://poser.pugx.org/FriendsOfSymfony/elastica-bundle/downloads.png)](https://packagist.org/packages/FriendsOfSymfony/elastica-bundle) [![Latest Stable Version](https://poser.pugx.org/FriendsOfSymfony/elastica-bundle/v/stable.png)](https://packagist.org/packages/FriendsOfSymfony/elastica-bundle) [![Latest Unstable Version](https://poser.pugx.org/friendsofsymfony/elastica-bundle/v/unstable.svg)](https://packagist.org/packages/friendsofsymfony/elastica-bundle)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/FriendsOfSymfony/FOSElasticaBundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/FriendsOfSymfony/FOSElasticaBundle/?branch=master)
 

UPGRADE-5.0.md

@@ -2,21 +2,24 @@ UPGRADE FROM 4.0 to 5.0
 =======================
 
 ### Elastica library changes
-Elastica has been updated to version 5.1. Please consider [their changelog for an upgrade guide](https://github.com/ruflin/Elastica/blob/master/CHANGELOG.md#510).
+The bundle now works with Elastica version 5 and 6 (instead of 3.2).
+Please consider [their changelog for an upgrade guide](https://github.com/ruflin/Elastica/blob/master/CHANGELOG.md).
+One of the implications is that it also needs Elasticsearch version 5 or 6.
 
 ### API Changes
   * Removed `sortIgnoreUnmapped` support for Paginator. `ignore_unmapped` is not supported in ES 5.0 anymore.
   * Removed `ttl` and `timestamp` support in configuration. These attributes are not supported in ES 5.0 anymore.
+  * Removed Propel support.
 
 ### Provider Changes
 The provider's related logic has been reworked completely (more in #1240 PR). 
-Legacy providers did a lot so their responsibility was split apart into several objects.
+Legacy providers did a lot, so their responsibility was split apart into several objects.
 A new `PagerProvider` is responsible for fetching object from database. 
 It should return an instance of  `PagerInterface`. The pager provides a page-oriented access to objects.
 There is a `InPlacePagerPersister` object that is responsible for iterating over a pager and persisting objects to the index.
 It also dispatches different types of events, it helps developers to hook into the persisting process.
-Removed stuff:
-    
+
+#### Removed stuff:
 * `FOS\ElasticaBundle\DependencyInjection\Compiler\RegisterProvidersPass` class was removed. As well as `fos_elastica.provider` tag.
 * `FOS\ElasticaBundle\Doctrine\AbstractProvider` class was removed.
 * `FOS\ElasticaBundle\Doctrine\SliceFetcherInterface` class was removed.
@@ -26,10 +29,7 @@ Removed stuff:
 * `FOS\ElasticaBundle\Doctrine\ORM\Provider` class was removed.
 * `FOS\ElasticaBundle\Doctrine\PHPCR\SliceFetcher` class was removed.
 * `FOS\ElasticaBundle\Doctrine\PHPCR\Provider` class was removed.
-* `FOS\ElasticaBundle\Propel\Provider` class was removed.
 * `FOS\ElasticaBundle\Provider\AbstractProvider` class was removed.
 * `FOS\ElasticaBundle\Provider\ProviderInterface` class was removed.
 * `FOS\ElasticaBundle\Provider\ProviderRegistry` class was removed.
 * `FOS\ElasticaBundle\Provider\ProviderRegistry` class was removed.
-    
-

composer.json

@@ -2,7 +2,7 @@
     "name": "friendsofsymfony/elastica-bundle",
     "type": "symfony-bundle",
     "description": "Elasticsearch PHP integration for your Symfony project using Elastica",
-    "keywords": ["doctrine2", "elastica", "elasticsearch", "mongodb", "propel", "search"],
+    "keywords": ["doctrine2", "elastica", "elasticsearch", "mongodb", "search"],
     "homepage": "https://github.com/FriendsOfSymfony/FOSElasticaBundle",
     "license": "MIT",
     "authors": [
@@ -15,6 +15,7 @@
         "php": ">=5.6.0",
         "symfony/framework-bundle": "^3.2|^4",
         "symfony/console": "^3.2|^4",
+        "symfony/dependency-injection": "^3.3|^4",
         "symfony/options-resolver" : "^3.2|^4",
         "symfony/property-access": "^3.2|^4",
         "pagerfanta/pagerfanta": "^1.0.5",
@@ -29,17 +30,13 @@
         "jackalope/jackalope-doctrine-dbal": "^1.2",
         "jms/serializer-bundle": "^2.2",
         "phpunit/phpunit": "^5.7.11|^6.5",
-        "propel/propel1": "^1.7",
         "knplabs/knp-components": "^1.2",
         "symfony/expression-language" : "^3.2|^4",
         "symfony/twig-bundle": "^3.2|^4",
         "symfony/serializer": "^3.2|^4",
         "symfony/yaml": "^3.2|^4",
         "friendsofphp/php-cs-fixer": "^2.2"
     },
-    "conflict": {
-        "symfony/dependency-injection": "<3.3"
-    },
     "suggest": {
         "enqueue/elastica-bundle": "The bundle adds extra features to FOSElasticaBundle bundle. Aimed to improve performance."
     },

doc/cookbook/manual-provider.md

@@ -35,9 +35,8 @@ class UserPagerProvider implements PagerProviderInterface
 
 There are some examples:
 
-* [DoctrineORMPagerProvider](https://github.com/FriendsOfSymfony/FOSElasticaBundle/blob/master/Doctrine/DoctrineORMPagerProvider.php)
-* [DoctrinePHPCRPagerProvider](https://github.com/FriendsOfSymfony/FOSElasticaBundle/blob/master/Doctrine/DoctrinePHPCRPagerProvider.php)
-* [DoctrineMongoDBPagerProvider](https://github.com/FriendsOfSymfony/FOSElasticaBundle/blob/master/Doctrine/DoctrineMongoDBPagerProvider.php)
-* [Propel1PagerProvider](https://github.com/FriendsOfSymfony/FOSElasticaBundle/blob/master/Propel/Propel1PagerProvider.php)
+* [ORMPagerProvider](../../src/Doctrine/ORMPagerProvider.php)
+* [PHPCRPagerProvider](../../src/Doctrine/PHPCRPagerProvider.php)
+* [MongoDBPagerProvider](../../src/Doctrine/MongoDBPagerProvider.php)
 
 [Back to index](../index.md)

doc/provider.md

@@ -22,7 +22,7 @@ fos_elastica:
                         provider: ~
 ```
 
-There are other providers Doctrine MongoDB, Doctrine PHPCR, Propel1 available.
+There are other providers Doctrine MongoDB, Doctrine PHPCR available.
 
 
 Provider options

doc/setup.md

@@ -108,8 +108,7 @@ Each defined type is made available as a service, and in this case the service k
 `fos_elastica.index.app.user` and is an instance of `Elastica\Type`.
 
 FOSElasticaBundle requires a provider for each type that will notify when an object
-that maps to a type has been modified. The bundle ships with support for Doctrine and
-Propel objects.
+that maps to a type has been modified. The bundle ships with support for Doctrine objects.
 
 Below is an example for the Doctrine ORM.
 
@@ -121,9 +120,7 @@ Below is an example for the Doctrine ORM.
                         lastName: ~
                         email: ~
                     persistence:
-                        # the driver can be orm, mongodb, phpcr or propel
-                        # listener and finder are not supported by
-                        # propel and should be removed
+                        # the driver can be orm, mongodb or phpcr
                         driver: orm
                         model: Acme\ApplicationBundle\Entity\User
                         provider: ~

doc/types.md

@@ -304,7 +304,7 @@ Declare that you want to update the index in real time:
 ```yaml
                 user:
                     persistence:
-                        driver: orm #the driver can be orm, mongodb, phpcr or propel
+                        driver: orm #the driver can be orm, mongodb or phpcr
                         model: Application\UserBundle\Entity\User
                         listener: ~ # by default, listens to "insert", "update" and "delete"
 ```
@@ -322,8 +322,6 @@ You can also choose to only listen for some of the events:
                             delete: true
 ```
 
-> **Propel** doesn't support this feature yet.
-
 ### Asynchronous index update
 
 You can also tell ElasticaBundle to update the indexes after Symfony response has returned.

phpunit.xml.dist

@@ -17,17 +17,15 @@
 
     <testsuites>
         <testsuite name="FOSElasticaBundle Test Suite">
-            <directory>./Tests</directory>
+            <directory>./tests</directory>
         </testsuite>
     </testsuites>
 
     <filter>
         <whitelist>
-            <directory>./</directory>
+            <directory>./src</directory>
             <exclude>
-                <directory>./Resources</directory>
-                <directory>./Tests</directory>
-                <directory>./vendor</directory>
+                <directory>./src/Resources</directory>
             </exclude>
         </whitelist>
     </filter>

src/DependencyInjection/Configuration.php

@@ -17,12 +17,7 @@
 
 class Configuration implements ConfigurationInterface
 {
-    /**
-     * Stores supported database drivers.
-     *
-     * @var array
-     */
-    private $supportedDrivers = ['orm', 'mongodb', 'propel', 'phpcr'];
+    const SUPPORTED_DRIVERS = ['orm', 'mongodb', 'phpcr'];
 
     /**
      * If the kernel is running in debug mode.
@@ -287,14 +282,6 @@ protected function getPersistenceNode()
 
         $node
             ->validate()
-                ->ifTrue(function ($v) {
-                    return isset($v['driver']) && 'propel' === $v['driver'] && isset($v['listener']);
-                })
-                    ->thenInvalid('Propel doesn\'t support listeners')
-                ->ifTrue(function ($v) {
-                    return isset($v['driver']) && 'propel' === $v['driver'] && isset($v['repository']);
-                })
-                    ->thenInvalid('Propel doesn\'t support the "repository" parameter')
                 ->ifTrue(function ($v) {
                     return isset($v['driver']) && 'orm' !== $v['driver'] && !empty($v['elastica_to_model_transformer']['hints']);
                 })
@@ -304,8 +291,8 @@ protected function getPersistenceNode()
                 ->scalarNode('driver')
                     ->defaultValue('orm')
                     ->validate()
-                    ->ifNotInArray($this->supportedDrivers)
-                        ->thenInvalid('The driver %s is not supported. Please choose one of '.json_encode($this->supportedDrivers))
+                    ->ifNotInArray(self::SUPPORTED_DRIVERS)
+                        ->thenInvalid('The driver %s is not supported. Please choose one of '.json_encode(self::SUPPORTED_DRIVERS))
                     ->end()
                 ->end()
                 ->scalarNode('model')->defaultValue(null)->end()