TODO item done, whitespace fix
[catagits/Catalyst-Runtime.git] / TODO
diff --git a/TODO b/TODO
index 3dc15fd..2683e0c 100644 (file)
--- a/TODO
+++ b/TODO
-Pending patches:
-  - meta test for MX::Emulate::CAF needed by Catalyst::Plugin::Cache::Curried
-    http://code2.0beta.co.uk/moose/svnweb/index.cgi/moose/revision?rev=7036
-    (groditi)
+# Known Bugs:
 
-  - batman's chained patch / issue?
+   - Bug ->go or ->visit causes actions which have Args or CaptureArgs called
+     twice when called via ->go or ->visit.
 
-  - Adopt::NEXT
-     - updated docs with how it works (t0m/rafl)
+     Test app: http://github.com/bobtfish/catalyst-app-bug-go_chain/tree/master
 
-Known issues:  
+# Compatibility warnings to add:
 
-  - Fix t/caf_backcompat_plugin_accessor_override.t - complex case
-    to do with class data / instance data.. Maybe need better tests?
+  - $self->config should warn as config should only ever be called as a
+    class method (TESTS).
 
-Cleanups:
+# Proposed functionality / feature additions:
 
-  - Fix 'as soon as Class::MOP 0.67 + 1 is released 
-    Class::MOP::load_class($class) can be used instead' in Catalyst::Utils 
-    (t0m)
-    
-  - Provide an env var in Adopt::NEXT to just turn the warnings off globally?
+## Log setup needs to be less lame
 
-  - Catalyst-Plugin-Authorization-ACL, Can't locate object method "tree" 
-    via package "Catalyst::Dispatcher", fix the plugin as tree was never 
-    a public method.
+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.
 
-  - Catalyst-Model-Akismet, incorrectly inherits from 
-    Catalyst::Component::InstancePerContext, should compose as a role. 
-    Fix the module.
-    
-  - 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. (done already?)
+Simple example: Catalyst::Plugin::Log::Colorful should just be a
+subclass of Catalyst::Log, no ::Plugin:: needed.
 
-  - Comments marked /Moose TODO/i in Catalyst::Request re {_body} (t0m)
+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)
+## Capture arguments that the plack engine component was run with somewhere,
+    to more easily support custom args from scripts (e.g. Gitalist's
+    --git_dir)
 
-  - Find whatever in the test suite craps a file called GLOB(0xfoo) onto my 
-    disk and fix it. (Believed to be in the optional tests?) (t0m)
+## throw away the restarter and allow using the restarters Plack provides
 
-Documentation:
+## remove per-request state from the engine instance
 
-   - extends in components must be inside a BEGIN block.
+## be smarter about how we use PSGI - not every response needs to be delayed
+    and streaming
 
-   - How to write Moosified Catalyst components.
+#  The horrible hack for plugin setup - replacing it:
 
-   - Manual / Tutorial updates
+ * Have a look at the Devel::REPL BEFORE_PLUGIN stuff
+   I wonder if what we need is that combined with plugins-as-roles
 
-   - Fix the Roadmap to be less full of lies.
+#  PSGI
 
-Profiling:
+##  To do at release time
 
-  - vs 5.70 and optimisation as needed.
+  - Release psgi branch of Catalyst-Devel
+  - Release new Task::Catalyst
+  - Release 5.9 branch of Catalyst-Manual
+  - Release Catalyst::Engine::HTTP::Prefork with deprecation notice
+    + exit in Makefile.PL if Catalyst > 5.89 is installed.
 
-Back-compat investigation:
+##  Blockers
 
-  - Common engine test failures, look into and get tests into core.
+  * I've noticed a small difference with Catalyst::Test. The latest stable
+    version include two headers, 'host' and 'https'. They are missing from
+    this version - Pedro Melo on list
+    ^^ Cannot replicate this? Mailed back to ask for tests..
 
