songbirdsh 0.0.4 → 0.0.5

data/HISTORY.rdoc

@@ -1,3 +1,18 @@
+= 0.0.5
+
+Bug fixes, code cleanup and some colour
+
+* Sorted out crash when listing queue while not playing
+* Added help to all commands
+* Added rainbow and added colour to the track display
+* Changed shuffle behaviour - it now just shuffles current queue
+* Added flush command
+* Switched to using bundler to manage gem
+
+= 0.0.4
+
+Some minor bug fixes
+
 = 0.0.3
 
 Introduced testing, lastfm support and a few other useful commands

data/Rakefile

@@ -1,10 +1,6 @@
-begin
-  require 'gemesis/rake'
-rescue Exception
-  puts "gemesis related tasks will only be available if you 'gem install gemesis'"
-end
+require 'bundler/gem_tasks'
 
 desc 'execute specifications'
 task :test do
-  sh 'rspec spec'
+  sh 'bundle exec rspec spec'
 end

data/lib/songbirdsh/cli.rb

@@ -28,7 +28,7 @@ module Songbirdsh
       with :show_properties, 'show'
       with :restart, 'next'
       with :enqueue, '+'
-      with_all *%w{reload search start stop scrobbling shuffle list setup_scrobbling}
+      with_all *%w{reload search start stop scrobbling shuffle list setup_scrobbling recent flush}
     end
   end
 end

data/lib/songbirdsh/command.rb

@@ -1,5 +1,11 @@
 module Songbirdsh
-  class Command
+  module Command
+    attr_reader :usage, :help
+
+    def self.included cls
+      cls.extend ClassMethods
+    end
+
     def self.load name, *args
       require "songbirdsh/command/#{name}"
       classname = name.to_s.split('_').map{|s|s.capitalize}.join
@@ -8,6 +14,22 @@ module Songbirdsh
 
     def initialize player
       @player = player
+      @usage = ''
+      @help = ''
+    end
+
+    module ClassMethods
+      def usage usage
+        define_method(:usage) { usage }
+      end
+
+      def help help
+        define_method(:help) { help }
+      end
+
+      def execute &block
+        define_method :execute, block
+      end
     end
   end
 end

data/lib/songbirdsh/command/enqueue.rb

@@ -1,16 +1,13 @@
 require 'yaml'
+require 'songbirdsh/range_expander'
 require 'songbirdsh/command'
 
-class Songbirdsh::Command::Enqueue < Songbirdsh::Command
-  def execute text
-    text.split(/[^0-9a-z]/).select {|s| s and !s.empty?}.each {|id| @player.enqueue id.to_i(36) }
+class Songbirdsh::Command::Enqueue
+  include Songbirdsh::Command
+  usage '*<id>'
+  help 'enqueues the list of songs with the specified ids'
+  execute do |text|
+    @expander ||= Songbirdsh::RangeExpander.new
+    @expander.expand(text).each {|id| @player.enqueue id }
   end
-
-  def usage
-    '*<id>'
-  end
-
-  def help
-    'enqueues the list of songs with the specified ids'
-  end
-end
+end

data/lib/songbirdsh/command/flush.rb

@@ -0,0 +1,7 @@
+require 'songbirdsh/command'
+
+class Songbirdsh::Command::Flush
+  include Songbirdsh::Command
+  help 'flushes the current queue'
+  execute {|ignored| loop { break unless @player.dequeue } }
+end

data/lib/songbirdsh/command/list.rb

@@ -1,24 +1,24 @@
 require 'songbirdsh/command'
 
-class Songbirdsh::Command::List < Songbirdsh::Command
-  def execute text
+class Songbirdsh::Command::List
+  include Songbirdsh::Command
+  help 'lists the contents of the track queue (and approximate times for when each track will be played)'
+  execute do |text|
     @terms = text.split(/\W/)
     current = @player.current
-    next_start_time = Time.at current.started
-    show next_start_time, current
-    next_start_time += current.duration
+    if current
+      next_start_time = Time.at current.started
+      show next_start_time, current
+    end
+    next_start_time += current.duration if next_start_time
     @player.each do |track|
       show next_start_time, track
-      next_start_time += track.duration
+      next_start_time += track.duration if next_start_time
     end
   end
 
   def show time, track
     return unless @terms.empty? or @terms.all? {|term| track.search_string.include? term }
