[feat] API filtering

This PR adds filtering of members for classes and components that allows
users to filter out private, protected, inherited, and deprecated
members. In the case of components, users can also filter out `internal`
properties - everything besides Yields and Arguments.

Filters only appear if there is something to filter, and by default
they are enabled (unchecked), so users should see the minimal public API
of the class.

The complexity of the filters is definitely not ideal, but at the moment
I'm unsure if pushing that complexity into the object model (e.g. by
adding `publicFields`, `privateFields`, `staticPublicFields`,
`staticPrivateFields`, etc directly to models) as part of the build step
will help much.

Author: pzuraq

addon/components/api/x-class/component.js

@@ -1,19 +1,35 @@
 import Component from '@ember/component';
 import { computed } from '@ember/object';
+import { capitalize } from '@ember/string';
+import { memberFilter }  from '../../../utils/computed';
 
 import layout from './template';
 
 export default Component.extend({
   layout,
 
+  showInherited: false,
+  showProtected: false,
+  showPrivate: false,
+  showDeprecated: false,
+
+  accessors: memberFilter('class', 'accessors'),
+  methods: memberFilter('class', 'methods'),
+  fields: memberFilter('class', 'fields'),
+
   hasContents: computed('class', {
     get() {
       let klass = this.get('class');
 
-      return klass.get('constructors.length') > 0
-        || klass.get('fields.length') > 0
-        || klass.get('accessors.length') > 0
-        || klass.get('methods.length') > 0;
+      return klass.get('allFields.length') > 0
+        || klass.get('allAccessors.length') > 0
+        || klass.get('allMethods.length') > 0;
+    }
+  }),
+
+  actions: {
+    updateFilter(filter, { target: { checked } }) {
+      this.set(`show${capitalize(filter)}`, checked);
     }
-  })
+  }
 });

addon/components/api/x-class/template.hbs

@@ -6,11 +6,20 @@
 {{#if hasContents}}
   <div class="class-contents">
     {{api/x-index
+      options=(hash
+        inherited=inherited
+        protected=protected
+        private=private
+        deprecated=deprecated
+      )
+
+      onOptionToggle=(action 'updateFilter')
+
       sections=(hash
-        constructors=class.constructors
-        fields=class.fields
-        accessors=class.accessors
-        methods=class.methods
+        constructors=constructors
+        fields=fields
+        accessors=accessors
+        methods=methods
       )
     }}
 

addon/components/api/x-component/component.js

@@ -1,21 +1,42 @@
 import Component from '@ember/component';
 import { computed } from '@ember/object';
+import { alias } from '@ember/object/computed';
+import { capitalize } from '@ember/string';
+import { memberFilter }  from '../../../utils/computed';
 
 import layout from './template';
 
 export default Component.extend({
   layout,
 
+  showInherited: false,
+  showInternal: false,
+  showProtected: false,
+  showPrivate: false,
+  showDeprecated: false,
+
+  yields: alias('component.overloadedYields'),
+
+  arguments: memberFilter('component', 'arguments'),
+  accessors: memberFilter('component', 'accessors'),
+  methods: memberFilter('component', 'methods'),
+  fields: memberFilter('component', 'fields'),
+
   hasContents: computed('component', {
     get() {
       let component = this.get('component');
 
-      return component.get('constructors.length') > 0
-        || component.get('yields.length') > 0
+      return component.get('overloadedYields.length') > 0
         || component.get('arguments.length') > 0
         || component.get('fields.length') > 0
         || component.get('accessors.length') > 0
         || component.get('methods.length') > 0;
     }
-  })
+  }),
+
+  actions: {
+    updateFilter(filter, { target: { checked } }) {
+      this.set(`show${capitalize(filter)}`, checked);
+    }
+  }
 });

addon/components/api/x-component/template.hbs

