This repository has been archived by the owner on Jun 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
route.html
1021 lines (651 loc) · 38.5 KB
/
route.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<title>route.coffee</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<link rel="stylesheet" media="all" href="docco.css" />
</head>
<body>
<div id="container">
<div id="background"></div>
<ul id="jump_to">
<li>
<a class="large" href="javascript:void(0);">Jump To …</a>
<a class="small" href="javascript:void(0);">+</a>
<div id="jump_wrapper">
<div id="jump_page">
<a class="source" href="chaplin.html">
chaplin.coffee
</a>
<a class="source" href="application.html">
application.coffee
</a>
<a class="source" href="composer.html">
composer.coffee
</a>
<a class="source" href="controller.html">
controller.coffee
</a>
<a class="source" href="dispatcher.html">
dispatcher.coffee
</a>
<a class="source" href="composition.html">
composition.coffee
</a>
<a class="source" href="event_broker.html">
event_broker.coffee
</a>
<a class="source" href="history.html">
history.coffee
</a>
<a class="source" href="route.html">
route.coffee
</a>
<a class="source" href="router.html">
router.coffee
</a>
<a class="source" href="support.html">
support.coffee
</a>
<a class="source" href="sync_machine.html">
sync_machine.coffee
</a>
<a class="source" href="utils.html">
utils.coffee
</a>
<a class="source" href="mediator.html">
mediator.coffee
</a>
<a class="source" href="collection.html">
collection.coffee
</a>
<a class="source" href="model.html">
model.coffee
</a>
<a class="source" href="collection_view.html">
collection_view.coffee
</a>
<a class="source" href="layout.html">
layout.coffee
</a>
<a class="source" href="view.html">
view.coffee
</a>
</div>
</li>
</ul>
<ul class="sections">
<li id="title">
<div class="annotation">
<h1>route.coffee</h1>
</div>
</li>
<li id="section-1">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-1">¶</a>
</div>
</div>
<div class="content"><div class='highlight'><pre><span class="string">'use strict'</span>
_ = <span class="built_in">require</span> <span class="string">'underscore'</span>
Backbone = <span class="built_in">require</span> <span class="string">'backbone'</span>
EventBroker = <span class="built_in">require</span> <span class="string">'chaplin/lib/event_broker'</span>
Controller = <span class="built_in">require</span> <span class="string">'chaplin/controllers/controller'</span>
utils = <span class="built_in">require</span> <span class="string">'chaplin/lib/utils'</span>
module.<span class="built_in">exports</span> = <span class="class"><span class="keyword">class</span> <span class="title">Route</span></span></pre></div></div>
</li>
<li id="section-2">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-2">¶</a>
</div>
<p>Borrow the static extend method from Backbone.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@extend</span> = Backbone.Model.extend</pre></div></div>
</li>
<li id="section-3">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-3">¶</a>
</div>
<p>Mixin an EventBroker.</p>
</div>
<div class="content"><div class='highlight'><pre> _.extend <span class="property">@prototype</span>, EventBroker</pre></div></div>
</li>
<li id="section-4">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-4">¶</a>
</div>
<p>Taken from Backbone.Router.</p>
</div>
<div class="content"><div class='highlight'><pre> escapeRegExp = <span class="regexp">/[\-{}\[\]+?.,\\\^$|#\s]/g</span>
optionalRegExp = <span class="regexp">/\((.*?)\)/g</span>
paramRegExp = <span class="regexp">/(?::|\*)(\w+)/g</span></pre></div></div>
</li>
<li id="section-5">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-5">¶</a>
</div>
<p>Add or remove trailing slash from path according to trailing option.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="function"><span class="title">processTrailingSlash</span> = <span class="params">(path, trailing)</span> -></span>
<span class="keyword">switch</span> trailing
<span class="keyword">when</span> <span class="literal">yes</span>
path += <span class="string">'/'</span> <span class="keyword">unless</span> path[-<span class="number">1.</span>.] <span class="keyword">is</span> <span class="string">'/'</span>
<span class="keyword">when</span> <span class="literal">no</span>
path = path[...-<span class="number">1</span>] <span class="keyword">if</span> path[-<span class="number">1.</span>.] <span class="keyword">is</span> <span class="string">'/'</span>
path</pre></div></div>
</li>
<li id="section-6">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-6">¶</a>
</div>
<p>Create a route for a URL pattern and a controller action
e.g. new Route '/users/:id', 'users', 'show', { some: 'options' }</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="attribute">constructor</span>: <span class="function"><span class="params">(<span class="property">@pattern</span>, <span class="property">@controller</span>, <span class="property">@action</span>, options)</span> -></span></pre></div></div>
</li>
<li id="section-7">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-7">¶</a>
</div>
<p>Disallow regexp routes.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">if</span> <span class="keyword">typeof</span> <span class="property">@pattern</span> <span class="keyword">isnt</span> <span class="string">'string'</span>
<span class="keyword">throw</span> <span class="keyword">new</span> Error <span class="string">'Route: RegExps are not supported.
Use strings with :names and `constraints` option of route'</span></pre></div></div>
</li>
<li id="section-8">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-8">¶</a>
</div>
<p>Clone options.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@options</span> = <span class="keyword">if</span> options <span class="keyword">then</span> _.extend({}, options) <span class="keyword">else</span> {}</pre></div></div>
</li>
<li id="section-9">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-9">¶</a>
</div>
<p>Store the name on the route if given</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@name</span> = <span class="property">@options</span>.name <span class="keyword">if</span> <span class="property">@options</span>.name?</pre></div></div>
</li>
<li id="section-10">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-10">¶</a>
</div>
<p>Don’t allow ambiguity with controller#action.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">if</span> <span class="property">@name</span> <span class="keyword">and</span> <span class="property">@name</span>.indexOf(<span class="string">'#'</span>) <span class="keyword">isnt</span> -<span class="number">1</span>
<span class="keyword">throw</span> <span class="keyword">new</span> Error <span class="string">'Route: "#" cannot be used in name'</span></pre></div></div>
</li>
<li id="section-11">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-11">¶</a>
</div>
<p>Set default route name.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@name</span> ?= <span class="property">@controller</span> + <span class="string">'#'</span> + <span class="property">@action</span></pre></div></div>
</li>
<li id="section-12">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-12">¶</a>
</div>
<p>Initialize list of :params which the route will use.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@allParams</span> = []
<span class="property">@requiredParams</span> = []
<span class="property">@optionalParams</span> = []</pre></div></div>
</li>
<li id="section-13">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-13">¶</a>
</div>
<p>Check if the action is a reserved name</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">if</span> <span class="property">@action</span> <span class="keyword">of</span> Controller.prototype
<span class="keyword">throw</span> <span class="keyword">new</span> Error <span class="string">'Route: You should not use existing controller '</span> +
<span class="string">'properties as action names'</span>
<span class="property">@createRegExp</span>()</pre></div></div>
</li>
<li id="section-14">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-14">¶</a>
</div>
<p>You’re frozen when your heart’s not open.</p>
</div>
<div class="content"><div class='highlight'><pre> Object.freeze? <span class="keyword">this</span></pre></div></div>
</li>
<li id="section-15">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-15">¶</a>
</div>
<p>Tests if route params are equal to criteria.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="attribute">matches</span>: <span class="function"><span class="params">(criteria)</span> -></span>
<span class="keyword">if</span> <span class="keyword">typeof</span> criteria <span class="keyword">is</span> <span class="string">'string'</span>
criteria <span class="keyword">is</span> <span class="property">@name</span>
<span class="keyword">else</span>
propertiesCount = <span class="number">0</span>
<span class="keyword">for</span> name <span class="keyword">in</span> [<span class="string">'name'</span>, <span class="string">'action'</span>, <span class="string">'controller'</span>]
propertiesCount++
property = criteria[name]
<span class="keyword">return</span> <span class="literal">false</span> <span class="keyword">if</span> property <span class="keyword">and</span> property <span class="keyword">isnt</span> <span class="keyword">this</span>[name]
invalidParamsCount = propertiesCount <span class="keyword">is</span> <span class="number">1</span> <span class="keyword">and</span> name <span class="keyword">in</span> [<span class="string">'action'</span>, <span class="string">'controller'</span>]
<span class="keyword">not</span> invalidParamsCount</pre></div></div>
</li>
<li id="section-16">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-16">¶</a>
</div>
<p>Generates route URL from params.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="attribute">reverse</span>: <span class="function"><span class="params">(params, query)</span> -></span>
params = <span class="property">@normalizeParams</span> params
<span class="keyword">return</span> <span class="literal">false</span> <span class="keyword">if</span> params <span class="keyword">is</span> <span class="literal">false</span>
url = <span class="property">@pattern</span></pre></div></div>
</li>
<li id="section-17">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-17">¶</a>
</div>
<p>From a params hash; we need to be able to return
the actual URL this route represents.
Iterate and replace params in pattern.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">for</span> name <span class="keyword">in</span> <span class="property">@requiredParams</span>
value = params[name]
url = url.replace <span class="regexp">///[:*]<span class="comment">#{name}///g, value</span>
</span></pre></div></div>
</li>
<li id="section-18">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-18">¶</a>
</div>
<p>Replace optional params.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">for</span> name <span class="keyword">in</span> <span class="property">@optionalParams</span>
<span class="keyword">if</span> value = params[name]
url = url.replace <span class="regexp">///[:*]<span class="comment">#{name}///g, value</span>
</span></pre></div></div>
</li>
<li id="section-19">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-19">¶</a>
</div>
<p>Kill unfulfilled optional portions.</p>
</div>
<div class="content"><div class='highlight'><pre> raw = url.replace optionalRegExp, <span class="function"><span class="params">(match, portion)</span> -></span>
<span class="keyword">if</span> portion.match <span class="regexp">/[:*]/g</span>
<span class="string">""</span>
<span class="keyword">else</span>
portion</pre></div></div>
</li>
<li id="section-20">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-20">¶</a>
</div>
<p>Add or remove trailing slash according to the Route options.</p>
</div>
<div class="content"><div class='highlight'><pre> url = processTrailingSlash raw, <span class="property">@options</span>.trailing
<span class="keyword">return</span> url <span class="keyword">unless</span> query</pre></div></div>
</li>
<li id="section-21">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-21">¶</a>
</div>
<p>Stringify query params if needed.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">if</span> <span class="keyword">typeof</span> query <span class="keyword">is</span> <span class="string">'object'</span>
queryString = utils.queryParams.stringify query
url += <span class="keyword">if</span> queryString <span class="keyword">then</span> <span class="string">'?'</span> + queryString <span class="keyword">else</span> <span class="string">''</span>
<span class="keyword">else</span>
url += (<span class="keyword">if</span> query[<span class="number">0</span>] <span class="keyword">is</span> <span class="string">'?'</span> <span class="keyword">then</span> <span class="string">''</span> <span class="keyword">else</span> <span class="string">'?'</span>) + query</pre></div></div>
</li>
<li id="section-22">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-22">¶</a>
</div>
<p>Validates incoming params and returns them in a unified form - hash</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="attribute">normalizeParams</span>: <span class="function"><span class="params">(params)</span> -></span>
<span class="keyword">if</span> utils.isArray params</pre></div></div>
</li>
<li id="section-23">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-23">¶</a>
</div>
<p>Ensure we have enough parameters.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">return</span> <span class="literal">false</span> <span class="keyword">if</span> params.length < <span class="property">@requiredParams</span>.length</pre></div></div>
</li>
<li id="section-24">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-24">¶</a>
</div>
<p>Convert params from array into object.</p>
</div>
<div class="content"><div class='highlight'><pre> paramsHash = {}
<span class="keyword">for</span> paramName, paramIndex <span class="keyword">in</span> <span class="property">@requiredParams</span>
paramsHash[paramName] = params[paramIndex]
<span class="keyword">return</span> <span class="literal">false</span> <span class="keyword">unless</span> <span class="property">@testConstraints</span> paramsHash
params = paramsHash
<span class="keyword">else</span></pre></div></div>
</li>
<li id="section-25">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-25">¶</a>
</div>
<p>null or undefined params are equivalent to an empty hash</p>
</div>
<div class="content"><div class='highlight'><pre> params ?= {}
<span class="keyword">return</span> <span class="literal">false</span> <span class="keyword">unless</span> <span class="property">@testParams</span> params
params</pre></div></div>
</li>
<li id="section-26">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-26">¶</a>
</div>
<p>Test if passed params hash matches current constraints.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="attribute">testConstraints</span>: <span class="function"><span class="params">(params)</span> -></span></pre></div></div>
</li>
<li id="section-27">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-27">¶</a>
</div>
<p>Apply the parameter constraints.</p>
</div>
<div class="content"><div class='highlight'><pre> constraints = <span class="property">@options</span>.constraints
<span class="keyword">if</span> constraints
<span class="keyword">for</span> own name, constraint <span class="keyword">of</span> constraints
<span class="keyword">return</span> <span class="literal">false</span> <span class="keyword">unless</span> constraint.test params[name]
<span class="literal">true</span></pre></div></div>
</li>
<li id="section-28">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-28">¶</a>
</div>
<p>Test if passed params hash matches current route.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="attribute">testParams</span>: <span class="function"><span class="params">(params)</span> -></span></pre></div></div>
</li>
<li id="section-29">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-29">¶</a>
</div>
<p>Ensure that params contains all the parameters needed.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">for</span> paramName <span class="keyword">in</span> <span class="property">@requiredParams</span>
<span class="keyword">return</span> <span class="literal">false</span> <span class="keyword">if</span> params[paramName] <span class="keyword">is</span> <span class="literal">undefined</span>
<span class="property">@testConstraints</span> params</pre></div></div>
</li>
<li id="section-30">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-30">¶</a>
</div>
<p>Creates the actual regular expression that Backbone.History#loadUrl
uses to determine if the current url is a match.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="attribute">createRegExp</span>:<span class="function"> -></span>
pattern = <span class="property">@pattern</span></pre></div></div>
</li>
<li id="section-31">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-31">¶</a>
</div>
<p>Escape magic characters.</p>
</div>
<div class="content"><div class='highlight'><pre> pattern = pattern.replace(escapeRegExp, <span class="string">'\\$&'</span>)</pre></div></div>
</li>
<li id="section-32">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-32">¶</a>
</div>
<p>Keep accurate back-reference indices in allParams.
Eg. Matching the regex returns arrays like [a, undefined, c]
and each item needs to be matched to the correct
named parameter via its position in the array.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@replaceParams</span> pattern, <span class="function"><span class="params">(match, param)</span> =></span>
<span class="property">@allParams</span>.push param</pre></div></div>
</li>
<li id="section-33">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-33">¶</a>
</div>
<p>Process optional route portions.</p>
</div>
<div class="content"><div class='highlight'><pre> pattern = pattern.replace optionalRegExp, <span class="property">@parseOptionalPortion</span></pre></div></div>
</li>
<li id="section-34">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-34">¶</a>
</div>
<p>Process remaining required params.</p>
</div>
<div class="content"><div class='highlight'><pre> pattern = <span class="property">@replaceParams</span> pattern, <span class="function"><span class="params">(match, param)</span> =></span>
<span class="property">@requiredParams</span>.push param
<span class="property">@paramCapturePattern</span> match</pre></div></div>
</li>
<li id="section-35">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-35">¶</a>
</div>
<p>Create the actual regular expression, match until the end of the URL,
trailing slash or the begin of query string.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@regExp</span> = <span class="regexp">///^<span class="comment">#{pattern}(?=\/?(?=\?|$))///</span>
parseOptionalPortion: (match, optionalPortion) =>
</span></pre></div></div>
</li>
<li id="section-36">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-36">¶</a>
</div>
<p>Extract and replace params.</p>
</div>
<div class="content"><div class='highlight'><pre> portion = <span class="property">@replaceParams</span> optionalPortion, <span class="function"><span class="params">(match, param)</span> =></span>
<span class="property">@optionalParams</span>.push param</pre></div></div>
</li>
<li id="section-37">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-37">¶</a>
</div>
<p>Replace the match (eg. :foo) with capturing groups.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@paramCapturePattern</span> match</pre></div></div>
</li>
<li id="section-38">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-38">¶</a>
</div>
<p>Replace the optional portion with a non-capturing and optional group.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="string">"(?:<span class="subst">#{portion}</span>)?"</span>
<span class="attribute">replaceParams</span>: <span class="function"><span class="params">(s, callback)</span> =></span></pre></div></div>
</li>
<li id="section-39">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-39">¶</a>
</div>
<p>Parse :foo and *bar, replacing via callback.</p>
</div>
<div class="content"><div class='highlight'><pre> s.replace paramRegExp, callback
<span class="attribute">paramCapturePattern</span>: <span class="function"><span class="params">(param)</span> -></span>
<span class="keyword">if</span> param.charAt(<span class="number">0</span>) <span class="keyword">is</span> <span class="string">':'</span></pre></div></div>
</li>
<li id="section-40">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-40">¶</a>
</div>
<p>Regexp for :foo.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="string">'([^\/\?]+)'</span>
<span class="keyword">else</span></pre></div></div>
</li>
<li id="section-41">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-41">¶</a>
</div>
<p>Regexp for *foo.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="string">'(.*?)'</span></pre></div></div>
</li>
<li id="section-42">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-42">¶</a>
</div>
<p>Test if the route matches to a path (called by Backbone.History#loadUrl).</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="attribute">test</span>: <span class="function"><span class="params">(path)</span> -></span></pre></div></div>
</li>
<li id="section-43">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-43">¶</a>
</div>
<p>Test the main RegExp.</p>
</div>
<div class="content"><div class='highlight'><pre> matched = <span class="property">@regExp</span>.test path
<span class="keyword">return</span> <span class="literal">false</span> <span class="keyword">unless</span> matched</pre></div></div>
</li>
<li id="section-44">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-44">¶</a>
</div>
<p>Apply the parameter constraints.</p>
</div>
<div class="content"><div class='highlight'><pre> constraints = <span class="property">@options</span>.constraints
<span class="keyword">if</span> constraints
<span class="keyword">return</span> <span class="property">@testConstraints</span> <span class="property">@extractParams</span> path
<span class="literal">true</span></pre></div></div>
</li>
<li id="section-45">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-45">¶</a>
</div>
<p>The handler called by Backbone.History when the route matches.
It is also called by Router#route which might pass options.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="attribute">handler</span>: <span class="function"><span class="params">(pathParams, options)</span> =></span>
options = <span class="keyword">if</span> options <span class="keyword">then</span> _.extend {}, options <span class="keyword">else</span> {}</pre></div></div>
</li>
<li id="section-46">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-46">¶</a>
</div>
<p>pathDesc may be either an object with params for reversing or a simple URL.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="keyword">if</span> <span class="keyword">typeof</span> pathParams <span class="keyword">is</span> <span class="string">'object'</span>
query = utils.queryParams.stringify options.query
params = pathParams
path = <span class="property">@reverse</span> params
<span class="keyword">else</span>
[path, query] = pathParams.split <span class="string">'?'</span>
<span class="keyword">if</span> <span class="keyword">not</span> query?
query = <span class="string">''</span>
<span class="keyword">else</span>
options.query = utils.queryParams.parse query
params = <span class="property">@extractParams</span> path
path = processTrailingSlash path, <span class="property">@options</span>.trailing
actionParams = _.extend {}, params, <span class="property">@options</span>.params</pre></div></div>
</li>
<li id="section-47">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-47">¶</a>
</div>
<p>Construct a route object to forward to the match event.</p>
</div>
<div class="content"><div class='highlight'><pre> route = {path, <span class="property">@action</span>, <span class="property">@controller</span>, <span class="property">@name</span>, query}</pre></div></div>
</li>
<li id="section-48">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-48">¶</a>
</div>
<p>Publish a global event passing the route and the params.
Original options hash forwarded to allow further forwarding to backbone.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="property">@publishEvent</span> <span class="string">'router:match'</span>, route, actionParams, options</pre></div></div>
</li>
<li id="section-49">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-49">¶</a>
</div>
<p>Extract named parameters from the URL path.</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="attribute">extractParams</span>: <span class="function"><span class="params">(path)</span> -></span>
params = {}</pre></div></div>
</li>
<li id="section-50">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-50">¶</a>
</div>
<p>Apply the regular expression.</p>
</div>
<div class="content"><div class='highlight'><pre> matches = <span class="property">@regExp</span>.exec path</pre></div></div>
</li>
<li id="section-51">