add META.isPrivate(), allow private components

Author: levithomason

src/utils/Meta.js

@@ -38,6 +38,23 @@ const META = {
     !_.has(component, '_meta.parent') || _.get(component, '_meta.parent') === component._meta.name
   ),
   isChild: component => !META.isParent(component),
+
+  // other
+  /**
+   * Components whose constructor begins with an "_" are private.
+   * This helper handles strings, classes, and instances and returns true if the
+   * name or class definition begins with an "_".
+   * @param {string|class|object} component A class, an instance, or constructor name.
+   * @returns {boolean}
+   */
+  isPrivate: component => {
+    // handle component names from a string, a class, or an instance
+    const name = _.isString(component) && component
+      || _.get(component, '_meta.name')
+      || _.get(component, '.constructor._meta.name');
+
+    return _.startsWith(name, '_');
+  },
 };
 
 export default META;

test/specs/Conformance-test.js

@@ -29,6 +29,13 @@ describe('Conformance', () => {
       });
 
       it(`has the "${sdClass}" element as its first child (no wrapper elements)`, () => {
+        // private components may be used as root elements and will not have the sd-* class
+        // skip any assertions if the first child is a private component
+        // TODO: this excludes private components from conformance, need to find a sane way to get conformance coverage
+        if (META.isPrivate(firstChild)) {
+          return;
+        }
+
         if (isDOMComponent(firstChild)) {
           expect(firstChild.getAttribute('class')).to.contain(sdClass);
         } else {

test/specs/index-test.js

@@ -1,6 +1,7 @@
 import _ from 'lodash';
 import path from 'path';
 import stardust from 'stardust';
+import META from 'src/utils/Meta';
 
 const componentCtx = require.context(
   'src/',
@@ -14,10 +15,9 @@ const componentNames = _.map(componentCtx.keys(), key => {
 
 describe('stardust (index.js)', () => {
   _.each(componentNames, name => {
-    const isPrivate = _.startsWith(name, '_');
+    const isPrivate = META.isPrivate(name);
     const isStardustProp = _.has(stardust, name);   // => stardust.H1
     const isSubComponent = _.some(stardust, name);  // => stardust.Header.H1
-    // console.log(`${name} isStardustProp=${isStardustProp} isSubComponent=${isSubComponent}`);
 
     if (isPrivate) {
       it(`does not expose private component "${name}"`, () => {