From: Ben Beltran Date: Fri, 19 May 2017 04:39:25 +0000 (-0500) Subject: Fix linter warnings X-Git-Tag: 0.1.0^2~1^2~21 X-Git-Url: https://git.r.bdr.sh/rbdr/lyricli/commitdiff_plain/1263f62c5c6379f11e19eb184ffedf5889390b70?ds=inline;hp=6608973cc785af2363b71299e03407e5dd436f54 Fix linter warnings --- 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) {