beats 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ae934eac074a47b7bb5f587fd96eb457f0ddabfbf18f5667e838dd01832c247
-  data.tar.gz: ee54703a136d795679807ea67f4f5cb79532f090d0c641f924590a036a35b2d9
+  metadata.gz: 387b94eb7731f5bf659134c0e6ceb9d0ba01947e130a64a18517fde233a8a958
+  data.tar.gz: c2b0b0b67d07f471861b5b457b522739f0cdc68f6240e66ee999e935633ebfd0
 SHA512:
-  metadata.gz: 2f2e931c783acab297d17187cadd51ebbba9cd5bd55ec9a81a6fddd15b0d95b8b03027508cbed4e3b07740a3e0d04d25e9e000b06074b916bc23cc6e4e0df3ed
-  data.tar.gz: f6fe7883c7a9f21d62d252eec3f646aa2af5f47acda24d20dc43c8761fcf84c87716a2cbc53248fdcf31f4c7832cb5d24353ea49520ada5555a6a9cb85234898
+  metadata.gz: fe882750e5035fb61aed261c9d7b7e61f3d048da16ee09aaeca089c07aba44abdc15ccceec8f0cc7b7885ddd1c997f3eb19d6abc46d64891aac48996a396c35b
+  data.tar.gz: 5f9a9ffcc09a015fd8bdd00a6308be9af14029924ba9d65967b0fa6d5b9a37c3545155b3ad51f79d8328770310788e82cafd49bb4314272686b7f0dbc9504240

data/LICENSE

@@ -1,24 +1,22 @@
-== Beats Drum Machine
+Copyright (c) 2010-19 Joel Strait
 
