[catagits/Catalyst-Runtime.git] / t / lib / TestApp / Controller / Action / Chained.pm

package TestApp::Controller::Action::Chained;

use strict;
use warnings;

use HTML::Entities;

use base qw/Catalyst::Controller/;

sub begin :Private { }

#
#   TODO
#   :Chained('') means what?
#

#
#   Simple parent/child action test
#
sub foo  :PathPart('chained/foo')  :CaptureArgs(1) :Chained('/') {
    my ( $self, $c, @args ) = @_;
    die "missing argument" unless @args;
    die "more than 1 argument: got @args" if @args > 1;
}
sub endpoint  :PathPart('end')  :Chained('/action/chained/foo')  :Args(1) { }

#
#   Parent/child test with two args each
#
sub foo2 :PathPart('chained/foo2') :CaptureArgs(2) :Chained('/') { }
sub endpoint2 :PathPart('end2') :Chained('/action/chained/foo2') :Args(2) { }

#
#   Relative specification of parent action
#
sub bar :PathPart('chained/bar') :Chained('/') :CaptureArgs(0) { }
sub finale :PathPart('') :Chained('bar') :Args { }

#
#   three chain with concurrent endpoints
#
sub one   :PathPart('chained/one') :Chained('/')                   :CaptureArgs(1) { }
sub two   :PathPart('two')         :Chained('/action/chained/one') :CaptureArgs(2) { }
sub three_end :PathPart('three')       :Chained('two') :Args(3) { }
sub one_end   :PathPart('chained/one') :Chained('/')   :Args(1) { }
sub two_end   :PathPart('two')         :Chained('one') :Args(2) { }

#
#   Dispatch on number of arguments
#
sub multi1 :PathPart('chained/multi') :Chained('/') :Args(1) { }
sub multi2 :PathPart('chained/multi') :Chained('/') :Args(2) { }

#
#   Roots in an action defined in a higher controller
#
sub higher_root :PathPart('bar') :Chained('/action/chained/foo/higher_root') :Args(1) { }

#
#   Controller -> subcontroller -> controller
#
sub pcp1 :PathPart('chained/pcp1')  :Chained('/')                        :CaptureArgs(1) { }
sub pcp3 :Chained('/action/chained/foo/pcp2') :Args(1)     { }

#
#   Dispatch on capture number
#
sub multi_cap1 :PathPart('chained/multi_cap') :Chained('/') :CaptureArgs(1) { }
sub multi_cap2 :PathPart('chained/multi_cap') :Chained('/') :CaptureArgs(2) { }
sub multi_cap_end1 :PathPart('baz') :Chained('multi_cap1') :Args(0) { }
sub multi_cap_end2 :PathPart('baz') :Chained('multi_cap2') :Args(0) { }

#
#   Priority: Slurpy args vs. chained actions
#
sub priority_a1 :PathPart('chained/priority_a') :Chained('/') :Args { }
sub priority_a2 :PathPart('chained/priority_a') :Chained('/') :CaptureArgs(1) { }
sub priority_a2_end :PathPart('end') :Chained('priority_a2') :Args(1) { }


#
#   Priority: Fixed args vs. chained actions
#
sub priority_b1 :PathPart('chained/priority_b') :Chained('/') :Args(3) { }
sub priority_b2 :PathPart('chained/priority_b') :Chained('/') :CaptureArgs(1) { }
sub priority_b2_end :PathPart('end') :Chained('priority_b2') :Args(1) { }

#
#   Priority: With no Args()
#
sub priority_c1 :PathPart('chained/priority_c') :Chained('/') :CaptureArgs(1) { }
sub priority_c2 :PathPart('') :Chained('priority_c1') { }
sub priority_c2_xyz :PathPart('xyz') :Chained('priority_c1')  { }


#
#   Optional specification of :Args in endpoint
#
sub opt_args :PathPart('chained/opt_args') :Chained('/') { }

#
#   Optional PathPart test -> /chained/optpp/*/opt_pathpart/*
#
sub opt_pp_start :Chained('/') :PathPart('chained/optpp') :CaptureArgs(1) { }
sub opt_pathpart :Chained('opt_pp_start') :Args(1) { }

