phpcs calisthenics rules скачать - phpcs calisthenics rules исходного кода скачать

Объектные правила гидроматленности для php_codesniffer

Умеренный: php_codesniffer отлично подходит для обработки пространств и позиций. Тем не менее, эти правила касаются архитектуры и структуры кода. В 2020 году есть инструмент, который подходит для этого идеально - Phpstan .

Сказав это, объективная гимнастика была реализована как правила PHPSTAN в пакете symplify/phpstan-rules . Вместо этого используйте?

 includes:
    - vendor/symplify/phpstan-rules/packages/object-calisthenics/config/object-calisthenics-rules.neon
    - vendor/symplify/phpstan-rules/packages/object-calisthenics/config/object-calisthenics-services.neon

Услова объекта-это набор правил в объектно-ориентированном коде, который фокусируется на обслуживаемости, читабельности, тестируемости и понимании . Сначала мы прагматичны - их легко использовать все вместе или один за другим.

Почему вы должны использовать это в своем проекте?

Читайте сообщение Уильяма Дюранда или Презентации по проверке Гилхерма Бланко .

Установить

composer require object-calisthenics/phpcs-calisthenics-rules --dev

Использование

Если вы знаете, что хотите, прыгайте прямо к конкретному правилу:

1. только x Уровень углубления на метод
2. Не используйте ключевое слово «иначе»
5. Используйте только один оператор объекта (->) на оператор
6. Не сокращать
7. Держите свои занятия небольшими
9. Не используйте Getters и Setters

Как быстро проверить 1 правило?

В php_codesniffer

vendor/bin/phpcs src tests -sp 
--standard=vendor/object-calisthenics/phpcs-calisthenics-rules/src/ObjectCalisthenics/ruleset.xml 
--sniffs=ObjectCalisthenics.Classes.ForbiddenPublicProperty

В EasyCodingstandard

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsClassesForbiddenPublicPropertySniff : ~

затем

vendor/bin/ecs check src

Реализовано нюхание правил

1. только `X` Уровень углубления на метод

 foreach ( $ sniffGroups as $ sniffGroup ) {
    foreach ( $ sniffGroup as $ sniffKey => $ sniffClass ) {
        if (! $ sniffClass instanceof Sniff) {
            throw new InvalidClassTypeException ;
        }
    }
}

 foreach ( $ sniffGroups as $ sniffGroup ) {
    $ this -> ensureIsAllInstanceOf ( $ sniffGroup , Sniff::class);
}

// ...
private function ensureIsAllInstanceOf ( array $ objects , string $ type )
{
    // ...
}

Использовать только это правило?

В php_codesniffer:

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.Metrics.MaxNestingLevel

В ECS:

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsMetricsMaxNestingLevelSniff : ~

? Настраивается

В php_codesniffer:

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.Metrics.MaxNestingLevel " >
        < properties >
            < property name = " maxNestingLevel " value = " 2 " />
        </ properties >
    </ rule >
</ ruleset >

В ECS:

 services :
    ObjectCalisthenicsSniffsMetricsMaxNestingLevelSniff :
        maxNestingLevel : 2

2. Не используйте ключевое слово «иначе»

 if ( $ status === self :: DONE ) {
    $ this -> finish ();
} else {
    $ this -> advance ();
}

 if ( $ status === self :: DONE ) {
    $ this -> finish ();
    return ;
}

$ this -> advance ();

Использовать только это правило?

В php_codesniffer:

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.ControlStructures.NoElse

В ECS:

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsControlStructuresNoElseSniff : ~

5. Используйте только один оператор объекта ( `->` ) на оператор

 $ this -> container -> getBuilder ()-> addDefinition (SniffRunner::class);

 $ containerBuilder = $ this -> getContainerBuilder ();
$ containerBuilder -> addDefinition (SniffRunner::class);

Использовать только это правило?

В php_codesniffer:

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.CodeAnalysis.OneObjectOperatorPerLine

В ECS:

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsCodeAnalysisOneObjectOperatorPerLineSniff : ~

? Настраивается

В php_codesniffer:

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.CodeAnalysis.OneObjectOperatorPerLine " >
        < properties >
            < property name = " variablesHoldingAFluentInterface " type = " array " value = " $queryBuilder,$containerBuilder " />
            < property name = " methodsStartingAFluentInterface " type = " array " value = " createQueryBuilder " />
            < property name = " methodsEndingAFluentInterface " type = " array " value = " execute,getQuery " />
        </ properties >
    </ rule >
</ ruleset >

В ECS:

 services :
    ObjectCalisthenicsSniffsCodeAnalysisOneObjectOperatorPerLineSniff :
        variablesHoldingAFluentInterface : ["$queryBuilder", "$containerBuilder"]
        methodsStartingAFluentInterface : ["createQueryBuilder"]
        methodsEndingAFluentInterface : ["execute", "getQuery"]

6. Не сокращать

Это связано с классом, чертой, интерфейсом, постоянной, функцией и именами переменных.

 class EM
{
    // ...
}

 class EntityMailer
{
    // ...
}

Использовать только это правило?

В php_codesniffer:

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.NamingConventions.ElementNameMinimalLength

В ECS:

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsNamingConventionsElementNameMinimalLengthSniff : ~

