Merge pull request #27 from RallyTechServices/projectScope

Project scope

Author: tyrjo

README.md

@@ -26,6 +26,15 @@ When user story is selected as the root type:
 
     * **Export User Stories and Child Items...** Stories, tasks, defects, and test cases will be exported.  Test cases that are children of defects (that are children of stories) will be exported, as will defects that are children of test cases that are children of stories.  If a defect is a child of a story and is also a child of a test case that is displayed, the defect may not appear where you expect.
 
+If this app is on a Timebox Scoped page, then the appropriate timebox filter
+will be applied if the Timebox is valid for the queried model.  If the Timebox
+is not valid for the selected model, then the Timebox scope will be ignored.
+
+If the page is scoped to a Milestone Timebox, there is an additional setting
+to allow the user to respect or ignore the global project setting. This is
+useful when Portfolio Items associated with a specific Milestone are not
+constrained to a specific subset of the Project Hierarchy tree.
+
 ### Caveats
 * If an item has a parent that is out of scope, then that item's relationship will not be seen.
 

deploy/Ugly.txt

@@ -1,6 +1,6 @@
 {
   "name": "custom-grid-with-deep-export",
-  "version": "1.2.0",
+  "version": "1.2.1-1",
   "scripts": {
     "debug": "grunt debug",
     "debug:watch": "nodemon --exec grunt debug",

package.json

@@ -13,7 +13,8 @@ Ext.define("custom-grid-with-deep-export", {
             query: '',
             showControls: true,
             type: 'HierarchicalRequirement',
-            pageSize: 50
+            pageSize: 50,
+            searchAllProjects: [{checked: false}],
         }
     },
 
@@ -51,12 +52,17 @@ Ext.define("custom-grid-with-deep-export", {
         this.modelNames = [this.getSetting('type')];
         this.logger.log('_buildStore', this.modelNames);
         var fetch = ['FormattedID', 'Name'];
+        var dataContext = this.getContext().getDataContext();
+        if (this.searchAllProjects()) {
+            dataContext.project = null;
+        }
 
         Ext.create('Rally.data.wsapi.TreeStoreBuilder').build({
             models: this.modelNames,
             enableHierarchy: true,
             remoteSort: true,
-            fetch: fetch
+            fetch: fetch,
+            context: dataContext
         }).then({
             success: this._addGridboard,
             scope: this
@@ -75,10 +81,14 @@ Ext.define("custom-grid-with-deep-export", {
         }
         this.logger.log('_addGridboard', store);
 
-
+        var context = this.getContext();
+        var dataContext = context.getDataContext();
+        if (this.searchAllProjects()) {
+            dataContext.project = null;
+        }
         this.gridboard = this.down('#display_box').add({
                 xtype: 'rallygridboard',
-                context: this.getContext(),
+                context: context,
                 modelNames: this.modelNames,
                 toggleState: 'grid',
                 plugins: [
@@ -126,7 +136,8 @@ Ext.define("custom-grid-with-deep-export", {
                 gridConfig: {
                     store: store,
                     storeConfig: {
-                        filters: filters
+                        filters: filters,
+                        context: dataContext
                     },
                     columnCfgs: [
                         'Name'
@@ -266,14 +277,18 @@ Ext.define("custom-grid-with-deep-export", {
         exporter.on('exporterror', this._showError, this);
         exporter.on('exportcomplete', this._showStatus, this);
 
+        var dataContext = this.getContext().getDataContext();
+        if (this.searchAllProjects()) {
+            dataContext.project = null;
+        }
         var hierarchyLoader = Ext.create('Rally.technicalservices.HierarchyLoader',{
             model: modelName,
             fetch: fetch,
             filters: filters,
             sorters: sorters,
             loadChildModels: childModels,
             portfolioItemTypes: this.portfolioItemTypes,
-            context: this.getContext().getDataContext()
+            context: dataContext
         });
         hierarchyLoader.on('statusupdate', this._showStatus, this);
         hierarchyLoader.on('hierarchyloadartifactsloaded', exporter.setRecords, exporter);
@@ -315,8 +330,26 @@ Ext.define("custom-grid-with-deep-export", {
     isExternal: function(){
         return typeof(this.getAppId()) == 'undefined';
     },
+    
+    isMilestoneScoped: function() {
+        var result = false;
+        
+        var tbscope = this.getContext().getTimeboxScope();
+        if (tbscope && tbscope.getType() == 'milestone') {
+            result = true;
+        }
+        return result
+    },
+    
+    searchAllProjects: function() {
+        var searchAllProjects = this.getSetting('searchAllProjects');
+        return this.isMilestoneScoped() && searchAllProjects;
+    },
+    
     getSettingsFields: function(){
-        return Rally.technicalservices.CustomGridWithDeepExportSettings.getFields();
+        return Rally.technicalservices.CustomGridWithDeepExportSettings.getFields({
+            showSearchAllProjects: this.isMilestoneScoped()
+        });
     },
     //onSettingsUpdate:  Override
     onSettingsUpdate: function (settings){

src/javascript/app.js

@@ -97,7 +97,8 @@ Ext.define('Rally.technicalservices.HierarchyLoader',{
             model: this.model,
             fetch: fetch,
             filters: this.filters,
-            sorters: this.sorters
+            sorters: this.sorters,
+            context: this.context
         };
         this.logger.log('fetchRoot config', config);
 

src/javascript/utils/hierarchy-loader.js

@@ -22,21 +22,31 @@
             'Rally.ui.CheckboxField'
         ],
 
-        getFields: function (context) {
+        getFields: function (config) {
 
             var type_filters = Rally.data.wsapi.Filter.or([
                 {property: 'TypePath', value: 'HierarchicalRequirement'},
                 {property: 'TypePath', operator: 'contains', value: 'PortfolioItem/'}
             ]);
 
             return [
+                {
+                  id:'searchAllProjects',
+                  name:'searchAllProjects',
+                  fieldLabel: 'Scope Across Workspace',
+                  labelAlign: 'left',
+                  xtype:'rallycheckboxfield',
+                  labelWidth: 150,
+                  margin: 10,
+                  hidden: !config.showSearchAllProjects
+                },
                 {
                     name: 'type',
                     xtype: 'rallycombobox',
                     allowBlank: false,
                     autoSelect: false,
                     shouldRespondToScopeChange: true,
-                    context: context,
+                    context: config.context,
                     initialValue: 'HierarchicalRequirement',
                     storeConfig: {
                         model: Ext.identityFn('TypeDefinition'),