Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

chore(docs): improve version picker #15381

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 116 additions & 22 deletions docs/app/src/versions.js
Original file line number Diff line number Diff line change
@@ -1,37 +1,131 @@
'use strict';
/* global console */

angular.module('versions', [])

.controller('DocsVersionsCtrl', ['$scope', '$location', '$window', 'NG_VERSIONS', function($scope, $location, $window, NG_VERSIONS) {
$scope.docs_version = NG_VERSIONS[0];
$scope.docs_versions = NG_VERSIONS;
.factory('getVersions', ['$http', '$q', function($http, $q) {

for (var i = 0, minor = NaN; i < NG_VERSIONS.length; i++) {
var version = NG_VERSIONS[i];
if (version.isSnapshot) {
version.isLatest = true;
continue;
var VERSION_REGEXP = /^(\d+)\.(\d+)\.(\d+)(?:-(?:(\w+)\.)?(\d+))?/;

return function() {
return $q.all([
// is it bad to use crossorigin??
$http.get('http://crossorigin.me/https://registry.npmjs.org/angular').then(processAllVersionsResponse),
$http.get('version.json').then(processCurrentVersionResponse)
])
.then(function(data) {
return {
all: data[0],
current: find(data[0], function(version) { return version.version.full === data[1]; })
};
})
.catch(function(e) {
console.log('Failed to get the version information...');
console.log(e.stack);
});
};

function processCurrentVersionResponse(response) {
return response.data.isSnapshot ? 'snapshot' : response.data.full;
}

function processAllVersionsResponse(response) {

var latestMap = {};

var versions = Object.keys(response.data.versions)
.map(function(versionStr) {
var version = parseVersion(versionStr);
var key = version.major + '.' + version.minor;
if (compareVersions(version, latestMap[key]) > 0) {
latestMap[key] = version;
}
return version;
})
.filter(function(version) {
return version && version.major > 0;
})
.map(function(version) {
return makeOption(version);
})
.reverse();

var latest = sortObject(latestMap, reverse(compareVersions)).map(function(version) { return makeOption(version, 'Latest'); });

return [{version: {full: 'snapshot'}, label: 'master', group: 'Latest'}]
.concat(latest)
.concat(versions);
}

function parseVersion(versionStr) {
var match = VERSION_REGEXP.exec(versionStr);
if (match) {
return {
major: parseInt(match[1],10),
minor: parseInt(match[2],10),
patch: parseInt(match[3],10),
prerelease: [match[4], parseInt(match[5], 10)],
full: versionStr
};
}
// NaN will give false here
if (minor <= version.minor) {
continue;
}

function compareVersions(left, right) {
if (!left) { return -1; }
if (!right) { return 1; }
if (left.major !== right.major) { return left.major - right.major; }
if (left.minor !== right.minor) { return left.minor - right.minor; }
if (left.patch !== right.patch) { return left.patch - right.patch; }

// non-prelease trumps prerelease
if (left.prerelease[0] === undefined && left.prerelease[1] === undefined) { return 1; }
if (right.prerelease[0] === undefined && right.prerelease[1] === undefined) { return -1; }

if (left.prerelease[0] !== right.prerelease[0]) { return left.prerelease[0] - right.prerelease[0]; }
return left.prerelease[1] - right.prerelease[1];
}

function makeOption(version, group) {
return {version: version, label: 'v' + version.full, group: group || 'v' + version.major + '.' + version.minor};
}

function reverse(fn) {
return function(left, right) { return -fn(left, right); };
}

function sortObject(obj, cmp) {
return Object.keys(obj).map(function(key) { return obj[key]; }).sort(cmp);
}

function find(collection, matcherFn) {
for (var i = 0, ii = collection.length; i < ii; ++i) {
if (matcherFn(collection[i])) {
return collection[i];
}
}
version.isLatest = true;
minor = version.minor;
}
}])

$scope.getGroupName = function(v) {
return v.isLatest ? 'Latest' : ('v' + v.major + '.' + v.minor + '.x');
};

$scope.jumpToDocsVersion = function(version) {
var currentPagePath = $location.path().replace(/\/$/, ''),
url = '';
if (version.isOldDocsUrl) {
url = version.docsUrl;
.controller('DocsVersionsCtrl', ['$scope', '$location', '$window', 'getVersions', function($scope, $location, $window, getVersions) {

getVersions().then(function(NG_VERSIONS) {
$scope.version = NG_VERSIONS;
});

$scope.jumpToDocsVersion = function(value) {
var currentPagePath = $location.path().replace(/\/$/, '');
var version = value.version;

var url = 'http://code.angularjs.org/' + version.full + '/docs';

// Versions before 1.0.2 had a different docs folder name
if (version.major === 0 || (version.major === 1 && version.minor === 0 && version.patch < 2)) {
url += '-' + version.version;
} else {
url = version.docsUrl + currentPagePath;
url += currentPagePath;
}

$window.location = url;
};
}]);
6 changes: 3 additions & 3 deletions docs/config/templates/indexPage.template.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,9 @@ <h4 class="search-results-group-heading">{{ key }}</h4>
<div class="container main-grid main-header-grid">
<div class="grid-left">
<div ng-controller="DocsVersionsCtrl" class="picker version-picker">
<select ng-options="v as (v.isSnapshot ? v.branch : ('v' + v.version)) group by getGroupName(v) for v in docs_versions"
ng-model="docs_version"
ng-change="jumpToDocsVersion(docs_version)"
<select ng-options="v as v.label group by v.group for v in version.all"
ng-model="version.current"
ng-change="jumpToDocsVersion(version.current)"
class="docs-version-jump">
</select>
</div>
Expand Down
9 changes: 6 additions & 3 deletions docs/gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ var bowerFolder = 'bower_components';

var src = 'app/src/**/*.js';
var ignoredFiles = '!src/angular.bind.js';
var assets = 'app/assets/**/*';
var assets = [
'app/assets/**/*',
'../build/version.json'
];


var getMergedEslintConfig = function(filepath) {
Expand Down Expand Up @@ -98,8 +101,8 @@ gulp.task('assets', ['bower'], function() {
var JS_EXT = /\.js$/;
return merge(
gulp.src(['img/**/*']).pipe(gulp.dest(outputFolder + '/img')),
gulp.src([assets]).pipe(gulp.dest(outputFolder)),
gulp.src([assets])
gulp.src(assets).pipe(gulp.dest(outputFolder)),
gulp.src(assets)
.pipe(foreach(function(stream, file) {
if (JS_EXT.test(file.relative)) {
var minFile = file.relative.replace(JS_EXT, '.min.js');
Expand Down