Skip to content

Fix multiple problems with uses and extends #574

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

Closed
wants to merge 7 commits into from
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
16 changes: 16 additions & 0 deletions app/helpers/project-name-from-class-name.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { helper } from '@ember/component/helper';

export function projectNameFromClassName([className, fallback]) {
className = className || "";
if (className.indexOf('Ember') > -1) {
return 'ember';
}

if (className.indexOf('DS.') > -1) {
return 'ember-data';
}

return fallback;
}

export default helper(projectNameFromClassName);
15 changes: 15 additions & 0 deletions app/helpers/remove-ember-prefix.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { helper } from '@ember/component/helper';

export function removeEmberPrefix(params/*, hash*/) {
let ext = params[0];
// Ember doesn't use the Ember prefix on all Classes
if(ext.indexOf('.')>=0 && ext.substring(0,5) === 'Ember'){
// return ext.replace('.','');
return ext.slice(6);
}
else{
return ext;
}
}

export default helper(removeEmberPrefix);
5 changes: 2 additions & 3 deletions app/models/class.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ const {attr, belongsTo} = DS;
const projectNameFromClassName = key => {
return computed(key, function() {
const value = this.get(key) || "";
if (value.indexOf('Ember.') > -1) {
if (value.indexOf('Ember') > -1) {
return 'ember';
}

if (value.indexOf('DS.') > 1) {
if (value.indexOf('DS.') > -1) {
return 'ember-data';
}

Expand Down Expand Up @@ -51,7 +51,6 @@ export default DS.Model.extend({

extendedClassProjectName: projectNameFromClassName('extends'),
extendedClassVersion: guessVersionFor('extends'),
usedClassProjectName: projectNameFromClassName('uses'),
usedClassVersion: guessVersionFor('uses')

});
4 changes: 2 additions & 2 deletions app/templates/project-version/classes/class.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
{{#if model.extends}}
<div class="attribute">
<span class="attribute-label">Extends:</span>
<span class="attribute-value">{{#link-to 'project-version.classes.class' model.extendedClassProjectName model.projectVersion.compactVersion model.extends}}{{model.extends}}{{/link-to}}</span>
<span class="attribute-value">{{#link-to 'project-version.classes.class' model.extendedClassProjectName model.projectVersion.compactVersion (remove-ember-prefix model.extends)}}{{model.extends}}{{/link-to}}</span>
</div>
{{/if}}
{{#if model.uses}}
Expand All @@ -18,7 +18,7 @@
<span class="attribute-value">
{{#each model.uses as |parentClass idx|}}
{{#if (not-eq idx 0)}}<span class="comma">,</span>{{/if}}
{{#link-to 'project-version.classes.class' model.usedClassProjectName model.projectVersion.compactVersion parentClass}}{{parentClass}}{{/link-to}}
{{#link-to 'project-version.classes.class' (project-name-from-class-name parentClass model.project.id) model.projectVersion.compactVersion (remove-ember-prefix parentClass)}}{{parentClass}}{{/link-to}}
{{/each}}
</span>
</div>
Expand Down
31 changes: 31 additions & 0 deletions tests/integration/helpers/remove-ember-prefix-test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import { moduleForComponent, test } from 'ember-qunit';
import hbs from 'htmlbars-inline-precompile';

moduleForComponent('remove-ember-prefix', 'helper:remove-ember-prefix', {
integration: true
});


test('it doesn\'t remove DS prefix', function(assert) {
this.set('inputValue', 'DS.Error');

this.render(hbs`{{remove-ember-prefix inputValue}}`);

assert.equal(this.$().text().trim(), 'DS.Error');
});

test('it does remove `Ember.` prefix ', function(assert) {
this.set('inputValue', 'Ember.ArrayProxy');

this.render(hbs`{{remove-ember-prefix inputValue}}`);

assert.equal(this.$().text().trim(), 'ArrayProxy');
});

test('it doesn\'t remove `Ember` prefix', function(assert) {
this.set('inputValue', 'EmberArray');

this.render(hbs`{{remove-ember-prefix inputValue}}`);

assert.equal(this.$().text().trim(), 'EmberArray');
});
19 changes: 19 additions & 0 deletions tests/unit/helpers/project-name-from-class-name-test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { projectNameFromClassName } from 'ember-api-docs/helpers/project-name-from-class-name';
import { module, test } from 'qunit';

module('Unit | Helper | project name from class name');

test('it should find ember project name', function(assert) {
const result = projectNameFromClassName(['Ember.SomeClass', 'fallback']);
assert.equal(result, 'ember');
});

test('it should find ember-data project name', function(assert) {
const result = projectNameFromClassName(['DS.SomeClass', 'fallback']);
assert.equal(result, 'ember-data');
});

test('it should find fallback project name', function(assert) {
const result = projectNameFromClassName(['Other.SomeClass', 'fallback']);
assert.equal(result, 'fallback');
});