X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=TODO;h=4937c44a179d6e20f5ccd8813a89441fdb72d573;hb=f5dbaa050401d417e43180442ca50ba07895f27f;hp=3f7cb085c6203f994857f4c51a58ddef493be41c;hpb=c571d2c84b0acd26c540bba4b604e7ce8e01e426;p=catagits%2FCatalyst-Runtime.git diff --git a/TODO b/TODO index 3f7cb08..4937c44 100644 --- a/TODO +++ b/TODO @@ -1,78 +1,180 @@ -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: - - CatalystX-Imports, Class::MOP doesn't consider anon subs in the symbol - table as methods, new version of fixed plugin (rafl), explanation of - the issue in Catalyst::Upgrading (groditi) - - - Catalyst-Log-Log4perl Deep recursion on subroutine "MockApp::setup" - (rafl) + Test app: http://github.com/bobtfish/catalyst-app-bug-go_chain/tree/master - - CatalystX-CRUD and CatalystX-CRUD-ModelAdapter-DBIC - fail tests against 5.80 (karpet) +# Compatibility warnings to add: - - 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.. + - $self->config should warn as config should only ever be called as a + class method (TESTS). -Cleanups: +# Proposed functionality / feature additions: -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 +## Log setup needs to be less lame +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. - - 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. +See also: Catalyst::Plugin::Log::Dispatch and +http://github.com/willert/catalyst-plugin-log4perl-simple/tree - - 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) +# REFACTORING - - 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) +## The horrible hack for plugin setup - replacing it: -Documentation: + * Have a look at the Devel::REPL BEFORE_PLUGIN stuff + I wonder if what we need is that combined with plugins-as-roles - - Manual / Tutorial updates +## App / ctx split: - - extends in components with attributes must be inside a BEGIN block. + 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 :) + + - 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. +### Next large steps, planned: - - Catalyst/Upgrading.pod +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 -Reported bugs: + - 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 - - Issues with TWMC not being loaded when it used to be in 5.70 - (Bill Moseley) + - 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 -Profiling: + - 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) - - vs 5.70 and optimisation as needed. +### Next steps - less planned: -Tests: + - Creating service()-like sugar for component - - Moosified test application? - - - Test & document warnings from plugin method on Catalyst + - 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 + + - + $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'); + + + accept_context_args - where does this come from? + +### Known issues + + - Broken $instance->expand_modules() in setup_components and figure + out later how to bring it back + + - expand_component_module