From 47f1de79ed1d0007dbba84dc3d511528c7fed3f0 Mon Sep 17 00:00:00 2001 From: Ben Beltran Date: Thu, 18 May 2017 22:44:25 -0500 Subject: Show the optional arguments --- Sources/main.swift | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'Sources') diff --git a/Sources/main.swift b/Sources/main.swift index e4b2760..42d4855 100644 --- a/Sources/main.swift +++ b/Sources/main.swift @@ -21,6 +21,21 @@ func createParser() -> ([String:Option], CommandLineKit) { parser.addOptions(Array(flags.values)) + parser.formatOutput = {parseString, type in + + var formattedString: String + + switch(type) { + case .About: + formattedString = "\(parseString) [ ]" + break + default: + formattedString = parseString + } + + return parser.defaultFormat(formattedString, type: type) + } + return (flags, parser) } -- cgit From 1263f62c5c6379f11e19eb184ffedf5889390b70 Mon Sep 17 00:00:00 2001 From: Ben Beltran Date: Thu, 18 May 2017 23:39:25 -0500 Subject: Fix linter warnings --- Sources/arguments_source.swift | 14 +++--- Sources/configuration.swift | 24 ++++++--- Sources/lyricli.swift | 6 +-- Sources/lyrics_engine.swift | 66 ++++++++++++------------ Sources/main.swift | 111 ++++++++++++++++++++++++++++------------- Sources/source_manager.swift | 29 +++++------ 6 files changed, 144 insertions(+), 106 deletions(-) (limited to 'Sources') diff --git a/Sources/arguments_source.swift b/Sources/arguments_source.swift index c07c952..d1bf4c6 100644 --- a/Sources/arguments_source.swift +++ b/Sources/arguments_source.swift @@ -1,17 +1,15 @@ /// Source that deals with command line class ArgumentsSource: Source { public var currentTrack: Track? { - get { - if CommandLine.arguments.count >= 3 { + if CommandLine.arguments.count >= 3 { - // expected usage: $ ./lyricli + // expected usage: $ ./lyricli - let trackName: String = CommandLine.arguments[2] - let trackArtist: String = CommandLine.arguments[1] + let trackName: String = CommandLine.arguments[2] + let trackArtist: String = CommandLine.arguments[1] - return Track(withName: trackName, andArtist: trackArtist) - } - return nil + return Track(withName: trackName, andArtist: trackArtist) } + return nil } } diff --git a/Sources/configuration.swift b/Sources/configuration.swift index f5e4b0f..bc21769 100644 --- a/Sources/configuration.swift +++ b/Sources/configuration.swift @@ -21,14 +21,19 @@ public class Configuration { // IMPROVEMENT: Enable a debug mode if let data = try? NSData(contentsOfFile: configurationPath) as Data { - if let parsedConfig = try? JSONSerialization.jsonObject(with: data) as! [String:Any] { - for (key, value) in parsedConfig { + if let parsedConfig = try? JSONSerialization.jsonObject(with: data) { + if let parsedConfig = parsedConfig as? [String: Any] { + for (key, value) in parsedConfig { - if key == "enabled_sources" { - configuration[key] = value as! [String] - } - else { - configuration[key] = value as! String + if key == "enabled_sources" { + if let value = value as? [String] { + configuration[key] = value + } + } else { + if let value = value as? String { + configuration[key] = value + } + } } } } @@ -43,7 +48,10 @@ public class Configuration { if let outputStream = OutputStream(toFileAtPath: configurationPath, append: false) { outputStream.open() - JSONSerialization.writeJSONObject(configuration, to: outputStream, options: [JSONSerialization.WritingOptions.prettyPrinted], error: &error) + JSONSerialization.writeJSONObject(configuration, + to: outputStream, + options: [JSONSerialization.WritingOptions.prettyPrinted], + error: &error) outputStream.close() } } diff --git a/Sources/lyricli.swift b/Sources/lyricli.swift index c44a7f4..5931ca1 100644 --- a/Sources/lyricli.swift +++ b/Sources/lyricli.swift @@ -18,13 +18,11 @@ public class Lyricli { } print(lyrics) - } - else { + } else { print("Lyrics not found :(") } - } - else { + } else { print("No Artist/Song could be found :(") } } diff --git a/Sources/lyrics_engine.swift b/Sources/lyrics_engine.swift index d6b1985..9741a2c 100644 --- a/Sources/lyrics_engine.swift +++ b/Sources/lyrics_engine.swift @@ -13,40 +13,37 @@ class LyricsEngine { // Fetches the lyrics and returns if found var lyrics: String? { - get { + var lyrics: String? - var lyrics: String? + 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)") { + // We'll lock until the async call is finished - // We'll lock until the async call is finished + var requestFinished = false + let asyncLock = NSCondition() + asyncLock.lock() - var requestFinished = false - let asyncLock = NSCondition() - asyncLock.lock() + // Call the API and unlock when you're done - // 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() - } - }) - - while(!requestFinished) { - asyncLock.wait() + fetchLyricsFromAPI(withURL: url, completionHandler: {lyricsResult -> Void in + if let lyricsResult = lyricsResult { + lyrics = lyricsResult + requestFinished = true + asyncLock.signal() } - asyncLock.unlock() + }) + + while !requestFinished { + asyncLock.wait() } + asyncLock.unlock() } } - - return lyrics } + + return lyrics } init(withTrack targetTrack: Track) { @@ -61,20 +58,21 @@ class LyricsEngine { var apiRequest = URLRequest(url: url) apiRequest.httpMethod = "GET" - let task = URLSession.shared.dataTask(with: apiRequest, completionHandler: {data, response, error -> Void in + let task = URLSession.shared.dataTask(with: apiRequest, completionHandler: {data, _, _ -> Void in // If the response is parseable JSON, and has a url, we'll look for // the lyrics in there if let data = data { - let jsonResponse = try? JSONSerialization.jsonObject(with: data) as! [String: Any] - if let jsonResponse = jsonResponse { - if let lyricsUrlString = jsonResponse["url"] as? String { - if let lyricsUrl = URL(string: lyricsUrlString) { - - // At this point we have a valid wiki url - self.fetchLyricsFromPage(withURL: lyricsUrl, completionHandler: completionHandler) - return + if let jsonResponse = try? JSONSerialization.jsonObject(with: data) { + if let jsonResponse = jsonResponse as? [String: Any] { + if let lyricsUrlString = jsonResponse["url"] as? String { + if let lyricsUrl = URL(string: lyricsUrlString) { + + // At this point we have a valid wiki url + self.fetchLyricsFromPage(withURL: lyricsUrl, completionHandler: completionHandler) + return + } } } } @@ -92,7 +90,7 @@ class LyricsEngine { var pageRequest = URLRequest(url: url) pageRequest.httpMethod = "GET" - let task = URLSession.shared.dataTask(with: pageRequest, completionHandler: {data, response, error -> Void in + let task = URLSession.shared.dataTask(with: pageRequest, completionHandler: {data, _, _ -> Void in // If the response is parseable JSON, and has a url, we'll look for // the lyrics in there diff --git a/Sources/main.swift b/Sources/main.swift index 42d4855..5c39cb5 100644 --- a/Sources/main.swift +++ b/Sources/main.swift @@ -1,11 +1,43 @@ import CommandLineKit import Foundation +func main() { + let (flags, parser) = createParser() + + do { + try parser.parse() + } catch { + parser.printUsage(error) + exit(EX_USAGE) + } + + // Boolean Options + + checkHelpFlag(flags["help"], withParser: parser) + checkVersionFlag(flags["version"], withParser: parser) + checkListSourcesFlag(flags["listSources"], withParser: parser) + checkTitleFlag(flags["title"], withParser: parser) + + // String Options + + checkEnableSourceFlag(flags["enableSource"], withParser: parser) + checkDisableSourceFlag(flags["disableSource"], withParser: parser) + checkResetSourceFlag(flags["resetSource"], withParser: parser) + + // Remove any flags so anyone after this gets the unprocessed values + + let programName: [String] = [CommandLine.arguments[0]] + CommandLine.arguments = programName + parser.unparsedArguments + + // Run Lyricli + + Lyricli.printLyrics() +} + /// Sets up and returns a new options parser /// /// - Returns: A Dictionary of Options, and a new CommandLineKit instance -func createParser() -> ([String:Option], CommandLineKit) { - +private func createParser() -> ([String:Option], CommandLineKit) { let parser = CommandLineKit() var flags: [String:Option] = [:] @@ -25,7 +57,7 @@ func createParser() -> ([String:Option], CommandLineKit) { var formattedString: String - switch(type) { + switch type { case .About: formattedString = "\(parseString) [ ]" break @@ -39,71 +71,80 @@ func createParser() -> ([String:Option], CommandLineKit) { return (flags, parser) } -func main() { - - let (flags, parser) = createParser() +// Handle the Help flag - do { - try parser.parse() - } - catch { - parser.printUsage(error) - exit(EX_USAGE) - } - - if let helpFlag = flags["help"] as? BoolOption { - if helpFlag.value == true { +private func checkHelpFlag(_ flag: Option?, withParser parser: CommandLineKit) { + if let helpFlag = flag as? BoolOption { + if helpFlag.value { parser.printUsage() exit(0) } } +} - if let versionFlag = flags["version"] as? BoolOption { - if versionFlag.value == true { +// Handle the version flag + +private func checkVersionFlag(_ flag: Option?, withParser parser: CommandLineKit) { + if let versionFlag = flag as? BoolOption { + if versionFlag.value { print(Lyricli.version) exit(0) } } +} - if let listSourcesFlag = flags["listSources"] as? BoolOption { - if listSourcesFlag.value == true { +// Handle the list sources flag + +private func checkListSourcesFlag(_ flag: Option?, withParser parser: CommandLineKit) { + if let listSourcesFlag = flag as? BoolOption { + if listSourcesFlag.value { Lyricli.printSources() exit(0) } } +} + +// Handle the title flag + +private func checkTitleFlag(_ flag: Option?, withParser parser: CommandLineKit) { + if let titleFlag = flag as? BoolOption { + if titleFlag.value { + Lyricli.showTitle = true + } + } +} + +// Handle the enable source flag - if let enableSourceFlag = flags["enableSource"] as? StringOption { +private func checkEnableSourceFlag(_ flag: Option?, withParser parser: CommandLineKit) { + if let enableSourceFlag = flag as? StringOption { if let source = enableSourceFlag.value { Lyricli.enableSource(source) exit(0) } } +} + +// Handle the disable source flag - if let disableSourceFlag = flags["disableSource"] as? StringOption { +private func checkDisableSourceFlag(_ flag: Option?, withParser parser: CommandLineKit) { + if let disableSourceFlag = flag as? StringOption { if let source = disableSourceFlag.value { Lyricli.disableSource(source) exit(0) } } +} + +// Handle the reset source flag - if let resetSourceFlag = flags["resetSource"] as? StringOption { +private func checkResetSourceFlag(_ flag: Option?, withParser parser: CommandLineKit) { + if let resetSourceFlag = flag as? StringOption { if let source = resetSourceFlag.value { Lyricli.resetSource(source) exit(0) } } - - if let titleFlag = flags["title"] as? BoolOption { - if titleFlag.value == true { - Lyricli.showTitle = true - } - } - - // Remove any flags so anyone after this gets the unprocessed values - let programName: [String] = [CommandLine.arguments[0]] - CommandLine.arguments = programName + parser.unparsedArguments - - Lyricli.printLyrics() } main() diff --git a/Sources/source_manager.swift b/Sources/source_manager.swift index dd956ad..e55cc8b 100644 --- a/Sources/source_manager.swift +++ b/Sources/source_manager.swift @@ -6,16 +6,13 @@ class SourceManager { ] var currentTrack: Track? { - get { - - for source in enabledSources { - if let currentTrack = source.currentTrack { - return currentTrack - } + for source in enabledSources { + if let currentTrack = source.currentTrack { + return currentTrack } - - return nil } + + return nil } var enabledSources: [Source] { @@ -23,19 +20,17 @@ class SourceManager { // Checks the config and returns an array of sources based on the // enabled and available ones - get { - var sources = [Source]() + var sources = [Source]() - if let sourceNames = Configuration.sharedInstance["enabled_sources"] as? [String]{ - for sourceName in sourceNames { - if let source = availableSources[sourceName] { - sources.append(source) - } + if let sourceNames = Configuration.sharedInstance["enabled_sources"] as? [String] { + for sourceName in sourceNames { + if let source = availableSources[sourceName] { + sources.append(source) } } - - return sources } + + return sources } func enable(sourceName: String) { -- cgit From 74b4bbe9f35e7d29e0822a892b8498cab9b1801c Mon Sep 17 00:00:00 2001 From: Ben Beltran Date: Fri, 19 May 2017 00:19:14 -0500 Subject: Set the version to 0.0.0 --- Sources/lyricli.swift | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Sources') diff --git a/Sources/lyricli.swift b/Sources/lyricli.swift index 5931ca1..10d9270 100644 --- a/Sources/lyricli.swift +++ b/Sources/lyricli.swift @@ -1,6 +1,6 @@ /// The main Lyricli interface public class Lyricli { - public static var version = "0.0.0-feature/option-parsing" + public static var version = "0.0.0" public static var showTitle = false -- cgit From d852b84edc24f1f1bbf4c34aa359447970e732b0 Mon Sep 17 00:00:00 2001 From: Ben Beltran Date: Sat, 20 May 2017 09:40:03 -0500 Subject: Improve comments in code --- Sources/arguments_source.swift | 11 +++++++---- Sources/configuration.swift | 26 +++++++++++++------------- Sources/lyricli.swift | 31 +++++++++++++++++++++---------- Sources/lyrics_engine.swift | 26 +++++++++++++++++--------- Sources/main.swift | 3 ++- Sources/source_manager.swift | 13 ++++++++----- Sources/source_protocol.swift | 2 ++ Sources/track.swift | 6 +++++- 8 files changed, 75 insertions(+), 43 deletions(-) (limited to 'Sources') diff --git a/Sources/arguments_source.swift b/Sources/arguments_source.swift index d1bf4c6..9615318 100644 --- a/Sources/arguments_source.swift +++ b/Sources/arguments_source.swift @@ -1,10 +1,13 @@ -/// 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 + // 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 let trackName: String = CommandLine.arguments[2] let trackArtist: String = CommandLine.arguments[1] diff --git a/Sources/configuration.swift b/Sources/configuration.swift index bc21769..f1a1ee1 100644 --- a/Sources/configuration.swift +++ b/Sources/configuration.swift @@ -1,24 +1,23 @@ 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) { @@ -42,6 +41,7 @@ public class Configuration { writeConfiguration() } + // Write the configuration back to the file private func writeConfiguration() { var error: NSError? @@ -56,7 +56,7 @@ public class Configuration { } } - // Allow access as an object + // Allow access to the config properties as a dictionary subscript(index: String) -> Any? { get { return configuration[index] diff --git a/Sources/lyricli.swift b/Sources/lyricli.swift index 10d9270..e7d14b9 100644 --- a/Sources/lyricli.swift +++ b/Sources/lyricli.swift @@ -1,15 +1,20 @@ -/// 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 { @@ -27,22 +32,28 @@ public class Lyricli { } } - 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)") } diff --git a/Sources/lyrics_engine.swift b/Sources/lyrics_engine.swift index 9741a2c..85e4735 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'>(.+) Void) { var apiRequest = URLRequest(url: url) @@ -83,8 +92,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 +115,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 +140,6 @@ class LyricsEngine { } // Escapes the HTML entities - private func decodeLyrics(_ lyrics: String) -> String { let unescapedLyrics = lyrics.htmlUnescape() diff --git a/Sources/main.swift b/Sources/main.swift index 5c39cb5..9d46e92 100644 --- a/Sources/main.swift +++ b/Sources/main.swift @@ -1,7 +1,8 @@ import CommandLineKit import Foundation -func main() { +// Entry point of the application. This is the main executable +private func main() { let (flags, parser) = createParser() do { diff --git a/Sources/source_manager.swift b/Sources/source_manager.swift index e55cc8b..5ee1305 100644 --- a/Sources/source_manager.swift +++ b/Sources/source_manager.swift @@ -1,10 +1,12 @@ -/// 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 { @@ -15,6 +17,7 @@ class SourceManager { 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 @@ -22,7 +25,7 @@ class SourceManager { 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) @@ -33,15 +36,15 @@ class SourceManager { 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) { - } } diff --git a/Sources/source_protocol.swift b/Sources/source_protocol.swift index ee9350c..0885994 100644 --- a/Sources/source_protocol.swift +++ b/Sources/source_protocol.swift @@ -1,3 +1,5 @@ +// 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 } } diff --git a/Sources/track.swift b/Sources/track.swift index d2a9047..ead4359 100644 --- a/Sources/track.swift +++ b/Sources/track.swift @@ -1,6 +1,10 @@ -/// 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) { -- cgit