kagu 3.0.9 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2b1c6ebb0b79f29eba4fe24a7dd3d79296ae91f0bbea0fb0fc7983bf835e281
-  data.tar.gz: ca3eccc89f387079b124934601b42d55189caeb21655dcc2ba10b4925229cf44
+  metadata.gz: d1cedd40180e7fdaaafb0a589b9497904dc1fea117988356a1b9825720d906eb
+  data.tar.gz: 6bd45283ddd23b1151928c3d5fe01fa57591df612c90604a1994271500dcf380
 SHA512:
-  metadata.gz: 9342fa71cbb60dc112d72a1578b1f0e08efe82bf2fcbafe90a3bf5bf1fb481bb5cc46df116227a5fea2076f68697dcc6bcc4eb695011acdab9b17a52ff0b7e58
-  data.tar.gz: bf93af997250a6721bce474f3004a15721245d21ca0d8efd8d47144fc3a374b3eb46695a7b249c4c0546daad8f95be8163db80db19a9e770726d470518ed2264
+  metadata.gz: 5c58699f791c9f6451aa0e2c40b98bbd8cf7749655e27b96856ed73a5273e323948891025df00d6f84f510b079b4fab00ab629e54c7d4cb6ed3a1f3268438b53
+  data.tar.gz: cb1ceb390210ae2ce2408cd9c801dd9853aa8712767e178eebac86864bb2d670a4042c190be832b55714c9570b33993ac27a314ae404f107bbd8b53f61158320

data/VERSION

@@ -1 +1 @@
-3.0.9
+4.0.0

data/kagu.gemspec

@@ -9,16 +9,20 @@ Gem::Specification.new do |s|
   s.description = 'API to manage macOS Music tracks and playlists'
   s.license = 'MIT'
 
