@slimlib/smart-mock 0.1.0 → 0.1.2

package/README.md

@@ -1,6 +1,51 @@
 # Smart Mock
 
-One more proxy based mock
+Yet another proxy mock (YAPM?). Still in a very early state (EXPECT BUGS!).
+
+Mock that records operations for code generation later. Idea is somewhat similar to `prepack` but instead of interpreting code by other JS code we run it in JS VM and later use mock to repeat same operations. Ideally combined with terser like optimizer. Please check example in `pkgbld` how it is used to eject config.
+
+## API
+
+### default `() => { createMock, generateGlobals, generate }`
+
+Default export function is a factory that creates 3 other functions with shared state.
+
+### `createMock<T extends object>(object: T, name: string): T`
+
+Function to create mock wrapper around object and defining global name for later usage. `object` can be real original object or a pure mock object with same behavior for the specific situation. All operations on this object will be recorded by mock.
+
+### `generate(object: unknown): string`
+
+Function to generate code for some export point (exit point). It will try to automatically inline operations that can be inlined.
+
+### `generateGlobals(): string`
+
+Function to generate global code that cannot be inlined to exit point.
+
+### Example
+
+```javascript
+import createMockProvider from '@slimlib/smart-mock';
+const { createMock, generate, generateGlobals } = createMockProvider();
+const mock = createMock({
+    fly() { return { status: 'flying' }; },
+    land() {},
+    name: ''
+}, 'fly');
+mock.name = 'Moth';
+const status = mock.fly();
+mock.land();
+```
+
+At this point `generate(mock)` will result in `mock`, `generate(mock.name)` in `'Moth'` and `generate(status)` in `fly.fly()`. And if you afterwards call `generateGlobals()` you get something like:
+
+```javascript
+fly.name = "Moth"
+const tmp_0 = fly.land
+tmp_0()
+```
+
+Each `generate` call updates counters / flags in mock so `generateGlobals` only emits what was not generated at the time of call.
 
 # License
 

package/dist/index.cjs

