feat(store): add createMockStore migration (#3810)

Author: timdeschryver

modules/store/migrations/16_0_0-beta/index.spec.ts

@@ -0,0 +1,50 @@
+import { Tree } from '@angular-devkit/schematics';
+import {
+  SchematicTestRunner,
+  UnitTestTree,
+} from '@angular-devkit/schematics/testing';
+import * as path from 'path';
+
+describe('Store Migration 16_0_0-beta', () => {
+  const collectionPath = path.join(__dirname, '../migration.json');
+
+  it(`should replace getMockStore with createMockStore`, async () => {
+    const input = `
+    import { getMockStore } from '@ngrx/store';
+    import { SomethingElse } from '@ngrx/store';
+    import {getMockStore} from '@ngrx/store';
+    import {foo, getMockStore, bar} from '@ngrx/store';
+    
+    const mockStore = getMockStore();
+
+    it('just a test', () => {
+      const s =getMockStore();
+    })
+`;
+
+    const expected = `
+    import {createMockStore } from '@ngrx/store';
+    import { SomethingElse } from '@ngrx/store';
+    import {createMockStore} from '@ngrx/store';
+    import {foo,createMockStore, bar} from '@ngrx/store';
+    
+    const mockStore =createMockStore();
+
+    it('just a test', () => {
+      const s =createMockStore();
+    })
+`;
+    const appTree = new UnitTestTree(Tree.empty());
+    appTree.create('./fixture.ts', input);
+    const runner = new SchematicTestRunner('schematics', collectionPath);
+
+    const newTree = await runner.runSchematic(
+      `ngrx-store-migration-16-0-0-beta`,
+      {},
+      appTree
+    );
+    const file = newTree.readContent('fixture.ts');
+
+    expect(file).toBe(expected);
+  });
+});

modules/store/migrations/16_0_0-beta/index.ts

@@ -0,0 +1,74 @@
+import * as ts from 'typescript';
+import { Rule, chain, Tree } from '@angular-devkit/schematics';
+import {
+  visitTSSourceFiles,
+  RemoveChange,
+  InsertChange,
+  commitChanges,
+} from '../../schematics-core';
+
+function updateGetMockStore(): Rule {
+  return (tree: Tree) => {
+    visitTSSourceFiles(tree, (sourceFile) => {
+      const imports = sourceFile.statements
+        .filter(ts.isImportDeclaration)
+        .filter(
+          (importDeclaration) =>
+            importDeclaration.moduleSpecifier.getText(sourceFile) ===
+              "'@ngrx/store'" ||
+            importDeclaration.moduleSpecifier.getText(sourceFile) ===
+              '"@ngrx/store"'
+        )
+        .flatMap((importDeclaration) => {
+          return importDeclaration.importClause?.namedBindings ?? [];
+        })
+        .flatMap((binding) =>
+          ts.isNamedImports(binding) ? binding.elements : []
+        )
+        .filter(
+          (element) => element.name.getText(sourceFile) === 'getMockStore'
+        );
+      if (!imports.length) return;
+
+      const changes: (InsertChange | RemoveChange)[] = [];
+      imports.forEach((binding) => {
+        changes.push(
+          new RemoveChange(sourceFile.fileName, binding.pos, binding.end)
+        );
+        changes.push(
+          new InsertChange(sourceFile.fileName, binding.pos, 'createMockStore')
+        );
+      });
+
+      ts.forEachChild(sourceFile, crawl);
+      return commitChanges(tree, sourceFile.fileName, changes);
+
+      function crawl(node: ts.Node) {
+        ts.forEachChild(node, crawl);
+
+        if (!ts.isCallExpression(node)) return;
+        if (!ts.isIdentifier(node.expression)) return;
+        if (node.expression.text !== 'getMockStore') return;
+
+        changes.push(
+          new RemoveChange(
+            sourceFile.fileName,
+            node.expression.pos,
+            node.expression.end
+          )
+        );
+        changes.push(
+          new InsertChange(
+            sourceFile.fileName,
+            node.expression.pos,
+            'createMockStore'
+          )
+        );
+      }
+    });
+  };
+}
+
+export default function (): Rule {
+  return chain([updateGetMockStore]);
+}

modules/store/migrations/migration.json

@@ -30,6 +30,11 @@
       "description": "The road to v15.2",
       "version": "15.2.0",
       "factory": "./15_2_0/index"
+    },
+    "ngrx-store-migration-16-0-0-beta": {
+      "description": "The road to v16.0-beta",
+      "version": "16.0.0-beta",
+      "factory": "./16_0_0-beta/index"
     }
   }
 }