feat: VSCODE-323 expose export to Ruby (#391)

* feat: VSCODE-323 expose export to Ruby

Also made export to language more prominent in README

* test: fixed existing tests and added new one for ruby

* chore: increase allowed bundle size

Co-authored-by: Massimiliano Marcon <[email protected]>

Author: mmarcon

README.md

@@ -24,12 +24,24 @@ MongoDB Playgrounds are the most convenient way to prototype and execute CRUD op
 - Edit documents returned by your playground.
 - Save your playgrounds in your workspace and use them to document how your application interacts with MongoDB.
 - Build aggregations quickly with helpful and well-commented stage snippets.
-- Export your queries and aggregations to one of the supported languages: Java, Node, C#, and Python 3
 
 ![Playgrounds](resources/screenshots/playground.png)
 
 _Make sure you are connected to a server or cluster before using a playground. You can't run a playground and you won't get completions if you are not connected._
 
+#### From Query API to your favorite language
+
+Select queries and aggregations within your Playground files and translate them into your favorite programming language. Supported languages are:
+
+ * Java
+ * Node.js
+ * C#
+ * Python 3
+ * Ruby
+
+![Query Translator](resources/screenshots/query-translator.png)
+
+
 ### Document Editing
 
 MongoDB for VS Code makes it extremely easy to make changes to documents in your collections. You can open documents in an editor tab, edit them and save the changes back to MongoDB.

package.json

@@ -266,6 +266,10 @@
         "command": "mdb.exportToNode",
         "title": "MongoDB: Export To Node.js"
       },
