first commit

Author: yuzhuang

.github/workflows/tests.yml

@@ -0,0 +1,39 @@
+name: Tests
+
+on:
+  push:
+    branches: [master]
+
+  pull_request:
+    branches: [master]
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3 
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: 7.4
+
+    - name: Validate composer.json and composer.lock
+      run: composer validate --strict
+
+    - name: Cache Composer packages
+      id: composer-cache
+      uses: actions/cache@v3
+      with:
+        path: vendor
+        key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-php-
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+
+    - name: Run test suite
+      run: composer run-script test

.gitignore

@@ -0,0 +1,15 @@
+.idea/*
+.idea/codeStyleSettings.xml
+.temp/*
+composer.lock
+/vendor/
+coverage.xml
+.phpunit.result.cache
+.phpunit.cache
+/.php-cs-fixer.php
+.php-cs-fixer.cache
+.temp/coverage.php
+*.swp
+*.swo
+.vscode/
+.DS_Store

README.md

@@ -1,2 +1,22 @@
-# composer-parser
-An parser that can parse php installed packages composer.json file
+# ComposerParser
+
+A parser that can parse the composer.json file of installed PHP packages.
+
+## Installation
+Require this package with composer:
+```bash
+composer require xdevor/composer-parser
+```
+
+## Usage
+
+1. parse composer.json file of installed PHP packages
+```php
+Parser::parse('the/package', 'name'); // return name of the package
+Parser::parse('the/package', 'not_exist_key'); // return null
+Parser::parse('the/package', 'authors.0.name'); // return the first author name
+```
+
+## License
+
+ComposerParser is open-sourced software licensed under the [MIT license](LICENSE.md).

composer.json

@@ -0,0 +1,46 @@
+{
+    "name": "xdevor/composer-parser",
+    "description": "A parser that can parse the composer.json file of installed PHP packages.",
+    "keywords": [
+        "parser",
+        "composer",
+        "packages",
+        "installed.json"
+    ],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "xdevor",
+            "email": "[email protected]"
+        }
+    ],
+    "homepage": "https://github.com/xdevor/composer-parser",
+    "require": {
+        "php": "^7.4"
+    },
+    "autoload": {
+        "psr-4": {
+            "Xdevor\\ComposerParser\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Xdevor\\ComposerParser\\Tests\\": "tests/"
+        },
+        "files": [
+            "./src/helpers.php"
+        ]
+    },
+    "scripts": {
+        "test": "./vendor/bin/pest"
+    },
+    "config": {
+        "sort-packages": true,
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
+    },
+    "require-dev": {
+        "pestphp/pest": "^1.22"
+    }
+}

phpunit.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">./app</directory>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </coverage>
+</phpunit>

src/Concerns/ParseArray.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Xdevor\ComposerParser\Concerns;
+
+use ArrayAccess;
+
+/**
+ * The code here is based on/reference to Illuminate\Support/Arr.
+ */
+trait ParseArray
+{
+    /**
+     * Get an item from an array using "dot" notation.
+     *
+     * @param  \ArrayAccess|array  $array
+     * @param  string|int|null  $key
+     * @param  mixed  $default
+     * @return mixed
+     */
+    public static function get($array, $key, $default = null)
+    {
+        if (! static::accessible($array)) {
+            return value($default);
+        }
+
+        if (is_null($key)) {
+            return $array;
+        }
+
+        if (static::exists($array, $key)) {
+            return $array[$key];
+        }
+
+        if (strpos($key, '.') === false) {
+            return $array[$key] ?? value($default);
+        }
+
+        foreach (explode('.', $key) as $segment) {
+            if (static::accessible($array) && static::exists($array, $segment)) {
+                $array = $array[$segment];
+            } else {
+                return value($default);
+            }
+        }
+
+        return $array;
+    }
+
+    /**
+     * Determine whether the given value is array accessible.
+     *
+     * @param  mixed  $value
+     * @return bool
+     */
+    public static function accessible($value)
+    {
+        return is_array($value) || $value instanceof ArrayAccess;
+    }
+
+    /**
+     * Determine if the given key exists in the provided array.
+     *
+     * @param  \ArrayAccess|array  $array
+     * @param  string|int  $key
+     * @return bool
+     */
+    public static function exists($array, $key)
+    {
+        if ($array instanceof ArrayAccess) {
+            return $array->offsetExists($key);
+        }
+
+        return array_key_exists($key, $array);
+    }
+}

src/Concerns/ParseInstalledPackages.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Xdevor\ComposerParser\Concerns;
+
+trait ParseInstalledPackages
+{
+    use ParseArray;
+
+    /**
+     * @var string|null path of installed json file
+     */
+    protected $installedJsonPath = null;
+
+    public function setInstalledJsonPath(?string $installedJsonPath)
+    {
+        $this->installedJsonPath = $installedJsonPath;
+    }
+
+    protected function parsePackageComposer(string $packageName, string $key, $default = null)
+    {
+        return self::get($this->packageComposer($packageName), $key, $default);
+    }
+
+    protected function packageComposer(string $templatePackageName): array
+    {
+        $packages = $this->installedPackages();
+        $packageComposer = [];
+
+        foreach ($packages as $package) {
+            if ($package['name'] === $templatePackageName) {
+                $packageComposer = $package;
+            }
+        }
+
+        return $packageComposer;
+    }
+
+    protected function installedPackages(): array
+    {
+        $packages = [];
+        $installedJsonPath = $this->installedJsonPath ?? file_exists(__DIR__ . '/../../vendor/composer/installed.json')
+        ? __DIR__ . '/../../vendor/composer/installed.json'
+        : __DIR__ . '/../../../vendor/composer/installed.json';
+
+        if (file_exists($installedJsonPath)) {
+            $installed = json_decode(file_get_contents($installedJsonPath), true);
+            $packages = $installed['packages'] ?? $installed;
+        }
+
+        return $packages;
+    }
+}

src/Parser.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Xdevor\ComposerParser;
+
+use Xdevor\ComposerParser\Concerns\ParseInstalledPackages;
+
+class Parser
+{
+    use ParseInstalledPackages;
+
+    public function __construct(string $installedJsonPath = null)
+    {
+        $this->setInstalledJsonPath($installedJsonPath);
+    }
+
+    public function parse(string $packageName, string $key, $default = null)
+    {
+        return $this->parsePackageComposer($packageName, $key, $default);
+    }
+}

src/helpers.php

@@ -0,0 +1,14 @@
+<?php
+
+if (! function_exists('value')) {
+    /**
+     * Return the default value of the given value.
+     *
+     * @param  mixed  $value
+     * @return mixed
+     */
+    function value($value, ...$args)
+    {
+        return $value instanceof Closure ? $value(...$args) : $value;
+    }
+}

tests/ParserTest.php

@@ -0,0 +1,21 @@
+<?php
+
+use Xdevor\ComposerParser\Parser;
+
+test('It can return correct value if key exist', function () {
+    $package = 'doctrine/instantiator';
+    $illuminateSupportName = (new Parser())->parse($package, 'name');
+    expect($illuminateSupportName)->toBe($package);
+});
+
+test('It return default if key not exist', function () {
+    $package = 'ooo/xxx';
+    $illuminateSupportName = (new Parser())->parse($package, 'name', null);
+    expect($illuminateSupportName)->toBe(null);
+});
+
+test('It can return correct value if array key exist', function () {
+    $package = 'doctrine/instantiator';
+    $illuminateSupportName = (new Parser())->parse($package, 'license.0');
+    expect($illuminateSupportName)->toBe('MIT');
+});