Skip to content

Commit

Permalink
consolidation/cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
@benmarch
benmarch committed Mar 14, 2016
1 parent 3600c4b commit 73b4f6b
Showing 1 changed file with 86 additions and 92 deletions.
178 changes: 86 additions & 92 deletions app/tour-controller.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,43 @@
currentStep = step;
}

/**
* gets a step relative to current step
*
* @param {number} offset Positive integer to search right, negative to search left
* @returns {step}
*/
function getStepByOffset(offset) {
if (!getCurrentStep()) {
return null;
}
return stepList[stepList.indexOf(getCurrentStep()) + offset];
}

/**
* retrieves a step (if it exists in the step list) by index, ID, or identity
* Note: I realize ID is short for identity, but ID is really the step name here
*
* @param {string | number | step} stepOrStepIdOrIndex Step to retrieve
* @returns {step}
*/
function getStepByIdentityOrIdOrIndex(stepOrStepIdOrIndex) {
//index
if (angular.isNumber(stepOrStepIdOrIndex)) {
return stepList[stepOrStepIdOrIndex];
}

//ID string
if (angular.isString(stepOrStepIdOrIndex)) {
return stepList.filter(function (step) {
return step.stepId === stepOrStepIdOrIndex;
})[0];
}

//step object
return ~stepList.indexOf(stepOrStepIdOrIndex) ? stepOrStepIdOrIndex : null;
}

/**
* return next step or null
* @returns {step}
Expand Down Expand Up @@ -149,21 +179,15 @@
self.addStep(step);
};

/**
* Checks to see if a step exists by ID, index, or identity
*
* @protected
* @param {string | number | step} stepOrStepIdOrIndex Step to check
* @returns {boolean}
*/
self.hasStep = function (stepOrStepIdOrIndex) {
//index
if (angular.isNumber(stepOrStepIdOrIndex)) {
return angular.isDefined(stepList[stepOrStepIdOrIndex]);
}

//ID string
if (angular.isString(stepOrStepIdOrIndex)) {
return !!stepList.filter(function (step) {
return step.id === stepOrStepIdOrIndex;
})[0];
}

//step object
return !!~stepList.indexOf(stepOrStepIdOrIndex);
return !!getStepByIdentityOrIdOrIndex(stepOrStepIdOrIndex);
};

/**
Expand All @@ -174,35 +198,33 @@
* @returns {promise}
*/
self.showStep = function(step) {
return $q(function (resolve, reject) {
if (!step) {
reject('No step.');
}
if (!step) {
return $q.reject('No step.');
}

handleEvent(step.config('onShow')).then(function () {
return handleEvent(step.config('onShow')).then(function () {

if (step.config('backdrop')) {
uiTourBackdrop.createForElement(step.element, step.preventScrolling, step.fixed);
}
if (step.config('backdrop')) {
uiTourBackdrop.createForElement(step.element, step.preventScrolling, step.fixed);
}

}).then(function () {
}).then(function () {

return dispatchEvent(step, 'uiTourShow');
return dispatchEvent(step, 'uiTourShow');

}).then(function () {
}).then(function () {

return digest();
return digest();

}).then(function () {
}).then(function () {

return handleEvent(step.config('onShown'));
return handleEvent(step.config('onShown'));

}).then(function () {
}).then(function () {

step.isNext = isNext();
step.isPrev = isPrev();
step.isNext = isNext();
step.isPrev = isPrev();

}).then(resolve);
});
};

Expand All @@ -214,30 +236,28 @@
* @returns {Promise}
*/
self.hideStep = function (step) {
return $q(function (resolve, reject) {
if (!step) {
return reject('No step.');
}
if (!step) {
return $q.reject('No step.');
}

handleEvent(step.config('onHide')).then(function () {
return handleEvent(step.config('onHide')).then(function () {

return dispatchEvent(step, 'uiTourHide');
return dispatchEvent(step, 'uiTourHide');

}).then(function () {
}).then(function () {

if (step.config('backdrop')) {
uiTourBackdrop.hide();
}
if (step.config('backdrop')) {
uiTourBackdrop.hide();
}

}).then(function () {
}).then(function () {

return digest();
return digest();

}).then(function () {
}).then(function () {

return handleEvent(step.config('onHidden'));
return handleEvent(step.config('onHidden'));

}).then(resolve);
});
};

Expand Down Expand Up @@ -376,7 +396,7 @@
*/
self.goTo = function (goTo) {
var currentStep = getCurrentStep(),
stepToShow,
stepToShow = getStepByIdentityOrIdOrIndex(goTo),
actionMap = {
$prev: {
getStep: getPrevStep,
Expand All @@ -391,59 +411,33 @@
};

if (goTo === '$prev' || goTo === '$next') {
return $q(function (resolve) {
stepToShow = actionMap[goTo].getStep();

//trigger either onNext or onPrev here
//if next or previous requires a redirect, it will happen here
//the tour will pause here until the next view loads and
//the next/prev step is found

handleEvent(currentStep.config(actionMap[goTo].preEvent)).then(function () {

return self.hideStep(currentStep);
//trigger either onNext or onPrev here
//if next or previous requires a redirect, it will happen here
//the tour will pause here until the next view loads and
//the next/prev step is found
return handleEvent(currentStep.config(actionMap[goTo].preEvent)).then(function () {

}).then(function () {
return self.hideStep(currentStep);

//if a redirect occurred during onNext or onPrev, getCurrentStep() !== currentStep
}).then(function () {

//this will only be true if no redirect occurred, since the redirect sets current step
if (!currentStep[actionMap[goTo].navCheck] || currentStep[actionMap[goTo].navCheck] !== getCurrentStep().stepId) {
setCurrentStep(actionMap[goTo].getStep());
}
//if a redirect occurred during onNext or onPrev, getCurrentStep() !== currentStep
//this will only be true if no redirect occurred, since the redirect sets current step
if (!currentStep[actionMap[goTo].navCheck] || currentStep[actionMap[goTo].navCheck] !== getCurrentStep().stepId) {
setCurrentStep(actionMap[goTo].getStep());
}

}).then(function () {
}).then(function () {

if (getCurrentStep()) {
return self.showStep(getCurrentStep());
} else {
self.end();
}
if (getCurrentStep()) {
return self.showStep(getCurrentStep());
} else {
self.end();
}

}).then(resolve);
});
}

//if not $prev or $next
if (angular.isNumber(goTo)) {

//if it is an index
stepToShow = stepList[goTo];

} else if (angular.isString(goTo)) {

//if it is a step ID
stepToShow = stepList.filter(function (step) {
return step.stepId === goTo;
})[0];

} else if (~stepList.indexOf(goTo)) {

//if it is a step
stepToShow = goTo;

}

//if no step found
if (!stepToShow) {
return $q.reject('No step.');
Expand Down

0 comments on commit 73b4f6b

Please sign in to comment.