mvc controllers and methods: provide mvc.Application automatically

Former-commit-id: 991d8e72c3c231813a455dd0680cd8a83b82abb1
This commit is contained in:
Gerasimos (Makis) Maropoulos 2020-05-06 08:00:56 +03:00
parent d19672115b
commit 8c470e46a2
3 changed files with 60 additions and 3 deletions

View File

@ -145,6 +145,7 @@ Prior to this version the `iris.Context` was the only one dependency that has be
| Type | Maps To | | Type | Maps To |
|------|:---------| |------|:---------|
| [*mvc.Application](https://pkg.go.dev/github.com/kataras/iris/v12/mvc?tab=doc#Application) | Current MVC Application |
| [iris.Context](https://pkg.go.dev/github.com/kataras/iris/v12/context?tab=doc#Context) | Current Iris Context | | [iris.Context](https://pkg.go.dev/github.com/kataras/iris/v12/context?tab=doc#Context) | Current Iris Context |
| [*sessions.Session](https://pkg.go.dev/github.com/kataras/iris/v12/sessions?tab=doc#Session) | Current Iris Session | | [*sessions.Session](https://pkg.go.dev/github.com/kataras/iris/v12/sessions?tab=doc#Session) | Current Iris Session |
| [context.Context](https://golang.org/pkg/context/#Context) | [ctx.Request().Context()](https://golang.org/pkg/net/http/#Request.Context) | | [context.Context](https://golang.org/pkg/context/#Context) | [ctx.Request().Context()](https://golang.org/pkg/net/http/#Request.Context) |

View File

@ -506,7 +506,7 @@ type testControllerNotCreateNewDueManuallySettingAllFields struct {
} }
func (c *testControllerNotCreateNewDueManuallySettingAllFields) AfterActivation(a AfterActivation) { func (c *testControllerNotCreateNewDueManuallySettingAllFields) AfterActivation(a AfterActivation) {
if n := len(a.DependenciesReadOnly()) - len(hero.BuiltinDependencies); n != 1 { if n := len(a.DependenciesReadOnly()) - len(hero.BuiltinDependencies) - 1; /* Application */ n != 1 {
c.T.Fatalf(`expecting 1 dependency; c.T.Fatalf(`expecting 1 dependency;
- the 'T' and the 'TitlePointer' are manually binded (nonzero fields on initilization) - the 'T' and the 'TitlePointer' are manually binded (nonzero fields on initilization)
- controller has no more than these two fields, it's a singleton - controller has no more than these two fields, it's a singleton
@ -624,3 +624,24 @@ func TestControllersInsideControllerDeep(t *testing.T) {
e := httptest.New(t, app) e := httptest.New(t, app)
e.GET("/something").Expect().Status(httptest.StatusOK).Body().Equal("foo bar") e.GET("/something").Expect().Status(httptest.StatusOK).Body().Equal("foo bar")
} }
type testApplicationDependency struct {
App *Application
}
func (c *testApplicationDependency) Get() string {
return c.App.Name
}
func TestApplicationDependency(t *testing.T) {
app := iris.New()
m := New(app).SetName("app1")
m.Handle(new(testApplicationDependency))
m2 := m.Clone(app.Party("/other")).SetName("app2")
m2.Handle(new(testApplicationDependency))
e := httptest.New(t, app)
e.GET("/").Expect().Status(httptest.StatusOK).Body().Equal("app1")
e.GET("/other").Expect().Status(httptest.StatusOK).Body().Equal("app2")
}

View File

@ -25,6 +25,8 @@ import (
// See `mvc#New` for more. // See `mvc#New` for more.
type Application struct { type Application struct {
container *hero.Container container *hero.Container
// This Application's Name. Keep names unique to each other.
Name string
Router router.Party Router router.Party
Controllers []*ControllerActivator Controllers []*ControllerActivator
@ -32,10 +34,34 @@ type Application struct {
} }
func newApp(subRouter router.Party, container *hero.Container) *Application { func newApp(subRouter router.Party, container *hero.Container) *Application {
return &Application{ app := &Application{
Router: subRouter, Router: subRouter,
container: container, container: container,
} }
// Register this Application so any field or method's input argument of
// *mvc.Application can point to the current MVC application that the controller runs on.
registerBuiltinDependencies(container, app)
return app
}
// See `hero.BuiltinDependencies` too, here we are registering dependencies per MVC Application.
func registerBuiltinDependencies(container *hero.Container, deps ...interface{}) {
for _, dep := range deps {
depTyp := reflect.TypeOf(dep)
for i, dependency := range container.Dependencies {
if dependency.Static {
if dependency.DestType == depTyp {
// Remove any existing before register this one (see app.Clone).
copy(container.Dependencies[i:], container.Dependencies[i+1:])
container.Dependencies = container.Dependencies[:len(container.Dependencies)-1]
break
}
}
}
container.Register(dep)
}
} }
// New returns a new mvc Application based on a "party". // New returns a new mvc Application based on a "party".
@ -44,7 +70,7 @@ func newApp(subRouter router.Party, container *hero.Container) *Application {
// //
// Example: `New(app.Party("/todo"))` or `New(app)` as it's the same as `New(app.Party("/"))`. // Example: `New(app.Party("/todo"))` or `New(app)` as it's the same as `New(app.Party("/"))`.
func New(party router.Party) *Application { func New(party router.Party) *Application {
return newApp(party, party.ConfigureContainer().Container) return newApp(party, party.ConfigureContainer().Container.Clone())
} }
// Configure creates a new controller and configures it, // Configure creates a new controller and configures it,
@ -78,6 +104,15 @@ func (app *Application) Configure(configurators ...func(*Application)) *Applicat
return app return app
} }
// SetName sets a unique name to this MVC Application.
// Used for logging, not used in runtime yet, but maybe useful for future features.
//
// It returns this Application.
func (app *Application) SetName(appName string) *Application {
app.Name = appName
return app
}
// Register appends one or more values as dependencies. // Register appends one or more values as dependencies.
// The value can be a single struct value-instance or a function // The value can be a single struct value-instance or a function
// which has one input and one output, the input should be // which has one input and one output, the input should be