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

การเพาะกายวัตถุเป็น ชุดของกฎในรหัสเชิงวัตถุที่มุ่งเน้นการบำรุงรักษาความสามารถในการอ่านความสามารถในการทดสอบและความเข้าใจ เรา ใช้งานได้ก่อน - พวกเขาใช้งานได้ง่ายเข้าด้วยกันหรือทีละคน

ทำไมคุณควรใช้สิ่งนี้ในโครงการของคุณ?

อ่านโพสต์โดย William Durand หรือตรวจสอบการนำเสนอโดย Guilherme Blanco

ติดตั้ง

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) และคำแนะนำประเภทสเกลาร์ สำหรับกรณีอื่น ๆ เช่นอีเมลคุณสามารถจัดการกับสิ่งนั้นในโดเมนของคุณผ่านวัตถุค่า

4. ใช้คอลเลกชันชั้นหนึ่ง - กฎนี้สมเหตุสมผล แต่เข้มงวดเกินไปที่จะเป็นประโยชน์ในการปฏิบัติ แม้แต่รหัสของเราก็ไม่ผ่านเลย

8. อย่าใช้คลาสที่มีตัวแปรอินสแตนซ์มากกว่าสองตัว ขึ้นอยู่กับแต่ละโดเมนของแต่ละโครงการ มันไม่สมเหตุสมผลที่จะทำกฎสำหรับสิ่งนั้น

---

3 กฎสำหรับการมีส่วนร่วม

• 1 คุณสมบัติต่อการประชาสัมพันธ์

• ทุกคุณสมบัติใหม่ จะต้องครอบคลุมโดยการทดสอบ

• การทดสอบและ การตรวจสอบสไตล์ ทั้งหมด จะต้องผ่าน

  composer complete-check

เรายินดีที่จะรวมคุณสมบัติของคุณแล้ว