Add displayName handler (closes #16)

This handler finds the `displayName` property/member and adds it to the
documentation as `displayName`.

Author: fkling

src/__tests__/main-test.js

@@ -23,6 +23,7 @@ describe('main', () => {
     it('parses with default resolver/handlers', () => {
       var docs = docgen.parse(source);
       expect(docs).toEqual({
+        displayName: 'ABC',
         description: 'Example component description',
         props: {
           foo: {
@@ -58,6 +59,7 @@ describe('main', () => {
        * Example component description
        */
       var Component = React.createClass({
+        displayName: 'ABC',
         propTypes: {
           /**
            * Example prop description
@@ -93,6 +95,7 @@ describe('main', () => {
       Component.defaultProps = {
         foo: true,
       };
+      Component.displayName = 'ABC';
     `);
   });
 

src/handlers/__tests__/displayNameHandler-test.js

@@ -0,0 +1,86 @@
+/*
+ *  Copyright (c) 2015, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the BSD-style license found in the
+ *  LICENSE file in the root directory of this source tree. An additional grant
+ *  of patent rights can be found in the PATENTS file in the same directory.
+ *
+ */
+
+/*global jest, describe, beforeEach, it, expect*/
+
+jest.autoMockOff();
+jest.mock('../../Documentation');
+
+describe('defaultPropsHandler', () => {
+  var documentation;
+  var displayNameHandler;
+  var expression, statement;
+
+  beforeEach(() => {
+    ({expression, statement} = require('../../../tests/utils'));
+    documentation = new (require('../../Documentation'));
+    displayNameHandler = require('../displayNameHandler');
+  });
+
+  it('extracts the displayName', () => {
+    var definition = expression('({displayName: "FooBar"})');
+    displayNameHandler(documentation, definition);
+    expect(documentation.displayName).toBe('FooBar');
+
+    definition = statement(`
+      class Foo {
+        static displayName = "BarFoo";
+      }
+    `);
+    displayNameHandler(documentation, definition);
+    expect(documentation.displayName).toBe('BarFoo');
+  });
+
+  it('resolves identifiers', () => {
+    var definition = statement(`
+      ({displayName: name})
+      var name = 'abc';
+    `).get('expression');
+    displayNameHandler(documentation, definition);
+    expect(documentation.displayName).toBe('abc');
+
+    definition = statement(`
+      class Foo {
+        static displayName = name;
+      }
+      var name = 'xyz';
+    `);
+    displayNameHandler(documentation, definition);
+    expect(documentation.displayName).toBe('xyz');
+  });
+
+  it('ignores non-literal names', () => {
+    var definition = expression('({displayName: foo.bar})');
+    expect(() => displayNameHandler(documentation, definition)).not.toThrow();
+    expect(documentation.displayName).not.toBeDefined();
+
+    definition = statement(`
+      class Foo {
+        static displayName = foo.bar;
+      }
+    `);
+    expect(() => displayNameHandler(documentation, definition)).not.toThrow();
+    expect(documentation.displayName).not.toBeDefined();
+  });
+
+  it('ignores non-literal names', () => {
+    var definition = expression('({displayName: foo.bar})');
+    expect(() => displayNameHandler(documentation, definition)).not.toThrow();
+    expect(documentation.displayName).not.toBeDefined();
+
+    definition = statement(`
+      class Foo {
+        static displayName = foo.bar;
+      }
+    `);
+    expect(() => displayNameHandler(documentation, definition)).not.toThrow();
+    expect(documentation.displayName).not.toBeDefined();
+  });
+});

src/handlers/displayNameHandler.js

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2015, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ * @flow
+ *
+ */
+
+import type Documentation from '../Documentation';
+
+import getMemberValuePath from '../utils/getMemberValuePath';
+import recast from 'recast';
+import resolveToValue from '../utils/resolveToValue';
+
+var {types: {namedTypes: types}} = recast;
+
+export default function displayNameHandler(
+  documentation: Documentation,
+  path: NodePath
+) {
+  var displayNamePath = getMemberValuePath(path, 'displayName');
+  if (!displayNamePath) {
+    return;
+  }
+  displayNamePath = resolveToValue(displayNamePath);
+  if (!displayNamePath || !types.Literal.check(displayNamePath.node)) {
+    return;
+  }
+  documentation.set('displayName', displayNamePath.node.value);
+}

src/handlers/index.js

@@ -16,3 +16,4 @@ export {default as defaultPropsHandler} from './defaultPropsHandler';
 export {default as propTypeHandler} from './propTypeHandler';
 export {default as propTypeCompositionHandler} from './propTypeCompositionHandler';
 export {default as propDocBlockHandler} from './propDocBlockHandler';
+export {default as displayNameHandler} from './displayNameHandler';

src/main.js

@@ -21,6 +21,7 @@ var defaultHandlers = [
   handlers.propDocBlockHandler,
   handlers.defaultPropsHandler,
   handlers.componentDocblockHandler,
+  handlers.displayNameHandler,
 ];
 
 /**