Merge remote-tracking branch 'origin/develop'

Author: wachterjohannes

Behat/SearchManagerContext.php

@@ -193,6 +193,18 @@ public function iSearchFor($query)
             ->execute();
     }
 
+    /**
+     * @When I search for :query with sort :sort and order :order
+     */
+    public function iSearchForWithSort($query, $sort, $order)
+    {
+        $this->lastResult = $this->getSearchManager()
+            ->createSearch($query)
+            ->indexes($this->getSearchManager()->getIndexNames())
+            ->addSorting($sort, $order)
+            ->execute();
+    }
+
     /**
      * @Given I search for :query in locale :locale
      */
@@ -280,6 +292,14 @@ public function theResultShouldBeAnArray()
         Assert::assertInternalType('array', $this->lastResult);
     }
 
+    /**
+     * @Then the result at position :position should be :id
+     */
+    public function theResultAtPositionShouldBe($position, $id)
+    {
+        Assert::assertEquals($this->lastResult[$position]->getId(), $id);
+    }
+
     /**
      * Return the search manager using the configured adapter ID.
      */
@@ -290,7 +310,7 @@ protected function getSearchManager()
             $this->kernel->getContainer()->get('massive_search.metadata.provider.chain'),
             $this->kernel->getContainer()->get('massive_search.object_to_document_converter'),
             $this->kernel->getContainer()->get('event_dispatcher'),
-            $this->kernel->getContainer()->get('massive_search.localization_strategy'),
+            $this->kernel->getContainer()->get('massive_search.index_name_decorator.default'),
             $this->kernel->getContainer()->get('massive_search.metadata.field_evaluator')
         );
     }

CHANGELOG.md

@@ -1,57 +1,66 @@
 CHANGELOG
 =========
 
+* 0.11.0 (2015-12-01)
+    * BUGFIX  #71 Fixed caching of repository method
+    * BUGFIX  #70 Added missing passing of options to PrefixDecorator
+    * FEATURE #67 Added support for sort/order for elastic search
+    * FEATURE #68 Introduce decorators for index names and introduce prefixes
+    * FEATURE #66 Added support for date
+    * FEATURE #60 Added support for custom type converter
+    * FEATURE #60 Added support for arrays
+
 * 0.10.0 (2015-11-19)
     * FEATURE #66 [Converter] Added support for date
     * FEATURE #60 [Converter] Added support for custom type converter
     * FEATURE #60 [General]   Added support for arrays
 
 * 0.9.0
-    * FEATURE [Configuration] Index name can now also be created using expression language
-    * FEATURE [Configuration] Search categories have been removed
+    * FEATURE Index name can now also be created using expression language
+    * FEATURE Search categories have been removed
 
 * 0.8.0
-    * FEATURE [Rebuild] Added reindex directive
-    * FEATURE [Tests]   Removed prophecy bridge
-    * FEATURE [General] Added Style-CI configuration
+    * FEATURE Added reindex directive
+    * FEATURE Removed prophecy bridge
+    * FEATURE Added Style-CI configuration
 
 * 0.7.0
-    * BUGFIX [Metadata] Added scalar check
+    * BUGFIX Added scalar check
 
 * 0.6.0
-    * BUGFIX [Configuraiton] Undefined index when elastic search is used without
-                             configuration
-    * BUGFIX [Search]        If not localized managed indexes exist then a global search is
-                             performed: https://github.com/massiveart/MassiveSearchBundle/issues/38
-    * BUGFIX [Metadata]      Removed index strategies, replaced with explicit `stored` and
-                             `indexed` and `aggregate` flags (**BC BREAK**).
-    * BUGFIX [Metadata]      Added metadata cache
-    * BUGFIX [Metadata]      Added metadata providers
+    * BUGFIX  Undefined index when elastic search is used without
+              configuration
+    * BUGFIX  If not localized managed indexes exist then a global search is
+              performed: https://github.com/massiveart/MassiveSearchBundle/issues/38
+    * BUGFIX  Removed index strategies, replaced with explicit `stored` and
+              `indexed` and `aggregate` flags (**BC BREAK**).
+    * BUGFIX  Added metadata cache
+    * BUGFIX  Added metadata providers
 
 * 0.5.1
-    * FEATURE [ZendLucene] Add index strategy 'INDEX_STORED_INDEXED'
+    * FEATURE Add index strategy 'INDEX_STORED_INDEXED'
 
 * 0.5.0
