maint/dock

.gitattributes

@@ -7,17 +7,10 @@
 /CONTRIBUTING.md          export-ignore
 /docker-compose.yml       export-ignore
 /LICENSE.md               export-ignore
-/logo.png                 export-ignore
 /phpunit.xml              export-ignore
-/phpunit71.xml            export-ignore
-/phpunit72.xml            export-ignore
-/phpunit73.xml            export-ignore
-/phpunit74.xml            export-ignore
-/phpunit80.xml            export-ignore
-/phpunit81.xml            export-ignore
-/phpunit82.xml            export-ignore
-/phpunit83.xml            export-ignore
-/phpunit84.xml            export-ignore
 /README.md                export-ignore
 /SECURITY.md              export-ignore
-/test.sh                  export-ignore
+/.env.example             export-ignore
+/dock                     export-ignore
+/test.sh                  export-ignore
+/art/                     export-ignore

.github/workflows/test.yml

@@ -9,22 +9,24 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
-    services:
-      docker:
-        image: docker:20.10.7
-        options: --privileged
 
     strategy:
       matrix:
-        php-version: [84, 83, 82, 81, 80, 74, 73, 72, 71]
+        php-version: ["8.4", "8.3", "8.2", "8.1", "8.0", "7.4", "7.3", "7.2", "7.1"]
 
     steps:
       - uses: actions/checkout@v4
 
-      - name: Install dependencies for PHP${{ matrix.php-version }}
-        run: |
-          docker compose run --rm php${{ matrix.php-version }}composer composer update --no-cache
+      - name: Create .env
+        run: touch .env
 
-      - name: Run PHPUnit tests for PHP${{ matrix.php-version }}
+      - name: Set PHP version in .env
         run: |
-          docker compose run --rm php${{ matrix.php-version }} vendor/bin/phpunit --configuration phpunit${{ matrix.php-version }}.xml
+          echo "PHP_COMPOSER=${{ matrix.php-version }}" >> .env
+          echo "PHP_VERSION=${{ matrix.php-version }}" >> .env
+
+      - name: Install dependencies (composer update) for PHP
+        run: sh dock composer update
+
+      - name: Run PHPUnit tests for PHP
+        run: sh dock test

.gitignore

@@ -4,12 +4,5 @@ composer.lock
 .phpunit.result.cache
 .php-cs-fixer.cache
 /.phpunit.cache/
-/vendor-php71/
-/vendor-php72/
-/vendor-php73/
-/vendor-php74/
-/vendor-php80/
-/vendor-php81/
-/vendor-php82/
-/vendor-php83/
-/vendor-php84/
+.vendor/
+.env

README.md

@@ -9,27 +9,45 @@
 [![wakatime](https://wakatime.com/badge/github/zero-to-prod/transformable.svg)](https://wakatime.com/badge/github/zero-to-prod/transformable)
 [![Hits-of-Code](https://hitsofcode.com/github/zero-to-prod/transformable?branch=main)](https://hitsofcode.com/github/zero-to-prod/transformable/view?branch=main)
 
+## Contents
+
+- [Introduction](#introduction)
+- [Requirements](#requirements)
+- [Installation](#installation)
+    - [Additional Packages](#additional-packages)
+- [Usage](#usage)
+    - [Methods](#methods)
+- [Local Development](#local-development)
+    - [Prerequisites](#prerequisites)
+    - [Initializing](#initializing)
+    - [Testing](#testing)
+    - [Configuration](#configuration)
+- [Contributing](#contributing)
+
+## Introduction
+
 Transform a class into different types.
 
+## Requirements
+
+- PHP 7.1 or higher.
+
 ## Installation
 
-You can install the package via Composer:
+Install `Zerotoprod\Transformable` via [Composer](https://getcomposer.org/):
 
 ```bash
 composer require zero-to-prod/transformable
 ```
 
+This will add the package to your project’s dependencies and create an autoloader entry for it.
+
 ### Additional Packages
 
 - [DataModel](https://github.com/zero-to-prod/data-model): Transform data into a class.
 - [DataModelHelper](https://github.com/zero-to-prod/data-model-helper): Helpers for a `DataModel`.
 - [DataModelFactory](https://github.com/zero-to-prod/data-model-factory): A factory helper to set the value of your `DataModel`.
 
-## Methods
-
-- `toArray(): array` Converts the object’s properties into an associative array.
-- `toJson(): string` Converts the object’s properties into a JSON string.
-
 ## Usage
 
 To use the `Zerotoprod\Transformable\Transformable` trait in your class, simply include it:
@@ -51,4 +69,71 @@ $model->email = 'john.doe@example.com';
 
 $array = $model->toArray();
 $json = $model->toJson();
-```
+```
+
+### Methods
+
+- `toArray(): array` Converts the object’s properties into an associative array.
+- `toJson(): string` Converts the object’s properties into a JSON string.
+
+## Local Development
+
+This project provides a convenient [dock](https://github.com/zero-to-prod/dock) script to simplify local development workflows within Docker
+containers.
+
+You can use this script to initialize the project, manage Composer dependencies, and run tests in a consistent PHP environment.
+
+### Prerequisites
+
+- Docker installed and running
+- A `.env` file (created automatically via the `dock init` command, if it doesn’t already exist)
+
+### Initializing
+
+Use the following commands to set up the project:
+
+```shell
+sh dock init
+sh dock composer update
+```
+
+### Testing
+
+This command runs PHPUnit inside the Docker container, using the PHP version specified in your `.env` file.
+You can modify or extend this script to include additional tests or commands as needed.
+
+```shell
+sh dock test
+```
+
+Run the test suite with all versions of php:
+
+```shell
+sh test.sh
+```
+
+### Configuration
+
+Before starting development, verify that your `.env` file contains the correct settings.
+
+You can specify which PHP version to use for local development, debugging, and Composer operations by updating these variables in your `.env` file:
+
+```dotenv
+PHP_VERSION=8.1
+PHP_DEBUG=8.1
+PHP_COMPOSER=8.1
+```
+
+Make sure these values reflect the PHP versions you intend to use.
+If the `.env` file does not exist, run the `sh dock init` command to create one from the `.env.example` template.
+
+## Contributing
+
+Contributions, issues, and feature requests are welcome!
+Feel free to check the [issues](https://github.com/zero-to-prod/transformable/issues) page if you want to contribute.
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-branch`).
+3. Commit changes (`git commit -m 'Add some feature'`).
+4. Push to the branch (`git push origin feature-branch`).
+5. Create a new Pull Request.

dock

@@ -0,0 +1,71 @@
+#!/usr/bin/env bash
+
+set -e
+
+usage() {
+  cat <<EOF
+Usage: $0 <command> [options]
+
+Commands:
+  init       Initialize the .env file from .env.example if it doesn't exist.
+  test       Run PHPUnit tests using the specified PHP version.
+  composer   Run Composer commands using the specified PHP version.
+  <service>  Run a specified Docker service with optional arguments.
+
+Examples:
+  $0 init
+  $0 test --filter=MyTest
+  $0 composer install
+  $0 php8.1 bash
+EOF
+  exit 1
+}
+
+if [ "$#" -lt 1 ]; then
+  usage
+fi
+
+run_service() {
+  local service=$1
+  shift
+  if ! docker compose run --rm "$service" "$@"; then
+    exit 1
+  fi
+}
+
+case "$1" in
+  init)
+    if [ ! -f ".env" ]; then
+      cp ".env.example" ".env"
+      echo "cp '.env.example' '.env'"
+    fi
+    exit 0;
+  ;;
+esac
+
+if [ ! -f ".env" ]; then
+  echo "Project does not have a .env file. Please provide one or run: dock init"
+  exit 0
+fi
+
+PHP_VERSION=$(grep "^PHP_VERSION=" .env | cut -d '=' -f2-)
+
+case "$1" in
+  test)
+    shift
+    run_service "php${PHP_VERSION}" vendor/bin/phpunit "$@"
+  ;;
+  build)
+    shift
+    docker compose build "php${PHP_VERSION}" "$@"
+    docker compose build "debug${PHP_VERSION}" "$@"
+    docker compose build "composer${PHP_VERSION}" "$@"
+  ;;
+  composer)
+    shift
+    run_service "composer${PHP_VERSION}" composer "$@"
+  ;;
+  *)
+    run_service "$@"
+  ;;
+esac