add --include and --exclude options.

Author: smeghead

CHANGELOG.md

@@ -3,6 +3,9 @@
 ### Features
 
  * add package diagram description to README.
+ * Updated the PHP version of the development environment to 8.1.
+ * add `--include` option. Enabled to specify the search pattern of the PHP source code to be processed.
+ * add `--exclude` option. Enabled to specify the exclusion pattern of the PHP source code to be processed.
 
 ## v0.0.8 (2022-11-21)
 

Dockerfile

@@ -1,4 +1,4 @@
-FROM php:7.4-cli
+FROM php:8.1-cli
 
 RUN apt-get update && apt-get install -y zip git plantuml && apt-get clean && rm -rf /var/lib/apt/lists/*
 

bin/php-class-diagram

@@ -22,6 +22,8 @@ $options = getopt('hv',[
     'php7',
     'php8',
     'header::',
+    'include::',
+    'exclude::',
 ], $rest_index);
 $arguments = array_slice($argv, $rest_index);
 
@@ -32,6 +34,7 @@ A CLI tool that parses the PHP source directory and outputs PlantUML class diagr
 
 OPTIONS
   -h, --help                     show this help page.
+  -v, --version                  show version.
       --class-diagram            output class diagram script. (default)
       --package-diagram          output package diagram script.
       --jig-diagram              output class diagram and package diagram script.
@@ -43,6 +46,8 @@ OPTIONS
       --php7                     parse php source file as php7.
       --php8                     parse php source file as php8. (not suppoted)
       --header='header string'   additional header string. You can specify multiple header values.
+      --include='wildcard'       include target file pattern. (default: `*.php`) You can specify multiple include patterns.
+      --exclude='wildcard'       exclude target file pattern. You can specify multiple exclude patterns.
 
 EOS;
 

src/Config/Options.php

@@ -89,4 +89,34 @@ public function headers(): array {
         }
         return $headers;
     }
+
+    /**
+     * @return string[] specified includes
+     */
+    public function includes(): array {
+        $includes = [];
+        if (isset($this->opt['include'])) {
+            $includes = $this->opt['include'];
+            if ( ! is_array($includes)) {
+                $includes = [$includes];
+            }
+        } else {
+            $includes[] = '*.php';
+        }
+        return $includes;
+    }
+
+    /**
+     * @return string[] specified excludes
+     */
+    public function excludes(): array {
+        $excludes = [];
+        if (isset($this->opt['exclude'])) {
+            $excludes = $this->opt['exclude'];
+            if ( ! is_array($excludes)) {
+                $excludes = [$excludes];
+            }
+        }
+        return $excludes;
+    }
 }

src/Main.php

@@ -15,13 +15,17 @@ class Main {
     public function __construct(string $directory, Options $options) {
         $finder = new Finder();
         $finder->files()->in($directory);
-        $finder->files()->name('*.php');
+        $finder->files()->name($options->includes());
+        $excludes = $options->excludes();
+        if (count($excludes) > 0) {
+            $finder->files()->notName($excludes);
+        }
         $entries = [];
         foreach ($finder as $file) {
             try {
                 $reflections = PhpReader::parseFile(realpath($directory), $file->getRealPath(), $options);
                 foreach ($reflections as $reflection) {
-                  $entries[] = new Entry($file->getRelativePath(), $reflection->getInfo(), $options);
+                    $entries[] = new Entry($file->getRelativePath(), $reflection->getInfo(), $options);
                 }
             } catch (\Exception $e) {
                 fputs(STDERR, $e->getMessage() . "\r\n");

test/OptionsTest.php

@@ -163,5 +163,65 @@ public function testMultipleHeaders(): void {
         $this->assertSame('title PHP Class Diagram', $options->headers()[0], 'specified header. title');
         $this->assertSame('skinparam pageMargin 10', $options->headers()[1], 'specified header. pageMargin');
     }
+    public function testInclude(): void {
+        $opt = [
+            'include' => '*.php8',
+        ];
+
+        $options = new Options($opt);
+
+        $this->assertSame('*.php8', $options->includes()[0], 'specified include.');
+    }
+    public function testMultipleInclude(): void {
+        $opt = [
+            'include' => [
+                '*.php7',
+                '*.php8',
+            ],
+        ];
+
+        $options = new Options($opt);
+
+        $this->assertSame('*.php7', $options->includes()[0], 'specified include. php7');
+        $this->assertSame('*.php8', $options->includes()[1], 'specified include. php8');
+    }
+    public function testIncludeDefault(): void {
+        $opt = [
+        ];
+
+        $options = new Options($opt);
+
+        $this->assertSame('*.php', $options->includes()[0], 'default include.');
+    }
+    public function testexclude(): void {
+        $opt = [
+            'exclude' => '*Exception.php',
+        ];
+
+        $options = new Options($opt);
+
+        $this->assertSame('*Exception.php', $options->excludes()[0], 'specified exclude.');
+    }
+    public function testMultipleExclude(): void {
+        $opt = [
+            'exclude' => [
+                '*Exception.php',
+                'config.php',
+            ],
+        ];
+
+        $options = new Options($opt);
+
+        $this->assertSame('*Exception.php', $options->excludes()[0], 'specified exclude. *Exception.php');
+        $this->assertSame('config.php', $options->excludes()[1], 'specified exclude. config.php');
+    }
+    public function testExcludeDefault(): void {
+        $opt = [
+        ];
+
+        $options = new Options($opt);
+
+        $this->assertSame(0, count($options->excludes()), 'default exclude is empty.');
+    }
 
 }