ruflin / Elastica

tests/Suggest/TermTest.php

<?php

namespace Elastica\Test\Suggest;

use Elastica\Document;
use Elastica\Index;
use Elastica\Suggest;
use Elastica\Suggest\Term;
use Elastica\Test\Base as BaseTest;

/**
 * @internal
 */
class TermTest extends BaseTest
{
    /**
     * @group unit
     */
    public function testToArray(): void
    {
        $suggest = new Suggest();

        $suggest1 = new Term('suggest1', '_all');
        $suggest1->setSort(Term::SORT_FREQUENCY);

        $suggest->addSuggestion($suggest1->setText('Foor'));

        $suggest2 = new Term('suggest2', '_all');
        $suggest2->setSuggestMode(Term::SUGGEST_MODE_POPULAR);
        $suggest->addSuggestion($suggest2->setText('Girhub'));

        $expected = [
            'suggest' => [
                'suggest1' => [
                    'term' => [
                        'field' => '_all',
                        'sort' => 'frequency',
                    ],
                    'text' => 'Foor',
                ],
                'suggest2' => [
                    'term' => [
                        'field' => '_all',
                        'suggest_mode' => 'popular',
                    ],
                    'text' => 'Girhub',
                ],
            ],
        ];

        $this->assertEquals($expected, $suggest->toArray());
    }

    /**
     * @group unit
     */
    public function testDistanceAlgorithm(): void
    {
        $suggest = new Suggest();

        $suggest1 = new Term('suggest1', '_all');
        $suggest1->setSort(Term::SORT_FREQUENCY);

        $suggest->addSuggestion($suggest1->setText('Foor'));

        $suggest2 = new Term('suggest2', '_all');
        $suggest2->setSuggestMode(Term::SUGGEST_MODE_POPULAR);
        $suggest2->setStringDistanceAlgorithm('jaro_winkler');
        $suggest->addSuggestion($suggest2->setText('Girhub'));

        $expected = [
            'suggest' => [
                'suggest1' => [
                    'term' => [
                        'field' => '_all',
                        'sort' => 'frequency',
                    ],
                    'text' => 'Foor',
                ],
                'suggest2' => [
                    'term' => [
                        'field' => '_all',
                        'suggest_mode' => 'popular',
                        'string_distance' => 'jaro_winkler',
                    ],
                    'text' => 'Girhub',
                ],
            ],
        ];

        $this->assertEquals($expected, $suggest->toArray());
    }

    /**
     * @group functional
     */
    public function testSuggestResults(): void
    {
        $suggest = new Suggest();
        $suggest1 = new Term('suggest1', 'text');
        $suggest->addSuggestion($suggest1->setText('Foor seach'));
        $suggest2 = new Term('suggest2', 'text');
        $suggest->addSuggestion($suggest2->setText('Girhub'));
        $suggest2->setStringDistanceAlgorithm('jaro_winkler');

        $index = $this->_getIndexForTest();
        $result = $index->search($suggest);

        $this->assertEquals(2, $result->countSuggests());

        $suggests = $result->getSuggests();

        // Ensure that two suggestion results are returned for suggest1
        $this->assertCount(2, $suggests['suggest1']);

        $this->assertEquals('github', $suggests['suggest2'][0]['options'][0]['text']);
        $this->assertEquals('food', $suggests['suggest1'][0]['options'][0]['text']);
    }

    /**
     * @group functional
     */
    public function testSuggestNoResults(): void
    {
        $termSuggest = new Term('suggest1', 'text');
        $termSuggest->setText('Foobar')->setSize(4);

        $index = $this->_getIndexForTest();
        $result = $index->search($termSuggest);

        $this->assertEquals(1, $result->countSuggests());

        // Assert that no suggestions were returned
        $suggests = $result->getSuggests();
        $this->assertCount(0, $suggests['suggest1'][0]['options']);
    }

    protected function _getIndexForTest(): Index

This method seems to be duplicated in your project.

    {
        $index = $this->_createIndex();
        $index->addDocuments([
            new Document(1, ['id' => 1, 'text' => 'GitHub']),
            new Document(2, ['id' => 1, 'text' => 'Elastic']),
            new Document(3, ['id' => 1, 'text' => 'Search']),
            new Document(4, ['id' => 1, 'text' => 'Food']),
            new Document(5, ['id' => 1, 'text' => 'Flood']),
            new Document(6, ['id' => 1, 'text' => 'Folks']),
        ]);
        $index->refresh();

        return $index;
    }
}