X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=TODO;h=2683e0ce0310aed19e58646edb62c3d036e7468c;hp=6c74e1441d9e0c723ab16e06e2152b78f9eae6a5;hb=6f009cc62849c974d53b1094284bb1089082be07;hpb=5bc06bcbb52291b4fbf751b62db568354c3dd4b9 diff --git a/TODO b/TODO index 6c74e14..2683e0c 100644 --- a/TODO +++ b/TODO @@ -24,14 +24,40 @@ subclass of Catalyst::Log, no ::Plugin:: needed. See also: Catalyst::Plugin::Log::Dispatch and http://github.com/willert/catalyst-plugin-log4perl-simple/tree -# REFACTORING +## Capture arguments that the plack engine component was run with somewhere, + to more easily support custom args from scripts (e.g. Gitalist's + --git_dir) -## The horrible hack for plugin setup - replacing it: +## throw away the restarter and allow using the restarters Plack provides + +## remove per-request state from the engine instance + +## be smarter about how we use PSGI - not every response needs to be delayed + and streaming + +# The horrible hack for plugin setup - replacing it: * Have a look at the Devel::REPL BEFORE_PLUGIN stuff I wonder if what we need is that combined with plugins-as-roles -## App / ctx split: +# PSGI + +## To do at release time + + - Release psgi branch of Catalyst-Devel + - Release new Task::Catalyst + - Release 5.9 branch of Catalyst-Manual + - Release Catalyst::Engine::HTTP::Prefork with deprecation notice + + exit in Makefile.PL if Catalyst > 5.89 is installed. + +## Blockers + + * I've noticed a small difference with Catalyst::Test. The latest stable + version include two headers, 'host' and 'https'. They are missing from + this version - Pedro Melo on list + ^^ Cannot replicate this? Mailed back to ask for tests.. + +# App / ctx split: NOTE - these are notes that t0m thought up after doing back compat for catalyst_component_class, may be inaccurate, wrong or missing things @@ -57,42 +83,88 @@ 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 - - - 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) +### Final steps for GSOC + +##### Things that work: + + - the default container loads all components, calls ACCEPT_CONTEXT() when appropriate, and COMPONENT() when appropriate, behaving like current Catalyst does + + - its possible to create a custom container, and override the components you want. Lifecycle, class, dependencies, all overridable. + + - config files are loaded without Catalyst::Plugin::ConfigLoader + + - per request life cycle somewhat works + + - external modules are loaded just using a custom container, much like Catalyst::Model::Adaptor + +##### Things that don't work: + + - expand_component_module + + - sugar is still not completely implemented + + - Some back compat + - wrappers around setup_component, setup_components, locate_components in Catalyst.pm + - $instance->expand_modules + - search_extra + - Crazy tests for things such as: + sub COMPONENT { + ... + *${appclass}::Model::TopLevel::GENERATED::ACCEPT_CONTEXT = sub { ... }; + ... + } + +##### Need planning, have questions: + + - per request life cycle + + - sugar - we should discuss the syntax with rafl and edenc + + - when / when not COMPONENT should be called + + - 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? + + - There are a few more FIXMEs, idk if any relevant here + +### Next steps - planned: + + - some imports need to get the importing package in Catalyst::IOC + - done - needs testing + + - Back compat for Catalyst.pm moved methods (locate_components) + - done - needs testing + + - 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 ### Next steps - less planned: - - Creating service()-like sugar for component + - make ACCEPT_CONTEXT and COMPONENT optional in Catalyst::IOC::BlockInjection and Catalyst::IOC::ConstructorInjection + - Create COMPONENTSingleton life cycle - 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 + - 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 @@ -104,12 +176,16 @@ and what needs to be done to fix it! package MyApp::Container; use Catalyst::IOC; - container $self, as { + 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 @@ -119,68 +195,3 @@ use Catalyst::IOC; }; 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; - - 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? - - get_components_names_types - - +# 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 { - - +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 (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... - - 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 - - - People wrapping locate_components in Catalyst.pm