#
#   Optional Args *and* PathPart -> /chained/optall/*/oa/...
#
sub opt_all_start :Chained('/') :PathPart('chained/optall') :CaptureArgs(1) { }
sub oa :Chained('opt_all_start') { }

#
#   :Chained is the same as :Chained('/')
#
sub rootdef :Chained :PathPart('chained/rootdef') :Args(1) { }

#
#   the ParentChain controller chains to this action by
#   specifying :Chained('.')
#
sub parentchain :Chained('/') :PathPart('chained/parentchain') :CaptureArgs(1) { }

#
#   This is just for a test that a loose end is not callable
#
sub loose :Chained :PathPart('chained/loose') CaptureArgs(1) { }

#
#   Forwarding out of the middle of a chain.
#
sub chain_fw_a :Chained :PathPart('chained/chain_fw') :CaptureArgs(1) {
    $_[1]->forward( '/action/chained/fw_dt_target' );
}
sub chain_fw_b :Chained('chain_fw_a') :PathPart('end') :Args(1) { }

#
#   Detaching out of the middle of a chain.
#
sub chain_dt_a :Chained :PathPart('chained/chain_dt') :CaptureArgs(1) {
    $_[1]->detach( '/action/chained/fw_dt_target' );
}
sub chain_dt_b :Chained('chain_dt_a') :PathPart('end') :Args(1) { }

#
#   Die in the middle of a chain
#
sub chain_die_a :Chained :PathPart('chained/chain_die') :CaptureArgs(1) {
    $_[1]->error( 'break in the middle of a chain' );
}

sub chain_die_b :Chained('chain_die_a') :PathPart('end') :Args(1) {}

#
#   Target for former forward and chain tests.
#
sub fw_dt_target :Private { }

#
#   Test multiple chained actions with no captures
#
sub empty_chain_a : Chained('/')             PathPart('chained/empty') CaptureArgs(0) { }
sub empty_chain_b : Chained('empty_chain_a') PathPart('')              CaptureArgs(0) { }
sub empty_chain_c : Chained('empty_chain_b') PathPart('')              CaptureArgs(0) { }
sub empty_chain_d : Chained('empty_chain_c') PathPart('')              CaptureArgs(1) { }
sub empty_chain_e : Chained('empty_chain_d') PathPart('')              CaptureArgs(0) { }
sub empty_chain_f : Chained('empty_chain_e') PathPart('')              Args(1)        { }

sub mult_nopp_base  : Chained('/') PathPart('chained/mult_nopp') CaptureArgs(0) { }
sub mult_nopp_all   : Chained('mult_nopp_base') PathPart('') Args(0) { }
sub mult_nopp_new   : Chained('mult_nopp_base') PathPart('new') Args(0) { }
sub mult_nopp_id    : Chained('mult_nopp_base') PathPart('') CaptureArgs(1) { }
sub mult_nopp_idall : Chained('mult_nopp_id') PathPart('') Args(0) { }
sub mult_nopp_idnew : Chained('mult_nopp_id') PathPart('new') Args(0) { }

sub mult_nopp2_base            : Chained('/') PathPart('chained/mult_nopp2') CaptureArgs(0) { }
sub mult_nopp2_nocap           : Chained('mult_nopp2_base') PathPart('') CaptureArgs(0) { }
sub mult_nopp2_action          : Chained('mult_nopp2_nocap') PathPart('action') CaptureArgs(0) { }
sub mult_nopp2_action_default  : Chained('mult_nopp2_action') PathPart('') Args(0) { }
sub mult_nopp2_action_with_arg : Chained('mult_nopp2_action') PathPart('') Args(1) { }
sub mult_nopp2_load            : Chained('mult_nopp2_base') PathPart('') CaptureArgs(1) { }
sub mult_nopp2_view            : Chained('mult_nopp2_load') PathPart('') Args(0) { }

