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 ### Final steps for GSOC
  61
  62 ##### Things that work:
  63
  64 ##### Things that don't work:
  65
  66 ##### Need planning, have questions:
  67
  68 ### Next steps - planned:
  69
  70   - some imports need to get the importing package in Catalyst::IOC
  71
  72   - test values directly instead of serializing them over http in t/lib/TestCustomContainer.pm
  73
  74   - 16:01 < shadowpaste> "t0m" at 217.168.150.38 pasted "more explicit? thoughts?" (13 lines) at http://paste.scsys.co.uk/131520
  75
  76   - make ACCEPT_CONTEXT and COMPONENT optional in Catalyst::IOC::BlockInjection and Catalyst::IOC::ConstructorInjection
  77     - Create COMPONENTSingleton life cycle
  78
  79   - Back compat for Catalyst.pm moved methods (locate_components)
  80
  81   - Test custom container
  82     - writing some tests which verify that the models you think should be
  83       there are there, and that they received their dependencies as arguments
  84     - i.e. Model::Bar should get params { foo => $model_foo } when being
  85       constructed, etc
  86     - Need to test that if you have a standard component Frotz
  87       and a customized component Fnar, and Fnar depends on Frotz
  88     - And yeah, some tests that the customised components actually work via
  89       $c->model('Foo'), and that COMPONENT is called (or not called)
  90       as appropiate and that ACCEPT_CONTEXT is called (or not) as appropriate
  91
  92 ### Next steps - less planned:
  93
  94   - Creating service()-like sugar for component
  95
  96   - Test cases for extending the container in an application.
  97     - Using the sugar added in the previous item
  98     - Test when Model::Foo depends_on Model::Bar
  99     - Test for component Foo => ( lifecycle => 'Singleton', class => 'My::External::Class', dependencies => { config => depends_on("config") } )
 100     - Fix ^^ so that you can get your component's namespaced config nicely.
 101
 102   - Tests for using the container outside of Catalyst
 103     - Custom container which adds some (very simple) services which are initialized from
 104       the application config file (note plain services, not components)
 105     - Depend on (and test) these inside Catalyst
 106     - Test loading container outside Catalyst, and these services working
 107     - Test Catalyst / MyApp is not loaded
 108
 109 #### Extending my app, notes
 110
 111 Basically try to implement something like this (starting out without the sugar!), and see how it breaks
 112 and what needs to be done to fix it!
 113
 114 ##### Eventual syntax
 115
 116 package MyApp::Container;
 117 use Catalyst::IOC;
 118
 119     container $self, as {
 120             container model => as {
 121                 component Foo => (); # As per default!
 122                 component Bar => (dependencies => ['/model/Foo']); # Magic!
 123                 component Baz => ( lifecycle => 'InstancePerContext );
 124                 component Quux => ( lifecycle => 'Singleton' ); # ACCEPT_CONTEXT not called
 125                 # Catalyst::Model::Adaptor example
 126                 conponent Fnar => ( lifecycle => 'Singleton', class => 'My::External::Class', dependencies => { config => depends_on('config')} );
 127                 #                                                                                               ^^ FIXME - gets whole config, not Model::Foo
 128                 #                                                                                                  There should be a 'nice' way to get the 'standard' config
 129             };
 130             # Note - implementation of BB may need to be changed to support making sure existing
 131             # services actually get overridden. not sure how the default container behaves when doing that
 132             # above code would build the constructor injection as it currently does,
 133             # defaulting to the class name in the right namespace as declared by the surrounding container
 134             # as well as adding using the catalyst-specific service class
 135     };
 136
 137 1;
 138
 139 ### To polish off / t0m review
 140
 141     locate_components service vs setup_components method
 142       - can we be more lazy?
 143       - should setup_components be a service that things like the ->component lookup
 144         can depend on?
 145
 146 ### Known issues
 147
 148     - Broken $instance->expand_modules() in setup_components and figure
 149       out later how to bring it back
 150
 151     - expand_component_module
 152
 153     - People wrapping locate_components in Catalyst.pm