Skip to content

Commit

Permalink
implement glob spec
Browse files Browse the repository at this point in the history
  • Loading branch information
@jaapio
jaapio committed Dec 20, 2019
1 parent ce5d9a3 commit b8256ce
Show file tree
Hide file tree
Showing 6 changed files with 503 additions and 1 deletion.
35 changes: 35 additions & 0 deletions examples/04-sample-phpdoc-layout-using-glob.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?php
require_once(__DIR__ . '/../vendor/autoload.php');

use Flyfinder\Specification\Glob;
use League\Flysystem\Filesystem;
use League\Flysystem\Adapter\Local;
use Flyfinder\Finder;
use Flyfinder\Path;
use Flyfinder\Specification\IsHidden;
use Flyfinder\Specification\HasExtension;
use Flyfinder\Specification\InPath;
use Flyfinder\Specification\AndSpecification;

// (03-sample-files based on some phpDocumentor2 src files)
$filesystem = new Filesystem(new Local(__DIR__ . '/03-sample-files'));
$filesystem->addPlugin(new Finder());

/*
* "phpdoc -d src -i src/phpDocumentor/DomainModel"
* should result in src/Cilex and src/phpDocumentor/. files being found,
* but src/phpDocumentor/DomainModel files being left out
*/
$dashDirectoryPath = new Glob('/src/**/*');
$dashIgnorePath = new InPath(new Path('src/phpDocumentor/DomainModel'));
$isHidden = new IsHidden();
$isPhpFile = new HasExtension(['php']);
$spec = new AndSpecification($dashDirectoryPath, $dashIgnorePath->notSpecification());
$spec->andSpecification($isHidden->notSpecification());
$spec->andSpecification($isPhpFile);

$generator = $filesystem->find($spec);
$result = [];
foreach($generator as $value) {
$result[] = $value;
}
1 change: 1 addition & 0 deletions phpcs.xml.dist
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<rule ref="Generic.Files.LineLength.TooLong">
<exclude-pattern>*/src/Finder.php</exclude-pattern>
<exclude-pattern>*/src/Specification/SpecificationInterface.php</exclude-pattern>
<exclude-pattern>*/tests/unit/Specification/GlobTest.php</exclude-pattern>
</rule>


Expand Down
261 changes: 261 additions & 0 deletions src/Specification/Glob.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,261 @@
<?php

declare(strict_types=1);

/**
* This file is part of phpDocumentor.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* Many thanks to webmozart by providing the original code in webmozart/glob
*
* @link https://github.com/webmozart/glob/blob/master/src/Glob.php
* @link http://phpdoc.org
*/

namespace Flyfinder\Specification;

use InvalidArgumentException;
use function preg_match;
use function sprintf;
use function strlen;
use function strpos;