-    * FEATURE [TestAdapter]  Supports indexes
-    * FEATURE [Mapping]      Expression language
-    * FEATURE [Persistence]  Doctrine ORM event subscriber
-    * FEATURE [Elastic]      Elasticsearch adapter
-    * FEATURE [Localization] Localization strategy support
-    * ENHANCEMENT [Config]   Renamed `adapter_id` to `adapter` in configuration. See UPGRADE.md
-    * ENHANCEMENT [Rebuild]  Added core support for rebuilding indexes via
+    * FEATURE     Supports indexes
+    * FEATURE     Expression language
+    * FEATURE     Doctrine ORM event subscriber
+    * FEATURE     Elasticsearch adapter
+    * FEATURE     Localization strategy support
+    * ENHANCEMENT Renamed `adapter_id` to `adapter` in configuration. See UPGRADE.md
+    * ENHANCEMENT Added core support for rebuilding indexes via
                              massive:search:index:rebuild command
 
 * 0.4.1
-    * BUGFIX [TestAdapter] Fixed deindexing
+    * BUGFIX Fixed deindexing
 
 * 0.4.0
-    * FEATURE [TestAdapter] Test (memory storage) adapter now uses regex when searching
+    * FEATURE Test (memory storage) adapter now uses regex when searching
 
 0.3.2
-    * BUGFIX [ZendSearch] Catch "non-wildcard characters" exception and return 0 results
+    * BUGFIX Catch "non-wildcard characters" exception and return 0 results
 
 0.3.1
-    * BUGFIX [ZendSeach] Added workaround to avoid Fatal errors after a test suite run caused by
+    * BUGFIX Added workaround to avoid Fatal errors after a test suite run caused by
                          the Lucene\Index `__destruct()` method. You can now configure the adapter to hide Exceptions
                          from the Index class.
 

DependencyInjection/Configuration.php

@@ -32,10 +32,6 @@ public function getConfigTreeBuilder()
                         ->scalarNode('factory')->defaultValue('massive_search.factory_default')->end()
                     ->end()
                 ->end()
-                ->enumNode('localization_strategy')
-                    ->values(['noop', 'index'])
-                    ->defaultValue('noop')
-                ->end()
                 ->enumNode('adapter')
                     ->values(['zend_lucene', 'elastic', 'test'])
                     ->defaultValue('zend_lucene')->end()
@@ -64,6 +60,7 @@ public function getConfigTreeBuilder()
                 ->arrayNode('metadata')
                     ->addDefaultsIfNotSet()
                     ->children()
+                        ->scalarNode('prefix')->defaultValue('massive')->end()
                         ->scalarNode('cache_dir')->defaultValue('%kernel.cache_dir%/massive-search')->end()
                         ->booleanNode('debug')->defaultValue('%kernel.debug%')->end()
                     ->end()

DependencyInjection/MassiveSearchExtension.php

@@ -35,7 +35,6 @@ public function load(array $configs, ContainerBuilder $container)
 
         $container->setAlias('massive_search.factory', $config['services']['factory']);
 
-        $this->loadLocalization($config, $loader, $container);
         $this->loadSearch($config, $loader, $container);
         $this->loadMetadata($config['metadata'], $loader, $container);
         $this->loadPersistence($config['persistence'], $loader);
@@ -52,23 +51,6 @@ private function loadPersistence($config, Loader\XmlFileLoader $loader)
         }
     }
 
-    private function loadLocalization($config, $loader, $container)
-    {
-        $loader->load('localization.xml');
-        $strategy = $config['localization_strategy'];
-
-        switch ($strategy) {
-            case 'noop':
-                $strategyId = 'massive_search.localization_strategy.noop';
-                break;
-            case 'index':
-                $strategyId = 'massive_search.localization_strategy.index';
-                break;
-        }
-
-        $container->setAlias('massive_search.localization_strategy', $strategyId);
-    }
-
     private function loadSearch($config, $loader, $container)
     {
         $container->setAlias('massive_search.adapter', 'massive_search.adapter.' . $config['adapter']);
@@ -112,6 +94,7 @@ private function loadMetadata($config, $loader, $container)
                 throw new \RuntimeException(sprintf('Could not create cache directory "%s".', $dir));
             }
         }
+        $container->setParameter('massive_search.metadata.prefix', $config['prefix']);
         $container->setParameter('massive_search.metadata.cache_dir', $config['cache_dir']);
         $container->setParameter('massive_search.metadata.debug', $config['debug']);
 

Resources/config/adapter_zendlucene.xml

