feat: Add rukus to meta

Author: husayt

src/getAyahMeta.ts

@@ -24,21 +24,27 @@ export function getAyahMeta(ayahId: AyahId): AyahMeta {
   const quarterData = getRubAlHizbMetaByAyahId(ayahId)
   const [surah, ayah] = findSurahAyahByAyahId(ayahId)
   const page: Page = findPagebyAyahId(ayahId)
-  const isSajdahAyah = SajdaList.some(([sajdaAyahId]) => sajdaAyahId === ayahId)
+
+  // const isSajdahAyah = SajdaList.some(([sajdaAyahId]) => sajdaAyahId === ayahId)
+  const isSajdahAyah = binarySearch(SajdaList, ayahId, (a, b) => a - b[0]) >= 0
+
+  const rk = binarySearch(RukuList, ayahId)
+  const isStartOfRuku = rk > 0
+  const ruku = isStartOfRuku ? rk : -rk - 2
+
   const isStartOfSurah = SurahList[surah][0] === ayahId
   const isStartOfPage = PageList[page] === ayahId
-  // const isStartOfRuku = RukuList[page] === ayahId
   const isStartOfJuz = JuzList[quarterData.juz] === ayahId
   const isStartOfQuarter = HizbQuarterList[quarterData.rubAlHizbId] === ayahId
   const isEndOfSurah = SurahList[surah + 1][0] - 1 === ayahId
   const isEndOfPage = PageList[page + 1] - 1 === ayahId
   const isEndOfJuz = JuzList[quarterData.juz + 1] - 1 === ayahId
-  const isEndOfRuku = JuzList[quarterData.juz + 1] - 1 === ayahId
+  const isEndOfRuku = binarySearch(RukuList, ayahId + 1) > 0
   const isEndOfQuarter = HizbQuarterList[quarterData.rubAlHizbId + 1] - 1 === ayahId
 
   return {
     ...quarterData, surah, ayah, page, isStartOfQuarter,
-    isEndOfQuarter, isSajdahAyah, isStartOfPage, isEndOfPage,
-    isStartOfJuz, isEndOfJuz, isStartOfSurah, isEndOfSurah
+    isEndOfQuarter, isSajdahAyah, isStartOfPage, isEndOfPage, ruku,
+    isStartOfJuz, isEndOfJuz, isStartOfSurah, isEndOfSurah, isStartOfRuku, isEndOfRuku
   }
 }

src/getAyahMetasForSurah.ts

@@ -2,6 +2,7 @@ import { getAyahMeta } from "./getAyahMeta"
 import { HizbQuarterList } from "./lists/hizbQuarterList"
 import { JuzList } from "./lists/juzList"
 import { PageList } from "./lists/pageList"
+import { RukuList } from "./lists/rukuList"
 import { SajdaList } from "./lists/sajdaList"
 import { SurahList } from "./lists/surahList"
 import { Surah, AyahMeta, AyahId, JuzPart } from "./types"
