Hit the docs some
[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 ##  PSGI
30
31 ###  Blockers
32
33   * Add some tests for Catalyst::Test::local_request
34   * Docs
35   * Test all the options work on all of the scripts
36   * Test (and fix if needed) Engine::Stomp and ::Wx
37   * Document how to use your own .psgi
38   * Document migration for setting engine in setup
39   * Document migration for setting engine in $ENV
40   * Document what to do if you're a Prefork person
41   * Test Catalyst::Engine::PSGI still works?
42
43 ###  Nice to have
44
45   * Do we need to do something else about middleware than let the user provide a .psgi?
46     What about the reverse proxy middleware
47   * Do we generate a .psgi by default?
48   * throw out Catalyst::Test's remote_request in favour of
49     Plack::Test::ExternalServer
50   * make sure we're running under a server that support psgi.streaming - maybe
51     just load the BufferedWrite middleware, although that might break things
52     relying on ->write doing an unbuffered write
53   * throw away the restarter and allow using the restarters Plack provides
54   * remove per-request state from the engine instance
55   * be smarter about how we use PSGI - not every response needs to be delayed
56     and streaming
57
58 ##  The horrible hack for plugin setup - replacing it:
59
60  * Have a look at the Devel::REPL BEFORE_PLUGIN stuff
61    I wonder if what we need is that combined with plugins-as-roles
62
63 ## App / ctx split:
64
65   NOTE - these are notes that t0m thought up after doing back compat for
66          catalyst_component_class, may be inaccurate, wrong or missing things
67          bug mst (at least) to correct before trying more than the first 2
68          steps. Please knock yourself out on the first two however :)
69
70   - Eliminate actions in MyApp from the main test suite
71   - Uncomment warning in C::C::register_action_methods, add tests it works
72     by mocking out the logging..
73   - Remove MyApp @ISA controller (ask metaclass if it has attributes, and if
74                                   so you need back compat :/)
75   - Make Catalyst::Context, move the per request stuff in there, handles from
76     main app class to delegate
77   - Make an instance of the app class which is a global variable
78   - Make new instance of the context class, not the app class per-request
79   - Remove the components as class data, move to instance data on the app
80     class (you probably have to do this for _all_ the class data, good luck!)
81   - Make it possible for users to spin up different instances of the app class
82     (with different config etc each)
83   - Profit! (Things like changing the complete app config per vhost, i.e.
84     writing a config loader / app class role which dispatches per vhost to
85     differently configured apps is piss easy)