Reverse Regex Laravel Package

Technical Evaluation

Architecture Fit

• Laravel Compatibility: The package’s stateless, regex-focused design aligns well with Laravel’s testing ecosystem (PestPHP, PHPUnit, Factories). It can be wrapped in a Laravel service or integrated into custom test helpers without violating Laravel’s conventions.
  • Example: Create a RegexDataGenerator facade or service that extends Laravel’s Factory class, enabling syntax like:

    $user = User::factory()->for($company)->create([
        'phone' => RegexDataGenerator::generate('04\d{8}'),
    ]);
    

• Component-Based: The Lexer, Parser, and Generator classes are loosely coupled, allowing for custom randomness strategies (e.g., seeded generation for deterministic tests) or extended regex support via middleware.
• Unicode and Edge-Case Support: Fills gaps in Laravel’s native tools (e.g., Faker lacks \X{####} Unicode support), critical for internationalized apps or domain-specific validation (e.g., Australian postcodes).
• Test Data Isolation: Ideal for unit/integration tests where data must strictly adhere to regex rules (e.g., API payloads, database constraints) without leaking into production logic.

Integration Feasibility

• Low Friction: Requires only Composer installation and minimal boilerplate (e.g., Lexer, Parser instantiation). Can be hidden behind a fluent interface (e.g., Regex::generate('pattern')->times(10)).
• Laravel Service Provider: Can be bootstrapped as a singleton in AppServiceProvider, exposing a global helper:

  // config/regex.php
  'generators' => [
      'phone' => '04\d{8}',
      'postcode' => '\d{4}',
  ];
  

  // Helper function
  function regex_generate(string $pattern, int $seed = null): string {
      $lexer = new \ReverseRegex\Lexer($pattern);
      $parser = new \ReverseRegex\Parser($lexer, new \ReverseRegex\Generator\Scope(), new \ReverseRegex\Generator\Scope());
      $gen = $seed ? new \ReverseRegex\Random\SeededRandom($seed) : new \ReverseRegex\Random\SimpleRandom();
      return $parser->parse()->getResult()->generate('', $gen);
  }
  

• PestPHP Integration: Plugs into Pest’s beforeEach or afterEach for automated test data generation:

  beforeEach(function () {
      $this->testData = [
          'valid_phone' => regex_generate('04\d{8}'),
          'invalid_phone' => regex_generate('[^04]\d{8}'),
      ];
  });
  

• Factory Macros: Extend Laravel’s factories to support regex patterns:

  User::factory()->state(function (array $attributes) {
      return [
          'phone' => regex_generate('04\d{8}'),
      ];
  });
  

Technical Risk

Key Questions for Stakeholders

1. Validation Needs:
   • "What regex patterns are critical for your test suite? Can they be expressed with this package’s supported syntax?"
   • "Are there domain-specific rules (e.g., financial formats, legal IDs) that require unsupported regex features?"
2. PHP Version:
   • "Is upgrading to PHP 8.1+ feasible for your team? If not, would a fork with PHP 7.4 support be justified?"
3. Testing Strategy:
   • "How do you currently generate test data? Would this replace Faker, custom scripts, or both?"
   • "Do you need deterministic (seeded) or truly random generation for CI/CD?"
4. Maintenance:
   • "Who would own long-term maintenance (e.g., updating the fork, handling PHPStan issues)?"
   • "Are there budget/resources to contribute fixes upstream or adopt phpstan-baseline?"
5. Performance:
   • "Will this be used for high-volume generation (e.g., load testing)? If so, have you benchmarked the parser?"
6. Alternatives:
   • "Have you considered custom solutions (e.g., a Laravel macro) or other packages like fzaninotto/Faker with extensions?"
7. Compliance:
   • "Are there regulatory requirements (e.g., GDPR, HIPAA) that mandate specific test data formats?"

Integration Approach

Stack Fit

• Laravel Ecosystem:
  • PestPHP: Replace Faker in test data generation with regex-driven alternatives.
  • PHPUnit: Use in DataProvider methods or setUp() for deterministic test data.
  • Factories: Extend Illuminate\Database\Eloquent\Factories\Factory with regex macros.
  • API Testing (Pest/PHPUnit): Generate valid/invalid payloads for Laravel Sanctum, Passport, or custom API validation.
• PHP Extensions:
  • Symfony Components: Works alongside symfony/polyfill-mbstring (already a dependency).
  • Doctrine: Compatible with Doctrine’s Lexer (used internally).
• CI/CD:
  • GitHub Actions: Leverage existing phpstan and cs-check workflows to enforce quality gates.
  • Composer Scripts: Add post-autoload-dump hooks to validate regex patterns in test files.

Migration Path

Compatibility