Merge branch 'master' into feat/cleaner-json-in-curl

Author: filfreire

.github/workflows/build.yml

@@ -0,0 +1,33 @@
+name: Build
+
+on:
+  push:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [16, 18]
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install
+        run: npm ci
+
+      - name: Test
+        run: npm run test
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Build
+        run: npm run build

src/fixtures/requests/headers.json

@@ -9,6 +9,10 @@
     {
       "name": "x-foo",
       "value": "Bar"
+    },
+    {
+      "name": "x-bar",
+      "value": "Foo"
     }
   ]
 }

src/fixtures/requests/multipart-data.json

@@ -15,6 +15,10 @@
         "value": "Hello World",
         "fileName": "hello.txt",
         "contentType": "text/plain"
+      },
+      {
+        "name": "bar",
+        "value": "Bonjour le monde"
       }
     ]
   }

src/fixtures/requests/multipart-form-data-no-params.json

@@ -0,0 +1,26 @@
+{
+  "log": {
+    "version": "1.2",
+    "creator": {
+      "name": "HTTPSnippet",
+      "version": "1.0.0"
+    },
+    "entries": [
+      {
+        "request": {
+          "method": "POST",
+          "url": "http://mockbin.com/har",
+          "headers": [
+            {
+              "name": "Content-Type",
+              "value": "multipart/form-data"
+            }
+          ],
+          "postData": {
+            "mimeType": "multipart/form-data"
+          }
+        }
+      }
+    ]
+  }
+}

src/helpers/__snapshots__/utils.test.ts.snap

@@ -230,6 +230,12 @@ Array [
         "link": "http://php.net/manual/en/book.curl.php",
         "title": "cURL",
       },
+      Object {
+        "description": "PHP with Guzzle",
+        "key": "guzzle",
+        "link": "http://docs.guzzlephp.org/en/stable/",
+        "title": "Guzzle",
+      },
       Object {
         "description": "PHP with pecl/http v1",
         "key": "http1",

src/helpers/code-builder.test.ts

@@ -18,4 +18,25 @@ describe('codeBuilder', () => {
       expect(result).toBe(`${indent.repeat(2)}${line}`);
     });
   });
+
+  describe('addPostProcessor', () => {
+    it('replaces accordingly with one replacer', () => {
+      const indent = '\t';
+      const { join, addPostProcessor, push } = new CodeBuilder({ indent });
+      push('console.log("hello world")');
+      addPostProcessor(code => code.replace(/console/, 'REPLACED'));
+
+      expect(join()).toBe('REPLACED.log("hello world")');
+    });
+
+    it('replaces accordingly with multiple replacers', () => {
+      const indent = '\t';
+      const { join, addPostProcessor, push } = new CodeBuilder({ indent });
+      push('console.log("hello world")');
+      addPostProcessor(code => code.replace(/world/, 'nurse!!'));
+      addPostProcessor(code => code.toUpperCase());
+
+      expect(join()).toBe('CONSOLE.LOG("HELLO NURSE!!")');
+    });
+  });
 });

src/helpers/code-builder.ts

@@ -1,6 +1,8 @@
 const DEFAULT_INDENTATION_CHARACTER = '';
 const DEFAULT_LINE_JOIN = '\n';
 
+export type PostProcessor = (unreplacedCode: string) => string;
+
 export interface CodeBuilderOptions {
   /**
    * Desired indentation character for aggregated lines of code
@@ -16,6 +18,7 @@ export interface CodeBuilderOptions {
 }
 
 export class CodeBuilder {
+  postProcessors: PostProcessor[] = [];
   code: string[] = [];
   indentationCharacter: string = DEFAULT_INDENTATION_CHARACTER;
   lineJoin = DEFAULT_LINE_JOIN;
@@ -61,7 +64,22 @@ export class CodeBuilder {
   };
 
   /**
-   * Concatenate all current lines using the given lineJoin
+   * Concatenate all current lines using the given lineJoin, then apply any replacers that may have been added
+   */
+  join = () => {
+    const unreplacedCode = this.code.join(this.lineJoin);
+    const replacedOutput = this.postProcessors.reduce(
+      (accumulator, replacer) => replacer(accumulator),
+      unreplacedCode,
+    );
+    return replacedOutput;
+  };
+
+  /**
+   * Often when writing modules you may wish to add a literal tag or bit of metadata that you wish to transform after other processing as a final step.
+   * To do so, you can provide a PostProcessor function and it will be run automatically for you when you call `join()` later on.
    */
-  join = () => this.code.join(this.lineJoin);
+  addPostProcessor = (postProcessor: PostProcessor) => {
+    this.postProcessors = [...this.postProcessors, postProcessor];
+  };
 }

src/targets/c/libcurl/fixtures/headers.c

@@ -6,6 +6,7 @@ curl_easy_setopt(hnd, CURLOPT_URL, "http://mockbin.com/har");
 struct curl_slist *headers = NULL;
 headers = curl_slist_append(headers, "accept: application/json");
 headers = curl_slist_append(headers, "x-foo: Bar");
+headers = curl_slist_append(headers, "x-bar: Foo");
 curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
 
 CURLcode ret = curl_easy_perform(hnd);

src/targets/c/libcurl/fixtures/multipart-data.c

@@ -7,6 +7,6 @@ struct curl_slist *headers = NULL;
 headers = curl_slist_append(headers, "content-type: multipart/form-data; boundary=---011000010111000001101001");
 curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
 
-curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"; filename=\"hello.txt\"\r\nContent-Type: text/plain\r\n\r\nHello World\r\n-----011000010111000001101001--\r\n");
+curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"; filename=\"hello.txt\"\r\nContent-Type: text/plain\r\n\r\nHello World\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bar\"\r\n\r\nBonjour le monde\r\n-----011000010111000001101001--\r\n");
 
 CURLcode ret = curl_easy_perform(hnd);

src/targets/c/libcurl/fixtures/multipart-form-data-no-params.c

@@ -0,0 +1,10 @@
+CURL *hnd = curl_easy_init();
+
+curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
+curl_easy_setopt(hnd, CURLOPT_URL, "http://mockbin.com/har");
+
+struct curl_slist *headers = NULL;
+headers = curl_slist_append(headers, "Content-Type: multipart/form-data");
+curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
+
+CURLcode ret = curl_easy_perform(hnd);