Merge branch 'master' of https://github.com/dart-code-checker/dart-code-metrics

Author: incendial

CHANGELOG.md

@@ -1,12 +1,17 @@
 # Changelog
 
+## Unreleased
+
+* feat: add alphabetical sorting by type for `member-ordering-extended` rule.
+* fix: prefer conditional expressions rule breaks code with increment / decrement operators
+
 ## 4.7.0
 
-* feat: add static code diagnostics `avoid-throw-in-catch-block`, `avoid-unnecessary-type-assertions`, `avoid-unnecessary-type-casts`, `avoid-missing-enum-constant-in-map`
-* feat: improve check unused l10n
-* fix: `no-magic-number` not working in array of widgets
-* chore: activate self implemented rules: `avoid-unnecessary-type-assertions`, `avoid-unnecessary-type-casts`, `prefer-first`, `prefer-last`, `prefer-match-file-name`
-* refactor: cleanup anti-patterns, metrics and rules documentation
+* feat: add static code diagnostics `avoid-throw-in-catch-block`, `avoid-unnecessary-type-assertions`, `avoid-unnecessary-type-casts`, `avoid-missing-enum-constant-in-map`.
+* feat: improve check unused l10n.
+* fix: `no-magic-number` not working in array of widgets.
+* chore: activate self implemented rules: `avoid-unnecessary-type-assertions`, `avoid-unnecessary-type-casts`, `prefer-first`, `prefer-last`, `prefer-match-file-name`.
+* refactor: cleanup anti-patterns, metrics and rules documentation.
 
 ## 4.6.0
 

lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering_extended/config_parser.dart

@@ -29,6 +29,10 @@ class _ConfigParser {
   static bool parseAlphabetize(Map<String, Object> config) =>
       (config['alphabetize'] as bool?) ?? false;
 
+  static bool parseAlphabetizeByType(Map<String, Object> config) =>
+      (config['alphabetize-by-type'] as bool?) ?? false;
+
+  // ignore: long-method
   static _MemberGroup? _parseGroup(String group) {
     final lastGroup = group.endsWith('getters-setters')
         ? 'getters-setters'

lib/src/analyzers/lint_analyzer/rules/rules_list/member_ordering_extended/member_ordering_extended_rule.dart

@@ -27,13 +27,17 @@ class MemberOrderingExtendedRule extends CommonRule {
 
   static const _warningMessage = 'should be before';
   static const _warningAlphabeticalMessage = 'should be alphabetically before';
+  static const _warningTypeAlphabeticalMessage =
+      'type name should be alphabetically before';
 
   final List<_MemberGroup> _groupsOrder;
   final bool _alphabetize;
+  final bool _alphabetizeByType;
 
   MemberOrderingExtendedRule([Map<String, Object> config = const {}])
       : _groupsOrder = _ConfigParser.parseOrder(config),
         _alphabetize = _ConfigParser.parseAlphabetize(config),
+        _alphabetizeByType = _ConfigParser.parseAlphabetizeByType(config),
         super(
           id: ruleId,
           severity: readSeverity(config, Severity.style),
@@ -77,6 +81,19 @@ class MemberOrderingExtendedRule extends CommonRule {
                     '${info.memberOrder.memberNames.currentName} $_warningAlphabeticalMessage ${info.memberOrder.memberNames.previousName}.',
               ),
             ),
+      if (!_alphabetize && _alphabetizeByType)
+        ...membersInfo.where((info) => info.memberOrder.isByTypeWrong).map(
+              (info) => createIssue(
+                rule: this,
+                location: nodeLocation(
+                  node: info.classMember,
+                  source: source,
+                  withCommentOrMetadata: true,
+                ),
+                message:
+                    '${info.memberOrder.memberNames.currentName} $_warningTypeAlphabeticalMessage ${info.memberOrder.memberNames.previousName}.',
+              ),
+            ),
     ];
   }
 }

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

@@ -36,6 +36,9 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
         memberOrder: _getOrder(
           closestGroup,
           declaration.fields.variables.first.name.name,
+          declaration.fields.type?.type
+                  ?.getDisplayString(withNullability: false) ??
+              '_',
         ),
       ));
     }
