-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathhobodrymlguide.lyx
11229 lines (8320 loc) · 166 KB
/
hobodrymlguide.lyx
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
#LyX 2.0 created this file. For more info see http://www.lyx.org/
\lyxformat 413
\begin_document
\begin_header
\textclass hobo
\use_default_options true
\master hobo.lyx
\begin_modules
logicalmkup
\end_modules
\maintain_unincluded_children false
\language english
\language_package default
\inputencoding auto
\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
\graphics default
\default_output_format default
\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize default
\spacing single
\use_hyperref false
\papersize default
\use_geometry false
\use_amsmath 1
\use_esint 1
\use_mhchem 1
\use_mathdots 1
\cite_engine basic
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
\use_refstyle 1
\boxbgcolor #e6e6e6
\index Index
\shortcut idx
\color #008000
\end_index
\secnumdepth 3
\tocdepth 3
\paragraph_separation skip
\defskip medskip
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\end_header
\begin_body
\begin_layout Chapter
Chapter 13
\begin_inset Newline newline
\end_inset
THE HOBO DRYML GUIDE
\end_layout
\begin_layout Section
What is DRYML
\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
DRYML
\end_layout
\end_inset
?
\end_layout
\begin_layout Standard
DRYML is a template language for Ruby on Rails that you can use in place
of Rails’ built-in ERB templates.
It is part of the larger Hobo project, but will eventually be made available
as a separate plugin.
\end_layout
\begin_layout Standard
DRYML was created in response to the observation that the vast majority
of Rails development time seems to be spent in the view-layer.
Rails’ models are beautifully declarative, the controllers can easily be
made very easily (witness the many and various “result controller” plugins),
but the views, ah the views…
\end_layout
\begin_layout Standard
Given that so much of the user interaction we encounter on the web is similar
from one website to another, surely we don’t have to code all this stuff
up from low-level primitives over and over again? Please, no!
\end_layout
\begin_layout Standard
Of course what we want is a nice library of ready-to-go user interface component
s, or widgets, which can be quickly added to our project, and easily tailored
to the specifics of our application.
\end_layout
\begin_layout Standard
If you’ve been at this game for a while you’re probably frowning now.
Re-use is a very, very thorny problem.
It’s one of those things that sounds straight-forward and obvious in principle,
but turns out to be horribly difficult in practice.
When you come to re-use something, you very often find that your new needs
differ from the original ones in a way that wasn’t foreseen or catered
for in the design of the component.
The more complex the component, the more likely it is that bending the
thing to your needs will be harder than starting again from scratch.
\end_layout
\begin_layout Standard
The challenge is not in being able to re-use code, it is:
\end_layout
\begin_layout Standard
\begin_inset Flex Strong
status collapsed
\begin_layout Plain Layout
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
Being able to re-use code in ways that were not foreseen.
\end_layout
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Standard
The reason we created DRYML was to see if this kind of flexibility could
be built into the language itself.
DRYML is a tag-based language that makes it trivially easy to give the
defined tags a great deal of flexibility.
\end_layout
\begin_layout Standard
DRYML is just a means to an end.
The real goal is to create a library of reusable user-interface components
that actually succeed in making it very quick and easy to create the view
layer of a web application.
\end_layout
\begin_layout Standard
That library is also part of Hobo – the
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
Rapid
\end_layout
\end_inset
tag library.
You will visit this library later on in the book
\begin_inset Note Note
status open
\begin_layout Plain Layout
Insert page numbers
\end_layout
\end_inset
.
Here, we will see how DRYML provides the tools and raw materials that make
a library like Rapid possible.
\end_layout
\begin_layout Standard
Discussing DRYML before Rapid means that many of the examples are
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
not
\end_layout
\end_inset
good advice for use of DRYML in a full Hobo app.
For example, you might see
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout LyX-Code
<%= h this.name %>
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Which in an app that used Rapid would be better written
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<view:name/>
\end_layout
\end_inset
or even just
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<name/>
\end_layout
\end_inset
(that’s a tag by the way, called
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
name
\end_layout
\end_inset
, not some metaprogramming trick that lets you use field names as tags).
Bear that in mind while you’re reading this chapter.
The examples are chosen to illustrate the point at hand, they are not necessari
ly something you want to paste right into your application.
\end_layout
\begin_layout Section
Simple page templates and ERB
\end_layout
\begin_layout Standard
In its most basic usage, DRYML can be indistinguishable from a normal Rails
template.
That’s because DRYML is (almost) an extension of ERB, so you can still
insert Ruby snippets using the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<% ...
%>
\end_layout
\end_inset
notation.
For example, a show-page for a blog post might look like this:
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout LyX-Code
<html>
\end_layout
\begin_layout LyX-Code
<head>
\end_layout
\begin_layout LyX-Code
<title>My Blog</title>
\end_layout
\begin_layout LyX-Code
</head>
\end_layout
\begin_layout LyX-Code
<body>
\end_layout
\begin_layout LyX-Code
<h1>My Famous Blog!</h1>
\end_layout
\begin_layout LyX-Code
<h2><%= @post.title %></h2>
\end_layout
\begin_layout LyX-Code
<div class="post-body">
\end_layout
\begin_layout LyX-Code
<%= @post.body %>
\end_layout
\begin_layout LyX-Code
</div>
\end_layout
\begin_layout LyX-Code
</body>
\end_layout
\begin_layout LyX-Code
</html>
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\begin_inset Flex Strong
status collapsed
\begin_layout Plain Layout
No ERB inside tags
\end_layout
\end_inset
\end_layout
\begin_layout Standard
DRYML’s support for ERB is not quite the same as true ERB templates.
The one thing you can’t do is use ERB snippets inside a tag.
To have the value of an attribute generated dynamically in ERB, you could
do:
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout LyX-Code
<a href="<%= my_url %>">
\end_layout
\end_inset
\end_layout
\begin_layout Standard
In DRYML you would do:
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout LyX-Code
<a href="#{my_url}">
\end_layout
\end_inset
\end_layout
\begin_layout Standard
In rare cases, you might use an ERB snippet to output one or more entire
attributes:
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout LyX-Code
<form <%= my_attributes %>>
\end_layout
\end_inset
\end_layout
\begin_layout Standard
We’re jumping ahead here, so just skip this if it doesn’t make sense, but
to do the equivalent in DRYML, you would need your attributes to be in
a hash (rather than a string), and do:
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout LyX-Code
<form merge-attrs="&my_attributes">
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Finally, in a rare case you could even use an ERB snippet to generate the
tag name itself:
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout LyX-Code
<<%= my_tag_name %>> ...
</<%= my_tag_name %>>
\end_layout
\end_inset
\end_layout
\begin_layout Standard
To achieve that in DRYML, you could put the angle brackets in the snippet
too:
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout LyX-Code
<%= "<#{my_tag_name}>" %> ...
<%= "</#{my_tag_name}>" %>
\end_layout
\end_inset
\end_layout
\begin_layout Section
Where are the layouts?
\end_layout
\begin_layout Standard
Going back to the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<page>
\end_layout
\end_inset
tag at the start of this section
\begin_inset Note Note
status open
\begin_layout Plain Layout
Page number
\end_layout
\end_inset
, from a “normal Rails” perspective, you might be wondering why the boilerplate
stuff like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<html>
\end_layout
\end_inset
,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<head>
\end_layout
\end_inset
and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<body>
\end_layout
\end_inset
are there.
What happened to layouts
\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
layouts
\end_layout
\end_inset
? You don’t tend to use layouts with DRYML, instead you would define your
own tag, typically
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<page>
\end_layout
\end_inset
, and call that.
Using tags for layouts is much more flexible, and it moves the choice of
layout out of the controller and into the view layer, where it should be.
\end_layout
\begin_layout Standard
We’ll see how to define a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<page>
\end_layout
\end_inset
tag in the next section.
\end_layout
\begin_layout Section
Defining simple tags
\end_layout
\begin_layout Standard
One of the strengths of DRYML is that defining tags is done right in the
template (or in an imported tag library) using the same XML-like syntax.
This means that if you’ve got markup you want to re-use, you can simply
cut-and-paste it into a tag definition.
\end_layout
\begin_layout Standard
Here’s the page from the previous section, defined as a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<page>
\end_layout
\end_inset
tag simply by wrapping the markup in a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<def>
\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
Tags!<def>
\end_layout
\end_inset
\end_layout
\end_inset
tag:
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout LyX-Code
<def tag="page">
\end_layout
\begin_layout LyX-Code
<html>
\end_layout
\begin_layout LyX-Code
<head>
\end_layout
\begin_layout LyX-Code
<title>My Blog</title>
\end_layout
\begin_layout LyX-Code
</head>
\end_layout
\begin_layout LyX-Code
<body>
\end_layout
\begin_layout LyX-Code
<h1>My Famous Blog!</h1>
\end_layout
\begin_layout LyX-Code
<h2><%= @post.title %></h2>
\end_layout
\begin_layout LyX-Code
<div class="post-body">
\end_layout
\begin_layout LyX-Code
<%= @post.body %>
\end_layout
\begin_layout LyX-Code
</div>
\end_layout
\begin_layout LyX-Code
</body>
\end_layout
\begin_layout LyX-Code
</html>
\end_layout
\begin_layout LyX-Code
</def>
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Now we can call that tag just as we would call any other:
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout LyX-Code
<page/>
\end_layout
\end_inset
\end_layout
\begin_layout Standard
If you’d like an analogy to “normal” programming, you can think of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<def>...</def>
\end_layout
\end_inset
as defining a method called
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
page
\end_layout
\end_inset
, and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<page/>
\end_layout
\end_inset
as a call to that method.
\end_layout
\begin_layout Standard
\begin_inset Flex Strong
status collapsed
\begin_layout Plain Layout
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
In fact, DRYML is implemented by compiling to Ruby, and that is exactly
what is happening.
\end_layout
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Section
Parameters
\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
DRYML!Parameters
\end_layout
\end_inset
\end_layout
\begin_layout Standard
We’ve illustrated the most basic usage of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<def>
\end_layout
\end_inset
, but our
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<page>
\end_layout
\end_inset
tag is not very useful.
Let’s take it a step further to make it into the equivalent of a layout.
First of all, we clearly need the body of the page to be different each
time we call it.
\end_layout
\begin_layout Standard
In DRYML we achieve this by adding
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
parameters
\end_layout
\end_inset
to the definition which is accomplished with the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
param
\end_layout
\end_inset
attribute.
Here’s the new definition:
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout LyX-Code
<def tag="page">
\end_layout
\begin_layout LyX-Code
<html>
\end_layout
\begin_layout LyX-Code
<head>
\end_layout
\begin_layout LyX-Code
<title>My Blog</title>
\end_layout
\begin_layout LyX-Code
</head>
\end_layout
\begin_layout LyX-Code
<body param/>
\end_layout
\begin_layout LyX-Code
</html>
\end_layout
\begin_layout LyX-Code
</def>
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Now, we can call the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<page>
\end_layout
\end_inset
tag and provide our own body:
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout LyX-Code
<page>
\end_layout
\begin_layout LyX-Code
<body:>
\end_layout