muzak 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3343a7ac9f6f6902736580ca2dc6d83821ccbdb8
-  data.tar.gz: 6e4ae9b75369dbdee0f1f3c3b74c970689c68ed8
+  metadata.gz: d298ab0d509e9b3cbf82b012a282ab8fe9fe7713
+  data.tar.gz: 1128e587b3f0d81ba2c0cbbd641dfb1e47cd9755
 SHA512:
-  metadata.gz: a00938c127bc0458f8055ed5f8519bb3e17f165665744fb71f1ba7b668db270387016c68e16ceddc9fdfde8b347eb05236c525daa650e245e6cdabf937c66716
-  data.tar.gz: eb1c7eb8fb51521d7fed514915f4af1890ab1eab39b18af6810ae7167c0e1524790132bf7ffa489f367a2b074ff11b2f3998a7619340f27ed1a9a57b32e8e95f
+  metadata.gz: b12d25d6fc3854b96926b49e78e9e57becd903987f2a4ff9438b91d7a0bb942fae43a7cc3b7b3cec08464672b4017803f20bcecc4f6028ae6f157ec7f637d230
+  data.tar.gz: 99a06151ac245f18e4a03fb9c12dc1dda1a57848c09487b4d7a27b5e7bebdf49bb88a98ecdc982e9fe2681e61a6408f3345c99b4dfdc5708717b3245171e56e8

data/COMMANDS.md

@@ -324,39 +324,6 @@ $ muzak-cmd help
 }
 ```
 
-## `index-build`
-
-(Re-)builds the index.
-
-**Note:** This command can take quite some time to run. It's generally a good
-idea to either set `index-autobuild` in the configuration to do automatic
-rebuilds or schedule this command via `cron` or a similar tool.
-
-### Syntax
-
-`index-build`
-
-### Example
-
-```bash
-$ muzak-cmd index-build
-```
-
-### Example Response
-
-```json
-{
-   "response" : {
-     "error" : null,
-     "method" : "index_build",
-     "data" : {
-       "artists" : 10,
-       "albums": 100
-     }
-   }
-}
-```
-
 ## `jukebox`
 
 Adds *N* random songs to the player's queue, where *N* is either the optional

data/CONFIGURATION.md

@@ -34,7 +34,6 @@ Muzak::Config.music # => "/home/william/mnt/fortuna/music/"
 Muzak::Config.player # => "mpv"
 Muzak::Config.art_geometry # => "300x300"
 Muzak::Config.jukebox_size # => 100
-Muzak::Config.deep_index # => true
 ```
 
 Since {Muzak::Config} is populated whenever `muzak` is loaded via `require`,
@@ -119,36 +118,6 @@ initialize and control.
 The short names of supported players can be found in
 {Muzak::Player::PLAYER_MAP}.
 
