Tone.js/test/core/IntervalTimeline.js

define(["Test", "Tone/core/IntervalTimeline", "helper/Basic"], function (Test, IntervalTimeline, Basic) {

	describe("IntervalTimeline", function(){

		Basic(IntervalTimeline);

		context("inserting/deleting events", function(){

			it ("accepts events into the timeline", function(){
				var sched = new IntervalTimeline();
				sched.addEvent({
					"state" : "A",
					"duration" : 0.2,
					"time"  : 0
				});
				sched.addEvent({
					"state" : "B",
					"duration" : 0.4,
					"time"  : 1
				});
				sched.addEvent({
					"state" : "C",
					"duration" : 12,
					"time"  : 2
				});
				sched.dispose();
			});

			it ("computes the lenght of the timeline correctly after adding events", function(){
				var sched = new IntervalTimeline();
				sched.addEvent({
					"state" : "A",
					"duration" : 0.2,
					"time"  : 0
				});
				sched.addEvent({
					"state" : "B",
					"duration" : 0.4,
					"time"  : 1
				});
				sched.addEvent({
					"state" : "C",
					"duration" : 12,
					"time"  : 2
				});
				expect(sched.length).to.equal(3);
				sched.dispose();
			});

			it ("can remove events from the timeline", function(){
				var sched = new IntervalTimeline();

				var ev0 = {
					"duration" : 0.2,
					"time"  : 0
				};
				var ev1 = {
					"duration" : 0.2,
					"time"  : 0
				};
				var ev2 = {
					"duration" : 0.2,
					"time"  : 0
				};
				sched.addEvent(ev0);
				sched.addEvent(ev1);
				sched.addEvent(ev2);
				expect(sched.length).to.equal(3);
				sched.removeEvent(ev0);
				sched.removeEvent(ev1);
				expect(sched.length).to.equal(1);
				sched.dispose();
			});

			it ("can add and remove and add again events from the timeline", function(){
				var sched = new IntervalTimeline();

				var ev0 = {
					"duration" : 0.2,
					"time"  : 0
				};
				var ev1 = {
					"duration" : 0.2,
					"time"  : 0
				};
				var ev2 = {
					"duration" : 0.2,
					"time"  : 0
				};
				sched.addEvent(ev0);
				sched.addEvent(ev1);
				sched.addEvent(ev2);
				expect(sched.length).to.equal(3);
				sched.removeEvent(ev0);
				sched.removeEvent(ev1);
				expect(sched.length).to.equal(1);
				sched.addEvent(ev0);
				sched.addEvent(ev1);
				expect(sched.length).to.equal(3);
				sched.dispose();
			});

			it ("throws an error if events do not have both time and duration attributes", function(){
				var sched = new IntervalTimeline();
				expect(function(){
					sched.addEvent({
						"time" : 0
					});
				}).to.throw(Error);
				expect(function(){
					sched.addEvent({
						"duration" : 0
					});
				}).to.throw(Error);
				sched.dispose();
			});

		});

		context("getting events", function(){

			it ("returns null when no events are in the timeline", function(){
				var sched = new IntervalTimeline();
				expect(sched.getEvent(3)).to.equal(null);
				sched.dispose();
			});

			it ("returns the event which overlaps the given time", function(){
				var sched = new IntervalTimeline();
				sched.addEvent({
					"state" : "A",
					"duration" : Infinity,
					"time"  : 0
				});
				sched.addEvent({
					"state" : "B",
					"duration" : 0.4,
					"time"  : 1
				});
				sched.addEvent({
					"state" : "C",
					"duration" : 12,
					"time"  : 2
				});
				expect(sched.getEvent(0.2).state).to.equal("A");
				sched.dispose();
			});

			it ("factors in start position and duration when checking for overlaps", function(){
				var sched = new IntervalTimeline();
				sched.addEvent({
					"duration" : 0.4,
					"time"  : 0
				});
				expect(sched.getEvent(0.5)).to.be.null;
				expect(sched.getEvent(-1)).to.be.null;
				expect(sched.getEvent(0)).to.not.be.null;
				expect(sched.getEvent(0.4)).to.not.be.null;
				sched.dispose();
			});

			it ("returns the event whose start is closest to the given time", function(){
				var sched = new IntervalTimeline();
				sched.addEvent({
					"state" : "A",
					"duration" : Infinity,
					"time"  : 0
				});
				sched.addEvent({
					"state" : "B",
					"duration" : 0.4,
					"time"  : 0.2
				});
				sched.addEvent({
					"state" : "C",
					"duration" : 12,
					"time"  : 2
				});
				expect(sched.getEvent(0.2).state).to.equal("B");
				sched.dispose();
			});

			it ("returns the events correctly after some events are removed", function(){
				var sched = new IntervalTimeline();
				var ev0 = {
					"state" : "A",
					"duration" : 0.2,
					"time"  : 0.1
				};
				var ev1 = {
					"state" : "B",
					"duration" : 0.3,
					"time"  : 0.2
				};
				var ev2 = {
					"state" : "C",
					"duration" : Infinity,
					"time"  : 0
				};
				sched.addEvent(ev0);
				sched.addEvent(ev1);
				sched.addEvent(ev2);
				sched.removeEvent(ev0);
				sched.removeEvent(ev1);
				expect(sched.getEvent(0.2)).to.not.be.null;
				expect(sched.getEvent(0.2).state).to.equal("C");
				sched.dispose();
			});

			it ("can handle many items", function(){
				var sched = new IntervalTimeline();
				for (var i = 0; i < 10000; i++){
					sched.addEvent({
						"time" : i,
						"duration" : 1
					});
				}
				for (var j = 0; j < 10000; j++){
					expect(sched.getEvent(j).time).to.equal(j);
				}
				sched.dispose();
			});

		});


		context("cancelling", function(){

			it ("can cancel items after the given time", function(){
				var sched = new IntervalTimeline();
				for (var i = 5; i < 100; i++){
					sched.addEvent({
						"time" : i,
						"duration" : 10
					});
				}
				sched.cancel(10);
				expect(sched.length).to.equal(5);
				sched.cancel(0);
				expect(sched.length).to.equal(0);
				sched.dispose();
			});
		});


		context("Iterators", function(){

			it("iterates over all items and returns and item", function(){
				var sched = new IntervalTimeline();
				sched.addEvent({"time" : 0, "duration" : 5});
				sched.addEvent({"time" : 0.1, "duration" : 5});
				sched.addEvent({"time" : 0.2, "duration" : 5});
				sched.addEvent({"time" : 0.3, "duration" : 5});
				sched.addEvent({"time" : 0.4, "duration" : 5});
				var count = 0;
				sched.forEach(function(event){
					expect(event).to.be.an.object;
					count++;
				});
				expect(count).to.equal(5);
				sched.dispose();
			});

			it("iterates over all items overlapping the given time", function(){
				var sched = new IntervalTimeline();
				sched.addEvent({"time" : 0, "duration" : 5});
				sched.addEvent({"time" : 0.1, "duration" : 5});
				sched.addEvent({"time" : 0.2, "duration" : 5});
				sched.addEvent({"time" : 0.3, "duration" : 5});
				sched.addEvent({"time" : 0.4, "duration" : 5});
				var count = 0;
				sched.forEachOverlap(0.3, function(event){
					expect(event).to.be.an.object;
					expect(event.time).to.be.at.most(0.3);
					count++;
				});
				expect(count).to.equal(4);
				sched.dispose();
			});

			it("handles time ranges before the available objects", function(){
				var sched = new IntervalTimeline();
				sched.addEvent({"time" : 0.1, "duration" : 5});
				sched.addEvent({"time" : 0.2, "duration" : 5});
				sched.addEvent({"time" : 0.3, "duration" : 5});
				sched.addEvent({"time" : 0.4, "duration" : 5});
				var count = 0;
				sched.forEachOverlap(0, function(){
					count++;
				});
				expect(count).to.equal(0);
				sched.dispose();
			});

			it("handles time ranges after the available objects", function(){
				var sched = new IntervalTimeline();
				sched.addEvent({"time" : 0.1, "duration" : 5});
				sched.addEvent({"time" : 0.2, "duration" : 5});
				sched.addEvent({"time" : 0.3, "duration" : 5});
				sched.addEvent({"time" : 0.4, "duration" : 5});
				var count = 0;
				sched.forEachOverlap(5.5, function(){
					count++;
				});
				expect(count).to.equal(0);
				sched.dispose();
			});

			it("iterates over all items after the given time", function(){
				var sched = new IntervalTimeline();
				sched.addEvent({"time" : 0.1, "duration" : 5});
				sched.addEvent({"time" : 0.2, "duration" : 5});
				sched.addEvent({"time" : 0.3, "duration" : 5});
				sched.addEvent({"time" : 0.4, "duration" : 5});
				var count = 0;
				sched.forEachAfter(0.2, function(event){
					expect(event).to.be.an.object;
					expect(event.time).to.be.gte(0.2);
					count++;
				});
				expect(count).to.equal(3);
				count = 0;
				sched.forEachAfter(0.35, function(event){
					expect(event.time).to.be.gte(0.35);
					count++;
				});
				expect(count).to.equal(1);
				sched.dispose();
			});

			it("handles time ranges after the available objects", function(){
				var sched = new IntervalTimeline();
				sched.addEvent({"time" : 0.1, "duration" : 5});
				sched.addEvent({"time" : 0.2, "duration" : 5});
				sched.addEvent({"time" : 0.3, "duration" : 5});
				sched.addEvent({"time" : 0.4, "duration" : 5});
				var count = 0;
				sched.forEachAfter(0.5, function(){
					count++;
				});
				expect(count).to.equal(0);
				sched.dispose();
			});

			it("iterates over all items", function(){
				var sched = new IntervalTimeline();
				sched.addEvent({"time" : 0.1, "duration" : 5});
				sched.addEvent({"time" : 0.2, "duration" : 5});
				sched.addEvent({"time" : 0.3, "duration" : 5});
				sched.addEvent({"time" : 0.4, "duration" : 5});
				var count = 0;
				sched.forEach(function(){
					count++;
				});
				expect(count).to.equal(4);
				sched.dispose();
			});

			it("can remove items during forEach iterations", function(){
				var sched = new IntervalTimeline();
				for (var i = 0; i < 1000; i++){
					sched.addEvent({"time" : i, "duration" : 0.01});
				}
				sched.forEach(function(event){
					sched.cancel(event.time);
				});
				expect(sched.length).to.equal(0);
				sched.dispose();
			});

			it("can remove items during forEachOverlap iterations", function(){
				var sched = new IntervalTimeline();
				for (var i = 0; i < 1000; i++){
					sched.addEvent({"time" : i, "duration" : Infinity});
				}
				sched.forEachOverlap(1000, function(event){
					sched.cancel(event.time);
				});
				expect(sched.length).to.equal(0);
				sched.dispose();
			});

			it("can remove items during forEachAfter iterations", function(){
				var sched = new IntervalTimeline();
				for (var i = 0; i < 1000; i++){
					sched.addEvent({"time" : i, "duration" : Infinity});
				}
				sched.forEachAfter(0, function(event){
					sched.removeEvent(event);
				});
				expect(sched.length).to.equal(0);
				sched.dispose();
			});
		});
	});
});