This repository has been archived by the owner on Jul 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathform_objects.html
385 lines (274 loc) · 8.36 KB
/
form_objects.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
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Form Objects</title>
<meta name="apple-mobile-web-app-capable" content="yes" />
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
<link rel="stylesheet" href="lib/reveal.js/css/reveal.min.css">
<link rel="stylesheet" href="lib/reveal.js/css/theme/night.css">
<link rel="stylesheet" href="lib/template.css">
<!-- For syntax highlighting -->
<link rel="stylesheet" href="lib/reveal.js/lib/css/zenburn.css">
<!-- If the query includes 'print-pdf', include the PDF print sheet -->
<script>
if( window.location.search.match( /print-pdf/gi ) ) {
var link = document.createElement( 'link' );
link.rel = 'stylesheet';
link.type = 'text/css';
link.href = 'css/print/pdf.css';
document.getElementsByTagName( 'head' )[0].appendChild( link );
}
</script>
<!--[if lt IE 9]>
<script src="lib/reveal.js/lib/js/html5shiv.js"></script>
<![endif]-->
</head>
<body>
<div class="reveal">
<div class="slides" id="content">
<section data-markdown
data-separator="==="
data-vertical="=="><script type="text/template">
<img src="./form_objects/sample_form.png"/>
==
### Name
* Mandatory, RAS
==
### Associated formation
* Selectable in the list of the school's formations
==
### Duration
* Range accessor on the model
* Default to 4-6 months if empty
==
### Period
* Date range accessor on the model
* Sent as YYYY-MM-DD strings
* Mandatory in the form only
==
<img src="./form_objects/sample_form.png"/>
==
**Where to put the logic ?**
===
# Form Objects
===
## Why
==
```markdown
+--------------+ +------------+
| | | |
| Frontend | | Backend |
| | HTTP | |
| * DOM | x-www-form-urlencoded | * Models |
| * JSON | +---------------------------------------------------> | * Scopes |
| * Javascript | <---------------------------------------------------+ | * Objects |
| | | |
+--------------+ +------------+
```
==
* Parameters parsing
* Selects prepopulation
* Error messages
* Handle failed submits
==
```markdown
+--------------+ +-------------+ +------------+
| | | | | |
| Frontend | | Form Object | | Backend |
| | | | | |
| * DOM | | | | * Models |
| * JSON | +----------------------------> | | +-----> | * Scopes |
| * Javascript | <----------------------------+ | | <-----+ | * Objects |
| | | | | |
+--------------+ +-------------+ +------------+
```
===
## What
==
### Business object
Handles **business validations**
Handles **user-specific** checks
==
### Presenter
Linked to a **specific form**
**Model-independant** representation
==
### Interface
Exposes a **high-level API**.
Implements HTML encoding and **HTTP decoding**.
===
## Result
==
<img src="./form_objects/sample_form.png"/>
==
```slim
= simple_form_for
internship_form,
url: [:directory, internship_form.school, internship_form.internship] do |f|
= f.input :name
= f.input :formation_id, collection: internship_form.available_formations
= f.input :duration, as: :month_slider
= f.input :period, as: :date_range_picker
= f.input :headcount
= f.input :description, as: :markdown
= f.submit
```
==
```ruby
module Directory
class InternshipsController < BaseController
def edit
internship = Internship.find(params[:id])
@internship_form = InternshipForm.new(internship)
end
def update
internship = Internship.find(params[:id])
@internship_form = InternshipForm.new(internship, params[:internship])
render :edit and return unless @internship_form.valid?
internship.update_attributes!(@internship_form.attributes)
redirect_with_success
end
end
end
```
==
<pre>
<code class="ruby">
pry> params
{
"_method" => "patch",
"action" => "update",
"authenticity_token" => "PHD99W8rJI98ziW9oKa/f9kKJ+ExIb+BEHwiXXEAxB5RhvsZW+j3C8SfJfR3eVVMdny2Xvjx6y9raFsJYw14YQ=",
"controller" => "directory/internships",
"id" => "19",
"internship" => {
"description" => "",
"duration" => {
"max" => "6",
"min" => "4"
},
"formation_id" => "58",
"headcount" => "300",
"name" => "Stage de fin d'études",
"period" => {
"begin" => "2016-03-14",
"end" => "2016-03-14"
}
},
"school_id" => "14-centrale-paris",
"utf8" => "✓"
}
</code>
</pre>
==
```ruby
pry> @internship_form.attributes
{
:description => "",
:duration => 4..6,
:formation => #<Formation:0x007f98c81f94e8>,
:headcount => 300,
:name => "Stage de fin d'études",
:period => Mon, 14 Mar 2016..Mon, 14 Mar 2016
}
```
===
## Jump to the code
==
```ruby
module Directory
class InternshipForm < Form::ResourceForm
resource :internship
attribute :name, String
attribute :formation, Formation
attribute :duration, Range
attribute :period, Range
attribute :headcount, Integer
attribute :description, String
delegate :school, to: :internship
validates :name, :formation_id, :period, :duration, presence: true
def initialize_duration
self.duration ||= (4..6)
end
def parse_duration(duration_params)
return if duration_params.blank?
self.duration = (duration_params[:min].to_i..duration_params[:max].to_i)
end
def parse_headcount(headcount)
return if headcount.blank?
self.headcount = headcount.to_i
end
def parse_period(period_params)
return if period_params.blank?
self.period = (Date.parse(period_params[:begin])..Date.parse(period_params[:end]))
end
def formation_id
formation.try(:id)
end
def parse_formation_id(formation_id)
self.formation = school.formations.where(id: formation_id).first
end
def available_formations
school.formations
end
end
end
```
==
```ruby
module Form
class ResourceForm
include ActiveModel::Model
include Virtus.model
class_attribute :resource_name
class << self
# Configuration
def resource(name)
self.resource_name = name
alias_method name, :resource # Reader
end
def model
resource_name.constantize
end
def model_name
ActiveModel::Name.new(self, nil, (resource_name || 'form').to_s)
end
end
delegate :persisted?, to: :resource
def initialize(resource = nil, params = {})
resource ||= self.class.model.new
@_resource = resource
# Initialization
attributes.keys.each do |key|
if respond_to?(:"initialize_#{key}", true)
send :"initialize_#{key}"
else
self.send(:"#{key}=", resource.send(key))
end
end
# Population from params
params.each do |key, value|
if respond_to?(:"parse_#{key}", true)
send(:"parse_#{key}", value)
elsif attributes.keys.include? key.to_sym
self.send(:"#{key}=", value)
end
end
end
def resource
@_resource
end
end
end
```
</script></section>
</div>
</div>
<script src="lib/reveal.js/lib/js/head.min.js"></script>
<script src="lib/reveal.js/js/reveal.min.js"></script>
<script src="lib/jquery/dist/jquery.min.js"></script>
<script src="config.js"></script>
</body>
</html>