import TKUnit = require("./TKUnit");
import types = require("utils/types");
//
// # Virtual Array module
// ``` JavaScript
import virtualArrayModule = require("data/virtual-array");
// ```
//
require("globals");
export var test_VirtualArray_shouldCreateArrayFromSpecifiedLength = function () {
var array = new virtualArrayModule.VirtualArray(100);
TKUnit.assert(array.length === 100, "VirtualArray should create array from specified length!");
};
export var test_VirtualArray_setItemShouldSetCorrectItem = function () {
var array = new virtualArrayModule.VirtualArray(100);
array.setItem(0, 0);
TKUnit.assert(array.getItem(0) === 0, "VirtualArray setItem() should set correct item!");
};
export var test_VirtualArray_setItemShouldRaiseChangeEventWhenYouSetDifferentItem = function () {
//
// ### Handle "itemsLoading" event to load items on demand using load() method.
// Use "length" property set via VirtualArray constructor to specify total number of items,
// "loadSize" to specify number of items to be requested in a single request,
// "itemsLoading" event to handle items request and "load()" method to copy items into the array.
// All already loaded items are cached in -memory and when "getItem()" method is called
// the array will raise "itemsLoading" event for still not loaded items.
// ``` JavaScript
var array = new virtualArrayModule.VirtualArray(100);
array.loadSize = 15;
//
var result: virtualArrayModule.ChangedData;
var index = 0;
array.on(virtualArrayModule.VirtualArray.changeEvent, (args: virtualArrayModule.ChangedData) => {
result = args;
});
array.setItem(index, 0);
TKUnit.assert(result && result.eventName === "change" && result.action === virtualArrayModule.ChangeType.Update &&
result.removed.length === 1 && result.index === index && result.addedCount === 1, "VirtualArray setItem() should raise 'change' event with correct args!");
result = undefined;
array.setItem(index, 1);
TKUnit.assert(result && result.eventName === "change" && result.action === virtualArrayModule.ChangeType.Update &&
result.removed.length === 1 && result.index === index && result.addedCount === 1, "VirtualArray setItem() should raise 'change' event with correct args!");
//
array.on(virtualArrayModule.VirtualArray.itemsLoadingEvent, (args: virtualArrayModule.ItemsLoading) => {
//// Argument (args) is ItemsLoading.
//// args.index is start index of the page where the requested index is located.
//// args.count number of requested items.
////
//// Note: Virtual array will divide total number of items to pages using "loadSize" property value. When you request an
//// item at specific index the array will raise "itemsLoading" event with "ItemsLoading" argument index set to the first index of the requested page
//// and count set to number of items in this page.
////
//// Important: If you have already loaded items in the requested page the array will raise multiple times "itemsLoading" event to request
//// all ranges of still not loaded items in this page.
var itemsToLoad = new Array();
for (var i = 0; i < args.count; i++) {
itemsToLoad.push(i + args.index);
}
array.load(args.index, itemsToLoad);
});
// ```
//
};
export var test_VirtualArray_loadShouldRaiseChangeEventWithCorrectArgs = function () {
//
// ### Handle "change" event when you load items using load() method.
// ``` JavaScript
var array = new virtualArrayModule.VirtualArray(100);
array.loadSize = 15;
//
var result: virtualArrayModule.ChangedData;
var index = 0;
//
array.on(virtualArrayModule.VirtualArray.changeEvent, (args: virtualArrayModule.ChangedData) => {
//// Argument (args) is ChangedData.
//// args.eventName is "change".
//// args.action is "update".
//// args.removed.length and result.addedCount are equal to number of loaded items with load() method.
//
result = args;
//
});
var itemsToLoad = [0, 1, 2];
array.load(index, itemsToLoad);
// ```
//
TKUnit.assert(result && result.eventName === "change" && result.action === virtualArrayModule.ChangeType.Update &&
result.removed.length === itemsToLoad.length && result.index === index && result.addedCount === itemsToLoad.length,
"VirtualArray load() should raise 'change' event with correct args!");
};
export var test_VirtualArray_lengthIncreaseShouldRaiseChangeEventWithCorrectArgs = function () {
//
// ### Handle "change" event when you increase "length" property.
// ``` JavaScript
var array = new virtualArrayModule.VirtualArray(100);
array.loadSize = 15;
//
var result: virtualArrayModule.ChangedData;
var index = array.length;
//
array.on(virtualArrayModule.VirtualArray.changeEvent, (args: virtualArrayModule.ChangedData) => {
//// Argument (args) is ChangedData.
//// args.eventName is "change".
//// args.action is "add".
//// args.removed.length is 0, result.addedCount is equal to the delta between new and old "length" property values.
//
result = args;
//
});
array.length += array.loadSize;
// ```
//
TKUnit.assert(result && result.eventName === "change" && result.action === virtualArrayModule.ChangeType.Add
&& result.index === index && result.addedCount === array.loadSize && result.removed.length === 0,
"VirtualArray length++ should raise 'change' event with correct args!");
};
export var test_VirtualArray_lengthDecreaseShouldRaiseChangeEventWithCorrectArgs = function () {
//
// ### Handle "change" event when you increase "length" property.
// ``` JavaScript
var array = new virtualArrayModule.VirtualArray(100);
array.loadSize = 15;
//
var result: virtualArrayModule.ChangedData;
var index = array.length;
//
array.on(virtualArrayModule.VirtualArray.changeEvent, (args: virtualArrayModule.ChangedData) => {
//// Argument (args) is ChangedData.
//// args.eventName is "change".
//// args.action is "remove".
//// result.addedCount is 0, args.removed.length is equal to the delta between new and old "length" property values.
//
result = args;
//
});
array.length -= array.loadSize;
TKUnit.assert(result && result.eventName === "change" && result.action === virtualArrayModule.ChangeType.Delete
&& result.index === index && result.removed.length === array.loadSize && result.addedCount === 0,
"VirtualArray length++ should raise 'change' event with correct args!");
};
export var test_VirtualArray_shouldRaiseItemsLoadingIfIndexIsNotLoadedAndGetItemIsCalled = function () {
var array = new virtualArrayModule.VirtualArray(100);
array.loadSize = 15;
var result: virtualArrayModule.ItemsLoading;
array.on(virtualArrayModule.VirtualArray.itemsLoadingEvent, (args: virtualArrayModule.ItemsLoading) => {
result = args;
});
array.getItem(0);
TKUnit.assert(result.eventName === virtualArrayModule.VirtualArray.itemsLoadingEvent && result.index === 0 &&
result.count === array.loadSize, "VirtualArray getItem() should raise 'itemsLoading' event with correct args if item is not loaded!");
};
export var test_VirtualArray_shouldNotRaiseItemsLoadingIfIndexIsLoadedAndGetItemIsCalled = function () {
var array = new virtualArrayModule.VirtualArray(100);
array.setItem(0, 0);
array.loadSize = 15;
var result: virtualArrayModule.ItemsLoading;
array.on(virtualArrayModule.VirtualArray.itemsLoadingEvent, (args: virtualArrayModule.ItemsLoading) => {
result = args;
});
array.getItem(0);
TKUnit.assert(types.isUndefined(result), "VirtualArray getItem() should not raise 'itemsLoading' event if item is loaded!");
};
export var test_VirtualArray_shouldRaiseItemsLoadingIfIndexIsNotLoadedAndGetItemIsCalledCorrectNumberOfTimesWithCorrectArgs = function () {
var array = new virtualArrayModule.VirtualArray(100);
array.loadSize = 15;
array.setItem(0, 0);
array.setItem(5, 5);
var result = new Array();
array.on(virtualArrayModule.VirtualArray.itemsLoadingEvent, (args: virtualArrayModule.ItemsLoading) => {
result.push(args);
});
array.getItem(1);
TKUnit.assert(result.length === 2 &&
result[0].eventName === virtualArrayModule.VirtualArray.itemsLoadingEvent && result[0].index === 1 && result[0].count === 4 &&
result[1].eventName === virtualArrayModule.VirtualArray.itemsLoadingEvent && result[1].index === 6 && result[1].count === 9,
"VirtualArray getItem() should raise 'itemsLoading' event with correct args!");
};