jjsm01/kimai2
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

improved search with negation (#5453)

Browse Source
This commit is contained in:
Kevin Papst
2025-05-05 18:18:00 +02:00
committed by GitHub
parent 2a9de506a1
commit 452a8d9390
20 changed files with 881 additions and 287 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
tests/Utils/SearchTermPartTest.php Normal file
View File

@@ -0,0 +1,43 @@
<?php
/*
* This file is part of the Kimai time-tracking app.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace App\Tests\Utils;
use App\Utils\SearchTermPart;
use PHPUnit\Framework\TestCase;
/**
* @covers \App\Utils\SearchTermPart
*/
class SearchTermPartTest extends TestCase
{
public static function getTestData(): array
{
return [
['foo bar test 1', 'foo bar test 1', null, false],
['foo:bar test 1', 'bar test 1', 'foo', false],
['foo:!bar test 1', 'bar test 1', 'foo', true],
['!bar', 'bar', null, true],
['bar', 'bar', null, false],
['hello:world', 'world', 'hello', false],
['hello:!world', 'world', 'hello', true],
];
}
/**
* @dataProvider getTestData
*/
public function testSearchTerm(string $term, string $expected, ?string $field, bool $excluded): void
{
$sut = new SearchTermPart($term);
self::assertEquals($expected, $sut->getTerm());
self::assertEquals($field, $sut->getField());
self::assertEquals($excluded, $sut->isExcluded());
}
}

134
tests/Utils/SearchTermTest.php
View File

@@ -22,11 +22,22 @@ class SearchTermTest extends TestCase
$sut = new SearchTerm('foo bar test 1');
self::assertEquals('foo bar test 1', $sut->getSearchTerm());
self::assertEmpty($sut->getSearchFields());
self::assertFalse($sut->hasSearchField('foo'));
self::assertTrue($sut->hasSearchTerm());
self::assertNull($sut->getSearchField('foo'));
self::assertEquals('foo bar test 1', $sut->getOriginalSearch());
self::assertEquals('foo bar test 1', (string) $sut);
$expectedParts = [
['foo', null, false],
['bar', null, false],
['test', null, false],
['1', null, false],
];
$i = 0;
foreach ($sut->getParts() as $part) {
$expected = $expectedParts[$i++];
self::assertEquals($expected[0], $part->getTerm());
self::assertEquals($expected[1], $part->getField());
self::assertEquals($expected[2], $part->isExcluded());
}
}
public function testWithMetaField(): void
@@ -35,37 +46,130 @@ class SearchTermTest extends TestCase
self::assertFalse($sut->hasSearchTerm());
self::assertEquals('', $sut->getSearchTerm());
self::assertNotEmpty($sut->getSearchFields());
self::assertTrue($sut->hasSearchField('foo'));
self::assertEquals('bar', $sut->getSearchField('foo'));
self::assertEquals(['foo' => 'bar'], $sut->getSearchFields());
self::assertEquals('foo:bar', $sut->getOriginalSearch());
self::assertCount(1, $sut->getParts());
$expectedParts = [
['foo', 'bar', false],
];
$i = 0;
foreach ($sut->getParts() as $part) {
$expected = $expectedParts[$i++];
self::assertEquals($expected[0], $part->getField());
self::assertEquals($expected[1], $part->getTerm());
self::assertEquals($expected[2], $part->isExcluded());
}
}
/**
* @group legacy
*/
public function testWithMultipleMetaFields(): void
{
$sut = new SearchTerm('foo:bar bar:foo');
self::assertFalse($sut->hasSearchTerm());
self::assertEquals('', $sut->getSearchTerm());
self::assertNotEmpty($sut->getSearchFields());
self::assertTrue($sut->hasSearchField('foo'));
self::assertTrue($sut->hasSearchField('bar'));
self::assertEquals('bar', $sut->getSearchField('foo'));
self::assertEquals('foo', $sut->getSearchField('bar'));
self::assertFalse($sut->hasSearchField('test')); // @phpstan-ignore method.deprecated
self::assertTrue($sut->hasSearchField('foo')); // @phpstan-ignore method.deprecated
self::assertTrue($sut->hasSearchField('bar')); // @phpstan-ignore method.deprecated
self::assertEquals('bar', $sut->getSearchField('foo')); // @phpstan-ignore method.deprecated
self::assertEquals('foo', $sut->getSearchField('bar')); // @phpstan-ignore method.deprecated
self::assertEquals(['foo' => 'bar', 'bar' => 'foo'], $sut->getSearchFields());
self::assertEquals('foo:bar bar:foo', $sut->getOriginalSearch());
self::assertCount(2, $sut->getParts());
}
public function testComplexWithMultipleAndDuplicateMetaFields(): void
{
$sut = new SearchTerm('foo:bar hello bar:foo world test foo:bar wuff');
$sut = new SearchTerm('foo:bar hello bar:!foo world test foo:bar2 wuff');
self::assertTrue($sut->hasSearchTerm());
self::assertEquals('hello world test wuff', $sut->getSearchTerm());
self::assertNotEmpty($sut->getSearchFields());
self::assertTrue($sut->hasSearchField('foo'));
self::assertTrue($sut->hasSearchField('bar'));
self::assertEquals('bar', $sut->getSearchField('foo'));
self::assertEquals('foo', $sut->getSearchField('bar'));
self::assertEquals(['foo' => 'bar', 'bar' => 'foo'], $sut->getSearchFields());
self::assertEquals('foo:bar hello bar:foo world test foo:bar wuff', $sut->getOriginalSearch());
self::assertEquals(['foo' => 'bar2', 'bar' => 'foo'], $sut->getSearchFields());
self::assertEquals('foo:bar hello bar:!foo world test foo:bar2 wuff', $sut->getOriginalSearch());
self::assertCount(7, $sut->getParts());
$expectedParts = [
['bar', 'foo', false],
['hello', null, false],
['foo', 'bar', true],
['world', null, false],
['test', null, false],
['bar2', 'foo', false],
['wuff', null, false],
];
$i = 0;
foreach ($sut->getParts() as $part) {
$expected = $expectedParts[$i++];
self::assertEquals($expected[0], $part->getTerm());
self::assertEquals($expected[1], $part->getField());
self::assertEquals($expected[2], $part->isExcluded());
}
}
public function testIssue5221(): void
{
$sut = new SearchTerm('ABC-123: abcd: abcd');
self::assertTrue($sut->hasSearchTerm());
self::assertEquals('ABC-123: abcd: abcd', $sut->getSearchTerm());
self::assertEmpty($sut->getSearchFields());
self::assertEquals([], $sut->getSearchFields());
self::assertEquals('ABC-123: abcd: abcd', $sut->getOriginalSearch());
self::assertCount(3, $sut->getParts());
$expectedParts = [
['ABC-123:', null, false],
['abcd:', null, false],
['abcd', null, false],
];
$i = 0;
foreach ($sut->getParts() as $part) {
$expected = $expectedParts[$i++];
self::assertEquals($expected[0], $part->getTerm());
self::assertEquals($expected[1], $part->getField());
self::assertEquals($expected[2], $part->isExcluded());
}
$sut = new SearchTerm('1 : 1:.');
self::assertTrue($sut->hasSearchTerm());
self::assertEquals('1 :', $sut->getSearchTerm());
self::assertNotEmpty($sut->getSearchFields());
self::assertSame([1 => '.'], $sut->getSearchFields()); // this is weird, should be a string, but PHP seems to think otherwise
self::assertEquals('1 : 1:.', $sut->getOriginalSearch());
self::assertCount(3, $sut->getParts());
$expectedParts = [
['1', null, false],
[':', null, false],
['.', '1', false],
];
$i = 0;
foreach ($sut->getParts() as $part) {
$expected = $expectedParts[$i++];
self::assertEquals($expected[0], $part->getTerm());
self::assertEquals($expected[1], $part->getField());
self::assertEquals($expected[2], $part->isExcluded());
}
}
public function testEmptySearchTerm(): void
{
$sut = new SearchTerm('ABC-123:"" abcd:"" abcd');
self::assertTrue($sut->hasSearchTerm());
self::assertEquals('abcd', $sut->getSearchTerm());
self::assertNotEmpty($sut->getSearchFields());
self::assertEquals(['ABC-123' => '', 'abcd' => ''], $sut->getSearchFields());
self::assertEquals('ABC-123:"" abcd:"" abcd', $sut->getOriginalSearch());
self::assertCount(3, $sut->getParts());
$expectedParts = [
['', 'ABC-123', false],
['', 'abcd', false],
['abcd', null, false],
];
$i = 0;
foreach ($sut->getParts() as $part) {
$expected = $expectedParts[$i++];
self::assertEquals($expected[0], $part->getTerm());
self::assertEquals($expected[1], $part->getField());
self::assertEquals($expected[2], $part->isExcluded());
}
}
}