try to make a summary of some sort
[catagits/Catalyst-Runtime.git] / TODO
diff --git a/TODO b/TODO
index 3f7cb08..ebf0b19 100644 (file)
--- a/TODO
+++ b/TODO
-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 :)
 
-       - How to write Moosified Catalyst components.
+  - 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)
 
-   - Fix the Roadmap to be less full of lies.
+## GSOC
 
-   - Catalyst/Upgrading.pod
+### Next large steps:
 
-Reported bugs:
+  - Moving setup_components etc into the container
 
-   - Issues with TWMC not being loaded when it used to be in 5.70 
-     (Bill Moseley)
+    - Move setup_components down into the container (setup_components becomes a one or two line method in Catalyst.pm)
 
-Profiling:
+    - refactor / cleanup setup_component
 
-  - vs 5.70 and optimisation as needed.
+    - Move locate_components
 
-Tests:
+    - Move contents of setup_components
 
-  - Moosified test application?
-  
-  - Test & document warnings from plugin method on Catalyst
+  - Finished documentation for ::IOC parts.
+
+  - 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
+
+  - Allowing people to change component lifecycles
+
+     role Service::WithAcceptContext {}
+     role Service::WithCOMPONENT {}
+     class Service::CatalystComponent extends Service with (WithAcceptContext, WithCOMPONENT) {}
+
+    a) configure additional services in that container 
+        -  super simple container $default_container => as { more services };
+        class MyApp::Container extends Catalyst::Container {
+            use Bread::Board; # Or our own sugar?
+            method BUILD { container $self => as { 
+                    service model => ...; # some constructor injection to MyApp::Model or something
+                    container Model => as {
+                        component Foo => (dependencies => ['/model']); # As per default!
+                        component Bar => (dependencies => ['/model/Foo']); # Magic!
+                    };
+                    # 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
+            } }
+        };
+    b) make component services depend on that, and 
+
+
+    c) ask for those 
+              services declared in a) outside of a web context
+       simple as well. $customised_container->fetch('service')->get # or whatever the api was
+
+19:23 < andrewalker> edenc, when explaining to me how it should be, drafted this: https://gist.github.com/1098186
+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
+19:26 <@rafl> so, the request context clearly isn't a service
+19:27 <@rafl> but that's ok. there's parametrised services
+19:27 < edenc> yeah, that was a draft
+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
+19:32 <@rafl> actually having services for the pre-ACCEPT_CONTEXT bits is what i want to think about
+
+### To polish off
+
+  - Document current methods
+  - +    $class->container->get_sub_container('model')->make_single_default;
++    $class->container->get_sub_container('view')->make_single_default;
+
+### Known issues
+
+    - Broken $instance->expand_modules() in setup_components and figure
+      out later how to bring it back
+
+    - expand_component_module