jimmy_jukebox 0.2.6

data/lib/jimmy_jukebox/version.rb

@@ -0,0 +1,3 @@
+module JimmyJukebox
+  VERSION = '0.2.6'
+end

data/lib/jimmy_jukebox.rb

@@ -0,0 +1,120 @@
+module JimmyJukebox
+
+  # make system call and get pid so you can terminate process
+  def system_yield_pid(*cmd)
+    # would like to use Process.respond_to?(:fork) but JRuby mistakenly returns true
+    begin
+      pid = fork do             # creates and runs block in subprocess (which will terminate with status 0), capture subprocess pid
+        exec(*cmd)              # replaces current process with system call
+        exit! 127               # exit process and return exit status 127; should never be reached
+      end
+    rescue NotImplementedError
+      require 'rubygems'
+      require 'spoon'
+      pid = Spoon.spawnp(*cmd)
+      #raise "*** fork() not supported ***" unless Process.respond_to?(:fork)
+    end
+    yield pid if block_given? # call block, passing in the subprocess pid
+    Process.waitpid(pid)      # Waits for a child process to exit, returns its process id, and sets $? to a Process::Status object
+    $?                        # return Process::Status object with instance methods .stopped?, .exited?, .exitstatus; see: http://www.ruby-doc.org/core/classes/Process/Status.html
+  end
+
+  class Jukebox
+
+    require 'jimmy_jukebox/user_config'
+
+    attr_reader :loop, :current_song_paused, :playing_pid
+
+    def initialize
+      @user_config = UserConfig.new
+    end
+
+    def play_loop
+      @loop = true
+      while @loop do
+        play
+      end
+    end
+
+    def play
+      begin
+        play_random_song(@user_config.songs)
+      rescue SystemExit, Interrupt => e
+        terminate_current_song
+        puts "\nMusic terminated by user"
+        exit
+      end
+    end
+
+    def quit
+      stop_looping
+      terminate_current_song
+    end
+
+    def skip_song
+      terminate_current_song
+    end
+
+    def pause_current_song
+      @current_song_paused = true
+      # jruby doesn't seem to handle system() correctly
+      # trying backticks
+      # system("kill -s STOP #{@playing_pid}") if @playing_pid
+      `kill -s STOP #{@playing_pid}` if @playing_pid
+    end
+
+    def unpause_current_song
+      @current_song_paused = false
+      # jruby doesn't seem to handle system() correctly
+      # trying backticks
+      #system("kill -s CONT #{@playing_pid}") if @playing_pid
+      `kill -s CONT #{@playing_pid}` if @playing_pid
+    end
+
+    private
+
+    def stop_looping
+      @loop = false
+    end
+
+    def play_random_song(songs)
+      terminate_current_song
+      raise "JimmyJukebox has no songs to play!" if songs.length == 0
+      music_file = songs[rand(songs.length)]
+      play_file(music_file)
+    end
+
+    def terminate_current_song
+      if @playing_pid
+        @current_song_paused = false
+        # killing processes seems problematic in JRuby
+        # I've tried several approaches, and nothing seems reliable
+        Process.kill("SIGKILL",@playing_pid)
+        #Process.kill("SIGTERM",@playing_pid)
+        #`kill #{@playing_pid}` if @playing_pid
+        @playing_pid = nil
+      end
+    end
+
+   def play_file(music_file)
+      # TODO: refactor the duplicate code below into a method
+      if music_file =~ /\.mp3$/i && @user_config.mp3_player
+        process_status = play_file_with(music_file, @user_config.mp3_player)
+      elsif music_file =~ /\.ogg$/i && @user_config.ogg_player
+        process_status = play_file_with(music_file, @user_config.ogg_player)
+      else
+        raise "Attempted to play a file format this program cannot play"
+      end
+      process_status.exitstatus.to_i == 0 ? (@playing_pid = nil) : (raise "Experienced a problem playing a song")
+    end
+
+    def play_file_with(music_file,player)
+      puts "Press Ctrl-C to stop the music and exit this program"
+      system_yield_pid(player, File.expand_path(music_file)) do |pid|
+        @playing_pid = pid 
+      end
+    end
+
+  end
+
+end

data/roadmap.txt

