Merge pull request #98 from GrandLTU/inclusive-range-filter

Mantas Urnieža · Mantas Urnieža · commit e76e17f3baa8 · 2015-06-22T08:46:21.000+03:00
Inclusive range filter
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -238,6 +238,16 @@ function ($v) {
                         ->end()
                     ->end();
                 break;
+            case 'range':
+            case 'date_range':
+                $node
+                    ->children()
+                        ->booleanNode('inclusive')
+                            ->info('Whether filter should match range ends.')
+                            ->defaultFalse()
+                        ->end()
+                    ->end();
+                break;
             default:
                 // Should not happen.
                 break;
diff --git a/DependencyInjection/Filter/RangeFilterFactory.php b/DependencyInjection/Filter/RangeFilterFactory.php
@@ -26,6 +26,9 @@ protected function configure(Definition $definition, array $configuration)
         parent::configure($definition, $configuration);
 
         $definition->addMethodCall('setField', [$configuration['field']]);
+        if (array_key_exists('inclusive', $configuration)) {
+            $definition->addMethodCall('setInclusive', [$configuration['inclusive']]);
+        }
     }
 
     /**
diff --git a/Filters/Widget/Range/AbstractRange.php b/Filters/Widget/Range/AbstractRange.php
@@ -0,0 +1,76 @@
+<?php
+
+/*
+ * This file is part of the ONGR package.
+ *
+ * (c) NFQ Technologies UAB <info@nfq.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace ONGR\FilterManagerBundle\Filters\Widget\Range;
+
+use ONGR\ElasticsearchBundle\DSL\Filter\RangeFilter;
+use ONGR\ElasticsearchBundle\DSL\Search;
+use ONGR\FilterManagerBundle\Filters\FilterState;
+use ONGR\FilterManagerBundle\Filters\Helper\FieldAwareInterface;
+use ONGR\FilterManagerBundle\Filters\Helper\FieldAwareTrait;
+use ONGR\FilterManagerBundle\Filters\Helper\ViewDataFactoryInterface;
+use ONGR\FilterManagerBundle\Filters\ViewData\RangeAwareViewData;
+use ONGR\FilterManagerBundle\Filters\Widget\AbstractSingleRequestValueFilter;
+use ONGR\FilterManagerBundle\Search\SearchRequest;
+
+/**
+ * Class AbstractRangeFilter.
+ */
+abstract class AbstractRange extends AbstractSingleRequestValueFilter implements
+    FieldAwareInterface,
+    ViewDataFactoryInterface
+{
+    use FieldAwareTrait;
+
+    /**
+     * @var bool
+     */
+    private $inclusive = false;
+
+    /**
+     * @param bool $inclusive
+     *
+     * @return $this
+     */
+    public function setInclusive($inclusive)
+    {
+        $this->inclusive = $inclusive;
+
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isInclusive()
+    {
+        return $this->inclusive;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createViewData()
+    {
+        return new RangeAwareViewData();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function modifySearch(Search $search, FilterState $state = null, SearchRequest $request = null)
+    {
+        if ($state && $state->isActive()) {
+            $filter = new RangeFilter($this->getField(), $state->getValue());
+            $search->addPostFilter($filter);
+        }
+    }
+}
diff --git a/Filters/Widget/Range/DateRange.php b/Filters/Widget/Range/DateRange.php
@@ -12,25 +12,18 @@
 namespace ONGR\FilterManagerBundle\Filters\Widget\Range;
 
 use ONGR\ElasticsearchBundle\DSL\Aggregation\StatsAggregation;
-use ONGR\ElasticsearchBundle\DSL\Filter\RangeFilter;
 use ONGR\ElasticsearchBundle\DSL\Search;
 use ONGR\ElasticsearchBundle\Result\DocumentIterator;
 use ONGR\FilterManagerBundle\Filters\FilterState;
-use ONGR\FilterManagerBundle\Filters\Helper\FieldAwareInterface;
-use ONGR\FilterManagerBundle\Filters\Helper\FieldAwareTrait;
-use ONGR\FilterManagerBundle\Filters\Helper\ViewDataFactoryInterface;
 use ONGR\FilterManagerBundle\Filters\ViewData;
-use ONGR\FilterManagerBundle\Filters\Widget\AbstractSingleRequestValueFilter;
-use ONGR\FilterManagerBundle\Search\SearchRequest;
+use ONGR\FilterManagerBundle\Filters\ViewData\RangeAwareViewData;
 use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Date range filter, selects documents from lower date to upper date.
  */
-class DateRange extends AbstractSingleRequestValueFilter implements FieldAwareInterface, ViewDataFactoryInterface
+class DateRange extends AbstractRange
 {
-    use FieldAwareTrait;
-
     /**
      * {@inheritdoc}
      */
@@ -40,8 +33,11 @@ public function getState(Request $request)
 
         if ($state->getValue()) {
             $values = explode(';', $state->getValue(), 2);
-            $normalized['gt'] = $values[0];
-            $normalized['lt'] = $values[1];
+            $gt = $this->isInclusive() ? 'gte' : 'gt';
+            $lt = $this->isInclusive() ? 'lte' : 'lt';
+
+            $normalized[$gt] = $values[0];
+            $normalized[$lt] = $values[1];
 
             $state->setValue($normalized);
         }
@@ -59,31 +55,12 @@ public function preProcessSearch(Search $search, Search $relatedSearch, FilterSt
         $search->addAggregation($stateAgg);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function modifySearch(Search $search, FilterState $state = null, SearchRequest $request = null)
-    {
-        if ($state && $state->isActive()) {
-            $filter = new RangeFilter($this->getField(), $state->getValue());
-            $search->addPostFilter($filter);
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function createViewData()
-    {
-        return new ViewData\RangeAwareViewData();
-    }
-
     /**
      * {@inheritdoc}
      */
     public function getViewData(DocumentIterator $result, ViewData $data)
     {
-        /** @var $data ViewData\RangeAwareViewData */
+        /** @var $data RangeAwareViewData */
         $data->setMinBounds(
             new \DateTime(
                 date(
diff --git a/Filters/Widget/Range/Range.php b/Filters/Widget/Range/Range.php
@@ -12,25 +12,17 @@
 namespace ONGR\FilterManagerBundle\Filters\Widget\Range;
 
 use ONGR\ElasticsearchBundle\DSL\Aggregation\StatsAggregation;
-use ONGR\ElasticsearchBundle\DSL\Filter\RangeFilter;
 use ONGR\ElasticsearchBundle\DSL\Search;
 use ONGR\ElasticsearchBundle\Result\DocumentIterator;
 use ONGR\FilterManagerBundle\Filters\FilterState;
-use ONGR\FilterManagerBundle\Filters\Helper\FieldAwareInterface;
-use ONGR\FilterManagerBundle\Filters\Helper\FieldAwareTrait;
-use ONGR\FilterManagerBundle\Filters\Helper\ViewDataFactoryInterface;
 use ONGR\FilterManagerBundle\Filters\ViewData;
-use ONGR\FilterManagerBundle\Filters\Widget\AbstractSingleRequestValueFilter;
-use ONGR\FilterManagerBundle\Search\SearchRequest;
 use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Range filter, selects documents from lower limit to upper limit.
  */
-class Range extends AbstractSingleRequestValueFilter implements FieldAwareInterface, ViewDataFactoryInterface
+class Range extends AbstractRange
 {
-    use FieldAwareTrait;
-
     /**
      * {@inheritdoc}
      */
@@ -50,25 +42,17 @@ public function getState(Request $request)
             return $state;
         }
 
-        $normalized['gt'] = floatval($values[0]);
-        $normalized['lt'] = floatval($values[1]);
+        $gt = $this->isInclusive() ? 'gte' : 'gt';
+        $lt = $this->isInclusive() ? 'lte' : 'lt';
+
+        $normalized[$gt] = floatval($values[0]);
+        $normalized[$lt] = floatval($values[1]);
 
         $state->setValue($normalized);
 
         return $state;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function modifySearch(Search $search, FilterState $state = null, SearchRequest $request = null)
-    {
-        if ($state && $state->isActive()) {
-            $filter = new RangeFilter($this->getField(), $state->getValue());
-            $search->addPostFilter($filter);
-        }
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -79,14 +63,6 @@ public function preProcessSearch(Search $search, Search $relatedSearch, FilterSt
         $search->addAggregation($stateAgg);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function createViewData()
-    {
-        return new ViewData\RangeAwareViewData();
-    }
-
     /**
      * {@inheritdoc}
      */
diff --git a/Search/FiltersContainer.php b/Search/FiltersContainer.php
@@ -83,7 +83,7 @@ public function buildSearchRequest(Request $request)
      * @param SearchRequest          $request
      * @param FilterInterface[]|null $filters
      *
-     * @return \ElasticsearchBundle\DSL\Search
+     * @return Search
      */
     public function buildSearch(SearchRequest $request, $filters = null)
     {
diff --git a/Tests/Functional/DependencyInjection/Compiler/FilterPassTest.php b/Tests/Functional/DependencyInjection/Compiler/FilterPassTest.php
@@ -51,6 +51,7 @@ public function filterTestProvider()
                 'filters' => [
                     'bar_range' => $fooRangeClass,
                     'sort' => 'ONGR\FilterManagerBundle\Filters\Widget\Sort\Sort',
+                    'inclusive_range' => 'ONGR\FilterManagerBundle\Filters\Widget\Range\Range',
                 ],
             ],
             // Case #1. foo_filters.
diff --git a/Tests/Functional/Filters/Widget/Range/RangeTest.php b/Tests/Functional/Filters/Widget/Range/RangeTest.php
@@ -76,45 +76,78 @@ public function getTestResultsData()
         $managers = $this->getFilterManager();
         // Case #0 range includes everything.
         $out[] = [
-            new Request(['range' => '0;50', 'sort' => '0', 'mode' => null]),
-            ['1', '2', '3', '4', '5'],
-            true,
-            $managers,
+            'request' => new Request(['range' => '0;50', 'sort' => '0', 'mode' => null]),
+            'ids' => ['1', '2', '3', '4', '5'],
+            'assertOrder' => true,
+            'managers' => $managers,
         ];
 
         // Case #1 two elements.
-        $out[] = [new Request(['range' => '1;4', 'sort' => '0', 'mode' => null]), ['2', '3'], true, $managers];
+        $out[] = [
+            'request' => new Request(['range' => '1;4', 'sort' => '0', 'mode' => null]),
+            'ids' => ['2', '3'],
+            'assertOrder' => true,
+            'managers' => $managers,
+        ];
 
         // Case #2 no elements.
-        $out[] = [new Request(['range' => '2;3', 'sort' => '0', 'mode' => null]), [], true, $managers];
+        $out[] = [
+            'request' => new Request(['range' => '2;3', 'sort' => '0', 'mode' => null]),
+            'ids' => [],
+            'assertOrder' => true,
+            'managers' => $managers,
+        ];
 
         // Case #3 invalid range specified.
         $out[] = [
-            new Request(['range' => '2', 'sort' => '0', 'mode' => null]),
+            'request' => new Request(['range' => '2', 'sort' => '0', 'mode' => null]),
+            'ids' => ['1', '2', '3', '4', '5'],
+            'assertOrder' => true,
+            'managers' => $managers,
+        ];
+
+        // Case #4 no range specified.
+        $out[] = [
+            new Request(['sort' => '0', 'mode' => null]),
             ['1', '2', '3', '4', '5'],
             true,
             $managers,
         ];
 
-        // Case #4 no range specified.
-        $out[] = [new Request(['sort' => '0', 'mode' => null]), ['1', '2', '3', '4', '5'], true, $managers];
-
         // Case #5 test with float shouldn't list anything.
-        $out[] = [new Request(['range' => '4.3;50', 'sort' => '0', 'mode' => null]), [], true, $managers];
+        $out[] = [
+            'request' => new Request(['range' => '4.3;50', 'sort' => '0', 'mode' => null]),
+            'ids' => [],
+            'assertOrder' => true,
+            'managers' => $managers,
+        ];
 
         // Case #6 test with float should list.
-        $out[] = [new Request(['range' => '4.1;50', 'sort' => '0', 'mode' => null]), ['5'], true, $managers];
+        $out[] = [
+            'request' => new Request(['range' => '4.1;50', 'sort' => '0', 'mode' => null]),
+            'ids' => ['5'],
+            'assertOrder' => true,
+            'managers' => $managers,
+        ];
+
+        // Case #7 Inclusive filter.
+        $out[] = [
+            'request' => new Request(['inclusive_range' => '1;2', 'sort' => '0', 'mode' => null]),
+            'ids' => ['1', '2'],
+            'assertOrder' => true,
+            'managers' => $managers,
+        ];
 
         return $out;
     }
 
     /**
      * Check if view data returned is correct.
      *
-     * @param Request $request     Http request.
-     * @param array   $ids         Array of document ids to assert.
-     * @param bool    $assertOrder Set true if order of results lso should be asserted.
-     * @param array   $managers    Set of filter managers to test.
+     * @param Request          $request     Http request.
+     * @param array            $ids         Array of document ids to assert.
+     * @param bool             $assertOrder Set true if order of results lso should be asserted.
+     * @param FiltersManager[] $managers    Set of filter managers to test.
      *
      * @dataProvider getTestResultsData()
      */
@@ -149,6 +182,12 @@ protected function getFilterManager()
         $filter->setField('price');
         $container->set('range', $filter);
 
+        $filter = new Range();
+        $filter->setRequestField('inclusive_range');
+        $filter->setField('price');
+        $filter->setInclusive(true);
+        $container->set('inclusive_range', $filter);
+
         $sort = new Sort();
         $sort->setRequestField('sort');
         $sort->setChoices($choices);
@@ -167,10 +206,10 @@ protected function getFilterManager()
     /**
      * This method asserts if search request gives expected results.
      *
-     * @param Request $request     Http request.
-     * @param array   $ids         Array of document ids to assert.
-     * @param bool    $assertOrder Set true if order of results lso should be asserted.
-     * @param array   $managers    Set of filter managers to test.
+     * @param Request          $request     Http request.
+     * @param array            $ids         Array of document ids to assert.
+     * @param bool             $assertOrder Set true if order of results lso should be asserted.
+     * @param FiltersManager[] $managers    Set of filter managers to test.
      *
      * @dataProvider getTestResultsData()
      */
diff --git a/Tests/Unit/DependencyInjection/ConfigurationTest.php b/Tests/Unit/DependencyInjection/ConfigurationTest.php
diff --git a/Tests/app/config/config_test.yml b/Tests/app/config/config_test.yml

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,9 @@ protected function configure(Definition $definition, array $configuration)`
`26`	`26`	`parent::configure($definition, $configuration);`
`27`	`27`
`28`	`28`	`$definition->addMethodCall('setField', [$configuration['field']]);`
	`29`	`+ if (array_key_exists('inclusive', $configuration)) {`
	`30`	`+ $definition->addMethodCall('setInclusive', [$configuration['inclusive']]);`
	`31`	`+ }`
`29`	`32`	`}`
`30`	`33`
`31`	`34`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ public function buildSearchRequest(Request $request)`
`83`	`83`	`* @param SearchRequest $request`
`84`	`84`	`* @param FilterInterface[]\|null $filters`
`85`	`85`	`*`
`86`		`- * @return \ElasticsearchBundle\DSL\Search`
	`86`	`+ * @return Search`
`87`	`87`	`*/`
`88`	`88`	`public function buildSearch(SearchRequest $request, $filters = null)`
`89`	`89`	`{`