phpcs calisthenics rules

قواعد الكائنات في التمساح لـ php_codesniffer

تم إهمالها: php_codesniffer رائع للتعامل مع المساحات ومواقف char. ومع ذلك ، فإن هذه القواعد تدور حول الهندسة المعمارية والهيكل. في عام 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

يتم تعيين قواعد التمارين الرياضية الكائنات في الكود الموجهة للكائنات ، والتي تركز على قابلية الصيانة ، قابلية القراءة ، قابلية الاختبار والشمولية . نحن براغماتية أولاً - من السهل استخدامها معًا أو واحدة تلو الأخرى.

لماذا يجب أن تستخدم هذا في مشروعك؟

اقرأ Post by William Durand أو Check Presentation قدمه Guilherme Blanco .

ثَبَّتَ

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

الاستخدام

إذا كنت تعرف ما تريد ، فقفز مباشرة إلى القاعدة المحددة:

• 1. فقط X مستوى المسافة البادئة لكل طريقة
• 2. لا تستخدم كلمة "أخرى"
• 5. استخدم مشغل كائن واحد فقط (->) لكل عبارة
• 6. لا تختصر
• 7. حافظ على فصولك الصغيرة
• 9. لا تستخدم getters و setters

كيف تتحقق بسرعة من قاعدة واحدة؟

في 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

سنكون سعداء بدمج الميزة الخاصة بك بعد ذلك.