wrk-flow / larastrict Goto Github PK

• Testing (can be used for Laravel testing without mockery and LaraStrict)

• Queries folder name convention and "Query" suffix
• Caches folder name convention and "Cache" suffix
• Services folder name convention and "Service" suffix
• Entities folder name convention and "Entity" suffix
• Actions folder name convention and "Action" suffix

• BC composer

Now we have to manually:

• extract implementation to interface (Contract) in Contracts namespace
• (PHPStorm does) replace usage of the implementation and use interface
• update service provider $bindings and adding Contract => implementation binding
• generate assert expectations php artisan make:expectation {path}

Use combination of rector + Laravel command?

If we are using closures, we can generate from closure typehints expected result and input parameters:

expectation would not create Closure $createData but

public readonly NotebookPageEntity $createDataPage,
        public readonly NotebookFinancePageEntity $createDataResultResult,

Assert::assertEquals($createData($expectation->createDataResultPage), $expectation->createDataResult, $message);

If you are using any interface for "setting" service provider.

• Instead of policies
• Sharable logic between views /
• type strict
• testable using factories

• easy install command
• stub files
• setup base composer scripts

For easy copy of hook params to implementation

For quality improvements would be great to patch Laravel framework using cweagans/composer-patches

• laravel/framework#42564
• laravel/framework#41557
• Mabe this "interface" laravel/framework#41485 (maybe could be PHP Attribute?)
• laravel/framework#42018

The patches would be in separate composer package to make it reusable without using larastrict (and maybe optional?).

To allow accessing data from "implementation" objects and passing it to expectation object.

• when injecting cacheme service we
• maybe we can use attribute (class attribute)
• when building class DI, we can return prefixed cachme service with namespace set to all keys.

When using get/set methods, it would be great to wrap cacheMeService in entity/class that would pass $key and strategy.

This would prevent bugs when using set with incorrect strategy

Proposals:

/** @var CacheEntity<string> $cache */
$cache = new CacheEntity(key: $key, strategy: CacheMeStrategy::Memory);
                
$value = $cache->get($this->cacheMeService);
$cache->set($this->cacheMeService, $value);

/** @var CacheEntity<string> $cache */
$cache = new CacheEntity(service: $this->cacheMeService, key: $key, strategy: CacheMeStrategy::Memory);
// construct with service
$cache = $this->cacheMeService->cache($key, strategy: CacheMeStrategy::Memory)
                
$value = $cache->get();
$cache->set($value);

@h4kuna what do you prefer?

• If class is using DI then check if class contains interface
• check if interface is in container (bindings/singletons)
• warn user that he should use interface instead of class

based on discussion with @h4kuna

When using where between with a datetime column there can be a bug. We should try to detect it.

• If we are using Model::CREATED_AT / Model::UPDATED_AT / MODEL::DELETED_AT
• If we are using Model::AtttributeX we could check the $casts?
• if we are using a string 'created_at', 'deleted_at', 'updated_at', maybe '%_at' ?

• Change from string to string|RoutePrefixEntity
• Add ability to customize "where" conditions to ensure that routes are in expected type

• TModel @template will be used for setTransformOnEntry
• TEntry @template will be used for onEntry/onChunk

This will be breaking change in PHPStan reports.

Syntax will be:

ChunkedModelQueryResult<MyModel,MyEntity>
ChunkedModelQueryResult<MyModel,MyModel >

• add soft deletes interface so we can detect soft deletes logic in type safe way
• rector/phpstan - Add interface if class that uses SoftDeletes trait does not use the interface

• Generate expectation
• Add ExpectationCallMap
• Generate assert mock
• Add support for return
• Add name of asserted attribute name
• Add ability to re-generate all asserts/expectations?
• Asset for assert class to check if the method for called expect number of times?

Example of a mock:

/**
 * @extends ExpectationCallMap<GetTourIdForObjectTypeBoardQueryContractExpectation>
 */
class GetTourIdForObjectTypeBoardTestQuery extends ExpectationCallMap implements GetTourIdForObjectTypeBoardQueryContract
{
    public function execute(int $objectId, int $objectTypeId, int $boardId): ?int
    {
        $expectation = $this->getExpectation();

        Assert::assertEquals($expectation->objectId, $objectId);
        Assert::assertEquals($expectation->objectTypeId, $objectTypeId);
        Assert::assertEquals($expectation->boardId, $boardId);
    }
}

Delete older than 60 days

php artisan queue:prune-failed --hours=1440

Problem

When using commands we have actions / services that logs different states. It would be great to prevent logging this to a log file (when using docker all logs are visible to user using stderr) when using command (called by user, not in schedule) and output it directly to user

Problem is detecting if the command was called via artisan.

Current state

At this moment there is partially working solution.

Proposal

• This can be done by replacing LogInterface with console output (currently we have this)
• Also it would be great to make the output nicer (like trying to group same stuff with "similar" context)

• automatic event listeners (via boot)
• cache to memory (and optionally to cache layer)

Assert class is missing \ in namespace for objects in default new statement

• Create fix https://github.com/nette/php-generator
• Use the new version

Assert class - documentation does not use full namespace for object return class

• Create fix https://github.com/nette/php-generator
• Use the new version

Add custom attribute and use one for automatically to (re)generate Assert classes and Expectation classes.

• by custom phpstan type that would indicate view path

From larastran rule:

• view helper function.
• $this->markdown and $this->view methods in Mailables.
• Illuminate\View\Factory::make method.
• Illuminate\Support\Facades\View::make method.
• Illuminate\Support\Facades\Route::view method.

To ensure that calls are asserted.

Check if AssertExpectationTestCase or AssertExpectationManagerTrait is used.

• mkdocs?
• Nuxt? https://content.nuxtjs.org/themes/docs/

If $message is used in method, incorrect value will be used.

/**
 * @template TModel of \Illuminate\Database\Eloquent\Model
 * @template TEntry
 */

• Change the closure(TModel) to closure(Entry)
• will be breaking change for phpstan (thats OK)
• add "test" file