@@ -9,8 +9,14 @@
             <argument>%massive_search.adapter.zend_lucene.basepath%</argument>
             <argument>%massive_search.adapter.zend_lucene.hide_index_exception%</argument>
             <argument>%massive_search.adapter.zend_lucene.encoding%</argument>
+        </service>
+
+        <service id="massive_search.events.zend_rebuild"
+                 class="Massive\Bundle\SearchBundle\Search\EventListener\ZendRebuildSubscriber">
+            <argument type="service" id="massive_search.adapter.zend_lucene"/>
+            <argument type="service" id="massive_search.index_name_decorator.default"/>
             <tag name="kernel.event_listener" event="massive_search.index_rebuild"
-                 method="optimizeIndexAfterRebuild"
+                 method="onIndexRebuild"
                  priority="-999"/>
         </service>
     </services>

Resources/config/localization.xml

@@ -33,13 +33,29 @@
             <argument type="service" id="massive_search.factory" />
         </service>
 
+        <!-- Decorators -->
+        <service id="massive_search.index_name_decorator" class="Massive\Bundle\SearchBundle\Search\Decorator\IndexNameDecorator">
+            <argument type="service" id="massive_search.metadata.field_evaluator"/>
+        </service>
+
+        <service id="massive_search.localization_decorator" class="Massive\Bundle\SearchBundle\Search\Decorator\LocalizationDecorator">
+            <argument type="service" id="massive_search.index_name_decorator"/>
+        </service>
+
+        <service id="massive_search.prefix_decorator" class="Massive\Bundle\SearchBundle\Search\Decorator\PrefixDecorator">
+            <argument type="service" id="massive_search.localization_decorator"/>
+            <argument>%massive_search.metadata.prefix%</argument>
+        </service>
+
+        <service id="massive_search.index_name_decorator.default" alias="massive_search.prefix_decorator"/>
+
         <!-- Search manager -->
         <service id="massive_search.search_manager" class="%massive_search.search_manager.class%">
             <argument type="service" id="massive_search.adapter" />
             <argument type="service" id="massive_search.metadata.provider.chain" />
             <argument type="service" id="massive_search.object_to_document_converter" />
             <argument type="service" id="event_dispatcher" />
-            <argument type="service" id="massive_search.localization_strategy" />
+            <argument type="service" id="massive_search.index_name_decorator.default" />
             <argument type="service" id="massive_search.metadata.field_evaluator" />
         </service>
 

Resources/config/search.xml

@@ -13,7 +13,7 @@ Contents
     mapping
     searching
     search_adapters
-    localization
+    index_name_decorators
     web_api
     extending
     commands

Resources/docs/index.rst

@@ -0,0 +1,48 @@
+Index name decorators
+=====================
+
+The bundle offers the possibility to influence the generated index names using
+the `decorator pattern`_. If you want to add your own decorator, you have to
+implement the `IndexNameDecoratorInterface`, and register the new decorator in
+the `Symfony dependency injection container`_. Consider that you should pass
+the current most outer decorator as an argument, so that it can be called in
+your decorator.
+
+Afterwards you have to make sure that your new decorator is returned when
+getting the service for `massive_search.index_name_decorator.default`, what can
+be achieved by using the `alias feature`_ of Symfony.
+
+Available index name decorators
+-------------------------------
+
+IndexNameDecorator
+~~~~~~~~~~~~~~~~~~
+
+The index name decorator returns the value for the index name from the
+:doc:`mapping` files.
+
+LocalizationDecorator
+~~~~~~~~~~~~~~~~~~~~~
+
+This decorator adds the locale to the index name, in case the document has a
+locale parameter.
+
+PrefixDecorator
+~~~~~~~~~~~~~~~
+
+The `PrefixDecorator` is responsible for adding a prefix to the index, so that
+the Bundle knows if the given index name is managed by the search bundle. This
+prefix can be configured by the `massive_search.metadata.prefix` configuration
+setting, which defaults to ``massive``.
+
+.. warning::
+
+    Make sure that the other indexes you might have in your system have a name
+    not starting with the prefix defined by this configuration. Otherwise it
+    might be possible that the MassiveSearchBundle modifies or deletes these
+    indexes.
+
+.. _`decorator pattern`: https://en.wikipedia.org/wiki/Decorator_pattern
+.. _`Symfony dependency injection container`: http://symfony.com/doc/current/components/dependency_injection/introduction.html#setting-up-the-container-with-configuration-files
+.. _`alias feature`: http://symfony.com/doc/current/components/dependency_injection/advanced.html#aliasing
+