forked from Echo3ToEcho7/app-catalog
-
Notifications
You must be signed in to change notification settings - Fork 193
/
DependencyStatusApp.html
417 lines (354 loc) · 16 KB
/
DependencyStatusApp.html
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<!-- Copyright (c) 2002-2010 Rally Software Development Corp. All rights reserved. -->
<html>
<head>
<meta name="Name" content="App: Dependency Status Dashboard"/>
<meta name="Vendor" content="Rally Software"/>
<meta name="Version" content="2012.01.14"/>
<script type="text/javascript" src="/apps/1.33/sdk.js?apiVersion=1.29"></script>
<script type="text/javascript">
//Object to retrieve iteration and
//user story dependency data
function DependencyDataService() {
var onBeforeUserStoryQuery = [];
var onError = [];
var onDataRetrievalComplete;
var that = this;
var rallyDataSource = new rally.sdk.data.RallyDataSource('__WORKSPACE_OID__', '__PROJECT_OID__',
'__PROJECT_SCOPING_UP__', '__PROJECT_SCOPING_DOWN__');
//Public method to retrieve data
//Upon successful retrieval onCompletedCallback will be invoked
//passing the results
this.retrieveData = function (onCompletedCallback) {
//Save for later
onDataRetrievalComplete = onCompletedCallback;
//KRM - Query improvement?
//If iterations are never set to completed there may be
//a very large # of results. Consider adding the following...
//AND (EndDate > Today)
var query = {
key : "iterations",
type : "iteration",
fetch : "ObjectID,StartDate,EndDate,State,Name,Project",
projectScopeUp : false,
projectScopeDown: false,
query : "(State != Accepted)",
order : "StartDate"
};
//Run the query
that.performQuery(query, retrieveDependencyData);
};
//Public method to
//add a handler for an event triggered
//before the main query is run
//Signature should be: function handler(iterations) {}
this.addOnBeforeUserStoryQueryHandler = function(handler) {
onBeforeUserStoryQuery.push(handler);
};
//Public method to
//add a handler for an event triggered
//when a query error occurs
//Signature should be: function handler(error) {}
this.addOnErrorHandler = function(handler) {
onError.push(handler);
};
//Public method to perform a query
//Provides error handling
this.performQuery = function(queries, callback) {
rallyDataSource.findAll(queries, function(results) {
//Check for errors
var errors = [];
for (var error in results.errors) {
if (results.errors.hasOwnProperty(error)) {
for (var i = 0; i < results.errors[error].length; i++) {
errors.push(results.errors[error][i]);
}
}
}
//No errors- perform callback with results
if (errors.length === 0) {
callback(results);
} else {
//An error occurred.
//Invoke handlers
var e = new Error("Error retrieving data.");
error.errors = errors;
for (var j = 0; j < onError.length; j++) {
onError[j](error);
}
}
});
};
//Private helper method used as a callback for retrieveData
//that retrieves user story information once the iteration
//information has been returned
function retrieveDependencyData(iterationResults) {
//Create the collection to be returned
var iterationInfo = [];
//Create a series of queries to find the
//user story info for each iteration
var queries = [];
for (var i = 0; i < iterationResults.iterations.length; i++) {
queries.push(
{
key : iterationResults.iterations[i].ObjectID + "UserStories",
type : "hierarchicalrequirement",
fetch : "Predecessors,ScheduleState,Blocked,FormattedID,Project,Name,ObjectID,Iteration,StartDate,EndDate",
query : "(Iteration = " + iterationResults.iterations[i]._ref + " )"
});
iterationInfo.push(iterationResults.iterations[i]);
}
//Execute the onBeforeQuery handlers
for (i = 0; i < onBeforeUserStoryQuery.length; i++) {
onBeforeUserStoryQuery[i](iterationInfo, queries);
}
that.performQuery(queries, function(results) {
for (var i = 0; i < iterationInfo.length; i++) {
iterationInfo[i].userStories = results[iterationInfo[i].ObjectID + "UserStories"];
}
onDataRetrievalComplete(iterationInfo);
});
}
return that;
}
//Object to display iteration and user story
//dependency data returned from the DependencyDataService
function DependencyDataPresenter(displayElementName) {
dojo.require("dojo.date.stamp");
var that = this;
var displayElement = dojo.byId(displayElementName);
//Public method to display iteration and user story dependency data
this.populateView = function(dependencyData) {
if (dependencyData.length > 0) {
displayElement.innerHTML += '<div id="subtitle">What is <span id="project-name">' +
dependencyData[0].Project.Name +
'</span> waiting for, and from whom?</div><div id="iteration-box"></div>';
//Display each iteration returned
for (var i = 0; i < dependencyData.length; i++) {
displayIteration(dojo.byId("iteration-box"), dependencyData[i]);
}
} else {
displayElement.innerHTML += '<div id="subtitle">No iterations found.</div>';
}
};
//Function to handle query errors
this.displayError = function(error) {
var errorHtml = '<div class="queryError">' +
error.message + '<ul>';
for (var i = 0; i < error.errors.length; i++) {
errorHtml += '<li>' + error.errors[i] + '</li>';
}
displayElement.innerHTML += errorHtml + '</ul></div>';
};
//Private helper function to format
//an ISO date into M/D
function formatDate(dateString) {
//KRM - strip off the Z so dojo doesn't do
//auto time zone stuff
var date = parseDate(dateString);
return (date.getMonth() + 1) + "/" + date.getDate();
}
function parseDate(dateString) {
return dojo.date.stamp.fromISOString(dateString.replace(/Z/, ""));
}
//Private helper function to display the
//specified iteration in the specified element.
function displayIteration(displayElement, iteration) {
//KRM - A note on the iteration status link:
//This is currently supported as of this writing but may go away in the future.
displayElement.innerHTML += '<div class="d-iteration" id="iteration' + iteration.ObjectID +
'"><div class="heading"><span class="rly-label"><a target="_top" href="/slm/rally.sp?pp=pj%2fd%2fis&iterationKey=' +
iteration.ObjectID + '">' + iteration.Name + '</a></span><br/>' +
formatDate(iteration.StartDate) + ' - ' + formatDate(iteration.EndDate) +
' (' + iteration.State + ')</div></div>';
var dependencyDiv = dojo.byId("iteration" + iteration.ObjectID);
var dependenciesFound = false;
for (var i = 0; i < iteration.userStories.length; i++) {
var userStory = iteration.userStories[i];
if (that.displayDependencies(dependencyDiv, userStory)) {
dependenciesFound = true;
}
}
if (!dependenciesFound) {
dependencyDiv.innerHTML += '<div class="dependency">No dependencies.</div>';
}
}
//Public function to display the
//specified user story and its dependencies in the specified element
this.displayDependencies = function(displayElement, userStory) {
if (userStory.Predecessors.length > 0) {
displayElement.innerHTML += '<div class="dependency" id="userStory' + userStory.ObjectID +
'">' + that.createArtifactLink(userStory) + '<br/></div>';
var userStoryDiv = dojo.byId("userStory" + userStory.ObjectID);
//Display each dependency
for (var i = 0; i < userStory.Predecessors.length; i++) {
that.displayDependency(userStoryDiv, userStory,
userStory.Predecessors[i]);
}
return true;
}
return false;
};
//Public function to display the specified predecessor
//in the specified displayDependency
this.displayDependency = function(displayElement, userStory, predecessor) {
var predecessorHtml = '<div class="predecessor-container"><div class="predecessor-status"><div class="state-legend' +
(predecessor.Blocked ? "-blocked" : "") + '" title="' + predecessor.ScheduleState + '">' +
getStateAbbreviation(predecessor.ScheduleState) +
'</div></div><div class="predecessor">Waiting on <b>' + predecessor.Project.Name +
'</b> for <br/>' + that.createArtifactLink(predecessor) + '<br/><span class="statusDescription">';
var warningImageHtml = '<img src="/slm/images/icon_alert_sm.gif" alt="Warning" title="Warning" /> ';
//Display the status of the predecessor
if (predecessor.Iteration === null) {
predecessorHtml += warningImageHtml + "Not yet scheduled";
} else if (predecessor.ScheduleState == "Accepted") {
predecessorHtml += "Accepted in " + predecessor.Iteration.Name +
" for " + formatDate(predecessor.Iteration.EndDate);
} else if (predecessor.Blocked) {
predecessorHtml += warningImageHtml + "Blocked";
} else if (
//KRM - Allow not late if same iteration?
//predecessor.Iteration._ref !== userStory.Iteration._ref &&
parseDate(predecessor.Iteration.EndDate) >
parseDate(userStory.Iteration.StartDate)) {
predecessorHtml += warningImageHtml + "Scheduled for " +
formatDate(predecessor.Iteration.EndDate) + " - too late";
} else {
predecessorHtml += "Scheduled for " + formatDate(predecessor.Iteration.EndDate);
}
displayElement.innerHTML += predecessorHtml + '</span></div></div>';
};
//Public function to create a link for
//the specified artifact
this.createArtifactLink = function(artifact) {
return '<a href="/slm/detail/' +
(artifact._type === "HierarchicalRequirement" ? 'ar/' : 'df/') +
artifact.ObjectID + '" target="_top">' + artifact.FormattedID + ': ' +
artifact.Name + '</a>';
};
//Private helper function to get the abbreviation
//for the specified user story state
function getStateAbbreviation(state) {
return state == "In-Progress" ? "P" : state.charAt(0);
}
return that;
}
</script>
<script type="text/javascript">
rally.addOnLoad(function () {
//Create the data collection and display creation objects
var dataService = new DependencyDataService();
var dataPresenter = new DependencyDataPresenter("status");
//Retrieve the data and display it when available
dataService.addOnErrorHandler(dataPresenter.displayError);
dataService.retrieveData(dataPresenter.populateView);
});
</script>
<style type="text/css">
body {
font-family: tahoma, geneva, helvetica, arial, sans-serif;
font-size: 11px;
background: EBEBD8;
}
.d-iteration {
padding: 5px;
margin: 5px;
background: white;
border: solid 1px #cccccc;
border-top: solid 2px #cccccc;
font-family: tahoma, geneva, helvetica, arial, sans-serif;
font-size: 11px;
width: 275px;
height: 400px;
overflow-y: auto;
float: left;
}
.heading {
border: 0px;
border-bottom: solid 1px #cccccc;
padding-bottom: 5px;
}
.heading .rly-label {
font-weight: bold;
}
#d_titlebar {
font-family: tahoma, geneva, helvetica, arial, sans-serif;
font-weight: bold;
padding-left: 10px;
font-size: 14px;
}
#subtitle {
font-family: tahoma, geneva, helvetica, arial, sans-serif;
padding-left: 10px;
font-size: 11px;
display: block;
}
.dependency {
padding-top: 5px;
padding-bottom: 3px;
padding-left: 3px;
float: left;
}
.dependency .predecessor {
padding: 5px;
padding-left: 22px;
}
.predecessor-container {
padding-left: 20px;
}
.predecessor-status {
float: left;
padding-top: 5px;
}
.statusDescription {
color: #999999;
}
a {
text-decoration: none;
}
a:link {
color: #366AB7;
}
a:visited {
color: #366AB7;
}
a img {
cursor: pointer;
}
/* State Squares */
.state-legend {
background: #006600 none repeat scroll 0%;
border: 1px solid #DDDDDD;
color: #FFFFFF;
cursor: default;
float: left;
height: 14px;
line-height: 14px;
margin-right: 1px;
text-align: center;
width: 14px;
}
.state-legend-blocked {
background: transparent url(/slm/images/icon_blocked.gif) no-repeat scroll 0%;
color: #FFFFFF;
cursor: default;
display: inline;
float: left;
height: 16px;
line-height: 16px;
margin-right: 1px;
text-align: center;
width: 16px;
}
.queryError {
padding-left: 10px;
padding-top: 10px;
color: red
}
</style>
</head>
<body>
<div id="d_titlebar">Dependency Status</div>
<div id="status"></div>
</body>
</html>