Merge pull request #87 from iforwms/feature/whitelist

Allow white-listing models

Author: mpociot

config/config.php

@@ -23,7 +23,18 @@
  // 'user'
  // ]
  ],
- 
+
+ /*
+ * If you want to see only specific models, specify them here using fully qualified
+ * classnames.
+ *
+ * Note: that if this array is filled, the 'ignore' array will not be used.
+ */
+ 'whitelist' => [
+ // App\User::class,
+ // App\Post::class,
+ ],
+
  /*
  * If true, all directories specified will be scanned recursively for models.
  * Set this to false if you prefer to explicitly define each directory that should

src/ModelFinder.php

@@ -31,16 +31,25 @@ public function getModelsInDirectory(string $directory): Collection
  $this->filesystem->files($directory);
 
  $ignoreModels = array_filter(config('erd-generator.ignore', []), 'is_string');
+ $whitelistModels = array_filter(config('erd-generator.whitelist', []), 'is_string');
 
- return Collection::make($files)->filter(function ($path) {
+ $collection = Collection::make($files)->filter(function ($path) {
  return Str::endsWith($path, '.php');
  })->map(function ($path) {
  return $this->getFullyQualifiedClassNameFromFile($path);
  })->filter(function (string $className) {
  return !empty($className)
  && is_subclass_of($className, EloquentModel::class)
  && ! (new ReflectionClass($className))->isAbstract();
- })->diff($ignoreModels)->sort();
+ });
+
+ if(!count($whitelistModels)) {
+ return $collection->diff($ignoreModels)->sort();
+ }
+
+ return $collection->filter(function (string $className) use ($whitelistModels) {
+ return in_array($className, $whitelistModels);
+ });
  }
 
  protected function getFullyQualifiedClassNameFromFile(string $path): string

tests/FindModelsFromConfigTest.php

@@ -46,4 +46,22 @@ public function it_will_ignore_a_model_if_it_is_excluded_on_config()
  $classNames->values()->all()
  );
  }
+
+ /** @test */
+ public function it_will_only_return_models_in_whitelist_if_present()
+ {
+ $this->app['config']->set('erd-generator.whitelist', [
+ Avatar::class,
+ ]);
+
+ $finder = new ModelFinder(app()->make('files'));
+
+ $classNames = $finder->getModelsInDirectory(__DIR__ . "/Models");
+
+ $this->assertCount(1, $classNames);
+ $this->assertEquals(
+ [Avatar::class],
+ $classNames->values()->all()
+ );
+ }
 }