Feature Request - Change class name in v4?

[donatj]

First off thanks again for this library, I use it all the time.

I've got a little change… request? Not really a "feature"

PHPunit 10 introduced the DataProvider attribute and now the DataProvider abstact class from this collides when using the attribute in my tests.

I end up just aliasing \TRegx\PhpUnit\DataProviders\DataProvider to TRegxDataProvider

It'd be a breaking change, but I'd like to just put in a suggestion that we change from

\TRegx\PhpUnit\DataProviders\DataProvider to
\TRegx\PhpUnit\DataProviders\DataProviders

[danon]

Hi! Thanks for reaching out! I appreciate it!

The only problem I can see with this rename, is that DataProvider is also the name of the instance of the records, like so:

/**
 * @test 
 * @dataProvider colors
 */
public function test(string $color, string $thing): void {
  // your test here
}

public function colors(): DataProvider {
  return DataProvider::join($this->blueColors(), $this->yellowColors(), $this->redColors());
}

@donatj Do you have an idea how to fix it/rename it?

Obviously the library should adapt to the changing phpunit interface, I'm just thinkinig how to acompolish that 🤔 .

[donatj]

Hah, hmm… I was like "Why do I never remember this being an issue?"

Looking at my tests, for reasons I don't understand I'm basically always doing yield from ala

public function colors(): \Generator {
  yield from DataProvider::join($this->blueColors(), $this->yellowColors(), $this->redColors());
}

That's probably completely unnecessary on my part… 

Um… I see the awkwardness of a plural would be defining a singular… I don't have any great ideas 😆

ComplexDataProvider or MultiDataProvider… CompositeDataProvider? I see your conundrum.

[danon]

@donatj I think I'll name it RecordSet. The idea that the colors() returns a data provider is wrong - it is a data provider, it returns the data.

public function colors(): DataProvider {
  yield from DataProvider::join($this->blueColors(), $this->yellowColors(), $this->redColors());
}

Names that look good to me:

• public function colors(): Data
• public function colors(): ProvidedData
• public function colors(): RecordSet
• public function colors(): Matrix

[donatj]

MatrixProvider sounds good to my ear