X-Git-Url: https://git.r.bdr.sh/rbdr/lyricli.rb/blobdiff_plain/34d0bf15a6f4009de376ceed1d7d5cca24a8dfe7..278e6d0afff19cce3ab8ad256c9ab8239bcf6289:/doc/Lyricli/Lyricli.html?ds=sidebyside diff --git a/doc/Lyricli/Lyricli.html b/doc/Lyricli/Lyricli.html index 090262d..e3accb5 100644 --- a/doc/Lyricli/Lyricli.html +++ b/doc/Lyricli/Lyricli.html @@ -99,8 +99,21 @@
+

Overview

+
+

+This class has the basic logic for extracting the lyrics and controlling +the application +

+
+
+
+ + +
+ @@ -131,7 +144,10 @@ -
+

+Exits with error when there is an empty field from the current track. +

+
 @@ -153,7 +169,11 @@ -
+

+Raises an InvalidLyricsError which means we did not get any valid +artist/song from any of the sources. +

+
 @@ -161,7 +181,7 @@
  • - - (Object) get_lyrics + - (String) get_lyrics @@ -175,7 +195,11 @@ -
    +

    +Extracts the current track, validates it and requests the lyrics from our +LyricsEngine. +

    +
    • @@ -200,7 +224,7 @@

    -A new instance of Lyricli. +Constructor, initializes `@source_manager`.

    @@ -224,7 +248,11 @@ A new instance of Lyricli. -
    +

    +Set the `@current_track` instance variable by asking the SourceManager for +its current track. +

    +
     @@ -247,7 +275,7 @@ A new instance of Lyricli.

    -A new instance of Lyricli +Constructor, initializes `@source_manager`

    @@ -262,12 +290,12 @@ A new instance of Lyricli 
     
 
-4
-5
-6
    +8 +9 +10 - 
    # File 'lib/lyricli/lyricli.rb', line 4
+      
    # File 'lib/lyricli/lyricli.rb', line 8
 
 def initialize
   @source_manager = SourceManager.new
@@ -293,21 +321,35 @@ A new instance of Lyricli
   
 
   
-
+
    
+  
    
+    
    
+Exits with error when there is an empty field from the current track.
+
    
+
+
+  
    
+
    
+
    
+  
+
+
    
@@ -371,44 +423,86 @@ A new instance of Lyricli
       
    
   
    
   
-    - (Object) get_lyrics 
+    - (String) get_lyrics 
   
 
   
 
   
-
    
   
    
     
       
     
 
-29
-30
-31
-32
    
+49
+50
+51
+52
+53
         		
     
-      
    # File 'lib/lyricli/lyricli.rb', line 29
+      
    # File 'lib/lyricli/lyricli.rb', line 49
 
 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
    
@@ -327,7 +369,11 @@ A new instance of Lyricli
   
 
    
   
    
-    
+    
    
+Raises an InvalidLyricsError which means we did not get any valid
+artist/song from any of the sources
+
    
+
 
   
    
 
    
@@ -339,10 +385,16 @@ A new instance of Lyricli
     
  • 
       
       
-        (InvalidLyrics)
+        (Lyricli::Exceptions::InvalidLyricsError)
       
       
       
+        —
+        
    
+because we found nothing
+
    
+
    
+      
     
    • 
   
 
@@ -353,15 +405,15 @@ A new instance of Lyricli
       
     
 
-8
-9
-10
    
+16
+17
+18
    
         		
     
-      
    # File 'lib/lyricli/lyricli.rb', line 8
+      
    # File 'lib/lyricli/lyricli.rb', line 16
 
 def exit_with_error
-  raise InvalidLyrics
+  raise Exceptions::InvalidLyricsError
 end
    
     
    		
   
    
+
    
+  
    
+    
    
+Extracts the current track, validates it and requests the lyrics from our
+LyricsEngine
+
    
+
+
+  
    
+
    
+
    
+  
+
    Returns:
    
+
      
+  
+    
    • 
+      
+      
+        (String)
+      
+      
+      
+        —
+        
      
+the found lyrics, or a string indicating none were found
+
      
+
      
+      
+    
      • 
+  
+
    
+
+
    
@@ -425,18 +519,31 @@ A new instance of Lyricli
   
 
   
-
    
   
    
     
       
     
 
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
    
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
         		
     
-      
    # File 'lib/lyricli/lyricli.rb', line 12
+      
    # File 'lib/lyricli/lyricli.rb', line 24
 
 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
+
    
+
+
+  
    
+
    
+
    
+  
+
+
    
   
    
     
       
     
 
-25
-26
-27
    
+44
+45
+46
         		
     
-      
    # File 'lib/lyricli/lyricli.rb', line 25
+      
    # File 'lib/lyricli/lyricli.rb', line 44
 
 def set_current_track
   @current_track = @source_manager.current_track
@@ -451,7 +558,7 @@ A new instance of Lyricli