mtk 0.0.2 → 0.0.3

data/spec/mtk/{pattern → patterns}/function_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe MTK::Pattern::Function do
+describe MTK::Patterns::Function do
 
-  FUNCTION = MTK::Pattern::Function
+  FUNCTION = MTK::Patterns::Function
 
   describe "#next" do
     it "calls a lambda to produce elements" do
@@ -35,7 +35,7 @@ describe MTK::Pattern::Function do
     end
 
     it "calls a 3-arg lambda with the previous value, function call count (starting from 0), and element count (starting from 0)" do
-      function = FUNCTION.new lambda{|prev,call_index,elem_index| prev.nil? ? MTK::Pattern.Sequence(1,2,3,4) : [call_index,elem_index] }
+      function = FUNCTION.new lambda{|prev,call_index,elem_index| prev.nil? ? MTK::Patterns.Sequence(1,2,3,4) : [call_index,elem_index] }
       function.next.should == 1
       function.next.should == 2
       function.next.should == 3
@@ -44,7 +44,7 @@ describe MTK::Pattern::Function do
     end
 
     it "can generate other Patterns, which will be iterated over before re-calling the function" do
-      function = FUNCTION.new lambda{|prev,index| MTK::Pattern.Sequence(index,2,3) }
+      function = FUNCTION.new lambda{|prev,index| MTK::Patterns.Sequence(index,2,3) }
       function.next.should == 0
       function.next.should == 2
       function.next.should == 3
@@ -67,66 +67,53 @@ describe MTK::Pattern::Function do
 end
 
 
-describe MTK::Pattern do
+describe MTK::Patterns do
+
+  let(:mock_lambda) { lambda{|_|:mock_value} }
 
   describe "#Function" do
     it "creates a Function" do
-      MTK::Pattern.Function(nil).should be_a MTK::Pattern::Function
+      MTK::Patterns.Function(nil).should be_a MTK::Patterns::Function
     end
 
     it "sets #elements from the varargs" do
-      MTK::Pattern.Function(:mock_lambda).function.should == :mock_lambda
-    end
-
-    it "does not set a type" do
-      MTK::Pattern.Function(:mock_lambda).type.should be_nil
+      MTK::Patterns.Function(:mock_lambda).function.should == :mock_lambda
     end
 
     it "doesn't wrap a lambda in the varargs Array" do
-      function = MTK::Pattern.Function( lambda{ 1 + 1 } )
+      function = MTK::Patterns.Function( lambda{ 1 + 1 } )
       function.next.should == 2
     end
   end
 
   describe "#PitchFunction" do
     it "creates a Function" do
-      MTK::Pattern.PitchFunction(:mock_lambda).should be_a MTK::Pattern::Function
+      MTK::Patterns.PitchFunction(mock_lambda).should be_a MTK::Patterns::Function
     end
 
     it "sets #elements from the varargs" do
-      MTK::Pattern.PitchFunction(:mock_lambda).function.should == :mock_lambda
-    end
-
-    it "sets #type to :pitch" do
-      MTK::Pattern.PitchFunction([]).type.should == :pitch
+      func = mock_lambda
+      MTK::Patterns.PitchFunction(func).function.should == func
     end
   end
 
   describe "#IntensityFunction" do
     it "creates a Function" do
-      MTK::Pattern.IntensityFunction(:mock_lambda).should be_a MTK::Pattern::Function
+      MTK::Patterns.IntensityFunction(mock_lambda).should be_a MTK::Patterns::Function
     end
 
     it "sets #elements from the varargs" do
-      MTK::Pattern.IntensityFunction(:mock_lambda).function.should == :mock_lambda
-    end
-
-    it "sets #type to :pitch" do
-      MTK::Pattern.IntensityFunction([]).type.should == :intensity
+      MTK::Patterns.IntensityFunction(mock_lambda).function.should == mock_lambda
     end
   end
 
   describe "#DurationFunction" do
     it "creates a Function" do
