muzak 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b64a222cbd2a691404714a63b195ee2a78bb82b3
-  data.tar.gz: 8d5547a8facf37798f822e53c97d9070dd29b6aa
+  metadata.gz: 917b86d06294801e33561fe181e64fd755f09828
+  data.tar.gz: 3aebb78550918a276f0cefc7fc11e57d277759a3
 SHA512:
-  metadata.gz: 999969bedb0fb6d2ea42fa856266702f2464207d6e3480eaccf8cad09f69b260e7981e8c7dc119cf0e02dfba0a9bf821230c1f8eb199137f9739e1d8866fa772
-  data.tar.gz: db562a2611427925e9c2a1621b5d294f6597dba8813647d9035ef7ecc57d8293b90f4f30c53f055b5b22a684ba418e0e2ecf9a5606c1a3268af47bb0d3144cf6
+  metadata.gz: 2f9bcb70833ce12b36e14e2f56e6042cdbfef39dc88362b8e9908a255f1eaad19d185956ebde3dbf8608f562e41a3e52151390a9c49b6afb2b38435646c53e77
+  data.tar.gz: 817a120b22297d8f3ba64afa8fe11a42452914c628de0f4b1a5f64d4d701b44c371024b2cdba0e9191cb9555ed4a0bd7d84fd8cadc2f8921c2e0e3e7f231e1fd

data/CONFIGURATION.md

@@ -8,8 +8,8 @@ For the developer documentation, see {Muzak::Config}.
 ## General behavior
 
 All of muzak's configuration is kept in {Muzak::Config}, which is read
-during load-time (i.e., during `require`) from {Muzak::CONFIG_FILE}, which
-is YAML-formatted.
+during load-time (i.e., during `require`) from {Muzak::Config::CONFIG_FILE},
+which is YAML-formatted.
 
 Muzak loads configuration keys just like commands, translating them from
 `kebab-case` to `snake_case`. For example, take the following configuration:

data/lib/muzak.rb

@@ -1,6 +1,5 @@
-require_relative "muzak/const"
-require_relative "muzak/utils"
 require_relative "muzak/config"
+require_relative "muzak/utils"
 require_relative "muzak/plugin"
 require_relative "muzak/song"
 require_relative "muzak/album"
@@ -10,3 +9,8 @@ require_relative "muzak/cmd"
 require_relative "muzak/player"
 require_relative "muzak/instance"
 
+# The primary namespace for muzak.
+module Muzak
+  # Muzak's current version
+  VERSION = "0.3.0".freeze
+end

data/lib/muzak/cmd.rb

@@ -5,12 +5,12 @@ module Muzak
   # @see file:COMMANDS.md User Commands
   module Cmd
     # load commands included by the user
-    Dir.glob(File.join(USER_COMMAND_DIR, "*")) { |file| require file }
+    Dir.glob(File.join(Config::USER_COMMAND_DIR, "*")) { |file| require file }
 
     # @return [Array<String>] all valid muzak commands
     def self.commands
       commands = instance_methods.map(&:to_s).reject { |m| m.start_with?("_") }
-      commands.map { |c| Utils.resolve_method c }
+      commands.map { |c| Config.resolve_method c }
     end
   end
 end

data/lib/muzak/cmd/config.rb

@@ -6,7 +6,7 @@ module Muzak
     # @command `config-get <key>`
     # @cmdexample `muzak> config-get player`
     def config_get(key)
-      value = Config.send Utils.resolve_command(key)
+      value = Config.send Config.resolve_command(key)
 
       build_response data: { key => value }
     end

data/lib/muzak/config.rb

@@ -10,6 +10,81 @@ module Muzak
   #   Config.art_geometry # => "300x300"
   # @see file:CONFIGURATION.md User Configuration
   class Config
+    # The root directory for all user configuration, data, etc
+    CONFIG_DIR = File.expand_path("~/.config/muzak").freeze
+
+    # Muzak's primary configuration file
+    # @see Muzak::Config
+    CONFIG_FILE = File.join(CONFIG_DIR, "muzak.yml").freeze
+
+    # Muzak's music index
+    INDEX_FILE = File.join(CONFIG_DIR, "index.dat").freeze
+
+    # The directory for all user playlists
+    PLAYLIST_DIR = File.join(CONFIG_DIR, "playlists").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
+
+    # All filename suffixes that muzak recognizes as music.
+    MUSIC_SUFFIXES = [
+      ".mp3",
+      ".flac",
+      ".m4a",
+      ".wav",
+      ".ogg",
+      ".oga",
+      ".opus",
+    ].freeze
+
+    # The regular expression that muzak uses to find album art.
+    ALBUM_ART_REGEX = /(cover)|(folder).(jpg)|(png)/i.freeze
+
+    # All events currently propagated by {Muzak::Instance#event}
+    PLUGIN_EVENTS = [
+      :instance_started,
+      :player_activated,
+      :player_deactivated,
+      :song_loaded,
+      :song_unloaded,
+      :playlist_enqueued,
+    ].freeze
+
+    # The default configuration keys and values.
+    DEFAULT_CONFIG = {
+      # core defaults
+      "debug" => false,
+      "verbose" => true,
+      "music" => File.expand_path("~/music"),
+      "player" => "mpv",
+      "jukebox-size" => 100,
+
+      # client/daemon defaults
+      "daemon-port" => 2669,
+      "daemon-host" => "localhost",
+    }.freeze
+
+    # Convert the given command into a method (kebab to camel case).
+    # @param cmd [String] the command to convert
+    # @return [String] the method corresponding to the command
+    # @example
+    #   resolve_command "do-something" # => "do_something"
+    def self.resolve_command(cmd)
+      cmd.tr "-", "_"
+    end
+
+    # Convert the given method into a command (camel to kebab case).
+    # @param meth [String, Symbol] the method to convert
+    # @return [String] the command corresponding to the method
+    # @example
+    #   resolve_method "do_something" # => "do-something"
+    def self.resolve_method(meth)
+      meth.to_s.tr "_", "-"
+    end
+
     # Catches all undefined configuration keys and defaults them to false.
     # @return [false]
     def self.method_missing(method, *args)
@@ -29,19 +104,6 @@ module Muzak
       respond_to? "plugin_#{pname}"
     end
 
-    DEFAULT_CONFIG = {
-      # core defaults
-      "debug" => false,
-      "verbose" => true,
-      "music" => File.expand_path("~/music"),
-      "player" => "mpv",
-      "jukebox-size" => 100,
-
-      # client/daemon defaults
-      "daemon-port" => 2669,
-      "daemon-host" => "localhost",
-    }.freeze
-
     if File.exist?(CONFIG_FILE)
       user_config = YAML::load_file(CONFIG_FILE)
     else
@@ -57,11 +119,11 @@ module Muzak
     @config = DEFAULT_CONFIG.merge(user_config)
 
     @config.each do |key, _|
-      define_singleton_method Utils.resolve_command(key) do
+      define_singleton_method resolve_command(key) do
         @config[key]
       end
 
-      define_singleton_method "#{Utils.resolve_command(key)}=" do |value|
+      define_singleton_method "#{resolve_command(key)}=" do |value|
         @config[key] = value
         sync!
       end

data/lib/muzak/index.rb

@@ -3,11 +3,12 @@ module Muzak
   class Index
     include Utils
 
+    # @return [Index] a {Index} instance instantiated with {Config::INDEX_FILE}
     def self.load_index!
-      if File.exist?(INDEX_FILE)
+      if File.exist?(Config::INDEX_FILE)
         Index.new
       else
-        error! "#{INDEX_FILE} missing, did you forget to run muzak-index?"
+        error! "#{Config::INDEX_FILE} missing, did you forget to run muzak-index?"
       end
     end
 
@@ -17,9 +18,9 @@ module Muzak
     # @return [Hash] the index hash
     attr_accessor :hash
 
-    # @param index_file [String] the path of the index data file
-    def initialize(file: INDEX_FILE)
-      debug "loading index from '#{INDEX_FILE}'..."
+    # @param file [String] the path of the index data file
+    def initialize(file: Config::INDEX_FILE)
+      debug "loading index from '#{Config::INDEX_FILE}'..."
 
       @hash = Marshal.load(File.read file)
     end

data/lib/muzak/instance.rb

@@ -12,7 +12,7 @@ module Muzak
     #   instance.command "pause"
     def command(cmd, *args)
       if Cmd.commands.include?(cmd)
-        meth = method(Utils.resolve_command(cmd))
+        meth = method(Config.resolve_command(cmd))
         if meth.arity == args.size || meth.arity <= -1
           meth.call *args
         else
@@ -57,9 +57,9 @@ module Muzak
     # Dispatch an event to all plugins.
     # @param type [Symbol] the type of event to dispatch
     # @param args [Array] the event's arguments
-    # @note {Muzak::PLUGIN_EVENTS} contains all valid events.
+    # @note {Config::PLUGIN_EVENTS} contains all valid events.
     def event(type, *args)
-      return unless PLUGIN_EVENTS.include?(type)
+      return unless Config::PLUGIN_EVENTS.include?(type)
 
       plugins.each do |plugin|
         Thread.new do

data/lib/muzak/playlist.rb

@@ -1,4 +1,5 @@
 module Muzak
+  # Represents a sequential list of songs for muzak.
   class Playlist
     # @return [String] the absolute path to the playlist on disk
     attr_accessor :filename
@@ -9,7 +10,7 @@ module Muzak
     # @param pname [String] the playlist's name
     # @return [String] the absolute path to the given playlist name
     def self.path_for(pname)
-      File.join(PLAYLIST_DIR, pname) + ".yml"
+      File.join(Config::PLAYLIST_DIR, pname) + ".yml"
     end
 
     # @param pname [String] the playlist's name
@@ -29,7 +30,7 @@ module Muzak
 
     # @return [Array<String>] the names of all currently available playlists
     def self.playlist_names
-      Dir.entries(PLAYLIST_DIR).reject do |ent|
+      Dir.entries(Config::PLAYLIST_DIR).reject do |ent|
         ent.start_with?(".")
       end.map do |ent|
         File.basename(ent, File.extname(ent))

data/lib/muzak/plugin.rb

@@ -8,7 +8,7 @@ module Muzak
   # The namespace for muzak plugins.
   module Plugin
     # load plugins included by the user
-    Dir.glob(File.join(USER_PLUGIN_DIR, "*")) { |file| require file }
+    Dir.glob(File.join(Config::USER_PLUGIN_DIR, "*")) { |file| require file }
 
     # @return [Array<Class>] all plugin classes visible under Plugin
     def self.plugin_classes

data/lib/muzak/plugin/stub_plugin.rb

@@ -14,7 +14,7 @@ module Muzak
         debug "loading #{self.class}"
       end
 
-      PLUGIN_EVENTS.each do |event|
+      Config::PLUGIN_EVENTS.each do |event|
         define_method(event) do |*args|
           nil # do nothing.
         end

data/lib/muzak/utils.rb

@@ -1,36 +1,18 @@
 module Muzak
   # A collection of convenience utilities for use throughout muzak.
   module Utils
-    # Convert the given command into a method (kebab to camel case).
-    # @param cmd [String] the command to convert
-    # @return [String] the method corresponding to the command
-    # @example
-    #   resolve_command "do-something" # => "do_something"
-    def self.resolve_command(cmd)
-      cmd.tr "-", "_"
-    end
-
-    # Convert the given method into a command (camel to kebab case).
-    # @param meth [String, Symbol] the method to convert
-    # @return [String] the command corresponding to the method
-    # @example
-    #   resolve_method "do_something" # => "do-something"
-    def self.resolve_method(meth)
-      meth.to_s.tr "_", "-"
-    end
-
     # Tests whether the given filename is likely to be music.
     # @param filename [String] the filename to test
     # @return [Boolean] whether or not the file is a music file
     def self.music?(filename)
-      [".mp3", ".flac", ".m4a", ".wav", ".ogg", ".oga", ".opus"].include?(File.extname(filename.downcase))
+      Config::MUSIC_SUFFIXES.include?(File.extname(filename.downcase))
     end
 
     # Tests whether the given filename is likely to be album art.
     # @param filename [String] the filename to test
     # @return [Boolean] whether or not the file is an art file
     def self.album_art?(filename)
-      File.basename(filename) =~ /(cover)|(folder).(jpg)|(png)/i
+      File.basename(filename) =~ Config::ALBUM_ART_REGEX
     end
 
     # Tests whether the given utility is available in the system path.
@@ -80,7 +62,7 @@ module Muzak
     # Outputs a boxed warning message.
     # @param args [Array<String>] the message(s)
     # @return [void]
-    def warn(*args)
+    def danger(*args)
       output pretty(:yellow, "warn"), args
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muzak
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: taglib-ruby
@@ -72,7 +72,6 @@ files:
 - lib/muzak/cmd/player.rb
 - lib/muzak/cmd/playlist.rb
 - lib/muzak/config.rb
-- lib/muzak/const.rb
 - lib/muzak/index.rb
 - lib/muzak/instance.rb
 - lib/muzak/player.rb

data/lib/muzak/const.rb

@@ -1,33 +0,0 @@
-module Muzak
-  # Muzak's current version
-  VERSION = "0.2.7".freeze
-
-  # The root directory for all user configuration, data, etc
-  CONFIG_DIR = File.expand_path("~/.config/muzak").freeze
-
-  # Muzak's primary configuration file
-  # @see Muzak::Config
-  CONFIG_FILE = File.join(CONFIG_DIR, "muzak.yml").freeze
-
-  # Muzak's music index
-  INDEX_FILE = File.join(CONFIG_DIR, "index.dat").freeze
-
-  # The directory for all user playlists
-  PLAYLIST_DIR = File.join(CONFIG_DIR, "playlists").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
-
-  # All events currently propagated by {Muzak::Instance#event}
-  PLUGIN_EVENTS = [
-    :instance_started,
-    :player_activated,
-    :player_deactivated,
-    :song_loaded,
-    :song_unloaded,
-    :playlist_enqueued
-  ]
-end