Skip to content
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

Add $moduleName to output messages where not currently implemented #60

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add $moduleName to output messages where not currently implemented #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
69 changes: 54 additions & 15 deletions Scan/ScanComposerRequirements.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public function scan(string $moduleName, array $components)
}

foreach ($requirements as $requirement => $requirementVersion) {
$this->scanComposerRequirementWithComponents($requirement, $requirementVersion, $components);
$this->scanComposerRequirementWithComponents($requirement, $requirementVersion, $components, $moduleName);
}
}

Expand Down Expand Up @@ -82,32 +82,43 @@ private function scanComponentWithComposerRequirements(
$suggestion .= sprintf('Perhaps use %s?', $this->composerProvider->getSuggestedVersion($version));
}

$this->messageBucket->add($message, MessageGroupLabels::GROUP_MISSING_COMPOSER_DEP, $suggestion, $moduleName);
$this->messageBucket->add(
$message,
MessageGroupLabels::GROUP_MISSING_COMPOSER_DEP,
$suggestion,
$moduleName
);
}

/**
* @param string $requirement
* @param string $requirementVersion
* @param Component[] $components
* @param string $moduleName
* @return void
*/
private function scanComposerRequirementWithComponents(
string $requirement,
string $requirementVersion,
array $components
array $components,
string $moduleName
) {
$this->checkIfRequirementIsNeeded($requirement, $components);
$this->checkIfComposerRequirementUsesWildCard($requirement, $requirementVersion);
$this->checkPhpVersion($requirement, $requirementVersion);
$this->checkIfRequirementIsNeeded($requirement, $components, $moduleName);
$this->checkIfComposerRequirementUsesWildCard($requirement, $requirementVersion, $moduleName);
$this->checkPhpVersion($requirement, $requirementVersion, $moduleName);
}

/**
* @param string $requirement
* @param array $components
* @param string $moduleName
* @return void
*/
private function checkIfRequirementIsNeeded(string $requirement, array $components)
{
private function checkIfRequirementIsNeeded(
string $requirement,
array $components,
string $moduleName
) {
if ($this->runtimeConfig->isHideNeedless()) {
return;
}
Expand All @@ -121,11 +132,25 @@ private function checkIfRequirementIsNeeded(string $requirement, array $componen
}

$message = 'Composer requirement "' . $requirement . '" possibly not needed';
$this->messageBucket->add($message, MessageGroupLabels::GROUP_UNNECESSARY_COMPOSER_DEP);
$this->messageBucket->add(
$message,
MessageGroupLabels::GROUP_UNNECESSARY_COMPOSER_DEP,
'',
$moduleName
);
}

private function checkIfComposerRequirementUsesWildCard(string $requirement, string $requirementVersion)
{
/**
* @param string $requirement
* @param string $requirementVersion
* @param string $moduleName
* @return void
*/
private function checkIfComposerRequirementUsesWildCard(
string $requirement,
string $requirementVersion,
string $moduleName
) {
if (preg_match('/^ext-/', $requirement)) {
return;
}
Expand All @@ -141,16 +166,25 @@ private function checkIfComposerRequirementUsesWildCard(string $requirement, str
$suggestion .= sprintf('Perhaps use %s?', $this->composerProvider->getSuggestedVersion($version));
}

$this->messageBucket->add($message, MessageGroupLabels::GROUP_WILDCARD_VERSION, $suggestion);
$this->messageBucket->add(
$message,
MessageGroupLabels::GROUP_WILDCARD_VERSION,
$suggestion,
$moduleName
);
}

/**
* @param string $requirement
* @param string $requirementVersion
* @param string $moduleName
* @return void
*/
private function checkPhpVersion(string $requirement, string $requirementVersion)
{
private function checkPhpVersion(
string $requirement,
string $requirementVersion,
string $moduleName
) {
if ($requirement !== 'php') {
return;
}
Expand All @@ -161,7 +195,12 @@ private function checkPhpVersion(string $requirement, string $requirementVersion
}

$message = 'Required PHP version "' . $requirementVersion . '" does not match your current PHP version ' . $currentVersion;
$this->messageBucket->add($message, MessageGroupLabels::GROUP_UNMET_REQUIREMENT);
$this->messageBucket->add(
$message,
MessageGroupLabels::GROUP_UNMET_REQUIREMENT,
'',
$moduleName
);
}

/**
Expand Down
7 changes: 6 additions & 1 deletion Scan/ScanDeprecatedClasses.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,12 @@ public function scan(string $moduleName)

if ($this->classInspector->isDeprecated()) {
$message = 'Usage of class "' . $className . '" is deprecated';
$this->messageBucket->add($message, MessageGroupLabels::GROUP_PHP_DEPRECATED);
$this->messageBucket->add(
$message,
MessageGroupLabels::GROUP_PHP_DEPRECATED,
'',
$moduleName
);
}
}
}
Expand Down