-/// Source that deals with command line
+// Source that reads track artist and name from the command line
class ArgumentsSource: Source {
- public var currentTrack: Track? {
- if CommandLine.arguments.count >= 3 {
- // expected usage: $ ./lyricli <artist> <name>
+ // Returns a track based on the arguments. It assumes the track artist
+ // will be the first argument, and the name will be the second, excluding
+ // any flags.
+ var currentTrack: Track? {
+ if CommandLine.arguments.count >= 3 {
+ // expected usage: $ ./lyricli <artist> <name>
let trackName: String = CommandLine.arguments[2]
let trackArtist: String = CommandLine.arguments[1]
import Foundation
-/// Handles reading and writing the configuration
-public class Configuration {
-
- let configurationPath = NSString(string: "~/.lyricli.conf").expandingTildeInPath
-
- // The defaults are added here
+// Reads and writes the configuration. Config keys are accessed as a dictionary.
+class Configuration {
+ // Location of the global configuration file
+ private let configurationPath = NSString(string: "~/.lyricli.conf").expandingTildeInPath
+ // Default options, will be automatically written to the global config if
+ // not found.
private var configuration: [String: Any] = [
- "enabled_sources": ["arguments"],
- "default": true
+ "enabled_sources": ["arguments"]
]
- static let sharedInstance: Configuration = Configuration()
+ // The shared instance of the object
+ static let shared: Configuration = Configuration()
private init() {
- // Read the config file and attempt toset any of the values. Otherwise
- // Don't do anything.
- // IMPROVEMENT: Enable a debug mode
+ // Read the config file and attempt to set any of the values. Otherwise
+ // don't do anything.
if let data = try? NSData(contentsOfFile: configurationPath) as Data {
if let parsedConfig = try? JSONSerialization.jsonObject(with: data) {
writeConfiguration()
}
+ // Write the configuration back to the file
private func writeConfiguration() {
var error: NSError?
}
}
- // Allow access as an object
+ // Allow access to the config properties as a dictionary
subscript(index: String) -> Any? {
get {
return configuration[index]
-/// The main Lyricli interface
-public class Lyricli {
- public static var version = "0.0.0"
+// The main class, handles all the actions that the executable will call
+class Lyricli {
- public static var showTitle = false
+ // Version of the application
+ static var version = "0.0.0"
- public static func printLyrics() {
+ // Flag that controls whether we should show the track artist and name before
+ // the lyrics
+ static var showTitle = false
+
+ // Obtains the name of the current track from a source, fetches the lyrics
+ // from an engine and prints them
+ static func printLyrics() {
let sourceManager = SourceManager()
if let currentTrack = sourceManager.currentTrack {
-
let engine = LyricsEngine(withTrack: currentTrack)
if let lyrics = engine.lyrics {
}
}
- public static func printSources() {
+ // Print the currently available sources
+ static func printSources() {
print("Listing Sources: Not yet implemented")
}
- public static func enableSource(_ sourceName: String) {
+ // Runs the enable method of a source and writes the configuration to set it
+ // as enabled
+ static func enableSource(_ sourceName: String) {
print("Enable source \(sourceName): Not yet implemented")
}
- public static func disableSource(_ sourceName: String) {
+ // Remove a source from the enabled sources configuration
+ static func disableSource(_ sourceName: String) {
print("Disable source \(sourceName): Not yet implemented")
}
- public static func resetSource(_ sourceName: String) {
+ // Removes any configuration for a source, and disables it
+ static func resetSource(_ sourceName: String) {
print("Reset source \(sourceName): Not yet implemented")
}
+ // Prints the track artist and name
private static func printTitle(_ track: Track) {
print("\(track.artist) - \(track.name)")
}
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)") {
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)
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)
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))
}
// Escapes the HTML entities
-
private func decodeLyrics(_ lyrics: String) -> String {
let unescapedLyrics = lyrics.htmlUnescape()
import CommandLineKit
import Foundation
-func main() {
+// Entry point of the application. This is the main executable
+private func main() {
let (flags, parser) = createParser()
do {
-/// Manages the different sources. Keeps track of them, lists and toggles
+// Collect and manage the available and enabled source
class SourceManager {
+ // List of sources enabled for the crurent platform
private var availableSources: [String: Source] = [
"arguments": ArgumentsSource()
]
+ // Iterate over the sources until we find a track or run out of sources
var currentTrack: Track? {
for source in enabledSources {
if let currentTrack = source.currentTrack {
return nil
}
+ // Return the list of enabled sources based on the configuration
var enabledSources: [Source] {
// Checks the config and returns an array of sources based on the
var sources = [Source]()
- if let sourceNames = Configuration.sharedInstance["enabled_sources"] as? [String] {
+ if let sourceNames = Configuration.shared["enabled_sources"] as? [String] {
for sourceName in sourceNames {
if let source = availableSources[sourceName] {
sources.append(source)
return sources
}
+ // Given a source name, it will enable it and add it to the enabled sources config
func enable(sourceName: String) {
}
+ // Given a source name, it will remove it from the enabled sources config
func disable(sourceName: String) {
}
+ // Given a source name, it removes any stored configuration and disables it
func reset(sourceName: String) {
}
-
- func getSources(sourceName: String) {
- }
}
+// All sources should comply with this protocol. The currentTrack computed
+// property will return a track if the conditions are met
protocol Source {
var currentTrack: Track? { get }
}
-/// Contains the artist and name of a track
+// Holds the name and artist of a track
class Track {
+
+ // The name of the track to search for
let name: String
+
+ // The name of the artist
let artist: String
init(withName trackName: String, andArtist trackArtist: String) {
git.r.bdr.sh / rbdr / lyricli / commitdiff