phpcs calisthenics rules

php_codesniffer에 대한 객체 calisthenics 규칙

더 이상 사용되지 않은 : PHP_CodesNiffer는 공간과 숯 위치를 처리하는 데 적합합니다. 그러나 이러한 규칙은 코드 아키텍처 및 구조에 관한 것입니다. 2020 년에는 Phpstan에 완벽하게 어울리는 도구가 있습니다 .

그 말을하면, 대상 칼리스 닉은 symplify/phpstan-rules 패키지에서 Phpstan 규칙으로 구현되었습니다. 대신 사용 하시겠습니까?

 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

객체 CALISTHENICS는 유지 관리, 가독성, 테스트 가능성 및 이해력에 중점을 둔 객체 지향 코드의 규칙 세트 입니다. 우리는 먼저 실용적 입니다 - 그들은 모두 하나 또는 하나씩 사용하기 쉽습니다.

프로젝트에서 이것을 사용해야하는 이유는 무엇입니까?

William Durand 의 게시물을 읽거나 Guilherme Blanco 의 프레젠테이션을 확인하십시오.

설치하다

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

용법

원하는 것을 알고 있다면 특정 규칙으로 바로 이동하십시오.

• 1. 방법 당 X 수준의 압입 수준
• 2. "다른"키워드를 사용하지 마십시오
• 5. 문당 하나의 오브젝트 연산자 (->) 만 사용하십시오
• 6. 약식하지 마십시오
• 7. 수업을 작게 유지하십시오
• 9. 게터와 세터를 사용하지 마십시오

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. 게터와 세터를 사용하지 마십시오

이 규칙은 부분적으로 도메인 구동 설계와 관련이 있습니다.

• 클래스에는 공개 속성이 포함되어서는 안됩니다.
• 메소드는 값을 설정하지 않고 동작을 나타내야합니다.

 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. Primitive 유형과 문자열 랩 - PHP 7이므로 define(strict_types=1) 및 스칼라 유형 힌트를 사용할 수 있습니다. 다른 경우와 같은 이메일의 경우 값 객체를 통해 도메인에서이를 처리 할 수 ​​있습니다.

4. 일등석 컬렉션 사용 -이 규칙은 의미가 있지만 실제로는 너무 엄격하지만 실제로는 유용합니다. 우리 코드조차도 전혀 전달하지 못했습니다.

8. 인스턴스 변수가 두 개 이상인 클래스를 사용하지 마십시오 . 이는 각 프로젝트의 개별 도메인에 따라 다릅니다. 이를 규칙하는 것은 의미가 없습니다.

---

기여를위한 3 가지 규칙

• PR 당 1 특징

• 모든 새로운 기능은 테스트로 다루어야합니다

• 모든 테스트 및 스타일 검사는 통과해야합니다

  composer complete-check

그러면 귀하의 기능을 병합하게되어 기쁩니다.