Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/request scope #201

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/interfaces/interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ namespace interfaces {
export interface ProvideInSyntax<T> extends ProvideDoneSyntax {
inSingletonScope(): ProvideWhenOnSyntax<T>;
inTransientScope(): ProvideWhenOnSyntax<T>;
inRequestScope(): ProvideWhenOnSyntax<T>;
}

export interface ProvideInWhenOnSyntax<T> extends ProvideInSyntax<T>, ProvideWhenSyntax<T>, ProvideOnSyntax<T> {}
Expand Down
9 changes: 9 additions & 0 deletions src/syntax/provide_in_syntax.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ class ProvideInSyntax<T> implements interfaces.ProvideInSyntax<T> {
return new ProvideWhenOnSyntax(provideWhenSyntax, provideOnSyntax);
}

public inRequestScope(): interfaces.ProvideWhenOnSyntax<T> {
let bindingWhenOnSyntax = (bind: inversifyInterfaces.Bind, target: any) => this._bindingInSyntax(bind, target).inRequestScope();
let inDoneSyntax = new ProvideDoneSyntax(bindingWhenOnSyntax);

let provideWhenSyntax = new ProvideWhenSyntax<T>(bindingWhenOnSyntax, inDoneSyntax);
let provideOnSyntax = new ProvideOnSyntax<T>(bindingWhenOnSyntax, inDoneSyntax);
return new ProvideWhenOnSyntax(provideWhenSyntax, provideOnSyntax);
}

public done(force?: boolean) {
return this._provideDoneSyntax.done(force);
}
Expand Down
4 changes: 4 additions & 0 deletions src/syntax/provide_in_when_on_syntax.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ class ProvideInWhenOnSyntax<T> implements interfaces.ProvideInWhenOnSyntax<T> {
return this._provideInSyntax.inTransientScope();
}

public inRequestScope(): interfaces.ProvideWhenOnSyntax<T> {
return this._provideInSyntax.inRequestScope();
}

public done(force?: boolean) {
return this._provideInSyntax.done(force);
}
Expand Down
31 changes: 30 additions & 1 deletion test/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -212,11 +212,17 @@ describe("inversify-binding-decorators", () => {
return fluentProvide(identifier).inTransientScope().done();
};

let provideRequest = function (identifier: string) {
return fluentProvide(identifier).inRequestScope().done();
};

interface Warrior {
katana: Weapon;
shuriken: ThrowableWeapon;
personalItem: PersonalItem;
fight(): string;
sneak(): string;
use(): string;
}

interface Weapon {
Expand All @@ -227,7 +233,12 @@ describe("inversify-binding-decorators", () => {
throw(): string;
}

interface PersonalItem {
use(): string;
}

let TYPE = {
PersonalItem: "PersonalItem",
ThrowableWeapon: "ThrowableWeapon",
Warrior: "Warrior",
Weapon: "Weapon"
Expand Down Expand Up @@ -255,22 +266,37 @@ describe("inversify-binding-decorators", () => {
}
}

@provideRequest(TYPE.PersonalItem)
class FamilyCrest implements PersonalItem {
private _mark: any;
public constructor() {
this._mark = Math.random();
}
public use() {
return "use! " + this._mark;
}
}

@provideTransient(TYPE.Warrior)
class Ninja implements Warrior {

public katana: Weapon;
public shuriken: ThrowableWeapon;
public personalItem: PersonalItem;

public constructor(
@inject(TYPE.Weapon) katana: Weapon,
@inject(TYPE.ThrowableWeapon) shuriken: ThrowableWeapon
@inject(TYPE.ThrowableWeapon) shuriken: ThrowableWeapon,
@inject(TYPE.PersonalItem) personalItem: PersonalItem
) {
this.katana = katana;
this.shuriken = shuriken;
this.personalItem = personalItem;
}

public fight() { return this.katana.hit(); }
public sneak() { return this.shuriken.throw(); }
public use() { return this.personalItem.use(); }

}

Expand All @@ -279,13 +305,16 @@ describe("inversify-binding-decorators", () => {
expect(ninja instanceof Ninja).eql(true);
expect(ninja.katana instanceof Katana).eql(true);
expect(ninja.shuriken instanceof Shuriken).eql(true);
expect(ninja.personalItem instanceof FamilyCrest).eql(true);

expect(ninja.fight().indexOf("cut!")).eql(0);
expect(ninja.sneak().indexOf("hit!")).eql(0);
expect(ninja.use().indexOf("use!")).eql(0);

let ninja2 = container.get<Warrior>(TYPE.Warrior);
expect(ninja.fight()).eql(ninja2.fight());
expect(ninja.sneak()).not.to.eql(ninja2.sneak());
expect(ninja.use()).not.to.eql(ninja2.use());

});

Expand Down
23 changes: 23 additions & 0 deletions test/syntax/provide_in_syntax.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,27 @@ describe("ProvideInSyntax", () => {
expect(mockBind.calledWith("Ninja")).to.be.eql(true, "mock bind was not called");

});
it("Should be able to declare a binding with request scope", () => {

class Ninja { }
let inRequestScopeExpectation = sinon.expectation.create("inRequestScope");
let mockBindingInSyntax = { inRequestScope: inRequestScopeExpectation } as any as inversifyInterfaces.BindingInSyntax<any>;
let mockBind = sinon.expectation.create("bind");
let bindingInSyntaxFunction =
(bind: inversifyInterfaces.Bind, target: any) => {
bind<Ninja>("Ninja");
return mockBindingInSyntax;
};
let binding: inversifyInterfaces.Binding<any> = (<any>bindingInSyntaxFunction)._binding;
let provideDoneSyntax = new ProvideDoneSyntax(binding as any);

let provideInSyntax = new ProvideInSyntax(bindingInSyntaxFunction, provideDoneSyntax);

provideInSyntax.inRequestScope().done()(Ninja);
let metadata = Reflect.getMetadata(METADATA_KEY.provide, Reflect)[0];
metadata.constraint(mockBind);
expect(inRequestScopeExpectation.calledOnce).to.eql(true, "inRequestScope was not called exactly once");
expect(mockBind.calledWith("Ninja")).to.be.eql(true, "mock bind was not called");

});
});