#
#	Test Choice between branches and early return logic
#   Declaration order is important for $children->{$*}, since this is first match best.
#
sub cc_base 	: Chained('/') 		 PathPart('chained/choose_capture') CaptureArgs(0) { }
sub cc_link  	: Chained('cc_base') PathPart('') 						CaptureArgs(0) { }
sub cc_anchor 	: Chained('cc_link') PathPart('anchor.html') 			Args(0) 	   { }
sub cc_all     	: Chained('cc_base') PathPart('') 						Args() 		   { }

sub cc_a		: Chained('cc_base') 	PathPart('') 	CaptureArgs(1) { }
sub cc_a_link	: Chained('cc_a') 	 	PathPart('a') 	CaptureArgs(0) { }
sub cc_a_anchor	: Chained('cc_a_link')  PathPart('') 	Args() 		   { }

sub cc_b		: Chained('cc_base') 	PathPart('b') 				CaptureArgs(0) { }
sub cc_b_link	: Chained('cc_b') 	 	PathPart('') 				CaptureArgs(1) { }
sub cc_b_anchor	: Chained('cc_b_link')  PathPart('anchor.html') 	Args() 		   { }

#
#   Test static paths vs. captures
#

sub apan        : Chained('/')     CaptureArgs(0) PathPrefix   { }
sub korv        : Chained('apan')  CaptureArgs(0) PathPart('') { }
sub wurst       : Chained('apan')  CaptureArgs(1) PathPart('') { }
sub static_end  : Chained('korv')  Args(0)                     { }
sub capture_end : Chained('wurst') Args(0)        PathPart('') { }


# */search vs doc/*
sub view : Chained('/') PathPart('chained') CaptureArgs(1) {}
sub star_search : Chained('view') PathPart('search') Args(0) { }
sub doc_star : Chained('/') PathPart('chained/doc') Args(1) {}

sub return_arg : Chained('view') PathPart('return_arg') Args(1) {}

sub return_arg_decoded : Chained('/') PathPart('chained/return_arg_decoded') Args(1) {
    my ($self, $c) = @_;
    $c->req->args([ map { decode_entities($_) } @{ $c->req->args }]);
}

sub roundtrip_urifor : Chained('/') PathPart('chained/roundtrip_urifor') CaptureArgs(1) {}
sub roundtrip_urifor_end : Chained('roundtrip_urifor') PathPart('') Args(1) {
    my ($self, $c) = @_;
    # This should round-trip, always - i.e. the uri you put in should come back out.
    $c->res->body($c->uri_for($c->action, $c->req->captures, @{$c->req->args}, $c->req->parameters));
    $c->stash->{no_end} = 1;
}

sub match_captures : Chained('/') PathPart('chained/match_captures') CaptureArgs(1) ActionClass('+TestApp::Action::TestMatchCaptures') {
    my ($self, $c) = @_;
    $c->res->header( 'X-TestAppActionTestMatchCapturesHasRan', 'yes');
}

sub match_captures_end : Chained('match_captures') PathPart('bar') Args(0) { }

sub end :Private {
  my ($self, $c) = @_;
  return if $c->stash->{no_end};
  my $out = join('; ', map { join(', ', @$_) }
                         ($c->req->captures, $c->req->args));
  $c->res->body($out);
}

1;
Commit	Line	Data
5882c86e	1	package TestApp::Controller::Action::Chained;
	2
	3	use strict;
	4	use warnings;
	5
372b0c1b	6	use HTML::Entities;
372b0c1b	7
ca5d34df	8	use base qw/Catalyst::Controller/;
5882c86e	9
	10	sub begin :Private { }
	11
	12	#
	13	# TODO
0e853a7f	14	# :Chained('') means what?
5882c86e	15	#
	16
	17	#
	18	# Simple parent/child action test
	19	#
62605319	20	sub foo :PathPart('chained/foo') :CaptureArgs(1) :Chained('/') {
	21	my ( $self, $c, @args ) = @_;
	22	die "missing argument" unless @args;
760d121e	23	die "more than 1 argument: got @args" if @args > 1;
62605319	24	}
5882c86e	25	sub endpoint :PathPart('end') :Chained('/action/chained/foo') :Args(1) { }
	26
	27	#
	28	# Parent/child test with two args each
	29	#
