apple_music_library 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90fcf6cf83ff9c5cf4bf0cf022ad5b4038c0464277a86e20c658580661cb233a
-  data.tar.gz: 3498457024ed7a40644dc14baa9eccb7b1f072e92d28f7739cf49959c86d90ea
+  metadata.gz: be251230181d53ca2f311d1b3fe47f60773c16300f3c7c115761e98bfa8da47b
+  data.tar.gz: e0ebe21930daf26dacca4d16e4ff94f5fad36da8a2e07e06ae4fa8b94ef7d721
 SHA512:
-  metadata.gz: 86f0e0d87e57d27a93034f0b055399c37c2a265984726eba7b1dc2e6ddd15a2ebb34a11676c64411417e772320ec170bad7b52eb91c35f703a9cd6286c923a74
-  data.tar.gz: 4ebe190007f3e9426dfe6968b61934cea5bc23e63cb72d4a824de9ff5a97061abd27b9dc91639c4af8492f438d04623338581a5c99697dbb920cbc1f89d6af19
+  metadata.gz: a9ddddc083a2d4621110b304d32474fc1164471c67ec3c671a33ae5cbe40bc51ce6bb23b51c7a930d456fd9c8f33300dbd67b39e553ecf15558a3ae54515e774
+  data.tar.gz: 1b08775b63e98f7e1eae53c6caa2ec5f6dbed16ba4b2c97df5ee41dfa8b836116ef58cf370b3b689485bad38d31e151f8dae732b337798d74dd5b6c172b94f9c

data/CHANGELOG.md

@@ -3,7 +3,19 @@
 ## [Unreleased]
 - Ability to print out playlist folder hierarchy
 
-## 0.4.0 - 2022-03-10
+## 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 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    apple_music_library (0.4.0)
+    apple_music_library (0.7.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:
@@ -44,6 +48,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

@@ -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/album.rb

@@ -1,16 +1,18 @@
+require_relative 'track_collection'
+
 module AppleMusicLibrary
-  class Album
+  class Album < TrackCollection
     attr_reader :artist
 
 
-    attr_reader :artist, :album_name, :tracks
+    attr_reader :artist
 
     @@albums = {}
 
     def initialize(artist, album_name)
       @artist = artist
       @album_name = album_name
-      @tracks = []
+      super
     end
 
     def self.all
@@ -29,13 +31,20 @@ module AppleMusicLibrary
       "#{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

@@ -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/genre.rb

@@ -1,13 +1,13 @@
 module AppleMusicLibrary
-  class Genre
+  class Genre < TrackCollection
 
-    attr_reader :name, :tracks
+    attr_reader :name
 
     @@genres = {}
 
     def initialize(name)
       @name = name
-      @tracks = []
+      super
     end
 
     def self.all
@@ -25,11 +25,5 @@ module AppleMusicLibrary
       @@genres[name]
     end
 
-    def add_track(track)
-      unless tracks.include?(track)
-        @tracks << track
-      end
-    end
-
   end
 end

data/lib/apple_music_library/library.rb

@@ -44,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)
@@ -76,8 +76,8 @@ module AppleMusicLibrary
       PlaylistFolder.find_by_name(playlist_folder_name)
     end
 
-    def tracks
-      @tracks ||= Track.all
+    def tracks(filter = nil)
+      filter.present? ? Track.send(filter) : Track.all
     end
 
     def track(track_id)
@@ -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

@@ -24,6 +24,7 @@ module AppleMusicLibrary
                   'Rating',
                   'Album Rating',
                   'Album Rating Computed',
+                  'Loved',
                   'Normalization',
                   'Persistent ID',
                   'Track Type',
@@ -37,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)
@@ -55,6 +59,10 @@ module AppleMusicLibrary
       @@tracks.values
     end
 
+    def self.loved
+      @loved ||= self.all.select{|t| t.loved?}
+    end
+
     def id
       track_id
     end      
@@ -71,6 +79,18 @@ module AppleMusicLibrary
       @info['Genre']
     end
 
+    def star_rating
+      rating / 20
+    end
+
+    def rated?
+      rating > 0 and rating <= 100
+    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/track_collection.rb

@@ -0,0 +1,26 @@
+module AppleMusicLibrary
+  class TrackCollection
+
+    attr_reader :tracks
+
+    def initialize(*args)
+      @tracks = []
+    end
+
+    def add_track(track)
+      @tracks << track
+    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
+
+  end
+end

data/lib/apple_music_library/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apple_music_library
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Todd Gehman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-03-12 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
@@ -140,6 +141,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: