@universal-ember/test-support 0.4.0 → 0.5.1

package/README.md

@@ -1,26 +1,78 @@
 # test-support
 
-[Short description of the addon.]
+Common utilities for every app to help making testing easier.
 
-## Compatibility
 
-- Ember.js v4.12 or above
-- Embroider or ember-auto-import v2
+## `getService`
 
-## Installation
+A typed way to get a service.
 
+```js
+import { getService } from '@universal-ember/test-support';
+
+test('can get a service', async function (assert) {
+  let router = getService('router');
+  //  ^ RouterService
+});
 ```
-ember install test-support
+
+## `noop`
+
+a no-op function. literally does nothing.
+
+```gjs
+import { noop } from '@universal-ember/test-support';
+
+<template>
+  {{ ( noop ) }}
+</template>
 ```
 
-## Usage
+## `refresh`
+
+Simulates refreshing the page without reloading the test window
 
-[Longer description of how to use the addon in apps.]
+```js
+import { module, test } from 'qunit';
+import { setupApplicationTest } from 'ember-qunit';
+import { currentURL, visit } from '@ember/test-helpers';
 
-## Contributing
+import { refresh } from '@universal-ember/test-support';
 
-See the [Contributing](CONTRIBUTING.md) guide for details.
+module('refresh', function (hooks) {
+  setupApplicationTest(hooks);
+
+  test('are visitable without error', async function (assert) {
+    await visit('/foo');
+    await refresh(this);
+    assert.strictEqual(currentURL(), '/foo');
+  });
+});
+```
 
-## License
+## `visitAllLinks`
 
-This project is licensed under the [MIT License](LICENSE.md).
+Will visit all links, recursively, exhausting every link in your app (excluding external links).
+
+This is helpful for making sure that no un-tested pages have errors.
+
+```js
+import { module, test } from 'qunit';
+import { setupApplicationTest } from 'ember-qunit';
+
+import { visitAllLinks } from '@universal-ember/test-support';
+
+module('All Links', function (hooks) {
+  setupApplicationTest(hooks);
+
+  test('are visitable without error', async function (assert) {
+    const size1 = await visitAllLinks();
+    const size2 = await visitAllLinks((url) => {
+      assert.ok(url);
+    });
+
+    assert.ok(size1 > 0, 'The test app has links');
+    assert.ok(size2 > 0, 'The test app has links');
+  });
+});
+```

package/declarations/container/get-service.d.ts

@@ -1,3 +1,2 @@
 import type { Registry as ServiceRegistry } from '@ember/service';
 export declare function getService<ServiceName extends keyof ServiceRegistry>(name: ServiceName): ServiceRegistry[ServiceName];
-//# sourceMappingURL=get-service.d.ts.map

package/declarations/index.d.ts

@@ -1,3 +1,4 @@
 export { visitAllLinks } from './routing/visit-all.ts';
 export { getService } from './container/get-service.ts';
-//# sourceMappingURL=index.d.ts.map
+export { noop } from './utils.ts';
+export { refresh } from './testing/test-helpers-extensions.ts';

package/declarations/routing/visit-all.d.ts

@@ -1,2 +1 @@
 export declare function visitAllLinks(callback?: (url: string) => void | Promise<void>): Promise<number>;
-//# sourceMappingURL=visit-all.d.ts.map

package/declarations/template-registry.d.ts

@@ -1,3 +1,2 @@
 export default interface Registry {
 }
-//# sourceMappingURL=template-registry.d.ts.map

package/declarations/testing/test-helpers-extensions.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Simulates reloading the app without reloading the page.
+ *
+ * Is an alias for the few utilities from `@ember/test-helpers` to teardown an app and re-visit the same page.
+ */
+export declare function refresh(context: any): Promise<void>;

package/declarations/utils.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A no-op function that literally does nothing.
+ */
+export declare function noop(...args: any[]): any;

package/dist/index.js

@@ -1,3 +1,5 @@
 export { visitAllLinks } from './routing/visit-all.js';
 export { getService } from './container/get-service.js';
+export { noop } from './utils.js';
+export { refresh } from './testing/test-helpers-extensions.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}

package/dist/testing/test-helpers-extensions.js

@@ -0,0 +1,26 @@
+import { currentURL, settled, teardownContext, setupContext, setupApplicationContext, visit } from '@ember/test-helpers';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+
+/**
+ * Simulates reloading the app without reloading the page.
+ *
+ * Is an alias for the few utilities from `@ember/test-helpers` to teardown an app and re-visit the same page.
+ */
+async function refresh(context) {
+  const url = currentURL();
+  await settled();
+  await teardownContext(context);
+  await settled();
+  await setupContext(context);
+  await settled();
+  await setupApplicationContext(context);
+  await settled();
+
+  // Has settled built in
+  await visit(url);
+}
+
+export { refresh };
+//# sourceMappingURL=test-helpers-extensions.js.map

package/dist/testing/test-helpers-extensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-helpers-extensions.js","sources":["../../src/testing/test-helpers-extensions.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\n\nimport {\n  setupContext,\n  teardownContext,\n  setupApplicationContext,\n  visit,\n  currentURL,\n  settled,\n} from '@ember/test-helpers';\n\n/**\n * Simulates reloading the app without reloading the page.\n *\n * Is an alias for the few utilities from `@ember/test-helpers` to teardown an app and re-visit the same page.\n */\nexport async function refresh(context: any) {\n  const url = currentURL();\n\n  await settled();\n\n  await teardownContext(context);\n  await settled();\n\n  await setupContext(context);\n  await settled();\n\n  await setupApplicationContext(context);\n  await settled();\n\n  // Has settled built in\n  await visit(url);\n}\n"],"names":["refresh","context","url","currentURL","settled","teardownContext","setupContext","setupApplicationContext","visit"],"mappings":";;AAAA;;;AAWA;AACA;AACA;AACA;AACA;AACO,eAAeA,OAAOA,CAACC,OAAY,EAAE;AAC1C,EAAA,MAAMC,GAAG,GAAGC,UAAU,EAAE;EAExB,MAAMC,OAAO,EAAE;EAEf,MAAMC,eAAe,CAACJ,OAAO,CAAC;EAC9B,MAAMG,OAAO,EAAE;EAEf,MAAME,YAAY,CAACL,OAAO,CAAC;EAC3B,MAAMG,OAAO,EAAE;EAEf,MAAMG,uBAAuB,CAACN,OAAO,CAAC;EACtC,MAAMG,OAAO,EAAE;;AAEf;EACA,MAAMI,KAAK,CAACN,GAAG,CAAC;AAClB;;;;"}

package/dist/utils.js

@@ -0,0 +1,9 @@
+/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars */
+
+/**
+ * A no-op function that literally does nothing.
+ */
+function noop(...args) {}
+
+export { noop };
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sources":["../src/utils.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars */\n\n/**\n * A no-op function that literally does nothing.\n */\nexport function noop(...args: any[]): any {}\n"],"names":["noop","args"],"mappings":"AAAA;;AAEA;AACA;AACA;AACO,SAASA,IAAIA,CAAC,GAAGC,IAAW,EAAO;;;;"}

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@universal-ember/test-support",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "description": "The default blueprint for Embroider v2 addons.",
   "keywords": [
     "ember-addon"
   ],
-  "repository": "",
+  "repository": {
+    "url": "https://github.com/universal-ember/test-support.git",
+    "directory": "test-support"
+  },
   "license": "MIT",
   "author": "",
   "exports": {
@@ -32,9 +35,8 @@
     "dist"
   ],
   "dependencies": {
-    "@ember/test-helpers": "^4.0.4",
-    "@embroider/addon-shim": "^1.8.7",
-    "decorator-transforms": "^1.0.1"
+    "@ember/test-helpers": "^4.0.4 || ^5.2.2",
+    "@embroider/addon-shim": "^1.8.7"
   },
   "devDependencies": {
     "@babel/core": "^7.23.6",

package/declarations/container/get-service.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-service.d.ts","sourceRoot":"","sources":["../../src/container/get-service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAKlE,wBAAgB,UAAU,CAAC,WAAW,SAAS,MAAM,eAAe,EAClE,IAAI,EAAE,WAAW,GAChB,eAAe,CAAC,WAAW,CAAC,CAU9B"}

package/declarations/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC"}

package/declarations/routing/visit-all.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"visit-all.d.ts","sourceRoot":"","sources":["../../src/routing/visit-all.ts"],"names":[],"mappings":"AA8CA,wBAAsB,aAAa,CACjC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,mBAkFjD"}

package/declarations/template-registry.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"template-registry.d.ts","sourceRoot":"","sources":["../src/template-registry.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,OAAO,WAAW,QAAQ;CAEhC"}