Repository navigation
Expand file tree
/
Copy pathjmf-rules.txt
More file actions
148 lines (131 loc) · 10.2 KB
/
Copy pathjmf-rules.txt
File metadata and controls
148 lines (131 loc) · 10.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# jacoco-method-filter — Rules Template AbsaOSS/spark-data-standardization
# [jmf:2.2.0]
#
# Syntax reference, pitfalls, examples, and workflows: https://github.com/MoranaApps/jacoco-method-filter/blob/main/docs/rules-reference.md
#
# ─────────────────────────────────────────────────────────────────────────────
# HOW TO USE
# ─────────────────────────────────────────────────────────────────────────────
#
# 1) Review the GLOBAL RULES below — they cover compiler-generated boilerplate.
# 2) Add project-specific patterns in the PROJECT RULES section.
# 3) Keep rules narrow; add id: labels so logs are readable.
# Every rule must have an id:<label>. Unlabelled rules emit a [warn] at load
# time. CLI users: pass --strict to enforce id: as a hard CI requirement.
# (sbt/Maven plugins do not yet expose --strict as a configuration key.)
# 4) Use --verify mode to confirm rules match before committing.
#
# ─────────────────────────────────────────────────────────────────────────────
# GLOBAL RULES
# ─────────────────────────────────────────────────────────────────────────────
# Global rules match ALL packages. Verify they do not suppress real logic.
# See docs/rules-reference.md#global-rule-safety-warning for details.
# Scala case class helpers
*#canEqual(*) id:case-canequal
*#equals(*) id:case-equals
*#apply(*) id:case-apply
*#unapply(*) id:case-unapply
*#hashCode(*) id:case-hashcode
*#copy(*) id:case-copy
# Subsumed by gen-defaults below; kept for clarity. Safe to remove if gen-defaults is enabled.
*#copy$default$*(*) id:case-copy-defaults
*#productElement() id:case-prod-element
*#productArity() id:case-prod-arity
*#productPrefix() id:case-prod-prefix
*#productIterator() id:case-prod-iterator
*#tupled() id:case-tupled
*#curried() id:case-curried
*#toString() id:case-tostring
# Scala 2.13+ case class boilerplate — safe to enable; no-op in 2.11/2.12
# Note: unmatched
#*#productElementName(*) id:case-prod-element-name
#*#productElementNames() id:case-prod-element-names
# WARNING: may collide with domain methods named `name` — rescue with + include rule if needed
# Note: unmatched
#*#name() id:case-name
# WARNING: may collide with domain methods named `groups` — rescue with + include rule if needed
# Note: unmatched
#*#groups() id:case-groups
# WARNING: may collide with domain methods named `optionalAttributes` — rescue with + include rule if needed
# Note: unmatched
#*#optionalAttributes() id:case-optionalAttributes
# Companion objects, constructors, and static definitions
*$#<init>(*) id:gen-ctor
*$#<clinit>() id:gen-clinit
# Companion objects and defaults
*$*#apply(*) id:comp-apply
*$*#unapply(*) id:comp-unapply
*$*#toString(*) id:comp-tostring
*$*#readResolve(*) id:comp-readresolve
# Java serialization hook — compiler-generated on the case class itself (not the companion)
# Body is a single expression returning a serialization proxy; no project logic.
# WARNING: if a class overrides writeReplace with custom logic, rescue with + include rule.
# Note: unmatched
#*#writeReplace(*) id:case-writereplace
# anonymous class created by a macro expansion
# Note: unmatched
#*$macro$*#$anonfun$inst$macro$* id:macro-inst
#*$macro$*#inst$macro$* id:macro-inst
# lambda
*#* synthetic name-contains:$anonfun$ id:scala-anonfun
# Lazy val compute — compiler-generated synchronization wrapper
# Scala compiles `lazy val foo = expr` into an accessor + a `foo$lzycompute()` method.
# The $lzycompute method body IS the lazy initializer (expr). If the initializer contains
# real business logic, filtering this method hides it. Only enable when the lazy val is a
# trivial constant, a boundary call not unit-testable, or an already-tested computation.
# Rescue any lazy vals with real logic via + include rules.
# DISABLED — enable with + include rules to rescue lazy vals whose initializer has real logic
# *#*$lzycompute(*) id:scala-lzycompute
# Lambda serialization helper — compiler-generated private static method
# Emitted by scalac/javac to support SerializedLambda deserialization.
# NOT marked ACC_SYNTHETIC (unlike $anonfun$*), so the synthetic flag does not catch it.
# Body contains only a series of instanceof/handle comparisons — no project logic.
*#$deserializeLambda$(*) id:scala-deser-lambda
# Value class companion extension bridges — compiler-generated identity operations
# When a value class (AnyVal) is used in a boxed context, the Scala compiler emits
# these *$extension methods on the companion object. Each is a single-expression
# delegate to the unboxed static method; no project logic is present.
*#hashCode$extension(*) id:valclass-hashcode-ext
*#equals$extension(*) id:valclass-equals-ext
*#toString$extension(*) id:valclass-tostring-ext
*#canEqual$extension(*) id:valclass-canequal-ext
*#productIterator$extension(*) id:valclass-proditer-ext
*#productElement$extension(*) id:valclass-prodelem-ext
*#productArity$extension(*) id:valclass-prodarity-ext
*#productPrefix$extension(*) id:valclass-prodprefix-ext
*#copy$extension(*) id:valclass-copy-ext
*#copy$default$*$extension(*) id:valclass-copydef-ext
# Function1 trait mixin delegates — single-call forwarders to scala.Function1
# These arise when a class mixes in Function1. Each is a one-liner forwarding to
# the trait default. Rarely contain project logic.
# CAUTION: if your code defines andThen/compose with custom logic in a non-Function1
# class, rescue those methods with + include rules.
*#andThen(*) id:fn1-andthen
*#compose(*) id:fn1-compose
# Default parameter accessors — compiler-generated constant-returning methods
# The Scala compiler emits a $default$N method for every parameter with a default
# value. Each method body returns the constant default expression; no logic.
# This rule supersedes `case-copy-defaults` above; both are safe to keep active.
*#*$default$*(*) id:gen-defaults
# ─────────────────────────────────────────────────────────────────────────────
# INCLUDE RULES (rescue methods from broad exclusions above)
# ─────────────────────────────────────────────────────────────────────────────
# Prefix a rule with "+" to rescue a method. Include always wins over exclude.
# GLOBAL RULES excludes:
# *#apply(*)
# *#toString()
#
# The project has factory methods named `apply` that contain real logic.
# These rules rescue those project-specific methods so they remain visible in JaCoCo coverage.
+za.co.absa.standardization.numeric.DecimalSymbols$#apply(*) id:std-include-decimal-symbols-apply
+za.co.absa.standardization.numeric.NumericPattern$#apply(*) id:std-include-numeric-pattern-apply
+za.co.absa.standardization.types.parsers.DecimalParser$#apply(*) id:std-include-decimal-parser-apply
+za.co.absa.standardization.types.parsers.FractionalParser$#apply(*) id:std-include-fractional-parser-apply
+za.co.absa.standardization.types.parsers.FractionalParser$#withInfinity(*) id:std-include-fractional-parser-with-infinity
+za.co.absa.standardization.time.DateTimePattern$#apply(*) id:std-include-datetime-pattern-apply
+za.co.absa.standardization.time.DateTimePattern$#asDefault(*) id:std-include-datetime-pattern-as-default
+za.co.absa.standardization.time.DateTimePattern$#isEpoch(*) id:std-include-datetime-pattern-is-epoch
+za.co.absa.standardization.stages.InfinitySupport$#apply(*) id:std-include-infinity-support-apply
# ─────────────────────────────────────────────────────────────────────────────
# PROJECT RULES
# ─────────────────────────────────────────────────────────────────────────────