apple_music_library 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d1148dd5f546044638ace3b635c61799d36f427cdf380e19d146be4ab55a0128
+  data.tar.gz: ceeafe5ace4e3ac2d76aa34bb2695592584799755b9318ce99b055bdfc971f83
+SHA512:
+  metadata.gz: 289f57dc10c8ec89d0ddf9506fbea8083ab8c6d07d0bfc1b060d481434e47e375e73bb8e6b5518570babd5add4f24bb3817a2bf6dce5108f173edbe43ed5b506
+  data.tar.gz: 0276d14ab7d07c5b2aaf1c56c95494ddb81680a2d6811ce3c5a0254e3f93a18fbbf8c8d85223de7b6ea0ec110a00748cc9727d936c46c98c5fd87ab4f0d98aa6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in apple_music_library.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    apple_music_library (0.2.0)
+      facets (~> 3.1)
+      plist (~> 3.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.9.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    facets (3.1.0)
+    plist (3.6.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  apple_music_library!
+  awesome_print (~> 1.9)
+  bundler (~> 2.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.21)
+
+BUNDLED WITH
+   2.3.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Todd Gehman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# AppleMusicLibrary
+
+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...`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apple_music_library'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install apple_music_library
+
+## Usage
+
+```ruby
+
+# Create library
+library = AppleMusicLibrary.new('path/to/Library.xml')
+
+# Count albums
+puts library.albums.count
+
+# Show tracks in a specific playlist
+playlist = library.playlist('XTC Favorites')
+playlist.tracks.each do |track|
+  puts track.name
+end
+
+# Count tracks by artist
+artist = library.artist('XTC')
+puts artist.tracks.count
+
+# Display track counts per genre
+library.genres.each do |genre|
+  puts "#{genre.tracks.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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pugetive/apple-music-library.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/apple_music_library.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "lib/apple_music_library/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "apple_music_library"
+  spec.version = AppleMusicLibrary::VERSION
+  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.description = "TODO: Write a longer description or delete this line."
+  spec.homepage = "https://github.com/pugetive/apple_music_library"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  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."
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.add_development_dependency "awesome_print", "~> 1.9"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.21"
+
+  spec.add_runtime_dependency "plist", "~> 3.6"
+  spec.add_runtime_dependency "facets", "~> 3.1"
+
+end

data/lib/apple_music_library/album.rb

@@ -0,0 +1,27 @@
+module AppleMusicLibrary
+  class Album
+    attr_reader :artist
+
+
+    attr_reader :artist, :album_name, :tracks
+
+    def initialize(artist, album_name)
+      @artist = artist
+      @album_name = album_name
+      @tracks = []
+    end
+
+    def id
+      "#{artist.name}-#{album_name}"
+    end
+
+    def add_track(track)
+      @tracks << track
+    end
+
+    def year
+      @year ||= tracks.sort(&:year).last.year
+    end
+
+  end
+end

data/lib/apple_music_library/artist.rb

@@ -0,0 +1,27 @@
+module AppleMusicLibrary
+  class Artist
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+      @albums = []
+    end
+
+    def add_album(album)
+      unless albums.include?(album)
+        @albums << album
+      end
+    end
+
+
+    def albums
+      @albums.sort(&:year)
+    end
+
+    def tracks
+      @tracks ||= @albums.map(&:tracks).flatten
+    end
+
+  end
+end

data/lib/apple_music_library/genre.rb

@@ -0,0 +1,18 @@
+module AppleMusicLibrary
+  class Genre
+
+    attr_reader :name, :tracks
+
+    def initialize(name)
+      @name = name
+      @tracks = []
+    end
+
+    def add_track(track)
+      unless tracks.include?(track)
+        @tracks << track
+      end
+    end
+
+  end
+end

data/lib/apple_music_library/library.rb

@@ -0,0 +1,176 @@
+require_relative 'album'
+require_relative 'artist'
+require_relative 'genre'
+require_relative 'playlist'
+require_relative 'track'
+require_relative "utils"
+require 'plist'
+
+module AppleMusicLibrary
+  class Library
+  
+    include Utils
+
+    MUSIC_FORMATS = [
+      'AAC audio file',
+      'AIFF audio file',
+      'Matched AAC audio file',
+      'MPEG audio file',
+      'MPEG-4 audio file',
+      'Protected AAC audio file',
+      'Purchased AAC audio file'
+    ]
+
+    attr_reader :plist
+
+    def initialize(music_library_file_path, verbose = false)
+      @verbose = verbose
+      message("Initializing library with #{music_library_file_path}")
+
+      unless File.file?(music_library_file_path)
+        raise Error.new("Supplied library file path name does not exist: [#{music_library_file_path}]")
+      end
+      begin
+        @plist = Plist.parse_xml(music_library_file_path)
+      rescue => e
+        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
+    end
+
+    def artists
+      @artists_hash.values
+    end
+
+    def artist(artist_name)
+      artists.find{|a| a.name == artist_name}
+    end
+
+    def albums
+      @albums_hash.values
+    end
+
+    def playlists
+      @playlists_hash.values
+    end
+
+    def playlist(playlist_name)
+      playlists.find{|p| p.name == playlist_name}
+    end
+
+
+    def albums
+      @albums_hash.values
+    end
+
+    def genres
+      @genres_hash.values.sort_by{|g| g.name}
+    end
+
+    def genre(genre_name)
+        genres.find{|g| g.name == genre_name}
+    end
+
+    def valid?
+      has_tracks?
+    end
+
+    def has_tracks?
+      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
+      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
+        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]
+      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

@@ -0,0 +1,68 @@
+# <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
+  class Playlist
+
+    attr_reader :info, :tracks
+
+    ATTRIBUTES = ['Name',
+                  'Description',
+                  'Playlist ID',
+                  'Playlist Persistent ID',
+                  'All Items',
+                  'Smart Info',
+                  'Smart Criteria',
+                  'Playlist Items',
+                  'Folder']
+
+    def initialize(info, library)
+      @info = info
+      @library = library
+      @tracks = []
+
+      load_tracks
+    end
+
+    def id
+      playlist_id
+    end                
+
+    ATTRIBUTES.each do |attribute|
+      define_method(attribute.to_s.snakecase) do
+        info[attribute]
+      end
+    end
+
+    def folder?
+      folder.present?
+    end
+
+    private
+
+    def load_tracks
+      if playlist_items and playlist_items.any?
+        playlist_items.each do |playlist_item|
+          track_id = playlist_item['Track ID']
+          track = @library.track(track_id)
+          @tracks << track
+        end
+      end
+    end
+
+    
+  end
+end

data/lib/apple_music_library/track.rb

@@ -0,0 +1,69 @@
+require 'facets'
+
+module AppleMusicLibrary
+  class Track
+    attr_reader :info, :artist, :album
+
+    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',
+                  'Kind',
+                  'Size',
+                  'Total Time',
+                  'Track Number',
+                  'Year',
+                  'Date Modified',
+                  'Date Added',
+                  'Bit Rate',
+                  'Sample Rate',
+                  'Play Count',
+                  'Play Date',
+                  'Play Date UTC',
+                  'Rating',
+                  'Album Rating',
+                  'Album Rating Computed',
+                  'Normalization',
+                  'Persistent ID',
+                  'Track Type',
+                  'Location',
+                  'File Folder Count',
+                  'Library Folder Count']
+
+    def initialize(info)
+      @info = info
+      @artist = Artist.new(artist_name)
+      @album = Album.new(@artist, album_name)
+    end
+
+    def id
+      track_id
+    end      
+
+    def artist_name
+      info['Artist']
+    end
+
+    def album_name
+      info['Album']
+    end
+
+    def genre_name
+      info['Genre']
+    end
+
+    ATTRIBUTES.each do |attribute|
+      define_method(attribute.to_s.snakecase) do
+        info[attribute]
+      end
+
+    end
+
+    # def slug
+    #   "#{name}::#{artist.name}::#{album}::#{disc_number}::#{track_number}"
+    # end
+  
+  end
+end
+

