-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathch5tut20alt.lyx
1563 lines (1164 loc) · 23.9 KB
/
ch5tut20alt.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
\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
\float_placement H
\paperfontsize default
\spacing single
\use_hyperref true
\pdf_bookmarks true
\pdf_bookmarksnumbered false
\pdf_bookmarksopen false
\pdf_bookmarksopenlevel 1
\pdf_breaklinks false
\pdf_pdfborder false
\pdf_colorlinks true
\pdf_backref false
\pdf_pdfusetitle true
\papersize default
\use_geometry false
\use_amsmath 0
\use_esint 0
\use_mhchem 1
\use_mathdots 1
\cite_engine basic
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date true
\use_refstyle 0
\boxbgcolor #e0e0e8
\index Index
\shortcut idx
\color #008000
\end_index
\secnumdepth -1
\tocdepth 2
\paragraph_separation skip
\defskip medskip
\quotes_language english
\papercolumns 1
\papersides 2
\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 Section
Tutorial 20
\begin_inset Newline newline
\end_inset
Adding User Comments to Models
\end_layout
\begin_layout Standard
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
By Kevin Potter
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection*
Tutorial Application:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
comments_recipe
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Say you're developing some big social site with a ton of different models
that
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
all
\end_layout
\end_inset
need to have comments.
The question is, how can we do this so we don't have to repeat any code?
Also, how can we make it so that adding it to a new model is easy when
that happens down the road?
\end_layout
\begin_layout Standard
Let's see what sort of requirements we have:
\end_layout
\begin_layout Itemize
Comments will come from a signed in user and be attached to them
\end_layout
\begin_layout Itemize
Comments should be able to be attached to
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
any
\end_layout
\end_inset
model now or down the road
\end_layout
\begin_layout Itemize
Guests can't comment but can see comments
\end_layout
\begin_layout Itemize
Users can't edit or delete their comments but admins can
\end_layout
\begin_layout Standard
There's several different potential approaches but we'll go with
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
polymorphism
\end_layout
\end_inset
.
The comments model will have a polymorphic association
\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
polymorphic associations
\end_layout
\end_inset
to the parent, the one that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
has_many :comments
\end_layout
\end_inset
.
\end_layout
\begin_layout Standard
So, let's start with a blank app.
\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 Code
> hobo new comment_test_app
\end_layout
\end_inset
\end_layout
\begin_layout Standard
After, we'll need a run of the mill Post model for testing.
\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 Code
> cd comment_test_app
\end_layout
\begin_layout Code
> hobo g resource Post subject:string body:text
\end_layout
\begin_layout Code
> hobo g migration
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection*
The Model
\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 Code
hobo g resource Comment
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Now, let's set the fields and the association up in in the model file,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
app/models/comment.rb
\end_layout
\end_inset
\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 Code
class Comment < ActiveRecord::Base
\end_layout
\begin_layout Code
hobo_model # Don't put anything above this
\end_layout
\begin_layout Code
\end_layout
\begin_layout Code
fields do
\end_layout
\begin_layout Code
body :text, :required
\end_layout
\begin_layout Code
timestamps
\end_layout
\begin_layout Code
end
\end_layout
\begin_layout Code
\end_layout
\begin_layout Code
belongs_to :commentable, :polymorphic => true
\end_layout
\begin_layout Code
belongs_to :owner, :class_name => "User",
\end_layout
\begin_layout Code
:creator => true
\end_layout
\begin_layout Code
\end_layout
\begin_layout Code
set_default_order "created_at desc"
\end_layout
\begin_layout Code
\end_layout
\begin_layout Code
...
\end_layout
\begin_layout Code
end
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Fairly standard stuff here except the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
:polymorphic => true
\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
:polymorphic => true
\end_layout
\end_inset
\end_layout
\end_inset
bit.
This is actually from rails, but really can shine with some DRYML magic
attached.
What this does, once you migrate, is adds a 'type' column to the comments
table in addition to the standard commentable_id column.
Now, when you attach a comment to another model, in addition to the model's
id, it also stores the type (id on it's own is not enough to guarantee
finding the right model with a polymorphic association).
\end_layout
\begin_layout Standard
\begin_inset Quotes eld
\end_inset
How does one setup the other side of the association though?
\begin_inset Quotes erd
\end_inset
you might ask.
That's the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
:commentable
\end_layout
\end_inset
part.
To add the comments association to another model you just add:
\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 Code
has_many :comments, :as => :commentable
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\begin_inset Box Shaded
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 Description
Note: It doesn't have to be comments but for our example, it's going to
be a requirement for proper activation in the code.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
So, let's run that migration:
\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 Code
hobo g migration
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Also, we have an owner for each comment, which is actually a User.
The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
:creator => true
\end_layout
\end_inset
flag takes care of setting the owner association as the current_user when
creating a comment.
\end_layout
\begin_layout Standard
Let's go ahead and take care of the permissions while we're thinking about
the model:
\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 Code
# --- Permissions --- #
\end_layout
\begin_layout Code
\end_layout
\begin_layout Code
def create_permitted?
\end_layout
\begin_layout Code
owner_is? acting_user
\end_layout
\begin_layout Code
end
\end_layout
\end_inset
\end_layout
\begin_layout Standard
We don't need to change the other permissions as they're already what we
want (only admins can edit or delete comments).
Here, we're using a helper method from the permissions system,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
owner_is?
\end_layout
\end_inset
owner_is?
\end_layout
\end_inset
, which is letting us bypass loading the owner model (if we did
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
owner == acting_user
\end_layout
\end_inset
, it'd load the owner association unnecessarily) or having the less clear
code of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
owner_id == acting_user.id
\end_layout
\end_inset
.
Also, by having it so that the only allowed creation is when the owner
is the acting_user, Rapid will remove the owner selector from the form.
Pretty slick.
\end_layout
\begin_layout Subsubsection*
The Controller
\end_layout
\begin_layout Standard
True to Hobo style, we're just popping in the comment controller to take
out the unneeded actions changing:
\end_layout
\begin_layout Standard
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
app/controllers/comments_controller.rb
\end_layout
\end_inset
\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 Code
auto_actions :all
\end_layout
\end_inset
\end_layout
\begin_layout Standard
to
\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 Code
auto_actions :write_only
\end_layout
\end_inset
\end_layout
\begin_layout Standard
We'll be embedding the very simple comment form in our commentable's show-page,
but I'm getting ahead of myself.
\end_layout
\begin_layout Subsubsection*
The Target(s)
\end_layout
\begin_layout Standard
Now add
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
has_many :comments, :as => :commentable
\end_layout
\end_inset
to both the Post and User model.
\end_layout
\begin_layout Standard
We don't need to migrate as there's no new columns on either Post or User.
\end_layout
\begin_layout Standard
\begin_inset Box Shaded
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 Description
Note: If you doing this on an existing app, you can add this to any model
you want to be commentable.
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection*
The View
\end_layout
\begin_layout Standard
We have the data side setup but no way of adding comments or seeing them
currently.
Let's remedy that.
In
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
app/views/taglibs/application.dryml
\end_layout
\end_inset
add this extension:
\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 Code
<extend tag="show-page">
\end_layout
\begin_layout Code
<old-show-page merge>
\end_layout
\begin_layout Code
<append-content-body:>
\end_layout
\begin_layout Code
<do:comments if="&this.respond_to? :comments">
\end_layout
\begin_layout Code
<h4 param="comment-header">Comments</h4>
\end_layout
\begin_layout Code
<collection part="comments-collection" />
\end_layout
\begin_layout Code
<h5 param="comment-form-label">
\end_layout
\begin_layout Code
Add a comment
\end_layout
\begin_layout Code
</h5>
\end_layout
\begin_layout Code
<form with="&this.user_new(current_user)"
\end_layout
\begin_layout Code
update="comments-collection" reset-form param >
\end_layout
\begin_layout Code
<field-list: skip="commentable"
\end_layout
\begin_layout Code
without-body-label />
\end_layout
\begin_layout Code
</form>
\end_layout
\begin_layout Code
</do>
\end_layout
\begin_layout Code
</append-content-body:>
\end_layout
\begin_layout Code
</old-show-page>
\end_layout
\begin_layout Code
</extend>
\end_layout
\end_inset
\end_layout
\begin_layout Standard
That's a lot to take in there, but let's break it down.
First, we're extending the show-page.
Since we're not targetting a particular model's show-page (with the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
for
\end_layout
\end_inset
attribute) this is modifying the show-page that
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
every
\end_layout
\end_inset
model's show-page is defined against.
So, we'll see the next part inside the end of the content-body
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
param
\end_layout
\end_inset
on every page...
if, it responds to the comments method.
\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 Code
<do:comments if=
\begin_inset Quotes erd
\end_inset
&this.respond_to? :comments
\begin_inset Quotes erd
\end_inset
>
\end_layout
\end_inset
\end_layout
\begin_layout Standard
So, this switches context to comments if the current context (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
this
\end_layout
\end_inset
) has a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
comments
\end_layout
\end_inset
method, which the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
has_many :comments
\end_layout
\end_inset
provides.
\end_layout
\begin_layout Standard
\begin_inset Box Shaded
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 Description
Note: We couldn't just use an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
if:comments
\end_layout
\end_inset
shortcut since
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
if
\end_layout
\end_inset
tests for
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
blankness
\end_layout
\end_inset