Merge pull request #808 from im-denisenko/feature/add-completion-sugg…

…ester Add completion suggester
ruflin · Apr 3, 2015 · da7342d · da7342d
2 parents 3f4fb2c + fa22d84
commit da7342d
Show file tree

Hide file tree

Showing 5 changed files with 162 additions and 3 deletions.
diff --git a/changes.txt b/changes.txt
@@ -1,5 +1,8 @@
 CHANGES
 
+2015-03-29
+- Added Elastica\Suggest\Completion
+
 2015-03-12
 - Fixed short match construction in query DSL #796
 

diff --git a/lib/Elastica/QueryBuilder/DSL/Suggest.php b/lib/Elastica/QueryBuilder/DSL/Suggest.php
@@ -4,6 +4,7 @@
 
 use Elastica\Exception\NotImplementedException;
 use Elastica\QueryBuilder\DSL;
+use Elastica\Suggest\Completion;
 use Elastica\Suggest\Phrase;
 use Elastica\Suggest\Term;
 
@@ -56,10 +57,13 @@ public function phrase($name, $field)
      * completion suggester
      *
      * @link http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-suggesters-completion.html
+     * @param  string     $name
+     * @param  string     $field
+     * @return Completion
      */
-    public function completion()
+    public function completion($name, $field)
     {
-        throw new NotImplementedException();
+        return new Completion($name, $field);
     }
 
     /**

diff --git a/lib/Elastica/Suggest/Completion.php b/lib/Elastica/Suggest/Completion.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace Elastica\Suggest;
+
+/**
+ * Comletion suggester
+ *
+ * @author Igor Denisenko <[email protected]>
+ * @link   http://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters-completion.html
+ */
+class Completion extends AbstractSuggest
+{
+    /**
+     * Set fuzzy parameter
+     * 
+     * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters-completion.html#fuzzy
+     * 
+     * @param  array $fuzzy
+     * @return $this
+     */
+    public function setFuzzy(array $fuzzy)
+    {
+        return $this->setParam('fuzzy', $fuzzy);
+    }
+}
diff --git a/test/lib/Elastica/Test/QueryBuilder/DSL/SuggestTest.php b/test/lib/Elastica/Test/QueryBuilder/DSL/SuggestTest.php
@@ -12,7 +12,7 @@ class SuggestTest extends \PHPUnit_Framework_TestCase
     private $suggesters = array(
         'term' => array('name', 'field'),
         'phrase' => array('name', 'field'),
-        'completion' => array(),
+        'completion' => array('name', 'field'),
         'context' => array(),
     );
 

diff --git a/test/lib/Elastica/Test/Suggest/CompletionTest.php b/test/lib/Elastica/Test/Suggest/CompletionTest.php
@@ -0,0 +1,127 @@
+<?php
+
+namespace Elastica\Test\Suggest;
+
+use Elastica\Document;
+use Elastica\Index;
+use Elastica\Query;
+use Elastica\Suggest\Completion;
+use Elastica\Test\Base as BaseTest;
+
+class CompletionTest extends BaseTest
+{
+    /**
+     * @var Index
+     */
+    protected $_index;
+
+    protected function setUp()
+    {
+        $this->_index = $this->_createIndex();
+        $type = $this->_index->getType('song');
+
+        $type->setMapping(array(
+            'fieldName' => array(
+                'type' => 'completion',
+                'payloads' => true,
+            ),
+        ));
+
+        $type->addDocuments(array(
+            new Document(1, array(
+                'fieldName' => array(
+                    'input' => array('Nevermind', 'Nirvana'),
+                    'output' => 'Nevermind - Nirvana',
+                    'payload' => array(
+                        'year' => 1991,
+                    ),
+                ),
+            )),
+            new Document(2, array(
+                'fieldName' => array(
+                    'input' => array('Bleach', 'Nirvana'),
+                    'output' => 'Bleach - Nirvana',
+                    'payload' => array(
+                        'year' => 1989,
+                    ),
+                ),
+            )),
+            new Document(3, array(
+                'fieldName' => array(
+                    'input' => array('Incesticide', 'Nirvana'),
+                    'output' => 'Incesticide - Nirvana',
+                    'payload' => array(
+                        'year' => 1992,
+                    ),
+                ),
+            )),
+        ));
+
+        $this->_index->refresh();
+    }
+
+    public function testToArray()
+    {
+        $suggest = new Completion('suggestName', 'fieldName');
+        $suggest->setText('foo');
+        $suggest->setSize(10);
+        $expected = array(
+            'text' => 'foo',
+            'completion' => array(
+                'size' => 10,
+                'field' => 'fieldName',
+            ),
+        );
+        $this->assertEquals($expected, $suggest->toArray());
+    }
+
+    public function testSuggestWorks()
+    {
+        $suggest = new Completion('suggestName', 'fieldName');
+        $suggest->setText('Never');
+
+        $resultSet = $this->_index->search(Query::create($suggest));
+
+        $this->assertTrue($resultSet->hasSuggests());
+
+        $suggests = $resultSet->getSuggests();
+        $options = $suggests['suggestName'][0]['options'];
+
+        $this->assertCount(1, $options);
+        $this->assertEquals('Nevermind - Nirvana', $options[0]['text']);
+        $this->assertEquals(1991, $options[0]['payload']['year']);
+    }
+
+    public function testFuzzySuggestWorks()
+    {
+        $suggest = new Completion('suggestName', 'fieldName');
+        $suggest->setFuzzy(array('fuzziness' => 2));
+        $suggest->setText('Neavermint');
+
+        $resultSet = $this->_index->search(Query::create($suggest));
+
+        $this->assertTrue($resultSet->hasSuggests());
+
+        $suggests = $resultSet->getSuggests();
+        $options = $suggests['suggestName'][0]['options'];
+
+        $this->assertCount(1, $options);
+        $this->assertEquals('Nevermind - Nirvana', $options[0]['text']);
+    }
+
+    public function testSetFuzzy()
+    {
+        $suggest = new Completion('suggestName', 'fieldName');
+
+        $fuzzy = array(
+            'unicode_aware' => true,
+            'fuzziness' => 3,
+        );
+
+        $suggest->setFuzzy($fuzzy);
+
+        $this->assertEquals($fuzzy, $suggest->getParam('fuzzy'));
+
+        $this->assertInstanceOf('Elastica\\Suggest\\Completion', $suggest->setFuzzy($fuzzy));
+    }
+}