1c34f703	30	sub foo2 :PathPart('chained/foo2') :CaptureArgs(2) :Chained('/') { }
5882c86e	31	sub endpoint2 :PathPart('end2') :Chained('/action/chained/foo2') :Args(2) { }
	32
	33	#
	34	# Relative specification of parent action
	35	#
1c34f703	36	sub bar :PathPart('chained/bar') :Chained('/') :CaptureArgs(0) { }
5882c86e	37	sub finale :PathPart('') :Chained('bar') :Args { }
	38
	39	#
	40	# three chain with concurrent endpoints
	41	#
1c34f703	42	sub one :PathPart('chained/one') :Chained('/') :CaptureArgs(1) { }
1c34f703	43	sub two :PathPart('two') :Chained('/action/chained/one') :CaptureArgs(2) { }
5882c86e	44	sub three_end :PathPart('three') :Chained('two') :Args(3) { }
	45	sub one_end :PathPart('chained/one') :Chained('/') :Args(1) { }
	46	sub two_end :PathPart('two') :Chained('one') :Args(2) { }
	47
	48	#
	49	# Dispatch on number of arguments
	50	#
	51	sub multi1 :PathPart('chained/multi') :Chained('/') :Args(1) { }
	52	sub multi2 :PathPart('chained/multi') :Chained('/') :Args(2) { }
	53
	54	#
	55	# Roots in an action defined in a higher controller
	56	#
	57	sub higher_root :PathPart('bar') :Chained('/action/chained/foo/higher_root') :Args(1) { }
	58
	59	#
	60	# Controller -> subcontroller -> controller
	61	#
1c34f703	62	sub pcp1 :PathPart('chained/pcp1') :Chained('/') :CaptureArgs(1) { }
5882c86e	63	sub pcp3 :Chained('/action/chained/foo/pcp2') :Args(1) { }
	64
	65	#
	66	# Dispatch on capture number
	67	#
1c34f703	68	sub multi_cap1 :PathPart('chained/multi_cap') :Chained('/') :CaptureArgs(1) { }
1c34f703	69	sub multi_cap2 :PathPart('chained/multi_cap') :Chained('/') :CaptureArgs(2) { }
5882c86e	70	sub multi_cap_end1 :PathPart('baz') :Chained('multi_cap1') :Args(0) { }
	71	sub multi_cap_end2 :PathPart('baz') :Chained('multi_cap2') :Args(0) { }
	72
	73	#
	74	# Priority: Slurpy args vs. chained actions
	75	#
	76	sub priority_a1 :PathPart('chained/priority_a') :Chained('/') :Args { }
1c34f703	77	sub priority_a2 :PathPart('chained/priority_a') :Chained('/') :CaptureArgs(1) { }
5882c86e	78	sub priority_a2_end :PathPart('end') :Chained('priority_a2') :Args(1) { }
5882c86e	79
b7ce908f	80
5882c86e	81	#
	82	# Priority: Fixed args vs. chained actions
	83	#
	84	sub priority_b1 :PathPart('chained/priority_b') :Chained('/') :Args(3) { }
1c34f703	85	sub priority_b2 :PathPart('chained/priority_b') :Chained('/') :CaptureArgs(1) { }
5882c86e	86	sub priority_b2_end :PathPart('end') :Chained('priority_b2') :Args(1) { }
	87
	88	#
b7ce908f	89	# Priority: With no Args()
	90	#
	91	sub priority_c1 :PathPart('chained/priority_c') :Chained('/') :CaptureArgs(1) { }
	92	sub priority_c2 :PathPart('') :Chained('priority_c1') { }
	93	sub priority_c2_xyz :PathPart('xyz') :Chained('priority_c1') { }
	94
	95
	96	#
5882c86e	97	# Optional specification of :Args in endpoint
	98	#
	99	sub opt_args :PathPart('chained/opt_args') :Chained('/') { }
	100
	101	#
	102	# Optional PathPart test -> /chained/optpp//opt_pathpart/
	103	#
1c34f703	104	sub opt_pp_start :Chained('/') :PathPart('chained/optpp') :CaptureArgs(1) { }
5882c86e	105	sub opt_pathpart :Chained('opt_pp_start') :Args(1) { }
	106
	107	#
	108	# Optional Args and PathPart -> /chained/optall/*/oa/...
	109	#