@@ -6,24 +6,34 @@
 {{#if hasContents}}
   <div class="class-contents">
     {{api/x-index
+      options=(hash
+        inherited=(hash shouldShow=component.hasInherited value=showInherited)
+        internal=(hash shouldShow=component.hasInternal value=showInternal)
+        protected=(hash shouldShow=component.hasProtected value=showProtected)
+        private=(hash shouldShow=component.hasPrivate value=showPrivate)
+        deprecated=(hash shouldShow=component.hasDeprecated value=showDeprecated)
+      )
+
+      onOptionToggle=(action 'updateFilter')
+
       sections=(hash
-        constructors=component.constructors
-        yields=component.yields
-        arguments=component.arguments
-        fields=component.fields
-        accessors=component.accessors
-        methods=component.methods
+        constructors=constructors
+        yields=yields
+        arguments=arguments
+        fields=fields
+        accessors=accessors
+        methods=methods
       )
     }}
 
     {{api/x-sections
       sections=(hash
-        constructors=component.constructors
-        yields=component.yields
-        arguments=component.arguments
-        fields=component.fields
-        accessors=component.accessors
-        methods=component.methods
+        constructors=constructors
+        yields=yields
+        arguments=arguments
+        fields=fields
+        accessors=accessors
+        methods=methods
       )
     }}
   </div>

addon/components/api/x-index/style.scss

@@ -1,5 +1,5 @@
 .class-index {
-  width: 200px;
+  flex: 0 0 200px;
   padding: 0 20px;
 
   font-size: 0.85em;

addon/components/api/x-index/template.hbs

@@ -1,6 +1,20 @@
 <div class="class-index__sticky">
   <h2>Index</h2>
 
+  <ul>
+    {{#each-in options as |key option|}}
+      {{#if option.shouldShow}}
+        <li>
+          <label>
+            <input type="checkbox" checked={{option.value}} onclick={{action onOptionToggle key}}>
+
+            {{capitalize key}}
+          </label>
+        </li>
+      {{/if}}
+    {{/each-in}}
+  </ul>
+
   {{#each-in sections as |section items|}}
     {{#if items}}
       <h3>{{capitalize section}}</h3>

addon/helpers/type-signature.js

@@ -42,6 +42,14 @@ export function typeSignature([typed]) {
     signature = functionSignature(typed);
   }
 
+  if (typed.isStatic) {
+    signature = `static ${signature}`;
+  }
+
+  if (typed.access === 'private' || typed.access === 'protected') {
+    signature = `${typed.access} ${signature}`;
+  }
+
   return htmlSafe(signature);
 }
 

addon/models/class.js

@@ -1,4 +1,10 @@
 import DS from 'ember-data';
+import {
+  filterBy,
+  or,
+  union
+} from '@ember/object/computed';
+import { memberUnion, hasMemberType } from '../utils/computed';
 
 const { attr, belongsTo } = DS;
 
@@ -17,5 +23,61 @@ export default DS.Model.extend({
   accessors: attr(),
   methods: attr(),
   fields: attr(),
-  tags: attr()
+  tags: attr(),
+
+  publicAccessors: filterBy('accessors', 'access', 'public'),
+  publicMethods: filterBy('methods', 'access', 'public'),
+  publicFields: filterBy('fields', 'access', 'public'),
+
+  privateAccessors: filterBy('accessors', 'access', 'private'),
+  privateMethods: filterBy('methods', 'access', 'private'),
+  privateFields: filterBy('fields', 'access', 'private'),
+
+  protectedAccessors: filterBy('accessors', 'access', 'protected'),
+  protectedMethods: filterBy('methods', 'access', 'protected'),
+  protectedFields: filterBy('fields', 'access', 'protected'),
+
+  allPublicAccessors: memberUnion('parentClass.allPublicAccessors', 'publicAccessors'),
+  allPublicMethods: memberUnion('parentClass.allPublicMethods', 'publicMethods'),
+  allPublicFields: memberUnion('parentClass.allPublicFields', 'publicFields'),
+
+  allPrivateAccessors: memberUnion('parentClass.allPrivateAccessors', 'privateAccessors'),
+  allPrivateMethods: memberUnion('parentClass.allPrivateMethods', 'privateMethods'),
+  allPrivateFields: memberUnion('parentClass.allPrivateFields', 'privateFields'),
+
+  allProtectedAccessors: memberUnion('parentClass.allProtectedAccessors', 'protectedAccessors'),
+  allProtectedMethods: memberUnion('parentClass.allProtectedMethods', 'protectedMethods'),
+  allProtectedFields: memberUnion('parentClass.allProtectedFields', 'protectedFields'),
+
+  allAccessors: union('allPublicAccessors', 'allPrivateAccessors', 'allProtectedAccessors'),
+  allMethods: union('allPublicMethods', 'allPrivateMethods', 'allProtectedMethods'),
+  allFields: union('allPublicFields', 'allPrivateFields', 'allProtectedFields'),
+
+  hasInherited: or(
+    'parentClass.allAccessors.length',
+    'parentClass.allMethods.length',
+    'parentClass.allFields.length'
+  ),
+
+  hasPrivate: or(
+    'allPrivateAccessors.length',
+    'allPrivateMethods.length',
+    'allPrivateFields.length'
+  ),
+
+  hasProtected: or(
+    'allProtectedAccessors.length',
+    'allProtectedMethods.length',
+    'allProtectedFields.length'
+  ),
+
+  hasDeprecated: hasMemberType(
+    'allFields',
+    'allAccessors',
+    'allMethods',
+
+    function(member) {
+      return member.tags && member.tags.find(t => t.name === 'deprecated');
+    }
+  )
 });

addon/models/component.js

@@ -1,11 +1,65 @@
 import DS from 'ember-data';
+import { filterBy, or } from '@ember/object/computed';
+
 import Class from './class';
+import { memberUnion, hasMemberType } from '../utils/computed';
 
 const { attr } = DS;
 
 export default Class.extend({
   isComponent: true,
 
   yields: attr(),
-  arguments: attr()
+  arguments: attr(),
+
+  overloadedYields: or('yields', 'inheritedYields'),
+
+  publicArguments: filterBy('arguments', 'access', 'public'),
+  privateArguments: filterBy('arguments', 'access', 'private'),
+  protectedArguments: filterBy('arguments', 'access', 'protected'),
+
+  allPublicArguments: memberUnion('parentClass.allPublicArguments', 'publicArguments'),
+  allPrivateArguments: memberUnion('parentClass.allPrivateArguments', 'privateArguments'),
+  allProtectedArguments: memberUnion('parentClass.allProtectedArguments', 'protectedArguments'),
+
+  allArguments: memberUnion('parentClass.allArguments', 'arguments'),
+
+  hasInherited: or(
+    'parentClass.overloadedYields.length',
+    'parentClass.allArguments.length',
+    'parentClass.allAccessors.length',
+    'parentClass.allMethods.length',
+    'parentClass.allFields.length'
+  ),
+
+  hasInternal: or(
+    'allAccessors.length',
+    'allMethods.length',
+    'allFields.length'
+  ),
+
+  hasPrivate: or(
+    'allPrivateAccessors.length',
+    'allPrivateArguments.length',
+    'allPrivateMethods.length',
+    'allPrivateFields.length'
+  ),
+
+  hasProtected: or(
+    'allProtectedAccessors.length',
+    'allProtectedArguments.length',
+    'allProtectedMethods.length',
+    'allProtectedFields.length'
+  ),
+
+  hasDeprecated: hasMemberType(
+    'allAccessors',
+    'allArguments',
+    'allMethods',
+    'allFields',
+
+    function(member) {
+      return member.tags && member.tags.find(t => t.name === 'deprecated');
+    }
+  )
 });