added context hook to allow the override of the default binder

This commit is contained in:
Sebastian Sdorra
2020-02-19 09:47:52 +01:00
parent fac46d636f
commit 041a999a01
4 changed files with 51 additions and 3 deletions

View File

@@ -10,11 +10,13 @@ type ExtensionRegistration = {
* The Binder class is mainly exported for testing, plugins should only use the default export. * The Binder class is mainly exported for testing, plugins should only use the default export.
*/ */
export class Binder { export class Binder {
name: string;
extensionPoints: { extensionPoints: {
[key: string]: Array<ExtensionRegistration>; [key: string]: Array<ExtensionRegistration>;
}; };
constructor() { constructor(name: string) {
this.name = name;
this.extensionPoints = {}; this.extensionPoints = {};
} }
@@ -73,6 +75,6 @@ export class Binder {
} }
// singleton binder // singleton binder
const binder = new Binder(); const binder = new Binder("default");
export default binder; export default binder;

View File

@@ -1,2 +1,3 @@
export { default as binder } from "./binder"; export { default as binder, Binder } from "./binder";
export * from "./useBinder";
export { default as ExtensionPoint } from "./ExtensionPoint"; export { default as ExtensionPoint } from "./ExtensionPoint";

View File

@@ -0,0 +1,29 @@
import useBinder, { BinderContext } from "./useBinder";
import { Binder } from "./binder";
import { mount } from "enzyme";
import "@scm-manager/ui-tests/enzyme";
import React from "react";
describe("useBinder tests", () => {
const BinderName = () => {
const binder = useBinder();
return <>{binder.name}</>;
};
it("should return default binder", () => {
const rendered = mount(<BinderName />);
expect(rendered.text()).toBe("default");
});
it("should return binder from context", () => {
const binder = new Binder("from-context");
const app = (
<BinderContext.Provider value={binder}>
<BinderName />
</BinderContext.Provider>
);
const rendered = mount(app);
expect(rendered.text()).toBe("from-context");
});
});

View File

@@ -0,0 +1,16 @@
import { createContext, useContext } from "react";
import defaultBinder from "./binder";
/**
* The BinderContext should only be used to override the default binder for testing purposes.
*/
export const BinderContext = createContext(defaultBinder);
/**
* Hook to get the binder from context.
*/
export const useBinder = () => {
return useContext(BinderContext);
};
export default useBinder;