@@ -17,7 +17,7 @@ function createRecordingMockFactory() {
             name,
             source: 0 /* MockDataSource.root */,
             useCount: 0,
-            generated: true
+            generated: false
         });
     }
     function generateGlobals() {
@@ -25,34 +25,39 @@ function createRecordingMockFactory() {
         for (const mockData of mockDatas) {
             if (mockData.generated)
                 continue;
-            if (!mockData.instanceName) {
+            if (!mockData.instanceName && mockData.source !== 0 /* MockDataSource.root */) {
                 mockData.instanceName = getNextInstanceName();
             }
-            strings.push('const ' + mockData.instanceName + ' = ' + getAccessor(mockData, mockData.parent));
+            const identifier = (mockData?.instanceName ?? mockData?.name);
+            if (mockData.source !== 0 /* MockDataSource.root */) {
+                strings.push('const ' + identifier + ' = ' + getAccessor(mockData, mockData.parent));
+            }
             for (const effect of (mockData.sideEffects || [])) {
                 switch (effect.source) {
                     case 3 /* MockDataSource.set */:
-                        strings.push(mockData.instanceName + '.' + effect.name + ' = ' + stringify(effect.options, replacer));
+                        strings.push(identifier + '.' + effect.name + ' = ' + stringify(effect.options, replacer));
                         break;
                     // case MockDataSource.defineProperty:
-                    //     strings.push('Object.defineProperty(' + mockData.instanceName + ', "' + (effect.name as string) + '", ' + stringify(effect.options, replacer as ReplacerFunction) + ')');
+                    //     strings.push('Object.defineProperty(' + identifier + ', "' + (effect.name as string) + '", ' + stringify(effect.options, replacer as ReplacerFunction) + ')');
                     //     break;
                     case 5 /* MockDataSource.deleteProperty */:
-                        strings.push('delete ' + mockData.instanceName + '["' + effect.name + '"]');
+                        strings.push('delete ' + identifier + '["' + effect.name + '"]');
                         break;
                     case 6 /* MockDataSource.setPrototypeOf */:
-                        strings.push('Object.setPrototypeOf(' + mockData.instanceName + ', ' + stringify(effect.options, replacer) + ')');
+                        strings.push('Object.setPrototypeOf(' + identifier + ', ' + stringify(effect.options, replacer) + ')');
                         break;
                     case 7 /* MockDataSource.preventExtensions */:
-                        strings.push('Object.preventExtensions(' + mockData.instanceName + ')');
+                        strings.push('Object.preventExtensions(' + identifier + ')');
+                        break;
+                    case 2 /* MockDataSource.call */:
+                        strings.push(identifier + getParameters(effect.options, replacer));
                         break;
                 }
             }
         }
         return strings.join('\n');
         function getAccessor(mockData, parent) {
-            var _a;
-            const parentName = ((_a = parent.instanceName) !== null && _a !== void 0 ? _a : parent.name);
+            const parentName = (parent?.instanceName ?? parent?.name);
             switch (mockData.source) {
                 case 2 /* MockDataSource.call */:
                     return parentName + getParameters(mockData.options, replacer);
@@ -253,7 +258,23 @@ function createRecordingMockFactory() {
                 const realThis = unwrapValue(thisArg);
                 const realArguments = unwrapValue(argumentsList);
                 ++mockData.useCount;
-                return createInternalMock(Reflect.apply(target, realThis, realArguments), {
+                const result = Reflect.apply(target, realThis, realArguments);
+                if (result === null || (typeof result !== 'object' && typeof result !== 'function')) {
+                    if (!mockData.sideEffects) {
+                        mockData.sideEffects = [];
+                    }
+                    mockData.sideEffects.push({
+                        useCount: 0,
+                        name: '',
+                        parent: mockData,
+                        source: 2 /* MockDataSource.call */,
+                        options: realArguments,
+                        generated: false
+                    });
+                    ++mockData.useCount;
+                    return result;
+                }
+                return createInternalMock(result, {
                     useCount: 0,
                     name: '',
                     parent: mockData,
@@ -271,6 +292,7 @@ function createRecordingMockFactory() {
 function getParameters(options, replacer) {
     return `(${options.length ? options.map(value => stringify(value, replacer)).join(',') : ''})`;
 }
+// stringify like functionality, recursively walks through objects and converts them to strings but leaved some basic values intact
 function stringify(value, replacer) {
     const original = value;
     value = replacer(value);

package/dist/index.d.ts

@@ -12,5 +12,5 @@ export declare const enum MockDataSource {
 export default function createRecordingMockFactory(): {
     createMock: <T extends object>(object: T, name: string) => T;
     generateGlobals: () => string;
-    generate: <T_1 extends object>(object: T_1) => string | boolean | RegExp | null | undefined;
+    generate: (object: unknown) => string | boolean | RegExp | null | undefined;
 };

package/dist/index.mjs

@@ -15,7 +15,7 @@ function createRecordingMockFactory() {
             name,
             source: 0 /* MockDataSource.root */,
             useCount: 0,
-            generated: true
+            generated: false
         });
     }
     function generateGlobals() {
@@ -23,34 +23,39 @@ function createRecordingMockFactory() {
         for (const mockData of mockDatas) {
             if (mockData.generated)
                 continue;
-            if (!mockData.instanceName) {
+            if (!mockData.instanceName && mockData.source !== 0 /* MockDataSource.root */) {
                 mockData.instanceName = getNextInstanceName();
             }
-            strings.push('const ' + mockData.instanceName + ' = ' + getAccessor(mockData, mockData.parent));
+            const identifier = (mockData?.instanceName ?? mockData?.name);
+            if (mockData.source !== 0 /* MockDataSource.root */) {
+                strings.push('const ' + identifier + ' = ' + getAccessor(mockData, mockData.parent));
+            }
             for (const effect of (mockData.sideEffects || [])) {
                 switch (effect.source) {
                     case 3 /* MockDataSource.set */:
-                        strings.push(mockData.instanceName + '.' + effect.name + ' = ' + stringify(effect.options, replacer));
+                        strings.push(identifier + '.' + effect.name + ' = ' + stringify(effect.options, replacer));
                         break;
                     // case MockDataSource.defineProperty:
-                    //     strings.push('Object.defineProperty(' + mockData.instanceName + ', "' + (effect.name as string) + '", ' + stringify(effect.options, replacer as ReplacerFunction) + ')');
+                    //     strings.push('Object.defineProperty(' + identifier + ', "' + (effect.name as string) + '", ' + stringify(effect.options, replacer as ReplacerFunction) + ')');
                     //     break;
                     case 5 /* MockDataSource.deleteProperty */:
-                        strings.push('delete ' + mockData.instanceName + '["' + effect.name + '"]');
+                        strings.push('delete ' + identifier + '["' + effect.name + '"]');
                         break;
                     case 6 /* MockDataSource.setPrototypeOf */:
-                        strings.push('Object.setPrototypeOf(' + mockData.instanceName + ', ' + stringify(effect.options, replacer) + ')');
+                        strings.push('Object.setPrototypeOf(' + identifier + ', ' + stringify(effect.options, replacer) + ')');
                         break;
                     case 7 /* MockDataSource.preventExtensions */:
-                        strings.push('Object.preventExtensions(' + mockData.instanceName + ')');
+                        strings.push('Object.preventExtensions(' + identifier + ')');
+                        break;
+                    case 2 /* MockDataSource.call */:
+                        strings.push(identifier + getParameters(effect.options, replacer));
                         break;
                 }
             }
         }
         return strings.join('\n');
         function getAccessor(mockData, parent) {
-            var _a;
-            const parentName = ((_a = parent.instanceName) !== null && _a !== void 0 ? _a : parent.name);
+            const parentName = (parent?.instanceName ?? parent?.name);
             switch (mockData.source) {
                 case 2 /* MockDataSource.call */:
                     return parentName + getParameters(mockData.options, replacer);
@@ -251,7 +256,23 @@ function createRecordingMockFactory() {
                 const realThis = unwrapValue(thisArg);
                 const realArguments = unwrapValue(argumentsList);
                 ++mockData.useCount;
-                return createInternalMock(Reflect.apply(target, realThis, realArguments), {
+                const result = Reflect.apply(target, realThis, realArguments);
+                if (result === null || (typeof result !== 'object' && typeof result !== 'function')) {
+                    if (!mockData.sideEffects) {
+                        mockData.sideEffects = [];
+                    }
+                    mockData.sideEffects.push({
+                        useCount: 0,
+                        name: '',
+                        parent: mockData,
+                        source: 2 /* MockDataSource.call */,
+                        options: realArguments,
+                        generated: false
+                    });
+                    ++mockData.useCount;
+                    return result;
+                }
+                return createInternalMock(result, {
                     useCount: 0,
                     name: '',
                     parent: mockData,
@@ -269,6 +290,7 @@ function createRecordingMockFactory() {
 function getParameters(options, replacer) {
     return `(${options.length ? options.map(value => stringify(value, replacer)).join(',') : ''})`;
 }
+// stringify like functionality, recursively walks through objects and converts them to strings but leaved some basic values intact
 function stringify(value, replacer) {
     const original = value;
     value = replacer(value);

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.0",
+  "version": "0.1.2",
   "license": "MIT",
   "name": "@slimlib/smart-mock",
   "author": "Konstantin Shutkin",