rubytrackselector 0.0.2

data/COPYING

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README

@@ -0,0 +1,54 @@
+Tired of hearing always the same background music in your game?
+Too lazy to fire up your media player?
+
+Ruby Track Selector to the rescue!
+ => gem install rubytrackselector
+
+_______________________________________________________________________________
+
+Ruby Track Selector organizes your game music into tags (for example "menu" or
+"loading") and generates a list of all music files for a given tag in
+"~/.rubytracks" and one or more application specific directories. The
+application specific directories can be disabled and re-enabled at will.
+
+_______________________________________________________________________________
+
+Example:
+
+    require "rubytrackselector"
+    
+    rts = RTS::Rts.new
+    rts.tag = RTS::MENU
+    
+    rts.files.sample   # => ~/.rubytracks/menu/ultra_awesome_menu_song.ogg
+    rts.files.sample   # => ~/.rubytracks/menu/awesome_menu_song.ogg
+
+With application specific directories:
+
+    require "rubytrackselector"
+    
+    rts = RTS::Rts.new
+    rts.tag = RTS::MENU
+    rts.local << File.join(File.dirname(__FILE__), "music")
+    rts.enable_local = true
+    
+    rts.files.sample  # => ~/.rubytracks/menu/awesome_menu_song.ogg
+    rts.files.sample  # => /game/path/music/menu/other_menu_song.ogg
+
+Rubygame integration:
+
+    require "rubytrackselector"
+    require "rubygame"
+    
+    rts = RTS::Rts.new
+    rts.tag = RTS::MENU
+    
+    rts.play(:repeats => -1)
+
+_______________________________________________________________________________
+
+Ruby Track Selector is licensed under the GNU Lesser General Public License.
+See COPYING for details.
+
+_______________________________________________________________________________
+                                                   (c) 2010 by Raphael Robatsch

data/Rakefile

@@ -0,0 +1,38 @@
+require "rake/testtask"
+require "rake/rdoctask"
+require "rake/gempackagetask"
+require "lib/rubytrackselector.rb"
+
+spec = Gem::Specification.new do |s|
+	s.name = "rubytrackselector"
+	s.summary = "A music selection library for Rubygame."
+	s.version = RTS::VERSION.join(".")
+	
+	s.required_ruby_version = ">= 1.8"
+	s.add_dependency("rubygame", "~> 2.6")
+	
+	s.author = "Raphael Robatsch"
+	s.email = "mf.m-f@rleahpar".reverse
+	s.has_rdoc = true
+	s.homepage = "http://raphaelr.github.com/rubytrackselector"
+	
+	s.files  = Dir["lib/**/*"] + Dir["test/**/*"] + Dir["doc/**/*"]
+	s.files += Dir["samples/*"] + Dir["*"]
+	s.extra_rdoc_files = Dir["doc/*.rdoc"]
+	s.test_files = Dir["test/test_*.rb"]
+end
+
+Rake::TestTask.new do |t|
+	t.libs << "test"
+	t.pattern = "test/test_*.rb"
+end
+
+Rake::RDocTask.new do |t|
+	t.main = "doc/index.rdoc"
+	t.title = "Ruby Track Selector #{RTS::VERSION.join(".")}"
+	t.rdoc_files = Dir["doc/*.rdoc"] + Dir["lib/**/*"]
+end
+
+Rake::GemPackageTask.new(spec) do |t|
+	t.need_tar_gz
+end

data/doc/index.rdoc

@@ -0,0 +1,52 @@
+For a complete example, see the RTS module documentation.
+
+== User Music Directory Structure
+
+    ~ (home)
+    |
+    +- .rubytracks (created automatically)
+    |  |
+    |  +- tag1 (created automatically if needed)
+    |  +- tag2 (created automatically if needed)
+    |  |
+    |  +- noname_tag_independent_music.ogg
+    |  +- noname_tag_independent_music2.ogg
+	
+
+The standard tag names are:
+
+    - menu
+    - calm_menu
+    - loading
+    - calm_loading
+    - action_scene
+    - puzzle_scene
+    - world_scene
+	
+== Local Music Directory
+
+Each application may define it's own music directory, which has the same
+structure as the user's music directory.
+
+    @rts = RTS::Rts.new
+    @rts.local << "data/music"
+    @rts.enable_local = true
+
+== Setting the tag
+
+    @rts.tag = RTS::MENU
+
+== Selecting a random file
+
+    @rts.files.sample
+
+== Playing a random file
+
+    @rts.play
+	# Any options passed to RTS::Rts#play get redirected to Rubygame::Music#play.
+
+== Noname-Tag
+
+If you don't set a tag, or set the tag to RTS::NONAME, User Track Player will
+select the files outside a tag (directly in ~/.usertrackplayer). You shouldn't
+do that.

data/lib/rubytrackselector.rb

@@ -0,0 +1,29 @@
+#--
+# Ruby Track Selector - A music selecting library for Rubygame.
+# Copyright (C) 2010  Raphael Robatsch.
+# 
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3 of the License, or (at your option) any later version.
+# 
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#++
+
+module RTS
+	# Ruby Track Selector Version.
+	# 
+	# <tt>[major, minor, revision]</tt>
+	VERSION = [0, 0, 2]
+end
+
+lib = File.join(File.expand_path(File.dirname(__FILE__)), "rubytrackselector")
+require File.join(lib, "home")
+require File.join(lib, "utp")

data/lib/rubytrackselector/home.rb

@@ -0,0 +1,37 @@
+#--
+# Ruby Track Selector - A music selecting library for Rubygame.
+# Copyright (C) 2010  Raphael Robatsch.
+# 
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3 of the License, or (at your option) any later version.
+# 
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#++
+
+module RTS
+	RTS_DIR = ".rubytracks" # :nodoc:
+	
+	# Returns the user's home directory.
+	def self.home
+		return File.expand_path("~")
+	end
+	
+	# Returns the path to the user's custom music directory.
+	# 
+	# +create+::  If this parameter is true, the directory will be created if
+	#             it doesn't exists.
+	def self.user_music(create = true)
+		dn = File.join(home, RTS_DIR)
+		Dir.mkdir(dn) if create && !Dir.exists?(dn)
+		return dn
+	end
+end

data/lib/rubytrackselector/utp.rb

@@ -0,0 +1,90 @@
+#--
+# Ruby Track Selector - A music selecting library for Rubygame.
+# Copyright (C) 2010  Raphael Robatsch.
+# 
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3 of the License, or (at your option) any later version.
+# 
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#++
+
+# == Usage Example
+# 
+#     # Initialize
+#     @rts = RTS::Rts.new
+#     @rts.local << "data/music" # Add application specific music directory.    (optional)
+#     @rts.enable_local = true   # Enable application specific music directory.
+#     
+#     # And play
+#     @rts.tag = RTS::MENU       # See below for a full list of tags.
+#                                # You can set it to any string you like.
+#     @rts.play(:repeats => -1)  # Select a random music and play it.
+#                                # Returns the selected Rubygame::Music.
+#  
+#      
+#     # Or manually:
+#     music = Rubygame::Music.load(@rts.files.sample)
+#     music.play(:repeats => -1)
+# 
+
+
+module RTS
+	# Tag for menu tracks.
+	MENU = "menu"
+	# Tag for calm menu tracks.
+	CALM_MENU = "calm_menu"
+	# Tag for loading tracks.
+	LOADING = "loading"
+	# Tag for calm loading tracks.
+	CALM_LOADING = "calm_loading"
+	# Tag for action tracks.
+	ACTION_SCENE = "action_scene"
+	# Tag for puzzle tracks.
+	PUZZLE_SCENE = "puzzle_scene"
+	# Tag for world map tracks.
+	WORLD_SCENE = "world_scene"
+	NONAME = nil # :nodoc:
+	
+	# Main RTS Class.
+	class Rts < Struct.new(:local, :enable_local, :tag)
+		# The current track being played by <tt>Rts#play</tt>.
+		attr_reader :current
+		
+		# Initializes a new RTS.
+		def initialize
+			self.local = []
+			self.enable_local = false
+		end
+		
+		# Returns a list of all music files in the selected tag.
+		def files
+			a = [RTS.user_music]
+			a += self.local if self.enable_local
+			join_string = (self.tag ? "#{self.tag}/" : "") + "*.{ogg,wav,mid,midi,mod}"
+			return a.collect { |x| Dir[File.join(x, join_string)] }.inject(:+)
+		end
+		
+		# Selects a random music file and plays it. The option hash passed to
+		# this method gets forwarded to <tt>Rubygame::Music#play</tt>. See
+		# http://docs.rubygame.org/rdoc/current/classes/Rubygame/Music.html#M000407
+		# for more information.
+		def play(opts = {})
+			if fn = files.sample
+				@current = Rubygame::Music.load(files.sample)
+				@current.play(opts)
+				return @current
+			else
+				return nil
+			end
+		end
+	end
+end

data/samples/sample.rb

@@ -0,0 +1,8 @@
+# This will print out 10 random song files. You can pass a tag
+# as command line parameter. Default is "menu".
+require File.join(File.dirname(__FILE__), "..", "lib", "rubytrackselector")
+
+rts = RTS::Rts.new
+rts.tag = ARGV[0] || RTS::MENU
+
+10.times { puts rts.files.sample }

data/test/test_general.rb

