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
/
refonte-js.html
583 lines (366 loc) · 9.52 KB
/
refonte-js.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
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Refonte V4</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">
# Refonte v4
**Contribution guide for backend developers**
===
## Context
---
### 1 : Slow page load
- ~1 MB (de-gzipped) JS with dependencies
- `content_for :scripts`
- blocked rendering
<br>
Time to first paint : **2.53s**
---
### 2. Long deployment
- Assets compilation : ~50min
```
ls **/schools/*.scss|wc -l
390
```
<!-- */ -->
---
### 3. Unmaintainable JS
- `content_for :scripts`
- `content_for :script_libraries`
- Error reporting
- Code duplication
- All-or-nothing crash
===
## Changes
- Dynamic school theme
- Asynchronous JS loading
- JS restructuration
===
## Dynamic school theme
===
### Before
<link href="/assets/schools/dauphine.css">
<br>
```scss
// app/assets/stylesheets/schools/dauphine.scss
$color: #00428f;
$color2: #002c66;
@import "../application";
```
<br>
** Full duplication **
---
### After
<link href="**/custom_colors/frontend.css**">
<br>
```ruby
# config/routes.rb
get '/custom_colors/:template.css', :to => 'application#custom_colors'
```
```ruby
> School.find('dauphine').configuration.color_scheme
{
"color"=>"#00428f",
"box-title-color"=>"#002c66",
"color-nav"=>"#002c66",
"color-darken"=>"#00428f",
"color-highlight"=>"#002c66",
"text"=>"#00428f",
"text-btn"=>"#f4f4f4",
"gray"=>"#e7e7e7",
"gray2"=>"#f4f4f4",
"gray-darken"=>"#cbcbcb"
}
```
===
### How?
---
One file with only color definitions
```scss
// app/assets/stylesheets/base/_colors.scss
$color: #a4c639; // couleur principale background
$box-title-color: #4d7f86; // couleur des titre des blocs
// [...]
```
---
One file with **all** styles dependant of colors
```scss
// app/assets/stylesheets/base/_theme.scss
.txt-color,
a, a:hover, a:active, a:focus, a:visited
{ color: $text; }
.bg-color
{ background-color: $color; }
.title-color { color: $box-title-color; }
// [...]
```
<small> keep it light! </small>
---
Include them in the base CSS
```scss
// app/assets/stylesheets/application.scss
@import "base/colors";
@import "base/theme";
@import "layout/header";
// [...]
```
---
Manually compile `_theme.scss` with the school custom colors
<br>
```ruby
# config/initializrs/color_scheme.rb
frontend_theme_scss_file = File.join(Rails.root, 'app/assets/stylesheets/base/_theme.scss')
ColorScheme.configure do |config|
config.register_template(:frontend, frontend_css_template)
end
```
```ruby
# GET /custom_colors/:template.css
def custom_colors
school = get_current_school
head 404 and return unless school && school.intranet?
scheme = ColorScheme.new(school.configuration.color_scheme)
render :text => scheme.compiled_css(params[:template]), :content_type => 'text/css'
end
```
===
### Gains
---
- Live editing, without need for deployment
- Re-usable for - eg - company custom themes
---
Only 11 assets to compile
```ruby
# config/initializers/assets.rb
Rails.application.config.assets.precompile = [
# Frontend
'application.css',
'print.css',
'frontend.js',
# Backend
'backend/backend.css',
'backend/application.js',
'backend/stats.css',
# Forum appli
'apps/forum_form.css',
'apps/forum_form.js',
# Forum subscriptions
'apps/forum-subscription.css',
# Mobile webviews
'mobile/application.css',
'mobile/mobile.js'
]
```
===
## Non-blocking JS
<div class="fragment">
<script **async="async"** src="/assets/frontend.js">
</div>
<br>
<div class="fragment">
Time to first paint : 2.5s → **1s**
</div>
---
### Consequence
- No inline JS in the view (dependencies are not loaded)
- Compilation needed (download order of files is not guaranteed)
===
## JS (re?)structuration
---
### 3 levels
- **bower components** : vendor dependencies
- **libs** : pure-JS helpers
- **components** : DOM manipulation
<br>
required and initialized in **app/assets/javascripts/frontend.coffee**
---
* Global namespace : `window.JT`
* App-wide configuration injected in `ApplicationLayout#js_config`
* remote services api keys
* flash messages
* current user, current locale
* When `application.coffee` is downloaded
* Initialize libs with config
* Parse the DOM for components
===
### Bower
* bootstrap
* lodash
* flowplayer
* ...
---
* Hard dependency : **node** (instructions in README)
* Live in /vendor/assets/bower_components
* Only versioned : `bower.json`
---
### How to add a bower component
<br>
`bower search multiselect`
`bower install bootstrap-multiselect --save`
<br>
```coffeescript
# app/assets/javascripts/frontend.coffee
#= require bower_components/bootstrap-multiselect/dist/js/bootstrap-multiselect.js
```
===
### Libs
* google-analytics.coffee
* google-maps.coffee
* pubsub.coffee
* ...
---
Live on the global namespace
```coffeescript
# Wrapper around Raven, with convenience methods for catching and being notified of exceptions
ExceptionNotifier = {}
ExceptionNotifier.configure = (ravenDSN, userId) ->
if ravenDSN
Raven.config(ravenDSN, {
# whitelistUrls: ['*.jobteaser.com']
}).install()
Raven.setUser({
id: userId || 'visitor'
})
JT.catchError = (fn) ->
try
fn()
catch err
log('[ERROR]', err)
Raven.captureException(err)
# Export
JT.ExceptionNotifier = ExceptionNotifier
```
---
Configured in `frontend.coffee`
```coffeescript
# Configure exceptions catching
JT.ExceptionNotifier.configure(JT.config.raven_dsn, JT.config.current_user)
```
===
### Components
* autohide_box.coffee
* video_player.coffee
* companies_filtering.coffee
---
* Scoped and bound to DOM elements
* Initializable with options
* Declared in the view, instanciated in one pass after the JS is loaded
* AJAX-loaded content must be given a new pass
---
### A sample component
```coffeescript
# JS component defining a slidable box, and its trigger
class Slidable extends JT.Components.Base
# Options :
# - container : the jquery selector for the content to be slided down / up
# - trigger : the jquery selector for the slide trigger
# - is_hidden (default false) : should the box be closed by default
initialize: (opts) ->
# Store DOM elements
@$container = @$el.find(opts.container)
@$trigger = @$el.find(opts.trigger)
# Apply configuration
if opts.is_hidden
@$container.hide()
# Bind to DOM events
@$trigger.on 'click', _.bind(this.toggle, this)
# Toggle the container
toggle: () ->
@$container.slideToggle()
JT.Components.Slidable = Slidable
```
---
### Declaration in the view
```haml
%div{ js_component(:slidable, container: '.sign-in-with-school-container', trigger: '.sign-in-with-school-link', is_hidden: true) }
%h2.sign-in-with-school-link
= t('sign_in_with_school')
%i.fa.fa-chevron-down
.sign-in-with-school-container
- @sso_schools.each do |school|
= render partial: 'sso_signin', locals: {school: school}
```
---
### Advantages
- Re-usable
- Isolated
- Robust against HTML / CSS changes
===
## Miscelanea
---
### Rails generator for JS component
```
> bundle exec rails g js_component GroupedAutocomplete
```
---
### I18n in components
```yaml
# config/locales/javascripts/autohide_box.fr.yml
fr:
javascripts:
autohide_box:
see_more: 'Afficher plus'
see_less: 'Afficher moins'
```
```coffeescript
# app/assets/javascripts/frontend/components/autohide_box.coffee
class AutohideBox extends JT.Components.Base
# [...]
render: () ->
if @opened
@$el.css('height', @max_height)
@$footer_container.html @i18n.see_less
else
@$el.css('height', @min_height)
@$footer_container.html @i18n.see_more
```
---
### Goodies in the stack
* fontawesome
* lodash
* handlebars for component templating
* `log()` : dev/staging-only console.log
* event bus : `JT.PubSub`
===
## What's next ?
* Pattern for components composition (eg, popup including a video player)
* React.js integration for server-side pre-rendering
* Who knows ?
===
# Questions?
</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>