apple_music_library 0.6.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63c39fb0820781890a73912185de50cd207af719b59d25a022626374f1ab8eac
-  data.tar.gz: 99d363ef519977c4b2786684e539289a58cf76503e397c34c7060f42a02c52aa
+  metadata.gz: d57d33d85a24895e93ca386313d43fe9dd28c6a48bec21fbb4348ec3b168a177
+  data.tar.gz: d3d0b25dbd54fa23f03cea03b46729224d9b1054da276060a62cac40ab0016e3
 SHA512:
-  metadata.gz: e8f45294602867c1de2a10ad3dbe1d88ad02508dc6060712c0cdb436e032c93ea5eb35f69eb0a9e9f1c5dae98089666d8928919f140b668d1c8980b11a7ec517
-  data.tar.gz: d0724a89d0d22c4be3a65550253284e176102e3c2c2f085ace60418516ba333ed7ebbdc25fda382ee18303d47bf29eeef256b533b231c733813f473c3c28a3a5
+  metadata.gz: 319fb967951a32d12f0d871c32d40b56a2c4d674bbb8966de6bf6b592da5b5ed0af41f9443caf2b7b222345ded89264af85bdf75694856a8ed7e37162ab706f1
+  data.tar.gz: 148f0638affc3d19f1c96619e732280966574885fce0c66acc69e083d0cd569200e2a8535f75f96e8ef06b75fdee07b6f0ca82befd0ab8a4bcf914b86af2fff5

data/CHANGELOG.md

@@ -3,9 +3,21 @@
 ## [Unreleased]
 - Ability to print out playlist folder hierarchy
 
+## 0.9.0 - 2022-03-15
+### Added
+- Ability to get genres associated with an artist
+
+## 0.8.0 - 2022-03-13
+### Added
+- Ability to sort artists by track count and album count
+
+## 0.7.0 - 2022-03-12
+### Added
+- Average star ratings for track collectsion (albums, playlists, genres)
+
 ## 0.6.0 - 2022-03-11
 ### Added
-- Ability to sort list top artists by play count
+- Ability to list top artists by play count
 
 ## 0.5.0 - 2022-03-11
 ### Added

data/Gemfile.lock

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

data/README.md

@@ -2,6 +2,10 @@
 
 The `apple_music_library` gem offeres a ruby interface to the information stored in an iTunes / Apple Muisic `Library.xml` file, as can be generated with the app's menu option `File > Library > Export Library...`
 
+[![Maintainability](https://api.codeclimate.com/v1/badges/86a57ad0904e4358dd02/maintainability)](https://codeclimate.com/github/pugetive/apple_music_library/maintainability)
+
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -40,10 +44,15 @@ playlist.tracks.each do |track|
   puts track.name
 end
 
-# Count tracks by artist
+# Count tracks by an artist
 artist = library.artist('XTC')
 puts artist.tracks.count
 
+# List genres associated with the artist
+artist.genres.each do |genre|
+  puts genre.name
+end
+
 # Get favorite tracks by this artist
 favorite_tracks = artist.tracks.select{|t| t.loved? || t.star_rating > 3}
 
@@ -52,10 +61,21 @@ library.artists(:most_played).each do |artist|
   puts "#{artist.play_count} :: #{artist.name}"
 end
 
+# List out artists with the most tracks
+library.artists(:most_tracks).each do |artist|
+  puts "#{artist.track_count} :: #{artist.name}"
+end
+
+# List out artists with the most albums
+library.artists(:most_albums).each do |artist|
+  puts "#{artist.album_count} :: #{artist.name}"
+end
+
 # Display track counts per genre
 library.genres.each do |genre|
-  puts "#{genre.tracks.count} #{genre.name}"
+  puts "#{genre.track_count} #{genre.name}"
 end
+
 ```
 All stored attributes are available via snake_cased methods on `Track` and `Playlist`. However, note that `#artist`, `#album`, and `#genre` are special cases, returning Ruby objects rather than their associated string values. Methods to return the string versions of these track attributes are provided as `track.artist_name`, `track.album_name`, and `track.genre_name`.
 

data/lib/apple_music_library/album.rb

@@ -1,16 +1,14 @@
+require_relative 'track_collection'
+
 module AppleMusicLibrary
-  class Album
+  class Album < TrackCollection
     attr_reader :artist
 
-
-    attr_reader :artist, :album_name, :tracks
-
     @@albums = {}
 
-    def initialize(artist, album_name)
+    def initialize(album_name, artist)
       @artist = artist
-      @album_name = album_name
-      @tracks = []
+      super
     end
 
     def self.all
@@ -22,20 +20,27 @@ module AppleMusicLibrary
       if @@albums[key]
         return @@albums[key]
       end
-      @@albums[key] = self.new(artist, album_name)
+      @@albums[key] = self.new(album_name, artist)
     end
 
     def id
       "#{artist.name}-#{album_name}"
     end
 
-    def add_track(track)
-      @tracks << track
+    def name
+      @album_name
     end
 
     def year
       @year ||= @tracks.sort_by(&:year).last.year
     end
 
+    def dump
+      puts "#{artist.name} - #{name}"
+      tracks.each do |track|
+        puts "\t#{track.name}"
+      end
+    end
+
   end
 end

data/lib/apple_music_library/artist.rb

@@ -16,11 +16,15 @@ module AppleMusicLibrary
     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
+      self.sorted_set(:play_count, limit)
+    end
+
+    def self.most_tracks(limit = 20)
+      self.sorted_set(:track_count, limit)
+    end
+
+    def self.most_albums(limit = 20)
+      self.sorted_set(:album_count, limit)
     end
 
     def self.find_or_create(name)
@@ -53,13 +57,34 @@ module AppleMusicLibrary
       @albums.sort_by(&:year)
     end
 
+    def album_count
+      @albums.size
+    end
+
     def tracks
       @tracks
     end
 
+    def track_count
+      @tracks.size
+    end
+
     def play_count
       tracks.map(&:play_count).sum
     end
 
+    def genres
+      @genres ||= tracks.map(&:genre).uniq
+    end
+
+    protected
+
+    def self.sorted_set(sort_by_method, limit)
+      if limit.nil?
+        self.all.sort_by{|a| a.send(sort_by_method)}.reverse
+      else
+        self.all.sort_by{|a| a.send(sort_by_method)}.reverse.take(limit)
+      end
+    end
   end
 end

data/lib/apple_music_library/genre.rb

@@ -1,35 +1,6 @@
 module AppleMusicLibrary
-  class Genre
+  class Genre < TrackCollection
 
-    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
-      end
-    end
 
   end
 end

data/lib/apple_music_library/library.rb

@@ -92,6 +92,10 @@ module AppleMusicLibrary
       tracks.any?
     end
 
+    def rated_tracks
+      tracks.select{|t| t.rated?}
+    end
+
     private
 
     def extract_plist_info

data/lib/apple_music_library/playlist.rb

@@ -1,9 +1,10 @@
 require 'facets'
+require_relative 'track_collection'
 
 module AppleMusicLibrary
-  class Playlist
+  class Playlist < TrackCollection
 
-    attr_reader :info, :tracks
+    attr_reader :info
 
     @@playlists = {}
 
@@ -25,7 +26,7 @@ module AppleMusicLibrary
         return PlaylistFolder.new(info)
       end
 
-      @tracks = []
+      super
 
       load_tracks
 

data/lib/apple_music_library/track.rb

@@ -38,6 +38,9 @@ module AppleMusicLibrary
       @info = info
       @artist = Artist.find_or_create(artist_name)
       @album = Album.find_or_create(@artist, album_name)
+      # if name.match(/Humble.*demo/)
+      #   puts "Adding track #{name} to album #{album_name}"
+      # end
       @genre = Genre.find_or_create(genre_name)
 
       @artist.add_track(self)
@@ -80,6 +83,10 @@ module AppleMusicLibrary
       rating / 20
     end
 
+    def rated?
+      rating > 0 and rating <= 100
+    end
+
     def loved?
       loved
     end

data/lib/apple_music_library/track_collection.rb

@@ -0,0 +1,56 @@
+module AppleMusicLibrary
+  class TrackCollection
+
+    attr_reader :name, :tracks
+
+    @@track_collections = {}
+
+    def initialize(name, *args)
+      @tracks = []
+      @name = name
+    end
+
+    def self.all
+      @@track_collections[token].values
+    end
+
+    def self.find_by_name(lookup_name)
+      @@track_collections[token][lookup_name]
+    end
+
+    def self.find_or_create(lookup_name)
+      unless @@track_collections[token]
+        @@track_collections[token] = {}
+      end
+      @@track_collections[token][lookup_name] = self.new(lookup_name)
+    end
+
+    def add_track(track)
+      @tracks << track
+    end
+
+    def track_count
+      @track_count ||= tracks.count
+    end
+
+    def star_rating
+      return nil if rated_tracks.empty?      
+      rated_tracks.map(&:star_rating).sum / rated_tracks.size
+    end
+
+    protected
+
+    def rated_tracks
+      @rated_tracks ||= tracks.select{|t| t.rated?}
+    end
+
+    def self.token
+      self.class.name
+    end
+
+    def token
+      self.class.token
+    end
+
+  end
+end

data/lib/apple_music_library/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apple_music_library
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Todd Gehman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -131,6 +131,7 @@ files:
 - lib/apple_music_library/playlist.rb
 - lib/apple_music_library/playlist_folder.rb
 - lib/apple_music_library/track.rb
+- lib/apple_music_library/track_collection.rb
 - lib/apple_music_library/utils.rb
 - lib/apple_music_library/version.rb
 - sig/apple_music_library.rbs
@@ -156,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.9
 signing_key:
 specification_version: 4
 summary: Provides a Ruby interface to the information stored in an Apple Music (formerly