dhun 0.5.4 → 0.5.5

data/FIX.md

@@ -1,5 +1,4 @@
 ## Fixes/Improvements required
 
-* Better Argument Handling. For e.g. `dhun play` w/o any arguments still works
-
-* Maintaining history of all files played in the session
+* Refactor multiple calls to result.to_json
+* Refactor handler calls by converting it from module to subclass of EventMachine::Connection object

data/README.md

@@ -29,42 +29,53 @@ the `gem` command to compile the native extensions.
 Pass the `-d` option to run the server as a daemon in the background. See
 `dhun -h` for more options.
 
-### Playing Files
+
+### Querying for files
 
 Dhun uses Spotlight to query for music files. Just specify a keyword, and Dhun
 will look for files matching that keyword and start playing them.
 
-You can also query the Spotlight database before playing the files.
+You can also query the Spotlight database before playing the files, with the 
+`query` command.
 
     $ dhun query here
-    9 Results
+    3 Results
     /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/01 40 Day Dream.mp3
     /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/02 Janglin.mp3
     /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/03 Carries On.mp3
-    /Users/deepak/Music/Amazon MP3/Edward Sharpe & The Magnetic Zeros/Here Comes/01 - 40 Day Dream.mp3
-    /Users/deepak/Music/Amazon MP3/Edward Sharpe & The Magnetic Zeros/Here Comes/02 - Janglin.mp3
-    /Users/deepak/Music/Amazon MP3/Edward Sharpe & The Magnetic Zeros/Here Comes/03 - Carries On.mp3
-    /Users/deepak/Dropbox/shared/music/Here Comes/02 - Janglin.mp3
-    /Users/deepak/Dropbox/shared/music/Here Comes/01 - 40 Day Dream.mp3
-    /Users/deepak/Dropbox/shared/music/Here Comes/03 - Carries On.mp3
 
-And then, when you are ready to play the files. Note that the `play` command
-will remove anything that may be already there on your queue. To add files,
-use `enqueue`.
+You can use query filters like `album:sid` or `artist:rahman`. Currently
+`album`, `artist`, `title`, `genre` and `file` filters are supported. 
+
+    $ dhun query genre:world album:gypsy
+    5 results
+    /Users/deepak/Dropbox/shared/music/gypsy/Putumayo - Gypsy Groove - 11 - Eastenders - Vino Iubirea Mea (!DelaDap Remix) (Germany).mp3
+    /Users/deepak/Dropbox/shared/music/gypsy/Putumayo - Gypsy Groove - 10 - Luminescent Orchestrii - Amari Szi, Amari (Amon Remix)  (USA).mp3
+    /Users/deepak/Dropbox/shared/music/gypsy/Putumayo - Gypsy Groove - 09 - Kistehén Tánczenekar - Virágok a Réten (Romano Drom Remix) (Hungary).mp3
+    /Users/deepak/Dropbox/shared/music/gypsy/Putumayo - Gypsy Groove - 08 - Anselmo Crew - Süt Ictim Dilim Yandi (Hungary).mp3
+    /Users/deepak/Dropbox/shared/music/gypsy/Putumayo - Gypsy Groove - 07 - Magnifico & Turbolentza - Zh Ne Sui Pa Pur Tua (Slovenia).mp3
+
+You can even mix the filters with a regular query like.
+
+    $ dhun query genre:world album:gypsy Czech
+    2 Results
+    /Users/deepak/Dropbox/shared/music/gypsy/Putumayo - Gypsy Groove - 01 - !DelaDap - Zsa Manca (Czech Republic-Hungary).mp3
+    /Users/deepak/Dropbox/shared/music/gypsy/Putumayo - Gypsy Groove - 03 - Gipsy.cz - Jednou (Czech Republic).mp3
+
+Note that if you want to pass filters longer than a word, you will need to
+enclose the argument in double quotes, like `dhun query "artist:akli d"`
+
+### Playing Files
+
+When you are ready to play the files, pass the query to the `play` command.
+Note that the `play` command will remove anything that may be already there on
+your queue. To append files to queue, use `enqueue`.
 
     $ dhun play here
-    9 files queued for playing
+    3 files queued for playing
     /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/01 40 Day Dream.mp3
     /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/02 Janglin.mp3
     /Users/deepak/Music/iTunes/iTunes Media/Music/Edward Sharpe & The Magnetic Zeros/Here Comes/03 Carries On.mp3
-    /Users/deepak/Music/Amazon MP3/Edward Sharpe & The Magnetic Zeros/Here Comes/01 - 40 Day Dream.mp3
-    /Users/deepak/Music/Amazon MP3/Edward Sharpe & The Magnetic Zeros/Here Comes/02 - Janglin.mp3
-    /Users/deepak/Music/Amazon MP3/Edward Sharpe & The Magnetic Zeros/Here Comes/03 - Carries On.mp3
-    /Users/deepak/Dropbox/shared/music/Here Comes/02 - Janglin.mp3
-    /Users/deepak/Dropbox/shared/music/Here Comes/01 - 40 Day Dream.mp3
-    /Users/deepak/Dropbox/shared/music/Here Comes/03 - Carries On.mp3
-
-More advanced querying support is coming soon.
 
 ### Controlling Playback
 
@@ -97,8 +108,7 @@ Status
     /Users/deepak/Dropbox/shared/music/Here Comes/01 - 40 Day Dream.mp3
     /Users/deepak/Dropbox/shared/music/Here Comes/03 - Carries On.mp3
 
-Enqueuing more files. Note that `dhun play` will empty the current queue
-before adding new files.
+Enqueuing more files.
 
     $ dhun enqueue chup
     1 files queued for playing.
@@ -116,7 +126,6 @@ These features are planned in the next few releases
 
 * Playing previous song, using something like `dhun prev`
 * Skipping ahead by more than one file, like `dhun next 2` or `dhun prev 2`
-* Advanced querying support with filters, like `dhun play "artist:Rahman"`
 
 And someday..
 

data/dhun.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = 'dhun'
-  s.version = '0.5.4'
+  s.version = '0.5.5'
   s.summary = "Minimalist music player for OS X"
-  s.date = '2009-12-10'
+  s.date = '2009-12-14'
   s.email = 'deepak.jois@gmail.com'
   s.homepage = 'http://github.com/deepakjois/dhun'
   s.has_rdoc = false

data/lib/dhun.rb

@@ -1,5 +1,5 @@
 module Dhun
-  VERSION = '0.5.4'
+  VERSION = '0.5.5'
 
   autoload :Runner, 'dhun/runner'
   autoload :Controller, 'dhun/controller'

data/lib/dhun/controller.rb

@@ -23,7 +23,8 @@ module Dhun
     end
     
     def query(*args)
-      q = Query.new(args.join(' '))
+      abort_if_empty_args(args)
+      q = Query.new(args)
       if q.is_valid?
         files = q.execute_spotlight_query
         puts(files.empty? ? "No Results Found" : "#{files.size} Results\n" + files.join("\n"))
@@ -33,6 +34,7 @@ module Dhun
     end
 
     def play(*args)
+      abort_if_empty_args(args)
       resp = get_json_response("play", args)
       return unless resp
       # Process response
@@ -47,6 +49,7 @@ module Dhun
     end
 
     def enqueue(*args)
+      abort_if_empty_args(args)
       resp = get_json_response("enqueue",args)
       return unless resp
       # Process response
@@ -76,6 +79,13 @@ module Dhun
       end
     end
 
+    def history
+      resp = get_json_response("history")
+      return unless resp
+      puts resp[:message]
+      print_list(resp[:history]) unless resp[:history].empty?
+    end
+
     def next(*args)
       resp = get_json_response("next")
       puts resp[:message] if resp
@@ -112,7 +122,7 @@ module Dhun
       resp = client.send(cmd)
     end
 
-    def get_json_response(command,*args)
+    def get_json_response(command,args=[])
       begin 
          resp = send_command(command,args)
          return Result.from_json_str(resp)
@@ -123,6 +133,10 @@ module Dhun
       end
     end
 
+    def abort_if_empty_args(args)
+      abort "You must pass in atleast one argument" if args.empty? 
+    end
+
     def print_list(list)
       list.each { |item| puts item }
     end

data/lib/dhun/handler.rb

@@ -5,13 +5,13 @@ module Dhun
     def stop
       result = Result.new :success, "Dhun is stopping"
       Server.stop
-      Player.instance.pause
+      Player.instance.stop
       return result.to_json
     end
     
     def play(*args)
       @player = Player.instance
-      q = Query.new(args.join(" "))
+      q = Query.new(args)
       if q.is_valid?
         files = q.execute_spotlight_query
         if files.empty?
@@ -57,6 +57,13 @@ module Dhun
       result = Result.new :success, status_msg, :now_playing => now_playing, :queue => queue
       result.to_json
     end
+
+    def history
+      @player = Player.instance
+      status_msg = @player.history.empty? ? "No files in history" : "#{@player.history.size} files in history"
+      result = Result.new :success, status_msg, :history => @player.history
+      result.to_json
+    end
     
     def next(*args)
       @player = Player.instance

data/lib/dhun/player.rb

@@ -5,6 +5,7 @@ module Dhun
     include Singleton
 
     attr_reader :queue
+    attr_reader :history
     attr_reader :status
     attr_reader :current
 
@@ -12,6 +13,7 @@ module Dhun
 
     def initialize
       @queue = []
+      @history = []
       @logger = Logger.instance
       @status = :stopped
     end
@@ -46,6 +48,7 @@ module Dhun
           @current = @queue.shift
           logger.log "Playing #{@current}"
           DhunExt.play_file @current
+          @history.unshift @current
         end
         @status = :stopped
         logger.log "Finished playing #{@current}"
@@ -69,13 +72,14 @@ module Dhun
 
     def stop
       @status = :stopped
-      @current = nil
       DhunExt.stop
       # Wait for @player_thread to exit cleanly
       @player_thread.join unless @player_thread.nil?
+      logger.debug "Stopped"
     end
 
     def next
+      logger.debug "Switching to next"
       stop # stops current track
       next_track = @queue.first
       play # start playing with the next track

data/lib/dhun/query.rb

@@ -1,23 +1,49 @@
 require 'dhun_ext'
+
 module Dhun
   class Query
 
     MD_ITEMS = [:kMDItemAlbum, :kMDItemAuthors, :kMDItemComposer, :kMDItemDisplayName, :kMDItemFSName, :kMDItemTitle, :kMDItemMusicalGenre]
-    attr_reader :query_string
+    MAPPINGS = { "file" => :kMDItemFSName, "album" => :kMDItemAlbum, "artist" => :kMDItemAuthors, "title" => :kMDItemTitle, "genre" => :kMDItemMusicalGenre }
+
     attr_reader :spotlight_query
 
-    def initialize(query_string)
-      @query_string = query_string
+    def initialize(args)
+      @query_args = args
       parse
     end
 
     def parse
-      str = MD_ITEMS.collect do |item|
-             "#{item.to_s} == '#{@query_string}'wc" 
-            end.join(" || ")
+      return if @query_args.empty?
+      filters = []
+      strings = []
+
+      @query_args.each do |arg|
+        # Check if it is a filter
+        if filter?(arg)
+          filters.push(arg)
+        else
+          strings.push(arg)
+        end
+      end
+
+      mappings = MD_ITEMS.clone
+      fq = filters.collect do |f|
+             fltr,query = *(f.split(":"))
+             md_item = MAPPINGS[fltr]
+             mappings.delete md_item
+             "#{md_item} == '#{query.strip}'wc"
+           end.join(" && ")
+
 
-      @spotlight_query = "kMDItemContentTypeTree == 'public.audio' && (#{str})"
-      #puts @spotlight_query
+      template = "%s == '%s'wc"
+      sq = strings.collect do |keyword|
+        q = mappings.collect { |key|  template % [key,keyword]  }.join(" || ")
+        "( #{q} )"
+      end.join(" && ")
+
+      @spotlight_query = ["kMDItemContentTypeTree == 'public.audio'", fq, sq].select { |s| s.length > 0 }.join(" && ")
+      Logger.instance.debug @spotlight_query
       @is_valid = true
     end
 
@@ -25,20 +51,16 @@ module Dhun
       @is_valid
     end
 
+    def filter?(str)
+      return false unless str.index ":"
+      a,b = *(str.split(":"))
+      # Check if filter is valid
+      return MAPPINGS.keys.member?(a)
+    end
+
     # Use extension to query spotlight
     def execute_spotlight_query
       return DhunExt.query_spotlight(@spotlight_query)
     end
-
-    def get_metadata_item(field)
-      case field
-        when "album"    then :kMDItemAlbum
-        when "artist"   then :kMDItemAuthors
-        when "composer" then :kMDItemComposer
-        when "title"    then :kMDItemTitle
-        when "genre"    then :kMDItemMusicalGenre
-        else "Unknown"
-      end
-    end
   end
 end

data/lib/dhun/runner.rb

@@ -5,7 +5,7 @@ module Dhun
   # Heavily lifted from Thin codebase
   class Runner
     COMMANDS = %w(start query)
-    CLIENT_COMMANDS = %w(stop play pause resume next enqueue status shuffle)
+    CLIENT_COMMANDS = %w(stop play pause resume next enqueue status shuffle history)
     # Parsed options
     attr_accessor :options
 
@@ -94,7 +94,11 @@ EOF
 
     def run_command
       controller = Controller.new(@options)
-      controller.send(@command,*@arguments)
+      begin
+        controller.send(@command,*@arguments)
+      rescue ArgumentError
+        abort "Illegal arguments passed to #{@command}"
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dhun
 version: !ruby/object:Gem::Version 
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors: 
 - Deepak Jois
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-10 00:00:00 -08:00
+date: 2009-12-14 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency