apple_music_library 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 840cb609f61bcb54a260d57acc3e6f5ff4ac72acbaf582bba56aeb1cc1b4bcd7
-  data.tar.gz: 9987bdbcf17275cdddc99ec4fa81f815932ffe394eb1e9d48b98bfd68016c1c2
+  metadata.gz: 63c39fb0820781890a73912185de50cd207af719b59d25a022626374f1ab8eac
+  data.tar.gz: 99d363ef519977c4b2786684e539289a58cf76503e397c34c7060f42a02c52aa
 SHA512:
-  metadata.gz: aa00cf271b73e5465a5c383a85002071211f615bbd6244977f2480bff5e3c44f783d46fcd050db5702958b84e24a27c3195b8e2987062213a065ec21a962365f
-  data.tar.gz: 6d1f93fc11f8dc2e7a64e0a94c073b5aac70e5e5ee3389e17b7ca3d02b86b329069f3c507bbca9d93c9ba1576cf1394809e0913918f9e59e56d8b29d4aec3482
+  metadata.gz: e8f45294602867c1de2a10ad3dbe1d88ad02508dc6060712c0cdb436e032c93ea5eb35f69eb0a9e9f1c5dae98089666d8928919f140b668d1c8980b11a7ec517
+  data.tar.gz: d0724a89d0d22c4be3a65550253284e176102e3c2c2f085ace60418516ba333ed7ebbdc25fda382ee18303d47bf29eeef256b533b231c733813f473c3c28a3a5

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+## [Unreleased]
+- Ability to print out playlist folder hierarchy
+
+## 0.6.0 - 2022-03-11
+### Added
+- Ability to sort list top artists by play count
+
+## 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.3.0)
+    apple_music_library (0.6.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,14 @@ end
 artist = library.artist('XTC')
 puts artist.tracks.count
 
+# Get favorite tracks by this artist
+favorite_tracks = artist.tracks.select{|t| t.loved? || t.star_rating > 3}
+
+# List out the most played artists
+library.artists(:most_played).each do |artist|
+  puts "#{artist.play_count} :: #{artist.name}"
+end
+
 # 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"
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/pugetive/apple_music_library"
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["changelog_uri"] = "https://github.com/pugetive/apple_music_library/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/apple_music_library/artist.rb

@@ -15,6 +15,14 @@ module AppleMusicLibrary
       @@artists.values
     end
 
+    def self.most_played(limit = 20)
+      if limit.nil?
+        self.all.sort_by(&:play_count).reverse
+      else
+        self.all.sort_by(&:play_count).reverse.take(limit)
+      end
+    end
+
     def self.find_or_create(name)
       if @@artists[name]
         return @@artists[name]
@@ -49,5 +57,9 @@ module AppleMusicLibrary
       @tracks
     end
 
+    def play_count
+      tracks.map(&:play_count).sum
+    end
+
   end
 end

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'
@@ -43,8 +44,8 @@ module AppleMusicLibrary
       @albums ||= Album.all
     end
 
-    def artists
-      @artists ||= Artist.all
+    def artists(filter = nil, limit = nil)
+      filter.present? ? Artist.send(filter, limit) : Artist.all
     end
 
     def artist(artist_name)
@@ -67,8 +68,16 @@ module AppleMusicLibrary
       Playlist.find_by_name(playlist_name)
     end
 
-    def tracks
-      @tracks ||= Track.all
+    def playlist_folders
+      @playlist_folders ||= PlaylistFolder.all
+    end
+
+    def playlist_folder(playlist_folder_name)
+      PlaylistFolder.find_by_name(playlist_folder_name)
+    end
+
+    def tracks(filter = nil)
+      filter.present? ? Track.send(filter) : Track.all
     end
 
     def track(track_id)
@@ -108,89 +117,12 @@ module AppleMusicLibrary
 
     def extract_playlists_from_plist
       plist['Playlists'].each do |playlist_info|
-        Playlist.new(playlist_info, self)
+        # The distinction between playlists and playlist folders
+        #   is made inside the Playlist instantiation
+        Playlist.new(playlist_info)
       end
     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
-    #   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 = Artist.find_or_create(track.artist_name)
-    #       album = add_track_to_album(track, track.album)
-    #       artist.add_album(album)
-
-    #       if track.genre_name.present?
-    #         genre = add_track_to_genre(track)
-    #       end
-    #     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)      
-    #   Artist.find_or_create(artist_name)
-    # end
-
-    # def add_track_to_album(track, album)
-    #   unless album = @albums_hash[album.id]
-    #     @albums_hash[album.id] = album
-    #   end
-    #   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]
-    #   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
 
 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
@@ -25,18 +11,20 @@ module AppleMusicLibrary
                   '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
 
-      return nil if folder?
+      if folder?
+        return PlaylistFolder.new(info)
+      end
 
-      @library = library
       @tracks = []
 
       load_tracks
@@ -49,11 +37,15 @@ module AppleMusicLibrary
     end
 
     def self.find_by_name(playlist_name)
-      @@playlists.values.select{|p| p.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|
@@ -72,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
@@ -81,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

@@ -24,6 +24,7 @@ module AppleMusicLibrary
                   'Rating',
                   'Album Rating',
                   'Album Rating Computed',
+                  'Loved',
                   'Normalization',
                   'Persistent ID',
                   'Track Type',
@@ -55,6 +56,10 @@ module AppleMusicLibrary
       @@tracks.values
     end
 
+    def self.loved
+      @loved ||= self.all.select{|t| t.loved?}
+    end
+
     def id
       track_id
     end      
@@ -71,6 +76,14 @@ module AppleMusicLibrary
       @info['Genre']
     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]

data/lib/apple_music_library/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apple_music_library
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.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
@@ -138,6 +140,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/pugetive/apple_music_library
   source_code_uri: https://github.com/pugetive/apple_music_library
+  changelog_uri: https://github.com/pugetive/apple_music_library/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -156,6 +159,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: []