beats 1.2.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f2f7351421971cb29e95868abde34acaa5ab6b2
-  data.tar.gz: ba692d9e94e5cac568eff994493a45b4739ee2ac
+  metadata.gz: bc3e2d1d7e7730ec749de9aacb9446ef847cfcbd
+  data.tar.gz: 42bff66e1caa2ff6ff503e57aac501ac36c0d445
 SHA512:
-  metadata.gz: 23dd31bfc7e19dcf52dcc573e054f36b46f93b4cd5d5aaa9e9077d9a9227082ddf42b4781f9564af1ab54fd70de1758116e8cf94c6189ca1bbf3f7426628b8dc
-  data.tar.gz: 19d77737f3a74672d0d73267ba673ecebf99c46c8af487d75762ee8956aab9e034d888d39707e1d6ef10cb6bdb3fd42f499b838b6e032290db664a2476ec5a68
+  metadata.gz: c5782528094a11cd93d7a49fa944787fd8150066ebc8f72a75253c4fd1326ae106c58fdb337591f815f4bf4cc85b58fdae497660e96c86789d365b833a72b15f
+  data.tar.gz: 666d0a00cf0da6f21e7c1476ded37fd97b41db884add895aff0e627a8e0e9bebbd6c8ee6f5f76d4a2f5916e9d9e83c203846082bc9ce0fad78a681000e0c87be

data/LICENSE

@@ -1,6 +1,6 @@
 == BEATS
 
-# Copyright (c) 2010-13 Joel Strait
+# Copyright (c) 2010-14 Joel Strait
 #
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this software and associated documentation

data/README.markdown

@@ -33,19 +33,44 @@ And [here's what it sounds like](http://beatsdrummachine.com/media/beat.mp3) aft
 Current Status
 --------------
 
-The latest stable version of Beats is 1.2.5, released on December 31, 2013. This release includes these improvements: 
+The latest stable version of Beats is 1.3.0, released on March 4, 2013.
 
-* Tracks that start with a `|` no longer cause an error in Ruby 2.0.0 and 2.1.0.
-* Additional Wave file formats can now be used as samples, due to upgrading to [WaveFile 0.6.0](http://wavefilegem.com) behind the scenes:
-  * 24-bit PCM
-  * 32-bit IEEE Float
-  * 64-bit IEEE Float
+This release is for all you swingers out there. A new `Swing` declaration in the song header will cause the song to be played with either a swung 8th note or swung 16th note rhythm. For example, take this song:
+
+    Song:
+      Tempo: 120
+      Flow:
+        - Verse: x4
+
+    Verse:
+    - bass.wav:   X...X...X...X...
+    - snare.wav:  ....X.......X...
+    - hihat.wav:  X.X.X.X.X.X.X.X.
+
+It will [sound like this](http://beatsdrummachine.com/media/straight.wav).
+
+You can add an 8th note swing like this (notice the 3rd line, everything else is the same):
+
+    Song:
+      Tempo: 120
+      Swing: 8   # Or, 16
+      Flow:
+        - Verse: x4
+
+    Verse:
+    - bass.wav:   X...X...X...X...
+    - snare.wav:  ....X.......X...
+    - hihat.wav:  X.X.X.X.X.X.X.X.
+
+And it will now [sound like this](http://beatsdrummachine.com/media/swing.wav).
+
+This release also includes a small bug fix. When you run the `beats` command with no arguments, it now displays the help screen, rather than an error message.
 
 
 Installation
 ------------
 
-To install the latest stable version (1.2.5) from [rubygems.org](http://rubygems.org/gems/beats), run the following from the command line:
+To install the latest stable version (1.3.0) from [rubygems.org](http://rubygems.org/gems/beats), run the following from the command line:
 
     gem install beats
 

data/bin/beats

@@ -71,6 +71,12 @@ end
 
 begin
   options = parse_options()
+
+  if ARGV.empty?
+    puts USAGE_INSTRUCTIONS
+    exit
+  end
+
   input_file_name = ARGV[0]
   output_file_name = ARGV[1]
 

data/lib/beats.rb

@@ -7,7 +7,8 @@ require 'beats/song'
 require 'beats/songparser'
 require 'beats/songoptimizer'
 require 'beats/track'
+require 'beats/transforms/song_swinger'
 
 module Beats
-  VERSION = "1.2.5"
+  VERSION = "1.3.0"
 end

data/lib/beats/song.rb

@@ -52,7 +52,7 @@ module Beats
     end
 
     def tempo=(new_tempo)
-      unless new_tempo.class == Fixnum && new_tempo > 0
+      unless (new_tempo.class == Fixnum || new_tempo.class == Float) && new_tempo > 0
         raise InvalidTempoError, "Invalid tempo: '#{new_tempo}'. Tempo must be a number greater than 0."
       end
 

data/lib/beats/songparser.rb

@@ -36,7 +36,7 @@ module Beats
         base_path = raw_song_components[:folder]
       end
 
-      song = Song.new()
+      song = Song.new
 
       # 1.) Set tempo
       begin
@@ -66,6 +66,15 @@ module Beats
         set_song_flow(song, raw_song_components[:flow])
       end
 
+      # 5.) Swing, if swing flag is set
+      if raw_song_components[:swing]
+        begin
+          song = Transforms::SongSwinger.transform(song, raw_song_components[:swing])
+        rescue Transforms::InvalidSwingRateError => detail
+          raise SongParseError, "#{detail}"
+        end
+      end
+
       return song, kit
     end
 
@@ -104,6 +113,7 @@ module Beats
         raw_song_components[:flow]    = raw_structure
       end
 
+      raw_song_components[:swing]   = raw_song_components[:header]["swing"]
       raw_song_components[:patterns]  = raw_song_components[:full_definition].reject {|k, v| k == "song"}
 
       return raw_song_components

data/lib/beats/transforms/song_swinger.rb

@@ -0,0 +1,54 @@
+module Beats
+  module Transforms
+    class InvalidSwingRateError < RuntimeError; end
+
+    class SongSwinger
+      def self.transform(song, swing_rate)
+        validate_swing_rate(swing_rate)
+
+        song.patterns.values.each do |pattern|
+          pattern.tracks.values.each do |track|
+            original_rhythm = track.rhythm
+
+            if swing_rate == 8
+              track.rhythm = swing_8(track.rhythm)
+            elsif swing_rate == 16
+              track.rhythm = swing_16(track.rhythm)
+            end
+          end
+        end
+
+        song.tempo *= 1.5
+
+        song
+      end
+
+      private
+
+      def self.validate_swing_rate(swing_rate)
+        if swing_rate != 8 && swing_rate != 16
+          raise InvalidSwingRateError, "Invalid swing rate: '#{swing_rate}'. Swing rate must be 8 or 16."
+        end
+      end
+
+      def self.swing_8(original_rhythm)
+        original_rhythm.chars.each_slice(4).inject("") do |new_rhythm, slice|
+          if slice.length == 1
+            new_rhythm << "#{slice[0]}."
+          else
+            new_rhythm << "#{slice[0]}.#{slice[1]}.#{slice[2]}#{slice[3]}"
+          end
+
+          new_rhythm
+        end
+      end
+
+      def self.swing_16(original_rhythm)
+        original_rhythm.chars.each_slice(2).inject("") do |new_rhythm, slice|
+          new_rhythm << "#{slice[0]}.#{slice[1]}"
+          new_rhythm
+        end
+      end
+    end
+  end
+end

data/test/audioengine_test.rb

@@ -27,9 +27,9 @@ class AudioEngineTest < Test::Unit::TestCase
   def load_fixtures
     test_engines = {}
     base_path = File.dirname(__FILE__) + "/.."
-    song_parser = SongParser.new()
+    song_parser = SongParser.new
 
-    test_engines[:blank] = AudioEngine.new(Song.new(), Kit.new(base_path, {}))
+    test_engines[:blank] = AudioEngine.new(Song.new, Kit.new(base_path, {}))
 
     FIXTURES.each do |fixture_name|
       song, kit = song_parser.parse(base_path, File.read("test/fixtures/valid/#{fixture_name}.txt"))
@@ -40,7 +40,7 @@ class AudioEngineTest < Test::Unit::TestCase
   end
 
   def test_initialize
-    test_engines = load_fixtures()
+    test_engines = load_fixtures
 
     assert_equal(5512.5, test_engines[:blank].step_sample_length)
     assert_equal(6615.0, test_engines[:repeats_not_specified].step_sample_length)
@@ -159,7 +159,7 @@ class AudioEngineTest < Test::Unit::TestCase
 
   def helper_generate_track_sample_data(kit, rhythm, step_sample_length, expected_primary, expected_overflow = [])
     track = Track.new("foo", rhythm)
-    engine = MockAudioEngine.new(Song.new(), kit)
+    engine = MockAudioEngine.new(Song.new, kit)
     engine.step_sample_length = step_sample_length
     actual = engine.generate_track_sample_data(track, kit.get_sample_data("S"))
 
@@ -182,7 +182,7 @@ class AudioEngineTest < Test::Unit::TestCase
 
 
     # Simple case, no overflow (stereo)
-    engine = MockAudioEngine.new(Song.new(), MONO_KIT)
+    engine = MockAudioEngine.new(Song.new, MONO_KIT)
     engine.step_sample_length = 4
     primary, overflow = engine.composite_pattern_tracks(no_overflow_pattern)
     assert_equal([
@@ -196,7 +196,7 @@ class AudioEngineTest < Test::Unit::TestCase
 
 
     # Simple case, no overflow (stereo)
-    engine = MockAudioEngine.new(Song.new(), STEREO_KIT)
+    engine = MockAudioEngine.new(Song.new, STEREO_KIT)
     engine.step_sample_length = 4
     primary, overflow = engine.composite_pattern_tracks(no_overflow_pattern)
     assert_equal([
@@ -222,7 +222,7 @@ class AudioEngineTest < Test::Unit::TestCase
 
 
     # Some overflow (mono)
-    engine = MockAudioEngine.new(Song.new(), MONO_KIT)
+    engine = MockAudioEngine.new(Song.new, MONO_KIT)
     engine.step_sample_length = 3
     primary, overflow = engine.composite_pattern_tracks(overflow_pattern)
     assert_equal([
@@ -236,7 +236,7 @@ class AudioEngineTest < Test::Unit::TestCase
 
 
     # Some overflow (stereo)
-    engine = MockAudioEngine.new(Song.new(), STEREO_KIT)
+    engine = MockAudioEngine.new(Song.new, STEREO_KIT)
     engine.step_sample_length = 3
     primary, overflow = engine.composite_pattern_tracks(overflow_pattern)
     assert_equal([

data/test/audioutils_test.rb

@@ -39,5 +39,8 @@ class AudioUtilsTest < Test::Unit::TestCase
     assert_equal(6615.0, AudioUtils.step_sample_length(44100, 100))
     assert_equal(3307.5, AudioUtils.step_sample_length(44100, 200))
     assert_equal(3307.5, AudioUtils.step_sample_length(22050, 100))
+
+    assert_equal(6874.612880831729, AudioUtils.step_sample_length(44100, 96.2236))
+    assert_equal(3437.3064404158645, AudioUtils.step_sample_length(22050, 96.2236))
   end
 end

data/test/fixtures/invalid/bad_swing_rate_1.txt

@@ -0,0 +1,9 @@
+# Invalid song, since the swing rate is invalid
+Song:
+  Tempo: 100
+  Swing: 7    # Invalid swing rate, not 8 or 16
+  Flow:
+    - Verse:  x2
+
+Verse:
+  - test/sounds/bass_mono_8.wav:  X...X...

data/test/fixtures/invalid/bad_swing_rate_2.txt

@@ -0,0 +1,9 @@
+# Invalid song, since the swing rate is invalid
+Song:
+  Tempo: 100
+  Swing: abc    # Invalid swing rate, not 8 or 16
+  Flow:
+    - Verse:  x2
+
+Verse:
+  - test/sounds/bass_mono_8.wav:  X...X...

data/test/fixtures/valid/example_swung_16th.txt

@@ -0,0 +1,18 @@
+# An example song
+
+Song:
+  Tempo: 120
+  Swing: 16
+  Kit:
+    - bass:     test/sounds/bass_mono_8.wav
+    - snare:    test/sounds/snare_mono_8.wav
+  Flow:
+    - Verse:  x2
+    - Chorus: x2
+
+Verse:
+  - bass:      X...X...
+  - snare:     ..X...X.
+Chorus:
+  - bass:      XXXXXXXX
+  - snare:     .X.X.X.X

data/test/fixtures/valid/example_swung_8th.txt

@@ -0,0 +1,18 @@
+# An example song
+
+Song:
+  Tempo: 120
+  Swing: 8
+  Kit:
+    - bass:     test/sounds/bass_mono_8.wav
+    - snare:    test/sounds/snare_mono_8.wav
+  Flow:
+    - Verse:  x2
+    - Chorus: x2
+
+Verse:
+  - bass:      X...X...
+  - snare:     ..X...X.
+Chorus:
+  - bass:      XXXXXXXX
+  - snare:     .X.X.X.X

data/test/fixtures/valid/example_unswung.txt

@@ -0,0 +1,17 @@
+# An example song
+
+Song:
+  Tempo: 120
+  Kit:
+    - bass:     test/sounds/bass_mono_8.wav
+    - snare:    test/sounds/snare_mono_8.wav
+  Flow:
+    - Verse:  x2
+    - Chorus: x2
+
+Verse:
+  - bass:      X...X...
+  - snare:     ..X...X.
+Chorus:
+  - bass:      XXXXXXXX
+  - snare:     .X.X.X.X

data/test/fixtures/valid/fractional_tempo.txt

@@ -0,0 +1,17 @@
+# An example song
+
+Song:
+  Tempo: 95.764 
+  Kit:
+    - bass:     test/sounds/bass_mono_8.wav
+    - snare:    test/sounds/snare_mono_8.wav
+  Flow:
+    - Verse:  x2
+    - Chorus: x2
+
+Verse:
+  - bass:      X...X...
+  - snare:     ..X...X.
+Chorus:
+  - bass:      XXXXXXXX
+  - snare:     .X.X.X.X

data/test/integration_test.rb

@@ -6,7 +6,7 @@ class IntegrationTest < Test::Unit::TestCase
 
   def setup
     # Make sure no output from previous tests is still around
-    clean_output_folder()
+    clean_output_folder
   end
 
   def test_bad_song_errors
@@ -21,7 +21,7 @@ class IntegrationTest < Test::Unit::TestCase
     invalid_fixtures.each do |fixture_name|
       assert_raise(SongParseError) do
         beats = BeatsRunner.new("test/fixtures/invalid/#{fixture_name}", "doesn't matter", {:split => false})
-        beats.run()
+        beats.run
       end
     end
   end
@@ -56,7 +56,7 @@ class IntegrationTest < Test::Unit::TestCase
     end
 
     beats = BeatsRunner.new(song_fixture, actual_output_file, options)
-    beats.run()
+    beats.run
     assert(File.exists?(actual_output_file), "Expected file '#{actual_output_file}' to exist, but it doesn't.")
 
     # Reading the files this way instead of a plain File.read() for Windows compatibility with binary files
@@ -89,7 +89,7 @@ class IntegrationTest < Test::Unit::TestCase
     end
 
     beats = BeatsRunner.new(song_fixture, actual_output_prefix + ".wav", options)
-    beats.run()
+    beats.run
     TRACK_NAMES.each do |track_name|
       if(track_name.start_with?("tom"))
         track_name += "_#{num_channels}_#{bits_per_sample}"
@@ -99,8 +99,8 @@ class IntegrationTest < Test::Unit::TestCase
       assert(File.exists?(actual_output_file), "Expected file '#{actual_output_file}' to exist, but it doesn't.")
 
       # Reading the files this way instead of a plain File.read() for Windows compatibility with binary files
-      expected_output_file_contents = File.open(expected_output_file, "rb") {|f| f.read() }
-      actual_output_file_contents = File.open(actual_output_file, "rb") {|f| f.read() }
+      expected_output_file_contents = File.open(expected_output_file, "rb") {|f| f.read }
+      actual_output_file_contents = File.open(actual_output_file, "rb") {|f| f.read }
       assert_equal(expected_output_file_contents, actual_output_file_contents)
 
       # Clean up after ourselves

data/test/kit_test.rb

@@ -40,7 +40,7 @@ class KitTest < Test::Unit::TestCase
   end
 
   def test_valid_initialization
-    kits = generate_test_data()
+    kits = generate_test_data
 
     assert_equal(16, kits[:empty].bits_per_sample)
     assert_equal(1, kits[:empty].num_channels)
@@ -93,7 +93,7 @@ class KitTest < Test::Unit::TestCase
   end
 
   def test_get_sample_data
-    kits = generate_test_data()
+    kits = generate_test_data
     # Should get an error when trying to get a non-existent sound
     assert_raise(StandardError) { kits[:mono8].get_sample_data("nonexistant") }
 

data/test/pattern_test.rb

@@ -27,7 +27,7 @@ class PatternTest < Test::Unit::TestCase
   end
 
   def test_initialize
-    test_patterns = generate_test_data()
+    test_patterns = generate_test_data
 
     pattern = test_patterns[:blank]
     assert_equal(pattern.name, :blank)
@@ -43,11 +43,11 @@ class PatternTest < Test::Unit::TestCase
   end
 
   def test_step_count
-    test_patterns = generate_test_data()
+    test_patterns = generate_test_data
 
-    assert_equal(0,  test_patterns[:blank].step_count())
-    assert_equal(32, test_patterns[:verse].step_count())
-    assert_equal(4,  test_patterns[:staircase].step_count())
+    assert_equal(0,  test_patterns[:blank].step_count)
+    assert_equal(32, test_patterns[:verse].step_count)
+    assert_equal(4,  test_patterns[:staircase].step_count)
   end
 
   def test_same_tracks_as?

data/test/song_swinger_test.rb

@@ -0,0 +1,170 @@
+require 'includes'
+
+class SongSwingerTest < Test::Unit::TestCase
+  def test_full_song_swing_rate_8
+    base_path = File.dirname(__FILE__) + "/sounds"
+    song, kit = SongParser.new.parse(base_path, File.read("test/fixtures/valid/example_mono_16_base_path.txt"))
+
+    shuffled_song = Transforms::SongSwinger.transform(song, 8)
+
+    assert_equal(180, shuffled_song.tempo)
+    assert_equal([:verse, :verse, :chorus, :chorus, :chorus, :chorus,
+                  :verse, :verse, :chorus, :chorus, :chorus, :chorus],
+                 shuffled_song.flow)
+
+    assert_equal([:chorus, :verse], shuffled_song.patterns.keys.sort)
+
+    chorus_pattern = shuffled_song.patterns[:chorus]
+    assert_equal(["bass",
+                  "snare",
+                  "hh_closed",
+                  "hh_closed2",
+                  "tom4_mono_16.wav",
+                  "tom2_mono_16.wav"],
+                 chorus_pattern.tracks.keys)
+
+    assert_equal("X.....X.....X.X...X.....", chorus_pattern.tracks["bass"].rhythm)
+    assert_equal("......X...........X.....", chorus_pattern.tracks["snare"].rhythm)
+    assert_equal("X...XXX...XX............", chorus_pattern.tracks["hh_closed"].rhythm)
+    assert_equal("............X...XX....X.", chorus_pattern.tracks["hh_closed2"].rhythm)
+    assert_equal(".................X......", chorus_pattern.tracks["tom4_mono_16.wav"].rhythm)
+    assert_equal("......................X.", chorus_pattern.tracks["tom2_mono_16.wav"].rhythm)
+
+    verse_pattern = shuffled_song.patterns[:verse]
+    assert_equal(["bass",
+                  "snare",
+                  "hh_closed",
+                  "hh_closed2",
+                  "agogo"],
+                 verse_pattern.tracks.keys)
+
+    assert_equal("X.....X.....X.....X.....", verse_pattern.tracks["bass"].rhythm)
+    assert_equal("......................X.", verse_pattern.tracks["snare"].rhythm)
+    assert_equal("X...XXX...XX............", verse_pattern.tracks["hh_closed"].rhythm)
+    assert_equal("............X...X.X...X.", verse_pattern.tracks["hh_closed2"].rhythm)
+    assert_equal("......................XX", verse_pattern.tracks["agogo"].rhythm)
+  end
+
+  def test_full_song_swing_rate_16
+    base_path = File.dirname(__FILE__) + "/sounds"
+    song, kit = SongParser.new.parse(base_path, File.read("test/fixtures/valid/example_mono_16_base_path.txt"))
+
+    shuffled_song = Transforms::SongSwinger.transform(song, 16)
+
+    assert_equal(180, shuffled_song.tempo)
+    assert_equal([:verse, :verse, :chorus, :chorus, :chorus, :chorus,
+                  :verse, :verse, :chorus, :chorus, :chorus, :chorus],
+                 shuffled_song.flow)
+
+    assert_equal([:chorus, :verse], shuffled_song.patterns.keys.sort)
+
+    chorus_pattern = shuffled_song.patterns[:chorus]
+    assert_equal(["bass",
+                  "snare",
+                  "hh_closed",
+                  "hh_closed2",
+                  "tom4_mono_16.wav",
+                  "tom2_mono_16.wav"],
+                 chorus_pattern.tracks.keys)
+
+    assert_equal("X.....X.....X.X...X.....", chorus_pattern.tracks["bass"].rhythm)
+    assert_equal("......X...........X.....", chorus_pattern.tracks["snare"].rhythm)
+    assert_equal("X..X.XX..X.X............", chorus_pattern.tracks["hh_closed"].rhythm)
+    assert_equal("............X..X.X...X..", chorus_pattern.tracks["hh_closed2"].rhythm)
+    assert_equal(".................X......", chorus_pattern.tracks["tom4_mono_16.wav"].rhythm)
+    assert_equal(".....................X..", chorus_pattern.tracks["tom2_mono_16.wav"].rhythm)
+
+    verse_pattern = shuffled_song.patterns[:verse]
+    assert_equal(["bass",
+                  "snare",
+                  "hh_closed",
+                  "hh_closed2",
+                  "agogo"],
+                 verse_pattern.tracks.keys)
+
+    assert_equal("X.....X.....X.....X.....", verse_pattern.tracks["bass"].rhythm)
+    assert_equal(".....................X..", verse_pattern.tracks["snare"].rhythm)
+    assert_equal("X..X.XX..X.X............", verse_pattern.tracks["hh_closed"].rhythm)
+    assert_equal("............X..X..X..X..", verse_pattern.tracks["hh_closed2"].rhythm)
+    assert_equal(".....................X.X", verse_pattern.tracks["agogo"].rhythm)
+  end
+
+  def test_swing_8_rhythm_conversions
+    test_rhythm_conversions(8, [["XXXXX.X.", "X.X.XXX...X."],
+                                ["XXXXXXX",  "X.X.XXX.X.X"],
+                                ["XXXX",     "X.X.XX"],
+                                ["....",     "......"],
+                                ["XXX",      "X.X.X"],
+                                ["XX",       "X.X."],
+                                ["X",        "X."]])
+  end
+
+  def test_swing_16_rhythm_conversions
+    test_rhythm_conversions(16, [["XXX..X..", "X.XX....X..."],
+                                 ["X..X..X",  "X....X...X."],
+                                 ["XX",       "X.X"],
+                                 ["X.",       "X.."],
+                                 [".X",       "..X"],
+                                 ["..",       "..."],
+                                 ["X",        "X."],
+                                 [".",        ".."]])
+  end
+
+  def test_tempo_change
+    [8, 16].each do |swing_rate|
+      song = Song.new
+      song.tempo = 140
+
+      song = Transforms::SongSwinger.transform(song, swing_rate)
+      assert_equal(210, song.tempo)
+    end
+  end
+
+  def test_conversion_to_fractional_tempo
+    [8, 16].each do |swing_rate|
+      song = Song.new
+      song.tempo = 145
+
+      song = Transforms::SongSwinger.transform(song, swing_rate)
+      assert_equal(217.5, song.tempo)
+    end
+  end
+
+  def test_fractional_tempo
+    [8, 16].each do |swing_rate|
+      song = Song.new
+      song.tempo = 145.325
+
+      song = Transforms::SongSwinger.transform(song, swing_rate)
+      assert_equal(217.98749999999998, song.tempo)
+    end
+  end
+
+  def test_invalid_swing_rate
+    [7, "abc", "8a", nil, "", [8]].each do |invalid_swing_rate|
+      song = Song.new
+      song.tempo = 100
+
+      assert_raise(Transforms::InvalidSwingRateError) do
+        song = Transforms::SongSwinger.transform(song, invalid_swing_rate)
+      end
+    end
+  end
+
+  private
+
+  def test_rhythm_conversions(swing_rate, expectations)
+    expectations.each do |original_rhythm, expected_rhythm|
+      song = Song.new
+
+      pattern = song.pattern(:my_pattern)
+      pattern.track("track1", original_rhythm)
+
+      song.pattern(pattern)
+
+      swung_song = Transforms::SongSwinger.transform(song, swing_rate)
+      swung_pattern = swung_song.patterns[:my_pattern]
+      assert_equal(expected_rhythm, swung_pattern.tracks["track1"].rhythm)
+    end
+  end
+end

data/test/song_test.rb

@@ -10,20 +10,20 @@ class SongTest < Test::Unit::TestCase
     test_songs = {}
     base_path = File.dirname(__FILE__) + "/.."
 
-    test_songs[:blank] = Song.new()
+    test_songs[:blank] = Song.new
 
-    test_songs[:no_flow] = Song.new()
+    test_songs[:no_flow] = Song.new
     verse = test_songs[:no_flow].pattern :verse
     verse.track "bass.wav",      "X.......X......."
     verse.track "snare.wav",     "....X.......X..."
     verse.track "hh_closed.wav", "X.X.X.X.X.X.X.X."
 
-    song_parser = SongParser.new()
+    song_parser = SongParser.new
     FIXTURES.each do |fixture_name|
       test_songs[fixture_name], throwaway_kit = song_parser.parse(base_path, File.read("test/fixtures/valid/#{fixture_name}.txt"))
     end
 
-    test_songs[:from_code] = Song.new()
+    test_songs[:from_code] = Song.new
     verse = test_songs[:from_code].pattern :verse
     verse.track "bass.wav",      "X.......X......."
     verse.track "snare.wav",     "....X.......X..."
@@ -38,15 +38,41 @@ class SongTest < Test::Unit::TestCase
   end
 
   def test_initialize
-    test_songs = generate_test_data()
+    test_songs = generate_test_data
 
     assert_equal([], test_songs[:blank].flow)
     assert_equal([], test_songs[:no_flow].flow)
     assert_equal([:verse, :chorus, :verse, :chorus, :chorus], test_songs[:from_code].flow)
   end
 
+  def test_tempo=
+    song = Song.new
+
+    song.tempo = 150
+    assert_equal(150, song.tempo)
+    
+    song.tempo = 145.854
+    assert_equal(145.854, song.tempo)
+
+    assert_raise(InvalidTempoError) do
+      song.tempo = -1
+    end
+
+    assert_raise(InvalidTempoError) do
+      song.tempo = -1.0
+    end
+
+    assert_raise(InvalidTempoError) do
+      song.tempo = "abc"
+    end
+
+    assert_raise(InvalidTempoError) do
+      song.tempo = "150"
+    end
+  end
+
   def test_pattern
-    song = Song.new()
+    song = Song.new
     verse1 = song.pattern :Verse
 
     assert_equal(:Verse, verse1.name)
@@ -63,7 +89,7 @@ class SongTest < Test::Unit::TestCase
   end
 
   def test_total_tracks
-    test_songs = generate_test_data()
+    test_songs = generate_test_data
 
     assert_equal(0, test_songs[:blank].total_tracks)
     assert_equal(3, test_songs[:no_flow].total_tracks)
@@ -75,7 +101,7 @@ class SongTest < Test::Unit::TestCase
   end
 
   def test_track_names
-    test_songs = generate_test_data()
+    test_songs = generate_test_data
 
     assert_equal([], test_songs[:blank].track_names)
     assert_equal(["bass.wav", "hh_closed.wav", "snare.wav"], test_songs[:no_flow].track_names)
@@ -98,9 +124,9 @@ class SongTest < Test::Unit::TestCase
   end
 
   def test_copy_ignoring_patterns_and_flow
-    test_songs = generate_test_data()
+    test_songs = generate_test_data
     original_song = test_songs[:example_no_kit]
-    cloned_song = original_song.copy_ignoring_patterns_and_flow()
+    cloned_song = original_song.copy_ignoring_patterns_and_flow
 
     assert_not_equal(cloned_song, original_song)
     assert_equal(cloned_song.tempo, original_song.tempo)
@@ -109,8 +135,8 @@ class SongTest < Test::Unit::TestCase
   end
 
   def test_split
-    test_songs = generate_test_data()
-    split_songs = test_songs[:example_with_kit].split()
+    test_songs = generate_test_data
+    split_songs = test_songs[:example_with_kit].split
 
     assert_equal(Hash, split_songs.class)
     assert_equal(6, split_songs.length)
@@ -141,20 +167,20 @@ class SongTest < Test::Unit::TestCase
   end
 
   def test_remove_unused_patterns
-    test_songs = generate_test_data()
+    test_songs = generate_test_data
 
     assert_equal(1, test_songs[:no_flow].patterns.length)
-    test_songs[:no_flow].remove_unused_patterns()
+    test_songs[:no_flow].remove_unused_patterns
     assert_equal({}, test_songs[:no_flow].patterns)
 
     assert_equal(3, test_songs[:example_no_kit].patterns.length)
-    test_songs[:example_no_kit].remove_unused_patterns()
+    test_songs[:example_no_kit].remove_unused_patterns
     assert_equal(3, test_songs[:example_no_kit].patterns.length)
     assert_equal(Hash, test_songs[:example_no_kit].patterns.class)
   end
 
   def test_to_yaml
-    test_songs = generate_test_data()
+    test_songs = generate_test_data
     kit = Kit.new("test/sounds", {"bass"     => "bass_mono_8.wav",
                                   "snare"    => "snare_mono_8.wav",
                                   "hhclosed" => "hh_closed_mono_8.wav",

data/test/songoptimizer_test.rb

@@ -50,14 +50,14 @@ Verse:
   - snare:  ..........X."
 
   def self.load_fixture(fixture_name)
-    SongParser.new().parse(FIXTURE_BASE_PATH, File.read("test/fixtures/#{fixture_name}"))
+    SongParser.new.parse(FIXTURE_BASE_PATH, File.read("test/fixtures/#{fixture_name}"))
   end
 
   def test_optimize
-    parser = SongParser.new()
+    parser = SongParser.new
     original_song, kit = parser.parse(File.dirname(__FILE__) + "/..", EXAMPLE_SONG_YAML)
 
-    optimizer = SongOptimizer.new()
+    optimizer = SongOptimizer.new
     optimized_song = optimizer.optimize(original_song, 4)
 
     assert_equal(optimized_song.tempo, 135)
@@ -122,11 +122,11 @@ Verse:
                                        :chorus_0, :chorus_4, :chorus_8, :chorus_12])
   end
 
-  def test_optimize_song_nondivisible_max_pattern_length()
-    parser = SongParser.new()
+  def test_optimize_song_nondivisible_max_pattern_length
+    parser = SongParser.new
     original_song, kit = parser.parse(File.dirname(__FILE__) + "/..", EXAMPLE_SONG_YAML_EMPTY_SUB_PATTERN)
 
-    optimizer = SongOptimizer.new()
+    optimizer = SongOptimizer.new
     optimized_song = optimizer.optimize(original_song, 7)
 
     pattern = optimized_song.patterns[:verse_0]
@@ -143,17 +143,17 @@ Verse:
 
   def test_pattern_collision
     original_song, kit = SongOptimizerTest.load_fixture("valid/optimize_pattern_collision.txt")
-    optimizer = SongOptimizer.new()
+    optimizer = SongOptimizer.new
     optimized_song = optimizer.optimize(original_song, 4)
 
     assert_equal([:verse2_0, :verse_0, :verse_20], optimized_song.patterns.keys.sort {|x, y| x.to_s <=> y.to_s })
   end
 
-  def test_optimize_song_containing_empty_pattern()
-    parser = SongParser.new()
+  def test_optimize_song_containing_empty_pattern
+    parser = SongParser.new
     original_song, kit = parser.parse(File.dirname(__FILE__) + "/..", EXAMPLE_SONG_YAML_EMPTY_SUB_PATTERN)
 
-    optimizer = SongOptimizer.new()
+    optimizer = SongOptimizer.new
     optimized_song = optimizer.optimize(original_song, 4)
 
     pattern = optimized_song.patterns[:verse_0]

data/test/songparser_test.rb

@@ -5,17 +5,23 @@ class SongParserTest < Test::Unit::TestCase
 
   # TODO: Add fixture for track with no rhythm
   VALID_FIXTURES =   [:no_tempo,
+                      :fractional_tempo,
                       :repeats_not_specified,
                       :pattern_with_overflow,
                       :example_no_kit,
                       :example_with_kit,
                       :example_with_empty_track,
                       :multiple_tracks_same_sound,
-                      :with_structure]
+                      :with_structure,
+                      :example_swung_8th,
+                      :example_swung_16th,
+                      :example_unswung]
 
   INVALID_FIXTURES = [:bad_repeat_count,
                       :bad_flow,
                       :bad_tempo,
+                      :bad_swing_rate_1,
+                      :bad_swing_rate_2,
                       :no_header,
                       :no_flow,
                       :pattern_with_no_tracks,
@@ -25,7 +31,7 @@ class SongParserTest < Test::Unit::TestCase
                       :sound_in_track_wrong_format]
 
   def self.load_fixture(fixture_name)
-    SongParser.new().parse(FIXTURE_BASE_PATH, File.read("test/fixtures/#{fixture_name}"))
+    SongParser.new.parse(FIXTURE_BASE_PATH, File.read("test/fixtures/#{fixture_name}"))
   end
 
   def self.generate_test_data
@@ -43,11 +49,14 @@ class SongParserTest < Test::Unit::TestCase
 
   # TODO: Add somes tests to validate the Kits
   def test_valid_parse
-    test_songs, test_kits = SongParserTest.generate_test_data()
+    test_songs, test_kits = SongParserTest.generate_test_data
 
     assert_equal(120, test_songs[:no_tempo].tempo)
     assert_equal([:verse], test_songs[:no_tempo].flow)
 
+    assert_equal(95.764, test_songs[:fractional_tempo].tempo)
+    assert_equal([:verse, :verse, :chorus, :chorus], test_songs[:fractional_tempo].flow)
+
     assert_equal(100, test_songs[:repeats_not_specified].tempo)
     assert_equal([:verse], test_songs[:repeats_not_specified].flow)
 
@@ -93,6 +102,39 @@ class SongParserTest < Test::Unit::TestCase
     assert_equal(1, song.patterns.length)
     assert_equal(1, song.patterns[:verse].tracks.length)
     assert_equal("X...X...", song.patterns[:verse].tracks["test/sounds/bass_mono_8.wav"].rhythm)
+
+    song = test_songs[:example_swung_8th]
+    assert_equal(180, song.tempo)
+    assert_equal([:verse, :verse, :chorus, :chorus], song.flow)
+    assert_equal(2, song.patterns.length)
+    assert_equal(2, song.patterns[:verse].tracks.length)
+    assert_equal("X.....X.....", song.patterns[:verse].tracks["bass"].rhythm)
+    assert_equal("....X.....X.", song.patterns[:verse].tracks["snare"].rhythm)
+    assert_equal(2, song.patterns[:chorus].tracks.length)
+    assert_equal("X.X.XXX.X.XX", song.patterns[:chorus].tracks["bass"].rhythm)
+    assert_equal("..X..X..X..X", song.patterns[:chorus].tracks["snare"].rhythm)
+
+    song = test_songs[:example_swung_16th]
+    assert_equal(180, song.tempo)
+    assert_equal([:verse, :verse, :chorus, :chorus], song.flow)
+    assert_equal(2, song.patterns.length)
+    assert_equal(2, song.patterns[:verse].tracks.length)
+    assert_equal("X.....X.....", song.patterns[:verse].tracks["bass"].rhythm)
+    assert_equal("...X.....X..", song.patterns[:verse].tracks["snare"].rhythm)
+    assert_equal(2, song.patterns[:chorus].tracks.length)
+    assert_equal("X.XX.XX.XX.X", song.patterns[:chorus].tracks["bass"].rhythm)
+    assert_equal("..X..X..X..X", song.patterns[:chorus].tracks["snare"].rhythm)
+
+    song = test_songs[:example_unswung]
+    assert_equal(120, song.tempo)
+    assert_equal([:verse, :verse, :chorus, :chorus], song.flow)
+    assert_equal(2, song.patterns.length)
+    assert_equal(2, song.patterns[:verse].tracks.length)
+    assert_equal("X...X...", song.patterns[:verse].tracks["bass"].rhythm)
+    assert_equal("..X...X.", song.patterns[:verse].tracks["snare"].rhythm)
+    assert_equal(2, song.patterns[:chorus].tracks.length)
+    assert_equal("XXXXXXXX", song.patterns[:chorus].tracks["bass"].rhythm)
+    assert_equal(".X.X.X.X", song.patterns[:chorus].tracks["snare"].rhythm)
   end
 
   def test_invalid_parse

data/test/track_test.rb

@@ -15,7 +15,7 @@ class TrackTest < Test::Unit::TestCase
   end
 
   def test_initialize
-    test_tracks = generate_test_data()
+    test_tracks = generate_test_data
 
     assert_equal([0], test_tracks[:blank].beats)
     assert_equal("bass", test_tracks[:blank].name)
@@ -40,13 +40,13 @@ class TrackTest < Test::Unit::TestCase
   end
 
   def test_step_count
-    test_tracks = generate_test_data()
-
-    assert_equal(0,  test_tracks[:blank].step_count())
-    assert_equal(1,  test_tracks[:solo].step_count())
-    assert_equal(4,  test_tracks[:with_overflow].step_count())
-    assert_equal(8,  test_tracks[:with_barlines].step_count())
-    assert_equal(4,  test_tracks[:placeholder].step_count())
-    assert_equal(32, test_tracks[:complicated].step_count())
+    test_tracks = generate_test_data
+
+    assert_equal(0,  test_tracks[:blank].step_count)
+    assert_equal(1,  test_tracks[:solo].step_count)
+    assert_equal(4,  test_tracks[:with_overflow].step_count)
+    assert_equal(8,  test_tracks[:with_barlines].step_count)
+    assert_equal(4,  test_tracks[:placeholder].step_count)
+    assert_equal(32, test_tracks[:complicated].step_count)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beats
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.3.0
 platform: ruby
 authors:
 - Joel Strait
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-31 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wavefile
@@ -36,6 +36,9 @@ files:
 - LICENSE
 - README.markdown
 - Rakefile
+- bin/beats
+- ext/mkrf_conf.rb
+- lib/beats.rb
 - lib/beats/audioengine.rb
 - lib/beats/audioutils.rb
 - lib/beats/beatsrunner.rb
@@ -45,9 +48,8 @@ files:
 - lib/beats/songoptimizer.rb
 - lib/beats/songparser.rb
 - lib/beats/track.rb
-- lib/beats.rb
+- lib/beats/transforms/song_swinger.rb
 - lib/wavefile/cachingwriter.rb
-- bin/beats
 - test/audioengine_test.rb
 - test/audioutils_test.rb
 - test/cachingwriter_test.rb
@@ -86,6 +88,8 @@ files:
 - test/fixtures/invalid/bad_flow.txt
 - test/fixtures/invalid/bad_repeat_count.txt
 - test/fixtures/invalid/bad_rhythm.txt
+- test/fixtures/invalid/bad_swing_rate_1.txt
+- test/fixtures/invalid/bad_swing_rate_2.txt
 - test/fixtures/invalid/bad_tempo.txt
 - test/fixtures/invalid/no_flow.txt
 - test/fixtures/invalid/no_header.txt
@@ -101,9 +105,13 @@ files:
 - test/fixtures/valid/example_no_kit.txt
 - test/fixtures/valid/example_stereo_16.txt
 - test/fixtures/valid/example_stereo_8.txt
+- test/fixtures/valid/example_swung_16th.txt
+- test/fixtures/valid/example_swung_8th.txt
+- test/fixtures/valid/example_unswung.txt
 - test/fixtures/valid/example_with_empty_track.txt
 - test/fixtures/valid/example_with_kit.txt
 - test/fixtures/valid/foo.txt
+- test/fixtures/valid/fractional_tempo.txt
 - test/fixtures/valid/multiple_tracks_same_sound.txt
 - test/fixtures/valid/no_tempo.txt
 - test/fixtures/valid/optimize_pattern_collision.txt
@@ -115,6 +123,7 @@ files:
 - test/integration_test.rb
 - test/kit_test.rb
 - test/pattern_test.rb
+- test/song_swinger_test.rb
 - test/song_test.rb
 - test/songoptimizer_test.rb
 - test/songparser_test.rb
@@ -207,7 +216,6 @@ files:
 - test/sounds/tom4_stereo_8.wav
 - test/sounds/tone.wav
 - test/track_test.rb
-- ext/mkrf_conf.rb
 homepage: http://beatsdrummachine.com/
 licenses: []
 metadata: {}
@@ -227,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A command-line drum machine. Feed it a song notated in YAML, and it will
@@ -271,6 +279,8 @@ test_files:
 - test/fixtures/invalid/bad_flow.txt
 - test/fixtures/invalid/bad_repeat_count.txt
 - test/fixtures/invalid/bad_rhythm.txt
+- test/fixtures/invalid/bad_swing_rate_1.txt
+- test/fixtures/invalid/bad_swing_rate_2.txt
 - test/fixtures/invalid/bad_tempo.txt
 - test/fixtures/invalid/no_flow.txt
 - test/fixtures/invalid/no_header.txt
@@ -286,9 +296,13 @@ test_files:
 - test/fixtures/valid/example_no_kit.txt
 - test/fixtures/valid/example_stereo_16.txt
 - test/fixtures/valid/example_stereo_8.txt
+- test/fixtures/valid/example_swung_16th.txt
+- test/fixtures/valid/example_swung_8th.txt
+- test/fixtures/valid/example_unswung.txt
 - test/fixtures/valid/example_with_empty_track.txt
 - test/fixtures/valid/example_with_kit.txt
 - test/fixtures/valid/foo.txt
+- test/fixtures/valid/fractional_tempo.txt
 - test/fixtures/valid/multiple_tracks_same_sound.txt
 - test/fixtures/valid/no_tempo.txt
 - test/fixtures/valid/optimize_pattern_collision.txt
@@ -300,6 +314,7 @@ test_files:
 - test/integration_test.rb
 - test/kit_test.rb
 - test/pattern_test.rb
+- test/song_swinger_test.rb
 - test/song_test.rb
 - test/songoptimizer_test.rb
 - test/songparser_test.rb