X-Git-Url: https://git.r.bdr.sh/rbdr/lyricli/blobdiff_plain/1263f62c5c6379f11e19eb184ffedf5889390b70..e82ec845286f902e4669279d5f1fb6b0097f0bc2:/Sources/lyrics_engine.swift

diff --git a/Sources/lyrics_engine.swift b/Sources/lyrics_engine.swift
index 9741a2c..27e0e11 100644
--- a/Sources/lyrics_engine.swift
+++ b/Sources/lyrics_engine.swift
@@ -1,20 +1,28 @@
 import Foundation
 import HTMLEntities
 
-/// Looks for lyrics on the internet
+// Given a track, attempts to fetch the lyrics from lyricswiki
 class LyricsEngine {
 
+    // URL of the API endpoint to use
     private let apiURL = "https://lyrics.wikia.com/api.php?action=lyrics&func=getSong&fmt=realjson"
+
+    // Method used to call the API
     private let apiMethod = "GET"
+
+    // Regular expxression used to find the lyrics in the lyricswiki HTML
     private let lyricsMatcher = "class='lyricbox'>(.+)<div"
 
+    // The track we'll be looking for
     private let track: Track
 
     // Fetches the lyrics and returns if found
-
     var lyrics: String? {
+
         var lyrics: String?
 
+        // Encode the track artist and name and finish building the API call URL
+
         if let artist = track.artist.addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed) {
             if let name: String = track.name.addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed) {
                 if let url = URL(string: "\(apiURL)&artist=\(artist)&song=\(name)") {
@@ -28,11 +36,9 @@ class LyricsEngine {
                     // Call the API and unlock when you're done
 
                     fetchLyricsFromAPI(withURL: url, completionHandler: {lyricsResult -> Void in
-                        if let lyricsResult = lyricsResult {
-                            lyrics = lyricsResult
-                            requestFinished = true
-                            asyncLock.signal()
-                        }
+                        lyrics = lyricsResult
+                        requestFinished = true
+                        asyncLock.signal()
                     })
 
                     while !requestFinished {
@@ -46,13 +52,14 @@ class LyricsEngine {
         return lyrics
     }
 
+    // Initializes with a track
     init(withTrack targetTrack: Track) {
 
         track = targetTrack
     }
 
-    // Fetch the lyrics from the API and request / parse the page
-
+    // Fetch the lyrics URL from the API, triggers the request to fetch the
+    // lyrics page
     private func fetchLyricsFromAPI(withURL url: URL, completionHandler: @escaping (String?) -> Void) {
 
         var apiRequest = URLRequest(url: url)
@@ -83,8 +90,7 @@ class LyricsEngine {
         task.resume()
     }
 
-    // Fetch the lyrics from the page and parse the page
-
+    // Fetch the lyrics from the page and send it to the parser
     private func fetchLyricsFromPage(withURL url: URL, completionHandler: @escaping (String?) -> Void) {
 
         var pageRequest = URLRequest(url: url)
@@ -107,10 +113,11 @@ class LyricsEngine {
         task.resume()
     }
 
-    // Parses the wiki to obtain the lyrics
-
+    // Parses the wiki to find the lyrics, decodes the lyrics object
     private func parseHtmlBody(_ body: String, completionHandler: @escaping (String?) -> Void) {
 
+        // Look for the lyrics lightbox
+
         if let regex = try? NSRegularExpression(pattern: lyricsMatcher) {
             let matches = regex.matches(in: body, range: NSRange(location: 0, length: body.characters.count))
 
@@ -131,7 +138,6 @@ class LyricsEngine {
     }
 
     // Escapes the HTML entities
-
     private func decodeLyrics(_ lyrics: String) -> String {
 
         let unescapedLyrics = lyrics.htmlUnescape()