-      MTK::Pattern.DurationFunction(:mock_lambda).should be_a MTK::Pattern::Function
+      MTK::Patterns.DurationFunction(mock_lambda).should be_a MTK::Patterns::Function
     end
 
     it "sets #elements from the varargs" do
-      MTK::Pattern.DurationFunction(:mock_lambda).function.should == :mock_lambda
-    end
-
-    it "sets #type to :pitch" do
-      MTK::Pattern.DurationFunction([]).type.should == :duration
+      MTK::Patterns.DurationFunction(mock_lambda).function.should == mock_lambda
     end
   end
 

data/spec/mtk/{pattern → patterns}/lines_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe MTK::Pattern::Lines do
+describe MTK::Patterns::Lines do
 
-  LINES = MTK::Pattern::Lines
+  LINES = MTK::Patterns::Lines
 
   let(:elements) { [0, [10,5], [5,10]] }
   let(:lines) { LINES.new elements }
@@ -32,61 +32,45 @@ describe MTK::Pattern::Lines do
 end
 
 
-describe MTK::Pattern do
+describe MTK::Patterns do
 
   describe "#Lines" do
     it "creates a Lines" do
-      MTK::Pattern.Lines(1,2,3).should be_a MTK::Pattern::Lines
+      MTK::Patterns.Lines(1,2,3).should be_a MTK::Patterns::Lines
     end
 
     it "sets #elements from the varargs" do
-      MTK::Pattern.Lines(1,2,3).elements.should == [1,2,3]
-    end
-
-    it "does not set a type" do
-      MTK::Pattern.Lines(1,2,3).type.should be_nil
+      MTK::Patterns.Lines(1,2,3).elements.should == [1,2,3]
     end
   end
 
   describe "#PitchLines" do
     it "creates a Lines" do
-      MTK::Pattern.PitchLines(1,2,3).should be_a MTK::Pattern::Lines
+      MTK::Patterns.PitchLines(1,2,3).should be_a MTK::Patterns::Lines
     end
 
     it "sets #elements from the varargs" do
-      MTK::Pattern.PitchLines(1,2,3).elements.should == [1,2,3]
-    end
-
-    it "sets #type to :pitch" do
-      MTK::Pattern.PitchLines([]).type.should == :pitch
+      MTK::Patterns.PitchLines(1,2,3).elements.should == [Pitch(1),Pitch(2),Pitch(3)]
     end
   end
 
   describe "#IntensityLines" do
     it "creates a Lines" do
-      MTK::Pattern.IntensityLines(1,2,3).should be_a MTK::Pattern::Lines
+      MTK::Patterns.IntensityLines(1,2,3).should be_a MTK::Patterns::Lines
     end
 
     it "sets #elements from the varargs" do
-      MTK::Pattern.IntensityLines(1,2,3).elements.should == [1,2,3]
-    end
-
-    it "sets #type to :pitch" do
-      MTK::Pattern.IntensityLines([]).type.should == :intensity
+      MTK::Patterns.IntensityLines(1,2,3).elements.should == [Intensity(1),Intensity(2),Intensity(3)]
     end
   end
 
   describe "#DurationLines" do
     it "creates a Lines" do
-      MTK::Pattern.DurationLines(1,2,3).should be_a MTK::Pattern::Lines
+      MTK::Patterns.DurationLines(1,2,3).should be_a MTK::Patterns::Lines
     end
 
     it "sets #elements from the varargs" do
-      MTK::Pattern.DurationLines(1,2,3).elements.should == [1,2,3]
-    end
-
-    it "sets #type to :pitch" do
-      MTK::Pattern.DurationLines([]).type.should == :duration
+      MTK::Patterns.DurationLines(1,2,3).elements.should == [Duration(1),Duration(2),Duration(3)]
     end
   end
 

data/spec/mtk/{pattern → patterns}/palindrome_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe MTK::Pattern::Palindrome do
+describe MTK::Patterns::Palindrome do
 
