Add multi-line test cases

Author: TotalTechGeek

index.js

@@ -8,11 +8,11 @@ import { program } from 'commander'
 import { hash } from './hash.js';
 import url from 'url'
 import { transpile } from './typescriptTranspiler.js';
-
+import { parse } from './parser/dsl.js';
 
 program
     .name('pineapple')
-    .version('0.6.2')
+    .version('0.6.3')
     .option('-i, --include <files...>', 'Comma separated globs of files.')
     .option('-a, --accept-all', 'Accept all snapshots.')
     .option('-u, --update-all', 'Update all snapshots.')
@@ -164,6 +164,28 @@ const tagTypes = [
     'afterEach'
 ]
 
+function multiLine(fileText, start, type) {
+    let end = start + 1;
+                        
+    console.log(fileText[start], type)
+    let text = (fileText[start].split(`@${type} `)[1] || '').trim() 
+    let lastSuccess = text
+
+    // while there isn't a * @ on the line
+    while (fileText[end] && !fileText[end].includes('* @')) {
+        if(fileText[end].includes('*/')) break; 
+        const addition = fileText[end].substring(fileText[end].indexOf('*') + 1).trim()
+        text += ' ' + addition
+        try {
+            parse(text) // attempt a parse
+            lastSuccess = text
+        } catch(err) {}
+        end++;
+    }
+
+    return lastSuccess.trim()
+}
+
 function getFunctions(file, fileText, fileName) {
 
 
@@ -182,13 +204,10 @@ function getFunctions(file, fileText, fileName) {
             while (current > 0 && !fileText[current].includes('/*')) {
                 current--;
                 for (const type of tagTypes) {
-                    if (fileText[current].includes(`@${type} `))
-                        tags.push(
-                            { 
-                                type, 
-                                text: fileText[current].split(`@${type} `)[1].trim() 
-                            }
-                        );
+                    if (fileText[current].includes(`@${type} `)) tags.push({ 
+                        type, 
+                        text: multiLine(fileText, current, type)
+                    });
                 }
             }
         }
@@ -253,7 +272,7 @@ function getFunctions(file, fileText, fileName) {
         const tags = item[1].filter(i => tagTypes.includes(i.getTagName()))
             .map(tag => {
                 const tagName = tag.getTagName()
-                return { type: tagName, text: fileText[tag.getStartLineNumber() - 1].split(`@${tagName}`)[1].trim() }
+                return { type: tagName, text: multiLine(fileText, tag.getStartLineNumber() - 1, tagName) }
             });
 
         return {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pineapple",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "description": "A testing framework for humans.",
   "main": "index.js",
   "scripts": {

test/class.js

@@ -81,4 +81,39 @@ export class Adder {
     static getPrevious() {
         return this.previousResult
     }
-}
+}
+
+
+/**
+ * @pineapple_import 
+ */
+export function setPersonCount (to = 0) {
+    Person.count = to
+}
+
+/**
+ * @test 'Jesse', 24 
+ * ~> $.grow(3)
+ * ~> $.grow(2) returns 29
+ * 
+ * @test 'Rick', 62 
+ * ~> $.grow(1) returns 63
+ * ~> $.grow(2) returns 65
+ * ~> $.getName() returns 'Rick'
+ * ~> $.grow() returns $.age === 66
+ */
+export class Person {
+    constructor(name, age) {
+        this.name = name
+        this.age = age
+    }
+
+    grow(amount = 1) {
+        return this.age += amount
+    }
+
+    getName() {
+        return this.name
+    }
+}
+

test/rental.js

@@ -8,3 +8,23 @@
     if (typeof buyer !== 'string' || typeof length !== 'number') throw new Error('Types do not match.')
     return { type, buyer, length }
 }
+
+
+/**
+ * @test { 
+ *      tenant: 'Rick',
+ *      length: 10,
+ *      type: 'boat' 
+ * } resolves
+ * 
+ * @test {
+ *      tenant: 10,
+ *      length: 'Rick',
+ *      type: 'boat'
+ * } rejects
+ */
+export async function createLease({ tenant, length, type = 'boat' }) {
+    if (typeof tenant !== 'string' || typeof length !== 'number') 
+        throw new Error('Types do not match.')
+    return { type, tenant, length }
+}

website/blog/v0.6.3.md

@@ -0,0 +1,69 @@
+---
+tags: [v0.6.3, patch]
+sidebar_position: 2
+date: 2022-05-10
+authors: 
+    - name: Jesse Mitchell
+      title: Developer of Pineapple
+      url: https://github.com/TotalTechGeek
+      image_url: https://github.com/TotalTechGeek.png
+---
+
+# Minor Patch: v0.6.3
+
+This patch introduces a small quality of life improvement, which I felt was particularly necessary after introducing class-based testing:
+
+**Multiline Test Cases!**
+
+
+```js
+/**
+ * @test 'Jesse', 24 
+ * ~> $.grow(3)
+ * ~> $.grow(2) returns 29
+ * 
+ * @test 'Rick', 62 
+ * ~> $.grow(1) returns 63
+ * ~> $.grow(2) returns 65
+ * ~> $.getName() returns 'Rick'
+ * ~> $.grow() returns $.age === 66
+ */
+export class Person {
+    constructor(name, age) {
+        this.name = name
+        this.age = age
+    }
+
+    grow(amount = 1) {
+        return this.age += amount
+    }
+
+    getName() {
+        return this.name
+    }
+}
+```
+
+If you write a test case on multiple lines, Pineapple will now automatically concatenate it to the test case. This is not exclusive to class / higher-order function syntax. 
+
+
+```js
+/**
+ * @test { 
+ *      tenant: 'Rick',
+ *      length: 10,
+ *      type: 'boat' 
+ * } resolves
+ * 
+ * @test {
+ *      tenant: 10,
+ *      length: 'Rick',
+ *      type: 'boat'
+ * } rejects
+ */
+export async function createLease({ tenant, length, type = 'boat' }) {
+    if (typeof tenant !== 'string' || typeof length !== 'number') 
+        throw new Error('Types do not match.')
+    return { type, tenant, length }
+}
+```