Merge pull request #124 from runspired/warp-drive

NullVoxPopuli · web-flow · commit 0d46c3ce2201 · 2025-10-31T15:34:05.000-04:00
Use modern EmberData/WarpDrive
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -25,6 +25,11 @@ export default [
   pluginJs.configs.recommended,
   eslintConfigPrettier,
   {
-    ignores: ['tests/fixtures/*', 'files/ember-cli-build.js'],
+    ignores: [
+      'tests/fixtures/*',
+      'files/ember-cli-build.js',
+      'files/_js_*',
+      'files/_ts_*',
+    ],
   },
 ];
diff --git a/files/_js_eslint.config.mjs b/files/_js_eslint.config.mjs
@@ -16,6 +16,7 @@ import globals from 'globals';
 import js from '@eslint/js';
 
 import ember from 'eslint-plugin-ember/recommended';
+<% if (warpDrive) { %>import WarpDrive from 'eslint-plugin-warp-drive/recommended';<% } %>
 import eslintConfigPrettier from 'eslint-config-prettier';
 import qunit from 'eslint-plugin-qunit';
 import n from 'eslint-plugin-n';
@@ -32,6 +33,8 @@ export default [
   eslintConfigPrettier,
   ember.configs.base,
   ember.configs.gjs,
+  <% if (warpDrive) { %>...WarpDrive,<% } %>
+
   /**
    * Ignores must be in their own object
    * https://eslint.org/docs/latest/use/configure/ignore
diff --git a/files/_ts_eslint.config.mjs b/files/_ts_eslint.config.mjs
@@ -18,6 +18,7 @@ import js from '@eslint/js';
 import ts from 'typescript-eslint';
 
 import ember from 'eslint-plugin-ember/recommended';
+<% if (warpDrive) { %>import WarpDrive from 'eslint-plugin-warp-drive/recommended';<% } %>
 
 import eslintConfigPrettier from 'eslint-config-prettier';
 import qunit from 'eslint-plugin-qunit';
@@ -43,6 +44,7 @@ export default ts.config(
   ember.configs.base,
   ember.configs.gjs,
   ember.configs.gts,
+  <% if (warpDrive) { %>...WarpDrive,<% } %>
   eslintConfigPrettier,
   /**
    * Ignores must be in their own object
diff --git a/files/app/app.ts b/files/app/app.ts
@@ -1,3 +1,4 @@
+<% if (warpDrive) { %>import '@warp-drive/ember/install';<% } %>
 import Application from '@ember/application';
 import compatModules from '@embroider/virtual/compat-modules';
 import Resolver from 'ember-resolver';
diff --git a/files/app/models/.gitkeep b/files/app/models/.gitkeep
diff --git a/files/app/services/store.ts b/files/app/services/store.ts
@@ -0,0 +1,17 @@
+import { useLegacyStore } from '@warp-drive/legacy';
+import { JSONAPICache } from '@warp-drive/json-api';
+
+const Store = useLegacyStore({
+  linksMode: true,
+  cache: JSONAPICache,
+  handlers: [
+    // -- your handlers here
+  ],
+  schemas: [
+    // -- your schemas here
+  ],
+});
+
+type Store = InstanceType<typeof Store>;
+
+export default Store;
diff --git a/files/ember-cli-build.js b/files/ember-cli-build.js
@@ -4,19 +4,22 @@ const EmberApp = require('ember-cli/lib/broccoli/ember-app');
 const { compatBuild } = require('@embroider/compat');
 
 module.exports = async function (defaults) {
-  const { buildOnce } = await import('@embroider/vite');
+  <% if (warpDrive) {%>const { setConfig } = await import('@warp-drive/core/build-config');
+  <% } %>const { buildOnce } = await import('@embroider/vite');
+
   let app = new EmberApp(defaults, {
-    <% if (emberData) {%>emberData: {
-      deprecations: {
-        // New projects can safely leave this deprecation disabled.
-        // If upgrading, to opt-into the deprecated behavior, set this to true and then follow:
-        // https://deprecations.emberjs.com/id/ember-data-deprecate-store-extends-ember-object
-        // before upgrading to Ember Data 6.0
-        DEPRECATE_STORE_EXTENDS_EMBER_OBJECT: false,
-      },
+    // Add options here
+  });
+<% if (warpDrive) {%>
+  setConfig(app, __dirname, {
+    // this should be the most recent <major>.<minor> version for
+    // which all deprecations have been fully resolved
+    // and should be updated when that changes
+    compatWith: '5.8',
+    deprecations: {
+      // ... list individual deprecations that have been resolved here
     },
-    <% } %>// Add options here
   });
-
+<% } %>
   return compatBuild(app, buildOnce);
 };
diff --git a/files/package.json b/files/package.json
@@ -35,16 +35,7 @@
     "@babel/runtime": "^7.28.4",
     "@babel/plugin-transform-runtime": "^7.28.3<% if (typescript) { %>",
     "@babel/plugin-transform-typescript": "^7.28.0<% } %>",
-    "@babel/eslint-parser": "^7.28.4<% if (typescript && emberData) { %>",
-    "@ember-data/adapter": "~5.6.0",
-    "@ember-data/graph": "~5.6.0",
-    "@ember-data/json-api": "~5.6.0",
-    "@ember-data/legacy-compat": "~5.6.0",
-    "@ember-data/model": "~5.6.0",
-    "@ember-data/request": "~5.6.0",
-    "@ember-data/request-utils": "~5.6.0",
-    "@ember-data/serializer": "~5.6.0",
-    "@ember-data/store": "~5.6.0<% } %><% if (typescript) { %>",
+    "@babel/eslint-parser": "^7.28.4<% if (typescript) { %>",
     "@ember/app-tsconfig": "^1.0.3<% } %>",
     "@ember/optional-features": "^2.2.0",
     "@ember/string": "^4.0.1",
@@ -65,17 +56,19 @@
     "@glint/template": "^1.6.1<% } %>",
     "@rollup/plugin-babel": "^6.0.4<% if (typescript) { %>",
     "@types/qunit": "^2.19.13",
-    "@types/rsvp": "^4.0.9<% if (emberData) {%>",
-    "@warp-drive/core-types": "~5.6.0<% }} %><% if (emberData) { %>",
-    "@warp-drive/ember": "~5.6.0<% } %>",
+    "@types/rsvp": "^4.0.9<% } %><% if (warpDrive) { %>",
+    "@warp-drive/core": "5.8.0",
+    "@warp-drive/ember": "5.8.0",
+    "@warp-drive/json-api": "5.8.0",
+    "@warp-drive/legacy": "5.8.0",
+    "@warp-drive/utilities": "5.8.0<% } %>",
     "babel-plugin-ember-template-compilation": "^2.4.1",
     "concurrently": "^9.2.1",
     "decorator-transforms": "^2.3.0",
     "ember-auto-import": "^2.11.1",
     "ember-cli": "~6.9.0-alpha.1",
     "ember-cli-babel": "^8.2.0",
-    "ember-cli-deprecation-workflow": "^3.4.0<% if (emberData) { %>",
-    "ember-data": "~5.6.0<% } %>",
+    "ember-cli-deprecation-workflow": "^3.4.0",
     "ember-load-initializers": "^3.0.1",
     "ember-modifier": "^4.2.2",
     "ember-page-title": "^9.0.3",
@@ -88,7 +81,8 @@
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-ember": "^12.7.4",
     "eslint-plugin-n": "^17.23.1",
-    "eslint-plugin-qunit": "^8.2.5",
+    "eslint-plugin-qunit": "^8.2.5<% if (warpDrive) { %>",
+    "eslint-plugin-warp-drive": "5.8.0<% } %>",
     "globals": "^16.4.0",
     "prettier": "^3.6.2",
     "prettier-plugin-ember-template-tag": "^2.1.0",
diff --git a/files/tests/test-helper.ts b/files/tests/test-helper.ts
@@ -1,3 +1,4 @@
+<% if (warpDrive) { %>import '@warp-drive/ember/install';<% } %>
 import Application from '<%= modulePrefix %>/app';
 import config from '<%= modulePrefix %>/config/environment';
 import * as QUnit from 'qunit';
diff --git a/index.js b/index.js
@@ -40,6 +40,7 @@ module.exports = {
           options.ciProvider && `"--ci-provider=${options.ciProvider}"`,
           options.typescript && `"--typescript"`,
           !options.emberData && `"--no-ember-data"`,
+          !options.warpDrive && `"--no-warp-drive"`,
         ]
           .filter(Boolean)
           .join(',\n            ') +
@@ -75,7 +76,7 @@ module.exports = {
       blueprint: 'app',
       blueprintOptions,
       lang: options.lang,
-      emberData: options.emberData,
+      warpDrive: options.warpDrive ?? options.emberData,
       ciProvider: options.ciProvider,
       typescript: options.typescript,
       packageManager: options.packageManager ?? 'npm',
@@ -101,9 +102,11 @@ module.exports = {
       );
     }
 
-    if (!options.emberData) {
-      files = files.filter((file) => !file.includes('models/'));
-      files = files.filter((file) => !file.includes('ember-data/'));
+    const warpDrive = options.warpDrive || options.emberData;
+    if (!warpDrive) {
+      files = files.filter((file) => !file.includes('services/store.ts'));
+    } else {
+      files = files.filter((file) => !file.includes('services/.gitkeep'));
     }
 
     this._files = files;
diff --git a/tests/arguments.test.mjs b/tests/arguments.test.mjs
@@ -108,15 +108,31 @@ describe('Blueprint Arguments', function () {
     it('installs ember-data by default', async function () {
       const { files } = await generateApp();
 
-      expect(parse(files['package.json']).devDependencies['ember-data']).to.not
-        .be.undefined;
+      expect(parse(files['package.json']).devDependencies['@warp-drive/core'])
+        .to.not.be.undefined;
     });
 
     it('does not add ember-data if you pass --no-ember-data', async function () {
       const { files } = await generateApp({ flags: ['--no-ember-data'] });
 
-      expect(parse(files['package.json']).devDependencies['ember-data']).to.be
-        .undefined;
+      expect(parse(files['package.json']).devDependencies['@warp-drive/core'])
+        .to.be.undefined;
+    });
+  });
+
+  describe('--no-warp-drive', async function () {
+    it('installs warp-drive by default', async function () {
+      const { files } = await generateApp();
+
+      expect(parse(files['package.json']).devDependencies['@warp-drive/core'])
+        .to.not.be.undefined;
+    });
+
+    it('does not add warp-drive if you pass --no-warp-drive', async function () {
+      const { files } = await generateApp({ flags: ['--no-warp-drive'] });
+
+      expect(parse(files['package.json']).devDependencies['@warp-drive/core'])
+        .to.be.undefined;
     });
   });
 
diff --git a/tests/fixtures/warpdrive-js/app/routes/application.js b/tests/fixtures/warpdrive-js/app/routes/application.js
@@ -0,0 +1,14 @@
+import Route from '@ember/routing/route';
+import { service } from '@ember/service';
+
+export default class ApplicationRoute extends Route {
+  @service store;
+
+  model() {
+    return {
+      person: this.store.request({
+        url: 'https://swapi.dev/api/people/1',
+      }),
+    };
+  }
+}
diff --git a/tests/fixtures/warpdrive-js/app/services/store.js b/tests/fixtures/warpdrive-js/app/services/store.js
@@ -0,0 +1,30 @@
+import { useLegacyStore } from '@warp-drive/legacy';
+import { JSONAPICache } from '@warp-drive/json-api';
+import { withDefaults } from '@warp-drive/legacy/model/migration-support';
+
+const Store = useLegacyStore({
+  linksMode: true,
+  cache: JSONAPICache,
+  handlers: [
+    {
+      request() {
+        return Promise.resolve({
+          data: {
+            type: 'person',
+            id: '1',
+            attributes: { name: 'Luke Skywalker' },
+          },
+        });
+      },
+    },
+  ],
+  schemas: [
+    // -- your schemas here
+    withDefaults({
+      type: 'person',
+      fields: [{ kind: 'field', name: 'name' }],
+    }),
+  ],
+});
+
+export default Store;
diff --git a/tests/fixtures/warpdrive-js/app/templates/application.gjs b/tests/fixtures/warpdrive-js/app/templates/application.gjs
@@ -0,0 +1,22 @@
+import { pageTitle } from 'ember-page-title';
+import { Request } from '@warp-drive/ember';
+
+<template>
+  {{pageTitle "MyTestApp"}}
+
+  {{outlet}}
+
+  {{! The following component displays Ember's default welcome message. }}
+  <Request @request={{@model.person}}>
+    <:loading>
+      <p>Loading person...</p>
+    </:loading>
+    <:error as |error|>
+      <p>Error loading person: {{error.message}}</p>
+    </:error>
+    <:content as |result|>
+      <h1>Welcome {{result.data.name}}</h1>
+    </:content>
+  </Request>
+  {{! Feel free to remove this! }}
+</template>
diff --git a/tests/fixtures/warpdrive-js/tests/application/index-test.js b/tests/fixtures/warpdrive-js/tests/application/index-test.js
@@ -0,0 +1,13 @@
+import { module, test } from 'qunit';
+import { setupApplicationTest } from 'ember-qunit';
+import { visit } from '@ember/test-helpers';
+
+module('Application | index', function (hooks) {
+  setupApplicationTest(hooks);
+
+  test('visiting / shows welcome message', async function (assert) {
+    await visit('/');
+
+    assert.dom('h1').hasText('Welcome Luke Skywalker');
+  });
+});
diff --git a/tests/fixtures/warpdrive-ts/app/routes/application.ts b/tests/fixtures/warpdrive-ts/app/routes/application.ts
@@ -0,0 +1,26 @@
+import Route from '@ember/routing/route';
+import { service } from '@ember/service';
+import { withReactiveResponse } from '@warp-drive/core/request';
+import type { Type } from '@warp-drive/core/types/symbols';
+import type Store from 'test-app/services/store';
+
+export interface Person {
+  id: string;
+  $type: 'person';
+  name: string;
+  [Type]: 'person';
+}
+
+export default class ApplicationRoute extends Route {
+  @service declare store: Store;
+
+  model() {
+    return {
+      person: this.store.request(
+        withReactiveResponse<Person>({
+          url: 'https://swapi.dev/api/people/1',
+        }),
+      ),
+    };
+  }
+}
diff --git a/tests/fixtures/warpdrive-ts/app/services/store.ts b/tests/fixtures/warpdrive-ts/app/services/store.ts
@@ -0,0 +1,32 @@
+import { useLegacyStore } from '@warp-drive/legacy';
+import { JSONAPICache } from '@warp-drive/json-api';
+import { withDefaults } from '@warp-drive/legacy/model/migration-support';
+
+const Store = useLegacyStore({
+  linksMode: true,
+  cache: JSONAPICache,
+  handlers: [
+    {
+      request<T>(): Promise<T> {
+        return Promise.resolve({
+          data: {
+            type: 'person',
+            id: '1',
+            attributes: { name: 'Luke Skywalker' }
+          },
+        } as T);
+      }
+    }
+  ],
+  schemas: [
+    // -- your schemas here
+    withDefaults({
+      type: 'person',
+      fields: [{ kind: 'field', name: 'name' }],
+    }),
+  ],
+});
+
+type Store = InstanceType<typeof Store>;
+
+export default Store;
diff --git a/tests/fixtures/warpdrive-ts/app/templates/application.gts b/tests/fixtures/warpdrive-ts/app/templates/application.gts
diff --git a/tests/fixtures/warpdrive-ts/tests/application/index-test.ts b/tests/fixtures/warpdrive-ts/tests/application/index-test.ts
diff --git a/tests/warpdrive.test.mjs b/tests/warpdrive.test.mjs

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+<% if (warpDrive) { %>import '@warp-drive/ember/install';<% } %>`
`1`	`2`	`import Application from '@ember/application';`
`2`	`3`	`import compatModules from '@embroider/virtual/compat-modules';`
`3`	`4`	`import Resolver from 'ember-resolver';`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+<% if (warpDrive) { %>import '@warp-drive/ember/install';<% } %>`
`1`	`2`	`import Application from '<%= modulePrefix %>/app';`
`2`	`3`	`import config from '<%= modulePrefix %>/config/environment';`
`3`	`4`	`import * as QUnit from 'qunit';`