Merge pull request #294 from kdambekalns/task/some-docs-and-code-tweaks

kdambekalns · web-flow · commit a5062467ba9b · 2019-03-13T14:36:14.000+01:00
TASK: Some docs and code tweaks
diff --git a/Classes/Driver/AbstractIndexerDriver.php b/Classes/Driver/AbstractIndexerDriver.php
@@ -14,8 +14,8 @@
  * source code.
  */
 
-use Neos\Flow\Annotations as Flow;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
+use Neos\Flow\Annotations as Flow;
 
 /**
  * Abstract Fulltext Indexer Driver
diff --git a/Classes/Driver/AbstractNodeTypeMappingBuilder.php b/Classes/Driver/AbstractNodeTypeMappingBuilder.php
@@ -17,8 +17,8 @@
 use Neos\ContentRepository\Domain\Service\NodeTypeManager;
 use Neos\Error\Messages\Result;
 use Neos\Flow\Annotations as Flow;
-use Neos\Flow\Configuration\Exception\InvalidConfigurationTypeException;
 use Neos\Flow\Configuration\ConfigurationManager;
+use Neos\Flow\Configuration\Exception\InvalidConfigurationTypeException;
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
 
 /**
diff --git a/Classes/Driver/RequestDriverInterface.php b/Classes/Driver/RequestDriverInterface.php
@@ -13,6 +13,7 @@
  * information, please view the LICENSE file which was distributed with this
  * source code.
  */
+
 use Flowpack\ElasticSearch\Domain\Model\Index;
 
 /**
diff --git a/Classes/Driver/Version5/DocumentDriver.php b/Classes/Driver/Version5/DocumentDriver.php
@@ -14,13 +14,13 @@
  * source code.
  */
 
-use Neos\Flow\Annotations as Flow;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\AbstractDriver;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\DocumentDriverInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\NodeTypeMappingBuilderInterface;
 use Flowpack\ElasticSearch\Domain\Model\Index;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\ContentRepository\Domain\Model\NodeType;
+use Neos\Flow\Annotations as Flow;
 
 /**
  * Document driver for Elasticsearch version 5.x
diff --git a/Classes/Driver/Version5/IndexDriver.php b/Classes/Driver/Version5/IndexDriver.php
@@ -14,10 +14,10 @@
  * source code.
  */
 
-use Neos\Flow\Annotations as Flow;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\AbstractDriver;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\IndexDriverInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception;
+use Neos\Flow\Annotations as Flow;
 
 /**
  * Index management driver for Elasticsearch version 5.x
diff --git a/Classes/Driver/Version5/IndexerDriver.php b/Classes/Driver/Version5/IndexerDriver.php
@@ -14,11 +14,11 @@
  * source code.
  */
 
+use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\AbstractIndexerDriver;
+use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\IndexerDriverInterface;
 use Flowpack\ElasticSearch\Domain\Model\Document as ElasticSearchDocument;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\Flow\Annotations as Flow;
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\AbstractIndexerDriver;
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\IndexerDriverInterface;
 
 /**
  * Indexer driver for Elasticsearch version 5.x
diff --git a/Classes/Driver/Version5/Mapping/NodeTypeMappingBuilder.php b/Classes/Driver/Version5/Mapping/NodeTypeMappingBuilder.php
@@ -14,14 +14,14 @@
  * source code.
  */
 
-use Neos\Flow\Annotations as Flow;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\AbstractNodeTypeMappingBuilder;
 use Flowpack\ElasticSearch\Domain\Model\Index;
 use Flowpack\ElasticSearch\Domain\Model\Mapping;
 use Flowpack\ElasticSearch\Mapping\MappingCollection;
 use Neos\ContentRepository\Domain\Model\NodeType;
 use Neos\Error\Messages\Result;
 use Neos\Error\Messages\Warning;
+use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Configuration\Exception\InvalidConfigurationTypeException;
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
 
diff --git a/Classes/Driver/Version5/Query/FilteredQuery.php b/Classes/Driver/Version5/Query/FilteredQuery.php
@@ -15,7 +15,6 @@
  */
 
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\AbstractQuery;
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\QueryBuildingException;
 
 /**
diff --git a/Classes/Driver/Version5/RequestDriver.php b/Classes/Driver/Version5/RequestDriver.php
@@ -14,10 +14,10 @@
  * source code.
  */
 
-use Neos\Flow\Annotations as Flow;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\AbstractDriver;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\RequestDriverInterface;
 use Flowpack\ElasticSearch\Domain\Model\Index;
+use Neos\Flow\Annotations as Flow;
 
 /**
  * Request driver for Elasticsearch version 5.x
diff --git a/Classes/Driver/Version5/SystemDriver.php b/Classes/Driver/Version5/SystemDriver.php
@@ -14,9 +14,9 @@
  * source code.
  */
 
-use Neos\Flow\Annotations as Flow;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\AbstractDriver;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\SystemDriverInterface;
+use Neos\Flow\Annotations as Flow;
 
 /**
  * System driver for Elasticsearch version 5.x
diff --git a/Classes/Factory/NodeTypeMappingBuilderFactory.php b/Classes/Factory/NodeTypeMappingBuilderFactory.php
@@ -14,8 +14,8 @@
  * source code.
  */
 
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\DriverConfigurationException;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\NodeTypeMappingBuilderInterface;
+use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\DriverConfigurationException;
 use Neos\Flow\Annotations as Flow;
 
 /**
diff --git a/Classes/Service/IndexWorkspaceTrait.php b/Classes/Service/IndexWorkspaceTrait.php
@@ -14,8 +14,8 @@
  * source code.
  */
 
-use Neos\Flow\Annotations as Flow;
 use Neos\ContentRepository\Domain\Model\NodeInterface;
+use Neos\Flow\Annotations as Flow;
 
 /**
  * Index Workspace Trait
diff --git a/Configuration/Settings.yaml b/Configuration/Settings.yaml
@@ -12,21 +12,21 @@ Flowpack:
                   query:
                     bool:
                       must:
-                      - match_all:
-                          boost: 1.0 # force match_all to be an object
+                        - match_all:
+                            boost: 1.0 # force match_all to be an object
                       filter:
                         bool:
                           must: []
                           should: []
                           must_not:
-                          - term:
-                              _hidden: true
-                          - range:
-                              _hiddenBeforeDateTime:
-                                gt: now
-                          - range:
-                              _hiddenAfterDateTime:
-                                lt: now
+                            - term:
+                                _hidden: true
+                            - range:
+                                _hiddenBeforeDateTime:
+                                  gt: now
+                            - range:
+                                _hiddenAfterDateTime:
+                                  lt: now
                   _source:
                     - '__path'
                 unsupportedFieldsInCountRequest:
diff --git a/Documentation/ElasticConfiguration-5.x.md b/Documentation/ElasticConfiguration-5.x.md
@@ -1,15 +1,7 @@
 # Needed Configuration in configuration.yml for Elasticsearch 5.x
 
-No special configuration is needed for Elasticsearch 5.x. Nice, isn't it?
+No special configuration is needed for Elasticsearch 5.x.
 
-But the following can make your life easier:
-
-```
-# the following settings secure your cluster
-cluster.name: [PUT_YOUR_CUSTOM_NAME_HERE]
-node.name: [PUT_YOUR_CUSTOM_NAME_HERE]
-network.host: _local_
-```
-
-**Note:** When using Elasticsearch 5.x changes to the mapping may be needed.
-More information on the [mapping in ElasticSearch 5.x](ElasticMapping-5.x.md).
+**Note:** Compared to what you may know from earlier versions of Elasticsearch,
+changes to the types may need to be done in your mapping for version 5. More
+information on the [mapping in ElasticSearch 5.x](ElasticMapping-5.x.md).
diff --git a/README.md b/README.md
@@ -29,24 +29,30 @@ Finally, run `./flow nodeindex:build`, and add the search plugin to your page. I
 
 ## Elastic version support
 
-**HINT: the Master of this package only supports modern versions of ES. If you need ES 1.x or 2.x support, please [see the 4.x branch of this repository](https://github.com/Flowpack/Flowpack.ElasticSearch.ContentRepositoryAdaptor/tree/4.0#elastic-version-support).**
+**HINT: this package only supports modern versions of Elasticsearch. If you need 1.x or 2.x support, please [see the 4.x branch of this repository](https://github.com/Flowpack/Flowpack.ElasticSearch.ContentRepositoryAdaptor/tree/4.0#elastic-version-support).**
 
-You can switch the Elastic driver by editing ```Settings.yaml```
-(```Flowpack.ElasticSearch.ContentRepositoryAdaptor.driver.version```) with the following value:
+You can switch the Elasticsearch driver by editing `Settings.yaml`
+(`Flowpack.ElasticSearch.ContentRepositoryAdaptor.driver.version`) with the following value:
 
-* ```5.x``` to support Elastic 5.x
+* `5.x` to support Elasticsearch 5.x
 
 _Currently the Driver interfaces are not marked as API, and can be changed to adapt to future needs._
 
-**Note:** When using Elasticsearch 5.x changes to the types may need to be done in your mapping.
-More information on the [mapping in ElasticSearch 5.x](Documentation/ElasticMapping-5.x.md).
-
 ### Elasticsearch Configuration file elasticsearch.yml
 
-There is a need, depending on your version of Elasticsearch, to add specific configuration to your
-Elasticsearch Configuration File `<your-elasticsearch>/config/elasticsearch.yml`.
+The following general configuration advice can make your life easier:
+
+```yaml
+# the following settings secure your cluster
+cluster.name: [PUT_YOUR_CUSTOM_NAME_HERE]
+node.name: [PUT_YOUR_CUSTOM_NAME_HERE]
+network.host: _local_
+```
 
-- [ElasticSearch 5.x](Documentation/ElasticConfiguration-5.x.md)
+There may be a need, to add specific configuration to your Elasticsearch Configuration File
+`<your-elasticsearch>/config/elasticsearch.yml`, , depending on your version of Elasticsearch.
+
+- [Elasticsearch 5.x](Documentation/ElasticConfiguration-5.x.md)
 
 ## Building up the Index
 
@@ -311,7 +317,7 @@ be fetched and passed to your template.
 
 If you do use the terms filter be aware of Elasticsearchs analyze functionality for strings. You might want to disable this
 for all your filterable properties, or else filtering won't work on them properly:
-```
+```yaml
 'Vendor.Name:Product'
   properties:
     color:
@@ -370,7 +376,7 @@ This is how a more complex example could look like. Imagine you a want to render
 node you want to display the distance to a specific point.
 
 First of all you have to define a property in your NodeTypes.yaml for your node where to store lat/lon information's:
-```
+```yaml
 'Vendor.Name:Retailer':
   properties:
     'latlng':
@@ -492,24 +498,24 @@ suggestions = ${Search.query(site)...suggestions('my_suggestions', this.suggesti
 
 In order to set the maximum cache time of a fusion prototype that renders nodes fetched by `Search()`,
 the nearest future value of the hiddenBeforeDateTime or hiddenAfterDateTime properties of all nodes in the result needs to be calculated.
+```
+prototype(Acme.Blog:Listing) < prototype(Neos.Fusion:Collection) {
+    @context.searchQuery = ${Search.query(site).nodeType('Acme.Blog:Post')}
 
-	prototype(Acme.Blog:Listing) < prototype(Neos.Fusion:Collection) {
-		@context.searchQuery = ${Search.query(site).nodeType('Acme.Blog:Post')}
-	
-	    collection = ${searchQuery.execute()}
-	    itemName = 'node'
-	    itemRenderer = Acme.Blog:Post
-	    
-	     @cache {
-        	mode = 'cached'
-			maximumLifetime = ${searchQuery.cacheLifetime()}
-			
-        	entryTags {
-          	map = ${'NodeType_Acme.Blog:Post'}
-        	}
-    	}
-	}
-
+    collection = ${searchQuery.execute()}
+    itemName = 'node'
+    itemRenderer = Acme.Blog:Post
+    
+     @cache {
+        mode = 'cached'
+        maximumLifetime = ${searchQuery.cacheLifetime()}
+        
+        entryTags {
+        map = ${'NodeType_Acme.Blog:Post'}
+        }
+    }
+}
+```
 
 ## Advanced: Configuration of Indexing
 
@@ -531,7 +537,7 @@ This configuration contains two parts:
   specified. It has access to the current `value` and the current `node`.
 
 Example (from the default configuration):
-```
+```yaml
  # Settings.yaml
 Neos:
   ContentRepository:
@@ -545,7 +551,7 @@ Neos:
           indexing: '${value}'
 ```
 
-```
+```yaml
  # NodeTypes.yaml
 'Neos.Neos:Timable':
   properties:
@@ -581,7 +587,7 @@ the standard indexing configuration:
 In order to enable fulltext indexing, every `Document` node must be configured as *fulltext root*. Thus,
 the following is configured in the default configuration:
 
-```
+```yaml
 'Neos.Neos:Document':
   search:
     fulltext:
@@ -596,7 +602,7 @@ in `NodeTypes.yaml` at `properties.[propertyName].search.fulltextExtractor`.
 
 An example:
 
-```
+```yaml
 'Neos.Neos.NodeTypes:Text':
   properties:
     'text':
@@ -621,7 +627,7 @@ An example:
 As a default, Elasticsearch indexes dates in the UTC Timezone. In order to have it index using the timezone
 currently configured in PHP, the configuration for any property in a node which represents a date should look like this:
 
-```
+```yaml
 'My.Blog:Post':
   properties:
     date:
@@ -650,7 +656,7 @@ For more information on Elasticsearch's Date Formats,
 If you want to index attachments, you need to install the [Elasticsearch Attachment Plugin](https://github.com/elastic/elasticsearch-mapper-attachments).
 Then, you can add the following to your `Settings.yaml`:
 
-```
+```yaml
 Neos:
   ContentRepository:
     Search:
@@ -674,7 +680,7 @@ If you want to fine-tune the indexing and mapping on a more detailed level, you
 
 First, configure the index settings as you need them, e.g. configuring analyzers:
 
-```
+```yaml
 Flowpack:
   ElasticSearch:
     indexes:
@@ -697,7 +703,7 @@ Flowpack:
 Then, you can change the analyzers on a per-field level; or e.g. reconfigure the _all field with the following snippet
 in the NodeTypes.yaml. Generally this works by defining the global mapping at `[nodeType].search.elasticSearchMapping`:
 
-```
+```yaml
 'Neos.Neos:Node':
   search:
     elasticSearchMapping:
@@ -719,7 +725,7 @@ If you need to run serveral (different) neos instances on the same elasticsearch
 
 So `./flow nodeindex:build` or `./flow nodeindex:cleanup` won't overwrite your other sites index.
 
-```
+```yaml
 Neos:
   ContentRepository:
     Search:
@@ -755,4 +761,4 @@ In order to understand what's going on, the following commands are helpful:
 3. Replace `ElasticSeach.fulltext` by `Indexing`
 4. Search for `ElasticSearch.` (inside the `indexing` expressions) and replace them by `Indexing.`
 
-Created by Sebastian Kurfürst; [contributions by Karsten Dambekalns, Robert Lemke and others](https://github.com/Flowpack/Flowpack.ElasticSearch.ContentRepositoryAdaptor/graphs/contributors).
+Created by [Sebastian Kurfürst; contributions by Karsten Dambekalns, Robert Lemke and others](https://github.com/Flowpack/Flowpack.ElasticSearch.ContentRepositoryAdaptor/graphs/contributors).
diff --git a/Tests/Unit/Eel/ElasticSearchQueryBuilderTest.php b/Tests/Unit/Eel/ElasticSearchQueryBuilderTest.php
diff --git a/composer.json b/composer.json
