@khanacademy/wonder-blocks-testing 5.0.2 → 7.0.0

package/src/fixtures/adapters/adapter-group.js

@@ -1,88 +0,0 @@
-// @flow
-import type {
-    FixturesAdapterGroup,
-    FixturesAdapterGroupOptions,
-    FixturesAdapterFixtureOptions,
-} from "../types.js";
-
-export type CloseGroupFn<TProps: {...}, Options: {...}, Exports: {...}> = (
-    options: $ReadOnly<FixturesAdapterGroupOptions>,
-    adapterOptions: ?$ReadOnly<Options>,
-    declaredFixtures: $ReadOnlyArray<FixturesAdapterFixtureOptions<TProps>>,
-) => ?$ReadOnly<Exports>;
-
-/**
- * Simple adapter group implementation.
- */
-export class AdapterGroup<TProps: {...}, Options: {...}, Exports: {...}>
-    implements FixturesAdapterGroup<TProps, Options, Exports>
-{
-    _closeGroupFn: ?CloseGroupFn<TProps, Options, Exports>;
-    +_fixtures: Array<FixturesAdapterFixtureOptions<TProps>>;
-    +_options: $ReadOnly<FixturesAdapterGroupOptions>;
-
-    /**
-     * Create an adapter group.
-     *
-     * @param {CloseGroupFn<TProps, Options, Exports>} closeGroupFn A function
-     * to invoke when the group is closed.
-     * @param {AdapterGroupOptions} options The options for the group.
-     */
-    constructor(
-        closeGroupFn: CloseGroupFn<TProps, Options, Exports>,
-        options: $ReadOnly<FixturesAdapterGroupOptions>,
-    ) {
-        if (typeof closeGroupFn !== "function") {
-            throw new TypeError("closeGroupFn must be a function");
-        }
-        if (typeof options !== "object" || options === null) {
-            throw new TypeError("options must be an object");
-        }
-        this._closeGroupFn = closeGroupFn;
-        this._options = options;
-        this._fixtures = [];
-    }
-
-    /**
-     * Close the group.
-     *
-     * This declares that no more fixtures are to be added to the group,
-     * and will call the parent adapter with the declared fixtures so that they
-     * can be adapted for the target fixture framework, such as Storybook.
-     */
-    +closeGroup: (
-        adapterOptions: ?$ReadOnly<Partial<Options>>,
-    ) => ?$ReadOnly<Exports> = (adapterOptions = null) => {
-        if (this._closeGroupFn == null) {
-            throw new Error("Group already closed");
-        }
-
-        try {
-            return this._closeGroupFn(
-                this._options,
-                adapterOptions,
-                this._fixtures,
-            );
-        } finally {
-            this._closeGroupFn = null;
-        }
-    };
-
-    /**
-     * Declare a fixture within the group.
-     *
-     * @param {FixturesAdapterFixtureOptions<TProps>} fixtureOptions The options
-     * describing the fixture.
-     */
-    +declareFixture: (
-        options: $ReadOnly<FixturesAdapterFixtureOptions<TProps>>,
-    ) => void = (options) => {
-        if (typeof options !== "object" || options === null) {
-            throw new TypeError("options must be an object");
-        }
-        if (this._closeGroupFn == null) {
-            throw new Error("Cannot declare fixtures after closing the group");
-        }
-        this._fixtures.push(options);
-    };
-}

package/src/fixtures/adapters/adapter.js

@@ -1,63 +0,0 @@
-// @flow
-import {AdapterGroup, type CloseGroupFn} from "./adapter-group.js";
-import type {
-    FixturesAdapter,
-    FixturesAdapterGroup,
-    FixturesAdapterGroupOptions,
-} from "../types.js";
-
-/**
- * Class for implementing a custom adapter.
- */
-export class Adapter<Options: {...}, Exports: {...}>
-    implements FixturesAdapter<Options, Exports>
-{
-    +_name: string;
-    +_closeGroupFn: CloseGroupFn<any, Options, Exports>;
-
-    /**
-     * @param {string} name The name of the adapter.
-     * @param {CloseGroupFn<any, Options, Exports>} closeGroupFn The function
-     * an adapter group should call when the group is closed. This is invoked
-     * by an adapter group when it is closed. This function is where an
-     * adapter implements the logic to generate the actual fixtures for the
-     * adapter's target framework.
-     */
-    constructor(
-        name: string,
-        closeGroupFn: CloseGroupFn<any, Options, Exports>,
-    ) {
-        if (typeof name !== "string") {
-            throw new TypeError("name must be a string");
-        }
-        if (name.trim() === "") {
-            throw new Error("name must be a non-empty string");
-        }
-        if (typeof closeGroupFn !== "function") {
-            throw new TypeError("closeGroupFn must be a function");
-        }
-
-        this._name = name;
-        this._closeGroupFn = closeGroupFn;
-    }
-
-    /**
-     * The name of the adapter.
-     */
-    get name(): string {
-        return this._name;
-    }
-
-    /**
-     * Declare a new fixture group.
-     *
-     * @param {FixturesAdapterGroupOptions} options The options describing the fixture
-     * group.
-     * @returns {FixturesAdapterGroup} The new fixture group.
-     */
-    declareGroup<Config: {...}>(
-        options: $ReadOnly<FixturesAdapterGroupOptions>,
-    ): FixturesAdapterGroup<Config, Options, Exports> {
-        return new AdapterGroup(this._closeGroupFn, options);
-    }
-}

