Return raw source strings for functions (#10)

* wip: Return raw strings for functions

* Improve code style, add readme

* New version nr

Author: bartvanraaij

README.md

@@ -7,6 +7,7 @@ This small JS utility reads PHP strings containing arrays and returns a JavaScri
 It uses [glayzzle/php-parser](https://github.com/glayzzle/php-parser) to parse PHP into AST and uses that 
 info to extract arrays.  
 It supports both indexed and associative arrays (i.e. lists and dictionaries/maps) and array, string, numeric and null values.
+Inline function calls are not evaluated but returned as raw strings. See the example below.
 
 ## Installation
 
@@ -35,6 +36,7 @@ const phpString = `[
   'and_numeric' => 42,
   'what_about' => true,
   'or' => false,
+  'func' => strtoupper('abc'),
 ]`;
 const data = fromString(phpString); 
 ```
@@ -50,7 +52,8 @@ const data = fromString(phpString);
   also_supports: null,
   and_numeric: 42,
   what_about: true,
-  or: false
+  or: false,
+  func: "strtoupper('abc')"
 }
 ```
 

index.js

@@ -13,7 +13,10 @@ function fromString (phpString) {
       extractDoc: false,
       suppressErrors: true
     },
-    ast: { withPositions: false }
+    ast: {
+      withPositions: true,
+      withSource: true
+    }
   });
 
   phpString = phpString.trim();
@@ -72,6 +75,7 @@ function parseValue (expr) {
   if (expr.kind === 'boolean') return expr.value;
   if (expr.kind === 'nullkeyword') return null;
   if (expr.kind === 'identifier' && expr.name.name === 'null') return null;
+  if (expr.kind === 'call') return expr.loc?.source;
   return undefined;
 }
 

index.test.js

@@ -57,7 +57,19 @@ test('php file', () => {
   expect(data).toEqual(['foo', 'bar']);
 });
 
-test('all value types match (arrays strings numbers decimals nulls booleans)', () => {
+test('function calls', () => {
+  const data = fromString(`[
+    'func' => env('SOME_VAR', true),
+    'another' => substr($var, 0, 5),
+    'arrow' => (fn() => 123),
+  ]`);
+  expect(data).toEqual({
+    func : "env('SOME_VAR', true)",
+    another: "substr($var, 0, 5)",
+  });
+})
+
+test('all value types match (arrays strings numbers decimals nulls booleans functions)', () => {
   const data = fromString(`[
     'arrayvalue' => [
       'hello', 'world'
@@ -68,6 +80,7 @@ test('all value types match (arrays strings numbers decimals nulls booleans)', (
     'nullvalue' => null,
     'truevalue' => true,
     'falsevalue' => false,
+    'functionvalue' => strtoupper('abc'),
   ]`);
   expect(data).toEqual({
     arrayvalue: ['hello', 'world'],
@@ -76,6 +89,8 @@ test('all value types match (arrays strings numbers decimals nulls booleans)', (
     decimalvalue: 4.2,
     nullvalue: null,
     truevalue: true,
-    falsevalue: false
+    falsevalue: false,
+    functionvalue: 'strtoupper(\'abc\')'
   });
 });
+

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "php-array-reader",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Reads PHP arrays from a string into a JavaScript object",
   "main": "index.js",
   "types": "index.d.ts",