-    puts "#{time}\n\t#{track}"
-  end
-
-  def help
-    'lists the contents of the track queue (and approximate times for when each track will be played)'
+    puts time ? "#{time.to_s.foreground(:blue)}\n\t#{track}" : track
   end
 end

data/lib/songbirdsh/command/recent.rb

@@ -0,0 +1,31 @@
+require 'songbirdsh/command'
+
+class Songbirdsh::Command::Recent
+  include Songbirdsh::Command
+  usage '<count>'
+  help 'lists the specified number of recently added albums'
+  execute do |text|
+    @player.library.reload unless @player.library.tracks
+    maximum, current_album, tracks, total_count = text.to_i, nil, [], 0
+    @player.library.tracks.reverse.each do |track|
+      unless current_album
+        current_album = track.album
+        tracks = [track]
+        next
+      end
+      if current_album==track.album
+        tracks << track
+      else
+        puts "#{current_album} - #{extract_artist tracks} - #{tracks.size} tracks (#{tracks.last.search_id}-#{tracks.first.search_id})"
+        current_album = track.album
+        tracks = [track]
+        total_count += 1
+      end
+      break if total_count >= maximum
+    end
+  end
+private
+  def extract_artist tracks
+    tracks.map{|t| t.artist}.uniq.size == 1 ? tracks.first.artist : 'various artists'
+  end
+end

data/lib/songbirdsh/command/reload.rb

@@ -1,15 +1,7 @@
 require 'songbirdsh/command'
 
-class Songbirdsh::Command::Reload < Songbirdsh::Command
-  def execute ignored=nil
-    @player.library.reload
-  end
-
-  def usage
-    ''
-  end
-
-  def help
-    'reloads the contents of the music library for fast searching'
-  end
+class Songbirdsh::Command::Reload
+  include Songbirdsh::Command
+  help 'reloads the contents of the music library for fast searching'
+  execute {|ignored| @player.library.reload }
 end

data/lib/songbirdsh/command/restart.rb

@@ -1,7 +1,7 @@
 require 'songbirdsh/command'
 
-class Songbirdsh::Command::Restart < Songbirdsh::Command
-  def execute ignored=nil
-    @player.restart
-  end
+class Songbirdsh::Command::Restart
+  include Songbirdsh::Command
+  help 'stops and restarts the player (which will kill the current track)'
+  execute {|ignored| @player.restart }
 end

data/lib/songbirdsh/command/scrobbling.rb

@@ -1,19 +1,14 @@
 require 'songbirdsh/command'
 
-class Songbirdsh::Command::Scrobbling < Songbirdsh::Command
-  def execute text
+class Songbirdsh::Command::Scrobbling
+  include Songbirdsh::Command
+  usage '<on|off>'
+  help 'turns interaction with lastfm on or off'
+  execute do |text|
     scrobbling = (text == 'on')
     return if @player.scrobbling == scrobbling
     puts scrobbling ? 'Turning scrobbling on' : 'Turning scrobbling off'
     @player.scrobbling = scrobbling
     @player.restart
   end
-
-  def usage
-    '<on|off>'
-  end
-
-  def help
-    'turns interaction with lastfm on or off'
-  end
 end

data/lib/songbirdsh/command/search.rb

@@ -1,7 +1,13 @@
 require 'songbirdsh/command'
 
-class Songbirdsh::Command::Search < Songbirdsh::Command
-  def execute text
+class Songbirdsh::Command::Search
+  include Songbirdsh::Command
+  usage '*<word>'
+  help <<EOF
+searches for tracks containing the specified words (in artist, title or album)
+ids are placed on the clipboard for convenient use with +
+EOF
+  execute do |text|
     terms = text.split(/\W/)
     matches = []
     @player.library.reload unless @player.library.tracks

data/lib/songbirdsh/command/setup_scrobbling.rb

@@ -1,11 +1,7 @@
 require 'songbirdsh/command'
 
-class Songbirdsh::Command::SetupScrobbling < Songbirdsh::Command
-  def execute text
-    @player.scrobbler.setup
-  end
-
-  def help
-    'runs through the steps required to get lastfm scrobbling working'
-  end
+class Songbirdsh::Command::SetupScrobbling
+  include Songbirdsh::Command
+  help 'runs through the steps required to get lastfm scrobbling working'
+  execute {|ignored| @player.scrobbler.setup }
 end

