omdxp/miracle

Read Quran and Get Info about Suar and Ajzaa

miracle

Read Quran and Get Info about Suar and Ajzaa

Installation

• Install the gomodule package with:

go get -u github.com/Omar-Belghaouti/miracle

• Or import the package in your project:

import "github.com/Omar-Belghaouti/miracle"

And run:

go mod tidy

Quick Start

package main

import (
	"fmt"
	"log"

	"github.com/Omar-Belghaouti/miracle"
	"github.com/Omar-Belghaouti/miracle/ajzaa"
	"github.com/Omar-Belghaouti/miracle/suar"
)

func main() {
	quran := miracle.Book()
	quran.SetLanguage("en")

	surah, err := quran.ReadSurah(suar.AAL_IMRAN)
	if err != nil {
		log.Fatal(err.Error())
	}
	fmt.Println(surah.Name)
	for k, v := range surah.Verse {
		fmt.Printf("%s: %s\n", k, v)
	}

	juz, err := quran.GetJuzInfo(ajzaa.JUZ_19)
	if err != nil {
		log.Fatal(err.Error())
	}
	fmt.Println(juz.Start)

	surahInfo, err := quran.GetSurahInfo(suar.AL_ADIYAT)
	if err != nil {
		log.Fatal(err.Error())
	}
	fmt.Println(surahInfo.Title)
}

Documentation

Check the documentation website for more information.

miracle's Issues

Verses are out of order?

• The verses of Suar are returned as map[string]string so you can access a verse quickly (O(1)).
• Since the verses are returned as a map they may be returned out of order. Here is a workaround to get them in order:

package main

import (
	"fmt"
	"log"
	"sort"
	"strconv"
	"strings"

	"github.com/Omar-Belghaouti/miracle"
	"github.com/Omar-Belghaouti/miracle/suar"
)

func main() {
	quran := miracle.Book()

	surah, err := quran.ReadSurah(suar.NUH)
	if err != nil {
		log.Fatal(err.Error())
	}

	keys := []struct {
		key   string
		value string
	}{}
	for k, v := range surah.Verse {
		key := strings.Split(k, "verse_")[1]
		keys = append(keys, struct {
			key   string
			value string
		}{
			key:   key,
			value: v,
		})
	}
	sort.Slice(keys, func(i, j int) bool {
		left, _ := strconv.Atoi(keys[i].key)
		right, _ := strconv.Atoi(keys[j].key)
		return left < right
	})

	for _, v := range keys {
		fmt.Printf("%s: %s\n", v.key, v.value)
	}

}