fixes #666 (#667)

* fixes #666
* added integration test

Author: Markus Kalkbrenner

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to the solarium library will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [5.0.0-beta.1]
+### Fixed
+- Helper::rangeQuery() must not escape point values. Added a new parameter to turn off escaping.
+
+
 ## [5.0.0-alpha.2]
 ### Added
 - introduced FacetResultInterface

docs/queries/query-helper/query-helper.md

@@ -7,7 +7,7 @@ Two special types of helper methods are
 Helper methods for general use
 ------------------------------
 
--   rangeQuery($field, $from, $to, $inclusive = true)
+-   rangeQuery($field, $from, $to, $inclusive = true, $escape = true)
 -   qparser($name, $params = array())
 -   functionCall($name, $params = array())
 -   join($from, $to, $dereferenced = false)

src/Core/Query/Helper.php

@@ -159,30 +159,33 @@ public function formatDate($input)
      * From and to can be any type of data. For instance int, string or point.
      * If they are null, then '*' will be used.
      *
-     * Example: rangeQuery('store', '45,-94', '46,-93')
+     * Example: rangeQuery('store', '45,-94', '46,-93', true, false)
      * Returns: store:[45,-94 TO 46,-93]
      *
      * Example: rangeQuery('store', '5', '*', false)
-     * Returns: store:{5 TO *}
+     * Returns: store:{"5" TO *}
      *
      * @param string      $field
      * @param string|null $from
      * @param string|null $to
-     * @param bool        $inclusive
+     * @param bool        $inclusive TRUE if the the range should include the boundaries, FALSE otherwise
+     * @param bool        $escape    Whether the values should be escaped as phrase or not. Default is TRUE because
+     *                               escaping is correct for security reasons. But for location searches (point values),
+     *                               escaping would break the functionality
      *
      * @return string
      */
-    public function rangeQuery(string $field, ?string $from, ?string $to, bool $inclusive = true): string
+    public function rangeQuery(string $field, ?string $from, ?string $to, bool $inclusive = true, bool $escape = true): string
     {
         if (null === $from) {
             $from = '*';
-        } else {
+        } elseif ($escape) {
             $from = $this->escapePhrase($from);
         }
 
         if (null === $to) {
             $to = '*';
-        } else {
+        } elseif ($escape) {
             $to = $this->escapePhrase($to);
         }
 

tests/Core/Query/HelperTest.php

@@ -33,8 +33,8 @@ public function testRangeQueryInclusive()
         );
 
         $this->assertSame(
-            'store:["45,-94" TO "46,-93"]',
-            $this->helper->rangeQuery('store', '45,-94', '46,-93')
+            'store:[45,-94 TO 46,-93]',
+            $this->helper->rangeQuery('store', '45,-94', '46,-93', true, false)
         );
     }
 
@@ -46,8 +46,8 @@ public function testRangeQueryExclusive()
         );
 
         $this->assertSame(
-            'store:{"45,-94" TO "46,-93"}',
-            $this->helper->rangeQuery('store', '45,-94', '46,-93', false)
+            'store:{45,-94 TO 46,-93}',
+            $this->helper->rangeQuery('store', '45,-94', '46,-93', false, false)
         );
     }
 
@@ -59,8 +59,8 @@ public function testRangeQueryInclusiveNullValues()
         );
 
         $this->assertSame(
-            'store:[* TO "46,-93"]',
-            $this->helper->rangeQuery('store', null, '46,-93')
+            'store:[* TO 46,-93]',
+            $this->helper->rangeQuery('store', null, '46,-93', true, false)
         );
     }
 
@@ -72,8 +72,8 @@ public function testRangeQueryExclusiveNullValues()
         );
 
         $this->assertSame(
-            'store:{* TO "46,-93"}',
-            $this->helper->rangeQuery('store', null, '46,-93', false)
+            'store:{* TO 46,-93}',
+            $this->helper->rangeQuery('store', null, '46,-93', false, false)
         );
     }
 

tests/Integration/AbstractTechproductsTest.php

@@ -87,6 +87,20 @@ public function testRangeQueries()
         $result = $this->client->select($select);
         $this->assertSame(10, $result->getNumFound());
         $this->assertSame(10, $result->count());
+
+        $select->setQuery(
+            $select->getHelper()->rangeQuery('store', '-90,-90', '90,90', true, false)
+        );
+        $result = $this->client->select($select);
+        $this->assertSame(2, $result->getNumFound());
+        $this->assertSame(2, $result->count());
+
+        $select->setQuery(
+            $select->getHelper()->rangeQuery('store', '-90,-180', '90,180', true, false)
+        );
+        $result = $this->client->select($select);
+        $this->assertSame(14, $result->getNumFound());
+        $this->assertSame(10, $result->count());
     }
 
     /**