muzak 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc187bfa8da7fb7a6622bf25b063aed6ab25062b
-  data.tar.gz: 85fea7679610e4f949be1b87ca8f141ba1c17d90
+  metadata.gz: 64f9b1939f3f50d2a64717f9becb02ed072f37e2
+  data.tar.gz: ff514441823414639bb1df7917517fae7e991eac
 SHA512:
-  metadata.gz: 3b74e7a470a49f5fa099d89ae843b1d3eb0b3384136da673a0eecefa0c2b007a914a87bf6c0878e31c02943397ee3b475fbbdbce26b195c2e5581129927c41c2
-  data.tar.gz: 62e8301ff354acc40ffd9d0ea858d899c9addc5fe776103e85681de2654fb1ecb57c6fe29006343a34807cb0061008a0540887e31a0d9b659350544861a3c3e5
+  metadata.gz: d49e644fb6ad60237635b412ec0c0595fcc51e60d3e2491deb9ad0aa4959afc074bd18fd0bf9d44e456baf60ed506fd5d1923756c39e2cc89f93388eef2cbbe0
+  data.tar.gz: be732cb96cf268795b9bf89f9b1eb2745c283d2fbbbd123af902bf56df13a45d97841ba3b784d56896a39d78b764cef8c80aa883d3816b0932bee18849e5e4cb

data/bin/muzak-cmd

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "muzak"
 require "socket"
@@ -8,7 +9,7 @@ require "shellwords"
 begin
   server_host = Muzak::Config.daemon_host
   server_port = Muzak::Config.daemon_port
-  sock = TCPSocket.new server_host, server_port
+  sock        = TCPSocket.new server_host, server_port
 rescue
   error = { response: { error: "muzak is not running" } }.to_json
   puts error

data/bin/muzak-dmenu

@@ -1,11 +1,12 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "muzak"
 require "socket"
 require "json"
 require "open3"
 
-DMENU_EXEC = Muzak::Config.dmenu_exec || "dmenu"
+DMENU_EXEC       = Muzak::Config.dmenu_exec || "dmenu"
 DMENU_LINES_EXEC = Muzak::Config.dmenu_lines_exec || "dmenu -l 10"
 
 def fatal(msg)
@@ -15,7 +16,8 @@ end
 
 def dmenu(options, lines: false)
   dmenu_cmd = lines ? DMENU_LINES_EXEC : DMENU_EXEC
-	opts = options.join("\n")
+  opts      = options.join("\n")
+
   Open3.popen2(dmenu_cmd) do |stdin, stdout|
     stdin.puts opts
     stdin.close
@@ -25,9 +27,7 @@ end
 
 def muzak_cmd(command)
   begin
-    server_host = Muzak::Config.daemon_host
-    server_port = Muzak::Config.daemon_port
-    sock = TCPSocket.new server_host, server_port
+    sock = TCPSocket.new Muzak::Config.daemon_host, Muzak::Config.daemon_port
   rescue
     fatal "Is muzakd running?"
   end
@@ -60,4 +60,3 @@ command = "#{command.chomp} #{arguments}" if arguments
 puts command
 
 muzak_cmd command
-

data/bin/muzak-index

@@ -1,37 +1,38 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "muzak"
 
-VERSION = 2
+VERSION = 3
 
 OPTS = {
   deep: !!(ARGV.delete("--deep") || ARGV.delete("-d")),
   verbose: !!(ARGV.delete("--verbose") || ARGV.delete("-V")),
   help: !!(ARGV.delete("--help") || ARGV.delete("-h")),
-  version: !!(ARGV.delete("--version") || ARGV.delete("-v"))
-}
+  version: !!(ARGV.delete("--version") || ARGV.delete("-v")),
+}.freeze
 
-def help
-  puts <<~EOS
-    Usage: #{$PROGRAM_NAME} [options] [tree] [index]
+HELP = <<~EOS
+  Usage: #{$PROGRAM_NAME} [options] [tree] [index]
 
