Merge branch 'master' into nodeinterface

Author: kdambekalns

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Command/NodeIndexCommandController.php

@@ -132,7 +132,7 @@ public function showMappingCommand() {
 	 * This command (re-)indexes all nodes contained in the content repository and sets the schema beforehand.
 	 *
 	 * @param integer $limit Amount of nodes to index at maximum
-	 * @param bool $update if TRUE, do not throw away the index at the start. Should *only be used for development*.
+	 * @param boolean $update if TRUE, do not throw away the index at the start. Should *only be used for development*.
 	 * @param string $workspace name of the workspace which should be indexed
 	 * @return void
 	 */
@@ -223,7 +223,7 @@ protected function indexWorkspace($workspaceName) {
 	 * @param array $dimensions
 	 * @return void
 	 */
-	protected function indexWorkspaceWithDimensions($workspaceName, $dimensions = array()) {
+	protected function indexWorkspaceWithDimensions($workspaceName, array $dimensions = array()) {
 		$context = $this->contextFactory->create(array('workspaceName' => $workspaceName, 'dimensions' => $dimensions));
 		$rootNode = $context->getRootNode();
 
@@ -241,6 +241,7 @@ protected function indexWorkspaceWithDimensions($workspaceName, $dimensions = ar
 
 	/**
 	 * @param \TYPO3\TYPO3CR\Domain\Model\NodeInterface $currentNode
+	 * @return void
 	 */
 	protected function traverseNodes(\TYPO3\TYPO3CR\Domain\Model\NodeInterface $currentNode) {
 
@@ -291,4 +292,4 @@ protected function calculateDimensionCombinations() {
 
 		return $combinations;
 	}
-}
+}

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Eel/ElasticSearchQueryBuilder.php

@@ -62,6 +62,13 @@ class ElasticSearchQueryBuilder implements QueryBuilderInterface, ProtectedConte
 	 */
 	protected $from;
 
+	/**
+	 * These fields are not accepted in a count request and must therefore be removed before doing so
+	 *
+	 * @var array
+	 */
+	protected $unsupportedFieldsInCountRequest = array('fields', 'sort', 'from', 'size');
+
 	/**
 	 * The ElasticSearch request, as it is being built up.
 	 * @var array
@@ -229,16 +236,61 @@ public function from($from) {
 	/**
 	 * add an exact-match query for a given property
 	 *
-	 * @param $propertyName
-	 * @param $propertyValue
+	 * @param string $propertyName Name of the property
+	 * @param mixed $value Value for comparison
 	 * @return ElasticSearchQueryBuilder
 	 */
-	public function exactMatch($propertyName, $propertyValue) {
-		if ($propertyValue instanceof NodeInterface) {
-			$propertyValue = $propertyValue->getIdentifier();
+	public function exactMatch($propertyName, $value) {
+		if ($value instanceof NodeInterface) {
+			$value = $value->getIdentifier();
 		}
 
-		return $this->queryFilter('term', array($propertyName => $propertyValue));
+		return $this->queryFilter('term', array($propertyName => $value));
+	}
+
+	/**
+	 * add a range filter (gt) for the given property
+	 *
+	 * @param string $propertyName Name of the property
+	 * @param mixed $value Value for comparison
+	 * @return ElasticSearchQueryBuilder
+	 */
+	public function greaterThan($propertyName, $value) {
+		return $this->queryFilter('range', array($propertyName => array('gt' => $value)));
+	}
+
+	/**
+	 * add a range filter (gte) for the given property
+	 *
+	 * @param string $propertyName Name of the property
+	 * @param mixed $value Value for comparison
+	 * @return ElasticSearchQueryBuilder
+	 */
+	public function greaterThanOrEqual($propertyName, $value) {
+		return $this->queryFilter('range', array($propertyName => array('gte' => $value)));
+	}
+
+	/**
+	 * add a range filter (lt) for the given property
+	 *
+	 * @param string $propertyName Name of the property
+	 * @param mixed $value Value for comparison
+	 * @return ElasticSearchQueryBuilder
+	 */
+	public function lessThan($propertyName, $value) {
+		return $this->queryFilter('range', array($propertyName => array('lt' => $value)));
+	}
+
+
+	/**
+	 * add a range filter (lte) for the given property
+	 *
+	 * @param string $propertyName Name of the property
+	 * @param mixed $value Value for comparison
+	 * @return ElasticSearchQueryBuilder
+	 */
+	public function lessThanOrEqual($propertyName, $value) {
+		return $this->queryFilter('range', array($propertyName => array('lte' => $value)));
 	}
 
 	/**
@@ -374,7 +426,14 @@ public function execute() {
 	 */
 	public function count() {
 		$timeBefore = microtime(TRUE);
-		$response = $this->elasticSearchClient->getIndex()->request('GET', '/_count', array(), json_encode($this->request));
+		$request = $this->request;
+		foreach ($this->unsupportedFieldsInCountRequest as $field) {
+			if (isset($request[$field])) {
+				unset($request[$field]);
+			}
+		}
+
+		$response = $this->elasticSearchClient->getIndex()->request('GET', '/_count', array(), json_encode($request));
 		$timeAfterwards = microtime(TRUE);
 
 		$treatedContent = $response->getTreatedContent();

Configuration/NodeTypes.yaml

@@ -76,7 +76,7 @@
           type: date
           include_in_all: false
           format: 'date_time_no_millis'
-        indexing: '${(node.hiddenBeforeDateTime ? node.hiddenBeforeDateTime.format("Y-m-d\TH:i:s") + "Z" : null)}'
+        indexing: '${(node.hiddenBeforeDateTime ? Date.format(node.hiddenBeforeDateTime, "Y-m-d\TH:i:s") + "Z" : null)}'
 
 
     '_hiddenAfterDateTime':
@@ -85,7 +85,7 @@
           type: date
           include_in_all: false
           format: 'date_time_no_millis'
-        indexing: '${(node.hiddenAfterDateTime ? node.hiddenAfterDateTime.format("Y-m-d\TH:i:s") + "Z" : null)}'
+        indexing: '${(node.hiddenAfterDateTime ? Date.format(node.hiddenAfterDateTime, "Y-m-d\TH:i:s") + "Z" : null)}'
 
 
 'TYPO3.Neos:Document':

Documentation/Index.rst

@@ -9,21 +9,21 @@ TYPO3 Flow Package for indexing Nodes from TYPO3 Neos to ElasticSearch.
 Setup
 -----
 
-To be able indexing nodes into ElasticSearch there must be an index at all. This has to be 'neos'.
+To be able indexing nodes into ElasticSearch there must be an index at all.
 This can be created on console like this when the ElasticSearch Server is running::
 
-	curl -XPUT 'http://localhost:9200/neos/'
+	curl -XPUT 'http://localhost:9200/typo3cr/'
 
 Other wise you get an error message like this::
 
 	{
-		"error" : "IndexMissingException[[neos] missing]",
+		"error" : "IndexMissingException[[typo3cr] missing]",
 		"status" : 404
 	}
 
-To be sure that the 'neos' index was created use the following url in your browser::
+To be sure that the 'typo3cr' index was created use the following url in your browser::
 
-	http://localhost:9200/neos/_search?pretty
+	http://localhost:9200/typo3cr/_search?pretty
 
 The output should be like this::
 
@@ -41,3 +41,7 @@ The output should be like this::
 			"hits" : [ ]
 		}
 	}
+
+It is recommended to use an index name that corresponds to the project you are indexing to avoid
+clashes by using the same index in different projects. The index name can be changed in the
+settings.

README.md

@@ -172,7 +172,11 @@ search underneath the current site node (like in the example above).
 Furthermore, the following operators are supported:
 
 * `nodeType("Your.Node:Type")`
-* `exactMatch(key, value)`; supports simple types: `exactMatch('tag', 'foo')`, or node references: `exactMatch('author', authorNode)`
+* `exactMatch('propertyName', value)`; supports simple types: `exactMatch('tag', 'foo')`, or node references: `exactMatch('author', authorNode)`
+* `greaterThan('propertyName', value)` -- range filter with property values greater than the given value
+* `greaterThanOrEqual('propertyName', value)` -- range filter with property values greater than or equal to the given value
+* `lessThan('propertyName', value)` -- range filter with property values less than the given value
+* `lessThanOrEqual('propertyName', value)` -- range filter with property values less than or equal to the given value
 * `sortAsc('propertyName')` and `sortDesc('propertyName')` -- can also be used multiple times, e.g. `sortAsc('tag').sortDesc(`date')` will first sort by tag ascending, and then by date descending.
 * `limit(5)` -- only return five results. If not specified, the default limit by ElasticSearch applies (which is at 10 by default)
 * `from(5)` -- return the results starting from the 6th one
@@ -285,7 +289,7 @@ TYPO3:
           type: date
           include_in_all: false
           format: 'date_time_no_millis'
-        indexing: '${(node.hiddenBeforeDateTime ? node.hiddenBeforeDateTime.format("Y-m-d\TH:i:s") + "Z" : null)}'
+        indexing: '${(node.hiddenBeforeDateTime ? Date.format(node.hiddenBeforeDateTime, "Y-m-d\TH:i:s") + "Z" : null)}'
 ```
 
 There are a few indexing helpers inside the `Indexing` namespace which are usable inside the
@@ -347,4 +351,4 @@ In order to understand what's going on, the following commands are helpful:
 
 * use `./flow nodeindex:showMapping` to show the currently defined ElasticSearch Mapping
 * use the `.log()` statement inside queries to dump them to the ElasticSearch Log
-* the logfile `Data/Logs/ElasticSearch.log` contains loads of helpful information.
+* the logfile `Data/Logs/ElasticSearch.log` contains loads of helpful information.

Tests/Unit/Eel/ElasticSearchQueryBuilderTest.php

@@ -160,7 +160,6 @@ public function limitWorks() {
 		$this->assertSame(2, $actual['size']);
 	}
 
-
 	/**
 	 * @test
 	 */
@@ -175,6 +174,30 @@ public function sortDescWorks() {
 		$this->assertSame($expected, $actual['sort']);
 	}
 
+	public function rangeConstraintExamples() {
+		return array(
+			array('greaterThan', 'gt', 10),
+			array('greaterThanOrEqual', 'gte', 20),
+			array('lessThan', 'lt', 'now'),
+			array('lessThanOrEqual', 'lte', 40)
+		);
+	}
+
+	/**
+	 * @test
+	 * @dataProvider rangeConstraintExamples
+	 */
+	public function rangeConstraintsWork($constraint, $operator, $value) {
+		$this->queryBuilder->$constraint('fieldName', $value);
+		$expected = array(
+			'range' => array(
+				'fieldName' => array($operator => $value)
+			)
+		);
+		$actual = $this->queryBuilder->getRequest();
+		$this->assertInArray($expected, $actual['query']['filtered']['filter']['bool']['must']);
+	}
+
 	/**
 	 * Test helper
 	 *

composer.json

@@ -1,13 +1,12 @@
 {
     "name": "flowpack/elasticsearch-contentrepositoryadaptor",
     "type": "typo3-flow-package",
-    "description": "This package provides functionality for the interaction of elasticsearch engine and TYPO3CR.",
+    "description": "This package provides functionality for using Elasticsearch on top of TYPO3CR.Search",
     "homepage": "http://flowpack.org/",
     "license": ["LGPL-3.0+"],
     "require": {
         "flowpack/elasticsearch": "*",
         "typo3/eel": "*",
-        "typo3/typo3cr": "*",
         "typo3/typo3cr-search": "*"
     },
     "autoload": {