-### `index-autobuild`
-
-*Optional.*
-
-*Default:* `86400`
-
-`index-autobuild: <span>` should be set to maximum number of seconds before
-an index is considered outdated (based on its {Muzak::Index#timestamp} field).
-
-When an outdated index is loaded and this key is set, muzak will automatically
-rebuild the index.
-
-**Note:** This is *not* an interval - the outdated index is only rebuilt
-when a new {Muzak::Instance} or {Muzak::Index} is instantiated.
-
-### `deep-index`
-
-*Optional.*
-
-*Default:* `false`
-
-If `deep-index: true` is set in the configuration file, then muzak will
-build a "deep" index. This involves opening each music file and reading metadata
-from it, which can take substantially longer than just a shallow filesystem
-index.
-
-This primary benefit of this is caching - having all the song metadata in the
-index allows muzak to make fewer disk accesses, which may be expensive over
-a remote disk.
-
 ### `jukebox-size`
 
 *Mandatory.*

data/lib/muzak/cmd/index.rb

@@ -1,19 +1,5 @@
 module Muzak
   module Cmd
-    # Rebuild the current instance's index.
-    # @command `index-build`
-    # @cmdexample `muzak> index-build`
-    def index_build(*args)
-      verbose "building a new index, this may take a while"
-
-      index.build!
-
-      build_response data: {
-        artists: index.artists.size,
-        albums: index.albums.size
-      }
-    end
-
     # List all artists in the index.
     # @command `list-artists`
     # @cmdexample `muzak> list-artists`

data/lib/muzak/config.rb

@@ -35,8 +35,6 @@ module Muzak
       "verbose" => true,
       "music" => File.expand_path("~/music"),
       "player" => "mpv",
-      "index-autobuild" => 86400,
-      "deep-index" => false,
       "jukebox-size" => 100,
 
       # client/daemon defaults

data/lib/muzak/const.rb

@@ -1,6 +1,6 @@
 module Muzak
   # Muzak's current version
-  VERSION = "0.1.8".freeze
+  VERSION = "0.2.0".freeze
 
   # The root directory for all user configuration, data, etc
   CONFIG_DIR = File.expand_path("~/.config/muzak").freeze

data/lib/muzak/index.rb

@@ -4,7 +4,11 @@ module Muzak
     include Utils
 
     def self.load_index!
-      Index.new(Config.music, deep: Config.deep_index)
+      if File.exist?(INDEX_FILE)
+        Index.new
+      else
+        error! "#{INDEX_FILE} missing, did you forget to run muzak-index?"
+      end
     end
 
     # @return [String] the path of the root of the music tree
@@ -16,39 +20,10 @@ module Muzak
     # @return [Hash] the index hash
     attr_accessor :hash
 
-    # @param tree [String] the root to begin indexing from
-    # @param deep [Boolean] whether to build a "deep" index
-    # @param sync [Boolean] whether or not to save to {Muzak::INDEX_FILE}
-    # @note if the index ({Muzak::INDEX_FILE}) already exists and is not
-    #   outdated, no building is performed.
-    # @see #build!
-    def initialize(tree, deep: false, sync: true)
-      @tree = tree
-      @deep = deep
-
-      if File.exist?(INDEX_FILE)
-        verbose "loading index from #{INDEX_FILE}"
-        @hash = Marshal::load(File.read INDEX_FILE)
-        return unless outdated?
-      end
-
-      build!(sync: sync)
-    end
-
-    # Synchronize the in-memory index hash with {Muzak::INDEX_FILE}.
-    def sync!
-      File.open(INDEX_FILE, "w") { |io| io.write Marshal::dump @hash }
-    end
-
-    # (Re)builds and saves the index ({Muzak::INDEX_FILE}) to disk.
-    # @param sync [Boolean] whether or not to save to {Muzak::INDEX_FILE}
-    # @note This method can be expensive.
-    def build!(sync: true)
-      @hash = build_index_hash!
-
-      debug "indexed #{albums.length} albums by #{artists.length} artists"
-
-      sync! if sync
+    # @param index_file [String] the path of the index data file
+    def initialize(file: INDEX_FILE)
+      @hash = Marshal.load(File.read file)
+      @deep = @hash["deep"]
     end
 
     # @return [Boolean] whether or not the current index is deep
@@ -61,14 +36,6 @@ module Muzak
       @hash["timestamp"]
     end
 
-    # @return [Boolean] whether or not the index is currently out of date
-    # @note The behavior of this method is affected by the value of
-    #   {Muzak::Config.index_autobuild}.
-    def outdated?
-      return false unless Config.index_autobuild
-      Time.now.to_i - timestamp >= Config.index_autobuild
-    end
-
     # @return [Array<String>] a list of all artists in the index
     def artists
       @artists ||= @hash["artists"].keys
@@ -138,55 +105,5 @@ module Muzak
         []
       end
     end
-
-    private
-
-    def build_index_hash!
-      index_hash = {
-        "timestamp" => Time.now.to_i,
-        "artists" => {},
-        "deep" => deep
-      }
-
-      Dir.entries(tree).each do |artist|
-        next unless File.directory?(File.join(tree, artist))
-        next if artist.start_with?(".")
-
-        index_hash["artists"][artist] = {}
-        index_hash["artists"][artist]["albums"] = {}
-
-        Dir.entries(File.join(tree, artist)).each do |album|
-          next if album.start_with?(".")
-
-          index_hash["artists"][artist]["albums"][album] = {}
-          index_hash["artists"][artist]["albums"][album]["songs"] = []
-          index_hash["artists"][artist]["albums"][album]["deep-songs"] = []
-
-          Dir.glob(File.join(tree, artist, album, "**")) do |file|
-            index_hash["artists"][artist]["albums"][album]["cover"] = file if album_art?(file)
-
-            if music?(file)
-              index_hash["artists"][artist]["albums"][album]["songs"] << file
-              if deep?
-                index_hash["artists"][artist]["albums"][album]["deep-songs"] << Song.new(file)
-              end
-            end
-          end
-
-          index_hash["artists"][artist]["albums"][album]["songs"].sort!
-
-          # 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 index_hash["artists"][artist]["albums"][album]["deep-songs"].any? { |s| s.track > 0 }
-            index_hash["artists"][artist]["albums"][album]["deep-songs"].sort_by!(&:track)
-          else
-            index_hash["artists"][artist]["albums"][album]["deep-songs"].sort_by!(&:path)
-          end
-        end
-      end
-
-      index_hash
-    end
   end
 end

data/lib/muzak/song.rb

@@ -60,7 +60,7 @@ module Muzak
     def best_guess_album_art
       album_dir = File.dirname(path)
 
-      art = Dir.entries(album_dir).find { |ent| album_art?(ent) }
+      art = Dir.entries(album_dir).find { |ent| Utils.album_art?(ent) }
       File.join(album_dir, art) unless art.nil?
     end
 

data/lib/muzak/utils.rb

@@ -22,14 +22,14 @@ module Muzak
     # 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 music?(filename)
+    def self.music?(filename)
       [".mp3", ".flac", ".m4a", ".wav", ".ogg", ".oga", ".opus"].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 album_art?(filename)
+    def self.album_art?(filename)
       File.basename(filename) =~ /(cover)|(folder).(jpg)|(png)/i
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muzak
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-08 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: taglib-ruby