X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=TODO;h=23cdab70a426324c1aa2a0c60378a5fee7b9d53f;hb=c31259881c5bdcab50409ff2e167a6aeb9df52cd;hp=409d8b2b551118da56c92e82aa434de8e9001209;hpb=731a47570cbf9ee677b9a016b7588950b946829b;p=catagits%2FCatalyst-Runtime.git diff --git a/TODO b/TODO index 409d8b2..23cdab7 100644 --- a/TODO +++ b/TODO @@ -57,30 +57,140 @@ http://github.com/willert/catalyst-plugin-log4perl-simple/tree ## GSOC -### Next large steps: +### 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 + + - Fix B::B so that Service::WithParametrs' parameters attribute has a builder + - Fix ConstructorInjection so that default parameters are supplied (for accept_context_args) + - Fix ConstructorInjection's 'suffix' - should be called 'config_key' or something, and + should be an attribute on the service (as it never changes), rather than a parameter + to the service + + - 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 - less planned: + + - Creating service()-like sugar for component - - Moving setup_components etc into the container + - 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 + + +#### 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 + }; + # 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 - - This is so that you can just load the container and get models etc from it, - without loading Catalyst. + - + $class->container->get_sub_container('model')->make_single_default; + + $class->container->get_sub_container('view')->make_single_default; - - Finished documentation for ::IOC parts. + +sub controller { shift->_lookup_mvc('controller', @_) } - - Test cases for extending the container in an application. + get_components_names_types - - Allowing people to change component lifecycles + locate_components - - This is done by being able to use an alternate Service class.. + +# 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 { - I.E. We currently force everything to do Catalyst/IOC/Service/WithAcceptContext.pm, but - things without an ACCEPT_CONTEXT could just not bother, and it would be nice to have - one that cached the object in request scope (i.e. Catalyst::Component::InstancePerContext) - etc. + + MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = { - However we need to work out an interface for people to setup / configure this. + +# 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', -### To polish off + # This is ok?? + +my $applevel_config = TestAppContainer->container->resolve(service => 'config')->{applevel_config}; + +__PACKAGE__->config(applevel_config => 'foo'); + + + +Same as L, but for controllers. The difference is + +that there is no ACCEPT_CONTEXT for controllers. + ^^ This is wrong!! + + - my $accept_context_args = $self->param('accept_context_args'); + + my $accept_context_args = $params{accept_context_args}; + ^^ This is wrong! 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?? + + accept_context_args - where does this come from? + + + $purity = $purity // 1; + ^^ perl 5.10 only + +### Known issues + + - Broken $instance->expand_modules() in setup_components and figure + out later how to bring it back + + - expand_component_module - - Document current methods - - + $class->container->get_sub_container('model')->make_single_default; -+ $class->container->get_sub_container('view')->make_single_default;