wahy 2.0.7 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a464603f9dc3bd456c8e2abb036f8960180022f4780b55456d08bc902d509cc2
-  data.tar.gz: dc613b0c8d233033c7a4c99e16d9a1834975d74fe85c9e7118bfd1f5edaf6c57
+  metadata.gz: 2aca1516f21b9f51c8558274e8bfa5ffc4614ee20124139f759b61bffa7690bf
+  data.tar.gz: 46720531b9a2813fdd15ca874c36d3a0cf5f7e43cbe9bc7340ccae5b0f8202e9
 SHA512:
-  metadata.gz: bcd24fc1ed36354b8a39936f2eb46e0f80b6a87d8f0ee8a2104e864880d44aba011ce6482cb53fef8cc4d600140e52146f21f765ad5958cbe18c59ba10c4ffd9
-  data.tar.gz: 8b830196da3e6fb84894355832b156f28f760c5ffad428c722979ec8d80a07a547b636aa10d821261740e0bd0ed2c00408afa889151a887f224390a42ba39187
+  metadata.gz: f6aae9f1643c2cd1ef6d1b43d6ed9c5cea43b1db18d1cecb8fefdb14dd2e67e13c915ed43817153bff1548d4683eea714a70199b121126c85b820a921e901c78
+  data.tar.gz: a233314dcdb19df9d1765d501d6f80abac8712c8c799f62edc966d7704129abaac178ad15f7a591d1283bf3571106f97c1e64ae4d653f477c11d84caa3c32069

data/README.md

@@ -2,17 +2,23 @@
 
 Wahy is a powerful Ruby-based tool designed to query, read, and display Quran chapters and verses directly from your terminal. It offers a clean, colorized CLI interface for quick lookup and a modular structure that allows you to use it as a library (API) in your own Ruby projects.
 
+Whether you want to browse a specific chapter, search for a verse by name or number, or programmatically access Quranic text in English (Yusuf Ali) or Turkish (Elmalılı Hamdi Yazır) translations, Wahy provides a fast and intuitive way to interact with the full 114-chapter Quran.
+
 ## Features
 
 - **Dual Language Support:** Easily query and read verses in Turkish (`tur`) or English (`eng`).
 - **Flexible Queries:** Search chapters by their number (e.g., `2`) or their names (e.g., `"Bakara"` or `"The Cow"`).
+- **Chapter Count Validation:** CLI now validates that chapter numbers are within the valid range (1–114) and shows an error for out-of-range inputs.
+- **Ayah Count Warnings:** When an invalid verse number is provided, the error message now includes the total verse count and valid range for that chapter (e.g., `"This chapter has 7 ayah(s). Valid range: 1–7."`).
 - **Verse Filtering:** Retrieve an entire chapter or a specific verse (e.g., `-a 5`) with ease.
 - **Colorized Terminal UI:** Optimized reading experience with automatic text centering and highlighted verse indicators.
 - **Modular Library:** Easily integrate the data parsing logic into other Ruby applications.
+- **Chapter Name Lists:** Query all chapter names as arrays via `Wahy.en_chapters` and `Wahy.tur_chapters`.
+- **Ayah Count API:** Look up the number of verses in any chapter via `Wahy.ayah_count`.
 
 ## Prerequisites
 
-- Ruby 2.5 or higher
+- Ruby 4.0.2 or higher
 - The project expects XML data files to be located in the `lib/wahy/data/` directory:
     - `config_en.xml`
     - `config_tr.xml`
@@ -53,6 +59,7 @@ You can use the wahy command directly in your terminal. By default, it displays
 | `-s` | `--scripture` | Chapter name or number (1-114) | `1` |
 | `-a` | `--ayah` | Specific verse number or 'all' | `all` |
 | - | `--list-chapters` | List all chapters in a clean table format | - |
+| `-v` | `--version` | Show version | - |
 | `-h` | `--help` | Show help menu | - |
 
 Examples
@@ -87,15 +94,33 @@ wahy --list-chapters
 # List all chapters in Turkish
 wahy --list-chapters -l tur
 ```
+
+### CLI Validation
+
+The CLI provides helpful error messages for invalid inputs:
+
+**Out-of-range chapter numbers:**
+
+```bash
+$ wahy -s 0
+Error: Chapter number must be between 1 and 114. Got 0.
+
+$ wahy -s 200
+Error: Chapter number must be between 1 and 114. Got 200.
+```
+
+**Invalid verse numbers:**
+
+```bash
+$ wahy -s 1 -a 10
+Error: Ayah #10 not found in Chapter 1 (The Opening).
+This chapter has 7 ayah(s). Valid range: 1–7.
+```
+
 ## Listing Chapters (`--list-chapters`)
 
 The `--list-chapters` feature acts as an interactive built-in index for the Quranic data files. It provides users with a clean, well-aligned terminal table showing the exact `ID` and `Chapter Name` mappings for the selected language.
 
-### Key Benefits:
-1. **Dynamic Language Switch:** Specifying `-l 'tur'` or `-l 'eng'` alongside `--list-chapters` automatically switches the content of the index table to that specific translation file.
-2. **Short-Circuit Execution:** When this flag is triggered, the program instantly renders the table and exits securely, avoiding any unnecessary XML traversing or verse filtering overhead.
-3. **Formatted UI Output:** Utilizing explicit string formatting rules ensures that all tabular column lines down the terminal remain perfectly aligned regardless of varying chapter name lengths.
-
 ### Example Output:
 ```text
 ==================================================
@@ -138,7 +163,23 @@ signs = Wahy.sign_data the_opening
 
 # 5. Get a specific sign
 sign_two = Wahy.take_specific_sign signs, 1
+
+# 6. Get all chapter names as arrays
+en_chapters = Wahy.en_chapters   # → ["The Opening", "The Cow", ...]
+tur_chapters = Wahy.tur_chapters # → ["Fatiha", "Bakara", ...]
+
+# 7. Get the number of ayahs in a chapter
+ayah_count = Wahy.ayah_count(1)        # → 7
+ayah_count = Wahy.ayah_count("Fatiha") # → 7
+ayah_count = Wahy.ayah_count(999)      # → 0 (unknown chapter)
 ```
 ## License
 
 This project is licensed under the MIT License.
+
+```text
+**Gem includes two XML data**
+English Quran Tranlation(/lib/data/config_en.xml): Written by Yusuf Ali
+Turkish Quran Tranlation(/lib/data/config_tr.xml): Written by Elmalılı Hamdi Yazır
+Special Thanks to: http://www.qurandatabase.org/Database.aspx
+```

data/lib/wahy/cli.rb

@@ -4,12 +4,13 @@ require 'colorize'
 
 module Wahy
   class CLI
+
     def self.start(args)
       options = {
         lang: 'eng',
         scripture: '1',
         ayah: 'all',
-        list_chapters: false # Yeni: Listeleme seçeneği varsayılan olarak kapalı
+        list_chapters: false
       }
 
       opt_parser = OptionParser.new do |opts|
@@ -27,11 +28,15 @@ module Wahy
           options[:ayah] = a
         end
 
-        # Yeni: Sadece sureleri listelemek için argüman
         opts.on("--list-chapters", "List all chapters in a table format for the selected language") do
           options[:list_chapters] = true
         end
 
+        opts.on("-v", "--version", "Prints the current version") do
+          puts "wahy version #{Wahy::VERSION}"
+          exit
+        end
+
         opts.on("-h", "--help", "Prints this help menu") do
           puts opts
           exit
@@ -59,14 +64,24 @@ module Wahy
 
       quran = Wahy.chapters_data(data)
 
-      # Eğer list-chapters bayrağı tetiklendiyse, tabloyu çiz ve programı sonlandır
       if options[:list_chapters]
         display_chapter_list(quran, options[:lang])
         exit
       end
 
-      # Listeleme istenmediyse normal okuma akışına devam et
-      chapter_node = Wahy.scripture_data(quran, options[:scripture])
+      scripture_input = options[:scripture].to_s
+
+      # Check chapter number range for numeric input
+      if scripture_input =~ /^\d+$/
+        chapter_num = scripture_input.to_i
+        if chapter_num < 1 || chapter_num > 114
+          puts "Error: Chapter number must be between 1 and 114. Got #{chapter_num}.".red
+          exit 1
+        end
+      end
+
+      scripture_id = options[:scripture]
+      chapter_node = Wahy.scripture_data(quran, scripture_id)
 
       unless chapter_node
         puts "Error: Scripture '#{options[:scripture]}' could not be found.".red
@@ -76,17 +91,19 @@ module Wahy
       chapter_id = chapter_node['ChapterID']
       chapter_name = chapter_node['ChapterName']
       verses = chapter_node.xpath('Verse')
+      total_verses = verses.length
 
       selected_verses = []
       if options[:ayah].to_s.downcase == 'all'
         selected_verses = verses
       else
-        target_ayah = options[:ayah].to_s
-        match = verses.find { |v| v['VerseID'] == target_ayah }
+        target_ayah = options[:ayah].to_i
+        match = verses.find { |v| v['VerseID'] == target_ayah.to_s }
         if match
           selected_verses = [match]
         else
           puts "Error: Ayah ##{target_ayah} not found in Chapter #{chapter_id} (#{chapter_name}).".red
+          puts "This chapter has #{total_verses} ayah(s). Valid range: 1-#{total_verses}.".red
           exit 1
         end
       end
@@ -109,7 +126,6 @@ module Wahy
       puts "=" * terminal_width
     end
 
-    # Yeni: Sureleri tablo halinde terminale basan yardımcı metod
     def self.display_chapter_list(chapters, lang)
       lang_display = lang.to_s.downcase.start_with?('t') ? "TURKISH" : "ENGLISH"
 
@@ -117,14 +133,12 @@ module Wahy
       puts " QURAN CHAPTERS (#{lang_display}) ".center(50).cyan.bold
       puts "=" * 50
 
-      # Sütun başlıkları: Sola dayalı 10 karakter ID, sola dayalı 35 karakter İsim
       puts sprintf("%-10s | %-35s", "ID", "CHAPTER NAME").yellow.bold
       puts "-" * 50
 
       chapters.each do |c|
         id = c['ChapterID']
         name = c['ChapterName']
-        # Sütun verilerini hizalayarak yazdır
         puts sprintf("%-10s | %-35s", id, name)
       end
 

data/lib/wahy/parser.rb

@@ -52,5 +52,40 @@ module Wahy
     def take_specific_sign(signs, verse_number)
       signs.find { |verse| verse["VerseID"] == verse_number.to_s }
     end
+
+    # Returns an array of chapter names from a parsed document
+    # @param doc [Nokogiri::XML::Document]
+    def chapter_names(doc)
+      doc.xpath("//Chapter").map { |c| c["ChapterName"] }
+    end
+
+    # Returns the number of ayahs (verses) in a chapter
+    # @param identifier [String, Integer] Chapter ID or name
+    # @return [Integer]
+    def ayah_count(identifier)
+      doc = new_data("eng")
+      chapters = doc.xpath("//Chapter")
+      chapter = if identifier.to_s =~ /^\d+$/
+                  chapters.find { |c| c["ChapterID"] == identifier.to_s }
+                else
+                  chapters.find { |c| c["ChapterName"].downcase == identifier.downcase }
+                end
+      return 0 unless chapter
+      chapter.xpath("Verse").count
+    end
+
+    # Returns an array of English chapter names
+    # @return [Array<String>]
+    def en_chapters
+      doc = new_data("eng")
+      chapter_names(doc)
+    end
+
+    # Returns an array of Turkish chapter names
+    # @return [Array<String>]
+    def tur_chapters
+      doc = new_data("tur")
+      chapter_names(doc)
+    end
   end
 end

data/lib/wahy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wahy
-  VERSION = "2.0.7"
+  VERSION = "2.0.9"
 end

data/sig/wahy.rbs

@@ -1,4 +1,15 @@
 module Wahy
   VERSION: String
+
   # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  new_data(lang: String) Nokogiri::XML::Document
+  chapters_data(doc: Nokogiri::XML::Document) Nokogiri::XML::NodeSet
+  scripture_data(chapters: Nokogiri::XML::NodeSet, identifier: String) Nokogiri::XML::Node?
+  sign_data(chapter: Nokogiri::XML::Node) Array[Nokogiri::XML::Node]
+  take_specific_sign(signs: Array[Nokogiri::XML::Node], verse_number: String) Nokogiri::XML::Node?
+  chapter_names(doc: Nokogiri::XML::Document) Array[String]
+  en_chapters() Array[String]
+  tur_chapters() Array[String]
+  ayah_count(identifier: String) Integer
 end

data/wahy.gemspec

@@ -8,8 +8,14 @@ Gem::Specification.new do |spec|
   spec.authors = ["cptangry"]
   spec.email = ["caglar.gokhan@gmail.com"]
 
-  spec.summary       = "A CLI tool and library to query the Holy Quran in TR/ENG."
-  spec.description   = "Query and read the Holy Quran chapters and verses in the terminal with colored output. Includes both English and Turkish support."
+  spec.summary       = "Query the Quran in your terminal with colorized output and a Ruby library API."
+  spec.description   = <<~DESC
+    Wahy is a CLI tool and Ruby library for querying the Holy Quran's 114 chapters
+    and verses. Browse chapters by name or number, filter specific ayahs, and
+    display results with colorized terminal output. Supports English (Yusuf Ali)
+    and Turkish (Elmalılı Hamdi Yazır) translations. Also usable as a library to
+    programmatically access chapter names, verse counts, and parsed Quranic data.
+  DESC
   spec.homepage      = "https://github.com/cptangry/wahy"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 4.0.2"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wahy
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.9
 platform: ruby
 authors:
 - cptangry
@@ -79,8 +79,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
-description: Query and read the Holy Quran chapters and verses in the terminal with
-  colored output. Includes both English and Turkish support.
+description: |
+  Wahy is a CLI tool and Ruby library for querying the Holy Quran's 114 chapters
+  and verses. Browse chapters by name or number, filter specific ayahs, and
+  display results with colorized terminal output. Supports English (Yusuf Ali)
+  and Turkish (Elmalılı Hamdi Yazır) translations. Also usable as a library to
+  programmatically access chapter names, verse counts, and parsed Quranic data.
 email:
 - caglar.gokhan@gmail.com
 executables:
@@ -124,5 +128,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.6
 specification_version: 4
-summary: A CLI tool and library to query the Holy Quran in TR/ENG.
+summary: Query the Quran in your terminal with colorized output and a Ruby library
+  API.
 test_files: []