base.js

// example sample data and code
define([
	"dojo/_base/lang",
	"dojo/_base/array",
	"dojo/_base/Deferred",
	"dojo/store/Memory",
	"dojo/store/Observable",
	"dojo/store/util/QueryResults",
	"./DeferredWrapper"
],
function(lang, arrayUtil, Deferred, Memory, Observable, QueryResults, DeferredWrapper){
	// some sample data
	// global var "data"
	data = {
		identifier: 'id',
		label: 'id',
		items: []
	};
	data_list = [ 
		{ col1: "normal", col2: false, col3: "new", col4: 'But are not followed by two hexadecimal', col5: 29.91, col6: 10, col7: false },
		{ col1: "important", col2: false, col3: "new", col4: 'Because a % sign always indicates', col5: 9.33, col6: -5, col7: false },
		{ col1: "important", col2: false, col3: "read", col4: 'Signs can be selectively', col5: 19.34, col6: 0, col7: true },
		{ col1: "note", col2: false, col3: "read", col4: 'However the reserved characters', col5: 15.63, col6: 0, col7: true },
		{ col1: "normal", col2: false, col3: "replied", col4: 'It is therefore necessary', col5: 24.22, col6: 5.50, col7: true },
		{ col1: "important", col2: false, col3: "replied", col4: 'To problems of corruption by', col5: 9.12, col6: -3, col7: true },
		{ col1: "note", col2: false, col3: "replied", col4: 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris', col5: 12.15, col6: -4, col7: false }
	];

	var rows = 100;
	for(var i=0, l=data_list.length; i<rows; i++){
		data.items.push(lang.mixin({ id: i }, data_list[i%l]));
	}

	// global var testStore
	testStore = Observable(new Memory({data: data}));

	function asyncQuery() {
		var results = Memory.prototype.query.apply(this, arguments),
			def = new Deferred(function(){
				clearTimeout(timer);
			}),
			timer = setTimeout(function(){
				def.resolve(results);
			}, 200);
		var promisedResults = QueryResults(def.promise);
		promisedResults.total = results.total;
		return promisedResults;
	}
	
	testAsyncStore = Observable(new Memory({
		data: data,
		query: asyncQuery
	}));
	//sample color data
	data2 = {
		identifier: 'id',
		label: 'id',
		items: []
	};
	colors = [
		{ col1: "Red", col2: false, col3: "Primary", col4: 'A primary color', col5: 255, col6: 0, col7: 0 },
		{ col1: "Yellow", col2: false, col3: "Primary", col4: 'A primary color', col5: 255, col6: 255, col7: 0 },
		{ col1: "Blue", col2: false, col3: "Primary", col4: 'A primary color', col5: 0, col6: 0, col7: 255 },
		{ col1: "Orange", col2: false, col3: "Secondary", col4: 'A Secondary color', col5: 255, col6: 165, col7: 0 },
		{ col1: "Purple", col2: false, col3: "Secondary", col4: 'A Secondary color', col5: 160, col6: 32, col7: 240 },
		{ col1: "Green", col2: false, col3: "Secondary", col4: 'A Secondary color', col5: 0, col6: 192, col7: 0 },
		{ col1: "Pink", col2: false, col3: "Hue", col4:'A hue' , col5: 255, col6: 192, col7: 203 }
	];

	for(var i=0, l=colors.length; i<rows; i++){
		data2.items.push(lang.mixin({ id: i }, colors[i%l]));
	}

	// global var colorStore
	colorStore = Observable(new Memory({data: data2}));
	data2.items= [];
	for(var i=0; i<colors.length; i++){
		data2.items.push(lang.mixin({ id: i }, colors[i]));
	}
	smallColorStore = Observable(new Memory({data: data2}));
	//empty store
	emptyStore = Observable(new Memory({ data: [] }));
	emptyAsyncStore = Observable(new Memory({
		data: [],
		query: asyncQuery
	}));

	//store with non-existent url
	//errorStore = Observable(Memory({data: junk}));
	testStateStore = Observable(new Memory({
			idProperty: "abbreviation",
			data: [
			{ "abbreviation": "AL", "name": "Alabama" },
			{ "abbreviation": "AK", "name": "Alaska" },
			{ "abbreviation": "AZ", "name": "Arizona" },
			{ "abbreviation": "AR", "name": "Arkansas" },
			{ "abbreviation": "CA", "name": "California" },
			{ "abbreviation": "CO", "name": "Colorado" },
			{ "abbreviation": "CT", "name": "Connecticut" },
			{ "abbreviation": "DE", "name": "Delaware" },
			{ "abbreviation": "FL", "name": "Florida" },
			{ "abbreviation": "GA", "name": "Georgia" },
			{ "abbreviation": "HI", "name": "Hawaii" },
			{ "abbreviation": "ID", "name": "Idaho" },
			{ "abbreviation": "IL", "name": "Illinois" },
			{ "abbreviation": "IN", "name": "Indiana" },
			{ "abbreviation": "IA", "name": "Iowa" },
			{ "abbreviation": "KS", "name": "Kansas" },
			{ "abbreviation": "KY", "name": "Kentucky" },
			{ "abbreviation": "LA", "name": "Louisiana" },
			{ "abbreviation": "ME", "name": "Maine" },
			{ "abbreviation": "MD", "name": "Maryland" },
			{ "abbreviation": "MA", "name": "Massachusetts" },
			{ "abbreviation": "MI", "name": "Michigan" },
			{ "abbreviation": "MN", "name": "Minnesota" },
			{ "abbreviation": "MS", "name": "Mississippi" },
			{ "abbreviation": "MO", "name": "Missouri" },
			{ "abbreviation": "MT", "name": "Montana" },
			{ "abbreviation": "NE", "name": "Nebraska" },
			{ "abbreviation": "NV", "name": "Nevada" },
			{ "abbreviation": "NH", "name": "New Hampshire" },
			{ "abbreviation": "NJ", "name": "New Jersey" },
			{ "abbreviation": "NM", "name": "New Mexico" },
			{ "abbreviation": "NY", "name": "New York" },
			{ "abbreviation": "NC", "name": "North Carolina" },
			{ "abbreviation": "ND", "name": "North Dakota" },
			{ "abbreviation": "OH", "name": "Ohio" },
			{ "abbreviation": "OK", "name": "Oklahoma" },
			{ "abbreviation": "OR", "name": "Oregon" },
			{ "abbreviation": "PA", "name": "Pennsylvania" },
			{ "abbreviation": "RI", "name": "Rhode Island" },
			{ "abbreviation": "SC", "name": "South Carolina" },
			{ "abbreviation": "SD", "name": "South Dakota" },
			{ "abbreviation": "TN", "name": "Tennessee" },
			{ "abbreviation": "TX", "name": "Texas" },
			{ "abbreviation": "UT", "name": "Utah" },
			{ "abbreviation": "VT", "name": "Vermont" },
			{ "abbreviation": "VA", "name": "Virginia" },
			{ "abbreviation": "WA", "name": "Washington" },
			{ "abbreviation": "WV", "name": "West Virginia" },
			{ "abbreviation": "WI", "name": "Wisconsin" },
			{ "abbreviation": "WY", "name": "Wyoming" }
		]
		}));
	var typesData = [];
	for(var i = 0; i < 12; i++){
		typesData.push({
			id: i,
			integer: Math.floor(Math.random() * 100),
			floatNum: Math.random() * 100,
			date: new Date(new Date().getTime() * Math.random() * 2),
			date2: new Date(new Date().getTime() - Math.random() * 1000000000),
			text: "A number in text " + Math.random(),
			text2: "A number in text " + Math.random(),
			bool: Math.random() > 0.5,
			bool2: Math.random() > 0.5,
			state: testStateStore.data[Math.floor(Math.random() * 50)].abbreviation,
			state2: testStateStore.data[Math.floor(Math.random() * 50)].abbreviation
		});
	}
	// global var testTypesStore
	testTypesStore = Observable(new Memory({data: typesData}));


	var testCountryData = [
		{ id: 'AF', name:'Africa', type:'continent', population:'900 million', area: '30,221,532 sq km',
				timezone: '-1 UTC to +4 UTC'},
			{ id: 'EG', name:'Egypt', type:'country', parent: 'AF' },
				{ id: 'Cairo', name:'Cairo', type:'city', parent: 'EG' },
			{ id: 'KE', name:'Kenya', type:'country', parent: 'AF'},
				{ id: 'Nairobi', name:'Nairobi', type:'city', parent: 'KE' },
				{ id: 'Mombasa', name:'Mombasa', type:'city', parent: 'KE' },
			{ id: 'SD', name:'Sudan', type:'country', parent: 'AF'},
				{ id: 'Khartoum', name:'Khartoum', type:'city', parent: 'SD' },
			{ id: 'AS', name:'Asia', type:'continent', population: '3.2 billion'},
				{ id: 'CN', name:'China', type:'country', parent: 'AS' },
					{ id: 'Shanghai', name:'Shanghai', type:'city', parent: 'CN' },
				{ id: 'IN', name:'India', type:'country', parent: 'AS' },
					{ id: 'Calcutta', name:'Calcutta', type:'city', parent: 'IN' },
				{ id: 'RU', name:'Russia', type:'country', parent: 'AS' },
					{ id: 'Moscow', name:'Moscow', type:'city', parent: 'RU' },
				{ id: 'MN', name:'Mongolia', type:'country', parent: 'AS' },
					{ id: 'UlanBator', name:'Ulan Bator', type:'city', parent: 'MN' },
			{ id: 'OC', name:'Oceania', type:'continent', population:'21 million'},
			{ id: 'AU', name:'Australia', type:'country', population:'21 million', parent: 'OC' },
				{ id: 'Sydney', name:'Sydney', type:'city', parent: 'AU' },
			{ id: 'EU', name:'Europe', type:'continent', population: '774 million' },
			{ id: 'DE', name:'Germany', type:'country', parent: 'EU' },
				{ id: 'Berlin', name:'Berlin', type:'city', parent: 'DE' },
			{ id: 'FR', name:'France', type:'country', parent: 'EU' },
				{ id: 'Paris', name:'Paris', type:'city', parent: 'FR' },
			{ id: 'ES', name:'Spain', type:'country', parent: 'EU' },
				{ id: 'Madrid', name:'Madrid', type:'city', parent: 'ES' },
			{ id: 'IT', name:'Italy', type:'country', parent: 'EU' },
				{ id: 'Rome', name:'Rome', type:'city', parent: 'IT' },
		{ id: 'NA', name:'North America', type:'continent', population: '575 million'},
			{ id: 'MX', name:'Mexico', type:'country',  population:'108 million', area:'1,972,550 sq km', parent: 'NA' },
				{ id: 'Mexico City', name:'Mexico City', type:'city', population:'19 million', timezone:'-6 UTC', parent: 'MX'},
				{ id: 'Guadalajara', name:'Guadalajara', type:'city', population:'4 million', timezone:'-6 UTC', parent: 'MX' },
			{ id: 'CA', name:'Canada', type:'country',  population:'33 million', area:'9,984,670 sq km', parent: 'NA' },
				{ id: 'Ottawa', name:'Ottawa', type:'city', population:'0.9 million', timezone:'-5 UTC', parent: 'CA'},
				{ id: 'Toronto', name:'Toronto', type:'city', population:'2.5 million', timezone:'-5 UTC', parent: 'CA' },
			{ id: 'US', name:'United States of America', type:'country', parent: 'NA' },
				{ id: 'New York', name:'New York', type:'city', parent: 'US' },
		{ id: 'SA', name:'South America', type:'continent', population: '445 million' },
			{ id: 'BR', name:'Brazil', type:'country', population:'186 million', parent: 'SA' },
				{ id: 'Brasilia', name:'Brasilia', type:'city', parent: 'BR' },
			{ id: 'AR', name:'Argentina', type:'country', population:'40 million', parent: 'SA' },
				{ id: 'BuenosAires', name:'Buenos Aires', type:'city', parent: 'AR' }
	];
	
	// global var testSyncCountryStore
	testSyncCountryStore = Observable(new Memory({
		data: testCountryData,
		getChildren: function(parent, options){
			// Support persisting the original query via options.originalQuery
			// so that child levels will filter the same way as the root level
			return this.query(
				lang.mixin({}, options && options.originalQuery || null,
					{ parent: parent.id }),
				options);
		},
		mayHaveChildren: function(parent){
			return parent.type != "city";
		},
		query: function (query, options){
			query = query || {};
			options = options || {};
			
			if (!query.parent && !options.deep) {
				// Default to a single-level query for root items (no parent)
				query.parent = undefined;
			}
			return this.queryEngine(query, options)(this.data);
		}
	}));
	
	// global var testCountryStore
	testCountryStore = new Observable(new DeferredWrapper(testSyncCountryStore));
	
	var testTopHeavyData = arrayUtil.map(testStateStore.data, function (state) {
		return {
			abbreviation: state.abbreviation,
			name: state.name,
			children: [{
				abbreviation: 'US',
				name: 'United States of America'
			}]
		};
	});
	
	// global var testTopHeavyStore
	// Store with few children and many parents to exhibit any
	// issues due to bugs related to total disregarding level
	testTopHeavyStore = Observable(new Memory({
		data: testTopHeavyData,
		idProperty: "abbreviation",
		getChildren: function(parent, options){
			return parent.children;
		},
		mayHaveChildren: function(parent){
			return !!parent.children;
		}
	}));

	function calculateOrder(store, object, before, orderField){
		// Calculates proper value of order for an item to be placed before another
		var afterOrder, beforeOrder = 0;
		if (!orderField) { orderField = "order"; }
		
		if(before){
			// calculate midpoint between two items' orders to fit this one
			afterOrder = before[orderField];
			store.query({}, {}).forEach(function(object){
				var ord = object[orderField];
				if(ord > beforeOrder && ord < afterOrder){
					beforeOrder = ord;
				}
			});
			return (afterOrder + beforeOrder) / 2;
		}else{
			// find maximum order and place this one after it
			afterOrder = 0;
			store.query({}, {}).forEach(function(object){
				var ord = object[orderField];
				if(ord > afterOrder){ afterOrder = ord; }
			});
			return afterOrder + 1;
		}
	}
	// global function createOrderedStore
	createOrderedStore = function(data, options){
		// Instantiate a Memory store modified to support ordering.
		return Observable(new Memory(lang.mixin({data: data,
			idProperty: "name",
			put: function(object, options){
				object.order = calculateOrder(this, object, options && options.before);
				return Memory.prototype.put.call(this, object, options);
			},
			// Memory's add does not need to be augmented since it calls put
			copy: function(object, options){
				// summary:
				//		Given an item already in the store, creates a copy of it.
				//		(i.e., shallow-clones the item sans id, then calls add)
				var k, obj = {}, id, idprop = this.idProperty, i = 0;
				for (k in object){
					obj[k] = object[k];
				}
				// Ensure unique ID.
				// NOTE: this works for this example (where id's are strings);
				// Memory should autogenerate random numeric IDs, but
				// something seems to be falling through the cracks currently...
				id = object[idprop];
				if(id in this.index){
					// rev id
					while(this.index[id + "(" + (++i) + ")"]){}
					obj[idprop] = id + "(" + i + ")";
				}
				this.add(obj, options);
			},
			query: function(query, options){
				options = options || {};
				options.sort = [{attribute:"order"}];
				return Memory.prototype.query.call(this, query, options);
			}
		}, options)));
	};
	// global var testOrderedData
	testOrderedData = [
		{order: 1, name:"preheat", description:"Preheat your oven to 350°F"},
		{order: 2, name:"mix dry", description:"In a medium bowl, combine flour, salt, and baking soda"},
		{order: 3, name:"mix butter", description:"In a large bowl, beat butter, then add the brown sugar and white sugar then mix"},
		{order: 4, name:"mix together", description:"Slowly add the dry ingredients from the medium bowl to the wet ingredients in the large bowl, mixing until the dry ingredients are totally combined"},
		{order: 5, name:"chocolate chips", description:"Add chocolate chips"},
		{order: 6, name:"make balls", description:"Scoop up a golf ball size amount of dough with a spoon and drop in onto a cookie sheet"},
		{order: 7, name:"bake", description:"Put the cookies in the oven and bake for about 10-14 minutes"},
		{order: 8, name:"remove", description:"Using a spatula, lift cookies off onto wax paper or a cooling rack"},
		{order: 9, name:"eat", description:"Eat and enjoy!"}
	];
	// global var testOrderedStore
	testOrderedStore = createOrderedStore(testOrderedData);
	return testStore;
});