✨ feat(note): add respelledSimple getter (#191)

albertms10 · Jun 19, 2023 · 7a38f86 · 7a38f86
1 parent 142b232
commit 7a38f86
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/lib/src/note/note.dart b/lib/src/note/note.dart
@@ -185,6 +185,19 @@ final class Note implements Comparable<Note>, Scalable<Note> {
     return Note(baseNote, accidental);
   }
 
+  /// Returns this [Note] with the simplest [Accidental] spelling while keeping
+  /// the same number of [semitones].
+  ///
+  /// Example:
+  /// ```dart
+  /// Note.e.sharp.respelledSimple == Note.f
+  /// Note.d.flat.flat.respelledSimple == Note.c
+  /// Note.f.sharp.sharp.sharp.respelledSimple == Note.g.sharp
+  /// ```
+  Note get respelledSimple =>
+      respellByAccidental(Accidental.natural) ??
+      respellByAccidental(Accidental(accidental.semitones.sign))!;
+
   /// Returns this [Note] positioned in the given [octave] as [PositionedNote].
   ///
   /// Example:

diff --git a/test/src/note/note_test.dart b/test/src/note/note_test.dart
@@ -239,6 +239,23 @@ void main() {
       });
     });
 
+    group('.respelledSimple', () {
+      test(
+        'should return this Note with the simplest Accidental spelling',
+        () {
+          expect(Note.c.respelledSimple, Note.c);
+          expect(Note.b.respelledSimple, Note.b);
+          expect(Note.d.flat.respelledSimple, Note.d.flat);
+          expect(Note.c.sharp.respelledSimple, Note.c.sharp);
+          expect(Note.e.sharp.respelledSimple, Note.f);
+          expect(Note.c.flat.respelledSimple, Note.b);
+          expect(Note.g.sharp.sharp.respelledSimple, Note.a);
+          expect(Note.a.flat.flat.flat.respelledSimple, Note.g.flat);
+          expect(Note.f.sharp.sharp.sharp.respelledSimple, Note.g.sharp);
+        },
+      );
+    });
+
     group('.circleOfFifthsDistance', () {
       test('should return the circle of fifths distance of this Note', () {
         expect(Note.f.flat.circleOfFifthsDistance, -8);