Skip to content

Commit 7c6e9f2

Browse files
coenjacobscoenjacobs
authored
Merge branch 'master' into create-phar
2 parents a756223 + 30a8a0d commit 7c6e9f2

27 files changed

+936
-89
lines changed

‎.github/workflows/analysis.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Psalm analysis
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
branches:
9+
- master
10+
11+
jobs:
12+
psalm:
13+
name: Psalm
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v2
18+
19+
- name: Psalm
20+
uses: docker://vimeo/psalm-github-actions

‎.github/workflows/docker-latest.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Publish latest to Docker Hub
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
docker:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v2
14+
- name: Prepare
15+
id: prep
16+
run: |
17+
DOCKER_IMAGE=coenjacobs/mozart
18+
VERSION=latest
19+
TAGS="${DOCKER_IMAGE}:${VERSION}"
20+
echo ::set-output name=tags::${TAGS}
21+
22+
- name: Set up Docker Buildx
23+
id: buildx
24+
uses: docker/setup-buildx-action@v1
25+
26+
- name: Cache Docker layers
27+
uses: actions/cache@v2
28+
with:
29+
path: /tmp/.buildx-cache
30+
key: ${{ runner.os }}-buildx-${{ github.sha }}
31+
restore-keys: |
32+
${{ runner.os }}-buildx-
33+
34+
- name: Login to DockerHub
35+
uses: docker/login-action@v1
36+
with:
37+
username: ${{ secrets.DOCKER_USERNAME }}
38+
password: ${{ secrets.DOCKER_PASSWORD }}
39+
40+
- name: Build and push
41+
id: docker_build
42+
uses: docker/build-push-action@v2
43+
with:
44+
builder: ${{ steps.buildx.outputs.name }}
45+
context: .
46+
file: ./Dockerfile
47+
target: application
48+
platforms: linux/amd64
49+
push: ${{ github.event_name != 'pull_request' }}
50+
tags: ${{ steps.prep.outputs.tags }}
51+
cache-from: type=local,src=/tmp/.buildx-cache
52+
cache-to: type=local,dest=/tmp/.buildx-cache

‎.github/workflows/main.yml‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
11
name: Lint and test
22

3-
on: [push, pull_request]
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
branches:
9+
- master
410

511
jobs:
612
tests:
713
runs-on: ubuntu-latest
814
strategy:
915
matrix:
10-
php: ['7.2', '7.3', '7.4']
16+
php: ['7.3', '7.4', '8.0']
1117
name: PHP ${{ matrix.php }} tests
1218
steps:
1319
- uses: actions/checkout@v1

‎.github/workflows/release.yml‎

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build and attach Mozart.phar to each release
1+
name: Build, tag and attach releases
22

33
on: release
44

@@ -27,4 +27,58 @@ jobs:
2727
token: ${{ secrets.GITHUB_TOKEN }}
2828
files: mozart.phar
2929
gzip: false
30-
allow_override: true
30+
allow_override: true
31+
docker:
32+
runs-on: ubuntu-latest
33+
name: Create Docker tag
34+
steps:
35+
- name: Checkout
36+
uses: actions/checkout@v2
37+
38+
- name: Prepare
39+
id: prep
40+
run: |
41+
DOCKER_IMAGE=coenjacobs/mozart
42+
VERSION=${{ github.event.release.tag_name }}
43+
TAGS="${DOCKER_IMAGE}:${VERSION}"
44+
echo ::set-output name=tags::${TAGS}
45+
46+
- name: Set up QEMU
47+
uses: docker/setup-qemu-action@v1
48+
with:
49+
platforms: all
50+
51+
- name: Set up Docker Buildx
52+
id: buildx
53+
uses: docker/setup-buildx-action@v1
54+
55+
- name: Cache Docker layers
56+
uses: actions/cache@v2
57+
with:
58+
path: /tmp/.buildx-cache
59+
key: ${{ runner.os }}-buildx-${{ github.sha }}
60+
restore-keys: |
61+
${{ runner.os }}-buildx-
62+
63+
- name: Login to DockerHub
64+
uses: docker/login-action@v1
65+
with:
66+
username: ${{ secrets.DOCKER_USERNAME }}
67+
password: ${{ secrets.DOCKER_PASSWORD }}
68+
69+
- name: Build and push
70+
id: docker_build
71+
uses: docker/build-push-action@v2
72+
with:
73+
builder: ${{ steps.buildx.outputs.name }}
74+
context: .
75+
file: ./Dockerfile
76+
target: application
77+
platforms: linux/amd64
78+
push: ${{ github.event_name != 'pull_request' }}
79+
tags: ${{ steps.prep.outputs.tags }}
80+
cache-from: type=local,src=/tmp/.buildx-cache
81+
cache-to: type=local,dest=/tmp/.buildx-cache
82+
83+
- name: Image digest
84+
run: echo ${{ steps.docker_build.outputs.digest }}

