CompileVisitor using the visitor pattern and CompiledInjector

.github/workflows/coding-standards.yml

@@ -9,4 +9,4 @@ jobs:
   cs:
     uses: ray-di/.github/.github/workflows/coding-standards.yml@v1
     with:
-      php_version: 8.3
+      php_version: 8.4

.github/workflows/static-analysis.yml

@@ -9,5 +9,5 @@ jobs:
   sa:
     uses: ray-di/.github/.github/workflows/static-analysis.yml@v1
     with:
-      php_version: 8.3
+      php_version: 8.4
       has_crc_config: true

README.md

@@ -1,68 +1,172 @@
 # Ray.Compiler
 
-## Dependency Injection Compiler
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/ray-di/Ray.Compiler/badges/quality-score.png?b=1.x)](https://scrutinizer-ci.com/g/ray-di/Ray.Compiler/?branch=1.x)
+[![codecov](https://codecov.io/gh/ray-di/Ray.Compiler/branch/1.x/graph/badge.svg?token=KCQXtu01zc)](https://codecov.io/gh/ray-di/Ray.Compiler)
+[![Type Coverage](https://shepherd.dev/github/ray-di/Ray.Compiler/coverage.svg)](https://shepherd.dev/github/ray-di/Ray.Compiler)
+[![Continuous Integration](https://github.com/ray-di/Ray.Compiler/actions/workflows/continuous-integration.yml/badge.svg?branch=1.x)](https://github.com/ray-di/Ray.Compiler/actions/workflows/continuous-integration.yml)
 
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/ray-di/Ray.Di/badges/quality-score.png?b=2.x)](https://scrutinizer-ci.com/g/ray-di/Ray.Di/?branch=2.x)
-[![codecov](https://codecov.io/gh/ray-di/Ray.Di/branch/2.x/graph/badge.svg?token=KCQXtu01zc)](https://codecov.io/gh/ray-di/Ray.Di)
-[![Type Coverage](https://shepherd.dev/github/ray-di/Ray.Di/coverage.svg)](https://shepherd.dev/github/ray-di/Ray.Di)
-[![Continuous Integration](https://github.com/ray-di/Ray.Di/actions/workflows/continuous-integration.yml/badge.svg?branch=2.x)](https://github.com/ray-di/Ray.Di/actions/workflows/continuous-integration.yml)
+Pre-compile Ray.Di bindings to PHP code for maximum performance. The compiled injector runs faster than the standard injector by avoiding runtime reflection and binding resolution.
 
-Ray.Compiler compiles Ray.Di bindings into PHP code, providing a performance boost that makes Dependency Injection couldn't be any faster.
+## Installation
 
-##  Script Injector
+```bash
+composer require ray/compiler
+```
 
-`ScriptInjector` has the same interface as Ray.Di Injector; whereas Ray.Di Injector resolves dependencies based on memory bindings, ScriptInjector executes pre-compiled PHP code and is faster.
+## Usage
 
-Ray.Di injector
-```php
-$injector = new Injector(new CarModule); // Ray.Di injector
-```
+Ray.Compiler provides two main components:
+
+1. **`Compiler`**: Compiles Ray.Di bindings into PHP code.
+2. **`CompiledInjector`**: High-performance injector that executes pre-compiled code.
+
+### Basic Usage
+
+Pre-compile your dependencies:
 
-Ray.Compiler injector
 ```php
-$injector = new ScriptInjector($tmpDir, fn => new CarModule);
+use Ray\Compiler\Compiler;
+
+$compiler = new Compiler();
+// Compile Ray.Di bindings to PHP files
+$compiler->compile(
+    $module,    // AbstractModule: Your application's module
+    $scriptDir  // string: Directory path where compiled PHP files will be generated
+);
 ```
 
-## Precompile
-
-You will want to compile all dependencies into code before deploying the production. The `DiCompiler` will compile all bindings into PHP code.
+Use the compiled injector:
 
 ```php
-$compiler = new DiCompiler(new CarModule, $tmpDir);
-$compiler->compile();
+use Ray\Compiler\CompiledInjector;
+
+$injector = new CompiledInjector($scriptDir);
+$instance = $injector->getInstance(YourInterface::class);
 ```
 
-## Object graph visualization
+### Compiler Integration
 
-Object graph can be visualized with `dumpGraph()`.
-Graph HTML files will be output at `graph` folder under `$tmpDir`.
+Create a compile script:
 
 ```php
-$compiler = new DiCompiler(new Module, $tmpDir);
-$compiler->compile();
-$compiler->dumpGraph();
+try {
+    $scripts = (new Compiler())->compile(
+        new AppModule(),
+        __DIR__ . '/di'
+    );
+    printf("Compiled %d files.\n", count($scripts));
+} catch (CompileException $e) {
+    fprintf(STDERR, "Compilation failed: %s\n", $e->getMessage());
+    exit(1);
+}
 ```
 
+Add compile script to your `composer.json`:
+
+```json
+{
+    "scripts": {
+        "post-install-cmd": ["php bin/compile.php"]
+    }
+}
 ```
-open tmp/graph/Ray_Compiler_FakeCarInterface-.html
+
+## Docker Integration
+
+Use multi-stage builds to maintain path consistency:
+
+```dockerfile
+# Build stage
+FROM php:8.2-cli-alpine as builder
+
+# Set working directory
+WORKDIR /app
+
+# Install composer
+COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
+
+# Copy composer files first
+COPY composer.json composer.lock ./
+
+# Install dependencies
+RUN composer install \
+    --no-dev \
+    --no-scripts \
+    --prefer-dist \
+    --no-interaction \
+    --optimize-autoloader
+
+# Copy application code
+COPY . .
+
+# Create non-root user
+RUN adduser -D appuser
+USER appuser
+
+# Compile DI code
+RUN php bin/compile.php
+
+# Production stage
+FROM php:8.2-cli-alpine
+
+# Create non-root user
+RUN adduser -D appuser
+
+# Set working directory
+WORKDIR /app
+
+# Copy only necessary files from builder
+COPY --from=builder /app/vendor/ ./vendor/
+COPY . .
+COPY --from=builder /app/tmp/di/ ./tmp/di/
+
+# Switch to non-root user
+USER appuser
+# Start command or other configurations can be added here
 ```
 
-## CompileInjector
+## Docker Best Practices
 
-The `CompileInjector` gives you the best performance in both development (x2) and production (x10) by switching two injector.
+When building your Docker images, it’s important to exclude unnecessary files to speed up builds, reduce image size, and prevent sensitive files from being included in the image. Below is a recommended `.dockerignore` file. Adjust it to fit your project’s requirements:
 
-Get the injector by specifying the binding and cache, depending on the execution context of the application.
+```dockerignore
+# Ignore Git files
+.git/
 
-```php
-$injector = new CompileInjector($tmpDir, $injectorContext);
+# Ignore dependency directories
+/vendor/
+/node_modules/
+
+# Ignore compiled DI files
+/tmp/di/
+
+# Ignore environment-specific files
+.env
+.env.local
+.env.*.local
+
+# Ignore documentation and tests
+/docs/
+/tests/
+
+# Ignore IDE-specific files
+.idea/
+.vscode/
+
+# Ignore log files
+*.log
+
+# Ignore OS-specific files
+.DS_Store
+Thumbs.db
 ```
 
-`$injectorContext` example: 
+## Version Control
 
- * [dev](docs/exmaple/DevInjectorContext.php)
- * [prod](docs/exmaple/ProdInjectorContext.php)
+Compiled DI code is considered an environment-specific build artifact and **should not** be committed to version control. This approach ensures that your repository remains clean and build artifacts do not cause merge conflicts or unexpected behavior across different environments.
 
-The `__invoke()` method prepares the modules needed in that context.
-The `getCache()` method specifies the cache of the injector itself.
+Add the compile directory to your `.gitignore`:
 
-Install `DiCompileModule` in the context for production. The injector is more optimized and dependency errors are reported at compile-time instead of run-time.
+```gitignore
+/tmp/di/
+```

bin/compile.php

@@ -0,0 +1,13 @@
+<?php
+
+use Ray\Compiler\Compiler;
+use Ray\Compiler\FakeCarModule;
+
+require dirname(__DIR__) . '/vendor/autoload.php';
+
+$scripts = (new Compiler())->compile(
+    new FakeCarModule(),
+    __DIR__ . '/di'
+);
+
+printf('Compiled %d files.', count($scripts));

composer-require-checker.json

@@ -4,19 +4,14 @@
     "static", "self", "parent",
     "array", "string", "int", "float", "bool", "iterable", "callable", "void", "object",
     "Attribute", "ReflectionAttribute",
-    "Ray\\Di\\AbstractModule", "Ray\\Di\\Annotation\\ScriptDir",
-    "Ray\\Di\\Argument", "Ray\\Di\\Arguments",
-    "Ray\\Di\\AssistedModule", "Ray\\Di\\Bind",
-    "Ray\\Di\\Container", "Ray\\Di\\Dependency",
-    "Ray\\Di\\DependencyInterface","Ray\\Di\\DependencyProvider",
-    "Ray\\Di\\Di\\Qualifier", "Ray\\Di\\Exception\\NotFound",
-    "Ray\\Di\\Exception\\Unbound", "Ray\\Di\\InjectionPointInterface",
-    "Ray\\Di\\Injector", "Ray\\Di\\InjectorInterface", "Ray\\Di\\Instance",
-    "Ray\\Di\\MultiBinding\\Map", "Ray\\Di\\MultiBinding\\MapProvider",
-    "Ray\\Di\\Name", "Ray\\Di\\NullCache",
-    "Ray\\Di\\NullModule", "Ray\\Di\\NullObjectDependency",
-    "Ray\\Di\\ProviderInterface", "Ray\\Di\\ProviderSetModule",
-    "Ray\\Di\\SetContextInterface"
-
+    "PhpParser",
+    "PhpParser\\BuilderFactory", "PhpParser\\Node", "PhpParser\\NodeAbstract", "PhpParser\\Node\\Arg",
+    "PhpParser\\Node\\Expr", "PhpParser\\Node\\Expr\\ArrayItem", "PhpParser\\Node\\Expr\\Array_",
+    "PhpParser\\Node\\Expr\\Array_", "PhpParser\\Node\\Expr\\Assign", "PhpParser\\Node\\Expr\\ConstFetch",
+    "PhpParser\\Node\\Expr\\FuncCall", "PhpParser\\Node\\Expr\\MethodCall", "PhpParser\\Node\\Expr\\New_",
+    "PhpParser\\Node\\Expr\\PropertyFetch", "PhpParser\\Node\\Expr\\Variable", "PhpParser\\Node\\Name",
+    "PhpParser\\Node\\FullyQualified", "PhpParser\\Node\\Scalar\\DNumber", "PhpParser\\Node\\Scalar\\LNumber",
+    "PhpParser\\Node\\Scalar\\String_", "PhpParser\\Node\\Stmt\\Return_", "PhpParser\\ParserFactory",
+    "PhpParser\\PrettyPrinter\\Standard", "PhpParser\\Node\\Name\\FullyQualified"
   ]
 }

composer.json

@@ -12,20 +12,19 @@
     ],
     "require": {
         "php": "^7.2 || ^8.0",
-        "doctrine/annotations": "^1.12 || ^2.0",
         "doctrine/cache": "^1.10 || ^2.1",
+        "doctrine/annotations": "^1.8 || ^2.0",
         "koriym/attributes": "^1.0",
         "koriym/null-object": "^1.0",
         "koriym/param-reader": "^1.0",
         "koriym/printo": "^1.0",
-        "nikic/php-parser": "^4.5 || ^5.0",
-        "ray/aop": "^2.14"
+        "ray/aop": "^2.14",
+        "ray/di": "^2.18"
     },
     "require-dev": {
         "ext-pdo": "*",
-        "ray/di": "^2.16",
-        "phpunit/phpunit": "^8.5.24 || ^9.5",
-        "bamarni/composer-bin-plugin": "^1.4"
+        "bamarni/composer-bin-plugin": "^1.4",
+        "phpunit/phpunit": "^8.5.41 || ^9.5"
     },
     "config": {
         "sort-packages": true,
@@ -36,7 +35,11 @@
     "autoload": {
         "psr-4": {
             "Ray\\Compiler\\": ["src", "src-deprecated"]
-        }
+        },
+        "files": [
+            "src-function/prototype.php",
+            "src-function/singleton.php"
+        ]
     },
     "autoload-dev": {
         "psr-4": {
@@ -51,7 +54,7 @@
         "coverage": ["php -dzend_extension=xdebug.so -dxdebug.mode=coverage ./vendor/bin/phpunit --coverage-text --coverage-html=build/coverage"],
         "pcov": ["php -dextension=pcov.so -d pcov.enabled=1 ./vendor/bin/phpunit --coverage-text --coverage-html=build/coverage  --coverage-clover=coverage.xml"],
         "cs": ["phpcs --standard=./phpcs.xml src tests"],
-        "cs-fix": ["phpcbf src tests"],
+        "cs-fix": ["phpcbf src src-function tests"],
         "clean": ["phpstan clear-result-cache", "psalm --clear-cache", "rm -rf tests/tmp/*.php"],
         "sa": ["psalm --show-info=false", "phpstan analyse -c phpstan.neon --no-progress"],
         "metrics": ["@test", "phpmetrics --report-html=build/metrics --exclude=Exception --log-junit=build/junit.xml --junit=build/junit.xml src"],
@@ -62,9 +65,6 @@
         "bamarni-bin": {
             "forward-command": true,
             "bin-links": true
-        },
-        "branch-alias": {
-            "dev-master": "1.0.x-dev"
         }
     }
 }