Keep anchors when switching versions

Author: kategengler

app/controllers/project-version.js

@@ -141,61 +141,80 @@ export default class ProjectVersionController extends Controller {
 
   @action
   updateProject(project, ver /*, component */) {
-    let projectVersionID = ver.compactVersion;
-    let endingRoute;
-    switch (this.router.currentRouteName) {
-      case 'project-version.classes.class': {
-        let className = this._getEncodedNameForCurrentClass();
-        endingRoute = `classes/${className}`;
-        break;
-      }
-      case 'project-version.modules.module': {
-        let moduleName = encodeURIComponent(this.moduleController.model.name);
-        endingRoute = `modules/${moduleName}`;
-        break;
-      }
-      case 'project-version.namespaces.namespace': {
-        let namespaceName = this.namespaceController.model.name;
-        endingRoute = `namespaces/${namespaceName}`;
-        break;
-      }
-      default:
-        endingRoute = '';
-        break;
-    }
-    // if the user is navigating to/from api versions >= 2.16, take them
-    // to the home page instead of trying to translate the url
-    let shouldConvertPackages = this._shouldConvertPackages(
-      ver,
-      this.projectService.version,
+    this.router.transitionTo(
+      findEndingRoute({
+        project,
+        targetVersion: ver.id,
+        currentVersion: this.projectService.version,
+        currentRouteName: this.router.currentRouteName,
+        classModelName: this.classController?.model?.get('name'),
+        moduleModelName: this.moduleController?.model?.name,
+        namespaceModelName: this.namespaceController?.model?.name,
+        currentAnchor: window.location.hash,
+      }),
     );
-    let isEmberProject = project === 'ember';
-
-    if (!isEmberProject || !shouldConvertPackages) {
-      this.router.transitionTo(
-        `/${project}/${projectVersionID}/${endingRoute}`,
-      );
-    } else {
-      this.router.transitionTo(`/${project}/${projectVersionID}`);
-    }
   }
+}
 
-  _getEncodedNameForCurrentClass() {
-    // escape any reserved characters for url, like slashes
-    return encodeURIComponent(this.classController.model.get('name'));
+export function findEndingRoute({
+  project,
+  targetVersion,
+  currentVersion,
+  currentRouteName,
+  classModelName,
+  moduleModelName,
+  namespaceModelName,
+  currentAnchor,
+}) {
+  let projectVersionID = getCompactVersion(targetVersion);
+  let endingRoute;
+  switch (currentRouteName) {
+    case 'project-version.classes.class': {
+      let className = encodeURIComponent(classModelName);
+      endingRoute = `classes/${className}`;
+      break;
+    }
+    case 'project-version.modules.module': {
+      let moduleName = encodeURIComponent(moduleModelName);
+      endingRoute = `modules/${moduleName}`;
+      break;
+    }
+    case 'project-version.namespaces.namespace': {
+      let namespaceName = namespaceModelName;
+      endingRoute = `namespaces/${namespaceName}`;
+      break;
+    }
+    default:
+      endingRoute = '';
+      break;
   }
 
-  // Input some version info, returns a boolean based on
-  // whether the user is switching versions for a 2.16 docs release or later.
-  // The urls for pre-2.16 classes and later packages are quite different
-  _shouldConvertPackages(targetVer, previousVer) {
-    let targetVersion = getCompactVersion(targetVer.id);
-    let previousVersion = getCompactVersion(previousVer);
-    let previousComparison = semverCompare(previousVersion, '2.16');
-    let targetComparison = semverCompare(targetVersion, '2.16');
-    return (
-      (previousComparison < 0 && targetComparison >= 0) ||
-      (previousComparison >= 0 && targetComparison < 0)
-    );
+  let isEmberProject = project === 'ember';
+
+  // if the user is navigating to/from api versions >= 2.16, take them
+  // to the home page instead of trying to translate the url
+  let shouldConvertPackages = _shouldConvertPackages(
+    targetVersion,
+    currentVersion,
+  );
+
+  if (!isEmberProject || !shouldConvertPackages) {
+    return `/${project}/${projectVersionID}/${endingRoute}${currentAnchor}`;
+  } else {
+    return `/${project}/${projectVersionID}`;
   }
 }
+
+// Input some version info, returns a boolean based on
+// whether the user is switching versions for a 2.16 docs release or later.
+// The urls for pre-2.16 classes and later packages are quite different
+function _shouldConvertPackages(targetVer, previousVer) {
+  let targetVersion = getCompactVersion(targetVer);
+  let previousVersion = getCompactVersion(previousVer);
+  let previousComparison = semverCompare(previousVersion, '2.16');
+  let targetComparison = semverCompare(targetVersion, '2.16');
+  return (
+    (previousComparison < 0 && targetComparison >= 0) ||
+    (previousComparison >= 0 && targetComparison < 0)
+  );
+}

tests/unit/controllers/project-version-test.js

@@ -1,6 +1,7 @@
 import { module, test } from 'qunit';
 /* eslint-disable ember/no-restricted-resolver-tests */
 import { setupTest } from 'ember-qunit';
+import { findEndingRoute } from 'ember-api-docs/controllers/project-version';
 
 const moduleIds = [
   'ember-2.10.0-ember',
@@ -45,4 +46,40 @@ module('Unit | Controller | project version', function (hooks) {
     let moduleNames = controller.getModuleRelationships('ember-2.10.1');
     assert.deepEqual(moduleNames, expectedModuleNames);
   });
+
+  module('findEndingRoute', function () {
+    test('Maintains anchors', function (assert) {
+      let endingRoute = findEndingRoute({
+        project: 'ember',
+        targetVersion: '6.4.0',
+        currentVersion: '6.5.0',
+        currentRouteName: 'project-version.classes.class',
+        classModelName: 'Component',
+        moduleModelName: null,
+        namespaceModelName: null,
+        currentAnchor: '#didInsertElement',
+      });
+
+      assert.strictEqual(
+        endingRoute,
+        '/ember/6.4/classes/Component#didInsertElement',
+      );
+
+      endingRoute = findEndingRoute({
+        project: 'ember',
+        targetVersion: '6.4.0',
+        currentVersion: '6.5.0',
+        currentRouteName: 'project-version.modules.module',
+        classModelName: null,
+        moduleModelName: '@ember/application',
+        namespaceModelName: null,
+        currentAnchor: '#classes',
+      });
+
+      assert.strictEqual(
+        endingRoute,
+        '/ember/6.4/modules/%40ember%2Fapplication#classes',
+      );
+    });
+  });
 });