Latest lints, require Dart 3.1, use mixin (#322)

.github/workflows/ci.yml

@@ -46,7 +46,7 @@ jobs:
       matrix:
         # Add macos-latest and/or windows-latest if relevant for this package.
         os: [ubuntu-latest]
-        sdk: [2.18.0, dev]
+        sdk: [3.1.0, dev]
     steps:
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
       - uses: dart-lang/setup-dart@b64355ae6ca0b5d484f0106a033dd1388965d06d

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 - Adds `shuffled` to `IterableExtension`.
 - Shuffle `IterableExtension.sample` results.
+- Require Dart `^3.1.0`
+- Mark "mixin" classes as `mixin`.
 
 ## 1.18.0
 

analysis_options.yaml

@@ -1,29 +1,16 @@
-include: package:lints/recommended.yaml
+include: package:dart_flutter_team_lints/analysis_options.yaml
 
 analyzer:
   language:
     strict-casts: true
 
 linter:
   rules:
-    - always_declare_return_types
-    - avoid_dynamic_calls
     - avoid_unused_constructor_parameters
     - cancel_subscriptions
-    - directives_ordering
-    - lines_longer_than_80_chars
     - literal_only_boolean_expressions
     - missing_whitespace_between_adjacent_strings
     - no_adjacent_strings_in_list
     - no_runtimeType_toString
-    - omit_local_variable_types
     - package_api_docs
-    - prefer_relative_imports
-    - prefer_single_quotes
-    - test_types_in_equals
-    - throw_in_finally
-    - type_annotate_public_apis
-    - unawaited_futures
     - unnecessary_await_in_return
-    - unnecessary_lambdas
-    - use_super_parameters

lib/algorithms.dart

@@ -7,4 +7,4 @@
 library dart.pkg.collection.algorithms;
 
 export 'src/algorithms.dart'
-    show binarySearch, insertionSort, lowerBound, mergeSort, shuffle, reverse;
+    show binarySearch, insertionSort, lowerBound, mergeSort, reverse, shuffle;

lib/collection.dart

@@ -3,7 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 export 'src/algorithms.dart'
-    show binarySearch, insertionSort, lowerBound, mergeSort, shuffle, reverse;
+    show binarySearch, insertionSort, lowerBound, mergeSort, reverse, shuffle;
 export 'src/boollist.dart';
 export 'src/canonicalized_map.dart';
 export 'src/combined_wrappers/combined_iterable.dart';

lib/src/comparators.dart

@@ -99,7 +99,7 @@ int compareAsciiUpperCase(String a, String b) {
       bUpperCase -= _asciiCaseBit;
     }
     if (aUpperCase != bUpperCase) return (aUpperCase - bUpperCase).sign;
-    if (defaultResult == 0) defaultResult = (aChar - bChar);
+    if (defaultResult == 0) defaultResult = aChar - bChar;
   }
   if (b.length > a.length) return -1;
   return defaultResult.sign;

lib/src/empty_unmodifiable_set.dart

@@ -34,7 +34,7 @@ class EmptyUnmodifiableSet<E> extends IterableBase<E>
   E singleWhere(bool Function(E) test, {E Function()? orElse}) =>
       orElse != null ? orElse() : throw StateError('No element');
   @override
-  Iterable<T> whereType<T>() => Iterable.empty();
+  Iterable<T> whereType<T>() => Iterable<T>.empty();
   @override
   Set<E> toSet() => {};
   @override

lib/src/equality.dart

@@ -138,10 +138,10 @@ class IterableEquality<E> implements Equality<Iterable<E>> {
       var c = _elementEquality.hash(element);
       hash = (hash + c) & _hashMask;
       hash = (hash + (hash << 10)) & _hashMask;
-      hash ^= (hash >> 6);
+      hash ^= hash >> 6;
     }
     hash = (hash + (hash << 3)) & _hashMask;
-    hash ^= (hash >> 11);
+    hash ^= hash >> 11;
     hash = (hash + (hash << 15)) & _hashMask;
     return hash;
   }
@@ -190,10 +190,10 @@ class ListEquality<E> implements Equality<List<E>> {
       var c = _elementEquality.hash(list[i]);
       hash = (hash + c) & _hashMask;
       hash = (hash + (hash << 10)) & _hashMask;
-      hash ^= (hash >> 6);
+      hash ^= hash >> 6;
     }
     hash = (hash + (hash << 3)) & _hashMask;
-    hash ^= (hash >> 11);
+    hash ^= hash >> 11;
     hash = (hash + (hash << 15)) & _hashMask;
     return hash;
   }
@@ -240,7 +240,7 @@ abstract class _UnorderedEquality<E, T extends Iterable<E>>
       hash = (hash + c) & _hashMask;
     }
     hash = (hash + (hash << 3)) & _hashMask;
-    hash ^= (hash >> 11);
+    hash ^= hash >> 11;
     hash = (hash + (hash << 15)) & _hashMask;
     return hash;
   }
@@ -349,7 +349,7 @@ class MapEquality<K, V> implements Equality<Map<K, V>> {
       hash = (hash + 3 * keyHash + 7 * valueHash) & _hashMask;
     }
     hash = (hash + (hash << 3)) & _hashMask;
-    hash ^= (hash >> 11);
+    hash ^= hash >> 11;
     hash = (hash + (hash << 15)) & _hashMask;
     return hash;
   }

lib/src/unmodifiable_wrappers.dart

@@ -25,7 +25,7 @@ class NonGrowableListView<E> extends DelegatingList<E>
 
 /// Mixin class that implements a throwing version of all list operations that
 /// change the List's length.
