Proposal: split assertContains for iterables and non-iterables

[keradus]

currently, one can do both with a single assertion:

$this->assertContains('b', ['a', 'b', 'c']);
$this->assertContains('b', 'abc');

which is confusing if someone use it like the following, and for that error prone due to accidental lack of types control

$this->assertContains('b', $haystack);

what about splitting the responsibility of that assertion, to have one for strings and one for iterables ?

ref PHP-CS-Fixer/PHP-CS-Fixer#4061

[sebastianbergmann]

I interpret this as

• Add assertIterableContains() and assertStringContains() in PHPUnit 7.5
• Deprecate (soft) assertContains() in PHPUnit 7.5
• Deprecate (hard) assertContains() in PHPUnit 8.0

Correct?

[sebastianbergmann]

Going further, we probably want to get rid of the optional parameters and introduce

• assertStringContainsString() (uses new StringContains($needle, false))
• assertStringContainsStringIgnoringCase() (uses new StringContains($needle, true))
• assertIterableContains() (uses new TraversableContains($needle, false, false))
• assertIterableContainsSame() (uses new TraversableContains($needle, true, true))

etc.

[sebastianbergmann]

@keradus Can you please have a look at master...686d153? Thanks!

[keradus]

Hi ! First of all, glad you like the idea !

Deprecate (soft) assertContains() in PHPUnit 7.5
Deprecate (hard) assertContains() in PHPUnit 8.0

can you elaborate how you define difference of hard and soft deprecation? if hard is removal of functionality, then that's how I would see this to happen indeed ;)

assertIterableContains() (uses new TraversableContains($needle, false, false))
assertIterableContainsSame() (uses new TraversableContains($needle, true, true))

I would rather promote strict comparison by default. Language itself is promoting to be strict about types now, let's not promote (by more convenient (/shorter) name) being not strict.
that saying, I would suggest following naming instead:
assertIterableContains to check strict
assertIterableContainsEqual to check non-strict

Can you please have a look at master...686d153? Thanks!

can you raise it as a PR? with link provided, I can't do the comments :(

[sebastianbergmann]

1. Soft Deprecation in PHPUnit 7.5
2. Hard Deprecation in PHPUnit 8
3. Removal in PHPUnit 9

[sebastianbergmann]

Sorry, but I do not send myself pull requests.

[sebastianbergmann]

I agree with promoting strict comparison, but the naming as-is makes more sense to me somehow.