t/lib/TestApp/Controller/Action/Chained.pm

   1 package TestApp::Controller::Action::Chained;
   2
   3 use strict;
   4 use warnings;
   5
   6 use HTML::Entities;
   7
   8 use base qw/Catalyst::Controller/;
   9
  10 sub begin :Private { }
  11
  12 #
  13 #   TODO
  14 #   :Chained('') means what?
  15 #
  16
  17 #
  18 #   Simple parent/child action test
  19 #
  20 sub foo  :PathPart('chained/foo')  :CaptureArgs(1) :Chained('/') {
  21     my ( $self, $c, @args ) = @_;
  22     die "missing argument" unless @args;
  23     die "more than 1 argument: got @args" if @args > 1;
  24 }
  25 sub endpoint  :PathPart('end')  :Chained('/action/chained/foo')  :Args(1) { }
  26
  27 #
  28 #   Parent/child test with two args each
  29 #
  30 sub foo2 :PathPart('chained/foo2') :CaptureArgs(2) :Chained('/') { }
  31 sub endpoint2 :PathPart('end2') :Chained('/action/chained/foo2') :Args(2) { }
  32
  33 #
  34 #   Relative specification of parent action
  35 #
  36 sub bar :PathPart('chained/bar') :Chained('/') :CaptureArgs(0) { }
  37 sub finale :PathPart('') :Chained('bar') :Args { }
  38
  39 #
  40 #   three chain with concurrent endpoints
  41 #
  42 sub one   :PathPart('chained/one') :Chained('/')                   :CaptureArgs(1) { }
  43 sub two   :PathPart('two')         :Chained('/action/chained/one') :CaptureArgs(2) { }
  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 #
  62 sub pcp1 :PathPart('chained/pcp1')  :Chained('/')                        :CaptureArgs(1) { }
  63 sub pcp3 :Chained('/action/chained/foo/pcp2') :Args(1)     { }
  64
  65 #
  66 #   Dispatch on capture number
  67 #
  68 sub multi_cap1 :PathPart('chained/multi_cap') :Chained('/') :CaptureArgs(1) { }
  69 sub multi_cap2 :PathPart('chained/multi_cap') :Chained('/') :CaptureArgs(2) { }
  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 { }
  77 sub priority_a2 :PathPart('chained/priority_a') :Chained('/') :CaptureArgs(1) { }
  78 sub priority_a2_end :PathPart('end') :Chained('priority_a2') :Args(1) { }
  79
  80
  81 #
  82 #   Priority: Fixed args vs. chained actions
  83 #
  84 sub priority_b1 :PathPart('chained/priority_b') :Chained('/') :Args(3) { }
  85 sub priority_b2 :PathPart('chained/priority_b') :Chained('/') :CaptureArgs(1) { }
  86 sub priority_b2_end :PathPart('end') :Chained('priority_b2') :Args(1) { }
  87
  88 #
  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 #
  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 #
 104 sub opt_pp_start :Chained('/') :PathPart('chained/optpp') :CaptureArgs(1) { }
 105 sub opt_pathpart :Chained('opt_pp_start') :Args(1) { }
 106
 107 #
 108 #   Optional Args *and* PathPart -> /chained/optall/*/oa/...
 109 #
 110 sub opt_all_start :Chained('/') :PathPart('chained/optall') :CaptureArgs(1) { }
 111 sub oa :Chained('opt_all_start') { }
 112
 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 #
 122 sub parentchain :Chained('/') :PathPart('chained/parentchain') :CaptureArgs(1) { }
 123
 124 #
 125 #   This is just for a test that a loose end is not callable
 126 #
 127 sub loose :Chained :PathPart('chained/loose') CaptureArgs(1) { }
 128
 129 #
 130 #   Forwarding out of the middle of a chain.
 131 #
 132 sub chain_fw_a :Chained :PathPart('chained/chain_fw') :CaptureArgs(1) {
 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 #
 140 sub chain_dt_a :Chained :PathPart('chained/chain_dt') :CaptureArgs(1) {
 141     $_[1]->detach( '/action/chained/fw_dt_target' );
 142 }
 143 sub chain_dt_b :Chained('chain_dt_a') :PathPart('end') :Args(1) { }
 144
 145 #
 146 #   Error in the middle of a chain
 147 #
 148 sub chain_error_a :Chained :PathPart('chained/chain_error') :CaptureArgs(1) {
 149     $_[1]->error( 'break in the middle of a chain' );
 150 }
 151
 152 sub chain_error_b :Chained('chain_error_a') :PathPart('end') :Args(1) {}
 153
 154 #
 155 #   Die in the middle of a chain
 156 #
 157 sub chain_die_a :Chained :PathPart('chained/chain_die') :CaptureArgs(1) {
 158     die( "die in the middle of a chain\n" );
 159 }
 160
 161 sub chain_die_b :Chained('chain_die_a') :PathPart('end') :Args(1) {}
 162
 163 #
 164 #   Target for former forward and chain tests.
 165 #
 166 sub fw_dt_target :Private { }
 167
 168 #
 169 #   Test multiple chained actions with no captures
 170 #
 171 sub empty_chain_a : Chained('/')             PathPart('chained/empty') CaptureArgs(0) { }
 172 sub empty_chain_b : Chained('empty_chain_a') PathPart('')              CaptureArgs(0) { }
 173 sub empty_chain_c : Chained('empty_chain_b') PathPart('')              CaptureArgs(0) { }
 174 sub empty_chain_d : Chained('empty_chain_c') PathPart('')              CaptureArgs(1) { }
 175 sub empty_chain_e : Chained('empty_chain_d') PathPart('')              CaptureArgs(0) { }
 176 sub empty_chain_f : Chained('empty_chain_e') PathPart('')              Args(1)        { }
 177
 178 sub mult_nopp_base  : Chained('/') PathPart('chained/mult_nopp') CaptureArgs(0) { }
 179 sub mult_nopp_all   : Chained('mult_nopp_base') PathPart('') Args(0) { }
 180 sub mult_nopp_new   : Chained('mult_nopp_base') PathPart('new') Args(0) { }
 181 sub mult_nopp_id    : Chained('mult_nopp_base') PathPart('') CaptureArgs(1) { }
 182 sub mult_nopp_idall : Chained('mult_nopp_id') PathPart('') Args(0) { }
 183 sub mult_nopp_idnew : Chained('mult_nopp_id') PathPart('new') Args(0) { }
 184
 185 sub mult_nopp2_base            : Chained('/') PathPart('chained/mult_nopp2') CaptureArgs(0) { }
 186 sub mult_nopp2_nocap           : Chained('mult_nopp2_base') PathPart('') CaptureArgs(0) { }
 187 sub mult_nopp2_action          : Chained('mult_nopp2_nocap') PathPart('action') CaptureArgs(0) { }
 188 sub mult_nopp2_action_default  : Chained('mult_nopp2_action') PathPart('') Args(0) { }
 189 sub mult_nopp2_action_with_arg : Chained('mult_nopp2_action') PathPart('') Args(1) { }
 190 sub mult_nopp2_load            : Chained('mult_nopp2_base') PathPart('') CaptureArgs(1) { }
 191 sub mult_nopp2_view            : Chained('mult_nopp2_load') PathPart('') Args(0) { }
 192
 193 #
 194 #   Test Choice between branches and early return logic
 195 #   Declaration order is important for $children->{$*}, since this is first match best.
 196 #
 197 sub cc_base     : Chained('/')       PathPart('chained/choose_capture') CaptureArgs(0) { }
 198 sub cc_link     : Chained('cc_base') PathPart('')                       CaptureArgs(0) { }
 199 sub cc_anchor   : Chained('cc_link') PathPart('anchor.html')            Args(0)        { }
 200 sub cc_all      : Chained('cc_base') PathPart('')                       Args()         { }
 201
 202 sub cc_a        : Chained('cc_base')    PathPart('')    CaptureArgs(1) { }
 203 sub cc_a_link   : Chained('cc_a')       PathPart('a')   CaptureArgs(0) { }
 204 sub cc_a_anchor : Chained('cc_a_link')  PathPart('')    Args()         { }
 205
 206 sub cc_b        : Chained('cc_base')    PathPart('b')               CaptureArgs(0) { }
 207 sub cc_b_link   : Chained('cc_b')       PathPart('')                CaptureArgs(1) { }
 208 sub cc_b_anchor : Chained('cc_b_link')  PathPart('anchor.html')     Args()         { }
 209
 210 #
 211 #   Test static paths vs. captures
 212 #
 213
 214 sub apan        : Chained('/')     CaptureArgs(0) PathPrefix   { }
 215 sub korv        : Chained('apan')  CaptureArgs(0) PathPart('') { }
 216 sub wurst       : Chained('apan')  CaptureArgs(1) PathPart('') { }
 217 sub static_end  : Chained('korv')  Args(0)                     { }
 218 sub capture_end : Chained('wurst') Args(0)        PathPart('') { }
 219
 220
 221 # */search vs doc/*
 222 sub view : Chained('/') PathPart('chained') CaptureArgs(1) {}
 223 sub star_search : Chained('view') PathPart('search') Args(0) { }
 224 sub doc_star : Chained('/') PathPart('chained/doc') Args(1) {}
 225
 226 sub return_arg : Chained('view') PathPart('return_arg') Args(1) {}
 227
 228 sub return_arg_decoded : Chained('/') PathPart('chained/return_arg_decoded') Args(1) {
 229     my ($self, $c) = @_;
 230     $c->req->args([ map { decode_entities($_) } @{ $c->req->args }]);
 231 }
 232
 233 sub roundtrip_urifor : Chained('/') PathPart('chained/roundtrip_urifor') CaptureArgs(1) {}
 234 sub roundtrip_urifor_end : Chained('roundtrip_urifor') PathPart('') Args(1) {
 235     my ($self, $c) = @_;
 236     # This should round-trip, always - i.e. the uri you put in should come back out.
 237     $c->res->body($c->uri_for($c->action, $c->req->captures, @{$c->req->args}, $c->req->parameters));
 238     $c->stash->{no_end} = 1;
 239 }
 240
 241 sub match_captures : Chained('/') PathPart('chained/match_captures') CaptureArgs(1) ActionClass('+TestApp::Action::TestMatchCaptures') {
 242     my ($self, $c) = @_;
 243     $c->res->header( 'X-TestAppActionTestMatchCapturesHasRan', 'yes');
 244 }
 245
 246 sub match_captures_end : Chained('match_captures') PathPart('bar') Args(0) { }
 247
 248 sub end :Private {
 249   my ($self, $c) = @_;
 250   return if $c->stash->{no_end};
 251   my $out = join('; ', map { join(', ', @$_) }
 252                          ($c->req->captures, $c->req->args));
 253   $c->res->body($out);
 254 }
 255
 256 1;