RoadMap

[roxblnfk]

• Interceptors core
  • Attributes Implement runner #1
• Tests Locators
  • Files finder Implement runner #1
  • Tokenizer Implement runner #1
  • Reflection loader
    • Classes Implement runner #1
    • Functions Expose tests-functions #13
  • Test Cases locator Implement runner #1
  • Cache
  • Watcher
• Application
  • Config file Add Config Inflector #23 Support custom configs #28
  • CLI params
  • Plugins system
• Tests Runner
  • Features
    • Filtering Implement filter functionality #42
    • Data Providers Expose DataProvider attribute #32
    • InlineTest
    • DataSet Add DataSet attribute #70
    • STDOUT Capture StdoutInterceptor #72
    • Errors trap (error handler) Error handler interceptor #73
    • Random order Add RandomOrder interceptor #71
    • Run in a separated process
    • Run in parallel (a few workers)
• Assertions
  • Static State Add Assert::same and assertion collector #3
    • Fibers support Add Assert::same and assertion collector #3
    • Assertion collector Add Assert::same and assertion collector #3
  • Assertions
• Mocks
  • Integrate Mockery
• Code Coverage
• Terminal Rendering Add Terminal Renderer #10
  • Mode --show-assertions Add assertions history into Terminal Renderer #12
  • Dotted mode Add Terminal Renderer #10
  • Compact mode Add Terminal Renderer #10
• Additional features
  • Retry Policy with Flacky Implement runner #1
  • Context injection (like logger)
  • App Container
  • Any Callable Interceptor (f.e. to preconfigure Container)
  • Wrap by Fiber coroutine
  • Benches
• IDE plugin
  • TeamCity support (see TeamCity formatter infection/infection#2446) TeamCity support #6
    • Data providers Expose DataProvider attribute #32
  • Context exposition
  • New statuses
• Infrastructure
  • Move repo into organization
  • CI
    • Autoreleases Add Github Workflows #20
    • CS fixer Add Github Workflows #20
    • Security Check Add Github Workflows #20
    • Psalm
    • Unit tests
    • Mutation
  • Configure monorepo, separate plugins
  • Write a lot of test
    • Prepare helpers to test assertions
• Documentation
  • readme and logo

[petrdobr]

Hello, I want to add new assert methods to this library.
Here what I suggest to add:

• assertNotSame($expected, $actual) to assert non-identical data, as opposite to assertSame
• assertTrue($value) / assertFalse($value) to assert boolean data (nice readability)
• assertInstanceOf($class, $object) to assert object type / inheritance
• assertContains($needle, $haystack) / assertNotContains(...) for arrays

What do you think this library needs first, maybe some different assert function?

[roxblnfk]

Let's start from these ones. But note: we don't need the prefix assert there. Just Assert::notSame()

[roxblnfk]

From PHP Beer:
https://github.com/JBZoo/PHPUnit

[petrdobr]

Here are new simple asserts I suggest to add next. Tell me your thoughts on them please.

Equality & Comparison

• equals(mixed $expected, mixed $actual) - assert values are equal, not strict comparison ==.
• notEquals(mixed $expected, mixed $actual) - assert values are not equal, not strict comparison ==.
• greaterThan($min, $actual) / greaterThanOrEqual($min, $actual)
  Numeric comparisons for metrics, lengths, counters.
• lessThan($max, $actual) / lessThanOrEqual($max, $actual)
  Symmetric bound checks.

Arrays & Iterables

• count(int $expected, array|\Countable $value)
  Assert collection size (materialize if needed).
• arrayHasKey(string|int $key, array|ArrayAccess $array) / arrayNotHasKey(...)
  Structure/shape checks for maps.

Strings

• stringContains(string $needle, string $haystack) / stringNotContains(...)
  Substring presence (case-sensitive by default).
• stringStartsWith(string $prefix, string $haystack) / stringEndsWith(string $suffix, string $haystack)
  Quick prefix/suffix checks.

Types & State

• array(mixed $value) / string(...) / int(...) / float(...) / bool(...)
  Primitive type guards (useful in data providers).

• empty(mixed $value) / notEmpty(mixed $value)
  Common quick checks for collections/string - under a question.

JSON

• json(string $value)
  Valid JSON (decodes without error).
• jsonEquals(string|array|object $expected, string|array|object $actual, bool $canonicalize = true)
  Compare after decode + normalized ordering (keys).

Filesystem

• fileExists(string $path) / fileNotExists(string $path)
  Presence of artifacts.

For later

• outputContains(string $expected, callable $fn) / outputNotContains(...)
  Run $fn, capture STDOUT, assert substring.

This list is based on PHPUnit asserts, but I tried to pick only the most basic methods from there.

[roxblnfk]

• Assert::count(int $expected, array|\Countable $value) -- i'm not sure about iterable because it can affect its state (f.e. generators).
• Let's add equals().
• About empty - should it work like PHP's empty()? Or it's bad idea to return true for "0" value?

We will think about STDOUT later.

You can also draw inspiration from the repository webmozarts/assert.

[petrdobr]

I've updated the list according to your notes. I also renamed isString, isArray etc. asserts to string, array for consistency.
About empty. I looked it up in PHPUnit, webmozarts/asserts, it follows PHP's empty behavior. Personally, I think this is a bad idea to have this assertion. Due to its name developers by default will expect it to follow PHP's empty, but the "0" case you pointed out breaks expectations for empty strings and can cause confusion.
I suggest we avoid creating Assert::empty() and instead make Assert::emptyArray(array $value), and Assert::emptyString(string $value) separately.

[roxblnfk]

What about blank()?
[] => true
null => true
'' => true

false, 0, "0" are not blank.
There is question about objects. Should we check (array) $object === [] or we must be strict and all the objects are not blank? What about Countable?

/**
 * Checks if a value is blank.
 * 
 * Returns true only for values representing absence of data:
 * null, empty string, or empty array.
 * 
 * Unlike empty(), does not consider false, 0, and "0" as blank,
 * since they represent valid data.
 * 
 * @param mixed $value The value to check
 * @return bool true if value is null, "" or [], false otherwise
 */
function isBlank(mixed $value): bool
{
    // ...
}

[roxblnfk]

BTW there is Laravel's blank() function implementation

[roxblnfk]

Separated issue for assertions: #24