Add option to ignore sub dependencies checking

soullivaneuh · Apr 18, 2020 · 70fb43f · 70fb43f
1 parent 439d8fd
commit 70fb43f
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -52,10 +52,12 @@ You can configure the plugin via the [`COMPOSER_HOME/config.json`](https://getco
 {
     "config": {
         "sllh-composer-versions-check": {
+            "ignore-sub-dependencies": false,
             "show-links": false
         }
     }
 }
 ```
 
+* `ignore-sub-dependencies`: Shows only outdated package required in composer.json.
 * `show-links`: Shows outdated package links. Set to `true` to get a larger output, like the demo.
diff --git a/src/VersionsCheck.php b/src/VersionsCheck.php
@@ -26,16 +26,24 @@ final class VersionsCheck
      * @param ArrayRepository             $distRepository
      * @param WritableRepositoryInterface $localRepository
      * @param RootPackageInterface        $rootPackage
+     * @param bool                        $ignoreSubDependencies
      */
-    public function checkPackages(ArrayRepository $distRepository, WritableRepositoryInterface $localRepository, RootPackageInterface $rootPackage)
+    public function checkPackages(ArrayRepository $distRepository, WritableRepositoryInterface $localRepository, RootPackageInterface $rootPackage, bool $ignoreSubDependencies)
     {
         $packages = $localRepository->getPackages();
+        $rootRequires = array_keys($rootPackage->getRequires()) + array_keys($rootPackage->getDevRequires());
+
         foreach ($packages as $package) {
             // Do not compare aliases. Aliased packages are also provided.
             if ($package instanceof AliasPackage) {
                 continue;
             }
 
+            // Sub dependencies are ignored and package is not require in root. Skip.
+            if ($ignoreSubDependencies && !in_array($package->getName(), $rootRequires, true)) {
+                continue;
+            }
+
             // Old composer versions BC
             $versionConstraint = class_exists('Composer\Semver\Constraint\Constraint')
                 ? new Constraint('>', $package->getVersion())

diff --git a/src/VersionsCheckPlugin.php b/src/VersionsCheckPlugin.php
@@ -103,13 +103,15 @@ private function resolveOptions()
         ;
 
         $options = array(
+            'ignore-sub-dependencies' => false,
             'show-links' => false,
         );
 
         if (null === $pluginConfig) {
             return $options;
         }
 
+        $options['ignore-sub-dependencies'] = isset($pluginConfig['ignore-sub-dependencies']) ? (bool) $pluginConfig['ignore-sub-dependencies'] : $options['ignore-sub-dependencies'];
         $options['show-links'] = isset($pluginConfig['show-links']) ? (bool) $pluginConfig['show-links'] : $options['show-links'];
 
         return $options;
@@ -125,7 +127,8 @@ private function checkVersions(RepositoryManager $repositoryManager, RootPackage
             $this->versionsCheck->checkPackages(
                 $repository,
                 $repositoryManager->getLocalRepository(),
-                $rootPackage
+                $rootPackage,
+                $this->options['ignore-sub-dependencies']
             );
         }
 

diff --git a/tests/VersionsCheckPluginTest.php b/tests/VersionsCheckPluginTest.php
@@ -89,12 +89,14 @@ public function getTestOptionsData()
             'No option' => array(
                 null,
                 array(
+                    'ignore-sub-dependencies' => false,
                     'show-links' => false,
                 ),
             ),
             'Empty array options' => array(
                 array(),
                 array(
+                    'ignore-sub-dependencies' => false,
                     'show-links' => false,
                 ),
             ),
@@ -105,6 +107,7 @@ public function getTestOptionsData()
                     ),
                 ),
                 array(
+                    'ignore-sub-dependencies' => false,
                     'show-links' => false,
                 ),
             ),
@@ -115,6 +118,7 @@ public function getTestOptionsData()
                     ),
                 ),
                 array(
+                    'ignore-sub-dependencies' => false,
                     'show-links' => false,
                 ),
             ),
@@ -125,6 +129,33 @@ public function getTestOptionsData()
                     ),
                 ),
                 array(
+                    'ignore-sub-dependencies' => false,
+                    'show-links' => false,
+                ),
+            ),
+            'Activate ignore-sub-dependencies' => array(
+                array(
+                    'config' => array(
+                        'sllh-composer-versions-check' => array(
+                            'ignore-sub-dependencies' => true,
+                        ),
+                    ),
+                ),
+                array(
+                    'ignore-sub-dependencies' => true,
+                    'show-links' => false,
+                ),
+            ),
+            'Disable ignore-sub-dependencies' => array(
+                array(
+                    'config' => array(
+                        'sllh-composer-versions-check' => array(
+                            'ignore-sub-dependencies' => false,
+                        ),
+                    ),
+                ),
+                array(
+                    'ignore-sub-dependencies' => false,
                     'show-links' => false,
                 ),
             ),
@@ -137,6 +168,7 @@ public function getTestOptionsData()
                     ),
                 ),
                 array(
+                    'ignore-sub-dependencies' => false,
                     'show-links' => true,
                 ),
             ),
@@ -149,6 +181,7 @@ public function getTestOptionsData()
                     ),
                 ),
                 array(
+                    'ignore-sub-dependencies' => false,
                     'show-links' => false,
                 ),
             ),

diff --git a/tests/VersionsCheckTest.php b/tests/VersionsCheckTest.php
@@ -208,6 +208,6 @@ public function testOutdatedWithLinks()
      */
     private function checkPackages()
     {
-        $this->versionsCheck->checkPackages($this->distRepository, $this->localRepository, $this->rootPackage);
+        $this->versionsCheck->checkPackages($this->distRepository, $this->localRepository, $this->rootPackage, false);
     }
 }