‎Dockerfile‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
FROM composer:2.0.8
2+
3+
FROM php:8.0.1-cli-alpine AS base
4+
5+
FROM base as builder
6+
RUN apk update && apk add git
7+
COPY --from=composer /usr/bin/composer /usr/bin/composer
8+
COPY ./composer.json /mozart/
9+
WORKDIR /mozart/
10+
RUN composer install --no-dev -o
11+
12+
FROM base AS application
13+
RUN mkdir project
14+
WORKDIR /project/
15+
COPY --from=builder /mozart/ /mozart/
16+
COPY ./bin/ /mozart/bin/
17+
COPY ./src/ /mozart/src/

‎README.md‎

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
1-
# Mozart [![Build Status](https://api.travis-ci.org/coenjacobs/mozart.png)](https://travis-ci.org/coenjacobs/mozart) [![Latest Stable Version](https://poser.pugx.org/coenjacobs/mozart/v/stable.svg)](https://packagist.org/packages/coenjacobs/mozart) [![License](https://poser.pugx.org/coenjacobs/mozart/license.svg)](https://packagist.org/packages/coenjacobs/mozart)
1+
# Mozart [![Latest Stable Version](https://poser.pugx.org/coenjacobs/mozart/v/stable.svg)](https://packagist.org/packages/coenjacobs/mozart) [![License](https://poser.pugx.org/coenjacobs/mozart/license.svg)](https://packagist.org/packages/coenjacobs/mozart) [![Docker Image Pulls](https://img.shields.io/docker/pulls/coenjacobs/mozart.svg)](https://hub.docker.com/r/coenjacobs/mozart)
22
Composes all dependencies as a package inside a WordPress plugin. Load packages through Composer and have them wrapped inside your own namespace. Gone are the days when plugins could load conflicting versions of the same package, resulting in hard to reproduce bugs.
33

4-
This package requires PHP 7.2 or higher in order to run the tool. You can use the resulting files as a bundle, requiring any PHP version you like, even PHP 5.2.
4+
This package requires PHP 7.3 or higher in order to run the tool. You can use the resulting files as a bundle, requiring any PHP version you like, even PHP 5.2.
55

66
**Warning:** This package is very experimental and breaking changes are very likely until version 1.0.0 is tagged. Use with caution, always wear a helmet when using this in production environments.
77

88
## Installation
99

10-
### Composer
10+
### Docker
11+
Pull the Docker image from the registry:
12+
13+
```
14+
docker pull coenjacobs/mozart
15+
```
16+
17+
Then you can start the container and run the `mozart compose` command in the container. In a single command:
18+
19+
```
20+
docker run --rm -it -v ${PWD}:/project/ coenjacobs/mozart /mozart/bin/mozart compose
21+
```
22+
23+
Above command automatically adds the current working directory as a volume into the designated directory for the project: `/project/`. In the Docker container, Mozart is installed in the `/mozart/` directory. Using the above command will run Mozart on the current working directory.
1124

25+
Please note that the Docker image for Mozart is only available starting from the `latest` build of version 0.7.0. The `latest` tag is always the latest build of the `master` branch and not a stable version. You can see [all available tags on Docker Hub](https://hub.docker.com/r/coenjacobs/mozart/tags).
26+
27+
### Composer
1228
Install through Composer, only required in development environments:
1329

1430
`composer require coenjacobs/mozart --dev`
@@ -18,8 +34,7 @@ This gives you a bin file named `mozart` inside your `vendor/bin` directory, aft
1834
After configuring Mozart properly, the `mozart compose` command does all the magic.
1935

2036
### Standalone Phar
21-
22-
`mozart.phar` can be [downloaded from the releases](https://github.com/coenjacobs/mozart/releases):
37+
`mozart.phar` can be [downloaded from the releases page](https://github.com/coenjacobs/mozart/releases):
2338

2439
```
2540
composer install --no-dev
@@ -39,6 +54,9 @@ Mozart requires little configuration. All you need to do is tell it where the bu
3954
"packages": [
4055
"pimple/pimple"
4156
],
57+
"exclude_packages": [
58+
"psr/container"
59+
],
4260
"override_autoload": {
4361
"google/apiclient": {
4462
"classmap": [
@@ -64,6 +82,7 @@ The following configuration is optional:
6482

6583
- `delete_vendor_directories` is a boolean flag to indicate if the packages' vendor directories should be deleted after being processed. _default: true_.
6684
- `packages` is an optional array that defines the packages to be processed by Mozart. The array requires the slugs of packages in the same format as provided in your `composer.json`. Mozart will automatically rewrite dependencies of these packages as well. You don't need to add dependencies of these packages to the list. If this field is absent, all packages listed under composer require will be included.
85+
- `exclude_packages` is an optional array that defines the packages to be excluded from the processing performed by Mozart. This is useful if some of the packages in the `packages` array define dependent packages whose namespaces you want to keep unchanged. The array requires the slugs of the packages, as in the case of the `packages` array.
6786
- `override_autoload` a dictionary, keyed with the package names, of autoload settings to replace those in the original packages' `composer.json` `autoload` property.
6887

6988
After Composer has loaded the packages as defined in your `composer.json` file, you can now run `mozart compose` and Mozart will bundle your packages according to the above configuration. It is recommended to dump the autoloader after Mozart has finished running, in case there are new classes or namespaces generated that aren't included in the autoloader yet.
@@ -83,3 +102,17 @@ Mozart is designed to install and be forgotten about. Using Composer scripts, th
83102
]
84103
}
85104
```
105+
106+
When using Mozart through its Docker container, you can replace the `"\"vendor/bin/mozart\" compose",` lines with the actual commands you use to [run the Docker container](#docker) for your specific project. Running Mozart from inside the Docker container is really fast and shouldn't take more than a couple seconds.
107+
108+
## Background and philosophy
109+
Mozart is designed to bridge the gap between the WordPress ecosytem and the vast packages ecosystem of PHP as a whole. Since WordPress is such an end-user friendly focussed CMS (for good reasons), there is no place within the ecosystem where an end-user would be burdened with using a developers tool like Composer. Also, since WordPress has to run on basically any hosting infrastructure, running Composer to install packages from the administration panel (trust me, I've tried - it can be done) is a mission impossible to make it happen and compatible with every server out there.
110+
111+
But why make a new tool for this? There are other tools that enable you to do this, right? Yes, there are now. [PHP-Scoper](https://github.com/humbug/php-scoper), for example. PHP-Scoper is a fantastic tool, that does the job right. But, PHP-Scoper wasn't available back when I started the Mozart project. Also, PHP-Scoper has a few limitations (no support for classmap autoloaders, for example) that were and are still quite common within the WordPress ecosystem. Finally, PHP-Scoper can be quite the tool to add to your development flow, while Mozart was designed to be _simple to implement_, specifically tailored for WordPress projects.
112+
113+
The key values of what's important to Mozart:
114+
- Must be able to be easily installable by a developer, preferably in a specific version.
115+
- Distribution must be done through an existing package manager or easily maintained separately.
116+
- Shouldn't add a whole layer of complexity to the development process, i.e. learning a whole new tool/language.
117+
118+
Mozart always has been and always will be geared towards solving the conflicting dependencies problem in the WordPress ecosystem, as efficiently and opinionated as possible. By being opinionated in certain ways and specifically focussed on WordPress projects, Mozart has quickly become easy to understand and implement.

‎bin/mozart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ call_user_func(function ($version) {
2626

2727
$app = new CoenJacobs\Mozart\Console\Application($version);
2828
$app->run();
29-
}, '0.6.0');
29+
}, '0.7.0');

‎composer.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"prefer-stable": true,
1313
"license": "MIT",
1414
"require": {
15-
"php": "^7.2",
15+
"php": "^7.3|^8.0",
1616
"symfony/console": "^4|^5",
1717
"symfony/finder": "^4|^5",
1818
"league/flysystem": "^1.0"
@@ -26,7 +26,8 @@
2626
"clue/phar-composer": "^1.2",
2727
"phpunit/phpunit": "^8.5",
2828
"squizlabs/php_codesniffer": "^3.5",
29-
"mheap/phpunit-github-actions-printer": "^1.4"
29+
"mheap/phpunit-github-actions-printer": "^1.4",
30+
"vimeo/psalm": "^4.4"
3031
},
3132
"scripts": {
3233
"lint": [

‎psalm.xml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?xml version="1.0"?>
2+
<psalm
3+
errorLevel="3"
4+
resolveFromConfigFile="true"
5+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6+
xmlns="https://getpsalm.org/schema/config"
7+
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
8+
>
9+
<projectFiles>
10+
<directory name="src" />
11+
<ignoreFiles>
12+
<directory name="vendor" />
13+
</ignoreFiles>
14+
</projectFiles>
15+
</psalm>

‎src/Composer/Autoload/Autoloader.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@
55
interface Autoloader
66
{
77
public function processConfig($autoloadConfig);
8+
public function getSearchNamespace();
89
}

0 commit comments

Comments
 (0)