Merge pull request #3981 from saulshanabrook/persist-collapsed

Persist code cell collapsed

packages/cells/src/widget.ts

@@ -211,6 +211,17 @@ class Cell extends Widget {
         this.editor.setOption(key, options.editorConfig[key]);
       });
     }
+
+  }
+
+  /**
+   * Modify some state for initialization.
+   *
+   * Should be called at the end of the subclasses's constructor.
+   */
+  protected initializeState() {
+    const jupyter = this.model.metadata.get('jupyter') || {} as any;
+    this.inputHidden = jupyter.source_hidden === true;
   }
 
   /**
@@ -572,7 +583,7 @@ class CodeCell extends Cell {
     });
 
     // Modify state
-    this.setPrompt(`${model.executionCount || ''}`);
+    this.initializeState();
     model.stateChanged.connect(this.onStateChanged, this);
     model.metadata.changed.connect(this.onMetadataChanged, this);
   }
@@ -582,6 +593,25 @@ class CodeCell extends Cell {
    */
   readonly model: ICodeCellModel;
 
+  /**
+   * Modify some state for initialization.
+   *
+   * Should be called at the end of the subclasses's constructor.
+   */
+  protected initializeState() {
+    super.initializeState();
+
+    const metadataScrolled = this.model.metadata.get('scrolled');
+    this.outputsScrolled = metadataScrolled === true;
+
+    const jupyter = this.model.metadata.get('jupyter') || {} as any;
+    const collapsed = this.model.metadata.get('collapsed');
+    this.outputHidden = collapsed === true || jupyter.outputs_hidden === true;
+
+    this.setPrompt(`${this.model.executionCount || ''}`);
+  }
+
+
   /**
    * Get the output area for the cell.
    */
@@ -735,7 +765,7 @@ class CodeCell extends Cell {
 
   private _rendermime: RenderMimeRegistry = null;
   private _outputHidden = false;
-  private _outputsScrolled = false;
+  private _outputsScrolled: boolean;
   private _outputWrapper: Widget = null;
   private _outputCollapser: OutputCollapser = null;
   private _outputPlaceholder: OutputPlaceholder = null;
@@ -832,6 +862,8 @@ class MarkdownCell extends Cell {
     this._updateRenderedInput().then(() => {
       this._ready.resolve(void 0);
     });
+
+    super.initializeState();
   }
 
   /**
@@ -977,6 +1009,7 @@ class RawCell extends Cell {
   constructor(options: Cell.IOptions) {
     super(options);
     this.addClass(RAW_CELL_CLASS);
+    super.initializeState();
   }
 
   /**

packages/mainmenu-extension/src/index.ts

@@ -52,6 +52,9 @@ namespace CommandIDs {
   export
   const closeAndCleanup = 'filemenu:close-and-cleanup';
 
+  export
+  const persistAndSave = 'filemenu:persist-and-save';
+
   export
   const createConsole = 'filemenu:create-console';
 
@@ -240,6 +243,21 @@ function createFileMenu(app: JupyterLab, menu: FileMenu): void {
       Private.delegateExecute(app, menu.closeAndCleaners, 'closeAndCleanup')
   });
 
+  // Add a delegator command for persisting data then saving.
+  commands.addCommand(CommandIDs.persistAndSave, {
+    label: () => {
+      const action =
+        Private.delegateLabel(app, menu.persistAndSavers, 'action');
+      const name =
+        Private.delegateLabel(app, menu.persistAndSavers, 'name');
+      return `Save ${name} ${action || 'with Extras'}`;
+    },
+    isEnabled:
+      Private.delegateEnabled(app, menu.persistAndSavers, 'persistAndSave'),
+    execute:
+      Private.delegateExecute(app, menu.persistAndSavers, 'persistAndSave')
+  });
+
   // Add a delegator command for creating a console for an activity.
   commands.addCommand(CommandIDs.createConsole, {
     label: () => {
@@ -272,6 +290,7 @@ function createFileMenu(app: JupyterLab, menu: FileMenu): void {
   // Add save group.
   const saveGroup = [
     'docmanager:save',
+    'filemenu:persist-and-save',
     'docmanager:save-as',
     'docmanager:save-all'
   ].map(command => { return { command }; });

packages/mainmenu/src/file.ts

@@ -24,6 +24,12 @@ interface IFileMenu extends IJupyterLabMenu {
    */
   readonly closeAndCleaners: Set<IFileMenu.ICloseAndCleaner<Widget>>;
 
+  /**
+   * The persist and save extension point.
+   */
+  readonly persistAndSavers: Set<IFileMenu.IPersistAndSave<Widget>>;
+
+
   /**
    * A set storing IConsoleCreators for the File menu.
    */
@@ -45,6 +51,8 @@ class FileMenu extends JupyterLabMenu implements IFileMenu {
     this.newMenu.menu.title.label = 'New';
     this.closeAndCleaners =
       new Set<IFileMenu.ICloseAndCleaner<Widget>>();
+    this.persistAndSavers =
+      new Set<IFileMenu.IPersistAndSave<Widget>>();
     this.consoleCreators =
       new Set<IFileMenu.IConsoleCreator<Widget>>();
   }
@@ -59,6 +67,12 @@ class FileMenu extends JupyterLabMenu implements IFileMenu {
    */
   readonly closeAndCleaners: Set<IFileMenu.ICloseAndCleaner<Widget>>;
 
+
+  /**
+   * The persist and save extension point.
+   */
+  readonly persistAndSavers: Set<IFileMenu.IPersistAndSave<Widget>>;
+
   /**
    * A set storing IConsoleCreators for the Kernel menu.
    */
@@ -102,6 +116,28 @@ namespace IFileMenu {
     closeAndCleanup: (widget: T) => Promise<void>;
   }
 
+  /**
+   * Interface for an activity that has some persistance action
+   * before saving.
+   */
+  export
+  interface IPersistAndSave<T extends Widget> extends IMenuExtender<T> {
+    /**
+     * A label to use for the activity that is being saved.
+     */
+    name: string;
+
+    /**
+     * A label to describe what is being persisted before saving.
+     */
+    action: string;
+
+    /**
+     * A function to perform the persistance.
+     */
+    persistAndSave: (widget: T) => Promise<void>;
+  }
+
   /**
    * Interface for a command to create a console for an activity.
    */

packages/notebook-extension/src/index.ts

@@ -249,6 +249,9 @@ namespace CommandIDs {
 
   export
   const disableOutputScrolling = 'notebook:disable-output-scrolling';
+
+  export
+  const saveWithView = 'notebook:save-with-view';
 }
 
 
@@ -1493,6 +1496,18 @@ function addCommands(app: JupyterLab, services: ServiceManager, tracker: Noteboo
     },
     isEnabled
   });
