X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=TODO;h=8490d57a0d5da91ab402d740a791427fa37640d8;hb=720e07a205830f6ea374f87090e3170e391a6f29;hp=9295085e89d94c79a54132992102397068a68865;hpb=a43734f6dc70998f00f2b4fc0d2dbe6fb6a0f69d;p=catagits%2FCatalyst-Runtime.git diff --git a/TODO b/TODO index 9295085..8490d57 100644 --- a/TODO +++ b/TODO @@ -57,27 +57,24 @@ http://github.com/willert/catalyst-plugin-log4perl-simple/tree ## GSOC -### Next large steps, planned: - -For all components that have been discovered, in whatever way, we create a service: - - that's a catalyst component service - - which is basically just a constructor injection - - except the constructor name is COMPONENT - - and we're "implicitly" passing along some constructor args - - Lifecycle => Singleton - - - We make a 'components' sub container in the main container. - - This gets the ConstructorInjection COMPONENT services, as model_Foo. - - Lifecycle of these services is Singleton - - This simplifies the code for MyApp->components, as it need only list one sub-container - - - We create a second service (depending on the first one) for ACCEPT_CONTEXT - - This has a custom service which calls ACCEPT_CONTEXT when the instance is fetched - - Not Singleton lifecycle - - Note - ACCEPT_CONTEXT can be called on app values - if you have a Model::Foo, with an ACCEPT_CONTEXT - and you call MyApp->model('Foo') then ACCEPT_CONTEXT gets invoked with a $c of 'MyApp' (this is not\ - the normal case, but we need to preserve for compat) +### Next steps - planned: + + - Test custom container + - writing some tests which verify that the models you think should be + there are there, and that they received their dependencies as arguments + - i.e. Model::Bar should get params { foo => $model_foo } when being + constructed, etc + - Need to test that if you have a standard component Frotz + and a customized component Fnar, and Fnar depends on Frotz + - And yeah, some tests that the customised components actually work via + $c->model('Foo'), and that COMPONENT is called (or not called) + as appropiate and that ACCEPT_CONTEXT is called (or not) as appropriate + + - Kill flush_request_services + - we're already passing $ctx in when we locate services so the ::Request + lifecycle can just stash the object in, or retrieve the object from the + stash + (actually, we're not passing $ctx when we locate services. Problem!) ### Next steps - less planned: @@ -86,76 +83,83 @@ For all components that have been discovered, in whatever way, we create a servi - Test cases for extending the container in an application. - Using the sugar added in the previous item - Test when Model::Foo depends_on Model::Bar - - a) configure additional services in that container - - super simple container $default_container => as { more services }; - class MyApp::Container extends Catalyst::Container { - use Bread::Board; # Or our own sugar? - method BUILD { container $self => as { - service model => ...; # some constructor injection to MyApp::Model or something - container Model => as { - component Foo => (dependencies => ['/model']); # As per default! - component Bar => (dependencies => ['/model/Foo']); # Magic! - }; - # Note - implementation of BB may need to be changed to support making sure existing - # services actually get overridden. not sure how the default container behaves when doing that - # above code would build the constructor injection as it currently does, - # defaulting to the class name in the right namespace as declared by the surrounding container - # as well as adding using the catalyst-specific service class - } } - }; - - let's consider the usage patterns we actually want to enable by doing the whole B::B thing - what happens if i make the "per-app" service for a component life only for the duration of the request? - or be instanciated every time i look up the component? - (or scoping it per session, or having a block injection, or something) - - say you override the app service to be per-request - now the wrapper for the per-request variant doesn't make sense anymore. does it? - because you're only overriding one half of what has been generated automatically - - ah, so you have basically ended up with getting a request scoped thing to be used to construct a request scoped thing, which is pointless? Would/could you not just override the - service which is actually getting looked up instead, and make it not depend on the auto-generated per-app scope service, which will then just never be built? - - yes, you could. but then you'd have to be aware of the distinction - which is what i hoped to be a barely visible backcompat thing - but which i'm afraid it won't be if we go for two actual separate services - - what stops the sugar we give from not just making you specify the lifecycle, and giving you the obvious name / wiring? - i.e. everything looks like 'Foo', so you don't have to know COMPONENT/Foo exists - - my hopes of not needing any sugar at all, i guess - - only a couple of new lifecycles to be registered with the container - ?? - + - Test for component Foo => ( lifecycle => 'Singleton', class => 'My::External::Class', dependencies => { config => depends_on("config") } ) + - Fix ^^ so that you can get your component's namespaced config nicely. + + - Tests for using the container outside of Catalyst + - Custom container which adds some (very simple) services which are initialized from + the application config file (note plain services, not components) + - Depend on (and test) these inside Catalyst + - Test loading container outside Catalyst, and these services working + - Test Catalyst / MyApp is not loaded + +#### Extending my app, notes + +Basically try to implement something like this (starting out without the sugar!), and see how it breaks +and what needs to be done to fix it! + +##### Eventual syntax + +package MyApp::Container; +use Catalyst::IOC; + + container $self, as { + container model => as { + component Foo => (); # As per default! + component Bar => (dependencies => ['/model/Foo']); # Magic! + component Baz => ( lifecycle => 'InstancePerContext ); + component Quux => ( lifecycle => 'Singleton' ); # ACCEPT_CONTEXT not called + # Catalyst::Model::Adaptor example + conponent Fnar => ( lifecycle => 'Singleton', class => 'My::External::Class', dependencies => { config => depends_on('config')} ); + # ^^ FIXME - gets whole config, not Model::Foo + # There should be a 'nice' way to get the 'standard' config + }; + # Note - implementation of BB may need to be changed to support making sure existing + # services actually get overridden. not sure how the default container behaves when doing that + # above code would build the constructor injection as it currently does, + # defaulting to the class name in the right namespace as declared by the surrounding container + # as well as adding using the catalyst-specific service class + }; + +1; + +##### To start with + +package MyApp::Container; +use Moose; + +extends 'Catalyst::Container; + +after BUILD => sub { + my $self = shift; + my $model_container = $self->get_sub_container('model'); + my $service = Catalyst::IOC::ConstructorInjection->new( + name => 'Baz', + class => 'MyApp::Model::Baz', + dependencies => [ + depends_on( '/application_name' ), + depends_on( '/config' ), + depends_on( '/model/Foo' ), + ], + lifecycle => 'InstancePerContext', + ); + $model_container->add_service( 'Foo', $service ); +}; ### To polish off / t0m review - - + $class->container->get_sub_container('model')->make_single_default; - + $class->container->get_sub_container('view')->make_single_default; - - get_components_names_types - - locate_components - - +# FIXME - t0m, how do you feel about this name? - +# also, do you think I should draw it here, or just return the data structure? - +sub get_components_names_types { - - + MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = { - - +# FIXME - just till I understand how it's supposed to be done - +# Made this so that COMPONENT is executed once, - +# and ACCEPT_CONTEXT every call. - +has instance => ( - + is => 'rw', - - # This is ok?? - +my $applevel_config = TestAppContainer->container->resolve(service => 'config')->{applevel_config}; - +__PACKAGE__->config(applevel_config => 'foo'); - + locate_components service vs setup_components method + - can we be more lazy? + - should setup_components be a service that things like the ->component lookup + can depend on? - accept_context_args - where does this come from? + - my $accept_context_args = $self->param('accept_context_args'); + + my $accept_context_args = $params{accept_context_args}; + ^^ This (may be) wrong! I am thinking the service should be allowed to mangle the + accept_context args, no? + Without this change, the user could make a custom service which mangled the param, and use + Catalyst/IOC/Service/WithAcceptContext.pm, with this change, that module will always see the + un-mangled version?? However, without this change, shit doesn't work... ### Known issues @@ -164,3 +168,4 @@ For all components that have been discovered, in whatever way, we create a servi - expand_component_module + - People wrapping locate_components in Catalyst.pm