-  PALINDROME = MTK::Pattern::Palindrome
+  PALINDROME = MTK::Patterns::Palindrome
 
   describe "#next" do
     it "reverses direction when the ends of the list are reached" do
@@ -20,14 +20,14 @@ describe MTK::Pattern::Palindrome do
     end
 
     it "enumerates nested sequences" do
-      palindrome = PALINDROME.new [1, MTK::Pattern.Sequence(2,3), 4]
+      palindrome = PALINDROME.new [1, MTK::Patterns.Sequence(2,3), 4]
       nexts = []
       10.times { nexts << palindrome.next }
       nexts.should == [1,2,3,4, 2,3,1, 2,3,4] # note sequence goes forward in both directions!
     end
 
     it "enumerates nested sequences, and repeats the last element" do
-      palindrome = PALINDROME.new [1, MTK::Pattern.Sequence(2,3), 4], :repeat_ends => true
+      palindrome = PALINDROME.new [1, MTK::Patterns.Sequence(2,3), 4], :repeat_ends => true
       nexts = []
       9.times { nexts << palindrome.next }
       nexts.should == [1,2,3,4, 4,2,3,1, 1] # note sequence goes forward in both directions!
@@ -63,61 +63,45 @@ describe MTK::Pattern::Palindrome do
 end
 
 
-describe MTK::Pattern do
+describe MTK::Patterns do
 
   describe "#Palindrome" do
     it "creates a Palindrome" do
-      MTK::Pattern.Palindrome(1,2,3).should be_a MTK::Pattern::Palindrome
+      MTK::Patterns.Palindrome(1,2,3).should be_a MTK::Patterns::Palindrome
     end
 
     it "sets #elements from the varargs" do
-      MTK::Pattern.Palindrome(1,2,3).elements.should == [1,2,3]
-    end
-
-    it "does not set a type" do
-      MTK::Pattern.Palindrome(1,2,3).type.should be_nil
+      MTK::Patterns.Palindrome(1,2,3).elements.should == [1,2,3]
     end
   end
 
   describe "#PitchPalindrome" do
     it "creates a Palindrome" do
-      MTK::Pattern.PitchPalindrome(1,2,3).should be_a MTK::Pattern::Palindrome
+      MTK::Patterns.PitchPalindrome(1,2,3).should be_a MTK::Patterns::Palindrome
     end
 
     it "sets #elements from the varargs" do
-      MTK::Pattern.PitchPalindrome(1,2,3).elements.should == [1,2,3]
-    end
-
-    it "sets #type to :pitch" do
-      MTK::Pattern.PitchPalindrome([]).type.should == :pitch
+      MTK::Patterns.PitchPalindrome(1,2,3).elements.should == [Pitch(1),Pitch(2),Pitch(3)]
     end
   end
 
   describe "#IntensityPalindrome" do
     it "creates a Palindrome" do
-      MTK::Pattern.IntensityPalindrome(1,2,3).should be_a MTK::Pattern::Palindrome
+      MTK::Patterns.IntensityPalindrome(1,2,3).should be_a MTK::Patterns::Palindrome
     end
 
     it "sets #elements from the varargs" do
-      MTK::Pattern.IntensityPalindrome(1,2,3).elements.should == [1,2,3]
-    end
-
-    it "sets #type to :pitch" do
-      MTK::Pattern.IntensityPalindrome([]).type.should == :intensity
+      MTK::Patterns.IntensityPalindrome(1,2,3).elements.should == [Intensity(1),Intensity(2),Intensity(3)]
     end
   end
 
   describe "#DurationPalindrome" do
     it "creates a Palindrome" do
-      MTK::Pattern.DurationPalindrome(1,2,3).should be_a MTK::Pattern::Palindrome
+      MTK::Patterns.DurationPalindrome(1,2,3).should be_a MTK::Patterns::Palindrome
     end
 
     it "sets #elements from the varargs" do
-      MTK::Pattern.DurationPalindrome(1,2,3).elements.should == [1,2,3]
-    end
-
-    it "sets #type to :pitch" do
-      MTK::Pattern.DurationPalindrome([]).type.should == :duration
+      MTK::Patterns.DurationPalindrome(1,2,3).elements.should == [Duration(1),Duration(2),Duration(3)]
     end
   end
 

data/spec/mtk/patterns/pattern_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe MTK::Patterns::Pattern do
+
+  PATTERN = MTK::Patterns::Pattern
+
+  let(:elements) { [1,2,3] }
+
+
+  describe "@min_elements" do
+    it "is the :min_elements option the pattern was constructed with" do
+      PATTERN.new([], min_elements: 1).min_elements.should == 1
+    end
+
+    it "is nil by default" do
+      PATTERN.new([]).min_elements.should be_nil
+    end
+
+    it "prevents a StopIteration error until min_elements have been emitted (overriding max_elements if necessary)" do
+      pattern = PATTERN.new([1,2,3], min_elements: 5, max_elements: 3)
+      5.times{ pattern.next }
+      lambda{ pattern.next }.should raise_error StopIteration
+    end
+
+    it "sets exactly how many elements will be emitted when set to the same values as max_elements" do
+      pattern = PATTERN.new([1,2,3], min_elements: 5, max_elements: 5)
+      5.times{ pattern.next }
+      lambda{ pattern.next }.should raise_error StopIteration
+    end
+
+    it "is maintained when applying Collection operations" do
+      PATTERN.new(elements, min_elements: 2).reverse.min_elements.should == 2
+    end
+  end
+
+  describe '#min_elements_unmet?' do
+    it "is true until min_elements have been emitted" do
+      pattern = PATTERN.new([:anything], min_elements:  5)
+      5.times { pattern.min_elements_unmet?.should be_true and pattern.next }
+      pattern.min_elements_unmet?.should be_false
+    end
+
+    it "is always false if min_elements is not set" do
+      pattern = PATTERN.new([:anything], min_elements: nil)
+      5.times { pattern.min_elements_unmet?.should be_false and pattern.next }
+    end
+
+    it "is always false if min_elements is 0" do
+      pattern = PATTERN.new([:anything], min_elements: 0)
+      5.times { pattern.min_elements_unmet?.should be_false and pattern.next }
+    end
+  end
+
+
+  describe "@max_elements" do
+    it "is the :max_elements option the pattern was constructed with" do
+      PATTERN.new([], max_elements: 1).max_elements.should == 1
+    end
+
+    it "is nil by default" do
+      PATTERN.new([]).max_elements.should be_nil
+    end
+
+    it "causes a StopIteration exception once max_elements have been emitted" do
+      pattern = PATTERN.new([:anything], max_elements: 5)
+      5.times { pattern.next }
+      lambda { pattern.next }.should raise_error
+    end
+
+    it "raises a StopIteration error when a nested pattern has emitted more than max_elements" do
+      pattern = PATTERN.new([Patterns.Cycle(1,2)], max_elements: 5)
+      5.times{ pattern.next }
+      lambda{ pattern.next }.should raise_error StopIteration
+    end
+
+    it "is maintained when applying Collection operations" do
+      PATTERN.new(elements, max_elements: 2).reverse.max_elements.should == 2
+    end
+  end
+
+
+  describe '#max_elements_exceeded?' do
+    it "is false until max_elements have been emitted" do
+      pattern = PATTERN.new([:anything], max_elements: 5)
+      5.times { pattern.max_elements_exceeded?.should be_false and pattern.next }
+      pattern.max_elements_exceeded?.should be_true
+    end
+
+    it "is always false when max_elements is not set" do
+      pattern = PATTERN.new([:anything], max_elements: nil)
+      5.times { pattern.max_elements_exceeded?.should be_false and pattern.next }
+    end
+  end
+
+
+  describe "@max_cycles" do
+    it "is the :max_cycles option the pattern was constructed with" do
+      PATTERN.new([], max_cycles: 2).max_cycles.should == 2
+    end
+
+    it "is 1 by default" do
+      PATTERN.new([]).max_cycles.should == 1
+    end
+
+    it "is maintained when applying Collection operations" do
+      PATTERN.new(elements, max_cycles: 2).reverse.max_cycles.should == 2
+    end
+  end
+
+
+  describe "#next" do
+    it "raises StopIteration if elements is empty" do
+      lambda{ PATTERN.new([]).next }.should raise_error StopIteration
+    end
+  end
+
+
+  describe "#==" do
+    it "is true if the elements and types are equal" do
+      PATTERN.new(elements, :type => :some_type).should == PATTERN.new(elements, :type => :some_type)
+    end
+
+    it "is false if the elements are not equal" do
+      PATTERN.new(elements, :type => :some_type).should_not == PATTERN.new(elements + [4], :type => :some_type)
+    end
+
+    it "is false if the types are not equal" do
+      PATTERN.new(elements, :type => :some_type).should_not == PATTERN.new(elements, :type => :another_type)
+    end
+  end
+
+end

