X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=TODO;h=da1026daecc0deb01d596b3e9179c37098946b77;hb=4af15971a8b23e2b255f20813e23eb27994e710d;hp=03dd432415bdd601b518b71a551547b10a4fd512;hpb=6a893485c342dfec4041f00eb10438ccc9327b65;p=catagits%2FCatalyst-Runtime.git diff --git a/TODO b/TODO index 03dd432..da1026d 100644 --- a/TODO +++ b/TODO @@ -1,77 +1,153 @@ -Back-compat investigation: +# Known Bugs: - - Get engines tested: - - Catalyst-Engine-Zeus - - Catalyst-Engine-XMPP2 - - Catalyst-Engine-HTTPEngine - - Catalyst-Engine-HTTP-Prefork - - Catalyst-Engine-Wx + - Bug ->go or ->visit causes actions which have Args or CaptureArgs called + twice when called via ->go or ->visit. -Known issues: + Test app: http://github.com/bobtfish/catalyst-app-bug-go_chain/tree/master - - Catalyst-Log-Log4perl Deep recursion on subroutine "MockApp::setup" due - to Adopt::NEXT not remembering which setup methods were already called - and which not, like NEXT does. Log::Log4perl needs to be fixed and the - problem should be described in Upgrading.pod. (rafl) +# Compatibility warnings to add: - - CatalystX-CRUD and CatalystX-CRUD-ModelAdapter-DBIC - fail tests against 5.80 (karpet) + - $self->config should warn as config should only ever be called as a + class method (TESTS). - - Catalyst-Plugin-Authorization-ACL fails as - Catalyst::Dispatcher::_do_forward does not fix arguments if you throw - an exception. Needs a test case (Caelum) - - - Catalyst::Plugin::Authentication new release. - - - Catalyst::Action::RenderView - - Catalyst::Plugin::DebugCookie - - Conflict with each other: $c->config->{debug}->{foo} = 'bar' - now breaks, unsure why.. +# Proposed functionality / feature additions: -Cleanups: +## Log setup needs to be less lame -18:01 <@mst> hmm. I think that warning should show what it found -18:01 <@mst> and say "you probably called ->model("Sessions") when you meant ->model("DB::Sessions")" or whatever -18:05 <@mst> unsafe_component_use_ok -18:05 <@mst> like we did for BindLex +So Catalyst::Plugin::Log::* can die +in a fire. Having $c->log_class would be a good start. kane volunteered +to do some of this. +Simple example: Catalyst::Plugin::Log::Colorful should just be a +subclass of Catalyst::Log, no ::Plugin:: needed. +See also: Catalyst::Plugin::Log::Dispatch and +http://github.com/willert/catalyst-plugin-log4perl-simple/tree - - Update Test suite to not assume MyApp ISA Controller - - After that set up attr handlers that will output helpful error messages - when you do it as well as how to fix it. +# REFACTORING - - Eliminate all instances of $instance->{$key}, I think the only thing - left is lib/Catalyst/Engine/HTTP.pm: $self->{inputbuf}, which I haven't - touched as it is used as an lvalue in a lot of places (t0m) +## The horrible hack for plugin setup - replacing it: - - Find whatever in the test suite craps a file called GLOB(0xfoo) onto my - disk and fix it. (Believed to be in the optional TEST_HTTP tests?) (t0m) + * Have a look at the Devel::REPL BEFORE_PLUGIN stuff + I wonder if what we need is that combined with plugins-as-roles -Documentation: +## App / ctx split: - - Manual / Tutorial updates + NOTE - these are notes that t0m thought up after doing back compat for + catalyst_component_class, may be inaccurate, wrong or missing things + bug mst (at least) to correct before trying more than the first 2 + steps. Please knock yourself out on the first two however :) - - extends in components with attributes must be inside a BEGIN block. + - Eliminate actions in MyApp from the main test suite + - Uncomment warning in C::C::register_action_methods, add tests it works + by mocking out the logging.. + - Remove MyApp @ISA controller (ask metaclass if it has attributes, and if + so you need back compat :/) + - Make Catalyst::Context, move the per request stuff in there, handles from + main app class to delegate + - Make an instance of the app class which is a global variable + - Make new instance of the context class, not the app class per-request + - Remove the components as class data, move to instance data on the app + class (you probably have to do this for _all_ the class data, good luck!) + - Make it possible for users to spin up different instances of the app class + (with different config etc each) + - Profit! (Things like changing the complete app config per vhost, i.e. + writing a config loader / app class role which dispatches per vhost to + differently configured apps is piss easy) - - How to write Moosified Catalyst components. +## GSOC - - Fix the Roadmap to be less full of lies. +### Final steps for GSOC - - Catalyst/Upgrading.pod +##### Things that work: -Reported bugs: +##### Things that don't work: - - Issues with TWMC not being loaded when it used to be in 5.70 - (Bill Moseley) +##### Need planning, have questions: -Profiling: +### Next steps - planned: - - vs 5.70 and optimisation as needed. + - some imports need to get the importing package in Catalyst::IOC -Tests: + - test values directly instead of serializing them over http in t/lib/TestCustomContainer.pm - - Moosified test application? - - - Test & document warnings from plugin method on Catalyst + - 16:01 < shadowpaste> "t0m" at 217.168.150.38 pasted "more explicit? thoughts?" (13 lines) at http://paste.scsys.co.uk/131520 + - make ACCEPT_CONTEXT and COMPONENT optional in Catalyst::IOC::BlockInjection and Catalyst::IOC::ConstructorInjection + - Create COMPONENTSingleton life cycle + + - Back compat for Catalyst.pm moved methods (locate_components) + + - 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 + + - 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 + +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 polish off / t0m review + + 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? + +### 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