fix(hierarchy): collect events from static and intstance members

Fixes documentationjs#486
dignifiedquire · Dec 8, 2016 · 6f98562 · 6f98562
1 parent 73ba79b
commit 6f98562
Show file tree

Hide file tree

Showing 58 changed files with 447 additions and 257 deletions.
diff --git a/lib/hierarchy.js b/lib/hierarchy.js
@@ -1,5 +1,6 @@
 'use strict';
 
+var _ = require('lodash');
 var hasOwnProperty = Object.prototype.hasOwnProperty;
 
 /**
@@ -119,16 +120,24 @@ module.exports = function (comments) {
           comment.members[scope] = node.members[scope];
         }
 
+        var events = comment.members.events || [];
+        var groups = [];
+
         if (comment.members.instance.length) {
-          comment.members.events = comment.members.instance.filter(function (member) {
-            return member.kind === 'event';
-          });
+          groups = _.groupBy(comment.members.instance, isEvent);
 
-          comment.members.instance = comment.members.instance.filter(function (member) {
-            return member.kind !== 'event';
-          });
+          events = events.concat(groups[true] || []);
+          comment.members.instance = groups[false] || [];
+        }
+
+        if (comment.members.static.length) {
+          groups = _.groupBy(comment.members.static, isEvent);
+
+          events = events.concat(groups[true] || []);
+          comment.members.static = groups[false] || [];
         }
 
+        comment.members.events = events;
 
         comment.path = path.map(pick).concat(pick(comment));
 
@@ -168,3 +177,12 @@ module.exports = function (comments) {
 
   return toComments(root.members.static);
 };
+
+/**
+ * Check if a given member object is of kind `event`.
+ * @param {Object} member - The member to check.
+ * @returns {boolean} `true` if it is of kind `event`, otherwise false.
+ */
+function isEvent(member) {
+  return member.kind === 'event';
+}
diff --git a/test/fixture/_external-deps-included.json b/test/fixture/_external-deps-included.json
@@ -114,7 +114,8 @@
     "kind": "function",
     "members": {
       "instance": [],
-      "static": []
+      "static": [],
+      "events": []
     },
     "path": [
       {
@@ -275,7 +276,8 @@
     "kind": "function",
     "members": {
       "instance": [],
-      "static": []
+      "static": [],
+      "events": []
     },
     "path": [
       {
@@ -436,7 +438,8 @@
     "kind": "function",
     "members": {
       "instance": [],
-      "static": []
+      "static": [],
+      "events": []
     },
     "path": [
       {

diff --git a/test/fixture/_multi-file-input.json b/test/fixture/_multi-file-input.json
@@ -232,7 +232,8 @@
     "kind": "function",
     "members": {
       "instance": [],
-      "static": []
+      "static": [],
+      "events": []
     },
     "path": [
       {
@@ -393,7 +394,8 @@
     "kind": "function",
     "members": {
       "instance": [],
-      "static": []
+      "static": [],
+      "events": []
     },
     "path": [
       {

diff --git a/test/fixture/boolean-literal-type.output.json b/test/fixture/boolean-literal-type.output.json
@@ -66,7 +66,8 @@
     ],
     "members": {
       "instance": [],
-      "static": []
+      "static": [],
+      "events": []
     },
     "path": [
       {

diff --git a/test/fixture/class.output.json b/test/fixture/class.output.json
@@ -385,7 +385,8 @@
           "scope": "instance",
           "members": {
             "instance": [],
-            "static": []
+            "static": [],
+            "events": []
           },
           "path": [
             {
@@ -551,7 +552,8 @@
           "scope": "instance",
           "members": {
             "instance": [],
-            "static": []
+            "static": [],
+            "events": []
           },
           "path": [
             {

diff --git a/test/fixture/document-exported-export-default-object.output.json b/test/fixture/document-exported-export-default-object.output.json
@@ -28,7 +28,8 @@
     "name": "document-exported-export-default-object.input",
     "members": {
       "instance": [],
-      "static": []
+      "static": [],
+      "events": []
     },
     "path": [
       {
@@ -66,7 +67,8 @@
     "name": "x",
     "members": {
       "instance": [],
-      "static": []
+      "static": [],
+      "events": []
     },
     "path": [
       {

diff --git a/test/fixture/document-exported-export-default-value.output.json b/test/fixture/document-exported-export-default-value.output.json
@@ -28,7 +28,8 @@
     "name": "document-exported-export-default-value.input",
     "members": {
       "instance": [],
-      "static": []
+      "static": [],
+      "events": []
     },
     "path": [
       {