1c34f703	110	sub opt_all_start :Chained('/') :PathPart('chained/optall') :CaptureArgs(1) { }
5882c86e	111	sub oa :Chained('opt_all_start') { }
5882c86e	112
0e853a7f	113	#
	114	# :Chained is the same as :Chained('/')
	115	#
	116	sub rootdef :Chained :PathPart('chained/rootdef') :Args(1) { }
	117
	118	#
	119	# the ParentChain controller chains to this action by
	120	# specifying :Chained('.')
	121	#
1c34f703	122	sub parentchain :Chained('/') :PathPart('chained/parentchain') :CaptureArgs(1) { }
0e853a7f	123
2349aeea	124	#
	125	# This is just for a test that a loose end is not callable
	126	#
1c34f703	127	sub loose :Chained :PathPart('chained/loose') CaptureArgs(1) { }
2349aeea	128
	129	#
	130	# Forwarding out of the middle of a chain.
	131	#
1c34f703	132	sub chain_fw_a :Chained :PathPart('chained/chain_fw') :CaptureArgs(1) {
2349aeea	133	$_[1]->forward( '/action/chained/fw_dt_target' );
	134	}
	135	sub chain_fw_b :Chained('chain_fw_a') :PathPart('end') :Args(1) { }
	136
	137	#
	138	# Detaching out of the middle of a chain.
	139	#
1c34f703	140	sub chain_dt_a :Chained :PathPart('chained/chain_dt') :CaptureArgs(1) {
2349aeea	141	$_[1]->detach( '/action/chained/fw_dt_target' );
	142	}
	143	sub chain_dt_b :Chained('chain_dt_a') :PathPart('end') :Args(1) { }
	144
	145	#
569b665e	146	# Die in the middle of a chain
	147	#
	148	sub chain_die_a :Chained :PathPart('chained/chain_die') :CaptureArgs(1) {
	149	$_[1]->error( 'break in the middle of a chain' );
	150	}
	151
	152	sub chain_die_b :Chained('chain_die_a') :PathPart('end') :Args(1) {}
	153
	154	#
2349aeea	155	# Target for former forward and chain tests.
	156	#
	157	sub fw_dt_target :Private { }
	158
8b13f357	159	#
	160	# Test multiple chained actions with no captures
	161	#
	162	sub empty_chain_a : Chained('/') PathPart('chained/empty') CaptureArgs(0) { }
	163	sub empty_chain_b : Chained('empty_chain_a') PathPart('') CaptureArgs(0) { }
	164	sub empty_chain_c : Chained('empty_chain_b') PathPart('') CaptureArgs(0) { }
	165	sub empty_chain_d : Chained('empty_chain_c') PathPart('') CaptureArgs(1) { }
	166	sub empty_chain_e : Chained('empty_chain_d') PathPart('') CaptureArgs(0) { }
	167	sub empty_chain_f : Chained('empty_chain_e') PathPart('') Args(1) { }
	168
f505df49	169	sub mult_nopp_base : Chained('/') PathPart('chained/mult_nopp') CaptureArgs(0) { }
	170	sub mult_nopp_all : Chained('mult_nopp_base') PathPart('') Args(0) { }
	171	sub mult_nopp_new : Chained('mult_nopp_base') PathPart('new') Args(0) { }
	172	sub mult_nopp_id : Chained('mult_nopp_base') PathPart('') CaptureArgs(1) { }
	173	sub mult_nopp_idall : Chained('mult_nopp_id') PathPart('') Args(0) { }
	174	sub mult_nopp_idnew : Chained('mult_nopp_id') PathPart('new') Args(0) { }
	175
055abad1	176	sub mult_nopp2_base : Chained('/') PathPart('chained/mult_nopp2') CaptureArgs(0) { }
	177	sub mult_nopp2_nocap : Chained('mult_nopp2_base') PathPart('') CaptureArgs(0) { }
	178	sub mult_nopp2_action : Chained('mult_nopp2_nocap') PathPart('action') CaptureArgs(0) { }
	179	sub mult_nopp2_action_default : Chained('mult_nopp2_action') PathPart('') Args(0) { }
	180	sub mult_nopp2_action_with_arg : Chained('mult_nopp2_action') PathPart('') Args(1) { }
	181	sub mult_nopp2_load : Chained('mult_nopp2_base') PathPart('') CaptureArgs(1) { }
	182	sub mult_nopp2_view : Chained('mult_nopp2_load') PathPart('') Args(0) { }
	183
