feat: Bundle :box:

Author: leocavalcante

README.md

@@ -59,15 +59,16 @@ phpctl sh echo 'Hello, World!' # To run arbitrary sh commands inside the contain
 | `server [port] [directory]` | Runs PHP's built-in web-server (default port is `80` and default directory is current `.`). |
 
 ### Useful 
-| Command | Description |
-|-----------------|---------------------------------------------------------------------|
-| `phpunit` | Runs [PHPUnit](https://phpunit.de/). |
-| `sh [commands]` | Starts an interactive Shell session or runs `sh` commands. |
-| `repl` | Starts a PHP REPL session (powered by [PsySH](https://psysh.org/)). |
-| `php-cs-fixer` | Runs [PHP-CS-Fixer](https://cs.symfony.com/). |
-| `phpstan` | Runs [PHPStan](https://phpstan.org/). |
-| `infection` | Runs [Infection](https://infection.github.io/). |
-| `box` | Runs [Box](https://github.com/box-project/box). |
+| Command | Description |
+|-----------------|-----------------------------------------------------------------------|
+| `phpunit` | Runs [PHPUnit](https://phpunit.de/). |
+| `sh [commands]` | Starts an interactive Shell session or runs `sh` commands. |
+| `repl` | Starts a PHP REPL session (powered by [PsySH](https://psysh.org/)). |
+| `php-cs-fixer` | Runs [PHP-CS-Fixer](https://cs.symfony.com/). |
+| `phpstan` | Runs [PHPStan](https://phpstan.org/). |
+| `infection` | Runs [Infection](https://infection.github.io/). |
+| `box` | Runs [Box](https://github.com/box-project/box). |
+| `bundle` | Bundles a project into an image and ships it as a single binary file. |
 
 ### Scaffolders
 | Command | Description |

bundle/Dockerfile

@@ -0,0 +1,8 @@
+ARG FROM=opencodeco/phpctl:php82
+FROM $FROM
+ARG ENTRYPOINT=php
+ENV ENTRYPOINT=$ENTRYPOINT
+ARG COMMAND=index.php
+ENV COMMAND=$COMMAND
+COPY . /usr/src
+ENTRYPOINT [ "/usr/src/docker-entrypoint.sh" ]

bundle/bin.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env sh
+: '
+ This script file was generated by the phpctl bundle command.
+ It is basically a wrapper around the docker run command.
+ It is not intended to be edited, but feel free to do so (if you know what you are doing).
+ Move this script file to somewhere in your PATH to make it available as a command.
+ A good place would be /usr/local/bin.
+'
+docker run \
+ -w /workdir \
+ -v $PWD:/workdir \
+ --net host \
+ $(env | awk -F= '/^[[:alpha:]]/{print $1}' | sed 's/^/-e/') \
+ --rm -it IMAGE $@

bundle/docker-entrypoint.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+"$ENTRYPOINT" "/usr/src/$COMMAND" $@

examples/README.md

@@ -5,3 +5,4 @@ Welcome to the `phpctl` examples page.
 Feel free to pick one to see how it is done:
 
 - [box](box/)
+- [bundle](bundle/)

examples/bundle/Makefile

@@ -0,0 +1,14 @@
+IMAGE=docker.io/leocavalcante/phpctl-bundle-example
+
+phpctl-bundle: clean
+phpctl bundle $(IMAGE) phpctl-bundle main.php
+
+.PHONY: push
+push:
+docker push $(IMAGE)
+
+install:
+mv phpctl-bundle /usr/local/bin
+
+clean:
+rm -rf phpctl-bundle

examples/bundle/README.md

@@ -0,0 +1,33 @@
+# Bundle
+
+This is the example directory for the `bundle` command.
+
+This command is used to bundle a project into an image and ship it as a single binanry file.
+
+The command usage is based on `phpctl bundle [image] [alias] [entryfile]`.
+
+But this directory uses `make` to make life easier.
+
+So just:
+```shell
+make && make install
+```
+
+Then execute:
+```shell
+phpctl-bundle
+```
+
+You should see:
+```text
+Hello, World!
+```
+As the output.
+
+The program is `main.php`:
+```php
+<?php
+
+echo "Hello, World!\n";
+
+```

examples/bundle/main.php

@@ -0,0 +1,3 @@
+<?php
+
+echo "Hello, World!\n";

src/bundle.sh

@@ -1,3 +1,23 @@
 box() {
  run -- box $@
 }
+
+bundle() {
+ image="$1"
+ alias="${image##*/}"
+ alias="${2-alias}"
+ command="${3-index.php}"
+ entrypoint="${4-php}"
+ from="${5-opencodeco/phpctl:php82}"
+ cp "$PHPCTL_DIR/bundle/Dockerfile" "$PHPCTL_DIR/bundle/docker-entrypoint.sh" .
+ docker build \
+ --build-arg FROM="$from" \
+ --build-arg ENTRYPOINT="$entrypoint" \
+ --build-arg COMMAND="$command" \
+ -t "$image" .
+ rm Dockerfile docker-entrypoint.sh
+ cp "$PHPCTL_DIR/bundle/bin.sh" "$alias"
+ sed -i.bak "s#IMAGE#$image#g" "$alias"
+ rm "$alias.bak"
+ chmod a+x "$alias"
+}

src/help.sh

@@ -31,6 +31,7 @@ help() {
  echo -e "\033[0;32m create [framework] [dir] \033[0m Creates a new project using the given framework (or package)"
  echo -e "\033[0;32m init [skeleton] \033[0m Initializes a skeleton configuration (phpunit, php-cs-fixer)"
  echo -e "\033[0;32m box \033[0m Runs Box (PHAR builder)"
+ echo -e "\033[0;32m bundle \033[0m Bundles a PHP project into a Docker image"
  echo -e "\033[0;32m help or man \033[0m Displays this help message"
  echo -e "\033[0;32m self-update \033[0m Updates phpctl itself"
  echo -e "\033[0;32m doctor \033[0m Inspects the current PHP_VERSION and PHPCTL_IMAGE"