fix(ElasticApiParser): Add rule to cleanUpSource(), cause dox does not understand methods which defined via square brackets

Author: nodkz

src/ElasticApiParser.js

@@ -143,7 +143,11 @@ export default class ElasticApiParser {
   static cleanUpSource(code: string): string {
     // remove invalid markup
     // {<<api-param-type-boolean,`Boolean`>>} converted to {Boolean}
-    const codeCleaned = code.replace(/{<<.+`(.*)`.+}/gi, '{$1}');
+    let codeCleaned = code.replace(/{<<.+`(.*)`.+}/gi, '{$1}');
+
+    // replace api.indices.prototype['delete'] = ca({
+    // on api.indices.prototype.delete = ca({
+    codeCleaned = codeCleaned.replace(/(api.*)\['(.+)'\](.*ca)/gi, '$1.$2$3');
 
     return codeCleaned;
   }
@@ -203,7 +207,7 @@ export default class ElasticApiParser {
   }
 
   static getMethodName(str: string): string | string[] {
-    const parts = str.replace(/\['(.+)'\]/, '.$1').split('.');
+    const parts = str.split('.');
     if (parts[0] === 'api') {
       parts.shift();
     }

src/__tests__/ElasticApiParser-test.js

@@ -17,44 +17,6 @@ import ElasticApiParser from '../ElasticApiParser';
 
 const apiPartialPath = path.resolve(__dirname, '../__mocks__/apiPartial.js');
 
-const code = `
-api.cat.prototype.allocation = ca({
-  params: {
-    format: { type: 'string' },
-    bytes: { type: 'enum', options: ['b', 'k', 'kb'] },
-    local: { type: 'boolean' },
-    masterTimeout: { type: 'time', name: 'master_timeout' },
-    h: { type: 'list' },
-    help: { type: 'boolean', 'default': false },
-    v: { type: 'boolean', 'default': false }
-  },
-  urls: [
-    {
-      fmt: '/_cat/allocation/<%=nodeId%>',
-      req: { nodeId: { type: 'list' }}
-    }, {
-      fmt: '/_cat/allocation'
-    }, {
-      fmt: '/<%=index%>/<%=type%>/_update_by_query',
-      req: {
-        index: {
-          type: 'list'
-        },
-        type: {
-          type: 'list'
-        }
-      }
-    }, {
-      fmt: '/<%=index%>/_update_by_query',
-      req: {
-        index: {
-          type: 'list'
-        }
-      }
-    }
-  ]
-});`;
-
 describe('ElasticApiParser', () => {
   let parser;
 
@@ -136,6 +98,24 @@ describe('ElasticApiParser', () => {
       });
     });
 
+    describe('cleanUpSource()', () => {
+      it('should {<<api-param-type-boolean,`Boolean`>>} convert to {Boolean}', () => {
+        expect(
+          ElasticApiParser.cleanUpSource(
+            `@param {<<api-param-type-boolean,\`Boolean\`>>} params.analyzeWildcard`
+          )
+        ).toEqual(`@param {Boolean} params.analyzeWildcard`);
+      });
+
+      it("should api['delete'] convert to api.delete", () => {
+        expect(
+          ElasticApiParser.cleanUpSource(
+            `api.indices.prototype['delete'] = ca({`
+          )
+        ).toEqual(`api.indices.prototype.delete = ca({`);
+      });
+    });
+
     describe('parseParamsDescription()', () => {
       it('should return descriptions for fields', () => {
         const source = ElasticApiParser.cleanUpSource(
@@ -164,7 +144,47 @@ describe('ElasticApiParser', () => {
 
     describe('codeToSettings()', () => {
       it('should return settings as object from ca({ settings })', () => {
-        expect(ElasticApiParser.codeToSettings(code)).toMatchObject({
+        expect(
+          ElasticApiParser.codeToSettings(
+            `
+        api.cat.prototype.allocation = ca({
+          params: {
+            format: { type: 'string' },
+            bytes: { type: 'enum', options: ['b', 'k', 'kb'] },
+            local: { type: 'boolean' },
+            masterTimeout: { type: 'time', name: 'master_timeout' },
+            h: { type: 'list' },
+            help: { type: 'boolean', 'default': false },
+            v: { type: 'boolean', 'default': false }
+          },
+          urls: [
+            {
+              fmt: '/_cat/allocation/<%=nodeId%>',
+              req: { nodeId: { type: 'list' }}
+            }, {
+              fmt: '/_cat/allocation'
+            }, {
+              fmt: '/<%=index%>/<%=type%>/_update_by_query',
+              req: {
+                index: {
+                  type: 'list'
+                },
+                type: {
+                  type: 'list'
+                }
+              }
+            }, {
+              fmt: '/<%=index%>/_update_by_query',
+              req: {
+                index: {
+                  type: 'list'
+                }
+              }
+            }
+          ]
+        });`
+          )
+        ).toMatchObject({
           params: {
             bytes: { options: ['b', 'k', 'kb'], type: 'enum' },
             format: { type: 'string' },
@@ -201,20 +221,12 @@ describe('ElasticApiParser', () => {
         expect(ElasticApiParser.getMethodName('api.updateByQuery')).toEqual(
           'updateByQuery'
         );
-
-        expect(ElasticApiParser.getMethodName(`api['delete']`)).toEqual(
-          'delete'
-        );
       });
 
       it('should return array of string', () => {
         expect(
           ElasticApiParser.getMethodName('api.cat.prototype.allocation')
         ).toEqual(['cat', 'allocation']);
-
-        expect(
-          ElasticApiParser.getMethodName(`api.indices.prototype['delete']`)
-        ).toEqual(['indices', 'delete']);
       });
     });
 

src/__tests__/__snapshots__/ElasticApiParser-test.js.snap

@@ -206,6 +206,10 @@ Object {
     "resolve": [Function],
     "type": "Elastic_Cat",
   },
+  "indices": Object {
+    "resolve": [Function],
+    "type": "Elastic_Indices",
+  },
   "search": Object {
     "args": Object {
       "_source": Object {
@@ -590,6 +594,38 @@ Object {
       "allocation",
     ],
   },
+  "indices.delete": Object {
+    "argsDescriptions": Object {
+      "index": "A comma-separated list of indices to delete; use \`_all\` or \`*\` string to delete all indices",
+      "masterTimeout": "Specify timeout for connection to master",
+      "timeout": "Explicit operation timeout",
+    },
+    "argsSettings": Object {
+      "method": "DELETE",
+      "params": Object {
+        "masterTimeout": Object {
+          "name": "master_timeout",
+          "type": "time",
+        },
+        "timeout": Object {
+          "type": "time",
+        },
+      },
+      "url": Object {
+        "fmt": "/<%=index%>",
+        "req": Object {
+          "index": Object {
+            "type": "list",
+          },
+        },
+      },
+    },
+    "description": "Perform a [indices.delete](https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html) request",
+    "elasticMethod": Array [
+      "indices",
+      "delete",
+    ],
+  },
   "search": Object {
     "argsDescriptions": Object {
       "[params.defaultOperator=OR]": "The default operator for query string query (AND or OR)",