-  - CatalystX-Imports, Class::MOP doesn't consider anon subs in the symbol 
-    table as methods, tests + fix, or explanation and documentation?
-    (rafl & phaylon)
-  
-  - Run another round of repository smokes against latest 5.80 trunk, manually
-    go through all the things which are broken (t0m).
-    
-   - Issues with TWMC not being loaded when it used to be in 5.70 
-     (Bill Moseley)
-     
-   - Fix memory leaks (I already tried Devel::Leak::Object, but no joy).
+# App / ctx split:
+
+  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)
+
+## GSOC
+
+### Final steps for GSOC
+
+##### Things that work:
+
+    - the default container loads all components, calls ACCEPT_CONTEXT() when appropriate, and COMPONENT() when appropriate, behaving like current Catalyst does
+
+    - its possible to create a custom container, and override the components you want. Lifecycle, class, dependencies, all overridable.
+
+    - config files are loaded without Catalyst::Plugin::ConfigLoader
+
+    - per request life cycle somewhat works
+
+    - external modules are loaded just using a custom container, much like Catalyst::Model::Adaptor
+
+##### Things that don't work:
+
+    - expand_component_module
+
+    - sugar is still not completely implemented
+
+    - Some back compat
+        - wrappers around setup_component, setup_components, locate_components in Catalyst.pm
+        - $instance->expand_modules
+        - search_extra
+        - Crazy tests for things such as:
+           sub COMPONENT {
+             ...
+             *${appclass}::Model::TopLevel::GENERATED::ACCEPT_CONTEXT = sub { ... };
+             ...
+           }
 
-Tests:
+##### Need planning, have questions:
 
-  - Moosified test application?
+    - per request life cycle
+
+    - sugar - we should discuss the syntax with rafl and edenc
+
+    - when / when not COMPONENT should be called
+
+    - locate_components service vs setup_components method
+      - can we be more lazy?
+      - should setup_components be a service that things like the ->component lookup
+        can depend on?
+
+    - There are a few more FIXMEs, idk if any relevant here
+
+### Next steps - planned:
+
+  - some imports need to get the importing package in Catalyst::IOC
+    - done - needs testing
+
+  - Back compat for Catalyst.pm moved methods (locate_components)
+    - done - needs testing
+
+  - Test custom container
+    - writing some tests which verify that the models you think should be
+      there are there, and that they received their dependencies as arguments
+    - i.e. Model::Bar should get params { foo => $model_foo } when being
+      constructed, etc
+    - Need to test that if you have a standard component Frotz
+      and a customized component Fnar, and Fnar depends on Frotz
+    - And yeah, some tests that the customised components actually work via
+      $c->model('Foo'), and that COMPONENT is called (or not called)
+      as appropiate and that ACCEPT_CONTEXT is called (or not) as appropriate
+
+### Next steps - less planned:
+
+  - make ACCEPT_CONTEXT and COMPONENT optional in Catalyst::IOC::BlockInjection and Catalyst::IOC::ConstructorInjection
+    - Create COMPONENTSingleton life cycle
+
+  - 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
+    - Test for component Foo => ( lifecycle => 'Singleton', class => 'My::External::Class', dependencies => { config => depends_on("config") } )
+    - Fix ^^ so that you can get your component's namespaced config nicely.
+
+  - Tests for using the container outside of Catalyst
+    - Custom container which adds some (very simple) services which are initialized from
+      the application config file (note plain services, not components)
+    - Depend on (and test) these inside Catalyst
+    - Test loading container outside Catalyst, and these services working
+    - Test Catalyst / MyApp is not loaded
+
+#### 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
+                # Catalyst::Model::Adaptor example
+                conponent Fnar => ( lifecycle => 'Singleton', class => 'My::External::Class', dependencies => { config => depends_on('config')} );
+                #                                                                                               ^^ FIXME - gets whole config, not Model::Foo
+                #                                                                                                  There should be a 'nice' way to get the 'standard' config
+            };                    
+            # 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;