spotify_rec 1.1 → 1.6

data/lib/my_list.rb

@@ -1,137 +1,162 @@
-class MyList
-
-  def initialize(user)
-    @user = user
-    @mylist = user.mylist
-    @menu = Menu.new(@user)
-  end
-
-  def separator
-    puts "----------------------------------------"
-  end
-
-  def list
-    unless @mylist.empty?
-      rows = @mylist.map do |hash|
-        if hash["type"] == "track" || hash["type"] == "album"
-          ["#{hash["name"]} by #{hash["artist"]}", hash["type"].capitalize]
-        else
-          [hash["name"], hash["type"].capitalize]
-        end
-      end
-      table = Terminal::Table.new :headings => ['Item', 'Type'], :rows => rows
-      puts table
-      $prompt.keypress("Press any key to return to the previous menu..")
-      @menu.my_list
-    else
-      empty_list
-    end
-  end
-
-  def empty_list
-    puts "Oh no! Your list is currently empty!".colorize(:light_red)
-    puts "Add up to 5 items to your list. An item can be a song, artist or genre.".colorize(:light_red)
-    separator
-    $prompt.keypress("Press any key to return to the previous menu..")
-    @menu.my_list
-  end
-
-  def add_to_list
-    if @mylist.length >= 5
-      puts "Oh no! You've reached maximum capacity in your list! You won't be able to add another item until you remove an existing one.".colorize(:light_red)
-      puts "You can do this by heading back to the previous menu, and selecting 'Remove'".colorize(:light_red)
-      $prompt.keypress("Press any key to return to the previous menu..")
-      @menu.my_list
-    end
-    selection = $prompt.select("Which type would you like to add?".colorize(:light_green), (["Song", "Artist", "Genre", "Back"]))
-    case selection
-      when "Song"
-        search_song
-      when "Artist"
-        search_artist
-      when "Genre"
-        store_genre
-      when "Back"
-      @menu.my_list
-    end
-  end
-
-  def remove_from_list
-    empty_list if @mylist.length <= 0
-    item_names = @mylist.map { |item| item["name"] }
-    item_names << "Back"
-    selection = $prompt.select("Which item would you like to remove?".colorize(:light_green), (item_names))
-    @menu.my_list if selection == "Back"
-    @mylist.each_with_index do |item, index|
-      @mylist.delete_at(index) if item["name"] == selection
-    end
-    update_file
-  end
-
-  def search_song
-    song_query = $prompt.ask("What is the name of the song?".colorize(:light_green))
-    tracks = RSpotify::Track.search(song_query, limit: 5)
-    cleaned_results = []
-    tracks.each { |t| cleaned_results << "#{t.name} by #{t.artists[0].name}" }
-    system("clear")
-    cleaned_results << "Back"
-    selection = $prompt.select("Please select one of the search results:", (cleaned_results)).split(" by ")
-    add_to_list if selection[0] == "Back"
-    store_song(selection)
-  end
-
-  def store_song(details)
-    track = RSpotify::Track.search("#{details[0]} #{details[1]}", limit: 1).first
-    song_details = {
-    "name" => track.name,
-    "artist" => track.artists[0].name,
-    "id" => track.id,
-    "type" => "track"
-    }
-    @mylist << song_details
-    update_file
-  end
-
-  def search_artist
-    artist_query = $prompt.ask("What is the name of the artist?".colorize(:light_green))
-    artists = RSpotify::Artist.search(artist_query, limit: 5)
-    cleaned_results = []
-    artists.each { |a| cleaned_results << "#{a.name}" }
-    system("clear")
-    selection = $prompt.select("Please select one of the search results:", (cleaned_results))
-    store_artist(selection)
-  end
-
-  def store_artist(details)
-    artist = RSpotify::Artist.search("#{details}", limit: 1).first
-    artist_details = {
-    "name" => artist.name,
-    "id" => artist.id,
-    "type" => "artist"
-    }
-    @mylist << artist_details
-    update_file
-  end
-
-  def store_genre
-    genres = RSpotify::Recommendations.available_genre_seeds
-    genre = $prompt.select("Which genre would you like to add to your list?".colorize(:light_green), genres, filter: true)
-    genre_details = {
-      "name" => genre.capitalize,
-      "type" => "genre"
-    }
-    @mylist << genre_details
-    update_file
-  end
-
-  def update_file
-    updated_data = Login.load_data.each { |user| user["mylist"] = @mylist if user["id"] == @user.uid.to_s }
-    File.open(userdata,"w") do |f|
-      f.puts JSON.pretty_generate(updated_data)
-    end
-    puts "Sweet! Your list has been updated!".colorize(:light_green)
-    $prompt.keypress("Press any key to return to the previous menu..")
-    @menu.my_list
-  end
-
-end
+# frozen_string_literal: true
+
+class MyList
+  def initialize(user)
+    @user = user
+    @mylist = user.mylist
+    @menu = Menu.new(@user)
+    @prompt = TTY::Prompt.new
+  end
+
+  # Display MyList
+  # Displays items in MyList. Raises error if no items in list
+  def list
+    raise MyListEmpty.new, 'List must not be empty' if @mylist.empty?
+
+    list_table
+    @prompt.keypress('Press any key to return to the previous menu..')
+    @menu.my_list
+  rescue MyListEmpty
+    empty_list
+  end
+
+  # Generates the list in table view and prints it to the screen
+  def list_table
+    rows = @mylist.map do |hash|
+      if hash['type'] == 'track' || hash['type'] == 'album'
+        ["#{hash['name']} by #{hash['artist']}", hash['type'].capitalize]
+      else
+        [hash['name'], hash['type'].capitalize]
+      end
+    end
+    table = Terminal::Table.new headings: %w[Item Type], rows: rows
+    puts table
+  end
+
+  # Tells the user they have no items in their list, and returns to menu
+  def empty_list
+    puts 'Oh no! Your list is currently empty!'.colorize(:light_red)
+    puts 'Add up to 5 items to your list. An item can be a song, artist or genre.'.colorize(:light_red)
+    puts
+    @prompt.keypress('Press any key to return to the previous menu..')
+    @menu.my_list
+  end
+
+  # Add to MyList
+  # Prompts the user to specify what type of item to add
+  def add_to_list
+    list_too_long if @mylist.length >= 5
+    selection = @prompt.select('Which type would you like to add?'.colorize(:light_green), %w[Song Artist Genre Back])
+    case_add_to_list(selection)
+  end
+
+  # Returns user to menu if the MyList has too many items
+  def list_too_long
+    puts "Oh no! You've reached maximum capacity in your list! You won't be able to add".colorize(:light_red)
+    puts 'another item until you remove an existing one.'.colorize(:light_red)
+    puts "You can do this by heading back to the previous menu, and selecting 'Remove'".colorize(:light_red)
+    @prompt.keypress('Press any key to return to the previous menu..')
+    @menu.my_list
+  end
+
+  # Cases the add to list selection and routes the user
+  def case_add_to_list(selection)
+    case selection
+    when 'Song'
+      search_song
+    when 'Artist'
+      search_artist
+    when 'Genre'
+      store_genre
+    when 'Back'
+      @menu.my_list
+    end
+  end
+
+  # Prompts user for song name and searches spotify. Prompts user to select a result
+  def search_song
+    song_query = @prompt.ask('What is the name of the song?'.colorize(:light_green))
+    tracks = RSpotify::Track.search(song_query, limit: 5)
+    cleaned_results = []
+    tracks.each { |t| cleaned_results << "#{t.name} by #{t.artists[0].name}" }
+    system('clear')
+    cleaned_results << 'Back'
+    selection = @prompt.select('Please select one of the search results:', cleaned_results).split(' by ')
+    add_to_list if selection[0] == 'Back'
+    store_song(selection)
+  end
+  
+  # Stores the song in a hash ready to be written to the file
+  def store_song(details)
+    track = RSpotify::Track.search("#{details[0]} #{details[1]}", limit: 1).first
+    song_details = {
+      'name' => track.name,
+      'artist' => track.artists[0].name,
+      'id' => track.id,
+      'type' => 'track'
+    }
+    @mylist << song_details
+    update_file
+  end
+
+  # Prompts user for artist name, searches for the artist and prompts user to select a result
+  def search_artist
+    artist_query = @prompt.ask('What is the name of the artist?'.colorize(:light_green))
+    artists = RSpotify::Artist.search(artist_query, limit: 5)
+    cleaned_results = []
+    artists.each { |a| cleaned_results << a.name.to_s }
+    system('clear')
+    selection = @prompt.select('Please select one of the search results:', cleaned_results)
+    store_artist(selection)
+  end
+
+  # Stores the artist details in a hash, ready to be written to userfile
+  def store_artist(details)
+    artist = RSpotify::Artist.search(details.to_s, limit: 1).first
+    artist_details = {
+      'name' => artist.name,
+      'id' => artist.id,
+      'type' => 'artist'
+    }
+    @mylist << artist_details
+    update_file
+  end
+
+  # Prompts user to select genre from the list. Stores details in hash to be written to file
+  def store_genre
+    genres = RSpotify::Recommendations.available_genre_seeds
+    genre = @prompt.select('Which genre would you like to add to your list?', genres, filter: true)
+    genre_details = {
+      'name' => genre.capitalize,
+      'type' => 'genre'
+    }
+    @mylist << genre_details
+    update_file
+  end
+
+  # Remove From MyList
+  # Prompts user to select item to remove from MyList. Removes item from mylist array
+  def remove_from_list
+    empty_list if @mylist.length <= 0
+    item_names = @mylist.map { |item| item['name'] }
+    item_names << 'Back'
+    selection = @prompt.select('Which item would you like to remove?'.colorize(:light_green), item_names)
+    @menu.my_list if selection == 'Back'
+    @mylist.each_with_index do |item, index|
+      @mylist.delete_at(index) if item['name'] == selection
+    end
+    update_file
+  end
+
+  # Update userfile
+  # Writes the user MyList to the userfile
+  def update_file
+    updated_data = Login.load_data.each { |user| user['mylist'] = @mylist if user['id'] == @user.uid.to_s }
+    File.open(userdata, 'w') do |f|
+      f.puts JSON.pretty_generate(updated_data)
+    end
+    puts 'Sweet! Your list has been updated!'.colorize(:light_green)
+    @prompt.keypress('Press any key to return to the previous menu..')
+    @menu.my_list
+  end
+end

data/lib/playlist.rb

@@ -1,112 +1,148 @@
-class Playlist
+# frozen_string_literal: true
 
+class Playlist
   attr_reader :tracks
 
   def initialize(user)
-    @playlist = user.playlist
     @user = user
+    @playlist = user.playlist
+    @prompt = TTY::Prompt.new
   end
 
-  def list
-    rows = @playlist.map { |track| [track["name"], track["artist"]] }
-    table = Terminal::Table.new :headings => ['Track', 'Artist'], :rows => rows
-    puts table
+  # Playlist Menu Section
+  # Prompts user to select an item from the menu
+  def menu
+    system('clear')
+    selection = @prompt.select('》  PLAYLIST  《', ['Display', 'Add', 'Remove', 'Export To File', 'Back'])
+    case selection
+    when 'Display'
+      list
+    else
+      case_menu(selection)
+    end
   end
 
-  def remove
-    empty if @playlist.length <= 0
-    item_names = @playlist.map { |item| "#{item["name"]} by #{item["artist"]}" }
-    item_names << "Back"
-    selection = $prompt.select("Which track would you like to remove?", (item_names)).split(" by ")
-    menu if selection == "Back"
-    @playlist.each_with_index do |item, index|
-      @user.playlist.delete_at(index) if item["name"] == selection[0]
+  # Cases the user selection and routes the user
+  def case_menu(selection)
+    case selection
+    when 'Add'
+      add
+    when 'Remove'
+      remove
+    else
+      second_case_menu(selection)
+    end
+  end
+
+  # Continues to case the selection and route the user
+  def second_case_menu(selection)
+    case selection
+    when 'Export To File'
+      export_to_file
+    when 'Back'
+      menu = Menu.new(@user)
+      menu.menu_router
     end
-    update_playlist
   end
 
+  # View Playlist
+  # Generates table from user playlist and prints it to the screen
+  def list
+    puts '》  PLAYLIST  《'
+    empty if @playlist.empty?
+    rows = @playlist.map { |track| [track['name'], track['artist']] }
+    table = Terminal::Table.new headings: %w[Track Artist], rows: rows
+    puts table
+    keypress_playlist
+    menu
+  end
+
+  # Tells user if their playlist is empty and sends them back to the menu
   def empty
-    puts "Oh no! Your playlist is currently empty!"
-    puts "You can add songs manually from the previous menu, or generate recommendations and add those!"
-    separator
-    $prompt.keypress("Press any key to return to the previous menu..")
-    Menu::my_list
+    puts 'Oh no! Your playlist is currently empty!'
+    puts 'You can add songs manually from the previous menu, or generate recommendations and add those!'
+    puts
+    @prompt.keypress('Press any key to return to the previous menu..')
+    menu
   end
 
+  # Add to Playlist
+  # Prompts user to enter song name, searches for song and prompts user to select a result
   def add
-    song_query = $prompt.ask("What is the name of the song?")
+    song_query = @prompt.ask('What is the name of the song?')
     tracks = RSpotify::Track.search(song_query, limit: 5)
     cleaned_results = []
     tracks.each { |t| cleaned_results << "#{t.name} by #{t.artists[0].name}" }