@@ -48,7 +51,11 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
     if (closestGroup != null) {
       _membersInfo.add(_MemberInfo(
         classMember: declaration,
-        memberOrder: _getOrder(closestGroup, declaration.name?.name ?? ''),
+        memberOrder: _getOrder(
+          closestGroup,
+          declaration.name?.name ?? '',
+          declaration.returnType.name,
+        ),
       ));
     }
   }
@@ -61,7 +68,13 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
       if (closestGroup != null) {
         _membersInfo.add(_MemberInfo(
           classMember: declaration,
-          memberOrder: _getOrder(closestGroup, declaration.name.name),
+          memberOrder: _getOrder(
+            closestGroup,
+            declaration.name.name,
+            declaration.returnType?.type
+                    ?.getDisplayString(withNullability: false) ??
+                '_',
+          ),
         ));
       }
     } else {
@@ -71,7 +84,13 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
       if (closestGroup != null) {
         _membersInfo.add(_MemberInfo(
           classMember: declaration,
-          memberOrder: _getOrder(closestGroup, declaration.name.name),
+          memberOrder: _getOrder(
+            closestGroup,
+            declaration.name.name,
+            declaration.returnType?.type
+                    ?.getDisplayString(withNullability: false) ??
+                '_',
+          ),
         ));
       }
     }
@@ -93,7 +112,11 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
     return closestGroups.firstOrNull;
   }
 
-  _MemberOrder _getOrder(_MemberGroup memberGroup, String memberName) {
+  _MemberOrder _getOrder(
+    _MemberGroup memberGroup,
+    String memberName,
+    String typeName,
+  ) {
     if (_membersInfo.isNotEmpty) {
       final lastMemberOrder = _membersInfo.last.memberOrder;
       final hasSameGroup = lastMemberOrder.memberGroup == memberGroup;
@@ -106,12 +129,19 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
       final memberNames = _MemberNames(
         currentName: memberName,
         previousName: lastMemberOrder.memberNames.currentName,
+        currentTypeName: typeName,
+        previousTypeName: lastMemberOrder.memberNames.currentTypeName,
       );
 
       return _MemberOrder(
         memberNames: memberNames,
         isAlphabeticallyWrong: hasSameGroup &&
             memberNames.currentName.compareTo(memberNames.previousName!) < 0,
+        isByTypeWrong: hasSameGroup &&
+            memberNames.currentTypeName
+                    .toLowerCase()
+                    .compareTo(memberNames.previousTypeName!.toLowerCase()) <
+                0,
         memberGroup: memberGroup,
         previousMemberGroup: previousMemberGroup,
         isWrong: (hasSameGroup && lastMemberOrder.isWrong) ||
@@ -120,8 +150,10 @@ class _Visitor extends RecursiveAstVisitor<List<_MemberInfo>> {
     }
 
     return _MemberOrder(
-      memberNames: _MemberNames(currentName: memberName),
+      memberNames:
+          _MemberNames(currentName: memberName, currentTypeName: typeName),
       isAlphabeticallyWrong: false,
+      isByTypeWrong: false,
       memberGroup: memberGroup,
       isWrong: false,
     );
@@ -196,13 +228,15 @@ class _MemberInfo {
 class _MemberOrder {
   final bool isWrong;
   final bool isAlphabeticallyWrong;
+  final bool isByTypeWrong;
   final _MemberNames memberNames;
   final _MemberGroup memberGroup;
   final _MemberGroup? previousMemberGroup;
 
   const _MemberOrder({
     required this.isWrong,
     required this.isAlphabeticallyWrong,
+    required this.isByTypeWrong,
     required this.memberNames,
     required this.memberGroup,
     this.previousMemberGroup,
@@ -213,9 +247,13 @@ class _MemberOrder {
 class _MemberNames {
   final String currentName;
   final String? previousName;
+  final String currentTypeName;
+  final String? previousTypeName;
 
   const _MemberNames({
     required this.currentName,
+    required this.currentTypeName,
     this.previousName,
+    this.previousTypeName,
   });
 }

lib/src/analyzers/lint_analyzer/rules/rules_list/prefer_conditional_expressions/prefer_conditional_expressions_rule.dart

@@ -1,6 +1,7 @@
 // ignore_for_file: public_member_api_docs
 
 import 'package:analyzer/dart/ast/ast.dart';
+import 'package:analyzer/dart/ast/token.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
 import 'package:meta/meta.dart';
 
@@ -72,7 +73,13 @@ class PreferConditionalExpressionsRule extends CommonRule {
       final firstExpression = thenStatement.rightHandSide;
       final secondExpression = elseStatement.rightHandSide;
 
-      return '$target = $condition ? $firstExpression : $secondExpression;';
+      final thenStatementOperator = thenStatement.operator.type;
+      final elseStatementOperator = elseStatement.operator.type;
+
+      return _isAssignmentOperatorNotEq(thenStatementOperator) &&
+              _isAssignmentOperatorNotEq(elseStatementOperator)
+          ? '$condition ? ${thenStatement.leftHandSide} ${thenStatementOperator.stringValue} $firstExpression : ${thenStatement.leftHandSide} ${elseStatementOperator.stringValue} $secondExpression;'
+          : '$target = $condition ? $firstExpression : $secondExpression;';
     }
 
     if (thenStatement is ReturnStatement && elseStatement is ReturnStatement) {
@@ -84,4 +91,7 @@ class PreferConditionalExpressionsRule extends CommonRule {
 
     return null;
   }
+
+  bool _isAssignmentOperatorNotEq(TokenType token) =>
+      token.isAssignmentOperator && token != TokenType.EQ;
 }

test/src/analyzers/lint_analyzer/rules/rules_list/member_ordering_extended/examples/type_alphabetical_example.dart

@@ -0,0 +1,22 @@
+class Test {
+  final value = 1;
+
+  String a;
+
+  String z;
+
+  double f; // LINT
+
+  double e;
+
+  int x;
+
+  // LINT
+  String work() {
+    return '';
+  }
+
+  bool create() => false; // LINT
+
+  void init() {} // LINT
+}

test/src/analyzers/lint_analyzer/rules/rules_list/member_ordering_extended/member_ordering_extened_rule_test.dart

@@ -12,6 +12,8 @@ const _alphabeticalExamplePath =
     'member_ordering_extended/examples/alphabetical_example.dart';
 const _alphabeticalCorrectExamplePath =
     'member_ordering_extended/examples/alphabetical_correct_example.dart';
+const _typeAlphabeticalExamplePath =
+    'member_ordering_extended/examples/type_alphabetical_example.dart';
 
 void main() {
   group('MemberOrderingExtendedRule', () {
@@ -275,6 +277,47 @@ void main() {
           RuleTestHelper.verifyNoIssues(issues);
         });
       });
+
+      group('and type alphabetical order', () {
+        test('reports about found issues', () async {
+          final unit = await RuleTestHelper.resolveFromFile(
+            _typeAlphabeticalExamplePath,
+          );
+          final config = {
+            'alphabetize-by-type': true,
+            'order': [
+              'public-methods',
+              'public-fields',
+            ],
+          };
+
+          final issues = MemberOrderingExtendedRule(config).check(unit);
+
+          RuleTestHelper.verifyIssues(
+            issues: issues,
+            startOffsets: [115, 153, 188, 61, 153],
+            startLines: [15, 19, 21, 8, 19],
+            startColumns: [3, 3, 3, 3, 3],
+            endOffsets: [149, 176, 202, 70, 176],
+            locationTexts: [
+              'String work() {\n'
+                  "    return '';\n"
+                  '  }',
+              'bool create() => false;',
+              'void init() {}',
+              'double f;',
+              'bool create() => false;',
+            ],
+            messages: [
+              'public-methods should be before public-fields.',
+              'public-methods should be before public-fields.',
+              'public-methods should be before public-fields.',
+              'f type name should be alphabetically before z.',
+              'create type name should be alphabetically before work.',
+            ],
+          );
+        });
+      });
     });
   });
 }

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

@@ -140,3 +140,37 @@ int anotherTestFunction() {
     a = 6;
   }
 }
+
+int newCase() {
+  final cond = false;
+  final delta = 1;
+  final value = 9;
+
+  // LINT
+  if (cond) {
+    value += delta;
+  } else {
+    value -= delta;
+  }
+
+  // LINT
+  if (cond) {
+    value -= delta;
+  } else {
+    value += delta;
+  }
+
+  // LINT
+  if (cond) {
+    value -= 2;
+  } else {
+    value += 5;
+  }
+
+  // LINT
+  if (cond) {
+    value *= 2;
+  } else {
+    value /= 5;
+  }
+}