update TODO, next planned steps
[catagits/Catalyst-Runtime.git] / TODO
diff --git a/TODO b/TODO
index 38b2d1d..9979345 100644 (file)
--- a/TODO
+++ b/TODO
@@ -57,33 +57,23 @@ http://github.com/willert/catalyst-plugin-log4perl-simple/tree
 
 ## GSOC
 
-### Next large steps, planned:
-
-For all components that have been discovered, in whatever way, we create a service:
- - that's a catalyst component service
- - which is basically just a constructor injection
- - except the constructor name is COMPONENT
- - and we're "implicitly" passing along some constructor args
- - Lifecycle => Singleton
-
- - Fix B::B so that Service::WithParametrs' parameters attribute has a builder
- - Fix ConstructorInjection so that default parameters are supplied (for accept_context_args)
- - Fix ConstructorInjection's 'suffix' - should be called 'config_key' or something, and
-   should be an attribute on the service (as it never changes), rather than a parameter
-   to the service 
-
- - We make a 'components' sub container in the main container.
-   - This gets the ConstructorInjection COMPONENT services, as model_Foo.
-   - Lifecycle of these services is Singleton
-   - This simplifies the code for MyApp->components, as it need only list one sub-container
-
- - We create a second service (depending on the first one) for ACCEPT_CONTEXT
-   - This has a custom service which calls ACCEPT_CONTEXT when the instance is fetched
-   - Not Singleton lifecycle
-   Note - ACCEPT_CONTEXT can be called on app values - if you have a Model::Foo, with an ACCEPT_CONTEXT
-   and you call MyApp->model('Foo') then ACCEPT_CONTEXT gets invoked with a $c of 'MyApp' (this is not\
-   the normal case, but we need to preserve for compat)
+### Next steps - planned:
+
+  - 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
+
+  - Kill flush_request_services
+    - we're already passing $ctx in when we locate services so the ::Request
+      lifecycle can just stash the object in, or retrieve the object from the
+      stash
 
 ### Next steps - less planned:
 
@@ -92,7 +82,15 @@ For all components that have been discovered, in whatever way, we create a servi
   - 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
 
@@ -104,12 +102,16 @@ and what needs to be done to fix it!
 package MyApp::Container;
 use Catalyst::IOC;
     
-    container $self, as { 
+    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
@@ -145,32 +147,18 @@ after BUILD => sub {
 
 ### To polish off / t0m review
 
-  - +    $class->container->get_sub_container('model')->make_single_default;
-    +    $class->container->get_sub_container('view')->make_single_default;
+    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?
 
-    get_components_names_types
-
-    locate_components
-
-    +# FIXME - t0m, how do you feel about this name?
-    +# also, do you think I should draw it here, or just return the data structure?
-    +sub get_components_names_types {
-
-    +Same as L<build_model_subcontainer>, but for controllers. The difference is
-    +that there is no ACCEPT_CONTEXT for controllers.
-    ^^ This is wrong!!
-    
     -    my $accept_context_args = $self->param('accept_context_args');
     +    my $accept_context_args = $params{accept_context_args};
-    ^^ This is wrong! The service should be allowed to mangle the accept_context args, no?
+    ^^ This (may be) wrong! I am thinking the service should be allowed to mangle the 
+       accept_context args, no?
        Without this change, the user could make a custom service which mangled the param, and use 
        Catalyst/IOC/Service/WithAcceptContext.pm, with this change, that module will always see the
-       un-mangled version??
-
-    accept_context_args - where does this come from?
-    
-    +    $purity = $purity // 1;
-    ^^ perl 5.10 only
+       un-mangled version?? However, without this change, shit doesn't work...
 
 ### Known issues
 
@@ -179,3 +167,4 @@ after BUILD => sub {
 
     - expand_component_module
 
+    - People wrapping locate_components in Catalyst.pm