-  s.files = `git ls-files | grep -vE '^(spec/|test/|\\.|Gemfile|Rakefile)'`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = %x(git ls-files | grep -vE '^(spec/|test/|\\.|Gemfile|Rakefile)').split("\n")
+  s.executables = %x(git ls-files -- bin/*).split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 3.1.0'
 
-  s.add_dependency 'activesupport', '>= 4.1.0', '< 7.0.0'
+  s.add_dependency 'activesupport', '>= 7.0.0', '< 8.0.0'
+  s.add_dependency 'addressable', '>= 2.7.0', '< 3.0.0'
   s.add_dependency 'applescript', '>= 1.0', '< 2.0'
 
   s.add_development_dependency 'byebug', '>= 3.2.0', '< 12.0.0'
   s.add_development_dependency 'rake', '>= 10.3.0', '< 14.0.0'
-  s.add_development_dependency 'rspec', '>= 3.1.0', '< 3.10.0'
+  s.add_development_dependency 'rspec', '>= 3.1.0', '< 3.11.0'
+  s.add_development_dependency 'rubocop', '>= 1.25.0', '< 2.0.0'
+  s.add_development_dependency 'rubocop-rake', '>= 0.6.0', '< 1.0.0'
+  s.add_development_dependency 'rubocop-rspec', '>= 2.8.0', '< 3.0.0'
 end

data/lib/kagu/finder.rb

@@ -2,7 +2,7 @@ module Kagu
 
   class Finder
 
-    MANDATORY_ATTRIBUTES = []
+    MANDATORY_ATTRIBUTES = [].freeze
 
     delegate :replace, :transliterate, to: 'self.class'
 
@@ -29,7 +29,7 @@ module Kagu
         tracks_digests.each_with_index do |hash, digests_index|
           digests(attributes).each_with_index do |digest, digest_index|
             tracks = hash[digest].presence || next
-            tracks = tracks.select { |track| !matches.any? { |match| match.try(:include?, track) } }
+            tracks = tracks.reject { |track| matches.any? { |match| match.try(:include?, track) } }
             next if tracks.empty?
             index = [digests_index, digest_index].max
             matches[index] ||= []
@@ -83,10 +83,11 @@ module Kagu
 
     def ignored=(values)
       @ignored = [values].flatten.map do |value|
-        if value.is_a?(Hash)
+        case value
+        when Hash
           value = value.stringify_keys
           value = "#{value['artist']} #{value['title']}"
-        elsif value.is_a?(Track)
+        when Track
           value = "#{value.artist} #{value.title}"
         else
           value = value.to_s

data/lib/kagu/playlist.rb

@@ -2,12 +2,12 @@ module Kagu
 
   class Playlist
 
-    MANDATORY_ATTRIBUTES = %w(name)
+    MANDATORY_ATTRIBUTES = %w(name).freeze
 
     include AttributesInitializer
     include Enumerable
 
-    attr_reader :name, :tracks
+    attr_reader :name
 
     delegate :each, to: :tracks
 
@@ -31,7 +31,7 @@ module Kagu
       return if tracks.empty?
       Kagu.logger.info('Kagu') { "Adding #{tracks.size} track(s) to playlist #{name.inspect}" }
       tracks.map(&:id).each_slice(500) do |ids|
-        AppleScript.execute(%Q{
+        AppleScript.execute("
           tell application #{Kagu::OSX_APP_NAME.inspect}
             set playlistToPush to user playlist #{name.inspect}
             set idsToAdd to {#{ids.map(&:inspect).join(',')}}
@@ -39,7 +39,7 @@ module Kagu
               duplicate (tracks of library playlist 1 whose persistent ID is idToAdd) to playlistToPush
             end repeat
           end tell
-        })
+        ")
       end
       true
     rescue => e
@@ -48,11 +48,11 @@ module Kagu
 
     def clear
       Kagu.logger.info('Kagu') { "Removing all tracks from playlist #{name.inspect}" }
-      AppleScript.execute(%Q{
+      AppleScript.execute("
         tell application #{Kagu::OSX_APP_NAME.inspect}
           delete tracks of playlist #{name.inspect}
         end tell
-      })
+      ")
       true
     rescue => e
       raise Error.new(e)
@@ -60,13 +60,13 @@ module Kagu
 
     def create
       Kagu.logger.info('Kagu') { "Creating playlist #{name.inspect}" }
-      AppleScript.execute(%Q{
+      AppleScript.execute("
         tell application #{Kagu::OSX_APP_NAME.inspect}
           if not (exists user playlist #{name.inspect}) then
             make new user playlist with properties { name: #{name.inspect} }
           end if
         end tell
-      })
+      ")
       true
     rescue => e
       raise Error.new(e)

data/lib/kagu/playlists.rb

@@ -12,27 +12,27 @@ module Kagu
       build(attributes).tap(&:save)
     end
 
-    def each(&block)
+    def each
       return unless block_given?
       Kagu.logger.debug('Kagu') { 'Loading library playlists' }
-      tracks = {}.tap do |tracks|
-        Tracks.new.each { |track| tracks[track.id] = track }
+      tracks = {}.tap do |items|
+        Tracks.new.each { |track| items[track.id] = track }
       end
       playlist_name = nil
       playlist_tracks = []
-      SwiftHelper.execute(%Q{
+      SwiftHelper.execute("
         import iTunesLibrary
 
-        let library = try! ITLibrary(apiVersion: "1")
+        let library = try! ITLibrary(apiVersion: \"1\")
         for playlist in library.allPlaylists.filter({ !$0.isMaster }) {
-          print("BEGIN_PLAYLIST")
+          print(\"BEGIN_PLAYLIST\")
           print(playlist.name)
           for track in playlist.items.filter({ $0.mediaKind == ITLibMediaItemMediaKind.kindSong }) {
             print(String(track.persistentID.uint64Value, radix: 16).uppercased())
           }
-          print("END_PLAYLIST")
+          print(\"END_PLAYLIST\")
         }
-      }) do |line|
+      ").each do |line|
         if line == 'BEGIN_PLAYLIST'
           playlist_name = nil
           playlist_tracks = []
@@ -44,6 +44,7 @@ module Kagu
           playlist_tracks << tracks[line]
         end
       end
+      nil
     end
 
   end

data/lib/kagu/swift_helper.rb

@@ -2,7 +2,7 @@ module Kagu
 
   module SwiftHelper
 
-    def self.execute(code, &block)
+    def self.execute(code)
       tempfile = Tempfile.new
       begin
         tempfile << code
@@ -12,12 +12,7 @@ module Kagu
       begin
         stdout, stderr, result = Open3.capture3("swift #{tempfile.path.inspect}")
         raise(stderr.presence || "Swift command returned with code: #{result.exitstatus}") unless result.success?
-        if block_given?
-          stdout.lines.each { |line| yield(line.chomp) }
-          nil
-        else
-          stdout
-        end
+        stdout.lines.map(&:chomp)
       ensure
         tempfile.unlink
       end

data/lib/kagu/track.rb

@@ -5,7 +5,7 @@ module Kagu
     include AttributesInitializer
     include Comparable
 
-    MANDATORY_ATTRIBUTES = %w(added_at id length path)
+    MANDATORY_ATTRIBUTES = %w(added_at id length).freeze
 
     attr_reader :added_at, :album, :artist, :bpm, :genre, :id, :length, :path, :title, :year
 
@@ -22,19 +22,14 @@ module Kagu
       super || self == other
     end
 
-    def exists?
-      path.file?
+    def exists_on_disk?
+      path.present? && path.file?
     end
 
     def hash
       [artist, title].hash
     end
 
-    def relative_path(directory)
-      directory = directory.to_s
-      directory.present? ? Pathname.new(path.to_s.gsub(/\A#{Regexp.escape(directory)}\//, '')) : path
-    end
-
     def to_s
       "#{artist} - #{title}"
     end
@@ -42,9 +37,10 @@ module Kagu
     private
 
     def added_at=(value)
-      if value.is_a?(String)
+      case value
+      when String
         value = Time.parse(value)
-      elsif value.is_a?(Integer)
+      when Integer
         value = Time.at(value)
       end
       @added_at = value.is_a?(Time) ? value.utc : nil
@@ -60,7 +56,7 @@ module Kagu
 
     def bpm=(value)
       value = value.to_s =~ /\A[0-9]+\z/ ? value.to_i : nil
-      @bpm = (value && value > 0) ? value : nil
+      @bpm = value && value > 0 ? value : nil
     end
 
     def genre=(value)
@@ -77,15 +73,9 @@ module Kagu
 
     def path=(value)
       value = value.to_s.presence
-      value = URI.unescape(URI.parse(value).path).presence if value.is_a?(String) && value.starts_with?('file://')
+      value = Addressable::URI.unescape(Addressable::URI.parse(value).path).presence if value.is_a?(String) && value.starts_with?('file://')
       value = value.encode('UTF-8', 'UTF-8-MAC') if value.present? && Kagu::IS_MAC_OS
-      if value.present?
-        @path = Pathname.new(value)
-        raise Error.new("No such file: #{path.to_s.inspect}") if path.exist? && !exists?
-        Kagu.logger.error('Kagu') { "No such track: #{path.inspect}" } unless exists?
-      else
-        @path = nil
-      end
+      @path = value.present? ? Pathname.new(value) : nil
     end
 
     def title=(value)

data/lib/kagu/tracks.rb

@@ -6,44 +6,45 @@ module Kagu
 
     EXTENSIONS = %w(.aac .flac .mp3 .wav).freeze
 
-    def each(&block)
+    def each
       return unless block_given?
       Kagu.logger.debug('Kagu') { 'Loading library tracks' }
       attributes = {}
-      SwiftHelper.execute(%Q{
+      SwiftHelper.execute("
         import iTunesLibrary
 
         func printObjectProperty<T: Encodable>(name: String, value: T?) {
           let jsonEncoder = JSONEncoder()
           let jsonData = try! jsonEncoder.encode(value)
           let json = String(data: jsonData, encoding: String.Encoding.utf8)
-          print("\\(name)=\\(json!)")
+          print(\"\\(name)=\\(json!)\")
         }
 
-        let library = try! ITLibrary(apiVersion: "1")
+        let library = try! ITLibrary(apiVersion: \"1\")
         for track in library.allMediaItems.filter({ $0.mediaKind == ITLibMediaItemMediaKind.kindSong }) {
-          print("BEGIN_TRACK")
-          printObjectProperty(name: "added_at", value: track.addedDate!.timeIntervalSince1970)
-          printObjectProperty(name: "album", value: track.album.title)
-          printObjectProperty(name: "artist", value: track.artist!.name)
-          printObjectProperty(name: "bpm", value: track.beatsPerMinute)
-          printObjectProperty(name: "genre", value: track.genre)
-          printObjectProperty(name: "id", value: String(track.persistentID.uint64Value, radix: 16).uppercased())
-          printObjectProperty(name: "length", value: track.totalTime)
-          printObjectProperty(name: "path", value: track.location)
-          printObjectProperty(name: "title", value: track.title)
-          printObjectProperty(name: "year", value: track.year)
-          print("END_TRACK")
+          print(\"BEGIN_TRACK\")
+          printObjectProperty(name: \"added_at\", value: track.addedDate!.timeIntervalSince1970)
+          printObjectProperty(name: \"album\", value: track.album.title)
+          printObjectProperty(name: \"artist\", value: track.artist!.name)
+          printObjectProperty(name: \"bpm\", value: track.beatsPerMinute)
+          printObjectProperty(name: \"genre\", value: track.genre)
+          printObjectProperty(name: \"id\", value: String(track.persistentID.uint64Value, radix: 16).uppercased())
+          printObjectProperty(name: \"length\", value: track.totalTime)
+          printObjectProperty(name: \"path\", value: track.location)
+          printObjectProperty(name: \"title\", value: track.title)
+          printObjectProperty(name: \"year\", value: track.year)
+          print(\"END_TRACK\")
         }
-      }) do |line|
+      ").each do |line|
         if line == 'BEGIN_TRACK'
           attributes = {}
         elsif line == 'END_TRACK'
           yield(Track.new(attributes))
-        elsif match = /(^\w+)=(.*)/.match(line)
+        elsif (match = /(^\w+)=(.*)/.match(line))
           attributes[match[1]] = JSON.parse(match[2])
         end
       end
+      nil
     end
 
   end

data/lib/kagu.rb

@@ -1,5 +1,6 @@
 require 'active_support'
 require 'active_support/core_ext'
+require 'addressable/uri'
 require 'applescript'
 require 'byebug' if ENV['DEBUGGER']
 require 'logger'
@@ -14,9 +15,7 @@ module Kagu
   IS_MAC_OS = RUBY_PLATFORM =~ /darwin/
   OSX_APP_NAME = begin
     if IS_MAC_OS
-      `sw_vers -productVersion`.chomp.to_f >= 10.15 ? 'Music' : 'iTunes'
-    else
-      nil
+      %x(sw_vers -productVersion).chomp.to_f >= 10.15 ? 'Music' : 'iTunes'
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kagu
 version: !ruby/object:Gem::Version
-  version: 3.0.9
+  version: 4.0.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2022-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,20 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 7.0.0
     - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 2.7.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: applescript
   requirement: !ruby/object:Gem::Requirement
@@ -99,7 +119,7 @@ dependencies:
         version: 3.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -109,7 +129,67 @@ dependencies:
         version: 3.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: API to manage macOS Music tracks and playlists
 email: al@alweb.org
 executables: []
@@ -142,14 +222,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: API for macOS Music