try to make a summary of some sort
[catagits/Catalyst-Runtime.git] / TODO
1 # Known Bugs:
2
3    - Bug ->go or ->visit causes actions which have Args or CaptureArgs called
4      twice when called via ->go or ->visit.
5
6      Test app: http://github.com/bobtfish/catalyst-app-bug-go_chain/tree/master
7
8 # Compatibility warnings to add:
9
10   - $self->config should warn as config should only ever be called as a
11     class method (TESTS).
12
13 # Proposed functionality / feature additions:
14
15 ## Log setup needs to be less lame
16
17 So Catalyst::Plugin::Log::* can die
18 in a fire. Having $c->log_class would be a good start. kane volunteered
19 to do some of this.
20
21 Simple example: Catalyst::Plugin::Log::Colorful should just be a
22 subclass of Catalyst::Log, no ::Plugin:: needed.
23
24 See also: Catalyst::Plugin::Log::Dispatch and
25 http://github.com/willert/catalyst-plugin-log4perl-simple/tree
26
27 # REFACTORING
28
29 ##  The horrible hack for plugin setup - replacing it:
30
31  * Have a look at the Devel::REPL BEFORE_PLUGIN stuff
32    I wonder if what we need is that combined with plugins-as-roles
33
34 ## App / ctx split:
35
36   NOTE - these are notes that t0m thought up after doing back compat for
37          catalyst_component_class, may be inaccurate, wrong or missing things
38          bug mst (at least) to correct before trying more than the first 2
39          steps. Please knock yourself out on the first two however :)
40
41   - Eliminate actions in MyApp from the main test suite
42   - Uncomment warning in C::C::register_action_methods, add tests it works
43     by mocking out the logging..
44   - Remove MyApp @ISA controller (ask metaclass if it has attributes, and if
45                                   so you need back compat :/)
46   - Make Catalyst::Context, move the per request stuff in there, handles from
47     main app class to delegate
48   - Make an instance of the app class which is a global variable
49   - Make new instance of the context class, not the app class per-request
50   - Remove the components as class data, move to instance data on the app
51     class (you probably have to do this for _all_ the class data, good luck!)
52   - Make it possible for users to spin up different instances of the app class
53     (with different config etc each)
54   - Profit! (Things like changing the complete app config per vhost, i.e.
55     writing a config loader / app class role which dispatches per vhost to
56     differently configured apps is piss easy)
57
58 ## GSOC
59
60 ### Next large steps:
61
62   - Moving setup_components etc into the container
63
64     - Move setup_components down into the container (setup_components becomes a one or two line method in Catalyst.pm)
65
66     - refactor / cleanup setup_component
67
68     - Move locate_components
69
70     - Move contents of setup_components
71
72   - Finished documentation for ::IOC parts.
73
74   - Creating service()-like sugar for component
75
76   - Test cases for extending the container in an application.
77     - Using the sugar added in the previous item
78     - Test when Model::Foo depends_on Model::Bar
79
80   - Allowing people to change component lifecycles
81
82      role Service::WithAcceptContext {}
83      role Service::WithCOMPONENT {}
84      class Service::CatalystComponent extends Service with (WithAcceptContext, WithCOMPONENT) {}
85
86     a) configure additional services in that container 
87         -  super simple container $default_container => as { more services };
88         class MyApp::Container extends Catalyst::Container {
89             use Bread::Board; # Or our own sugar?
90             method BUILD { container $self => as { 
91                     service model => ...; # some constructor injection to MyApp::Model or something
92                     container Model => as {
93                         component Foo => (dependencies => ['/model']); # As per default!
94                         component Bar => (dependencies => ['/model/Foo']); # Magic!
95                     };
96                     # Note - implementation of BB may need to be changed to support making sure existing 
97                     # services actually get overridden. not sure how the default container behaves when doing that
98                     # above code would build the constructor injection as it currently does,
99                     # defaulting to the class name in the right namespace as declared by the surrounding container
100                     # as well as adding using the catalyst-specific service class
101             } }
102         };
103     b) make component services depend on that, and 
104
105
106     c) ask for those 
107               services declared in a) outside of a web context
108        simple as well. $customised_container->fetch('service')->get # or whatever the api was
109
110 19:23 < andrewalker> edenc, when explaining to me how it should be, drafted this: https://gist.github.com/1098186
111 19:26 < edenc> I like the possibility of being able to provide a backwards-compatible structure which we can muck around with by configuring B::B
112 19:26 <@rafl> so, the request context clearly isn't a service
113 19:27 <@rafl> but that's ok. there's parametrised services
114 19:27 < edenc> yeah, that was a draft
115 19:27 <@rafl> the outer Foo service is pretty much what i'd expect Service::WithAcceptContext to do, except with a dependency on a context instead of a service parameter
116 19:32 <@rafl> actually having services for the pre-ACCEPT_CONTEXT bits is what i want to think about
117
118 ### To polish off
119
120   - Document current methods
121   - +    $class->container->get_sub_container('model')->make_single_default;
122 +    $class->container->get_sub_container('view')->make_single_default;
123
124 ### Known issues
125
126     - Broken $instance->expand_modules() in setup_components and figure
127       out later how to bring it back
128
129     - expand_component_module
130