quran-audio 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd6892ac4ea40e4ceedcf5596e92bb06bcd578db055b16acf793cec19dca277f
-  data.tar.gz: 942914a841bd747cbcd11fd8af1666aef716d48996789438acac8b5cbdd08cb9
+  metadata.gz: 709a79351be5539a80a26a13ac39b41336b6a084cc14e56d476e5cd203090ab6
+  data.tar.gz: 7a0e5403541389a206d28f98bf53756a33ef672ad2bbc7162378efd59080642e
 SHA512:
-  metadata.gz: b732e4378bf21f7d7341f68db747e2fae0dcee83ad7d0b5235b602ab3a7439daa6f1311b0d1a0f7a6a19ca2537fff21280d58ee9d5c881c7ae11f5aabd94628a
-  data.tar.gz: 77b4d19899be0bc4041a4d087fcad940a5e624f64559fe0ae024009378f1b7cb5d4579eb6446038f31bd4e41cadf7388101ff15deab3f0eb1cee42d74f8406a7
+  metadata.gz: 655fda01723b31bd0d125f886a1b4695d6f16f8ae6bc5b3fac69c12019954c059f1a0fad0987e4d417e689d818400696a11dfa4431002cbcf4d9151f3c41640e
+  data.tar.gz: ede8a0dee97e2c33ddb78314bf4004ab8e785cf6b761cb7b9aea2c1ce03e30d7bbc88b7c0dfc0eeca96c5ac23b013f767b062f415eb3d2ed6608da600fd76554

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/bin/quran-audio

@@ -1,17 +1,28 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-libexec = File.realpath File.join(__dir__, "..", "libexec", "quran-audio")
-case ARGV[0]
-when "pull"
-  Process.spawn File.join(libexec, "pull"), *ARGV[1..]
+def wait
   Process.wait
-when "ls"
-  Process.spawn File.join(libexec, "ls"), *ARGV[1..]
-  Process.wait
-else
-  warn "Usage: quran-audio [COMMAND] [OPTIONS]\n\n" \
-       "Commands:\n" \
-       "  pull              Pull MP3 files from everyayah.com\n" \
-       "  ls                List reciters\n" \
+rescue Interrupt
+  retry
+end
+
+def main(argv)
+  libexec = File.realpath File.join(__dir__, "..", "libexec", "quran-audio")
+  case argv[0]
+  when "pull"
+    Process.spawn File.join(libexec, "pull"), *ARGV[1..]
+    Process.wait
+  when "ls"
+    Process.spawn File.join(libexec, "ls"), *ARGV[1..]
+    Process.wait
+  else
+    warn "Usage: quran-audio [COMMAND] [OPTIONS]\n\n" \
+         "Commands:\n" \
+         "  pull              Pull MP3 files from everyayah.com\n" \
+         "  ls                List reciters\n" \
+  end
+rescue Interrupt
+  wait
 end
+main(ARGV)

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,44 +4,47 @@ 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])
+      start(surahs)
+    end
+
+    private
+
+    attr_reader :http
+
+    def start(surahs)
       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
       end
     end
 
-    private
-
     def pull(mp3, delay, interrupt: false)
       res = http.get(mp3.remote_path)
       write(mp3, res, interrupt:)
       sleep(delay)
     rescue Interrupt
-      line.end.rewind.print("Wait for a graceful exit").end
+      line.end.rewind.print("SIGINT: exiting cleanly, please wait").end
       pull(mp3, delay, interrupt: true)
     rescue SocketError, SystemCallError, Net::OpenTimeout => e
       line.end.rewind.print("#{e.class}: retry")
-      interrupt ? throw(:interrupt, true) : pull(mp3, delay)
+      interrupt ? abort! : pull(mp3, delay)
     end
 
     def write(mp3, res, interrupt:)
@@ -49,14 +52,31 @@ module Quran::Audio
       when Net::HTTPOK
         mkdir_p File.dirname(mp3.local_path)
         File.binwrite(mp3.local_path, res.body)
-        throw(:interrupt, true) if interrupt
+        abort! if interrupt
       else
-        puts "error #{res.body}"
+        line.end.print("error: unexpected response (#{res.class})")
+        abort!
       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.destdir, 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
+
+    def abort!
+      throw(:abort, 1)
     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.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.destdir, 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/libexec/quran-audio/pull

@@ -7,5 +7,8 @@ def main(argv)
     .new(argv)
     .run
 end
-interrupt = catch(:interrupt) { main(ARGV) }
-exit(1) if interrupt
+excode = catch(:abort) {
+  main(ARGV)
+  0
+}
+exit excode

data/share/quran-audio/VERSION

@@ -1 +1 @@
-v0.3.1
+v0.3.3

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/recitations.json

@@ -0,0 +1,26 @@
+{
+  "alafasy": {
+    "name": "Mishari bin Rashed Alafasy",
+    "origin": "Kuwait",
+    "available_bitrates": [128, 64],
+    "default_bitrate": 128,
+    "path": "/data/Alafasy_%{bitrate}kbps/",
+    "destdir": "%{sharedir}/mp3/alafasy/"
+  },
+  "alajmi": {
+    "name": "Ahmad bin Ali Al-Ajmi",
+    "origin": "Saudi Arabia",
+    "available_bitrates": [128],
+    "default_bitrate": 128,
+    "path": "/data/ahmed_ibn_ali_al_ajamy_%{bitrate}kbps/",
+    "destdir": "%{sharedir}/mp3/alajmi/"
+  },
+  "yassin": {
+    "name": "Sahl Yassin",
+    "origin": "Saudi Arabia",
+    "available_bitrates": [128],
+    "default_bitrate": 128,
+    "path": "/data/Sahl_Yassin_%{bitrate}kbps/",
+    "destdir": "%{sharedir}/mp3/yassin/"
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quran-audio
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 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/authors.json

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

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 %>