@@ -0,0 +1,20 @@
+TODO:
+  figure out why Macs running Ruby 1.8 won't skip song
+  add file downloading error handling
+  make playable on Windows
+  call strip on music directory names
+  chmod ug+rx downloaded music files?
+
+  Buddy Bolden
+  Bunk Johnson
+  Cab Calloway
+  Glenn Miller
+  Fats Waller
+  Ben Webster
+  Paul Whiteman
+    http://www.archive.org/search.php?query=paul%20whiteman%20AND%20mediatype%3Aaudio
+  Thelonious Monk
+  http://www.archive.org/details/1920s-redNicholsHisFivePennies-01-10
+  http://www.archive.org/details/1920sJazz-01-90
+  http://www.archive.org/details/LilArmstrong-01-10
+

data/spec/jimmy_jukebox_spec.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+require 'fakefs/safe'
+require 'jimmy_jukebox'
+include JimmyJukebox
+
+# Override exec() to prevent songs from actually playing
+# Instead, start a brief sleep process
+module Kernel
+  alias :real_exec :exec
+
+  def exec(*cmd)
+    real_exec("sleep 0.2")  
+  end
+end
+
+describe Jukebox do
+
+  before(:all) do
+    #ARGV.clear
+    ARGV.pop
+  end
+
+  context "with no command line parameter" do
+
+    it "can be instantiated" do
+      jj = Jukebox.new
+      jj.should_not be_nil
+      jj.quit
+    end
+
+    #it "raises exception when no songs available"
+    #  lambda do
+    #    jj = Jukebox.new
+    #  end.should raise_error
+    #end
+
+    it "generates a non-empty song list" do
+      jj = Jukebox.new
+      jj.instance_variable_get(:@user_config).songs.should_not be_nil
+      jj.instance_variable_get(:@user_config).songs.should_not be_empty
+      jj.instance_variable_get(:@user_config).songs.length.should be > 0
+    end
+
+    it "generates a non-empty song list with only mp3 & ogg files" do
+      jj = Jukebox.new
+      jj.instance_variable_get(:@user_config).songs.each do |song|
+        song.should match(/.*\.mp3|.*\.ogg/i)
+      end
+    end
+
+    it "can play" do
+      jj = Jukebox.new
+      thread = Thread.new do
+        jj.play
+      end
+      sleep 0.2
+      jj.instance_variable_get(:@playing_pid).should_not be_nil
+      jj.should_receive(:terminate_current_song)
+      jj.quit
+    end
+
+    it "can play_loop" do
+      jj = Jukebox.new
+      thread = Thread.new do
+        jj.play_loop
+      end
+      sleep 0.1
+      song1 = jj.playing_pid
+      song1.should_not be_nil
+      jj.loop.should be_true
+      sleep 0.2
+      song2 = jj.playing_pid
+      song2.should_not be_nil
+      song2.should_not == song1
+      jj.quit
+    end
+
+    it "can skip a song" do
+      jj = Jukebox.new
+      thread = Thread.new do
+        jj.play_loop
+      end
+      sleep 0.2
+      song_1 = jj.playing_pid
+      jj.skip_song
+      sleep 0.2
+      song_2 = jj.playing_pid
+      jj.skip_song
+      sleep 0.2
+      song_3 = jj.playing_pid
+      song_1.should_not == song_2 || song_2.should_not == song_3
+      jj.quit
+    end
+
+    it "can pause the current song" do
+      jj = Jukebox.new
+      thread = Thread.new do
+        jj.play
+      end
+      sleep 0.1
+      song_1 = jj.playing_pid
+      jj.pause_current_song
+      song_2 = jj.playing_pid
+      song_1.should == song_2
+      jj.current_song_paused.should be_true
+      jj.quit
+    end
+
+    it "can unpause a paused song" do
+      jj = Jukebox.new
+      thread = Thread.new do
+        jj.play
+      end
+      sleep 0.05
+      song_1 = jj.playing_pid
+      jj.current_song_paused.should be_false
+      jj.pause_current_song
+      song_2 = jj.playing_pid
+      jj.current_song_paused.should be_true
+      song_2.should == song_1
+      jj.unpause_current_song
+      jj.current_song_paused.should be_false
+      song_3 = jj.playing_pid
+      jj.current_song_paused.should be_false
+      jj.pause_current_song
+      song_4 = jj.playing_pid
+      jj.current_song_paused.should be_true
+      song_4.should == song_3
+      jj.unpause_current_song
+      jj.current_song_paused.should be_false
+      jj.quit
+    end
+  end
+
+  context "with valid music directory as command line parameter" do
+
+    before(:each) do
+      ARGV.delete_if { |val| true }
+      ARGV << File.expand_path("~/Music")
+    end
+
+    it "can skip a song" do
+      jj = Jukebox.new
+      thread = Thread.new do
+        jj.play_loop
+      end
+      sleep 0.2
+      song_1 = jj.playing_pid
+      jj.skip_song
+      sleep 0.2
+      song_2 = jj.playing_pid
+      jj.skip_song
+      sleep 0.2
+      song_3 = jj.playing_pid
+      song_1.should_not == song_2 || song_2.should_not == song_3
+      jj.quit
+    end
+
+  end
+
+end

