From: John Napiorkowski Date: Tue, 19 May 2015 01:23:21 +0000 (-0400) Subject: more flexible declare of class traits X-Git-Tag: 5.90092~2 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=7dac038c9d0d69aefa96bde4a1d574d0f983c684 more flexible declare of class traits --- diff --git a/Changes b/Changes index fe57228..49d101d 100644 --- a/Changes +++ b/Changes @@ -1,11 +1,15 @@ # This file documents the revision history for Perl extension Catalyst. -5.90091 - 2014-05-08 +5.90092 - 2015-05-XX + - Allows you to use a namespace suffix for request, response and stats + class traits. Docs and tests for this. + +5.90091 - 2015-05-08 - Fixed a bug where if an injected component expanded sub components, those sub components would not show up in the startup debug dev console ( even though they were actually created). -5.90090 - 2014-04-29 +5.90090 - 2015-04-29 - Updated some documention in Catalyst::Request::Upload to clarify behavior that RT ticket reported as confusing or unexpected - Merged all changes from 5.90089_XXX development cycle. diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 016ef2d..a3a0e39 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -82,8 +82,18 @@ sub _build_request_constructor_args { sub composed_request_class { my $class = shift; my @traits = (@{$class->request_class_traits||[]}, @{$class->config->{request_class_traits}||[]}); + + # For each trait listed, figure out what the namespace is. First we try the $trait + # as it is in the config. Then try $MyApp::TraitFor::Request:$trait. Last we try + # Catalyst::TraitFor::Request::$trait. If none load, throw error. + + my $trait_ns = 'TraitFor::Request'; + my @normalized_traits = map { + Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_) + } @traits; + return $class->_composed_request_class || - $class->_composed_request_class(Moose::Util::with_traits($class->request_class, @traits)); + $class->_composed_request_class(Moose::Util::with_traits($class->request_class, @normalized_traits)); } has response => ( @@ -106,8 +116,14 @@ sub _build_response_constructor_args { sub composed_response_class { my $class = shift; my @traits = (@{$class->response_class_traits||[]}, @{$class->config->{response_class_traits}||[]}); + + my $trait_ns = 'TraitFor::Response'; + my @normalized_traits = map { + Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_) + } @traits; + return $class->_composed_response_class || - $class->_composed_response_class(Moose::Util::with_traits($class->response_class, @traits)); + $class->_composed_response_class(Moose::Util::with_traits($class->response_class, @normalized_traits)); } has namespace => (is => 'rw'); @@ -132,7 +148,8 @@ our $RECURSION = 1000; our $DETACH = Catalyst::Exception::Detach->new; our $GO = Catalyst::Exception::Go->new; -#I imagine that very few of these really need to be class variables. if any. +#I imagine that very few of these really +#need to be class variables. if any. #maybe we should just make them attributes with a default? __PACKAGE__->mk_classdata($_) for qw/components arguments dispatcher engine log dispatcher_class @@ -150,14 +167,20 @@ __PACKAGE__->stats_class('Catalyst::Stats'); sub composed_stats_class { my $class = shift; my @traits = (@{$class->stats_class_traits||[]}, @{$class->config->{stats_class_traits}||[]}); + + my $trait_ns = 'TraitFor::Stats'; + my @normalized_traits = map { + Class::Load::load_first_existing_class($_, $class.'::'.$trait_ns.'::'. $_, 'Catalyst::'.$trait_ns.'::'.$_) + } @traits; + return $class->_composed_stats_class || - $class->_composed_stats_class(Moose::Util::with_traits($class->stats_class, @traits)); + $class->_composed_stats_class(Moose::Util::with_traits($class->stats_class, @normalized_traits)); } __PACKAGE__->_encode_check(Encode::FB_CROAK | Encode::LEAVE_SRC); # Remember to update this in Catalyst::Runtime as well! -our $VERSION = '5.90091'; +our $VERSION = '5.90092'; $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases sub import { @@ -2721,8 +2744,27 @@ Returns or sets the request class. Defaults to L. =head2 $app->request_class_traits -An arrayref of Ls which are applied to the request class. +An arrayref of Ls which are applied to the request class. You can +name the full namespace of the role, or a namespace suffix, which will then +be tried against the following standard namespace prefixes. + $MyApp::TraitFor::Request::$trait_suffix + Catalyst::TraitFor::Request::$trait_suffix + +So for example if you set: + + MyApp->request_class_traits(['Foo']); + +We try each possible role in turn (and throw an error if none load) + + Foo + MyApp::TraitFor::Request::Foo + Catalyst::TraitFor::Request::Foo + +The namespace part 'TraitFor::Request' was choosen to assist in backwards +compatibility with L which previously provided +these features in a stand alone package. + =head2 $app->composed_request_class This is the request class which has been composed with any request_class_traits. @@ -2733,7 +2775,27 @@ Returns or sets the response class. Defaults to L. =head2 $app->response_class_traits -An arrayref of Ls which are applied to the response class. +An arrayref of Ls which are applied to the response class. You can +name the full namespace of the role, or a namespace suffix, which will then +be tried against the following standard namespace prefixes. + + $MyApp::TraitFor::Response::$trait_suffix + Catalyst::TraitFor::Response::$trait_suffix + +So for example if you set: + + MyApp->response_class_traits(['Foo']); + +We try each possible role in turn (and throw an error if none load) + + Foo + MyApp::TraitFor::Response::Foo + Catalyst::TraitFor::Responset::Foo + +The namespace part 'TraitFor::Response' was choosen to assist in backwards +compatibility with L which previously provided +these features in a stand alone package. + =head2 $app->composed_response_class @@ -3898,7 +3960,26 @@ A arrayref of Ls that are applied to the stats_class before creatin =head2 $app->composed_stats_class -this is the stats_class composed with any 'stats_class_traits'. +this is the stats_class composed with any 'stats_class_traits'. You can +name the full namespace of the role, or a namespace suffix, which will then +be tried against the following standard namespace prefixes. + + $MyApp::TraitFor::Stats::$trait_suffix + Catalyst::TraitFor::Stats::$trait_suffix + +So for example if you set: + + MyApp->stats_class_traits(['Foo']); + +We try each possible role in turn (and throw an error if none load) + + Foo + MyApp::TraitFor::Stats::Foo + Catalyst::TraitFor::Stats::Foo + +The namespace part 'TraitFor::Stats' was choosen to assist in backwards +compatibility with L which previously provided +these features in a stand alone package. =head2 $c->use_stats diff --git a/lib/Catalyst/Runtime.pm b/lib/Catalyst/Runtime.pm index b620293..7187a39 100644 --- a/lib/Catalyst/Runtime.pm +++ b/lib/Catalyst/Runtime.pm @@ -7,7 +7,7 @@ BEGIN { require 5.008003; } # Remember to update this in Catalyst as well! -our $VERSION = '5.90091'; +our $VERSION = '5.90092'; $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases =head1 NAME diff --git a/t/class_traits.t b/t/class_traits.t index f796323..8c65b38 100644 --- a/t/class_traits.t +++ b/t/class_traits.t @@ -9,6 +9,26 @@ BEGIN { sub a { 'a' } sub b { 'b' } + + package Catalyst::TraitFor::Request::Foo; + use Moose::Role; + + sub c { 'c' } + + package TestApp::TraitFor::Request::Bar; + use Moose::Role; + + sub d { 'd' } + + package Catalyst::TraitFor::Response::Foo; + use Moose::Role; + + sub c { 'c' } + + package TestApp::TraitFor::Response::Bar; + use Moose::Role; + + sub d { 'd' } } { @@ -16,8 +36,8 @@ BEGIN { use Catalyst; - __PACKAGE__->request_class_traits([qw/TestRole/]); - __PACKAGE__->response_class_traits([qw/TestRole/]); + __PACKAGE__->request_class_traits([qw/TestRole Foo Bar/]); + __PACKAGE__->response_class_traits([qw/TestRole Foo Bar/]); __PACKAGE__->stats_class_traits([qw/TestRole/]); __PACKAGE__->setup; @@ -38,7 +58,11 @@ my ($res, $c) = ctx_request '/'; is $c->req->a, 'a'; is $c->req->b, 'b'; +is $c->req->c, 'c'; +is $c->req->d, 'd'; is $c->res->a, 'a'; is $c->res->b, 'b'; +is $c->res->c, 'c'; +is $c->res->d, 'd'; done_testing;