Rename MimeRenderer -> MimeDocument

packages/application/src/mimerenderers.ts

@@ -6,7 +6,7 @@ import {
 } from '@jupyterlab/apputils';
 
 import {
-  MimeRenderer, MimeRendererFactory
+  MimeDocument, MimeDocumentFactory
 } from '@jupyterlab/docregistry';
 
 import {
@@ -70,7 +70,7 @@ function createRendermimePlugin(item: IRenderMime.IExtension): JupyterLabPlugin<
         return;
       }
 
-      let factory = new MimeRendererFactory({
+      let factory = new MimeDocumentFactory({
         mimeType: item.mimeType,
         renderTimeout: item.renderTimeout,
         dataType: item.dataType,
@@ -81,7 +81,7 @@ function createRendermimePlugin(item: IRenderMime.IExtension): JupyterLabPlugin<
 
       const factoryName = factory.name;
       const namespace = `${factoryName}-renderer`;
-      const tracker = new InstanceTracker<MimeRenderer>({ namespace });
+      const tracker = new InstanceTracker<MimeDocument>({ namespace });
 
       // Handle state restoration.
       restorer.restore(tracker, {

packages/docregistry/src/default.ts

@@ -403,16 +403,16 @@ abstract class ABCWidgetFactory<T extends DocumentRegistry.IReadyWidget, U exten
 
 
 /**
- * A widget for rendered mimetype.
+ * A widget for rendered mimetype document.
  */
 export
-class MimeRenderer extends Widget implements DocumentRegistry.IReadyWidget {
+class MimeDocument extends Widget implements DocumentRegistry.IReadyWidget {
   /**
    * Construct a new markdown widget.
    */
-  constructor(options: MimeRenderer.IOptions) {
+  constructor(options: MimeDocument.IOptions) {
     super();
-    this.addClass('jp-MimeRenderer');
+    this.addClass('jp-MimeDocument');
     let layout = this.layout = new PanelLayout();
     let toolbar = new Widget();
     toolbar.addClass('jp-Toolbar');
@@ -528,12 +528,12 @@ class MimeRenderer extends Widget implements DocumentRegistry.IReadyWidget {
 
 
 /**
- * The namespace for MimeRenderer class statics.
+ * The namespace for MimeDocument class statics.
  */
 export
-namespace MimeRenderer {
+namespace MimeDocument {
   /**
-   * The options used to initialize a MimeRenderer.
+   * The options used to initialize a MimeDocument.
    */
   export
   interface IOptions {
@@ -566,14 +566,14 @@ namespace MimeRenderer {
 
 
 /**
- * An implementation of a widget factory for a rendered mimetype.
+ * An implementation of a widget factory for a rendered mimetype document.
  */
 export
-class MimeRendererFactory extends ABCWidgetFactory<MimeRenderer, DocumentRegistry.IModel> {
+class MimeDocumentFactory extends ABCWidgetFactory<MimeDocument, DocumentRegistry.IModel> {
   /**
    * Construct a new markdown widget factory.
    */
-  constructor(options: MimeRendererFactory.IOptions) {
+  constructor(options: MimeDocumentFactory.IOptions) {
     super({ ...options, readOnly: true });
     this._rendermime = options.rendermime;
     this._mimeType = options.mimeType;
@@ -586,8 +586,8 @@ class MimeRendererFactory extends ABCWidgetFactory<MimeRenderer, DocumentRegistr
   /**
    * Create a new widget given a context.
    */
-  protected createNewWidget(context: DocumentRegistry.Context): MimeRenderer {
-    let widget = new MimeRenderer({
+  protected createNewWidget(context: DocumentRegistry.Context): MimeDocument {
+    let widget = new MimeDocument({
       context,
       rendermime: this._rendermime.clone(),
       mimeType: this._mimeType,
@@ -609,12 +609,12 @@ class MimeRendererFactory extends ABCWidgetFactory<MimeRenderer, DocumentRegistr
 
 
 /**
- * The namespace for MimeRendererFactory class statics.
+ * The namespace for MimeDocumentFactory class statics.
  */
 export
-namespace MimeRendererFactory {
+namespace MimeDocumentFactory {
   /**
-   * The options used to initialize a MimeRendererFactory.
+   * The options used to initialize a MimeDocumentFactory.
    */
   export
   interface IOptions extends DocumentRegistry.IWidgetFactoryOptions {

packages/markdownviewer-extension/src/index.ts

@@ -10,7 +10,7 @@ import {
 } from '@jupyterlab/apputils';
 
 import {
-  MimeRendererFactory, MimeRenderer
+  MimeDocumentFactory, MimeDocument
 } from '@jupyterlab/docregistry';
 
 
@@ -51,7 +51,7 @@ const plugin: JupyterLabPlugin<void> = {
  * Activate the markdown plugin.
  */
 function activate(app: JupyterLab, restorer: ILayoutRestorer) {
-    const factory = new MimeRendererFactory({
+    const factory = new MimeDocumentFactory({
       name: FACTORY,
       fileExtensions: ['.md'],
       mimeType: 'text/markdown',
@@ -61,7 +61,7 @@ function activate(app: JupyterLab, restorer: ILayoutRestorer) {
 
     const { commands } = app;
     const namespace = 'rendered-markdown';
-    const tracker = new InstanceTracker<MimeRenderer>({ namespace });
+    const tracker = new InstanceTracker<MimeDocument>({ namespace });
 
     // Handle state restoration.
     restorer.restore(tracker, {

test/src/docregistry/default.spec.ts

@@ -4,7 +4,7 @@
 import expect = require('expect.js');
 
 import {
-  Message, MessageLoop
+  Message
 } from '@phosphor/messaging';
 
 import {
@@ -14,7 +14,7 @@ import {
 import {
   ABCWidgetFactory, Base64ModelFactory, DocumentModel,
   DocumentRegistry, TextModelFactory, Context,
-  MimeRenderer, MimeRendererFactory
+  MimeDocument, MimeDocumentFactory
 } from '@jupyterlab/docregistry';
 
 import {
@@ -25,7 +25,7 @@ import {
 const RENDERMIME = defaultRenderMime();
 
 
-class LogRenderer extends MimeRenderer {
+class LogRenderer extends MimeDocument {
   methods: string[] = [];
 
   protected onAfterAttach(msg: Message): void {
@@ -584,37 +584,37 @@ describe('docmanager/default', () => {
 
   });
 
-  describe('MimeRendererFactory', () => {
+  describe('MimeDocumentFactory', () => {
 
     describe('#createNew()', () => {
 
       it('should require a context parameter', () => {
-        let widgetFactory = new MimeRendererFactory({
+        let widgetFactory = new MimeDocumentFactory({
           name: 'markdown',
           fileExtensions: ['.md'],
           rendermime: RENDERMIME,
           mimeType: 'text/markdown'
         });
-        expect(widgetFactory.createNew(context)).to.be.a(MimeRenderer);
+        expect(widgetFactory.createNew(context)).to.be.a(MimeDocument);
       });
 
     });
 
   });
 
-  describe('MimeRenderer', () => {
+  describe('MimeDocument', () => {
 
     describe('#constructor()', () => {
 
       it('should require options', () => {
-        let widget = new MimeRenderer({
+        let widget = new MimeDocument({
           context,
           rendermime: RENDERMIME,
           mimeType: 'text/markdown',
           renderTimeout: 1000,
           dataType: 'string'
         });
-        expect(widget).to.be.a(MimeRenderer);
+        expect(widget).to.be.a(MimeDocument);
       });
 
     });