data/spec/mtk/patterns/sequence_spec.rb

@@ -0,0 +1,203 @@
+require 'spec_helper'
+
+describe MTK::Patterns::Sequence do
+
+  SEQUENCE = MTK::Patterns::Sequence
+
+  let(:elements) { [1,2,3] }
+  let(:sequence) { SEQUENCE.new(elements) }
+
+  it "is a MTK::Collection" do
+    sequence.should be_a MTK::Helpers::Collection
+    # and now we won't test any other collection features here... see collection_spec
+  end
+
+  describe ".from_a" do
+    it "acts like .new" do
+      SEQUENCE.from_a(elements).should == sequence
+    end
+  end
+
+  describe "#elements" do
+    it "is the array the sequence was constructed with" do
+      sequence.elements.should == elements
+    end
+  end
+
+  describe "#next" do
+    it "enumerates the elements" do
+      nexts = []
+      elements.length.times do
+        nexts << sequence.next
+      end
+      nexts.should == elements
+    end
+
+    it "raises StopIteration when the end of the Sequence is reached" do
+      elements.length.times{ sequence.next }
+      lambda{ sequence.next }.should raise_error(StopIteration)
+    end
+
+    it "should automatically break out of Kernel#loop" do
+      nexts = []
+      loop do # loop rescues StopIteration and exits the loop
+        nexts << sequence.next
+      end
+      nexts.should == elements
+    end
+
+    it "enumerates the elements in sub-sequences" do
+      sub_sequence = SEQUENCE.new [2,3]
+      sequence = SEQUENCE.new [1,sub_sequence,4]
+      nexts = []
+      loop { nexts << sequence.next }
+      nexts.should == [1,2,3,4]
+    end
+
+    it "skips over empty sub-sequences" do
+      sub_sequence = SEQUENCE.new []
+      sequence = SEQUENCE.new [1,sub_sequence,4]
+      nexts = []
+      loop { nexts << sequence.next }
+      nexts.should == [1,4]
+    end
+
+  end
+
+  describe "@min_elements" do
+    it "prevents a StopIteration error until min_elements have been emitted" do
+      pattern = SEQUENCE.new([1,2,3], cycle_count: 1, min_elements: 5)
+      5.times{ pattern.next }
+      lambda{ pattern.next }.should raise_error StopIteration
+    end
+  end
+
+
+  describe "@max_cycles" do
+    it "is the :max_cycles option the pattern was constructed with" do
+      SEQUENCE.new( [], max_cycles: 2 ).max_cycles.should == 2
+    end
+
+    it "is 1 by default" do
+      SEQUENCE.new( [] ).max_cycles.should == 1
+    end
+
+    it "loops indefinitely when it's nil" do
+      sequence = SEQUENCE.new( [1], max_cycles: nil )
+      lambda { 100.times { sequence.next } }.should_not raise_error
+    end
+
+    it "causes a StopIteration exception after the number of cycles has completed" do
+      sequence = SEQUENCE.new( elements, max_cycles: 2 )
+      2.times do
+        elements.length.times { sequence.next } # one full cycle
+      end
+      lambda { sequence.next }.should raise_error StopIteration
+    end
+  end
+
+
+  describe "#max_cycles_exceeded?" do
+    it "is false until max_elements have been emitted" do
+      sequence = SEQUENCE.new( elements, max_cycles: 2 )
+      2.times do
+        sequence.max_cycles_exceeded?.should be_false
+        elements.length.times { sequence.next } # one full cycle
+      end
+      # unlike with element_count and max_elements_exceeded?, cycle_count doesn't get bumped until
+      # you ask for the next element and a StopIteration is thrown
+      lambda { sequence.next }.should raise_error StopIteration
+      sequence.max_cycles_exceeded?.should be_true
+    end
+
+    it "is always false when max_cycles is not set" do
+      pattern = PATTERN.new([:anything], max_cycles: nil)
+      15.times { pattern.max_cycles_exceeded?.should be_false and pattern.next }
+    end
+  end
+
+
+  it "has max_elements_exceeded once max_elements have been emitted (edge case, has same number of elements)" do
+    sequence = SEQUENCE.new([1,2,3,4,5], :max_elements => 5)
+    5.times { sequence.max_elements_exceeded?.should(be_false) and sequence.next }
+    sequence.max_elements_exceeded?.should be_true
+    lambda { sequence.next }.should raise_error StopIteration
+  end
+
+
+  it "raises a StopIteration error when a nested pattern has emitted more than max_elements" do
+    sequence = SEQUENCE.new([Patterns.Cycle(1,2)], :max_elements => 5)
+    5.times { sequence.next }
+    lambda{ sequence.next }.should raise_error StopIteration
+  end
+  
+
+  describe "#rewind" do
+    it "restarts at the beginning of the sequence" do
+      loop { sequence.next }
+      sequence.rewind
+      sequence.next.should == elements.first
+    end
+
+    it "returns self, so it can be chained to #next" do
+      first = sequence.next
+      sequence.rewind.next.should == first
+    end
+
+    it "causes sub-sequences to start from the beginning when encountered again after #rewind" do
+      sub_sequence = SEQUENCE.new [2,3]
+      sequence = SEQUENCE.new [1,sub_sequence,4]
+      loop { sequence.next }
+      sequence.rewind
+      nexts = []
+      loop { nexts << sequence.next }
+      nexts.should == [1,2,3,4]
+    end
+  end
+
+end
+
+
+describe MTK::Patterns do
+
+  describe "#Sequence" do
+    it "creates a Sequence" do
+      MTK::Patterns.Sequence(1,2,3).should be_a MTK::Patterns::Sequence
+    end
+
+    it "sets #elements from the varargs" do
+      MTK::Patterns.Sequence(1,2,3).elements.should == [1,2,3]
+    end
+  end
+
+  describe "#PitchSequence" do
+    it "creates a Sequence" do
+      MTK::Patterns.PitchSequence(1,2,3).should be_a MTK::Patterns::Sequence
+    end
+
+    it "sets #elements from the varargs" do
+      MTK::Patterns.PitchSequence(1,2,3).elements.should == [Pitch(1),Pitch(2),Pitch(3)]
+    end
+  end
+
+  describe "#IntensitySequence" do
+    it "creates a Sequence" do
+      MTK::Patterns.IntensitySequence(1,2,3).should be_a MTK::Patterns::Sequence
+    end
+
+    it "sets #elements from the varargs" do
+      MTK::Patterns.IntensitySequence(1,2,3).elements.should == [Intensity(1),Intensity(2),Intensity(3)]
+    end
+  end
+
+  describe "#DurationSequence" do
+    it "creates a Sequence" do
+      MTK::Patterns.DurationSequence(1,2,3).should be_a MTK::Patterns::Sequence
+    end
+
+    it "sets #elements from the varargs" do
+      MTK::Patterns.DurationSequence(1,2,3).elements.should == [Duration(1),Duration(2),Duration(3)]
+    end
+  end
+
+end