forked from Q42/TrelloScrum
-
Notifications
You must be signed in to change notification settings - Fork 0
/
trelloscrum.js
918 lines (811 loc) · 34.8 KB
/
trelloscrum.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
/*
** Scrum for Trello- https://github.com/Q42/TrelloScrum
** Adds Scrum to your Trello
**
** Original:
** Jasper Kaizer <https://github.com/jkaizer>
** Marcel Duin <https://github.com/marcelduin>
**
** Contribs:
** Paul Lofte <https://github.com/paullofte>
** Nic Pottier <https://github.com/nicpottier>
** Bastiaan Terhorst <https://github.com/bastiaanterhorst>
** Morgan Craft <https://github.com/mgan59>
** Frank Geerlings <https://github.com/frankgeerlings>
** Cedric Gatay <https://github.com/CedricGatay>
** Kit Glennon <https://github.com/kitglen>
** Samuel Gaus <https://github.com/gausie>
** Sean Colombo <https://github.com/seancolombo>
**
*/
// Thanks @unscriptable - http://unscriptable.com/2009/03/20/debouncing-javascript-methods/
var debounce = function (func, threshold, execAsap) {
var timeout;
return function debounced () {
var obj = this, args = arguments;
function delayed () {
if (!execAsap)
func.apply(obj, args);
timeout = null;
};
if (timeout)
clearTimeout(timeout);
else if (execAsap)
func.apply(obj, args);
timeout = setTimeout(delayed, threshold || 100);
};
}
// For MutationObserver
var obsConfig = { childList: true, characterData: true, attributes: false, subtree: true };
//default story point picker sequence (can be overridden in the Scrum for Trello 'Settings' popup)
var _pointSeq = ['?', 0, .5, 1, 2, 3, 5, 8, 13, 21];
//attributes representing points values for card
var _pointsAttr = ['cpoints', 'points'];
// All settings and their defaults.
var S4T_SETTINGS = [];
var SETTING_NAME_LINK_STYLE = "burndownLinkStyle";
var SETTING_NAME_ESTIMATES = "estimatesSequence";
var S4T_ALL_SETTINGS = [SETTING_NAME_LINK_STYLE, SETTING_NAME_ESTIMATES];
var S4T_SETTING_DEFAULTS = {};
S4T_SETTING_DEFAULTS[SETTING_NAME_LINK_STYLE] = 'full';
S4T_SETTING_DEFAULTS[SETTING_NAME_ESTIMATES] = _pointSeq.join();
refreshSettings(); // get the settings right away (may take a little bit if using Chrome cloud storage)
//internals
var reg = /((?:^|\s))\((\x3f|\d*\.?\d+)(\))\s?/m, //parse regexp- accepts digits, decimals and '?', surrounded by ()
regC = /((?:^|\s))\[(\x3f|\d*\.?\d+)(\])\s?/m, //parse regexp- accepts digits, decimals and '?', surrounded by []
iconUrl, pointsDoneUrl,
flameUrl, flame18Url,
scrumLogoUrl, scrumLogo18Url;
if(typeof chrome !== 'undefined'){
// Works in Chrome
iconUrl = chrome.extension.getURL('images/storypoints-icon.png');
pointsDoneUrl = chrome.extension.getURL('images/points-done.png');
flameUrl = chrome.extension.getURL('images/burndown_for_trello_icon_12x12.png');
flame18Url = chrome.extension.getURL('images/burndown_for_trello_icon_18x18.png');
scrumLogoUrl = chrome.extension.getURL('images/trello-scrum-icon_12x12.png');
scrumLogo18Url = chrome.extension.getURL('images/trello-scrum-icon_18x18.png');
} else if(navigator.userAgent.indexOf('Safari') != -1){ // Chrome defines both "Chrome" and "Safari", so this test MUST be done after testing for Chrome
// Works in Safari
iconUrl = safari.extension.baseURI + 'images/storypoints-icon.png';
pointsDoneUrl = safari.extension.baseURI + 'images/points-done.png';
flameUrl = safari.extension.baseURI + 'images/burndown_for_trello_icon_12x12.png';
flame18Url = safari.extension.baseURI + 'images/burndown_for_trello_icon_18x18.png';
scrumLogoUrl = safari.extension.baseURI + 'images/trello-scrum-icon_12x12.png';
scrumLogo18Url = safari.extension.baseURI + 'images/trello-scrum-icon_18x18.png';
} else {
// Works in Firefox Add-On
if(typeof self.options != 'undefined'){ // options defined in main.js
iconUrl = self.options.iconUrl;
pointsDoneUrl = self.options.pointsDoneUrl;
flameUrl = self.options.flameUrl;
flame18Url = self.options.flame18Url;
scrumLogoUrl = self.options.scrumLogoUrl;
scrumLogo18Url = self.options.scrumLogo18Url;
}
}
function round(_val) {return (Math.round(_val * 100) / 100)};
// Comment out before release - makes cross-browser debugging easier.
//function log(msg){
// if(typeof chrome !== 'undefined'){
// console.log(msg);
// } else {
// $($('.header-btn-text').get(0)).text(msg);
// }
//}
// Some browsers have serious errors with MutationObserver (eg: Safari doesn't have it called MutationObserver).
var CrossBrowser = {
init: function(){
this.MutationObserver = window.MutationObserver || window.WebKitMutationObserver || window.MozMutationObserver || null;
}
};
CrossBrowser.init();
//what to do when DOM loads
$(function(){
//watch filtering
function updateFilters() {
setTimeout(calcListPoints);
};
$('.js-toggle-label-filter, .js-select-member, .js-due-filter, .js-clear-all').live('mouseup', calcListPoints);
$('.js-input').live('keyup', calcListPoints);
$('.js-share').live('mouseup',function(){
setTimeout(checkExport,500)
});
calcListPoints();
});
// Recalculates every card and its totals (used for significant DOM modifications).
var recalcListAndTotal = debounce(function($el){
($el||$('.list')).each(function(){
if(!this.list) new List(this);
else if(this.list.refreshList){
this.list.refreshList(); // make sure each card's points are still accurate (also calls list.calc()).
}
})
}, 500, false);
var recalcTotalsObserver = new CrossBrowser.MutationObserver(function(mutations)
{
// Determine if the mutation event included an ACTUAL change to the list rather than
// a modification caused by this extension making an update to points, etc. (prevents
// infinite recursion).
var doFullRefresh = false;
var refreshJustTotals = false;
$.each(mutations, function(index, mutation){
var $target = $(mutation.target);
// Ignore a bunch of known cases that send mutation events which don't require us to recalcListAndTotal.
if(! ($target.hasClass('list-total')
|| $target.hasClass('list-title')
|| $target.hasClass('list-header')
|| $target.hasClass('date') // the 'time-ago' functionality changes date spans every minute
|| $target.hasClass('js-phrase') // this is constantly updated by Trello, but doesn't affect estimates.
|| $target.hasClass('member')
|| $target.hasClass('clearfix')
|| $target.hasClass('badges')
|| $target.hasClass('header-btn-text')
|| (typeof mutation.target.className == "undefined")
))
{
if($target.hasClass('badge')){
if(!$target.hasClass("consumed")){
refreshJustTotals = true;
}
} else {
// It appears this was an actual modification and not a recursive notification.
doFullRefresh = true;
}
}
});
if(doFullRefresh){
recalcListAndTotal();
} else if(refreshJustTotals){
calcListPoints();
}
$editControls = $(".card-detail-title .edit-controls");
if($editControls.length > 0)
{
showPointPicker($editControls.get(0));
}
});
recalcTotalsObserver.observe(document.body, obsConfig);
// Refreshes the link to the Burndown Chart dialog.
function updateBurndownLink(){
// Add the link for Burndown Charts
//$('.s4tLink').remove();
if($('.s4tLink').length === 0){
var buttons = "";
// Link for Burndown Charts
var linkSetting = S4T_SETTINGS[SETTING_NAME_LINK_STYLE];
if(linkSetting !== 'none'){
buttons += "<a id='burndownLink' class='s4tLink quiet ed board-header-btn dark-hover' href='#'>";
buttons += "<span class='icon-sm board-header-btn-icon'><img src='"+flameUrl+"' width='12' height='12'/></span>";
if(linkSetting !== 'icon'){
buttons += "<span class='text board-header-btn-text'>Burndown Chart</span>";
}
buttons += "</a>";
}
// Link for settings
buttons += "<a id='scrumSettingsLink' class='s4tLink quiet ed board-header-btn dark-hover' href='#'>";
buttons += "<span class='icon-sm board-header-btn-icon'><img src='"+scrumLogoUrl+"' width='12' height='12' title='Settings: Scrum for Trello'/></span>";
//buttons += "<span class='text board-header-btn-text'>Settings</span>"; // too big :-/ icon only for now
buttons += "</a>";
var showOnLeft = true;
if(showOnLeft){
$('.board-header-btns.left').last().after(buttons);
} else {
$('.board-header-btns.right,#board-header a').last().after(buttons);
}
$('#burndownLink').click(showBurndown);
$('#scrumSettingsLink').click(showSettings);
}
}
var ignoreClicks = function(){ return false; };
function showBurndown()
{
$('body').addClass("window-up");
$('.window').css("display", "block").css("top", "50px");
// Figure out the current user and board.
$memberObj = $('.header-user .member-avatar');
if($memberObj.length == 0){
$memberObj = $('.header-user .member-initials'); // if the user doesn't have an icon
}
var username = $memberObj.attr('title').match(/\(([^\)\(]*?)\)$/)[1];
// Find the short-link board name, etc. so that the back-end can figure out what board this is.
var shortLink = document.location.href.match(/b\/([A-Za-z0-9]{8})\//)[1];
var boardName = "";
boardName = $('.board-name span.text').text().trim();
// Build the dialog DOM elements. There are no unescaped user-provided strings being used here.
var clearfix = $('<div/>', {class: 'clearfix'});
var windowHeaderUtils = $('<div/>', {class: 'window-header-utils dialog-close-button'}).append( $('<a/>', {class: 'icon-lg icon-close dark-hover js-close-window', href: '#', title:'Close this dialog window.'}) );
var iFrameWrapper = $('<div/>', {style: 'padding:10px; padding-top: 13px;'});
var flameIcon = $('<img/>', {style: 'position:absolute; margin-left: 20px; margin-top:15px;', src:flame18Url});
var actualIFrame = $('<iframe/>', {frameborder: '0',
style: 'width: 670px; height: 512px;',
id: 'burndownFrame',
src: "https://www.burndownfortrello.com/s4t_burndownPopup.php?username="+encodeURIComponent(username)+"&shortLink="+encodeURIComponent(shortLink)+"&boardName="+encodeURIComponent(boardName)
});
var loadingFrameIndicator = $('<span/>', {class: 'js-spinner', id: 'loadingBurndownFrame', style: 'position: absolute; left: 225px; top: 260px;'}).append($('<span/>', {class: 'spinner left', style: 'margin-right:4px;'})).append("Loading 'Burndown for Trello'...");
iFrameWrapper.append(loadingFrameIndicator); // this will show that the iframe is loading... until it loads.
iFrameWrapper.append(actualIFrame);
actualIFrame.css("visibility", "hidden");
$windowWrapper = $('.window-wrapper');
$windowWrapper.click(ignoreClicks);
$windowWrapper.empty().append(clearfix).append(flameIcon).append(windowHeaderUtils).append(iFrameWrapper);
$('#burndownFrame').load(function(){ $('#loadingBurndownFrame').remove(); actualIFrame.css("visibility", "visible"); }); // once the iframe loads, get rid of the loading indicator.
$('.window-header-utils a.js-close-window').click(hideBurndown);
$(window).bind('resize', repositionBurndown);
$('.window-overlay').bind('click', hideBurndown);
repositionBurndown();
}
var settingsFrameId = 'settingsFrame';
function showSettings()
{
$('body').addClass("window-up");
$('.window').css("display", "block").css("top", "50px");
// Build the dialog DOM elements. There are no unescaped user-provided strings being used here.
var clearfix = $('<div/>', {class: 'clearfix'});
var windowHeaderUtils = $('<div/>', {class: 'window-header-utils dialog-close-button'}).append( $('<a/>', {class: 'icon-lg icon-close dark-hover js-close-window', href: '#', title:'Close this dialog window.'}) );
var settingsIcon = $('<img/>', {style: 'position:absolute; margin-left: 20px; margin-top:15px;', src:scrumLogo18Url});
// Create the Settings form.
{
// Load the current settings (with defaults in case Settings haven't been set).
var setting_link = S4T_SETTINGS[SETTING_NAME_LINK_STYLE];
var setting_estimateSeq = S4T_SETTINGS[SETTING_NAME_ESTIMATES];
var settingsDiv = $('<div/>', {style: "padding:0px 10px;font-family:'Helvetica Neue', Arial, Helvetica, sans-serif;"});
var iframeHeader = $('<h3/>', {style: 'text-align: center;'});
iframeHeader.text('Scrum for Trello');
var settingsHeader = $('<h3/>', {style: 'text-align: center;margin-bottom:0px'});
settingsHeader.text('Settings');
var settingsInstructions = $('<div/>', {style: 'margin-bottom:10px'}).html('These settings affect how Scrum for Trello appears to <em>you</em> on all boards. When you're done, remember to click "Save Settings" below.');
var settingsForm = $('<form/>', {id: 'scrumForTrelloForm'});
// How the 'Burndown Chart' link should appear (if at all).
var fieldset_burndownLink = $('<fieldset/>');
var legend_burndownLink = $('<legend/>');
legend_burndownLink.text("Burndown Chart link");
var burndownLinkSetting_radioName = 'burndownLinkSetting';
fieldset_burndownLink.append(legend_burndownLink);
var burndownRadio_full = $('<input/>', {type: 'radio', name: burndownLinkSetting_radioName, id: 'link_full', value: 'full'});
if(setting_link == 'full'){
burndownRadio_full.prop('checked', true);
}
var label_full = $('<label/>', {for: 'link_full'});
label_full.text('Enable "Burndown Chart" link (recommended)');
fieldset_burndownLink.append(burndownRadio_full).append(label_full).append("<br/>");
var burndownRadio_icon = $('<input/>', {type: 'radio', name: burndownLinkSetting_radioName, id: 'link_icon', value: 'icon'});
if(setting_link == 'icon'){
burndownRadio_icon.prop('checked', true);
}
var label_icon = $('<label/>', {for: 'link_icon'});
label_icon.text('Icon only');
fieldset_burndownLink.append(burndownRadio_icon).append(label_icon).append("<br/>");
var burndownRadio_none = $('<input/>', {type: 'radio', name: burndownLinkSetting_radioName, id: 'link_none', value: 'none'});
if(setting_link == 'none'){
burndownRadio_none.prop('checked', true);
}
var label_none = $('<label/>', {for: 'link_none'});
label_none.text('Disable completely');
fieldset_burndownLink.append(burndownRadio_none).append(label_none).append("<br/>");
// Which estimate buttons should show up.
var fieldset_estimateButtons = $('<fieldset/>', {style: 'margin-top:5px'});
var legend_estimateButtons = $('<legend/>');
legend_estimateButtons.text("Estimate Buttons");
fieldset_estimateButtons.append(legend_estimateButtons);
var explanation = $('<div/>').text("List out the values you want to appear on the estimate buttons, separated by commas. They can be whole numbers, decimals, or a question mark.");
fieldset_estimateButtons.append(explanation);
var estimateFieldId = 'pointSequenceToUse';
var estimateField = $('<input/>', {id: estimateFieldId, size: 40, val: setting_estimateSeq});
fieldset_estimateButtons.append(estimateField);
var titleTextStr = "Original sequence is: " + _pointSeq.join();
var restoreDefaultsButton = $('<button/>')
.text('restore to original values')
.attr('title', titleTextStr)
.click(function(e){
e.preventDefault();
$('#'+settingsFrameId).contents().find('#'+estimateFieldId).val(_pointSeq.join());
});
fieldset_estimateButtons.append(restoreDefaultsButton);
var saveButton = $('<button/>', {style:'margin-top:5px'}).text('Save Settings').click(function(e){
e.preventDefault();
// Save the settings (persists them using Chrome cloud, LocalStorage, or Cookies - in that order of preference if available).
S4T_SETTINGS[SETTING_NAME_LINK_STYLE] = $('#'+settingsFrameId).contents().find('input:radio[name='+burndownLinkSetting_radioName+']:checked').val();
S4T_SETTINGS[SETTING_NAME_ESTIMATES] = $('#'+settingsFrameId).contents().find('#'+estimateFieldId).val();
// Persist all settings.
$.each(S4T_ALL_SETTINGS, function(i, settingName){
saveSetting(settingName, S4T_SETTINGS[settingName]);
});
// Allow the UI to update itself as needed.
onSettingsUpdated();
});
var savedIndicator = $('<span/>', {id: 's4tSaved', style: 'color:#080;background-color:#afa;font-weight:bold;display:none;margin-left:10px'})
.text("Saved!");
// Set up the form (all added down here to be easier to change the order).
settingsForm.append(fieldset_burndownLink);
settingsForm.append(fieldset_estimateButtons);
settingsForm.append(saveButton);
settingsForm.append(savedIndicator);
}
// Quick start instructions.
var quickStartDiv = $('<div>\
<h4 style="margin-top:0px;margin-bottom:0px">Getting started</h4>\
<ol style="margin-top:0px">\
<li>To add an estimate to a card, first <strong>click a card</strong> to open it</li>\
<li><strong>Click the title of the card</strong> to "edit" the title.</li>\
<li>Once the Card title is in edit-mode, blue number buttons will appear. <strong>Click one of the buttons</strong> to set that as the estimate.</li>\
</ol>\
</div>');
var moreInfoLink = $('<small>For more information, see <a href="http://scrumfortrello.com">ScrumForTrello.com</a></small>');
// Add each of the components to build the iframe (all done here to make it easier to re-order them).
settingsDiv.append(iframeHeader);
settingsDiv.append(quickStartDiv);
settingsDiv.append(settingsHeader);
settingsDiv.append(settingsInstructions);
settingsDiv.append(settingsForm);
settingsDiv.append(moreInfoLink);
// Trello swallows normal input, so things like checkboxes and radio buttons don't work right... so we stuff everything in an iframe.
var iframeObj = $('<iframe/>', {frameborder: '0',
style: 'width: 670px; height: 528px;', /* 512 was fine on Chrome, but FF requires 528 to avoid scrollbars */
id: settingsFrameId,
});
$windowWrapper = $('.window-wrapper');
$windowWrapper.click(ignoreClicks);
$windowWrapper.empty().append(clearfix).append(settingsIcon).append(windowHeaderUtils);
iframeObj.appendTo($windowWrapper);
// Firefox wil load the iframe (even if there is no 'src') and overwrite the existing HTML, so we've
// reworked this to load about:blank then set our HTML upon load completion.
iframeObj.load(function(){
iframeObj.contents().find('body').append(settingsDiv);
});
iframeObj.attr('src', "about:blank"); // need to set this AFTER the .load() has been registered.
$('.window-header-utils a.js-close-window').click(hideBurndown);
$(window).bind('resize', repositionBurndown);
$('.window-overlay').bind('click', hideBurndown);
repositionBurndown();
}
function hideBurndown()
{
$('body').removeClass("window-up");
$('.window').css("display", "none");
$(window).unbind('resize', repositionBurndown);
$('.window-header-utils a.js-close-window').unbind('click', hideBurndown);
$('.window-wrapper').unbind('click', ignoreClicks);
$('.window-overlay').unbind('click', hideBurndown);
}
function repositionBurndown()
{
// NOTE: With the most recent Trello update, I don't think we have to position the window manually anymore.
//windowWidth = $(window).width();
//if(windowWidth < 0) // todo change this to a n actual number (probably 710 or so)
//{
// // todo shrink our iframe to an appropriate size. contents should wrap
//}
//else
//{
// burndownWindowWidth = 690;
// leftPadding = (windowWidth - burndownWindowWidth) / 2.0;
// $('.window').css("left", leftPadding);
//}
}
//calculate board totals
var ctto;
function computeTotal(){
clearTimeout(ctto);
ctto = setTimeout(function(){
var $title = $('.board-header-btns.right,#board-header a');
var $total = $title.children('.list-total').empty();
if ($total.length == 0)
$total = $('<span/>', {class: "list-total"}).appendTo($title);
for (var i in _pointsAttr){
var score = 0,
attr = _pointsAttr[i];
$('#board .list-total .'+attr).each(function(){
score+=parseFloat(this.textContent)||0;
});
var scoreSpan = $('<span/>', {class: attr}).text(round(score)||'');
$total.append(scoreSpan);
}
updateBurndownLink(); // the burndown link and the total are on the same bar... so now they'll be in sync as to whether they're both there or not.
});
};
//calculate list totals
var lto;
function calcListPoints(){
clearTimeout(lto);
lto = setTimeout(function(){
$('.list').each(function(){
if(!this.list) new List(this);
else if(this.list.calc) this.list.calc();
});
});
};
//.list pseudo
function List(el){
if(el.list)return;
el.list=this;
var $list=$(el),
$total=$('<span class="list-total">'),
busy = false,
to,
to2;
function readCard($c){
if($c.target) {
if(!/list-card/.test($c.target.className)) return;
$c = $($c.target).filter('.list-card:not(.placeholder)');
}
$c.each(function(){
if(!this.listCard) for (var i in _pointsAttr)
new ListCard(this,_pointsAttr[i]);
else for (var i in _pointsAttr)
setTimeout(this.listCard[_pointsAttr[i]].refresh);
});
};
// All calls to calc are throttled to happen no more than once every 500ms (makes page-load and recalculations much faster).
var self = this;
this.calc = debounce(function(){
self._calcInner();
}, 500, true); // executes right away unless over its 500ms threshold since the last execution
this._calcInner = function(e){ // don't call this directly. Call calc() instead.
//if(e&&e.target&&!$(e.target).hasClass('list-card')) return; // TODO: REMOVE - What was this? We never pass a param into this function.
clearTimeout(to);
to = setTimeout(function(){
$total.empty().appendTo($list.find('.list-title,.list-header'));
for (var i in _pointsAttr){
var score=0,
attr = _pointsAttr[i];
$list.find('.list-card:not(.placeholder)').each(function(){
if(!this.listCard) return;
if(!isNaN(Number(this.listCard[attr].points))){
// Performance note: calling :visible in the selector above leads to noticible CPU usage.
if(jQuery.expr.filters.visible(this)){
score+=Number(this.listCard[attr].points);
}
}
});
var scoreTruncated = round(score);
var scoreSpan = $('<span/>', {class: attr}).text( (scoreTruncated>0) ? scoreTruncated : '' );
$total.append(scoreSpan);
computeTotal();
}
});
};
this.refreshList = debounce(function(){
readCard($list.find('.list-card:not(.placeholder)'));
this.calc(); // readCard will call this.calc() if any of the cards get refreshed.
}, 500, false);
var cardAddedRemovedObserver = new CrossBrowser.MutationObserver(function(mutations)
{
// Determine if the mutation event included an ACTUAL change to the list rather than
// a modification caused by this extension making an update to points, etc. (prevents
// infinite recursion).
$.each(mutations, function(index, mutation){
var $target = $(mutation.target);
// Ignore a bunch of known elements that send mutation events.
if(! ($target.hasClass('list-total')
|| $target.hasClass('list-title')
|| $target.hasClass('list-header')
|| $target.hasClass('badge-points')
|| $target.hasClass('badges')
|| (typeof mutation.target.className == "undefined")
))
{
var list;
// It appears this was an actual mutation and not a recursive notification.
$list = $target.closest(".list");
if($list.length > 0){
list = $list.get(0).list;
if(!list){
list = new List(mutation.target);
}
if(list){
list.refreshList(); // debounced, so its safe to call this multiple times for the same list in this loop.
}
}
}
});
});
cardAddedRemovedObserver.observe($list.get(0), obsConfig);
setTimeout(function(){
readCard($list.find('.list-card'));
setTimeout(el.list.calc);
});
};
//.list-card pseudo
function ListCard(el, identifier){
if(el.listCard && el.listCard[identifier]) return;
//lazily create object
if (!el.listCard){
el.listCard={};
}
el.listCard[identifier]=this;
var points=-1,
consumed=identifier!=='points',
regexp=consumed?regC:reg,
parsed,
that=this,
busy=false,
$card=$(el),
$badge=$('<div class="badge badge-points point-count" style="background-image: url('+iconUrl+')"/>'),
to,
to2;
// MutationObservers may send a bunch of similar events for the same card (also depends on browser) so
// refreshes are debounced now.
var self = this;
this.refresh = debounce(function(){
self._refreshInner();
}, 250, true); // executes right away unless over its 250ms threshold
this._refreshInner=function(){
if(busy) return;
busy = true;
clearTimeout(to);
to = setTimeout(function(){
var $title=$card.find('a.list-card-title');
if(!$title[0])return;
var titleTextContent = $title[0].childNodes[1].textContent;
if(titleTextContent) el._title = titleTextContent;
// Get the stripped-down (parsed) version without the estimates, that was stored after the last change.
var parsedTitle = $title.data('parsed-title');
if(titleTextContent != parsedTitle){
// New card title, so we have to parse this new info to find the new amount of points.
parsed=titleTextContent.match(regexp);
points=parsed?parsed[2]:-1;
} else {
// Title text has already been parsed... process the pre-parsed title to get the correct points.
var origTitle = $title.data('orig-title');
parsed=origTitle.match(regexp);
points=parsed?parsed[2]:-1;
}
clearTimeout(to2);
to2 = setTimeout(function(){
// Add the badge (for this point-type: regular or consumed) to the badges div.
$badge
.text(that.points)
[(consumed?'add':'remove')+'Class']('consumed')
.attr({title: 'This card has '+that.points+ (consumed?' consumed':'')+' storypoint' + (that.points == 1 ? '.' : 's.')})
.prependTo($card.find('.badges'));
// Update the DOM element's textContent and data if there were changes.
if(titleTextContent != parsedTitle){
$title.data('orig-title', titleTextContent); // store the non-mutilated title (with all of the estimates/time-spent in it).
}
parsedTitle = $.trim(el._title.replace(reg,'$1').replace(regC,'$1'));
el._title = parsedTitle;
$title.data('parsed-title', parsedTitle); // save it to the DOM element so that both badge-types can refer back to it.
$title[0].childNodes[1].textContent = parsedTitle;
var list = $card.closest('.list');
if(list[0]){
list[0].list.calc();
}
busy = false;
});
});
};
this.__defineGetter__('points',function(){
return parsed?points:''
});
var cardShortIdObserver = new CrossBrowser.MutationObserver(function(mutations){
$.each(mutations, function(index, mutation){
var $target = $(mutation.target);
if(mutation.addedNodes.length > 0){
$.each(mutation.addedNodes, function(index, node){
if($(node).hasClass('card-short-id')){
// Found a card-short-id added to the DOM. Need to refresh this card.
var listElement = $target.closest('.list').get(0);
if(!listElement.list) new List(listElement); // makes sure the .list in the DOM has a List object
var $card = $target.closest('.list-card');
if($card.length > 0){
var listCardHash = $card.get(0).listCard;
if(listCardHash){
// The hash contains a ListCard object for each type of points (cpoints, points, possibly more in the future).
$.each(_pointsAttr, function(index, pointsAttr){
listCardHash[pointsAttr].refresh();
});
}
}
}
});
}
});
});
// The MutationObserver is only attached once per card (for the non-consumed-points ListCard) and that Observer will make the call
// to update BOTH types of points-badges.
if(!consumed){
var observerConfig = { childList: true, characterData: false, attributes: false, subtree: true };
cardShortIdObserver.observe(el, observerConfig);
}
setTimeout(that.refresh);
};
//the story point picker
function showPointPicker(location) {
if($(location).find('.picker').length) return;
var $picker = $('<div/>', {class: "picker"}).appendTo('.card-detail-title .edit-controls');
$picker.append($('<span>', {class: "picker-title"}).text("Estimated Points"));
var estimateSequence = (S4T_SETTINGS[SETTING_NAME_ESTIMATES].replace(/ /g, '')).split(',');
for (var i in estimateSequence) $picker.append($('<span>', {class: "point-value"}).text(estimateSequence[i]).click(function(){
var value = $(this).text();
var $text = $('.card-detail-title .edit textarea');
var text = $text.val();
// replace our new
$text[0].value=text.match(reg)?text.replace(reg, '('+value+') '):'('+value+') ' + text;
// then click our button so it all gets saved away
$(".card-detail-title .edit .js-save-edit").click();
return false
}))
if($(location).find('.picker-consumed').length) return;
var $pickerConsumed = $('<div/>', {class: "picker-consumed"}).appendTo('.card-detail-title .edit-controls');
$pickerConsumed.append($('<span>', {class: "picker-title"}).text("Consumed Points"));
var consumedSequence = (S4T_SETTINGS[SETTING_NAME_ESTIMATES]).split(',');
for (var i in consumedSequence) $pickerConsumed.append($('<span>', {class: "point-value"}).text(consumedSequence[i]).click(function(){
var value = $(this).text();
var $text = $('.card-detail-title .edit textarea');
var text = $text.val();
// replace our new
$text[0].value=text.match(regC)?text.replace(regC, ' ['+value+']'):text + ' ['+value+']';
// then click our button so it all gets saved away
$(".card-detail-title .edit .js-save-edit").click();
return false
}))
};
//for export
var $excel_btn,$excel_dl;
window.URL = window.webkitURL || window.URL;
function checkExport() {
if($excel_btn && $excel_btn.filter(':visible').length) return;
if($('.pop-over-list').find('.js-export-excel').length) return;
var $js_btn = $('.pop-over-list').find('.js-export-json');
var $ul = $js_btn.closest('ul:visible');
if(!$js_btn.length) return;
$js_btn.parent().after($('<li>').append(
$excel_btn = $('<a href="#" target="_blank" title="Open downloaded file with Excel">Excel</a>')
.click(showExcelExport)
))
};
function showExcelExport() {
$excel_btn.text('Generating...');
$.getJSON($('.pop-over-list').find('.js-export-json').attr('href'), function(data) {
var s = '<table id="export" border=1>';
s += '<tr><th>Points</th><th>Story</th><th>Description</th></tr>';
$.each(data['lists'], function(key, list) {
var list_id = list["id"];
s += '<tr><th colspan="3">' + list['name'] + '</th></tr>';
$.each(data["cards"], function(key, card) {
if (card["idList"] == list_id) {
var title = card["name"];
var parsed = title.match(reg);
var points = parsed?parsed[1]:'';
title = title.replace(reg,'');
s += '<tr><td>'+ points + '</td><td>' + title + '</td><td>' + card["desc"] + '</td></tr>';
}
});
s += '<tr><td colspan=3></td></tr>';
});
s += '</table>';
var blob = new Blob([s],{type:'application/ms-excel'});
var board_title_reg = /.*\/(.*)$/;
var board_title_parsed = document.location.href.match(board_title_reg);
var board_title = board_title_parsed[1];
$excel_btn
.text('Excel')
.after(
$excel_dl=$('<a>')
.attr({
download: board_title + '.xls',
href: window.URL.createObjectURL(blob)
})
);
var evt = document.createEvent('MouseEvents');
evt.initMouseEvent('click', true, true, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null);
$excel_dl[0].dispatchEvent(evt);
$excel_dl.remove()
});
return false
};
// for settings
function useChromeStorage(){
return ((typeof chrome !== "undefined") && (typeof chrome.storage !== "undefined"));
}
/**
* Saves the Setting (defined by 'settingName') to be whatever is in 'settingValue'.
*
* This will use Chrome cloud-storage if available, then will fall back to LocalStorage
* if possible and fall back to cookies otherwise.
*
* NOTE: Remember to enver store confidential or user information in Chrome cloud
* storage (it's not encrypted).
*/
function saveSetting(settingName, settingValue){
// Use Chrome cloud storage where available (will sync across multiple computers).
if(useChromeStorage()){
var objectToPersist = {}; // can't use an object-literal to do it, or chrome will make an object whose key is literally 'settingName'
objectToPersist[settingName] = settingValue;
chrome.storage.sync.set(objectToPersist, function() {
// console.log("Chrome saved " + settingName + ".");
});
} else if(typeof(Storage) !== "undefined"){
localStorage[settingName] = settingValue;
} else {
// No LocalStorage support... use cookies instead.
setCookie(settingName, settingValue);
}
} // end saveSetting()
/**
* Retrieves the Setting defined by 'settingName'. The 'defaultValue' is optional.
*
* This will use LocalStorage if possible and fall back to cookies otherwise. Typically
* this function will only be used if Chrome cloud storage is not available.
*/
function getSetting(settingName, defaultValue){
var retVal = defaultValue;
if(typeof(Storage) !== "undefined"){
var lsValue = localStorage[settingName];
if(typeof lsValue !== 'undefined'){
retVal = lsValue;
}
} else {
// No LocalStorage support... use cookies instead.
retVal = getCookie(settingName, defaultValue);
}
return retVal;
}; // end getSetting()
/**
* Refreshes all of the persisted settings and puts them in memory. This is
* done at the beginning, and any time chrome cloud-storage sends an event
* that the data has changed.
*/
function refreshSettings(){
if(useChromeStorage()){
chrome.storage.sync.get(S4T_ALL_SETTINGS, function(result){
//if(chrome.runtime.lastError){}
$.each(S4T_ALL_SETTINGS, function(i, settingName){
if(result[settingName]){
S4T_SETTINGS[settingName] = result[settingName];
} else {
S4T_SETTINGS[settingName] = S4T_SETTING_DEFAULTS[settingName];
}
});
onSettingsUpdated();
});
} else {
// Get the settings (with defaults for each). Add a new line here for every new setting.
$.each(S4T_ALL_SETTINGS, function(i, settingName){
S4T_SETTINGS[settingName] = getSetting(settingName, S4T_SETTING_DEFAULTS[settingName]);
});
onSettingsUpdated();
}
}; // end refreshSettings()
function onSettingsUpdated(){
// Temporary indication to the user that the settings were saved (might not always be on screen, but that's not a problem).
$('#'+settingsFrameId).contents().find('#s4tSaved').show().fadeOut(2000, "linear");
// Refresh the links because link-settings may have changed.
$('.s4tLink').remove();
updateBurndownLink();
} // end onSettingsUpdated()
/**
* Sets a key/value cookie to live for about a year. Cookies are typically not used by
* this extension if LocalSettings is available in the browser.
* From: http://www.w3schools.com/js/js_cookies.asp
*/
function setCookie(c_name,value){
var exdays = 364;
var exdate=new Date();
exdate.setDate(exdate.getDate() + exdays);
var c_value=escape(value) + ((exdays==null) ? "" : "; expires="+exdate.toUTCString());
document.cookie=c_name + "=" + c_value;
}; // end setCookie()
/**
* Gets a cookie value if available (defaultValue if not found). Cookies are typically not\
* used by this extension if LocalSettings is available in the browser.
* Basically from: http://www.w3schools.com/js/js_cookies.asp
*/
function getCookie(c_name, defaultValue){
var c_value = document.cookie;
var c_start = c_value.indexOf(" " + c_name + "=");
if (c_start == -1){
c_start = c_value.indexOf(c_name + "=");
}
if (c_start == -1){
c_value = defaultValue;
} else {
c_start = c_value.indexOf("=", c_start) + 1;
var c_end = c_value.indexOf(";", c_start);
if (c_end == -1) {
c_end = c_value.length;
}
c_value = unescape(c_value.substring(c_start,c_end));
}
return c_value;
}; // end getCookie()