ruby-mpd 0.1.7 → 0.1.8

data/README.rdoc

@@ -3,7 +3,7 @@
 ruby-mpd is a powerful object-oriented Music Player Daemon library, forked from librmpd.
 librmpd is as of writing outdated by 6 years! This library tries to act as a successor,
 originally using librmpd as a base, however almost all of the codebase was rewritten.
-ruby-mpd supports all "modern" MPD features.
+ruby-mpd supports all "modern" MPD features as well as callbacks.
 
 == MPD Protocol
 
@@ -41,7 +41,7 @@ When you are done, disconnect by calling disconnect.
 
 *Note*: The server may disconnect you at any time due to inactivity. This can
 be fixed by enabling callbacks (see the Callbacks section) or by issuing a
-`ping` command at certain intervals
+`ping` command at certain intervals.
 
 Once connected, you can issue commands to talk to the server.
 

data/lib/ruby-mpd.rb

@@ -46,16 +46,20 @@ class MPD
   def initialize(hostname = 'localhost', port = 6600)
     @hostname = hostname
     @port = port
-    @socket = nil
-    @version = nil
-    @tags = nil
+    reset_vars
 
-    @stop_cb_thread = false
     @mutex = Mutex.new
-    @cb_thread = nil
     @callbacks = {}
   end
 
+  # Initialize instance variables on new object, or on disconnect.
+  def reset_vars
+    @socket = nil
+    @version = nil
+    @tags = nil
+  end
+  private :reset_vars
+
   # This will register a block callback that will trigger whenever
   # that specific event happens.
   #
@@ -81,12 +85,51 @@ class MPD
   # @param [Symbol] event The event that happened.
   # @return [void]
   def emit(event, *args)
-    @callbacks[event] ||= []
+    return unless @callbacks[event]
     @callbacks[event].each do |handle|
       handle.call *args
     end
   end
 
+  # Constructs a callback loop thread and/or resumes it.
+  # @return [Thread]
+  def callback_thread
+    @cb_thread ||= Thread.new(self) do |mpd|
+      old_status = {}
+      while true
+        status = mpd.status rescue {}
+
+        status[:connection] = mpd.connected?
+
+        status[:time] = [nil, nil] if !status[:time] # elapsed, total
+        status[:audio] = [nil, nil, nil] if !status[:audio] # samp, bits, chans
+
+        status.each do |key, val|
+          next if val == old_status[key] # skip unchanged keys
+
+          if key == :song
+            emit(:song, mpd.current_song)
+          else # convert arrays to splat arguments
+            val.is_a?(Array) ? emit(key, *val) : emit(key, val)
+          end
+        end
+
+        old_status = status
+        sleep 0.1
+
+        if !status[:connection] && !Thread.current[:stop]
+          sleep 2
+          mpd.connect rescue nil
+        end
+
+        Thread.stop if Thread.current[:stop]
+      end
+    end
+    @cb_thread[:stop] = false
+    @cb_thread.run if @cb_thread.stop?
+  end
+  private :callback_thread
+
   # Connect to the daemon.
   #
   # When called without any arguments, this will just connect to the server
@@ -104,47 +147,7 @@ class MPD
     @socket = File.exists?(@hostname) ? UNIXSocket.new(@hostname) : TCPSocket.new(@hostname, @port)
     @version = @socket.gets.chomp.gsub('OK MPD ', '') # Read the version
 
-    if callbacks and (@cb_thread.nil? or !@cb_thread.alive?)
-      @stop_cb_thread = false
-      @cb_thread = Thread.new(self) { |mpd|
-        old_status = {}
-        connected = ''
-        while !@stop_cb_thread
-          status = mpd.status rescue {}
-          c = mpd.connected?
-
-          # @todo Move into status[:connection]?
-          if connected != c
-            connected = c
-            emit(:connection, connected)
-          end
-
-          status[:time] = [nil, nil] if !status[:time] # elapsed, total
-          status[:audio] = [nil, nil, nil] if !status[:audio] # samp, bits, chans
-
-          status.each do |key, val|
-            next if val == old_status[key] # skip unchanged keys
-
-            if key == :song
-              emit(:song, mpd.current_song)
-            else # convert arrays to splat arguments
-              val.is_a?(Array) ? emit(key, *val) : emit(key, val)
-            end
-          end
-
-          old_status = status
-          sleep 0.1
-
-          if !connected
-            sleep 2
-            unless @stop_cb_thread
-              mpd.connect rescue nil
-            end
-          end
-        end
-      }
-    end
-
+    callback_thread if callbacks
     return true
   end
 
@@ -163,13 +166,13 @@ class MPD
   # the callback thread, thus disabling callbacks.
   # @return [Boolean] True if successfully disconnected, false otherwise.
   def disconnect
-    @stop_cb_thread = true
+    @cb_thread[:stop] = true if @cb_thread
 
     return false if !@socket
 
     @socket.puts 'close'
     @socket.close
-    @socket = nil
+    reset_vars
     return true
   end
 
@@ -202,7 +205,7 @@ class MPD
   # @return (see #handle_server_response)
   # @raise [MPDError] if the command failed.
   def send_command(command, *args)
-    raise ConnectionError, "Not connected to the server!" if @socket.nil?
+    raise ConnectionError, "Not connected to the server!" if !@socket
 
     @mutex.synchronize do
       begin
@@ -210,7 +213,7 @@ class MPD
         response = handle_server_response
         return parse_response(command, response)
       rescue Errno::EPIPE
-        @socket = nil
+        reset_vars # kill the socket and reset
         raise ConnectionError, 'Broken pipe (got disconnected)'
       end
     end
@@ -225,21 +228,16 @@ class MPD
   # @return [true] If "OK" is returned.
   # @raise [MPDError] If an "ACK" is returned.
   def handle_server_response
-    return if @socket.nil?
-
     msg = ''
-    reading = true
-    error = nil
-    while reading
-      line = @socket.gets
-      case line
+    while true
+      case line = @socket.gets
       when "OK\n", nil
-        reading = false
+        break
       when /^ACK/
         error = line
-        reading = false
+        break
       else
-        msg += line
+        msg << line
       end
     end
 

data/lib/ruby-mpd/exceptions.rb

@@ -12,7 +12,7 @@ class MPD
   class ServerArgumentError < ServerError; end
   # MPD server password incorrect - ACK_ERROR_PASSWORD
   class IncorrectPassword < ServerError; end
-  # ACK_ERROR_PERMISSION - not permitted to use the command. 
+  # ACK_ERROR_PERMISSION - not permitted to use the command.
   # (Mostly, the solution is to connect via UNIX domain socket)
   class PermissionError < ServerError; end
 
@@ -30,4 +30,4 @@ class MPD
   class NotPlaying < ServerError; end
   # ACK_ERROR_EXIST - the resource already exists.
   class AlreadyExists < ServerError; end
-end
+end

data/lib/ruby-mpd/parser.rb

@@ -40,7 +40,7 @@ class MPD
 
 
     # Commands, where it makes sense to always explicitly return an array.
-    RETURN_ARRAY = [:channels, :outputs, :readmessages, :list, :listall, 
+    RETURN_ARRAY = [:channels, :outputs, :readmessages, :list, :listall,
       :listallinfo, :find, :search, :listplaylists, :listplaylist, :playlistfind,
       :playlistsearch, :plchanges, :tagtypes, :commands, :notcommands, :urlhandlers,
       :decoders, :listplaylistinfo]
@@ -57,8 +57,8 @@ class MPD
         value.to_sym
       elsif key == :playlist && !value.to_i.zero?
         # doc states it's an unsigned int, meaning if we get 0,
-        # then it's a name string. HAXX! what if playlist name is '123'?
-        # @todo HAXX
+        # then it's a name string.
+        # @todo HAXX! what if playlist name is '123'?
         value.to_i
       elsif key == :db_update
         Time.at(value.to_i)
@@ -71,13 +71,12 @@ class MPD
       end
     end
 
-    # Parses a single response line into an object.
-    def parse_line(string)
-      return nil if string.nil?
-      key, value = string.split(': ', 2)
+    # Parses a single response line into a key-object (value) pair.
+    def parse_line(line)
+      return nil if line.nil?
+      key, value = line.split(/:\s?/, 2)
       key = key.downcase.to_sym
-      value ||= '' # no nil values please ("album: ")
-      return parse_key(key, value.chomp)
+      return key, parse_key(key, value.chomp)
     end
 
     # This builds a hash out of lines returned from the server,
@@ -88,16 +87,14 @@ class MPD
       return {} if string.nil?
 
       string.split("\n").each_with_object({}) do |line, hash|
-        key, value = line.split(': ', 2)
-        key = key.downcase.to_sym
-        value ||= '' # no nil values please ("album: ")
+        key, object = parse_line(line)
 
         # if val appears more than once, make an array of vals.
         if hash.include? key
-          hash[key] = [hash[key]] if !hash[key].is_a?(Array) # if necessary
-          hash[key] << parse_key(key, value.chomp) # add new val to array
+          hash[key] = Array(hash[key]) # convert to array (http://rubyquicktips.com/post/9618833891/convert-object-to-array)
+          hash[key] << object # add new obj to array
         else # val hasn't appeared yet, map it.
-          hash[key] = parse_key(key, value.chomp) # map val to key
+          hash[key] = object # map obj to key
         end
       end
     end
@@ -109,10 +106,15 @@ class MPD
       return array.map {|hash| Song.new(hash) }
     end
 
+    # Remove lines which we don't want.
+    def filter_lines(string, filter)
+      string.split("\n").reject {|line| line =~ /(#{filter.join('|')}):/}.join("\n")
+    end
+
     # Make chunks from string.
     # @return [Array<String>]
     def make_chunks(string)
-      first_key = string.match(/\A(.+?): /)[1]
+      first_key = string.match(/\A(.+?):\s?/)[1]
 
       chunks = string.split(/\n(?=#{first_key})/)
       chunks.inject([]) do |result, chunk|
@@ -121,28 +123,37 @@ class MPD
     end
 
     # Parses the response, determining per-command on what parsing logic
-    # to use (build_response vs build_grouped_response). 
+    # to use (build_response vs build a single grouped hash).
     #
     # @return [Array<Hash>, Array<String>, String, Integer] Parsed response.
     def parse_response(command, string)
       # return explicit array if needed
-      return RETURN_ARRAY.include?(command) ? [] : true if string.is_a?(TrueClass)
-      command == :listall ? build_grouped_response(string) : build_response(command, string)
+      return RETURN_ARRAY.include?(command) ? [] : true if string == true
+      if command == :listall 
+        build_hash(string)
+      elsif command == :listallinfo
+        build_response(command, string, [:directory, :playlist])
+      else
+        build_response(command, string)
+      end
     end
 
     # Parses the response into appropriate objects (either a single object,
     # or an array of objects or an array of hashes).
     #
     # @return [Array<Hash>, Array<String>, String, Integer] Parsed response.
-    def build_response(command, string)
+    def build_response(command, string, filter=nil)
       return [] if string.nil? || !string.is_a?(String)
 
+      # filter lines if filter specified
+      string = filter_lines(string,filter) if filter
+
       chunks = make_chunks(string)
       # if there are any new lines (more than one data piece), it's a hash, else an object.
       is_hash = chunks.any? {|chunk| chunk.include? "\n"}
 
       list = chunks.inject([]) do |result, chunk|
-        result << (is_hash ? build_hash(chunk) : parse_line(chunk))
+        result << (is_hash ? build_hash(chunk) : parse_line(chunk)[1]) # parse_line(chunk)[1] is object
       end
 
       # if list has only one element and not set to explicit array, return it, else return array
@@ -150,19 +161,5 @@ class MPD
       return result
     end
 
-    # Parse the response into groups that have the same key (used for file lists,
-    # groups together files, directories and playlists).
-    # @return [Hash<Array>] A hash of key groups.
-    def build_grouped_response(string)
-      return [] if string.nil? || !string.is_a?(String)
-
-      string.split("\n").each_with_object({}) do |line, hash|
-        key, value = line.split(': ', 2)
-        key = key.downcase.to_sym
-        hash[key] ||= []
-        hash[key] << parse_key(key, value.chomp) # map val to key
-      end
-    end
-
   end
-end
+end

data/lib/ruby-mpd/playlist.rb

@@ -85,4 +85,4 @@ class MPD
     end
 
   end
-end
+end

data/lib/ruby-mpd/plugins/controls.rb

@@ -19,7 +19,7 @@ class MPD
       # @param [Hash] pos :id of the song where to start playing.
       # @macro returnraise
       def play(pos = nil)
-        if pos.is_a?(Hash) 
+        if pos.is_a?(Hash)
           if pos[:id]
             send_command :playid, priority, pos[:id]
           else
@@ -61,4 +61,4 @@ class MPD
       end
     end
   end
-end
+end

data/lib/ruby-mpd/plugins/database.rb

@@ -110,7 +110,7 @@ class MPD
       def songs_by_artist(artist)
         search :artist, artist
       end
-      
+
     end
   end
-end
+end

data/lib/ruby-mpd/plugins/information.rb

@@ -146,4 +146,4 @@ class MPD
       end
     end
   end
-end
+end

data/lib/ruby-mpd/plugins/outputs.rb

@@ -23,4 +23,4 @@ class MPD
       end
     end
   end
-end
+end

data/lib/ruby-mpd/plugins/playback_options.rb

@@ -85,4 +85,4 @@ class MPD
 
     end
   end
-end
+end

data/lib/ruby-mpd/plugins/playlists.rb

@@ -12,4 +12,4 @@ class MPD
 
     end
   end
-end
+end

data/lib/ruby-mpd/plugins/queue.rb

@@ -43,7 +43,7 @@ class MPD
       # @param [Hash] pos :id to specify the song ID to delete instead of position.
       # @macro returnraise
       def delete(pos)
-        if pos.is_a?(Hash) 
+        if pos.is_a?(Hash)
           if pos[:id]
             send_command :deleteid, pos[:id]
           else
@@ -64,7 +64,7 @@ class MPD
       # @param [Hash] from :id to specify the song ID to move instead of position.
       # @macro returnraise
       def move(from, to)
-        if pos.is_a?(Hash) 
+        if pos.is_a?(Hash)
           if pos[:id]
             send_command :moveid, pos[:id], to
           else
@@ -110,7 +110,7 @@ class MPD
       # @param [Range] pos A range of positions.
       # @param [Hash] pos :id to specify the song ID to move instead of position.
       def song_priority(priority, pos)
-        if pos.is_a?(Hash) 
+        if pos.is_a?(Hash)
           if pos[:id]
             send_command :prioid, priority, pos[:id]
           else
@@ -151,4 +151,4 @@ class MPD
 
     end
   end
-end
+end

data/lib/ruby-mpd/plugins/reflection.rb

@@ -43,4 +43,4 @@ class MPD
       end
     end
   end
-end
+end

data/lib/ruby-mpd/plugins/stickers.rb

@@ -26,7 +26,7 @@ class MPD
       # Adds a sticker value to the specified object. If a sticker
       # item with that name already exists, it is replaced.
       def set_sticker(type, uri, name, value)
-        send_command :sticker, :set, type, uri, name
+        send_command :sticker, :set, type, uri, name, value
       end
 
       # Deletes a sticker value from the specified object. If you do
@@ -49,4 +49,4 @@ class MPD
     end
 
   end
-end
+end

data/lib/ruby-mpd/song.rb

@@ -5,11 +5,16 @@ class MPD; end
 # If the field doesn't exist or isn't set, nil will be returned
 class MPD::Song
   # length in seconds
-  attr_accessor :time
+  attr_reader :file, :title, :time, :artist, :album, :albumartist
 
   def initialize(options)
-    @data = {} #allowed fields are @types + :file
+    @data = {} # allowed fields are @types + :file
     @time = options.delete(:time).first #HAXX for array return
+    @file = options.delete(:file)
+    @title = options.delete(:title)
+    @artist = options.delete(:artist)
+    @album = options.delete(:album)
+    @albumartist = options.delete(:albumartist)
     @data.merge! options
   end
 
@@ -34,4 +39,4 @@ class MPD::Song
       raise NoMethodError, "#{m}"
     end
   end
-end
+end

data/ruby-mpd.gemspec

@@ -3,7 +3,7 @@
 Gem::Specification.new do |s|
   s.platform      = Gem::Platform::RUBY
   s.name          = 'ruby-mpd'
-  s.version       = '0.1.7'
+  s.version       = '0.1.8'
   s.homepage      = 'https://github.com/archSeer/ruby-mpd'
   s.authors       = ["Blaž Hrastnik"]
   s.email         = ['speed.the.bboy@gmail.com']

data/test/libtests.rb

@@ -305,7 +305,7 @@ class MPDTester < Test::Unit::TestCase
     @mpd.connect
 
     dirs = @mpd.directories
-    
+
     assert_equal 7, dirs.size
     assert_equal 'Astral_Projection', dirs[0]
     assert_equal 'Astral_Projection/Dancing_Galaxy', dirs[1]
@@ -439,7 +439,7 @@ class MPDTester < Test::Unit::TestCase
     pls = @mpd.playlist
 
     assert_equal 8, pls.size
-    
+
     pls.each do |song|
       assert_equal 'Astral Projection', song.artist
       assert_equal 'Dancing Galaxy', song.album
@@ -581,7 +581,7 @@ class MPDTester < Test::Unit::TestCase
     @mpd.connect
 
     assert @mpd.ping
-    
+
     @mpd.disconnect
     assert_raise(MPD::ServerError) {@mpd.ping}
   end
@@ -911,7 +911,7 @@ class MPDTester < Test::Unit::TestCase
     assert @mpd.play
 
     sleep 2
-    
+
     assert @mpd.pause = true
 
     sleep 2
@@ -923,7 +923,7 @@ class MPDTester < Test::Unit::TestCase
     song = @mpd.current_song
 
     assert_equal 'Flying Into A Star', song.title
-    
+
     status = @mpd.status
 
     assert_equal '200:585', status['time']
@@ -940,7 +940,7 @@ class MPDTester < Test::Unit::TestCase
     assert @mpd.play
 
     sleep 2
-    
+
     assert @mpd.pause = true
 
     sleep 2
@@ -952,7 +952,7 @@ class MPDTester < Test::Unit::TestCase
     song = @mpd.current_song
 
     assert_equal 'Flying Into A Star', song.title
-    
+
     status = @mpd.status
 
     assert_equal '200:585', status['time']
@@ -963,7 +963,7 @@ class MPDTester < Test::Unit::TestCase
 
   def test_volume
     @mpd.connect
-    
+
     vol = @mpd.volume
 
     @mpd.volume = 30
@@ -1121,7 +1121,7 @@ class MPDTester < Test::Unit::TestCase
     assert_equal 1, ret
 
     status = @mpd.status
-    
+
     assert_equal '1', status['updating_db']
 
     status = @mpd.status

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mpd
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-22 00:00:00.000000000 Z
+date: 2013-01-27 00:00:00.000000000 Z
 dependencies: []
 description: A powerful, modern and feature complete library for the Music Player
   Daemon.