added TimeInterval to func monkeyAround()

[graemerycyk]

This doesn’t remove the infinite running of monkeyAround() but simply adds the ability to run swiftMonkey tests based on a specific amount of time.

Thanks to @mohamede1945 for raising the issue and @DwayneCoussement for answering my question about this improvement 🙌

[wojciechczerski]

Hello @grycyk and thank you very much for this PR! There is one small thing I would like you to change. When this is done we can do a release with this new feature 😄

[wojciechczerski]

Could you please make it an additional method so that we keep the parameterless monkeyAround() still available? I can see from the commit summary that:

This doesn’t remove the infinite running of monkeyAround() ...

But I'm afraid it does. When you try to compile the tests for the provided sample app the compilation will fail.

[graemerycyk]

True true, .infinitely can be used but that will mean they will have to update their test(s), sorry, I didn't consider that 🙈 okay, I will make a fix later today and will update the PR.

[wojciechczerski]

Ah I totally forgot about the .infinity value! With that the solution is even more simple:

public func monkeyAround(forDuration duration: TimeInterval = .infinity) {
    ...
}

Great idea @grycyk 👍

[graemerycyk]

@wojciechczerski it should be fixed now i think. 👍

p.s a typo in my commit message "separate method" 😅

[wojciechczerski]

Since we changed the signature we could also provide a more accurate Quick Help documentation, for example:

/// Generate random events or fixed-interval events based on a specific duration or infinitely.
///
/// - Parameter duration: The duration for which to generate the random events.

[wojciechczerski]

I made one more small request to the documentation but apart from that it should be good.

BTW: I am fine if you do a force push to your branch - this might be helpful that you don't have to populate the commits for every change request (like created it as a spearate method). But it's up to you of course ;)

[graemerycyk]

So will we keep it in one method?

Adding public func monkeyAround(forDuration duration: TimeInterval = .infinity) I will add the extra documentation comment too, will push it over in about an hour.

[wojciechczerski]

I would prefer to see it just as you designed it but with the default .infinity duration.

With such API someone who looks at the code will immediately understand that this method will monkey around for some time and by default it runs forever. And the best is that you get all this information just from the method signature without even looking at the documentation. On the other hand in order to understand what does the monkeyAround() do, you need to read the docs.

[graemerycyk]

super!! ill fix the PR asap 👍

[graemerycyk]

@wojciechczerski I think this should be the final change needed. 👍

[wojciechczerski]

The parameter name is duration so it should be:

/// - duration: Set to .infinity by default.

Improvement: You can surround .infinity with the `` code markers to make it look even better in the Quick Help:

/// - duration: Set to `.infinity` by default.

Suggestion

How about we put the Set to .infinity by default. in the main description of the duration parameter? It would look like this:

/// - Parameter duration: The duration for which to generate the random events.
///                       Set to `.infinity` by default.

What do you think @grycyk ?

[graemerycyk]

Done! 👍 @wojciechczerski I have never really used documentation from the comment like that with Quick Help before so thanks for the pointers! 🙌

[wojciechczerski]

Aaaand it's merged as well! Thank you very much for your contribution @grycyk ! I hope I wasn't too annoying with my picky comments 😃

I'll try to make a release today in the evening.

[graemerycyk]

@wojciechczerski Not at all, if anything is worth doing, its worth doing right! 💯
I will look at helping out again, I think this is a interesting project! 🙌