package/src/fixtures/adapters/adapters.js

@@ -1,2 +0,0 @@
-// @flow
-export {getAdapter as storybook} from "./storybook.js";

package/src/fixtures/adapters/storybook.js

@@ -1,125 +0,0 @@
-// @flow
-import * as React from "react";
-import {action} from "@storybook/addon-actions";
-import {Adapter} from "./adapter.js";
-
-import type {
-    FixturesAdapterGroupOptions,
-    FixturesAdapterFixtureOptions,
-    FixturesAdapterFactory,
-} from "../types.js";
-
-type StoryContext = {|
-    args: $ReadOnly<any>,
-    argTypes: $ReadOnly<any>,
-    globals: $ReadOnlyArray<any>,
-    hooks: $ReadOnlyArray<any>,
-    parameters: $ReadOnly<any>,
-    viewMode: mixed,
-|};
-
-export type StorybookOptions = {|
-    decorators?: Array<
-        (story: React.ComponentType<any>, context: StoryContext) => React.Node,
-    >,
-    parameters?: $ReadOnly<any>,
-|};
-
-type DefaultExport = {|
-    title?: ?string,
-    ...StorybookOptions,
-|};
-
-type Exports<TProps: {...}> = {|
-    default: DefaultExport,
-    [story: string]: React.ComponentType<TProps>,
-|};
-
-/**
- * Get a fixture framework adapter for Storybook support.
- */
-export const getAdapter: FixturesAdapterFactory<
-    StorybookOptions,
-    Exports<any>,
-> = (MountingComponent = null) =>
-    new Adapter<StorybookOptions, Exports<any>>(
-        "storybook",
-        <TProps: {...}>(
-            {
-                title,
-                description: groupDescription,
-                // We don't use the default title in Storybook as storybook
-                // will generate titles for us if we pass a nullish title.
-                getDefaultTitle: _,
-            }: $ReadOnly<FixturesAdapterGroupOptions>,
-            adapterOptions: ?$ReadOnly<StorybookOptions>,
-            declaredFixtures: $ReadOnlyArray<
-                FixturesAdapterFixtureOptions<TProps>,
-            >,
-        ): ?$ReadOnly<Exports<TProps>> => {
-            const templateMap = new WeakMap();
-
-            const log = (message, ...args) => action(message)(...args);
-
-            const exports = declaredFixtures.reduce(
-                (acc, {description, getProps, component: Component}, i) => {
-                    const storyName = `${i + 1} ${description}`;
-                    const exportName = storyName
-                        // Make word boundaries start with an upper case letter.
-                        .replace(/\b\w/g, (c) => c.toUpperCase())
-                        // Remove all non-alphanumeric characters.
-                        .replace(/[^\w]+/g, "")
-                        // Remove all underscores.
-                        .replace(/[_]+/g, "");
-
-                    // We create a “template” of how args map to rendering
-                    // for each type of component as the component here could
-                    // be the component under test, or wrapped in a wrapper
-                    // component. We don't use decorators for the wrapper
-                    // because we may not be in a storybook context and it
-                    // keeps the framework API simpler this way.
-                    let Template = templateMap.get(Component);
-                    if (Template == null) {
-                        // The MountingComponent is a bit different than just a
-                        // Storybook decorator. It's a React component that
-                        // takes over rendering the component in the fixture
-                        // with the given args, allowing for greater
-                        // customization in a platform-agnostic manner (i.e.
-                        // not just story format).
-                        Template = MountingComponent
-                            ? (args) => (
-                                  <MountingComponent
-                                      component={Component}
-                                      props={args}
-                                      log={log}
-                                  />
-                              )
-                            : (args) => <Component {...args} />;
-                        templateMap.set(Component, Template);
-                    }
-
-                    // Each story that shares that component then reuses that
-                    // template.
-                    acc[exportName] = Template.bind({});
-                    acc[exportName].args = getProps({log});
-                    // Adding a story name here means that we don't have to
-                    // care about naming the exports correctly, if we don't
-                    // want (useful if we need to autogenerate or manually
-                    // expose ESM exports).
-                    acc[exportName].storyName = storyName;
-
-                    return acc;
-                },
-                {
-                    default: {
-                        title,
-                        // TODO(somewhatabstract): Use groupDescription
-                        // Possibly via a decorator?
-                        ...adapterOptions,
-                    },
-                },
-            );
-
-            return Object.freeze(exports);
-        },
-    );

