Internal improvements 6 (#29)

* Add ByRefService and ByRefServiceInterface with by-reference parameter methods

* Add UnpackService and ArgumentUnpackingTest for argument unpacking functionality

* Add UnsealedPayloadService and ComplexUnsealedShapesTest for dynamic shape processing

* Add CollisionService and related traits for method conflict resolution testing

* Add trait alias caching and retrieval in HierarchyResolver for improved performance

* Add ReadonlyUser and UninitializedReadonlyContainer classes with tests for readonly properties

* Add AnonymousContractInterface and ReadonlyOrder classes with tests for anonymous class contracts

* Add Suit and TransactionStatus enums with tests for key-of and value-of functionality

* Add ConditionalReturnService and MultiBranchConditionalReturnsTest for complex return type handling

* Add DnfService and DnfAndComplexIntersectionsTest for handling complex intersections and type aliases

* Add DeepOffsetContainer and DeepOffsetAccessTest for multi-level nested offset access and type validation

* Add CurriedPipelineService and tests for curried callable validation and type checking

* Add CallableTypeNode handling in ReturnChecker for callable return type validation

* Add CallableTypeNode support and enhance callable handling in various services

* Add GenericStreamService and tests for generic iterable and generator functionality

* Enhance GeneratorChecker and RuntimeTypeChecker to support context-aware type validation with $thisOrClass parameter

* Add FirstClassCallableService and corresponding tests for first-class callable validation

* Add MultiTemplateBag class and corresponding tests for multi-template functionality

* Add CRLF line-drift stress tests for source transformation

* Refactor CRLF line-drift tests to ensure Windows compatibility and improve line index assertions

* Fix debug_backtrace function retrieval in ParamChecker and ReturnChecker for improved reliability

* Enhance documentation on generics, callables, and iterators

- Added sections on simultaneous first-use multi-template inference and generic callables with template substitution in generics and bounds documentation.
- Expanded explanations on conditional types, negated generic conditionals, and generic iterables with template substitution.
- Introduced detailed examples for generic generators and interactive generators, including validation of sent values.
- Updated arrays and shapes documentation to include key/value extractions and implicit keyless tuple syntax.
- Improved clarity on callable contracts, including strict closure instance contracts and higher-order callables.
- Enhanced iterator and generator documentation with lazy validation and multi-level iterator unwrapping.

* Fix path comparison in TypeError exception handling for CRLF tests

Author: rcalicdan

.github/workflows/ci.yml

@@ -43,4 +43,4 @@ jobs:
         if: matrix.os == 'ubuntu-latest' && matrix.php == '8.3'
 
       - name: Run Test Suite (Pest)
-        run: ./vendor/bin/pest --ci
+        run: ./vendor/bin/pest --compact

docs/advanced/liskov-and-inheritance.md

@@ -283,6 +283,57 @@ $service->recordAuditLog(-1, 'audit_ok');
 
 ---
 
+## Trait Conflict Resolution (`insteadof`)
+
+When a class uses multiple traits with identical method names, PHP requires resolving the collision with `insteadof`. TypePHP respects `insteadof` precedence, enforcing contracts strictly from the selected trait:
+
+```php
+trait PrimaryLogger
+{
+    /**
+     * @param positive-int $level
+     * @param non-empty-string $message
+     */
+    public function log(int $level, string $message): string
+    {
+        return "primary: {$level} - {$message}";
+    }
+}
+
+trait SecondaryLogger
+{
+    /**
+     * @param negative-int $level
+     * @param string $message
+     */
+    public function log(int $level, string $message): string
+    {
+        return "secondary: {$level} - {$message}";
+    }
+}
+
+class LoggingService
+{
+    // PrimaryLogger::log is selected instead of SecondaryLogger
+    use SecondaryLogger, PrimaryLogger {
+        PrimaryLogger::log insteadof SecondaryLogger;
+        SecondaryLogger::log as secondaryLog;
+    }
+}
+
+$service = new LoggingService();
+
+// 1. Primary log() enforces positive-int and non-empty-string from PrimaryLogger
+$service->log(10, 'server_boot'); // Valid
+// $service->log(-5, 'server_boot'); // Throws: TypeError: Argument $level must be of type positive-int
+
+// 2. Aliased secondaryLog() enforces negative-int from SecondaryLogger
+$service->secondaryLog(-20, 'server_shutdown'); // Valid
+// $service->secondaryLog(20, 'server_shutdown'); // Throws: TypeError: Argument $level must be of type negative-int
+```
+
+---
+
 ## Partial Parameter Overriding (Gap-Filling)
 
 If a child class overrides a method and provides a docblock for **only some** parameters, TypePHP fills in the missing parameter contracts from the parent class or interface:
@@ -338,7 +389,7 @@ When a child class, constructor, or trait implementation overrides an ancestor m
 TypePHP resolves parameter contract inheritance using **3-Tier Name & Position Disambiguation**:
 
 1. **Name-First Matching:** If a parameter name in the child method matches a parameter name in the parent class (e.g. `$container`), the parent's contract is mapped to that parameter regardless of its position index in the child.
-2. **Position Fallback on Renamed Parameters:** If a parameter is renamed in the child class (e.g., `$id` $\rightarrow$ `$userId`), TypePHP maps the contract using its position index.
+2. **Position Fallback on Renamed Parameters:** If a parameter is renamed in the child class (e.g. `$id` $\rightarrow$ `$userId`), TypePHP maps the contract using its position index.
 3. **Candidate Disambiguation (Shift Protection):** If a child class inserts a new parameter at index 0 (shifting all subsequent parameters down), TypePHP **verifies that the candidate child parameter does not already exist in the parent under its own name**. This prevents parent parameter contracts from accidentally mis-mapping onto shifted child parameters!
 
 ```php
@@ -435,7 +486,7 @@ To ensure that resolving complex inheritance chains introduces zero perceptible
 
 When you call `$userRepo->find(42)` 1,000 times in a loop:
 * **Invocation #1:** TypePHP builds the `UserRepository` inheritance tree, parses the docblocks, merges parent gaps, and caches the resolved contract in static RAM.
-* **Invocations #2 through #1,000:** TypePHP fetches the pre-resolved contract directly from static RAM in **O(1) constant nanoseconds**—zero Reflection traversal occurs!
+* **Invocations #2 through #1,000:** TypePHP fetches the pre-resolved contract directly from static RAM in **$O(1)$ constant nanoseconds**—zero Reflection traversal occurs!
 
 ---
 
@@ -445,3 +496,4 @@ TypePHP protects your application from third-party vendor docblock bugs using **
 
 * If a parent class or interface is located inside an excluded folder (such as `/vendor/`), TypePHP **ignores its inherited docblocks**.
 * This prevents third-party package docblock errors or outdated annotations from causing unexpected `TypeError` exceptions in your application code.
+```

docs/core-concepts/function-contracts.md

@@ -66,6 +66,148 @@ registerUser(age: 25, username: 'Alice', id: -5);
 
 ---
 
+## Arguments Passed By-Reference (`&$param`)
+
+TypePHP natively supports PHP's by-reference parameter semantics (`function update(int &$value)`).
+
+### How By-Reference Validation Works
+
+1. **Entry Guard Rails:** TypePHP inspects and validates the variable's value *on function entry* before the function body executes.
+2. **In-Place Caller Scope Mutation:** If the argument passes validation, the function body executes normally, and any modifications to the variable mutate the caller's variable in the caller's scope.
+3. **Safety Guarantee on Failure:** If an invalid value is passed into a by-reference parameter, a `TypeError` is thrown *before* any code in the function body runs, ensuring the caller's variable remains **100% un-mutated and un-corrupted**.
+
+```php
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @param positive-int &$score
+ * @param non-empty-string &$username
+ */
+function applyBonus(int &$score, string &$username): void
+{
+    $score += 50;
+    $username = strtoupper($username);
+}
+
+// 1. Valid Call: Value is validated on entry and mutated in caller scope
+$userScore = 100;
+$userName = 'alice';
+
+applyBonus($userScore, $userName);
+
+echo $userScore; // Output: 150
+echo $userName;  // Output: 'ALICE'
+
+// 2. Invalid Call: Throws TypeError on entry, leaving caller variable untouched!
+$invalidScore = -10;
+$userTag = 'alice';
+
+try {
+    applyBonus($invalidScore, $userTag);
+} catch (\TypeError $e) {
+    echo $invalidScore; // Still -10 (Caller variable was never corrupted!)
+}
+```
+
+### DocBlock Syntax Flexibility (`&$param` vs. `$param`)
+
+You can write your DocBlock annotations with or without the leading ampersand (`&`). Both are recognized identically by TypePHP's parser:
+
+```php
+// Option A: Explicit ampersand in DocBlock (Recommended)
+/**
+ * @param positive-int &$count
+ */
+function incrementCount(int &$count): void { $count++; }
+
+// Option B: Ampersand in native PHP signature only (Fully supported)
+/**
+ * @param positive-int $count
+ */
+function incrementCount(int &$count): void { $count++; }
+```
+
+### By-Reference Arrays & Shapes
+
+Mutating collections or array shapes in-place preserves caller scope bindings:
+
+```php
+/**
+ * @param list<positive-int> &$scores
+ */
+function appendReward(array &$scores): void
+{
+    $scores[] = 500; // Mutates array in caller scope
+}
+
+$myScores = [10, 20, 30];
+appendReward($myScores);
+
+print_r($myScores); // [10, 20, 30, 500]
+```
+
+### Variadic By-Reference Parameters (`&...$params`)
+
+When accepting a variable number of by-reference arguments (`int &...$numbers`), TypePHP validates every individual argument on entry and preserves in-place mutations across all variadic arguments:
+
+```php
+/**
+ * @param positive-int &...$numbers
+ */
+function doubleAll(int &...$numbers): void
+{
+    foreach ($numbers as &$num) {
+        $num *= 2;
+    }
+}
+
+$a = 5;
+$b = 10;
+$c = 15;
+
+doubleAll($a, $b, $c);
+
+echo "$a, $b, $c"; // Output: 10, 20, 30
+```
+
+### OOP & Interface Inheritance for By-Reference Parameters
+
+When a child class implements an interface or overrides a parent method with by-reference parameters, the type contract and reference semantics are inherited automatically (even when child methods rename parameters):
+
+```php
+interface StatusUpdaterInterface
+{
+    /**
+     * @param non-empty-string &$status
+     * @param positive-int &$code
+     */
+    public function update(string &$status, int &$code): void;
+}
+
+class StatusUpdater implements StatusUpdaterInterface
+{
+    // Inherits contracts and by-reference semantics seamlessly
+    public function update(string &$status, int &$statusCode): void
+    {
+        $status = strtoupper($status);
+        $statusCode += 100;
+    }
+}
+
+$updater = new StatusUpdater();
+$currentStatus = 'pending';
+$currentCode = 200;
+
+$updater->update($currentStatus, $currentCode);
+
+echo $currentStatus; // 'PENDING'
+echo $currentCode;   // 300
+```
+
+---
+
 ## Class Methods (Instance & Static)
 
 All parameter and return contract rules apply identically to **instance methods** (`public`, `protected`, `private`) and **static methods**: