Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
67.57% covered (warning)
67.57%
25 / 37
44.44% covered (danger)
44.44%
4 / 9
 CRAP
0.00% covered (danger)
0.00%
0 / 1
ComposerPackage
67.57% covered (warning)
67.57%
25 / 37
44.44% covered (danger)
44.44%
4 / 9
 29.05
0.00% covered (danger)
0.00%
0 / 1
 fromFile
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
 1
 fromComposerJsonArray
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
 2
 __construct
77.27% covered (warning)
77.27%
17 / 22
0.00% covered (danger)
0.00%
0 / 1
 9.95
 getPackageName
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
 1
 getRelativePath
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
 getPackageAbsolutePath
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
 getAutoload
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
 1
 getRequiresNames
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
 2
 getLicense
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
1<?php
2/**
3 * Object for getting typed values from composer.json.
4 *
5 * Use this for dependencies. Use ProjectComposerPackage for the primary composer.json.
6 */
7
8namespace BrianHenryIE\Strauss\Composer;
9
10use Composer\Composer;
11use Composer\Factory;
12use Composer\IO\NullIO;
13
14/**
15 * @phpstan-type AutoloadKey array{files?:array<string>,classmap?:array<string>,"psr-4"?:array<string,string|array<string>>}
16 */
17class ComposerPackage
18{
19    /**
20     * The composer.json file as parsed by Composer.
21     *
22     * @see \Composer\Factory::create
23     *
24     * @var \Composer\Composer
25     */
26    protected \Composer\Composer $composer;
27
28    /**
29     * The name of the project in composer.json.
30     *
31     * e.g. brianhenryie/my-project
32     *
33     * @var string
34     */
35    protected string $packageName;
36
37    /**
38     * Virtual packages and meta packages do not have a composer.json.
39     * Some packages are installed in a different directory name than their package name.
40     *
41     * @var ?string
42     */
43    protected ?string $relativePath = null;
44
45    /**
46     * Packages can be symlinked from outside the current project directory.
47     *
48     * @var ?string
49     */
50    protected ?string $packageAbsolutePath = null;
51
52    /**
53     * The discovered files, classmap, psr0 and psr4 autoload keys discovered (as parsed by Composer).
54     *
55     * @var AutoloadKey
56     */
57    protected array $autoload = [];
58
59    /**
60     * The names in the composer.json's "requires" field (without versions).
61     *
62     * @var string[]
63     */
64    protected array $requiresNames = [];
65
66    protected string $license;
67
68    /**
69     * @param string $absolutePath The absolute path to composer.json
70     * @param ?array{files?:array<string>, classmap?:array<string>, psr?:array<string,string|array<string>>} $overrideAutoload Optional configuration to replace the package's own autoload definition with
71     *                                    another which Strauss can use.
72     * @return ComposerPackage
73     */
74    public static function fromFile(string $absolutePath, array $overrideAutoload = null): ComposerPackage
75    {
76        $composer = Factory::create(new NullIO(), $absolutePath, true);
77
78        return new ComposerPackage($composer, $overrideAutoload);
79    }
80
81    /**
82     * This is used for virtual packages, which don't have a composer.json.
83     *
84     * @param array{name?:string, license?:string, requires?:array<string,string>, autoload?:AutoloadKey} $jsonArray composer.json decoded to array
85     * @param ?AutoloadKey $overrideAutoload New autoload rules to replace the existing ones.
86     */
87    public static function fromComposerJsonArray($jsonArray, array $overrideAutoload = null): ComposerPackage
88    {
89        $factory = new Factory();
90        $io = new NullIO();
91        $composer = $factory->createComposer($io, $jsonArray, true);
92
93        return new ComposerPackage($composer, $overrideAutoload);
94    }
95
96    /**
97     * Create a PHP object to represent a composer package.
98     *
99     * @param Composer $composer
100     * @param ?AutoloadKey $overrideAutoload Optional configuration to replace the package's own autoload definition with another which Strauss can use.
101     */
102    public function __construct(Composer $composer, array $overrideAutoload = null)
103    {
104        $this->composer = $composer;
105
106        $this->packageName = $composer->getPackage()->getName();
107
108        $composerJsonFileAbsolute = $composer->getConfig()->getConfigSource()->getName();
109
110        $absolutePath = realpath(dirname($composerJsonFileAbsolute));
111        if (false !== $absolutePath) {
112            $this->packageAbsolutePath = $absolutePath . '/';
113        }
114
115        $vendorDirectory = $this->composer->getConfig()->get('vendor-dir');
116        if (file_exists($vendorDirectory . '/' . $this->packageName)) {
117            $this->relativePath = $this->packageName;
118            $this->packageAbsolutePath = realpath($vendorDirectory . '/' . $this->packageName) . '/';
119        // If the package is symlinked, the path will be outside the working directory.
120        } elseif (0 !== strpos($absolutePath, getcwd()) && 1 === preg_match('/.*[\/\\\\]([^\/\\\\]*[\/\\\\][^\/\\\\]*)[\/\\\\][^\/\\\\]*/', $vendorDirectory, $output_array)) {
121            $this->relativePath = $output_array[1];
122        } elseif (1 === preg_match('/.*[\/\\\\]([^\/\\\\]+[\/\\\\][^\/\\\\]+)[\/\\\\]composer.json/', $composerJsonFileAbsolute, $output_array)) {
123        // Not every package gets installed to a folder matching its name (crewlabs/unsplash).
124            $this->relativePath = $output_array[1];
125        }
126
127        if (!is_null($overrideAutoload)) {
128            $composer->getPackage()->setAutoload($overrideAutoload);
129        }
130
131        $this->autoload = $composer->getPackage()->getAutoload();
132
133        foreach ($composer->getPackage()->getRequires() as $_name => $packageLink) {
134            $this->requiresNames[] = $packageLink->getTarget();
135        }
136
137        // Try to get the license from the package's composer.json, assume proprietary (all rights reserved!).
138        $this->license = !empty($composer->getPackage()->getLicense())
139            ? implode(',', $composer->getPackage()->getLicense())
140            : 'proprietary?';
141    }
142
143    /**
144     * Composer package project name.
145     *
146     * vendor/project-name
147     *
148     * @return string
149     */
150    public function getPackageName(): string
151    {
152        return $this->packageName;
153    }
154
155    /**
156     * Is this relative to vendor?
157     */
158    public function getRelativePath(): ?string
159    {
160        return $this->relativePath . '/';
161    }
162
163    public function getPackageAbsolutePath(): ?string
164    {
165        return $this->packageAbsolutePath;
166    }
167
168    /**
169     *
170     * e.g. ['psr-4' => [ 'BrianHenryIE\Project' => 'src' ]]
171     * e.g. ['psr-4' => [ 'BrianHenryIE\Project' => ['src','lib] ]]
172     * e.g. ['classmap' => [ 'src', 'lib' ]]
173     * e.g. ['files' => [ 'lib', 'functions.php' ]]
174     *
175     * @return AutoloadKey
176     */
177    public function getAutoload(): array
178    {
179        return $this->autoload;
180    }
181
182    /**
183     * The names of the packages in the composer.json's "requires" field (without version).
184     *
185     * Excludes PHP, ext-*, since we won't be copying or prefixing them.
186     *
187     * @return string[]
188     */
189    public function getRequiresNames(): array
190    {
191        // Unset PHP, ext-*.
192        $removePhpExt = function ($element) {
193            return !( 0 === strpos($element, 'ext') || 'php' === $element );
194        };
195
196        return array_filter($this->requiresNames, $removePhpExt);
197    }
198
199    public function getLicense():string
200    {
201        return $this->license;
202    }
203}