+      {
+        "command": "mdb.exportToRuby",
+        "title": "MongoDB: Export To Ruby"
+      },
       {
         "command": "mdb.addConnection",
         "title": "Add MongoDB Connection",

resources/screenshots/query-translator.png

@@ -6,7 +6,7 @@ const version = JSON.parse(fs.readFileSync(path.resolve(__dirname, '..', 'packag
 const vsixFileName = path.resolve(__dirname, '..', `./mongodb-vscode-${version}.vsix`);
 const size = fs.statSync(vsixFileName).size;
 
-const maxSize = 6 * 1000000; // 6 MB
+const maxSize = 6.2 * 1000000; // ~6.2 MB
 
 if (size >= maxSize) {
   throw new Error(`vsix bundle too big expected max ${maxSize} bytes, got ${size}.`);

scripts/check-vsix-size.ts

@@ -18,6 +18,7 @@ enum EXTENSION_COMMANDS {
   MDB_EXPORT_TO_JAVA = 'mdb.exportToJava',
   MDB_EXPORT_TO_CSHARP = 'mdb.exportToCsharp',
   MDB_EXPORT_TO_NODE = 'mdb.exportToNode',
+  MDB_EXPORT_TO_RUBY = 'mdb.exportToRuby',
   MDB_CHANGE_EXPORT_TO_LANGUAGE_ADDONS = 'mdb.changeExportToLanguageAddons',
 
   MDB_OPEN_MONGODB_DOCUMENT_FROM_CODE_LENS = 'mdb.openMongoDBDocumentFromCodeLens',

src/commands/index.ts

@@ -71,6 +71,14 @@ export default class CodeActionProvider implements vscode.CodeActionProvider {
         tooltip: 'Export To Node.js'
       };
       codeActions.push(exportToJSCommand);
+
+      const exportToRubyCommand = new vscode.CodeAction('Export To Ruby', vscode.CodeActionKind.Empty);
+      exportToRubyCommand.command = {
+        command: EXTENSION_COMMANDS.MDB_EXPORT_TO_RUBY,
+        title: 'Export To Ruby',
+        tooltip: 'Export To Ruby'
+      };
+      codeActions.push(exportToRubyCommand);
     }
 
     return codeActions;

src/editors/codeActionProvider.ts

@@ -211,6 +211,9 @@ export default class MDBExtensionController implements vscode.Disposable {
     this.registerCommand(EXTENSION_COMMANDS.MDB_EXPORT_TO_NODE, () =>
       this._playgroundController.exportToLanguage(ExportToLanguages.JAVASCRIPT)
     );
+    this.registerCommand(EXTENSION_COMMANDS.MDB_EXPORT_TO_RUBY, () =>
+      this._playgroundController.exportToLanguage(ExportToLanguages.RUBY)
+    );
     this.registerCommand(EXTENSION_COMMANDS.MDB_CHANGE_EXPORT_TO_LANGUAGE_ADDONS, (exportToLanguageAddons) =>
       this._playgroundController.changeExportToLanguageAddons(exportToLanguageAddons)
     );

src/mdbExtensionController.ts

@@ -146,7 +146,7 @@ suite('Code Action Provider Test Suite', function () {
     expect(codeActions).to.exist;
 
     if (codeActions) {
-      expect(codeActions.length).to.be.equal(5);
+      expect(codeActions.length).to.be.equal(6);
       const actionCommand = codeActions[2].command;
 
       if (actionCommand) {
@@ -178,7 +178,7 @@ suite('Code Action Provider Test Suite', function () {
     expect(codeActions).to.exist;
 
     if (codeActions) {
-      expect(codeActions.length).to.be.equal(5);
+      expect(codeActions.length).to.be.equal(6);
       const actionCommand = codeActions[2].command;
 
       if (actionCommand) {
@@ -227,7 +227,7 @@ suite('Code Action Provider Test Suite', function () {
     expect(codeActions).to.exist;
 
     if (codeActions) {
-      expect(codeActions.length).to.be.equal(5);
+      expect(codeActions.length).to.be.equal(6);
       const actionCommand = codeActions[3].command;
 
       if (actionCommand) {
@@ -280,7 +280,7 @@ suite('Code Action Provider Test Suite', function () {
     expect(codeActions).to.exist;
 
     if (codeActions) {
-      expect(codeActions.length).to.be.equal(5);
+      expect(codeActions.length).to.be.equal(6);
       const actionCommand = codeActions[1].command;
 
       if (actionCommand) {
@@ -312,6 +312,64 @@ suite('Code Action Provider Test Suite', function () {
           language: 'python'
         };
 
+        expect(mdbTestExtension.testExtensionController._playgroundController._playgroundResult).to.be.deep.equal(expectedResult);
+      }
+    }
+  });
+  test('exports to ruby and includes driver syntax', async () => {
+    const textFromEditor = "use('db'); db.coll.find({ name: '22' })";
+    const selection = {
+      start: { line: 0, character: 24 },
+      end: { line: 0, character: 38 }
+    } as vscode.Selection;
+    const mode = ExportToLanguageMode.QUERY;
+    const activeTextEditor = { document: { getText: () => textFromEditor } } as vscode.TextEditor;
+
+    mdbTestExtension.testExtensionController._playgroundController._selectedText = "{ name: '22' }";
+    mdbTestExtension.testExtensionController._playgroundController._codeActionProvider.selection = selection;
+    mdbTestExtension.testExtensionController._playgroundController._codeActionProvider.mode = mode;
+    mdbTestExtension.testExtensionController._playgroundController._activeTextEditor = activeTextEditor;
+
+    const testCodeActionProvider = new CodeActionProvider();
+    testCodeActionProvider.refresh({ selection, mode });
+
+    const codeActions = testCodeActionProvider.provideCodeActions();
+
+    expect(codeActions).to.exist;
+
+    if (codeActions) {
+      expect(codeActions.length).to.be.equal(6);
+      const actionCommand = codeActions[5].command;
+
+      if (actionCommand) {
+        expect(actionCommand.command).to.be.equal('mdb.exportToRuby');
+        expect(actionCommand.title).to.be.equal('Export To Ruby');
+
+        await vscode.commands.executeCommand(actionCommand.command);
+
+        let expectedResult: PlaygroundResult = {
+          namespace: 'DATABASE_NAME.COLLECTION_NAME',
+          type: null,
+          content: "{\n  'name' => '22'\n}",
+          language: 'ruby'
+        };
+        expect(mdbTestExtension.testExtensionController._playgroundController._playgroundResult).to.be.deep.equal(expectedResult);
+
+        const codeLenses = mdbTestExtension.testExtensionController._playgroundController._exportToLanguageCodeLensProvider.provideCodeLenses();
+        expect(codeLenses.length).to.be.equal(2);
+
+        await vscode.commands.executeCommand('mdb.changeExportToLanguageAddons', {
+          ...mdbTestExtension.testExtensionController._playgroundController._exportToLanguageCodeLensProvider._exportToLanguageAddons,
+          driverSyntax: true
+        });
+
+        expectedResult = {
+          namespace: 'db.coll',
+          type: null,
+          content: "# Requires the MongoDB Ruby Driver\n# https://docs.mongodb.com/ruby-driver/master/\n\nclient = Mongo::Client.new('mongodb://localhost:27018/?appname=mongodb-vscode+0.0.0-dev.0', :database => 'db')\n\nresult = client.database['coll'].find({\n  'name' => '22'\n})",
+          language: 'ruby'
+        };
+
         expect(mdbTestExtension.testExtensionController._playgroundController._playgroundResult).to.be.deep.equal(expectedResult);
       }
     }

src/test/suite/editors/codeActionProvider.test.ts

@@ -41,7 +41,8 @@ export enum ExportToLanguages {
   PYTHON = 'python',
   JAVA = 'java',
   CSHARP = 'csharp',
-  JAVASCRIPT = 'javascript'
+  JAVASCRIPT = 'javascript',
+  RUBY = 'ruby'
 }
 
 export enum ExportToLanguageMode {