Merge pull request #301 from jenweber/bugfix-duplicate-properties

bugfix: duplicate properties (#276)

Author: sivakumar-kailasam

app/components/api-index-filter.js

@@ -48,7 +48,9 @@ export default Component.extend({
     if (!this.get('filterData.showDeprecated')) {
       items = items.filter(item => item.deprecated !== true);
     }
-    return uniq(sortBy(items, 'name'), true, (item => item.name));
+
+    let sortedUniqueItems = uniq(sortBy(items, 'name'), true, (item => item.name));
+    return this.filterMultipleInheritance(sortedUniqueItems);
   },
 
   filteredData: computed('filteredMethods', 'filteredProperties', 'filteredEvents', function() {
@@ -57,6 +59,54 @@ export default Component.extend({
       properties: this.get('filteredProperties'),
       events: this.get('filteredEvents')
     };
-  })
+  }),
 
-});
+  /**
+  * Returns an array where duplicate methods (by name) are removed.
+  * The docs for the nearest inheritance are typically more helpful to users,
+  * so in cases of duplicates, "more local" is preferred.
+  * Without this, multiple entries for some methods will show up.
+  * @method filterMultipleInheritance
+  */
+  filterMultipleInheritance(items) {
+    let dedupedArray = [];
+    for (let i = 0; i < items.length; i++) {
+      let currentItem = items[i];
+      if (i === items.length - 1) {
+        // if it's the last item, keep it
+        dedupedArray.push(currentItem);
+      } else {
+        let nextItem = items[i + 1];
+        if (currentItem.name === nextItem.name) {
+          // if the method would be listed twice, find the more local documentation
+          let mostLocal = this.findMostLocal(currentItem, nextItem)
+          dedupedArray.push(mostLocal);
+          i += 1; // skip the next item with duplicate name
+        } else {
+          dedupedArray.push(currentItem);
+        }
+      }
+    }
+    return dedupedArray;
+  },
+  /**
+  * Returns whichever item is most local.
+  * What is "most local" is determined by looking at the file path for the
+  * method, the file path for the class being viewed, and the parent if needed.
+  * @method findMostLocal
+  */
+  findMostLocal(currentItem, nextItem) {
+    let currentScope = this.get('model.file');
+    let parentClassScope = this.get('model.parentClass.file');
+    if (currentScope === currentItem.file) {
+      // if the item belongs to the class, keep it
+      return currentItem;
+    } else if (parentClassScope === currentItem.file) {
+      // or if the item belongs to the parent class, keep it
+      return currentItem;
+    } else {
+      // otherwise, the next item must be "more local"
+      return nextItem;
+    }
+  }
+})

app/templates/components/class-field-description.hbs

@@ -19,7 +19,7 @@
       <span class="access">deprecated</span>
     {{/if}}
   </h3>
-  <p class="github-link">
+  <p class="github-link" data-test-file={{field.file}}>
     {{#if field.inherited}}
       Inherited from
       <a href="{{github-link model.project.id model.projectVersion.version field.file field.line}}" target="_blank" rel="noopener">

tests/acceptance/method-inheritance-test.js

@@ -0,0 +1,17 @@
+import moduleForAcceptance from 'ember-api-docs/tests/helpers/module-for-acceptance';
+import {test} from 'qunit';
+import { visit, click, findAll, findWithAssert } from 'ember-native-dom-helpers';
+import testSelector from 'ember-test-selectors';
+
+moduleForAcceptance('Acceptance | method inheritance')
+
+test('no duplicate methods displayed', async function (assert) {
+  await visit('/ember-data/2.14/classes/DS.JSONAPIAdapter');
+  assert.equal(findAll("[data-test-item='createRecord']").length, 1);
+});
+
+test('most local inherited method is shown', async function (assert) {
+  await visit('/ember-data/2.14/classes/DS.JSONAPIAdapter');
+  await click(`${testSelector('item', 'createRecord')} a`)
+  assert.ok(findWithAssert("[data-test-file='addon/adapters/rest.js']"));
+});