MensBeam/Arsse
3
1
Fork 0
Code Issues 24 Pull requests Releases 28 Activity

Function to apply filter rules

Browse source
This commit is contained in:
J. King 2021-01-03 22:15:39 -05:00
parent b12f87e231
commit 47ae65b9d3
2 changed files with 87 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
lib/Rule/Rule.php
View file

@ -28,4 +28,61 @@ abstract class Rule {
}
return $pattern;
}
}
public static function validate(string $pattern): bool {
try {
static::prep($pattern);
} catch (Exception $e) {
return false;
}
return true;
}
/** applies keep and block rules against the title and categories of an article
*
* Returns true if the article is to be kept, and false if it is to be suppressed
*/
public static function apply(string $keepRule, string $blockRule, string $title, array $categories = []): bool {
// if neither rule is processed we should keep
$keep = true;
// add the title to the front of the category array
array_unshift($categories, $title);
// process the keep rule if it exists
if (strlen($keepRule)) {
try {
$rule = static::prep($keepRule);
} catch (Exception $e) {
return true;
}
// if a keep rule is specified the default state is now not to keep
$keep = false;
foreach ($categories as $str) {
if (is_string($str)) {
if (preg_match($rule, $str)) {
// keep if the keep-rule matches one of the strings
$keep = true;
break;
}
}
}
}
// process the block rule if the keep rule was matched
if ($keep && strlen($blockRule)) {
try {
$rule = static::prep($blockRule);
} catch (Exception $e) {
return true;
}
foreach ($categories as $str) {
if (is_string($str)) {
if (preg_match($rule, $str)) {
// do not keep if the block-rule matches one of the strings
$keep = false;
break;
}
}
}
}
return $keep;
}
}

30
tests/cases/Misc/TestRule.php
View file

@ -7,16 +7,44 @@ declare(strict_types=1);
namespace JKingWeb\Arsse\TestCase\Misc;
use JKingWeb\Arsse\Rule\Rule;
use JKingWeb\Arsse\Rule\Exception;
/** @covers \JKingWeb\Arsse\Rule\Rule */
class TestRule extends \JKingWeb\Arsse\Test\AbstractTest {
public function testPrepareAPattern(): void {
$exp = "`\\`..\\`..\\`..\\\\\\`..`u";
$this->assertTrue(Rule::validate("`..`..\\`..\\\\`.."));
$this->assertSame($exp, Rule::prep("`..`..\\`..\\\\`.."));
}
public function testPrepareAnInvalidPattern(): void {
$this->assertFalse(Rule::validate("["));
$this->assertException("invalidPattern", "Rule");
Rule::prep("[");
}
}
/** @dataProvider provideApplications */
public function testApplyRules(string $keepRule, string $blockRule, string $title, array $categories, $exp): void {
if ($exp instanceof \Exception) {
$this->assertException($exp);
Rule::apply($keepRule, $blockRule, $title, $categories);
} else {
$this->assertSame($exp, Rule::apply($keepRule, $blockRule, $title, $categories));
}
}
public function provideApplications(): iterable {
return [
["", "", "Title", ["Dummy", "Category"], true],
["^Title$", "", "Title", ["Dummy", "Category"], true],
["^Category$", "", "Title", ["Dummy", "Category"], true],
["^Naught$", "", "Title", ["Dummy", "Category"], false],
["", "^Title$", "Title", ["Dummy", "Category"], false],
["", "^Category$", "Title", ["Dummy", "Category"], false],
["", "^Naught$", "Title", ["Dummy", "Category"], true],
["^Category$", "^Category$", "Title", ["Dummy", "Category"], false],
["[", "", "Title", ["Dummy", "Category"], true],
["", "[", "Title", ["Dummy", "Category"], true],
];
}
}