ruby-mpd 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abe8c832ca9a5b9254a92bfe8927b132c3bbe498
-  data.tar.gz: dbb36caae0622e63cc70149924911dec0d1abde1
+  metadata.gz: d97d6dfaa6b5323b36dcd22fba6c4bcd43bf562c
+  data.tar.gz: 5b006f249e407ff97378887b8bf60ad94035c97c
 SHA512:
-  metadata.gz: 861e3e63f0a6faeff4794b226e38475ea404c20d1f9a3fcb2b9eb37b0394f090aa6a933c134f2e2d389b8134107a859df94e26f86ab56e93e352e30bd416b12c
-  data.tar.gz: 35d40fc9e2b6ee08d6b564c7ec1f7b301699bec390248fc0bc270a1a1b68d56b3906a2010c9734efeb31363c5b64b5f4b8ea566c6a08da0c594b6fd967c5b873
+  metadata.gz: e7c25979f1d9af125916c1f3072d0f5678bbe8afdb4b7c7b2c7804062cd5e154658097958418fbca579801ec441ab86e08a2b5202403fd440b6bc73cc42cd3c0
+  data.tar.gz: dda3e10e3c3a74433a48832178c78a25188c947ee407fb7897e0944a49f5b0d8557691bf1fd8515a2d4ff4e1487e83ec2f2fb37c581de608cb722c4da4b2582b

data/README.rdoc

@@ -45,14 +45,14 @@ via a reconnect mechanism.
 
 Once connected, you can issue commands to talk to the server.
 
-    mpd.connect
+  mpd.connect
     
-    mpd.play if mpd.stopped?
+  mpd.play if mpd.stopped?
 
-    song = mpd.current_song
-    puts "Current Song: #{song.artist} - #{song.title}"
+  song = mpd.current_song
+  puts "Current Song: #{song.artist} - #{song.title}"
 
-You can find command documentation can be found {here}[http://www.rubydoc.info/github/archSeer/ruby-mpd/master/MPD].
+Command documentation can be found {here}[http://www.rubydoc.info/github/archSeer/ruby-mpd/master/MPD].
 
 == Commands
 
@@ -98,16 +98,45 @@ Commands that support ranges: +#delete+, +#move+, +#queue+, +#song_priority+, +#
 
 == Searching
 
-Searching is case insensitive by default. To enable case sensitivity, pass a third
-argument with the key +:case_sensitive+. This does not work for Playlist#searchadd.
+The MPD protocol supports two commands +find+ and +search+, where +find+ is strict
+and will be case sensitive, as well as return only full matches, while +search+ is
+"loose" -- case insensitive and allow partial matches.
+
+For ease of use, ruby-mpd encapsulates both +find+ and +search+ in one method,
++MPD#where+.
+
+Searching is case *loose* by default, meaning it is case insensitive, and will do
+partial matching. To enable *strict* matching, enable the +strict+ option.
+
+This does not work for Playlist#searchadd.
+
+  mpd.where({artist: 'MyArtiSt'}, {strict: true})
+
+Multiple query parameters can also be used:
+
+  mpd.where(artist: 'Bonobo', album: 'Black Sands')
 
-  mpd.search(:artist, 'MyArtiSt', :case_sensitive => true)
+Query keys can be any of of the tags supported by MPD (a list can be fetched via
+MPD#tags), or one of the two special parameters: +:file+ to search by full path
+(relative to database root), and +:any+ to match against all available tags.
 
 While searching, one can also enable the +add+ option, which will automatically add
 the songs the query returned to the queue. In that case, the response will only return
 +true+, stating that the operation was successful (instead of returning an array).
 
-  mpd.search(:artist, 'MyArtiSt', {:case_sensitive => true, :add => true})
+  mpd.where({artist: 'MyArtiSt'}, {strict: true, add: true})
+
+=== Queue searching
+
+Queue searching works the same way (except by using +MPD#queue_where+), and it also
+accepts multiple search parameters (which seems to be undocumented in the MPD protocol
+specification).
+
+Same as +#where+, it is "loose" by default, and it supports a +:strict+ option.
+
+  mpd.queue_where(artist: 'James Brown', genre: 'Funk')
+
+  mpd.queue_where({artist: 'James Brown', genre: 'Funk'}, {strict: true})
 
 == Playlists
 
@@ -129,7 +158,7 @@ get your results, you simply use the object in an object-oriented way:
   playlist.add('awesome_track.mp3')
 
 To create a new playlist, simply create a new object. The playlist will be created
-in the daemon's library automatically as soon as you use +#add+ or +#findadd+. There
+in the daemon's library automatically as soon as you use +#add+ or +#searchadd+. There
 is also no save method, as playlists get 'saved' by the daemon any time you do an
 action on them (add, delete, rename).
 
@@ -262,4 +291,6 @@ for a controlled environment needs to be written.
 
 * MPD::Song, MPD::Directory.
 * Make stickers a mixin for Playlist, Song, Directory...
-* Namespace queue
+* Namespace queue
+
+* Merge +where+ and +queue_where+, by doing +where(..., {in_queue: true})+?

data/Rakefile

@@ -1,6 +1,16 @@
 require 'rake/testtask'
+
 Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-task :default => :test
+desc "Open an irb session preloaded with this API"
+task :console do
+  $:.unshift(File.expand_path('../lib', __FILE__))
+  require 'ruby-mpd'
+  require 'irb'
+  ARGV.clear
+  IRB.start
+end
+
+task :default => :test

data/lib/ruby-mpd.rb

@@ -39,8 +39,7 @@ class MPD
   include Plugins::Reflection
   include Plugins::Channels
 
-  # The version of the MPD protocol the server is using.
-  attr_reader :version
+  attr_reader :version, :hostname, :port
 
   # Initialize an MPD object with the specified hostname and port.
   # When called without arguments, 'localhost' and 6600 are used.
@@ -86,8 +85,7 @@ class MPD
   # @param [Proc, Method] block The actual callback.
   # @return [void]
   def on(event, &block)
-    @callbacks[event] ||= []
-    @callbacks[event].push block
+    (@callbacks[event] ||= []).push block
   end
 
   # Triggers an event, running it's callbacks.
@@ -95,9 +93,7 @@ class MPD
   # @return [void]
   def emit(event, *args)
     return unless @callbacks[event]
-    @callbacks[event].each do |handle|
-      handle.call *args
-    end
+    @callbacks[event].each { |handle| handle.call *args }
   end
 
   # Constructs a callback loop thread and/or resumes it.
@@ -110,21 +106,19 @@ class MPD
 
         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[:time] ||= [nil, nil] # elapsed, total
+        status[:audio] ||= [nil, nil, nil] # samp, bits, chans
         status[:song] = mpd.current_song
 
         status.each do |key, val|
           next if val == old_status[key] # skip unchanged keys
-          # convert arrays to splat arguments
-          val.is_a?(Array) ? emit(key, *val) : emit(key, val)
+          emit key, *val # splat arrays
         end
 
         old_status = status
         sleep 0.1
 
-        if !status[:connection] && !Thread.current[:stop]
+        unless status[:connection] || Thread.current[:stop]
           sleep 2
           mpd.connect rescue nil
         end
@@ -151,12 +145,11 @@ class MPD
 
     # by protocol, we need to get a 'OK MPD <version>' reply
     # should we fail to do so, the connection was unsuccessful
-    if response = @socket.gets
-      @version = response.chomp.gsub('OK MPD ', '') # Read the version
-    else
+    unless response = @socket.gets
       reset_vars
       raise ConnectionError, 'Unable to connect (possibly too many connections open)'
     end
+    @version = response.chomp.gsub('OK MPD ', '') # Read the version
 
     if callbacks
       warn "Using 'true' or 'false' as an argument to MPD#connect has been deprecated, and will be removed in the future!"
@@ -171,10 +164,8 @@ class MPD
   #
   # @return [Boolean] True only if the server responds otherwise false.
   def connected?
-    return false if !@socket
-
-    ret = send_command(:ping) rescue false
-    return ret
+    return false unless @socket
+    send_command(:ping) rescue false
   end
 
   # Disconnect from the MPD daemon. This has no effect if the client is not
@@ -184,7 +175,7 @@ class MPD
   def disconnect
     @cb_thread[:stop] = true if @cb_thread
 
-    return false if !@socket
+    return false unless @socket
 
     begin
       @socket.puts 'close'
@@ -269,12 +260,9 @@ class MPD
       end
     end
 
-    if !error
-      return msg
-    else
-      err = error.match(/^ACK \[(?<code>\d+)\@(?<pos>\d+)\] \{(?<command>.*)\} (?<message>.+)$/)
-      raise SERVER_ERRORS[err[:code].to_i], "[#{err[:command]}] #{err[:message]}"
-    end
+    return msg unless error
+    err = error.match(/^ACK \[(?<code>\d+)\@(?<pos>\d+)\] \{(?<command>.*)\} (?<message>.+)$/)
+    raise SERVER_ERRORS[err[:code].to_i], "[#{err[:command]}] #{err[:message]}"
   end
 
   SERVER_ERRORS = {

data/lib/ruby-mpd/parser.rb

@@ -12,25 +12,30 @@ class MPD
     private
 
     # Parses the command into MPD format.
-    def convert_command(command, *args)
-      args.map! do |word|
-        if word.is_a?(TrueClass) || word.is_a?(FalseClass)
-          word ? '1' : '0' # convert bool to 1 or 0
-        elsif word.is_a?(Range)
-          if word.end == -1 # negative means to end of range
-            "#{word.begin}:"
+    def convert_command(command, *params)
+      params.map! do |param|
+        case param
+        when true, false
+          param ? '1' : '0' # convert bool to 1 or 0
+        when Range
+          if param.end == -1 # negative means to end of range
+            "#{param.begin}:"
           else
-            "#{word.begin}:#{word.end + (word.exclude_end? ? 0 : 1)}"
+            "#{param.begin}:#{param.end + (param.exclude_end? ? 0 : 1)}"
           end
-        elsif word.is_a?(MPD::Song)
-          %Q["#{word.file}"] # escape filename
+        when MPD::Song
+          %Q["#{param.file}"] # escape filename
+        when Hash # normally a search query
+          param.each_with_object("") do |(type, what), query|
+            query << %Q[#{type} "#{what}" ]
+          end.strip
         else
           # escape any strings with space (wrap in double quotes)
-          word = word.to_s
-          word.match(/\s|'/) ? %Q["#{word}"] : word
+          param = param.to_s
+          param.match(/\s|'/) ? %Q["#{param}"] : param
         end
       end
-      return [command, args].join(' ').strip
+      return [command, params].join(' ').strip
     end
 
     INT_KEYS = [
@@ -77,7 +82,6 @@ class MPD
 
     # 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
       return key, parse_key(key, value.chomp)
@@ -95,8 +99,7 @@ class MPD
 
         # if val appears more than once, make an array of vals.
         if hash.include? key
-          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
+          hash[key] = Array(hash[key]) << object
         else # val hasn't appeared yet, map it.
           hash[key] = object # map obj to key
         end
@@ -106,7 +109,7 @@ class MPD
     # Converts the response to MPD::Song objects.
     # @return [Array<MPD::Song>] An array of songs.
     def build_songs_list(array)
-      return array.map {|hash| Song.new(hash) }
+      return array.map { |hash| Song.new(hash) }
     end
 
     # Remove lines which we don't want.
@@ -118,11 +121,7 @@ class MPD
     # @return [Array<String>]
     def make_chunks(string)
       first_key = string.match(/\A(.+?):\s?/)[1]
-
-      chunks = string.split(/\n(?=#{first_key})/)
-      chunks.inject([]) do |result, chunk|
-        result << chunk.strip
-      end
+      chunks = string.split(/\n(?=#{first_key})/).map(&:strip)
     end
 
     # Parses the response, determining per-command on what parsing logic
@@ -149,16 +148,14 @@ class MPD
     def build_response(command, string)
       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"}
+      is_hash = chunks.any? { |chunk| chunk.include? "\n" }
 
       list = chunks.inject([]) do |result, 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
-      result = (list.length == 1 && !RETURN_ARRAY.include?(command)) ? list.first : list
-      return result
+      (list.length == 1 && !RETURN_ARRAY.include?(command)) ? list.first : list
     end
-
   end
 end

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

@@ -45,6 +45,8 @@ class MPD
       # Searches are case insensitive by default, however you can enable
       # it using the third argument.
       #
+      # @deprecated Use {#where} instead.
+      #
       # Options:
       # * *add*: Add the search results to the queue.
       # * *case_sensitive*: Make the query case sensitive.
@@ -56,13 +58,41 @@ class MPD
       # @return [Array<MPD::Song>] Songs that matched.
       # @return [true] if +:add+ is enabled.
       def search(type, what, options = {})
+        warn "MPD#search is deprecated! Use MPD#where instead."
+        options[:strict] = options[:case_sensitive] # transparently upgrade renamed option
+        where({type => what}, options)
+      end
+
+      # Searches the database for any songs that match the specified parameters.
+      # Searching is *loose* (case insensitive and allow partial matching) by
+      # default.
+      #
+      # The search keys can be any of the tags supported by MPD, or one of the
+      # two special parameters: +:file+ to search by full path (relative to
+      # database root), and +:any+ to match against all available tags.
+      #
+      #    mpd.where(artist: "DJ Shadow", album: "Endtroducing.....")
+      #
+      # A hash of options can be passed as a last parameter:
+      #
+      #    mpd.where({artist: "Nujabes", album: "Modal Soul"}, {add: true})
+      #
+      # Options:
+      # * *add*: Add search results to the queue.
+      # * *strict*: Search will be *case sensitive* and allow only *full matches*.
+      #
+      # @param [Hash] params A hash of search parameters.
+      # @param [Hash] options A hash of options.
+      # @return [Array<MPD::Song>] Songs that matched.
+      # @return [true] if +:add+ is enabled.
+      def where(params, options = {})
         if options[:add]
-          command = options[:case_sensitive] ? :findadd : :searchadd
+          command = options[:strict] ? :findadd : :searchadd
         else
-          command = options[:case_sensitive] ? :find : :search
+          command = options[:strict] ? :find : :search
         end
 
-        build_songs_list send_command(command, type, what)
+        build_songs_list send_command(command, params)
       end
 
       # Tell the server to update the database. Optionally,
@@ -110,7 +140,7 @@ class MPD
       #
       # @return [Array<MPD::Song>]
       def songs_by_artist(artist)
-        search :artist, artist
+        where(artist: artist)
       end
 
     end

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

@@ -95,54 +95,54 @@ class MPD
       # Is MPD paused?
       # @return [Boolean]
       def paused?
-        return status[:state] == :pause
+        status[:state] == :pause
       end
 
       # Is MPD playing?
       # @return [Boolean]
       def playing?
-        return status[:state] == :play
+        status[:state] == :play
       end
 
       # @return [Boolean] Is MPD stopped?
       def stopped?
-        return status[:state] == :stop
+        status[:state] == :stop
       end
 
       # Gets the volume level.
       # @return [Integer]
       def volume
-        return status[:volume]
+        status[:volume]
       end
 
       # @return [Integer] Crossfade in seconds.
       def crossfade
-        return status[:xfade]
+        status[:xfade]
       end
 
       # @return [Integer] Current playlist version number.
       def playlist_version
-        return status[:playlist]
+        status[:playlist]
       end
 
       # Returns true if consume is enabled.
       def consume?
-        return status[:consume]
+        status[:consume]
       end
 
       # Returns true if single is enabled.
       def single?
-        return status[:single]
+        status[:single]
       end
 
       # Returns true if random playback is currently enabled,
       def random?
-        return status[:random]
+        status[:random]
       end
 
       # Returns true if repeat is enabled,
       def repeat?
-        return status[:repeat]
+        status[:repeat]
       end
     end
   end

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

@@ -7,7 +7,7 @@ class MPD
       #
       # @return [Array<MPD::Playlist>] Array of playlists
       def playlists
-        send_command(:listplaylists).map {|opt| MPD::Playlist.new(self, opt)}
+        send_command(:listplaylists).map { |opt| MPD::Playlist.new(self, opt) }
       end
 
     end

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

@@ -84,6 +84,8 @@ class MPD
       # Searches for songs in the queue matched by the what
       # argument. Case insensitive by default.
       #
+      # @deprecated Use {#queue_where} instead.
+      #
       # @param [Symbol] type Can be any tag supported by MPD, or one of the two special
       #   parameters: +:file+ to search by full path (relative to database root),
       #   and +:any+ to match against all available tags.
@@ -91,8 +93,34 @@ class MPD
       # @param [Hash] options Use +:case_sensitive+ to make the query case sensitive.
       # @return [Array<MPD::Song>] Songs that matched.
       def queue_search(type, what, options = {})
-        command = options[:case_sensitive] ? :playlistfind : :playlistsearch
-        build_songs_list send_command(command, type, what)
+        warn "MPD#queue_search is deprecated! Use MPD#where instead."
+        options[:strict] = options[:case_sensitive] # transparently upgrade renamed option
+        queue_where({type => what}, options)
+      end
+
+      # Searches the queue for any songs that match the specified parameters.
+      # Searching is *loose* (case insensitive and allow partial matching) by
+      # default.
+      #
+      # The search keys can be any of the tags supported by MPD, or one of the
+      # two special parameters: +:file+ to search by full path (relative to
+      # database root), and +:any+ to match against all available tags.
+      #
+      #    mpd.queue_where(artist: "DJ Shadow", album: "Endtroducing.....")
+      #
+      # A hash of options can be passed as a last parameter:
+      #
+      #    mpd.queue_where({artist: "Nujabes", album: "Modal Soul"}, {add: true})
+      #
+      # Options:
+      # * *strict*: Search will be *case sensitive* and allow only *full matches*.
+      #
+      # @param [Hash] params A hash of search parameters.
+      # @param [Hash] options A hash of options.
+      # @return [Array<MPD::Song>] Songs that matched.
+      def queue_where(params, options = {})
+        command = options[:strict] ? :playlistfind : :playlistsearch
+        build_songs_list send_command(command, params)
       end
 
       # List the changes since the specified version in the queue.
@@ -105,6 +133,13 @@ class MPD
 
       # Set the priority of the specified songs. A higher priority means that it will be played
       # first when "random" mode is enabled.
+      #
+      # Several ranges or ID's can be specified at once:
+      #
+      #  mpd.song_priority(10, [5..7, 9..10]) # songs 5 to 10, excluding 8
+      #
+      #  mpd.song_priority(10, {id: [5, 8, 12]}) # songs with ID's 5, 8 and 12
+      #
       # @param [Integer] priority An integer between 0 and 255. The default priority of new songs is 0.
       # @param [Integer] pos A specific position.
       # @param [Range] pos A range of positions.
@@ -112,12 +147,12 @@ class MPD
       def song_priority(priority, pos)
         if pos.is_a?(Hash)
           if pos[:id]
-            send_command :prioid, priority, pos[:id]
+            send_command :prioid, priority, *pos[:id]
           else
             raise ArgumentError, 'Only :id key is allowed!'
           end
         else
-          send_command :prio, priority, pos
+          send_command :prio, priority, *pos
         end
       end
 

data/lib/ruby-mpd/song.rb

@@ -9,7 +9,7 @@ class MPD::Song
 
   def initialize(options)
     @data = {} # allowed fields are @types + :file
-    @time = options.delete(:time) { [nil] }.first #HAXX for array return
+    @time = options.delete(:time) { [nil] }.first # HAXX for array return
     @file = options.delete(:file)
     @title = options.delete(:title)
     @artist = options.delete(:artist)
@@ -25,11 +25,8 @@ class MPD::Song
 
   # @return [String] A formatted representation of the song length ("1:02")
   def length
-    if @time.nil?
-      '--:--'
-    else
-      "#{(@time / 60)}:#{"%02d" % (@time % 60)}"
-    end
+    return '--:--' if @time.nil?
+    "#{@time / 60}:#{"%02d" % (@time % 60)}"
   end
 
   # Pass any unknown calls over to the data hash.

data/lib/ruby-mpd/version.rb

@@ -1,3 +1,3 @@
 class MPD
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/ruby-mpd.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |s|
   s.name          = 'ruby-mpd'
   s.version       = MPD::VERSION
   s.homepage      = 'https://github.com/archSeer/ruby-mpd'
+  s.license       = 'GPL-2'
   s.authors       = ["Blaž Hrastnik"]
   s.email         = ['speed.the.bboy@gmail.com']
   s.summary       = "Modern client library for MPD"
@@ -16,4 +17,4 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mpd
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Blaž Hrastnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-24 00:00:00.000000000 Z
+date: 2014-01-27 00:00:00.000000000 Z
 dependencies: []
 description: A powerful, modern and feature complete library for the Music Player
   Daemon.
@@ -18,7 +18,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - COPYING
 - README.rdoc
 - Rakefile
@@ -41,7 +41,8 @@ files:
 - ruby-mpd.gemspec
 - test/test_parser.rb
 homepage: https://github.com/archSeer/ruby-mpd
-licenses: []
+licenses:
+- GPL-2
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -49,20 +50,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Modern client library for MPD
 test_files:
 - test/test_parser.rb
-has_rdoc: