Merge branch 'release/0.1.0'

[rbdr/lyricli] / Sources / lyrics_engine.swift

diff --git a/Sources/lyrics_engine.swift b/Sources/lyrics_engine.swift
index 9741a2c63d65393ebeadc27fd63c5d5829455bd7..85e4735eaa00a5027f795285a65b46061d89bcf2 100644 (file)
--- a/Sources/lyrics_engine.swift
+++ b/Sources/lyrics_engine.swift
@@ -1,20 +1,28 @@
 import Foundation
 import HTMLEntities
 
 import Foundation
 import HTMLEntities
 

-/// Looks for lyrics on the internet
+// Given a track, attempts to fetch the lyrics from lyricswiki

 class LyricsEngine {
 
 class LyricsEngine {
 

+    // URL of the API endpoint to use

     private let apiURL = "https://lyrics.wikia.com/api.php?action=lyrics&func=getSong&fmt=realjson"
     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"
     private let apiMethod = "GET"

+
+    // Regular expxression used to find the lyrics in the lyricswiki HTML

     private let lyricsMatcher = "class='lyricbox'>(.+)<div"
 
     private let lyricsMatcher = "class='lyricbox'>(.+)<div"
 

+    // The track we'll be looking for

     private let track: Track
 
     // Fetches the lyrics and returns if found
     private let track: Track
 
     // Fetches the lyrics and returns if found

-

     var lyrics: String? {
     var lyrics: String? {

+

         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)") {
         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)") {


@@ -46,13 +54,14 @@ class LyricsEngine {
         return lyrics
     }
 
         return lyrics
     }
 

+    // Initializes with a track

     init(withTrack targetTrack: Track) {
 
         track = targetTrack
     }
 
     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)
     private func fetchLyricsFromAPI(withURL url: URL, completionHandler: @escaping (String?) -> Void) {
 
         var apiRequest = URLRequest(url: url)


@@ -83,8 +92,7 @@ class LyricsEngine {
         task.resume()
     }
 
         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)
     private func fetchLyricsFromPage(withURL url: URL, completionHandler: @escaping (String?) -> Void) {
 
         var pageRequest = URLRequest(url: url)


@@ -107,10 +115,11 @@ class LyricsEngine {
         task.resume()
     }
 
         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) {
 
     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))
 
         if let regex = try? NSRegularExpression(pattern: lyricsMatcher) {
             let matches = regex.matches(in: body, range: NSRange(location: 0, length: body.characters.count))
 


@@ -131,7 +140,6 @@ class LyricsEngine {
     }
 
     // Escapes the HTML entities
     }
 
     // Escapes the HTML entities

-

     private func decodeLyrics(_ lyrics: String) -> String {
 
         let unescapedLyrics = lyrics.htmlUnescape()
     private func decodeLyrics(_ lyrics: String) -> String {
 
         let unescapedLyrics = lyrics.htmlUnescape()