Merge pull request #3 from xdevor/feat/parse-all-method

xdevor · web-flow · commit e4e0838da0fa · 2023-03-26T11:11:29.000+08:00
feat: add parseAll method
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -41,4 +41,4 @@ jobs:
       run: composer install --prefer-dist --no-progress
 
     - name: Run test suite
-      run: composer run-script test & composer run-script test:type
+      run: composer run-script test:cov & composer run-script test:type
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ composer require xdevor/composer-parser
 
 ## Usage
 
-1. parse composer.json file of all installed PHP packages
+1. parse specific installed package by key
 ```php
 ...
 use Xdevor\ComposerParser\Parser;
@@ -29,6 +29,15 @@ use Xdevor\ComposerParser\Parser;
 (new Parser(__DIR__ . '/customize/path/installed.json'))->parse('the/package', 'name'); // parse customize path
 ```
 
+2. parse all installed package by key
+```php
+...
+use Xdevor\ComposerParser\Parser;
+...
+(new Parser())->parseAll($key = 'name'); // return name of all installed PHP packages
+(new Parser())->parseAll($key = 'extra.laravel.providers'); // return providers of all installed PHP packages
+```
+
 ## Contributing
 
 Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
diff --git a/composer.json b/composer.json
@@ -31,6 +31,7 @@
     },
     "scripts": {
         "test": "vendor/bin/pest",
+        "test:cov": "vendor/bin/pest --coverage",
         "test:type": "vendor/bin/phpstan analyse src tests --ansi --memory-limit=-1 --level=5"
     },
     "config": {
diff --git a/src/Concerns/ParseInstalledPackages.php b/src/Concerns/ParseInstalledPackages.php
@@ -16,6 +16,21 @@ public function setInstalledJsonPath(?string $installedJsonPath)
         $this->installedJsonPath = $installedJsonPath;
     }
 
+    protected function parseAllByKey(string $key): array
+    {
+        $packages = $this->installedPackages();
+        $result = [];
+
+        foreach ($packages as $package) {
+            $value = self::parseArray($package, $key);
+            if (!is_null($value)) {
+                $result[] = $value;
+            }
+        }
+
+        return $result;
+    }
+
     protected function parsePackageComposer(string $packageName, string $key, $default = null)
     {
         return self::parseArray($this->packageComposer($packageName), $key, $default);
@@ -38,9 +53,14 @@ protected function packageComposer(string $templatePackageName): array
     protected function installedPackages(): array
     {
         $packages = [];
-        $installedJsonPath = $this->installedJsonPath ?? file_exists(__DIR__ . '/../../vendor/composer/installed.json')
-        ? __DIR__ . '/../../vendor/composer/installed.json'
-        : __DIR__ . '/../../../../composer/installed.json';
+        var_dump($this->installedJsonPath);
+        if (is_null($this->installedJsonPath)) {
+            $installedJsonPath = file_exists(__DIR__ . '/../../vendor/composer/installed.json')
+            ? __DIR__ . '/../../vendor/composer/installed.json'
+            : __DIR__ . '/../../../../composer/installed.json';
+        } else {
+            $installedJsonPath = $this->installedJsonPath;
+        }
 
         if (file_exists($installedJsonPath)) {
             $installed = json_decode(file_get_contents($installedJsonPath), true);
diff --git a/src/Parser.php b/src/Parser.php
@@ -17,4 +17,9 @@ public function parse(string $packageName, string $key, $default = null)
     {
         return $this->parsePackageComposer($packageName, $key, $default);
     }
+
+    public function parseAll(string $key): array
+    {
+        return $this->parseAllByKey($key);
+    }
 }
diff --git a/tests/ParserTest.php b/tests/ParserTest.php
@@ -32,5 +32,15 @@
 test('It can use custom installed.json path', function () {
     $packageName = 'filp/whoops';
     $actual = (new Parser(__DIR__ . '/../tests/assets/fakeInstalled.json'))->parse($packageName, 'extra.branch-alias.dev-master');
-    expect($actual)->toBe('2.7-dev');
+    expect($actual)->toBe('2.7-test-dev');
+});
+
+test('It can parse all by key', function () {
+    $actual = (new Parser(__DIR__ . '/../tests/assets/fakeInstalled.json'))->parseAll('name');
+    expect($actual)->toBe(['filp/whoops', 'phar-io/manifest', 'phar-io/version', 'phpstan/phpstan']);
+});
+
+test('It return empty array if key not exist on parse all method', function () {
+    $actual = (new Parser(__DIR__ . '/../tests/assets/fakeInstalled.json'))->parseAll('xxx.ooo.xxx');
+    expect($actual)->toBe([]);
 });
diff --git a/tests/assets/fakeInstalled.json b/tests/assets/fakeInstalled.json
@@ -32,7 +32,7 @@
             "type": "library",
             "extra": {
                 "branch-alias": {
-                    "dev-master": "2.7-dev"
+                    "dev-master": "2.7-test-dev"
                 }
             },
             "installation-source": "dist",
@@ -73,6 +73,188 @@
                 }
             ],
             "install-path": "../filp/whoops"
