Convert confusable violations to named fields (#1887)

See: #1871.
astral-sh · Jan 15, 2023 · 2c64461 · 2c64461
1 parent 81996f1
commit 2c64461
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 27 deletions.
diff --git a/src/rules/ruff/rules.rs b/src/rules/ruff/rules.rs
@@ -1632,20 +1632,20 @@ pub fn ambiguous_unicode_character(
                     let end_location = Location::new(location.row(), location.column() + 1);
                     let mut diagnostic = Diagnostic::new::<DiagnosticKind>(
                         match context {
-                            Context::String => violations::AmbiguousUnicodeCharacterString(
-                                current_char,
+                            Context::String => violations::AmbiguousUnicodeCharacterString {
+                                confusable: current_char,
                                 representant,
-                            )
+                            }
                             .into(),
-                            Context::Docstring => violations::AmbiguousUnicodeCharacterDocstring(
-                                current_char,
+                            Context::Docstring => violations::AmbiguousUnicodeCharacterDocstring {
+                                confusable: current_char,
                                 representant,
-                            )
+                            }
                             .into(),
-                            Context::Comment => violations::AmbiguousUnicodeCharacterComment(
-                                current_char,
+                            Context::Comment => violations::AmbiguousUnicodeCharacterComment {
+                                confusable: current_char,
                                 representant,
-                            )
+                            }
                             .into(),
                         },
                         Range::new(location, end_location),

diff --git a/src/rules/ruff/snapshots/ruff__rules__ruff__tests__confusables.snap b/src/rules/ruff/snapshots/ruff__rules__ruff__tests__confusables.snap
@@ -4,8 +4,8 @@ expression: diagnostics
 ---
 - kind:
     AmbiguousUnicodeCharacterString:
-      - 𝐁
-      - B
+      confusable: 𝐁
+      representant: B
   location:
     row: 1
     column: 5
@@ -23,8 +23,8 @@ expression: diagnostics
   parent: ~
 - kind:
     AmbiguousUnicodeCharacterDocstring:
-      - ）
-      - )
+      confusable: ）
+      representant: )
   location:
     row: 6
     column: 55
@@ -42,8 +42,8 @@ expression: diagnostics
   parent: ~
 - kind:
     AmbiguousUnicodeCharacterComment:
-      - ᜵
-      - /
+      confusable: ᜵
+      representant: /
   location:
     row: 7
     column: 61

diff --git a/src/violations.rs b/src/violations.rs
@@ -6030,68 +6030,104 @@ impl AlwaysAutofixableViolation for PreferListBuiltin {
 // Ruff
 
 define_violation!(
-    pub struct AmbiguousUnicodeCharacterString(pub char, pub char);
+    pub struct AmbiguousUnicodeCharacterString {
+        pub confusable: char,
+        pub representant: char,
+    }
 );
 impl AlwaysAutofixableViolation for AmbiguousUnicodeCharacterString {
     fn message(&self) -> String {
-        let AmbiguousUnicodeCharacterString(confusable, representant) = self;
+        let AmbiguousUnicodeCharacterString {
+            confusable,
+            representant,
+        } = self;
         format!(
             "String contains ambiguous unicode character '{confusable}' (did you mean \
              '{representant}'?)"
         )
     }
 
     fn autofix_title(&self) -> String {
-        let AmbiguousUnicodeCharacterString(confusable, representant) = self;
+        let AmbiguousUnicodeCharacterString {
+            confusable,
+            representant,
+        } = self;
         format!("Replace '{confusable}' with '{representant}'")
     }
 
     fn placeholder() -> Self {
-        AmbiguousUnicodeCharacterString('𝐁', 'B')
+        AmbiguousUnicodeCharacterString {
+            confusable: '𝐁',
+            representant: 'B',
+        }
     }
 }
 
 define_violation!(
-    pub struct AmbiguousUnicodeCharacterDocstring(pub char, pub char);
+    pub struct AmbiguousUnicodeCharacterDocstring {
+        pub confusable: char,
+        pub representant: char,
+    }
 );
 impl AlwaysAutofixableViolation for AmbiguousUnicodeCharacterDocstring {
     fn message(&self) -> String {
-        let AmbiguousUnicodeCharacterDocstring(confusable, representant) = self;
+        let AmbiguousUnicodeCharacterDocstring {
+            confusable,
+            representant,
+        } = self;
         format!(
             "Docstring contains ambiguous unicode character '{confusable}' (did you mean \
              '{representant}'?)"
         )
     }
 
     fn autofix_title(&self) -> String {
-        let AmbiguousUnicodeCharacterDocstring(confusable, representant) = self;
+        let AmbiguousUnicodeCharacterDocstring {
+            confusable,
+            representant,
+        } = self;
         format!("Replace '{confusable}' with '{representant}'")
     }
 
     fn placeholder() -> Self {
-        AmbiguousUnicodeCharacterDocstring('𝐁', 'B')
+        AmbiguousUnicodeCharacterDocstring {
+            confusable: '𝐁',
+            representant: 'B',
+        }
     }
 }
 
 define_violation!(
-    pub struct AmbiguousUnicodeCharacterComment(pub char, pub char);
+    pub struct AmbiguousUnicodeCharacterComment {
+        pub confusable: char,
+        pub representant: char,
+    }
 );
 impl AlwaysAutofixableViolation for AmbiguousUnicodeCharacterComment {
     fn message(&self) -> String {
-        let AmbiguousUnicodeCharacterComment(confusable, representant) = self;
+        let AmbiguousUnicodeCharacterComment {
+            confusable,
+            representant,
+        } = self;
         format!(
             "Comment contains ambiguous unicode character '{confusable}' (did you mean \
              '{representant}'?)"
         )
     }
 
     fn autofix_title(&self) -> String {
-        let AmbiguousUnicodeCharacterComment(confusable, representant) = self;
+        let AmbiguousUnicodeCharacterComment {
+            confusable,
+            representant,
+        } = self;
         format!("Replace '{confusable}' with '{representant}'")
     }
 
     fn placeholder() -> Self {
-        AmbiguousUnicodeCharacterComment('𝐁', 'B')
+        AmbiguousUnicodeCharacterComment {
+            confusable: '𝐁',
+            representant: 'B',
+        }
     }
 }