refactoring

components/library/LibraryPage.ts

@@ -1,10 +1,15 @@
 import { Page } from '@playwright/test'
 import { testId } from '@utils/testId'
+import { VerseDetailsPage } from './VerseDetailsPage'
 
 
 export class LibraryPage {
   constructor(private readonly page: Page) {}
 
+  get verseDetails() {
+    return new VerseDetailsPage(this.page)
+  }
+
   get searchbar() {
     return this.page.getByPlaceholder('Search')
   }

components/shared/Application.ts

@@ -1,5 +1,5 @@
 import { InboxDeckPage, ReviewDeckPage } from '@components/decks'
-import { LibraryPage, VerseDetailsPage } from '@components/library'
+import { LibraryPage } from '@components/library'
 import { TabsBar } from '@components/shared'
 import { TutorialOverlay } from '@components/tutorial'
 import { Page } from '@playwright/test'
@@ -15,7 +15,6 @@ export interface ApplicationParams {
 
 export class Application {
   public readonly library: LibraryPage
-  public readonly verseDetails: VerseDetailsPage
   public readonly tabs: TabsBar
   public readonly inboxDeck: InboxDeckPage
   public readonly reviewDeck: ReviewDeckPage
@@ -25,7 +24,6 @@ export class Application {
     public readonly page: Page
   ) {
     this.library = new LibraryPage(page)
-    this.verseDetails = new VerseDetailsPage(page)
     this.inboxDeck = new InboxDeckPage(page)
     this.tabs = new TabsBar(page)
     this.reviewDeck = new ReviewDeckPage(page)

scenarios/library.ts

@@ -2,6 +2,6 @@ import { Application } from "@components/shared"
 
 export async function addVerseToInbox(app: Application, verse: string) {
   await app.library.verse(verse).click()
-  await app.verseDetails.addButton.click()
-  await app.verseDetails.addButton.waitFor({ state: 'detached' })
+  await app.library.verseDetails.addButton.click()
+  await app.library.verseDetails.addButton.waitFor({ state: 'detached' })
 }

tests/inbox/InboxDeck.SwipeCards.spec.ts

@@ -13,48 +13,80 @@ test.describe('Inbox Deck › Swipe Cards', () => {
     await app.tabs.inboxTab.click()
   })
 
+
+  /**
+   * Swiping a card left should put a card at the end of the inbox deck
+   */
   test('Swipe card left', async () => {
     await app.inboxDeck.swipeCardLeft()
 
-    await expect(app.inboxDeck.getCard('BG 1.1', 'Text')).toHaveAttribute('data-index', '0')
-    await expect(app.inboxDeck.getCard('BG 1.1', 'Translation')).toHaveAttribute('data-index', '1')
-    await expect(app.tabs.inboxBadge).toContainText('2')
+    await expect(app.inboxDeck.getCard('BG 1.1', 'Text'))
+      .toHaveAttribute('data-index', '0')
+    await expect(app.inboxDeck.getCard('BG 1.1', 'Translation'))
+      .toHaveAttribute('data-index', '1')
+    await expect(app.tabs.inboxBadge) // No card removed from the inbox
+      .toContainText('2')
   })
 
-  test('Cycle swipe card left', async () => {
+
+  /**
+   * Changing cards in the inbox deck must be looped
+   */
+  test('Swipe cards in the loop', async () => {
     await app.inboxDeck.swipeCardLeft()
     await app.inboxDeck.swipeCardLeft()
 
-    await expect(app.inboxDeck.getCard('BG 1.1', 'Translation')).toHaveAttribute('data-index', '0')
-    await expect(app.inboxDeck.getCard('BG 1.1', 'Text')).toHaveAttribute('data-index', '1')
+    await expect(app.inboxDeck.getCard('BG 1.1', 'Translation'))
+      .toHaveAttribute('data-index', '0')
+    await expect(app.inboxDeck.getCard('BG 1.1', 'Text'))
+      .toHaveAttribute('data-index', '1')
   })
 
+
+  /**
+   * Swiping a card up should remove a card from the inbox deck
+   */
   test('Swipe card up', async () => {
     await app.inboxDeck.swipeCardUp()
 
     await expect(app.tabs.inboxBadge).toContainText('1')
   })
 
-  test('Review badge', async () => {
+
+  /**
+   * If the card has been memorized, a “Review” badge should appear
+   * next to the verse number in the library
+   */
+  test('Memorize card', async () => {
     await app.inboxDeck.swipeCardUp()
     await app.tabs.libraryTab.click()
     await expect(app.library.verseBadge('BG 1.1')).toHaveText('Review')
   })
 
-  test('Swipe all cards up', async () => {
+
+  /**
+   * If user memorized all cards then:
+   * 1. The badge with the number of cards in the inbox deck should disappear
+   * 2. The "Inbox is empty" message should be visible
+   */
+  test('Memorize all cards', async () => {
     await app.inboxDeck.swipeCardUp()
     await app.inboxDeck.swipeCardUp()
 
     await expect(app.inboxDeck.inboxEmpty).toBeVisible()
     await expect(app.tabs.inboxBadge).toBeHidden()
   })
 
+
+  /**
+   * To swipe the card up, the user needs to move it a sufficient distance
+   */
   test('Move card up', async () => {
     const distances = [40, 60, 120]
 
     for (const distance of distances) {
       await app.inboxDeck.swipeCardUp(distance, 25)
-      await expect(app.tabs.inboxBadge).toContainText('2')
+      await expect(app.tabs.inboxBadge).toContainText('2') // No, the card is not swiped up yet
     }
   })
 })

tests/inbox/InboxDeck.spec.ts

@@ -10,6 +10,9 @@ test.describe('Inbox Deck', () => {
     await app.open()
   })
 
+  /**
+   * "Inbox is empty" message should be visible when there are cards in the inbox.
+   */
   test('Inbox is empty', async () => {
     await app.tabs.inboxTab.click()
     await expect(app.tabs.inboxEmpty).toBeVisible()

tests/library/AddVerseToInbox.spec.ts

@@ -14,34 +14,30 @@ test.describe('Library › Add verse to Inbox', () => {
     await app.open()
   })
 
-  test.afterEach(async ({ page }) => {
-    await page.close()
-  })
-
 
   /* -------------------------------------------------------------------------- */
   /*                                    Tests                                   */
   /* -------------------------------------------------------------------------- */
 
   test('Add verse to the Inbox deck', async () => {
     await app.library.verse('BG 1.1').click()
-    await app.verseDetails.addButton.click()
+    await app.library.verseDetails.addButton.click()
 
     await expect(app.library.verseBadge('BG 1.1')).toContainText('Inbox')
     await expect(app.tabs.inboxBadge).toContainText('2')
   })
 
   test('Add button is disabled if verse has already been added', async () => {
     await app.library.verse('BG 1.1').click()
-    await app.verseDetails.addButton.click()
+    await app.library.verseDetails.addButton.click()
     await app.library.verse('BG 1.1').click()
 
-    await expect(app.verseDetails.addButton).toBeDisabled()
+    await expect(app.library.verseDetails.addButton).toBeDisabled()
   })
 
   test('Back returns to app.library', async () => {
     await app.library.verse('BG 1.1').click()
-    await app.verseDetails.backButton.click()
+    await app.library.verseDetails.backButton.click()
 
     await expect(app.library.searchbar).toBeVisible()
   })

tests/library/SearchVerses.Language.spec.ts

@@ -17,10 +17,6 @@ test.describe('Library › Search › Change language', () => {
     await changeLanguage(app, 'Русский')
   })
 
-  test.afterEach(async ({ page }) => {
-    page.close()
-  })
-
 
   /* -------------------------------------------------------------------------- */
   /*                                    Tests                                   */

tests/library/SearchVerses.spec.ts

@@ -14,11 +14,6 @@ test.describe('Library › Search', () => {
     await app.open()
   })
 
-  test.afterEach(async ({ page }) => {
-    page.close()
-  })
-
-
   /* -------------------------------------------------------------------------- */
   /*                                    Tests                                   */
   /* -------------------------------------------------------------------------- */

tests/tutorial/Tutorial.Full.spec.ts

@@ -14,7 +14,7 @@ test.describe('Tutorial :: Full', () => {
 
     await app.tutorial.card(2).waitFor()
     await app.library.verse("BG 1.1").click()
-    await app.verseDetails.addButton.click()
+    await app.library.verseDetails.addButton.click()
     await app.tabs.inboxTab.click()
 
     await app.tutorial.card(6).waitFor()

tests/tutorial/Tutorial.Library.spec.ts

@@ -27,6 +27,6 @@ test.describe('Tutorial :: Library', () => {
    */
   test('Do not allow to open any verse but BG 1.1', async () => {
     await app.library.verse("BG 2.13").click()
-    await expect(app.verseDetails.addButton).not.toBeVisible()
+    await expect(app.library.verseDetails.addButton).not.toBeVisible()
   })
 })