CHANGELOG.md

Changelog

All notable changes to laravel-ddd will be documented in this file.

[1.2.0] - 2024-11-23

Breaking

• Stubs are now published to base_path('stubs/ddd') instead of resource_path('stubs/ddd'). In other words, they are now co-located alongside the framework's published stubs, within a ddd subfolder.
• Published stubs now use .stub extension instead of .php.stub (following Laravel's convention).
• If you are using published stubs from pre 1.2, you will need to refactor your stubs accordingly.

Added

• Support for the Application Layer, to generate domain-specific objects that don't belong directly in the domain layer:

  // In config/ddd.php
  'application_path' => 'app/Modules',
  'application_namespace' => 'App\Modules',
  'application_objects' => [
      'controller',
      'request',
      'middleware',
  ],

• Support for Custom Layers, additional top-level namespaces of your choosing, such as Infrastructure, Integrations, etc.:

  // In config/ddd.php
  'layers' => [
      'Infrastructure' => 'src/Infrastructure',
  ],

• Added config utility command ddd:config to help manage the package's configuration over time.
• Added stub utility command ddd:stub to publish one or more stubs selectively.
• Added ddd:controller to generate domain-specific controllers.
• Added ddd:request to generate domain-spefic requests.
• Added ddd:middleware to generate domain-specific middleware.
• Added ddd:migration to generate domain migrations.
• Added ddd:seeder to generate domain seeders.
• Added ddd:stub to manage stubs.
• Migration folders across domains will be registered and scanned when running php artisan migrate, in addition to the standard application database/migrations path.
• Ability to customize generator object naming conventions with your own logic using DDD::resolveObjectSchemaUsing().

Changed

• ddd:model now extends Laravel's native make:model and inherits all standard options:
  • --migration|-m
  • --factory|-f
  • --seed|-s
  • --controller --resource --requests|-crR
  • --policy
  • -mfsc
  • --all|-a
  • --pivot|-p
• ddd:cache is now ddd:optimize (ddd:cache is still available as an alias).
• Since Laravel 11.27.1, the framework's optimize and optimize:clear commands will automatically invoke ddd:optimize (ddd:cache) and ddd:clear respectively.

Deprecated

• Domain base models are no longer required by default, and config('ddd.base_model') is now null by default.
• Stubs are no longer published via php artisan vendor:publish --tag="ddd-stubs". Instead, use php artisan ddd:stub to manage them.

[1.1.3] - 2024-11-05

Chore

• Allow laravel/prompts dependency to use latest version when possible.

[1.1.2] - 2024-09-02

Fixed

• During domain factory autoloading, ensure that guessFactoryNamesUsing returns a string when a domain factory is resolved.
• Resolve issues with failing tests caused by mutations to composer.json that weren't rolled back.

[1.1.1] - 2024-04-17

Added

• Ability to ignore folders during autoloading via config('ddd.autoload_ignore'), or register a custom filter callback via DDD::filterAutoloadPathsUsing(callable $filter).

    /*
    |--------------------------------------------------------------------------
    | Autoload Ignore Folders
    |--------------------------------------------------------------------------
    |
    | Folders that should be skipped during autoloading discovery,
    | relative to the root of each domain.
    |
    | e.g., src/Domain/Invoicing/<folder-to-ignore>
    |
    | If more advanced filtering is needed, a callback can be registered
    | using `DDD::filterAutoloadPathsUsing(callback $filter)` in
    | the AppServiceProvider's boot method.
    |
    */
    'autoload_ignore' => [
        'Tests',
        'Database/Migrations',
    ],

Changed

• Internals: Domain cache is no longer quietly cleared on laravel's cache:clearing event, so that ddd:cache yields consistent results no matter which order it runs in production (before or after cache:clear or optimize:clear commands).

[1.1.0] - 2024-04-07

Added

• Add ddd:class generator extending Laravel's make:class (Laravel 11 only).
• Add ddd:interface generator extending Laravel's make:interface (Laravel 11 only).
• Add ddd:trait generator extending Laravel's make:trait (Laravel 11 only).
• Allow overriding configured namespaces at runtime by specifying an absolute name starting with /:

# The usual: generate a provider in the configured provider namespace
php artisan ddd:provider Invoicing:InvoiceServiceProvider 
# -> Domain\Invoicing\Providers\InvoiceServiceProvider

# Override the configured namespace at runtime
php artisan ddd:provider Invoicing:/InvoiceServiceProvider
# -> Domain\Invoicing\InvoiceServiceProvider

# Generate an event inside the Models namespace (hypothetical)
php artisan ddd:event Invoicing:/Models/EventDoesNotBelongHere
# -> Domain\Invoicing\Models\EventDoesNotBelongHere

# Deep nesting is supported
php artisan ddd:exception Invoicing:/Models/Exceptions/InvoiceNotFoundException
# -> Domain\Invoicing\Models\Exceptions\InvoiceNotFoundException

Fixed

• Internals: Handle a variety of additional edge cases when generating base models and base view models.

[1.0.0] - 2024-03-31

Added

• ddd:list to show a summary of current domains in the domain folder.
• For all generator commands, if a domain isn't specified, prompt for it with auto-completion suggestions based on the contents of the root domain folder.
• Command aliases for some generators:
  • Data Transfer Object: ddd:dto, ddd:data, ddd:data-transfer-object, ddd:datatransferobject
  • Value Object: ddd:value, ddd:valueobject, ddd:value-object
  • View Model: ddd:view-model, ddd:viewmodel
• Additional generators that extend Laravel's generators and funnel the generated objects into the domain layer:
  • ddd:cast {domain}:{name}
  • ddd:channel {domain}:{name}
  • ddd:command {domain}:{name}
  • ddd:enum {domain}:{name} (Laravel 11 only)
  • ddd:event {domain}:{name}
  • ddd:exception {domain}:{name}
  • ddd:job {domain}:{name}
  • ddd:listener {domain}:{name}
  • ddd:mail {domain}:{name}
  • ddd:notification {domain}:{name}
  • ddd:observer {domain}:{name}
  • ddd:policy {domain}:{name}
  • ddd:provider {domain}:{name}
  • ddd:resource {domain}:{name}
  • ddd:rule {domain}:{name}
  • ddd:scope {domain}:{name}
• Support for autoloading and discovery of domain service providers, commands, policies, and factories.

Changed

• (BREAKING) For applications that published the config prior to this release, config should be removed, re-published, and re-configured.
• (BREAKING) Generator commands no longer receive a domain argument. Instead of ddd:action Invoicing CreateInvoice, one of the following would be used:
  • Using the --domain option: ddd:action CreateInvoice --domain=Invoicing (this takes precedence).
  • Shorthand syntax: ddd:action Invoicing:CreateInvoice.
  • Or simply ddd:action CreateInvoice to be prompted for the domain afterwards.
• Improved the reliability of generating base view models when ddd.base_view_model is something other than the default Domain\Shared\ViewModels\ViewModel.
• Domain factories are now generated inside the domain layer under the configured factory namespace ddd.namespaces.factory (default Database\Factories). Factories located in /database/factories/<domain>/* (v0.x) will continue to work as a fallback when attempting to resolve a domain model's factory.
• Minimum supported Laravel version is now 10.25.

Chore

• Dropped Laravel 9 support.

[0.10.0] - 2024-03-23

Added

• Add ddd.domain_path and ddd.domain_namespace to config, to specify the path to the domain layer and root domain namespace more explicitly (replaces the previous ddd.paths.domains config).
• Implement Lunarstorm\LaravelDDD\Factories\HasDomainFactory trait which can be used on domain models that are unable to extend the base domain model.

Changed

• Default base-model.php.stub now utilizes the HasDomainFactory trait.

Deprecated

• Config ddd.paths.domains deprecated in favour of ddd.domain_path and ddd.domain_namespace. Existing config files published prior to this release should remove ddd.paths.domains and add ddd.domain_path and ddd.domain_namespace accordingly.

[0.9.0] - 2024-03-11

Changed

• Internals: normalize generator file paths using DIRECTORY_SEPARATOR for consistency across different operating systems when it comes to console output and test expectations.

Chore

• Add Laravel 11 support.
• Add PHP 8.3 support.

[0.8.1] - 2023-12-05

Chore

• Update dependencies.

[0.8.0] - 2023-11-12

Changed

• Implement proper support for custom base models when using ddd:model:
  • If the configured ddd.base_model exists (evaluated using class_exists), base model generation is skipped.
  • If ddd.base_model does not exist and falls under a domain namespace, base model will be generated.
  • Falling under a domain namespace means Domain\**\Models\**.
  • If ddd.base_model were set to App\Models\NonExistentModel or Illuminate\Database\Eloquent\NonExistentModel, they fall outside of the domain namespace and will not be generated for you.

Fixed

• Resolve long-standing issue where ddd:model would not properly detect whether the configured ddd.base_model already exists, leading to unintended results.

Chore

• Update composer dependencies.

BREAKING

• The default domain model stub model.php.stub has changed. If stubs were published prior to this release, you may have to delete and re-publish; unless the published model.php.stub has been entirely customized with independent logic for your respective application.

[0.7.0] - 2023-10-22

Added

• Formal support for subdomains (nested domains). For example, to generate model Domain\Reporting\Internal\Models\InvoiceReport, the domain argument can be specified with dot notation: ddd:model Reporting.Internal InvoiceReport. Specifying Reporting/Internal or Reporting\\Internal will also be accepted and normalized to dot notation internally.
• Implement abstract Lunarstorm\LaravelDDD\Factories\DomainFactory extension of Illuminate\Database\Eloquent\Factories\Factory:
  • Implements DomainFactory::resolveFactoryName() to resolve the corresponding factory for a domain model.
  • Will resolve the correct factory if the model belongs to a subdomain; Domain\Reporting\Internal\Models\InvoiceReport will correctly resolve to Database\Factories\Reporting\Internal\InvoiceReportFactory.

Changed

• Default base model implementation in base-model.php.stub now uses DomainFactory::factoryForModel() inside the newFactory method to resolve the model factory.

BREAKING

• For existing installations of the package to support sub-domain model factories, the base model's newFactory() should be updated where applicable; see base-model.php.stub.

use Lunarstorm\LaravelDDD\Factories\DomainFactory;

// ...

protected static function newFactory()
{
    return DomainFactory::factoryForModel(get_called_class());
}

[0.6.1] - 2023-08-14

Fixed

• Ensure generated domain factories set the protected $model property.
• Ensure generated factory classes are always suffixed by Factory.

[0.6.0] - 2023-08-14

Added

• Ability to generate domain model factories, in a few ways:
  • ddd:factory Invoicing InvoiceFactory
  • ddd:model Invoicing Invoice --factory
  • ddd:model Invoicing Invoice -f
  • ddd:model -f (if relying on prompts)

[0.5.1] - 2023-06-27

Changed

• Clean up default stubs; get rid of extraneous ellipses in comment blocks and ensure code style is consistent.

Fixed

• Ensure generator commands show a nicely sanitized path to generated file in the console output (previously, double slashes were present). Only applies to Laravel 9.32.0 onwards, when file paths were added to the console output.

Chore

• Upgrade test suite to use Pest 2.x.

[0.5.0] - 2023-06-14

Added

• Ability to generate actions (ddd:action), which by default generates an action class based on the lorisleiva/laravel-actions package.

Changed

• Minor cleanups and updates to the default ddd.php config file.
• Update stubs to be less opinionated where possible.

[0.4.0] - 2023-05-08

Changed

• Update argument definitions across generator commands to play nicely with PromptsForMissingInput behaviour introduced in Laravel v9.49.0.

Fixed

• Ensure the configured domain path and namespace is respected by ddd:base-model and ddd:base-view-model.

[0.3.0] - 2023-03-23

Added

• Increase test coverage to ensure expected namespaces are present in generated objects.

Changed

• Domain generator commands will infer the root domain namespace based on the configured ddd.paths.domains.
• Change the default domain path in config to src/Domain (was previously src/Domains), thereby generating objects with the singular Domain root namespace.

[0.2.0] - 2023-03-20

Added

• Support for Laravel 10.

Changed

• Install command now publishes config, registers the default domain path in composer.json, and prompts to publish stubs.
• Generator command signatures simplified to ddd:* (previously ddd:make:*).

Fixed

• When ViewModels are generated, base view model import statement is now properly substituted.

[0.1.0] - 2023-01-19

Added

• Early version of generator commands for domain models, dto, value objects, view models.
• ddd:install command to automatically register the domain folder inside the application's composer.json (experimental)