? Настраивается

В php_codesniffer:

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.NamingConventions.ElementNameMinimalLength " >
        < properties >
            < property name = " minLength " value = " 3 " />
            < property name = " allowedShortNames " type = " array " value = " i,id,to,up " />
        </ properties >
    </ rule >
</ ruleset >

В ECS:

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsNamingConventionsElementNameMinimalLengthSniff :
        minLength : 3
        allowedShortNames : ["i", "id", "to", "up"]

7. Держите свои занятия небольшими

 class SimpleStartupController
{
    // 300 lines of code
}

 class SimpleStartupController
{
    // 50 lines of code
}

 class SomeClass
{
    public function simpleLogic ()
    {
        // 30 lines of code
    }
}

 class SomeClass
{
    public function simpleLogic ()
    {
        // 10 lines of code
    }
}

 class SomeClass
{
    // 20 properties
}

 class SomeClass
{
    // 5 properties
}

 class SomeClass
{
    // 20 methods
}

 class SomeClass
{
    // 5 methods
}

Использовать только это правило?

В php_codesniffer:

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.Files.ClassTraitAndInterfaceLength,ObjectCalisthenics.Files.FunctionLength,ObjectCalisthenics.Metrics.MethodPerClassLimit,ObjectCalisthenics.Metrics.PropertyPerClassLimit

В ECS:

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsFilesClassTraitAndInterfaceLengthSniff : ~
    ObjectCalisthenicsSniffsFilesFunctionLengthSniff : ~
    ObjectCalisthenicsSniffsMetricsMethodPerClassLimitSniff : ~
    ObjectCalisthenicsSniffsMetricsPropertyPerClassLimitSniff : ~

? Настраивается

В php_codesniffer:

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.Files.ClassTraitAndInterfaceLength " >
        < properties >
            < property name = " maxLength " value = " 200 " />
        </ properties >
    </ rule >
    < rule ref = " ObjectCalisthenics.Files.FunctionLength " >
        < properties >
            < property name = " maxLength " value = " 20 " />
        </ properties >
    </ rule >
    < rule ref = " ObjectCalisthenics.Metrics.PropertyPerClassLimit " >
        < properties >
            < property name = " maxCount " value = " 10 " />
        </ properties >
    </ rule >
    < rule ref = " ObjectCalisthenics.Metrics.MethodPerClassLimit " >
        < properties >
            < property name = " maxCount " value = " 10 " />
        </ properties >
    </ rule >
</ ruleset >

В ECS:

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsFilesClassTraitAndInterfaceLengthSniff :
        maxLength : 200
    ObjectCalisthenicsSniffsFilesFunctionLengthSniff :
        maxLength : 20
    ObjectCalisthenicsSniffsMetricsPropertyPerClassLimitSniff :
        maxCount : 10
    ObjectCalisthenicsSniffsMetricsMethodPerClassLimitSniff :
        maxCount : 10

9. Не используйте Getters и Setters

Эти правила частично связаны с дизайном домена.

Занятия не должны содержать общественные свойства.
Метод должен представлять поведение, а не устанавливать значения.

 class ImmutableBankAccount
{
    public $ currency = ' USD ' ;

    private $ amount ;

    public function setAmount ( int $ amount )
    {
        $ this -> amount = $ amount ;
    }
}

 class ImmutableBankAccount
{
    private $ currency = ' USD ' ;

    private $ amount ;

    public function withdrawAmount ( int $ withdrawnAmount )
    {
        $ this -> amount -= $ withdrawnAmount ;
    }
}

Использовать только это правило?

В php_codesniffer:

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.Classes.ForbiddenPublicProperty,ObjectCalisthenics.NamingConventions.NoSetter

В ECS:

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsClassesForbiddenPublicPropertySniff : ~
    ObjectCalisthenicsSniffsNamingConventionsNoSetterSniff : ~

? Настраивается

В php_codesniffer:

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.NamingConventions.NoSetter " >
        < properties >
            < property name = " allowedClasses " type = " array " value = " *DataObject " />
        </ properties >
    </ rule >
</ ruleset >

В ECS:

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsNamingConventionsNoSetterSniff :
        allowedClasses : 
            - ' *DataObject '

Не внедренные правила - слишком строгие, расплывчатые или раздражающие

Используя на практике, мы обнаружили, что это правило слишком строгим, расплывчатым или даже раздражающим, а не помогая писать более чистый и более прагматический код. Они также тесно связаны с доменным дизайном.

3. Оберните примитивные типы и строки - Поскольку PHP 7 вы можете использовать define(strict_types=1) и скалярные подсказки. Для других случаев, например, по электронной почте, вы можете справиться с этим в своем домене через объекты Value.

4. Используйте коллекции первого класса - это правило имеет смысл, но слишком строго, чтобы быть полезным на практике. Даже наш код не прошел его вообще.

8. Не используйте классы с более чем двумя переменными экземпляра - это зависит от отдельной области каждого проекта. Не имеет смысла составлять правило для этого.

3 правила для участия

1 функция за пиар
Каждая новая функция должна быть покрыта тестами
Все тесты и проверки стиля должны пройти
```
composer complete-check
```

Мы будем рады объединить вашу функцию.

Расширять