beats 1.2.2 → 1.2.3

data/README.markdown

@@ -35,16 +35,16 @@ And [here's what it sounds like](http://beatsdrummachine.com/beat.mp3) after get
 Current Status
 --------------
 
-The latest stable version of BEATS is 1.2.2, released on June 12, 2011. This is a minor release which includes two bug fixes:
+The latest stable version of BEATS is 1.2.3, released on December 31, 2011. This is a minor release which includes two improvements:
 
-* Bug fix: Compatibility issues with Windows
-* Bug fix: Return the correct status code when BEATS terminates, to improve scriptability.
+* Bug fix: You can now use `~` in sound file paths, and it will correctly expand to your home folder. (At least on UNIX OSes, I'm not sure if that works on Windows).
+* The new `--path` option allows setting the base path from which relative sound file paths are searched for.
 
 
 Installation
 ------------
 
-To install the latest stable version (1.2.2) from [rubygems.org](http://rubygems.org/gems/beats), run the following from the command line:
+To install the latest stable version (1.2.3) from [rubygems.org](http://rubygems.org/gems/beats), run the following from the command line:
 
     gem install beats
 

data/bin/beats

@@ -20,7 +20,7 @@ require "lib/track"
 USAGE_INSTRUCTIONS = ""
 
 def parse_options()
-  options = {:split => false, :pattern => nil}
+  options = {:split => false}
 
   optparse = OptionParser.new do |opts|
     opts.banner = "usage: beats [options] input_file [output_file]"
@@ -32,12 +32,16 @@ def parse_options()
     opts.on('-p', '--pattern PATTERN_NAME', "Output a single pattern instead of the whole song" ) do |p|
       options[:pattern] = p
     end
-  
+
+    opts.on('--path BASE_PATH', "The base path used to load sound files with relative paths.") do |base_path|
+      options[:base_path] = base_path
+    end
+
     opts.on('-v', '--version', "Display version number and exit") do
       puts "BEATS v#{Beats::BEATS_VERSION}"
       exit
     end
-  
+
     opts.on( '-h', '--help', "Display this screen and exit" ) do
       puts opts
       exit

data/lib/beats.rb

@@ -1,5 +1,5 @@
 class Beats
-  BEATS_VERSION = "1.2.2"
+  BEATS_VERSION = "1.2.3"
  
   # Each pattern in the song will be split up into sub patterns that have at most this many steps.
   # In general, audio for several shorter patterns can be generated more quickly than for one long
@@ -18,7 +18,8 @@ class Beats
   end
 
   def run
-    song, kit = SongParser.new().parse(File.dirname(@input_file_name), File.read(@input_file_name))
+    base_path = @options[:base_path] || File.dirname(@input_file_name)
+    song, kit = SongParser.new().parse(base_path, File.read(@input_file_name))
 
     song = normalize_for_pattern_option(song)
     songs_to_generate = normalize_for_split_option(song)

data/lib/kit.rb

@@ -137,18 +137,15 @@ private
     end
   end
   
-  def get_absolute_path(base_path, sound_file_name)
-    path_is_absolute = sound_file_name.start_with?(File::SEPARATOR)
-    return path_is_absolute ? sound_file_name : (base_path + File::SEPARATOR + sound_file_name)
-  end
-  
+  # Converts relative paths into absolute paths. Note that this will also handle
+  # expanding ~ on platforms that support that.
   def make_file_names_absolute(kit_items)
     kit_items.each do |label, sound_file_names|
       unless sound_file_names.class == Array
         sound_file_names = [sound_file_names]
       end
       
-      sound_file_names.map! {|sound_file_name| get_absolute_path(base_path, sound_file_name)}  
+      sound_file_names.map! {|sound_file_name| File.expand_path(sound_file_name, base_path) }  
       kit_items[label] = sound_file_names
     end
     

data/test/audioengine_test.rb

@@ -1,5 +1,3 @@
-$:.unshift File.join(File.dirname(__FILE__),'..','lib')
-
 require 'includes'
 
 # Make private methods public for testing

data/test/audioutils_test.rb

@@ -1,5 +1,3 @@
-$:.unshift File.join(File.dirname(__FILE__),'..','lib')
-
 require 'includes'
 
 class AudioUtilsTest < Test::Unit::TestCase

data/test/fixtures/valid/example_mono_16_base_path.txt

@@ -0,0 +1,33 @@
+# An example song using mono 16-bit sounds
+# The sound files in this example do not exist in the given
+# location relative to this file, so this is intended for testing
+# when a custom base path is given.
+
+Song:
+  Tempo: 120
+  Flow:
+    - Verse:   x2
+    - Chorus:  x4
+    - Verse:   x2
+    - Chorus:  x4
+  Kit:
+    - bass:       bass_mono_16.wav
+    - snare:      snare_mono_16.wav
+    - hh_closed:  hh_closed_mono_16.wav
+    - agogo:      agogo_high_mono_16.wav
+
+Verse:
+  - bass:       X...X...X...X...
+  - snare:      ..............X.
+  - hh_closed:  X.XXX.XX........
+  - hh_closed:  ........X.X.X.X.
+  - agogo:      ..............XX
+
+# Also including non-Kit sounds to test that they work as well:
+Chorus:
+  - bass:              X...X...XX..X...
+  - snare:             ....X.......X...
+  - hh_closed:         X.XXX.XX........
+  - hh_closed:         ........X.XX..X.
+  - tom4_mono_16.wav:  ...........X....
+  - tom2_mono_16.wav:  ..............X.

data/test/integration_test.rb

@@ -1,11 +1,14 @@
-$:.unshift File.join(File.dirname(__FILE__),'..','lib')
-
 require 'includes'
 
 class IntegrationTest < Test::Unit::TestCase
   TRACK_NAMES =  ["bass", "snare", "hh_closed", "hh_closed2", "agogo", "tom4", "tom2"]
   OUTPUT_FOLDER = "test/integration_output"
   
+  def setup
+    # Make sure no output from previous tests is still around
+    clean_output_folder()
+  end
+
   def test_bad_song_errors
     invalid_fixtures = ["bad_tempo.txt",
                         "bad_repeat_count.txt",
@@ -17,7 +20,7 @@ class IntegrationTest < Test::Unit::TestCase
         
     invalid_fixtures.each do |fixture_name|
       assert_raise(SongParseError) do
-        beats = Beats.new("test/fixtures/invalid/#{fixture_name}", "doesn't matter", {:split => false, :pattern => nil})
+        beats = Beats.new("test/fixtures/invalid/#{fixture_name}", "doesn't matter", {:split => false})
         beats.run()
       end
     end
@@ -27,25 +30,32 @@ class IntegrationTest < Test::Unit::TestCase
   # TODO: Add tests for the -p option
   # TODO: Add test verify that song generated with and without SongOptimizer are identical.
   
+  def test_base_path
+    run_combined_test("mono", 16, "_base_path", "test/sounds")
+    run_split_test("mono", 16, "_base_path", "test/sounds")
+  end
+
   def test_generate_combined
-    # Make sure no output from previous tests is still around
-    clean_output_folder()
-    
     run_combined_test("mono",   8)
     run_combined_test("mono",   16)
     run_combined_test("stereo", 8)
     run_combined_test("stereo", 16)
   end
   
-  def run_combined_test(num_channels, bits_per_sample)
+  def run_combined_test(num_channels, bits_per_sample, suffix="", base_path=nil)
     # Make sure no output from previous tests is still around
     assert_equal([".", ".."], Dir.new(OUTPUT_FOLDER).entries)
     
-    song_fixture         = "test/fixtures/valid/example_#{num_channels}_#{bits_per_sample}.txt"
-    actual_output_file   = "#{OUTPUT_FOLDER}/example_combined_#{num_channels}_#{bits_per_sample}.wav"
+    song_fixture         = "test/fixtures/valid/example_#{num_channels}_#{bits_per_sample}#{suffix}.txt"
+    actual_output_file   = "#{OUTPUT_FOLDER}/example_combined_#{num_channels}_#{bits_per_sample}#{suffix}.wav"
     expected_output_file = "test/fixtures/expected_output/example_combined_#{num_channels}_#{bits_per_sample}.wav"
     
-    beats = Beats.new(song_fixture, actual_output_file, {:split => false, :pattern => nil})
+    options = {:split => false}
+    unless base_path == nil
+      options[:base_path] = base_path
+    end
+
+    beats = Beats.new(song_fixture, actual_output_file, options)
     beats.run()
     assert(File.exists?(actual_output_file), "Expected file '#{actual_output_file}' to exist, but it doesn't.")
 
@@ -59,24 +69,26 @@ class IntegrationTest < Test::Unit::TestCase
   end
   
   def test_generate_split
-    # Make sure no output from previous tests is still around
-    clean_output_folder()
-    
     run_split_test("mono",    8)
     run_split_test("mono",   16)
     run_split_test("stereo",  8)
     run_split_test("stereo", 16)
   end
   
-  def run_split_test(num_channels, bits_per_sample)
+  def run_split_test(num_channels, bits_per_sample, suffix="", base_path=nil)
     # Make sure no output from previous tests is still around
     assert_equal([".", ".."], Dir.new(OUTPUT_FOLDER).entries)
     
-    song_fixture         = "test/fixtures/valid/example_#{num_channels}_#{bits_per_sample}.txt"
-    actual_output_prefix   = "#{OUTPUT_FOLDER}/example_split_#{num_channels}_#{bits_per_sample}"
+    song_fixture         = "test/fixtures/valid/example_#{num_channels}_#{bits_per_sample}#{suffix}.txt"
+    actual_output_prefix   = "#{OUTPUT_FOLDER}/example_split_#{num_channels}_#{bits_per_sample}#{suffix}"
     expected_output_prefix = "test/fixtures/expected_output/example_split_#{num_channels}_#{bits_per_sample}"
     
-    beats = Beats.new(song_fixture, actual_output_prefix + ".wav", {:split => true, :pattern => nil})
+    options = {:split => true}
+    unless base_path == nil
+      options[:base_path] = base_path
+    end
+
+    beats = Beats.new(song_fixture, actual_output_prefix + ".wav", options)
     beats.run()
     TRACK_NAMES.each do |track_name|
       if(track_name.start_with?("tom"))

data/test/kit_test.rb

@@ -1,5 +1,3 @@
-$:.unshift File.join(File.dirname(__FILE__),'..','lib')
-
 require 'includes'
 
 # Kit which allows directly changing the sound bank after initialization, to allows tests

data/test/pattern_test.rb

@@ -1,5 +1,3 @@
-$:.unshift File.join(File.dirname(__FILE__),'..','lib')
-
 require 'includes'
 
 class PatternTest < Test::Unit::TestCase

data/test/patternexpander_test.rb

@@ -1,5 +1,3 @@
-$:.unshift File.join(File.dirname(__FILE__),'..','lib')
-
 require 'includes'
 
 class PatternExpanderTest < Test::Unit::TestCase  

data/test/song_test.rb

@@ -1,5 +1,3 @@
-$:.unshift File.join(File.dirname(__FILE__),'..','lib')
-
 require 'includes'
 
 class SongTest < Test::Unit::TestCase

data/test/songoptimizer_test.rb

@@ -1,5 +1,3 @@
-$:.unshift File.join(File.dirname(__FILE__),'..','lib')
-
 require 'includes'
 
 class MockSongOptimizer < SongOptimizer

data/test/songparser_test.rb

@@ -1,5 +1,3 @@
-$:.unshift File.join(File.dirname(__FILE__),'..','lib')
-
 require 'includes'
 
 class SongParserTest < Test::Unit::TestCase

data/test/track_test.rb

@@ -1,5 +1,3 @@
-$:.unshift File.join(File.dirname(__FILE__),'..','lib')
-
 require 'includes'
 
 class TrackTest < Test::Unit::TestCase

metadata

@@ -2,7 +2,7 @@
 name: beats
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors: 
 - Joel Strait
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-13 00:00:00 Z
+date: 2012-01-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: wavefile
@@ -47,6 +47,7 @@ files:
 - lib/songparser.rb
 - lib/track.rb
 - bin/beats
+- bin/example_song.wav
 - test/audioengine_test.rb
 - test/audioutils_test.rb
 - test/fixtures/expected_output/example_combined_mono_16.wav
@@ -94,6 +95,7 @@ files:
 - test/fixtures/invalid/sound_in_track_wrong_format.txt
 - test/fixtures/invalid/template.txt
 - test/fixtures/valid/example_mono_16.txt
+- test/fixtures/valid/example_mono_16_base_path.txt
 - test/fixtures/valid/example_mono_8.txt
 - test/fixtures/valid/example_no_kit.txt
 - test/fixtures/valid/example_stereo_16.txt
@@ -225,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.13
 signing_key: 
 specification_version: 3
 summary: A command-line drum machine. Feed it a song notated in YAML, and it will produce a precision-milled Wave file of impeccable timing and feel.
@@ -277,6 +279,7 @@ test_files:
 - test/fixtures/invalid/sound_in_track_wrong_format.txt
 - test/fixtures/invalid/template.txt
 - test/fixtures/valid/example_mono_16.txt
+- test/fixtures/valid/example_mono_16_base_path.txt
 - test/fixtures/valid/example_mono_8.txt
 - test/fixtures/valid/example_no_kit.txt
 - test/fixtures/valid/example_stereo_16.txt
@@ -385,3 +388,4 @@ test_files:
 - test/sounds/tom4_stereo_8.wav
 - test/sounds/tone.wav
 - test/track_test.rb
+has_rdoc: