👌 Improve readability in target element trait logic

appcues · Apr 11, 2023 · 183107b · 183107b
1 parent a9ecf7c
commit 183107b
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/Sources/AppcuesKit/Presentation/Debugger/ScreenCapturing/UIKitElementTargeting.swift b/Sources/AppcuesKit/Presentation/Debugger/ScreenCapturing/UIKitElementTargeting.swift
@@ -31,7 +31,7 @@ internal class UIKitElementSelector: AppcuesElementSelector {
 
         super.init()
 
-        // note: accessibilityLabel is inhertied from base type NSObject and used here
+        // note: accessibilityLabel is inherited from base type NSObject and used here
         self.accessibilityLabel = accessibilityLabel
 
     }

diff --git a/Sources/AppcuesKit/Presentation/Public/AppcuesElementTargeting.swift b/Sources/AppcuesKit/Presentation/Public/AppcuesElementTargeting.swift
@@ -29,7 +29,7 @@ public protocol AppcuesElementTargeting {
 internal extension AppcuesElementTargeting {
     // Default implementation that looks at the current view capture and finds any matches.
     // Used during targeted element experiences to find the position in the UI for the experience.
-    func findMatches(for selector: AppcuesElementSelector) -> [(AppcuesViewElement, Int)]? {
+    func findMatches(for selector: AppcuesElementSelector) -> [(view: AppcuesViewElement, weight: Int)]? {
         return captureLayout()?.viewsMatchingSelector(selector)
     }
 }
diff --git a/Sources/AppcuesKit/Presentation/Public/AppcuesViewElement.swift b/Sources/AppcuesKit/Presentation/Public/AppcuesViewElement.swift
@@ -77,7 +77,7 @@ internal extension AppcuesViewElement {
     // Used internally by the SDK to find all views, recursively, that have at least a
     // partial match with the given selector. Used to find the position of an element
     // targeted experience.
-    func viewsMatchingSelector(_ target: AppcuesElementSelector) -> [(AppcuesViewElement, Int)] {
+    func viewsMatchingSelector(_ target: AppcuesElementSelector) -> [(view: AppcuesViewElement, weight: Int)] {
         var views: [(AppcuesViewElement, Int)] = []
 
         if let current = selector {

diff --git a/Sources/AppcuesKit/Presentation/Traits/Appcues/AppcuesTargetElementTrait.swift b/Sources/AppcuesKit/Presentation/Traits/Appcues/AppcuesTargetElementTrait.swift
@@ -95,7 +95,7 @@ internal class AppcuesTargetElementTrait: BackdropDecoratingTrait {
 
         // if only a single match of anything, use it
         if weightedViews.count == 1 {
-            return weightedViews[0].0
+            return weightedViews[0].view
         }
 
         // iterating through the array, storing the highest weight value and the list of views
@@ -104,8 +104,8 @@ internal class AppcuesTargetElementTrait: BackdropDecoratingTrait {
         var maxWeightViews: [AppcuesViewElement] = []
 
         weightedViews.forEach {
-            let view = $0.0
-            let weight = $0.1
+            let view = $0.view
+            let weight = $0.weight
             if weight > maxWeight {
                 // new max weight, reset list
                 maxWeight = weight
@@ -116,12 +116,12 @@ internal class AppcuesTargetElementTrait: BackdropDecoratingTrait {
             }
         }
 
-        // if this has produced a single most distinct result, use it
-        if maxWeightViews.count == 1 {
-            return maxWeightViews[0]
+        guard maxWeightViews.count == 1 else {
+            // this selector was not able to find a distinct match in this view
+            throw TraitError(description: "multiple non-distinct views (\(weightedViews.count)) matched selector \(config.selector)")
         }
 
-        // otherwise, this selector was not able to find a distinct match in this view
-        throw TraitError(description: "multiple non-distinct views (\(weightedViews.count)) matched selector \(config.selector)")
+        // if this has produced a single most distinct result, use it
+        return maxWeightViews[0]
     }
 }