-    Options:
-      --deep, -d      Build a "deep" index (contains metadata)
-      --verbose, -V   Be verbose while indexing
-      --help, -h      Print this help message
-      --version, -v   Print version information
+  Options:
+    --deep, -d      Build a "deep" index (contains metadata)
+    --verbose, -V   Be verbose while indexing
+    --help, -h      Print this help message
+    --version, -v   Print version information
 
-    Arguments:
-      [tree]          The filesystem tree to index (default: #{Muzak::Config.music})
-      [index]         The saved index (default: #{Muzak::Config::INDEX_FILE})
-  EOS
+  Arguments:
+    [tree]          The filesystem tree to index (default: #{Muzak::Config.music})
+    [index]         The saved index (default: #{Muzak::Config::INDEX_FILE})
+EOS
 
+def help
+  puts HELP
   exit
 end
 
 def version
   puts "muzak-index version #{VERSION}."
-
   exit
 end
 
@@ -55,7 +56,7 @@ index_file = ARGV.shift || Muzak::Config::INDEX_FILE
 index_hash = {
   "tree" => tree,
   "timestamp" => Time.now.to_i,
-  "deep" => OPTS[:deep]
+  "deep" => OPTS[:deep],
 }
 
 artist_names = Dir.entries(tree).reject! { |ent| ent.start_with?(".") }
@@ -70,8 +71,8 @@ artist_names.each do |artist|
 
     info "indexing '#{artist}' - '#{album}'..."
 
-    album_hash = {}
-    album_hash["songs"] = []
+    album_hash               = {}
+    album_hash["songs"]      = []
     album_hash["deep-songs"] = []
 
     Dir.glob(File.join(tree, artist, album, "**")) do |file|
@@ -79,9 +80,7 @@ artist_names.each do |artist|
 
       if Muzak::Utils.music?(file)
         album_hash["songs"] << file
-        if OPTS[:deep]
-          album_hash["deep-songs"] << Muzak::Song.new(file)
-        end
+        album_hash["deep-songs"] << Muzak::Song.new(file) if OPTS[:deep]
       end
     end
 
@@ -90,7 +89,7 @@ artist_names.each do |artist|
     # if any of the track numbers in the album are > 0 (the fallback),
     # sort by ID3 track numbers. otherwise, hope that the song
     # paths contain track numbers (e.g, "01 song.mp3").
-    if album_hash["deep-songs"].any? { |s| s.track > 0 }
+    if album_hash["deep-songs"].any? { |s| s.track.positive? }
       album_hash["deep-songs"].sort_by!(&:track)
     else
       album_hash["deep-songs"].sort_by!(&:path)

data/bin/muzak-setup

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "tty-prompt"
 require "muzak"
 
-VERSION = 1
+VERSION = 2
 
 prompt = TTY::Prompt.new
 

data/bin/muzakd

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "muzak"
 require "shellwords"
@@ -8,8 +9,7 @@ require "thread"
 
 Process.daemon unless Muzak::Config.debug || Muzak::Config.verbose
 
-muzak = Muzak::Instance.new
-
+muzak  = Muzak::Instance.new
 server = TCPServer.new Muzak::Config.daemon_port
 
 loop do
@@ -18,10 +18,10 @@ loop do
       cmd_argv = Shellwords.split(client.readline)
       client.puts(muzak.command(*cmd_argv).to_json)
       exit! 0 if cmd_argv.first == "quit"
-    rescue Exception => e
+    rescue => e
       client.puts({ response: { error: e.to_s } }.to_json)
     ensure
-      client.close if client
+      client&.close
     end
   end
 end

data/lib/muzak.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "muzak/config"
 require_relative "muzak/utils"
 require_relative "muzak/plugin"
@@ -12,5 +14,5 @@ require_relative "muzak/instance"
 # The primary namespace for muzak.
 module Muzak
   # Muzak's current version
-  VERSION = "0.4.2".freeze
+  VERSION = "0.5.0"
 end

data/lib/muzak/album.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Muzak
   # Represents a collection of songs for muzak.
   class Album
@@ -14,8 +16,8 @@ module Muzak
     # @param songs [Array<Song>] the album's songs
     # @param cover_art [String] the album's cover art
     def initialize(title, songs, cover_art = nil)
-      @title = title
-      @songs = songs
+      @title     = title
+      @songs     = songs
       @cover_art = cover_art
     end
   end

data/lib/muzak/cmd.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Dir.glob(File.join(__dir__, "cmd/*")) { |f| require_relative f }
 
 module Muzak
@@ -5,7 +7,7 @@ module Muzak
   # @see file:COMMANDS.md User Commands
   module Cmd
     # load commands included by the user
-    Dir.glob(File.join(Config::USER_COMMAND_DIR, "*")) { |file| require file }
+    Dir[Config::USER_COMMAND_GLOB].each { |cmd| require cmd }
 
     # @return [Array<String>] all valid muzak commands
     def self.commands

data/lib/muzak/cmd/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "yaml"
 
 module Muzak

data/lib/muzak/cmd/index.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Muzak
   module Cmd
     # Reload the active index from the index file.
@@ -19,7 +21,7 @@ module Muzak
     # @cmdexample `muzak> dump-index`
     def dump_index
       build_response data: {
-        index: index.hash
+        index: index.hash,
       }
     end
 
@@ -28,7 +30,7 @@ module Muzak
     # @cmdexample `muzak> list-artists`
     def list_artists
       build_response data: {
-        artists: index.artists
+        artists: index.artists,
       }
     end
 
@@ -37,7 +39,7 @@ module Muzak
     # @cmdexample `muzak> list-albums`
     def list_albums
       build_response data: {
-        albums: index.album_names
+        albums: index.album_names,
       }
     end
 
@@ -50,7 +52,7 @@ module Muzak
       albums = index.albums_by(artist).map(&:title)
 
       build_response data: {
-        albums: albums
+        albums: albums,
       }
     end
 
@@ -63,7 +65,7 @@ module Muzak
       songs = index.songs_by(artist).map(&:title)
 
       build_response data: {
-        songs: songs
+        songs: songs,
       }
     end
   end

data/lib/muzak/cmd/meta.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Muzak
   module Cmd
     # Return a simple heartbeat message.
@@ -8,16 +10,16 @@ module Muzak
       debug "pong: #{timestamp}"
 
       build_response data: {
-        pong: timestamp
+        pong: timestamp,
       }
     end
 
     # Return a "helpful" listing of commands.
     # @command `help`
     # @cmdexample `muzak> help`
-    def help(*args)
+    def help(*_args)
       build_response data: {
-        commands: Muzak::Cmd.commands
+        commands: Muzak::Cmd.commands,
       }
     end
 
@@ -28,7 +30,7 @@ module Muzak
     #   plugins are configured.
     def list_plugins
       build_response data: {
-        plugins: Plugin.plugin_names
+        plugins: Plugin.plugin_names,
       }
     end
 

data/lib/muzak/cmd/player.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Muzak
   module Cmd
     # Activate the configured player.
@@ -12,7 +14,7 @@ module Muzak
       end
 
       build_response data: {
-        player: player.class.name
+        player: player.class.name,
       }
     end
 
@@ -27,7 +29,7 @@ module Muzak
       player.deactivate!
 
       build_response data: {
-        player: player.class.name
+        player: player.class.name,
       }
     end
 
@@ -87,7 +89,7 @@ module Muzak
       artist = args.join(" ")
       albums = index.albums_by(artist)
 
-      unless albums.empty?
+      if albums.any?
         albums.each do |album|
           player.enqueue_album album
         end
@@ -102,8 +104,7 @@ module Muzak
     # @cmdexample `muzak> enqueue-album Your Favorite Album`
     def enqueue_album(*args)
       album_name = args.join(" ")
-
-      album = index.albums[album_name]
+      album      = index.albums[album_name]
 
       if album
         player.enqueue_album album
@@ -122,7 +123,7 @@ module Muzak
       songs.each { |s| player.enqueue_song s }
 
       build_response data: {
-        jukebox: songs.map(&:full_title)
+        jukebox: songs.map(&:full_title),
       }
     end
 
@@ -131,7 +132,7 @@ module Muzak
     # @cmdexample `muzak> list-queue`
     def list_queue
       build_response data: {
-        queue: player.list_queue.map(&:title)
+        queue: player.list_queue.map(&:title),
       }
     end
 
@@ -160,7 +161,7 @@ module Muzak
     def now_playing
       if player.playing?
         build_response data: {
-          playing: player.now_playing&.full_title
+          playing: player.now_playing&.full_title,
         }
       else
         build_response error: "no currently playing song"

data/lib/muzak/cmd/playlist.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Muzak
   module Cmd
     # List all currently available playlists.
@@ -5,7 +7,7 @@ module Muzak
     # @cmdexample `muzak> list-playlists`
     def list_playlists
       build_response data: {
-        playlists: Playlist.playlist_names
+        playlists: Playlist.playlist_names,
       }
     end
 
@@ -53,7 +55,7 @@ module Muzak
       artist = args.join(" ")
       songs = index.songs_by(artist)
 
-      unless songs.empty?
+      if songs.any?
         playlists[pname].add(songs)
         build_response
       else

data/lib/muzak/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "yaml"
 require "fileutils"
 
@@ -23,12 +25,18 @@ module Muzak
     # The directory for all user playlists
     PLAYLIST_DIR = File.join(CONFIG_DIR, "playlists").freeze
 
+    # The glob pattern for all user playlists
+    PLAYLIST_GLOB = File.join(PLAYLIST_DIR, "*.yml").freeze
+
     # The directory for all user plugins
     USER_PLUGIN_DIR = File.join(CONFIG_DIR, "plugins").freeze
 
     # The directory for all user commands
     USER_COMMAND_DIR = File.join(CONFIG_DIR, "commands").freeze
 
+    # The glob pattern for all user commands
+    USER_COMMAND_GLOB = File.join(USER_COMMAND_DIR, "*.rb").freeze
+
     # All filename suffixes that muzak recognizes as music.
     MUSIC_SUFFIXES = [
       ".mp3",
@@ -41,17 +49,17 @@ module Muzak
     ].freeze
 
     # The regular expression that muzak uses to find album art.
-    ALBUM_ART_REGEX = /(cover)|(folder).(jpg)|(png)/i.freeze
+    ALBUM_ART_REGEX = /(cover)|(folder).(jpg)|(png)/i
 
     # All events currently propagated by {Muzak::Instance#event}
-    PLUGIN_EVENTS = [
-      :instance_started,
-      :instance_quitting,
-      :player_activated,
-      :player_deactivated,
-      :song_loaded,
-      :song_unloaded,
-      :playlist_enqueued,
+    PLUGIN_EVENTS = %i[
+      instance_started
+      instance_quitting
+      player_activated
+      player_deactivated
+      song_loaded
+      song_unloaded
+      playlist_enqueued
     ].freeze
 
     # The default configuration keys and values.
@@ -91,7 +99,19 @@ module Muzak
     # Catches all undefined configuration keys and defaults them to false.
     # @return [false]
     def self.method_missing(method, *args)
-      false
+      # this is basically useless, since respond_to_missing? will always be true,
+      # but it gets RuboCop to shut up.
+      if respond_to_missing? method, *args
+        false
+      else
+        super
+      end
+    end
+
+    # We "respond" to all methods with a default of false, so this is always true.
+    # @return [true]
+    def self.respond_to_missing?(*_args)
+      true
     end
 
     # @return [Boolean] whether or not the given plugin is configured
@@ -102,7 +122,7 @@ module Muzak
     end
 
     if File.exist?(CONFIG_FILE)
-      user_config = YAML::load_file(CONFIG_FILE)
+      user_config = YAML.load_file(CONFIG_FILE)
     else
       user_config = DEFAULT_CONFIG
 

data/lib/muzak/index.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Muzak
   # Represents muzak's music index.
   class Index
@@ -26,8 +28,7 @@ module Muzak
       debug "loading index from '#{file}'..."
 
       @file = file
-
-      @hash = Marshal.load(File.read file)
+      @hash = Marshal.load File.read(file) # rubocop:disable Security/MarshalLoad
 
       memoize_collections!
     end
@@ -37,7 +38,7 @@ module Muzak
     # @return [void]
     def reload!
       debug "reloading index from '#{file}'..."
-      @hash = Marshal.load(File.read file)
+      @hash = Marshal.load File.read(file) # rubocop:disable Security/MarshalLoad
       @albums_hash = nil
       memoize_collections!
     end
@@ -65,11 +66,7 @@ module Muzak
 
         artists.each do |a|
           @hash["artists"][a]["albums"].each do |title, album_hash|
-            if deep?
-              songs = album_hash["deep-songs"]
-            else
-              songs = album_hash["songs"].map { |s| Song.new(s) }
-            end
+            songs = load_songs album_hash
             albums_hash[title] = Album.new(title, songs, album_hash["cover"])
           end
         end
@@ -101,11 +98,7 @@ module Muzak
     def albums_by(artist)
       if artists.include?(artist)
         @hash["artists"][artist]["albums"].map do |title, album_hash|
-          if deep?
-            songs = album_hash["deep-songs"]
-          else
-            songs = album_hash["songs"].map { |s| Song.new(s) }
-          end
+          songs = load_songs album_hash
           Album.new(title, songs, album_hash["cover"])
         end
       else
@@ -133,10 +126,8 @@ module Muzak
       error "no such artist: '#{artist}'" unless @hash["artists"].key?(artist)
 
       begin
-        albums_by(artist).map do |album|
-          album.songs
-        end.flatten
-      rescue Exception => e
+        albums_by(artist).map(&:songs).flatten
+      rescue
         []
       end
     end
@@ -148,10 +139,23 @@ module Muzak
       @all_albums = @hash["artists"].map { |_, a| a["albums"] }.flatten
 
       if deep?
-        @all_deep_songs = @all_albums.map { |aa| aa.map { |_, a| a["deep-songs"] } }.flatten
+        @all_deep_songs = @all_albums.map do |aa|
+          aa.map { |_, a| a["deep-songs"] }
+        end.flatten
       else
         @all_songs = @all_albums.map { |aa| aa.map { |_, a| a["songs"] } }.flatten
       end
     end
+
+    # Load the songs from an album hash into {Song} instances.
+    # @param ah [Hash] the album hash
+    # @api private
+    def load_songs(ah)
+      if deep?
+        ah["deep-songs"]
+      else
+        ah["songs"].map { |s| Song.new s }
+      end
+    end
   end
 end

data/lib/muzak/instance.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Muzak
   # Encapsulates the entirety of muzak's running state.
   class Instance
@@ -15,7 +17,7 @@ module Muzak
       if Cmd.commands.include?(cmd)
         meth = method(Config.resolve_command(cmd))
         if meth.arity == args.size || meth.arity <= -1
-          meth.call *args
+          meth.call(*args)
         else
           build_response error: "got #{args.size} args, needed #{meth.arity}"
         end
@@ -42,12 +44,9 @@ module Muzak
 
       error! "#{Config.music} doesn't exist" unless File.exist?(Config.music)
 
-      @index = Index.load_index!
-
-      @player = Player.load_player!(self)
-
-      @plugins = Plugin.load_plugins!
-
+      @index     = Index.load_index!
+      @player    = Player.load_player!(self)
+      @plugins   = Plugin.load_plugins!
       @playlists = Playlist.load_playlists!
 
       enqueue_playlist Config.default_playlist if Config.default_playlist

data/lib/muzak/player.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # we have to require StubPlayer first because ruby's module resolution is bad
 require_relative "player/stub_player"
 

data/lib/muzak/player/mpd.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "ruby-mpd"
 
 module Muzak

data/lib/muzak/player/mpv.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "tempfile"
 require "socket"
 require "json"
@@ -8,6 +10,14 @@ module Muzak
   module Player
     # Exposes MPV's IPC to muzak for playback control.
     class MPV < StubPlayer
+      DEFAULT_MPV_ARGS = [
+        "--no-osc",
+        "--no-osd-bar",
+        "--no-input-default-bindings",
+        "--no-input-cursor",
+        "--load-scripts=no", # autoload and other scripts clobber our mpv management
+      ].freeze
+
       # @return [Boolean] whether or not MPV is available for execution
       def self.available?
         ::MPV::Server.available?
@@ -25,24 +35,7 @@ module Muzak
 
         debug "activating #{self.class}"
 
-        args = [
-          # there's also this, which (might) also work
-          # "--audio-display=no",
-          "--no-osc",
-          "--no-osd-bar",
-          "--no-input-default-bindings",
-          "--no-input-cursor",
-          "--load-scripts=no", # autoload and other scripts with clobber our mpv management
-        ]
-
-        args.concat ["--no-force-window", "--no-video"] if Config.mpv_no_art
-
-        args << "--geometry=#{Config.art_geometry}" if Config.art_geometry
-
-        # this is an experimental flag, but it could improve
-        # muzak's load times substantially when used with a network
-        # mounted music library
-        args << "--prefetch-playlist" if ::MPV::Server.has_flag?("--prefetch-playlist")
+        args = DEFAULT_MPV_ARGS + configured_mpv_args
 
         @mpv = ::MPV::Session.new(user_args: args)
         @mpv.callbacks << ::MPV::Callback.new(self, :dispatch_event!)
@@ -172,7 +165,22 @@ module Muzak
       # Get mpv's currently loaded song.
       # @return [Song, nil] the currently loaded song
       def now_playing
-        @_now_playing ||= Song.new(@mpv.get_property "path")
+        @_now_playing ||= Song.new @mpv.get_property("path")
+      end
+
+      def configured_mpv_args
+        args = []
+
+        args.concat ["--no-force-window", "--no-video"] if Config.mpv_no_art
+
+        args << "--geometry=#{Config.art_geometry}" if Config.art_geometry
+
+        # this is an experimental flag, but it could improve
+        # muzak's load times substantially when used with a network
+        # mounted music library
+        args << "--prefetch-playlist" if ::MPV::Server.has_flag?("--prefetch-playlist")
+
+        args
       end
 
       # Load a song and optional album art into mpv.
@@ -184,7 +192,7 @@ module Muzak
         append_type = Config.autoplay ? "append-play" : "append"
         cmds = ["loadfile", song.path, append_type]
         cmds << "external-file=\"#{art}\"" if art
-        @mpv.command *cmds
+        @mpv.command(*cmds)
       end
 
       # Dispatch the given event to the active {Muzak::Instance}.

data/lib/muzak/player/multiplayer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Muzak
   module Player
     # Wraps multiple players into a single class.

data/lib/muzak/player/stub_player.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Muzak
   module Player
     # A no-op player that all players inherit from.
@@ -85,7 +87,7 @@ module Muzak
       # @param song [Song] the song to enqueue
       # @return [void]
       # @note NO-OP
-      def enqueue_song(song)
+      def enqueue_song(_song)
         debug "#enqueue_song"
       end
 
@@ -93,7 +95,7 @@ module Muzak
       # @param album [Album] the album to enqueue
       # @return [void]
       # @note NO-OP
-      def enqueue_album(album)
+      def enqueue_album(_album)
         debug "#enqueue_album"
       end
 
@@ -101,7 +103,7 @@ module Muzak
       # @param playlist [Playlist] the playlist to enqueue
       # @return [void]
       # @note NO-OP
-      def enqueue_playlist(playlist)
+      def enqueue_playlist(_playlist)
         debug "#enqueue_playlist"
       end
 

data/lib/muzak/player/vlc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "vlc-client"
 
 module Muzak

data/lib/muzak/playlist.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Muzak
   # Represents a sequential list of songs for muzak.
   class Playlist
@@ -30,11 +32,7 @@ module Muzak
 
     # @return [Array<String>] the names of all currently available playlists
     def self.playlist_names
-      Dir.entries(Config::PLAYLIST_DIR).reject do |ent|
-        ent.start_with?(".")
-      end.map do |ent|
-        File.basename(ent, File.extname(ent))
-      end
+      Dir[Config::PLAYLIST_GLOB].map { |p| File.basename(p, File.extname(p)) }
     end
 
     # Instantiates all playlists by loading them from disk.

data/lib/muzak/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # we have to require StubPlugin first because ruby's module resolution is bad
 require_relative "plugin/stub_plugin"
 
@@ -30,7 +32,7 @@ module Muzak
         Config.plugin?(pk.plugin_name) && pk.available?
       end
 
-      pks.map { |pk| pk.new }
+      pks.map(&:new)
     end
   end
 end

data/lib/muzak/song.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "taglib"
 require "json"
 
@@ -39,15 +41,14 @@ module Muzak
       @path = path
 
       TagLib::FileRef.open(path) do |ref|
-        break if ref.null?
-        @title = ref.tag.title
-        @artist = ref.tag.artist
-        @album = ref.tag.album
-        @year = ref.tag.year
-        @track = ref.tag.track
-        @genre = ref.tag.genre
-        @comment = ref.tag.comment
-        @length = ref.audio_properties.length
+        @title   = ref&.tag&.title
+        @artist  = ref&.tag&.artist
+        @album   = ref&.tag&.album
+        @year    = ref&.tag&.year
+        @track   = ref&.tag&.track
+        @genre   = ref&.tag&.genre
+        @comment = ref&.tag&.comment
+        @length  = ref&.audio_properties&.length
       end
 
       # provide some sane fallbacks

data/lib/muzak/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Muzak
   # A collection of convenience utilities for use throughout muzak.
   module Utils
@@ -38,13 +40,13 @@ module Muzak
     # @param color [Symbol] the color to use on the string
     # @param str [String] the string to format
     # @return [String] the color-formatted string
-    def pretty(color = :none, str)
+    def pretty(str, color = :none)
       colors = {
         none: 0,
         red: 31,
         green: 32,
         yellow: 33,
-        blue: 34
+        blue: 34,
       }
 
       "\e[#{colors[color]}m#{str}\e[0m"
@@ -63,22 +65,22 @@ module Muzak
     # @param args [Array<String>] the message(s)
     # @return [void]
     def danger(*args)
-      output pretty(:yellow, "warn"), args
+      output pretty("warn", :yellow), args
     end
 
     # Outputs a boxed error message.
     # @param args [Array<String>] the message(s)
     # @return [void]
     def error(*args)
-      context = self.is_a?(Module) ? name : self.class.name
-      output pretty(:red, "error"), "[#{context}]", args
+      context = is_a?(Module) ? name : self.class.name
+      output pretty("error", :red), "[#{context}]", args
     end
 
     # Outputs a boxed error message and then exits.
     # @param args [Array<String>] the message(s)
     # @return [void]
     def error!(*args)
-      error *args
+      error(*args)
       exit 1
     end
 
@@ -87,8 +89,8 @@ module Muzak
     # @return [void]
     def debug(*args)
       return unless debug?
-      context = self.is_a?(Module) ? name : self.class.name
-      output pretty(:yellow, "debug"), "[#{context}]", args
+      context = is_a?(Module) ? name : self.class.name
+      output pretty("debug", :yellow), "[#{context}]", args
     end
 
     # Outputs a boxed verbose message.
@@ -97,18 +99,19 @@ module Muzak
     def verbose(*args)
       return unless verbose?
 
-      output pretty(:blue, "verbose"), args
+      output pretty("verbose", :blue), args
     end
 
     # Returns a response hash containing the given data and error.
     # @param error [String] the error string, if needed
     # @param data [String, Hash] the data, if needed
     def build_response(error: nil, data: nil)
-      { response: {
+      {
+        response: {
           error: error,
           data: data,
-          method: caller_locations.first.label
-        }
+          method: caller_locations.first.label,
+        },
       }
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muzak
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-28 00:00:00.000000000 Z
+date: 2017-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: taglib-ruby