hearken 0.0.4 → 0.0.5

data/HISTORY.rdoc

@@ -1,3 +1,9 @@
+= 0.0.5
+
+* fixed 'recent' command - the library is sorted on file modification date
+* moved 'current_song' from working directory to .hearken directory
+* Changed dequeue to return track instead of id - this fixed a bug where reindexing would cause player to start playing the wrong files.
+
 = 0.0.4
 
 * Partially fixed bug with growl (correctly escaping characters in message)

data/README.rdoc

@@ -26,14 +26,20 @@ Growl notification (as new tracks are played) will work but only if 'growlnotify
 
     hearken index DIRECTORY
 
-Will create a track index at ~/.music.  Note that this might take a while the first time you run it.
+Will create a track index at ~/.hearken/music.  Note that this might take a while the first time you run it.
 
 Subsequent runs will only query tags for new or modified files so should be fairly fast.
 
+The index can be regenerated while the console is running and reloaded using the 'reload' command.
+
 == Console
 
     hearken console
 
+This enters an interactive prompt where you can start/stop the player, search and enqueue tracks.
+
+The queue will be persisted to ~/.hearken/queue
+
 == Commands
 
     ?
@@ -44,8 +50,47 @@ will list all commands
 
 will describe the use and purpose of a particular command
 
+== Main commands
+
+    search iver bon
+
+Searches for tracks with 'bon' and 'iver' in the track, artist or album name (this is case insensitive).
+
+Results will be displayed and the ids will be added to the clipboard (for convenient pasting to the '+' command).
+
+    + abc-f 123 456
+
+Enqueues tracks with ids abc, abd, abe, abf, 123 and 456
+
+    start
+
+Starts the player
+
+    stop
+
+Stops the player
+
+    next
+
+Stops and restarts the player (which will kill the currently playing track)
+
+    setup_scrobbling
+
+Runs through a wizard to configure scrobbling to last.fm
+
+	scrobbling on
+
+Turns scrobbling on (has no effect if scrobbling has not been configured)
+
+	scrobbling off
+
+Turns scrobbling off
+
 = Future plans for world domination
 
-* Fix or remove 'recent' - it should sort library based on file modification date
+* add a '-' command to remove tracks from queue
+* add a command to launch last.fm profile (for track history)
+* put some content on wiki to explain usage (especially use of track ranges '+ eft-z')
+* eliminate last.fm setup command once setup and add lastfm commands only when setup
 * Get working on linux
 * Get working on windows

data/lib/hearken.rb

@@ -1,3 +1,3 @@
 module Hearken
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/hearken/command/shuffle.rb

@@ -5,8 +5,8 @@ class Hearken::Command::Shuffle
   help 'shuffles the current queue'
   execute do |ignored=nil|
     ids = []
-    while id = @player.dequeue
-      ids << id
+    while track = @player.dequeue
+      ids << track.id
     end
     ids.sort_by { rand }.each {|id| @player.enqueue id }
   end

data/lib/hearken/console.rb

@@ -25,10 +25,10 @@ module Hearken
       at_exit { @player.stop }
       @prompt = "hearken > "
       with :status, "'"
-      with :show_properties, 'show'
       with :restart, 'next'
+      with :list, 'ls'
       with :enqueue, '+'
-      with_all *%w{reload search start stop scrobbling shuffle list setup_scrobbling recent flush }
+      with_all *%w{reload search start stop scrobbling shuffle setup_scrobbling recent flush}
     end
   end
 end

data/lib/hearken/library.rb

@@ -23,10 +23,6 @@ class Hearken::Library
     @tracks[id]
   end
 
-  def path row
-    row.path
-  end
-
   def with_track id
     yield @tracks[id]
   end
@@ -42,6 +38,10 @@ class Hearken::Library
         @tracks << track
         id += 1
       end
+      @tracks.sort! do |a, b|
+        tc = a.timestamp <=> b.timestamp
+        tc == 0 ? a.id <=> b.id : tc
+      end
     end if File.exist? index_path
   end
 end

data/lib/hearken/paths.rb

@@ -1,9 +1,10 @@
 require 'fileutils'
 
 module Hearken::Paths
-  attr_reader :preferences_path, :queue_path, :index_path
+  attr_reader :base_path, :preferences_path, :queue_path, :index_path
 
   def create_paths
+    @base_path = '.hearken'.from_home
     @preferences_path = '.hearken/config'.from_home
     @queue_path = '.hearken/queue'.from_home
     @index_path = '.hearken/music'.from_home
@@ -16,4 +17,8 @@ module Hearken::Paths
   def in_queue_dir
     Dir.chdir(queue_path) { yield }
   end
+
+  def in_base_dir
+    Dir.chdir(base_path) { yield }
+  end
 end

data/lib/hearken/player.rb

@@ -37,12 +37,16 @@ module Hearken
     end
 
     def current
-      (@pid and File.exist?('current_song')) ? YAML.load_file('current_song') : nil
+      in_base_dir do
+        (@pid and File.exist?('current_song')) ? YAML.load_file('current_song') : nil
+      end
     end
 
     def register track
       track.started = Time.now.to_i
-      File.open('current_song', 'w') {|f| f.print track.to_yaml }
+      in_base_dir do
+        File.open('current_song', 'w') {|f| f.print track.to_yaml }
+      end
     end
 
     def notify_started track
@@ -57,6 +61,10 @@ module Hearken
       @scrobbler.enabled = tf
     end
 
+    def random_track      
+      @library.row (rand * @library.count).to_i
+    end
+
     def start
       return if @pid
       @pid = fork do
@@ -65,26 +73,18 @@ module Hearken
           Process.kill 'TERM', player_pid if player_pid
           exit
         end
-        total_tracks = @library.count
         loop do
-          id = dequeue || (rand * total_tracks).to_i
-          row = @library.row id
-          unless row
-            puts "track with id #{id} did not exist"
+          track = dequeue || random_track
+          next unless track
+          unless File.exist? track.path
+            puts "skipping track as #{track.path} does not exist"
             next
           end
-          path = @library.path row
-          unless path and File.exist? path
-            puts "track with id #{id} did not refer to a file"
-            next
-          end
-          @library.with_track(id) do |track|
-            notify_started track
-            register track
-            player_pid = path.escape2("\`").to_player
-            Process.wait player_pid
-            notify_finished track
-          end
+          notify_started track
+          register track
+          player_pid = track.path.escape2("\`").to_player
+          Process.wait player_pid
+          notify_finished track
         end
       end
     end

data/lib/hearken/queue.rb

@@ -26,9 +26,8 @@ module Hearken::Queue
       file = Dir.glob('*.song').sort.first
       return nil unless file
       hash = YAML.load_file file
-      id = hash[:id] if hash
       FileUtils.rm file
-      id
+      hash
     end
   end
 end

data/spec/hearken/command/shuffle_spec.rb

@@ -13,9 +13,13 @@ describe Hearken::Command::Shuffle do
   end
 
   it 'should dequeue all tracks, shuffle then enqueue them' do
-    @player.should_receive(:dequeue).and_return(1)
-    @player.should_receive(:dequeue).and_return(2)
-    @player.should_receive(:dequeue).and_return(3)
+    track = stub 'track'
+    track.should_receive(:id).and_return 1
+    track.should_receive(:id).and_return 2
+    track.should_receive(:id).and_return 3
+    @player.should_receive(:dequeue).and_return track
+    @player.should_receive(:dequeue).and_return track
+    @player.should_receive(:dequeue).and_return track
     @player.should_receive(:dequeue).and_return nil
 
     @player.should_receive(:enqueue).with 3

metadata

@@ -2,7 +2,7 @@
 name: hearken
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Mark Ryall
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-06 00:00:00 +10:00
+date: 2011-08-07 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -138,7 +138,6 @@ files:
 - lib/hearken/command/scrobbling.rb
 - lib/hearken/command/search.rb
 - lib/hearken/command/setup_scrobbling.rb
-- lib/hearken/command/show_properties.rb
 - lib/hearken/command/shuffle.rb
 - lib/hearken/command/start.rb
 - lib/hearken/command/status.rb
@@ -198,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: hearken
-rubygems_version: 1.5.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: command line music player

data/lib/hearken/command/show_properties.rb

@@ -1,9 +0,0 @@
-require 'hearken/command'
-require 'pp'
-
-class Hearken::Command::ShowProperties
-  include Hearken::Command
-  usage '<id>'
-  help 'show the track details for a specified id'
-  execute {|id| @player.library.with_track(id.to_i(36)) {|track| pp track } }
-end