data/lib/songbirdsh/command/show_properties.rb

@@ -1,8 +1,9 @@
 require 'songbirdsh/command'
 require 'pp'
 
-class Songbirdsh::Command::ShowProperties < Songbirdsh::Command
-  def execute id
-    @player.library.with_track(id.to_i(36)) {|track| pp track }
-  end
+class Songbirdsh::Command::ShowProperties
+  include Songbirdsh::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

data/lib/songbirdsh/command/shuffle.rb

@@ -1,15 +1,13 @@
 require 'songbirdsh/command'
 
-class Songbirdsh::Command::Shuffle < Songbirdsh::Command
-  def execute text
-    if @player.matches
-      @player.matches.sort_by { rand }.join(' ').to_clipboard
-    else
-      puts 'nothing to shuffle - please search for some tracks'
+class Songbirdsh::Command::Shuffle
+  include Songbirdsh::Command
+  help 'shuffles the current queue'
+  execute do |ignored=nil|
+    ids = []
+    while id = @player.dequeue
+      ids << id
     end
-  end
-
-  def help
-    'shuffles the results from the last search and places them on the clipboard'
+    ids.sort_by { rand }.each {|id| @player.enqueue id }
   end
 end

data/lib/songbirdsh/command/start.rb

@@ -1,7 +1,7 @@
 require 'songbirdsh/command'
 
-class Songbirdsh::Command::Start < Songbirdsh::Command
-  def execute ignored=nil
-    @player.start
-  end
+class Songbirdsh::Command::Start
+  include Songbirdsh::Command
+  help 'starts the player'
+  execute {|ignored| @player.start }
 end

data/lib/songbirdsh/command/status.rb

@@ -1,12 +1,8 @@
 require 'yaml'
 require 'songbirdsh/command'
 
-class Songbirdsh::Command::Status < Songbirdsh::Command
-  def execute text
-    puts @player.status
-  end
-
-  def help
-    'shows the current playing status'
-  end
+class Songbirdsh::Command::Status
+  include Songbirdsh::Command
+  help 'shows the current player status'
+  execute {|ignored| puts @player.status }
 end

data/lib/songbirdsh/command/stop.rb

@@ -1,7 +1,7 @@
 require 'songbirdsh/command'
 
-class Songbirdsh::Command::Stop < Songbirdsh::Command
-  def execute ignored=nil
-    @player.stop
-  end
+class Songbirdsh::Command::Stop
+  include Songbirdsh::Command
+  help 'stops the player'
+  execute {|ignored| @player.stop }
 end

data/lib/songbirdsh/player.rb

@@ -1,12 +1,11 @@
-require 'songbirdsh/queue'
-require 'songbirdsh/library'
-
 require 'cgi'
 require 'yaml'
 require 'fileutils'
 require 'splat'
 
+require 'songbirdsh/queue'
 require 'songbirdsh/scrobbler'
+require 'songbirdsh/library'
 
 module Songbirdsh
   class Player
@@ -20,19 +19,23 @@ module Songbirdsh
       @library = Library.new preferences
     end
 
+    def c text,colour
+      text.to_s.foreground colour
+    end
+
     def status
       if @pid
         track = self.current
-        puts "Since #{Time.at(track.started)}\n\t#{track}"
+        puts "Since #{c Time.at(track.started), :cyan}\n\t#{track}"
         played = Time.now.to_i-track.started
-        puts "#{played} seconds (#{track.duration-played} remaining)"
+        puts "#{c played, :yellow} seconds (#{c track.duration-played, :yellow} remaining)"
       else
-        puts 'not playing'
+        puts 'not playing'.foreground(:yellow)
       end
     end
 
-    def current 
-      YAML.load(File.read('current_song'))
+    def current
+      (@pid and File.exist?('current_song')) ? YAML.load_file('current_song') : nil
     end
 
     def register track

data/lib/songbirdsh/range_expander.rb

@@ -0,0 +1,30 @@
+module Songbirdsh
+  class RangeExpander
+    def expand text
+      text.split(/[^0-9a-z-]/).inject([]) {|acc, term| acc + expand_term(term) }
+    end
+
+    def expand_to_ids text
+      expand(text).map {|number| from_number number }
+    end
+  private
+    def expand_term term
+      words = term.split '-'
+      words.empty? ? [] : range(words.first, words.last)
+    end
+
+    def range from, to
+      f, t = to_number(from), to_number(to)
+      t = to_number(from.slice(0...from.size-to.size)+to) if t < f
+      (f..t).to_a
+    end
+
+    def from_number term
+      term.to_s 36
+    end
+
+    def to_number term
+      term.to_i 36
+    end
+  end
+end

