Skip to content

Remove routes #951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 26, 2025
Merged
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
24 changes: 20 additions & 4 deletions app/components/ember-landing-page.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,27 @@
<li><LinkTo @route='project-version.classes.class' @model='ComputedProperty'>Computed Properties</LinkTo> - declare functions as properties</li>
{{! template-lint-disable no-potential-path-strings }}
<li><LinkTo @route='project-version.classes.class' @model='@ember/object/computed'>Computed Macros</LinkTo> - shorter ways of expressing certain types of computed properties</li>
<li><LinkTo @route='project-version.classes.class' @model='EmberArray'>EmberArray</LinkTo> - contains methods like <LinkTo @route='project-version.classes.class.methods.method' @models={{array 'EmberArray' 'forEach'}} @query={{hash anchor='forEach'}}>forEach</LinkTo> and <LinkTo @route='project-version.classes.class.methods.method' @models={{array 'EmberArray' 'mapBy'}} @query={{hash anchor='mapBy'}}>mapBy</LinkTo> that help you iterate over Ember Objects</li>
<li><LinkTo @route='project-version.classes.class' @model='EmberObject'>EmberObject</LinkTo> - the main base class for all Ember objects, including the <LinkTo @route='project-version.classes.class.methods.method' @models={{array 'EmberObject' 'get'}} @query={{hash anchor='get'}}>get</LinkTo> and <LinkTo @route='project-version.classes.class.methods.method' @models={{array 'EmberObject' 'set'}} @query={{hash anchor='set'}}>set</LinkTo> methods</li>
<li><LinkTo @route='project-version.classes.class' @model='Ember.Templates.helpers'>Ember.Templates.helpers</LinkTo> - built-in functions that can be used in templates, such as the <LinkTo @route='project-version.classes.class.methods.method' @models={{array 'Ember.Templates.helpers' 'each'}} @query={{hash anchor='each'}}>each</LinkTo>, <LinkTo @route='project-version.classes.class.methods.method' @models={{array 'Ember.Templates.helpers' 'on'}} @query={{hash anchor='on'}}>on</LinkTo> and <LinkTo @route='project-version.classes.class.methods.method' @models={{array 'Ember.Templates.helpers' 'fn'}} @query={{hash anchor='fn'}}>fn</LinkTo> helpers</li>
<li>
<LinkTo @route='project-version.classes.class' @model='EmberArray'>EmberArray</LinkTo> - contains methods like
<a href="/ember/{{@version}}/classes/EmberArray#forEach">forEach</a> and
<a href="/ember/{{@version}}/classes/EmberArray#mapBy">mapBy</a>
that help you iterate over Ember Objects
</li>
<li>
<LinkTo @route='project-version.classes.class' @model='EmberObject'>EmberObject</LinkTo> - the main base class for all Ember objects, including the
<a href="/ember/{{@version}}/classes/EmberObject#get">get</a> and
<a href="/ember/{{@version}}/classes/EmberObject#set">set</a> methods
</li>
<li>
<LinkTo @route='project-version.classes.class' @model='Ember.Templates.helpers'>Ember.Templates.helpers</LinkTo> - built-in functions that can be used in templates, such as the
<a href="/ember/{{@version}}/classes/Ember.Templates.helpers#each">each</a> and
<a href="/ember/{{@version}}/classes/Ember.Templates.helpers#on">on</a> helpers
</li>
<li><LinkTo @route='project-version.classes.class' @model='Helper'>Helpers</LinkTo> - a way to define custom display functions that are used in templates</li>
<li><LinkTo @route='project-version.classes.class' @model='Route'>Route</LinkTo> - used to define individual routes, including the <LinkTo @route='project-version.classes.class.methods.method' @models={{array 'Route' 'model'}} @query={{hash anchor='model'}}>model</LinkTo> hook for loading data</li>
<li>
<LinkTo @route='project-version.classes.class' @model='Route'>Route</LinkTo> - used to define individual routes, including the
<a href="/ember/{{@version}}/classes/Route#model">model</a> hook for loading data
</li>
<li><LinkTo @route='project-version.classes.class' @model='Service'>Service</LinkTo> - an Ember object that lives for the duration of the application, and can be made available in different parts of your application</li>
</ul>
<h2>Useful links</h2>
Expand Down
15 changes: 5 additions & 10 deletions app/controllers/project-version.js
Original file line number Diff line number Diff line change
Expand Up @@ -149,32 +149,27 @@ export default class ProjectVersionController extends Controller {
endingRoute = `classes/${className}`;
break;
}
case 'project-version.classes.class.index': {
let className = this._getEncodedNameForCurrentClass();
endingRoute = `classes/${className}`;
break;
}
case 'project-version.modules.module.index': {
case 'project-version.modules.module': {
let moduleName = encodeURIComponent(this.moduleController.model.name);
endingRoute = `modules/${moduleName}`;
break;
}
case 'project-version.namespaces.namespace.index': {
case 'project-version.namespaces.namespace': {
let namespaceName = this.namespaceController.model.name;
endingRoute = `namespaces/${namespaceName}`;
break;
}
case 'project-version.classes.class.methods.index': {
case 'project-version.classes.class.methods': {
let className = this._getEncodedNameForCurrentClass();
endingRoute = `classes/${className}/methods`;
break;
}
case 'project-version.classes.class.events.index': {
case 'project-version.classes.class.events': {
let className = this._getEncodedNameForCurrentClass();
endingRoute = `classes/${className}/events`;
break;
}
case 'project-version.classes.class.properties.index': {
case 'project-version.classes.class.properties': {
let className = this._getEncodedNameForCurrentClass();
endingRoute = `classes/${className}/properties`;
break;
Expand Down
19 changes: 3 additions & 16 deletions app/router.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ AppRouter.map(function () {
// project-version.classes-redirect => project-version.classes.index
// project-version.class => project-version.classes.class
this.route('classes', function () {
this.route('class', { path: '/:class' }, itemRoutes);
this.route('class', { path: '/:class' });
});
// this.route('class', {path: '/classes/:class'}, itemRoutes);

Expand All @@ -58,7 +58,7 @@ AppRouter.map(function () {
// project-version.namespace => project-version.namespaces.namespace
// routes/project-version/namespace => routes/project-version/namespaces/namespace
this.route('namespaces', function () {
this.route('namespace', { path: '/:namespace' }, itemRoutes);
this.route('namespace', { path: '/:namespace' });
});
// this.route('namespace', {path: '/namespaces/:namespace'}, itemRoutes);

Expand All @@ -67,22 +67,9 @@ AppRouter.map(function () {
// routes/project-version/module => routes/project-version/modules/module
// routes/project-version/module/* => routes/project-version/modules/module/*
this.route('modules', function () {
this.route('module', { path: '/:module' }, itemRoutes);
this.route('module', { path: '/:module' });
});
// this.route('module', {path: '/modules/:module'}, itemRoutes);

// Common sub-routes
function itemRoutes() {
this.route('methods', function () {
this.route('method', { path: '/:method' });
});
this.route('properties', function () {
this.route('property', { path: '/:property' });
});
this.route('events', function () {
this.route('event', { path: '/:event' });
});
}
}
);
this.route('class', { path: '/classes/:class' });
Expand Down
15 changes: 0 additions & 15 deletions app/routes/project-version.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import Route from '@ember/routing/route';
import semverCompare from 'semver-compare';
import getFullVersion from 'ember-api-docs/utils/get-full-version';
import getLastVersion from 'ember-api-docs/utils/get-last-version';
import getCompactVersion from 'ember-api-docs/utils/get-compact-version';

import config from 'ember-api-docs/config/environment';

Expand Down Expand Up @@ -135,20 +134,6 @@ export default class ProjectVersionRoute extends Route {
};
}

// 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)
);
}

/**
splits the first encoded revision string in the list and takes the string after the version (which is the encoded name), then decodes the result.
*/
Expand Down
5 changes: 0 additions & 5 deletions app/routes/project-version/classes/class/events.js

This file was deleted.

5 changes: 0 additions & 5 deletions app/routes/project-version/classes/class/index.js

This file was deleted.

5 changes: 0 additions & 5 deletions app/routes/project-version/classes/class/methods.js

This file was deleted.

5 changes: 0 additions & 5 deletions app/routes/project-version/classes/class/properties.js

This file was deleted.

7 changes: 5 additions & 2 deletions app/routes/project-version/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ import Route from '@ember/routing/route';
export default class IndexRoute extends Route {
async model() {
const projectVersion = this.modelFor('project-version');
const project = await projectVersion.project;
return project;

return {
project: projectVersion.belongsTo('project').id(),
version: projectVersion.version,
};
}
}
5 changes: 0 additions & 5 deletions app/routes/project-version/modules/module/events.js

This file was deleted.

5 changes: 0 additions & 5 deletions app/routes/project-version/modules/module/methods.js

This file was deleted.

5 changes: 0 additions & 5 deletions app/routes/project-version/modules/module/properties.js

This file was deleted.

20 changes: 0 additions & 20 deletions app/templates/class-index.hbs

This file was deleted.

1 change: 0 additions & 1 deletion app/templates/class.hbs

This file was deleted.

21 changes: 20 additions & 1 deletion app/templates/project-version/classes/class.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,25 @@
</section>
<hr>
</div>
{{outlet}}
<ApiIndexFilter @model={{this.model}} @filterData={{this.filterData}} as |filteredModel|>
<ApiIndex @itemData={{filteredModel}} @classNames="api__index__content" as |sectionData|>
{{#each sectionData.sections as |section|}}
{{#if section.items}}
<h3 class="api-index-section-title">{{section.title}}</h3>
<ul class="{{section.class}}">
{{#each section.items as |item|}}
<li data-test-item={{item.name}}>
<a
href="#{{item.name}}"
>
{{item.name}}
</a>
</li>
{{/each}}
</ul>
{{/if}}
{{/each}}
</ApiIndex>
</ApiIndexFilter>
{{/if}}
</div>
4 changes: 2 additions & 2 deletions app/templates/project-version/index.hbs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{#if (eq @model.id "ember-data")}}
{{#if (eq @model.project "ember-data")}}
<EmberDataLandingPage />
{{else}}
<EmberLandingPage />
<EmberLandingPage @version={{@model.version}}/>
{{/if}}
2 changes: 0 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,6 @@
"ember-qunit": "^5.1.5",
"ember-resolver": "^8.0.3",
"ember-rfc176-data": "^0.3.17",
"ember-route-action-helper": "^2.0.8",
"ember-scroll": "^1.0.3",
"ember-showdown-shiki": "^1.2.1",
"ember-sinon": "^4.1.1",
"ember-source": "~3.28.8",
Expand Down
Loading