Skip to content

Showing pencil link only on current release, and linking to gh edit #566

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
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
5 changes: 4 additions & 1 deletion app/helpers/github-link.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
import { helper } from '@ember/component/helper';
import githubMap from '../utils/github-map';

export function githubLink([project, version, file, line]) {
export function githubLink([project, version, file, line], { isEdit=false }) {
if (isEdit) {
return `https://github.com/${githubMap[project]}/edit/release/${file}#L${line}`;
}
return `https://github.com/${githubMap[project]}/tree/v${version}/${file}#L${line}`;
}

Expand Down
9 changes: 9 additions & 0 deletions app/helpers/is-latest.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { helper } from '@ember/component/helper';
import getLastVersion from 'ember-api-docs/utils/get-last-version';

export function isLatest(params, { version, allVersions}) {
let latestVersion = getLastVersion(allVersions);
return version === latestVersion;
}

export default helper(isLatest);
4 changes: 3 additions & 1 deletion app/templates/project-version/classes/class.hbs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<article class="chapter">
<a data-tooltip="View on Github" class="heading__link__edit" href="{{github-link model.project.id model.projectVersion.version model.file model.line}}" target="_blank" rel="noopener">{{svg-jar "fa-pencil"}}</a>
{{#if (is-latest version=model.projectVersion.version allVersions=model.project.projectVersions)}}
<a data-tooltip="Edit on Github" class="heading__link__edit" href="{{github-link model.project.id model.projectVersion.version model.file model.line isEdit=true}}" target="_blank" rel="noopener">{{svg-jar "fa-pencil"}}</a>
{{/if}}
<h1 class="module-name">Class {{model.name}}</h1>
{{#if model.access}}<span class="access">{{model.access}}</span>{{/if}}

Expand Down
40 changes: 40 additions & 0 deletions tests/integration/helpers/is-latest-test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import { module, test } from 'qunit';
import { setupRenderingTest } from 'ember-qunit';
import { render } from '@ember/test-helpers';
import hbs from 'htmlbars-inline-precompile';
import { A } from '@ember/array';

const versions = A([
{ id: 'ember-1.13.0' },
{ id: 'ember-3.5.0' },
{ id: 'ember-2.1.10' }
]);

module('helper:is-latest', function (hooks) {
setupRenderingTest(hooks);

test('should resolve true if latest release', async function(assert) {
this.set('version', '3.5.0');
this.set('allVersions', versions);

await render(hbs`
{{#if (is-latest version=version allVersions=allVersions)}}
Hello World
{{/if}}
`);

assert.equal(this.element.textContent.trim(), 'Hello World');
});

test('should resolve false if not latest', async function (assert) {
this.set('version', '3.1.0');
this.set('allVersions', versions);
await render(hbs`
{{#if (is-latest version=version allVersions=allVersions)}}
Hello World
{{/if}}
`);
assert.notEqual(this.element.textContent.trim(), 'Hello World');
})

});
2 changes: 1 addition & 1 deletion tests/unit/helpers/github-link-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ import { module, test } from 'qunit';
module('Unit | Helper | github link');

test('should render a github link from file info', function(assert) {
let result = githubLink(['ember', '2.10.0', 'ember-glimmer/lib/component.js', '35']);
let result = githubLink(['ember', '2.10.0', 'ember-glimmer/lib/component.js', '35'], {});
assert.equal(result, 'https://github.com/emberjs/ember.js/tree/v2.10.0/ember-glimmer/lib/component.js#L35');
});