Code style - chain calls

[arogachev]

Similar to #yiisoft/html#132.

form/tests/Helper/HtmlFormErrorsTest.php

Lines 34 to 36 in d1b8854

	$this->assertFalse($validator
	->validate($formModel)
	->isValid());

Possible fix:

$isValid = $validator
    ->validate($formModel)
    ->isValid();
$this->assertFalse($isValid);

[vjik]

Or so:

$this->assertFalse(
    $validator 
        ->validate($formModel) 
        ->isValid()
); 

[arogachev]

@sankaest Do you want to do it and have time for this?

[sankaest]

no problem, I'll do (will check all packages again) it by the end of this week :)

[arogachev]

Great. 👍 But @rustamwin and @darkdef have different opinion. 🤔 Maybe wait for them to share it to avoid extra work.

[sankaest]

Any clues for me regarding style? What exactly should be changed and examples (from->to). @arogachev @rustamwin @darkdef

[darkdef]

I think that reading one line of 80 characters is easier than winding two screens.
Nobody writes like this:

function tttt(
string $str
) {

[sankaest]

@darkdef could you please copy here "bad" code style (real example, or give row number in the class) and how it should be restyled. It is always better to show how it should be, otherwise guessing a numbers with lottery will be easier, than writing a code what is good enough. :)

And is your example regarding chaining?

Also, @samdark should it be advised in some docs and/or accepted by the community?

I am confused right now, what is "correct" style.

[darkdef]

Fo example:

example1

$this->getQuoter()->quoteTableName($table)

Vs example2

$this
   ->getQuoter()
   ->quoteTableName($table)

For me - example1 better.
And readable for human.
Example2 by codestyle, but better for pc (it's my opinion)

[samdark]

Yes, it should be documented. Main rules are:

1. If it is a long chain that doesn't fit line length (120 characters) then each call should on a new line.
2. It is is a short chain, it is alright to leave it as is.

[sankaest]

that 120 characters is something new for me (is it final decision?) . In which yiisoft/docs/blob/master/*.md file is (or should this be) mentioned? At least I could not discover it. Need to create new one?

It seems to me, that there is quite a lot of different situations, so examples in *.md should help and clarify.

[samdark]

https://github.com/yiisoft/docs/blob/master/010-code-style.md is a good place to mention it. It wasn't written anywhere else yet.

[samdark]

Done: https://github.com/yiisoft/docs/blob/master/010-code-style.md#chain-calls

[sankaest]

@samdark what about such kind of chain? just and example (total length > 120 char).

$this->chain->withChain()->veryLongChain(['key1' => self::CONST_1, 'key2' => self::VALUE_2, 'key3' => self::CONST_VALUE_3]);

I mean we count length from $this-> till ; with everything inside brackets of chains?
Without inside brackets it would be less, than 120 chars.

$this
    ->chain
    ->withChain()
    ->veryLongChain(['key1' => self::CONST_1, 'key2' => self::VALUE_2, 'key3' => self::CONST_VALUE_3]);

Just to be sure.

[vjik]

String length included all symbols (including prefix spaces).

[vjik]

Already fixed.