data/lib/apple_music_library/utils.rb

@@ -0,0 +1,28 @@
+require 'awesome_print'
+
+module AppleMusicLibrary
+  module Utils
+
+    def message(text)
+      return unless @verbose
+      puts "---------------------------------------------------------------------------"
+      puts "DEV MESSAGE @ #{Time.now.strftime('%H:%M:%S')} ::: #{text}"
+      puts "---------------------------------------------------------------------------"
+    end
+
+    def heading(text)
+      puts
+      puts "---------------------------------------------------------------------------"
+      puts "#{text} [#{delimit(songs.size)} songs]"
+      puts "- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -"
+    end
+
+    def delimit(number)
+      number.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+    end
+
+    def dump
+      ap plist
+    end
+  end
+end

data/lib/apple_music_library/version.rb

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

data/lib/apple_music_library.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "apple_music_library/library"
+require_relative "apple_music_library/version"
+
+module AppleMusicLibrary
+  class Error < StandardError; end
+
+  def self.new(music_library_file_path, verbose = false)
+    AppleMusicLibrary::Library.new(music_library_file_path, verbose)
+  end
+
+end

data/sig/apple_music_library.rbs

@@ -0,0 +1,4 @@
+module AppleMusicLibrary
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: apple_music_library
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Todd Gehman
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description:
+email:
+- github@pugetive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- apple_music_library.gemspec
+- lib/apple_music_library.rb
+- lib/apple_music_library/album.rb
+- lib/apple_music_library/artist.rb
+- lib/apple_music_library/genre.rb
+- lib/apple_music_library/library.rb
+- lib/apple_music_library/playlist.rb
+- lib/apple_music_library/track.rb
+- lib/apple_music_library/utils.rb
+- lib/apple_music_library/version.rb
+- sig/apple_music_library.rbs
+homepage: https://github.com/pugetive/apple_music_library
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pugetive/apple_music_library
+  source_code_uri: https://github.com/pugetive/apple_music_library
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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.
+test_files: []