package/src/fixtures/combine-options.js

@@ -1,25 +0,0 @@
-// @flow
-import {combineTopLevel} from "./combine-top-level.js";
-
-/**
- * Combine one or more objects into a single object.
- *
- * Objects later in the argument list take precedence over those that are
- * earlier. Object and array values at the root level are merged.
- */
-export const combineOptions = <Options: {...}>(
-    ...toBeCombined: $ReadOnlyArray<Partial<Options>>
-): $ReadOnly<Partial<Options>> => {
-    const combined = toBeCombined.filter(Boolean).reduce((acc, cur) => {
-        for (const key of Object.keys(cur)) {
-            // We always call combine, even if acc[key] is undefined
-            // because we need to make sure we clone values.
-            acc[key] = combineTopLevel(acc[key], cur[key]);
-        }
-        return acc;
-    }, {});
-
-    // We know that we are creating a compatible return type.
-    // $FlowIgnore[incompatible-return]
-    return combined;
-};

package/src/fixtures/combine-top-level.js

@@ -1,44 +0,0 @@
-// @flow
-import {clone} from "@khanacademy/wonder-stuff-core";
-
-/**
- * Combine two values.
- *
- * This method clones val2 before using any of its properties to try to ensure
- * the combined object is not linked back to the original.
- *
- * If the values are objects, it will merge them at the top level. Properties
- * themselves are not merged; val2 properties will overwrite val1 where there
- * are conflicts
- *
- * If the values are arrays, it will concatenate and dedupe them.
- * NOTE: duplicates in either val1 or val2 will also be deduped.
- *
- * If the values are any other type, or val2 has a different type to val1, val2
- * will be returned.
- */
-export const combineTopLevel = (
-    val1: $ReadOnly<any>,
-    val2: $ReadOnly<any>,
-): any => {
-    const obj2Clone = clone(val2);
-
-    // Only merge if they're both arrays or both objects.
-    // If not, we will just return val2.
-    if (
-        val1 !== null &&
-        val2 !== null &&
-        typeof val1 === "object" &&
-        typeof val2 === "object"
-    ) {
-        const val1IsArray = Array.isArray(val1);
-        const val2IsArray = Array.isArray(val2);
-
-        if (val1IsArray && val2IsArray) {
-            return Array.from(new Set([...val1, ...obj2Clone]));
-        } else if (!val1IsArray && !val2IsArray) {
-            return {...val1, ...obj2Clone};
-        }
-    }
-    return obj2Clone;
-};

package/src/fixtures/setup.js

@@ -1,30 +0,0 @@
-// @flow
-import type {FixturesConfiguration} from "./types.js";
-
-let _configuration: ?$ReadOnly<FixturesConfiguration<any, any>> = null;
-
-/**
- * Setup the fixture framework.
- */
-export const setup = <TAdapterOptions: {...}, TAdapterExports: {...}>(
-    configuration: $ReadOnly<
-        FixturesConfiguration<TAdapterOptions, TAdapterExports>,
-    >,
-) => {
-    _configuration = configuration;
-};
-
-/**
- * Get the framework configuration.
- *
- * @returns {Configuration} The configuration as provided via setup().
- * @throws {Error} If the configuration has not been set.
- */
-export const getConfiguration = (): $ReadOnly<
-    FixturesConfiguration<any, any>,
-> => {
-    if (_configuration == null) {
-        throw new Error("Not configured");
-    }
-    return _configuration;
-};