@@ -40,6 +41,13 @@ export function getAyahMetasForSurah(surahNumber: Surah): AyahMeta[] {
       else { meta.isStartOfPage = false }
       meta.isEndOfPage = PageList[meta.page + 1] === ayahId + 1
 
+      if (RukuList[meta.ruku + 1] === ayahId) {
+        meta.ruku += 1
+        meta.isStartOfRuku = true
+      }
+      else { meta.isStartOfRuku = false }
+      meta.isEndOfRuku = RukuList[meta.ruku + 1] === ayahId + 1
+
       meta.isEndOfJuz = JuzList[meta.juz + 1] === ayahId + 1
       if (JuzList[meta.juz + 1] === ayahId) {
         meta.juz += 1

src/types.ts

@@ -136,7 +136,7 @@ export type AyahMeta = {
   hizbId: HizbId
   rubAlHizbId: RubAlHizbId
   page: Page
-  // rub: number
+  ruku: number
   surah: Surah
   ayah: AyahNo
   isStartOfQuarter: boolean
@@ -148,4 +148,6 @@ export type AyahMeta = {
   isEndOfJuz: boolean
   isStartOfSurah: boolean
   isEndOfSurah: boolean
+  isStartOfRuku: boolean
+  isEndOfRuku: boolean
 }

src/utils.ts

@@ -9,8 +9,8 @@
 export function binarySearch<T, X>(
   ar: Array<T>,
   el: X,
-  compare_fn: (a: X, b: T) => number = (a, b) => a as number - (b as number)
-): number | -1 {
+  compare_fn: (a: X, b: T) => number = (a, b) => (a as number) - (b as number)
+): number {
   let m = 0
   let n = ar.length - 1
   while (m <= n) {

tests/getAyahMeta.spec.ts

@@ -1,4 +1,4 @@
-import { getAyahMeta, meta } from "../src"
+import { getAyahMeta, meta, RukuList } from "../src"
 
 describe("ayahMeta", () => {
   it("should return correct metadata for the first ayah", () => {
@@ -12,6 +12,9 @@ describe("ayahMeta", () => {
     expect(result.isEndOfJuz).toBeFalsy()
     expect(result.isEndOfQuarter).toBeFalsy()
     expect(result.isSajdahAyah).toBeFalsy()
+    expect(result.isEndOfRuku).toBeFalsy()
+    expect(result.isStartOfRuku).toBeTruthy()
+    expect(result.ruku).toBe(1)
   })
 
   it("should return correct metadata for the 7th ayah", () => {
@@ -23,6 +26,9 @@ describe("ayahMeta", () => {
     expect(result.isEndOfPage).toBeTruthy()
     expect(result.isEndOfJuz).toBeFalsy()
     expect(result.isSajdahAyah).toBeFalsy()
+    expect(result.isStartOfRuku).toBeFalsy()
+    expect(result.isEndOfRuku).toBeTruthy()
+    expect(result.ruku).toBe(1)
   })
 
   it("should return correct metadata for the 8th ayah", () => {
@@ -33,7 +39,36 @@ describe("ayahMeta", () => {
     expect(result.isEndOfSurah).toBeFalsy()
     expect(result.isEndOfPage).toBeFalsy()
     expect(result.isEndOfJuz).toBeFalsy()
+    expect(result.isEndOfRuku).toBeFalsy()
+    expect(result.isStartOfRuku).toBeTruthy()
+    expect(result.ruku).toBe(2)
+    expect(result.isSajdahAyah).toBeFalsy()
+  })
 
+  it("should return correct metadata for the 14th ayah", () => {
+    const result = getAyahMeta(14)
+    expect(result.isStartOfSurah).toBeFalsy()
+    // expect(result.isStartOfPage).toBeTruthy()
+    expect(result.isStartOfJuz).toBeFalsy()
+    expect(result.isEndOfSurah).toBeFalsy()
+    expect(result.isEndOfPage).toBeFalsy()
+    expect(result.isEndOfJuz).toBeFalsy()
+    expect(result.isEndOfRuku).toBeTruthy()
+    expect(result.isStartOfRuku).toBeFalsy()
+    expect(result.ruku).toBe(2)
+    expect(result.isSajdahAyah).toBeFalsy()
+  })
+  it("should return correct metadata for the 15th ayah", () => {
+    const result = getAyahMeta(15)
+    expect(result.isStartOfSurah).toBeFalsy()
+    // expect(result.isStartOfPage).toBeTruthy()
+    expect(result.isStartOfJuz).toBeFalsy()
+    expect(result.isEndOfSurah).toBeFalsy()
+    expect(result.isEndOfPage).toBeFalsy()
+    expect(result.isEndOfJuz).toBeFalsy()
+    expect(result.isEndOfRuku).toBeFalsy()
+    expect(result.isStartOfRuku).toBeTruthy()
+    expect(result.ruku).toBe(3)
     expect(result.isSajdahAyah).toBeFalsy()
   })
 
@@ -46,16 +81,19 @@ describe("ayahMeta", () => {
     expect(result.isEndOfPage).toBeTruthy()
     expect(result.isEndOfJuz).toBeTruthy()
     expect(result.isSajdahAyah).toBeFalsy()
+    expect(result.isEndOfRuku).toBeTruthy()
+    expect(result.isEndOfQuarter).toBeTruthy()
+    expect(result.ruku).toBe(meta.numRukus)
   })
 
   it("1160 is SajdahAyah", () => {
     const result = getAyahMeta(1160)
     expect(result.isSajdahAyah).toBeTruthy()
   })
 
-  it("1160 is SajdahAyah", () => {
-    const result = getAyahMeta(1160)
-    expect(result.isSajdahAyah).toBeTruthy()
+  it("1161 is not SajdahAyah", () => {
+    const result = getAyahMeta(1161)
+    expect(result.isSajdahAyah).toBeFalsy()
   })
 
   it("should throw RangeError for ayah number below 1", () => {
@@ -65,4 +103,13 @@ describe("ayahMeta", () => {
   it("should throw RangeError for ayah number above numAyahs", () => {
     expect(() => getAyahMeta(meta.numAyahs + 1)).toThrow(RangeError)
   })
+
+
+  it("should return correct metadata for ayah 6235", () => {
+    const result = getAyahMeta(6235)
+    expect(result.isStartOfRuku).toBeFalsy()
+    expect(result.isEndOfRuku).toBeFalsy()
+    expect(result.isEndOfQuarter).toBeFalsy()
+    expect(result.ruku).toBe(meta.numRukus)
+  })
 })