6365b527	184	#
	185	# Test Choice between branches and early return logic
	186	# Declaration order is important for $children->{$*}, since this is first match best.
	187	#
	188	sub cc_base : Chained('/') PathPart('chained/choose_capture') CaptureArgs(0) { }
	189	sub cc_link : Chained('cc_base') PathPart('') CaptureArgs(0) { }
	190	sub cc_anchor : Chained('cc_link') PathPart('anchor.html') Args(0) { }
	191	sub cc_all : Chained('cc_base') PathPart('') Args() { }
	192
	193	sub cc_a : Chained('cc_base') PathPart('') CaptureArgs(1) { }
	194	sub cc_a_link : Chained('cc_a') PathPart('a') CaptureArgs(0) { }
	195	sub cc_a_anchor : Chained('cc_a_link') PathPart('') Args() { }
	196
	197	sub cc_b : Chained('cc_base') PathPart('b') CaptureArgs(0) { }
	198	sub cc_b_link : Chained('cc_b') PathPart('') CaptureArgs(1) { }
	199	sub cc_b_anchor : Chained('cc_b_link') PathPart('anchor.html') Args() { }
	200
2f381252	201	#
	202	# Test static paths vs. captures
	203	#
	204
	205	sub apan : Chained('/') CaptureArgs(0) PathPrefix { }
	206	sub korv : Chained('apan') CaptureArgs(0) PathPart('') { }
	207	sub wurst : Chained('apan') CaptureArgs(1) PathPart('') { }
	208	sub static_end : Chained('korv') Args(0) { }
	209	sub capture_end : Chained('wurst') Args(0) PathPart('') { }
	210
ef5e5ed1	211
	212	# /search vs doc/
	213	sub view : Chained('/') PathPart('chained') CaptureArgs(1) {}
	214	sub star_search : Chained('view') PathPart('search') Args(0) { }
	215	sub doc_star : Chained('/') PathPart('chained/doc') Args(1) {}
	216
06f97d3f	217	sub return_arg : Chained('view') PathPart('return_arg') Args(1) {}
06f97d3f	218
372b0c1b	219	sub return_arg_decoded : Chained('/') PathPart('chained/return_arg_decoded') Args(1) {
	220	my ($self, $c) = @_;
	221	$c->req->args([ map { decode_entities($_) } @{ $c->req->args }]);
	222	}
	223
36c67dc1	224	sub roundtrip_urifor : Chained('/') PathPart('chained/roundtrip_urifor') CaptureArgs(1) {}
	225	sub roundtrip_urifor_end : Chained('roundtrip_urifor') PathPart('') Args(1) {
	226	my ($self, $c) = @_;
	227	# This should round-trip, always - i.e. the uri you put in should come back out.
	228	$c->res->body($c->uri_for($c->action, $c->req->captures, @{$c->req->args}, $c->req->parameters));
	229	$c->stash->{no_end} = 1;
	230	}
2c527b91	231
ca5d34df	232	sub match_captures : Chained('/') PathPart('chained/match_captures') CaptureArgs(1) ActionClass('+TestApp::Action::TestMatchCaptures') {
1279064a	233	my ($self, $c) = @_;
	234	$c->res->header( 'X-TestAppActionTestMatchCapturesHasRan', 'yes');
	235	}
	236
	237	sub match_captures_end : Chained('match_captures') PathPart('bar') Args(0) { }
	238
5882c86e	239	sub end :Private {
5882c86e	240	my ($self, $c) = @_;
81e75875	241	return if $c->stash->{no_end};
5882c86e	242	my $out = join('; ', map { join(', ', @$_) }
	243	($c->req->captures, $c->req->args));
	244	$c->res->body($out);
	245	}
	246
	247	1;