/**
* Glob specification class
*
* @psalm-immutable
*/
final class Glob extends CompositeSpecification
{
/** @var string */
private $regex;

/**
* The "static prefix" is the part of the glob up to the first wildcard "*".
* If the glob does not contain wildcards, the full glob is returned.
*
* @var string
*/
private $staticPrefix;

public function __construct(string $glob)
{
$this->regex = self::toRegEx($glob);
$this->staticPrefix = self::getStaticPrefix($glob);
}

/**
* @inheritDoc
*/
public function isSatisfiedBy(array $value) : bool
{
//Flysystem paths are not absolute, so make it that way.
$path = '/' . $value['path'];
if (strpos($path, $this->staticPrefix) !== 0) {
return false;
}

if (preg_match($this->regex, $path)) {
return true;
}

return false;
}

/**
* Returns the static prefix of a glob.
*
* The "static prefix" is the part of the glob up to the first wildcard "*".
* If the glob does not contain wildcards, the full glob is returned.
*
* @param string $glob The canonical glob. The glob should contain forward
* slashes as directory separators only. It must not
* contain any "." or ".." segments.
*
* @return string The static prefix of the glob.
*
* @psalm-pure
*/
private static function getStaticPrefix(string $glob) : string
{
if (strpos($glob, '/') !== 0 && strpos($glob, '://') === false) {
throw new InvalidArgumentException(sprintf(
'The glob "%s" is not absolute and not a URI.',
$glob
));
}
$prefix = '';
$length = strlen($glob);
for ($i = 0; $i < $length; ++$i) {
$c = $glob[$i];
switch ($c) {
case '/':
$prefix .= '/';
if (self::isRecursiveWildcard($glob, $i)) {
break 2;
}
break;
case '*':
case '?':
case '{':
case '[':
break 2;
case '\\':
if (isset($glob[$i + 1])) {
switch ($glob[$i + 1]) {
case '*':
case '?':
case '{':
case '}':
case '[':
case ']':
case '-':
case '^':
case '$':
case '~':
case '\\':
$prefix .= $glob[$i + 1];
++$i;
break;
default:
$prefix .= '\\';
}
}
break;
default:
$prefix .= $c;
break;
}
}
return $prefix;
}

/**
* Checks if the current position the glob is start of a Recursive directory wildcard
*
* @psalm-pure
*/
private static function isRecursiveWildcard(string $glob, int $i) : bool
{
return isset($glob[$i + 3]) && $glob[$i + 1] . $glob[$i + 2] . $glob[$i + 3] === '**/';
}

/**
* Converts a glob to a regular expression.
*
* @param string $glob The canonical glob. The glob should contain forward
* slashes as directory separators only. It must not
* contain any "." or ".." segments.
*
* @return string The regular expression for matching the glob.
*
* @psalm-pure
*/
private static function toRegEx(string $glob) : string
{
$delimiter = '~';
$inSquare = false;
$curlyLevels = 0;
$regex = '';
$length = strlen($glob);
for ($i = 0; $i < $length; ++$i) {
$c = $glob[$i];
switch ($c) {
case '.':
case '(':
case ')':
case '|':
case '+':
case '^':
case '$':
case $delimiter:
$regex .= '\\' . $c;
break;
case '/':
if (self::isRecursiveWildcard($glob, $i)) {
$regex .= '/([^/]+/)*';
$i += 3;
} else {
$regex .= '/';
}
break;
case '*':
$regex .= '[^/]*';
break;
case '?':
$regex .= '.';
break;
case '{':
$regex .= '(';
++$curlyLevels;
break;
case '}':
if ($curlyLevels > 0) {
$regex .= ')';
--$curlyLevels;
} else {
$regex .= '}';
}
break;
case ',':
$regex .= $curlyLevels > 0 ? '|' : ',';
break;
case '[':
$regex .= '[';
$inSquare = true;
if (isset($glob[$i + 1]) && $glob[$i + 1] === '^') {
$regex .= '^';
++$i;
}
break;
case ']':
$regex .= $inSquare ? ']' : '\\]';
$inSquare = false;
break;
case '-':
$regex .= $inSquare ? '-' : '\\-';
break;
case '\\':
if (isset($glob[$i + 1])) {
switch ($glob[$i + 1]) {
case '*':
case '?':
case '{':
case '}':
case '[':
case ']':
case '-':
case '^':
case '$':
case '~':
case '\\':
$regex .= '\\' . $glob[$i + 1];
++$i;
break;
default:
$regex .= '\\\\';
}
}
break;
default:
$regex .= $c;
break;
}
}
if ($inSquare) {
throw new InvalidArgumentException(sprintf(
'Invalid glob: missing ] in %s',
$glob
));
}
if ($curlyLevels > 0) {
throw new InvalidArgumentException(sprintf(
'Invalid glob: missing } in %s',
$glob
));
}
return $delimiter . '^' . $regex . '$' . $delimiter;
}
}
2 changes: 1 addition & 1 deletion .../integration/FindOnSamplePhpdocLayout.php → ...egration/FindOnSamplePhpdocLayoutTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
*
* @coversNothing
*/
class FindOnSamplePhpdocLayout extends TestCase
class FindOnSamplePhpdocLayoutTest extends TestCase
{
public function testFindingOnSamplePhpdocLayout() : void
{
Expand Down
36 changes: 36 additions & 0 deletions tests/integration/FindOnSamplePhpdocLayoutUsingGlobTest.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?php

declare(strict_types=1);

/**
* This file is part of phpDocumentor.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @link http://phpdoc.org
*/

namespace Flyfinder;

use PHPUnit\Framework\TestCase;

/**
* Integration test against examples/04-sample-phpdoc-layout-using-glob.php
*
* @coversNothing
*/
class FindOnSamplePhpdocLayoutUsingGlobTest extends TestCase
{
public function testFindingOnSamplePhpdocLayout() : void
{
$result = [];
include __DIR__ . '/../../examples/04-sample-phpdoc-layout-using-glob.php';

$this->assertCount(4, $result);
$this->assertSame('JmsSerializerServiceProvider.php', $result[0]['basename']);
$this->assertSame('MonologServiceProvider.php', $result[1]['basename']);
$this->assertSame('Application.php', $result[2]['basename']);
$this->assertSame('Bootstrap.php', $result[3]['basename']);
}
}
Loading

0 comments on commit b8256ce

Please sign in to comment.