Large TODO update
[catagits/Catalyst-Runtime.git] / TODO
diff --git a/TODO b/TODO
index 8715e8d..2dd12f7 100644 (file)
--- a/TODO
+++ b/TODO
-Back-compat investigation:
-
-  - Get engines tested:
-    - Catalyst-Engine-Zeus
-    - Catalyst-Engine-XMPP2
-    - Catalyst-Engine-HTTPEngine
-    - Catalyst-Engine-HTTP-Prefork
-    - Catalyst-Engine-SCGI
-    - Catalyst-Engine-Wx
-
-Known issues:
-     - CatalystX-Imports, Class::MOP doesn't consider anon subs in the symbol 
-       table as methods, tests + fix, or explanation and documentation?
-       (rafl & phaylon)
-     - Catalyst-Log-Log4perl Deep recursion on subroutine "MockApp::setup" 
-       (rafl)
-     
-     - Catalyst-Plugin-Cache dies due to mk_accessors('meta')
-     
-     - CatalystX-CRUD and CatalystX-CRUD-ModelAdapter-DBIC
-       fail tests against 5.80 (karpet)
-
-     - 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..
-         
-      - Catalyst::Component::ACCEPT_CONTEXT - Having a COMPONENT method
-        after Catalyst::Component::COMPONENT used to work, and will still
-        delegate (and warn), but then NEXT::COMPONENT will not dtrt if you
-        re-dispatch again (NEXT would seemingly go back to the start?)..
-        See Reaction test suite for example of this happening.
-        FIXME - Also don't think this correctly delegates - $c appears 
-        missing.
-
-  - Fix memory leaks (I already tried Devel::Leak::Object, but no joy).
-
-  -  In 5.70, you can have a component which doesn't inherit from ::Component, 
-     and has no new method, and it'll do the right thing for you. We should 
-     still support that, but warn for/deprecate it so it can go for 5.9X...
-     This obviously needs better tests :/
-
-Cleanups:
-
-  - Allow turning deprecated warnings off with use Catalyst 
-    qw/-NoDeprecationWarnings/
-
-  - 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.
-
-  - 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)
-
-  - 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)
-
-Documentation:
-
-   - extends in components with attributes must be inside a BEGIN block.
-
-   - How to write Moosified Catalyst components.
-
-   - Manual / Tutorial updates
-
-   - Fix the Roadmap to be less full of lies.
-
-   -  With 5.7 people did extends qw/Moose::Object Catalyst::Component/, now 
-      Catalyst::Component isa Moose::Object so now isa doesn't linearize 
-      anymore, docs of what doesn't work and why (rafl)
-      
-   - Document all other known failure cases / upgrade issues.
-   
-   - Tidy up / finish off incompatibility warnings etc.
-
-Reported bugs:
-
-   - Issues with TWMC not being loaded when it used to be in 5.70 
-     (Bill Moseley)
-
-Profiling:
-
-  - vs 5.70 and optimisation as needed.
-
-Tests:
-
-  - Moosified test application?
-
-  - Test warning from back-compat methods in Catalyst::Dispatcher
-  
-  - Test warnings from plugin method on Catalyst
+# Known Bugs:
+
+   - Bug ->go or ->visit causes actions which have Args or CaptureArgs called
+     twice when called via ->go or ->visit.
+
+     Test app: http://github.com/bobtfish/catalyst-app-bug-go_chain/tree/master
+
+   - Bricas' Exception blog post
+
+     http://bricas.vox.com/library/post/catalyst-exceptionclass.html
+
+     Broken by recent exception refactoring
+
+# Compatibility warnings to add:
+
+  - $self->config should warn as config should only ever be called as a
+    class method.
+
+# Proposed functionality / feature additions:
+
+## 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.
+
+See also: Catalyst::Plugin::Log::Dispatch and
+http://github.com/willert/catalyst-plugin-log4perl-simple/tree
+
+# REFACTORING
+
+##  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:
+
+  NOTE - these are notes that t0m thought up after doing back compat for
+         _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)