Skip to content

Add base rules #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/Rules/BaseRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ class BaseRule

public static string $rootPath = 'app/';

public static string $reason = 'we use Laravel framework!';

public static function classSet(): ClassSet
{
return ClassSet::fromDir(static::directory());
Expand Down
32 changes: 32 additions & 0 deletions src/Rules/Extending/BaseExtending.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?php

declare(strict_types=1);

namespace Mortexa\LaravelArkitect\Rules\Extending;

use Arkitect\Expression\ForClasses\Extend;
use Arkitect\Expression\ForClasses\ResideInOneOfTheseNamespaces;
use Arkitect\Rules\DSL\ArchRule;
use Arkitect\Rules\Rule;
use Mortexa\LaravelArkitect\Contracts\RuleContract;
use Mortexa\LaravelArkitect\Rules\BaseRule;

abstract class BaseExtending extends BaseRule implements RuleContract
{
public static string $namespace = 'Console\Commands';

public static string $path = 'Console/Commands';

public static array $except = [];

public static array $classNames = [];

public static function rule(): ArchRule
{
return Rule::allClasses()
->except(...static::$except)
->that(new ResideInOneOfTheseNamespaces(static::namespace()))
->should(new Extend(...static::$classNames))
->because(static::$reason);
}
}
17 changes: 2 additions & 15 deletions src/Rules/Extending/CommandsExtending.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,11 @@

namespace Mortexa\LaravelArkitect\Rules\Extending;

use Arkitect\Expression\ForClasses\Extend;
use Arkitect\Expression\ForClasses\ResideInOneOfTheseNamespaces;
use Arkitect\Rules\DSL\ArchRule;
use Arkitect\Rules\Rule;
use Mortexa\LaravelArkitect\Contracts\RuleContract;
use Mortexa\LaravelArkitect\Rules\BaseRule;

class CommandsExtending extends BaseRule implements RuleContract
class CommandsExtending extends BaseExtending
{
public static string $namespace = 'Console\Commands';

public static string $path = 'Console/Commands';

public static function rule(): ArchRule
{
return Rule::allClasses()
->that(new ResideInOneOfTheseNamespaces(static::namespace()))
->should(new Extend('Illuminate\Console\Command'))
->because('we use Laravel framework!');
}
public static array $classNames = ['Illuminate\Console\Command'];
}
20 changes: 4 additions & 16 deletions src/Rules/Extending/ControllersExtending.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,13 @@

namespace Mortexa\LaravelArkitect\Rules\Extending;

use Arkitect\Expression\ForClasses\Extend;
use Arkitect\Expression\ForClasses\ResideInOneOfTheseNamespaces;
use Arkitect\Rules\DSL\ArchRule;
use Arkitect\Rules\Rule;
use Mortexa\LaravelArkitect\Contracts\RuleContract;
use Mortexa\LaravelArkitect\Rules\BaseRule;

class ControllersExtending extends BaseRule implements RuleContract
class ControllersExtending extends BaseExtending
{
public static string $namespace = 'Http\Controllers';

public static string $path = 'Http/Controllers';

public static function rule(): ArchRule
{
return Rule::allClasses()
->except('App\Http\Controllers\Controller')
->that(new ResideInOneOfTheseNamespaces(static::namespace()))
->should(new Extend('App\Http\Controllers\Controller'))
->because('we use Laravel framework!');
}
public static array $except = ['App\Http\Controllers\Controller'];

public static array $classNames = ['App\Http\Controllers\Controller'];
}
20 changes: 4 additions & 16 deletions src/Rules/Extending/ExceptionsExtending.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,13 @@

namespace Mortexa\LaravelArkitect\Rules\Extending;

use Arkitect\Expression\ForClasses\Extend;
use Arkitect\Expression\ForClasses\ResideInOneOfTheseNamespaces;
use Arkitect\Rules\DSL\ArchRule;
use Arkitect\Rules\Rule;
use Mortexa\LaravelArkitect\Contracts\RuleContract;
use Mortexa\LaravelArkitect\Rules\BaseRule;

class ExceptionsExtending extends BaseRule implements RuleContract
class ExceptionsExtending extends BaseExtending
{
public static string $namespace = 'Exceptions';

public static string $path = 'Exceptions';

public static function rule(): ArchRule
{
return Rule::allClasses()
->except('App\Exceptions\Handler')
->that(new ResideInOneOfTheseNamespaces(static::namespace()))
->should(new Extend('Exception'))
->because('we use Laravel framework!');
}
public static array $except = ['App\Exceptions\Handler'];

public static array $classNames = ['Exception'];
}
17 changes: 2 additions & 15 deletions src/Rules/Extending/FactoriesExtending.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,13 @@

namespace Mortexa\LaravelArkitect\Rules\Extending;

use Arkitect\Expression\ForClasses\Extend;
use Arkitect\Expression\ForClasses\ResideInOneOfTheseNamespaces;
use Arkitect\Rules\DSL\ArchRule;
use Arkitect\Rules\Rule;
use Mortexa\LaravelArkitect\Contracts\RuleContract;
use Mortexa\LaravelArkitect\Rules\BaseRule;

class FactoriesExtending extends BaseRule implements RuleContract
class FactoriesExtending extends BaseExtending
{
public static string $namespace = 'Database\Factories';

public static string $path = 'database/factories';

public static function rule(): ArchRule
{
return Rule::allClasses()
->that(new ResideInOneOfTheseNamespaces(static::namespace()))
->should(new Extend('Illuminate\Database\Eloquent\Factories\Factory'))
->because('we use Laravel framework!');
}
public static array $classNames = ['Illuminate\Database\Eloquent\Factories\Factory'];

public static function namespace(): string
{
Expand Down
30 changes: 9 additions & 21 deletions src/Rules/Extending/ModelsExtending.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,18 @@

namespace Mortexa\LaravelArkitect\Rules\Extending;

use Arkitect\Expression\ForClasses\Extend;
use Arkitect\Expression\ForClasses\ResideInOneOfTheseNamespaces;
use Arkitect\Rules\DSL\ArchRule;
use Arkitect\Rules\Rule;
use Mortexa\LaravelArkitect\Contracts\RuleContract;
use Mortexa\LaravelArkitect\Rules\BaseRule;

class ModelsExtending extends BaseRule implements RuleContract
class ModelsExtending extends BaseExtending
{
public static string $namespace = 'Models';

public static string $path = 'Models';

public static function rule(): ArchRule
{
return Rule::allClasses()
->except(
'App\Models\User',
'App\Models\Admin',
'App\Models\Client',
'App\Models\Scopes'
)
->that(new ResideInOneOfTheseNamespaces(static::namespace()))
->should(new Extend('Illuminate\Database\Eloquent\Model'))
->because('we use Laravel framework!');
}
public static array $except = [
'App\Models\User',
'App\Models\Admin',
'App\Models\Client',
'App\Models\Scopes',
];

public static array $classNames = ['Illuminate\Database\Eloquent\Model'];
}