chore: change calculation for ban-name chain calls

Author: incendial

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 * feat: add static code diagnostic [`arguments-ordering`](https://dartcodemetrics.dev/docs/rules/common/arguments-ordering).
+* feat: add method call chains support for [`ban-name`](https://dartcodemetrics.dev/docs/rules/common/ban-name).
 
 ## 5.0.1
 

lib/src/analyzers/lint_analyzer/rules/rules_list/ban_name/ban_name_rule.dart

@@ -42,32 +42,11 @@ class BanNameRule extends CommonRule {
 
     source.unit.visitChildren(visitor);
 
-    final filteredNodeList = visitor.nodes.where((node) {
-      if (node.endNode != null) {
-        final inlineNode = source.content
-            .substring(
-              node.node.offset,
-              node.endNode!.end,
-            )
-            .replaceAll('\n', '');
-
-        if (!inlineNode.contains(node.fullName)) {
-          return false;
-        }
-      }
-
-      return true;
-    });
-
-    return filteredNodeList
+    return visitor.nodes
         .map(
           (node) => createIssue(
             rule: this,
-            location: nodeLocation(
-              node: node.node,
-              source: source,
-              endNode: node.endNode,
-            ),
+            location: nodeLocation(node: node.node, source: source),
             message: node.message,
           ),
         )

lib/src/analyzers/lint_analyzer/rules/rules_list/ban_name/visitor.dart

@@ -7,85 +7,92 @@ class _Visitor extends GeneralizingAstVisitor<void> {
 
   Iterable<_NodeInfo> get nodes => _nodes;
 
-  final _nodeBreadcrumb = <String, AstNode>{};
+  final _visitedNodes = <AstNode>{};
 
   _Visitor(List<_BanNameConfigEntry> entries)
       : _entryMap = Map.fromEntries(entries.map((e) => MapEntry(e.ident, e)));
 
   @override
   void visitSimpleIdentifier(SimpleIdentifier node) {
-    _visitIdent(node, node.name);
+    _visitIdent(node, node);
   }
 
   @override
   void visitPrefixedIdentifier(PrefixedIdentifier node) {
-    _visitIdent(node, node.identifier.name);
-    _visitIdent(node, node.prefix.name);
+    _visitIdent(node, node.identifier);
+    _visitIdent(node, node.prefix);
   }
 
   @override
   void visitLibraryIdentifier(LibraryIdentifier node) {
     for (final component in node.components) {
-      _visitIdent(node, component.name);
+      _visitIdent(node, component);
     }
   }
 
   @override
   void visitDeclaration(Declaration node) {
     final name = node.declaredElement?.displayName;
     if (name != null) {
-      _visitIdent(node, name);
+      _checkBannedName(node, name);
     }
 
     super.visitDeclaration(node);
   }
 
-  void _visitIdent(AstNode node, String name) {
-    final prevNode =
-        _nodeBreadcrumb.isNotEmpty ? _nodeBreadcrumb.values.last : null;
-    if (node.offset - 1 == prevNode?.end) {
-      _nodeBreadcrumb.addAll({name: node});
-    } else {
-      _nodeBreadcrumb.clear();
+  void _visitIdent(AstNode node, SimpleIdentifier name) {
+    _checkBannedName(name, name.name);
+
+    if (node is PrefixedIdentifier) {
+      _checkBannedName(node, node.name);
     }
 
-    if (_nodeBreadcrumb.isEmpty) {
-      _nodeBreadcrumb.addAll({name: node});
+    _traverseParents(name.parent);
+  }
+
+  void _traverseParents(AstNode? node) {
+    if (node is MethodInvocation) {
+      _checkBannedName(
+        node,
+        '${node.realTarget}.${node.methodName}',
+      );
+      _traverseParents(node.parent);
     }
 
-    if (_entryMap.containsKey(name)) {
-      _nodes.add(_NodeInfo(
+    if (node is PropertyAccess) {
+      _checkBannedName(
         node,
-        fullName: name,
-        message: '${_entryMap[name]!.description} ($name is banned)',
-      ));
+        '${node.realTarget}.${node.propertyName}',
+      );
+      _traverseParents(node.realTarget);
+    }
+
+    if (node is ConstructorName) {
+      _traverseParents(node.parent);
+    }
 
-      return;
+    if (node is InstanceCreationExpression) {
+      _checkBannedName(node, node.constructorName.toString());
     }
+  }
 
-    final breadcrumbString = _nodeBreadcrumb.keys.join('.');
-    if (_entryMap.containsKey(breadcrumbString)) {
+  void _checkBannedName(AstNode node, String name) {
+    if (_entryMap.containsKey(name) && !_visitedNodes.contains(node)) {
+      _visitedNodes.add(node);
       _nodes.add(_NodeInfo(
-        _nodeBreadcrumb.values.first,
-        fullName: breadcrumbString,
-        message:
-            '${_entryMap[breadcrumbString]!.description} ($breadcrumbString is banned)',
-        endNode: _nodeBreadcrumb.values.last,
+        node,
+        message: '${_entryMap[name]!.description} ($name is banned)',
       ));
     }
   }
 }
 
 class _NodeInfo {
   final AstNode node;
-  final String fullName;
   final String message;
-  final AstNode? endNode;
 
   _NodeInfo(
     this.node, {
-    required this.fullName,
     required this.message,
-    this.endNode,
   });
 }

test/src/analyzers/lint_analyzer/rules/rules_list/ban_name/ban_name_rule_test.dart

@@ -40,8 +40,8 @@ void main() {
 
       RuleTestHelper.verifyIssues(
         issues: issues,
-        startLines: [7, 8, 10, 13, 16, 17, 20, 23, 24, 26],
-        startColumns: [3, 12, 7, 1, 1, 12, 1, 1, 1, 28],
+        startLines: [7, 8, 10, 13, 16, 17, 21, 24, 25, 26, 32],
+        startColumns: [3, 12, 7, 1, 1, 12, 3, 3, 3, 3, 28],
         locationTexts: [
           'showDialog',
           'showDialog',
@@ -51,10 +51,11 @@ void main() {
               '  late var strangeName; // LINT\n'
               '}',
           'strangeName',
-          'StrangeClass.someMethod();',
-          'DateTime.now();',
+          'StrangeClass.someMethod()',
+          'DateTime.now()',
+          'DateTime.now()',
+          'DateTime.now()',
           'DateTime.now()',
-          'DateTime.now',
         ],
         messages: [
           'Please use myShowDialog (showDialog is banned)',
@@ -67,6 +68,7 @@ void main() {
           'Please use clock.now instead (DateTime.now is banned)',
           'Please use clock.now instead (DateTime.now is banned)',
           'Please use clock.now instead (DateTime.now is banned)',
+          'Please use clock.now instead (DateTime.now is banned)',
         ],
       );
     });

test/src/analyzers/lint_analyzer/rules/rules_list/ban_name/examples/example.dart

@@ -17,12 +17,17 @@ class AnotherStrangeName {
   late var strangeName; // LINT
 }
 
-StrangeClass.someMethod(); // LINT
-NonStrangeClass.someMethod();
+void main() {
+  StrangeClass.someMethod(); // LINT
+  NonStrangeClass.someMethod();
+
+  DateTime.now(); // LINT
+  DateTime.now().day; // LINT
+  DateTime.now().day.isFinite; // LINT
+
+  DateTime now = DateTime(2022);
+}
 
-DateTime.now(); // LINT
-DateTime.now().day; // LINT
 class DateTimeTest {
   final currentTimestamp = DateTime.now(); // LINT
 }
-DateTime now = DateTime(2022);