Rename double.approximately to double.around

sugar/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## `sugar.collection`
 - Add `Lists.toggleAll(...)`
+- Add `SplayTreeMaps.firstValueAfter(...)`
+- Add `SplayTreeMaps.lastValueBefore(...)`
 
 ## `sugar.core`
 - Add `System.currentDateTime`
@@ -11,6 +13,12 @@
 - **Breaking** - Remove `Maybe` extension.
 - Remove `Iterables.indexed` since it already exists in Dart 3.
 
+## `sugar.crdt`
+- Add `StringIndex`
+
+## `sugar.math`
+- **Breaking** Change `double.approximately(...)` to `double.around(...)`
+
 ## `sugar.time`
 - Add optional `DateUnit` parameter to `LocalDate.now(...)`
 - Add optional `TemporalUnit` parameter to `LocalDateTime.now(...)`

sugar/dartdoc_options.yaml

@@ -6,6 +6,8 @@ dartdoc:
       name: "Core"
     "Collection":
       name: "Collection"
+    "CRDT":
+      name: "CRDT"
     "Time":
       name: "Time"
   categoryOrder:

sugar/lib/crdt.dart

@@ -1 +1,2 @@
+// TODO: add documentation.
 export 'src/crdt/string_index.dart';

sugar/lib/src/collection/splay_tree_maps.dart

@@ -1,12 +1,29 @@
 import 'dart:collection';
 
+/// Provides functions for working [SplayTreeMap]s.
 extension SplayTreeMaps<K, V> on SplayTreeMap<K, V> {
 
+  /// Returns the value associated with the first key after [key], or null if there are no keys after [key].
+  ///
+  /// ```dart
+  /// final map = SplayTreeMap.of({1: 'A', 2: 'B', 3: 'C'});
+  ///
+  /// print(map.firstValueAfter(1)); // 'B'
+  /// print(map.firstValueAfter(3)); // null
+  /// ```
   V? firstValueAfter(K key) => switch (firstKeyAfter(key)) {
     null => null,
     final key => this[key],
   };
 
+  /// Returns the value associated with the last key before [key], or null if there are no keys before [key].
+  ///
+  /// ```dart
+  /// final map = SplayTreeMap.of({1: 'A', 2: 'B', 3: 'C'});
+  ///
+  /// print(map.lastValueBefore(3)); // 'B'
+  /// print(map.lastValueBefore(1)); // null
+  /// ```
   V? lastValueBefore(K key) => switch (lastKeyBefore(key)) {
     null => null,
     final key => this[key],

sugar/lib/src/math/numbers.dart

@@ -106,10 +106,10 @@ extension Doubles on double {
   /// Returns true if this and [other] are within the [tolerance] of each other.
   ///
   /// ```dart
-  /// 1.0002.approximately(1.0, 0.01); // true
+  /// 1.0002.around(1.0, 0.01); // true
   ///
-  /// 1.2.approximately(1.0, 0.01); // false
+  /// 1.2.around(1.0, 0.01); // false
   /// ```
-  @useResult bool approximately(double other, double tolerance) => (this - other).abs() <= tolerance;
+  @useResult bool around(num other, double tolerance) => (this - other).abs() <= tolerance;
 
 }

sugar/lib/src/time/zone/dynamic_timezone.dart

@@ -32,7 +32,7 @@ import 'package:sugar/sugar.dart';
   /// ## Contract
   /// The transitions, offsets, abbreviations and DSTs should be non-empty and have the same length.
   DynamicTimezone(super._name, this._initial, this._transitions, this._offsets, this._unit, this._abbreviations, this._dsts):
-    _range = Interval.empty(0),
+    _range = const Interval.empty(0),
     _timezone = _initial,
     super.from();
 

sugar/test/src/collection/splay_tree_maps_test.dart

@@ -0,0 +1,22 @@
+import 'dart:collection';
+
+import 'package:sugar/sugar.dart';
+import 'package:test/test.dart';
+
+void main() {
+  group('SplayTreeMaps', () {
+    final map = SplayTreeMap.of({1: 'A', 2: 'B', 3: 'C'});
+
+    group('firstValueAfter(...)', () {
+      test('key exists', () => expect(map.firstValueAfter(1), 'B'));
+
+      test('key does not exist', () => expect(map.firstValueAfter(3), null));
+    });
+
+    group('lastValueBefore(...)', () {
+      test('key exists', () => expect(map.lastValueBefore(3), 'B'));
+
+      test('key does not exist', () => expect(map.lastValueBefore(1), null));
+    });
+  });
+}

sugar/test/src/core/range/interval_test.dart

@@ -54,7 +54,7 @@ void main() {
     });
 
     group('empty(...)', () {
-      final interval = Interval.empty(1);
+      const interval = Interval.empty(1);
 
       test('empty', () => expect(interval.contains(1), false));
 

sugar/test/src/math/numbers_test.dart

@@ -60,9 +60,13 @@ void main() {
   });
 
   group('Doubles', () {
-    test('approximately true', () => expect(1.0002.approximately(1.0, 0.01), true));
+    test('around int in tolerance', () => expect(1.0002.around(1, 0.01), true));
 
-    test('approximately false', () => expect(1.2.approximately(1.0, 0.01), false));
+    test('around int outside tolerance', () => expect(1.2.around(2, 0.01), false));
+
+    test('around double in tolerance', () => expect(1.0002.around(1.0, 0.01), true));
+
+    test('around double outside tolerance', () => expect(1.2.around(1.0, 0.01), false));
   });
 
 }