fix warn that File.exists 'been deprecated in 2.1

[rbdr/lyricli.rb] / lib / lyricli / lyricli.rb

diff --git a/lib/lyricli/lyricli.rb b/lib/lyricli/lyricli.rb
index 06302f50948080335de90fd65303485826ba4d1f..c3e1faecb94dd657a98bf78de7e1fe0b972d9b98 100644 (file)
--- a/lib/lyricli/lyricli.rb
+++ b/lib/lyricli/lyricli.rb
@@ -1,32 +1,53 @@
 module Lyricli
+
+  # This class has the basic logic for extracting the lyrics and controlling the
+  # application
   class Lyricli
 
+    # Constructor, initializes `@source_manager`
     def initialize
       @source_manager = SourceManager.new
     end
 
+    # Raises an InvalidLyricsError which means we did not get any valid
+    # artist/song from any of the sources
+    #
+    # @raise [Lyricli::Exceptions::InvalidLyricsError] because we found nothing
     def exit_with_error
-      raise InvalidLyrics
+      raise Exceptions::InvalidLyricsError
     end
 
+    # Extracts the current track, validates it and requests the lyrics from our
+    # LyricsEngine
+    #
+    # @return [String] the found lyrics, or a string indicating none were found
     def get_lyrics
-      set_current_track
-      check_params
+
+      begin
+        set_current_track
+        check_params
+      rescue Exceptions::InvalidLyricsError
+        return "No Artist/Song could be found :("
+      end
 
       engine = LyricsEngine.new(@current_track[:artist], @current_track[:song])
 
       begin
-        engine.get_lyrics
-      rescue LyricsNotFoundException
-        "Lyrics not found :("
+        return engine.get_lyrics
+      rescue Exceptions::LyricsNotFoundError
+        return "Lyrics not found :("
       end
     end
 
+    # Set the `@current_track` instance variable by asking the SourceManager for
+    # its current track
     def set_current_track
       @current_track = @source_manager.current_track
     end
 
+    # Exits with error when there is an empty field from the current track.
     def check_params
+      self.exit_with_error unless @current_track
       self.exit_with_error if @current_track[:artist].nil? or @current_track[:artist].empty?
       self.exit_with_error if @current_track[:song].nil? or @current_track[:song].empty?
     end