quran-audio 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd6892ac4ea40e4ceedcf5596e92bb06bcd578db055b16acf793cec19dca277f
-  data.tar.gz: 942914a841bd747cbcd11fd8af1666aef716d48996789438acac8b5cbdd08cb9
+  metadata.gz: b9d4aa2977f958be7f3d1544b0cefa0141a464886fbcc6681390735b1af33083
+  data.tar.gz: 467c4a4f34baf890df84fce649122fb3fca2bb483c399ee831fdb7e699b43b9b
 SHA512:
-  metadata.gz: b732e4378bf21f7d7341f68db747e2fae0dcee83ad7d0b5235b602ab3a7439daa6f1311b0d1a0f7a6a19ca2537fff21280d58ee9d5c881c7ae11f5aabd94628a
-  data.tar.gz: 77b4d19899be0bc4041a4d087fcad940a5e624f64559fe0ae024009378f1b7cb5d4579eb6446038f31bd4e41cadf7388101ff15deab3f0eb1cee42d74f8406a7
+  metadata.gz: 00c1fef420cf3fb24b2130c04da9b8c8032f8cb101089d4f430fb1a3029e869d0359aa20e7e650f9c2b0ce3f52c09e28399710bb62cb33a246a5c99efec1dab5
+  data.tar.gz: 0c7ab62d560a4b775edfdbb596cffffa8163de8137133b84e826fd647f7654316d659490cc11c339715a8ac11e0f1f11703c1a1d5010606d23fdc873e1dca5de

data/README.md

@@ -19,15 +19,14 @@ An example path:
 * **~/.local/share/quran-audio/mp3/yassin/** <br>
   Contains recitations by Sahl Yassin
 
-## Usage
+## Install
 
-    # Clone
-    git clone https://github.com/ReflectsLight/quran-audio
-    cd quran-audio
+quran-audio is available via rubygems.org:
 
-    # Install
-    gem install quran-audio
-    quran-audio --help
+    user@localhost$ gem install quran-audio
+    user@localhost$ quran-audio --help
+    user@localhost$ quran-audio ls --help
+    user@localhost$ quran-audio pull --help
 
 ## Thanks
 

data/lib/quran/audio/command/ls.rb

@@ -3,19 +3,19 @@
 module Quran::Audio
   class Command::Ls < Command
     set_banner usage: "quran-audio ls [OPTIONS]",
-               description: "List reciters"
+               description: "List recitations"
 
     def run
-      authors  = Ryo.from_json(path: File.join(dir.datadir, "authors.json"))
-      template = File.binread(File.join(dir.datadir, "erb", "author.txt.erb"))
-      render(authors, template)
+      recitations = Ryo.from_json(path: File.join(dir.datadir, "recitations.json"))
+      template = File.binread(File.join(dir.datadir, "erb", "recitation.erb"))
+      render(recitations, template)
     end
 
     private
 
-    def render(authors, template)
-      puts Ryo.each(authors).map { |switch, author|
-        ERB.new(template).result_with_hash({switch:, author: Ryo(author)})
+    def render(recitations, template)
+      puts Ryo.each(recitations).map { |switch, recitation|
+        ERB.new(template).result_with_hash({switch:, recitation: Ryo(recitation)})
       }.join("\n")
     end
   end

data/lib/quran/audio/command/pull.rb

@@ -4,26 +4,23 @@ module Quran::Audio
   class Command::Pull < Command
     set_banner usage: "quran-audio pull [OPTIONS]",
                description: "Pull MP3 files from everyayah.com"
-    set_option "-a AUTHOR", "--author AUTHOR", "An author's name"
+    set_option "-r RECITATION", "--recitation RECITATION", "A recitation's name", default: "alafasy"
     set_option "-b BITRATE", "--bitrate BITRATE", "MP3 bitrate"
-    set_option "-s NUMBERS", "--surahs NUMBERS", "Comma-separated list of surah IDs", as: Array
-    set_option "-d SECONDS", "--delay", "Delay between requests, in seconds", as: Float
-    set_default author: "alafasy", surahs: (1..114).to_a, delay: 0.5
-
-    attr_reader :http
+    set_option "-s NUMBERS", "--surahs NUMBERS", "Comma-separated list of surah IDs", as: Array, default: (1..114)
+    set_option "-d SECONDS", "--delay", "Delay between requests, in seconds", as: Float, default: 0.5
 
     def initialize(...)
       super
       @http = Net::HTTP.new("everyayah.com", 443).tap { _1.use_ssl = true }
-      @surah_length = Ryo.from_json(path: File.join(dir.datadir, "surah_length.json"))
     end
 
     def run
+      summary(recitations[recitation])
       surahs.each do |surah|
-        1.upto(surah_length(surah)) do |ayah|
-          mp3 = MP3.new(author:, surah:, ayah:, bitrate:)
-          pull(mp3, options.delay) unless File.exist?(mp3.local_path)
-          percent = sprintf("%.2f", (ayah / surah_length(surah).to_f) * 100)
+        1.upto(sizeof[surah]) do |ayah|
+          mp3 = MP3.new(recitation:, surah:, ayah:, bitrate:)
+          pull(mp3, delay) unless File.exist?(mp3.local_path)
+          percent = sprintf("%.2f", (ayah / sizeof[surah].to_f) * 100)
           line.rewind.print "Surah #{surah} [#{percent}%]"
         end
         line.end
@@ -32,6 +29,8 @@ module Quran::Audio
 
     private
 
+    attr_reader :http
+
     def pull(mp3, delay, interrupt: false)
       res = http.get(mp3.remote_path)
       write(mp3, res, interrupt:)
@@ -55,8 +54,20 @@ module Quran::Audio
       end
     end
 
-    def surah_length(surah)
-      @surah_length[surah.to_s]
+    def summary(r)
+      line
+        .rewind
+        .print("Recitation".ljust(12), r.name).end
+        .print("Directory".ljust(12), format(r.dest_dir, sharedir: dir.sharedir))
+        .end.end
+    end
+
+    def sizeof
+      @sizeof ||= Ryo.from_json(path: File.join(dir.datadir, "sizeof.json"))
+    end
+
+    def recitations
+      @recitations ||= Ryo.from_json(path: File.join(dir.datadir, "recitations.json"))
     end
   end
 end

data/lib/quran/audio/mp3.rb

@@ -1,23 +1,36 @@
 # frozen_string_literal: true
 
 module Quran::Audio
-  class MP3 < Struct.new(:author, :surah, :ayah, :bitrate, keyword_init: true)
-    def initialize(author:, **kw)
-      super(author: authors[author], **kw)
+  ##
+  # {Quran::Audio::MP3 Quran::Audio::MP3} provides
+  # an abstract interface around an MP3 file, and
+  # within the context of the quran-audio project.
+  class MP3 < Struct.new(:recitation, :surah, :ayah, :bitrate, keyword_init: true)
+    def initialize(recitation:, **kw)
+      super(recitation: recitations[recitation], **kw)
     end
 
+    ##
+    # @return [String]
+    #  Returns the bitrate of an MP3 file
     def bitrate
-      super || author.default_bitrate
+      super || recitation.default_bitrate
     end
 
+    ##
+    # @return [String]
+    #  Returns the path to an MP3 file on a remote HTTP server
     def remote_path
       filename = [surah.to_s.rjust(3, "0"), ayah.to_s.rjust(3, "0"), ".mp3"].join
-      File.join format(author.remote_path, bitrate:), filename
+      File.join format(recitation.remote_path, bitrate:), filename
     end
 
+    ##
+    # @return [String]
+    #  Returns the path to an MP3 file on disk
     def local_path
       File.join(
-        format(author.dest_dir, sharedir:),
+        format(recitation.dest_dir, sharedir:),
         surah.to_s,
         "#{ayah}.mp3"
       )
@@ -25,8 +38,8 @@ module Quran::Audio
 
     private
 
-    def authors
-      @authors ||= Ryo.from_json(path: File.join(datadir, "authors.json"))
+    def recitations
+      @recitations ||= Ryo.from_json(path: File.join(datadir, "recitations.json"))
     end
 
     def sharedir

data/share/quran-audio/VERSION

@@ -1 +1 @@
-v0.3.1
+v0.3.2

data/share/quran-audio/data/erb/recitation.erb

@@ -0,0 +1,4 @@
+<%= Paint[recitation.name, :bold] %>
+From       <%= recitation.origin %>
+Bitrates   <%= recitation.available_bitrates.join(", ") %> (default = <%= recitation.default_bitrate %>)
+CLI        --recitation <%= switch %>

data/share/quran-audio/data/{authors.json → recitations.json}

@@ -1,7 +1,7 @@
 {
   "alafasy": {
     "name": "Mishari bin Rashed Alafasy",
-    "nationality": "Kuwait",
+    "origin": "Kuwait",
     "available_bitrates": [128, 64],
     "default_bitrate": 128,
     "remote_path": "/data/Alafasy_%{bitrate}kbps/",
@@ -9,7 +9,7 @@
   },
   "alajmi": {
     "name": "Ahmad bin Ali Al-Ajmi",
-    "nationality": "Saudi Arabia",
+    "origin": "Saudi Arabia",
     "available_bitrates": [128],
     "default_bitrate": 128,
     "remote_path": "/data/ahmed_ibn_ali_al_ajamy_%{bitrate}kbps/",
@@ -17,7 +17,7 @@
   },
   "yassin": {
     "name": "Sahl Yassin",
-    "nationality": "Saudi Arabia",
+    "origin": "Saudi Arabia",
     "available_bitrates": [128],
     "default_bitrate": 128,
     "remote_path": "/data/Sahl_Yassin_%{bitrate}kbps/",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quran-audio
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - '0x1eef'
@@ -113,12 +113,12 @@ files:
 - libexec/quran-audio/ls
 - libexec/quran-audio/pull
 - share/quran-audio/VERSION
-- share/quran-audio/data/authors.json
-- share/quran-audio/data/erb/author.txt.erb
-- share/quran-audio/data/surah_length.json
+- share/quran-audio/data/erb/recitation.erb
+- share/quran-audio/data/recitations.json
+- share/quran-audio/data/sizeof.json
 homepage: https://github.com/ReflectsLight/quran-audio#readme
 licenses:
-- BSD0L
+- GPL-3.0-or-later
 metadata: {}
 post_install_message:
 rdoc_options: []

data/share/quran-audio/data/erb/author.txt.erb

@@ -1,4 +0,0 @@
-<%= Paint[author.name, :bold] %>
-From       <%= author.nationality %>
-Bitrates   <%= author.available_bitrates.join(", ") %> (default = <%= author.default_bitrate %>)
-CLI        --author <%= switch %>