fix(enharmonic_note): address edge cases for items getter (#23)

* fix(enharmonic_note): address edge cases for `items` getter * test(enharmonic_note): add test cases for `items` getter * feat(accidental): override `toString` method and add test cases
albertms10 · Apr 8, 2023 · 4ab2a7c · 4ab2a7c
1 parent 8d3ff21
commit 4ab2a7c
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 9 deletions.
diff --git a/lib/src/note/accidental.dart b/lib/src/note/accidental.dart
@@ -43,6 +43,9 @@ class Accidental {
             (semitones.abs() ~/ 2);
   }
 
+  @override
+  String toString() => '$symbol ($semitones)';
+
   @override
   bool operator ==(Object other) =>
       other is Accidental && semitones == other.semitones;

diff --git a/lib/src/note/enharmonic_note.dart b/lib/src/note/enharmonic_note.dart
@@ -21,23 +21,27 @@ class EnharmonicNote extends Enharmonic<Note> {
     final note = Notes.fromValue(semitones);
 
     if (note != null) {
-      final noteBelow = Notes.fromOrdinal(Notes.values.indexOf(note));
-      final noteAbove = Notes.fromOrdinal(Notes.values.indexOf(note) + 2);
+      final noteBelow = Notes.fromOrdinal(note.ordinal - 1);
+      final noteAbove = Notes.fromOrdinal(note.ordinal + 1);
 
-      return SplayTreeSet<Note>.from({
+      return {
         Note(
           noteBelow,
-          Accidental(note.value - noteBelow.value),
+          Accidental((note.value - noteBelow.value).chromaticModExcludeZero),
         ),
         Note(note),
         Note(
           noteAbove,
-          Accidental(note.value - noteAbove.value),
+          Accidental(
+            note.value -
+                noteAbove.value -
+                (note.value > noteAbove.value ? chromaticDivisions : 0),
+          ),
         ),
-      });
+      };
     }
 
-    return SplayTreeSet<Note>.from({
+    return {
       Note(
         Notes.fromValue(semitones - 1)!,
         Accidental.sharp,
@@ -46,7 +50,7 @@ class EnharmonicNote extends Enharmonic<Note> {
         Notes.fromValue(semitones + 1)!,
         Accidental.flat,
       ),
-    });
+    };
   }
 
   /// Returns the [Note] from [semitones] and a [preferredAccidental].
@@ -75,7 +79,7 @@ class EnharmonicNote extends Enharmonic<Note> {
   /// ```
   @override
   EnharmonicNote transposeBy(int semitones) =>
-      EnharmonicNote(this.semitones + semitones);
+      EnharmonicNote((this.semitones + semitones).chromaticModExcludeZero);
 
   /// Returns the shortest fifths distance between this and [other].
   ///

diff --git a/test/src/note/accidental_test.dart b/test/src/note/accidental_test.dart
@@ -33,6 +33,22 @@ void main() {
       });
     });
 
+    group('.toString()', () {
+      test('should return the string representation of this Accidental', () {
+        expect(const Accidental(5).toString(), '♯𝄪𝄪 (5)');
+        expect(const Accidental(4).toString(), '𝄪𝄪 (4)');
+        expect(Accidental.tripleSharp.toString(), '♯𝄪 (3)');
+        expect(Accidental.doubleSharp.toString(), '𝄪 (2)');
+        expect(Accidental.sharp.toString(), '♯ (1)');
+        expect(Accidental.natural.toString(), '♮ (0)');
+        expect(Accidental.flat.toString(), '♭ (-1)');
+        expect(Accidental.doubleFlat.toString(), '𝄫 (-2)');
+        expect(Accidental.tripleFlat.toString(), '♭𝄫 (-3)');
+        expect(const Accidental(-4).toString(), '𝄫𝄫 (-4)');
+        expect(const Accidental(-5).toString(), '♭𝄫𝄫 (-5)');
+      });
+    });
+
     group('.hashCode', () {
       test('should ignore equal Accidental instances in a Set', () {
         final collection = {

diff --git a/test/src/note/enharmonic_note_test.dart b/test/src/note/enharmonic_note_test.dart
@@ -3,6 +3,51 @@ import 'package:test/test.dart';
 
 void main() {
   group('EnharmonicNote', () {
+    group('.items', () {
+      test('should return the correct notes for this EnharmonicNote', () {
+        expect(EnharmonicNote.c.items, {
+          const Note(Notes.b, Accidental.sharp),
+          Note.c,
+          const Note(Notes.d, Accidental.doubleFlat),
+        });
+        expect(EnharmonicNote.cSharp.items, {Note.cSharp, Note.dFlat});
+        expect(EnharmonicNote.d.items, {
+          const Note(Notes.c, Accidental.doubleSharp),
+          Note.d,
+          const Note(Notes.e, Accidental.doubleFlat),
+        });
+        expect(EnharmonicNote.dSharp.items, {Note.dSharp, Note.eFlat});
+        expect(EnharmonicNote.e.items, {
+          const Note(Notes.d, Accidental.doubleSharp),
+          Note.e,
+          const Note(Notes.f, Accidental.flat),
+        });
+        expect(EnharmonicNote.f.items, {
+          const Note(Notes.e, Accidental.sharp),
+          Note.f,
+          const Note(Notes.g, Accidental.doubleFlat),
+        });
+        expect(EnharmonicNote.fSharp.items, {Note.fSharp, Note.gFlat});
+        expect(EnharmonicNote.g.items, {
+          const Note(Notes.f, Accidental.doubleSharp),
+          Note.g,
+          const Note(Notes.a, Accidental.doubleFlat),
+        });
+        expect(EnharmonicNote.gSharp.items, {Note.gSharp, Note.aFlat});
+        expect(EnharmonicNote.a.items, {
+          const Note(Notes.g, Accidental.doubleSharp),
+          Note.a,
+          const Note(Notes.b, Accidental.doubleFlat),
+        });
+        expect(EnharmonicNote.aSharp.items, {Note.aSharp, Note.bFlat});
+        expect(EnharmonicNote.b.items, {
+          const Note(Notes.a, Accidental.doubleSharp),
+          Note.b,
+          const Note(Notes.c, Accidental.flat),
+        });
+      });
+    });
+
     group('.shortestFifthsDistance()', () {
       test('should return the shortest fifths distance from other', () {
         expect(EnharmonicNote.c.shortestFifthsDistance(EnharmonicNote.c), 0);