Add filter for Kotlin enum classes by Godin · Pull Request #1625 · jacoco/jacoco

Godin · 2024-05-25T22:11:44Z

leveretka

Overall looks good, thanks for fixing it!

I just have a small suggestion to improve readability.

leveretka · 2024-06-10T08:53:01Z

+
+	public void filter(final MethodNode methodNode,
+			final IFilterContext context, final IFilterOutput output) {
+		if (!"java/lang/Enum".equals(context.getSuperClassName())) {


I don't know if this is the convention here, but as a code reader, I'd prefer to see a single if without negations in the conditions to reduce a cognitive load. Since the body of the if is just one line, this is an acceptable level of nesting.

We don't have a strict convention about this and both styles can be found, but seems that the early-returns style is prevalent:

single if in

jacoco/org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/EnumEmptyConstructorFilter.java

Lines 39 to 48 in 5aabb2e

public void filter(final MethodNode methodNode,

final IFilterContext context, final IFilterOutput output) {

if (ENUM_TYPE.equals(context.getSuperClassName())

&& CONSTRUCTOR_NAME.equals(methodNode.name)

&& CONSTRUCTOR_DESC.equals(methodNode.desc)

&& new Matcher().match(methodNode)) {

output.ignore(methodNode.instructions.getFirst(),

methodNode.instructions.getLast());

}

}

jacoco/org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/PrivateEmptyNoArgConstructorFilter.java

Lines 26 to 35 in 5aabb2e

public void filter(final MethodNode methodNode,

final IFilterContext context, final IFilterOutput output) {

if ((methodNode.access & Opcodes.ACC_PRIVATE) != 0

&& CONSTRUCTOR_NAME.equals(methodNode.name)

&& CONSTRUCTOR_DESC.equals(methodNode.desc) && new Matcher()

.match(methodNode, context.getSuperClassName())) {

output.ignore(methodNode.instructions.getFirst(),

methodNode.instructions.getLast());

}

}

early returns in

jacoco/org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/BridgeFilter.java

Lines 23 to 30 in 5aabb2e

public void filter(final MethodNode methodNode,

final IFilterContext context, final IFilterOutput output) {

if ((methodNode.access & Opcodes.ACC_BRIDGE) == 0) {

return;

}

output.ignore(methodNode.instructions.getFirst(),

methodNode.instructions.getLast());

}

jacoco/org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/KotlinInlineClassFilter.java

Lines 74 to 87 in 5aabb2e

public void filter(final MethodNode methodNode,

final IFilterContext context, final IFilterOutput output) {

if (!KotlinGeneratedFilter.isKotlinClass(context)) {

return;

}

if (!context.getClassAnnotations().contains("Lkotlin/jvm/JvmInline;")) {

return;

}

if ((methodNode.access & Opcodes.ACC_STATIC) != 0) {

return;

}

output.ignore(methodNode.instructions.getFirst(),

methodNode.instructions.getLast());

}

jacoco/org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/KotlinGeneratedFilter.java

Lines 31 to 50 in 5aabb2e

public void filter(final MethodNode methodNode,

final IFilterContext context, final IFilterOutput output) {

if (context.getSourceFileName() == null) {

// probably full debug information is missing

// disabled filtering as all methods might be erroneously skipped

return;

}

if (!isKotlinClass(context)) {

return;

}

if (hasLineNumber(methodNode)) {

return;

}

output.ignore(methodNode.instructions.getFirst(),

methodNode.instructions.getLast());

}

jacoco/org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/KotlinDefaultMethodsFilter.java

Lines 25 to 31 in 5aabb2e

public void filter(final MethodNode methodNode,

final IFilterContext context, final IFilterOutput output) {

if (!KotlinGeneratedFilter.isKotlinClass(context)) {

return;

}

new Matcher().match(methodNode, output);

}

jacoco/org.jacoco.core/src/org/jacoco/core/internal/analysis/filter/KotlinDefaultArgumentsFilter.java

Lines 72 to 86 in 5aabb2e

public void filter(final MethodNode methodNode,

final IFilterContext context, final IFilterOutput output) {

if ((methodNode.access & Opcodes.ACC_SYNTHETIC) == 0) {

return;

}

if (!KotlinGeneratedFilter.isKotlinClass(context)) {

return;

}

if (isDefaultArgumentsMethod(methodNode)) {

new Matcher().match(methodNode, output, false);

} else if (isDefaultArgumentsConstructor(methodNode)) {

new Matcher().match(methodNode, output, true);

}

}

leveretka · 2024-06-10T08:57:33Z

 				new ExhaustiveSwitchFilter(), //
 				new RecordPatternFilter(), //
 				new AnnotationGeneratedFilter(), new KotlinGeneratedFilter(),
+				new KotlinEnumFilter(), //


Why do we need a // here?

Otherwise Eclipse JDT Formatter will join lines and the change will look like

new AnnotationGeneratedFilter(), new KotlinGeneratedFilter(), - new KotlinLateinitFilter(), new KotlinWhenFilter(), - new KotlinWhenStringFilter(), + new KotlinEnumFilter(), new KotlinLateinitFilter(), + new KotlinWhenFilter(), new KotlinWhenStringFilter(), new KotlinUnsafeCastOperatorFilter(),

Godin added component: core.filters language: Kotlin labels May 25, 2024

Godin added this to the 0.8.13 milestone May 25, 2024

Godin self-assigned this May 25, 2024

(WIP) add validation test

24b9de9

Godin force-pushed the k2_enum_entries branch from f57d802 to 24b9de9 Compare May 31, 2024 08:04

Godin added 3 commits May 31, 2024 10:32

(WIP) add unit test

bd32861

(WIP) implement

6d553a9

(WIP) update changelog

bc40a7e

Godin added the type: enhancement label May 31, 2024

Godin marked this pull request as ready for review June 7, 2024 21:18

Godin requested a review from leveretka June 7, 2024 21:18

leveretka reviewed Jun 10, 2024

View reviewed changes

Merge branch 'master' into k2_enum_entries

5a90f76

leveretka self-requested a review July 8, 2024 19:33

leveretka approved these changes Jul 8, 2024

View reviewed changes

Godin merged commit 196e61a into jacoco:master Jul 8, 2024

Godin deleted the k2_enum_entries branch July 8, 2024 19:38

Godin mentioned this pull request Dec 21, 2024

Class with parameter with default value and JvmOverloads annotation on constructor is not fully covered in Kotlin #1752

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add filter for Kotlin enum classes#1625

Add filter for Kotlin enum classes#1625
Godin merged 5 commits intojacoco:masterfrom
Godin:k2_enum_entries

Godin commented May 25, 2024

Uh oh!

leveretka left a comment

Uh oh!

leveretka Jun 10, 2024

Uh oh!

Godin Jul 8, 2024

Uh oh!

leveretka Jun 10, 2024

Uh oh!

Godin Jul 8, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	public void filter(final MethodNode methodNode,
	final IFilterContext context, final IFilterOutput output) {
	if (ENUM_TYPE.equals(context.getSuperClassName())
	&& CONSTRUCTOR_NAME.equals(methodNode.name)
	&& CONSTRUCTOR_DESC.equals(methodNode.desc)
	&& new Matcher().match(methodNode)) {
	output.ignore(methodNode.instructions.getFirst(),
	methodNode.instructions.getLast());
	}
	}

	public void filter(final MethodNode methodNode,
	final IFilterContext context, final IFilterOutput output) {
	if ((methodNode.access & Opcodes.ACC_PRIVATE) != 0
	&& CONSTRUCTOR_NAME.equals(methodNode.name)
	&& CONSTRUCTOR_DESC.equals(methodNode.desc) && new Matcher()
	.match(methodNode, context.getSuperClassName())) {
	output.ignore(methodNode.instructions.getFirst(),
	methodNode.instructions.getLast());
	}
	}

	public void filter(final MethodNode methodNode,
	final IFilterContext context, final IFilterOutput output) {
	if ((methodNode.access & Opcodes.ACC_BRIDGE) == 0) {
	return;
	}
	output.ignore(methodNode.instructions.getFirst(),
	methodNode.instructions.getLast());
	}

	public void filter(final MethodNode methodNode,
	final IFilterContext context, final IFilterOutput output) {
	if (!KotlinGeneratedFilter.isKotlinClass(context)) {
	return;
	}
	if (!context.getClassAnnotations().contains("Lkotlin/jvm/JvmInline;")) {
	return;
	}
	if ((methodNode.access & Opcodes.ACC_STATIC) != 0) {
	return;
	}
	output.ignore(methodNode.instructions.getFirst(),
	methodNode.instructions.getLast());
	}

	public void filter(final MethodNode methodNode,
	final IFilterContext context, final IFilterOutput output) {

	if (context.getSourceFileName() == null) {
	// probably full debug information is missing
	// disabled filtering as all methods might be erroneously skipped
	return;
	}

	if (!isKotlinClass(context)) {
	return;
	}

	if (hasLineNumber(methodNode)) {
	return;
	}

	output.ignore(methodNode.instructions.getFirst(),
	methodNode.instructions.getLast());
	}

	public void filter(final MethodNode methodNode,
	final IFilterContext context, final IFilterOutput output) {
	if ((methodNode.access & Opcodes.ACC_SYNTHETIC) == 0) {
	return;
	}
	if (!KotlinGeneratedFilter.isKotlinClass(context)) {
	return;
	}

	if (isDefaultArgumentsMethod(methodNode)) {
	new Matcher().match(methodNode, output, false);
	} else if (isDefaultArgumentsConstructor(methodNode)) {
	new Matcher().match(methodNode, output, true);
	}
	}

Conversation

Godin commented May 25, 2024

Uh oh!

leveretka left a comment

Choose a reason for hiding this comment

Uh oh!

leveretka Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

Godin Jul 8, 2024

Choose a reason for hiding this comment

Uh oh!

leveretka Jun 10, 2024

Choose a reason for hiding this comment

Uh oh!

Godin Jul 8, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants