apple_music_library 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1148dd5f546044638ace3b635c61799d36f427cdf380e19d146be4ab55a0128
-  data.tar.gz: ceeafe5ace4e3ac2d76aa34bb2695592584799755b9318ce99b055bdfc971f83
+  metadata.gz: 28f3fe7d3df7d724f7e7290f9eb6c33e2dae08d22e60ed07dfeb87c9bda9c283
+  data.tar.gz: 302301b2f8dd1826f71d18474fa15dfa804babf481b46ab4db99694364e0342f
 SHA512:
-  metadata.gz: 289f57dc10c8ec89d0ddf9506fbea8083ab8c6d07d0bfc1b060d481434e47e375e73bb8e6b5518570babd5add4f24bb3817a2bf6dce5108f173edbe43ed5b506
-  data.tar.gz: 0276d14ab7d07c5b2aaf1c56c95494ddb81680a2d6811ce3c5a0254e3f93a18fbbf8c8d85223de7b6ea0ec110a00748cc9727d936c46c98c5fd87ab4f0d98aa6
+  metadata.gz: 5bcb31d7d2326fe4d6f614a6a29a6c69b4e47e349a235b47234afc97f10618630eb4ae995bfc2c402fe2629d080e6834067cc2b6606ba22132c1662af9d19c1e
+  data.tar.gz: d1785f58aab9a2a75d1c77ce165f37307141af7dc25833d12f669dbc0c201a9633384187c9d71b36e3a5e7a8c1f7a8696d8e14197b826f5538d5b49e3310cd82

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## [Unreleased]
+- Ability to print out playlist folder hierarchy
+
+## 0.5.0 - 2022-03-11
+### Added
+- Basic functionality for track ratings via the #rating, #star_rating, and #loved
+
+## 0.4.0 - 2022-03-11
+### Added
+- Basic functionality for Playlist Folders
+### Fixed
+- The #find_by_name methods for Playlists and PlaylistFolders now return a single object when only a single exact match is found (the most common case) but continue to return an array of objects when there are multiple matches.
+
+## 0.3.0 - 2022-03-10
+
+### Fixed
+- Fixed handling of albums, genres, and playlists as accessed via methods on artists/tracks.
+
+## 0.2.0 - 2022-03-10
+### Added
+- Basic functionality to parse a library plist into Track, Album, Artist, Genre, and Playlist objects.
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    apple_music_library (0.2.0)
+    apple_music_library (0.5.0)
       facets (~> 3.1)
       plist (~> 3.6)
 

data/README.md

@@ -28,6 +28,12 @@ library = AppleMusicLibrary.new('path/to/Library.xml')
 # Count albums
 puts library.albums.count
 
+# Show playlist inside playlist folder
+playlist_folder = library.playlist_folder('Folder for Testing')
+playlist_folder.playlists.each do |playlist|
+  puts playlist.name
+end
+
 # Show tracks in a specific playlist
 playlist = library.playlist('XTC Favorites')
 playlist.tracks.each do |track|
@@ -38,6 +44,9 @@ end
 artist = library.artist('XTC')
 puts artist.tracks.count
 
+# Get favorite tracks by this artists
+favorite_tracks = artist.tracks.select{|t| t.loved? || t.star_rating > 3}
+
 # Display track counts per genre
 library.genres.each do |genre|
   puts "#{genre.tracks.count} #{genre.name}"

data/apple_music_library.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Todd Gehman"]
   spec.email = ["github@pugetive.com"]
 
-  spec.summary = "Provides a ruby OO interface to the information stored in an Apple Music (formerly iTunes) Library xml file."
+  spec.summary = "Provides a Ruby interface to the information stored in an Apple Music (formerly iTunes) Library xml file."
   # spec.description = "TODO: Write a longer description or delete this line."
   spec.homepage = "https://github.com/pugetive/apple_music_library"
   spec.license = "MIT"

data/lib/apple_music_library/album.rb

@@ -5,12 +5,26 @@ module AppleMusicLibrary
 
     attr_reader :artist, :album_name, :tracks
 
+    @@albums = {}
+
     def initialize(artist, album_name)
       @artist = artist
       @album_name = album_name
       @tracks = []
     end
 
+    def self.all
+      @@albums.values
+    end
+
+    def self.find_or_create(artist, album_name)
+      key = "#{artist.name}-#{album_name}"
+      if @@albums[key]
+        return @@albums[key]
+      end
+      @@albums[key] = self.new(artist, album_name)
+    end
+
     def id
       "#{artist.name}-#{album_name}"
     end
@@ -20,7 +34,7 @@ module AppleMusicLibrary
     end
 
     def year
-      @year ||= tracks.sort(&:year).last.year
+      @year ||= @tracks.sort_by(&:year).last.year
     end
 
   end

data/lib/apple_music_library/artist.rb

@@ -3,24 +3,50 @@ module AppleMusicLibrary
 
     attr_reader :name
 
+    @@artists = {}
+
     def initialize(name)
       @name = name
       @albums = []
+      @tracks = []
+    end
+
+    def self.all
+      @@artists.values
+    end
+
+    def self.find_or_create(name)
+      if @@artists[name]
+        return @@artists[name]
+      end
+      @@artists[name] = self.new(name)
+    end
+
+    def self.find_by_name(artist_name)
+      if @@artists[artist_name]
+        return @@artists[artist_name]
+      end
+      nil
     end
 
     def add_album(album)
-      unless albums.include?(album)
+      unless @albums.include?(album)
         @albums << album
       end
     end
 
+    def add_track(track)
+      unless @tracks.include?(track)
+        @tracks << track
+      end
+    end
 
     def albums
-      @albums.sort(&:year)
+      @albums.sort_by(&:year)
     end
 
     def tracks
-      @tracks ||= @albums.map(&:tracks).flatten
+      @tracks
     end
 
   end

data/lib/apple_music_library/genre.rb

@@ -3,11 +3,28 @@ module AppleMusicLibrary
 
     attr_reader :name, :tracks
 
+    @@genres = {}
+
     def initialize(name)
       @name = name
       @tracks = []
     end
 
+    def self.all
+      @@genres.values
+    end
+    
+    def self.find_or_create(name)
+      if @@genres[name]
+        return @@genres[name]
+      end
+      @@genres[name] = self.new(name)
+    end
+
+    def self.find_by_name(name)
+      @@genres[name]
+    end
+
     def add_track(track)
       unless tracks.include?(track)
         @tracks << track

data/lib/apple_music_library/library.rb

@@ -2,6 +2,7 @@ require_relative 'album'
 require_relative 'artist'
 require_relative 'genre'
 require_relative 'playlist'
+require_relative 'playlist_folder'
 require_relative 'track'
 require_relative "utils"
 require 'plist'
@@ -36,53 +37,51 @@ module AppleMusicLibrary
         raise Error, "Failed to parse library xml file [#{e.message}]"
       end
 
-      @artists_hash   = {}
-      @tracks_hash    = {}
-      @playlists_hash = {}
-      @albums_hash    = {}
-      @genres_hash    = {}
-
-      @locations_hash = {}
-      @slugs_hash     = {}      
-
       extract_plist_info
     end
 
-    def tracks
-      @tracks_hash.values
+    def albums
+      @albums ||= Album.all
     end
 
     def artists
-      @artists_hash.values
+      @artists ||= Artist.all
     end
 
     def artist(artist_name)
-      artists.find{|a| a.name == artist_name}
+      Artist.find_by_name(artist_name)
     end
 
-    def albums
-      @albums_hash.values
+    def genres
+      @genres ||= Genre.all
+    end
+
+    def genre(genre_name)
+      Genre.find_by_name(genre_name)
     end
 
     def playlists
-      @playlists_hash.values
+      @playlists ||= Playlist.all
     end
 
     def playlist(playlist_name)
-      playlists.find{|p| p.name == playlist_name}
+      Playlist.find_by_name(playlist_name)
     end
 
+    def playlist_folders
+      @playlist_folders ||= PlaylistFolder.all
+    end
 
-    def albums
-      @albums_hash.values
+    def playlist_folder(playlist_folder_name)
+      PlaylistFolder.find_by_name(playlist_folder_name)
     end
 
-    def genres
-      @genres_hash.values.sort_by{|g| g.name}
+    def tracks(filter = nil)
+      filter.present? ? Track.send(filter) : Track.all
     end
 
-    def genre(genre_name)
-        genres.find{|g| g.name == genre_name}
+    def track(track_id)
+      Track.find(track_id)
     end
 
     def valid?
@@ -93,82 +92,35 @@ module AppleMusicLibrary
       tracks.any?
     end
 
-    def track(track_id)
-      track = @tracks_hash[track_id.to_i]
-      if track.nil?
-        message("Cound not find track with ID [#{track_id}]")
-        message("Searched tracks: [#{@tracks_hash.keys.sort.join(', ')}]")
-      end
-      track
-    end
-
     private
 
     def extract_plist_info
+      extract_tracks_from_plist
+      extract_playlists_from_plist
+    end
+
+    def extract_tracks_from_plist
       non_music_formats = {}
       plist['Tracks'].each do |track|
         if MUSIC_FORMATS.include?(track[1]['Kind'])
-          track = Track.new(track[1])
-          # next if track.artist.name == 'NPR'
-          @tracks_hash[track.id] = track
-          # @locations_hash[track.location] = track
-
-          artist = add_artist(track.artist)
-          album = add_track_to_album(track, track.album)
-          artist.add_album(album)
-
-          if track.genre_name.present?
-            genre = add_track_to_genre(track)
-          end
+          Track.new(track[1])
         else
           non_music_formats[track[1]['Kind']] = true
         end
       end
 
-      plist['Playlists'].each do |playlist_info|
-        playlist = Playlist.new(playlist_info, self)
-        next if playlist.folder?
-        @playlists_hash[playlist.id] = playlist
-      end
-
       if non_music_formats.any?
         message("Skipped the following non-music formats:\n#{non_music_formats.keys.join(', ')}")
       end
-    end
-
-
-    def add_artist(artist)
-      unless @artists_hash[artist.name]
-        @artists_hash[artist.name] = artist
-      end
-      artist
-    end
-
-    def add_track_to_album(track, album)
-      return if @albums_hash[album.id]
-      # message("Creating new artist #{artist.name}")
-      @albums_hash[album.id] = album
-      album.add_track(track)
-      album
-    end
 
-    def find_or_create_album(album)
-      unless @albums_hash[album.id]
-        @albums_hash[album.id] = album
-      end
-      album.artist.add_album(album)
     end
 
-
-    def add_track_to_genre(track)
-      if @genres_hash[track.genre_name]
-        return @genres_hash[track.genre_name]
+    def extract_playlists_from_plist
+      plist['Playlists'].each do |playlist_info|
+        # The distinction between playlists and playlist folders
+        #   is made inside the Playlist instantiation
+        Playlist.new(playlist_info)
       end
-        # message("Creating new artist #{artist.name}")
-      genre = AppleMusicLibrary::Genre.new(track.genre_name)
-      @genres_hash[track.genre_name] = genre
-      genre.add_track(track)
-      genre
     end
 
   end

data/lib/apple_music_library/playlist.rb

@@ -1,17 +1,3 @@
-# <key>Name</key><string>Non-XTC</string>
-# <key>Description</key><string></string>
-# <key>Playlist ID</key><integer>79359</integer>
-# <key>Playlist Persistent ID</key><string>59C95825DF1F0DCC</string>
-# <key>All Items</key><true/>
-# <key>Smart Info</key>
-# <data>
-# AQEAAwAAAAIAAAAZAAAAAAAAAAcAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
-# AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
-# AAAAAA==
-# </data>
-# <key>Smart Criteria</key>
-# <data>
-
 require 'facets'
 
 module AppleMusicLibrary
@@ -19,26 +5,47 @@ module AppleMusicLibrary
 
     attr_reader :info, :tracks
 
+    @@playlists = {}
+
     ATTRIBUTES = ['Name',
                   'Description',
                   'Playlist ID',
                   'Playlist Persistent ID',
+                  'Parent Persistent ID',
                   'All Items',
                   'Smart Info',
                   'Smart Criteria',
                   'Playlist Items',
                   'Folder']
 
-    def initialize(info, library)
+    def initialize(info)
       @info = info
-      @library = library
+
+      if folder?
+        return PlaylistFolder.new(info)
+      end
+
       @tracks = []
 
       load_tracks
+
+      @@playlists[id] = self
+    end
+
+    def self.all
+      @@playlists.values
+    end
+
+    def self.find_by_name(playlist_name)
+      results = @@playlists.values.select{|p| p.name == playlist_name}
+      if results.size == 1
+        return results.first
+      end
+      results
     end
 
     def id
-      playlist_id
+      playlist_persistent_id
     end                
 
     ATTRIBUTES.each do |attribute|
@@ -57,7 +64,7 @@ module AppleMusicLibrary
       if playlist_items and playlist_items.any?
         playlist_items.each do |playlist_item|
           track_id = playlist_item['Track ID']
-          track = @library.track(track_id)
+          track = Track.find(track_id)
           @tracks << track
         end
       end
@@ -66,3 +73,18 @@ module AppleMusicLibrary
     
   end
 end
+
+# <key>Name</key><string>Non-XTC</string>
+# <key>Description</key><string></string>
+# <key>Playlist ID</key><integer>79359</integer>
+# <key>Playlist Persistent ID</key><string>59C95825DF1F0DCC</string>
+# <key>All Items</key><true/>
+# <key>Smart Info</key>
+# <data>
+# AQEAAwAAAAIAAAAZAAAAAAAAAAcAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+# AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+# AAAAAA==
+# </data>
+# <key>Smart Criteria</key>
+# <data>
+

