Fix real text too short

[krsriq]

What is the reason for this PR?

This PR is related to #37, a more detailed description of the issues observed can be found there.

realText may produce text that is too short, e.g. by running:

$faker = \Faker\Factory::create();
$faker->seed(252);
$text = $faker->realText(2000, 2);

which returns THE. (even though 2000 characters were requested).

• A new feature (resolve Feature request: minimum character count for realText #37)
• Fixed an issue

Author's checklist

• Follow the Contribution Guide
• New features and changes are documented

Summary of changes

This PR fixes the issue mentioned above while adding a new Text::realTextBetween($minNbChars = 160, $maxNbChars = 200, $indexSize = 2) method (as was suggested in #37).

It adds a simple loop to make sure that the returned text from realText is at least 80% the length set with $maxNbChars. The same logic is used to provide the realTextBetween method.
Also made sure we have a maximum number of retries and added tests.

Review checklist

• All checks have passed
• Changes are approved by maintainer

[pimjansen]

Shouldnt we set a minimum here as well? And check for valid values since an -10 can also be passed

[krsriq]

I've now added a check that $minNbChars is not smaller than 1.

It doesn't make much sense to set $minNbChars to something much smaller than $maxNbChars, but it also doesn't prevent the algorithm from working as expected (producing real text that is between min and max chars long), so I wouldn't prohibit doing it.

[krsriq]

Thank you!

[bram-pkg]

@krsriq can you please document this?

[krsriq]

@krsriq can you please document this?

@bramceulemans yes, definitely - it's on my todo list :)

[bram-pkg]

@bramceulemans yes, definitely - it's on my todo list :)

Thanks :)