Fix public accessibility analysis false-positive for enum case parame…

…ter types

CHANGELOG.md

@@ -14,13 +14,14 @@
 - Subscript functions required by `@dynamicMemberLookup` are now retained.
 - A newline is no longer printed before non-Xcode formatted results.
 - `--external-codable-protocols` now retains enums that conform to `CodingKey`.
-- Fix redundant public accessibility analysis false-positive for actors. 
-- Fix redundant public accessibility analysis false-positive for property wrappers.
-- Fix redundant public accessibility analysis false-positive for declarations referenced from a public `@inlinable` function.
-- Fix redundant public accessibility analysis false-positive for function parameter default values.
-- Fix redundant public accessibility analysis false-positive for inherited and default associated types.
-- Fix redundant public accessibility analysis false-positive for generic types used in the generic argument clause of a return type.
-- Fix redundant public accessibility analysis false-positive for retained/ignored declarations.
+- Fix public accessibility analysis false-positive for actors. 
+- Fix public accessibility analysis false-positive for property wrappers.
+- Fix public accessibility analysis false-positive for declarations referenced from a public `@inlinable` function.
+- Fix public accessibility analysis false-positive for function parameter default values.
+- Fix public accessibility analysis false-positive for inherited and default associated types.
+- Fix public accessibility analysis false-positive for generic types used in the generic argument clause of a return type.
+- Fix public accessibility analysis false-positive for retained/ignored declarations.
+- Fix public accessibility analysis false-positive for enum case parameter types. 
 
 ## 2.17.1 (2023-12-04)
 

Sources/PeripheryKit/Indexer/SwiftIndexer.swift

@@ -332,11 +332,22 @@ public final class SwiftIndexer: Indexer {
                 .reduce(into: [Int: [Declaration]]()) { (result, decl) in
                     result[decl.location.line, default: []].append(decl)
                 }
+            let sortedDeclLines = declsByLine.keys.sorted().reversed()
 
             for ref in danglingReferences {
-                guard let candidateDecls =
-                        declsByLocation[ref.location] ??
-                        declsByLine[ref.location.line] else { continue }
+                let sameLineCandidateDecls = declsByLocation[ref.location] ??
+                        declsByLine[ref.location.line]
+                var candidateDecls = [Declaration]()
+
+                if let sameLineCandidateDecls {
+                    candidateDecls = sameLineCandidateDecls
+                } else {
+                    // No matching declarations on the same line, default to the nearest preceding
+                    // declaration.
+                    if let line = sortedDeclLines.first(where: { $0 < ref.location.line }) {
+                        candidateDecls = declsByLine[line] ?? []
+                    }
+                }
 
                 // The vast majority of the time there will only be a single declaration for this location,
                 // however it is possible for there to be more than one. In that case, first attempt to associate with

Tests/AccessibilityTests/AccessibilityProject/Sources/MainTarget/main.swift

@@ -44,6 +44,7 @@ case let .someCase(a, b):
     _ = a.value
     _ = b.value
 }
+_ = PublicEnumCaseWithParameter.someCase(param1: nil, param2: nil)
 
 // Inheritance
 _ = PublicClassInheritingPublicClass()

Tests/AccessibilityTests/AccessibilityProject/Sources/TargetA/PublicEnumCaseWithParameter.swift

@@ -0,0 +1,10 @@
+public class PublicEnumCaseWithParameter_ParameterType {}
+public class PublicEnumCaseWithParameter_ParameterType_Outer {
+    public class Inner {}
+}
+public enum PublicEnumCaseWithParameter {
+    case someCase(
+        param1: PublicEnumCaseWithParameter_ParameterType?,
+        param2: PublicEnumCaseWithParameter_ParameterType_Outer.Inner?
+    )
+}

Tests/AccessibilityTests/RedundantPublicAccessibilityTest.swift

@@ -212,6 +212,16 @@ class RedundantPublicAccessibilityTest: SourceGraphTestCase {
         }
     }
 
+    func testEnumCaseWithParameter() {
+        Self.index()
+
+        assertNotRedundantPublicAccessibility(.class("PublicEnumCaseWithParameter_ParameterType"))
+        assertNotRedundantPublicAccessibility(.class("PublicEnumCaseWithParameter_ParameterType_Outer")) {
+            self.assertNotRedundantPublicAccessibility(.class("Inner"))
+        }
+        assertNotRedundantPublicAccessibility(.enum("PublicEnumCaseWithParameter"))
+    }
+
     func testTypealiasWithClosureType() {
         Self.index()