data/spec/song_loader_spec.rb

@@ -0,0 +1,190 @@
+require 'spec_helper'
+require 'rubygems'
+require 'rspec/mocks'
+require 'fakeweb' # apparently must be required before fakefs
+FakeWeb.allow_net_connect = false
+require 'fakefs/safe'
+require 'jimmy_jukebox/song_loader'
+
+describe JimmyJukebox::SongLoader do
+
+  #before(:all) do
+    # If using fakefs without safe, make sure we're using FakeFS gem,
+    # not the real file system!
+    # File.directory?("/home").should be_false
+  #end
+
+  before(:all) do
+    #ARGV.delete_if { |val| true }
+    #ARGV.clear
+    ARGV.pop
+  end
+
+  before(:each) do
+    @sl = JimmyJukebox::SongLoader
+  end
+
+  describe "#create_save_dir" do
+
+    it "should create a directory" do
+      FakeFS do
+        topdir = File.join("/home","user_name4","Music")
+        subdir = File.join(topdir, "rock", "Beatles")
+        File.directory?(subdir).should be_false
+        @sl.create_save_dir(subdir)
+        File.directory?(subdir).should be_true
+      end
+    end
+
+  end
+
+  describe "#version_of_song_in_any_dir?" do
+
+    it "should return true if song in top of directory tree" do
+      FakeFS do
+        topdir = "/home/user_name1/Music"
+        songname = "Paperback_Writer.mp3"
+        File.directory?(topdir).should be_false
+        FileUtils.mkdir_p(topdir)
+        File.directory?(topdir).should be_true
+        Dir.chdir(topdir)
+        File.exists?(songname).should be_false
+        FileUtils.touch(songname)
+        File.exists?(songname).should be_true
+        @sl.version_of_song_in_any_dir?(songname,topdir).should be_true
+      end
+    end
+
+    it "should return true if song in subdirectory" do
+      FakeFS do
+        topdir = "/home/user_name2/Music"
+        subdir = File.join(topdir, "rock", "Beatles")
+        songname = "Paperback_Writer.mp3"
+        File.directory?(subdir).should be_false
+        FileUtils.mkdir_p(subdir)
+        FileUtils.touch(File.join(subdir, songname))
+        File.exists?(File.join(subdir, songname)).should be_true
+        @sl.version_of_song_in_any_dir?(songname,subdir).should be_true
+      end
+    end
+
+    it "should return false if song not in directory tree" do
+      FakeFS do
+        topdir = "/home/user_name3/Music"
+        subdir = File.join(topdir, "rock", "Beatles")
+        songname = "Paperback_Writer.mp3"
+        FileUtils.mkdir_p(subdir)
+        File.exists?(File.join(subdir, songname)).should be_false
+        @sl.version_of_song_in_any_dir?(songname,subdir).should be_false
+      end
+    end
+
+  end
+
+  describe "test defaults" do
+
+    it "should have a user_config" do
+      @sl.instance_variable_get(:@user_config).should_not be_nil
+    end
+
+    it "should have a user_config with a non-nil default_music_dir" do
+      @sl.instance_variable_get(:@user_config).default_music_dir.should == File.expand_path("~/Music")
+    end
+
+    it "should have a SUPPORTED_MUSIC_TYPES of '/\.mp3$|\.ogg$/i'" do
+      @sl::SUPPORTED_MUSIC_TYPES.should == /\.mp3$|\.ogg$/i
+    end
+
+  end
+
+  describe "#original_dixieland_jazz_band without dirname" do
+  
+    context "no songs in directory" do
+
+      before(:each) do
+        @dirname = File.expand_path(@sl.instance_variable_get(:@user_config).default_music_dir + '/JAZZ/Original_Dixieland_Jazz_Band')
+        @sl.stub!(:version_of_song_in_any_dir?).and_return(false)
+      end
+
+      it "should try to download many songs" do
+        @sl.should_receive(:open).at_least(25).times
+        @sl.send(:original_dixieland_jazz_band)
+      end
+
+    end
+
+  end
+
+  describe "#charlie_christian without dirname" do
+   
+    context "no songs yet downloaded" do
+
+      it "should try to download many songs" do
+        dirname = File.expand_path(@sl.instance_variable_get(:@user_config).default_music_dir + '/JAZZ/Charlie_Christian')
+        @sl.stub!(:version_of_song_in_any_dir?).and_return(false)
+        @sl.should_receive(:open).exactly(8).times
+        @sl.charlie_christian
+        File.exists?(dirname).should be_true
+      end
+
+    end
+
+    context "all songs already downloaded" do
+
+      it "should not download any songs" do
+        dirname = File.expand_path(@sl.instance_variable_get(:@user_config).default_music_dir + '/JAZZ/Charlie_Christian')
+        @sl.stub!(:version_of_song_in_any_dir?).and_return(true)
+        @sl.should_not_receive(:open)
+        @sl.charlie_christian
+      end
+
+    end
+
+  end
+
+  describe "#lionel_hampton without dirname" do
+    
+    it "should try to download many songs" do
+      dirname = File.expand_path(@sl.instance_variable_get(:@user_config).default_music_dir + '/JAZZ/Lionel_Hampton')
+      @sl.stub!(:version_of_song_in_any_dir?).and_return(false)
+      @sl.should_receive(:open).at_least(50).times
+      @sl.lionel_hampton
+      File.exists?(dirname).should be_true
+    end
+
+  end
+
+  describe "#dizzy_gillespie with dirname" do
+
+    it "should try to download three songs" do
+      dirname = File.expand_path(@sl.instance_variable_get(:@user_config).default_music_dir + '/JAZZ/Dizzy_Gillespie')
+      @sl.stub!(:version_of_song_in_any_dir?).and_return(false)
+      @sl.should_receive(:open).exactly(3).times
+      @sl.dizzy_gillespie(dirname)
+    end
+
+    it "should successfully download three songs" do
+      pending("use FakeWeb")
+      FakeWeb.register_uri(:any, "http://www.archive.org/download/DizzyGillespie-GroovinHigh/02.GroovinHigh.mp3", :response => "/home/james/Music/JAZZ/Dizzy_Gillespie/Groovin' High 1945.mp3")
+      FakeWeb.register_uri(:any, "http://www.archive.org/download/DizzyGillespie-Manteca/01Manteca.ogg", :response => "/home/james/Music/JAZZ/Dizzy_Gillespie/01Manteca.ogg")
+      FakeWeb.register_uri(:any, "http://www.archive.org/download/DizzyGillespieLouisArmstrong-UmbrellaMan/DizzyGillespieLouisArmstrong-UmbrellaMan.mp3", :response => "/home/james/Music/JAZZ/Dizzy_Gillespie/DizzyGillespieLouisArmstrong-UmbrellaMan.mp3")
+      dirname = File.expand_path("/home/user_name6/non-existent-dir")
+      File.exists?(dirname).should be_false
+      @sl.dizzy_gillespie(dirname)
+      #File.exists?(dirname + "/02.GroovinHigh.mp3").should be_true
+      #File.exists?(dirname + "/01Manteca.ogg").should be_true
+      #File.exists?(dirname + "/DizzyGillespieLouisArmstrong-UmbrellaMan.mp3").should be_true
+      FakeWeb.clean_registry
+    end
+
+  end
+
+  describe "call to non-existent method" do
+
+    it "should raise NoMethodError" do
+      lambda { @sl.non_existent_method }.should raise_error(NoMethodError)
+    end
+
+  end
+
+end