kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-09-18 18:44:16 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #9598 from Sobuno/NewQueryParserV3

Browse Source 
New Query Parser for Search Engine and Rules
This commit is contained in:
James Cole
2025-01-05 07:32:55 +01:00
committed by GitHub
parent c3ffd39450 dae7e7d507
commit 0810f617c7
21 changed files with 843 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

197
tests/unit/Support/Search/QueryParser/AbstractQueryParserInterfaceParseQueryTest.php Normal file
View File

@@ -0,0 +1,197 @@
<?php
declare(strict_types=1);
namespace Tests\unit\Support\Search\QueryParser;
use FireflyIII\Support\Search\QueryParser\FieldNode;
use FireflyIII\Support\Search\QueryParser\QueryParserInterface;
use FireflyIII\Support\Search\QueryParser\StringNode;
use FireflyIII\Support\Search\QueryParser\NodeGroup;
use FireflyIII\Support\Search\QueryParser\Node;
use Tests\integration\TestCase;
abstract class AbstractQueryParserInterfaceParseQueryTest extends TestCase
{
abstract protected function createParser(): QueryParserInterface;
public function queryDataProvider(): array
{
return [
'empty query' => [
'query' => '',
'expected' => new NodeGroup([])
],
'simple word' => [
'query' => 'groceries',
'expected' => new NodeGroup([new StringNode('groceries')])
],
'prohibited word' => [
'query' => '-groceries',
'expected' => new NodeGroup([new StringNode('groceries', true)])
],
'prohibited field' => [
'query' => '-amount:100',
'expected' => new NodeGroup([new FieldNode('amount', '100', true)])
],
'quoted word' => [
'query' => '"test phrase"',
'expected' => new NodeGroup([new StringNode('test phrase')])
],
'prohibited quoted word' => [
'query' => '-"test phrase"',
'expected' => new NodeGroup([new StringNode('test phrase', true)])
],
'multiple words' => [
'query' => 'groceries shopping market',
'expected' => new NodeGroup([
new StringNode('groceries'),
new StringNode('shopping'),
new StringNode('market')
])
],
'field operator' => [
'query' => 'amount:100',
'expected' => new NodeGroup([new FieldNode('amount', '100')])
],
'quoted field value with single space' => [
'query' => 'description:"test phrase"',
'expected' => new NodeGroup([new FieldNode('description', 'test phrase')])
],
'multiple fields' => [
'query' => 'amount:100 category:food',
'expected' => new NodeGroup([
new FieldNode('amount', '100'),
new FieldNode('category', 'food')
])
],
'simple subquery' => [
'query' => '(amount:100 category:food)',
'expected' => new NodeGroup([
new NodeGroup([
new FieldNode('amount', '100'),
new FieldNode('category', 'food')
])
])
],
'prohibited subquery' => [
'query' => '-(amount:100 category:food)',
'expected' => new NodeGroup([
new NodeGroup([
new FieldNode('amount', '100'),
new FieldNode('category', 'food')
], true)
])
],
'nested subquery' => [
'query' => '(amount:100 (description:"test" category:food))',
'expected' => new NodeGroup([
new NodeGroup([
new FieldNode('amount', '100'),
new NodeGroup([
new FieldNode('description', 'test'),
new FieldNode('category', 'food')
])
])
])
],
'mixed words and operators' => [
'query' => 'groceries amount:50 shopping',
'expected' => new NodeGroup([
new StringNode('groceries'),
new FieldNode('amount', '50'),
new StringNode('shopping')
])
],
'subquery after field value' => [
'query' => 'amount:100 (description:"market" category:food)',
'expected' => new NodeGroup([
new FieldNode('amount', '100'),
new NodeGroup([
new FieldNode('description', 'market'),
new FieldNode('category', 'food')
])
])
],
'word followed by subquery' => [
'query' => 'groceries (amount:100 description_contains:"test")',
'expected' => new NodeGroup([
new StringNode('groceries'),
new NodeGroup([
new FieldNode('amount', '100'),
new FieldNode('description_contains', 'test')
])
])
],
'nested subquery with prohibited field' => [
'query' => '(amount:100 (description_contains:"test payment" -has_attachments:true))',
'expected' => new NodeGroup([
new NodeGroup([
new FieldNode('amount', '100'),
new NodeGroup([
new FieldNode('description_contains', 'test payment'),
new FieldNode('has_attachments', 'true', true)
])
])
])
],
'complex nested subqueries' => [
'query' => 'shopping (amount:50 market (-category:food word description:"test phrase" (has_notes:true)))',
'expected' => new NodeGroup([
new StringNode('shopping'),
new NodeGroup([
new FieldNode('amount', '50'),
new StringNode('market'),
new NodeGroup([
new FieldNode('category', 'food', true),
new StringNode('word'),
new FieldNode('description', 'test phrase'),
new NodeGroup([
new FieldNode('has_notes', 'true')
])
])
])
])
],
'word with multiple spaces' => [
'query' => '"multiple spaces"',
'expected' => new NodeGroup([new StringNode('multiple spaces')])
],
'field with multiple spaces in value' => [
'query' => 'description:"multiple spaces here"',
'expected' => new NodeGroup([new FieldNode('description', 'multiple spaces here')])
],
'unmatched right parenthesis in word' => [
'query' => 'test)word',
'expected' => new NodeGroup([new StringNode('test)word')])
],
'unmatched right parenthesis in field' => [
'query' => 'description:test)phrase',
'expected' => new NodeGroup([new FieldNode('description', 'test)phrase')])
],
'subquery followed by word' => [
'query' => '(amount:100 category:food) shopping',
'expected' => new NodeGroup([
new NodeGroup([
new FieldNode('amount', '100'),
new FieldNode('category', 'food')
]),
new StringNode('shopping')
])
]
];
}
/**
* @dataProvider queryDataProvider
* @param string $query The query string to parse
* @param Node $expected The expected parse result
*/
public function testQueryParsing(string $query, Node $expected): void
{
$actual = $this->createParser()->parse($query);
$this->assertEquals($expected, $actual);
}
}

23
tests/unit/Support/Search/QueryParser/GdbotsQueryParserParseQueryTest.php Normal file
View File

@@ -0,0 +1,23 @@
<?php
namespace Tests\unit\Support\Search\QueryParser;
use FireflyIII\Support\Search\QueryParser\GdbotsQueryParser;
use FireflyIII\Support\Search\QueryParser\QueryParserInterface;
/**
* @group unit-test
* @group support
* @group search
*
* @internal
*
* @coversNothing
*/
final class GdbotsQueryParserParseQueryTest extends AbstractQueryParserInterfaceParseQueryTest
{
protected function createParser(): QueryParserInterface
{
return new GdbotsQueryParser();
}
}

24
tests/unit/Support/Search/QueryParser/QueryParserParseQueryTest.php Normal file
View File

@@ -0,0 +1,24 @@
<?php
namespace Tests\unit\Support\Search\QueryParser;
use FireflyIII\Support\Search\QueryParser\QueryParser;
use FireflyIII\Support\Search\QueryParser\QueryParserInterface;
/**
* @group unit-test
* @group support
* @group search
*
* @internal
*
* @coversNothing
*/
final class QueryParserParseQueryTest extends AbstractQueryParserInterfaceParseQueryTest
{
protected function createParser(): QueryParserInterface
{
return new QueryParser();
}
}