Skip to content

Single class diagram #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Single class diagram #76

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9cc668a
add an option to only render the class diagram for one single class
pmaasz Aug 29, 2024
9bfdadf
add minimal test
pmaasz Aug 29, 2024
ce64f74
directory or single file are accepted as parameter
pmaasz Aug 29, 2024
47b2368
directory or single file are accepted as parameter
pmaasz Aug 29, 2024
3981207
directory or single file are accepted as parameter
pmaasz Aug 29, 2024
c84be99
cosmetic change
pmaasz Aug 30, 2024
20f0a5d
changes if to check file exists and only put out error for directory
pmaasz Aug 31, 2024
35fce94
removes code because classes already work
pmaasz Aug 31, 2024
bc53408
removes code because classes already work
pmaasz Aug 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions bin/php-class-diagram
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,18 @@ if (empty($directory)) {
fwrite(STDERR, $usage);
exit(-1);
}
if (!is_dir($directory)) {
fwrite(STDERR, sprintf("ERROR: specified directory dose not exists. directory: %s\n", $directory));
fwrite(STDERR, $usage);
exit(-1);
if (!is_file($directory) && !is_dir($directory)) {
if(!is_file($directory)) {
fwrite(STDERR, sprintf("ERROR: specified file dose not exists. file: %s\n", $directory));
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The error message displayed when you think you have specified a directory but the path is wrong is `ERROR: specified file dose not exist.

Since it is the basic policy that the default argument is a directory, [ERROR: specified directory dose not exist.] should be displayed.

It is better to use file_exists to check for the existence of a file or directory, and the error message if it does not exist should always be [ERROR: specified directory dose not exist.].

fwrite(STDERR, $usage);
exit(-1);
}

if (!is_dir($directory)) {
fwrite(STDERR, sprintf("ERROR: specified directory dose not exists. directory: %s\n", $directory));
fwrite(STDERR, $usage);
exit(-1);
}
}

$main = new Main($directory, new Options($options));
Expand Down
45 changes: 42 additions & 3 deletions src/Main.php
View file
Open in desktop
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Including a single file in the processing for Main.php would require a lot of modifications.

This is a more ad-hoc solution, but how about the following change in bin/php-class-diagram?

if (is_file($directory)) {
    $options['include'] = basename($directory);
    $directory = dirname($directory);
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My actual goal is to have a file and draw all existing dependencies of the specified file disregarding the directory. I wanted to do this step by step so I don't tear the project apart. I can mark this MR as a draft and just work on this further. Thanks very much for your input!

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pmaasz
Perhaps this repository is closer to your goal.
https://github.com/hirokinoue/dependency-visualizer
@hirokinoue

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I had a look at the suggested repo and tried it out but the drawn graph is sadly also missing the information I want.

Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,30 @@ public function __construct(
}

public function run(): void
{
if (!is_dir($this->directory)) {
$this->runSingleClass();

return;
}

$this->runDefault();
}

private function runDefault(): void
{
$finder = $this->createFinder();
$entries = $this->findEntries($finder);
$this->renderEntries($entries);
}

private function runSingleClass(): void
{
$finder = $this->createSingleClassFinder();
$entries = $this->findEntries($finder);
$this->renderEntries($entries);
}

private function createFinder(): Finder
{
$finder = new Finder();
Expand All @@ -42,6 +60,26 @@ private function createFinder(): Finder
return $finder;
}

private function createSingleClassFinder(): Finder
{
$fileDir = explode('/', $this->directory);
$fileName = array_pop($fileDir);
$fileDir = implode('/', $fileDir);

$finder = new Finder();
$finder->files()->in($fileDir);
$finder->files()->name([
$fileName,
]);

$excludes = $this->options->excludes();
if (count($excludes) > 0) {
$finder->files()->notName($excludes)->notPath($excludes);
}

return $finder;
}

/**
* @return list<Entry>
*/
Expand All @@ -62,6 +100,7 @@ private function findEntries(Finder $finder): array
fwrite(STDERR, $e->getMessage() . "\r\n");
}
}

return $entries;
}

Expand All @@ -74,9 +113,9 @@ private function renderEntries(array $entries): void

match ($this->options->diagram()) {
Options::DIAGRAM_CLASS => $this->renderDiagramClass($relation),
OPTIONS::DIAGRAM_PACKAGE => $this->renderDiagramPackage($relation),
OPTIONS::DIAGRAM_JIG => $this->renderDiagramJig($relation),
OPTIONS::DIAGRAM_DIVISION => $this->renderDiagramDivision($relation),
Options::DIAGRAM_PACKAGE => $this->renderDiagramPackage($relation),
Options::DIAGRAM_JIG => $this->renderDiagramJig($relation),
Options::DIAGRAM_DIVISION => $this->renderDiagramDivision($relation),
default => throw new RuntimeException('invalid diagram.')
};
}
Expand Down