mtk 0.0.1

data/spec/mtk/timeline_spec.rb

@@ -0,0 +1,234 @@
+require 'spec_helper'
+
+describe MTK::Timeline do
+
+  let(:note1) { Note.new(C4, p, 1) }
+  let(:note2) { Note.new(G4, f, 2) }
+  let(:timeline_raw_data) { { 0 => note1, 1 => [note1, note2] } }
+  let(:timeline_hash) { { 0 => [note1], 1 => [note1, note2] } }
+  let(:timeline) { Timeline.from_hash(timeline_raw_data) }
+
+  it "is Enumerable" do
+    Timeline.new.should be_a Enumerable
+  end
+
+  it "wraps lone values in arrays" do
+    Timeline.from_hash(timeline_raw_data).should == Timeline.from_hash(timeline_hash)
+  end
+
+  describe "from_hash" do
+    it "creates an empty timeline when the hash is empty" do
+      Timeline.from_hash({}).should be_empty
+    end
+
+    it "builds a Timeline from a map of times to single events" do
+      t = Timeline.from_hash({ 0 => note1, 1 => note2 })
+      t[0].should == [note1]
+      t[1].should == [note2]
+    end
+
+    it "builds a Timeline from a map of times to event lists" do
+      t = Timeline.from_hash({ 0 => [note1, note2], 1 => [note2] })
+      t[0].should == [note1, note2]
+      t[1].should == [note2]
+    end
+  end
+
+  describe "from_a" do
+    it "creates a timeline from an Enumerable"
+  end
+
+  describe "#to_hash" do
+    it "returns the underlying Hash" do
+      timeline.to_hash.should == timeline_hash
+    end
+  end
+
+  describe "#clear" do
+    it "clears the timeline" do
+      timeline.clear.should be_empty
+    end
+  end
+
+  describe "#merge" do
+    it "merges all the time,event pairs in the given Enumerable into this Timeline"
+  end
+
+  describe "#empty?" do
+    it "is true when the timeilne has no events" do
+      Timeline.new.empty?.should be_true
+    end
+  end
+
+  describe "#[]" do
+    it "returns an array of the event(s) at the timepoint" do
+      timeline[0].should == [note1]
+      timeline[1].should == [note1, note2]
+    end
+    it "returns nil when no events exist at the timepoint" do
+      timeline[3].should == nil
+    end
+  end
+
+  describe "#[]=" do
+    it "set a single event at the given timepoint" do
+      timeline[5] = note1
+      timeline[5].should == [note1]
+    end
+    it "set an array of events at the given timepoint" do
+      timeline[5] = [note1, note2]
+      timeline[5].should == [note1, note2]
+    end
+    it "replaces existing events at the timepoint" do
+      timeline[5] = note1
+      timeline[5] = note2
+      timeline[5].should == [note2]
+    end
+  end
+
+  describe "#add" do
+    it "creates a new event list at a previously empty timepoint" do
+      timeline.add(5, note1)
+      timeline[5].should == [note1]
+    end
+
+    it "appends to existing event lists" do
+      timeline.add(5, note1)
+      timeline.add(5, note2)
+      timeline[5].should == [note1, note2]
+    end
+
+    it "accepts either a single event or a list of events as its second argument"
+  end
+
+  describe "#delete" do
+    it "removes an event list at the given time" do
+      timeline.delete(1)
+      timeline.should == { 0 => [note1] }
+    end
+  end
+
+  describe "#has_time?" do
+    it "returns true if the time has been assigned" do
+      (timeline.has_time? 1).should be_true
+    end
+    it "returns false if the time doesn't exist" do
+      (timeline.has_time? 3).should be_false
+    end
+  end
+
+  describe "#times" do
+    it "is the sorted list of times" do
+      timeline.times.should == [0,1]
+    end
+  end
+
+  describe "#==" do
+    it "is true when the underlying Hashes are equal" do
+      timeline.should == Timeline.from_hash(timeline_hash)
+    end
+    it "is false when the underlying Hashes are not equal" do
+      timeline.should_not == Timeline.from_hash( {0 => [note2], 1 => [note1, note2]} )
+    end
+    it "allows for direct comparison to hashes" do
+      timeline.should == timeline_hash
+    end
+  end
+
+  describe "#events" do
+    it "is all events in a flattened array" do
+      timeline.events.should == [note1, note1, note2]
+    end
+  end
+
+  describe "#each" do
+    it "yields each |time,single_event| pair" do
+      yielded = []
+      timeline.each{|t,e| yielded << [t,e] }
+      yielded.should == [ [0,note1], [1,note1], [1,note2] ]
+    end
+  end
+
+  describe "#each_time" do
+    it "yields each |time,event_list| pair" do
+      yielded = []
+      timeline.each_time{|t,es| yielded << [t,es] }
+      yielded.should == [ [0,[note1]], [1,[note1,note2]] ]
+    end
+  end
+
+  describe "#map" do
+    it "returns a new Timeline where each [time,event] pair is replaced by the result of block" do
+      mapped = timeline.map{|time,event| [time+1, event.transpose(time+2)] }
+      mapped.should == { 1 => [note1.transpose(2)], 2 => [note1.transpose(3), note2.transpose(3)] }
+    end
+
+    it "does not modify this Timeline" do
+      timeline.map{|t,e| [0,nil] }
+      timeline.should == timeline_hash
+    end
+  end
+
+  describe "#map!" do
+    it "maps the Timeline in place" do
+      timeline.map! {|time,event| [time+1, event.transpose(time+2)] }
+      timeline.should == { 1 => [note1.transpose(2)], 2 => [note1.transpose(3), note2.transpose(3)] }
+    end
+  end
+
+  describe "#map_events" do
+    it "maps the Timeline in place" do
+      mapped = timeline.map_events {|event| event.transpose(1) }
+      mapped.should == { 0 => [note1.transpose(1)], 1=> [note1.transpose(1), note2.transpose(1)] }
+    end
+
+    it "does not modify this Timeline" do
+      timeline.map_events {|event| event.transpose(1) }
+      timeline.should == timeline_hash
+    end
+  end
+
+  describe "#map_events!" do
+    it "maps the Timeline in place" do
+      timeline.map_events! {|event| event.transpose(1) }
+      timeline.should == { 0 => [note1.transpose(1)], 1=> [note1.transpose(1), note2.transpose(1)] }
+    end
+  end
+
+  describe "#compact!" do
+    it "removes empty event lists" do
+      timeline[3] = []
+      timeline[4] = []
+      timeline.compact!
+      timeline.should == timeline_hash
+    end
+  end
+  
+  describe "#flatten" do
+    it "flattens nested timelines so that all nested subtimes are converted to absolute times in a single timeline" do
+      timeline[10] = Timeline.from_hash({ 0 => note2, 1 => note1 })
+      timeline.flatten.should == timeline_hash.merge({ 10 => [note2], 11 => [note1] })
+    end
+    
+    it "handles nested timelines which have nested timelines inside of them" do
+      nested = Timeline.from_hash({ 0 => note1 })
+      timeline[10] = Timeline.from_hash({ 100 => nested })
+      timeline.flatten.should == timeline_hash.merge({ 110 => [note1] })
+    end
+    
+    it "returns a new Timeline" do
+      timeline.flatten.should_not equal(timeline)
+    end
+  end
+
+  describe "#clone" do
+    it "creates an equal Timeline" do
+      timeline.clone.should == timeline
+    end
+
+    it "returns a new instance" do
+      timeline.clone.should_not equal(timeline)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'mtk'
+require 'mtk/patterns'
+include MTK
+include Pitches
+include PitchClasses
+include Dynamics
+include Intervals

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: mtk
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Adam Murray
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-08 00:00:00 Z
+dependencies: []
+
+description: 
+email: adam@compusition.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.md
+- lib/mtk/chord.rb
+- lib/mtk/constants/dynamics.rb
+- lib/mtk/constants/intervals.rb
+- lib/mtk/constants/pitch_classes.rb
+- lib/mtk/constants/pitches.rb
+- lib/mtk/constants/pseudo_constants.rb
+- lib/mtk/event.rb
+- lib/mtk/midi/file.rb
+- lib/mtk/note.rb
+- lib/mtk/numeric_extensions.rb
+- lib/mtk/pattern/choice.rb
+- lib/mtk/pattern/note_sequence.rb
+- lib/mtk/pattern/pitch_sequence.rb
+- lib/mtk/pattern/sequence.rb
+- lib/mtk/patterns.rb
+- lib/mtk/pitch.rb
+- lib/mtk/pitch_class.rb
+- lib/mtk/pitch_class_set.rb
+- lib/mtk/pitch_set.rb
+- lib/mtk/timeline.rb
+- lib/mtk/util/mappable.rb
+- lib/mtk.rb
+- spec/mtk/chord_spec.rb
+- spec/mtk/constants/dynamics_spec.rb
+- spec/mtk/constants/intervals_spec.rb
+- spec/mtk/constants/pitch_classes_spec.rb
+- spec/mtk/constants/pitches_spec.rb
+- spec/mtk/event_spec.rb
+- spec/mtk/midi/file_spec.rb
+- spec/mtk/note_spec.rb
+- spec/mtk/numeric_extensions_spec.rb
+- spec/mtk/pattern/choice_spec.rb
+- spec/mtk/pattern/note_sequence_spec.rb
+- spec/mtk/pattern/pitch_sequence_spec.rb
+- spec/mtk/pattern/sequence_spec.rb
+- spec/mtk/pitch_class_set_spec.rb
+- spec/mtk/pitch_class_spec.rb
+- spec/mtk/pitch_set_spec.rb
+- spec/mtk/pitch_spec.rb
+- spec/mtk/timeline_spec.rb
+- spec/spec_helper.rb
+- spec/test.mid
+homepage: http://github.com/adamjmurray/mtk
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Musical ToolKit for Ruby
+test_files: []
+