-abstract class NonGrowableListMixin<E> implements List<E> {
+abstract mixin class NonGrowableListMixin<E> implements List<E> {
   static Never _throw() {
     throw UnsupportedError('Cannot change the length of a fixed-length list');
   }
@@ -116,7 +116,7 @@ class UnmodifiableSetView<E> extends DelegatingSet<E>
 
 /// Mixin class that implements a throwing version of all set operations that
 /// change the Set.
-abstract /*mixin*/ class UnmodifiableSetMixin<E> implements Set<E> {
+abstract mixin class UnmodifiableSetMixin<E> implements Set<E> {
   static Never _throw() {
     throw UnsupportedError('Cannot modify an unmodifiable Set');
   }
@@ -164,7 +164,7 @@ abstract /*mixin*/ class UnmodifiableSetMixin<E> implements Set<E> {
 
 /// Mixin class that implements a throwing version of all map operations that
 /// change the Map.
-abstract /*mixin*/ class UnmodifiableMapMixin<K, V> implements Map<K, V> {
+abstract mixin class UnmodifiableMapMixin<K, V> implements Map<K, V> {
   static Never _throw() {
     throw UnsupportedError('Cannot modify an unmodifiable Map');
   }

lib/src/wrappers.dart

@@ -793,7 +793,7 @@ class MapValueSet<K, V> extends _DelegatingIterableBase<V> implements Set<V> {
 
   @override
   void removeWhere(bool Function(V) test) {
-    var toRemove = [];
+    var toRemove = <K>[];
     _baseMap.forEach((key, value) {
       if (test(value)) toRemove.add(key);
     });
@@ -811,7 +811,7 @@ class MapValueSet<K, V> extends _DelegatingIterableBase<V> implements Set<V> {
       valuesToRetain.add(_baseMap[key] ?? null as V);
     }
 
-    var keysToRemove = [];
+    var keysToRemove = <K>[];
     _baseMap.forEach((k, v) {
       if (!valuesToRetain.contains(v)) keysToRemove.add(k);
     });

pubspec.yaml

@@ -9,8 +9,8 @@ topics:
  - collections
 
 environment:
-  sdk: ">=2.18.0 <4.0.0"
+  sdk: ^3.1.0
 
 dev_dependencies:
-  lints: ^2.0.1
+  dart_flutter_team_lints: ^2.0.0
   test: ^1.16.0

test/algorithms_test.dart

@@ -3,6 +3,8 @@
 // BSD-style license that can be found in the LICENSE file.
 
 /// Tests algorithm utilities.
+library;
+
 import 'dart:math';
 
 import 'package:collection/collection.dart';
@@ -13,7 +15,7 @@ void main() {
   void testShuffle(List list) {
     var copy = list.toList();
     shuffle(list);
-    expect(UnorderedIterableEquality().equals(list, copy), isTrue);
+    expect(const UnorderedIterableEquality().equals(list, copy), isTrue);
   }
 
   test('Shuffle 0', () {
@@ -270,34 +272,34 @@ void main() {
       test('$name2: Same #$n', () {
         var list = List<OC>.generate(n, (i) => OC(i, 0));
         // Should succeed. Bad implementations of, e.g., quicksort can diverge.
-        sort(list, ocOrder, compareInt);
+        sort(list, _ocOrder, _compareInt);
       });
       test('$name: Pre-sorted #$n', () {
         var list = List<OC>.generate(n, (i) => OC(-i, i));
         var expected = list.toList();
-        sort(list, ocOrder, compareInt);
+        sort(list, _ocOrder, _compareInt);
         // Elements have not moved.
         expect(list, expected);
       });
       test('$name: Reverse-sorted #$n', () {
         var list = List<OC>.generate(n, (i) => OC(i, -i));
-        sort(list, ocOrder, compareInt);
-        expectSorted(list, ocOrder, compareInt);
+        sort(list, _ocOrder, _compareInt);
+        expectSorted(list, _ocOrder, _compareInt);
       });
       test('$name: Random #$n', () {
         var random = Random();
         var list = List<OC>.generate(n, (i) => OC(i, random.nextInt(n)));
-        sort(list, ocOrder, compareInt);
-        expectSorted(list, ocOrder, compareInt);
+        sort(list, _ocOrder, _compareInt);
+        expectSorted(list, _ocOrder, _compareInt);
       });
       test('$name: Sublist #$n', () {
         var random = Random();
         var list = List<OC>.generate(n, (i) => OC(i, random.nextInt(n)));
         var original = list.toList();
         var start = n ~/ 4;
         var end = start * 3;
-        sort(list, ocOrder, compareInt, start, end);
-        expectSorted(list, ocOrder, compareInt, start, end);
+        sort(list, _ocOrder, _compareInt, start, end);
+        expectSorted(list, _ocOrder, _compareInt, start, end);
         expect(list.sublist(0, start), original.sublist(0, start));
         expect(list.sublist(end), original.sublist(end));
       });
@@ -374,7 +376,6 @@ class C {
 }
 
 int compareC(C one, C other) => one.id - other.id;
-int cId(C c) => c.id;
 
 /// Class naturally ordered by its first constructor argument.
 class OC implements Comparable<OC> {
@@ -389,10 +390,9 @@ class OC implements Comparable<OC> {
   String toString() => 'OC[$id,$order]';
 }
 
-int ocId(OC oc) => oc.id;
-int ocOrder(OC oc) => oc.order;
+int _ocOrder(OC oc) => oc.order;
 
-int compareInt(int a, int b) => a - b;
+int _compareInt(int a, int b) => a - b;
 
 /// Check that a list is sorted according to [compare] of [keyOf] of elements.
 void expectSorted<T, K>(

test/analysis_options.yaml

@@ -4,3 +4,5 @@ include: ../analysis_options.yaml
 analyzer:
   errors:
     avoid_dynamic_calls: ignore
+    inference_failure_on_collection_literal: ignore
+    inference_failure_on_instance_creation: ignore

test/boollist_test.dart

@@ -44,10 +44,12 @@ void main() {
       var b = BoolList(1024, fill: false);
 
       expect(() {
+        // ignore: unnecessary_statements
         b[-1];
       }, throwsRangeError);
 
       expect(() {
+        // ignore: unnecessary_statements
         b[1024];
       }, throwsRangeError);
     });

test/canonicalized_map_test.dart

@@ -147,9 +147,9 @@ void main() {
 
     test('addEntries adds key-value pairs to the map', () {
       map.addEntries([
-        MapEntry('1', 'value 1'),
-        MapEntry('01', 'value 01'),
-        MapEntry('2', 'value 2'),
+        const MapEntry('1', 'value 1'),
+        const MapEntry('01', 'value 01'),
+        const MapEntry('2', 'value 2'),
       ]);
       expect(map, {'01': 'value 01', '2': 'value 2'});
     });

test/combined_wrapper/iterable_test.dart

@@ -22,12 +22,12 @@ void main() {
   });
 
   test('should function as an empty iterable when no iterables are passed', () {
-    var empty = CombinedIterableView([]);
+    var empty = const CombinedIterableView([]);
     expect(empty, isEmpty);
   });
 
   test('should function as an empty iterable with all empty iterables', () {
-    var empty = CombinedIterableView([[], [], []]);
+    var empty = const CombinedIterableView([[], [], []]);
     expect(empty, isEmpty);
   });
 

test/combined_wrapper/map_test.dart

@@ -7,8 +7,6 @@ import 'dart:collection';
 import 'package:collection/collection.dart';
 import 'package:test/test.dart';
 
-import '../unmodifiable_collection_test.dart' as common;
-
 void main() {
   var map1 = const {1: 1, 2: 2, 3: 3};
   var map2 = const {4: 4, 5: 5, 6: 6};
@@ -24,10 +22,10 @@ void main() {
     ..addAll(map3);
 
   // In every way possible this should test the same as an UnmodifiableMapView.
-  common.testReadMap(
+  _testReadMap(
       concat, CombinedMapView([map1, map2, map3, map4]), 'CombinedMapView');
 
-  common.testReadMap(
+  _testReadMap(
       concat,
       CombinedMapView([map1, {}, map2, {}, map3, {}, map4, {}]),
       'CombinedMapView (some empty)');
@@ -69,3 +67,52 @@ void main() {
     expect(keys.toList(), keys.toList());
   });
 }
+
+void _testReadMap(Map<int, int> original, Map<int, int> wrapped, String name) {
+  test('$name length', () {
+    expect(wrapped.length, equals(original.length));
+  });
+
+  test('$name isEmpty', () {
+    expect(wrapped.isEmpty, equals(original.isEmpty));
+  });
+
+  test('$name isNotEmpty', () {
+    expect(wrapped.isNotEmpty, equals(original.isNotEmpty));
+  });
+
+  test('$name operator[]', () {
+    expect(wrapped[0], equals(original[0]));
+    expect(wrapped[999], equals(original[999]));
+  });
+
+  test('$name containsKey', () {
+    expect(wrapped.containsKey(0), equals(original.containsKey(0)));
+    expect(wrapped.containsKey(999), equals(original.containsKey(999)));
+  });
+
+  test('$name containsValue', () {
+    expect(wrapped.containsValue(0), equals(original.containsValue(0)));
+    expect(wrapped.containsValue(999), equals(original.containsValue(999)));
+  });
+
+  test('$name forEach', () {
+    var origCnt = 0;
+    var wrapCnt = 0;
+    wrapped.forEach((k, v) {
+      wrapCnt += 1 << k + 3 * v;
+    });
+    original.forEach((k, v) {
+      origCnt += 1 << k + 3 * v;
+    });
+    expect(wrapCnt, equals(origCnt));
+  });
+
+  test('$name keys', () {
+    expect(wrapped.keys, orderedEquals(original.keys));
+  });
+
+  test('$name values', () {
+    expect(wrapped.values, orderedEquals(original.values));
+  });
+}