-# Copyright (c) 2010-18 Joel Strait
-#
-# Permission is hereby granted, free of charge, to any person
-# obtaining a copy of this software and associated documentation
-# files (the "Software"), to deal in the Software without
-# restriction, including without limitation the rights to use,
-# copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the
-# Software is furnished to do so, subject to the following
-# conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-# OTHER DEALINGS IN THE SOFTWARE.
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -35,7 +35,7 @@ For more, check out [beatsdrummachine.com](https://beatsdrummachine.com)
 Installation
 ------------
 
-To install the latest stable version (2.1.1) from [rubygems.org](https://rubygems.org/gems/beats), run the following from the command line:
+To install the latest stable version (2.1.2) from [rubygems.org](https://rubygems.org/gems/beats), run the following from the command line:
 
     gem install beats
 
@@ -49,25 +49,17 @@ Beats is not very useful unless you have some sounds to use with it. You can dow
 Usage
 -----
 
-Beats runs from the command-line. Run `beats -h` to see the available options. For more detailed instructions, visit [https://github.com/jstrait/beats/wiki/Usage](https://github.com/jstrait/beats/wiki/Usage) on the [Beats Wiki](https://github.com/jstrait/beats/wiki).
+Beats runs from the command-line. Run `beats -h` to see the available options. For more detailed instructions, visit <https://beatsdrummachine.com/usage/>.
 
-Check out [this tutorial at beatsdrummachine.com](https://beatsdrummachine.com/tutorial/) to see an example of how to create a beat from sratch.
+Check out [this tutorial at beatsdrummachine.com](https://beatsdrummachine.com/tutorial/) to see an example of how to create a beat from scratch.
 
 
-What's New in v2.1.1
+What's New in v2.1.2
 --------------------
 
-The latest version of Beats is 2.1.1, released on June 29, 2018. It contains these changes:
+The latest version of Beats is 2.1.2, released on December 18, 2019. It contains these changes:
 
-* Several error messages are improved to be more accurate or specific.
-* **Bug fix**: Songs can now use *.wav files with more than 2 channels. Previously, using a sound with more than 2 channels would cause a fatal `Invalid sample data array in AudioUtils.normalize()` error.
-* **Bug fix**: If a sound is defined multiple times in a Kit, the final definition should be used as the winner. However, previously this did not occur if the earlier definition was for a composite sound. For example, with this Kit:
-
-      Kit:
-        - sound: [sound1.wav, sound2.wav]
-        - sound: sound3.wav
-
-  `sound` will now be bound to `sound3.wav`, not `[sound1.wav, sound2.wav]`.
+* Several confusing/unhelpful errors shown due to an error in an input file have been improved. For example, if a pattern has the invalid name "4", the error message will now be `Pattern name '4' is not valid. It must be a value that will be parsed from YAML as a String.`, instead of `undefined method 'downcase' for 4:Integer`.
 
 For info about previous releases, visit https://github.com/jstrait/beats/releases.
 
@@ -92,7 +84,7 @@ To run the tests:
 Found a Bug? Have a Suggestion? Want to Contribute?
 ---------------------------------------------------
 
-Contact me (Joel Strait) by sending a GitHub message or opening a GitHub issue.
+Contact me (Joel Strait) by opening a GitHub issue.
 
 
 License

data/Rakefile

@@ -1,6 +1,6 @@
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.libs << 'lib' << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "lib" << "test"
+  t.pattern = "test/**/*_test.rb"
 end

data/bin/beats

@@ -15,24 +15,24 @@ def parse_options
   optparse = OptionParser.new do |opts|
     opts.banner = "usage: beats [options] input_file [output_file]"
 
-    opts.on('-s', '--split', "Save each track to an individual wave file") do
+    opts.on("-s", "--split", "Save each track to an individual wave file") do
       options[:split] = true
     end
 
-    opts.on('-p', '--pattern PATTERN_NAME', "Output a single pattern instead of the whole song" ) do |p|
+    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|
+    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
+    opts.on("-v", "--version", "Display version number and exit") do
       puts "Beats Drum Machine #{Beats::VERSION}"
       exit
     end
 
-    opts.on( '-h', '--help', "Display this screen and exit" ) do
+    opts.on("-h", "--help", "Display this screen and exit") do
       puts opts
       exit
     end

data/lib/beats.rb

@@ -1,21 +1,21 @@
-require 'yaml'
+require "yaml"
 
 gem "wavefile", "=0.8.1"
-require 'wavefile'
-require 'wavefile/caching_writer'
+require "wavefile"
+require "wavefile/caching_writer"
 
-require 'beats/audio_engine'
-require 'beats/audio_utils'
-require 'beats/beats_runner'
-require 'beats/kit'
-require 'beats/kit_builder'
-require 'beats/pattern'
-require 'beats/song'
-require 'beats/song_parser'
-require 'beats/song_optimizer'
-require 'beats/track'
-require 'beats/transforms/song_swinger'
+require "beats/audio_engine"
+require "beats/audio_utils"
+require "beats/beats_runner"
+require "beats/kit"
+require "beats/kit_builder"
+require "beats/pattern"
+require "beats/song"
+require "beats/song_parser"
+require "beats/song_optimizer"
+require "beats/track"
+require "beats/transforms/song_swinger"
 
 module Beats
-  VERSION = "2.1.1"
+  VERSION = "2.1.2"
 end

data/lib/beats/kit.rb

@@ -2,7 +2,7 @@ module Beats
   class Kit
     class LabelNotFoundError < RuntimeError; end
 
-    PLACEHOLDER_TRACK_NAME = 'empty_track_placeholder_name_234hkj32hjk4hjkhds23'
+    PLACEHOLDER_TRACK_NAME = "empty_track_placeholder_name_234hkj32hjk4hjkhds23"
 
     def initialize(items, num_channels, bits_per_sample)
       @items = items

data/lib/beats/kit_builder.rb

@@ -27,13 +27,17 @@ module Beats
 
         filenames.each do |filename|
           unless filename.is_a?(String)
-            raise SoundFileNotFoundError, "The Kit sound '#{label}' contains an invalid file: '#{filename}'"
+            raise SoundFileNotFoundError, "Kit sound '#{label}' contains an invalid filename: '#{filename}'. It must be a value that will be parsed from YAML as a String."
           end
           composite_replacement = "#{label}-#{File.basename(filename, ".*")}"
           @labels_to_filenames[composite_replacement] = absolute_file_name(filename)
           @composite_replacements[label] << composite_replacement
         end
       else
+        unless filenames.is_a?(String)
+          raise SoundFileNotFoundError, "Kit sound '#{label}' has an invalid filename: '#{filenames}'. It must be a value that will be parsed from YAML as a String."
+        end
+
         @labels_to_filenames[label] = absolute_file_name(filenames)
         @composite_replacements.delete(label)
       end

data/lib/beats/song.rb

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

data/lib/beats/song_parser.rb

@@ -86,11 +86,9 @@ Song:
         raw_song_definition = YAML.load(raw_yaml_string)
       rescue Psych::SyntaxError => detail
         raise ParseError, "Syntax error in YAML file: #{detail}"
-      rescue ArgumentError => detail
-        raise ParseError, "Syntax error in YAML file: #{detail}"
       end
 
-      header_keys = raw_song_definition.keys.select {|key| key.downcase == "song" }
+      header_keys = raw_song_definition.keys.select {|key| key.is_a?(String) && key.downcase == "song" }
 
       if header_keys.empty?
         raise ParseError, NO_SONG_HEADER_ERROR_MSG
@@ -115,6 +113,10 @@ Song:
     def self.add_kit_sounds_from_kit(kit_builder, raw_kit)
       return if raw_kit.nil?
 
+      unless raw_kit.is_a?(Array)
+        raise ParseError, "Kit is not an array. Make sure each sound in the Kit is placed on new indented line prefixed with a '-'"
+      end
+
       # Add sounds defined in the Kit section of the song header
       # Converts [{a=>1}, {b=>2}, {c=>3}] from raw YAML to {a=>1, b=>2, c=>3}
       raw_kit.each do |kit_item|
@@ -137,14 +139,26 @@ Song:
 
     def self.add_patterns_to_song(song, kit_builder, raw_patterns)
       raw_patterns.each do |pattern_name, raw_tracks|
+        if !pattern_name.is_a?(String)
+          raise ParseError, "Pattern name '#{pattern_name}' is not valid. It must be a value that will be parsed from YAML as a String."
+        end
+
         if raw_tracks.nil?
           # TODO: Possibly allow if pattern not referenced in the Flow, or has 0 repeats?
           raise ParseError, "Pattern '#{pattern_name}' has no tracks. It needs at least one."
         end
 
+        if !raw_tracks.is_a?(Array)
+          raise ParseError, "Tracks in pattern '#{pattern_name}' are not an Array. Make sure each track is placed on new indented line prefixed with a '-'"
+        end
+
         tracks = []
 
-        raw_tracks.each do |raw_track|
+        raw_tracks.each_with_index do |raw_track, index|
+          if !raw_track.is_a?(Hash)
+            raise ParseError, "Track ##{index + 1} in pattern '#{pattern_name}' is incomplete. Must be in form '- <kit/file name>: <rhythm>'"
+          end
+
           track_names = raw_track.keys.first
           rhythm = raw_track.values.first
 
@@ -158,7 +172,7 @@ Song:
 
           track_names.map! do |track_name|
             unless track_name.is_a?(String)
-              raise ParseError, "'#{track_name}' in pattern '#{pattern_name}' is not a valid track sound"
+              raise ParseError, "'#{track_name}' in pattern '#{pattern_name}' is not a valid filename/kit sound. It must be a value that will be parsed from YAML as a String."
             end
             kit_builder.composite_replacements[track_name] || track_name
           end
@@ -177,34 +191,42 @@ Song:
     def self.set_song_flow(song, raw_flow)
       flow = []
 
+      if !raw_flow.is_a?(Array)
+        raise ParseError, "Song flow is not an array. Make sure each section of the flow is placed on new indented line prefixed with a '-'"
+      end
+
       raw_flow.each do |pattern_item|
-        if pattern_item.class == String
-          pattern_item = {pattern_item => "x1"}
+        if !pattern_item.is_a?(Hash)
+          if pattern_item.is_a?(String)
+            pattern_item = {pattern_item => "x1"}
+          else
+            raise ParseError, "'#{pattern_item}' is invalid flow section; must be in form '- <pattern name>: <repeat count>'"
+          end
         end
 
         pattern_name = pattern_item.keys.first
+        if !pattern_name.is_a?(String)
+          raise ParseError, "Pattern name '#{pattern_name}' in flow is not valid. It must be a value that will be parsed from YAML as a String."
+        end
         pattern_name_sym = pattern_name.downcase.to_sym
 
-        # Convert the number of repeats from a String such as "x4" into an integer such as 4.
-        multiples_str = pattern_item[pattern_name]
-        multiples_str.slice!(0)
-        multiples = multiples_str.to_i
+        repeat_count_str = pattern_item[pattern_name]
 
-        unless multiples_str.match(/[^0-9]/).nil?
+        unless repeat_count_str.is_a?(String) && repeat_count_str.match(/^x[0-9]+$/) != nil
           raise ParseError,
-                "'#{multiples_str}' is an invalid number of repeats for pattern '#{pattern_name}'. Number of repeats should be a whole number."
-        else
-          if multiples < 0
-            raise ParseError, "'#{multiples_str}' is an invalid number of repeats for pattern '#{pattern_name}'. Must be 0 or greater."
-          elsif multiples > 0 && !song.patterns.has_key?(pattern_name_sym)
-            # This test is purposefully designed to only throw an error if the number of repeats is greater
-            # than 0. This allows you to specify an undefined pattern in the flow with "x0" repeats.
-            # This can be convenient for defining the flow before all patterns have been added to the song file.
-            raise ParseError, "Song flow includes non-existent pattern: '#{pattern_name}'"
-          end
+                "'#{repeat_count_str}' is an invalid number of repeats for pattern '#{pattern_name}'. Number of repeats must be a whole number >= 0, prefixed with 'x'."
+        end
+
+        repeat_count = repeat_count_str[1..-1].to_i
+
+        if repeat_count > 0 && !song.patterns.has_key?(pattern_name_sym)
+          # This test is purposefully designed to only throw an error if the number of repeats is greater
+          # than 0. This allows you to specify an undefined pattern in the flow with "x0" repeats.
+          # This can be convenient for defining the flow before all patterns have been added to the song file.
+          raise ParseError, "Song flow includes non-existent pattern: '#{pattern_name}'"
         end
 
-        multiples.times { flow << pattern_name_sym }
+        repeat_count.times { flow << pattern_name_sym }
       end
 
       song.flow = flow

data/test/audio_engine_test.rb

@@ -1,4 +1,4 @@
-require 'includes'
+require "includes"
 
 # Make private methods public for testing
 class MockAudioEngine < AudioEngine

data/test/audio_utils_test.rb

@@ -1,4 +1,4 @@
-require 'includes'
+require "includes"
 
 class AudioUtilsTest < Minitest::Test
   def test_composite

data/test/caching_writer_test.rb

@@ -1,4 +1,4 @@
-require 'includes'
+require "includes"
 
 # Basic tests for CachingWriter; the integration tests test it more thoroughly.
 class CachingWriterTest < Minitest::Test

data/test/fixtures/invalid/flow_invalid_repeat_count_prefix.txt

@@ -0,0 +1,8 @@
+# Invalid song, since the number of repeats for pattern Verse has an invalid prefix
+Song:
+  Tempo: 100
+  Flow:
+    - Verse:  ax2
+
+Verse:
+  - test/sounds/bass_mono_8.wav:  X...X...X...XX..X...X...XX..X...

data/test/fixtures/invalid/flow_invalid_repeat_count_suffix.txt

@@ -0,0 +1,8 @@
+# Invalid song, since the number of repeats for pattern Verse has an invalid suffix
+Song:
+  Tempo: 100
+  Flow:
+    - Verse:  x2a
+
+Verse:
+  - test/sounds/bass_mono_8.wav:  X...X...X...XX..X...X...XX..X...

data/test/fixtures/invalid/{bad_repeat_count.txt → flow_missing_repeat_count.txt}

@@ -1,8 +1,8 @@
-# Invalid song, since the number of repeats for pattern Verse is not a number
+# Invalid song, since the number of repeats for pattern Verse is missing
 Song:
   Tempo: 100
   Flow:
-    - Verse:  x2a
+    - Verse:
 
 Verse:
-  - test/sounds/bass_mono_8.wav:  X...X...X...XX..X...X...XX..X...
+  - test/sounds/bass_mono_8.wav:  X...X...X...XX..X...X...XX..X...

data/test/fixtures/invalid/flow_negative_repeat_count.txt

@@ -0,0 +1,8 @@
+# Invalid song, since the flow repeat count is less than 0
+Song:
+  Tempo: 100
+  Flow:
+    - Verse:  x-2
+
+Verse:
+  - test/sounds/bass_mono_8.wav:  X...X...X...XX..X...X...XX..X...

data/test/fixtures/invalid/flow_non_string_repeat_count.txt

@@ -0,0 +1,8 @@
+# Invalid song, since the flow repeat count is not a String like "x4"
+Song:
+  Tempo: 100
+  Flow:
+    - Verse:  [1, 2, 3]
+
+Verse:
+  - test/sounds/bass_mono_8.wav:  X...X...X...XX..X...X...XX..X...

data/test/fixtures/invalid/flow_not_an_array.txt

@@ -0,0 +1,15 @@
+# Invalid song, since the flow is not an array (i.e., each line is not prefixed with "-")
+Song:
+  Tempo: 100
+  Flow:
+    Verse:  x2
+    Chorus: x2
+    Verse:  x2
+    Chorus: x2
+
+
+Verse:
+  - test/sounds/bass_mono_8.wav:  X...X...
+
+Chorus:
+  - test/sounds/snare_mono_8.wav:  X...X...

data/test/fixtures/invalid/flow_pattern_name_not_a_string.txt

@@ -0,0 +1,15 @@
+# Invalid song, a pattern used in the flow has a name which will not be parsed as a String
+Song:
+  Tempo: 120
+  Flow:
+    - Verse: x2
+    - 4: x2       # Invalid pattern name!
+  Kit:
+    - bass:       ../../sounds/bass_mono_8.wav
+    - snare:      ../../sounds/snare_mono_8.wav
+    - hh_closed:  ../../sounds/hh_closed_mono_8.wav
+    - agogo:      ../../sounds/agogo_high_mono_8.wav
+
+Verse:
+  - bass:       X...X...X...X...
+  - snare:      ..............X.