PHP Object Calisthenics Made Simple - Version 3.0 is Out Now

2017-06-26

If you are a coding standard nerd like me, you'll probably have more than just PSR-2 standard in your ruleset. But even if you don't, Object Calisthenics is a developer-friendly game changer for your code.

Much Simpler than 2.0

1. You don't have to know a single thing about coding standards to start

2. Simple to install

composer require object-calisthenics/phpcs-calisthenics-rules

3. You can start with 1 sniff

Quick quiz: what is this variable?

$this->di->...;

Dependency Injection? Dependency Injection Container? Who would guess it's Donation Invoice!

Rule #6 - Do Not Abbreviate checks these cases. It detects short names that are ambiguous and hard to decode.

For a quick check, just run the full config:

vendor/bin/ecs check src --config vendor/object-calisthenics/phpcs-calisthenics-rules/config/object-calisthenics.yml

You can run this locally or put to your CI and you are ready to go.

Fancy Readme With Examples

We put lots of work to README for the new release. It isn't a long text describing what exactly the rule does and how it originated - there is already a blog post for that.

Instead, README goes right to the point:

• YES and NO code snippets,
• how to use them - copy/paste CLI command
• and how to configure them - link to particular config lines

Configure What You Need

As you can see in the bottom part of screenshot, most of rules are configurable. It allows you to adapt their strictness to your specific needs and needs of your project.

Do you prefer to require min 4 chars?

use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return function (ContainerConfigurator $containerConfigurator): void {
    $services = $containerConfigurator->services();
    $services->set('ObjectCalisthenics\Sniffs\NamingConventions\ElementNameMinimalLengthSniff')
        ->property('minLength', 4);
};

Do you want to add own allowed short names?

use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return function (ContainerConfigurator $containerConfigurator): void {
    $services = $containerConfigurator->services();

    // Rule 6: Do not abbreviate
    $services->set(ObjectCalisthenics\Sniffs\NamingConventions\ElementNameMinimalLengthSniff::class)
        ->property('minLength', 4)
        // default: ["i", "id", "to", "up"]
        ->property('allowedShortNames', ['y', 'i', 'id', 'to', 'up']);
};

Minitip: What Can You Configure in Particular Sniff?

• Open ElementNameMinimalLengthSniff class in your IDE.
• Look for public properties. CodeSniffer uses them to set any configuration.

That was Rule 6.

5 more Rules

1. Only X Level of Indentation per Method

❌

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

✅

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

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

2. Do Not Use "else" Keyword

❌

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

✅

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

$this->advance();

5. Use Only One Object Operator (->) per Line

❌

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

✅

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

7. Keep Your Classes Small

❌

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
}

9. Do not Use Getters and Setters

Classes should not contain public properties.

❌

class ImmutableBankAccount
{
    public $currency = 'USD';

✅

class ImmutableBankAccount
{
    private $currency = 'USD';

Method should represent behavior, not set values.

❌

    private $amount;

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

✅

    private $amount;

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

Check the README to see how to use them and configure them.

9 – 6 = 3... Where is the Rest of Rules?

There are 3 more rules to complete the list from the original manifesto:

3. Wrap Primitive Types and Strings
4. Use First Class Collections
5. Do Not Use Classes With More Than Two Instance Variables

They are mostly related to DDD (Domain Driven Design), too strict to use in practise or too vague to cover them with semantic rule.

Thanks to all Contributors

Last but not least, I'd like to personally thank contributors who helped to make this version happen as it is:

• @frenck
• @mihaeu
• @roukmoute
• @UFOMelkor

Without your help, this would not have been possible. Thank you guys.

To Sum up Object Calisthenics 3.0

• Simple setup over boring academic explanations.
• Rules are explained in examples.
• 0-setup. You can just copy-paste CLI commands and run it.
• You can choose a level of strictness that suits you thanks to flexible configuration.

To find more details about this release see Release notes on Github.