data/lib/songbirdsh/track.rb

@@ -1,3 +1,5 @@
+require 'rainbow'
+
 module Songbirdsh
   class Track
     attr_accessor *%w{id track album artist duration genre number year disc disc_total track_total label started}
@@ -23,7 +25,11 @@ module Songbirdsh
     end
 
     def to_s
-      "#{self.search_id}: #{self.artist} - #{self.album} - #{self.number} #{self.track} (#{self.duration})"
+      "#{my(:search_id,:white)}: #{my(:artist, :yellow)} - #{my(:album,:cyan)} - #{my(:number,:magenta)} #{my(:track,:green)} (#{my(:duration,:white)})"
+    end
+
+    def my field, colour
+      self.send(field).to_s.foreground(colour)
     end
   end
 end

data/spec/songbirdsh/command/enqueue_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__)+'/../../spec_helper'
+require_relative '../../spec_helper'
 require 'songbirdsh/command/enqueue'
 
 describe Songbirdsh::Command::Enqueue do
@@ -12,15 +12,13 @@ describe Songbirdsh::Command::Enqueue do
     @command = Songbirdsh::Command::Enqueue.new @player
   end
 
-  it 'should enqueue a single track' do
-    @player.should_receive(:enqueue).with(1371)
-    @command.execute '123'
-  end
+  it 'should enqueue whatever is returned from the expander' do
+    expander = stub('expander')
+    Songbirdsh::RangeExpander.should_receive(:new).and_return(expander)
+    expander.should_receive(:expand).with('some text').and_return([1,2,3])
+
+    [1,2,3].each {|id| @player.should_receive(:enqueue).with id}
 
-  it 'should enqueue multiple tracks separated by any non digit' do
-    %w{1371 5370 9369}.each do |id|
-      @player.should_receive(:enqueue).with(id.to_i)
-    end
-    @command.execute "123 \t 456  , 789 "
+    @command.execute "some text"
   end
 end

data/spec/songbirdsh/command/list_spec.rb

@@ -0,0 +1,27 @@
+require_relative '../../spec_helper'
+require 'songbirdsh/command/list'
+
+describe Songbirdsh::Command::List do
+  extend ShellShock::CommandSpec
+
+  with_help 'lists the contents of the track queue (and approximate times for when each track will be played)'
+
+  before do
+    @player = stub('player')
+    @command = Songbirdsh::Command::List.new @player
+  end
+
+  it 'should display nothing when there is no current track and nothing enqueued' do
+    @player.stub!(:current).and_return nil
+    @player.stub! :each
+    @command.execute ''
+  end
+
+  it 'should display queue contents with no times when there is no current track' do
+    track = stub 'track'
+    @player.stub!(:current).and_return nil
+    @player.stub!(:each).and_yield track
+    @command.should_receive(:puts).with track
+    @command.execute ''
+  end
+end

data/spec/songbirdsh/command/reload_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__)+'/../../spec_helper'
+require_relative '../../spec_helper'
 require 'songbirdsh/command/reload'
 
 describe Songbirdsh::Command::Reload do

data/spec/songbirdsh/command/shuffle_spec.rb

@@ -0,0 +1,27 @@
+require_relative '../../spec_helper'
+require 'songbirdsh/command/shuffle'
+
+describe Songbirdsh::Command::Shuffle do
+  extend ShellShock::CommandSpec
+
+  with_usage ''
+  with_help 'shuffles the current queue'
+
+  before do
+    @player = stub 'player'
+    @command = Songbirdsh::Command::Shuffle.new @player
+  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)
+    @player.should_receive(:dequeue).and_return nil
+
+    @player.should_receive(:enqueue).with 3
+    @player.should_receive(:enqueue).with 2
+    @player.should_receive(:enqueue).with 1
+
+    @command.execute
+  end
+end

data/spec/songbirdsh/player_spec.rb

@@ -0,0 +1,36 @@
+require_relative '../spec_helper'
+require 'songbirdsh/player'
+
+describe Songbirdsh::Player do
+  let(:preferences) { {} }
+  let(:player) { Songbirdsh::Player.new preferences }
+
+  before do
+    scrobbler = mock 'scrobbler'
+    library = mock 'library'
+    Songbirdsh::Scrobbler.stub!(:new).and_return scrobbler
+    Songbirdsh::Library.stub!(:new).and_return library
+  end
+
+  describe '#current' do
+    it 'should return current_track when player has pid and file is present' do
+      player.instance_eval { @pid = 1 }
+      hash = stub 'hash'
+      File.stub!(:exist?).with('current_song').and_return true
+      YAML.stub!(:load_file).with('current_song').and_return hash
+      player.current.should == hash
+    end
+
+    it 'should return nil when player has no pid and file is present' do
+      player.instance_eval { @pid = nil }
+      File.stub!(:exist?).with('current_song').and_return true
+      player.current.should == nil
+    end
+
+    it 'should return nil when has pid and file is not present' do
+      player.instance_eval { @pid = 1 }
+      File.stub!(:exist?).with('current_song').and_return false
+      player.current.should == nil
+    end
+  end
+end

data/spec/songbirdsh/range_expander_spec.rb

@@ -0,0 +1,28 @@
+require_relative '../spec_helper'
+require 'songbirdsh/range_expander'
+
+describe Songbirdsh::RangeExpander do
+  before do
+    @expander = Songbirdsh::RangeExpander.new
+  end
+
+  it 'should expand single values' do
+    @expander.expand('123').should == [1371]
+  end
+
+  it 'should expand multiple values separated by any non digit' do
+    @expander.expand("123 \t 456  , 789 ").should == [1371, 5370, 9369]
+  end
+
+  it 'should expand a fully specified range' do
+    @expander.expand(" 456-45i ").should == (5370..5382).to_a
+  end
+
+  it 'should expand an abbreviated range' do
+    @expander.expand(" 456-i ").should == (5370..5382).to_a
+  end
+
+  it 'should expand ids for a range' do
+    @expander.expand_to_ids(" s-z ").should == %w{s t u v w x y z}
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
-$: << File.dirname(__FILE__)+'/../lib'
+$: << File.expand_path('../../lib', __FILE__)
 
+require 'bundler/setup'
+require 'rspec'
 require 'shell_shock/command_spec'

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: songbirdsh
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
+  prerelease: 
+  version: 0.0.5
 platform: ruby
 authors: 
 - Mark Ryall
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-20 00:00:00 +10:00
+date: 2011-06-19 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,8 +21,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -38,8 +32,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -51,49 +43,40 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 3
         version: "3"
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: splat
+  name: sqlite3
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 1
-        version: "0.1"
+        version: "1"
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: sqlite3
+  name: simple_scrobbler
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        version: "1"
+        version: "0"
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: simple_scrobbler
+  name: rainbow
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+        version: "1"
   type: :runtime
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
@@ -104,9 +87,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 8
         version: "0.8"
   type: :development
   version_requirements: *id007
@@ -118,8 +98,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
         version: "2"
   type: :development
   version_requirements: *id008
@@ -136,7 +114,9 @@ extra_rdoc_files: []
 files: 
 - lib/songbirdsh/cli.rb
 - lib/songbirdsh/command/enqueue.rb
+- lib/songbirdsh/command/flush.rb
 - lib/songbirdsh/command/list.rb
+- lib/songbirdsh/command/recent.rb
 - lib/songbirdsh/command/reload.rb
 - lib/songbirdsh/command/restart.rb
 - lib/songbirdsh/command/scrobbling.rb
@@ -153,11 +133,16 @@ files:
 - lib/songbirdsh/player.rb
 - lib/songbirdsh/preferences.rb
 - lib/songbirdsh/queue.rb
+- lib/songbirdsh/range_expander.rb
 - lib/songbirdsh/scrobbler.rb
 - lib/songbirdsh/track.rb
 - lib/songbirdsh.rb
 - spec/songbirdsh/command/enqueue_spec.rb
+- spec/songbirdsh/command/list_spec.rb
 - spec/songbirdsh/command/reload_spec.rb
+- spec/songbirdsh/command/shuffle_spec.rb
+- spec/songbirdsh/player_spec.rb
+- spec/songbirdsh/range_expander_spec.rb
 - spec/spec_helper.rb
 - bin/songbirdsh
 - README.rdoc
@@ -179,21 +164,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: command line jukebox music player