@@ -0,0 +1,43 @@
+require "test/unit"
+require "fileutils"
+require "rubytrackselector"
+require "testhelper"
+
+class UsermusicTest < Test::Unit::TestCase
+	def setup
+		usermusic_wrapper do
+			FileUtils.rm_rf(RTS.user_music(false)) rescue nil
+			@musics = generate_musics.sort
+			@rts = RTS::Rts.new
+		end
+	end
+	
+	def test_user_musics
+		usermusic_wrapper do
+			assert_equal @musics, @rts.files.sort
+		end
+	end
+	
+	def test_local_musics
+		usermusic_wrapper do
+			@rts.local << ["test"]
+			@rts.enable_local = true
+			assert_equal [*@musics, "test/dummy.wav"].sort, @rts.files
+		end
+	end
+	
+	def test_disable_local_musics
+		usermusic_wrapper do
+			@rts.local << ["test"]
+			@rts.enable_local = false
+			assert_equal @musics, @rts.files.sort
+		end
+	end
+	
+	def test_default_disable_local_musics
+		usermusic_wrapper do
+			@rts.local << ["test"]
+			assert_equal @musics, @rts.files.sort
+		end
+	end
+end

data/test/test_homedir.rb

@@ -0,0 +1,27 @@
+require "test/unit"
+require "fileutils"
+require "rubytrackselector"
+require "testhelper"
+
+class HomedirTest < Test::Unit::TestCase
+	def test_home
+		assert_equal File.expand_path("~"), RTS.home
+		assert_equal File.join(RTS.home, RTS::RTS_DIR), RTS.user_music
+	end
+	
+	def test_no_music_dir
+		usermusic_wrapper do
+			FileUtils.rm_rf(RTS.user_music) rescue nil
+			RTS.user_music(false)
+			assert_equal false, Dir.exists?(RTS.user_music(false))
+		end
+	end
+	
+	def test_has_music_dir
+		usermusic_wrapper do
+			FileUtils.rm_rf(RTS.user_music) rescue nil
+			RTS.user_music(true)
+			assert_equal true, Dir.exists?(RTS.user_music(false))
+		end
+	end
+end

data/test/test_tags.rb

@@ -0,0 +1,35 @@
+require "test/unit"
+require "fileutils"
+require "rubytrackselector"
+require "testhelper"
+
+class TagTest < Test::Unit::TestCase
+	def setup
+		usermusic_wrapper do
+			FileUtils.rm_rf(RTS.user_music(false)) rescue nil
+			Dir.mkdir(File.join(RTS.user_music, "tag1"))
+			Dir.mkdir(File.join(RTS.user_music, "tag2"))
+			
+			@musics    = []
+			@musics[0] = generate_musics(RTS.user_music + "/tag1").sort
+			@musics[1] = generate_musics(RTS.user_music + "/tag2").sort
+			@musics[2] = generate_musics.sort
+			@rts = RTS::Rts.new
+		end
+	end
+	
+	def test_tags
+		usermusic_wrapper do
+			assert_equal @musics[2], @rts.files
+			
+			@rts.tag = "tag1"
+			assert_equal @musics[0], @rts.files
+			
+			@rts.tag = "tag2"
+			assert_equal @musics[1], @rts.files
+			
+			@rts.tag = nil
+			assert_equal @musics[2], @rts.files
+		end
+	end
+end

data/test/testhelper.rb

@@ -0,0 +1,28 @@
+def usermusic_wrapper(new_md = ".rubytrackselector-test-tmp")
+	dummy_stderr = Object.new
+	def dummy_stderr.write(*); end
+	original_stderr = $stderr
+	
+	$stderr = dummy_stderr
+	original_md = RTS::RTS_DIR
+	RTS::const_set(:RTS_DIR, new_md)
+	$stderr = original_stderr
+	
+	yield
+	
+	$stderr = dummy_stderr
+	RTS::const_set(:RTS_DIR, original_md)
+	$stderr = original_stderr
+end
+
+def generate_musics(to = nil, n = 5)
+	to ||= RTS.user_music
+	n.times do
+		s = ""
+		20.times {  s += (rand('z'.ord - 'a'.ord) + 'a'.ord).chr }
+		s += ".wav"
+		
+		FileUtils.cp("test/dummy.wav", File.join(to , s))
+	end
+	return Dir[File.join(to, "*.wav")]
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: rubytrackselector
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Raphael Robatsch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-18 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubygame
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: raphaelr@f-m.fm
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- doc/index.rdoc
+files: 
+- lib/rubytrackselector/home.rb
+- lib/rubytrackselector/utp.rb
+- lib/rubytrackselector.rb
+- test/dummy.wav
+- test/testhelper.rb
+- test/test_general.rb
+- test/test_homedir.rb
+- test/test_tags.rb
+- doc/index.rdoc
+- samples/sample.rb
+- COPYING
+- Rakefile
+- README
+has_rdoc: true
+homepage: http://raphaelr.github.com/rubytrackselector
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      version: "1.8"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A music selection library for Rubygame.
+test_files: 
+- test/test_general.rb
+- test/test_homedir.rb
+- test/test_tags.rb