Warn user when includesText assertion should expect collapsable whitespace

[happycollision]

I added three tests. The first two may not be desirable specifications, since passing them might cause a major version bump again. (They test that text containing expected line breaks, etc, would pass.)

The third test is an example of a possible scenario to mitigate confusion described in #197. That would be my suggestion if passing the first two is too much of a burden. Or something like that.

[Turbo87]

I'm not sure what the issue is here. hasText() and includesText() should behave similarly in general and also with regard to whitespace collapsing. I agree though, that it might make sense to print a warning somewhere if the input string contains whitespace that would be collapsed 🤔

If your issue is that you would like to do a has/includesText() assertion without the automatic collapsing then maybe it would make sense to introduce a collapseWhitespace: false option on those assertions.

[happycollision]

Yes. That is another option that I had considering and of course forgot to mention. This PR does add a message for the user, but I am not sure if this is the best way. Or should it throw and error with a message in there, because bad input was supplied as the expected test? I’ll remove the two tests I figured that were not going to be the path forward.

…

On Nov 16, 2018, at 2:12 AM, Tobias Bieniek ***@***.***> wrote: I'm not sure what the issue is here. hasText() and includesText() should behave similarly in general and also with regard to whitespace collapsing. I agree though, that it might make sense to print a warning somewhere if the input string contains whitespace that would be collapsed 🤔 If your issue is that you would like to do a has/includesText() assertion without the automatic collapsing then maybe it would make sense to introduce a collapseWhitespace: false option on those assertions. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

[Turbo87]

Or should it throw and error with a message in there, because bad input was supplied as the expected test?

I think we should probably just use console.warn() 🤔

[happycollision]

Great. I think the assertions you have will work just fine. Just that helpful messaging will be sufficient.

I'll do some further tests with changes in an Ember environment, then adjust this PR.

[happycollision]

After checking on this inside Ember's testing env, I still think it is possibly more useful to append the warning to the message that is pushed into the results of the assertion. I know that I do not open the inspector when I am testing unless I am looking for something that I am already expecting to see there. Things like console.logs that I have in my code.

To illustrate, here are two screenshots. The first shows adding a warning in the console only.

You can see the message is there, but the context for it is difficult to discern. And if you have multiple test failures, you may not know which one it is referring to.

This screenshot shows when we append the warning to the message.

Here, we don't need to open the console to see our message associated with the proper test.

This is achieved through adding this code to the assertion just before pushing the message:

    if (!result && text !== collapseWhitespace(text)) {
      message = message + '\n\nYour expected text contains spacing that is not preserved in this assertion. Try the `.hasText()` assertion passing in your expected text as a RegEx pattern.';
    }

So this code won't even run if the result is true.

I am happy to simply change this to console.warn as you suggested, though, if you still prefer that. Let me know if the messaging is what you prefer.

[happycollision]

I have also updated the API docs to contain a warning to the same effect. Just lets users know that whitespace is collapsed in this assertion.

[Turbo87]

I have also updated the API docs to contain a warning to the same effect

I guess the same warning should be added to the hasText() assertion then

I am happy to simply change this to console.warn as you suggested, though, if you still prefer that.

yeah, I think that would be better

[happycollision]

Should be all set, @Turbo87.

FYI, the warning message reads as follows:

The .includesText(), .containsText(), and .hasTextContaining() assertions collapse whitespace. The text you are checking for contains whitespace that may have made your test fail incorrectly. Try the .hasText() assertion passing in your expected text as a RegExp pattern. Your text:

(Then it reproduces the user's text on the next line.)

[Turbo87]

thanks :)