split functionallity into multiple classes

Author: techwithtim

src/client/datascience/export/exportBase.ts

@@ -1,21 +1,15 @@
 import { inject, injectable, named } from 'inversify';
-import { Memento, SaveDialogOptions, Uri } from 'vscode';
-import { IApplicationShell } from '../../common/application/types';
+import { Uri } from 'vscode';
 import { IFileSystem, TemporaryFile } from '../../common/platform/types';
-import { IMemento, WORKSPACE_MEMENTO } from '../../common/types';
-import { ExportNotebookSettings } from '../interactive-common/interactiveWindowTypes';
 import { IDataScienceErrorHandler, INotebookEditor } from '../types';
+import { IExportManagerFilePicker } from './exportManagerFilePicker';
 
 export enum ExportFormat {
     pdf = 'pdf',
     html = 'html',
     python = 'python'
 }
 
-export const PDFExtensions = { PDF: ['.pdf'] };
-export const HTMLExtensions = { HTML: ['.html', 'htm'] };
-export const PythonExtensions = { Python: ['.py'] };
-
 export const IExportManager = Symbol('IExportManager');
 export interface IExportManager {
     export(format: ExportFormat, activeEditor: INotebookEditor): Promise<Uri | undefined>;
@@ -28,27 +22,21 @@ export interface IExport {
 
 @injectable()
 export class ExportManager implements IExportManager {
-    private readonly defaultExportSaveLocation = ''; // set default save location
-
     constructor(
         @inject(IExport) @named(ExportFormat.pdf) private readonly exportToPDF: IExport,
         @inject(IExport) @named(ExportFormat.html) private readonly exportToHTML: IExport,
         @inject(IExport) @named(ExportFormat.python) private readonly exportToPython: IExport,
-        @inject(IApplicationShell) private readonly applicationShell: IApplicationShell,
-        @inject(IMemento) @named(WORKSPACE_MEMENTO) private workspaceStorage: Memento,
         @inject(IFileSystem) private readonly fileSystem: IFileSystem,
-        @inject(IDataScienceErrorHandler) private readonly errorHandler: IDataScienceErrorHandler
+        @inject(IDataScienceErrorHandler) private readonly errorHandler: IDataScienceErrorHandler,
+        @inject(IExportManagerFilePicker) private readonly filePicker: IExportManagerFilePicker
     ) {}
 
     public async export(format: ExportFormat, activeEditor: INotebookEditor): Promise<Uri | undefined> {
         // need to add telementry and status messages
 
-        let target;
-        if (format !== ExportFormat.python) {
-            target = await this.getExportFileLocation(format);
-            if (!target) {
-                return; // user didn't select path
-            }
+        const target = await this.filePicker.getExportFileLocation(format);
+        if (!target) {
+            return;
         }
 
         const tempFile = await this.makeTemporaryFile(activeEditor);
@@ -91,55 +79,8 @@ export class ExportManager implements IExportManager {
 
         return tempFile;
     }
-
-    private getLastFileSaveLocation(): Uri {
-        const filePath = this.workspaceStorage.get(
-            ExportNotebookSettings.lastSaveLocation,
-            this.defaultExportSaveLocation
-        );
-
-        return Uri.file(filePath);
-    }
-
-    private updateFileSaveLocation(value: Uri) {
-        const filePath = value.toString();
-        this.workspaceStorage.update(ExportNotebookSettings.lastSaveLocation, filePath);
-    }
-
-    private async getExportFileLocation(format: ExportFormat): Promise<Uri | undefined> {
-        let fileExtensions;
-        switch (format) {
-            case ExportFormat.python:
-                fileExtensions = PythonExtensions;
-                break;
-
-            case ExportFormat.pdf:
-                fileExtensions = PDFExtensions;
-                break;
-
-            case ExportFormat.html:
-                fileExtensions = HTMLExtensions;
-                break;
-
-            default:
-                return;
-        }
-
-        const options: SaveDialogOptions = {
-            defaultUri: this.getLastFileSaveLocation(),
-            saveLabel: '',
-            filters: fileExtensions
-        };
-
-        const uri = await this.applicationShell.showSaveDialog(options);
-        if (uri) {
-            this.updateFileSaveLocation(uri);
-        }
-        return uri;
-    }
 }
 
 // continue with decorater pattern - READ
 // ts mockito - READ
-// do depenedncy checking using code seen before
 // test that stuff

src/client/datascience/export/exportManager.ts

@@ -0,0 +1,71 @@
+import { inject, injectable, named } from 'inversify';
+import { Memento, SaveDialogOptions, Uri } from 'vscode';
+import { IApplicationShell } from '../../common/application/types';
+import { IMemento, WORKSPACE_MEMENTO } from '../../common/types';
+import { ExportNotebookSettings } from '../interactive-common/interactiveWindowTypes';
+import { ExportFormat } from './exportManager';
+
+export const PDFExtensions = { PDF: ['.pdf'] };
+export const HTMLExtensions = { HTML: ['.html', 'htm'] };
+export const PythonExtensions = { Python: ['.py'] };
+
+export const IExportManagerFilePicker = Symbol('IExportManagerFilePicker');
+export interface IExportManagerFilePicker {
+    getExportFileLocation(format: ExportFormat): Promise<Uri | undefined>;
+}
+
+@injectable()
+export class ExportManagerFilePicker implements IExportManagerFilePicker {
+    private readonly defaultExportSaveLocation = ''; // set default save location
+
+    constructor(
+        @inject(IApplicationShell) private readonly applicationShell: IApplicationShell,
+        @inject(IMemento) @named(WORKSPACE_MEMENTO) private workspaceStorage: Memento
+    ) {}
+
+    public async getExportFileLocation(format: ExportFormat): Promise<Uri | undefined> {
+        let fileExtensions;
+        switch (format) {
+            case ExportFormat.python:
+                fileExtensions = PythonExtensions;
+                break;
+
+            case ExportFormat.pdf:
+                fileExtensions = PDFExtensions;
+                break;
+
+            case ExportFormat.html:
+                fileExtensions = HTMLExtensions;
+                break;
+
+            default:
+                return;
+        }
+
+        const options: SaveDialogOptions = {
+            defaultUri: this.getLastFileSaveLocation(),
+            saveLabel: '',
+            filters: fileExtensions
+        };
+
+        const uri = await this.applicationShell.showSaveDialog(options);
+        if (uri) {
+            this.updateFileSaveLocation(uri);
+        }
+        return uri;
+    }
+
+    private getLastFileSaveLocation(): Uri {
+        const filePath = this.workspaceStorage.get(
+            ExportNotebookSettings.lastSaveLocation,
+            this.defaultExportSaveLocation
+        );
+
+        return Uri.file(filePath);
+    }
+
+    private updateFileSaveLocation(value: Uri) {
+        const filePath = value.toString();
+        this.workspaceStorage.update(ExportNotebookSettings.lastSaveLocation, filePath);
+    }
+}

src/client/datascience/export/exportManagerFilePicker.ts

@@ -1,9 +1,9 @@
 import { injectable } from 'inversify';
 import { Uri } from 'vscode';
-import { ExportBase } from './exportBase';
+import { IExport } from './exportManager';
 
 @injectable()
-export class ExportToHTML extends ExportBase {
+export class ExportToHTML implements IExport {
     // tslint:disable-next-line: no-empty
     public async export(_source: Uri, _target: Uri): Promise<void> {}
 }

src/client/datascience/export/exportToHTML.ts

@@ -1,9 +1,9 @@
 import { injectable } from 'inversify';
 import { Uri } from 'vscode';
-import { ExportBase } from './exportBase';
+import { IExport } from './exportManager';
 
 @injectable()
-export class ExportToPDF extends ExportBase {
+export class ExportToPDF implements IExport {
     // tslint:disable-next-line: no-empty
     public async export(_source: Uri, _target: Uri): Promise<void> {}
 }

src/client/datascience/export/exportToPDF.ts

@@ -3,18 +3,16 @@ import { Uri, ViewColumn } from 'vscode';
 import { IDocumentManager } from '../../common/application/types';
 import { IFileSystem } from '../../common/platform/types';
 import { INotebookEditorProvider, INotebookImporter } from '../types';
-import { ExportBase } from './exportBase';
+import { IExport } from './exportManager';
 
 @injectable()
-export class ExportToPython extends ExportBase {
+export class ExportToPython implements IExport {
     constructor(
         @inject(INotebookEditorProvider) protected readonly notebookEditorProvider: INotebookEditorProvider,
         @inject(IFileSystem) protected readonly fileSystem: IFileSystem,
         @inject(IDocumentManager) protected readonly documentManager: IDocumentManager,
         @inject(INotebookImporter) protected readonly importer: INotebookImporter
-    ) {
-        super();
-    }
+    ) {}
 
     public async export(source: Uri): Promise<void> {
         const contents = await this.importer.importFromFile(

src/client/datascience/export/exportToPython.ts

@@ -37,6 +37,7 @@ import { DataScienceErrorHandler } from './errorHandler/errorHandler';
 import { ExportCommands } from './export/exportCommands';
 import { ExportFormat, ExportManager, IExport, IExportManager } from './export/exportManager';
 import { ExportManagerDependencyChecker } from './export/exportManagerDependencyChecker';
+import { ExportManagerFilePicker, IExportManagerFilePicker } from './export/exportManagerFilePicker';
 import { ExportToHTML } from './export/exportToHTML';
 import { ExportToPDF } from './export/exportToPDF';
 import { ExportToPython } from './export/exportToPython';
@@ -276,6 +277,7 @@ export function registerTypes(serviceManager: IServiceManager) {
     serviceManager.addSingleton<IExport>(IExport, ExportToHTML, ExportFormat.html);
     serviceManager.addSingleton<IExport>(IExport, ExportToPython, ExportFormat.python);
     serviceManager.addSingleton<ExportCommands>(ExportCommands, ExportCommands);
+    serviceManager.addSingleton<IExportManagerFilePicker>(ExportManagerFilePicker, ExportManagerFilePicker);
 
     registerGatherTypes(serviceManager);
     registerNotebookTypes(serviceManager);