+  commands.addCommand(CommandIDs.saveWithView, {
+    label: 'Save Notebook with View State',
+    execute: args => {
+      const current = getCurrent(args);
+
+      if (current) {
+        NotebookActions.persistViewState(current.content);
+        app.commands.execute('docmanager:save');
+      }
+    },
+    isEnabled
+  });
 }
 
 
@@ -1519,7 +1534,8 @@ function populatePalette(palette: ICommandPalette): void {
     CommandIDs.reconnectToKernel,
     CommandIDs.createConsole,
     CommandIDs.closeAndShutdown,
-    CommandIDs.trust
+    CommandIDs.trust,
+    CommandIDs.saveWithView
   ].forEach(command => { palette.addItem({ command, category }); });
 
   EXPORT_TO_FORMATS.forEach(exportToFormat => {
@@ -1623,6 +1639,17 @@ function populateMenus(app: JupyterLab, mainMenu: IMainMenu, tracker: INotebookT
     }
   } as IFileMenu.ICloseAndCleaner<NotebookPanel>);
 
+  // Add a save with view command to the file menu.
+  mainMenu.fileMenu.persistAndSavers.add({
+    tracker,
+    action: 'with View State',
+    name: 'Notebook',
+    persistAndSave: (current: NotebookPanel) => {
+      NotebookActions.persistViewState(current.content);
+      return app.commands.execute('docmanager:save');
+    }
+  } as IFileMenu.IPersistAndSave<NotebookPanel>);
+
   // Add a notebook group to the File menu.
   let exportTo = new Menu({ commands } );
   exportTo.title.label = 'Export Notebook As…';

packages/notebook/src/actions.tsx

@@ -1083,6 +1083,58 @@ namespace NotebookActions {
     Private.handleState(widget, state);
   }
 
