UndocumentedPublicProperty and UndocumentedPublicFunction should include objects

[anthonycr]

Summary

Given an object with an undocumented public function or property, I would expect the UndocumentedPublicFunction rule or UndocumentedPublicProperty rule to fail the build. However, the behavior of the rules is inconsistent in regards to objects.

The following code is failed when the rules are enabled and an object is nested in a class, as expected:

class Test {
  object InnerObject {
    // Fails, expected
    fun noComment1() {}
    // Fails, expected
    val a = 1
  }
}

However, if the object is promoted to a top level object, then the rules will not fail the function or property.

object Test {
  // Passes, unexpected
  fun noComment1() {}
  // Passes, unexpected
  val a = 1
}

Changes

I discovered that the containingClass() function used in both rules to determine if the function or property is part of a public class returns null if the function or property is in an object. We can change this behavior to check if the object is public or not by replacing the usage of containingClass() with containingClassOrObject. In this way, we can treat an undocumented function or property in an object the same as one in a regular class.

I changed both UndocumentedPublicFunction and UndocumentedPublicProperty to utilize containingClassOrObject instead of containingClass(). I also added test cases for public and private object cases as well as a nested object test case. For the test cases I added to the UndocumentedPublicPropertySpec, I renamed two of the existing test cases with ambiguous names to avoid confusion with the test cases I added.

[cortinico]

Thanks for the fix 🙏 That's really appreciated.

[codecov]

Codecov Report

Merging #3940 (9018979) into main (5048b8b) will not change coverage.
The diff coverage is 0.00%.

❗ Current head 9018979 differs from pull request most recent head 89ad157. Consider uploading reports for the commit 89ad157 to get more accurate results

@@            Coverage Diff            @@
##               main    #3940   +/-   ##
=========================================
  Coverage     83.44%   83.44%           
  Complexity     3149     3149           
=========================================
  Files           456      456           
  Lines          9014     9014           
  Branches       1754     1754           
=========================================
  Hits           7522     7522           
  Misses          565      565           
  Partials        927      927           

Impacted Files	Coverage Δ
.../rules/documentation/UndocumentedPublicFunction.kt	85.71% <0.00%> (ø)
.../rules/documentation/UndocumentedPublicProperty.kt	88.46% <0.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5048b8b...89ad157. Read the comment docs.

[schalkms]

Does the rule also flag interfaces with this implementation?

[anthonycr]

@schalkms yes, interfaces were being flagged before with containingClass() and are being flagged with this updated implementation, as the interface is returned as the encapulating "class" by the containingClassOrObject property. I just added a test case for interfaces to both the property and function test specs as it doesn't look like that case was explicitly being tested for yet.