+        },
+        {
+            "name": "phar-io/manifest",
+            "version": "2.0.3",
+            "version_normalized": "2.0.3.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/phar-io/manifest.git",
+                "reference": "97803eca37d319dfa7826cc2437fc020857acb53"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/phar-io/manifest/zipball/97803eca37d319dfa7826cc2437fc020857acb53",
+                "reference": "97803eca37d319dfa7826cc2437fc020857acb53",
+                "shasum": ""
+            },
+            "require": {
+                "ext-dom": "*",
+                "ext-phar": "*",
+                "ext-xmlwriter": "*",
+                "phar-io/version": "^3.0.1",
+                "php": "^7.2 || ^8.0"
+            },
+            "time": "2021-07-20T11:28:43+00:00",
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.0.x-dev"
+                }
+            },
+            "installation-source": "dist",
+            "autoload": {
+                "classmap": [
+                    "src/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "authors": [
+                {
+                    "name": "Arne Blankerts",
+                    "email": "arne@blankerts.de",
+                    "role": "Developer"
+                },
+                {
+                    "name": "Sebastian Heuer",
+                    "email": "sebastian@phpeople.de",
+                    "role": "Developer"
+                },
+                {
+                    "name": "Sebastian Bergmann",
+                    "email": "sebastian@phpunit.de",
+                    "role": "Developer"
+                }
+            ],
+            "description": "Component for reading phar.io manifest information from a PHP Archive (PHAR)",
+            "support": {
+                "issues": "https://github.com/phar-io/manifest/issues",
+                "source": "https://github.com/phar-io/manifest/tree/2.0.3"
+            },
+            "install-path": "../phar-io/manifest"
+        },
+        {
+            "name": "phar-io/version",
+            "version": "3.2.1",
+            "version_normalized": "3.2.1.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/phar-io/version.git",
+                "reference": "4f7fd7836c6f332bb2933569e566a0d6c4cbed74"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/phar-io/version/zipball/4f7fd7836c6f332bb2933569e566a0d6c4cbed74",
+                "reference": "4f7fd7836c6f332bb2933569e566a0d6c4cbed74",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^7.2 || ^8.0"
+            },
+            "time": "2022-02-21T01:04:05+00:00",
+            "type": "library",
+            "installation-source": "dist",
+            "autoload": {
+                "classmap": [
+                    "src/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "authors": [
+                {
+                    "name": "Arne Blankerts",
+                    "email": "arne@blankerts.de",
+                    "role": "Developer"
+                },
+                {
+                    "name": "Sebastian Heuer",
+                    "email": "sebastian@phpeople.de",
+                    "role": "Developer"
+                },
+                {
+                    "name": "Sebastian Bergmann",
+                    "email": "sebastian@phpunit.de",
+                    "role": "Developer"
+                }
+            ],
+            "description": "Library for handling version information and constraints",
+            "support": {
+                "issues": "https://github.com/phar-io/version/issues",
+                "source": "https://github.com/phar-io/version/tree/3.2.1"
+            },
+            "install-path": "../phar-io/version"
+        },
+        {
+            "name": "phpstan/phpstan",
+            "version": "1.10.8",
+            "version_normalized": "1.10.8.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/phpstan/phpstan.git",
+                "reference": "0166aef76e066f0dd2adc2799bdadfa1635711e9"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/phpstan/phpstan/zipball/0166aef76e066f0dd2adc2799bdadfa1635711e9",
+                "reference": "0166aef76e066f0dd2adc2799bdadfa1635711e9",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^7.2|^8.0"
+            },
+            "conflict": {
+                "phpstan/phpstan-shim": "*"
+            },
+            "time": "2023-03-24T10:28:16+00:00",
+            "bin": [
+                "phpstan",
+                "phpstan.phar"
+            ],
+            "type": "library",
+            "installation-source": "dist",
+            "autoload": {
+                "files": [
+                    "bootstrap.php"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "description": "PHPStan - PHP Static Analysis Tool",
+            "keywords": [
+                "dev",
+                "static analysis"
+            ],
+            "support": {
+                "docs": "https://phpstan.org/user-guide/getting-started",
+                "forum": "https://github.com/phpstan/phpstan/discussions",
+                "issues": "https://github.com/phpstan/phpstan/issues",
+                "security": "https://github.com/phpstan/phpstan/security/policy",
+                "source": "https://github.com/phpstan/phpstan-src"
+            },
+            "funding": [
+                {
+                    "url": "https://github.com/ondrejmirtes",
+                    "type": "github"
+                },
+                {
+                    "url": "https://github.com/phpstan",
+                    "type": "github"
+                },
+                {
+                    "url": "https://tidelift.com/funding/github/packagist/phpstan/phpstan",
+                    "type": "tidelift"
+                }
+            ],
+            "install-path": "../phpstan/phpstan"
         }
     ]
 }

Original file line number	Diff line number	Diff line change
`@@ -17,4 +17,9 @@ public function parse(string $packageName, string $key, $default = null)`
`17`	`17`	`{`
`18`	`18`	`return $this->parsePackageComposer($packageName, $key, $default);`
`19`	`19`	`}`
	`20`	`+`
	`21`	`+ public function parseAll(string $key): array`
	`22`	`+ {`
	`23`	`+ return $this->parseAllByKey($key);`
	`24`	`+ }`
`20`	`25`	`}`