diff --git a/.editorconfig b/.editorconfig
index 8802775..518c149 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -10,12 +10,25 @@ indent_style = space
indent_size = 4
trim_trailing_whitespace = true
+[*.js]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
[*.php]
ij_php_space_before_short_closure_left_parenthesis = false
ij_php_space_after_type_cast = true
-[*.md]
-trim_trailing_whitespace = false
+[*.yaml]
+indent_size = 2
[*.yml]
indent_size = 2
+
+[*.xml.dist]
+indent_size = 2
+
+[LICENSE*]
+indent_style = unset
+indent_size = unset
diff --git a/.gitattributes b/.gitattributes
index 65a6a4e..fdf0ca4 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -26,6 +26,7 @@
/CHANGELOG.md merge=union
# Exclude files from the archive
+/.editorconfig export-ignore
/.gitattributes export-ignore
/.github export-ignore
/.gitignore export-ignore
@@ -33,7 +34,11 @@
/codeception.yml export-ignore
/composer-require-checker.json export-ignore
/docs export-ignore
+/ecs.php export-ignore
+/infection.json* export-ignore
+/phpstan*.neon* export-ignore
/phpunit.xml.dist export-ignore
/psalm.xml export-ignore
/rector.php export-ignore
+/runtime export-ignore
/tests export-ignore
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
deleted file mode 100644
index 1946f00..0000000
--- a/.github/CODE_OF_CONDUCT.md
+++ /dev/null
@@ -1,102 +0,0 @@
-# Code of Conduct
-
-## Our Pledge
-
-As contributors and maintainers of this project, and in order to keep community open and welcoming, we ask to
-respect all community members.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
-
-## Enforcement Responsibilities
-
-Core team members are responsible for clarifying and enforcing our standards of acceptable behavior and will take
-appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Core team members have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
-issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for
-moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing
-the community in public spaces. Examples of representing a project or community include using an official e-mail
-address, posting via an official social media account, within project GitHub, official forum or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting core team members. All
-complaints will be reviewed and investigated promptly and fairly.
-
-All core team members are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Core team members will follow these Community Impact Guidelines in determining the consequences for any action they
-deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in
-the community.
-
-**Consequence**: A private, written warning from core team members, providing clarity around the nature of the violation
-and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including
-unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding
-interactions in community spaces as well as external channels like social media. Violating these terms may lead to
-a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified
-period of time. No public or private interaction with the people involved, including unsolicited interaction with those
-enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate
-behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
deleted file mode 100644
index 4b4046c..0000000
--- a/.github/FUNDING.yml
+++ /dev/null
@@ -1,3 +0,0 @@
-# These are supported funding model platforms
-
-github: [terabytesoftw]
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index 7e17783..0000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,14 +0,0 @@
-### What steps will reproduce the problem?
-
-### What is the expected result?
-
-### What do you get instead?
-
-
-### Additional info
-
-| Q | A
-| ---------------- | ---
-| Version | 1.0.?
-| PHP version |
-| Operating system |
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
deleted file mode 100644
index cecccf6..0000000
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ /dev/null
@@ -1,6 +0,0 @@
-| Q | A
-| ------------- | ---
-| Is bugfix? | ✔️/❌
-| New feature? | ✔️/❌
-| Breaks BC? | ✔️/❌
-| Fixed issues |
diff --git a/.github/linters/.editorconfig-checker.json b/.github/linters/.editorconfig-checker.json
new file mode 100644
index 0000000..f681ed3
--- /dev/null
+++ b/.github/linters/.editorconfig-checker.json
@@ -0,0 +1,8 @@
+{
+ "Exclude": [
+ "phpstan-baseline.neon",
+ "resources/doc/faqs.md",
+ "tests/Json/JsonFileTest.php",
+ "tests/Json/JsonFormatterTest.php"
+ ]
+}
diff --git a/.github/linters/actionlint.yml b/.github/linters/actionlint.yml
new file mode 100644
index 0000000..328407a
--- /dev/null
+++ b/.github/linters/actionlint.yml
@@ -0,0 +1,6 @@
+---
+paths:
+ .github/workflows/**/*.yml:
+ ignore:
+ - '"pull_request" section is alias node but mapping node is expected'
+ - '"push" section is alias node but mapping node is expected'
diff --git a/.github/workflows/dependency-check.yml b/.github/workflows/dependency-check.yml
index 169bb4b..e69d7d1 100644
--- a/.github/workflows/dependency-check.yml
+++ b/.github/workflows/dependency-check.yml
@@ -1,33 +1,21 @@
+---
on:
- pull_request:
+ pull_request: &ignore-paths
paths-ignore:
- - 'docs/**'
- - 'README.md'
- - 'CHANGELOG.md'
- - '.gitignore'
- - '.gitattributes'
- - 'infection.json.dist'
- - 'phpunit.xml.dist'
- - 'psalm.xml'
+ - ".gitattributes"
+ - ".gitignore"
+ - "CHANGELOG.md"
+ - "docs/**"
+ - "README.md"
- push:
- paths-ignore:
- - 'docs/**'
- - 'README.md'
- - 'CHANGELOG.md'
- - '.gitignore'
- - '.gitattributes'
- - 'infection.json.dist'
- - 'phpunit.xml.dist'
- - 'psalm.xml'
+ push: *ignore-paths
+
+name: Composer require checker
-name: dependency-check
+permissions:
+ contents: read
+ pull-requests: write
jobs:
composer-require-checker:
- uses: php-forge/actions/.github/workflows/composer-require-checker.yml@main
- with:
- os: >-
- ['ubuntu-latest']
- php-version: >-
- ['8.1']
+ uses: yii2-framework/actions/.github/workflows/composer-require-checker.yml@main
diff --git a/.github/workflows/ecs.yml b/.github/workflows/ecs.yml
index 93fb367..e18f15c 100644
--- a/.github/workflows/ecs.yml
+++ b/.github/workflows/ecs.yml
@@ -1,34 +1,21 @@
+---
on:
- pull_request:
+ pull_request: &ignore-paths
paths-ignore:
- - 'docs/**'
- - 'README.md'
- - 'CHANGELOG.md'
- - '.gitignore'
- - '.gitattributes'
- - 'infection.json.dist'
- - 'phpunit.xml.dist'
+ - ".gitattributes"
+ - ".gitignore"
+ - "CHANGELOG.md"
+ - "docs/**"
+ - "README.md"
- push:
- branches: ['main']
- paths-ignore:
- - 'docs/**'
- - 'README.md'
- - 'CHANGELOG.md'
- - '.gitignore'
- - '.gitattributes'
- - 'infection.json.dist'
- - 'phpunit.xml.dist'
+ push: *ignore-paths
name: ecs
+permissions:
+ contents: read
+ pull-requests: write
+
jobs:
easy-coding-standard:
- uses: php-forge/actions/.github/workflows/ecs.yml@main
- secrets:
- AUTH_TOKEN: ${{ secrets.AUTH_TOKEN }}
- with:
- os: >-
- ['ubuntu-latest']
- php-version: >-
- ['8.1']
+ uses: yii2-framework/actions/.github/workflows/ecs.yml@main
diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml
new file mode 100644
index 0000000..7b46557
--- /dev/null
+++ b/.github/workflows/linter.yml
@@ -0,0 +1,17 @@
+---
+on:
+ - pull_request
+ - push
+
+name: linter
+
+permissions:
+ checks: write
+ contents: read
+ statuses: write
+
+jobs:
+ linter:
+ uses: yii2-framework/actions/.github/workflows/super-linter.yml@v1
+ secrets:
+ AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/mutation.yml b/.github/workflows/mutation.yml
new file mode 100644
index 0000000..c0267c3
--- /dev/null
+++ b/.github/workflows/mutation.yml
@@ -0,0 +1,26 @@
+---
+on:
+ pull_request: &ignore-paths
+ paths-ignore:
+ - ".gitattributes"
+ - ".gitignore"
+ - "CHANGELOG.md"
+ - "docs/**"
+ - "README.md"
+
+ push: *ignore-paths
+
+name: mutation test
+
+permissions:
+ contents: read
+ pull-requests: write
+
+jobs:
+ mutation:
+ uses: yii2-framework/actions/.github/workflows/infection.yml@v1
+ with:
+ before-hook: composer require infection/infection --dev --no-progress --no-suggest --prefer-dist
+ phpstan: true
+ secrets:
+ STRYKER_DASHBOARD_API_KEY: ${{ secrets.STRYKER_DASHBOARD_API_KEY }}
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
new file mode 100644
index 0000000..99d7c1c
--- /dev/null
+++ b/.github/workflows/static.yml
@@ -0,0 +1,21 @@
+---
+on:
+ pull_request: &ignore-paths
+ paths-ignore:
+ - ".gitattributes"
+ - ".gitignore"
+ - "CHANGELOG.md"
+ - "docs/**"
+ - "README.md"
+
+ push: *ignore-paths
+
+name: static analysis
+
+permissions:
+ contents: read
+ pull-requests: write
+
+jobs:
+ phpstan:
+ uses: yii2-framework/actions/.github/workflows/phpstan.yml@main
diff --git a/.gitignore b/.gitignore
index 08dc4d4..d4c5c11 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,51 @@
-vendor/
-phpunit.xml
-.php-cs-fixer.cache
+# codecoverage (if present)
+code_coverage
+
+# codeception (if present)
+c3.php
+
+# composer
+composer.lock
+
+# gitHub copilot config (if present)
+.github/agents/**
+.github/copilot-instructions.md
+.github/copilot/**
+.github/instructions/**
+.github/prompts/**
+.github/skills/**
+
+# mac ds_store (if present)
+.DS_Store
+
+# netbeans project (if present)
+nbproject
+
+# node_modules (if present)
+node_modules
+package-lock.json
+
+# phpstorm project (if present)
+.idea
+
+# phpunit (if present)
+.phpunit.cache
.phpunit.result.cache
+phpunit.xml*
+
+# vagrant (if present)
+.vagrant
+
+# vendor
+vendor
+
+# vscode project (if present)
+.vscode
+
+# windows thumbnail cache (if present)
+Thumbs.db
+
+# zend studio for eclipse project (if present)
+.buildpath
+.project
+.settings
diff --git a/.styleci.yml b/.styleci.yml
index 5b7ddb2..6cf29b2 100644
--- a/.styleci.yml
+++ b/.styleci.yml
@@ -17,9 +17,10 @@ enabled:
- combine_nested_dirname
- declare_strict_types
- dir_constant
- - fully_qualified_strict_types
+ - empty_loop_body_braces
- function_to_constant
- hash_to_slash_comment
+ - integer_literal_case
- is_null
- logical_operators
- magic_constant_casing
@@ -56,7 +57,6 @@ enabled:
- phpdoc_order
- phpdoc_property
- phpdoc_scalar
- - phpdoc_separation
- phpdoc_singular_inheritdoc
- phpdoc_trim
- phpdoc_trim_consecutive_blank_line_separation
@@ -78,9 +78,10 @@ enabled:
- trailing_comma_in_multiline_array
- unalign_double_arrow
- unalign_equals
- - empty_loop_body_braces
- - integer_literal_case
- union_type_without_spaces
disabled:
- function_declaration
+ - new_with_parentheses
+ - psr12_braces
+ - psr12_class_definition
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 128a8ef..fa41cf6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,4 @@
-Change Log
-==========
+# ChangeLog
## 0.1.3 Under development
@@ -11,10 +10,11 @@ Change Log
- Bug #108: Restore working directory after running the asset manager (@terabytesoftw)
- Bug #109: Respect `root-package-json-dir` for `package.json` read/write (@terabytesoftw)
- Bug #110: Preserve nested empty arrays when rewriting `package.json` (@terabytesoftw)
-- Bug #111: Throw `RuntimeException` class on asset/json `I/O` failures (@terabytesoftw)
+- Bug #111: Throw `RuntimeException` class on asset/JSON `I/O` failures (@terabytesoftw)
- Bug #112: Update `README.md` and add development and testing documentation (@terabytesoftw)
- Bug #113: Fix PHP `8.4` nullable type deprecation warnings in tests (@terabytesoftw)
- Bug #114: Fix PHP `8.5` deprecation of `setAccessible()` in `ReflectionProperty` class (`@terabytesoftw`)
+- Bug #115: Update CI workflows and apply automated refactors (@terabytesoftw)
## 0.1.2 June 10, 2024
diff --git a/README.md b/README.md
index a18fc06..0f1174f 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-
Foxy
-
- ./tests/
+ tests
- ./src
+ ./src
-
- .php-cs-fixer.dist.php
- ./tests
- ./resources
- ./vendor
-
diff --git a/rector.php b/rector.php
new file mode 100644
index 0000000..c8db3d7
--- /dev/null
+++ b/rector.php
@@ -0,0 +1,36 @@
+parallel();
+
+ $rectorConfig->importNames();
+
+ $rectorConfig->paths(
+ [
+ __DIR__ . '/src',
+ __DIR__ . '/tests',
+ ],
+ );
+
+ $rectorConfig->sets(
+ [
+ Rector\Set\ValueObject\SetList::PHP_81,
+ Rector\Set\ValueObject\LevelSetList::UP_TO_PHP_81,
+ Rector\Set\ValueObject\SetList::TYPE_DECLARATION,
+ ],
+ );
+
+ $rectorConfig->skip(
+ [
+ Rector\TypeDeclaration\Rector\Class_\TypedPropertyFromCreateMockAssignRector::class,
+ ],
+ );
+
+ $rectorConfig->rules(
+ [
+ Rector\CodeQuality\Rector\BooleanAnd\SimplifyEmptyArrayCheckRector::class,
+ ],
+ );
+};
diff --git a/resources/doc/config.md b/resources/doc/config.md
index 7055dd5..98983b2 100644
--- a/resources/doc/config.md
+++ b/resources/doc/config.md
@@ -1,5 +1,4 @@
-Configuration
-=============
+# Configuration
## Manipulate the configuration
@@ -49,6 +48,7 @@ The accepted value types are:
- JSON array or object
**Example:**
+
```json
{
"config": {
@@ -62,6 +62,7 @@ The accepted value types are:
Can be overridden by `FOXY__ENABLED="false"` environment variable.
**Example:**
+
```json
{
"config": {
@@ -91,6 +92,7 @@ All keys starting with the prefix `manager-` can accept a unique value, but it w
a map containing the value for each manager defined by her name.
**Example:**
+
```json
{
"config": {
@@ -116,6 +118,7 @@ a map containing the value for each manager defined by her name.
You can enable or disable the plugin with the option `config.foxy.enabled` [`boolean`, default: `true`].
**Example:**
+
```json
{
"config": {
@@ -137,8 +140,8 @@ You can choose the asset manager with the option `config.foxy.manager` [`string`
- `pnpm`
- `yarn`
-
**Example:**
+
```json
{
"config": {
@@ -155,6 +158,7 @@ You can validate the version of the asset manager with the option
`config.foxy.manager-version` [`string`, default: `null`].
**Example:**
+
```json
{
"config": {
@@ -171,6 +175,7 @@ You can define the custom path of the binary of the asset manager with the optio
`config.foxy.manager-bin` [`string`, default: `null`].
**Example:**
+
```json
{
"config": {
@@ -187,6 +192,7 @@ You can add custom options for the asset manager binary for the install and upda
option `config.foxy.manager-options` [`string`, default: `null`].
**Example:**
+
```json
{
"config": {
@@ -208,6 +214,7 @@ You can add custom options for the asset manager binary for the install command
option `config.foxy.manager-install-options` [`string`, default: `null`].
**Example:**
+
```json
{
"config": {
@@ -230,6 +237,7 @@ You can add custom options for the asset manager binary for the update command w
option `config.foxy.manager-update-options` [`string`, default: `null`].
**Example:**
+
```json
{
"config": {
@@ -247,6 +255,7 @@ You can define the execution timeout of the asset manager with the
option `config.foxy.manager-timeout` [`int`, default: `PHP_INT_MAX`].
**Example:**
+
```json
{
"config": {
@@ -263,6 +272,7 @@ You can enable or disable the fallback of the asset package file with the option
`config.foxy.fallback-asset` [`boolean`, default: `true`].
**Example:**
+
```json
{
"config": {
@@ -273,12 +283,13 @@ You can enable or disable the fallback of the asset package file with the option
}
```
-### Enable/disable the fallback for the Composer lock file and its dependencies
+### Enable/disable the fallback for the Composer lockfile and its dependencies
-You can enable or disable the fallback of the Composer lock file and its dependencies with the option
+You can enable or disable the fallback of the Composer lockfile and its dependencies with the option
`config.foxy.fallback-composer` [`boolean`, default: `true`].
**Example:**
+
```json
{
"config": {
@@ -295,6 +306,7 @@ You can enable or disable the running of the asset manager with the option
`config.foxy.run-asset-manager` [`boolean`, default: `true`].
**Example:**
+
```json
{
"config": {
@@ -316,6 +328,7 @@ You can define the custom path of the mock package of PHP library with the optio
`config.foxy.composer-asset-dir` [`string`, default: `null`].
**Example:**
+
```json
{
"config": {
@@ -329,7 +342,7 @@ You can define the custom path of the mock package of PHP library with the optio
### Enable/disable manually the PHP packages with an asset package definition
By default, Foxy looks in the `composer.json` file of the PHP dependencies, if the mock package needs
-to be added into NPM or Yarn. However, some public PHP package already uses the `package.json` file
+to be added into npm or Yarn. However, some public PHP package already uses the `package.json` file
to handle their asset dependencies, but Foxy is not enabled for this package. In this case, you can
manually enable the PHP packages to be scanned in your project.
@@ -340,6 +353,7 @@ You can define the patterns to enable or disable the packages with the option
`config.foxy.enable-packages` [`array`, default: `array()`].
**Example:**
+
```json
{
"config": {
@@ -357,14 +371,12 @@ You can define the patterns to enable or disable the packages with the option
If you do not deactivate any packages, you can use a simple array.
**Example:**
+
```json
{
"config": {
"foxy": {
- "enable-packages": [
- "/^bar\/*/",
- "foo/*"
- ]
+ "enable-packages": ["/^bar\/*/", "foo/*"]
}
}
}
@@ -375,6 +387,7 @@ If you do not deactivate any packages, you can use a simple array.
You can define the custom directory for `package.json` file with the option `root-package-json-dir` [`string`, default: `null`].
**Example:**
+
```json
{
"config": {
@@ -386,6 +399,7 @@ You can define the custom directory for `package.json` file with the option `roo
```
> **Notes:**
+>
> - This path affects reading, writing, and merging the real `package.json` file, and the working directory for the asset manager.
> - Relative paths are resolved from the current working directory. Absolute paths are supported.
> - Filesystem roots such as `/` or `C:\` are preserved.
diff --git a/resources/doc/events.md b/resources/doc/events.md
index 234abaa..a32c2a0 100644
--- a/resources/doc/events.md
+++ b/resources/doc/events.md
@@ -1,5 +1,4 @@
-Events
-======
+# Events
Foxy triggers events with the event dispatcher system of Composer allowing you to extend Foxy's
capabilities. To do this, you must create a Composer plugin requiring Foxy in addition to the
diff --git a/resources/doc/faqs.md b/resources/doc/faqs.md
index d22e2e9..a3083ad 100644
--- a/resources/doc/faqs.md
+++ b/resources/doc/faqs.md
@@ -1,16 +1,13 @@
-FAQs
-====
+# FAQs
-What version required of Composer?
-----------------------------------
+## What version of Composer is required?
See the documentation: [Installation](index.md#installation).
-Why this plugin?
-----------------
+## Why this plugin?
It is certain that each language has its own dependency management system, and that it is highly recommended to use
-each package manager. NPM or Yarn works very well when the asset dependencies are managed only in the PHP project,
+each package manager. Npm or Yarn works very well when the asset dependencies are managed only in the PHP project,
but when you create PHP libraries that using assets, there is no way to automatically add asset dependencies,
and most importantly, no validation of versions can be done automatically. You must tell the developers
the list of asset dependencies that using by your PHP library, and you must ask him to add manually the asset
@@ -23,50 +20,48 @@ less possible, to use correctly all tools such as Babel, Scss, Less, etc ...
Foxy focuses solely on automation of the validation, addition, updating and deleting of the dependencies in
the definition file of the asset package, while restoring the project state, as well as PHP dependencies if
-NPM or Yarn terminates with an error.
+npm or Yarn terminates with an error.
-What is the difference between Foxy and Fxp Composer Asset Plugin?
-------------------------------------------------------------------
+## What is the difference between Foxy and Fxp Composer Asset Plugin?
When [Fxp Composer Asset Plugin](https://github.com/fxpio/composer-asset-plugin) has been created,
-it lacked some important functionality to NPM and Bower as a true lock file, the access to
+it lacked some important functionality to npm and Bower as a true lockfile, the access to
private repositories, the management of organizations (scope), and the assets was limited to a simple
download of the packages. The solution was to use the SAT solver, the VCS Repositories and the
-Composer lock file to manage the asset dependencies of the PHP libraries. However, there are 3 major
+Composer lockfile to manage the asset dependencies of the PHP libraries. However, there are 3 major
disadvantages to this approach:
1. The plugin must be installed in global mode
-2. Nodejs must be used more and more to compile some libraries
-3. The use of VCS Repositories coupled with the SAT Solver architecture of Composer is much less
- efficient than NPM, despite the optimizations of the plugin to avoid the imports
+2. Node.js must be used more and more to compile some libraries
+3. The use of VCS Repositories coupled with the SAT Solver architecture of Composer is much less efficient than npm,
+ despite the optimizations of the plugin to avoid the imports
-Now, Bower has been depreciated, NPM has a true lock file (since 5.x), as well as the possibility
-of using the private repositories, Yarn arrived with his big performances, and more and more javascript
-library requires a compilation because they use Babel, Typescript, Sass, Less, etc...
+Now, Bower has been depreciated, npm has a true lockfile (since 5.x), as well as the possibility
+of using the private repositories, Yarn arrived with his big performances, and more and more JavaScript
+library requires a compilation because they use Babel, TypeScript, Sass, Less, etc...
-Nodejs filling its gaps, and becoming more and more required, a plugin could finally perform the reverse operation,
-retaining the benefits of Fxp Composer Asset Plugin and NPM. So, conversely, Foxy creates package mocks for NPM
+Node.js filling its gaps, and becoming increasingly required, a plugin could finally perform the reverse operation,
+retaining the benefits of Fxp Composer Asset Plugin and npm. So, conversely, Foxy creates package mocks for npm
in local directory, containing only the `package.json` file from the PHP library, and adding the path of the
mock package to the project's `package.json` file. The entire validation and installation process is left
-to NPM or Yarn. However, the plugin manages the fallback if there is an error of the asset manager.
+to npm or Yarn. However, the plugin manages the fallback if there is an error of the asset manager.
To conclude, given that there is not a backward compatibility, and that it is impossible to have a version
of the plugin installed globally, and another version installed in the project - because Composer will
install the plugin in the project, but will only use the plugin installed globally - the Fxp Composer Asset
Plugin was become Foxy.
-How does the plugin work?
--------------------------
+## How does the plugin work?
-Foxy creates the mocks of Composer packages for NPM in local directory, containing only the `package.json`
+Foxy creates the mocks of Composer packages for npm in local directory, containing only the `package.json`
file from the PHP library, and adding the package path to the `package.json` file of the project.
-The name of the Composer package is converted to a format compatible with NPM, using the NPM scope
+The name of the Composer package is converted to a format compatible with npm, using the npm scope
`@composer-asset` and replacing the separation slash `/` between the vendor and the package name by
2 dashes `--`, giving consequently, the following format `@composer-asset/--`
-(this scope is reserved by Foxy in the registry of NPM and in Github).
+(this scope is reserved by Foxy in the registry of npm and in GitHub).
-NPM will install in the `node_modules/@composer-asset` folder an updated copy of each Composer package mock
+npm will install in the `node_modules/@composer-asset` folder an updated copy of each Composer package mock
that is located by default in the folder `vendor/foxy/composer-asset`.
For more details, the plugin work in this order:
@@ -75,42 +70,38 @@ For more details, the plugin work in this order:
2. Saving the status of project
3. Installing/updating of the PHP dependencies by Composer
4. Retrieving the entire list of installed packages
-5. Retains only PHP dependencies with the `foxy/foxy` dependency in the `require` or `require-dev` section of
- the `composer.json` file and with the presence of the `package.json` file
-6. Checking the lock file of asset manager
-7. Comparing the difference between the installed asset dependencies and the new asset dependencies, to determine
+5. Retains only PHP dependencies that include `foxy/foxy` dependency in `require` or `require-dev` and that contain a
+ `package.json` file
+6. Comparing the difference between the installed asset dependencies and the new asset dependencies, to determine
whether the dependency must be installed, updated, or removed
-8. Creating, updating, or deleting of the mock asset libraries in local directory, containing only the
+7. Creating, updating, or deleting of the mock asset libraries in local directory, containing only the
`package.json` file of the PHP library, with a formatted name as:
`@composer-asset/--`
-9. Adding, updating, or deleting the mock asset library in the `package.json` file of the project
-10. Running the install or update command of asset manager
-11. Restoring the `package.json` file with the previous dependencies if the asset manager terminates with an error
-12. Restoring the `composer.lock` file and all PHP dependencies if the asset manager terminates with an error
+8. Adding, updating, or deleting the mock asset library in the `package.json` file of the project
+9. Running the install or update command of asset manager
+10. Restoring the `package.json` file with the previous dependencies if the asset manager terminates with an error
+11. Restoring the `composer.lock` file and all PHP dependencies if the asset manager terminates with an error
-Is Foxy useful if my asset dependencies are defined only in my project?
------------------------------------------------------------------------
+## Is Foxy useful if my asset dependencies are defined only in my project?
Foxy is mainly focused on automating of the asset management of the PHP libraries, avoiding potentially conflicting
manual management.
Given that Foxy makes it possible to ensure that the entire management process is valid whether it is for Composer
-and NPM or Yarn, you can use Foxy even if all of your asset dependencies are only defined in the `package.json` file
+and npm or Yarn, you can use Foxy even if all of your asset dependencies are only defined in the `package.json` file
of your project. However, the value added by Foxy in this configuration will be low, and will be limited to the
management of the fallback of the PHP dependencies if there is an error of the asset manager.
-NPM/Yarn does not find the mock of the Composer dependencies
-------------------------------------------------------------
+## npm/Yarn does not find the mock of the Composer dependencies
The advantage of Foxy, is that it allows you to keep the workflows of each tool. However, Foxy creates PHP
-package mocks for NPM, and in this case, Composer must be launched before NPM or Yarn. After, nothing prevents
+package mocks for npm, and in this case, Composer must be launched before npm or Yarn. After, nothing prevents
you to using all available commands of your favorite asset manager.
-Why Foxy does nothing with the '--dry-run' option?
---------------------------------------------------
+## Why Foxy does nothing with the '--dry-run' option?
-Foxy can work with Composer's `--dry-run` option, but chose to do nothing. Given that the PHP dependencies
-are not installed, updated or deleted, Foxy can not update the `package.json` file, and so, NPM can not
+Foxy can work with Composer's `--dry-run` option, but chooses to do nothing. Given that the PHP dependencies
+are not installed, updated or deleted, Foxy cannot update the `package.json` file, and so, npm can not
check the new constraints, if any. To sum up, this amounts to running the commands
`composer update --dry-run` followed by `npm update --dry-run`.
@@ -118,7 +109,6 @@ However, with the Foxy's fallbacks, this behavior is automatically reproduced, b
dependencies, and restoring the `package.json` file, the `composer.lock` file, and all the PHP dependencies
if the asset manager finishes with an error.
-How to increase the PHP memory limit?
--------------------------------------
+## How to increase the PHP memory limit?
See the official documentation of Composer: [Memory limits errors](https://getcomposer.org/doc/articles/troubleshooting.md#memory-limit-errors).
diff --git a/resources/doc/index.md b/resources/doc/index.md
index 78d0658..5867f03 100644
--- a/resources/doc/index.md
+++ b/resources/doc/index.md
@@ -1,5 +1,4 @@
-Getting started
-===============
+# Getting started
1. [Introduction](index.md#introduction)
2. [Required dependencies](index.md#required-dependencies)
@@ -15,9 +14,9 @@ Foxy is a Composer plug-in that aggregates npm-packages from Composer packages.
This makes it possible (and automates the process of) installing and updating npm-packages that ship with your Composer packages, leveraging the native (`bun`, `npm`, `yarn`, or `pnpm`) package manager to do the heavy lifting.
-For this approach to work well, you should think of an npm-package in a Composer package not just as an "artifact", but as an actual npm-package *embedded* in your Composer package.
+For this approach to work well, you should think of an npm-package in a Composer package not just as an "artifact", but as an actual npm-package _embedded_ in your Composer package.
-Importantly, you should name it and *version* it, independently of your Composer version number - like you would normally do with a stand-alone npm-package.
+Importantly, you should name it and _version_ it, independently of your Composer version number - like you would normally do with a stand-alone npm-package.
Note that, for npm-packages with no version number, Foxy will default to the Composer version, as a fallback only: versioning your npm-package explicitly is much safer in terms of correctly versioning breaking/non-breaking changes to any client-side APIs exposed by the embedded npm-package.
diff --git a/resources/doc/usage.md b/resources/doc/usage.md
index 13046e1..7ff2716 100644
--- a/resources/doc/usage.md
+++ b/resources/doc/usage.md
@@ -1,10 +1,10 @@
-Usage
-=====
+# Usage
To use Foxy, whether for a PHP library or a PHP project, you must add the Foxy dependency in
the `require` section of the Composer file.
**composer.json:**
+
```json
{
"require": {
@@ -16,11 +16,12 @@ the `require` section of the Composer file.
And create the `package.json` file to add your asset dependencies.
**package.json:**
+
```json
{
- "dependencies": {
- "@foo/bar": "latest"
- }
+ "dependencies": {
+ "@foo/bar": "latest"
+ }
}
```
@@ -35,6 +36,7 @@ In the case if you use Foxy in a PHP library, you can render Foxy optional by ad
the `require-dev` section of the Composer file.
**composer.json:**
+
```json
{
"require-dev": {
@@ -54,6 +56,7 @@ However, if you want enable the Foxy for your library, but without required depe
you can use the extra option `extra.foxy` in your `composer.json` file:
**composer.json:**
+
```json
{
"extra": {
diff --git a/runtime/.gitignore b/runtime/.gitignore
new file mode 100644
index 0000000..d6b7ef3
--- /dev/null
+++ b/runtime/.gitignore
@@ -0,0 +1,2 @@
+*
+!.gitignore
diff --git a/src/Asset/AbstractAssetManager.php b/src/Asset/AbstractAssetManager.php
index 6d96018..669301c 100644
--- a/src/Asset/AbstractAssetManager.php
+++ b/src/Asset/AbstractAssetManager.php
@@ -2,26 +2,14 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Asset;
use Composer\IO\IOInterface;
use Composer\Package\RootPackageInterface;
use Composer\Semver\VersionParser;
-use Composer\Util\Filesystem;
-use Composer\Util\Platform;
-use Composer\Util\ProcessExecutor;
+use Composer\Util\{Filesystem, Platform, ProcessExecutor};
use Foxy\Config\Config;
-use Foxy\Converter\SemverConverter;
-use Foxy\Converter\VersionConverterInterface;
+use Foxy\Converter\{SemverConverter, VersionConverterInterface};
use Foxy\Exception\RuntimeException;
use Foxy\Fallback\FallbackInterface;
use Foxy\Json\JsonFile;
@@ -29,22 +17,20 @@
use function is_dir;
use function is_string;
use function ltrim;
+use function preg_match;
use function rtrim;
use function sprintf;
use function trim;
use const DIRECTORY_SEPARATOR;
-/**
- * Abstract Manager.
- *
- * @author François Pluchino
- */
abstract class AbstractAssetManager implements AssetManagerInterface
{
final public const NODE_MODULES_PATH = './node_modules';
+
protected bool $updatable = true;
- private null|string $version = '';
+
+ private string|null $version = '';
public function __construct(
protected IOInterface $io,
@@ -52,19 +38,39 @@ public function __construct(
protected ProcessExecutor $executor,
protected Filesystem $fs,
protected FallbackInterface|null $fallback = null,
- protected VersionConverterInterface|null $versionConverter = null
+ protected VersionConverterInterface|null $versionConverter = null,
) {
$this->versionConverter ??= new SemverConverter();
}
- public function isAvailable(): bool
- {
- return null !== $this->getVersion();
- }
+ /**
+ * Get the command to install the asset dependencies.
+ */
+ abstract protected function getInstallCommand(): string;
- public function getPackageName(): string
+ /**
+ * Get the command to update the asset dependencies.
+ */
+ abstract protected function getUpdateCommand(): string;
+
+ /**
+ * Get the command to retrieve the version.
+ */
+ abstract protected function getVersionCommand(): string;
+
+ public function addDependencies(RootPackageInterface $rootPackage, array $dependencies): AssetPackageInterface
{
- return 'package.json';
+ $assetPackage = new AssetPackage(
+ $rootPackage,
+ new JsonFile($this->getPackageJsonPath(), null, $this->io),
+ );
+ $assetPackage->removeUnusedDependencies($dependencies);
+ $alreadyInstalledDependencies = $assetPackage->addNewDependencies($dependencies);
+
+ $this->actionWhenComposerDependenciesAreAlreadyInstalled($alreadyInstalledDependencies);
+ $this->io->write('Merging Composer dependencies in the asset package ');
+
+ return $assetPackage->write();
}
public function getPackageJsonPath(): string
@@ -72,28 +78,24 @@ public function getPackageJsonPath(): string
return rtrim($this->getRootPackageDir(), '/\\') . DIRECTORY_SEPARATOR . $this->getPackageName();
}
- public function hasLockFile(): bool
+ public function getPackageName(): string
{
- return file_exists($this->getLockFilePath());
+ return 'package.json';
}
- public function isInstalled(): bool
+ public function hasLockFile(): bool
{
- return is_dir($this->getNodeModulesPath()) && file_exists($this->getPackageJsonPath());
+ return file_exists($this->getLockFilePath());
}
- public function setFallback(FallbackInterface $fallback): static
+ public function isAvailable(): bool
{
- $this->fallback = $fallback;
-
- return $this;
+ return null !== $this->getVersion();
}
- public function setUpdatable($updatable): static
+ public function isInstalled(): bool
{
- $this->updatable = $updatable;
-
- return $this;
+ return is_dir($this->getNodeModulesPath()) && file_exists($this->getPackageJsonPath());
}
public function isUpdatable(): bool
@@ -106,48 +108,6 @@ public function isValidForUpdate(): bool
return true;
}
- public function validate(): void
- {
- $version = $this->getVersion();
- /** @var string $constraintVersion */
- $constraintVersion = $this->config->get('manager-version');
-
- if (null === $version) {
- throw new RuntimeException(sprintf('The binary of "%s" must be installed', $this->getName()));
- }
-
- if ($constraintVersion) {
- $parser = new VersionParser();
- $constraint = $parser->parseConstraints($constraintVersion);
-
- if (!$constraint->matches($parser->parseConstraints($version))) {
- throw new RuntimeException(
- sprintf(
- 'The installed %s version "%s" doesn\'t match with the constraint version "%s"',
- $this->getName(),
- $version,
- $constraintVersion
- )
- );
- }
- }
- }
-
- public function addDependencies(RootPackageInterface $rootPackage, array $dependencies): AssetPackageInterface
- {
- $assetPackage = new AssetPackage(
- $rootPackage,
- new JsonFile($this->getPackageJsonPath(), null, $this->io)
- );
- $assetPackage->removeUnusedDependencies($dependencies);
- $alreadyInstalledDependencies = $assetPackage->addNewDependencies($dependencies);
-
- $this->actionWhenComposerDependenciesAreAlreadyInstalled($alreadyInstalledDependencies);
- $this->io->write('Merging Composer dependencies in the asset package ');
-
- return $assetPackage->write();
- }
-
public function run(): int
{
if (true !== $this->config->get('run-asset-manager')) {
@@ -202,12 +162,53 @@ public function run(): int
return $res;
} finally {
- if ($changedDir && null !== $originalDir) {
- if (chdir($originalDir) === false) {
- throw new RuntimeException(
- sprintf('Unable to restore working directory to "%s".', $originalDir)
- );
- }
+ if ($changedDir && null !== $originalDir && chdir($originalDir) === false) {
+ throw new RuntimeException(
+ sprintf('Unable to restore working directory to "%s".', $originalDir),
+ );
+ }
+ }
+
+ return 0;
+ }
+
+ public function setFallback(FallbackInterface $fallback): static
+ {
+ $this->fallback = $fallback;
+
+ return $this;
+ }
+
+ public function setUpdatable($updatable): static
+ {
+ $this->updatable = $updatable;
+
+ return $this;
+ }
+
+ public function validate(): void
+ {
+ $version = $this->getVersion();
+ /** @var string $constraintVersion */
+ $constraintVersion = $this->config->get('manager-version');
+
+ if (null === $version) {
+ throw new RuntimeException(sprintf('The binary of "%s" must be installed', $this->getName()));
+ }
+
+ if ($constraintVersion) {
+ $parser = new VersionParser();
+ $constraint = $parser->parseConstraints($constraintVersion);
+
+ if (!$constraint->matches($parser->parseConstraints($version))) {
+ throw new RuntimeException(
+ sprintf(
+ 'The installed %s version "%s" doesn\'t match with the constraint version "%s"',
+ $this->getName(),
+ $version,
+ $constraintVersion,
+ ),
+ );
}
}
}
@@ -224,6 +225,36 @@ protected function actionWhenComposerDependenciesAreAlreadyInstalled(array $name
// do nothing by default
}
+ /**
+ * Build the command with binary and command options.
+ *
+ * @param string $defaultBin The default binary of command if option isn't defined.
+ * @param string $action The command action to retrieve the options in config.
+ * @param array|string $command The command.
+ */
+ protected function buildCommand(string $defaultBin, string $action, array|string $command): string
+ {
+ $bin = $this->config->get('manager-bin', $defaultBin);
+ $bin = Platform::isWindows() ? str_replace('/', '\\', (string) $bin) : $bin;
+ $gOptions = trim((string) $this->config->get('manager-options', ''));
+ $options = trim((string) $this->config->get('manager-' . $action . '-options', ''));
+
+ /** @psalm-var string|string[] $command */
+ return (string) $bin . ' ' . implode(' ', (array) $command)
+ . (empty($gOptions) ? '' : ' ' . $gOptions)
+ . (empty($options) ? '' : ' ' . $options);
+ }
+
+ protected function getLockFilePath(): string
+ {
+ return rtrim($this->getRootPackageDir(), '/\\') . DIRECTORY_SEPARATOR . $this->getLockPackageName();
+ }
+
+ protected function getNodeModulesPath(): string
+ {
+ return rtrim($this->getRootPackageDir(), '/\\') . DIRECTORY_SEPARATOR . ltrim(self::NODE_MODULES_PATH, './');
+ }
+
protected function getRootPackageDir(): string
{
$rootPackageDir = $this->config->get('root-package-json-dir');
@@ -233,7 +264,7 @@ protected function getRootPackageDir(): string
if ('' === $rootPackageDir) {
$rootPackageDir = DIRECTORY_SEPARATOR;
- } elseif (1 === \preg_match('/^[A-Za-z]:$/', $rootPackageDir)) {
+ } elseif (1 === preg_match('/^[A-Za-z]:$/', $rootPackageDir)) {
$rootPackageDir .= DIRECTORY_SEPARATOR;
}
@@ -259,67 +290,24 @@ protected function getRootPackageDir(): string
return $currentDir;
}
- protected function getLockFilePath(): string
- {
- return rtrim($this->getRootPackageDir(), '/\\') . DIRECTORY_SEPARATOR . $this->getLockPackageName();
- }
-
- protected function getNodeModulesPath(): string
- {
- return rtrim($this->getRootPackageDir(), '/\\') . DIRECTORY_SEPARATOR . ltrim(self::NODE_MODULES_PATH, './');
- }
-
- /**
- * Build the command with binary and command options.
- *
- * @param string $defaultBin The default binary of command if option isn't defined.
- * @param string $action The command action to retrieve the options in config.
- * @param array|string $command The command.
- */
- protected function buildCommand(string $defaultBin, string $action, array|string $command): string
- {
- $bin = $this->config->get('manager-bin', $defaultBin);
- $bin = Platform::isWindows() ? str_replace('/', '\\', (string) $bin) : $bin;
- $gOptions = trim((string) $this->config->get('manager-options', ''));
- $options = trim((string) $this->config->get('manager-' . $action . '-options', ''));
-
- /** @psalm-var string|string[] $command */
- return (string) $bin . ' ' . implode(' ', (array) $command)
- . (empty($gOptions) ? '' : ' ' . $gOptions)
- . (empty($options) ? '' : ' ' . $options);
- }
-
protected function getVersion(): string|null
{
if ($this->version === '' && $this->versionConverter !== null) {
$this->executor->execute($this->getVersionCommand(), $version);
- $this->version = '' !== trim((string) $version) ? $this->versionConverter->convertVersion(trim((string) $version)) : null;
+ $this->version = '' !== trim((string) $version)
+ ? $this->versionConverter->convertVersion(trim((string) $version))
+ : null;
}
return $this->version;
}
- /**
- * Get the command to retrieve the version.
- */
- abstract protected function getVersionCommand(): string;
-
- /**
- * Get the command to install the asset dependencies.
- */
- abstract protected function getInstallCommand(): string;
-
- /**
- * Get the command to update the asset dependencies.
- */
- abstract protected function getUpdateCommand(): string;
-
private function isAbsolutePath(string $path): bool
{
if ('/' === $path[0] || '\\' === $path[0]) {
return true;
}
- return (bool) \preg_match('/^[A-Za-z]:[\\\\\/]/', $path);
+ return (bool) preg_match('/^[A-Za-z]:[\\\\\/]/', $path);
}
}
diff --git a/src/Asset/AssetManagerFinder.php b/src/Asset/AssetManagerFinder.php
index 6f0c9dc..a7dfda1 100644
--- a/src/Asset/AssetManagerFinder.php
+++ b/src/Asset/AssetManagerFinder.php
@@ -2,24 +2,12 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Asset;
use Foxy\Exception\RuntimeException;
-/**
- * Asset Manager finder.
- *
- * @author François Pluchino
- */
+use function sprintf;
+
final class AssetManagerFinder
{
/**
diff --git a/src/Asset/AssetManagerInterface.php b/src/Asset/AssetManagerInterface.php
index 93abb73..617b269 100644
--- a/src/Asset/AssetManagerInterface.php
+++ b/src/Asset/AssetManagerInterface.php
@@ -2,37 +2,31 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Asset;
use Composer\Package\RootPackageInterface;
use Foxy\Exception\RuntimeException;
use Foxy\Fallback\FallbackInterface;
-/**
- * Interface of asset manager.
- *
- * @author François Pluchino
- */
interface AssetManagerInterface
{
/**
- * Get the name of asset manager.
+ * Add the asset dependencies in asset package file.
+ *
+ * @param RootPackageInterface $rootPackage The composer root package
+ * @param array $dependencies The asset local dependencies
*/
- public function getName(): string;
+ public function addDependencies(RootPackageInterface $rootPackage, array $dependencies): AssetPackageInterface;
/**
- * Check if the asset manager is available.
+ * Get the filename of the lock file.
*/
- public function isAvailable(): bool;
+ public function getLockPackageName(): string;
+
+ /**
+ * Get the name of asset manager.
+ */
+ public function getName(): string;
/**
* Get the filename of the asset package.
@@ -45,23 +39,14 @@ public function getPackageName(): string;
public function hasLockFile(): bool;
/**
- * Check if the asset dependencies are installed or not.
- */
- public function isInstalled(): bool;
-
- /**
- * Set the fallback.
- *
- * @param FallbackInterface $fallback The fallback
+ * Check if the asset manager is available.
*/
- public function setFallback(FallbackInterface $fallback): self;
+ public function isAvailable(): bool;
/**
- * Define if the asset manager can be use the update command.
- *
- * @param bool $updatable The value
+ * Check if the asset dependencies are installed or not.
*/
- public function setUpdatable(bool $updatable): self;
+ public function isInstalled(): bool;
/**
* Check if the asset manager can be use the update command or not.
@@ -74,28 +59,29 @@ public function isUpdatable(): bool;
public function isValidForUpdate(): bool;
/**
- * Get the filename of the lock file.
+ * Run the asset manager to install/update the asset dependencies.
*/
- public function getLockPackageName(): string;
+ public function run(): int;
/**
- * Validate the version of asset manager.
+ * Set the fallback.
*
- * @throws RuntimeException When the binary isn't installed
- * @throws RuntimeException When the version doesn't match
+ * @param FallbackInterface $fallback The fallback
*/
- public function validate(): void;
+ public function setFallback(FallbackInterface $fallback): self;
/**
- * Add the asset dependencies in asset package file.
+ * Define if the asset manager can be use the update command.
*
- * @param RootPackageInterface $rootPackage The composer root package
- * @param array $dependencies The asset local dependencies
+ * @param bool $updatable The value
*/
- public function addDependencies(RootPackageInterface $rootPackage, array $dependencies): AssetPackageInterface;
+ public function setUpdatable(bool $updatable): self;
/**
- * Run the asset manager to install/update the asset dependencies.
+ * Validate the version of asset manager.
+ *
+ * @throws RuntimeException When the binary isn't installed
+ * @throws RuntimeException When the version doesn't match
*/
- public function run(): int;
+ public function validate(): void;
}
diff --git a/src/Asset/AssetPackage.php b/src/Asset/AssetPackage.php
index f6d6c93..73289a3 100644
--- a/src/Asset/AssetPackage.php
+++ b/src/Asset/AssetPackage.php
@@ -2,40 +2,35 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Asset;
use Composer\Json\JsonFile;
use Composer\Package\RootPackageInterface;
+use Exception;
+use Seld\JsonLint\ParsingException;
+
+use function count;
+use function dirname;
+use function is_array;
-/**
- * Asset package.
- *
- * @author François Pluchino
- */
final class AssetPackage implements AssetPackageInterface
{
+ public const COMPOSER_PREFIX = '@composer-asset/';
+
public const SECTION_DEPENDENCIES = 'dependencies';
+
public const SECTION_DEV_DEPENDENCIES = 'devDependencies';
- public const COMPOSER_PREFIX = '@composer-asset/';
- protected array $package = [];
+
+ private array $package = [];
/**
* @param RootPackageInterface $rootPackage The composer root package
- * @param JsonFile $jsonFile The json file
+ * @param JsonFile $jsonFile The JSON file
+ *
+ * @throws ParsingException
*/
- public function __construct(RootPackageInterface $rootPackage, protected JsonFile $jsonFile)
+ public function __construct(RootPackageInterface $rootPackage, private readonly JsonFile $jsonFile)
{
- $this->jsonFile = $jsonFile;
-
if ($jsonFile->exists()) {
$this->setPackage((array) $jsonFile->read());
}
@@ -43,44 +38,6 @@ public function __construct(RootPackageInterface $rootPackage, protected JsonFil
$this->injectRequiredKeys($rootPackage);
}
- public function write(): self
- {
- $this->jsonFile->write($this->package);
-
- return $this;
- }
-
- public function setPackage(array $package): self
- {
- $this->package = $package;
-
- return $this;
- }
-
- public function getPackage(): array
- {
- return $this->package;
- }
-
- public function getInstalledDependencies(): array
- {
- $installedAssets = [];
-
- if (isset($this->package[self::SECTION_DEPENDENCIES]) && \is_array($this->package[self::SECTION_DEPENDENCIES])) {
- /**
- * @var string $dependency
- * @var string $version
- */
- foreach ($this->package[self::SECTION_DEPENDENCIES] as $dependency => $version) {
- if (str_starts_with($dependency, self::COMPOSER_PREFIX)) {
- $installedAssets[$dependency] = $version;
- }
- }
- }
-
- return $installedAssets;
- }
-
/**
* Add new dependencies.
*
@@ -105,7 +62,7 @@ public function addNewDependencies(array $dependencies): array
if (isset($installedAssets[$name])) {
$existingPackages[] = $name;
} else {
- $this->package[self::SECTION_DEPENDENCIES][$name] = 'file:./' . \dirname($path);
+ $this->package[self::SECTION_DEPENDENCIES][$name] = 'file:./' . dirname($path);
}
}
@@ -115,6 +72,30 @@ public function addNewDependencies(array $dependencies): array
return $existingPackages;
}
+ public function getInstalledDependencies(): array
+ {
+ $installedAssets = [];
+
+ if (isset($this->package[self::SECTION_DEPENDENCIES]) && is_array($this->package[self::SECTION_DEPENDENCIES])) {
+ /**
+ * @var string $dependency
+ * @var string $version
+ */
+ foreach ($this->package[self::SECTION_DEPENDENCIES] as $dependency => $version) {
+ if (str_starts_with($dependency, self::COMPOSER_PREFIX)) {
+ $installedAssets[$dependency] = $version;
+ }
+ }
+ }
+
+ return $installedAssets;
+ }
+
+ public function getPackage(): array
+ {
+ return $this->package;
+ }
+
/**
* @psalm-suppress MixedArrayAccess
*/
@@ -130,14 +111,31 @@ public function removeUnusedDependencies(array $dependencies): self
return $this;
}
+ public function setPackage(array $package): self
+ {
+ $this->package = $package;
+
+ return $this;
+ }
+
+ /**
+ * @throws Exception
+ */
+ public function write(): self
+ {
+ $this->jsonFile->write($this->package);
+
+ return $this;
+ }
+
/**
* Inject the required keys for asset package defined in root composer package.
*
* @param RootPackageInterface $rootPackage The composer root package
*/
- protected function injectRequiredKeys(RootPackageInterface $rootPackage): void
+ private function injectRequiredKeys(RootPackageInterface $rootPackage): void
{
- if (!isset($this->package['license']) && \count($rootPackage->getLicense()) > 0) {
+ if (!isset($this->package['license']) && count($rootPackage->getLicense()) > 0) {
$license = current($rootPackage->getLicense());
if ('proprietary' === $license) {
@@ -155,9 +153,9 @@ protected function injectRequiredKeys(RootPackageInterface $rootPackage): void
*
* @param string $section The package section
*/
- protected function orderPackages(string $section): void
+ private function orderPackages(string $section): void
{
- if (isset($this->package[$section]) && \is_array($this->package[$section])) {
+ if (isset($this->package[$section]) && is_array($this->package[$section])) {
ksort($this->package[$section], SORT_STRING);
}
}
diff --git a/src/Asset/AssetPackageInterface.php b/src/Asset/AssetPackageInterface.php
index b6b1c45..9a916be 100644
--- a/src/Asset/AssetPackageInterface.php
+++ b/src/Asset/AssetPackageInterface.php
@@ -2,35 +2,25 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Asset;
-/**
- * Interface of asset package.
- *
- * @author François Pluchino
- */
interface AssetPackageInterface
{
/**
- * Write the asset package in file.
+ * Add the new asset dependencies and return the names of already installed asset dependencies.
+ *
+ * @param array $dependencies The asset dependencies
+ *
+ * @return array The asset package name of the already asset dependencies
*/
- public function write(): self;
+ public function addNewDependencies(array $dependencies): array;
/**
- * Set the asset package.
+ * Get the installed asset dependencies.
*
- * @param array $package The asset package
+ * @return array The installed asset dependencies
*/
- public function setPackage(array $package): self;
+ public function getInstalledDependencies(): array;
/**
* Get the asset package.
@@ -38,25 +28,21 @@ public function setPackage(array $package): self;
public function getPackage(): array;
/**
- * Get the installed asset dependencies.
+ * Remove the unused asset dependencies.
*
- * @return array The installed asset dependencies
+ * @param array $dependencies All asset dependencies
*/
- public function getInstalledDependencies(): array;
+ public function removeUnusedDependencies(array $dependencies): self;
/**
- * Add the new asset dependencies and return the names of already installed asset dependencies.
- *
- * @param array $dependencies The asset dependencies
+ * Set the asset package.
*
- * @return array The asset package name of the already asset dependencies
+ * @param array $package The asset package
*/
- public function addNewDependencies(array $dependencies): array;
+ public function setPackage(array $package): self;
/**
- * Remove the unused asset dependencies.
- *
- * @param array $dependencies All asset dependencies
+ * Write the asset package in file.
*/
- public function removeUnusedDependencies(array $dependencies): self;
+ public function write(): self;
}
diff --git a/src/Asset/BunManager.php b/src/Asset/BunManager.php
index 9b2429e..ef8dea9 100644
--- a/src/Asset/BunManager.php
+++ b/src/Asset/BunManager.php
@@ -2,34 +2,20 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Asset;
use Composer\Util\Platform;
-/**
- * Bun Manager.
- *
- * @author Wilmer Arambula (terabytesfotw@gmail.com)
- */
final class BunManager extends AbstractAssetManager
{
- public function getName(): string
+ public function getLockPackageName(): string
{
- return 'bun';
+ return 'yarn.lock';
}
- public function getLockPackageName(): string
+ public function getName(): string
{
- return 'yarn.lock';
+ return 'bun';
}
public function isInstalled(): bool
@@ -37,24 +23,24 @@ public function isInstalled(): bool
return parent::isInstalled() && file_exists($this->getLockFilePath());
}
- protected function getVersionCommand(): string
+ protected function getInstallCommand(): string
{
$command = Platform::isWindows() ? 'bun.exe' : 'bun';
- return $this->buildCommand($command, 'version', '--version');
+ return $this->buildCommand($command, 'install', 'install -y');
}
- protected function getInstallCommand(): string
+ protected function getUpdateCommand(): string
{
$command = Platform::isWindows() ? 'bun.exe' : 'bun';
- return $this->buildCommand($command, 'install', 'install -y');
+ return $this->buildCommand($command, 'update', 'update -y');
}
- protected function getUpdateCommand(): string
+ protected function getVersionCommand(): string
{
$command = Platform::isWindows() ? 'bun.exe' : 'bun';
- return $this->buildCommand($command, 'update', 'update -y');
+ return $this->buildCommand($command, 'version', '--version');
}
}
diff --git a/src/Asset/NpmManager.php b/src/Asset/NpmManager.php
index 94c3c46..bdf9dff 100644
--- a/src/Asset/NpmManager.php
+++ b/src/Asset/NpmManager.php
@@ -2,37 +2,25 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Asset;
-/**
- * NPM Manager.
- *
- * @author François Pluchino
- */
final class NpmManager extends AbstractAssetManager
{
- public function getName(): string
+ public function getLockPackageName(): string
{
- return 'npm';
+ return 'package-lock.json';
}
- public function getLockPackageName(): string
+ public function getName(): string
{
- return 'package-lock.json';
+ return 'npm';
}
- protected function getVersionCommand(): string
+ protected function actionWhenComposerDependenciesAreAlreadyInstalled(array $names): void
{
- return $this->buildCommand('npm', 'version', '--version');
+ foreach ($names as $name) {
+ $this->fs->remove(self::NODE_MODULES_PATH . '/' . $name);
+ }
}
protected function getInstallCommand(): string
@@ -45,10 +33,8 @@ protected function getUpdateCommand(): string
return $this->buildCommand('npm', 'update', 'update');
}
- protected function actionWhenComposerDependenciesAreAlreadyInstalled(array $names): void
+ protected function getVersionCommand(): string
{
- foreach ($names as $name) {
- $this->fs->remove(self::NODE_MODULES_PATH . '/' . $name);
- }
+ return $this->buildCommand('npm', 'version', '--version');
}
}
diff --git a/src/Asset/PnpmManager.php b/src/Asset/PnpmManager.php
index 8a60e81..65837ec 100644
--- a/src/Asset/PnpmManager.php
+++ b/src/Asset/PnpmManager.php
@@ -2,42 +2,23 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Asset;
-/**
- * Pnpm Manager.
- *
- * @author Steffen Dietz
- */
final class PnpmManager extends AbstractAssetManager
{
- public function getName(): string
- {
- return 'pnpm';
- }
-
public function getLockPackageName(): string
{
return 'pnpm-lock.yaml';
}
- public function isInstalled(): bool
+ public function getName(): string
{
- return parent::isInstalled() && file_exists($this->getLockFilePath());
+ return 'pnpm';
}
- protected function getVersionCommand(): string
+ public function isInstalled(): bool
{
- return $this->buildCommand('pnpm', 'version', '--version');
+ return parent::isInstalled() && file_exists($this->getLockFilePath());
}
protected function getInstallCommand(): string
@@ -49,4 +30,9 @@ protected function getUpdateCommand(): string
{
return $this->buildCommand('pnpm', 'update', 'update');
}
+
+ protected function getVersionCommand(): string
+ {
+ return $this->buildCommand('pnpm', 'version', '--version');
+ }
}
diff --git a/src/Asset/YarnManager.php b/src/Asset/YarnManager.php
index b779be6..cf13ede 100644
--- a/src/Asset/YarnManager.php
+++ b/src/Asset/YarnManager.php
@@ -2,34 +2,20 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Asset;
use Composer\Semver\VersionParser;
-/**
- * Yarn Manager.
- *
- * @author François Pluchino
- */
final class YarnManager extends AbstractAssetManager
{
- public function getName(): string
+ public function getLockPackageName(): string
{
- return 'yarn';
+ return 'yarn.lock';
}
- public function getLockPackageName(): string
+ public function getName(): string
{
- return 'yarn.lock';
+ return 'yarn';
}
public function isInstalled(): bool
@@ -48,11 +34,6 @@ public function isValidForUpdate(): bool
return 0 === $this->executor->execute($cmd);
}
- protected function getVersionCommand(): string
- {
- return $this->buildCommand('yarn', 'version', '--version');
- }
-
protected function getInstallCommand(): string
{
return $this->buildCommand('yarn', 'install', $this->mergeInteractiveCommand(['install']));
@@ -65,13 +46,18 @@ protected function getUpdateCommand(): string
return $this->buildCommand('yarn', 'update', $this->mergeInteractiveCommand([$commandName]));
}
+ protected function getVersionCommand(): string
+ {
+ return $this->buildCommand('yarn', 'version', '--version');
+ }
+
private function isYarnNext(): bool
{
$version = $this->getVersion();
$parser = new VersionParser();
$constraint = $parser->parseConstraints('>=2.0.0');
- return $version !== null ? $constraint->matches($parser->parseConstraints($version)) : false;
+ return $version !== null && $constraint->matches($parser->parseConstraints($version));
}
private function mergeInteractiveCommand(array $command): array
diff --git a/src/Config/Config.php b/src/Config/Config.php
index a3ba67f..072ad05 100644
--- a/src/Config/Config.php
+++ b/src/Config/Config.php
@@ -2,24 +2,22 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Config;
use Foxy\Exception\RuntimeException;
-/**
- * Helper of package config.
- *
- * @author François Pluchino
- */
+use function array_key_exists;
+use function ctype_digit;
+use function in_array;
+use function is_array;
+use function json_decode;
+use function json_last_error;
+use function sprintf;
+use function str_replace;
+use function str_starts_with;
+use function strtoupper;
+use function trim;
+
class Config
{
private array $cacheEnv = [];
@@ -28,24 +26,7 @@ class Config
* @param array $config The config.
* @param array $defaults The default values.
*/
- public function __construct(private array $config, private array $defaults = [])
- {
- $this->config = $config;
- $this->defaults = $defaults;
- }
-
- /**
- * Get the array config value.
- *
- * @param string $key The config key.
- * @param array $default The default value.
- */
- public function getArray(string $key, array $default = []): array
- {
- $value = $this->get($key, null);
-
- return is_array($value) ? $value : $default;
- }
+ public function __construct(private readonly array $config, private readonly array $defaults = []) {}
/**
* Get the config value.
@@ -55,7 +36,7 @@ public function getArray(string $key, array $default = []): array
*/
public function get(string $key, mixed $default = null): mixed
{
- if (\array_key_exists($key, $this->cacheEnv)) {
+ if (array_key_exists($key, $this->cacheEnv)) {
return $this->cacheEnv[$key];
}
@@ -68,11 +49,34 @@ public function get(string $key, mixed $default = null): mixed
$defaultValue = $this->getDefaultValue($key, $default);
- return \array_key_exists($key, $this->config)
+ return array_key_exists($key, $this->config)
? $this->getByManager($key, $this->config[$key], $defaultValue)
: $defaultValue;
}
+ /**
+ * Get the array config value.
+ *
+ * @param string $key The config key.
+ * @param array $default The default value.
+ */
+ public function getArray(string $key, array $default = []): array
+ {
+ $value = $this->get($key);
+
+ return is_array($value) ? $value : $default;
+ }
+
+ /**
+ * Convert the value of environment variable into a boolean.
+ *
+ * @param string $value The value of environment variable.
+ */
+ private function convertBoolean(string $value): bool
+ {
+ return in_array($value, ['true', '1', 'yes', 'y'], true);
+ }
+
/**
* Convert the config key into environment variable.
*
@@ -105,39 +109,7 @@ private function convertEnvValue(string $value, string $environmentVariable): ar
}
/**
- * Check if the value of environment variable is a boolean.
- *
- * @param string $value The value of environment variable.
- */
- private function isBoolean(string $value): bool
- {
- $value = strtolower($value);
-
- return \in_array($value, ['true', 'false', '1', '0', 'yes', 'no', 'y', 'n'], true);
- }
-
- /**
- * Convert the value of environment variable into a boolean.
- *
- * @param string $value The value of environment variable.
- */
- private function convertBoolean(string $value): bool
- {
- return \in_array($value, ['true', '1', 'yes', 'y'], true);
- }
-
- /**
- * Check if the value of environment variable is a integer.
- *
- * @param string $value The value of environment variable.
- */
- private function isInteger(string $value): bool
- {
- return ctype_digit(trim($value, '-'));
- }
-
- /**
- * Convert the value of environment variable into a integer.
+ * Convert the value of environment variable into an integer.
*
* @param string $value The value of environment variable.
*/
@@ -146,16 +118,6 @@ private function convertInteger(string $value): int
return (int) $value;
}
- /**
- * Check if the value of environment variable is a string JSON.
- *
- * @param string $value The value of environment variable.
- */
- private function isJson(string $value): bool
- {
- return str_starts_with($value, '{') || str_starts_with($value, '[');
- }
-
/**
* Convert the value of environment variable into a json array.
*
@@ -168,13 +130,34 @@ private function convertJson(string $value, string $environmentVariable): array
if (json_last_error()) {
throw new RuntimeException(
- sprintf('The "%s" environment variable isn\'t a valid JSON', $environmentVariable)
+ sprintf('The "%s" environment variable isn\'t a valid JSON', $environmentVariable),
);
}
return is_array($value) ? $value : [];
}
+ /**
+ * Get the value defined by the manager name in the key.
+ *
+ * @param string $key The config key.
+ * @param mixed $value The value.
+ * @param mixed $default The default value.
+ */
+ private function getByManager(string $key, mixed $value, mixed $default = null): mixed
+ {
+ if (str_starts_with($key, 'manager-') && is_array($value)) {
+ /** @var int|string $manager */
+ $manager = $this->get('manager', '');
+
+ $value = array_key_exists($manager, $value)
+ ? $value[$manager]
+ : $default;
+ }
+
+ return $value;
+ }
+
/**
* Get the configured default value or custom default value.
*
@@ -183,7 +166,7 @@ private function convertJson(string $value, string $environmentVariable): array
*/
private function getDefaultValue(string $key, mixed $default = null): mixed
{
- $value = null === $default && \array_key_exists($key, $this->defaults)
+ $value = null === $default && array_key_exists($key, $this->defaults)
? $this->defaults[$key]
: $default;
@@ -191,23 +174,34 @@ private function getDefaultValue(string $key, mixed $default = null): mixed
}
/**
- * Get the value defined by the manager name in the key.
+ * Check if the value of environment variable is a boolean.
*
- * @param string $key The config key.
- * @param mixed $value The value.
- * @param mixed $default The default value.
+ * @param string $value The value of environment variable.
*/
- private function getByManager(string $key, mixed $value, mixed $default = null): mixed
+ private function isBoolean(string $value): bool
{
- if (str_starts_with($key, 'manager-') && \is_array($value)) {
- /** @var int|string $manager */
- $manager = $this->get('manager', '');
+ $value = strtolower($value);
- $value = \array_key_exists($manager, $value)
- ? $value[$manager]
- : $default;
- }
+ return in_array($value, ['true', 'false', '1', '0', 'yes', 'no', 'y', 'n'], true);
+ }
- return $value;
+ /**
+ * Check if the value of environment variable is an integer.
+ *
+ * @param string $value The value of environment variable.
+ */
+ private function isInteger(string $value): bool
+ {
+ return ctype_digit(trim($value, '-'));
+ }
+
+ /**
+ * Check if the value of environment variable is a string JSON.
+ *
+ * @param string $value The value of environment variable.
+ */
+ private function isJson(string $value): bool
+ {
+ return str_starts_with($value, '{') || str_starts_with($value, '[');
}
}
diff --git a/src/Config/ConfigBuilder.php b/src/Config/ConfigBuilder.php
index b3a6903..64ff1dc 100644
--- a/src/Config/ConfigBuilder.php
+++ b/src/Config/ConfigBuilder.php
@@ -2,26 +2,17 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Config;
use Composer\Composer;
use Composer\IO\IOInterface;
use Composer\Json\JsonFile;
+use Seld\JsonLint\ParsingException;
+
+use function array_merge;
+use function is_array;
+use function is_string;
-/**
- * Plugin Config builder.
- *
- * @author François Pluchino
- */
abstract class ConfigBuilder
{
/**
@@ -30,6 +21,8 @@ abstract class ConfigBuilder
* @param Composer $composer The composer.
* @param array $defaults The default values.
* @param IOInterface|null $io The composer input/output.
+ *
+ * @throws ParsingException
*/
public static function build(Composer $composer, array $defaults = [], IOInterface|null $io = null): Config
{
@@ -38,18 +31,32 @@ public static function build(Composer $composer, array $defaults = [], IOInterfa
return new Config($config, $defaults);
}
+ /**
+ * Get the home directory of composer.
+ *
+ * @param Composer $composer The composer
+ */
+ private static function getComposerHome(Composer $composer): string
+ {
+ $composerHome = $composer->getConfig()->get('home');
+
+ return is_string($composerHome) ? $composerHome : '';
+ }
+
/**
* Get the base of data.
*
* @param Composer $composer The composer.
* @param IOInterface|null $io The composer input/output.
+ *
+ * @throws ParsingException
*/
private static function getConfigBase(Composer $composer, IOInterface|null $io = null): array
{
$globalPackageConfig = self::getGlobalConfig($composer, 'composer', $io);
$globalConfig = self::getGlobalConfig($composer, 'config', $io);
$packageConfig = $composer->getPackage()->getConfig();
- $packageConfig = isset($packageConfig['foxy']) && \is_array($packageConfig['foxy'])
+ $packageConfig = isset($packageConfig['foxy']) && is_array($packageConfig['foxy'])
? $packageConfig['foxy']
: [];
@@ -62,6 +69,8 @@ private static function getConfigBase(Composer $composer, IOInterface|null $io =
* @param Composer $composer The composer.
* @param string $filename The filename.
* @param IOInterface|null $io The composer input/output.
+ *
+ * @throws ParsingException
*/
private static function getGlobalConfig(Composer $composer, string $filename, IOInterface|null $io = null): array
{
@@ -73,7 +82,7 @@ private static function getGlobalConfig(Composer $composer, string $filename, IO
/** @var array $data */
$data = $file->read();
- if (isset($data['config']['foxy']) && \is_array($data['config']['foxy'])) {
+ if (isset($data['config']['foxy']) && is_array($data['config']['foxy'])) {
$config = $data['config']['foxy'];
if ($io instanceof IOInterface && $io->isDebug()) {
@@ -84,16 +93,4 @@ private static function getGlobalConfig(Composer $composer, string $filename, IO
return $config;
}
-
- /**
- * Get the home directory of composer.
- *
- * @param Composer $composer The composer
- */
- private static function getComposerHome(Composer $composer): string
- {
- $composerHome = $composer->getConfig()->get('home');
-
- return is_string($composerHome) ? $composerHome : '';
- }
}
diff --git a/src/Converter/SemverConverter.php b/src/Converter/SemverConverter.php
index cbb70bc..175456b 100644
--- a/src/Converter/SemverConverter.php
+++ b/src/Converter/SemverConverter.php
@@ -2,33 +2,26 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Converter;
-/**
- * Converter for Semver syntax version to composer syntax version.
- *
- * @author François Pluchino
- */
+use function in_array;
+use function preg_match;
+use function str_replace;
+use function str_starts_with;
+use function strlen;
+use function substr;
+
final class SemverConverter implements VersionConverterInterface
{
public function convertVersion(string|null $version = null): string
{
- if (\in_array($version, [null, '', 'latest'], true)) {
+ if (in_array($version, [null, '', 'latest'], true)) {
return ('latest' === $version ? 'default || ' : '') . '*';
}
$version = str_replace('–', '-', $version);
- $prefix = preg_match('/^[a-z]/', $version) && !str_starts_with($version, 'dev-') ? substr($version, 0, 1) : '';
- $version = substr($version, \strlen($prefix));
+ $prefix = preg_match('/^[a-z]/', $version) && !str_starts_with($version, 'dev-') ? $version[0] : '';
+ $version = substr($version, strlen($prefix));
$version = SemverUtil::convertVersionMetadata($version);
$version = SemverUtil::convertDateVersion($version);
diff --git a/src/Converter/SemverUtil.php b/src/Converter/SemverUtil.php
index c564f53..33807c6 100644
--- a/src/Converter/SemverUtil.php
+++ b/src/Converter/SemverUtil.php
@@ -2,24 +2,13 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Converter;
use Composer\Package\Version\VersionParser;
-/**
- * Utils for semver converter.
- *
- * @author François Pluchino
- */
+use function in_array;
+use function strlen;
+
abstract class SemverUtil
{
/**
@@ -81,22 +70,6 @@ public static function createPattern(string $pattern): string
return '/^(' . $numVer . '|' . $numVer2 . '|' . $numVer3 . ')' . $pattern . '/';
}
- /**
- * Clean the wildcard in version.
- *
- * @param string $version The version.
- *
- * @return string The cleaned version.
- */
- private static function cleanWildcard(string $version): string
- {
- while (str_contains($version, '.x.x')) {
- $version = str_replace('.x.x', '.x', $version);
- }
-
- return $version;
- }
-
/**
* Clean the raw version.
*
@@ -112,41 +85,53 @@ private static function cleanWildcard(string $version): string
*/
private static function cleanVersion(string $version, array $matches): array
{
- $end = substr($version, \strlen((string) $matches[1][0][0]));
+ $end = substr($version, strlen((string) $matches[1][0][0]));
$version = $matches[1][0][0] . '-';
$matches = [];
+
if (preg_match('/^([-+])/', $end, $matches)) {
$end = substr($end, 1);
}
$matches = [];
+
preg_match('/^[a-z]+/', $end, $matches);
+
$type = isset($matches[0]) ? self::normalizeStability($matches[0]) : '';
- $end = substr($end, \strlen($type));
+ $end = substr($end, strlen($type));
return [$type, $version, $end];
}
/**
- * Normalize the stability.
+ * Clean the wildcard in version.
*
- * @param string $stability The stability.
+ * @param string $version The version.
*
- * @return string The normalized stability.
+ * @return string The cleaned version.
*/
- private static function normalizeStability(string $stability): string
+ private static function cleanWildcard(string $version): string
{
- $stability = strtolower($stability);
+ while (str_contains($version, '.x.x')) {
+ $version = str_replace('.x.x', '.x', $version);
+ }
- return match ($stability) {
- 'a' => 'alpha',
- 'b', 'pre' => 'beta',
- 'build' => 'patch',
- 'rc' => 'RC',
- 'dev', 'snapshot' => 'dev',
- default => VersionParser::normalizeStability($stability),
- };
+ return $version;
+ }
+
+ /**
+ * Convert the minor version of date.
+ *
+ * @param string $minor The minor version.
+ */
+ private static function convertDateMinorVersion(string $minor): string
+ {
+ $split = explode('.', $minor);
+ $minor = (int) $split[0];
+ $revision = isset($split[1]) ? (int) $split[1] : 0;
+
+ return '.' . sprintf('%03d', $minor) . sprintf('%03d', $revision);
}
/**
@@ -163,27 +148,33 @@ private static function matchVersion(string $version, string $type): array
{
$type = match ($type) {
'dev', 'snapshot' => 'dev',
- default => \in_array($type, ['alpha', 'beta', 'RC'], true) ? $type : 'patch',
+ default => in_array($type, ['alpha', 'beta', 'RC'], true) ? $type : 'patch',
};
- $patchVersion = !\in_array($type, ['dev'], true);
-
+ $patchVersion = $type !== 'dev';
$version .= $type;
return [$version, $patchVersion];
}
/**
- * Convert the minor version of date.
+ * Normalize the stability.
*
- * @param string $minor The minor version.
+ * @param string $stability The stability.
+ *
+ * @return string The normalized stability.
*/
- private static function convertDateMinorVersion(string $minor): string
+ private static function normalizeStability(string $stability): string
{
- $split = explode('.', $minor);
- $minor = (int) $split[0];
- $revision = isset($split[1]) ? (int) $split[1] : 0;
+ $stability = strtolower($stability);
- return '.' . sprintf('%03d', $minor) . sprintf('%03d', $revision);
+ return match ($stability) {
+ 'a' => 'alpha',
+ 'b', 'pre' => 'beta',
+ 'build' => 'patch',
+ 'rc' => 'RC',
+ 'dev', 'snapshot' => 'dev',
+ default => VersionParser::normalizeStability($stability),
+ };
}
}
diff --git a/src/Converter/VersionConverterInterface.php b/src/Converter/VersionConverterInterface.php
index 2577f48..c69f895 100644
--- a/src/Converter/VersionConverterInterface.php
+++ b/src/Converter/VersionConverterInterface.php
@@ -2,22 +2,8 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Converter;
-/**
- * Interface for the converter for asset syntax version to composer syntax version.
- *
- * @author François Pluchino
- */
interface VersionConverterInterface
{
/**
diff --git a/src/Event/AbstractSolveEvent.php b/src/Event/AbstractSolveEvent.php
index 162951c..034b94f 100644
--- a/src/Event/AbstractSolveEvent.php
+++ b/src/Event/AbstractSolveEvent.php
@@ -2,25 +2,11 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Event;
use Composer\EventDispatcher\Event;
use Composer\Package\PackageInterface;
-/**
- * Abstract event for solve event.
- *
- * @author François Pluchino
- */
abstract class AbstractSolveEvent extends Event
{
/**
@@ -32,7 +18,7 @@ abstract class AbstractSolveEvent extends Event
*/
public function __construct(string $name, private readonly string $assetDir, private readonly array $packages = [])
{
- parent::__construct($name, [], []);
+ parent::__construct($name);
}
/**
diff --git a/src/Event/GetAssetsEvent.php b/src/Event/GetAssetsEvent.php
index 6054ae3..82028f4 100644
--- a/src/Event/GetAssetsEvent.php
+++ b/src/Event/GetAssetsEvent.php
@@ -2,25 +2,11 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Event;
use Composer\Package\PackageInterface;
use Foxy\FoxyEvents;
-/**
- * Get assets event.
- *
- * @author François Pluchino
- */
final class GetAssetsEvent extends AbstractSolveEvent
{
/**
@@ -33,18 +19,6 @@ final class GetAssetsEvent extends AbstractSolveEvent
public function __construct(string $assetDir, array $packages, private array $assets = [])
{
parent::__construct(FoxyEvents::GET_ASSETS, $assetDir, $packages);
-
- $this->assets = $assets;
- }
-
- /**
- * Check if the asset package is present.
- *
- * @param string $name The asset package name
- */
- public function hasAsset(string $name): bool
- {
- return isset($this->assets[$name]);
}
/**
@@ -57,7 +31,7 @@ public function hasAsset(string $name): bool
*
* For the Composer package `foo/bar`.
*
- * $event->addAsset('@composer-asset/foo--bar', 'file:./vendor/foxy/composer-asset/foo/bar');
+ * $event->addAsset('@composer-asset/foo--bar', 'file:./vendor/php-forge/foxy/composer-asset/foo/bar');
*/
public function addAsset(string $name, string $path): self
{
@@ -73,4 +47,14 @@ public function getAssets(): array
{
return $this->assets;
}
+
+ /**
+ * Check if the asset package is present.
+ *
+ * @param string $name The asset package name
+ */
+ public function hasAsset(string $name): bool
+ {
+ return isset($this->assets[$name]);
+ }
}
diff --git a/src/Event/PostSolveEvent.php b/src/Event/PostSolveEvent.php
index b9b5876..6f03d9e 100644
--- a/src/Event/PostSolveEvent.php
+++ b/src/Event/PostSolveEvent.php
@@ -2,25 +2,11 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Event;
use Composer\Package\PackageInterface;
use Foxy\FoxyEvents;
-/**
- * Post solve event.
- *
- * @author François Pluchino
- */
final class PostSolveEvent extends AbstractSolveEvent
{
/**
@@ -30,7 +16,7 @@ final class PostSolveEvent extends AbstractSolveEvent
*
* @psalm-param PackageInterface[] $packages All installed Composer packages.
*/
- public function __construct($assetDir, array $packages, private readonly int $runResult)
+ public function __construct(string $assetDir, array $packages, private readonly int $runResult)
{
parent::__construct(FoxyEvents::POST_SOLVE, $assetDir, $packages);
}
diff --git a/src/Event/PreSolveEvent.php b/src/Event/PreSolveEvent.php
index 2632be1..f9c6acb 100644
--- a/src/Event/PreSolveEvent.php
+++ b/src/Event/PreSolveEvent.php
@@ -2,25 +2,11 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Event;
use Composer\Package\PackageInterface;
use Foxy\FoxyEvents;
-/**
- * Pre solve event.
- *
- * @author François Pluchino
- */
final class PreSolveEvent extends AbstractSolveEvent
{
/**
diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php
index b3b31b3..7366b1d 100644
--- a/src/Exception/ExceptionInterface.php
+++ b/src/Exception/ExceptionInterface.php
@@ -2,22 +2,6 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Exception;
-/**
- * The interface of exception.
- *
- * @author François Pluchino
- */
-interface ExceptionInterface
-{
-}
+interface ExceptionInterface {}
diff --git a/src/Exception/RuntimeException.php b/src/Exception/RuntimeException.php
index e68f1bf..84c1b0e 100644
--- a/src/Exception/RuntimeException.php
+++ b/src/Exception/RuntimeException.php
@@ -2,22 +2,6 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Exception;
-/**
- * The Runtime Exception.
- *
- * @author François Pluchino
- */
-class RuntimeException extends \RuntimeException implements ExceptionInterface
-{
-}
+class RuntimeException extends \RuntimeException implements ExceptionInterface {}
diff --git a/src/Fallback/AssetFallback.php b/src/Fallback/AssetFallback.php
index e644436..ba2a257 100644
--- a/src/Fallback/AssetFallback.php
+++ b/src/Fallback/AssetFallback.php
@@ -2,56 +2,29 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Fallback;
use Composer\IO\IOInterface;
use Composer\Util\Filesystem;
use Foxy\Config\Config;
use Foxy\Exception\RuntimeException;
+use Throwable;
-/**
- * Asset fallback.
- *
- * @author François Pluchino
- */
final class AssetFallback implements FallbackInterface
{
- protected Filesystem $fs;
- protected string|null $originalContent = null;
+ private readonly Filesystem $fs;
+
+ private string|null $originalContent = null;
public function __construct(
- protected IOInterface $io,
- protected Config $config,
- protected string $path,
- Filesystem|null $fs = null
+ private readonly IOInterface $io,
+ private readonly Config $config,
+ private readonly string $path,
+ Filesystem|null $fs = null,
) {
$this->fs = $fs ?: new Filesystem();
}
- public function save(): self
- {
- if (file_exists($this->path) && is_file($this->path)) {
- $content = file_get_contents($this->path);
-
- if (false === $content) {
- throw new RuntimeException(sprintf('Unable to read fallback asset file "%s".', $this->path));
- }
-
- $this->originalContent = $content;
- }
-
- return $this;
- }
-
public function restore(): void
{
if (!$this->config->get('fallback-asset')) {
@@ -62,11 +35,11 @@ public function restore(): void
try {
$this->fs->remove($this->path);
- } catch (\Throwable $exception) {
+ } catch (Throwable $exception) {
throw new RuntimeException(
sprintf('Unable to remove fallback asset file "%s".', $this->path),
0,
- $exception
+ $exception,
);
}
@@ -78,4 +51,19 @@ public function restore(): void
}
}
}
+
+ public function save(): self
+ {
+ if (file_exists($this->path) && is_file($this->path)) {
+ $content = file_get_contents($this->path);
+
+ if (false === $content) {
+ throw new RuntimeException(sprintf('Unable to read fallback asset file "%s".', $this->path));
+ }
+
+ $this->originalContent = $content;
+ }
+
+ return $this;
+ }
}
diff --git a/src/Fallback/ComposerFallback.php b/src/Fallback/ComposerFallback.php
index aa4a654..7e1ffa5 100644
--- a/src/Fallback/ComposerFallback.php
+++ b/src/Fallback/ComposerFallback.php
@@ -2,38 +2,25 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Fallback;
-use Composer\Composer;
-use Composer\Factory;
+use Composer\{Composer, Factory};
use Composer\Filter\PlatformRequirementFilter\PlatformRequirementFilterFactory;
use Composer\Installer;
use Composer\IO\IOInterface;
use Composer\Util\Filesystem;
+use Exception;
use Foxy\Config\Config;
-use Foxy\Util\ConsoleUtil;
-use Foxy\Util\LockerUtil;
-use Foxy\Util\PackageUtil;
+use Foxy\Util\{ConsoleUtil, LockerUtil, PackageUtil};
+use LogicException;
use Symfony\Component\Console\Input\InputInterface;
-/**
- * Composer fallback.
- *
- * @author François Pluchino
- */
+use function is_array;
+
final class ComposerFallback implements FallbackInterface
{
- protected Filesystem $fs;
- protected array $lock = [];
+ private readonly Filesystem $fs;
+ private array $lock = [];
/**
* @param Composer $composer The composer.
@@ -44,16 +31,38 @@ final class ComposerFallback implements FallbackInterface
* @param Installer|null $installer The installer.
*/
public function __construct(
- protected Composer $composer,
- protected IOInterface $io,
- protected Config $config,
- protected InputInterface $input,
+ private readonly Composer $composer,
+ private readonly IOInterface $io,
+ private readonly Config $config,
+ private readonly InputInterface $input,
Filesystem|null $fs = null,
- protected Installer|null $installer = null
+ private readonly Installer|null $installer = null,
) {
$this->fs = $fs ?: new Filesystem();
}
+ /**
+ * @throws Exception
+ */
+ public function restore(): void
+ {
+ if (!$this->config->get('fallback-composer')) {
+ return;
+ }
+
+ $this->io->write('Fallback to previous state for Composer ');
+ $hasLock = $this->restoreLockData();
+
+ if ($hasLock) {
+ $this->restorePreviousLockFile();
+ } else {
+ /** @var string $vendorDir */
+ $vendorDir = $this->composer->getConfig()->get('vendor-dir');
+
+ $this->fs->remove($vendorDir);
+ }
+ }
+
public function save(): self
{
$rm = $this->composer->getRepositoryManager();
@@ -64,36 +73,36 @@ public function save(): self
try {
$lock = $locker->getLockData();
$this->lock = PackageUtil::loadLockPackages($lock);
- } catch (\LogicException) {
+ } catch (LogicException) {
$this->lock = [];
}
return $this;
}
- public function restore(): void
+ /**
+ * Get the installer.
+ */
+ private function getInstaller(): Installer
{
- if (!$this->config->get('fallback-composer')) {
- return;
- }
-
- $this->io->write('Fallback to previous state for Composer ');
- $hasLock = $this->restoreLockData();
-
- if ($hasLock) {
- $this->restorePreviousLockFile();
- } else {
- /** @var string $vendorDir */
- $vendorDir = $this->composer->getConfig()->get('vendor-dir');
+ return $this->installer ?? Installer::create($this->io, $this->composer);
+ }
- $this->fs->remove($vendorDir);
- }
+ /**
+ * Get the lock value.
+ *
+ * @param string $key The key.
+ * @param mixed $default The default value.
+ */
+ private function getLockValue(string $key, mixed $default = null): mixed
+ {
+ return $this->lock[$key] ?? $default;
}
/**
* Restore the data of lock file.
*/
- protected function restoreLockData(): bool
+ private function restoreLockData(): bool
{
/** @psalm-suppress MixedArgument */
$this->composer->getLocker()->setLockData(
@@ -106,20 +115,22 @@ protected function restoreLockData(): bool
$this->getLockValue('stability-flags', []),
$this->getLockValue('prefer-stable', false),
$this->getLockValue('prefer-lowest', false),
- $this->getLockValue('platform-overrides', [])
+ $this->getLockValue('platform-overrides', []),
);
$isLocked = $this->composer->getLocker()->isLocked();
$lockData = $isLocked ? $this->composer->getLocker()->getLockData() : null;
- $hasPackage = \is_array($lockData) && isset($lockData['packages']) && !empty($lockData['packages']);
+ $hasPackage = is_array($lockData) && isset($lockData['packages']) && !empty($lockData['packages']);
return $isLocked && $hasPackage;
}
/**
* Restore the PHP dependencies with the previous lock file.
+ *
+ * @throws Exception
*/
- protected function restorePreviousLockFile(): void
+ private function restorePreviousLockFile(): void
{
$config = $this->composer->getConfig();
[$preferSource, $preferDist] = ConsoleUtil::getPreferredInstallOptions($config, $this->input);
@@ -148,23 +159,4 @@ protected function restorePreviousLockFile(): void
$dispatcher->setRunScripts(!$this->input->getOption('no-scripts'));
}
-
- /**
- * Get the lock value.
- *
- * @param string $key The key.
- * @param mixed $default The default value.
- */
- private function getLockValue(string $key, mixed $default = null): mixed
- {
- return $this->lock[$key] ?? $default;
- }
-
- /**
- * Get the installer.
- */
- private function getInstaller(): Installer
- {
- return $this->installer ?? Installer::create($this->io, $this->composer);
- }
}
diff --git a/src/Fallback/FallbackInterface.php b/src/Fallback/FallbackInterface.php
index d19b792..9d04a82 100644
--- a/src/Fallback/FallbackInterface.php
+++ b/src/Fallback/FallbackInterface.php
@@ -2,31 +2,17 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Fallback;
-/**
- * Interface of fallback.
- *
- * @author François Pluchino
- */
interface FallbackInterface
{
/**
- * Save the state.
+ * Restore the state.
*/
- public function save(): self;
+ public function restore(): void;
/**
- * Restore the state.
+ * Save the state.
*/
- public function restore(): void;
+ public function save(): self;
}
diff --git a/src/Foxy.php b/src/Foxy.php
index 9ebba5f..d0ac6a3 100644
--- a/src/Foxy.php
+++ b/src/Foxy.php
@@ -2,70 +2,49 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy;
use Composer\Composer;
use Composer\DependencyResolver\Operation\InstallOperation;
use Composer\EventDispatcher\EventSubscriberInterface;
-use Composer\Installer\PackageEvent;
-use Composer\Installer\PackageEvents;
+use Composer\Installer\{PackageEvent, PackageEvents};
use Composer\IO\IOInterface;
use Composer\Plugin\PluginInterface;
-use Composer\Script\Event;
-use Composer\Script\ScriptEvents;
-use Composer\Util\Filesystem;
-use Composer\Util\ProcessExecutor;
-use Foxy\Asset\AbstractAssetManager;
-use Foxy\Asset\AssetManagerFinder;
-use Foxy\Asset\AssetManagerInterface;
-use Foxy\Config\Config;
-use Foxy\Config\ConfigBuilder;
+use Composer\Script\{Event, ScriptEvents};
+use Composer\Util\{Filesystem, ProcessExecutor};
+use Foxy\Asset\{AbstractAssetManager, AssetManagerFinder, AssetManagerInterface};
+use Foxy\Asset\{BunManager, NpmManager, PnpmManager, YarnManager};
+use Foxy\Config\{Config, ConfigBuilder};
use Foxy\Exception\RuntimeException;
-use Foxy\Fallback\AssetFallback;
-use Foxy\Fallback\ComposerFallback;
-use Foxy\Solver\Solver;
-use Foxy\Solver\SolverInterface;
-use Foxy\Util\ComposerUtil;
-use Foxy\Util\ConsoleUtil;
-
-/**
- * Composer plugin.
- *
- * @author François Pluchino
- *
- * @psalm-suppress MissingConstructor
- */
+use Foxy\Fallback\{AssetFallback, ComposerFallback};
+use Foxy\Solver\{Solver, SolverInterface};
+use Foxy\Util\{ComposerUtil, ConsoleUtil};
+use Seld\JsonLint\ParsingException;
+
final class Foxy implements PluginInterface, EventSubscriberInterface
{
final public const REQUIRED_COMPOSER_VERSION = '^2.0.0';
- private Config $config;
- private AssetManagerInterface $assetManager;
+
private AssetFallback $assetFallback;
- private ComposerFallback $composerFallback;
- private SolverInterface $solver;
- private bool $initialized = false;
+
+ private AssetManagerInterface $assetManager;
/**
* The list of the classes of asset managers.
*
* @psalm-var list>
*/
- private static $assetManagers = [
- Asset\BunManager::class,
- Asset\NpmManager::class,
- Asset\PnpmManager::class,
- Asset\YarnManager::class,
+ private static array $assetManagers = [
+ BunManager::class,
+ NpmManager::class,
+ PnpmManager::class,
+ YarnManager::class,
];
+ private ComposerFallback $composerFallback;
+
+ private Config $config;
+
/**
* The default values of config.
*/
@@ -90,16 +69,13 @@ final class Foxy implements PluginInterface, EventSubscriberInterface
'enable-packages' => [],
];
- public static function getSubscribedEvents(): array
- {
- return [
- ComposerUtil::getInitEventName() => [['init', 100]],
- PackageEvents::POST_PACKAGE_INSTALL => [['initOnInstall', 100]],
- ScriptEvents::POST_INSTALL_CMD => [['solveAssets', 100]],
- ScriptEvents::POST_UPDATE_CMD => [['solveAssets', 100]],
- ];
- }
+ private bool $initialized = false;
+
+ private SolverInterface $solver;
+ /**
+ * @throws ParsingException
+ */
public function activate(Composer $composer, IOInterface $io): void
{
ComposerUtil::validateVersion(self::REQUIRED_COMPOSER_VERSION, Composer::VERSION);
@@ -127,23 +103,14 @@ public function deactivate(Composer $composer, IOInterface $io): void
// Do nothing
}
- public function uninstall(Composer $composer, IOInterface $io): void
- {
- // Do nothing
- }
-
- /**
- * Init the plugin just after the first installation.
- *
- * @param PackageEvent $event The package event
- */
- public function initOnInstall(PackageEvent $event): void
+ public static function getSubscribedEvents(): array
{
- $operation = $event->getOperation();
-
- if ($operation instanceof InstallOperation && 'php-forge/foxy' === $operation->getPackage()->getName()) {
- $this->init();
- }
+ return [
+ ComposerUtil::getInitEventName() => [['init', 100]],
+ PackageEvents::POST_PACKAGE_INSTALL => [['initOnInstall', 100]],
+ ScriptEvents::POST_INSTALL_CMD => [['solveAssets', 100]],
+ ScriptEvents::POST_UPDATE_CMD => [['solveAssets', 100]],
+ ];
}
/**
@@ -162,6 +129,20 @@ public function init(): void
}
}
+ /**
+ * Init the plugin just after the first installation.
+ *
+ * @param PackageEvent $event The package event
+ */
+ public function initOnInstall(PackageEvent $event): void
+ {
+ $operation = $event->getOperation();
+
+ if ($operation instanceof InstallOperation && 'php-forge/foxy' === $operation->getPackage()->getName()) {
+ $this->init();
+ }
+ }
+
/**
* Set the solver.
*
@@ -183,6 +164,11 @@ public function solveAssets(Event $event): void
$this->solver->solve($event->getComposer(), $event->getIO());
}
+ public function uninstall(Composer $composer, IOInterface $io): void
+ {
+ // Do nothing
+ }
+
/**
* Get the asset manager.
*
@@ -193,11 +179,11 @@ public function solveAssets(Event $event): void
*
* @throws RuntimeException When the asset manager is not found.
*/
- protected function getAssetManager(
+ private function getAssetManager(
IOInterface $io,
Config $config,
ProcessExecutor $executor,
- Filesystem $fs
+ Filesystem $fs,
): AssetManagerInterface {
$amf = new AssetManagerFinder();
diff --git a/src/FoxyEvents.php b/src/FoxyEvents.php
index 898fcb3..fbc172d 100644
--- a/src/FoxyEvents.php
+++ b/src/FoxyEvents.php
@@ -2,31 +2,10 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy;
-/**
- * Events of Foxy.
- *
- * @author François Pluchino
- */
abstract class FoxyEvents
{
- /**
- * The "PRE_SOLVE" event is triggered before the `solve` action of asset packages.
- *
- * @Event("Foxy\Event\PreSolveEvent")
- */
- final public const PRE_SOLVE = 'foxy.pre-solve';
-
/**
* The "GET_ASSETS" event is triggered before the `solve` action of asset packages
* and during the retrieves the map of the asset packages.
@@ -42,4 +21,11 @@ abstract class FoxyEvents
* @Event("Foxy\Event\PostSolveEvent")
*/
final public const POST_SOLVE = 'foxy.post-solve';
+
+ /**
+ * The "PRE_SOLVE" event is triggered before the `solve` action of asset packages.
+ *
+ * @Event("Foxy\Event\PreSolveEvent")
+ */
+ final public const PRE_SOLVE = 'foxy.pre-solve';
}
diff --git a/src/Json/JsonFile.php b/src/Json/JsonFile.php
index 07cb210..dfbc914 100644
--- a/src/Json/JsonFile.php
+++ b/src/Json/JsonFile.php
@@ -2,37 +2,33 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Json;
use Foxy\Exception\RuntimeException;
-/**
- * The JSON file.
- *
- * @author François Pluchino
- */
final class JsonFile extends \Composer\Json\JsonFile
{
/**
* @psalm-var string[]
*/
private array $arrayKeys = [];
- private int|null $indent = null;
+
/**
* @psalm-var string[]
*/
private static array $encodeArrayKeys = [];
+
private static int $encodeIndent = JsonFormatter::DEFAULT_INDENT;
+ private int|null $indent = null;
+
+ public static function encode(mixed $data, int $options = 448, string $indent = self::INDENT_DEFAULT): string
+ {
+ $result = parent::encode($data, $options);
+
+ return JsonFormatter::format($result, self::$encodeArrayKeys, self::$encodeIndent, false);
+ }
+
/**
* Get the list of keys to be retained with an array representation if they are empty.
*
@@ -48,7 +44,7 @@ public function getArrayKeys(): array
}
/**
- * Get the indent for this json file.
+ * Get the indent for this JSON file.
*/
public function getIndent(): int
{
@@ -72,19 +68,15 @@ public function read(): array
public function write(array $hash, int $options = 448): void
{
self::$encodeArrayKeys = $this->getArrayKeys();
+
self::$encodeIndent = JsonFormatter::DEFAULT_INDENT;
+
parent::write($hash, $options);
+
self::$encodeArrayKeys = [];
self::$encodeIndent = JsonFormatter::DEFAULT_INDENT;
}
- public static function encode(mixed $data, int $options = 448, string $indent = self::INDENT_DEFAULT): string
- {
- $result = parent::encode($data, $options, self::INDENT_DEFAULT);
-
- return JsonFormatter::format($result, self::$encodeArrayKeys, self::$encodeIndent, false);
- }
-
/**
* Parse the original content.
*/
@@ -100,6 +92,7 @@ private function parseOriginalContent(): void
throw new RuntimeException(sprintf('Unable to read json file "%s".', $path));
}
}
+
$this->arrayKeys = JsonFormatter::getArrayKeys($content);
$this->indent = JsonFormatter::getIndent($content);
}
diff --git a/src/Json/JsonFormatter.php b/src/Json/JsonFormatter.php
index 42197cb..8defa30 100644
--- a/src/Json/JsonFormatter.php
+++ b/src/Json/JsonFormatter.php
@@ -2,28 +2,63 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Json;
-/**
- * Formats JSON strings with a custom indent.
- *
- * @author François Pluchino
- */
+use JsonException;
+
+use function array_walk_recursive;
+use function in_array;
+use function is_string;
+use function json_decode;
+use function json_encode;
+use function mb_convert_encoding;
+use function pack;
+use function preg_match;
+use function preg_match_all;
+use function preg_replace;
+use function preg_replace_callback;
+use function str_repeat;
+use function str_replace;
+use function strlen;
+use function trim;
+
final class JsonFormatter
{
- public const DEFAULT_INDENT = 4;
public const ARRAY_KEYS_REGEX = '/["\']([\w\d_\-.]+)["\']\s*:\s*\[\s*\]/';
+
+ public const DEFAULT_INDENT = 4;
+
public const INDENT_REGEX = '/^[{\[][\r\n]([ ]+)["\']/';
+ /**
+ * Format the data in JSON.
+ *
+ * @param string $json The original JSON.
+ * @param array $arrayKeys The list of keys to be retained with an array representation if they are empty.
+ * @param int $indent The space count for indent.
+ * @param bool $formatJson Check if the JSON must be formatted.
+ *
+ * @psalm-param string[] $arrayKeys The list of keys to be retained with an array representation if they are empty.
+ *
+ * @throws JsonException
+ */
+ public static function format(
+ string $json,
+ array $arrayKeys = [],
+ int $indent = self::DEFAULT_INDENT,
+ bool $formatJson = true,
+ ): string {
+ if ($formatJson) {
+ $json = self::formatInternal($json, true, true);
+ }
+
+ if (4 !== $indent) {
+ $json = str_replace(' ', str_repeat(' ', $indent), $json);
+ }
+
+ return self::replaceArrayByMap($json, $arrayKeys);
+ }
+
/**
* Get the list of keys to be retained with an array representation if they are empty.
*
@@ -46,63 +81,38 @@ public static function getArrayKeys(string $content): array
public static function getIndent(string $content): int
{
$indent = self::DEFAULT_INDENT;
- \preg_match(self::INDENT_REGEX, \trim($content), $matches);
+ preg_match(self::INDENT_REGEX, trim($content), $matches);
if (!empty($matches)) {
- $indent = \strlen($matches[1]);
+ $indent = strlen($matches[1]);
}
return $indent;
}
- /**
- * Format the data in JSON.
- *
- * @param string $json The original JSON.
- * @param array $arrayKeys The list of keys to be retained with an array representation if they are empty.
- * @param int $indent The space count for indent.
- * @param bool $formatJson Check if the json must be formatted.
- *
- * @psalm-param string[] $arrayKeys The list of keys to be retained with an array representation if they are empty.
- */
- public static function format(
- string $json,
- array $arrayKeys = [],
- $indent = self::DEFAULT_INDENT,
- $formatJson = true
- ): string {
- if ($formatJson) {
- $json = self::formatInternal($json, true, true);
- }
-
- if (4 !== $indent) {
- $json = \str_replace(' ', \str_repeat(' ', $indent), $json);
- }
-
- return self::replaceArrayByMap($json, $arrayKeys);
- }
-
/**
* Format the data in JSON.
*
* @param bool $unescapeUnicode Un escape unicode.
* @param bool $unescapeSlashes Un escape slashes.
+ *
+ * @throws JsonException
*/
private static function formatInternal(string $json, bool $unescapeUnicode, bool $unescapeSlashes): string
{
- $array = \json_decode($json, true);
-
- if (!is_array($array)) {
+ if ($json === '') {
return $json;
}
+ $array = json_decode($json, true, 512, JSON_THROW_ON_ERROR);
+
if ($unescapeUnicode) {
- \array_walk_recursive($array, function (mixed &$item): void {
- if (\is_string($item)) {
- $item = \preg_replace_callback(
+ array_walk_recursive($array, static function (mixed &$item): void {
+ if (is_string($item)) {
+ $item = preg_replace_callback(
'/\\\\u([0-9a-fA-F]{4})/',
- static function (mixed $match) {
- $result = \mb_convert_encoding(\pack('H*', $match[1]), 'UTF-8', 'UCS-2BE');
+ static function (mixed $match): string|array {
+ $result = mb_convert_encoding(pack('H*', $match[1]), 'UTF-8', 'UCS-2BE');
return $result !== false ? $result : '';
},
$item,
@@ -112,14 +122,14 @@ static function (mixed $match) {
}
if ($unescapeSlashes) {
- \array_walk_recursive($array, function (mixed &$item): void {
- if (\is_string($item)) {
- $item = \str_replace('\\/', '/', $item);
+ array_walk_recursive($array, static function (mixed &$item): void {
+ if (is_string($item)) {
+ $item = str_replace('\\/', '/', $item);
}
});
}
- return \json_encode($array, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
+ return json_encode($array, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
}
/**
@@ -132,13 +142,13 @@ static function (mixed $match) {
*/
private static function replaceArrayByMap(string $json, array $arrayKeys): string
{
- \preg_match_all(self::ARRAY_KEYS_REGEX, $json, $matches, PREG_SET_ORDER);
+ preg_match_all(self::ARRAY_KEYS_REGEX, $json, $matches, PREG_SET_ORDER);
foreach ($matches as $match) {
- if (!\in_array($match[1], $arrayKeys, true)) {
- $replace = \preg_replace('/\[\s*\]/', '{}', $match[0]);
+ if (!in_array($match[1], $arrayKeys, true)) {
+ $replace = preg_replace('/\[\s*\]/', '{}', $match[0]);
if (null !== $replace) {
- $json = \str_replace($match[0], $replace, $json);
+ $json = str_replace($match[0], $replace, $json);
}
}
}
diff --git a/src/Solver/Solver.php b/src/Solver/Solver.php
index 6e0d4e8..24a69ea 100644
--- a/src/Solver/Solver.php
+++ b/src/Solver/Solver.php
@@ -2,15 +2,6 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Solver;
use Composer\Composer;
@@ -18,20 +9,20 @@
use Composer\Json\JsonFile;
use Composer\Package\PackageInterface;
use Composer\Util\Filesystem;
+use Exception;
use Foxy\Asset\AssetManagerInterface;
use Foxy\Config\Config;
-use Foxy\Event\GetAssetsEvent;
-use Foxy\Event\PostSolveEvent;
-use Foxy\Event\PreSolveEvent;
+use Foxy\Event\{GetAssetsEvent, PostSolveEvent, PreSolveEvent};
+use Foxy\Exception\RuntimeException;
use Foxy\Fallback\FallbackInterface;
use Foxy\FoxyEvents;
use Foxy\Util\AssetUtil;
-/**
- * Solver of asset dependencies.
- *
- * @author François Pluchino
- */
+use function basename;
+use function copy;
+use function mkdir;
+use function rtrim;
+
final class Solver implements SolverInterface
{
/**
@@ -40,12 +31,11 @@ final class Solver implements SolverInterface
* @param FallbackInterface|null $composerFallback The composer fallback instance.
*/
public function __construct(
- protected AssetManagerInterface $assetManager,
- protected Config $config,
- protected Filesystem $fs,
- protected FallbackInterface|null $composerFallback = null
- ) {
- }
+ private readonly AssetManagerInterface $assetManager,
+ private readonly Config $config,
+ private readonly Filesystem $fs,
+ private readonly FallbackInterface|null $composerFallback = null,
+ ) {}
public function setUpdatable($updatable): self
{
@@ -54,6 +44,9 @@ public function setUpdatable($updatable): self
return $this;
}
+ /**
+ * @throws Exception
+ */
public function solve(Composer $composer, IOInterface $io): void
{
if (!$this->config->get('enabled')) {
@@ -76,20 +69,22 @@ public function solve(Composer $composer, IOInterface $io): void
if ($res > 0 && $this->composerFallback) {
$this->composerFallback->restore();
- throw new \RuntimeException('The asset manager ended with an error');
+ throw new RuntimeException('The asset manager ended with an error');
}
}
/**
* Get the package of asset dependencies.
*
- * @param Composer $composer The composer instance.
+ * @param Composer $composer The composer instance.
* @param string $assetDir The asset directory.
* @param array $packages The package dependencies.
*
* @psalm-param PackageInterface[] $packages The package dependencies.
+ *
+ * @throws Exception
*/
- protected function getAssets(Composer $composer, string $assetDir, array $packages): array
+ private function getAssets(Composer $composer, string $assetDir, array $packages): array
{
$installationManager = $composer->getInstallationManager();
$configPackages = $this->config->getArray('enable-packages');
@@ -118,15 +113,17 @@ protected function getAssets(Composer $composer, string $assetDir, array $packag
* @param string $filename The filename of asset package.
*
* @psalm-return string[] The package name and the relative package path from the current directory
+ *
+ * @throws Exception
*/
- protected function getMockPackagePath(PackageInterface $package, string $assetDir, string $filename): array
+ private function getMockPackagePath(PackageInterface $package, string $assetDir, string $filename): array
{
$packageName = AssetUtil::getName($package);
- $packagePath = \rtrim($assetDir, '/') . '/' . $package->getName();
- $newFilename = $packagePath . '/' . \basename($filename);
+ $packagePath = rtrim($assetDir, '/') . '/' . $package->getName();
+ $newFilename = $packagePath . '/' . basename($filename);
- \mkdir($packagePath, 0777, true);
- \copy($filename, $newFilename);
+ mkdir($packagePath, 0777, true);
+ copy($filename, $newFilename);
$jsonFile = new JsonFile($newFilename);
$packageValue = AssetUtil::formatPackage($package, $packageName, (array) $jsonFile->read());
diff --git a/src/Solver/SolverInterface.php b/src/Solver/SolverInterface.php
index 49f2670..cc47ef8 100644
--- a/src/Solver/SolverInterface.php
+++ b/src/Solver/SolverInterface.php
@@ -2,25 +2,11 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Solver;
use Composer\Composer;
use Composer\IO\IOInterface;
-/**
- * Interface of solver.
- *
- * @author François Pluchino
- */
interface SolverInterface
{
/**
diff --git a/src/Util/AssetUtil.php b/src/Util/AssetUtil.php
index f835992..7a97570 100644
--- a/src/Util/AssetUtil.php
+++ b/src/Util/AssetUtil.php
@@ -2,15 +2,6 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Util;
use Composer\Installer\InstallationManager;
@@ -18,14 +9,47 @@
use Composer\Package\PackageInterface;
use Foxy\Asset\AssetManagerInterface;
use Foxy\Asset\AssetPackage;
+use JsonException;
+
+use function count;
+use function explode;
+use function file_exists;
+use function file_get_contents;
+use function fnmatch;
+use function is_int;
+use function is_string;
+use function json_decode;
+use function preg_match;
+use function realpath;
+use function str_replace;
-/**
- * Helper for Foxy.
- *
- * @author François Pluchino
- */
final class AssetUtil
{
+ /**
+ * Format the asset package.
+ *
+ * @param PackageInterface $package The composer package instance.
+ * @param string $packageName The package name of asset.
+ * @param array $packageValue The package value of asset.
+ */
+ public static function formatPackage(PackageInterface $package, string $packageName, array $packageValue): array
+ {
+ $packageValue['name'] = $packageName;
+
+ if (!isset($packageValue['version'])) {
+ $extra = $package->getExtra();
+ $version = $package->getPrettyVersion();
+
+ if (str_starts_with($version, 'dev-') && isset($extra['branch-alias'][$version])) {
+ $version = $extra['branch-alias'][$version];
+ }
+
+ $packageValue['version'] = self::formatVersion(str_replace('-dev', '', (string) $version));
+ }
+
+ return $packageValue;
+ }
+
/**
* Get the name for the asset dependency.
*
@@ -33,7 +57,7 @@ final class AssetUtil
*/
public static function getName(PackageInterface $package): string
{
- return AssetPackage::COMPOSER_PREFIX . \str_replace(['/'], '--', $package->getName());
+ return AssetPackage::COMPOSER_PREFIX . str_replace(['/'], '--', $package->getName());
}
/**
@@ -43,12 +67,14 @@ public static function getName(PackageInterface $package): string
* @param AssetManagerInterface $assetManager The asset manager.
* @param PackageInterface $package The package instance.
* @param array $configPackages The packages defined in config.
+ *
+ * @throws JsonException
*/
public static function getPath(
InstallationManager $installationManager,
AssetManagerInterface $assetManager,
PackageInterface $package,
- array $configPackages = []
+ array $configPackages = [],
): string|null {
$path = null;
@@ -61,12 +87,12 @@ public static function getPath(
$composerJsonPath = $installPath . '/composer.json';
}
- if (null !== $composerJsonPath && \file_exists($composerJsonPath)) {
+ if (null !== $composerJsonPath && file_exists($composerJsonPath)) {
/** @var array[] $composerJson */
- $composerJson = \json_decode(\file_get_contents($composerJsonPath), true);
+ $composerJson = json_decode(file_get_contents($composerJsonPath), true, 512, JSON_THROW_ON_ERROR);
$rootPackageDir = $composerJson['config']['foxy']['root-package-json-dir'] ?? null;
- if (null !== $installPath && \is_string($rootPackageDir)) {
+ if (null !== $installPath && is_string($rootPackageDir)) {
$installPath .= '/' . $rootPackageDir;
}
}
@@ -74,30 +100,13 @@ public static function getPath(
if (null !== $installPath) {
$filename = $installPath . '/' . $assetManager->getPackageName();
- $path = \file_exists($filename) ? \str_replace('\\', '/', \realpath($filename)) : null;
+ $path = file_exists($filename) ? str_replace('\\', '/', realpath($filename)) : null;
}
}
return $path;
}
- /**
- * Check if the package is available for Foxy.
- *
- * @param PackageInterface $package The package instance.
- * @param array $configPackages The packages defined in config.
- */
- public static function isAsset(PackageInterface $package, array $configPackages = []): bool
- {
- $projectConfig = self::getProjectActivation($package, $configPackages);
- $enabled = false !== $projectConfig;
-
- return $enabled && (self::hasExtraActivation($package)
- || self::hasPluginDependency($package->getRequires())
- || self::hasPluginDependency($package->getDevRequires())
- || true === $projectConfig);
- }
-
/**
* Check if foxy is enabled in extra section of package.
*
@@ -113,9 +122,9 @@ public static function hasExtraActivation(PackageInterface $package): bool
/**
* Check if the package contains assets.
*
- * @param Link[] $requires The require links.
+ * @param Link[] $requires The requirement links.
*
- * @psalm-param Link[] $requires The require links.
+ * @psalm-param Link[] $requires The requirement links.
*/
public static function hasPluginDependency(array $requires): bool
{
@@ -133,39 +142,31 @@ public static function hasPluginDependency(array $requires): bool
}
/**
- * Check if the package is enabled by the project config.
+ * Check if the package is available for Foxy.
*
* @param PackageInterface $package The package instance.
* @param array $configPackages The packages defined in config.
*/
- public static function isProjectActivation(PackageInterface $package, array $configPackages): bool
+ public static function isAsset(PackageInterface $package, array $configPackages = []): bool
{
- return true === self::getProjectActivation($package, $configPackages);
+ $projectConfig = self::getProjectActivation($package, $configPackages);
+ $enabled = false !== $projectConfig;
+
+ return $enabled && (self::hasExtraActivation($package)
+ || self::hasPluginDependency($package->getRequires())
+ || self::hasPluginDependency($package->getDevRequires())
+ || true === $projectConfig);
}
/**
- * Format the asset package.
+ * Check if the package is enabled by the project config.
*
- * @param PackageInterface $package The composer package instance.
- * @param string $packageName The package name of asset.
- * @param array $packageValue The package value of asset.
+ * @param PackageInterface $package The package instance.
+ * @param array $configPackages The packages defined in config.
*/
- public static function formatPackage(PackageInterface $package, string $packageName, array $packageValue): array
+ public static function isProjectActivation(PackageInterface $package, array $configPackages): bool
{
- $packageValue['name'] = $packageName;
-
- if (!isset($packageValue['version'])) {
- $extra = $package->getExtra();
- $version = $package->getPrettyVersion();
-
- if (str_starts_with($version, 'dev-') && isset($extra['branch-alias'][$version])) {
- $version = $extra['branch-alias'][$version];
- }
-
- $packageValue['version'] = self::formatVersion(\str_replace('-dev', '', (string) $version));
- }
-
- return $packageValue;
+ return true === self::getProjectActivation($package, $configPackages);
}
/**
@@ -175,10 +176,10 @@ public static function formatPackage(PackageInterface $package, string $packageN
*/
private static function formatVersion(string $version): string
{
- $version = \str_replace(['x', 'X', '*'], '0', $version);
- $exp = \explode('.', $version);
+ $version = str_replace(['x', 'X', '*'], '0', $version);
+ $exp = explode('.', $version);
- if (($size = \count($exp)) < 3) {
+ if (($size = count($exp)) < 3) {
for ($i = $size; $i < 3; ++$i) {
$exp[] = '0';
}
@@ -204,14 +205,14 @@ private static function getProjectActivation(PackageInterface $package, array $c
* @var array $configPackages
*/
foreach ($configPackages as $pattern => $activation) {
- if (\is_int($pattern) && \is_string($activation)) {
+ if (is_int($pattern) && is_string($activation)) {
$pattern = $activation;
$activation = true;
}
if (
- \is_string($pattern) &&
- ((str_starts_with($pattern, '/') && \preg_match($pattern, $name)) || \fnmatch($pattern, $name))
+ is_string($pattern)
+ && ((str_starts_with($pattern, '/') && preg_match($pattern, $name)) || fnmatch($pattern, $name))
) {
$value = $activation;
diff --git a/src/Util/ComposerUtil.php b/src/Util/ComposerUtil.php
index 499110e..db088ad 100644
--- a/src/Util/ComposerUtil.php
+++ b/src/Util/ComposerUtil.php
@@ -2,26 +2,12 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Util;
use Composer\Installer\InstallerEvents;
use Composer\Semver\Semver;
use Foxy\Exception\RuntimeException;
-/**
- * Helper for Composer.
- *
- * @author François Pluchino
- */
final class ComposerUtil
{
/**
diff --git a/src/Util/ConsoleUtil.php b/src/Util/ConsoleUtil.php
index 4342b7c..131dc7e 100644
--- a/src/Util/ConsoleUtil.php
+++ b/src/Util/ConsoleUtil.php
@@ -2,23 +2,12 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Util;
use Composer\Config;
use Composer\IO\IOInterface;
-use Symfony\Component\Console\Input\ArgvInput;
-use Symfony\Component\Console\Input\InputInterface;
-
-use const PHP_VERSION_ID;
+use ReflectionClass;
+use Symfony\Component\Console\Input\{ArgvInput, InputInterface};
/**
* Helper for console.
@@ -34,15 +23,10 @@ final class ConsoleUtil
*/
public static function getInput(IOInterface $io): InputInterface
{
- $ref = new \ReflectionClass($io);
+ $ref = new ReflectionClass($io);
if ($ref->hasProperty('input')) {
$prop = $ref->getProperty('input');
-
- if (PHP_VERSION_ID < 80500) {
- $prop->setAccessible(true);
- }
-
$input = $prop->getValue($io);
if ($input instanceof InputInterface) {
diff --git a/src/Util/LockerUtil.php b/src/Util/LockerUtil.php
index bb07974..2f154f3 100644
--- a/src/Util/LockerUtil.php
+++ b/src/Util/LockerUtil.php
@@ -2,15 +2,6 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Util;
use Composer\Installer\InstallationManager;
@@ -18,11 +9,6 @@
use Composer\Json\JsonFile;
use Composer\Package\Locker;
-/**
- * Helper for Locker.
- *
- * @author François Pluchino
- */
final class LockerUtil
{
/**
@@ -31,7 +17,7 @@ final class LockerUtil
public static function getLocker(
IOInterface $io,
InstallationManager $im,
- string $composerFile
+ string $composerFile,
): Locker {
$lockFile = str_replace('.json', '.lock', $composerFile);
diff --git a/src/Util/PackageUtil.php b/src/Util/PackageUtil.php
index 5adc2e9..a337d91 100644
--- a/src/Util/PackageUtil.php
+++ b/src/Util/PackageUtil.php
@@ -2,40 +2,45 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Util;
use Composer\Package\AliasPackage;
use Composer\Package\Loader\ArrayLoader;
-/**
- * Helper for package.
- *
- * @author François Pluchino
- */
final class PackageUtil
{
/**
- * Load all packages in the lock data of locker.
+ * Convert the package aliases of the locker load data.
*
* @param array $lockData The lock data of locker.
*
* @return array The lock data.
*/
- public static function loadLockPackages(array $lockData): array
+ public static function convertLockAlias(array $lockData): array
{
- $loader = new ArrayLoader();
- $lockData = self::loadLockPackage($loader, $lockData);
- $lockData = self::loadLockPackage($loader, $lockData, true);
- return self::convertLockAlias($lockData);
+ $loadDatawithaliases = $lockData['aliases'] ?? [];
+
+ if ($loadDatawithaliases === []) {
+ return $lockData;
+ }
+
+ $alias = [];
+
+ /**
+ * @psalm-var array{
+ * array{alias: string, alias_normalized: string, version: string, package: string}
+ * } $loadDatawithaliases
+ */
+ foreach ($loadDatawithaliases as $config) {
+ $alias[$config['package']][$config['version']] = [
+ 'alias' => $config['alias'],
+ 'alias_normalized' => $config['alias_normalized'],
+ ];
+ }
+
+ $lockData['aliases'] = $alias;
+
+ return $lockData;
}
/**
@@ -72,36 +77,17 @@ public static function loadLockPackage(ArrayLoader $loader, array $lockData, boo
}
/**
- * Convert the package aliases of the locker load data.
+ * Load all packages in the lock data of locker.
*
* @param array $lockData The lock data of locker.
*
* @return array The lock data.
*/
- public static function convertLockAlias(array $lockData): array
+ public static function loadLockPackages(array $lockData): array
{
- $loadDatawithaliases = $lockData['aliases'] ?? [];
-
- if ($loadDatawithaliases === []) {
- return $lockData;
- }
-
- $alias = [];
-
- /**
- * @psalm-var array{
- * array{alias: string, alias_normalized: string, version: string, package: string}
- * } $loadDatawithaliases
- */
- foreach ($loadDatawithaliases as $config) {
- $alias[$config['package']][$config['version']] = [
- 'alias' => $config['alias'],
- 'alias_normalized' => $config['alias_normalized'],
- ];
- }
-
- $lockData['aliases'] = $alias;
-
- return $lockData;
+ $loader = new ArrayLoader();
+ $lockData = self::loadLockPackage($loader, $lockData);
+ $lockData = self::loadLockPackage($loader, $lockData, true);
+ return self::convertLockAlias($lockData);
}
}
diff --git a/tests/Asset/AssetManager.php b/tests/Asset/AssetManager.php
index 1efdcc5..bc5ea0b 100644
--- a/tests/Asset/AssetManager.php
+++ b/tests/Asset/AssetManager.php
@@ -2,200 +2,69 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Asset;
use Composer\IO\IOInterface;
use Composer\Json\JsonFile;
use Composer\Package\RootPackageInterface;
-use Composer\Util\Filesystem;
-use Composer\Util\ProcessExecutor;
-use Foxy\Asset\AbstractAssetManager;
-use Foxy\Asset\AssetManagerInterface;
+use Composer\Util\{Filesystem, ProcessExecutor};
+use Foxy\Asset\{AbstractAssetManager, AssetManagerInterface, AssetPackageInterface};
use Foxy\Config\Config;
+use Foxy\Exception\RuntimeException;
use Foxy\Fallback\FallbackInterface;
-use Foxy\Tests\Fixtures\Util\ProcessExecutorMock;
-use Foxy\Tests\Fixtures\Util\ThrowingProcessExecutorMock;
+use Foxy\Tests\Fixtures\Util\{ProcessExecutorMock, ThrowingProcessExecutorMock};
use PHPUnit\Framework\Attributes\RequiresOperatingSystemFamily;
-use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\MockObject\{Exception, MockObject};
+use PHPUnit\Framework\TestCase;
use Xepozz\InternalMocker\MockerState;
+use function chdir;
use function file_get_contents;
use function file_put_contents;
+use function getcwd;
use const DIRECTORY_SEPARATOR;
-/**
- * Abstract class for asset manager tests.
- *
- * @author François Pluchino
- */
-abstract class AssetManager extends \PHPUnit\Framework\TestCase
+abstract class AssetManager extends TestCase
{
protected Config|null $config = null;
- protected IOInterface|null $io = null;
- protected ProcessExecutorMock|ThrowingProcessExecutorMock|null $executor = null;
- protected Filesystem|MockObject|null $fs = null;
- protected \Symfony\Component\Filesystem\Filesystem|null $sfs = null;
- protected FallbackInterface|MockObject|null $fallback = null;
- protected AssetManagerInterface|null $manager = null;
- protected string|null $oldCwd = '';
- protected string|null $cwd = '';
-
- protected function setUp(): void
- {
- parent::setUp();
-
- $this->config = new Config([]);
- $this->io = $this->createMock(IOInterface::class);
- $this->executor = new ProcessExecutorMock($this->io);
- $this->fs = $this->createMock(Filesystem::class);
- $this->sfs = new \Symfony\Component\Filesystem\Filesystem();
- $this->fallback = $this->createMock(FallbackInterface::class);
- $this->manager = $this->getManager();
- $this->oldCwd = getcwd();
- $this->cwd = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('foxy_asset_manager_test_', true);
- $this->sfs->mkdir($this->cwd);
-
- \chdir($this->cwd);
- }
- protected function tearDown(): void
- {
- parent::tearDown();
-
- \chdir($this->oldCwd);
-
- $this->sfs->remove($this->cwd);
- $this->config = null;
- $this->io = null;
- $this->executor = null;
- $this->fs = null;
- $this->sfs = null;
- $this->fallback = null;
- $this->manager = null;
- $this->oldCwd = null;
- $this->cwd = null;
- }
-
- public function testGetName(): void
- {
- $this->assertSame($this->getValidName(), $this->manager->getName());
- }
-
- public function testGetLockPackageName(): void
- {
- $this->assertSame($this->getValidLockPackageName(), $this->manager->getLockPackageName());
- }
-
- public function testGetPackageName(): void
- {
- $this->assertSame('package.json', $this->manager->getPackageName());
- }
-
- public function testHasLockFile(): void
- {
- $this->assertFalse($this->manager->hasLockFile());
- }
-
- public function testHasLockFileWithRootPackageDirAsRoot(): void
- {
- $this->config = new Config([], ['root-package-json-dir' => DIRECTORY_SEPARATOR]);
- $this->manager = $this->getManager();
-
- MockerState::addCondition('Foxy\\Asset', 'getcwd', [], $this->cwd);
-
- $this->assertInstanceOf(AbstractAssetManager::class, $this->manager);
- /** @var AbstractAssetManager $manager */
- $manager = $this->manager;
-
- $this->assertSame(
- DIRECTORY_SEPARATOR . $manager->getPackageName(),
- $manager->getPackageJsonPath()
- );
- $this->assertFalse($this->manager->hasLockFile());
- }
-
- #[RequiresOperatingSystemFamily('Windows')]
- public function testGetPackageJsonPathWithWindowsRootPackageDir(): void
- {
- $this->config = new Config([], ['root-package-json-dir' => 'C:\\']);
- $this->manager = $this->getManager();
-
- $this->assertInstanceOf(AbstractAssetManager::class, $this->manager);
- /** @var AbstractAssetManager $manager */
- $manager = $this->manager;
-
- $this->assertSame('C:\\package.json', $manager->getPackageJsonPath());
- }
+ protected string|null $cwd = '';
- public function testIsInstalled(): void
- {
- $this->assertFalse($this->manager->isInstalled());
- }
+ protected ProcessExecutorMock|ThrowingProcessExecutorMock|null $executor = null;
- public function testIsUpdatable(): void
- {
- $this->assertFalse($this->manager->isUpdatable());
- }
+ protected FallbackInterface|MockObject|null $fallback = null;
- public function testSetUpdatable(): void
- {
- $res = $this->manager->setUpdatable(false);
+ protected Filesystem|MockObject|null $fs = null;
- $this->assertInstanceOf(AssetManagerInterface::class, $res);
- }
+ protected IOInterface|null $io = null;
- public function testValidateWithoutInstalledManager(): void
- {
- $this->expectException(\Foxy\Exception\RuntimeException::class);
- $this->expectExceptionMessageMatches('/The binary of "(\w+)" must be installed/');
+ protected AssetManagerInterface|null $manager = null;
- $this->manager->validate();
- }
+ protected string|null $oldCwd = '';
- public function testValidateWithInstalledManagerAndWithoutValidVersion(): void
- {
- $this->expectException(\Foxy\Exception\RuntimeException::class);
- $this->expectExceptionMessageMatches(
- '/The installed (\w+) version "42.0.0" doesn\'t match with the constraint version ">=50.0"/'
- );
+ protected \Symfony\Component\Filesystem\Filesystem|null $sfs = null;
- $this->config = new Config([], ['manager-version' => '>=50.0']);
- $this->manager = $this->getManager();
+ abstract protected function getManager(): AssetManagerInterface;
- $this->executor->addExpectedValues(0, '42.0.0');
+ abstract protected function getValidInstallCommand(): string;
- $this->manager->validate();
- }
+ abstract protected function getValidLockPackageName(): string;
- public function testValidateWithInstalledManagerAndWithValidVersion(): void
- {
- $this->config = new Config([], ['manager-version' => '>=41.0']);
- $this->manager = $this->getManager();
+ abstract protected function getValidName(): string;
- $this->executor->addExpectedValues(0, '42.0.0');
+ abstract protected function getValidUpdateCommand(): string;
- $this->manager->validate();
- $this->assertSame('>=41.0', $this->config->get('manager-version'));
- }
+ abstract protected function getValidVersionCommand(): string;
- public function testValidateWithInstalledManagerAndWithoutValidationVersion(): void
+ public static function getRunData(): array
{
- $this->executor->addExpectedValues(0, '42.0.0');
-
- $this->manager->validate();
- $this->assertNull($this->config->get('manager-version'));
+ return [[0, 'install'], [0, 'update'], [1, 'install'], [1, 'update']];
}
+ /**
+ * @throws Exception
+ */
public function testAddDependenciesForInstallCommand(): void
{
$expectedPackage = [
@@ -209,21 +78,31 @@ public function testAddDependenciesForInstallCommand(): void
'@composer-asset/new--dependency' => 'path/new/dependency/package.json',
];
- /** @var MockObject|RootPackageInterface $rootPackage */
$rootPackage = $this->createMock(RootPackageInterface::class);
+ $rootPackage->expects(self::any())->method('getLicense')->willReturn([]);
- $rootPackage->expects($this->any())->method('getLicense')->willReturn([]);
-
- $this->assertFalse($this->manager->isInstalled());
- $this->assertFalse($this->manager->isUpdatable());
+ self::assertFalse(
+ $this->manager->isInstalled(),
+ );
+ self::assertFalse(
+ $this->manager->isUpdatable(),
+ );
$assetPackage = $this->manager->addDependencies($rootPackage, $allDependencies);
- $this->assertInstanceOf(\Foxy\Asset\AssetPackageInterface::class, $assetPackage);
-
- $this->assertEquals($expectedPackage, $assetPackage->getPackage());
+ self::assertInstanceOf(
+ AssetPackageInterface::class,
+ $assetPackage,
+ );
+ self::assertSame(
+ $expectedPackage,
+ $assetPackage->getPackage(),
+ );
}
+ /**
+ * @throws Exception
+ */
public function testAddDependenciesForUpdateCommand(): void
{
$this->actionForTestAddDependenciesForUpdateCommand();
@@ -247,33 +126,52 @@ public function testAddDependenciesForUpdateCommand(): void
$jsonFile = new JsonFile($this->cwd . '/package.json');
- /** @var MockObject|RootPackageInterface $rootPackage */
$rootPackage = $this->createMock(RootPackageInterface::class);
-
- $rootPackage->expects($this->any())->method('getLicense')->willReturn([]);
+ $rootPackage->expects(self::any())->method('getLicense')->willReturn([]);
$nodeModulePath = $this->cwd . ltrim(AbstractAssetManager::NODE_MODULES_PATH, '.');
$jsonFile->write($package);
- $this->assertFileExists($jsonFile->getPath());
+ self::assertFileExists(
+ $jsonFile->getPath(),
+ );
+
$this->sfs->mkdir($nodeModulePath);
- $this->assertFileExists($nodeModulePath);
+
+ self::assertFileExists(
+ $nodeModulePath,
+ );
$lockFilePath = $this->cwd . DIRECTORY_SEPARATOR . $this->manager->getLockPackageName();
file_put_contents($lockFilePath, '{}');
- $this->assertFileExists($lockFilePath);
- $this->assertTrue($this->manager->isInstalled());
- $this->assertTrue($this->manager->isUpdatable());
+ self::assertFileExists(
+ $lockFilePath,
+ );
+ self::assertTrue(
+ $this->manager->isInstalled(),
+ );
+ self::assertTrue(
+ $this->manager->isUpdatable(),
+ );
$assetPackage = $this->manager->addDependencies($rootPackage, $allDependencies);
- $this->assertInstanceOf(\Foxy\Asset\AssetPackageInterface::class, $assetPackage);
- $this->assertEquals($expectedPackage, $assetPackage->getPackage());
+ self::assertInstanceOf(
+ AssetPackageInterface::class,
+ $assetPackage,
+ );
+ self::assertSame(
+ $expectedPackage,
+ $assetPackage->getPackage(),
+ );
}
+ /**
+ * @throws Exception
+ */
public function testAddDependenciesUsesRootPackageJsonDir(): void
{
$rootPackageDir = $this->cwd . DIRECTORY_SEPARATOR . 'root-package';
@@ -298,40 +196,142 @@ public function testAddDependenciesUsesRootPackageJsonDir(): void
'@composer-asset/new--dependency' => 'path/new/dependency/package.json',
];
- /** @var MockObject|RootPackageInterface $rootPackage */
$rootPackage = $this->createMock(RootPackageInterface::class);
+ $rootPackage->expects(self::any())->method('getLicense')->willReturn([]);
- $rootPackage->expects($this->any())->method('getLicense')->willReturn([]);
$this->manager->addDependencies($rootPackage, $dependencies);
- $this->assertSame($cwdPackageContent, file_get_contents($cwdPackagePath));
+ self::assertSame(
+ $cwdPackageContent,
+ file_get_contents($cwdPackagePath),
+ );
$updatedContent = (string) file_get_contents($rootPackagePath);
- $this->assertStringContainsString(
+ self::assertStringContainsString(
'"@composer-asset/new--dependency": "file:./path/new/dependency"',
- $updatedContent
+ $updatedContent,
);
- $this->assertMatchesRegularExpression(
+ self::assertMatchesRegularExpression(
'/\n {4}"dependencies": \{/',
$updatedContent,
);
- $this->assertMatchesRegularExpression(
+ self::assertMatchesRegularExpression(
'/\n {8}"@composer-asset\/new--dependency": "file:\.\/path\/new\/dependency"/',
- $updatedContent
+ $updatedContent,
);
}
- public function testRunWithDisableOption(): void
+ public function testGetLockPackageName(): void
{
- $this->config = new Config([], ['run-asset-manager' => false]);
+ self::assertSame(
+ $this->getValidLockPackageName(),
+ $this->manager->getLockPackageName(),
+ );
+ }
- $this->assertSame(0, $this->getManager()->run());
+ public function testGetName(): void
+ {
+ self::assertSame(
+ $this->getValidName(),
+ $this->manager->getName(),
+ );
}
- public static function getRunData(): array
+ #[RequiresOperatingSystemFamily('Windows')]
+ public function testGetPackageJsonPathWithWindowsRootPackageDir(): void
{
- return [[0, 'install'], [0, 'update'], [1, 'install'], [1, 'update']];
+ $this->config = new Config([], ['root-package-json-dir' => 'C:\\']);
+ $this->manager = $this->getManager();
+
+ self::assertInstanceOf(
+ AbstractAssetManager::class,
+ $this->manager,
+ );
+
+ /** @var AbstractAssetManager $manager */
+ $manager = $this->manager;
+
+ self::assertSame(
+ 'C:\\package.json',
+ $manager->getPackageJsonPath(),
+ );
+ }
+
+ public function testGetPackageName(): void
+ {
+ self::assertSame(
+ 'package.json',
+ $this->manager->getPackageName(),
+ );
+ }
+
+ public function testHasLockFile(): void
+ {
+ self::assertFalse(
+ $this->manager->hasLockFile(),
+ );
+ }
+
+ public function testHasLockFileWithoutRootPackageDirAndGetcwdFailure(): void
+ {
+ $this->config = new Config([]);
+ $this->manager = $this->getManager();
+
+ MockerState::addCondition('Foxy\\Asset', 'getcwd', [], false);
+
+ $this->expectException(RuntimeException::class);
+ $this->expectExceptionMessage('Unable to get the current working directory.');
+
+ $this->manager->hasLockFile();
+ }
+
+ public function testHasLockFileWithRelativeRootPackageDirAndGetcwdFailure(): void
+ {
+ $this->config = new Config([], ['root-package-json-dir' => 'root-package']);
+ $this->manager = $this->getManager();
+
+ MockerState::addCondition('Foxy\\Asset', 'getcwd', [], false);
+
+ $this->expectException(RuntimeException::class);
+ $this->expectExceptionMessage('Unable to get the current working directory.');
+
+ $this->manager->hasLockFile();
+ }
+
+ public function testHasLockFileWithRootPackageDirAsRoot(): void
+ {
+ $this->config = new Config([], ['root-package-json-dir' => DIRECTORY_SEPARATOR]);
+ $this->manager = $this->getManager();
+
+ MockerState::addCondition('Foxy\\Asset', 'getcwd', [], $this->cwd);
+
+ self::assertInstanceOf(AbstractAssetManager::class, $this->manager);
+
+ /** @var AbstractAssetManager $manager */
+ $manager = $this->manager;
+
+ self::assertSame(
+ DIRECTORY_SEPARATOR . $manager->getPackageName(),
+ $manager->getPackageJsonPath(),
+ );
+ self::assertFalse(
+ $this->manager->hasLockFile(),
+ );
+ }
+
+ public function testIsInstalled(): void
+ {
+ self::assertFalse(
+ $this->manager->isInstalled(),
+ );
+ }
+
+ public function testIsUpdatable(): void
+ {
+ self::assertFalse(
+ $this->manager->isUpdatable(),
+ );
}
/**
@@ -354,28 +354,46 @@ public function testRunForInstallCommand(int $expectedRes, string $action): void
$nodeModulePath = $this->cwd . ltrim(AbstractAssetManager::NODE_MODULES_PATH, '.');
$this->sfs->mkdir($nodeModulePath);
- $this->assertFileExists($nodeModulePath);
+
+ self::assertFileExists(
+ $nodeModulePath,
+ );
$lockFilePath = $this->cwd . DIRECTORY_SEPARATOR . $this->manager->getLockPackageName();
file_put_contents($lockFilePath, '{}');
- $this->assertFileExists($lockFilePath);
- $this->assertTrue($this->manager->isInstalled());
- $this->assertTrue($this->manager->isUpdatable());
+ self::assertFileExists(
+ $lockFilePath,
+ );
+ self::assertTrue(
+ $this->manager->isInstalled(),
+ );
+ self::assertTrue(
+ $this->manager->isUpdatable(),
+ );
}
if (0 === $expectedRes) {
- $this->fallback->expects($this->never())->method('restore');
+ $this->fallback->expects(self::never())->method('restore');
} else {
- $this->fallback->expects($this->once())->method('restore');
+ $this->fallback->expects(self::once())->method('restore');
}
$this->executor->addExpectedValues($expectedRes, 'ASSET MANAGER OUTPUT');
- $this->assertSame($expectedRes, $this->getManager()->run());
- $this->assertSame($expectedCommand, $this->executor->getLastCommand());
- $this->assertSame('ASSET MANAGER OUTPUT', $this->executor->getLastOutput());
+ self::assertSame(
+ $expectedRes,
+ $this->getManager()->run(),
+ );
+ self::assertSame(
+ $expectedCommand,
+ $this->executor->getLastCommand(),
+ );
+ self::assertSame(
+ 'ASSET MANAGER OUTPUT',
+ $this->executor->getLastOutput(),
+ );
}
public function testRunRestoresTimeoutWhenExecutorThrows(): void
@@ -393,18 +411,24 @@ public function testRunRestoresTimeoutWhenExecutorThrows(): void
try {
$this->manager->run();
- $this->fail('Expected a runtime exception when execute fails.');
+ self::fail('Expected a runtime exception when execute fails.');
} catch (\RuntimeException $exception) {
- $this->assertSame('Process execution failed.', $exception->getMessage());
+ self::assertSame(
+ 'Process execution failed.',
+ $exception->getMessage(),
+ );
}
- $this->assertSame($expectedTimeout, ProcessExecutor::getTimeout());
+ self::assertSame(
+ $expectedTimeout,
+ ProcessExecutor::getTimeout(),
+ );
} finally {
ProcessExecutor::setTimeout($originalTimeout);
}
}
- public function testSpecifyCustomDirectoryFromPackageJson(): void
+ public function testRunWithChdirFailure(): void
{
$rootPackageDir = $this->cwd . DIRECTORY_SEPARATOR . 'root-package';
$this->sfs->mkdir($rootPackageDir);
@@ -416,39 +440,70 @@ public function testSpecifyCustomDirectoryFromPackageJson(): void
);
$this->manager = $this->getManager();
- $this->assertSame($rootPackageDir, $this->config->get('root-package-json-dir'));
- $this->assertSame(0, $this->getManager()->run());
- $this->assertSame($originalCwd, getcwd());
+ MockerState::addCondition('Foxy\\Asset', 'chdir', [$rootPackageDir], false);
+
+ try {
+ $this->getManager()->run();
+ self::fail('Expected a runtime exception when chdir fails.');
+ } catch (RuntimeException $exception) {
+ self::assertSame(
+ sprintf('Unable to change working directory to "%s".', $rootPackageDir),
+ $exception->getMessage(),
+ );
+ self::assertSame(
+ $originalCwd,
+ getcwd(),
+ );
+ }
}
- public function testSpecifyCustomDirectoryFromPackageJsonException(): void
+ public function testRunWithChdirRestoreFailure(): void
{
+ $rootPackageDir = $this->cwd . DIRECTORY_SEPARATOR . 'root-package';
+ $this->sfs->mkdir($rootPackageDir);
$originalCwd = getcwd();
- $expectedPath = $this->cwd . DIRECTORY_SEPARATOR . 'path/to/invalid';
$this->config = new Config(
[],
- ['run-asset-manager' => true, 'root-package-json-dir' => 'path/to/invalid'],
+ ['run-asset-manager' => true, 'root-package-json-dir' => $rootPackageDir],
);
$this->manager = $this->getManager();
+ MockerState::addCondition('Foxy\\Asset', 'chdir', [$rootPackageDir], true);
+ MockerState::addCondition('Foxy\\Asset', 'chdir', [$originalCwd], false);
+
+ $this->executor->addExpectedValues(0, 'ASSET MANAGER OUTPUT');
+
try {
- $this->getManager()->run();
- $this->fail('Expected a runtime exception for invalid root package directory.');
- } catch (\Foxy\Exception\RuntimeException $exception) {
- $this->assertSame(
- sprintf('The root package directory "%s" doesn\'t exist.', $expectedPath),
- $exception->getMessage()
+ $this->manager->run();
+ self::fail('Expected a runtime exception when restoring chdir fails.');
+ } catch (RuntimeException $exception) {
+ self::assertSame(
+ sprintf('Unable to restore working directory to "%s".', $originalCwd),
+ $exception->getMessage(),
+ );
+ self::assertSame(
+ $originalCwd,
+ getcwd(),
);
- $this->assertSame($originalCwd, getcwd());
}
}
+ public function testRunWithDisableOption(): void
+ {
+ $this->config = new Config([], ['run-asset-manager' => false]);
+
+ self::assertSame(
+ 0,
+ $this->getManager()->run(),
+ );
+ }
+
public function testRunWithGetcwdFailure(): void
{
$rootPackageDir = $this->cwd . DIRECTORY_SEPARATOR . 'root-package';
$this->sfs->mkdir($rootPackageDir);
- $originalCwd = \getcwd();
+ $originalCwd = getcwd();
$this->config = new Config(
[],
@@ -460,105 +515,126 @@ public function testRunWithGetcwdFailure(): void
try {
$this->getManager()->run();
- $this->fail('Expected a runtime exception when getcwd fails.');
- } catch (\Foxy\Exception\RuntimeException $exception) {
- $this->assertSame('Unable to get the current working directory.', $exception->getMessage());
- $this->assertSame($originalCwd, \getcwd());
+ self::fail('Expected a runtime exception when getcwd fails.');
+ } catch (RuntimeException $exception) {
+ self::assertSame(
+ 'Unable to get the current working directory.',
+ $exception->getMessage(),
+ );
+ self::assertSame(
+ $originalCwd,
+ getcwd(),
+ );
}
}
- public function testHasLockFileWithRelativeRootPackageDirAndGetcwdFailure(): void
+ public function testSetUpdatable(): void
{
- $this->config = new Config([], ['root-package-json-dir' => 'root-package']);
- $this->manager = $this->getManager();
-
- MockerState::addCondition('Foxy\\Asset', 'getcwd', [], false);
-
- $this->expectException(\Foxy\Exception\RuntimeException::class);
- $this->expectExceptionMessage('Unable to get the current working directory.');
+ $res = $this->manager->setUpdatable(false);
- $this->manager->hasLockFile();
+ self::assertInstanceOf(
+ AssetManagerInterface::class,
+ $res,
+ );
}
- public function testHasLockFileWithoutRootPackageDirAndGetcwdFailure(): void
+ public function testSpecifyCustomDirectoryFromPackageJson(): void
{
- $this->config = new Config([]);
- $this->manager = $this->getManager();
-
- MockerState::addCondition('Foxy\\Asset', 'getcwd', [], false);
+ $rootPackageDir = $this->cwd . DIRECTORY_SEPARATOR . 'root-package';
+ $this->sfs->mkdir($rootPackageDir);
+ $originalCwd = getcwd();
- $this->expectException(\Foxy\Exception\RuntimeException::class);
- $this->expectExceptionMessage('Unable to get the current working directory.');
+ $this->config = new Config(
+ [],
+ ['run-asset-manager' => true, 'root-package-json-dir' => $rootPackageDir],
+ );
+ $this->manager = $this->getManager();
- $this->manager->hasLockFile();
+ self::assertSame(
+ $rootPackageDir,
+ $this->config->get('root-package-json-dir'),
+ );
+ self::assertSame(
+ 0,
+ $this->getManager()->run(),
+ );
+ self::assertSame(
+ $originalCwd,
+ getcwd(),
+ );
}
- public function testRunWithChdirFailure(): void
+ public function testSpecifyCustomDirectoryFromPackageJsonException(): void
{
- $rootPackageDir = $this->cwd . DIRECTORY_SEPARATOR . 'root-package';
- $this->sfs->mkdir($rootPackageDir);
- $originalCwd = \getcwd();
+ $originalCwd = getcwd();
+ $expectedPath = $this->cwd . DIRECTORY_SEPARATOR . 'path/to/invalid';
$this->config = new Config(
[],
- ['run-asset-manager' => true, 'root-package-json-dir' => $rootPackageDir],
+ ['run-asset-manager' => true, 'root-package-json-dir' => 'path/to/invalid'],
);
$this->manager = $this->getManager();
- MockerState::addCondition('Foxy\\Asset', 'chdir', [$rootPackageDir], false);
-
try {
$this->getManager()->run();
- $this->fail('Expected a runtime exception when chdir fails.');
- } catch (\Foxy\Exception\RuntimeException $exception) {
- $this->assertSame(
- sprintf('Unable to change working directory to "%s".', $rootPackageDir),
- $exception->getMessage()
+ self::fail('Expected a runtime exception for invalid root package directory.');
+ } catch (RuntimeException $exception) {
+ self::assertSame(
+ sprintf('The root package directory "%s" doesn\'t exist.', $expectedPath),
+ $exception->getMessage(),
+ );
+ self::assertSame(
+ $originalCwd,
+ getcwd(),
);
- $this->assertSame($originalCwd, \getcwd());
}
}
- public function testRunWithChdirRestoreFailure(): void
+ public function testValidateWithInstalledManagerAndWithoutValidationVersion(): void
{
- $rootPackageDir = $this->cwd . DIRECTORY_SEPARATOR . 'root-package';
- $this->sfs->mkdir($rootPackageDir);
- $originalCwd = \getcwd();
+ $this->executor->addExpectedValues(0, '42.0.0');
+ $this->manager->validate();
- $this->config = new Config(
- [],
- ['run-asset-manager' => true, 'root-package-json-dir' => $rootPackageDir],
+ self::assertNull(
+ $this->config->get('manager-version'),
);
- $this->manager = $this->getManager();
+ }
- MockerState::addCondition('Foxy\\Asset', 'chdir', [$rootPackageDir], true);
- MockerState::addCondition('Foxy\\Asset', 'chdir', [$originalCwd], false);
+ public function testValidateWithInstalledManagerAndWithoutValidVersion(): void
+ {
+ $this->expectException(RuntimeException::class);
+ $this->expectExceptionMessageMatches(
+ '/The installed (\w+) version "42.0.0" doesn\'t match with the constraint version ">=50.0"/',
+ );
- $this->executor->addExpectedValues(0, 'ASSET MANAGER OUTPUT');
+ $this->config = new Config([], ['manager-version' => '>=50.0']);
- try {
- $this->manager->run();
- $this->fail('Expected a runtime exception when restoring chdir fails.');
- } catch (\Foxy\Exception\RuntimeException $exception) {
- $this->assertSame(
- sprintf('Unable to restore working directory to "%s".', $originalCwd),
- $exception->getMessage()
- );
- $this->assertSame($originalCwd, \getcwd());
- }
+ $this->manager = $this->getManager();
+ $this->executor->addExpectedValues(0, '42.0.0');
+ $this->manager->validate();
}
- abstract protected function getManager(): AssetManagerInterface;
-
- abstract protected function getValidName(): string;
+ public function testValidateWithInstalledManagerAndWithValidVersion(): void
+ {
+ $this->config = new Config([], ['manager-version' => '>=41.0']);
- abstract protected function getValidLockPackageName(): string;
+ $this->manager = $this->getManager();
+ $this->executor->addExpectedValues(0, '42.0.0');
+ $this->manager->validate();
- abstract protected function getValidVersionCommand(): string;
+ self::assertSame(
+ '>=41.0',
+ $this->config->get('manager-version'),
+ );
+ }
- abstract protected function getValidInstallCommand(): string;
+ public function testValidateWithoutInstalledManager(): void
+ {
+ $this->expectException(RuntimeException::class);
+ $this->expectExceptionMessageMatches('/The binary of "(\w+)" must be installed/');
- abstract protected function getValidUpdateCommand(): string;
+ $this->manager->validate();
+ }
protected function actionForTestAddDependenciesForUpdateCommand(): void
{
@@ -572,4 +648,43 @@ protected function actionForTestRunForInstallCommand(string $action): void
{
// do nothing by default
}
+
+ /**
+ * @throws Exception
+ */
+ protected function setUp(): void
+ {
+ parent::setUp();
+
+ $this->config = new Config([]);
+ $this->io = $this->createMock(IOInterface::class);
+ $this->executor = new ProcessExecutorMock($this->io);
+ $this->fs = $this->createMock(Filesystem::class);
+ $this->sfs = new \Symfony\Component\Filesystem\Filesystem();
+ $this->fallback = $this->createMock(FallbackInterface::class);
+ $this->manager = $this->getManager();
+ $this->oldCwd = getcwd();
+ $this->cwd = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('foxy_asset_manager_test_', true);
+ $this->sfs->mkdir($this->cwd);
+
+ chdir($this->cwd);
+ }
+
+ protected function tearDown(): void
+ {
+ parent::tearDown();
+
+ chdir($this->oldCwd);
+
+ $this->sfs->remove($this->cwd);
+ $this->config = null;
+ $this->io = null;
+ $this->executor = null;
+ $this->fs = null;
+ $this->sfs = null;
+ $this->fallback = null;
+ $this->manager = null;
+ $this->oldCwd = null;
+ $this->cwd = null;
+ }
}
diff --git a/tests/Asset/AssetManagerFinderTest.php b/tests/Asset/AssetManagerFinderTest.php
index 985c0bb..c22ceed 100644
--- a/tests/Asset/AssetManagerFinderTest.php
+++ b/tests/Asset/AssetManagerFinderTest.php
@@ -2,98 +2,92 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Asset;
-use Foxy\Asset\AssetManagerFinder;
+use Foxy\Asset\{AssetManagerFinder, AssetManagerInterface};
+use Foxy\Exception\RuntimeException;
use PHPUnit\Framework\TestCase;
-/**
- * Asset manager finder tests.
- *
- * @author François Pluchino
- *
- * @internal
- */
final class AssetManagerFinderTest extends TestCase
{
- public function testFindManagerWithValidManager(): void
+ public function testFindManagerWithAutoManagerAndAvailableManagerByAvailability(): void
{
- $am = $this->createMock(\Foxy\Asset\AssetManagerInterface::class);
+ $am = $this->createMock(AssetManagerInterface::class);
- $am->expects($this->once())->method('getName')->willReturn('foo');
+ $am->expects(self::once())->method('getName')->willReturn('foo');
+ $am->expects(self::once())->method('hasLockFile')->willReturn(false);
+ $am->expects(self::once())->method('isAvailable')->willReturn(true);
$amf = new AssetManagerFinder([$am]);
- $res = $amf->findManager('foo');
- $this->assertSame($am, $res);
+ $res = $amf->findManager();
+
+ self::assertSame(
+ $am,
+ $res,
+ );
}
- public function testFindManagerWithInvalidManager(): void
+ public function testFindManagerWithAutoManagerAndAvailableManagerByLockFile(): void
{
- $this->expectException(\Foxy\Exception\RuntimeException::class);
- $this->expectExceptionMessage('The asset manager "bar" doesn\'t exist');
-
- $am = $this->createMock(\Foxy\Asset\AssetManagerInterface::class);
+ $am = $this->createMock(AssetManagerInterface::class);
- $am->expects($this->once())->method('getName')->willReturn('foo');
+ $am->expects(self::once())->method('getName')->willReturn('foo');
+ $am->expects(self::once())->method('hasLockFile')->willReturn(true);
+ $am->expects(self::never())->method('isAvailable');
$amf = new AssetManagerFinder([$am]);
- $amf->findManager('bar');
+ $res = $amf->findManager();
+
+ self::assertSame(
+ $am,
+ $res,
+ );
}
- public function testFindManagerWithAutoManagerAndAvailableManagerByLockFile(): void
+ public function testFindManagerWithAutoManagerAndNoAvailableManager(): void
{
- $am = $this->createMock(\Foxy\Asset\AssetManagerInterface::class);
+ $this->expectException(RuntimeException::class);
+ $this->expectExceptionMessage('No asset manager is found');
- $am->expects($this->once())->method('getName')->willReturn('foo');
- $am->expects($this->once())->method('hasLockFile')->willReturn(true);
- $am->expects($this->never())->method('isAvailable');
+ $am = $this->getMockBuilder(AssetManagerInterface::class)->getMock();
- $amf = new AssetManagerFinder([$am]);
+ $am->expects(self::atLeastOnce())->method('getName')->willReturn('foo');
+ $am->expects(self::once())->method('hasLockFile')->willReturn(false);
+ $am->expects(self::once())->method('isAvailable')->willReturn(false);
- $res = $amf->findManager(null);
+ $amf = new AssetManagerFinder([$am]);
- $this->assertSame($am, $res);
+ $amf->findManager();
}
- public function testFindManagerWithAutoManagerAndAvailableManagerByAvailability(): void
+ public function testFindManagerWithInvalidManager(): void
{
- $am = $this->createMock(\Foxy\Asset\AssetManagerInterface::class);
+ $this->expectException(RuntimeException::class);
+ $this->expectExceptionMessage('The asset manager "bar" doesn\'t exist');
- $am->expects($this->once())->method('getName')->willReturn('foo');
- $am->expects($this->once())->method('hasLockFile')->willReturn(false);
- $am->expects($this->once())->method('isAvailable')->willReturn(true);
+ $am = $this->createMock(AssetManagerInterface::class);
- $amf = new AssetManagerFinder([$am]);
+ $am->expects(self::once())->method('getName')->willReturn('foo');
- $res = $amf->findManager(null);
+ $amf = new AssetManagerFinder([$am]);
- $this->assertSame($am, $res);
+ $amf->findManager('bar');
}
- public function testFindManagerWithAutoManagerAndNoAvailableManager(): void
+ public function testFindManagerWithValidManager(): void
{
- $this->expectException(\Foxy\Exception\RuntimeException::class);
- $this->expectExceptionMessage('No asset manager is found');
-
- $am = $this->getMockBuilder(\Foxy\Asset\AssetManagerInterface::class)->getMock();
+ $am = $this->createMock(AssetManagerInterface::class);
- $am->expects($this->atLeastOnce())->method('getName')->willReturn('foo');
- $am->expects($this->once())->method('hasLockFile')->willReturn(false);
- $am->expects($this->once())->method('isAvailable')->willReturn(false);
+ $am->expects(self::once())->method('getName')->willReturn('foo');
$amf = new AssetManagerFinder([$am]);
+ $res = $amf->findManager('foo');
- $amf->findManager(null);
+ self::assertSame(
+ $am,
+ $res,
+ );
}
}
diff --git a/tests/Asset/AssetPackageTest.php b/tests/Asset/AssetPackageTest.php
index 381e9be..ecdeb6f 100644
--- a/tests/Asset/AssetPackageTest.php
+++ b/tests/Asset/AssetPackageTest.php
@@ -2,89 +2,28 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Asset;
use Composer\Json\JsonFile;
use Composer\Package\RootPackageInterface;
+use Exception;
use Foxy\Asset\AssetPackage;
+use JsonException;
use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Seld\JsonLint\ParsingException;
use Symfony\Component\Filesystem\Filesystem;
-/**
- * Asset package tests.
- *
- * @author François Pluchino
- *
- * @internal
- */
-final class AssetPackageTest extends \PHPUnit\Framework\TestCase
+use function file_put_contents;
+
+use const DIRECTORY_SEPARATOR;
+
+final class AssetPackageTest extends TestCase
{
protected string|null $cwd = '';
- protected Filesystem|null $sfs = null;
- protected MockObject|RootPackageInterface|null $rootPackage = null;
protected JsonFile|MockObject|null $jsonFile = null;
-
- protected function setUp(): void
- {
- parent::setUp();
-
- $this->cwd = sys_get_temp_dir() . \DIRECTORY_SEPARATOR . uniqid('foxy_asset_package_test_', true);
- $this->sfs = new Filesystem();
- $this->rootPackage = $this->createMock(RootPackageInterface::class);
- $this->jsonFile = $this->getMockBuilder(JsonFile::class)
- ->disableOriginalConstructor()
- ->onlyMethods(['exists', 'getPath', 'read', 'write'])
- ->getMock()
- ;
-
- $this->rootPackage->expects($this->any())->method('getLicense')->willReturn([]);
-
- $this->sfs->mkdir($this->cwd);
- }
-
- protected function tearDown(): void
- {
- parent::tearDown();
-
- $this->sfs->remove($this->cwd);
- $this->jsonFile = null;
- $this->rootPackage = null;
- $this->sfs = null;
- $this->cwd = null;
- }
-
- public function testGetPackageWithExistingFile(): void
- {
- $package = ['name' => '@foo/bar'];
- $contentString = json_encode($package);
- $this->addPackageFile($package, $contentString);
-
- $assetPackage = new AssetPackage($this->rootPackage, $this->jsonFile);
-
- $this->assertSame($package, $assetPackage->getPackage());
- }
-
- public function testWrite(): void
- {
- $package = ['name' => '@foo/bar'];
-
- $this->jsonFile->expects($this->once())->method('exists')->willReturn(false);
- $this->jsonFile->expects($this->once())->method('write')->with($package);
-
- $assetPackage = new AssetPackage($this->rootPackage, $this->jsonFile);
-
- $assetPackage->setPackage($package);
- $assetPackage->write();
- }
+ protected MockObject|RootPackageInterface|null $rootPackage = null;
+ protected Filesystem|null $sfs = null;
public static function getDataRequiredKeys(): array
{
@@ -124,21 +63,54 @@ public static function getDataRequiredKeys(): array
}
/**
- * @dataProvider getDataRequiredKeys
+ * @throws JsonException|ParsingException
*/
- public function testInjectionOfRequiredKeys(array $expected, array $package, string $license): void
+ public function testAddNewDependencies(): void
{
- $this->addPackageFile($package);
-
- $this->rootPackage = $this->createMock(RootPackageInterface::class);
+ $expected = [
+ 'dependencies' => [
+ '@bar/foo' => '^1.0.0',
+ '@composer-asset/baz--bar' => 'file:./path/baz/bar',
+ '@composer-asset/foo--bar' => 'file:./path/foo/bar',
+ '@composer-asset/new--dependency' => 'file:./path/new/dependency',
+ ],
+ ];
+ $expectedExisting = [
+ '@composer-asset/foo--bar',
+ '@composer-asset/baz--bar',
+ ];
+ $package = [
+ 'dependencies' => [
+ '@composer-asset/foo--bar' => 'file:./path/foo/bar',
+ '@bar/foo' => '^1.0.0',
+ '@composer-asset/baz--bar' => 'file:./path/baz/bar',
+ ],
+ ];
+ $dependencies = [
+ '@composer-asset/foo--bar' => 'path/foo/bar/package.json',
+ '@composer-asset/baz--bar' => 'path/baz/bar/package.json',
+ '@composer-asset/new--dependency' => 'path/new/dependency/package.json',
+ ];
- $this->rootPackage->expects($this->any())->method('getLicense')->willReturn([$license]);
+ $this->addPackageFile($package);
$assetPackage = new AssetPackage($this->rootPackage, $this->jsonFile);
+ $existing = $assetPackage->addNewDependencies($dependencies);
- $this->assertEquals($expected, $assetPackage->getPackage());
+ self::assertSame(
+ $expected,
+ $assetPackage->getPackage(),
+ );
+ self::assertSame(
+ $expectedExisting,
+ $existing,
+ );
}
+ /**
+ * @throws ParsingException
+ * @throws JsonException
+ */
public function testGetInstalledDependencies(): void
{
$expected = [
@@ -157,43 +129,57 @@ public function testGetInstalledDependencies(): void
$assetPackage = new AssetPackage($this->rootPackage, $this->jsonFile);
- $this->assertEquals($expected, $assetPackage->getInstalledDependencies());
+ self::assertSame(
+ $expected,
+ $assetPackage->getInstalledDependencies(),
+ );
}
- public function testAddNewDependencies(): void
+ /**
+ * @throws ParsingException
+ * @throws JsonException
+ */
+ public function testGetPackageWithExistingFile(): void
{
- $expected = [
- 'dependencies' => [
- '@bar/foo' => '^1.0.0',
- '@composer-asset/baz--bar' => 'file:./path/baz/bar',
- '@composer-asset/foo--bar' => 'file:./path/foo/bar',
- '@composer-asset/new--dependency' => 'file:./path/new/dependency',
- ],
- ];
- $expectedExisting = ['@composer-asset/foo--bar', '@composer-asset/baz--bar'];
+ $package = ['name' => '@foo/bar'];
- $package = [
- 'dependencies' => [
- '@composer-asset/foo--bar' => 'file:./path/foo/bar',
- '@bar/foo' => '^1.0.0',
- '@composer-asset/baz--bar' => 'file:./path/baz/bar',
- ],
- ];
- $dependencies = [
- '@composer-asset/foo--bar' => 'path/foo/bar/package.json',
- '@composer-asset/baz--bar' => 'path/baz/bar/package.json',
- '@composer-asset/new--dependency' => 'path/new/dependency/package.json',
- ];
+ $contentString = json_encode($package, JSON_THROW_ON_ERROR);
+ $this->addPackageFile($package, $contentString);
+
+ $assetPackage = new AssetPackage($this->rootPackage, $this->jsonFile);
+
+ self::assertSame(
+ $package,
+ $assetPackage->getPackage(),
+ );
+ }
+
+ /**
+ * @dataProvider getDataRequiredKeys
+ *
+ * @throws JsonException|ParsingException
+ */
+ public function testInjectionOfRequiredKeys(array $expected, array $package, string $license): void
+ {
$this->addPackageFile($package);
+ $this->rootPackage = $this->createMock(RootPackageInterface::class);
+
+ $this->rootPackage->expects(self::any())->method('getLicense')->willReturn([$license]);
+
$assetPackage = new AssetPackage($this->rootPackage, $this->jsonFile);
- $existing = $assetPackage->addNewDependencies($dependencies);
- $this->assertSame($expected, $assetPackage->getPackage());
- $this->assertSame($expectedExisting, $existing);
+ self::assertSame(
+ $expected,
+ $assetPackage->getPackage(),
+ );
}
+ /**
+ * @throws ParsingException
+ * @throws JsonException
+ */
public function testRemoveUnusedDependencies(): void
{
$expected = [
@@ -215,9 +201,29 @@ public function testRemoveUnusedDependencies(): void
$this->addPackageFile($package);
$assetPackage = new AssetPackage($this->rootPackage, $this->jsonFile);
+
$assetPackage->removeUnusedDependencies($dependencies);
- $this->assertEquals($expected, $assetPackage->getPackage());
+ self::assertSame(
+ $expected,
+ $assetPackage->getPackage(),
+ );
+ }
+
+ /**
+ * @throws Exception|ParsingException
+ */
+ public function testWrite(): void
+ {
+ $package = ['name' => '@foo/bar'];
+
+ $this->jsonFile->expects(self::once())->method('exists')->willReturn(false);
+ $this->jsonFile->expects(self::once())->method('write')->with($package);
+
+ $assetPackage = new AssetPackage($this->rootPackage, $this->jsonFile);
+
+ $assetPackage->setPackage($package);
+ $assetPackage->write();
}
/**
@@ -225,16 +231,49 @@ public function testRemoveUnusedDependencies(): void
*
* @param array $package The package.
* @param string|null $contentString The string content of package.
+ *
+ * @throws JsonException
*/
- protected function addPackageFile(array $package, $contentString = null): void
+ protected function addPackageFile(array $package, string|null $contentString = null): void
{
$filename = $this->cwd . '/package.json';
- $contentString ??= json_encode($package);
+ $contentString ??= json_encode($package, JSON_THROW_ON_ERROR);
+
+ $this->jsonFile->expects(self::any())->method('exists')->willReturn(true);
+ $this->jsonFile->expects(self::any())->method('getPath')->willReturn($filename);
+ $this->jsonFile->expects(self::any())->method('read')->willReturn($package);
+
+ file_put_contents($filename, $contentString);
+ }
+
+ protected function setUp(): void
+ {
+ parent::setUp();
+
+ $this->cwd = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('foxy_asset_package_test_', true);
- $this->jsonFile->expects($this->any())->method('exists')->willReturn(true);
- $this->jsonFile->expects($this->any())->method('getPath')->willReturn($filename);
- $this->jsonFile->expects($this->any())->method('read')->willReturn($package);
+ $this->sfs = new Filesystem();
- \file_put_contents($filename, $contentString);
+ $this->rootPackage = $this->createMock(RootPackageInterface::class);
+ $this->jsonFile = $this
+ ->getMockBuilder(JsonFile::class)
+ ->disableOriginalConstructor()
+ ->onlyMethods(['exists', 'getPath', 'read', 'write'])
+ ->getMock()
+ ;
+ $this->rootPackage->expects(self::any())->method('getLicense')->willReturn([]);
+
+ $this->sfs->mkdir($this->cwd);
+ }
+
+ protected function tearDown(): void
+ {
+ parent::tearDown();
+
+ $this->sfs->remove($this->cwd);
+ $this->jsonFile = null;
+ $this->rootPackage = null;
+ $this->sfs = null;
+ $this->cwd = null;
}
}
diff --git a/tests/Asset/BunAssetManagerTest.php b/tests/Asset/BunAssetManagerTest.php
index ec5ee7c..3ddf39a 100644
--- a/tests/Asset/BunAssetManagerTest.php
+++ b/tests/Asset/BunAssetManagerTest.php
@@ -2,27 +2,11 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Asset;
use Composer\Util\Platform;
use Foxy\Asset\BunManager;
-/**
- * Pnpm asset manager tests.
- *
- * @author Steffen Dietz
- *
- * @internal
- */
final class BunAssetManagerTest extends AssetManager
{
protected function getManager(): BunManager
@@ -30,9 +14,9 @@ protected function getManager(): BunManager
return new BunManager($this->io, $this->config, $this->executor, $this->fs, $this->fallback);
}
- protected function getValidName(): string
+ protected function getValidInstallCommand(): string
{
- return 'bun';
+ return Platform::isWindows() ? 'bun.exe install -y' : 'bun install -y';
}
protected function getValidLockPackageName(): string
@@ -40,18 +24,18 @@ protected function getValidLockPackageName(): string
return 'yarn.lock';
}
- protected function getValidVersionCommand(): string
+ protected function getValidName(): string
{
- return Platform::isWindows() ? 'bun.exe --version' : 'bun --version';
+ return 'bun';
}
- protected function getValidInstallCommand(): string
+ protected function getValidUpdateCommand(): string
{
- return Platform::isWindows() ? 'bun.exe install -y' : 'bun install -y';
+ return Platform::isWindows() ? 'bun.exe update -y' : 'bun update -y';
}
- protected function getValidUpdateCommand(): string
+ protected function getValidVersionCommand(): string
{
- return Platform::isWindows() ? 'bun.exe update -y' : 'bun update -y';
+ return Platform::isWindows() ? 'bun.exe --version' : 'bun --version';
}
}
diff --git a/tests/Asset/NpmAssetManagerTest.php b/tests/Asset/NpmAssetManagerTest.php
index a7ab14a..264ed8d 100644
--- a/tests/Asset/NpmAssetManagerTest.php
+++ b/tests/Asset/NpmAssetManagerTest.php
@@ -2,26 +2,10 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Asset;
use Foxy\Asset\NpmManager;
-/**
- * NPM asset manager tests.
- *
- * @author François Pluchino
- *
- * @internal
- */
final class NpmAssetManagerTest extends AssetManager
{
protected function getManager(): NpmManager
@@ -29,9 +13,9 @@ protected function getManager(): NpmManager
return new NpmManager($this->io, $this->config, $this->executor, $this->fs, $this->fallback);
}
- protected function getValidName(): string
+ protected function getValidInstallCommand(): string
{
- return 'npm';
+ return 'npm install';
}
protected function getValidLockPackageName(): string
@@ -39,18 +23,18 @@ protected function getValidLockPackageName(): string
return 'package-lock.json';
}
- protected function getValidVersionCommand(): string
+ protected function getValidName(): string
{
- return 'npm --version';
+ return 'npm';
}
- protected function getValidInstallCommand(): string
+ protected function getValidUpdateCommand(): string
{
- return 'npm install';
+ return 'npm update';
}
- protected function getValidUpdateCommand(): string
+ protected function getValidVersionCommand(): string
{
- return 'npm update';
+ return 'npm --version';
}
}
diff --git a/tests/Asset/PnpmAssetManagerTest.php b/tests/Asset/PnpmAssetManagerTest.php
index 738c514..67bbd02 100644
--- a/tests/Asset/PnpmAssetManagerTest.php
+++ b/tests/Asset/PnpmAssetManagerTest.php
@@ -2,26 +2,10 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Asset;
use Foxy\Asset\PnpmManager;
-/**
- * Pnpm asset manager tests.
- *
- * @author Steffen Dietz
- *
- * @internal
- */
final class PnpmAssetManagerTest extends AssetManager
{
protected function getManager(): PnpmManager
@@ -29,9 +13,9 @@ protected function getManager(): PnpmManager
return new PnpmManager($this->io, $this->config, $this->executor, $this->fs, $this->fallback);
}
- protected function getValidName(): string
+ protected function getValidInstallCommand(): string
{
- return 'pnpm';
+ return 'pnpm install';
}
protected function getValidLockPackageName(): string
@@ -39,18 +23,18 @@ protected function getValidLockPackageName(): string
return 'pnpm-lock.yaml';
}
- protected function getValidVersionCommand(): string
+ protected function getValidName(): string
{
- return 'pnpm --version';
+ return 'pnpm';
}
- protected function getValidInstallCommand(): string
+ protected function getValidUpdateCommand(): string
{
- return 'pnpm install';
+ return 'pnpm update';
}
- protected function getValidUpdateCommand(): string
+ protected function getValidVersionCommand(): string
{
- return 'pnpm update';
+ return 'pnpm --version';
}
}
diff --git a/tests/Asset/YarnAssetManagerTest.php b/tests/Asset/YarnAssetManagerTest.php
index f3e2dfc..156e53c 100644
--- a/tests/Asset/YarnAssetManagerTest.php
+++ b/tests/Asset/YarnAssetManagerTest.php
@@ -2,26 +2,10 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Asset;
use Foxy\Asset\YarnManager;
-/**
- * Yarn asset manager tests.
- *
- * @author François Pluchino
- *
- * @internal
- */
final class YarnAssetManagerTest extends AssetManager
{
public function actionForTestRunForInstallCommand($action): void
@@ -35,14 +19,20 @@ public function actionForTestRunForInstallCommand($action): void
}
}
+ protected function actionForTestAddDependenciesForUpdateCommand(): void
+ {
+ $this->executor->addExpectedValues(0, '1.0.0');
+ $this->executor->addExpectedValues(0, 'CHECK OUTPUT');
+ }
+
protected function getManager(): YarnManager
{
return new YarnManager($this->io, $this->config, $this->executor, $this->fs, $this->fallback);
}
- protected function getValidName(): string
+ protected function getValidInstallCommand(): string
{
- return 'yarn';
+ return 'yarn install --non-interactive';
}
protected function getValidLockPackageName(): string
@@ -50,14 +40,9 @@ protected function getValidLockPackageName(): string
return 'yarn.lock';
}
- protected function getValidVersionCommand(): string
- {
- return 'yarn --version';
- }
-
- protected function getValidInstallCommand(): string
+ protected function getValidName(): string
{
- return 'yarn install --non-interactive';
+ return 'yarn';
}
protected function getValidUpdateCommand(): string
@@ -65,9 +50,8 @@ protected function getValidUpdateCommand(): string
return 'yarn upgrade --non-interactive';
}
- protected function actionForTestAddDependenciesForUpdateCommand(): void
+ protected function getValidVersionCommand(): string
{
- $this->executor->addExpectedValues(0, '1.0.0');
- $this->executor->addExpectedValues(0, 'CHECK OUTPUT');
+ return 'yarn --version';
}
}
diff --git a/tests/Asset/YarnNextAssetManagerTest.php b/tests/Asset/YarnNextAssetManagerTest.php
index bb660c6..5594819 100644
--- a/tests/Asset/YarnNextAssetManagerTest.php
+++ b/tests/Asset/YarnNextAssetManagerTest.php
@@ -2,26 +2,10 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Asset;
use Foxy\Asset\YarnManager;
-/**
- * Yarn Next asset manager tests.
- *
- * @author François Pluchino
- *
- * @internal
- */
final class YarnNextAssetManagerTest extends AssetManager
{
public function actionForTestRunForInstallCommand($action): void
@@ -33,14 +17,20 @@ public function actionForTestRunForInstallCommand($action): void
}
}
+ protected function actionForTestAddDependenciesForUpdateCommand(): void
+ {
+ $this->executor->addExpectedValues(0, '2.0.0');
+ $this->executor->addExpectedValues(0, 'CHECK OUTPUT');
+ }
+
protected function getManager(): YarnManager
{
return new YarnManager($this->io, $this->config, $this->executor, $this->fs, $this->fallback);
}
- protected function getValidName(): string
+ protected function getValidInstallCommand(): string
{
- return 'yarn';
+ return 'yarn install';
}
protected function getValidLockPackageName(): string
@@ -48,14 +38,9 @@ protected function getValidLockPackageName(): string
return 'yarn.lock';
}
- protected function getValidVersionCommand(): string
- {
- return 'yarn --version';
- }
-
- protected function getValidInstallCommand(): string
+ protected function getValidName(): string
{
- return 'yarn install';
+ return 'yarn';
}
protected function getValidUpdateCommand(): string
@@ -63,9 +48,8 @@ protected function getValidUpdateCommand(): string
return 'yarn up';
}
- protected function actionForTestAddDependenciesForUpdateCommand(): void
+ protected function getValidVersionCommand(): string
{
- $this->executor->addExpectedValues(0, '2.0.0');
- $this->executor->addExpectedValues(0, 'CHECK OUTPUT');
+ return 'yarn --version';
}
}
diff --git a/tests/Config/ConfigTest.php b/tests/Config/ConfigTest.php
index cd9ae95..0585606 100644
--- a/tests/Config/ConfigTest.php
+++ b/tests/Config/ConfigTest.php
@@ -2,47 +2,35 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Config;
-use Composer\Composer;
-use Composer\Config;
+use Composer\{Composer, Config};
use Composer\IO\IOInterface;
use Composer\Package\RootPackageInterface;
+use Exception;
use Foxy\Config\ConfigBuilder;
+use Foxy\Exception\RuntimeException;
use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Seld\JsonLint\ParsingException;
+
+use function getenv;
+use function putenv;
+use function sprintf;
+use function str_starts_with;
+use function strpos;
+use function substr;
-/**
- * Tests for config.
- *
- * @author François Pluchino
- *
- * @internal
- */
-final class ConfigTest extends \PHPUnit\Framework\TestCase
+final class ConfigTest extends TestCase
{
private Composer|MockObject|null $composer = null;
private Config|MockObject|null $composerConfig = null;
private IOInterface|MockObject|null $io = null;
private MockObject|RootPackageInterface|null $package = null;
- protected function setUp(): void
+ public static function getDataForGetArrayConfig(): array
{
- $this->composer = $this->createMock(Composer::class);
- $this->composerConfig = $this->createMock(Config::class);
- $this->io = $this->createMock(IOInterface::class);
- $this->package = $this->createMock(RootPackageInterface::class);
-
- $this->composer->expects($this->any())->method('getPackage')->willReturn($this->package);
- $this->composer->expects($this->any())->method('getConfig')->willReturn($this->composerConfig);
+ return [['foo', [], []], ['foo', [42], [42]], ['foo', [42], [], ['foo' => [42]]]];
}
public static function getDataForGetConfig(): array
@@ -68,6 +56,26 @@ public static function getDataForGetConfig(): array
];
}
+ /**
+ * @dataProvider getDataForGetArrayConfig
+ *
+ * @param string $key The key.
+ * @param array $expected The expected value.
+ * @param array $default The default value.
+ * @param array $defaults The configured default values.
+ *
+ * @throws ParsingException
+ */
+ public function testGetArrayConfig(string $key, array $expected, array $default, array $defaults = []): void
+ {
+ $config = ConfigBuilder::build($this->composer, $defaults, $this->io);
+
+ self::assertSame(
+ $expected,
+ $config->getArray($key, $default),
+ );
+ }
+
/**
* @dataProvider getDataForGetConfig
*
@@ -76,17 +84,19 @@ public static function getDataForGetConfig(): array
* @param mixed $default The default value.
* @param string|null $env The env variable.
* @param array $defaults The configured default values.
+ *
+ * @throws ParsingException
*/
public function testGetConfig(
string $key,
mixed $expected,
mixed $default = null,
string|null $env = null,
- array $defaults = []
+ array $defaults = [],
): void {
// add env variables
if (null !== $env) {
- \putenv($env);
+ putenv($env);
}
$globalLogComposer = true;
@@ -94,11 +104,11 @@ public function testGetConfig(
$globalPath = realpath(__DIR__ . '/../Fixtures/package/global');
- $this->composerConfig->expects($this->any())->method('has')->with('home')->willReturn(true);
- $this->composerConfig->expects($this->any())->method('get')->with('home')->willReturn($globalPath);
+ $this->composerConfig->expects(self::any())->method('has')->with('home')->willReturn(true);
+ $this->composerConfig->expects(self::any())->method('get')->with('home')->willReturn($globalPath);
$this->package
- ->expects($this->any())
+ ->expects(self::any())
->method('getConfig')
->willReturn(
[
@@ -118,25 +128,25 @@ public function testGetConfig(
],
);
- if (\str_starts_with($key, 'global-')) {
- $this->io->expects($this->atLeast(2))->method('isDebug')->willReturn(true);
+ if (str_starts_with($key, 'global-')) {
+ $this->io->expects(self::atLeast(2))->method('isDebug')->willReturn(true);
$globalLogComposer = false;
$globalLogConfig = false;
$this->io
- ->expects($this->atLeastOnce())
+ ->expects(self::atLeastOnce())
->method('writeError')
->willReturnCallback(
static function ($message) use ($globalPath, &$globalLogComposer, &$globalLogConfig): void {
- if (\sprintf('Loading Foxy config in file %s/composer.json', $globalPath)) {
+ if (sprintf('Loading Foxy config in file %s/composer.json', $globalPath)) {
$globalLogComposer = true;
}
- if (\sprintf('Loading Foxy config in file %s/config.json', $globalPath)) {
+ if (sprintf('Loading Foxy config in file %s/config.json', $globalPath)) {
$globalLogConfig = true;
}
- }
+ },
);
}
@@ -145,63 +155,70 @@ static function ($message) use ($globalPath, &$globalLogComposer, &$globalLogCon
// remove env variables
if (null !== $env) {
- $envKey = \substr($env, 0, \strpos($env, '='));
-
- \putenv($envKey);
+ $envKey = substr($env, 0, strpos($env, '='));
+ putenv($envKey);
- $this->assertFalse(\getenv($envKey));
+ self::assertFalse(
+ getenv($envKey),
+ );
}
- $this->assertTrue($globalLogComposer);
- $this->assertTrue($globalLogConfig);
- $this->assertSame($expected, $value);
- // test cache
- $this->assertSame($expected, $config->get($key, $default));
- }
-
- public static function getDataForGetArrayConfig(): array
- {
- return [['foo', [], []], ['foo', [42], [42]], ['foo', [42], [], ['foo' => [42]]]];
+ self::assertTrue(
+ $globalLogComposer,
+ );
+ self::assertTrue(
+ $globalLogConfig,
+ );
+ self::assertSame(
+ $expected,
+ $value,
+ );
+ self::assertSame(
+ $expected,
+ $config->get($key, $default),
+ );
}
/**
- * @dataProvider getDataForGetArrayConfig
- *
- * @param string $key The key.
- * @param array $expected The expected value.
- * @param array $default The default value.
- * @param array $defaults The configured default values.
+ * @throws Exception|ParsingException
*/
- public function testGetArrayConfig(string $key, array $expected, array $default, array $defaults = []): void
- {
- $config = ConfigBuilder::build($this->composer, $defaults, $this->io);
-
- $this->assertSame($expected, $config->getArray($key, $default));
- }
-
public function testGetEnvConfigWithInvalidJson(): void
{
- $this->expectException(\Foxy\Exception\RuntimeException::class);
+ $this->expectException(RuntimeException::class);
$this->expectExceptionMessage('The "FOXY__ENV_JSON" environment variable isn\'t a valid JSON');
- \putenv('FOXY__ENV_JSON="{"foo"}"');
+ putenv('FOXY__ENV_JSON="{"foo"}"');
$config = ConfigBuilder::build($this->composer, [], $this->io);
$ex = null;
try {
$config->get('env-json');
- } catch (\Exception $e) {
+ } catch (Exception $e) {
$ex = $e;
}
- \putenv('FOXY__ENV_JSON');
- $this->assertFalse(\getenv('FOXY__ENV_JSON'));
+ putenv('FOXY__ENV_JSON');
+
+ self::assertFalse(
+ getenv('FOXY__ENV_JSON'),
+ );
if (null === $ex) {
- throw new \Exception('The expected exception was not thrown');
+ throw new Exception('The expected exception was not thrown');
}
throw $ex;
}
+
+ protected function setUp(): void
+ {
+ $this->composer = $this->createMock(Composer::class);
+ $this->composerConfig = $this->createMock(Config::class);
+ $this->io = $this->createMock(IOInterface::class);
+ $this->package = $this->createMock(RootPackageInterface::class);
+
+ $this->composer->expects(self::any())->method('getPackage')->willReturn($this->package);
+ $this->composer->expects(self::any())->method('getConfig')->willReturn($this->composerConfig);
+ }
}
diff --git a/tests/Converter/SemverConverterTest.php b/tests/Converter/SemverConverterTest.php
index 196b879..5dc4575 100644
--- a/tests/Converter/SemverConverterTest.php
+++ b/tests/Converter/SemverConverterTest.php
@@ -2,54 +2,18 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Converter;
-use Foxy\Converter\SemverConverter;
-use Foxy\Converter\VersionConverterInterface;
+use Foxy\Converter\{SemverConverter, VersionConverterInterface};
use PHPUnit\Framework\TestCase;
-/**
- * Tests for the conversion of Semver syntax to composer syntax.
- *
- * @author François Pluchino
- *
- * @internal
- */
+use function ctype_alpha;
+use function in_array;
+
final class SemverConverterTest extends TestCase
{
private VersionConverterInterface|null $converter = null;
- protected function setUp(): void
- {
- $this->converter = new SemverConverter();
- }
-
- protected function tearDown(): void
- {
- $this->converter = null;
- }
-
- /**
- * @dataProvider getTestVersions
- */
- public function testConverter(string|null $semver, string $composer): void
- {
- $this->assertEquals($composer, $this->converter->convertVersion($semver));
-
- if (!\ctype_alpha((string) $semver) && !\in_array($semver, [null, ''], true)) {
- $this->assertEquals('v' . $composer, $this->converter->convertVersion('v' . $semver));
- }
- }
-
public static function getTestVersions(): array
{
return [
@@ -100,4 +64,32 @@ public static function getTestVersions(): array
['', '*'],
];
}
+
+ /**
+ * @dataProvider getTestVersions
+ */
+ public function testConverter(string|null $semver, string $composer): void
+ {
+ self::assertSame(
+ $composer,
+ $this->converter->convertVersion($semver),
+ );
+
+ if (!ctype_alpha((string) $semver) && !in_array($semver, [null, ''], true)) {
+ self::assertSame(
+ 'v' . $composer,
+ $this->converter->convertVersion('v' . $semver),
+ );
+ }
+ }
+
+ protected function setUp(): void
+ {
+ $this->converter = new SemverConverter();
+ }
+
+ protected function tearDown(): void
+ {
+ $this->converter = null;
+ }
}
diff --git a/tests/Event/GetAssetsEventTest.php b/tests/Event/GetAssetsEventTest.php
index d976bb1..b40babf 100644
--- a/tests/Event/GetAssetsEventTest.php
+++ b/tests/Event/GetAssetsEventTest.php
@@ -2,26 +2,10 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Event;
use Foxy\Event\GetAssetsEvent;
-/**
- * Tests for get assets event.
- *
- * @author François Pluchino
- *
- * @internal
- */
final class GetAssetsEventTest extends SolveEvent
{
private array $assets = ['@composer-asset/foo--bar' => 'file:./vendor/foxy/composer-asset/foo/bar'];
@@ -31,30 +15,31 @@ public function getEvent(): GetAssetsEvent
return new GetAssetsEvent($this->assetDir, $this->packages, $this->assets);
}
- public function testHasAsset(): void
- {
- $event = $this->getEvent();
-
- $this->assertTrue($event->hasAsset('@composer-asset/foo--bar'));
- }
-
public function testAddAsset(): void
{
$assetPackageName = '@composer-asset/bar--foo';
$assetPackagePath = 'file:./vendor/foxy/composer-asset/bar/foo';
$event = $this->getEvent();
- $this->assertFalse($event->hasAsset($assetPackageName));
+ self::assertFalse(
+ $event->hasAsset($assetPackageName),
+ );
$event->addAsset($assetPackageName, $assetPackagePath);
- $this->assertTrue($event->hasAsset($assetPackageName));
+ self::assertTrue(
+ $event->hasAsset($assetPackageName),
+ );
}
public function testGetAssets(): void
{
$event = $this->getEvent();
- $this->assertSame($this->assets, $event->getAssets());
+
+ self::assertSame(
+ $this->assets,
+ $event->getAssets(),
+ );
$expectedAssets = [
'@composer-asset/foo--bar' => 'file:./vendor/foxy/composer-asset/foo/bar',
@@ -63,6 +48,18 @@ public function testGetAssets(): void
$event->addAsset('@composer-asset/bar--foo', 'file:./vendor/foxy/composer-asset/bar/foo');
- $this->assertSame($expectedAssets, $event->getAssets());
+ self::assertSame(
+ $expectedAssets,
+ $event->getAssets(),
+ );
+ }
+
+ public function testHasAsset(): void
+ {
+ $event = $this->getEvent();
+
+ self::assertTrue(
+ $event->hasAsset('@composer-asset/foo--bar'),
+ );
}
}
diff --git a/tests/Event/PostSolveEventTest.php b/tests/Event/PostSolveEventTest.php
index 96a4c1c..8400d4f 100644
--- a/tests/Event/PostSolveEventTest.php
+++ b/tests/Event/PostSolveEventTest.php
@@ -2,26 +2,10 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Event;
use Foxy\Event\PostSolveEvent;
-/**
- * Tests for post solve event.
- *
- * @author François Pluchino
- *
- * @internal
- */
final class PostSolveEventTest extends SolveEvent
{
public function getEvent(): PostSolveEvent
@@ -33,6 +17,9 @@ public function testGetRunResult(): void
{
$event = $this->getEvent();
- $this->assertSame(42, $event->getRunResult());
+ self::assertSame(
+ 42,
+ $event->getRunResult(),
+ );
}
}
diff --git a/tests/Event/PreSolveEventTest.php b/tests/Event/PreSolveEventTest.php
index 5e5eef1..9ad55b7 100644
--- a/tests/Event/PreSolveEventTest.php
+++ b/tests/Event/PreSolveEventTest.php
@@ -2,26 +2,10 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Event;
use Foxy\Event\PreSolveEvent;
-/**
- * Tests for pre solve event.
- *
- * @author François Pluchino
- *
- * @internal
- */
final class PreSolveEventTest extends SolveEvent
{
public function getEvent(): PreSolveEvent
diff --git a/tests/Event/SolveEvent.php b/tests/Event/SolveEvent.php
index d1baec2..add9977 100644
--- a/tests/Event/SolveEvent.php
+++ b/tests/Event/SolveEvent.php
@@ -2,61 +2,52 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Event;
use Composer\Package\PackageInterface;
use Foxy\Event\AbstractSolveEvent;
+use PHPUnit\Framework\MockObject\Exception;
use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+use const DIRECTORY_SEPARATOR;
-/**
- * Tests for solve events.
- *
- * @author François Pluchino
- */
-abstract class SolveEvent extends \PHPUnit\Framework\TestCase
+abstract class SolveEvent extends TestCase
{
protected string $assetDir = '';
protected PackageInterface|MockObject|array|null $packages = null;
- protected function setUp(): void
- {
- $this->assetDir = sys_get_temp_dir() . \DIRECTORY_SEPARATOR . uniqid('foxy_event_test_', true);
- $this->packages = [$this->createMock(PackageInterface::class)];
- }
-
- protected function tearDown(): void
- {
- $this->assetDir = '';
- $this->packages = null;
- }
-
/**
* Get the event instance.
- *
- * @return AbstractSolveEvent
*/
- abstract public function getEvent();
+ abstract public function getEvent(): AbstractSolveEvent;
public function testGetAssetDir(): void
{
$event = $this->getEvent();
- $this->assertSame($this->assetDir, $event->getAssetDir());
+ self::assertSame($this->assetDir, $event->getAssetDir());
}
public function testGetPackages(): void
{
$event = $this->getEvent();
- $this->assertSame($this->packages, $event->getPackages());
+ self::assertSame($this->packages, $event->getPackages());
+ }
+
+ /**
+ * @throws Exception
+ */
+ protected function setUp(): void
+ {
+ $this->assetDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('foxy_event_test_', true);
+ $this->packages = [$this->createMock(PackageInterface::class)];
+ }
+
+ protected function tearDown(): void
+ {
+ $this->assetDir = '';
+ $this->packages = null;
}
}
diff --git a/tests/Fallback/AssetFallbackTest.php b/tests/Fallback/AssetFallbackTest.php
index 12871b1..15dde15 100644
--- a/tests/Fallback/AssetFallbackTest.php
+++ b/tests/Fallback/AssetFallbackTest.php
@@ -2,15 +2,6 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Fallback;
use Composer\IO\IOInterface;
@@ -19,56 +10,27 @@
use Foxy\Exception\RuntimeException;
use Foxy\Fallback\AssetFallback;
use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
use Xepozz\InternalMocker\MockerState;
-/**
- * Tests for composer fallback.
- *
- * @author François Pluchino
- *
- * @internal
- */
-final class AssetFallbackTest extends \PHPUnit\Framework\TestCase
+use function chdir;
+use function file_put_contents;
+
+use const DIRECTORY_SEPARATOR;
+
+final class AssetFallbackTest extends TestCase
{
protected AssetFallback|null $assetFallback = null;
private Config|null $config = null;
- private IOInterface|MockObject|null $io = null;
+ private string|null $cwd = '';
private Filesystem|MockObject|null $fs = null;
- private \Symfony\Component\Filesystem\Filesystem|null $sfs = null;
+ private IOInterface|MockObject|null $io = null;
private string|null $oldCwd = '';
- private string|null $cwd = '';
-
- protected function setUp(): void
- {
- parent::setUp();
-
- $this->oldCwd = getcwd();
- $this->cwd = sys_get_temp_dir() . \DIRECTORY_SEPARATOR . uniqid('foxy_asset_fallback_test_', true);
- $this->config = new Config(['fallback-asset' => true]);
- $this->io = $this->createMock(IOInterface::class);
- $this->fs = $this->createMock(Filesystem::class);
- $this->sfs = new \Symfony\Component\Filesystem\Filesystem();
- $this->sfs->mkdir($this->cwd);
-
- \chdir($this->cwd);
-
- $this->assetFallback = new AssetFallback($this->io, $this->config, 'package.json', $this->fs);
- }
+ private \Symfony\Component\Filesystem\Filesystem|null $sfs = null;
- protected function tearDown(): void
+ public static function getRestoreData(): array
{
- parent::tearDown();
-
- \chdir($this->oldCwd);
-
- $this->sfs->remove($this->cwd);
- $this->config = null;
- $this->io = null;
- $this->fs = null;
- $this->sfs = null;
- $this->assetFallback = null;
- $this->oldCwd = null;
- $this->cwd = null;
+ return [[true], [false]];
}
public static function getSaveData(): array
@@ -77,30 +39,81 @@ public static function getSaveData(): array
}
/**
- * @dataProvider getSaveData
+ * @dataProvider getRestoreData
*/
- public function testSave(bool $withPackageFile): void
+ public function testRestore(bool $withPackageFile): void
{
+ $content = '{}';
+ $path = $this->cwd . '/package.json';
+
if ($withPackageFile) {
- \file_put_contents($this->cwd . '/package.json', '{}');
+ file_put_contents($path, $content);
}
- $this->assertInstanceOf(AssetFallback::class, $this->assetFallback->save());
+ $this->io->expects(self::once())->method('write');
+
+ $this->fs->expects(self::once())->method('remove')->with('package.json');
+
+ $this->assetFallback->save();
+ $this->assetFallback->restore();
+
+ if ($withPackageFile) {
+ self::assertFileExists($path);
+ self::assertSame($content, file_get_contents($path));
+ } else {
+ self::assertFileDoesNotExist($path);
+ }
}
- public function testSaveThrowsWhenFileCannotBeRead(): void
+ public function testRestoreThrowsWhenRemoveFails(): void
{
$path = $this->cwd . '/package.json';
+ file_put_contents($path, '{}');
- \file_put_contents($path, '{}');
- $this->assertFileExists($path);
+ $this->io->expects(self::once())->method('write');
- MockerState::addCondition('Foxy\\Fallback', 'file_get_contents', ['package.json', false, null, 0, null], false);
+ $this->fs
+ ->expects(self::once())
+ ->method('remove')
+ ->with('package.json')
+ ->willThrowException(new RuntimeException('Remove failed.'));
+
+ $this->assetFallback->save();
$this->expectException(RuntimeException::class);
- $this->expectExceptionMessage('Unable to read fallback asset file "package.json".');
+ $this->expectExceptionMessage('Unable to remove fallback asset file "package.json".');
+
+ try {
+ $this->assetFallback->restore();
+ } catch (RuntimeException $exception) {
+ $previous = $exception->getPrevious();
+
+ self::assertInstanceOf(\RuntimeException::class, $previous);
+ self::assertSame('Remove failed.', $previous->getMessage());
+
+ throw $exception;
+ }
+ }
+
+ public function testRestoreThrowsWhenWriteFails(): void
+ {
+ $content = '{}';
+ $path = $this->cwd . '/package.json';
+
+ file_put_contents($path, $content);
+
+ $this->io->expects(self::once())->method('write');
+
+ $this->fs->expects(self::once())->method('remove')->with('package.json');
$this->assetFallback->save();
+
+ MockerState::addCondition('Foxy\\Fallback', 'file_put_contents', ['package.json', $content, 0, null], false);
+
+ $this->expectException(RuntimeException::class);
+ $this->expectExceptionMessage('Unable to write fallback asset file "package.json".');
+
+ $this->assetFallback->restore();
}
public function testRestoreWithDisableOption(): void
@@ -108,93 +121,70 @@ public function testRestoreWithDisableOption(): void
$config = new Config(['fallback-asset' => false]);
$assetFallback = new AssetFallback($this->io, $config, 'package.json', $this->fs);
- $this->io->expects($this->never())->method('write');
+ $this->io->expects(self::never())->method('write');
- $this->fs->expects($this->never())->method('remove');
+ $this->fs->expects(self::never())->method('remove');
$assetFallback->restore();
}
- public static function getRestoreData(): array
- {
- return [[true], [false]];
- }
-
/**
- * @dataProvider getRestoreData
+ * @dataProvider getSaveData
*/
- public function testRestore(bool $withPackageFile): void
+ public function testSave(bool $withPackageFile): void
{
- $content = '{}';
- $path = $this->cwd . '/package.json';
-
if ($withPackageFile) {
- file_put_contents($path, $content);
+ file_put_contents($this->cwd . '/package.json', '{}');
}
- $this->io->expects($this->once())->method('write');
-
- $this->fs->expects($this->once())->method('remove')->with('package.json');
-
- $this->assetFallback->save();
- $this->assetFallback->restore();
-
- if ($withPackageFile) {
- $this->assertFileExists($path);
- $this->assertSame($content, file_get_contents($path));
- } else {
- $this->assertFileDoesNotExist($path);
- }
+ self::assertInstanceOf(AssetFallback::class, $this->assetFallback->save());
}
- public function testRestoreThrowsWhenWriteFails(): void
+ public function testSaveThrowsWhenFileCannotBeRead(): void
{
- $content = '{}';
$path = $this->cwd . '/package.json';
- \file_put_contents($path, $content);
-
- $this->io->expects($this->once())->method('write');
-
- $this->fs->expects($this->once())->method('remove')->with('package.json');
+ file_put_contents($path, '{}');
+ self::assertFileExists($path);
- $this->assetFallback->save();
-
- MockerState::addCondition('Foxy\\Fallback', 'file_put_contents', ['package.json', $content, 0, null], false);
+ MockerState::addCondition('Foxy\\Fallback', 'file_get_contents', ['package.json', false, null, 0, null], false);
$this->expectException(RuntimeException::class);
- $this->expectExceptionMessage('Unable to write fallback asset file "package.json".');
+ $this->expectExceptionMessage('Unable to read fallback asset file "package.json".');
- $this->assetFallback->restore();
+ $this->assetFallback->save();
}
- public function testRestoreThrowsWhenRemoveFails(): void
+ protected function setUp(): void
{
- $path = $this->cwd . '/package.json';
- \file_put_contents($path, '{}');
-
- $this->io->expects($this->once())->method('write');
+ parent::setUp();
- $this->fs
- ->expects($this->once())
- ->method('remove')
- ->with('package.json')
- ->willThrowException(new \RuntimeException('Remove failed.'));
+ $this->oldCwd = getcwd();
+ $this->cwd = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('foxy_asset_fallback_test_', true);
+ $this->config = new Config(['fallback-asset' => true]);
+ $this->io = $this->createMock(IOInterface::class);
+ $this->fs = $this->createMock(Filesystem::class);
+ $this->sfs = new \Symfony\Component\Filesystem\Filesystem();
+ $this->sfs->mkdir($this->cwd);
- $this->assetFallback->save();
+ chdir($this->cwd);
- $this->expectException(RuntimeException::class);
- $this->expectExceptionMessage('Unable to remove fallback asset file "package.json".');
+ $this->assetFallback = new AssetFallback($this->io, $this->config, 'package.json', $this->fs);
+ }
- try {
- $this->assetFallback->restore();
- } catch (RuntimeException $exception) {
- $previous = $exception->getPrevious();
+ protected function tearDown(): void
+ {
+ parent::tearDown();
- $this->assertInstanceOf(\RuntimeException::class, $previous);
- $this->assertSame('Remove failed.', $previous->getMessage());
+ chdir($this->oldCwd);
- throw $exception;
- }
+ $this->sfs->remove($this->cwd);
+ $this->config = null;
+ $this->io = null;
+ $this->fs = null;
+ $this->sfs = null;
+ $this->assetFallback = null;
+ $this->oldCwd = null;
+ $this->cwd = null;
}
}
diff --git a/tests/Fallback/ComposerFallbackTest.php b/tests/Fallback/ComposerFallbackTest.php
index 2b5ae87..fe6a1f1 100644
--- a/tests/Fallback/ComposerFallbackTest.php
+++ b/tests/Fallback/ComposerFallbackTest.php
@@ -2,15 +2,6 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Fallback;
use Composer\Composer;
@@ -20,81 +11,37 @@
use Composer\IO\IOInterface;
use Composer\Repository\RepositoryManager;
use Composer\Util\Filesystem;
+use Exception;
use Foxy\Config\Config;
use Foxy\Fallback\ComposerFallback;
use Foxy\Util\LockerUtil;
+use JsonException;
use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
use Symfony\Component\Console\Input\InputInterface;
-/**
- * Tests for composer fallback.
- *
- * @author François Pluchino
- *
- * @internal
- */
-final class ComposerFallbackTest extends \PHPUnit\Framework\TestCase
+use function chdir;
+use function count;
+use function file_put_contents;
+
+use const DIRECTORY_SEPARATOR;
+
+final class ComposerFallbackTest extends TestCase
{
- private Config|null $config = null;
private Composer|MockObject|null $composer = null;
- private IOInterface|MockObject|null $io = null;
- private InputInterface|MockObject|null $input = null;
+ private ComposerFallback|null $composerFallback = null;
+ private Config|null $config = null;
+ private string|null $cwd = '';
private Filesystem|MockObject|null $fs = null;
+ private InputInterface|MockObject|null $input = null;
private Installer|MockObject|null $installer = null;
- private \Symfony\Component\Filesystem\Filesystem|null $sfs = null;
+ private IOInterface|MockObject|null $io = null;
private string|null $oldCwd = '';
- private string|null $cwd = '';
- private ComposerFallback|null $composerFallback = null;
-
- protected function setUp(): void
- {
- parent::setUp();
-
- $this->oldCwd = getcwd();
- $this->cwd = sys_get_temp_dir() . \DIRECTORY_SEPARATOR . uniqid('foxy_composer_fallback_test_', true);
- $this->config = new Config(['fallback-composer' => true]);
- $this->composer = $this->createMock(Composer::class);
- $this->io = $this->createMock(IOInterface::class);
- $this->input = $this->createMock(InputInterface::class);
- $this->fs = $this->createMock(Filesystem::class);
- /** @var Installer|MockObject */
- $this->installer = $this
- ->getMockBuilder(Installer::class)
- ->disableOriginalConstructor()
- ->onlyMethods(['run'])
- ->getMock();
- $this->sfs = new \Symfony\Component\Filesystem\Filesystem();
- $this->sfs->mkdir($this->cwd);
-
- \chdir($this->cwd);
-
- $this->composerFallback = new ComposerFallback(
- $this->composer,
- $this->io,
- $this->config,
- $this->input,
- $this->fs,
- $this->installer
- );
- }
+ private \Symfony\Component\Filesystem\Filesystem|null $sfs = null;
- protected function tearDown(): void
+ public static function getRestoreData(): array
{
- parent::tearDown();
-
- \chdir($this->oldCwd);
-
- $this->sfs->remove($this->cwd);
- $this->config = null;
- $this->composer = null;
- $this->io = null;
- $this->input = null;
- $this->fs = null;
- $this->installer = null;
- $this->sfs = null;
- $this->composerFallback = null;
- $this->oldCwd = null;
- $this->cwd = null;
+ return [[[]], [[['name' => 'foo/bar', 'version' => '1.0.0.0']]]];
}
public static function getSaveData(): array
@@ -102,45 +49,10 @@ public static function getSaveData(): array
return [[true], [false]];
}
- /**
- * @dataProvider getSaveData
- */
- public function testSave(bool $withLockFile): void
- {
- $rm = $this->createMock(RepositoryManager::class);
-
- $this->composer->expects($this->any())->method('getRepositoryManager')->willReturn($rm);
-
- $im = $this->createMock(InstallationManager::class);
-
- $this->composer->expects($this->any())->method('getInstallationManager')->willReturn($im);
-
- \file_put_contents($this->cwd . '/composer.json', '{}');
-
- if ($withLockFile) {
- \file_put_contents($this->cwd . '/composer.lock', json_encode(['content-hash' => 'HASH_VALUE']));
- }
-
- $this->assertInstanceOf(ComposerFallback::class, $this->composerFallback->save());
- }
-
- public function testRestoreWithDisableOption(): void
- {
- $config = new Config(['fallback-composer' => false]);
- $composerFallback = new ComposerFallback($this->composer, $this->io, $config, $this->input);
-
- $this->io->expects($this->never())->method('write');
-
- $composerFallback->restore();
- }
-
- public static function getRestoreData(): array
- {
- return [[[]], [[['name' => 'foo/bar', 'version' => '1.0.0.0']]]];
- }
-
/**
* @dataProvider getRestoreData
+ *
+ * @throws Exception|JsonException
*/
public function testRestore(array $packages): void
{
@@ -149,8 +61,8 @@ public function testRestore(array $packages): void
$lockFile = 'composer.lock';
$vendorDir = $this->cwd . '/vendor/';
- \file_put_contents($this->cwd . '/' . $composerFile, $composerContent);
- \file_put_contents(
+ file_put_contents($this->cwd . '/' . $composerFile, $composerContent);
+ file_put_contents(
$this->cwd . '/' . $lockFile,
json_encode(
[
@@ -158,52 +70,143 @@ public function testRestore(array $packages): void
'packages' => $packages,
'packages-dev' => [],
'prefer-stable' => true,
- ]
- )
+ ],
+ JSON_THROW_ON_ERROR,
+ ),
);
$this->input
- ->expects($this->any())
+ ->expects(self::any())
->method('getOption')
- ->willReturnCallback(fn ($option) => 'verbose' === $option ? false : null);
+ ->willReturnCallback(fn($option): bool|null => 'verbose' === $option ? false : null);
$ed = $this->createMock(EventDispatcher::class);
- $this->composer->expects($this->any())->method('getEventDispatcher')->willReturn($ed);
+ $this->composer->expects(self::any())->method('getEventDispatcher')->willReturn($ed);
$rm = $this->createMock(RepositoryManager::class);
- $this->composer->expects($this->any())->method('getRepositoryManager')->willReturn($rm);
+ $this->composer->expects(self::any())->method('getRepositoryManager')->willReturn($rm);
$im = $this->createMock(InstallationManager::class);
- $this->composer->expects($this->any())->method('getInstallationManager')->willReturn($im);
- $this->io->expects($this->once())->method('write');
+ $this->composer->expects(self::any())->method('getInstallationManager')->willReturn($im);
+ $this->io->expects(self::once())->method('write');
$locker = LockerUtil::getLocker($this->io, $im, $composerFile);
- $this->composer->expects($this->atLeastOnce())->method('getLocker')->willReturn($locker);
+ $this->composer->expects(self::atLeastOnce())->method('getLocker')->willReturn($locker);
$config = $this->getMockBuilder(\Composer\Config::class)
->disableOriginalConstructor()
->onlyMethods(['get'])
->getMock();
- $this->composer->expects($this->atLeastOnce())->method('getConfig')->willReturn($config);
+ $this->composer->expects(self::atLeastOnce())->method('getConfig')->willReturn($config);
$config
- ->expects($this->atLeastOnce())
+ ->expects(self::atLeastOnce())
->method('get')
- ->willReturnCallback(fn ($key, $default = null) => 'vendor-dir' === $key ? $vendorDir : $default);
+ ->willReturnCallback(fn($key, $default = null) => 'vendor-dir' === $key ? $vendorDir : $default);
- if (0 === \count($packages)) {
- $this->fs->expects($this->once())->method('remove')->with($vendorDir);
+ if (0 === count($packages)) {
+ $this->fs->expects(self::once())->method('remove')->with($vendorDir);
} else {
- $this->fs->expects($this->never())->method('remove');
- $this->installer->expects($this->once())->method('run');
+ $this->fs->expects(self::never())->method('remove');
+ $this->installer->expects(self::once())->method('run');
}
$this->composerFallback->save();
$this->composerFallback->restore();
}
+
+ /**
+ * @throws Exception
+ */
+ public function testRestoreWithDisableOption(): void
+ {
+ $config = new Config(['fallback-composer' => false]);
+ $composerFallback = new ComposerFallback($this->composer, $this->io, $config, $this->input);
+
+ $this->io->expects(self::never())->method('write');
+
+ $composerFallback->restore();
+ }
+
+ /**
+ * @dataProvider getSaveData
+ *
+ * @throws JsonException
+ */
+ public function testSave(bool $withLockFile): void
+ {
+ $rm = $this->createMock(RepositoryManager::class);
+
+ $this->composer->expects(self::any())->method('getRepositoryManager')->willReturn($rm);
+
+ $im = $this->createMock(InstallationManager::class);
+
+ $this->composer->expects(self::any())->method('getInstallationManager')->willReturn($im);
+
+ file_put_contents($this->cwd . '/composer.json', '{}');
+
+ if ($withLockFile) {
+ file_put_contents(
+ "{$this->cwd}/composer.lock",
+ json_encode(['content-hash' => 'HASH_VALUE'], JSON_THROW_ON_ERROR),
+ );
+ }
+
+ self::assertInstanceOf(ComposerFallback::class, $this->composerFallback->save());
+ }
+
+ protected function setUp(): void
+ {
+ parent::setUp();
+
+ $this->oldCwd = getcwd();
+ $this->cwd = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('foxy_composer_fallback_test_', true);
+ $this->config = new Config(['fallback-composer' => true]);
+ $this->composer = $this->createMock(Composer::class);
+ $this->io = $this->createMock(IOInterface::class);
+ $this->input = $this->createMock(InputInterface::class);
+ $this->fs = $this->createMock(Filesystem::class);
+ $this->installer = $this
+ ->getMockBuilder(Installer::class)
+ ->disableOriginalConstructor()
+ ->onlyMethods(['run'])
+ ->getMock();
+ $this->sfs = new \Symfony\Component\Filesystem\Filesystem();
+ $this->sfs->mkdir($this->cwd);
+
+ chdir($this->cwd);
+
+ $this->composerFallback = new ComposerFallback(
+ $this->composer,
+ $this->io,
+ $this->config,
+ $this->input,
+ $this->fs,
+ $this->installer,
+ );
+ }
+
+ protected function tearDown(): void
+ {
+ parent::tearDown();
+
+ chdir($this->oldCwd);
+
+ $this->sfs->remove($this->cwd);
+ $this->config = null;
+ $this->composer = null;
+ $this->io = null;
+ $this->input = null;
+ $this->fs = null;
+ $this->installer = null;
+ $this->sfs = null;
+ $this->composerFallback = null;
+ $this->oldCwd = null;
+ $this->cwd = null;
+ }
}
diff --git a/tests/Fixtures/Asset/StubAssetManager.php b/tests/Fixtures/Asset/StubAssetManager.php
index 1dade63..a449081 100644
--- a/tests/Fixtures/Asset/StubAssetManager.php
+++ b/tests/Fixtures/Asset/StubAssetManager.php
@@ -6,38 +6,34 @@
use Composer\IO\IOInterface;
use Composer\Package\RootPackageInterface;
-use Composer\Util\Filesystem;
-use Composer\Util\ProcessExecutor;
-use Foxy\Asset\AssetManagerInterface;
-use Foxy\Asset\AssetPackageInterface;
+use Composer\Util\{Filesystem, ProcessExecutor};
+use Foxy\Asset\{AssetManagerInterface, AssetPackageInterface};
use Foxy\Config\Config;
+use Foxy\Exception\RuntimeException;
use Foxy\Fallback\FallbackInterface;
-use RuntimeException;
-
-/**
- * Stub of AssetManagerInterface for tests.
- *
- * @copyright Copyright (C) 2026 Terabytesoftw.
- * @license https://opensource.org/license/mit/ MIT License
- */
+
final class StubAssetManager implements AssetManagerInterface
{
public function __construct(
IOInterface $io,
Config $config,
ProcessExecutor $executor,
- Filesystem $fs
- ) {
+ Filesystem $fs,
+ ) {}
+
+ public function addDependencies(RootPackageInterface $rootPackage, array $dependencies): AssetPackageInterface
+ {
+ throw new RuntimeException('Not used in this test.');
}
- public function getName(): string
+ public function getLockPackageName(): string
{
- return 'stub';
+ return 'stub-lock.json';
}
- public function isAvailable(): bool
+ public function getName(): string
{
- return true;
+ return 'stub';
}
public function getPackageName(): string
@@ -50,19 +46,14 @@ public function hasLockFile(): bool
return false;
}
- public function isInstalled(): bool
- {
- return false;
- }
-
- public function setFallback(FallbackInterface $fallback): self
+ public function isAvailable(): bool
{
- return $this;
+ return true;
}
- public function setUpdatable(bool $updatable): self
+ public function isInstalled(): bool
{
- return $this;
+ return false;
}
public function isUpdatable(): bool
@@ -75,22 +66,20 @@ public function isValidForUpdate(): bool
return false;
}
- public function getLockPackageName(): string
+ public function run(): int
{
- return 'stub-lock.json';
+ return 0;
}
- public function validate(): void
+ public function setFallback(FallbackInterface $fallback): self
{
+ return $this;
}
- public function addDependencies(RootPackageInterface $rootPackage, array $dependencies): AssetPackageInterface
+ public function setUpdatable(bool $updatable): self
{
- throw new RuntimeException('Not used in this test.');
+ return $this;
}
- public function run(): int
- {
- return 0;
- }
+ public function validate(): void {}
}
diff --git a/tests/Fixtures/Util/AbstractProcessExecutorMock.php b/tests/Fixtures/Util/AbstractProcessExecutorMock.php
index e193d49..0b26698 100644
--- a/tests/Fixtures/Util/AbstractProcessExecutorMock.php
+++ b/tests/Fixtures/Util/AbstractProcessExecutorMock.php
@@ -2,40 +2,30 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Fixtures\Util;
use Composer\Util\ProcessExecutor;
-/**
- * Mock of ProcessExecutor.
- *
- * @author François Pluchino
- */
+use function count;
+
abstract class AbstractProcessExecutorMock extends ProcessExecutor
{
- /**
- * @var array
- */
- private $expectedValues = [];
+ private array $executedCommands = [];
- /**
- * @var array
- */
- private $executedCommands = [];
+ private array $expectedValues = [];
+
+ private int $position = 0;
/**
- * @var int
+ * @param int $returnedCode The returned code
+ * @param null $output The output
*/
- private $position = 0;
+ public function addExpectedValues(int $returnedCode = 0, $output = null): static
+ {
+ $this->expectedValues[] = [$returnedCode, $output];
+
+ return $this;
+ }
public function doExecute($command, &$output = null, string|null $cwd = null): int
{
@@ -48,94 +38,67 @@ public function doExecute($command, &$output = null, string|null $cwd = null): i
return $returnedCode;
}
- /**
- * @param int $returnedCode The returned code
- * @param null $output The output
- *
- * @return self
- */
- public function addExpectedValues($returnedCode = 0, $output = null)
- {
- $this->expectedValues[] = [$returnedCode, $output];
-
- return $this;
- }
-
/**
* Get the executed command.
*
* @param int $position The position of executed command
- *
- * @return string|null
*/
- public function getExecutedCommand($position)
+ public function getExecutedCommand(int $position): int|string|null
{
return $this->getExecutedValue($position, 0);
}
/**
- * Get the executed returned code.
+ * Get the executed command.
*
* @param int $position The position of executed command
- *
- * @return int|null
*/
- public function getExecutedReturnedCode($position)
+ public function getExecutedOutput(int $position): int|string|null
{
- return $this->getExecutedValue($position, 1);
+ return $this->getExecutedValue($position, 2);
}
/**
- * Get the executed command.
+ * Get the executed returned code.
*
* @param int $position The position of executed command
- *
- * @return string|null
*/
- public function getExecutedOutput($position)
+ public function getExecutedReturnedCode(int $position): int|string|null
{
- return $this->getExecutedValue($position, 2);
+ return $this->getExecutedValue($position, 1);
}
/**
* Get the last executed command.
- *
- * @return string|null
*/
- public function getLastCommand()
+ public function getLastCommand(): int|string|null
{
- return $this->getExecutedCommand(\count($this->executedCommands) - 1);
+ return $this->getExecutedCommand(count($this->executedCommands) - 1);
}
/**
- * Get the last executed returned code.
- *
- * @return int|null
+ * Get the last executed output.
*/
- public function getLastReturnedCode()
+ public function getLastOutput(): int|string|null
{
- return $this->getExecutedReturnedCode(\count($this->executedCommands) - 1);
+ return $this->getExecutedOutput(count($this->executedCommands) - 1);
}
/**
- * Get the last executed output.
- *
- * @return string|null
+ * Get the last executed returned code.
*/
- public function getLastOutput()
+ public function getLastReturnedCode(): int|string|null
{
- return $this->getExecutedOutput(\count($this->executedCommands) - 1);
+ return $this->getExecutedReturnedCode(count($this->executedCommands) - 1);
}
/**
* Get the value of the executed command.
*
* @param int $position The position
- * @param int $index The index of value
- *
- * @return int|string|null
+ * @param int $index The index of value
*/
- private function getExecutedValue($position, int $index)
+ private function getExecutedValue(int $position, int $index): int|string|null
{
return isset($this->executedCommands[$position])
? $this->executedCommands[$position][$index]
diff --git a/tests/Fixtures/Util/ProcessExecutorMock.php b/tests/Fixtures/Util/ProcessExecutorMock.php
index 41ab712..168ba51 100644
--- a/tests/Fixtures/Util/ProcessExecutorMock.php
+++ b/tests/Fixtures/Util/ProcessExecutorMock.php
@@ -2,39 +2,12 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Fixtures\Util;
-use Composer\Composer;
-use Composer\Util\ProcessExecutor;
-
-/*
- * Mock of ProcessExecutor.
- *
- * @author François Pluchino
- */
-if (version_compare(Composer::VERSION, '2.3.0', '<')) {
- class ProcessExecutorMock extends AbstractProcessExecutorMock
- {
- public function execute($command, &$output = null, $cwd = null): int
- {
- return $this->doExecute($command, $output, $cwd);
- }
- }
-} else {
- class ProcessExecutorMock extends AbstractProcessExecutorMock
+class ProcessExecutorMock extends AbstractProcessExecutorMock
+{
+ public function execute($command, &$output = null, string|null $cwd = null): int
{
- public function execute($command, &$output = null, string|null $cwd = null): int
- {
- return $this->doExecute($command, $output, $cwd);
- }
+ return $this->doExecute($command, $output, $cwd);
}
}
diff --git a/tests/Fixtures/Util/ProcessExecutorMockTest.php b/tests/Fixtures/Util/ProcessExecutorMockTest.php
index e01e2cb..b205d08 100644
--- a/tests/Fixtures/Util/ProcessExecutorMockTest.php
+++ b/tests/Fixtures/Util/ProcessExecutorMockTest.php
@@ -2,76 +2,60 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace Foxy\Tests\Json;
-
-use Foxy\Tests\Fixtures\Util\ProcessExecutorMock;
-
-/**
- * Tests for the process executor mock.
- *
- * @author François Pluchino
- *
- * @internal
- */
-final class ProcessExecutorMockTest extends \PHPUnit\Framework\TestCase
+namespace Foxy\Tests\Fixtures\Util;
+
+use PHPUnit\Framework\TestCase;
+
+final class ProcessExecutorMockTest extends TestCase
{
- public function testExecuteWithoutExpectedValues(): void
+ public function testExecuteWithExpectedValues(): void
{
$executor = new ProcessExecutorMock();
+ $executor->addExpectedValues(0, 'TEST');
+ $executor->addExpectedValues(42, 'TEST 2');
+
$executor->execute('run', $output);
+ $executor->execute('run2', $output2);
- $this->assertSame('run', $executor->getExecutedCommand(0));
- $this->assertEquals(0, $executor->getExecutedReturnedCode(0));
- $this->assertNull($executor->getExecutedOutput(0));
+ self::assertSame('run', $executor->getExecutedCommand(0));
+ self::assertSame(0, $executor->getExecutedReturnedCode(0));
+ self::assertSame('TEST', $executor->getExecutedOutput(0));
- $this->assertNull($executor->getExecutedCommand(1));
- $this->assertNull($executor->getExecutedReturnedCode(1));
- $this->assertNull($executor->getExecutedOutput(1));
+ self::assertSame('run2', $executor->getExecutedCommand(1));
+ self::assertSame(42, $executor->getExecutedReturnedCode(1));
+ self::assertSame('TEST 2', $executor->getExecutedOutput(1));
- $this->assertSame('run', $executor->getLastCommand());
- $this->assertEquals(0, $executor->getLastReturnedCode());
- $this->assertNull($executor->getLastOutput());
+ self::assertNull($executor->getExecutedCommand(2));
+ self::assertNull($executor->getExecutedReturnedCode(2));
+ self::assertNull($executor->getExecutedOutput(2));
- $this->assertNull($output);
+ self::assertSame('run2', $executor->getLastCommand());
+ self::assertSame(42, $executor->getLastReturnedCode());
+ self::assertSame('TEST 2', $executor->getLastOutput());
+
+ self::assertSame('TEST', $output);
+ self::assertSame('TEST 2', $output2);
}
- public function testExecuteWithExpectedValues(): void
+ public function testExecuteWithoutExpectedValues(): void
{
$executor = new ProcessExecutorMock();
- $executor->addExpectedValues(0, 'TEST');
- $executor->addExpectedValues(42, 'TEST 2');
-
$executor->execute('run', $output);
- $executor->execute('run2', $output2);
-
- $this->assertSame('run', $executor->getExecutedCommand(0));
- $this->assertSame(0, $executor->getExecutedReturnedCode(0));
- $this->assertSame('TEST', $executor->getExecutedOutput(0));
- $this->assertSame('run2', $executor->getExecutedCommand(1));
- $this->assertSame(42, $executor->getExecutedReturnedCode(1));
- $this->assertSame('TEST 2', $executor->getExecutedOutput(1));
+ self::assertSame('run', $executor->getExecutedCommand(0));
+ self::assertEquals(0, $executor->getExecutedReturnedCode(0));
+ self::assertNull($executor->getExecutedOutput(0));
- $this->assertNull($executor->getExecutedCommand(2));
- $this->assertNull($executor->getExecutedReturnedCode(2));
- $this->assertNull($executor->getExecutedOutput(2));
+ self::assertNull($executor->getExecutedCommand(1));
+ self::assertNull($executor->getExecutedReturnedCode(1));
+ self::assertNull($executor->getExecutedOutput(1));
- $this->assertSame('run2', $executor->getLastCommand());
- $this->assertSame(42, $executor->getLastReturnedCode());
- $this->assertSame('TEST 2', $executor->getLastOutput());
+ self::assertSame('run', $executor->getLastCommand());
+ self::assertEquals(0, $executor->getLastReturnedCode());
+ self::assertNull($executor->getLastOutput());
- $this->assertSame('TEST', $output);
- $this->assertSame('TEST 2', $output2);
+ self::assertNull($output);
}
}
diff --git a/tests/Fixtures/Util/ThrowingProcessExecutorMock.php b/tests/Fixtures/Util/ThrowingProcessExecutorMock.php
index f5b8bf1..136e54a 100644
--- a/tests/Fixtures/Util/ThrowingProcessExecutorMock.php
+++ b/tests/Fixtures/Util/ThrowingProcessExecutorMock.php
@@ -2,29 +2,15 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Fixtures\Util;
use Composer\Util\ProcessExecutor;
+use Foxy\Exception\RuntimeException;
-/**
- * Mock of ProcessExecutor that always throws.
- *
- * @copyright Copyright (C) 2026 Terabytesoftw.
- * @license https://opensource.org/license/mit/ MIT License
- */
final class ThrowingProcessExecutorMock extends ProcessExecutor
{
public function execute($command, &$output = null, string|null $cwd = null): int
{
- throw new \RuntimeException('Process execution failed.');
+ throw new RuntimeException('Process execution failed.');
}
}
diff --git a/tests/Fixtures/package/global/theme/foo/bar/package.json b/tests/Fixtures/package/global/theme/foo/bar/package.json
index 2c63c08..0967ef4 100644
--- a/tests/Fixtures/package/global/theme/foo/bar/package.json
+++ b/tests/Fixtures/package/global/theme/foo/bar/package.json
@@ -1,2 +1 @@
-{
-}
+{}
diff --git a/tests/FoxyTest.php b/tests/FoxyTest.php
index dc58bb2..4dc2b5c 100644
--- a/tests/FoxyTest.php
+++ b/tests/FoxyTest.php
@@ -2,118 +2,103 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests;
use Composer\Composer;
use Composer\Config;
use Composer\DependencyResolver\Operation\InstallOperation;
-use Composer\Installer\InstallationManager;
-use Composer\Installer\PackageEvent;
+use Composer\Installer\{InstallationManager, PackageEvent};
use Composer\IO\IOInterface;
-use Composer\Package\Package;
-use Composer\Package\RootPackageInterface;
+use Composer\Package\{Package, RootPackageInterface};
use Composer\Repository\RepositoryManager;
use Composer\Script\Event;
+use Foxy\Exception\RuntimeException;
+use Foxy\Fallback\AssetFallback;
use Foxy\Foxy;
use Foxy\Solver\SolverInterface;
use Foxy\Tests\Fixtures\Asset\StubAssetManager;
use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use ReflectionClass;
+use ReflectionException;
+use Seld\JsonLint\ParsingException;
+
+use function getcwd;
use const PHP_VERSION_ID;
-final class FoxyTest extends \PHPUnit\Framework\TestCase
+final class FoxyTest extends TestCase
{
private Composer|MockObject $composer;
private Config $composerConfig;
private IOInterface $io;
private RootPackageInterface|MockObject $package;
- protected function setUp(): void
- {
- $this->composer = $this->createMock(Composer::class);
- $this->composerConfig = $this->createMock(Config::class);
- $this->io = $this->createMock(IOInterface::class);
- $this->package = $this->createMock(RootPackageInterface::class);
-
- $this->composer
- ->expects($this->any())
- ->method('getPackage')
- ->willReturn($this->package);
-
- $this->composer
- ->expects($this->any())
- ->method('getConfig')
- ->willReturn($this->composerConfig);
-
- $rm = $this->createMock(RepositoryManager::class);
-
- $this->composer
- ->expects($this->any())
- ->method('getRepositoryManager')
- ->willReturn($rm);
-
- $im = $this->createMock(InstallationManager::class);
-
- $this->composer
- ->expects($this->any())
- ->method('getInstallationManager')
- ->willReturn($im)
- ;
- }
-
- public function testGetSubscribedEvents(): void
+ public static function getSolveAssetsData(): array
{
- $this->assertCount(4, Foxy::getSubscribedEvents());
+ return [['solve_event_install', false], ['solve_event_update', true]];
}
+ /**
+ * @throws ParsingException
+ */
public function testActivate(): void
{
$foxy = new Foxy();
$foxy->activate($this->composer, $this->io);
$foxy->init();
- $this->assertTrue(true);
+ self::assertTrue(true);
}
- public function testDeactivate(): void
+ /**
+ * @throws ParsingException
+ */
+ public function testActivateBuildsAssetFallbackWithResolvedRootPackagePath(): void
{
+ $this->package
+ ->expects(self::any())
+ ->method('getConfig')
+ ->willReturn(['foxy' => ['manager' => 'npm', 'root-package-json-dir' => 'root-package']]);
+
$foxy = new Foxy();
- $foxy->deactivate($this->composer, $this->io);
+ $foxy->activate($this->composer, $this->io);
- $this->assertTrue(true);
- }
+ $foxyReflection = new ReflectionClass($foxy);
+ $assetFallbackProperty = $foxyReflection->getProperty('assetFallback');
+ $assetFallback = $assetFallbackProperty->getValue($foxy);
- public function testUninstall(): void
- {
- $foxy = new Foxy();
- $foxy->uninstall($this->composer, $this->io);
+ self::assertInstanceOf(AssetFallback::class, $assetFallback);
- $this->assertTrue(true);
+ $fallbackReflection = new ReflectionClass($assetFallback);
+
+ $pathProperty = $fallbackReflection->getProperty('path');
+ $expectedPath = rtrim((string) getcwd(), '/\\')
+ . DIRECTORY_SEPARATOR
+ . 'root-package'
+ . DIRECTORY_SEPARATOR
+ . 'package.json';
+
+ self::assertSame($expectedPath, $pathProperty->getValue($assetFallback));
}
+ /**
+ * @throws ParsingException
+ */
public function testActivateOnInstall(): void
{
$package = $this->createMock(Package::class);
- $package->expects($this->once())->method('getName')->willReturn('php-forge/foxy');
+ $package->expects(self::once())->method('getName')->willReturn('php-forge/foxy');
$operation = $this->createMock(InstallOperation::class);
- $operation->expects($this->once())->method('getPackage')->willReturn($package);
+ $operation->expects(self::once())->method('getPackage')->willReturn($package);
/** @var MockObject|PackageEvent $event */
$event = $this->createMock(PackageEvent::class);
- $event->expects($this->once())->method('getOperation')->willReturn($operation);
+ $event->expects(self::once())->method('getOperation')->willReturn($operation);
$foxy = new Foxy();
@@ -121,69 +106,20 @@ public function testActivateOnInstall(): void
$foxy->initOnInstall($event);
}
- public function testActivateWithInvalidManager(): void
- {
- $this->expectException(\Foxy\Exception\RuntimeException::class);
- $this->expectExceptionMessage('The asset manager "invalid_manager" doesn\'t exist');
-
- $this->package
- ->expects($this->any())
- ->method('getConfig')
- ->willReturn(['foxy' => ['manager' => 'invalid_manager']]);
-
- $foxy = new Foxy();
- $foxy->activate($this->composer, $this->io);
- }
-
- public function testActivateBuildsAssetFallbackWithResolvedRootPackagePath(): void
- {
- $this->package
- ->expects($this->any())
- ->method('getConfig')
- ->willReturn(['foxy' => ['manager' => 'npm', 'root-package-json-dir' => 'root-package']]);
-
- $foxy = new Foxy();
- $foxy->activate($this->composer, $this->io);
-
- $foxyReflection = new \ReflectionClass($foxy);
- $assetFallbackProperty = $foxyReflection->getProperty('assetFallback');
-
- if (PHP_VERSION_ID < 80500) {
- $assetFallbackProperty->setAccessible(true);
- }
-
- $assetFallback = $assetFallbackProperty->getValue($foxy);
-
- $this->assertInstanceOf(\Foxy\Fallback\AssetFallback::class, $assetFallback);
-
- $fallbackReflection = new \ReflectionClass($assetFallback);
- $pathProperty = $fallbackReflection->getProperty('path');
-
- if (PHP_VERSION_ID < 80500) {
- $pathProperty->setAccessible(true);
- }
-
- $expectedPath = rtrim((string) \getcwd(), '/\\')
- . DIRECTORY_SEPARATOR
- . 'root-package'
- . DIRECTORY_SEPARATOR
- . 'package.json';
-
- $this->assertSame($expectedPath, $pathProperty->getValue($assetFallback));
- }
-
+ /**
+ * @throws ParsingException|ReflectionException
+ */
public function testActivateUsesPackageNameForNonAbstractAssetManager(): void
{
$this->package
- ->expects($this->any())
+ ->expects(self::any())
->method('getConfig')
->willReturn(['foxy' => ['manager' => 'stub']]);
- $foxyReflection = new \ReflectionClass(Foxy::class);
+ $foxyReflection = new ReflectionClass(Foxy::class);
$assetManagersProperty = $foxyReflection->getProperty('assetManagers');
if (PHP_VERSION_ID < 80500) {
- $assetManagersProperty->setAccessible(true);
}
$originalAssetManagers = $assetManagersProperty->getValue();
@@ -196,28 +132,48 @@ public function testActivateUsesPackageNameForNonAbstractAssetManager(): void
$assetFallbackProperty = $foxyReflection->getProperty('assetFallback');
if (PHP_VERSION_ID < 80500) {
- $assetFallbackProperty->setAccessible(true);
}
$assetFallback = $assetFallbackProperty->getValue($foxy);
- $fallbackReflection = new \ReflectionClass($assetFallback);
+ $fallbackReflection = new ReflectionClass($assetFallback);
$pathProperty = $fallbackReflection->getProperty('path');
- if (PHP_VERSION_ID < 80500) {
- $pathProperty->setAccessible(true);
- }
-
- $this->assertSame('stub-package.json', $pathProperty->getValue($assetFallback));
+ self::assertSame('stub-package.json', $pathProperty->getValue($assetFallback));
} finally {
$assetManagersProperty->setValue(null, $originalAssetManagers);
}
}
- public static function getSolveAssetsData(): array
+ /**
+ * @throws ParsingException
+ */
+ public function testActivateWithInvalidManager(): void
{
- return [['solve_event_install', false], ['solve_event_update', true]];
+ $this->expectException(RuntimeException::class);
+ $this->expectExceptionMessage('The asset manager "invalid_manager" doesn\'t exist');
+
+ $this->package
+ ->expects(self::any())
+ ->method('getConfig')
+ ->willReturn(['foxy' => ['manager' => 'invalid_manager']]);
+
+ $foxy = new Foxy();
+ $foxy->activate($this->composer, $this->io);
+ }
+
+ public function testDeactivate(): void
+ {
+ $foxy = new Foxy();
+ $foxy->deactivate($this->composer, $this->io);
+
+ self::assertTrue(true);
+ }
+
+ public function testGetSubscribedEvents(): void
+ {
+ self::assertCount(4, Foxy::getSubscribedEvents());
}
/**
@@ -230,12 +186,53 @@ public function testSolveAssets(string $eventName, bool $expectedUpdatable): voi
/** @var MockObject|SolverInterface $solver */
$solver = $this->createMock(SolverInterface::class);
- $solver->expects($this->once())->method('setUpdatable')->with($expectedUpdatable);
- $solver->expects($this->once())->method('solve')->with($this->composer, $this->io);
+ $solver->expects(self::once())->method('setUpdatable')->with($expectedUpdatable);
+ $solver->expects(self::once())->method('solve')->with($this->composer, $this->io);
$foxy = new Foxy();
$foxy->setSolver($solver);
$foxy->solveAssets($event);
}
+
+ public function testUninstall(): void
+ {
+ $foxy = new Foxy();
+ $foxy->uninstall($this->composer, $this->io);
+
+ self::assertTrue(true);
+ }
+
+ protected function setUp(): void
+ {
+ $this->composer = $this->createMock(Composer::class);
+ $this->composerConfig = $this->createMock(Config::class);
+ $this->io = $this->createMock(IOInterface::class);
+ $this->package = $this->createMock(RootPackageInterface::class);
+
+ $this->composer
+ ->expects(self::any())
+ ->method('getPackage')
+ ->willReturn($this->package);
+
+ $this->composer
+ ->expects(self::any())
+ ->method('getConfig')
+ ->willReturn($this->composerConfig);
+
+ $rm = $this->createMock(RepositoryManager::class);
+
+ $this->composer
+ ->expects(self::any())
+ ->method('getRepositoryManager')
+ ->willReturn($rm);
+
+ $im = $this->createMock(InstallationManager::class);
+
+ $this->composer
+ ->expects(self::any())
+ ->method('getInstallationManager')
+ ->willReturn($im)
+ ;
+ }
}
diff --git a/tests/Json/JsonFileTest.php b/tests/Json/JsonFileTest.php
index f4d6ca6..f041ca2 100644
--- a/tests/Json/JsonFileTest.php
+++ b/tests/Json/JsonFileTest.php
@@ -2,66 +2,44 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Json;
+use Exception;
use Foxy\Exception\RuntimeException;
use Foxy\Json\JsonFile;
-use PHPForge\Support\Assert;
+use PHPForge\Support\LineEndingNormalizer;
+use PHPUnit\Framework\TestCase;
+use Seld\JsonLint\ParsingException;
use Symfony\Component\Filesystem\Filesystem;
use Xepozz\InternalMocker\MockerState;
-/**
- * Tests for json file.
- *
- * @author François Pluchino
- *
- * @internal
- */
-final class JsonFileTest extends \PHPUnit\Framework\TestCase
+use function chdir;
+use function file_get_contents;
+
+use const DIRECTORY_SEPARATOR;
+
+final class JsonFileTest extends TestCase
{
- private Filesystem|null $sfs = null;
- private string|null $oldCwd = '';
private string|null $cwd = '';
+ private string|null $oldCwd = '';
+ private Filesystem|null $sfs = null;
- protected function setUp(): void
+ public function testGetArrayKeysThrowsWhenFileCannotBeRead(): void
{
- parent::setUp();
-
- $this->oldCwd = getcwd();
- $this->cwd = sys_get_temp_dir() . \DIRECTORY_SEPARATOR . uniqid('foxy_asset_json_file_test_', true);
- $this->sfs = new Filesystem();
- $this->sfs->mkdir($this->cwd);
-
- \chdir($this->cwd);
- }
+ $filename = './package.json';
- protected function tearDown(): void
- {
- parent::tearDown();
+ file_put_contents($filename, '{}');
- \chdir($this->oldCwd);
+ self::assertFileExists($filename);
- $this->sfs->remove($this->cwd);
- $this->sfs = null;
- $this->oldCwd = null;
- $this->cwd = null;
- }
+ MockerState::addCondition('Foxy\\Json', 'file_get_contents', [$filename, false, null, 0, null], false);
- public function testGetArrayKeysWithoutFile(): void
- {
- $filename = './package.json';
$jsonFile = new JsonFile($filename);
- $this->assertSame([], $jsonFile->getArrayKeys());
+ $this->expectException(RuntimeException::class);
+ $this->expectExceptionMessageMatches('/Unable to read json file ".+package\.json"\./');
+
+ $jsonFile->getArrayKeys();
}
public function testGetArrayKeysWithExistingFile(): void
@@ -76,37 +54,23 @@ public function testGetArrayKeysWithExistingFile(): void
JSON;
$filename = './package.json';
- file_put_contents($filename, $content);
- $this->assertFileExists($filename);
- $jsonFile = new JsonFile($filename);
-
- $this->assertSame($expected, $jsonFile->getArrayKeys());
- }
-
- public function testGetArrayKeysThrowsWhenFileCannotBeRead(): void
- {
- $filename = './package.json';
-
- file_put_contents($filename, '{}');
- $this->assertFileExists($filename);
+ file_put_contents($filename, $content);
- MockerState::addCondition('Foxy\\Json', 'file_get_contents', [$filename, false, null, 0, null], false);
+ self::assertFileExists($filename);
$jsonFile = new JsonFile($filename);
- $this->expectException(RuntimeException::class);
- $this->expectExceptionMessageMatches('/Unable to read json file ".+package\.json"\./');
-
- $jsonFile->getArrayKeys();
+ self::assertSame($expected, $jsonFile->getArrayKeys());
}
- public function testGetIndentWithoutFile(): void
+ public function testGetArrayKeysWithoutFile(): void
{
$filename = './package.json';
+
$jsonFile = new JsonFile($filename);
- $this->assertSame(4, $jsonFile->getIndent());
+ self::assertSame([], $jsonFile->getArrayKeys());
}
public function testGetIndentWithExistingFile(): void
@@ -118,70 +82,70 @@ public function testGetIndentWithExistingFile(): void
JSON;
$filename = './package.json';
+
file_put_contents($filename, $content);
- $this->assertFileExists($filename);
+
+ self::assertFileExists($filename);
$jsonFile = new JsonFile($filename);
- $this->assertSame(2, $jsonFile->getIndent());
+ self::assertSame(2, $jsonFile->getIndent());
}
- public function testWriteWithoutFile(): void
+ public function testGetIndentWithoutFile(): void
{
- $expected = << 'test'];
-
$jsonFile = new JsonFile($filename);
- $jsonFile->write($data);
- $this->assertFileExists($filename);
- $content = file_get_contents($filename);
-
- Assert::equalsWithoutLE($expected, $content);
+ self::assertSame(4, $jsonFile->getIndent());
}
- public function testWriteWithExistingFile(): void
+ /**
+ * @throws Exception|ParsingException
+ */
+ public function testWriteForcesFourSpacesIndentWithExistingTwoSpaceFile(): void
{
$expected = <<assertFileExists($filename);
+
+ self::assertFileExists($filename);
$jsonFile = new JsonFile($filename);
- $data = (array) $jsonFile->read();
+
+ $data = $jsonFile->read();
+
$data['private'] = true;
+
$jsonFile->write($data);
- $this->assertFileExists($filename);
+ self::assertFileExists($filename);
+
$content = file_get_contents($filename);
- Assert::equalsWithoutLE($expected, $content);
+ self::assertSame(
+ LineEndingNormalizer::normalize($expected),
+ LineEndingNormalizer::normalize($content),
+ );
}
+ /**
+ * @throws Exception|ParsingException
+ */
public function testWritePreservesNestedEmptyArraysWithoutSpaces(): void
{
$content = '{"name":"test","workspaces":[],"overrides":{"pkg":{"files":[]}},"dependencies":{}}';
@@ -190,52 +154,123 @@ public function testWritePreservesNestedEmptyArraysWithoutSpaces(): void
file_put_contents($filename, $content);
- $this->assertFileExists($filename);
+ self::assertFileExists($filename);
$jsonFile = new JsonFile($filename);
- $data = (array) $jsonFile->read();
+
+ $data = $jsonFile->read();
+
$data['private'] = true;
$jsonFile->write($data);
- $this->assertFileExists($filename);
+ self::assertFileExists($filename);
$content = file_get_contents($filename);
- $this->assertStringContainsString('"workspaces": []', $content);
- $this->assertStringContainsString('"files": []', $content);
- $this->assertStringContainsString('"dependencies": {}', $content);
- $this->assertMatchesRegularExpression('/^ {4}"dependencies": \{\}/m', $content);
+ self::assertStringContainsString('"workspaces": []', $content);
+ self::assertStringContainsString('"files": []', $content);
+ self::assertStringContainsString('"dependencies": {}', $content);
+ self::assertMatchesRegularExpression('/^ {4}"dependencies": \{\}/m', $content);
}
- public function testWriteForcesFourSpacesIndentWithExistingTwoSpaceFile(): void
+ /**
+ * @throws Exception|ParsingException
+ */
+ public function testWriteWithExistingFile(): void
{
$expected = <<assertFileExists($filename);
+
+ self::assertFileExists($filename);
$jsonFile = new JsonFile($filename);
- $data = (array) $jsonFile->read();
+
+ $data = $jsonFile->read();
+
$data['private'] = true;
+
+ $jsonFile->write($data);
+
+ self::assertFileExists($filename);
+
+ $content = file_get_contents($filename);
+
+ self::assertSame(
+ LineEndingNormalizer::normalize($expected),
+ LineEndingNormalizer::normalize($content),
+ );
+ }
+
+ /**
+ * @throws Exception
+ */
+ public function testWriteWithoutFile(): void
+ {
+ $expected = << 'test'];
+
+ $jsonFile = new JsonFile($filename);
+
$jsonFile->write($data);
- $this->assertFileExists($filename);
+ self::assertFileExists($filename);
+
$content = file_get_contents($filename);
- Assert::equalsWithoutLE($expected, $content);
+ self::assertSame(
+ LineEndingNormalizer::normalize($expected),
+ LineEndingNormalizer::normalize($content),
+ );
+ }
+
+ protected function setUp(): void
+ {
+ parent::setUp();
+
+ $this->oldCwd = getcwd();
+ $this->cwd = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('foxy_asset_json_file_test_', true);
+ $this->sfs = new Filesystem();
+ $this->sfs->mkdir($this->cwd);
+
+ chdir($this->cwd);
+ }
+
+ protected function tearDown(): void
+ {
+ parent::tearDown();
+
+ chdir($this->oldCwd);
+
+ $this->sfs->remove($this->cwd);
+ $this->sfs = null;
+ $this->oldCwd = null;
+ $this->cwd = null;
}
}
diff --git a/tests/Json/JsonFormatterTest.php b/tests/Json/JsonFormatterTest.php
index d7a6bfa..1ec578b 100644
--- a/tests/Json/JsonFormatterTest.php
+++ b/tests/Json/JsonFormatterTest.php
@@ -2,29 +2,18 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Json;
use Foxy\Json\JsonFormatter;
-use PHPForge\Support\Assert;
-
-/**
- * Tests for json formatter.
- *
- * @author François Pluchino
- *
- * @internal
- */
-final class JsonFormatterTest extends \PHPUnit\Framework\TestCase
+use JsonException;
+use PHPForge\Support\LineEndingNormalizer;
+use PHPUnit\Framework\TestCase;
+
+final class JsonFormatterTest extends TestCase
{
+ /**
+ * @throws JsonException
+ */
public function testFormat(): void
{
$expected = << [],
'dependencies' => ['@foo/bar' => '^1.0.0'], 'devDependencies' => [],
];
- $content = json_encode($data);
- Assert::equalsWithoutLE($expected, JsonFormatter::format($content, ['contributors'], 2));
+ $content = json_encode($data, JSON_THROW_ON_ERROR);
+
+ self::assertSame(
+ LineEndingNormalizer::normalize($expected),
+ LineEndingNormalizer::normalize(JsonFormatter::format($content, ['contributors'], 2)),
+ );
}
+ /**
+ * @throws JsonException
+ */
public function testFormatWithEmptyContent(): void
{
- $this->assertEmpty(JsonFormatter::format('', [], 2));
+ self::assertEmpty(
+ JsonFormatter::format('', [], 2),
+ );
}
public function testGetArrayKeys(): void
@@ -64,7 +62,10 @@ public function testGetArrayKeys(): void
JSON;
$expected = ['contributors'];
- $this->assertSame($expected, JsonFormatter::getArrayKeys($content));
+ self::assertSame(
+ $expected,
+ JsonFormatter::getArrayKeys($content),
+ );
}
public function testGetArrayKeysWithoutSpacesBeforeArray(): void
@@ -72,7 +73,10 @@ public function testGetArrayKeysWithoutSpacesBeforeArray(): void
$content = '{"name":"test","workspaces":[]}';
$expected = ['workspaces'];
- $this->assertSame($expected, JsonFormatter::getArrayKeys($content));
+ self::assertSame(
+ $expected,
+ JsonFormatter::getArrayKeys($content),
+ );
}
public function testGetIndent(): void
@@ -84,34 +88,51 @@ public function testGetIndent(): void
}
JSON;
- $this->assertSame(2, JsonFormatter::getIndent($content));
+ self::assertSame(
+ 2,
+ JsonFormatter::getIndent($content),
+ );
}
- public function testUnescapeUnicode(): void
+ /**
+ * @throws JsonException
+ */
+ public function testUnescapeSlashes(): void
{
- $data = ['name' => '\u0048\u0065\u006c\u006c\u006f'];
- $content = json_encode($data);
+ $data = ['url' => 'https:\/\/example.com'];
+
+ $content = json_encode($data, JSON_THROW_ON_ERROR);
$expected = << 'https:\/\/example.com'];
- $content = json_encode($data);
+ $data = ['name' => '\u0048\u0065\u006c\u006c\u006f'];
+
+ $content = json_encode($data, JSON_THROW_ON_ERROR);
$expected = <<
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Solver;
use Composer\Composer;
use Composer\EventDispatcher\EventDispatcher;
use Composer\Installer\InstallationManager;
use Composer\IO\IOInterface;
-use Composer\Package\Link;
-use Composer\Package\PackageInterface;
-use Composer\Package\RootPackageInterface;
-use Composer\Repository\InstalledArrayRepository;
-use Composer\Repository\RepositoryManager;
-use Composer\Repository\WritableRepositoryInterface;
+use Composer\Package\{Link, PackageInterface, RootPackageInterface};
+use Composer\Repository\{InstalledArrayRepository, RepositoryManager, WritableRepositoryInterface};
use Composer\Semver\Constraint\Constraint;
-use Composer\Util\Filesystem;
-use Composer\Util\HttpDownloader;
+use Composer\Util\{Filesystem, HttpDownloader};
+use Exception;
use Foxy\Asset\AssetManagerInterface;
use Foxy\Config\Config;
use Foxy\Fallback\FallbackInterface;
-use Foxy\Solver\Solver;
-use Foxy\Solver\SolverInterface;
+use Foxy\Solver\{Solver, SolverInterface};
use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+use function chdir;
+use function class_exists;
+use function dirname;
+use function file_put_contents;
-/**
- * Tests for solver.
- *
- * @author François Pluchino
- *
- * @internal
- */
-class SolverTest extends \PHPUnit\Framework\TestCase
+use const DIRECTORY_SEPARATOR;
+
+class SolverTest extends TestCase
{
- private Config|null $config = null;
private Composer|MockObject|null $composer = null;
private \Composer\Config|MockObject|null $composerConfig = null;
- private MockObject|WritableRepositoryInterface|null $localRepo = null;
- private IOInterface|MockObject|null $io = null;
+ private FallbackInterface|MockObject|null $composerFallback = null;
+ private Config|null $config = null;
+ private string|null $cwd = '';
private Filesystem|MockObject|null $fs = null;
private InstallationManager|MockObject|null $im = null;
- private \Symfony\Component\Filesystem\Filesystem|MockObject|null $sfs = null;
- private MockObject|RootPackageInterface|null $package = null;
+ private IOInterface|MockObject|null $io = null;
+ private MockObject|WritableRepositoryInterface|null $localRepo = null;
private AssetManagerInterface|MockObject|null $manager = null;
- private FallbackInterface|MockObject|null $composerFallback = null;
private string|null $oldCwd = '';
- private string|null $cwd = '';
+ private MockObject|RootPackageInterface|null $package = null;
+ private \Symfony\Component\Filesystem\Filesystem|MockObject|null $sfs = null;
private SolverInterface|null $solver = null;
+ public static function getSolveData(): array
+ {
+ return [[0], [1]];
+ }
+
+ public function testSetUpdatable(): void
+ {
+ $this->manager->expects(self::once())->method('setUpdatable')->with(false);
+ $this->solver->setUpdatable(false);
+ }
+
+ /**
+ * @dataProvider getSolveData
+ *
+ * @param int $resRunManager The result value of the run command of asset manager
+ *
+ * @throws Exception
+ */
+ public function testSolve(int $resRunManager): void
+ {
+ /** @var MockObject|PackageInterface $requirePackage */
+ $requirePackage = $this->createMock(PackageInterface::class);
+
+ $requirePackage->expects(self::any())->method('getPrettyVersion')->willReturn('1.0.0');
+ $requirePackage->expects(self::any())->method('getName')->willReturn('foo/bar');
+ $requirePackage
+ ->expects(self::any())
+ ->method('getRequires')
+ ->willReturn([new Link('root/package', 'php-forge/foxy', new Constraint('=', '1.0.0'))]);
+ $requirePackage->expects(self::any())->method('getDevRequires')->willReturn([]);
+
+ $this->addInstalledPackages([$requirePackage]);
+
+ $requirePackagePath = $this->cwd . '/vendor/foo/bar';
+
+ $this->im->expects(self::once())->method('getInstallPath')->willReturn($requirePackagePath);
+ $this->manager->expects(self::exactly(2))->method('getPackageName')->willReturn('package.json');
+ $this->manager->expects(self::once())->method('addDependencies');
+ $this->manager->expects(self::once())->method('run')->willReturn($resRunManager);
+
+ if (0 === $resRunManager) {
+ $this->composerFallback->expects(self::never())->method('restore');
+ } else {
+ $this->composerFallback->expects(self::once())->method('restore');
+
+ $this->expectException('RuntimeException');
+ $this->expectExceptionMessage('The asset manager ended with an error');
+ }
+
+ $requirePackageFilename = $requirePackagePath . DIRECTORY_SEPARATOR . $this->manager->getPackageName();
+
+ $this->sfs->mkdir(dirname($requirePackageFilename));
+
+ file_put_contents($requirePackageFilename, '{}');
+
+ $this->solver->solve($this->composer, $this->io);
+ }
+
+ /**
+ * @throws Exception
+ */
+ public function testSolveWithDisableOption(): void
+ {
+ $config = new Config(['enabled' => false]);
+ $solver = new Solver($this->manager, $config, $this->fs);
+
+ $this->manager->expects(self::never())->method('run');
+
+ $solver->solve($this->composer, $this->io);
+ }
+
protected function setUp(): void
{
parent::setUp();
$this->oldCwd = getcwd();
- $this->cwd = sys_get_temp_dir() . \DIRECTORY_SEPARATOR . uniqid('foxy_solver_test_', true);
+ $this->cwd = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('foxy_solver_test_', true);
$this->config = new Config(['enabled' => true, 'composer-asset-dir' => $this->cwd . '/composer-asset-dir']);
$this->composer = $this->createMock(Composer::class);
$this->composerConfig = $this->createMock(\Composer\Config::class);
@@ -75,11 +133,11 @@ protected function setUp(): void
$this->composerFallback = $this->createMock(FallbackInterface::class);
$this->sfs->mkdir($this->cwd);
- \chdir($this->cwd);
+ chdir($this->cwd);
$this->localRepo = $this->createMock(InstalledArrayRepository::class);
- if (\class_exists(HttpDownloader::class)) {
+ if (class_exists(HttpDownloader::class)) {
$rm = new RepositoryManager($this->io, $this->composerConfig, new HttpDownloader($this->io, $this->composerConfig));
$rm->setLocalRepository($this->localRepo);
} else {
@@ -87,21 +145,21 @@ protected function setUp(): void
$rm->setLocalRepository($this->localRepo);
}
- $this->composer->expects($this->any())->method('getRepositoryManager')->willReturn($rm);
- $this->composer->expects($this->any())->method('getInstallationManager')->willReturn($this->im);
- $this->composer->expects($this->any())->method('getPackage')->willReturn($this->package);
- $this->composer->expects($this->any())->method('getConfig')->willReturn($this->composerConfig);
+ $this->composer->expects(self::any())->method('getRepositoryManager')->willReturn($rm);
+ $this->composer->expects(self::any())->method('getInstallationManager')->willReturn($this->im);
+ $this->composer->expects(self::any())->method('getPackage')->willReturn($this->package);
+ $this->composer->expects(self::any())->method('getConfig')->willReturn($this->composerConfig);
$this->composer
- ->expects($this->any())
+ ->expects(self::any())
->method('getEventDispatcher')
->willReturn(new EventDispatcher($this->composer, $this->io));
$sfs = $this->sfs;
$this->fs
- ->expects($this->any())
+ ->expects(self::any())
->method('findShortestPath')
- ->willReturnCallback(fn ($from, $to) => rtrim($sfs->makePathRelative($to, $from), '/'));
+ ->willReturnCallback(fn(string $from, string $to): string => rtrim($sfs->makePathRelative($to, $from), '/'));
$this->solver = new Solver($this->manager, $this->config, $this->fs, $this->composerFallback);
}
@@ -128,72 +186,6 @@ protected function tearDown(): void
$this->cwd = null;
}
- public function testSetUpdatable(): void
- {
- $this->manager->expects($this->once())->method('setUpdatable')->with(false);
- $this->solver->setUpdatable(false);
- }
-
- public function testSolveWithDisableOption(): void
- {
- $config = new Config(['enabled' => false]);
- $solver = new Solver($this->manager, $config, $this->fs);
-
- $this->manager->expects($this->never())->method('run');
-
- $solver->solve($this->composer, $this->io);
- }
-
- public static function getSolveData(): array
- {
- return [[0], [1]];
- }
-
- /**
- * @dataProvider getSolveData
- *
- * @param int $resRunManager The result value of the run command of asset manager
- */
- public function testSolve(int $resRunManager): void
- {
- /** @var MockObject|PackageInterface $requirePackage */
- $requirePackage = $this->createMock(PackageInterface::class);
-
- $requirePackage->expects($this->any())->method('getPrettyVersion')->willReturn('1.0.0');
- $requirePackage->expects($this->any())->method('getName')->willReturn('foo/bar');
- $requirePackage
- ->expects($this->any())
- ->method('getRequires')
- ->willReturn([new Link('root/package', 'php-forge/foxy', new Constraint('=', '1.0.0'))]);
- $requirePackage->expects($this->any())->method('getDevRequires')->willReturn([]);
-
- $this->addInstalledPackages([$requirePackage]);
-
- $requirePackagePath = $this->cwd . '/vendor/foo/bar';
-
- $this->im->expects($this->once())->method('getInstallPath')->willReturn($requirePackagePath);
- $this->manager->expects($this->exactly(2))->method('getPackageName')->willReturn('package.json');
- $this->manager->expects($this->once())->method('addDependencies');
- $this->manager->expects($this->once())->method('run')->willReturn($resRunManager);
-
- if (0 === $resRunManager) {
- $this->composerFallback->expects($this->never())->method('restore');
- } else {
- $this->composerFallback->expects($this->once())->method('restore');
-
- $this->expectException('RuntimeException');
- $this->expectExceptionMessage('The asset manager ended with an error');
- }
-
- $requirePackageFilename = $requirePackagePath . \DIRECTORY_SEPARATOR . $this->manager->getPackageName();
-
- $this->sfs->mkdir(\dirname($requirePackageFilename));
-
- \file_put_contents($requirePackageFilename, '{}');
-
- $this->solver->solve($this->composer, $this->io);
- }
-
/**
* Add the installed packages in local repository.
*
@@ -201,6 +193,6 @@ public function testSolve(int $resRunManager): void
*/
private function addInstalledPackages(array $packages = []): void
{
- $this->localRepo->expects($this->any())->method('getCanonicalPackages')->willReturn($packages);
+ $this->localRepo->expects(self::any())->method('getCanonicalPackages')->willReturn($packages);
}
}
diff --git a/tests/Support/InternalMockerExtension.php b/tests/Support/InternalMockerExtension.php
index fc43b5f..e386264 100644
--- a/tests/Support/InternalMockerExtension.php
+++ b/tests/Support/InternalMockerExtension.php
@@ -2,45 +2,38 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Support;
-use PHPUnit\Event\Test\PreparationStarted;
-use PHPUnit\Event\Test\PreparationStartedSubscriber;
-use PHPUnit\Event\TestSuite\Started;
-use PHPUnit\Event\TestSuite\StartedSubscriber;
-use PHPUnit\Runner\Extension\Extension;
-use PHPUnit\Runner\Extension\Facade;
-use PHPUnit\Runner\Extension\ParameterCollection;
+use PHPUnit\Event\Test\{Finished, FinishedSubscriber};
+use PHPUnit\Event\Test\{PreparationStarted, PreparationStartedSubscriber};
+use PHPUnit\Event\TestSuite\{Started, StartedSubscriber};
+use PHPUnit\Runner\Extension\{Extension, Facade, ParameterCollection};
use PHPUnit\TextUI\Configuration\Configuration;
-use Xepozz\InternalMocker\Mocker;
-use Xepozz\InternalMocker\MockerState;
+use Xepozz\InternalMocker\{Mocker, MockerState};
final class InternalMockerExtension implements Extension
{
public function bootstrap(Configuration $configuration, Facade $facade, ParameterCollection $parameters): void
{
$facade->registerSubscribers(
- new class () implements StartedSubscriber {
+ new class implements StartedSubscriber {
public function notify(Started $event): void
{
InternalMockerExtension::load();
}
},
- new class () implements PreparationStartedSubscriber {
+ new class implements PreparationStartedSubscriber {
public function notify(PreparationStarted $event): void
{
MockerState::resetState();
}
},
+ new class implements FinishedSubscriber {
+ public function notify(Finished $event): void
+ {
+ MockerState::resetState();
+ }
+ },
);
}
diff --git a/tests/Util/AssetUtilTest.php b/tests/Util/AssetUtilTest.php
index dfe1d97..db7ab12 100644
--- a/tests/Util/AssetUtilTest.php
+++ b/tests/Util/AssetUtilTest.php
@@ -2,82 +2,79 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Util;
use Composer\Installer\InstallationManager;
-use Composer\Package\Link;
-use Composer\Package\PackageInterface;
+use Composer\Package\{Link, PackageInterface};
use Composer\Semver\Constraint\Constraint;
-use Foxy\Asset\AbstractAssetManager;
-use Foxy\Asset\AssetManagerInterface;
+use Foxy\Asset\{AbstractAssetManager, AssetManagerInterface};
use Foxy\Util\AssetUtil;
+use JsonException;
use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
use Symfony\Component\Filesystem\Filesystem;
-/**
- * Tests for asset util.
- *
- * @author François Pluchino
- *
- * @internal
- */
-final class AssetUtilTest extends \PHPUnit\Framework\TestCase
+use function count;
+use function file_put_contents;
+use function realpath;
+use function str_replace;
+
+use const DIRECTORY_SEPARATOR;
+
+final class AssetUtilTest extends TestCase
{
- private Filesystem|null $sfs;
private string|null $cwd;
+ private Filesystem|null $sfs;
- protected function setUp(): void
+ public static function getExtraData(): array
{
- parent::setUp();
-
- $this->cwd = sys_get_temp_dir() . \DIRECTORY_SEPARATOR . uniqid('foxy_asset_util_test_', true);
- $this->sfs = new Filesystem();
- $this->sfs->mkdir($this->cwd);
+ return [[false, false], [true, false], [false, true], [true, true]];
}
- protected function tearDown(): void
+ public static function getFormatPackageData(): array
{
- parent::tearDown();
-
- $this->sfs->remove($this->cwd);
- $this->sfs = null;
- $this->cwd = null;
+ return [
+ ['1.0.0', null, '1.0.0'],
+ ['1.0.1', '1.0.0', '1.0.0'],
+ ['1.0.0.x-dev', null, '1.0.0'],
+ ['1.0.0.x', null, '1.0.0'],
+ ['1.0.0.1', null, '1.0.0'],
+ ['dev-master', null, '1.0.0', '1-dev'],
+ ['dev-master', null, '1.0.0', '1.0-dev'],
+ ['dev-master', null, '1.0.0', '1.0.0-dev'],
+ ['dev-master', null, '1.0.0', '1.x-dev'],
+ ['dev-master', null, '1.0.0', '1.0.x-dev'],
+ ['dev-master', null, '1.0.0', '1.*-dev'],
+ ['dev-master', null, '1.0.0', '1.0.*-dev'],
+ ];
}
- public function testGetName(): void
+ public static function getIsProjectActivationData(): array
{
- $package = $this->createMock(PackageInterface::class);
- $package->expects($this->once())->method('getName')->willReturn('foo/bar');
-
- $this->assertSame('@composer-asset/foo--bar', AssetUtil::getName($package));
+ return [
+ ['full/qualified', true],
+ ['full-disable/qualified', false],
+ ['foo/bar', true],
+ ['baz/foo', false],
+ ['baz/foo-test', false],
+ ['bar/test', true],
+ ['other/package', false],
+ ['test-string/package', true],
+ ];
}
- public function testGetPathWithoutRequiredFoxy(): void
+ public static function getIsProjectActivationWithWildcardData(): array
{
- $installationManager = $this->createMock(InstallationManager::class);
-
- $installationManager->expects($this->never())->method('getInstallPath');
-
- $assetManager = $this->createMock(AbstractAssetManager::class);
-
- /** @var MockObject|PackageInterface $package */
- $package = $this->createMock(PackageInterface::class);
-
- $package->expects($this->once())->method('getRequires')->willReturn([]);
- $package->expects($this->once())->method('getDevRequires')->willReturn([]);
-
- $res = AssetUtil::getPath($installationManager, $assetManager, $package);
-
- $this->assertNull($res);
+ return [
+ ['full/qualified', true],
+ ['full-disable/qualified', false],
+ ['foo/bar', true],
+ ['baz/foo', false],
+ ['baz/foo-test', false],
+ ['bar/test', true],
+ ['other/package', true],
+ ['test-string/package', true],
+ ];
}
public static function getRequiresData(): array
@@ -107,16 +104,64 @@ public static function getRequiresData(): array
}
/**
- * @dataProvider getRequiresData
+ * @dataProvider getFormatPackageData
+ */
+ public function testFormatPackage(
+ string $packageVersion,
+ string|null $assetVersion,
+ string $expectedAssetVersion,
+ string|null $branchAlias = null,
+ ): void {
+ $packageName = '@composer-asset/foo--bar';
+
+ /** @var MockObject|PackageInterface $package */
+ $package = $this->createMock(PackageInterface::class);
+
+ $assetPackage = [];
+
+ if (null !== $assetVersion) {
+ $assetPackage['version'] = $assetVersion;
+
+ $package->expects(self::never())->method('getPrettyVersion');
+ $package->expects(self::never())->method('getExtra');
+ } else {
+ $extra = [];
+
+ if (null !== $branchAlias) {
+ $extra['branch-alias'][$packageVersion] = $branchAlias;
+ }
+
+ $package->expects(self::once())->method('getPrettyVersion')->willReturn($packageVersion);
+ $package->expects(self::once())->method('getExtra')->willReturn($extra);
+ }
+
+ $expected = ['name' => $packageName, 'version' => $expectedAssetVersion];
+
+ $res = AssetUtil::formatPackage($package, $packageName, $assetPackage);
+
+ self::assertEquals($expected, $res);
+ }
+
+ public function testGetName(): void
+ {
+ $package = $this->createMock(PackageInterface::class);
+ $package->expects(self::once())->method('getName')->willReturn('foo/bar');
+
+ self::assertSame('@composer-asset/foo--bar', AssetUtil::getName($package));
+ }
+
+ /**
+ * @dataProvider getExtraData
*
- * @param Link[] $requires
- * @param Link[] $devRequires
+ * @throws JsonException
*/
- public function testGetPathWithRequiredFoxy(array $requires, array $devRequires, bool $fileExists = false): void
+ public function testGetPathWithExtraActivation(bool $withExtra, bool $fileExists = false): void
{
$installationManager = $this->createMock(InstallationManager::class);
- $installationManager->expects($this->once())->method('getInstallPath')->willReturn($this->cwd);
+ if ($withExtra && $fileExists) {
+ $installationManager->expects(self::once())->method('getInstallPath')->willReturn($this->cwd);
+ }
/** @var AbstractAssetManager|MockObject $assetManager */
$assetManager = $this
@@ -126,44 +171,60 @@ public function testGetPathWithRequiredFoxy(array $requires, array $devRequires,
$package = $this->createMock(PackageInterface::class);
- $package->expects($this->once())->method('getRequires')->willReturn($requires);
-
- if (0 === \count($devRequires)) {
- $package->expects($this->never())->method('getDevRequires');
- } else {
- $package->expects($this->once())->method('getDevRequires')->willReturn($devRequires);
- }
+ $package->expects(self::any())->method('getRequires')->willReturn([]);
+ $package->expects(self::any())->method('getDevRequires')->willReturn([]);
+ $package->expects(self::atLeastOnce())->method('getExtra')->willReturn(['foxy' => $withExtra]);
if ($fileExists) {
- $expectedFilename = $this->cwd . \DIRECTORY_SEPARATOR . $assetManager->getPackageName();
+ $expectedFilename = $this->cwd . DIRECTORY_SEPARATOR . $assetManager->getPackageName();
- \file_put_contents($expectedFilename, '{}');
+ file_put_contents($expectedFilename, '{}');
- $expectedFilename = \str_replace('\\', '/', \realpath($expectedFilename));
+ $expectedFilename = $withExtra ? str_replace('\\', '/', realpath($expectedFilename)) : null;
} else {
$expectedFilename = null;
}
$res = AssetUtil::getPath($installationManager, $assetManager, $package);
- $this->assertSame($expectedFilename, $res);
+ self::assertSame($expectedFilename, $res);
}
- public static function getExtraData(): array
+ /**
+ * @throws JsonException
+ */
+ public function testGetPathWithoutRequiredFoxy(): void
{
- return [[false, false], [true, false], [false, true], [true, true]];
+ $installationManager = $this->createMock(InstallationManager::class);
+
+ $installationManager->expects(self::never())->method('getInstallPath');
+
+ $assetManager = $this->createMock(AbstractAssetManager::class);
+
+ /** @var MockObject|PackageInterface $package */
+ $package = $this->createMock(PackageInterface::class);
+
+ $package->expects(self::once())->method('getRequires')->willReturn([]);
+ $package->expects(self::once())->method('getDevRequires')->willReturn([]);
+
+ $res = AssetUtil::getPath($installationManager, $assetManager, $package);
+
+ self::assertNull($res);
}
/**
- * @dataProvider getExtraData
+ * @dataProvider getRequiresData
+ *
+ * @param Link[] $requires
+ * @param Link[] $devRequires
+ *
+ * @throws JsonException
*/
- public function testGetPathWithExtraActivation(bool $withExtra, bool $fileExists = false): void
+ public function testGetPathWithRequiredFoxy(array $requires, array $devRequires, bool $fileExists = false): void
{
$installationManager = $this->createMock(InstallationManager::class);
- if ($withExtra && $fileExists) {
- $installationManager->expects($this->once())->method('getInstallPath')->willReturn($this->cwd);
- }
+ $installationManager->expects(self::once())->method('getInstallPath')->willReturn($this->cwd);
/** @var AbstractAssetManager|MockObject $assetManager */
$assetManager = $this
@@ -173,59 +234,79 @@ public function testGetPathWithExtraActivation(bool $withExtra, bool $fileExists
$package = $this->createMock(PackageInterface::class);
- $package->expects($this->any())->method('getRequires')->willReturn([]);
- $package->expects($this->any())->method('getDevRequires')->willReturn([]);
- $package->expects($this->atLeastOnce())->method('getExtra')->willReturn(['foxy' => $withExtra]);
+ $package->expects(self::once())->method('getRequires')->willReturn($requires);
+
+ if (0 === count($devRequires)) {
+ $package->expects(self::never())->method('getDevRequires');
+ } else {
+ $package->expects(self::once())->method('getDevRequires')->willReturn($devRequires);
+ }
if ($fileExists) {
- $expectedFilename = $this->cwd . \DIRECTORY_SEPARATOR . $assetManager->getPackageName();
+ $expectedFilename = $this->cwd . DIRECTORY_SEPARATOR . $assetManager->getPackageName();
- \file_put_contents($expectedFilename, '{}');
+ file_put_contents($expectedFilename, '{}');
- $expectedFilename = $withExtra ? \str_replace('\\', '/', \realpath($expectedFilename)) : null;
+ $expectedFilename = str_replace('\\', '/', realpath($expectedFilename));
} else {
$expectedFilename = null;
}
$res = AssetUtil::getPath($installationManager, $assetManager, $package);
- $this->assertSame($expectedFilename, $res);
+ self::assertSame($expectedFilename, $res);
+ }
+
+ /**
+ * @throws JsonException
+ */
+ public function testGetPathWithRootPackageDir(): void
+ {
+ $installationManager = $this->createMock(InstallationManager::class);
+ $installationManager
+ ->expects(self::once())
+ ->method('getInstallPath')
+ ->willReturn('tests/Fixtures/package/global');
+
+ $assetManager = $this->createMock(AssetManagerInterface::class);
+ $assetManager->expects(self::once())->method('getPackageName')->willReturn('foo/bar');
+
+ $package = $this->createMock(PackageInterface::class);
+ $package->expects(self::once())->method('getName')->willReturn('foo/bar');
+ $package->expects(self::once())->method('getRequires')->willReturn([]);
+ $package->expects(self::once())->method('getDevRequires')->willReturn([]);
+
+ $configPackages = [
+ '/^foo\/bar$/' => true,
+ ];
+
+ $expectedPath = 'tests/Fixtures/package/global/theme/foo/bar';
+
+ $res = AssetUtil::getPath($installationManager, $assetManager, $package, $configPackages);
+
+ self::assertStringContainsString($expectedPath, $res);
}
public function testHasNoPluginDependency(): void
{
- $this->assertFalse(
- AssetUtil::hasPluginDependency([new Link('root/package', 'foo/bar', new Constraint('=', '1.0.0'))])
+ self::assertFalse(
+ AssetUtil::hasPluginDependency([new Link('root/package', 'foo/bar', new Constraint('=', '1.0.0'))]),
);
}
public function testHasPluginDependency(): void
{
- $this->assertTrue(
+ self::assertTrue(
AssetUtil::hasPluginDependency(
[
new Link('root/package', 'foo/bar', new Constraint('=', '1.0.0')),
new Link('root/package', 'php-forge/foxy', new Constraint('=', '1.0.0')),
new Link('root/package', 'bar/foo', new Constraint('=', '1.0.0')),
],
- )
+ ),
);
}
- public static function getIsProjectActivationData(): array
- {
- return [
- ['full/qualified', true],
- ['full-disable/qualified', false],
- ['foo/bar', true],
- ['baz/foo', false],
- ['baz/foo-test', false],
- ['bar/test', true],
- ['other/package', false],
- ['test-string/package', true],
- ];
- }
-
/**
* @dataProvider getIsProjectActivationData
*/
@@ -243,25 +324,11 @@ public function testIsProjectActivation(string $packageName, bool $expected): vo
/** @var MockObject|PackageInterface $package */
$package = $this->createMock(PackageInterface::class);
- $package->expects($this->once())->method('getName')->willReturn($packageName);
+ $package->expects(self::once())->method('getName')->willReturn($packageName);
$res = AssetUtil::isProjectActivation($package, $enablePackages);
- $this->assertSame($expected, $res);
- }
-
- public static function getIsProjectActivationWithWildcardData(): array
- {
- return [
- ['full/qualified', true],
- ['full-disable/qualified', false],
- ['foo/bar', true],
- ['baz/foo', false],
- ['baz/foo-test', false],
- ['bar/test', true],
- ['other/package', true],
- ['test-string/package', true],
- ];
+ self::assertSame($expected, $res);
}
/**
@@ -278,94 +345,28 @@ public function testIsProjectActivationWithWildcardPattern(string $packageName,
/** @var MockObject|PackageInterface $package */
$package = $this->createMock(PackageInterface::class);
- $package->expects($this->once())->method('getName')->willReturn($packageName);
+ $package->expects(self::once())->method('getName')->willReturn($packageName);
$res = AssetUtil::isProjectActivation($package, $enablePackages);
- $this->assertSame($expected, $res);
+ self::assertSame($expected, $res);
}
- public static function getFormatPackageData(): array
+ protected function setUp(): void
{
- return [
- ['1.0.0', null, '1.0.0'],
- ['1.0.1', '1.0.0', '1.0.0'],
- ['1.0.0.x-dev', null, '1.0.0'],
- ['1.0.0.x', null, '1.0.0'],
- ['1.0.0.1', null, '1.0.0'],
- ['dev-master', null, '1.0.0', '1-dev'],
- ['dev-master', null, '1.0.0', '1.0-dev'],
- ['dev-master', null, '1.0.0', '1.0.0-dev'],
- ['dev-master', null, '1.0.0', '1.x-dev'],
- ['dev-master', null, '1.0.0', '1.0.x-dev'],
- ['dev-master', null, '1.0.0', '1.*-dev'],
- ['dev-master', null, '1.0.0', '1.0.*-dev'],
- ];
- }
-
- /**
- * @dataProvider getFormatPackageData
- */
- public function testFormatPackage(
- string $packageVersion,
- string|null $assetVersion,
- string $expectedAssetVersion,
- string|null $branchAlias = null
- ): void {
- $packageName = '@composer-asset/foo--bar';
-
- /** @var MockObject|PackageInterface $package */
- $package = $this->createMock(PackageInterface::class);
-
- $assetPackage = [];
-
- if (null !== $assetVersion) {
- $assetPackage['version'] = $assetVersion;
-
- $package->expects($this->never())->method('getPrettyVersion');
- $package->expects($this->never())->method('getExtra');
- } else {
- $extra = [];
-
- if (null !== $branchAlias) {
- $extra['branch-alias'][$packageVersion] = $branchAlias;
- }
-
- $package->expects($this->once())->method('getPrettyVersion')->willReturn($packageVersion);
- $package->expects($this->once())->method('getExtra')->willReturn($extra);
- }
-
- $expected = ['name' => $packageName, 'version' => $expectedAssetVersion];
-
- $res = AssetUtil::formatPackage($package, $packageName, $assetPackage);
+ parent::setUp();
- $this->assertEquals($expected, $res);
+ $this->cwd = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('foxy_asset_util_test_', true);
+ $this->sfs = new Filesystem();
+ $this->sfs->mkdir($this->cwd);
}
- public function testGetPathWithRootPackageDir(): void
+ protected function tearDown(): void
{
- $installationManager = $this->createMock(InstallationManager::class);
- $installationManager
- ->expects($this->once())
- ->method('getInstallPath')
- ->willReturn('tests/Fixtures/package/global');
-
- $assetManager = $this->createMock(AssetManagerInterface::class);
- $assetManager->expects($this->once())->method('getPackageName')->willReturn('foo/bar');
-
- $package = $this->createMock(PackageInterface::class);
- $package->expects($this->once())->method('getName')->willReturn('foo/bar');
- $package->expects($this->once())->method('getRequires')->willReturn([]);
- $package->expects($this->once())->method('getDevRequires')->willReturn([]);
-
- $configPackages = [
- '/^foo\/bar$/' => true,
- ];
-
- $expectedPath = 'tests/Fixtures/package/global/theme/foo/bar';
-
- $res = AssetUtil::getPath($installationManager, $assetManager, $package, $configPackages);
+ parent::tearDown();
- $this->assertStringContainsString($expectedPath, $res);
+ $this->sfs->remove($this->cwd);
+ $this->sfs = null;
+ $this->cwd = null;
}
}
diff --git a/tests/Util/ComposerUtilTest.php b/tests/Util/ComposerUtilTest.php
index 6c4f9ff..c9fed9c 100644
--- a/tests/Util/ComposerUtilTest.php
+++ b/tests/Util/ComposerUtilTest.php
@@ -2,27 +2,13 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Util;
+use Foxy\Exception\RuntimeException;
use Foxy\Util\ComposerUtil;
+use PHPUnit\Framework\TestCase;
-/**
- * Tests for composer util.
- *
- * @author François Pluchino
- *
- * @internal
- */
-final class ComposerUtilTest extends \PHPUnit\Framework\TestCase
+final class ComposerUtilTest extends TestCase
{
public static function getValidateVersionData(): array
{
@@ -45,11 +31,11 @@ public static function getValidateVersionData(): array
public function testValidateVersion(string $composerVersion, string $requiredVersion, bool $valid): void
{
if ($valid) {
- $this->assertTrue(true, 'Composer\'s version is valid');
+ self::assertTrue(true, 'Composer\'s version is valid');
} else {
- $this->expectException(\Foxy\Exception\RuntimeException::class);
+ $this->expectException(RuntimeException::class);
$this->expectExceptionMessageMatches(
- '/Foxy requires the Composer\'s minimum version "([\d\.^|, ]+)", current version is "([\d\.]+)"/'
+ '/Foxy requires the Composer\'s minimum version "([\d\.^|, ]+)", current version is "([\d\.]+)"/',
);
}
diff --git a/tests/Util/ConsoleUtilTest.php b/tests/Util/ConsoleUtilTest.php
index 85d8829..3c88093 100644
--- a/tests/Util/ConsoleUtilTest.php
+++ b/tests/Util/ConsoleUtilTest.php
@@ -2,35 +2,28 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Util;
use Composer\Config;
-use Composer\IO\ConsoleIO;
-use Composer\IO\IOInterface;
+use Composer\IO\{ConsoleIO, IOInterface};
use Foxy\Util\ConsoleUtil;
+use PHPUnit\Framework\TestCase;
use Symfony\Component\Console\Helper\HelperSet;
-use Symfony\Component\Console\Input\ArgvInput;
-use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\{ArgvInput, InputInterface};
use Symfony\Component\Console\Output\NullOutput;
-/**
- * Tests for console util.
- *
- * @author François Pluchino
- *
- * @internal
- */
-final class ConsoleUtilTest extends \PHPUnit\Framework\TestCase
+final class ConsoleUtilTest extends TestCase
{
+ public static function getPreferredInstallOptionsData(): array
+ {
+ return [
+ [false, false, 'auto', false],
+ [false, true, 'auto', true],
+ [true, false, 'source', false],
+ [false, true, 'dist', false],
+ ];
+ }
+
public function testGetInput(): void
{
$input = new ArgvInput();
@@ -38,7 +31,7 @@ public function testGetInput(): void
$helperSet = new HelperSet();
$io = new ConsoleIO($input, $output, $helperSet);
- $this->assertSame($input, ConsoleUtil::getInput($io));
+ self::assertSame($input, ConsoleUtil::getInput($io));
}
public function testGetInputWithoutValidInput(): void
@@ -46,17 +39,7 @@ public function testGetInputWithoutValidInput(): void
/** @var IOInterface $io */
$io = $this->createMock(IOInterface::class);
- $this->assertInstanceOf(ArgvInput::class, ConsoleUtil::getInput($io));
- }
-
- public static function getPreferredInstallOptionsData(): array
- {
- return [
- [false, false, 'auto', false],
- [false, true, 'auto', true],
- [true, false, 'source', false],
- [false, true, 'dist', false],
- ];
+ self::assertInstanceOf(ArgvInput::class, ConsoleUtil::getInput($io));
}
/**
@@ -66,22 +49,22 @@ public function testGetPreferredInstallOptions(
bool $expectedPreferSource,
bool $expectedPreferDist,
string $preferedInstall,
- bool $inputPrefer
+ bool $inputPrefer,
): void {
$config = $this->createMock(Config::class);
$input = $this->createMock(InputInterface::class);
- $config->expects($this->once())->method('get')->with('preferred-install')->willReturn($preferedInstall);
+ $config->expects(self::once())->method('get')->with('preferred-install')->willReturn($preferedInstall);
if ($inputPrefer) {
- $input->expects($this->atLeastOnce())
+ $input->expects(self::atLeastOnce())
->method('getOption')
- ->willReturnCallback(static fn ($option) => !('prefer-source' === $option))
+ ->willReturnCallback(static fn($option): bool => !('prefer-source' === $option))
;
}
$res = ConsoleUtil::getPreferredInstallOptions($config, $input);
- $this->assertEquals([$expectedPreferSource, $expectedPreferDist], $res);
+ self::assertEquals([$expectedPreferSource, $expectedPreferDist], $res);
}
}
diff --git a/tests/Util/PackageUtilTest.php b/tests/Util/PackageUtilTest.php
index c6af8e5..0a2c64e 100644
--- a/tests/Util/PackageUtilTest.php
+++ b/tests/Util/PackageUtilTest.php
@@ -2,70 +2,22 @@
declare(strict_types=1);
-/*
- * This file is part of the Foxy package.
- *
- * (c) François Pluchino
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
namespace Foxy\Tests\Util;
use Composer\Package\CompletePackage;
use Foxy\Util\PackageUtil;
+use PHPUnit\Framework\TestCase;
-/**
- * Tests for package util.
- *
- * @author François Pluchino
- *
- * @internal
- */
-final class PackageUtilTest extends \PHPUnit\Framework\TestCase
+final class PackageUtilTest extends TestCase
{
- public function testLoadLockPackages(): void
- {
- $lockData = [
- 'packages' => [
- ['name' => 'foo/bar', 'version' => '1.0.0.0'],
- ],
- 'packages-dev' => [
- ['name' => 'bar/foo', 'version' => '1.0.0.0'],
- ],
- ];
-
- $package = new CompletePackage('foo/bar', '1.0.0.0', '1.0.0.0');
- $package->setType('library');
-
- $packageDev = new CompletePackage('bar/foo', '1.0.0.0', '1.0.0.0');
- $packageDev->setType('library');
-
- $expectedPackages = [$package];
- $expectedDevPackages = [$packageDev];
-
- $lockDataLoaded = PackageUtil::loadLockPackages($lockData);
-
- $this->assertArrayHasKey('packages', $lockDataLoaded);
- $this->assertArrayHasKey('packages-dev', $lockDataLoaded);
- $this->assertEquals($lockDataLoaded['packages'], $expectedPackages);
- $this->assertEquals($lockDataLoaded['packages-dev'], $expectedDevPackages);
- }
-
- public function testLoadLockPackagesWithoutPackages(): void
- {
- $this->assertSame([], PackageUtil::loadLockPackages([]));
- }
-
public function testConvertLockAlias(): void
{
$lockData = [
'aliases' => [
[
'alias' => '1.0.0',
- 'alias_normalized' =>
- '1.0.0.0',
+ 'alias_normalized'
+ => '1.0.0.0',
'version' => 'dev-feature/1.0-test',
'package' => 'foo/bar',
],
@@ -95,7 +47,40 @@ public function testConvertLockAlias(): void
$convertedAliases = PackageUtil::convertLockAlias($lockData);
- $this->assertArrayHasKey('aliases', $convertedAliases);
- $this->assertEquals($convertedAliases['aliases'], $expectedAliases);
+ self::assertArrayHasKey('aliases', $convertedAliases);
+ self::assertEquals($expectedAliases, $convertedAliases['aliases']);
+ }
+
+ public function testLoadLockPackages(): void
+ {
+ $lockData = [
+ 'packages' => [
+ ['name' => 'foo/bar', 'version' => '1.0.0.0'],
+ ],
+ 'packages-dev' => [
+ ['name' => 'bar/foo', 'version' => '1.0.0.0'],
+ ],
+ ];
+
+ $package = new CompletePackage('foo/bar', '1.0.0.0', '1.0.0.0');
+ $package->setType('library');
+
+ $packageDev = new CompletePackage('bar/foo', '1.0.0.0', '1.0.0.0');
+ $packageDev->setType('library');
+
+ $expectedPackages = [$package];
+ $expectedDevPackages = [$packageDev];
+
+ $lockDataLoaded = PackageUtil::loadLockPackages($lockData);
+
+ self::assertArrayHasKey('packages', $lockDataLoaded);
+ self::assertArrayHasKey('packages-dev', $lockDataLoaded);
+ self::assertEquals($expectedPackages, $lockDataLoaded['packages']);
+ self::assertEquals($expectedDevPackages, $lockDataLoaded['packages-dev']);
+ }
+
+ public function testLoadLockPackagesWithoutPackages(): void
+ {
+ self::assertSame([], PackageUtil::loadLockPackages([]));
}
}
+