musicapp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5502b9d74f1058162f63e3d699eba347382f2c5e68e6b882c26b0c221425bd0d
+  data.tar.gz: e2377983af7cf564251f262971a1569e1bdf8b998845018a319c069a2d9b43ca
+SHA512:
+  metadata.gz: d319affe2f460b17d875d7cd879471b0ed377e1a5d45470a1938f378f138a69e5b798dab296b5fe3b8d5484e03196c1a5144c89a431ca82473a456d005cc85a9
+  data.tar.gz: efd5a73da7d492945352c7255864de9d9538894dcf8f68f5273762459a5d0db405a429a8d4bd5161aeb155a7ba337ee4fc6d64cfd6ebbb3196bf77a08880593f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,126 @@
+AllCops:
+  Exclude:
+    - bin/*
+    - node_modules/**/*
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/EmptyLinesAroundAccessModifier:
+  EnforcedStyle: only_before
+
+Layout/SpaceInLambdaLiteral:
+  EnforcedStyle: require_space
+
+Layout/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashSyntax:
+  Exclude:
+    - Rakefile
+    - "**/*.rake"
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '()'
+    '%w': '()'
+    '%r': '()'
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/ZeroLengthPredicate:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Unreleased

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in musicapp.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 0.85.0"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    musicapp (0.1.0)
+      pastel (~> 0.7.4)
+      thor (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    equatable (0.6.1)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    pastel (0.7.4)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.85.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    thor (1.0.1)
+    tty-color (0.5.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  musicapp!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.85.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 labocho
+
+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,62 @@
+# musicapp
+
+`musicapp` is a command to control Apple's Music.app.
+Now, this supports following.
+
+* Get metadata of selected tracks as JSON.
+* Set metadata of selected tracks by JSON.
+* Play, Pause, and skip to next track.
+
+## Installation
+
+    $ gem install musicapp
+
+Or
+
+    $ git clone https://github.com/labocho/musicapp.git
+    $ cd musicapp
+    $ bundle install
+    $ bundle exec rake install
+
+## Usage
+
+    # Show help
+    $ musicapp help
+
+    # Play, Pause, Skip to next track
+    $ musicapp play
+    $ musicapp stop
+    $ musicapp skip
+
+    # Get metadata of selected tracks
+    $ musicapp get --field name,trackNumber
+    {"name":"Hello, World!","trackNumber":12}
+    {"name":"foobar","trackNumber":13}
+
+    # Set metadata of selected tracks
+    $ cat <<EOS | musicapp set
+    {"name":"Hello, World!!!","trackNumber":11}
+    {"name":"foobar!!","trackNumber":12}
+    EOS
+
+    # List available metadata fields
+    $ musicapp fields
+    album
+    albumArtist
+    albumDisliked
+    ...
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/musicapp.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "musicapp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/musicapp

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require "musicapp"
+Musicapp::Cli.start(ARGV)

data/lib/musicapp.rb

@@ -0,0 +1,9 @@
+require "musicapp/version"
+
+module Musicapp
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+require "musicapp/cli"
+require "musicapp/script"

data/lib/musicapp/cli.rb

@@ -0,0 +1,83 @@
+require "thor"
+require "pastel"
+
+module Musicapp
+  class Cli < Thor
+    desc "get", "Get and print metadata"
+    option :field, aliases: :f, type: :string
+    def get
+      fields = case options[:field]
+      when "all"
+        :all
+      when nil
+        :default
+      else
+        options[:field].split(",")
+      end
+
+      Script.get_metadata(fields).each do |track|
+        puts track.to_json
+      end
+    rescue ::Musicapp::Error => e
+      color_warn e.message
+      exit 1
+    end
+
+    desc "set", "Set metadata"
+    def set
+      new_metadata = $stdin.read.each_line.map {|l| JSON.parse(l) }
+      properties = new_metadata.flat_map(&:keys).uniq.sort
+      current_metadata = Script.get_metadata(properties | %w(name))
+
+      current_metadata.zip(new_metadata).each do |(current_value, new_value)|
+        puts current_value["name"]
+        new_value.each do |k, v|
+          puts "  #{k}:"
+          puts "     #{current_value[k]}"
+          puts "  -> #{v}"
+        end
+      end
+
+      print "Update?: "
+      exit 1 unless $stdin.gets.chomp =~ /^y(es)?/i
+
+      Script.set_metadata(new_metadata)
+      puts "Complete!"
+    rescue ::Musicapp::Error => e
+      color_warn e.message
+      exit 1
+    rescue ::JSON::ParserError => e
+      color_warn e.message
+      exit 2
+    end
+
+    desc "fields", "List available fields"
+    def fields
+      Script::FULL_PROPERTIES.sort.each do |f|
+        puts f
+      end
+    end
+
+    desc "play", "Play"
+    def play
+      Script.play
+    end
+
+    desc "pause", "Pause"
+    def pause
+      Script.pause
+    end
+
+    desc "next", "Advance to the next track"
+    def next
+      Script.next_track
+    end
+
+    private
+    def color_warn(message)
+      pastel = Pastel.new
+      message = pastel.red(message) if pastel.enabled?
+      warn message
+    end
+  end
+end

data/lib/musicapp/script.rb

@@ -0,0 +1,240 @@
+# rubocop:disable Naming/AccessorMethodName
+require "shellwords"
+require "open3"
+require "json"
+
+module Musicapp
+  module Script
+    class ScriptError < ::Musicapp::Error; end
+
+    ITEM_PROPERTIES = %w(
+      name
+    ).map(&:freeze).freeze
+    TRACK_PROPERTIES = %w(
+      album
+      albumArtist
+      albumDisliked
+      albumLoved
+      albumRating
+      albumRatingKind
+      artist
+      bitRate
+      bookmark
+      bookmarkable
+      bpm
+      category
+      cloudStatus
+      comment
+      compilation
+      composer
+      databaseID
+      dateAdded
+      description
+      discCount
+      discNumber
+      disliked
+      downloaderAppleID
+      downloaderName
+      duration
+      enabled
+      episodeID
+      episodeNumber
+      eq
+      finish
+      gapless
+      genre
+      grouping
+      kind
+      longDescription
+      loved
+      lyrics
+      mediaKind
+      modificationDate
+      movement
+      movementCount
+      movementNumber
+      playedCount
+      playedDate
+      purchaserAppleID
+      purchaserName
+      rating
+      ratingKind
+      releaseDate
+      sampleRate
+      seasonNumber
+      shufflable
+      skippedCount
+      skippedDate
+      show
+      sortAlbum
+      sortArtist
+      sortAlbumArtist
+      sortName
+      sortComposer
+      sortShow
+      size
+      start
+      time
+      trackCount
+      trackNumber
+      unplayed
+      volumeAdjustment
+      work
+      year
+    ).map(&:freeze).freeze
+    FILE_TRACK_PROPERTIES = %w(
+      location
+    ).map(&:freeze).freeze
+    FULL_PROPERTIES = (ITEM_PROPERTIES + TRACK_PROPERTIES + FILE_TRACK_PROPERTIES).freeze
+    DEFAULT_PROPERTIES = %w(album albumArtist artist discCount discNumber name trackCount trackNumber location).map(&:freeze).freeze
+    READONLY_PROPERTIES = %w(
+      albumRatingKind
+      bitRate
+      cloudStatus
+      databaseID
+      dateAdded
+      downloaderAppleID
+      downloaderName
+      duration
+      kind
+      modificationDate
+      purchaserAppleID
+      purchaserName
+      ratingKind
+      releaseDate
+      sampleRate
+      size
+      time
+    ).map(&:freeze).freeze
+    WRITABLE_PROPERTIES = (FULL_PROPERTIES - READONLY_PROPERTIES).freeze
+
+    module_function
+
+    def osascript(script, *args)
+      out, err, status = Open3.capture3("osascript", "-l", "JavaScript", "-e", script, *args)
+      unless status.success?
+        raise ScriptError, err
+      end
+
+      [out, err, status]
+    end
+
+    def get_metadata(properties)
+      properties = case properties
+      when :all
+        FULL_PROPERTIES
+      when :default
+        DEFAULT_PROPERTIES
+      else
+        invalid = properties - FULL_PROPERTIES
+        unless invalid.empty?
+          raise ::Musicapp::Error, "Unknown properties: #{invalid.inspect}"
+        end
+
+        properties
+      end
+
+      script = <<~JS
+        function run(argv) {
+          var itunes = Application("Music");
+          var selection = itunes.browserWindows[0].selection();
+          var trackProperties = JSON.parse(argv[0]);
+          var tracks = [];
+
+          for (var i in selection) {
+            var props = {};
+            var track = selection[i];
+
+            for (var j in trackProperties) {
+              var prop = trackProperties[j];
+              switch(prop) {
+                case "location":
+                  if (track.class() != "fileTrack") continue;
+                  props.location = track.location().toString();
+                  break;
+                default:
+                  props[prop] = track[prop]();
+              }
+            }
+
+            tracks.push(props);
+          }
+
+          return JSON.stringify(tracks);
+        }
+      JS
+
+      out, _err, _status = osascript(script, properties.to_json)
+      JSON.parse(out)
+    end
+
+    def set_metadata(metadata)
+      script = <<~JS
+        function run(argv) {
+          var itunes = Application("Music");
+          var selection = itunes.browserWindows[0].selection();
+          var metadata = JSON.parse(argv[0]);
+          var track = null;
+
+          for (var i in selection) {
+            track = metadata[i]
+            if (!track) continue;
+
+            for (var j in track) {
+              var prop = track[j];
+              selection[i][j] = prop;
+            }
+          }
+        }
+      JS
+
+      invalid = metadata.flat_map do |track|
+        track.keys - WRITABLE_PROPERTIES
+      end
+
+      unless invalid.empty?
+        raise ::Musicapp::Error, "Unknown or readonly properties: #{invalid.inspect}"
+      end
+
+      out, _err, _status = osascript(script, metadata.to_json)
+      out
+    end
+
+    def play
+      script = <<~JS
+        function run(argv) {
+          var itunes = Application("Music");
+          itunes.play();
+        }
+      JS
+
+      out, _err, _status = osascript(script)
+      out
+    end
+
+    def pause
+      script = <<~JS
+        function run(argv) {
+          var itunes = Application("Music");
+          itunes.pause();
+        }
+      JS
+
+      out, _err, _status = osascript(script)
+      out
+    end
+
+    def next_track
+      script = <<~JS
+        function run(argv) {
+          var itunes = Application("Music");
+          itunes.nextTrack();
+        }
+      JS
+
+      out, _err, _status = osascript(script)
+      out
+    end
+  end
+end
+# rubocop:enable Naming/AccessorMethodName

data/lib/musicapp/version.rb

@@ -0,0 +1,3 @@
+module Musicapp
+  VERSION = "0.1.0".freeze
+end

data/musicapp.gemspec

@@ -0,0 +1,30 @@
+require_relative "lib/musicapp/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "musicapp"
+  spec.version       = Musicapp::VERSION
+  spec.authors       = ["labocho"]
+  spec.email         = ["labocho@penguinlab.jp"]
+
+  spec.summary       = "CLI for Apple's Music.app"
+  spec.description   = "CLI for Apple's Music.app"
+  spec.homepage      = "https://github.com/labocho/musicapp"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/labocho/musicapp"
+  spec.metadata["changelog_uri"] = "https://github.com/labocho/musicapp/master/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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r(^exe/)) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pastel", "~> 0.7.4"
+  spec.add_dependency "thor", "~> 1.0"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: musicapp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- labocho
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.4
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: CLI for Apple's Music.app
+email:
+- labocho@penguinlab.jp
+executables:
+- musicapp
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rubocop
+- bin/setup
+- exe/musicapp
+- lib/musicapp.rb
+- lib/musicapp/cli.rb
+- lib/musicapp/script.rb
+- lib/musicapp/version.rb
+- musicapp.gemspec
+homepage: https://github.com/labocho/musicapp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/labocho/musicapp
+  source_code_uri: https://github.com/labocho/musicapp
+  changelog_uri: https://github.com/labocho/musicapp/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: CLI for Apple's Music.app
+test_files: []