Skip to content

Commit

Permalink
Add enrollment track filter
Browse files Browse the repository at this point in the history 
AN-6236
  • Loading branch information
@dan-f
dan-f committed Apr 21, 2016
1 parent 7fe6924 commit 81e0b81
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 65 deletions.
1 change: 1 addition & 0 deletions ...ster/templates/roster-controls.underscore → ...ners/roster/templates/controls.underscore
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
<div class="learners-search-container"></div>
<div class="learners-cohort-filter-container"></div>
<div class="learners-enrollment-track-filter-container"></div>
11 changes: 9 additions & 2 deletions analytics_dashboard/static/apps/learners/roster/views/controls.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ define(function (require) {

Filter = require('learners/roster/views/filter'),
LearnerSearch = require('learners/roster/views/search'),
rosterControlsTemplate = require('text!learners/roster/templates/roster-controls.underscore'),
rosterControlsTemplate = require('text!learners/roster/templates/controls.underscore'),

RosterControlsView;

Expand All @@ -18,7 +18,8 @@ define(function (require) {

regions: {
search: '.learners-search-container',
cohortFilter: '.learners-cohort-filter-container'
cohortFilter: '.learners-cohort-filter-container',
enrollmentTrackFilter: '.learners-enrollment-track-filter-container'
},

initialize: function (options) {
Expand All @@ -37,6 +38,12 @@ define(function (require) {
filterValues: this.options.courseMetadata.get('cohorts'),
selectDisplayName: gettext('Cohort Groups')
}));
this.showChildView('enrollmentTrackFilter', new Filter({
collection: this.options.collection,
filterKey: 'enrollment_mode',
filterValues: this.options.courseMetadata.get('enrollment_modes'),
selectDisplayName: gettext('Enrollment Tracks')
}));
}
});

Expand Down
145 changes: 82 additions & 63 deletions analytics_dashboard/static/apps/learners/roster/views/spec/roster-spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ define(function (require) {
var $ = require('jquery'),
_ = require('underscore'),
axe = require('axe-core'),
SpecHelpers = require('uitk/utils/spec-helpers/spec-helpers'),
URI = require('URI'),

CourseMetadataModel = require('learners/common/models/course-metadata'),
Expand Down Expand Up @@ -491,80 +492,100 @@ define(function (require) {
});

describe('filtering', function () {
describe('by cohort', function () {
var expectCanFilterBy = function (cohort) {
$('select').val(cohort);
$('select').change();
if (cohort) {
expect(getLastRequestParams()).toEqual(jasmine.objectContaining({
cohort: cohort
}));
} else {
expect(getLastRequestParams().hasOwnProperty('cohort')).toBe(false);
}
getLastRequest().respond(200, {}, JSON.stringify(getResponseBody(1, 1)));
expect($('option[value="' + cohort + '"]')).toBeSelected();
};
var expectCanFilterBy = function (filterKey, filterValue) {
var expectedRequestSubset;
$('select').val(filterValue);
$('select').change();
if (filterValue) {
expectedRequestSubset = {};
expectedRequestSubset[filterKey] = filterValue;
expect(getLastRequestParams()).toEqual(jasmine.objectContaining(expectedRequestSubset));
} else {
expect(getLastRequestParams().hasOwnProperty(filterKey)).toBe(false);
}
getLastRequest().respond(200, {}, JSON.stringify(getResponseBody(1, 1)));
expect($('option[value="' + filterValue + '"]')).toBeSelected();
};

it('renders the current cohort filter', function () {
var courseMetadataModel,
collection,
SpecHelpers.withConfiguration({
'by cohort': [
'cohort', // filter field name
'cohorts', // course metadata field name
{'Cohort A': 1, 'Cohort B': 2} // default cohort metadata
],
'by enrollment track': [
'enrollment_mode', // filter field name
'enrollment_modes', // course metadata field name
{verified: 1, audit: 2} // default enrollment modes
]
}, function (filterFieldName, courseMetadataFieldName, filterOptions) {
var courseMetadataAttributes = {};
courseMetadataAttributes[courseMetadataFieldName] = filterOptions;
this.courseMetadata = new CourseMetadataModel(courseMetadataAttributes);
this.filterFieldName = filterFieldName;
this.filterOptions = filterOptions;
this.firstFilterOption = _.keys(this.filterOptions)[0];
}, function () {
it('renders the filter which is currently applied', function () {
var collection,
firstFilterOption,
rosterView;
courseMetadataModel = new CourseMetadataModel({cohorts: {
'Cohort A': 1,
'Cohort B': 2
}});
firstFilterOption = this.firstFilterOption;
collection = new LearnerCollection();
collection.setFilterField('cohort', 'Cohort A');
collection.setFilterField(this.filterFieldName, firstFilterOption);
rosterView = getRosterView({
courseMetadataModel: courseMetadataModel,
courseMetadataModel: this.courseMetadata,
collection: collection
});
expect(rosterView.$('.learners-filter option[value="Cohort A"]')).toBeSelected();
expect(rosterView.$('.learners-filter option[value="' + firstFilterOption + '"]')).toBeSelected();
});

it('does not render when the course contains no cohorts', function () {
var rosterView = getRosterView({courseMetadata: {cohorts: {}}});
it('only renders when filter options are provided', function () {
var rosterView,
selectOptions,
defaultSelectOption;

// Doesn't render when no filter options are provided.
rosterView = getRosterView({courseMetadata: {}});
expect(rosterView.$('.learners-filter').children()).not.toExist();
});

it('renders when the course contains cohorts', function () {
var rosterView = getRosterView({courseMetadata: {cohorts: {
'Cohort A': 1,
'Cohort B': 2
}}}),
options = rosterView.$('.learners-filter option'),
defaultOption = $(options[0]),
cohortAOption = $(options[1]),
cohortBOption = $(options[2]);

expect(defaultOption).toBeSelected();
expect(defaultOption).toHaveValue('');
expect(defaultOption).toHaveText('All');

expect(cohortAOption).not.toBeSelected();
expect(cohortAOption).toHaveValue('Cohort A');
expect(cohortAOption).toHaveText('Cohort A (1 learner)');

expect(cohortBOption).not.toBeSelected();
expect(cohortBOption).toHaveValue('Cohort B');
expect(cohortBOption).toHaveText('Cohort B (2 learners)');
// Does render when filter options are provided.
rosterView = getRosterView({courseMetadataModel: this.courseMetadata});
selectOptions = rosterView.$('.learners-filter option').get();
defaultSelectOption = selectOptions[0];

expect(defaultSelectOption).toBeSelected();
expect(defaultSelectOption).toHaveValue('');
expect(defaultSelectOption).toHaveText('All');

_.chain(this.filterOptions)
.pairs()
.zip(_.rest(selectOptions))
.each(function (filterAndSelectOption) {
var filterOption = filterAndSelectOption[0],
filterOptionKey = filterOption[0],
learnerCount = filterOption[1],
selectOption = filterAndSelectOption[1];
expect(selectOption).not.toBeSelected();
expect(selectOption).toHaveValue(filterOptionKey);
if (learnerCount === 1) {
expect(selectOption).toHaveText(filterOptionKey + ' (' + learnerCount + ' learner)');
} else {
expect(selectOption).toHaveText(filterOptionKey + ' (' + learnerCount + ' learners)');
}
});
});

it('can execute a cohort filter', function () {
getRosterView({courseMetadata: {cohorts: {
'Cohort A': 1
}}});
expectCanFilterBy('Cohort A');
expectCanFilterBy('');
it('can execute a filter', function () {
getRosterView({courseMetadataModel: this.courseMetadata});
expectCanFilterBy(this.filterFieldName, this.firstFilterOption);
expectCanFilterBy(this.filterFieldName, '');
});

it('handles server errors', function () {
var rosterView = getRosterView({courseMetadata: {cohorts: {
'Cohort A': 1
}}});
var rosterView = getRosterView({courseMetadataModel: this.courseMetadata});
spyOn(rosterView, 'trigger');
rosterView.$('select').val('Cohort A');
rosterView.$('select').val(this.firstFilterOption);
rosterView.$('select').change();
verifyErrorHandling(
rosterView,
Expand All @@ -574,13 +595,11 @@ define(function (require) {
});

it('handles network errors', function () {
var rosterView = getRosterView({courseMetadata: {cohorts: {
'Cohort A': 1
}}});
var rosterView = getRosterView({courseMetadataModel: this.courseMetadata});
testTimeout(rosterView, function () {
rosterView.$('select').val('Cohort A');
rosterView.$('select').val(this.firstFilterOption);
rosterView.$('select').change();
});
}.bind(this));
});
});
});
Expand Down

0 comments on commit 81e0b81

Please sign in to comment.