+  /**
+   * Persists the collapsed state of all code cell outputs to the model.
+   *
+   * @param widget - The target notebook widget.
+   */
+  export
+  function persistViewState(widget: Notebook): void {
+    if (!widget.model) {
+      return;
+    }
+    let state = Private.getState(widget);
+    let cells = widget.widgets;
+    each(cells, (cell: Cell) => {
+      const {model, inputHidden} = cell;
+      const metadata = model.metadata;
+      const jupyter = metadata.get('jupyter') as any || {};
+
+      if (inputHidden) {
+        jupyter.source_hidden = true;
+      } else {
+        delete jupyter.source_hidden;
+      }
+
+      if (cell.model.type === 'code') {
+        const {outputHidden, outputsScrolled} = (cell as CodeCell);
+
+        // set both metadata keys
+        // https://github.com/jupyterlab/jupyterlab/pull/3981#issuecomment-391139167
+        if (outputHidden) {
+          model.metadata.set('collapsed', true);
+          jupyter.outputs_hidden = true;
+        } else {
+          model.metadata.delete('collapsed');
+          delete jupyter.outputs_hidden;
+        }
+
+        if (outputsScrolled) {
+          model.metadata.set('scrolled', true);
+        } else {
+          model.metadata.delete('scrolled');
+        }
+      }
+
+      if (Object.keys(jupyter).length === 0) {
+        metadata.delete('jupyter');
+      } else {
+        metadata.set('jupyter', jupyter);
+      }
+    });
+    Private.handleState(widget, state);
+  }
+
 
   /**
    * Set the markdown header level.

packages/notebook/src/celltools.ts

@@ -355,7 +355,7 @@ namespace CellTools {
         this._cellModel = null;
         return;
       }
-      let promptNode = activeCell.promptNode.cloneNode(true) as HTMLElement;
+      let promptNode = activeCell.promptNode ? activeCell.promptNode.cloneNode(true) as HTMLElement : null;
       let prompt = new Widget({ node: promptNode });
       let factory = activeCell.contentFactory.editorFactory;
 

packages/shortcuts-extension/schema/plugin.json

@@ -157,6 +157,15 @@
       },
       "type": "object"
     },
+    "filemenu:persist-and-save": {
+      "default": { },
+      "properties": {
+        "command": { "default": "filemenu:persist-and-save" },
+        "keys": { "default": ["Ctrl Shift S"] },
+        "selector": { "default": "body" }
+      },
+      "type": "object"
+    },
     "help:toggle": {
       "default": { },
       "properties": {

tests/test-cells/src/widget.spec.ts

@@ -386,6 +386,22 @@ describe('cells/widget', () => {
 
     describe('#outputCollapsed', () => {
 
+      it('should initialize from the model', () => {
+        const collapsedModel = new CodeCellModel({});
+        let widget = new CodeCell({ model: collapsedModel, rendermime });
+        expect(widget.outputHidden).to.be(false);
+
+        collapsedModel.metadata.set('collapsed', true);
+        collapsedModel.metadata.set('jupyter', {outputs_hidden: false});
+        widget = new CodeCell({ model: collapsedModel, rendermime });
+        expect(widget.outputHidden).to.be(true);
+
+        collapsedModel.metadata.set('collapsed', false);
+        collapsedModel.metadata.set('jupyter', {outputs_hidden: true});
+        widget = new CodeCell({ model: collapsedModel, rendermime });
+        expect(widget.outputHidden).to.be(true);
+      });
+
       it('should be the view state of the output being collapsed', () => {
         let widget = new CodeCell({ model, rendermime });
         expect(widget.outputHidden).to.be(false);
@@ -395,6 +411,28 @@ describe('cells/widget', () => {
 
     });
 
+    describe('#outputsScrolled', () => {
+
+      it('should initialize from the model', () => {
+        const collapsedModel = new CodeCellModel({});
+        let widget = new CodeCell({ model: collapsedModel, rendermime });
+        expect(widget.outputsScrolled).to.be(false);
+
+        collapsedModel.metadata.set('scrolled', false);
+        widget = new CodeCell({ model: collapsedModel, rendermime });
+        expect(widget.outputsScrolled).to.be(false);
+
+        collapsedModel.metadata.set('scrolled', 'auto');
+        widget = new CodeCell({ model: collapsedModel, rendermime });
+        expect(widget.outputsScrolled).to.be(false);
+
+        collapsedModel.metadata.set('scrolled', true);
+        widget = new CodeCell({ model: collapsedModel, rendermime });
+        expect(widget.outputsScrolled).to.be(true);
+      });
+
+    });
+
     describe('#dispose()', () => {
 
       it('should dispose of the resources held by the widget', () => {