-
Notifications
You must be signed in to change notification settings - Fork 0
/
jsMVC.js
1653 lines (1510 loc) · 57 KB
/
jsMVC.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Define the framework namespace.
// TODO: Hide all the private functions inside a closure.
var jsMVC = {};
// jQuery
// ****************************************************************************
// ****************************************************************************
// TODO: Include jQuery inlined here in noConflict mode.
$.noConflict();
// JSON
// ****************************************************************************
// ****************************************************************************
// TODO: Include the minified JSON library here.
// A JSON library that does the same as the standar ECMA JSON object is needed
// in case an older brower that does not have it is been used.
// INIT
// ****************************************************************************
// ****************************************************************************
// The first function that must be called to start the framework.
// The first parameter is the root folder for the application to load.
// From this folder the config file (as named in config.name) will be loaded.
// Finally init.application will be called to start loading the provided application controller on the provided container.
jsMVC.init = function (appFolder, appContainer, appController, appParams) {
// Set the application folder.
if (typeof appFolder === "string") {
jsMVC.config.prefix = appFolder;
} else {
jsMVC.error.log("The first parameter to init must be a string with the Application folder.");
return;
}
// Set the application container.
if (typeof appContainer === "string") {
if (jQuery.find(appContainer).length === 1) {
jsMVC.controller.application.container = appContainer;
} else {
jsMVC.error.log("The application container selector must match only one element.");
return;
}
} else {
jsMVC.error.log("The second parameter to init must be a selector to the application container.");
return;
}
// Check the application controller name.
if (typeof appController !== "string") {
jsMVC.error.log("The third parameter to init must be the application controller name.");
return;
}
// Load the config.
jsMVC.config.load().done(function() {
// Initiate the application.
jsMVC.init.application(appController, appParams);
}).fail(function (jqXHR, textStatus, errorThrown) {
// TODO: Do visually something on config load fail.
// The config load already shows an error message.
});
};
// Loads the application controller and calls its constructor method.
// The application provides the page name that will be loaded.
// When finished all this the application onLoad method is called.
jsMVC.init.application = function (applicationName, constructorParameters) {
// Load the application controller.
jsMVC.controller.application.load(applicationName).done(function (application) {
// Set the active applications to container.
jQuery(jsMVC.controller.application.container).data("data-jsMVC-application", application);
// Call the application init method.
jsMVC.classes.initInstance(application, constructorParameters);
// Apply the application styles.
jsMVC.render.styles(application.styles); // TODO: Wait for this deferred ???
// Get the page controller name.
var pageName = jsMVC.init.application.getPageName(application);
// TODO: Get the page controller constructor parameters.
var pageParams = [];
// Load the page.
jsMVC.init.page(pageName, pageParams).done(function (page) {
// Set the application controller page property.
application.page = page;
// Call the application onLoad method.
if (application.onLoad !== undefined && jQuery.isFunction(application.onLoad)) {
application.onLoad();
}
});
}).fail(function (jqXHR, textStatus, errorThrown) {
// TODO: Do visually something on application load fail.
jsMVC.error.log("Failed to load application \"" + applicationName + "\".");
});
};
jsMVC.init.application.getPageName = function (application) {
// Go through each page mapping.
// The page mapping is an object with the various page names as property keys.
for (var pageName in application.pages) {
// Every page object has various properties to match with the URL.
var pageMapper = application.pages[pageName];
// By default every page matches unless proven guilty.
var matched = true;
// The keys of the page object ae the parts of the URL to match.
for (var partKey in pageMapper) {
var part = pageMapper[partKey];
if (partKey == "scheme") {
matched = matched && part.test(location.protocol);
} else if (partKey == "domain") {
matched = matched && part.test(location.hostname);
} else if (partKey == "port") {
matched = matched && part.test(location.port);
} else if (partKey == "path") {
matched = matched && part.test(location.pathname);
} else if (partKey == "query") {
for (var queryKey in part) {
var queryRegex = part[queryKey];
var queryValue = jsMVC.utils.getUrlParameter(queryKey);
if (queryValue !== null) {
matched = matched && queryRegex.test(queryValue);
} else {
matched = false;
}
}
} else if (partKey == "fragment") {
matched = matched && part.test(location.hash);
}
}
if (matched) {
return pageName;
}
}
return "main"; // The default page.
};
// Loads the page controller and calls its constructor method.
// As provided by the application controller, set page title, favicon and language code.
// When finished all this the page onLoad method is called.
jsMVC.init.page = function (pageName, constructorParameters) {
// The deferred to return.
var deferred = jQuery.Deferred();
// Load the page controller.
jsMVC.controller.page.load(pageName).done(function (page) {
// Set the active page name.
jsMVC.controller.page.name = pageName;
// Set the page controller view property.
page.view = jQuery(jsMVC.controller.application.container);
// Call the page init method.
jsMVC.classes.initInstance(page, constructorParameters);
// Apply the page styles.
jsMVC.render.styles(page.styles); // TODO: Wait for this deferred ???
// Set html title from the page controller's method or property.
if (page.getTitle !== undefined && jQuery.isFunction(page.getTitle)) {
jsMVC.document.setTitle(page.getTitle());
} else if (page.title && typeof(page.title) === 'string') {
jsMVC.document.setTitle(page.title);
}
// Set favicon from the page controller's method or property.
if (page.getFavIcon !== undefined && jQuery.isFunction(page.getFavIcon)) {
jsMVC.document.setFavIcon(page.getFavIcon());
} else if (page.favIcon && typeof(page.favIcon) === 'string') {
jsMVC.document.setFavIcon(page.favIcon);
}
// Set the document language code from the page controller's method or property.
if (page.getLanguageCode !== undefined && jQuery.isFunction(page.getLanguageCode)) {
jsMVC.document.setLanguageCode(page.getLanguageCode());
} else if (page.languageCode && typeof(page.languageCode) === 'string') {
jsMVC.document.setLanguageCode(page.languageCode);
}
// Render all the views.
jsMVC.render.processViews(jsMVC.controller.application.container).done(function () {
// Call the page onLoad method.
if (page.onLoad !== undefined && jQuery.isFunction(page.onLoad)) {
page.onLoad();
}
// Resolve the deferred returning the controller.
deferred.resolve(page);
});
}).fail(function (jqXHR, textStatus, errorThrown) {
// TODO: Do visually something on page load fail.
jsMVC.error.log("Failed to load page \"" + pageName + "\".");
deferred.reject();
});
// Return the promise only.
return deferred.promise();
};
// Packages
// ****************************************************************************
// ****************************************************************************
jsMVC.error = {}; // Log functions.
jsMVC.config = {}; // Load and parse the configuration file.
jsMVC.utils = {}; // Utility functions.
jsMVC.document = {}; // Utilities to alter the DOM.
jsMVC.model = {}; // Action requests to the server.
jsMVC.view = {}; // Load views.
jsMVC.style = {}; // Load styles.
jsMVC.image = {}; // Load image.
jsMVC.translation = {}; // Translation functions.
jsMVC.library = {}; // Load javascripts.
jsMVC.classes = {}; // Loading and creating classes with its parents, etc.
jsMVC.source = {}; // Load and create user created classes.
jsMVC.controller = {}; // Controllers:
jsMVC.controller.application = {}; // Load and create application controllers (Class).
jsMVC.controller.page = {}; // Load and create page controllers (Class).
jsMVC.controller.view = {}; // Load and create view controllers (Class).
jsMVC.social = {}; // Social plugins:
jsMVC.social.facebook = {}; // Facebook functions and helpers.
// ERROR
// ****************************************************************************
// ****************************************************************************
// Error logging function.
// Use this function to log errors or messages, doing so, later we could easily improve all the logs.
// This function can be overrided by the developer as needed.
jsMVC.error.log = function (msg) {
alert(msg);
};
// CONFIG
// ****************************************************************************
// ****************************************************************************
// Debug mode on or off.
// Can be overrided with the config file.
jsMVC.config.debug = false;
// The config file name.
jsMVC.config.name = "config.json";
// The main URI prefix.
jsMVC.config.prefix = "";
// The main URI suffix.
jsMVC.config.suffix = "";
// Fetchs the config file and parses it (if no error on the json file).
jsMVC.config.load = function () {
var deferred = jQuery.Deferred();
jQuery.ajax({
url: jsMVC.config.prefix + jsMVC.config.name,
dataType: "json", // Evaluates as JSON and returns a JavaScript object. Any malformed JSON is rejected and a parse error is thrown.
success: function (jsonConfig) {
jsMVC.config.parse(jsonConfig).done(function () {
deferred.resolve();
}).fail(function () {
// TODO: Parse failed!
deferred.reject(null, "parsererror", null);
});
},
error: function (jqXHR, textStatus, errorThrown) {
if (textStatus === "parsererror") {
jsMVC.error.log("Config parse error");
} else {
jsMVC.error.log("Config not loaded (" + errorThrown + ")");
}
deferred.reject(jqXHR, textStatus, errorThrown);
}
});
return deferred.promise();
};
// Parse the config file and set the framework constants.
// The jsonConfig variable was already validated by the load function and is a valid json encoded javascript object.
jsMVC.config.parse = function (jsonConfig) {
var dynamicWhen = new jsMVC.utils.DynamicWhen();
/*** Start parsing the things thay may be a depency for ALL the rest. ***/
// Debug mode.
if (jsonConfig.debug !== undefined) {
jsMVC.config.debug = jsonConfig.debug;
}
/*** Them parse first the things that may need to start downloading something. ***/
// Image
if (jsonConfig.image) {
var imageConfig = jsonConfig.image;
// Prefix
if (imageConfig.prefix) {
jsMVC.image.prefix = imageConfig.prefix;
}
// Delay min.
if (imageConfig.delayMin) {
jsMVC.image.delayMin = imageConfig.delayMin;
}
// Delay max.
if (imageConfig.delayMax) {
jsMVC.image.delayMax = imageConfig.delayMax;
}
// Preloaded images.
if (imageConfig.preload && jQuery.isArray(imageConfig.preload)) {
var preload = imageConfig.preload;
for (var key in preload) {
dynamicWhen.addDeferred(
jsMVC.image.load(jsMVC.image.getUri(preload[key]))
);
}
}
}
// Translation
if (jsonConfig.translation) {
var translationConfig = jsonConfig.translation;
// Prefix
if (translationConfig.prefix) {
jsMVC.translation.prefix = translationConfig.prefix;
}
// Suffix
if (translationConfig.suffix) {
jsMVC.translation.suffix = translationConfig.suffix;
}
// Globals
if (translationConfig.globals && jQuery.isArray(translationConfig.globals)) {
var globalTranslations = translationConfig.globals;
for (var key in globalTranslations) {
// TODO: Use dynamic when!!
// TODO: Set an onFinishCallback!!!!!!!!!!!
jsMVC.translation.addToMain(globalTranslations[key]);
}
}
}
// Libraries
if (jsonConfig.library) {
var libraryConfig = jsonConfig.library;
// Local
if (libraryConfig.local) {
var localConfig = libraryConfig.local;
// Prefix
if (localConfig.prefix) {
jsMVC.library.prefix = localConfig.prefix;
}
// Files
if (localConfig.files && jQuery.isArray(localConfig.files)) {
var files = localConfig.files;
for (var key in files) {
dynamicWhen.addDeferred(
jsMVC.library.load(jsMVC.config.prefix + jsMVC.library.prefix + files[key])
);
}
}
}
// External
if (libraryConfig.external) {
var externalConfig = libraryConfig.external;
// Sources
if (externalConfig.sources && jQuery.isArray(externalConfig.sources)) {
var sources = externalConfig.sources;
for (var key in sources) {
dynamicWhen.addDeferred(
jsMVC.library.load(sources[key])
);
}
}
}
}
/*** Continue parsing the rest of the config in order. ***/
// Model
if (jsonConfig.model) {
// TODO: Model
}
// View
if (jsonConfig.view) {
var viewConfig = jsonConfig.view;
// Prefix
if (viewConfig.prefix) {
jsMVC.view.prefix = viewConfig.prefix;
}
// Suffix
if (viewConfig.suffix) {
jsMVC.view.suffix = viewConfig.suffix;
}
// Delay min.
if (viewConfig.delayMin) {
jsMVC.view.delayMin = viewConfig.delayMin;
}
// Delay max.
if (viewConfig.delayMax) {
jsMVC.view.delayMax = viewConfig.delayMax;
}
}
// Style
if (jsonConfig.style) {
var styleConfig = jsonConfig.style;
// Prefix
if (styleConfig.prefix) {
jsMVC.style.prefix = styleConfig.prefix;
}
// Suffix
if (styleConfig.suffix) {
jsMVC.style.suffix = styleConfig.suffix;
}
}
// Source
if (jsonConfig.source) {
var sourceConfig = jsonConfig.source;
// Prefix
if (sourceConfig.prefix) {
jsMVC.source.prefix = sourceConfig.prefix;
}
// Suffix
if (sourceConfig.suffix) {
jsMVC.source.suffix = sourceConfig.suffix;
}
}
// Controller
if (jsonConfig.controller) {
var controllerConfig = jsonConfig.controller;
// Application
if (controllerConfig.application) {
var applicationConfig = controllerConfig.application;
// Prefix
if (applicationConfig.prefix) {
jsMVC.controller.application.prefix = applicationConfig.prefix;
}
// Suffix
if (applicationConfig.suffix) {
jsMVC.controller.application.suffix = applicationConfig.suffix;
}
// Delay min.
if (applicationConfig.delayMin) {
jsMVC.controller.application.delayMin = applicationConfig.delayMin;
}
// Delay max.
if (applicationConfig.delayMax) {
jsMVC.controller.application.delayMax = applicationConfig.delayMax;
}
}
// Page
if (controllerConfig.page) {
var pageConfig = controllerConfig.page;
// Prefix
if (pageConfig.prefix) {
jsMVC.controller.page.prefix = pageConfig.prefix;
}
// Suffix
if (pageConfig.suffix) {
jsMVC.controller.page.suffix = pageConfig.suffix;
}
// Delay min.
if (pageConfig.delayMin) {
jsMVC.controller.page.delayMin = pageConfig.delayMin;
}
// Delay max.
if (pageConfig.delayMax) {
jsMVC.controller.page.delayMax = pageConfig.delayMax;
}
}
// View
if (controllerConfig.view) {
var viewConfig = controllerConfig.view;
// Prefix
if (viewConfig.prefix) {
jsMVC.controller.view.prefix = viewConfig.prefix;
}
// Suffix
if (viewConfig.suffix) {
jsMVC.controller.view.suffix = viewConfig.suffix;
}
// Delay min.
if (viewConfig.delayMin) {
jsMVC.controller.view.delayMin = viewConfig.delayMin;
}
// Delay max.
if (viewConfig.delayMax) {
jsMVC.controller.view.delayMax = viewConfig.delayMax;
}
}
}
// Social
if (jsonConfig.social) {
var socialConfig = jsonConfig.social;
// FaceBook
if (socialConfig.facebook) {
var facebookConfig = socialConfig.facebook;
// AppId
if (facebookConfig.appId) {
var appId = facebookConfig.appId;
// TODO: Parse the other FB.init params
// "cookie": false,
// "logging": true,
// "session": null,
// "status": true,
// "xfbml": false,
// "channelUrl": null
// TODO: Use the autoLoad property jsMVC.social.facebook.init(appId);
}
// TODO: AUTOLOAD
}
}
return dynamicWhen.getWhen();
};
// UTILS
// ****************************************************************************
// ****************************************************************************
jsMVC.utils.sleep = function (ms) {
var date = new Date();
var currrentDate = null;
do {
currentDate = new Date();
} while ( currentDate - date < ms );
};
jsMVC.utils.createRandomNumber = function (min, max) {
return Math.floor(Math.random() * (max - min)) + min;
};
jsMVC.utils.createRandomString = function (length) {
var chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
var randomstring = '';
for (var i = 0; i < length; i++) {
var rnum = Math.floor(Math.random() * chars.length);
randomstring += chars.substring(rnum, rnum+1);
}
return randomstring;
};
jsMVC.utils.isLetter = function (character) {
var upChar = character.charAt(0).toUpperCase().charCodeAt(0);
return (upChar >= "A".charCodeAt(0) && upChar <= "Z".charCodeAt(0));
};
jsMVC.utils.getUrlParameter = function (paramName) {
var queryString = location.search;
var regExp = RegExp("[?|&]"+paramName+'=(.+?)(&|$)');
var match = queryString.match(regExp);
if (jQuery.isArray(match)) {
return match[1];
} else {
return null;
}
};
// Allows to add deferreds to a deferred and then get a deferred that waits for all of them.
// TODO: Use an array and pass the array or deferred to jQuery.when to make it simpler.
jsMVC.utils.DynamicWhen = function () {
var when = undefined;
this.addDeferred = function (deferred) {
if (when === undefined) {
when = jQuery.when(deferred);
} else {
when = jQuery.when(when, deferred);
}
};
this.getWhen = function () {
if (when === undefined) {
return jQuery.when(null); // A when that is resolved by default.
} else {
return when;
}
};
};
// DOCUMENT
// ****************************************************************************
// ****************************************************************************
jsMVC.document.createRandomId = function () {
var length = 16;
var randomId = "random-id-" + jsMVC.utils.createRandomString(length);
while (jQuery('#' + randomId).length !== 0) {
randomId = "random-id-" + jsMVC.utils.createRandomString(length);
}
return randomId;
};
jsMVC.document.createRandomClass = function () {
var length = 16;
var randomClass = "random-class-" + jsMVC.utils.createRandomString(length);
while (jQuery('.' + randomClass).length !== 0) {
randomClass = "random-class-" + jsMVC.utils.createRandomString(length);
}
return randomClass;
};
jsMVC.document.clearTitle = function () {
// jQuery('title').html() hungs the browser on IE6
document.title = "";
};
jsMVC.document.setTitle = function (title) {
// jQuery('title').html() hungs the browser on IE6
if (typeof(title) === 'string') {
document.title = title;
}
};
jsMVC.document.getTitle = function () {
// jQuery('title').html() hungs the browser on IE6
return document.title;
};
jsMVC.document.removeFavIconTag = function () {
jQuery('head link[rel~="icon"]').remove();
jQuery('head link[rel~="shortcut"]').remove();
};
jsMVC.document.clearFavIcon = function () {
// DOES NOT WORK ON CHROME AT LEAST!!!!!
jsMVC.document.removeFavIconTag();
jQuery('head').append('<link rel="shortcut icon" href=""></link>');
};
jsMVC.document.setFavIcon = function (imageFile) {
// DOES NOT WORK ON CHROME AT LEAST!!!!!
jsMVC.document.removeFavIconTag();
if (typeof(imageFile) === 'string') {
jQuery('head').append('<link rel="shortcut icon" href="' + jsMVC.image.getUri(imageFile) + '"></link>');
}
};
jsMVC.document.setLanguageCode = function (languageCode) {
if (typeof(languageCode) === 'string') {
jQuery("html").attr("lang", languageCode);
jQuery("html").attr("xml:lang", languageCode);
}
};
// MODEL
// ****************************************************************************
// ****************************************************************************
jsMVC.model = function (controller) {
this.get = function (url, params) {
var settings = {
accepts: "application/json",
cache: false,
contentType: "application/x-www-form-urlencoded",
context: controller,
data: params,
dataType: "json",
type: "GET",
url: url
};
return jQuery.ajax(settings);
};
// Pages fetched with POST are never cached, so the cache and ifModified
// options in jQuery.ajaxSetup() have no effect on these requests.
this.post = function (url, params) {
var settings = {
accepts: "application/json",
cache: false,
contentType: "application/json",
context: controller,
data: JSON.stringify({json: params}),
dataType: "json",
type: "POST",
url: url
};
return jQuery.ajax(settings);
};
};
// VIEW
// ****************************************************************************
// ****************************************************************************
// The path prefix to get the server files.
// Can be overrided with the config file.
jsMVC.view.prefix = "views/";
// The path suffix to get the server files.
// Can be overrided with the config file.
jsMVC.view.suffix = ".html";
// Get the URI of the view.
// Names are treated as java packages (main.footer.Legal is main/footer/Legal.html).
jsMVC.view.getUri = function (viewName) {
return jsMVC.config.prefix +
jsMVC.view.prefix +
viewName.replace(".", "/") +
jsMVC.view.suffix +
jsMVC.config.suffix;
};
// The deferrs of the views that are downloading or downloaded.
jsMVC.view.queue = {};
// An optional extra delay to use when debugging.
// Can be overrided with the config file.
jsMVC.view.delayMin = 0;
jsMVC.view.delayMax = 0;
// Load the view from the server and returns the raw view (String) as a parameter to the done callback of the returned deferred object.
// TODO: Allow to load HTML from a different server (cross domain). Maybe using an iframe, I don't know.
jsMVC.view.load = function (viewName) {
// The deferred to return.
var deferred = jQuery.Deferred();
// Get the download deferred from the queue.
var downloader = jsMVC.view.queue[viewName];
// First time downloading ??
if (downloader === undefined) {
// Create the downloader.
downloader = jQuery.ajax({
url: jsMVC.view.getUri(viewName),
// Returns HTML as plain text;
// Included script tags are evaluated when inserted in the DOM.
dataType: "html"
});
// Fill the queue.
jsMVC.view.queue[viewName] = downloader;
}
// On download done.
downloader.done(function (stringView) {
// If in debug mode add a delay to the request.
if (jsMVC.config.debug) {
setTimeout(
function () {
deferred.resolve(stringView);
},
jsMVC.utils.createRandomNumber(jsMVC.view.delayMin, jsMVC.view.delayMax)
);
} else {
deferred.resolve(stringView);
}
});
// On download fail.
downloader.fail(function (jqXHR, textStatus, errorThrown) {
// Clear queue.
jsMVC.view.queue[viewName] = undefined;
// TODO: Better error message. Use debug mode and apply styles, put a message when dbl click on the view, etc.
deferred.reject(jqXHR, textStatus, errorThrown);
});
// Return the promise only.
return deferred.promise();
};
// STYLE
// ****************************************************************************
// ****************************************************************************
// The path prefix to get the server files.
// Can be overrided with the config file.
jsMVC.style.prefix = "css/";
// The path suffix to get the server files.
// Can be overrided with the config file.
jsMVC.style.suffix = ".css";
// Get the URI of the stylesheet.
// Names are treated as java packages (main.header.Border is main/header/Border.css).
jsMVC.style.getUri = function (styleName) {
return jsMVC.config.prefix +
jsMVC.style.prefix +
styleName.replace('.', '/') +
jsMVC.style.suffix +
jsMVC.config.suffix;
};
// An optional extra delay to use when debugging.
// Can be overrided with the config file.
jsMVC.style.delayMin = 0;
jsMVC.style.delayMax = 0;
// TODO: Use a cache ?
// TODO: Load the stylesheet asynchronically. As text, with an object or new Image().
jsMVC.style.load = function (styleName) {
var deferred = jQuery.Deferred();
jQuery('head').append('<link rel="stylesheet" href="' + jsMVC.style.getUri(styleName) + '" type="text/css"></link>');
// If in debug mode add a delay to the request.
if (jsMVC.config.debug) {
setTimeout(
function () {
deferred.resolve();
},
jsMVC.utils.createRandomNumber(jsMVC.style.delayMin, jsMVC.style.delayMax)
);
} else {
deferred.resolve();
}
return deferred.promise();
};
// IMAGE
// ****************************************************************************
// ****************************************************************************
// The path prefix to get the server files.
// Can be overrided with the config file.
jsMVC.image.prefix = "images/";
// Get the URI of the image file.
// The image file is not treated as a package, is a normal path.
jsMVC.image.getUri = function (imageFile) {
return jsMVC.config.prefix +
jsMVC.image.prefix +
imageFile +
jsMVC.config.suffix;
};
// The deferrs of the images that are downloading or downloaded.
jsMVC.image.queue = {};
// An optional extra delay to use when debugging.
// Can be overrided with the config file.
jsMVC.image.delayMin = 0;
jsMVC.image.delayMax = 0;
// http://developer.yahoo.com/yui/imageloader/
// http://jqueryfordesigners.com/image-loading/
// http://www.appelsiini.net/projects/lazyload
// http://wpleet.com/how-to-preload-an-image-using-jquery-javascript/
// Load the image from the server and returns the imageUri and image object as a parameter to the done callback of the returned deferred object.
jsMVC.image.load = function (imageUri) {
// The deferred to return.
var deferred = jQuery.Deferred();
// Get the download deferred from the queue.
var downloader = jsMVC.image.queue[imageUri];
// First time downloading ??
if (downloader === undefined) {
// Create the downloader.
downloader = jQuery.Deferred();
var image = jQuery(new Image())
.load(function () {
downloader.resolve(imageUri, image);
})
.error(function () {
downloader.reject(imageUri, image);
})
.attr("src", imageUri);
// Fill the queue.
jsMVC.image.queue[imageUri] = downloader;
}
// On download done.
downloader.done(function (uri, image) {
// If in debug mode add a delay to the request.
if (jsMVC.config.debug) {
setTimeout(
function () {
deferred.resolve(uri, image);
},
jsMVC.utils.createRandomNumber(jsMVC.image.delayMin, jsMVC.image.delayMax)
);
} else {
deferred.resolve(uri, image);
}
});
// On download fail.
downloader.fail(function (uri, image) {
deferred.reject(uri, image);
});
// Return the promise only.
return deferred.promise();
};
// TRANSLATION
// ****************************************************************************
// ****************************************************************************
// The path prefix to get the server files.
// Can be overrided with the config file.
jsMVC.translation.prefix = "translations/";
// The path suffix to get the server files.
// Can be overrided with the config file.
jsMVC.translation.suffix = ".json";
// Get the URI of the translationName class.
// Names are treated as java packages (person.Employee is person/Employee.json).
jsMVC.translation.getUri = function (translationName) {
return jsMVC.config.prefix +
jsMVC.translation.prefix +
translationName.replace(".", "/") +
jsMVC.translation.suffix +
jsMVC.config.suffix;
};
// The main translation object, generated with all the global translations
jsMVC.translation.main = {};
// Translation files indexed by name.
jsMVC.translation.cache = {};
// Loads the translation json file and call the callback with the javascript object as its only parameter.
jsMVC.translation.load = function (translationName, onSuccessCallback) {
var jsonTranslation = jsMVC.translation.cache[translationName];
if (jsonTranslation !== undefined) {
if (onSuccessCallback !== undefined && jQuery.isFunction(onSuccessCallback)) {
onSuccessCallback(jsonTranslation);
}
return null; // To use with a deferred, evalutes to ready.
} else {
return jQuery.ajax({ // Returns a deferred.
url: jsMVC.translation.getUri(translationName),
dataType: "json", // Evaluates as JSON and returns a JavaScript object. Any malformed JSON is rejected and a parse error is thrown.
success: function (jsonTranslation) {
jsMVC.translation.cache[translationName] = jsonTranslation;
if (onSuccessCallback !== undefined && jQuery.isFunction(onSuccessCallback)) {
onSuccessCallback(jsonTranslation);
}
},
error: function (a, err, c) {
if (err === "parsererror") {
jsMVC.error.log("Translation " + translationName + " parse error");
} else {
jsMVC.error.log("Translation " + translationName + " not loaded (" + c + ")");
}
}
});
}
};
// Ads every property found on the loaded file to the main translation file.
jsMVC.translation.addToMain = function (translationName, onFinishCallback) {
jsMVC.translation.load(
translationName,
function (jsonTranslation) {
for (var key in jsonTranslation) {
jsMVC.translation.main[key] = jsonTranslation[key];
}
if (onFinishCallback !== undefined && jQuery.isFunction(onFinishCallback)) {
onFinishCallback();
}
}
);
};
// LIBRARY
// ****************************************************************************
// ****************************************************************************
// The path prefix to get the server files.
// Can be overrided with the config file.
jsMVC.library.prefix = "lib/";
// TODO: getUri
// The deferrs of the views that are downloading or downloaded.
jsMVC.library.queue = {};
// An optional extra delay to use when debugging.
// Can be overrided with the config file.
jsMVC.library.delayMin = 0;
jsMVC.library.delayMax = 0;
// Load and execute a script, returns a deferred object. If the second parameter is True the execution is blocking!
// TODO: Separate download from execution, see controlJS, from Steve Souders website.
// When a script is added the browser blocks until it is downloaded, parsed and ran.
// It's part of the specification to avoid dependency conclicts.
jsMVC.library.load = function (scriptUri, sync) {
// The deferred to return.
var deferred = jQuery.Deferred();
// Get the download deferred from the queue.
var downloader = jsMVC.library.queue[scriptUri];
// First time downloading ??
if (downloader === undefined) {
// Create the downloader.
downloader = jQuery.ajax({
url: scriptUri,
async: sync ? false : true,
dataType: 'script'
});
// Fill the queue.
jsMVC.library.queue[scriptUri] = downloader;
}
// On download done.
downloader.done(function (stringScript) {
if (jsMVC.config.debug && !sync) {
setTimeout(
function () {
deferred.resolve(stringScript);
},
Math.floor(Math.random()*(jsMVC.library.delayMax - jsMVC.library.delayMin)) + jsMVC.library.delayMin
);
} else {
deferred.resolve(stringScript);
}
});
// On download fail.
downloader.fail(function (jqXHR, textStatus, errorThrown) {
deferred.reject(jqXHR, textStatus, errorThrown);
});
// Return the promise only.
return deferred.promise();
};
// CLASSES
// ****************************************************************************
// ****************************************************************************
// Given a class name, a cache and a function to generate the file URI it instantiates a new object.
// When the javascript is loaded with jsMVC.library.load, the loaded class must appear on the cache.
jsMVC.classes.createNewInstance = function (className, cache, fileUriGeneratorFunction, sync) {
var loadingDeferred = null;
if (cache[className] === undefined) {
// The loaded scripts are a function call that add something to the cache!
loadingDeferred = jsMVC.library.load(fileUriGeneratorFunction(className), sync);
}
var deferred = jQuery.Deferred();
var loadingWhen = jQuery.when(loadingDeferred);
loadingWhen.done(function () {
var classDefinition = cache[className];
var classMetadata = classDefinition.classMetadata;
var classConstructor = classDefinition.classConstructor;
if (classMetadata.parentName) {