-    system("clear")
-    cleaned_results << "Back"
-    selection = $prompt.select("Please select one of the search results:", (cleaned_results)).split(" by ")
-    menu if selection[0] == "Back"
+    system('clear')
+    cleaned_results << 'Back'
+    selection = @prompt.select('Please select one of the search results:', cleaned_results).split(' by ')
+    menu if selection[0] == 'Back'
     store(selection)
   end
 
+  # Turns song details into a hash and adds to playlist array
   def store(details)
     track = RSpotify::Track.search("#{details[0]} #{details[1]}", limit: 1).first
     song_details = {
-    "name" => track.name,
-    "id" => track.id,
-    "artist" => track.artists[0].name
+      'name' => track.name,
+      'id' => track.id,
+      'artist' => track.artists[0].name
     }
     @playlist << song_details
     update_playlist
   end
 
+  # Remove from Playlist
+  # Prompts user to select item in playlist to remove and deleted from playlist array
+  def remove
+    empty if @playlist.length <= 0
+    item_names = @playlist.map { |item| "#{item['name']} by #{item['artist']}" }
+    item_names << 'Back'
+    selection = @prompt.select('Which track would you like to remove?', item_names).split(' by ')
+    menu if selection == 'Back'
+    @playlist.each_with_index do |item, index|
+      @user.playlist.delete_at(index) if item['name'] == selection[0]
+    end
+    update_playlist
+  end
+
+  # Update Playlist in file
+  # Loads userdata and updates playlist in file. Returns the user to the menu
   def update_playlist
-    updated_data = Login.load_data.each { |user| user["playlist"] = @playlist if user["id"] == @user.uid.to_s }
-    File.open((Login::userdata),"w") do |f|
+    updated_data = Login.load_data.each { |user| user['playlist'] = @playlist if user['id'] == @user.uid.to_s }
+    File.open(Login.userdata, 'w') do |f|
       f.puts JSON.pretty_generate(updated_data)
     end
-    puts "Sweet! Your playlist has been updated!"
-    $prompt.keypress("Press any key to return to the previous menu..")
+    puts 'Sweet! Your playlist has been updated!'
+    @prompt.keypress('Press any key to return to the previous menu..')
     menu
   end
 
+  # Export playlist to file
+  # Writes user playlist information to a markdown file
   def export_to_file
     path = File.join(File.dirname(File.dirname(File.absolute_path(__FILE__))))
-    playlist_file = "#{path}/playlist.md"
-    File.open(playlist_file,"w") do |f|
+    File.open("#{path}/playlist.md", 'w') do |f|
       f.puts("# #{@user.username}'s Playlist")
-      @playlist.each { |track| f.puts("1. #{track["name"]} by #{track["artist"]} || [Listen on Spotify](https://open.spotify.com/track/#{track["id"]})") }
+      @playlist.each do |track|
+        link = "[Listen on Spotify](https://open.spotify.com/track/#{track['id']})"
+        f.puts("1. #{track['name']} by #{track['artist']} #{link}")
+      end
     end
-    system("cp #{playlist_file} ~/Desktop/playlist.md")
-    puts "Exported playlist to your Desktop!"
-    sleep(2)
-    system("clear")
+    copy_to_desktop(path)
   end
 
-  def keypress_playlist
-    $prompt.keypress("Press any key to return to the previous menu..")
+  # Copies markdown file to desktop for easy access
+  def copy_to_desktop(path)
+    system("cp #{path}/playlist.md ~/Desktop/playlist.md")
+    puts 'Exported playlist to your Desktop!'
+    @prompt.keypress('Press any key to return to the previous menu..')
+    menu
   end
 
-  def menu
-    system("clear")
-    selection = $prompt.select("》  PLAYLIST  《", (["Display", "Add", "Remove", "Export To File", "Back"]))
-    case selection
-      when "Display"
-        puts "》  PLAYLIST  《"
-        list
-        keypress_playlist
-        menu
-      when "Add"
-        add
-        keypress_playlist
-        menu
-      when "Remove"
-        remove
-        menu
-      when "Export To File"
-        export_to_file
-        keypress_playlist
-        menu
-      when "Back"
-        @menu = Menu.new(@user)
-        @menu.menu_router
-    end
-  end
+  # Helper method
 
-end
+  def keypress_playlist
+    @prompt.keypress('Press any key to return to the previous menu..')
+  end
+end