Plány na nový File Finder

Jedna z knihoven, které už moře let plánuju předělat, je Finder. Narazil jsem totiž časem na různé situace, kdy mi nevyhovoval.

V současnosti funguje takto:

Finder::findFiles('*.php', '*.inc')->in('/foo');   // hledá /foo/*.php a /foo/*.inc
Finder::findFiles('*.php', '*.inc')->from('/foo'); // hledá navíc v podadresářích
// nebo Finder::find() a Finder::findDirectories()

plus vyloučení:

Finder::findFiles('*.php', '*.inc')
	->exclude('temp.php') // vyloučení názvu souboru
	->from('/foo')
	->exclude('vendor') // vyloučení cesty, nebude prohledávat např. v /foo/sub/vendor

V metodě in() a from() musí být platný adresář, ve find*() a exclude() mohou být souborové/adresářové masky.

Masky a cesty všude

Líbilo by se mi, kdyby šel konfigurovat podobně jako gitignore. Včetně podpory pro wildcard **, který představuje libovolně mnoho adresářů. Pokud zapíšu třeba foo/**/file.php, znamená to jak foo/sub/file.php, tak i foo/file.php nebo foo/sub1/sub2/file.php.

Plán je, že by ve všech zmíněných metodách mohla být maska i adresář. Třeba ve findFiles():

Finder::findFiles('tests/*.inc')->from('/foo');    // *.inc kdekoliv ve /foo/**/tests
Finder::findFiles('**/tests/*.inc')->from('/foo'); // ekvivalent předchozího
Finder::findFiles('./tests/*.inc')->from('/foo');  // *.inc jen ve /foo/tests

Maska v in() a from():

Finder::findFiles('*.php')->in('/foo/*/vendor');
Finder::findFiles('*.php')->in('/foo/*/vendor/**'); // totéž jako from('/foo/*/vendor')
Finder::findFiles('*.php')->from('/foo/**/vendor'); // najde i /foo/sub1/sub2/vendor/sub3/file.php

Vlastně by klidně mohlo jít zapsat i stručné:

Finder::findFiles('/foo/**/*.php');

A nakonec masky a adresáře ve vyloučení:

Finder::findFiles('*.php')->from('/foo')->exclude('tests/*.inc');    // vynechá *.inc v tests/
Finder::findFiles('*.php')->from('/foo')->exclude('**/tests/*.inc'); // ekvivalent předchozího
Finder::findFiles('*.php')->from('/foo')->exclude('./tests/*.inc');  // vynechá *.inc jen ve /foo/tests/
Finder::findFiles('*.php')->from('/foo')->exclude('bar/');  // vynechá jen adresáře bar/ při procházení

FileInfo

Vrácené soubory budou objekty Nette\Utils\FileInfo, což je potomek původního SplFileInfo, ale přidává důležité metody getRelativePath() a getRelativePathname(), které mi vždycky chyběly. Přidám asi i read a write pro přečtení/zápis obsahu souboru.

Další věci

Metody pro přidání cest a masek půjde volat vícekrát. Protože nejde volat vícekrát statickou metodu jako např. findFiles(), přidám metody files() a directories():

(new Finder)->files('*.php')->files('*.inc')->in('/foo')->from('/bar');

Také by bylo možné říct, že chci hledat soubory dle určité masky v jednom adresáři a dle jiné masky v jiném adresáři. Mohlo by to vypadat nějak takto:

($finder = new Finder)
	->files('*.php')->in('/foo')
	->append()
	->files('*.inc')->from('/bar');

Do výsledku je tak možné přidat třeba jeden soubor navíc:

$finder = Finder::findFiles('*.php')->from('/foo')
	->append(__FILE__);

Dále lze přeskakovat adresáře, které nelze číst pomocí $finder->ignoreUnreadableDirs() (uvažuju, že by to mohlo být default) a třídit adresáře a v nich soubory pomocí $finder->sortByName().

Máte k tomu nějaké nápady nebo něco dalšího vám u Finderu chybí?