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 ##  The horrible hack for plugin setup - replacing it:
  30
  31  * Have a look at the Devel::REPL BEFORE_PLUGIN stuff
  32    I wonder if what we need is that combined with plugins-as-roles
  33
  34 ## App / ctx split:
  35
  36   NOTE - these are notes that t0m thought up after doing back compat for
  37          catalyst_component_class, may be inaccurate, wrong or missing things
  38          bug mst (at least) to correct before trying more than the first 2
  39          steps. Please knock yourself out on the first two however :)
  40
  41   - Eliminate actions in MyApp from the main test suite
  42   - Uncomment warning in C::C::register_action_methods, add tests it works
  43     by mocking out the logging..
  44   - Remove MyApp @ISA controller (ask metaclass if it has attributes, and if
  45                                   so you need back compat :/)
  46   - Make Catalyst::Context, move the per request stuff in there, handles from
  47     main app class to delegate
  48   - Make an instance of the app class which is a global variable
  49   - Make new instance of the context class, not the app class per-request
  50   - Remove the components as class data, move to instance data on the app
  51     class (you probably have to do this for _all_ the class data, good luck!)
  52   - Make it possible for users to spin up different instances of the app class
  53     (with different config etc each)
  54   - Profit! (Things like changing the complete app config per vhost, i.e.
  55     writing a config loader / app class role which dispatches per vhost to
  56     differently configured apps is piss easy)
  57
  58 ## GSOC
  59
  60 ### Next steps - less planned:
  61
  62   - Creating service()-like sugar for component
  63
  64   - Test cases for extending the container in an application.
  65     - Using the sugar added in the previous item
  66     - Test when Model::Foo depends_on Model::Bar
  67     - Test for component Foo => ( lifecycle => 'Singleton', class => 'My::External::Class', dependencies => { config => depends_on("config") } )
  68     - Fix ^^ so that you can get your component's namespaced config nicely.
  69
  70   - Tests for using the container outside of Catalyst
  71     - Custom container which adds some (very simple) services which are initialized from
  72       the application config file (note plain services, not components)
  73     - Depend on (and test) these inside Catalyst
  74     - Test loading container outside Catalyst, and these services working
  75     - Test Catalyst / MyApp is not loaded
  76
  77 #### Extending my app, notes
  78
  79 Basically try to implement something like this (starting out without the sugar!), and see how it breaks
  80 and what needs to be done to fix it!
  81
  82 ##### Eventual syntax
  83
  84 package MyApp::Container;
  85 use Catalyst::IOC;
  86
  87     container $self, as {
  88             container model => as {
  89                 component Foo => (); # As per default!
  90                 component Bar => (dependencies => ['/model/Foo']); # Magic!
  91                 component Baz => ( lifecycle => 'InstancePerContext );
  92                 component Quux => ( lifecycle => 'Singleton' ); # ACCEPT_CONTEXT not called
  93                 # Catalyst::Model::Adaptor example
  94                 conponent Fnar => ( lifecycle => 'Singleton', class => 'My::External::Class', dependencies => { config => depends_on('config')} );
  95                 #                                                                                               ^^ FIXME - gets whole config, not Model::Foo
  96                 #                                                                                                  There should be a 'nice' way to get the 'standard' config
  97             };
  98             # Note - implementation of BB may need to be changed to support making sure existing
  99             # services actually get overridden. not sure how the default container behaves when doing that
 100             # above code would build the constructor injection as it currently does,
 101             # defaulting to the class name in the right namespace as declared by the surrounding container
 102             # as well as adding using the catalyst-specific service class
 103     };
 104
 105 1;
 106
 107 ##### To start with
 108
 109 package MyApp::Container;
 110 use Moose;
 111
 112 extends 'Catalyst::Container;
 113
 114 after BUILD => sub {
 115     my $self = shift;
 116     my $model_container = $self->get_sub_container('model');
 117     my $service = Catalyst::IOC::ConstructorInjection->new(
 118         name      => 'Baz',
 119         class     => 'MyApp::Model::Baz',
 120         dependencies => [
 121             depends_on( '/application_name' ),
 122             depends_on( '/config' ),
 123             depends_on( '/model/Foo' ),
 124         ],
 125         lifecycle => 'InstancePerContext',
 126     );
 127     $model_container->add_service( 'Foo', $service );
 128 };
 129
 130 ### To polish off / t0m review
 131
 132     locate_components service vs setup_components method
 133       - can we be more lazy?
 134       - should setup_components be a service that things like the ->component lookup
 135         can depend on?
 136
 137     -    my $accept_context_args = $self->param('accept_context_args');
 138     +    my $accept_context_args = $params{accept_context_args};
 139     ^^ This (may be) wrong! I am thinking the service should be allowed to mangle the
 140        accept_context args, no?
 141        Without this change, the user could make a custom service which mangled the param, and use
 142        Catalyst/IOC/Service/WithAcceptContext.pm, with this change, that module will always see the
 143        un-mangled version?? However, without this change, shit doesn't work...
 144
 145 ### Known issues
 146
 147     - Broken $instance->expand_modules() in setup_components and figure
 148       out later how to bring it back
 149
 150     - expand_component_module
 151
 152     - People wrapping locate_components in Catalyst.pm