IntenseFinance/firefly-iii
3
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-02-25 18:45:27 -06:00
Code Issues Packages Projects Releases Wiki Activity

Renaming of classes, making true recursive structure

Browse Source
This commit is contained in:
Sobuno 2025-01-02 23:19:21 +01:00
parent 2ae3929dd6
commit af7a4b5d3d
7 changed files with 66 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
app/Support/Search/OperatorQuerySearch.php
View File

@ -41,9 +41,10 @@ use FireflyIII\Repositories\Tag\TagRepositoryInterface;
use FireflyIII\Repositories\UserGroups\Currency\CurrencyRepositoryInterface;
use FireflyIII\Support\Search\QueryParser\QueryParserInterface;
use FireflyIII\Support\Search\QueryParser\Node;
use FireflyIII\Support\Search\QueryParser\Field;
use FireflyIII\Support\Search\QueryParser\Word;
use FireflyIII\Support\Search\QueryParser\Subquery;
use FireflyIII\Support\Search\QueryParser\FieldNode;
use FireflyIII\Support\Search\QueryParser\StringNode;
use FireflyIII\Support\Search\QueryParser\NodeGroup;
use FireflyIII\Support\ParseDateString;
use FireflyIII\User;
use Illuminate\Pagination\LengthAwarePaginator;
@ -140,7 +141,7 @@ class OperatorQuerySearch implements SearchInterface
app('log')->debug(sprintf('Using %s as implementation for QueryParserInterface', get_class($parser)));
try {
$nodes = $parser->parse($query);
$parsedQuery = $parser->parse($query);
} catch (\LogicException|\TypeError $e) {
app('log')->error($e->getMessage());
app('log')->error(sprintf('Could not parse search: "%s".', $query));
@ -148,10 +149,8 @@ class OperatorQuerySearch implements SearchInterface
throw new FireflyException(sprintf('Invalid search value "%s". See the logs.', e($query)), 0, $e);
}
app('log')->debug(sprintf('Found %d node(s)', count($nodes)));
foreach ($nodes as $node) {
$this->handleSearchNode($node);
}
app('log')->debug(sprintf('Found %d node(s) at top-level', count($parsedQuery->getNodes())));
$this->handleSearchNode($parsedQuery);
// add missing information
$this->collector->withBillInformation();
@ -170,27 +169,16 @@ class OperatorQuerySearch implements SearchInterface
app('log')->debug(sprintf('Now in handleSearchNode(%s)', get_class($node)));
switch (true) {
case $node instanceof Word:
$word = (string) $node->getValue();
if($node->isProhibited()) {
app('log')->debug(sprintf('Exclude word "%s" from search string', $word));
$this->prohibitedWords[] = $word;
} else {
app('log')->debug(sprintf('Add word "%s" to search string', $word));
$this->words[] = $word;
}
case $node instanceof StringNode:
$this->handleStringNode($node);
break;
case $node instanceof Field:
case $node instanceof FieldNode:
$this->handleFieldNode($node);
break;
case $node instanceof Subquery:
//TODO: Handle Subquery prohibition, i.e. flip all prohibition flags inside the subquery
foreach ($node->getNodes() as $subNode) {
$this->handleSearchNode($subNode);
}
case $node instanceof NodeGroup:
$this->handleNodeGroup($node);
break;
default:
@ -199,10 +187,32 @@ class OperatorQuerySearch implements SearchInterface
}
}
private function handleNodeGroup(NodeGroup $node): void
{
//TODO: Handle Subquery prohibition, i.e. flip all prohibition flags inside the subquery
foreach ($node->getNodes() as $subNode) {
$this->handleSearchNode($subNode);
}
}
private function handleStringNode(StringNode $node): void
{
$string = (string) $node->getValue();
if($node->isProhibited()) {
app('log')->debug(sprintf('Exclude string "%s" from search string', $string));
$this->prohibitedWords[] = $string;
} else {
app('log')->debug(sprintf('Add string "%s" to search string', $string));
$this->words[] = $string;
}
}
/**
* @throws FireflyException
*/
private function handleFieldNode(Field $node): void
private function handleFieldNode(FieldNode $node): void
{
$operator = strtolower($node->getOperator());
$value = $node->getValue();

2
app/Support/Search/QueryParser/Field.php → app/Support/Search/QueryParser/FieldNode.php
View File

@ -7,7 +7,7 @@ namespace FireflyIII\Support\Search\QueryParser;
/**
* Represents a field operator with value (e.g. amount:100)
*/
class Field extends Node
class FieldNode extends Node
{
private string $operator;
private string $value;

15
app/Support/Search/QueryParser/GdbotsQueryParser.php
View File

@ -19,17 +19,18 @@ class GdbotsQueryParser implements QueryParserInterface
}
/**
* @return Node[]
* @return NodeGroup
* @throws FireflyException
*/
public function parse(string $query): array
public function parse(string $query): NodeGroup
{
try {
$result = $this->parser->parse($query);
return array_map(
$nodes = array_map(
fn(GdbotsNode\Node $node) => $this->convertNode($node),
$result->getNodes()
);
return new NodeGroup($nodes);
} catch (\LogicException|\TypeError $e) {
fwrite(STDERR, "Setting up GdbotsQueryParserTest\n");
dd('Creating GdbotsQueryParser');
@ -44,17 +45,17 @@ class GdbotsQueryParser implements QueryParserInterface
{
switch (true) {
case $node instanceof GdbotsNode\Word:
return new Word($node->getValue());
return new StringNode($node->getValue());
case $node instanceof GdbotsNode\Field:
return new Field(
return new FieldNode(
$node->getValue(),
(string) $node->getNode()->getValue(),
BoolOperator::PROHIBITED === $node->getBoolOperator()
);
case $node instanceof GdbotsNode\Subquery:
return new Subquery(
return new NodeGroup(
array_map(
fn(GdbotsNode\Node $subNode) => $this->convertNode($subNode),
$node->getNodes()
@ -69,7 +70,7 @@ class GdbotsQueryParser implements QueryParserInterface
case $node instanceof GdbotsNode\Mention:
case $node instanceof GdbotsNode\Emoticon:
case $node instanceof GdbotsNode\Emoji:
return new Word((string) $node->getValue());
return new StringNode((string) $node->getValue());
default:
throw new FireflyException(

6
app/Support/Search/QueryParser/Subquery.php → app/Support/Search/QueryParser/NodeGroup.php
View File

@ -5,9 +5,11 @@ declare(strict_types=1);
namespace FireflyIII\Support\Search\QueryParser;
/**
* Represents a subquery (group of nodes)
* Represents a group of nodes.
*
* NodeGroups can be nested inside other NodeGroups, making them subqueries
*/
class Subquery extends Node
class NodeGroup extends Node
{
/** @var Node[] */
private array $nodes;

27
app/Support/Search/QueryParser/QueryParser.php
View File

@ -30,16 +30,16 @@ class QueryParser implements QueryParserInterface
private string $query;
private int $position = 0;
/** @return Node[] */
public function parse(string $query): array
/** @return NodeGroup */
public function parse(string $query): NodeGroup
{
$this->query = $query;
$this->position = 0;
return $this->parseQuery(false);
return $this->buildNodeGroup(false);
}
/** @return Node[] */
private function parseQuery(bool $isSubquery): array
/** @return NodeGroup */
private function buildNodeGroup(bool $isSubquery, bool $prohibited = false): NodeGroup
{
$nodes = [];
$nodeResult = $this->buildNextNode($isSubquery);
@ -52,7 +52,7 @@ class QueryParser implements QueryParserInterface
$nodeResult = $this->buildNextNode($isSubquery);
}
return $nodes;
return new NodeGroup($nodes, $prohibited);
}
private function buildNextNode(bool $isSubquery): NodeResult
@ -105,8 +105,7 @@ class QueryParser implements QueryParserInterface
if ($tokenUnderConstruction === '') {
// A left parentheses at the beginning of a token indicates the start of a subquery
$this->position++;
return new NodeResult(
new Subquery($this->parseQuery(true), $prohibited),
return new NodeResult($this->buildNodeGroup(true, $prohibited),
false
);
} else {
@ -161,16 +160,18 @@ class QueryParser implements QueryParserInterface
$this->position++;
}
return new NodeResult($tokenUnderConstruction !== '' || $fieldName !== ''
? $this->createNode($tokenUnderConstruction, $fieldName, $prohibited)
: null, true);
$finalNode = $tokenUnderConstruction !== '' || $fieldName !== ''
? $this->createNode($tokenUnderConstruction, $fieldName, $prohibited)
: null;
return new NodeResult($finalNode, true);
}
private function createNode(string $token, string $fieldName, bool $prohibited): Node
{
if (strlen($fieldName) > 0) {
return new Field(trim($fieldName), trim($token), $prohibited);
return new FieldNode(trim($fieldName), trim($token), $prohibited);
}
return new Word(trim($token), $prohibited);
return new StringNode(trim($token), $prohibited);
}
}

4
app/Support/Search/QueryParser/QueryParserInterface.php
View File

@ -7,7 +7,7 @@ namespace FireflyIII\Support\Search\QueryParser;
interface QueryParserInterface
{
/**
* @return Node[]
* @return NodeGroup
*/
public function parse(string $query): array;
public function parse(string $query): NodeGroup;
}

4
app/Support/Search/QueryParser/Word.php → app/Support/Search/QueryParser/StringNode.php
View File

@ -5,9 +5,9 @@ declare(strict_types=1);
namespace FireflyIII\Support\Search\QueryParser;
/**
* Represents a word in the search query, meaning either a single-word without spaces or a quote-delimited string
* Represents a string in the search query, meaning either a single-word without spaces or a quote-delimited string
*/
class Word extends Node
class StringNode extends Node
{
private string $value;