data/lib/apple_music_library/playlist_folder.rb

@@ -0,0 +1,55 @@
+require 'facets'
+
+module AppleMusicLibrary
+  class PlaylistFolder
+
+    attr_reader :info
+
+    @@playlist_folders = {}
+
+    def initialize(info)
+      @info = info
+
+      @@playlist_folders[id] = self
+    end
+
+    def self.all
+      @@playlist_folders.values
+    end
+
+    def self.find_by_name(playlist_folder_name)
+      results = @@playlist_folders.values.select{|pf| pf.name == playlist_folder_name}
+      if results.size == 1
+        return results.first
+      end
+      results
+    end
+
+    def id
+      playlist_persistent_id
+    end                
+
+    def children
+      playlist_folders.concat(playlists)
+    end
+
+    def playlist_folders
+      @@playlist_folders.values.select{|pf| pf.parent_persistent_id == id}
+    end
+
+    def playlists
+      Playlist.all.select{|p| p.parent_persistent_id == id}
+    end
+
+    Playlist::ATTRIBUTES.each do |attribute|
+      define_method(attribute.to_s.snakecase) do
+        info[attribute]
+      end
+    end
+
+
+    private
+
+
+  end
+end

data/lib/apple_music_library/track.rb

@@ -2,13 +2,13 @@ require 'facets'
 
 module AppleMusicLibrary
   class Track
-    attr_reader :info, :artist, :album
+    attr_reader :artist, :album, :genre
 
-    ATTRIBUTES = ['Track ID', 
-                  'Name',
                   # 'Artist', The #artist, #album, and #genre methods return objects rather than strings and have methods like #artist_name to retrieve the strings.
                   # 'Album',
                   # 'Genre',
+    ATTRIBUTES = ['Track ID', 
+                  'Name',
                   'Kind',
                   'Size',
                   'Total Time',
@@ -24,6 +24,7 @@ module AppleMusicLibrary
                   'Rating',
                   'Album Rating',
                   'Album Rating Computed',
+                  'Loved',
                   'Normalization',
                   'Persistent ID',
                   'Track Type',
@@ -31,10 +32,32 @@ module AppleMusicLibrary
                   'File Folder Count',
                   'Library Folder Count']
 
+    @@tracks = {}
+
     def initialize(info)
       @info = info
-      @artist = Artist.new(artist_name)
-      @album = Album.new(@artist, album_name)
+      @artist = Artist.find_or_create(artist_name)
+      @album = Album.find_or_create(@artist, album_name)
+      @genre = Genre.find_or_create(genre_name)
+
+      @artist.add_track(self)
+      @artist.add_album(@album)
+      @album.add_track(self)
+      @genre.add_track(self)
+      @@tracks[id] = self
+    end
+
+
+    def self.find(track_id)
+      @@tracks[track_id]
+    end
+
+    def self.all
+      @@tracks.values
+    end
+
+    def self.loved
+      @loved ||= self.all.select{|t| t.loved?}
     end
 
     def id
@@ -42,22 +65,29 @@ module AppleMusicLibrary
     end      
 
     def artist_name
-      info['Artist']
+      @info['Artist']
     end
 
     def album_name
-      info['Album']
+      @info['Album']
     end
 
     def genre_name
-      info['Genre']
+      @info['Genre']
     end
 
-    ATTRIBUTES.each do |attribute|
-      define_method(attribute.to_s.snakecase) do
-        info[attribute]
-      end
+    def star_rating
+      rating / 20
+    end
+
+    def loved?
+      loved
+    end
 
+    ATTRIBUTES.each do |track_attribute|
+      define_method(track_attribute.to_s.snakecase) do
+        @info[track_attribute]
+      end
     end
 
     # def slug

data/lib/apple_music_library/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AppleMusicLibrary
-  VERSION = "0.2.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apple_music_library
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Todd Gehman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -128,6 +129,7 @@ files:
 - lib/apple_music_library/genre.rb
 - lib/apple_music_library/library.rb
 - lib/apple_music_library/playlist.rb
+- lib/apple_music_library/playlist_folder.rb
 - lib/apple_music_library/track.rb
 - lib/apple_music_library/utils.rb
 - lib/apple_music_library/version.rb
@@ -156,6 +158,6 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: Provides a ruby OO interface to the information stored in an Apple Music
-  (formerly iTunes) Library xml file.
+summary: Provides a Ruby interface to the information stored in an Apple Music (formerly
+  iTunes) Library xml file.
 test_files: []