Tiny update regarding drop of Author

ioanlucut · Sep 18, 2023 · c6dc387 · c6dc387
1 parent 24e5835
commit c6dc387
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 28 deletions.
diff --git a/mocks/songWithSubsections.mock.txt b/mocks/songWithSubsections.mock.txt
@@ -1,5 +1,5 @@
 [title]
-Any title {alternative: {Any other title}, author: {CustomAuthor}, contentHash: {#customHash}, id: {customId}}
+Any title {alternative: {Any other title}, composer: {CustomComposer}, contentHash: {#customHash}, id: {customId}}
 
 [sequence]
 v1.1,v1.2,c1.1,c1.2,v2.1,v2.2,c1.1,c1.2

diff --git a/src/core.spec.ts b/src/core.spec.ts
@@ -55,7 +55,7 @@ describe('core', () => {
     it('should work correctly', () => {
       expect(
         getTitleWithoutMeta(
-          'Any title {alternative: {Any other title}, author: {CustomAuthor}, contentHash: {#customHash}, id: {customId}}',
+          'Any title {alternative: {Any other title}, composer: {CustomAuthor}, contentHash: {#customHash}, id: {customId}}',
         ),
       ).toMatchInlineSnapshot(`"Any title"`);
 
@@ -69,12 +69,12 @@ describe('core', () => {
     it('should work correctly', () => {
       expect(
         getMetaSectionsFromTitle(
-          'Any title {alternative: {Any other title}, author: {CustomAuthor}, contentHash: {#customHash}, id: {customId}}',
+          'Any title {alternative: {Any other title}, composer: {CustomAuthor}, contentHash: {#customHash}, id: {customId}}',
         ),
       ).toMatchInlineSnapshot(`
         {
           "alternative": "Any other title",
-          "author": "CustomAuthor",
+          "composer": "CustomAuthor",
           "contentHash": "#customHash",
           "id": "customId",
         }

diff --git a/src/songsParser.spec.ts b/src/songsParser.spec.ts
@@ -116,7 +116,6 @@ describe('songsParser', () => {
     expect(parseSong(SONG_WITH_SUBSECTIONS_MOCK_FILE_CONTENT))
       .toMatchInlineSnapshot(`
       {
-        "author": "CustomAuthor",
         "contentHash": "#customHash",
         "id": "customId",
         "sequence": [
@@ -290,7 +289,6 @@ describe('songsParser', () => {
     expect(parseSong(SONG_WITH_SUBSECTIONS_MOCK_FILE_CONTENT))
       .toMatchInlineSnapshot(`
       {
-        "author": "CustomAuthor",
         "contentHash": "#customHash",
         "id": "customId",
         "sequence": [

diff --git a/src/songsParser.ts b/src/songsParser.ts
@@ -82,7 +82,6 @@ export const parseSong = (songContent: string): Song => {
     {
       id: metaSectionsFromTitle[SongMeta.ID],
       title: titleContent,
-      author: metaSectionsFromTitle[SongMeta.AUTHOR],
       sequence: definedSequenceWithMarkup,
       contentHash: metaSectionsFromTitle[SongMeta.CONTENT_HASH],
       verses: sections,

diff --git a/src/types.ts b/src/types.ts
@@ -1,9 +1,33 @@
 export enum SequenceChar {
+  /**
+   * Simple verse section
+   */
   VERSE = 'v',
+
+  /**
+   * Pre-chorus section
+   */
   PRECHORUS = 'p',
+
+  /**
+   * Chorus section
+   */
   CHORUS = 'c',
+
+  /**
+   * Bridge section
+   */
   BRIDGE = 'b',
+
+  /**
+   * Ending section
+   */
   ENDING = 'e',
+
+  /**
+   * Recital section
+   */
+  RECITAL = 's',
 }
 
 /**
@@ -24,9 +48,13 @@ const C_START_INDEX = 1;
 /**
  * Bridge 1 will always be 1 (cannot be just `b`, thus `b,b2`)
  */
-
 const B_START_INDEX = 1;
 
+/**
+ * Recital 1 will always be 1 (cannot be just `s`, thus `s,s2`)
+ */
+const S_START_INDEX = 1;
+
 export const SongSection = {
   SEQUENCE: '[sequence]',
   TITLE: '[title]',
@@ -54,30 +82,17 @@ export const SongSection = {
         ? `${SequenceChar.BRIDGE}${index}`
         : SequenceChar.BRIDGE
     }]`,
+  RECITAL: (index = 0) =>
+    `[${
+      index > S_START_INDEX
+        ? `${SequenceChar.RECITAL}${index}`
+        : SequenceChar.RECITAL
+    }]`,
   ENDING: `[${SequenceChar.ENDING}]`,
 };
 
 export enum SongMeta {
-  /**
-   * Alternative song title
-   */
-  ALTERNATIVE = 'alternative',
-
-  /**
-   * Song author
-   */
-  AUTHOR = 'author',
-
-  /**
-   * Song version (can be multiple / duplicated)
-   */
-  VERSION = 'version',
-
-  /**
-   * Song content hash (used to detect changes between the corrections & do partial deployments)
-   */
   CONTENT_HASH = 'contentHash',
-
   ID = 'id',
 }
 
@@ -90,6 +105,7 @@ export enum SectionGroupCategory {
   PRECHORUS = 'Prechorus',
   CHORUS = 'Chorus',
   ENDING = 'Ending',
+  RECITAL = 'Recital',
 }
 
 export type Section = {
@@ -107,7 +123,6 @@ export type Section = {
 };
 
 export type Song = {
-  author?: string;
   contentHash: string;
   id: string;
   sequence: string[];