Do not cover private methods

[kofronpi]

In the coverage report SimpleCov show my private methods as not covered. It would be nice to be able to configure SimpleCov to uncover all private methods.

[colszowka]

You could use the :nocov: token to wrap the code to skip, as shown here, in that example also showing how to configure a different keyword for the nocov wrapper.

As general advice, although it is very reasonable to avoid directly testing private methods of your classes, normally these methods will be used by the actual public API of your objects to perform some kind of task, and hence if you appropriately test the public interface of your classes and objects you should automatically also get full coverage of your private methods. In my experience, private methods rarely end up being not covered by tests, even if you stick to no direct testing of private methods.

[dideler]

Very useful information. I think using # :nocov: to skip code should be mentioned in the README. A search for "nocov" or "skip" returns no results in the README.

if you appropriately test the public interface of your classes and objects you should automatically also get full coverage of your private method

This would also be useful in the README. I was going to skip a private method until I read this and realized I wasn't testing appropriately. At least have a section on private methods in the README, since a search for "private" also returns no results in the README.

Thanks for making simplecov!

[bf4]

@dideler Would you consider making a pull request?

[dideler]

Sure, as long as @colszowka or any other committer agrees with the suggestions.

I'm not sure where in the README these changes would go. They don't seem to fit nicely in any of the existing sections. Maybe a FAQ section?

[bf4]

I think it should be in the filters section perhaps even with a link to the feature