sinatra 2.2.0 → 3.1.0

Sign up to get free protection for your applications and to get access to all the features.
data/README.ko.md DELETED
@@ -1,2967 +0,0 @@
1
- # Sinatra
2
-
3
- *주의: 이 문서는 영문판의 번역본이며 최신판 문서와 다를 수 있습니다.*
4
-
5
- Sinatra는 최소한의 노력으로 루비 기반 웹 애플리케이션을 신속하게 만들 수 있게
6
- 해 주는 [DSL](https://en.wikipedia.org/wiki/Domain-specific_language)입니다.
7
-
8
- ```ruby
9
- # myapp.rb
10
- require 'sinatra'
11
-
12
- get '/' do
13
- 'Hello world!'
14
- end
15
- ```
16
-
17
- 아래의 명령어로 젬을 설치합니다.
18
-
19
- ```shell
20
- gem install sinatra
21
- ```
22
-
23
- 아래의 명령어로 실행합니다.
24
-
25
- ```shell
26
- ruby myapp.rb
27
- ```
28
-
29
- [http://localhost:4567](http://localhost:4567) 를 확인해 보세요.
30
-
31
- `gem install thin`도 함께 실행하기를 권장합니다.
32
- thin이 설치되어 있을 경우 Sinatra는 thin을 통해 실행합니다.
33
-
34
- ## 목차
35
-
36
- * [Sinatra](#sinatra)
37
- * [목차](#목차)
38
- * [라우터(Routes)](#라우터routes)
39
- * [조건(Conditions)](#조건conditions)
40
- * [반환값(Return Values)](#반환값return-values)
41
- * [커스텀 라우터 매처(Custom Route Matchers)](#커스텀-라우터-매처custom-route-matchers)
42
- * [정적 파일(Static Files)](#정적-파일static-files)
43
- * [뷰 / 템플릿(Views / Templates)](#뷰--템플릿views--templates)
44
- * [리터럴 템플릿(Literal Templates)](#리터럴-템플릿literal-templates)
45
- * [가능한 템플릿 언어들(Available Template Languages)](#가능한-템플릿-언어들available-template-languages)
46
- * [Haml 템플릿](#haml-템플릿)
47
- * [Erb 템플릿](#erb-템플릿)
48
- * [Builder 템플릿](#builder-템플릿)
49
- * [Nokogiri 템플릿](#nokogiri-템플릿)
50
- * [Sass 템플릿](#sass-템플릿)
51
- * [SCSS 템플릿](#scss-템플릿)
52
- * [Less 템플릿](#less-템플릿)
53
- * [Liquid 템플릿](#liquid-템플릿)
54
- * [Markdown 템플릿](#markdown-템플릿)
55
- * [Textile 템플릿](#textile-템플릿)
56
- * [RDoc 템플릿](#rdoc-템플릿)
57
- * [AsciiDoc 템플릿](#asciidoc-템플릿)
58
- * [Radius 템플릿](#radius-템플릿)
59
- * [Markaby 템플릿](#markaby-템플릿)
60
- * [RABL 템플릿](#rabl-템플릿)
61
- * [Slim 템플릿](#slim-템플릿)
62
- * [Creole 템플릿](#creole-템플릿)
63
- * [MediaWiki 템플릿](#mediawiki-템플릿)
64
- * [CoffeeScript 템플릿](#coffeescript-템플릿)
65
- * [Stylus 템플릿](#stylus-템플릿)
66
- * [Yajl 템플릿](#yajl-템플릿)
67
- * [WLang 템플릿](#wlang-템플릿)
68
- * [템플릿에서 변수에 접근하기](#템플릿에서-변수에-접근하기)
69
- * [템플릿에서의 `yield` 와 중첩 레이아웃](#템플릿에서의-yield-와-중첩-레이아웃)
70
- * [인라인 템플릿](#인라인-템플릿)
71
- * [이름을 가지는 템플릿(Named Templates)](#이름을-가지는-템플릿named-templates)
72
- * [파일 확장자 연결하기](#파일-확장자-연결하기)
73
- * [나만의 고유한 템플릿 엔진 추가하기](#나만의-고유한-템플릿-엔진-추가하기)
74
- * [템플릿 검사를 위한 커스텀 로직 사용하기](#템플릿-검사를-위한-커스텀-로직-사용하기)
75
- * [필터(Filters)](#필터filters)
76
- * [헬퍼(Helpers)](#헬퍼helpers)
77
- * [세션(Sessions) 사용하기](#세션sessions-사용하기)
78
- * [중단하기(Halting)](#중단하기halting)
79
- * [넘기기(Passing)](#넘기기passing)
80
- * [다른 라우터 부르기(Triggering Another Route)](#다른-라우터-부르기triggering-another-route)
81
- * [본문, 상태 코드 및 헤더 설정하기](#본문-상태-코드-및-헤더-설정하기)
82
- * [응답 스트리밍(Streaming Responses)](#응답-스트리밍streaming-responses)
83
- * [로깅(Logging)](#로깅logging)
84
- * [마임 타입(Mime Types)](#마임-타입mime-types)
85
- * [URL 생성하기](#url-생성하기)
86
- * [브라우저 재지정(Browser Redirect)](#브라우저-재지정browser-redirect)
87
- * [캐시 컨트롤(Cache Control)](#캐시-컨트롤cache-control)
88
- * [파일 전송하기(Sending Files)](#파일-전송하기sending-files)
89
- * [요청 객체에 접근하기(Accessing the Request Object)](#요청-객체에-접근하기accessing-the-request-object)
90
- * [첨부(Attachments)](#첨부attachments)
91
- * [날짜와 시간 다루기](#날짜와-시간-다루기)
92
- * [템플릿 파일 참조하기](#템플릿-파일-참조하기)
93
- * [설정(Configuration)](#설정configuration)
94
- * [공격 방어 설정하기(Configuring attack protection)](#공격-방어-설정하기configuring-attack-protection)
95
- * [가능한 설정들(Available Settings)](#가능한-설정들available-settings)
96
- * [환경(Environments)](#환경environments)
97
- * [에러 처리(Error Handling)](#에러-처리error-handling)
98
- * [찾을 수 없음(Not Found)](#찾을-수-없음not-found)
99
- * [에러](#에러)
100
- * [Rack 미들웨어(Rack Middleware)](#rack-미들웨어rack-middleware)
101
- * [테스팅(Testing)](#테스팅testing)
102
- * [Sinatra::Base - 미들웨어(Middleware), 라이브러리(Libraries), 그리고 모듈 앱(Modular Apps)](#sinatrabase---미들웨어middleware-라이브러리libraries-그리고-모듈-앱modular-apps)
103
- * [모듈(Modular) vs. 전통적 방식(Classic Style)](#모듈modular-vs-전통적-방식classic-style)
104
- * [모듈 애플리케이션(Modular Application) 제공하기](#모듈-애플리케이션modular-application-제공하기)
105
- * [config.ru로 전통적 방식의 애플리케이션 사용하기](#configru로-전통적-방식의-애플리케이션-사용하기)
106
- * [언제 config.ru를 사용할까?](#언제-configru를-사용할까)
107
- * [Sinatra를 미들웨어로 사용하기](#sinatra를-미들웨어로-사용하기)
108
- * [동적인 애플리케이션 생성(Dynamic Application Creation)](#동적인-애플리케이션-생성dynamic-application-creation)
109
- * [범위(Scopes)와 바인딩(Binding)](#범위scopes와-바인딩binding)
110
- * [애플리케이션/클래스 범위](#애플리케이션클래스-범위)
111
- * [요청/인스턴스 범위](#요청인스턴스-범위)
112
- * [위임 범위(Delegation Scope)](#위임-범위delegation-scope)
113
- * [명령행(Command Line)](#명령행command-line)
114
- * [다중 스레드(Multi-threading)](#다중-스레드multi-threading)
115
- * [요구사항(Requirement)](#요구사항requirement)
116
- * [최신(The Bleeding Edge)](#최신the-bleeding-edge)
117
- * [Bundler를 사용하여](#bundler를-사용하여)
118
- * [직접 하기(Roll Your Own)](#직접-하기roll-your-own)
119
- * [전역으로 설치(Install Globally)](#전역으로-설치install-globally)
120
- * [버저닝(Versioning)](#버저닝versioning)
121
- * [더 읽을 거리(Further Reading)](#더-읽을-거리further-reading)
122
-
123
- ## 라우터(Routes)
124
-
125
- Sinatra에서, 라우터(route)는 URL-매칭 패턴과 쌍을 이루는 HTTP 메서드입니다.
126
- 각각의 라우터는 블록과 연결됩니다.
127
-
128
- ```ruby
129
- get '/' do
130
- .. 무언가 보여주기(show) ..
131
- end
132
-
133
- post '/' do
134
- .. 무언가 만들기(create) ..
135
- end
136
-
137
- put '/' do
138
- .. 무언가 대체하기(replace) ..
139
- end
140
-
141
- patch '/' do
142
- .. 무언가 수정하기(modify) ..
143
- end
144
-
145
- delete '/' do
146
- .. 무언가 없애기(annihilate) ..
147
- end
148
-
149
- options '/' do
150
- .. 무언가 주기(appease) ..
151
- end
152
-
153
- link '/' do
154
- .. 무언가 관계맺기(affiliate) ..
155
- end
156
-
157
- unlink '/' do
158
- .. 무언가 격리하기(separate) ..
159
- end
160
- ```
161
-
162
- 라우터는 정의된 순서에 따라 매치되고 요청에 대해 가장 먼저 매칭된 라우터가 호출됩니다.
163
-
164
- 라우터 패턴에는 이름을 가진 매개변수가 포함될 수 있으며, `params` 해시로 접근할 수 있습니다.
165
-
166
- ```ruby
167
- get '/hello/:name' do
168
- # "GET /hello/foo" 및 "GET /hello/bar"와 매치
169
- # params['name']은 'foo' 또는 'bar'
170
- "Hello #{params['name']}!"
171
- end
172
- ```
173
-
174
- 또한 블록 매개변수를 통하여도 이름을 가진 매개변수에 접근할 수 있습니다.
175
-
176
- ```ruby
177
- get '/hello/:name' do |n|
178
- # "GET /hello/foo" 및 "GET /hello/bar"와 매치
179
- # params['name']은 'foo' 또는 'bar'
180
- # n 에는 params['name']가 저장
181
- "Hello #{n}!"
182
- end
183
- ```
184
-
185
- 라우터 패턴에는 스플랫(splat, 또는 와일드카드)도 매개변수도 포함될 수 있으며, 이럴 경우 `params['splat']` 배열을 통해 접근할 수 있습니다.
186
-
187
- ```ruby
188
- get '/say/*/to/*' do
189
- # /say/hello/to/world와 매치
190
- params['splat'] # => ["hello", "world"]
191
- end
192
-
193
- get '/download/*.*' do
194
- # /download/path/to/file.xml과 매치
195
- params['splat'] # => ["path/to/file", "xml"]
196
- end
197
- ```
198
-
199
- 블록 매개변수로도 접근할 수 있습니다.
200
-
201
- ```ruby
202
- get '/download/*.*' do |path, ext|
203
- [path, ext] # => ["path/to/file", "xml"]
204
- end
205
- ```
206
-
207
- 라우터는 정규표현식으로 매치할 수 있습니다.
208
-
209
- ```ruby
210
- get /\/hello\/([\w]+)/ do
211
- "Hello, #{params['captures'].first}!"
212
- end
213
- ```
214
-
215
- 블록 매개변수로도 사용가능합니다.
216
-
217
- ```ruby
218
- get %r{/hello/([\w]+)} do |c|
219
- # "GET /meta/hello/world", "GET /hello/world/1234" 등과 매치
220
- "Hello, #{c}!"
221
- end
222
- ```
223
-
224
- 라우터 패턴에는 선택적인(optional) 매개변수도 올 수 있습니다.
225
-
226
- ```ruby
227
- get '/posts/:format?' do
228
- # "GET /posts/" 는 물론 "GET /posts/json", "GET /posts/xml" 와 같은 어떤 확장자와도 매칭
229
- end
230
- ```
231
-
232
- 쿼리 파라메터로도 이용가능 합니다.
233
-
234
- ```ruby
235
- get '/posts' do
236
- # matches "GET /posts?title=foo&author=bar"
237
- title = params['title']
238
- author = params['author']
239
- # uses title and author variables; query is optional to the /posts route
240
- end
241
- ```
242
-
243
- 한편, 경로 탐색 공격 방지(path traversal attack protection, 아래 참조)를 비활성화시키지 않았다면,
244
- 요청 경로는 라우터와 매칭되기 이전에 수정될 수 있습니다.
245
-
246
- ### 조건(Conditions)
247
-
248
- 라우터는 사용자 에이전트(user agent)같은 다양한 매칭 조건을 포함할 수 있습니다.
249
-
250
- ```ruby
251
- get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do
252
- "Songbird 버전 #{params['agent'][0]}을 사용하는군요!"
253
- end
254
-
255
- get '/foo' do
256
- # songbird 브라우저가 아닌 경우 매치
257
- end
258
- ```
259
-
260
- 다른 가능한 조건에는 `host_name`과 `provides`가 있습니다.
261
-
262
- ```ruby
263
- get '/', :host_name => /^admin\./ do
264
- "Admin Area, Access denied!"
265
- end
266
-
267
- get '/', :provides => 'html' do
268
- haml :index
269
- end
270
-
271
- get '/', :provides => ['rss', 'atom', 'xml'] do
272
- builder :feed
273
- end
274
- ```
275
- `provides`는 request의 허용된 해더를 검색합니다.
276
-
277
- 사용자 정의 조건도 쉽게 만들 수 있습니다.
278
-
279
- ```ruby
280
- set(:probability) { |value| condition { rand <= value } }
281
-
282
- get '/win_a_car', :probability => 0.1 do
283
- "내가 졌소!"
284
- end
285
-
286
- get '/win_a_car' do
287
- "미안해서 어쩌나."
288
- end
289
- ```
290
-
291
- 여러 값을 받는 조건에는 스플랫(splat)을 사용합니다.
292
-
293
- ```ruby
294
- set(:auth) do |*roles| # <- 이게 스플랫
295
- condition do
296
- unless logged_in? && roles.any? {|role| current_user.in_role? role }
297
- redirect "/login/", 303
298
- end
299
- end
300
- end
301
-
302
- get "/my/account/", :auth => [:user, :admin] do
303
- "내 계정 정보"
304
- end
305
-
306
- get "/only/admin/", :auth => :admin do
307
- "관리자 외 접근불가!"
308
- end
309
- ```
310
-
311
- ### 반환값(Return Values)
312
-
313
- 라우터 블록의 반환 값은 HTTP 클라이언트로 전달되는 응답 본문만을 결정하거나, 또는 Rack 스택에서 다음 번 미들웨어만를 결정합니다.
314
- 위의 예제에서 볼 수 있지만 대부분의 경우 이 반환값은 문자열입니다.하지만 다른 값도 허용됩니다.
315
-
316
- 유효한 Rack 응답, Rack 본문 객체 또는 HTTP 상태 코드가 되는 어떠한 객체라도 반환할 수 있습니다.
317
-
318
- * 세 요소를 가진 배열: `[상태 (Integer), 헤더 (Hash), 응답 본문 (#each에 반응)]`
319
- * 두 요소를 가진 배열: `[상태 (Integer), 응답 본문 (#each에 반응)]`
320
- * `#each`에 반응하고 주어진 블록으로 문자열만을 전달하는 객체
321
- * 상태 코드를 의미하는 Integer
322
-
323
- 이것을 이용한 예를 들자면, 스트리밍(streaming) 예제를 쉽게 구현할 수 있습니다.
324
-
325
- ```ruby
326
- class Stream
327
- def each
328
- 100.times { |i| yield "#{i}\n" }
329
- end
330
- end
331
-
332
- get('/') { Stream.new }
333
- ```
334
-
335
- `stream` 헬퍼 메서드(아래 참조)를 사용하면 이런 번거로움을 줄이고 스트리밍 로직을 라우터 속에 포함 시킬 수도 있습니다.
336
-
337
- ### 커스텀 라우터 매처(Custom Route Matchers)
338
-
339
- 위에서 보듯, Sinatra에는 문자열 패턴 및 정규표현식을 이용한 라우터 매칭 지원이 내장되어 있습니다.
340
- 하지만, 그게 끝은 아닙니다. 여러분 만의 매처(matcher)도 쉽게 정의할 수 있습니다.
341
-
342
- ```ruby
343
- class AllButPattern
344
- Match = Struct.new(:captures)
345
-
346
- def initialize(except)
347
- @except = except
348
- @captures = Match.new([])
349
- end
350
-
351
- def match(str)
352
- @captures unless @except === str
353
- end
354
- end
355
-
356
- def all_but(pattern)
357
- AllButPattern.new(pattern)
358
- end
359
-
360
- get all_but("/index") do
361
- # ...
362
- end
363
- ```
364
-
365
- 사실 위의 예제는 조금 과하게 작성된 면이 있습니다. 간단하게 표현할 수도 있어요.
366
-
367
- ```ruby
368
- get // do
369
- pass if request.path_info == "/index"
370
- # ...
371
- end
372
- ```
373
-
374
- 또는 거꾸로 탐색(negative look ahead)할 수도 있습니다.
375
-
376
- ```ruby
377
- get %r{(?!/index)} do
378
- # ...
379
- end
380
- ```
381
-
382
- ## 정적 파일(Static Files)
383
-
384
- 정적 파일들은 `./public` 디렉터리에서 제공됩니다. 위치를 다른 곳으로
385
- 변경하려면 `:public_folder` 옵션을 지정하면 됩니다.
386
-
387
- ```ruby
388
- set :public_folder, __dir__ + '/static'
389
- ```
390
-
391
- public 디렉터리명은 URL에 포함되지 않는다는 점에 주의하세요.
392
- `./public/css/style.css` 파일은 아마 `http://example.com/css/style.css` 로 접근할 수 있을 것입니다.
393
-
394
- `Cache-Control` 헤더 정보를 추가하려면 `:static_cache_control` 설정(아래 참조)을 사용하면 됩니다.
395
-
396
- ## 뷰 / 템플릿(Views / Templates)
397
-
398
- 템플릿 언어들은 각각의 렌더링 메서드를 통해 표출됩니다.
399
- 이들 메서드는 문자열을 반환할 뿐입니다.
400
-
401
- ```ruby
402
- get '/' do
403
- erb :index
404
- end
405
- ```
406
-
407
- 이 구문은 `views/index.erb`를 렌더합니다.
408
-
409
- 템플릿 이름 대신 템플릿의 내용을 직접 넘길 수도 있습니다.
410
-
411
- ```ruby
412
- get '/' do
413
- code = "<%= Time.now %>"
414
- erb code
415
- end
416
- ```
417
-
418
- 템플릿은 두 번째 인자로 옵션값의 해시를 받습니다.
419
-
420
- ```ruby
421
- get '/' do
422
- erb :index, :layout => :post
423
- end
424
- ```
425
-
426
- 이 구문은 `views/post.erb` 속에 내장된 `views/index.erb`를 렌더합니다.
427
- (`views/layout.erb`파일이 존재할 경우 기본값은 `views/layout.erb`입니다.)
428
-
429
- Sinatra가 이해하지 못하는 모든 옵션값들은 템플릿 엔진으로 전달됩니다.
430
-
431
- ```ruby
432
- get '/' do
433
- haml :index, :format => :html5
434
- end
435
- ```
436
-
437
- 옵션값은 템플릿 언어별로 전역적으로 설정할 수도 있습니다.
438
-
439
- ```ruby
440
- set :haml, :format => :html5
441
-
442
- get '/' do
443
- haml :index
444
- end
445
- ```
446
-
447
- render 메서드에서 전달된 옵션값들은 `set`을 통해 설정한 옵션값보다 우선합니다.
448
-
449
- 가능한 옵션값들은 다음과 같습니다.
450
-
451
- <dl>
452
- <dt>locals</dt>
453
- <dd>
454
- 문서로 전달되는 local 목록. 파셜과 함께 사용하기 좋음.
455
- 예제: <tt>erb "<%= foo %>", :locals => {:foo => "bar"}</tt>
456
- </dd>
457
-
458
- <dt>default_encoding</dt>
459
- <dd>
460
- 불확실한 경우에 사용할 문자열 인코딩.
461
- 기본값은 <tt>settings.default_encoding</tt>.
462
- </dd>
463
-
464
- <dt>views</dt>
465
- <dd>
466
- 템플릿을 로드할 뷰 폴더.
467
- 기본값은 <tt>settings.views</tt>.
468
- </dd>
469
-
470
- <dt>layout</dt>
471
- <dd>
472
- 레이아웃을 사용할지 여부 (<tt>true</tt> 또는 <tt>false</tt>), 만약
473
- 이 값이 심볼일 경우, 사용할 템플릿을 지정. 예제:
474
- <tt>erb :index, :layout => !request.xhr?</tt>
475
- </dd>
476
-
477
- <dt>content_type</dt>
478
- <dd>
479
- 템플릿이 생성하는 Content-Type, 기본값은 템플릿 언어에 의존.
480
- </dd>
481
-
482
- <dt>scope</dt>
483
- <dd>
484
- 템플릿을 렌더링하는 범위. 기본값은 어플리케이션 인스턴스.
485
- 만약 이 값을 변경하면, 인스턴스 변수와 헬퍼 메서드들을 사용할 수 없게 됨.
486
- </dd>
487
-
488
- <dt>layout_engine</dt>
489
- <dd>
490
- 레이아웃 렌더링에 사용할 템플릿 엔진. 레이아웃을 지원하지 않는 언어인 경우에 유용.
491
- 기본값은 템플릿에서 사용하는 엔진. 예제: <tt>set :rdoc, :layout_engine => :erb</tt>
492
- </dd>
493
- </dl>
494
-
495
-
496
- 템플릿은 `./views` 디렉터리에 있는 것으로 가정됩니다. 뷰 디렉터리를
497
- 다른 곳으로 하고 싶으시면 이렇게 하세요.
498
-
499
- ```ruby
500
- set :views, settings.root + '/templates'
501
- ```
502
-
503
- 템플릿은 언제나 심볼로 참조되어야 한다는 것에 주의하세요.
504
- 템플릿이 하위 디렉터리에 위치한 경우(그럴 경우에는 `:'subdir/template'`을
505
- 사용)에도 예외는 없습니다. 반드시 심볼이어야 하는 이유는, 문자열을 넘기면
506
- 렌더링 메서드가 전달된 문자열을 직접 렌더하기 때문입니다.
507
-
508
- ### 리터럴 템플릿(Literal Templates)
509
-
510
- ```ruby
511
- get '/' do
512
- haml '%div.title Hello World'
513
- end
514
- ```
515
-
516
- 템플릿 문자열을 렌더합니다.
517
-
518
- ### 가능한 템플릿 언어들(Available Template Languages)
519
-
520
- 일부 언어는 여러 개의 구현이 있습니다. (스레드에 안전하게 thread-safe) 어느 구현을
521
- 사용할지 저정하려면, 먼저 require 하기만 하면 됩니다.
522
-
523
- ```ruby
524
- require 'rdiscount' # or require 'bluecloth'
525
- get('/') { markdown :index }
526
- ```
527
-
528
- #### Haml 템플릿
529
-
530
- <table>
531
- <tr>
532
- <td>의존성</td>
533
- <td><a href="http://haml.info/">haml</a></td>
534
- </tr>
535
- <tr>
536
- <td>파일 확장자</td>
537
- <td><tt>.haml</tt></td>
538
- </tr>
539
- <tr>
540
- <td>예제</td>
541
- <td><tt>haml :index, :format => :html5</tt></td>
542
- </tr>
543
- </table>
544
-
545
- #### Erb 템플릿
546
-
547
- <table>
548
- <tr>
549
- <td>의존성</td>
550
- <td><a href="http://www.kuwata-lab.com/erubis/">erubis</a> 또는 erb (루비 속에 포함)</td>
551
- </tr>
552
- <tr>
553
- <td>파일 확장자</td>
554
- <td><tt>.erb</tt>, <tt>.rhtml</tt>, <tt>.erubis</tt> (Erubis만 해당)</td>
555
- </tr>
556
- <tr>
557
- <td>예제</td>
558
- <td><tt>erb :index</tt></td>
559
- </tr>
560
- </table>
561
-
562
- #### Builder 템플릿
563
-
564
- <table>
565
- <tr>
566
- <td>의존성</td>
567
- <td><a href="https://github.com/jimweirich/builder">builder</a></td>
568
- </tr>
569
- <tr>
570
- <td>파일 확장자</td>
571
- <td><tt>.builder</tt></td>
572
- </tr>
573
- <tr>
574
- <td>예제</td>
575
- <td><tt>builder { |xml| xml.em "hi" }</tt></td>
576
- </tr>
577
- </table>
578
-
579
- 인라인 템플릿으로 블록을 받을 수도 있습니다(예제 참조).
580
-
581
- #### Nokogiri 템플릿
582
-
583
- <table>
584
- <tr>
585
- <td>의존성</td>
586
- <td><a href="http://www.nokogiri.org/">nokogiri</a></td>
587
- </tr>
588
- <tr>
589
- <td>파일 확장자</td>
590
- <td><tt>.nokogiri</tt></td>
591
- </tr>
592
- <tr>
593
- <td>예제</td>
594
- <td><tt>nokogiri { |xml| xml.em "hi" }</tt></td>
595
- </tr>
596
- </table>
597
-
598
- 인라인 템플릿으로 블록을 받을 수도 있습니다(예제 참조).
599
-
600
- #### Sass 템플릿
601
-
602
- <table>
603
- <tr>
604
- <td>의존성</td>
605
- <td><a href="http://sass-lang.com/">sass</a></td>
606
- </tr>
607
- <tr>
608
- <td>파일 확장자</td>
609
- <td><tt>.sass</tt></td>
610
- </tr>
611
- <tr>
612
- <td>예제</td>
613
- <td><tt>sass :stylesheet, :style => :expanded</tt></td>
614
- </tr>
615
- </table>
616
-
617
- #### SCSS 템플릿
618
-
619
- <table>
620
- <tr>
621
- <td>의존성</td>
622
- <td><a href="http://sass-lang.com/">sass</a></td>
623
- </tr>
624
- <tr>
625
- <td>파일 확장자</td>
626
- <td><tt>.scss</tt></td>
627
- </tr>
628
- <tr>
629
- <td>예제</td>
630
- <td><tt>scss :stylesheet, :style => :expanded</tt></td>
631
- </tr>
632
- </table>
633
-
634
- #### Less 템플릿
635
-
636
- <table>
637
- <tr>
638
- <td>의존성</td>
639
- <td><a href="http://lesscss.org/">less</a></td>
640
- </tr>
641
- <tr>
642
- <td>파일 확장자</td>
643
- <td><tt>.less</tt></td>
644
- </tr>
645
- <tr>
646
- <td>예제</td>
647
- <td><tt>less :stylesheet</tt></td>
648
- </tr>
649
- </table>
650
-
651
- #### Liquid 템플릿
652
-
653
- <table>
654
- <tr>
655
- <td>의존성</td>
656
- <td><a href="https://shopify.github.io/liquid/">liquid</a></td>
657
- </tr>
658
- <tr>
659
- <td>파일 확장자</td>
660
- <td><tt>.liquid</tt></td>
661
- </tr>
662
- <tr>
663
- <td>예제</td>
664
- <td><tt>liquid :index, :locals => { :key => 'value' }</tt></td>
665
- </tr>
666
- </table>
667
-
668
- Liquid 템플릿에서는 루비 메서드(`yield` 제외)를 호출할 수 없기
669
- 때문에, 거의 대부분의 경우 locals를 전달해야 합니다.
670
-
671
- #### Markdown 템플릿
672
-
673
- <table>
674
- <tr>
675
- <td>의존성</td>
676
- <td>
677
- <a href="https://github.com/davidfstr/rdiscount" title="RDiscount">RDiscount</a>,
678
- <a href="https://github.com/vmg/redcarpet" title="RedCarpet">RedCarpet</a>,
679
- <a href="https://github.com/ged/bluecloth" title="bluecloth">BlueCloth</a>,
680
- <a href="http://kramdown.gettalong.org/" title="kramdown">kramdown</a>,
681
- <a href="https://github.com/bhollis/maruku" title="maruku">maruku</a>
682
- 중 아무거나
683
- </td>
684
- </tr>
685
- <tr>
686
- <td>파일 확장</td>
687
- <td><tt>.markdown</tt>, <tt>.mkd</tt>, <tt>.md</tt></td>
688
- </tr>
689
- <tr>
690
- <td>예제</td>
691
- <td><tt>markdown :index, :layout_engine => :erb</tt></td>
692
- </tr>
693
- </table>
694
-
695
- Markdown에서는 메서드 호출 뿐 아니라 locals 전달도 안됩니다.
696
- 따라서 일반적으로는 다른 렌더링 엔진과 함께 사용하게 됩니다.
697
-
698
- ```ruby
699
- erb :overview, :locals => { :text => markdown(:introduction) }
700
- ```
701
-
702
- 다른 템플릿 속에서 `markdown` 메서드를 호출할 수도 있습니다.
703
-
704
- ```ruby
705
- %h1 안녕 Haml!
706
- %p= markdown(:greetings)
707
- ```
708
-
709
- Markdown에서 루비를 호출할 수 없기 때문에, Markdown으로 작성된 레이아웃은
710
- 사용할 수 없습니다. 하지만, `:layout_engine` 옵션으로 레이아웃의 템플릿을
711
- 다른 렌더링 엔진으로 렌더링 할 수는 있습니다.
712
-
713
- #### Textile 템플릿
714
-
715
- <table>
716
- <tr>
717
- <td>의존성</td>
718
- <td><a href="http://redcloth.org/">RedCloth</a></td>
719
- </tr>
720
- <tr>
721
- <td>파일 확장자</td>
722
- <td><tt>.textile</tt></td>
723
- </tr>
724
- <tr>
725
- <td>예제</td>
726
- <td><tt>textile :index, :layout_engine => :erb</tt></td>
727
- </tr>
728
- </table>
729
-
730
- Textile에서는 메서드 호출 뿐 아니라 locals 전달도 안됩니다.
731
- 따라서 일반적으로는 다른 렌더링 엔진과 함께 사용하게 됩니다.
732
-
733
- ```ruby
734
- erb :overview, :locals => { :text => textile(:introduction) }
735
- ```
736
-
737
- 다른 템플릿 속에서 `textile` 메서드를 호출할 수도 있습니다.
738
-
739
- ```ruby
740
- %h1 안녕 Haml!
741
- %p= textile(:greetings)
742
- ```
743
-
744
- Textile에서 루비를 호출할 수 없기 때문에, Textile으로 작성된 레이아웃은
745
- 사용할 수 없습니다. 하지만, `:layout_engine` 옵션으로 레이아웃의 템플릿을
746
- 다른 렌더링 엔진으로 렌더링 할 수는 있습니다.
747
-
748
- #### RDoc 템플릿
749
-
750
- <table>
751
- <tr>
752
- <td>의존성</td>
753
- <td><a href="http://rdoc.sourceforge.net/" title="RDoc">rdoc</a></td>
754
- </tr>
755
- <tr>
756
- <td>파일 확장자</td>
757
- <td><tt>.rdoc</tt></td>
758
- </tr>
759
- <tr>
760
- <td>예제</td>
761
- <td><tt>rdoc :README, :layout_engine => :erb</tt></td>
762
- </tr>
763
- </table>
764
-
765
- RDoc에서는 메서드 호출 뿐 아니라 locals 전달도 안됩니다.
766
- 따라서 일반적으로는 다른 렌더링 엔진과 함께 사용하게 됩니다.
767
-
768
- ```ruby
769
- erb :overview, :locals => { :text => rdoc(:introduction) }
770
- ```
771
-
772
- 다른 템플릿 속에서 `rdoc` 메서드를 호출할 수도 있습니다.
773
-
774
- ```ruby
775
- %h1 Hello From Haml!
776
- %p= rdoc(:greetings)
777
- ```
778
-
779
- RDoc에서 루비를 호출할 수 없기 때문에, RDoc으로 작성된 레이아웃은
780
- 사용할 수 없습니다. 하지만, `:layout_engine` 옵션으로 레이아웃의 템플릿을
781
- 다른 렌더링 엔진으로 렌더링 할 수는 있습니다.
782
-
783
- #### AsciiDoc 템플릿
784
-
785
- <table>
786
- <tr>
787
- <td>의존성</td>
788
- <td><a href="http://asciidoctor.org/" title="Asciidoctor">Asciidoctor</a></td>
789
- </tr>
790
- <tr>
791
- <td>파일 확장자</td>
792
- <td><tt>.asciidoc</tt>, <tt>.adoc</tt> and <tt>.ad</tt></td>
793
- </tr>
794
- <tr>
795
- <td>예제</td>
796
- <td><tt>asciidoc :README, :layout_engine => :erb</tt></td>
797
- </tr>
798
- </table>
799
-
800
- AsciiDoc 템플릿에서는 루비 메서드를 호출할 수 없기
801
- 때문에, 거의 대부분의 경우 locals를 전달해야 합니다.
802
-
803
- #### Radius 템플릿
804
-
805
- <table>
806
- <tr>
807
- <td>의존성</td>
808
- <td><a href="https://github.com/jlong/radius" title="Radius">radius</a></td>
809
- </tr>
810
- <tr>
811
- <td>파일 확장자</td>
812
- <td><tt>.radius</tt></td>
813
- </tr>
814
- <tr>
815
- <td>예제</td>
816
- <td><tt>radius :index, :locals => { :key => 'value' }</tt></td>
817
- </tr>
818
- </table>
819
-
820
- Radius 템플릿에서는 루비 메서드를 호출할 수 없기
821
- 때문에, 거의 대부분의 경우 locals를 전달해야 합니다.
822
-
823
- #### Markaby 템플릿
824
-
825
- <table>
826
- <tr>
827
- <td>의존성</td>
828
- <td><a href="http://markaby.github.io/">markaby</a></td>
829
- </tr>
830
- <tr>
831
- <td>파일확장</td>
832
- <td><tt>.mab</tt></td>
833
- </tr>
834
- <tr>
835
- <td>예제</td>
836
- <td><tt>markaby { h1 "Welcome!" }</tt></td>
837
- </tr>
838
- </table>
839
-
840
- 인라인 템플릿으로 블록을 받을 수도 있습니다(예제 참조).
841
-
842
- #### RABL 템플릿
843
-
844
- <table>
845
- <tr>
846
- <td>의존성</td>
847
- <td><a href="https://github.com/nesquena/rabl">rabl</a></td>
848
- </tr>
849
- <tr>
850
- <td>파일 확장자</td>
851
- <td><tt>.rabl</tt></td>
852
- </tr>
853
- <tr>
854
- <td>예제</td>
855
- <td><tt>rabl :index</tt></td>
856
- </tr>
857
- </table>
858
-
859
- #### Slim 템플릿
860
-
861
- <table>
862
- <tr>
863
- <td>의존성</td>
864
- <td><a href="http://slim-lang.com/">slim</a></td>
865
- </tr>
866
- <tr>
867
- <td>파일 확장자</td>
868
- <td><tt>.slim</tt></td>
869
- </tr>
870
- <tr>
871
- <td>예제</td>
872
- <td><tt>slim :index</tt></td>
873
- </tr>
874
- </table>
875
-
876
- #### Creole 템플릿
877
-
878
- <table>
879
- <tr>
880
- <td>의존성</td>
881
- <td><a href="https://github.com/minad/creole">creole</a></td>
882
- </tr>
883
- <tr>
884
- <td>파일 확장자</td>
885
- <td><tt>.creole</tt></td>
886
- </tr>
887
- <tr>
888
- <td>예제</td>
889
- <td><tt>creole :wiki, :layout_engine => :erb</tt></td>
890
- </tr>
891
- </table>
892
-
893
- Creole에서는 메서드 호출 뿐 아니라 locals 전달도 안됩니다.
894
- 따라서 일반적으로는 다른 렌더링 엔진과 함께 사용하게 됩니다.
895
-
896
- ```ruby
897
- erb :overview, :locals => { :text => creole(:introduction) }
898
- ```
899
-
900
- 다른 템플릿 속에서 `creole` 메서드를 호출할 수도 있습니다.
901
-
902
- ```ruby
903
- %h1 Hello From Haml!
904
- %p= creole(:greetings)
905
- ```
906
-
907
- Creole에서 루비를 호출할 수 없기 때문에, Creole으로 작성된 레이아웃은
908
- 사용할 수 없습니다. 하지만, `:layout_engine` 옵션으로 레이아웃의 템플릿을
909
- 다른 렌더링 엔진으로 렌더링 할 수는 있습니다.
910
-
911
- #### MediaWiki 템플릿
912
-
913
- <table>
914
- <tr>
915
- <td>의존성</td>
916
- <td><a href="https://github.com/nricciar/wikicloth" title="WikiCloth">WikiCloth</a></td>
917
- </tr>
918
- <tr>
919
- <td>파일 확장자</td>
920
- <td><tt>.mediawiki</tt> and <tt>.mw</tt></td>
921
- </tr>
922
- <tr>
923
- <td>예제</td>
924
- <td><tt>mediawiki :wiki, :layout_engine => :erb</tt></td>
925
- </tr>
926
- </table>
927
-
928
- MediaWiki 마크업에서는 메서드 호출 뿐 아니라 locals 전달도 불가능합니다.
929
- 따라서 일반적으로는 다른 렌더링 엔진과 함께 사용하게 됩니다.
930
-
931
- ```ruby
932
- erb :overview, :locals => { :text => mediawiki(:introduction) }
933
- ```
934
-
935
- 다른 템플릿 속에서 `mediawiki` 메서드를 호출할 수도 있습니다.
936
-
937
- ```ruby
938
- %h1 Hello From Haml!
939
- %p= mediawiki(:greetings)
940
- ```
941
-
942
- MediaWiki에서 루비를 호출할 수 없기 때문에, MediaWiki으로 작성된 레이아웃은
943
- 사용할 수 없습니다. 하지만, `:layout_engine` 옵션으로 레이아웃의 템플릿을
944
- 다른 렌더링 엔진으로 렌더링 할 수는 있습니다.
945
-
946
- #### CoffeeScript 템플릿
947
-
948
- <table>
949
- <tr>
950
- <td>의존성</td>
951
- <td>
952
- <a href="https://github.com/josh/ruby-coffee-script" title="Ruby CoffeeScript">
953
- CoffeeScript
954
- </a> 와
955
- <a href="https://github.com/sstephenson/execjs/blob/master/README.md#readme" title="ExecJS">
956
- 자바스크립트 실행법
957
- </a>
958
- </td>
959
- </tr>
960
- <tr>
961
- <td>파일 확장자</td>
962
- <td><tt>.coffee</tt></td>
963
- </tr>
964
- <tr>
965
- <td>예제</td>
966
- <td><tt>coffee :index</tt></td>
967
- </tr>
968
- </table>
969
-
970
- #### Stylus 템플릿
971
-
972
- <table>
973
- <tr>
974
- <td>의존성</td>
975
- <td>
976
- <a href="https://github.com/forgecrafted/ruby-stylus" title="Ruby Stylus">
977
- Stylus
978
- </a> 와
979
- <a href="https://github.com/sstephenson/execjs/blob/master/README.md#readme" title="ExecJS">
980
- 자바스크립트 실행법
981
- </a>
982
- </td>
983
- </tr>
984
- <tr>
985
- <td>파일 확장자</td>
986
- <td><tt>.styl</tt></td>
987
- </tr>
988
- <tr>
989
- <td>예제</td>
990
- <td><tt>stylus :index</tt></td>
991
- </tr>
992
- </table>
993
-
994
- Stylus 템플릿을 사용가능하게 하려면, 먼저 `stylus`와 `stylus/tilt`를 로드
995
- 해야합니다.
996
-
997
- ```ruby
998
- require 'sinatra'
999
- require 'stylus'
1000
- require 'stylus/tilt'
1001
-
1002
- get '/' do
1003
- stylus :example
1004
- end
1005
- ```
1006
-
1007
- #### Yajl 템플릿
1008
-
1009
- <table>
1010
- <tr>
1011
- <td>의존성</td>
1012
- <td><a href="https://github.com/brianmario/yajl-ruby">yajl-ruby</a></td>
1013
- </tr>
1014
- <tr>
1015
- <td>파일 확장자</td>
1016
- <td><tt>.yajl</tt></td>
1017
- </tr>
1018
- <tr>
1019
- <td>예제</td>
1020
- <td>
1021
- <tt>
1022
- yajl :index,
1023
- :locals => { :key => 'qux' },
1024
- :callback => 'present',
1025
- :variable => 'resource'
1026
- </tt>
1027
- </td>
1028
- </tr>
1029
- </table>
1030
-
1031
- 템플릿 소스는 루비 문자열로 평가(evaluate)되고, 결과인 json 변수는 `#to_json`으로 변환됩니다.
1032
-
1033
- ```ruby
1034
- json = { :foo => 'bar' }
1035
- json[:baz] = key
1036
- ```
1037
-
1038
- `:callback`과 `:variable` 옵션은 렌더된 객체를 꾸미는데(decorate) 사용할 수 있습니다.
1039
-
1040
- ```javascript
1041
- var resource = {"foo":"bar","baz":"qux"};
1042
- present(resource);
1043
- ```
1044
-
1045
- #### WLang 템플릿
1046
-
1047
- <table>
1048
- <tr>
1049
- <td>의존성</td>
1050
- <td><a href="https://github.com/blambeau/wlang/" title="WLang">WLang</a></td>
1051
- </tr>
1052
- <tr>
1053
- <td>파일 확장자</td>
1054
- <td><tt>.wlang</tt></td>
1055
- </tr>
1056
- <tr>
1057
- <td>예제</td>
1058
- <td><tt>wlang :index, :locals => { :key => 'value' }</tt></td>
1059
- </tr>
1060
- </table>
1061
-
1062
- WLang 템플릿에서는 루비 메서드를 사용하는게 일반적이지 않기
1063
- 때문에, 거의 대부분의 경우 locals를 전달합니다. 그래도
1064
- WLang으로 쓰여진 레이아웃과 `yield`는 지원합니다.
1065
-
1066
- ### 템플릿에서 변수에 접근하기
1067
-
1068
- 템플릿은 라우터 핸들러와 같은 맥락(context)에서 평가됩니다. 라우터
1069
- 핸들러에서 설정한 인스턴스 변수들은 템플릿에서 직접 접근 가능합니다.
1070
-
1071
- ```ruby
1072
- get '/:id' do
1073
- @foo = Foo.find(params['id'])
1074
- haml '%h1= @foo.name'
1075
- end
1076
- ```
1077
-
1078
- 명시적으로 로컬 변수의 해시를 지정할 수도 있습니다.
1079
-
1080
- ```ruby
1081
- get '/:id' do
1082
- foo = Foo.find(params['id'])
1083
- haml '%h1= bar.name', :locals => { :bar => foo }
1084
- end
1085
- ```
1086
-
1087
- 이 방법은 주로 템플릿을 다른 템플릿 속에서 파셜(partial)로 렌더링할
1088
- 때 사용됩니다.
1089
-
1090
- ### 템플릿에서의 `yield` 와 중첩 레이아웃
1091
-
1092
- 레이아웃은 보통 `yield`만 호출하는 템플릿입니다.
1093
- 위에 설명된 `:template` 옵션을 통해 템플릿을 사용하거나,
1094
- 다음 예제처럼 블록으로 렌더링 할 수 있습니다.
1095
-
1096
- ```ruby
1097
- erb :post, :layout => false do
1098
- erb :index
1099
- end
1100
- ```
1101
-
1102
- 위 코드는 `erb :index, :layout => :post`와 대부분 동일합니다.
1103
-
1104
- 렌더링 메서드에 블록 넘기기는 중첩 레이아웃을 만들때 유용합니다.
1105
-
1106
- ```ruby
1107
- erb :main_layout, :layout => false do
1108
- erb :admin_layout do
1109
- erb :user
1110
- end
1111
- end
1112
- ```
1113
-
1114
- 위의 코드도 줄일 수 있습니다.
1115
-
1116
- ```ruby
1117
- erb :admin_layout, :layout => :main_layout do
1118
- erb :user
1119
- end
1120
- ```
1121
-
1122
- 현재, `erb`, `haml`, `liquid`, `slim `, `wlang`는 블럭을 지원합니다.
1123
- 일반적인 `render` 메소드도 블럭을 지원합니다.
1124
-
1125
- ### 인라인 템플릿
1126
-
1127
- 템플릿은 소스 파일의 마지막에서 정의할 수도 있습니다.
1128
-
1129
- ```ruby
1130
- require 'sinatra'
1131
-
1132
- get '/' do
1133
- haml :index
1134
- end
1135
-
1136
- __END__
1137
-
1138
- @@ layout
1139
- %html
1140
- = yield
1141
-
1142
- @@ index
1143
- %div.title Hello world.
1144
- ```
1145
-
1146
- 참고: sinatra를 require한 소스 파일에 정의된 인라인 템플릿은 자동으로
1147
- 로드됩니다. 다른 소스 파일에서 인라인 템플릿을 사용하려면 명시적으로
1148
- `enable :inline_templates`을 호출하면 됩니다.
1149
-
1150
- ### 이름을 가지는 템플릿(Named Templates)
1151
-
1152
- 템플릿은 톱 레벨(top-level)에서 `template`메서드로도 정의할 수 있습니다.
1153
-
1154
- ```ruby
1155
- template :layout do
1156
- "%html\n =yield\n"
1157
- end
1158
-
1159
- template :index do
1160
- '%div.title Hello World!'
1161
- end
1162
-
1163
- get '/' do
1164
- haml :index
1165
- end
1166
- ```
1167
-
1168
- "layout"이라는 이름의 템플릿이 존재하면, 템플릿이 렌더될 때마다 사용됩니다.
1169
- 레이아웃을 비활성화할 때는 `:layout => false`를 전달하여 개별적으로
1170
- 비활성시키거나 `set :haml, :layout => false`으로 기본값을 비활성으로 둘 수
1171
- 있습니다.
1172
-
1173
- ```ruby
1174
- get '/' do
1175
- haml :index, :layout => !request.xhr?
1176
- end
1177
- ```
1178
-
1179
- ### 파일 확장자 연결하기
1180
-
1181
- 어떤 파일 확장자를 특정 템플릿 엔진과 연결하려면, `Tilt.register`를 사용하면
1182
- 됩니다. 예를 들어, `tt`라는 파일 확장자를 Textile 템플릿과 연결하고 싶다면,
1183
- 다음과 같이 하면 됩니다.
1184
-
1185
- ```ruby
1186
- Tilt.register :tt, Tilt[:textile]
1187
- ```
1188
-
1189
- ### 나만의 고유한 템플릿 엔진 추가하기
1190
-
1191
- 우선, Tilt로 여러분 엔진을 등록하고, 렌더링 메서드를 생성합니다.
1192
-
1193
- ```ruby
1194
- Tilt.register :myat, MyAwesomeTemplateEngine
1195
-
1196
- helpers do
1197
- def myat(*args) render(:myat, *args) end
1198
- end
1199
-
1200
- get '/' do
1201
- myat :index
1202
- end
1203
- ```
1204
-
1205
- 위 코드는 `./views/index.myat` 를 렌더합니다.
1206
- Tilt에 대한 더 자세한 내용은 https://github.com/rtomayko/tilt 참조하세요.
1207
-
1208
- ### 템플릿 검사를 위한 커스텀 로직 사용하기
1209
-
1210
- 고유한 템플릿 룩업을 구현하기 위해서는 `#find_template` 메서드를 만드셔야 합니다.
1211
-
1212
- ```ruby
1213
- configure do
1214
- set :views [ './views/a', './views/b' ]
1215
- end
1216
-
1217
- def find_template(views, name, engine, &block)
1218
- Array(views).each do |v|
1219
- super(v, name, engine, &block)
1220
- end
1221
- end
1222
- ```
1223
-
1224
- ## 필터(Filters)
1225
-
1226
- 사전 필터(before filter)는 라우터와 동일한 맥락에서 매 요청 전에 평가되며
1227
- 요청과 응답을 변형할 수 있습니다. 필터에서 설정된 인스턴스 변수들은 라우터와
1228
- 템플릿에서 접근 가능합니다.
1229
-
1230
- ```ruby
1231
- before do
1232
- @note = 'Hi!'
1233
- request.path_info = '/foo/bar/baz'
1234
- end
1235
-
1236
- get '/foo/*' do
1237
- @note #=> 'Hi!'
1238
- params['splat'] #=> 'bar/baz'
1239
- end
1240
- ```
1241
-
1242
- 사후 필터(after filter)는 라우터와 동일한 맥락에서 매 요청 이후에 평가되며
1243
- 마찬가지로 요청과 응답을 변형할 수 있습니다. 사전 필터와 라우터에서 설정된
1244
- 인스턴스 변수들은 사후 필터에서 접근 가능합니다.
1245
-
1246
- ```ruby
1247
- after do
1248
- puts response.status
1249
- end
1250
- ```
1251
-
1252
- 참고: 만약 라우터에서 `body` 메서드를 사용하지 않고 그냥 문자열만 반환한
1253
- 경우라면, body는 나중에 생성되는 탓에, 아직 사후 필터에서 사용할 수 없을
1254
- 것입니다.
1255
-
1256
- 필터는 패턴을 취할 수도 있으며, 이 경우 요청 경로가 그 패턴과 매치할
1257
- 경우에만 필터가 평가될 것입니다.
1258
-
1259
- ```ruby
1260
- before '/protected/*' do
1261
- authenticate!
1262
- end
1263
-
1264
- after '/create/:slug' do |slug|
1265
- session['last_slug'] = slug
1266
- end
1267
- ```
1268
-
1269
- 라우터와 마찬가지로, 필터 역시 조건을 취할 수 있습니다.
1270
-
1271
- ```ruby
1272
- before :agent => /Songbird/ do
1273
- # ...
1274
- end
1275
-
1276
- after '/blog/*', :host_name => 'example.com' do
1277
- # ...
1278
- end
1279
- ```
1280
-
1281
- ## 헬퍼(Helpers)
1282
-
1283
- 톱-레벨의 `helpers` 메서드를 사용하여 라우터 핸들러와 템플릿에서 사용할 헬퍼
1284
- 메서드들을 정의할 수 있습니다.
1285
-
1286
- ```ruby
1287
- helpers do
1288
- def bar(name)
1289
- "#{name}bar"
1290
- end
1291
- end
1292
-
1293
- get '/:name' do
1294
- bar(params['name'])
1295
- end
1296
- ```
1297
-
1298
- 또는, 헬퍼 메서드는 별도의 모듈 속에 정의할 수도 있습니다.
1299
-
1300
- ```ruby
1301
- module FooUtils
1302
- def foo(name) "#{name}foo" end
1303
- end
1304
-
1305
- module BarUtils
1306
- def bar(name) "#{name}bar" end
1307
- end
1308
-
1309
- helpers FooUtils, BarUtils
1310
- ```
1311
-
1312
- 이 것은 모듈을 애플리케이션 클래스에 포함(include)시킨 것과 같습니다.
1313
-
1314
- ### 세션(Sessions) 사용하기
1315
-
1316
- 세션은 요청 동안에 상태를 유지하기 위해 사용합니다.
1317
- 세션이 활성화되면, 사용자 세션 당 세션 해시 하나씩을 갖게 됩니다.
1318
-
1319
- ```ruby
1320
- enable :sessions
1321
-
1322
- get '/' do
1323
- "value = " << session['value'].inspect
1324
- end
1325
-
1326
- get '/:value' do
1327
- session['value'] = params['value']
1328
- end
1329
- ```
1330
-
1331
- `enable :sessions`은 실은 모든 데이터를 쿠키 속에 저장하는 것에 주의하세요.
1332
- 이 방식이 바람직하지 않을 수도 있습니다. (예를 들어, 많은 양의 데이터를
1333
- 저장하게 되면 트래픽이 늘어납니다).
1334
- 이런 경우에는 랙 세션 미들웨어(Rack session middleware)를 사용할 수 있습니다.
1335
- `enable :sessions`을 호출하지 **않는** 대신에, 선택한 미들웨어를 다른
1336
- 미들웨어들처럼 포함시키면 됩니다.
1337
-
1338
- ```ruby
1339
- use Rack::Session::Pool, :expire_after => 2592000
1340
-
1341
- get '/' do
1342
- "value = " << session['value'].inspect
1343
- end
1344
-
1345
- get '/:value' do
1346
- session['value'] = params['value']
1347
- end
1348
- ```
1349
-
1350
- 보안 강화을 위해서, 쿠키 속의 세션 데이터는 세션 시크릿(secret)으로
1351
- 사인(sign)됩니다. Sinatra는 무작위 시크릿을 생성합니다. 하지만, 이
1352
- 시크릿은 애플리케이션 시작 시마다 변경되기 때문에, 애플리케이션의
1353
- 모든 인스턴스들이 공유할 시크릿을 직접 만들 수도 있습니다.
1354
-
1355
- ```ruby
1356
- set :session_secret, 'super secret'
1357
- ```
1358
-
1359
- 조금 더 세부적인 설정이 필요하다면, `sessions` 설정에서 옵션이 있는
1360
- 해시를 저장할 수도 있습니다.
1361
-
1362
- ```ruby
1363
- set :sessions, :domain => 'foo.com'
1364
- ```
1365
-
1366
- 세션을 다른 foo.com의 서브도메인 들과 공유하기 원한다면, 다음에 나오는
1367
- 것 처럼 도메인 앞에 *.*을 붙이셔야 합니다.
1368
-
1369
- ```ruby
1370
- set :sessions, :domain => '.foo.com'
1371
- ```
1372
-
1373
- ### 중단하기(Halting)
1374
-
1375
- 필터나 라우터에서 요청을 즉각 중단하고 싶을 때 사용하합니다.
1376
-
1377
- ```ruby
1378
- halt
1379
- ```
1380
-
1381
- 중단할 때 상태를 지정할 수도 있습니다.
1382
-
1383
- ```ruby
1384
- halt 410
1385
- ```
1386
-
1387
- 본문을 넣을 수도 있습니다.
1388
-
1389
- ```ruby
1390
- halt 'this will be the body'
1391
- ```
1392
-
1393
- 둘 다 할 수도 있습니다.
1394
-
1395
- ```ruby
1396
- halt 401, 'go away!'
1397
- ```
1398
-
1399
- 헤더를 추가할 경우에는 다음과 같이 하면 됩니다.
1400
-
1401
- ```ruby
1402
- halt 402, {'Content-Type' => 'text/plain'}, 'revenge'
1403
- ```
1404
-
1405
- 당연히 `halt`와 템플릿은 같이 사용할 수 있습니다.
1406
-
1407
- ```ruby
1408
- halt erb(:error)
1409
- ```
1410
-
1411
- ### 넘기기(Passing)
1412
-
1413
- 라우터는 `pass`를 사용하여 다음 번 매칭되는 라우터로 처리를 넘길 수 있습니다.
1414
-
1415
- ```ruby
1416
- get '/guess/:who' do
1417
- pass unless params['who'] == 'Frank'
1418
- 'You got me!'
1419
- end
1420
-
1421
- get '/guess/*' do
1422
- 'You missed!'
1423
- end
1424
- ```
1425
-
1426
- 이 때 라우터 블록에서 즉각 빠져나오게 되고 제어는 다음 번 매칭되는 라우터로
1427
- 넘어갑니다. 만약 매칭되는 라우터를 찾지 못하면, 404가 반환됩니다.
1428
-
1429
- ### 다른 라우터 부르기(Triggering Another Route)
1430
-
1431
- 때로는 `pass`가 아니라, 다른 라우터를 호출한 결과를 얻고 싶을 때도
1432
- 있습니다. 이럴때는 간단하게 `call`을 사용하면 됩니다.
1433
-
1434
- ```ruby
1435
- get '/foo' do
1436
- status, headers, body = call env.merge("PATH_INFO" => '/bar')
1437
- [status, headers, body.map(&:upcase)]
1438
- end
1439
-
1440
- get '/bar' do
1441
- "bar"
1442
- end
1443
- ```
1444
-
1445
- 위 예제의 경우, `"bar"`를 헬퍼로 옮겨 `/foo`와 `/bar` 모두에서 사용하도록
1446
- 하면 테스팅을 쉽게 하고 성능을 높일 수 있습니다.
1447
-
1448
- 요청의 사본이 아닌 바로 그 인스턴스로 보내지도록 하고 싶다면,
1449
- `call` 대신 `call!`을 사용하면 됩니다.
1450
-
1451
- `call`에 대한 더 자세한 내용은 Rack 명세를 참고하세요.
1452
-
1453
- ### 본문, 상태 코드 및 헤더 설정하기
1454
-
1455
- 라우터 블록의 반환값과 함께 상태 코드(status code)와 응답 본문(response body)을
1456
- 설정할수 있고 권장됩니다. 하지만, 경우에 따라서는 본문을 실행 흐름 중의 임의
1457
- 지점에서 설정해야 할때도 있습니다. 이런 경우 `body` 헬퍼 메서드를 사용하면
1458
- 됩니다. 이렇게 하면, 그 순간부터 본문에 접근할 때 그 메서드를 사용할 수가 있습니다.
1459
-
1460
- ```ruby
1461
- get '/foo' do
1462
- body "bar"
1463
- end
1464
-
1465
- after do
1466
- puts body
1467
- end
1468
- ```
1469
-
1470
- `body`로 블록을 전달하는 것도 가능하며, 이 블록은 랙(Rack) 핸들러에 의해
1471
- 실행됩니다. (이 방법은 스트리밍을 구현할 때 사용할 수 있습니다. "값
1472
- 반환하기"를 참고하세요).
1473
-
1474
- 본문와 마찬가지로, 상태코드와 헤더도 설정할 수 있습니다.
1475
-
1476
- ```ruby
1477
- get '/foo' do
1478
- status 418
1479
- headers \
1480
- "Allow" => "BREW, POST, GET, PROPFIND, WHEN",
1481
- "Refresh" => "Refresh: 20; http://www.ietf.org/rfc/rfc2324.txt"
1482
- body "I'm a tea pot!"
1483
- end
1484
- ```
1485
-
1486
- `body`처럼, `header`와 `status`도 매개변수 없이 사용하여 현재 값을
1487
- 액세스할 수 있습니다.
1488
-
1489
- ### 응답 스트리밍(Streaming Responses)
1490
-
1491
- 응답 본문의 일정 부분을 계속 생성하는 가운데 데이터를 내보내기 시작하고
1492
- 싶을 경우가 있습니다. 극단적인 예제로, 클라이언트가 접속을 끊기 전까지
1493
- 계속 데이터를 내보내고 싶을 경우도 있죠. 여러분만의 래퍼(wrapper)를
1494
- 만들지 않으려면 `stream` 헬퍼를 사용하면 됩니다.
1495
-
1496
- ```ruby
1497
- get '/' do
1498
- stream do |out|
1499
- out << "It's gonna be legen -\n"
1500
- sleep 0.5
1501
- out << " (wait for it) \n"
1502
- sleep 1
1503
- out << "- dary!\n"
1504
- end
1505
- end
1506
- ```
1507
-
1508
- 이렇게 스트리밍 API나 [서버 발송 이벤트Server Sent
1509
- Events](https://w3c.github.io/eventsource/)를 구현할 수 있고, 이 방법은
1510
- [WebSockets](https://en.wikipedia.org/wiki/WebSocket)을 위한 기반으로 사용됩니다.
1511
- 이 방법은 일부 콘텐츠가 느린 자원에 의존하는 경우에 스로풋(throughtput)을
1512
- 높이기 위해 사용되기도 합니다.
1513
-
1514
- 스트리밍 동작, 특히 동시 요청의 수는 애플리케이션을 서빙하는 웹서버에 크게
1515
- 의존합니다. 일부의 경우 아예 스트리밍을 지원하지 조차 않습니다. 만약 서버가
1516
- 스트리밍을 지원하지 않는다면, 본문은 `stream` 으로 전달된 블록이 수행을 마친
1517
- 후에 한꺼번에 반환됩니다. 이런 한번에 쏘는 샷건같은 방식으로는 스트리밍은
1518
- 움직이지 않습니다.
1519
-
1520
- 선택적 매개변수 `keep_open`이 설정되어 있다면, 스트림 객체에서 `close`를
1521
- 호출하지 않을 것이고, 나중에 실행 흐름 상의 어느 시점에서 스트림을 닫을 수
1522
- 있습니다. 이 옵션은 Thin과 Rainbow 같은 이벤트 기반 서버에서만 작동하고
1523
- 다른 서버들은 여전히 스트림을 닫습니다.
1524
-
1525
- ```ruby
1526
- # long polling
1527
-
1528
- set :server, :thin
1529
- connections = []
1530
-
1531
- get '/subscribe' do
1532
- # register a client's interest in server events
1533
- stream(:keep_open) do |out|
1534
- connections << out
1535
- # purge dead connections
1536
- connections.reject!(&:closed?)
1537
- end
1538
- end
1539
-
1540
- post '/:message' do
1541
- connections.each do |out|
1542
- # notify client that a new message has arrived
1543
- out << params['message'] << "\n"
1544
-
1545
- # indicate client to connect again
1546
- out.close
1547
- end
1548
-
1549
- # acknowledge
1550
- "message received"
1551
- end
1552
- ```
1553
-
1554
- ### 로깅(Logging)
1555
-
1556
- 요청 스코프(request scope) 내에서, `Logger`의 인스턴스인 `logger`
1557
- 헬퍼를 사용할 수 있습니다.
1558
-
1559
- ```ruby
1560
- get '/' do
1561
- logger.info "loading data"
1562
- # ...
1563
- end
1564
- ```
1565
-
1566
- 이 로거는 자동으로 Rack 핸들러에서 설정한 로그설정을 참고합니다.
1567
- 만약 로깅이 비활성상태라면, 이 메서드는 더미(dummy) 객체를 반환하기 때문에,
1568
- 라우터나 필터에서 이 부분에 대해 걱정할 필요는 없습니다.
1569
-
1570
- 로깅은 `Sinatra::Application`에서만 기본으로 활성화되어 있음에 유의합시다.
1571
- 만약 `Sinatra::Base`로부터 상속받은 경우라면 직접 활성화시켜 줘야 합니다.
1572
-
1573
- ```ruby
1574
- class MyApp < Sinatra::Base
1575
- configure :production, :development do
1576
- enable :logging
1577
- end
1578
- end
1579
- ```
1580
-
1581
- 로깅 미들웨어를 사용하지 않으려면, `logging` 설정을 `nil`로 두면 됩니다.
1582
- 하지만, 이 경우 주의할 것은 `logger`는 `nil`을 반환하는 것입니다.
1583
- 통상적인 유스케이스는 여러분만의 로거를 사용하고자 할 경우일 것입니다.
1584
- Sinatra는 `env['rack.logger']`에서 찾은 로거를 사용할 것입니다.
1585
-
1586
- ### 마임 타입(Mime Types)
1587
-
1588
- `send_file`이나 정적인 파일을 사용할 때에 Sinatra가 인식하지 못하는
1589
- 마임 타입이 있을 수 있습니다. 이 경우 `mime_type`을 사용하여 파일
1590
- 확장자를 등록합니다.
1591
-
1592
- ```ruby
1593
- configure do
1594
- mime_type :foo, 'text/foo'
1595
- end
1596
- ```
1597
-
1598
- `content_type` 헬퍼로 쓸 수도 있습니다.
1599
-
1600
- ```ruby
1601
- get '/' do
1602
- content_type :foo
1603
- "foo foo foo"
1604
- end
1605
- ```
1606
-
1607
- ### URL 생성하기
1608
-
1609
- URL을 생성할때 `url` 헬퍼 메서드를 사용합니다. 예를 들어 Haml에서는 이렇게
1610
- 합니다.
1611
-
1612
- ```ruby
1613
- %a{:href => url('/foo')} foo
1614
- ```
1615
-
1616
- 이것은 리버스 프록시(reverse proxies)와 Rack 라우터가 있다면 참고합니다.
1617
-
1618
- 이 메서드는 `to`라는 별칭으로도 사용할 수 있습니다. (아래 예제 참조)
1619
-
1620
- ### 브라우저 재지정(Browser Redirect)
1621
-
1622
- `redirect` 헬퍼 메서드를 사용하여 브라우저를 리다이렉트 시킬 수 있습니다.
1623
-
1624
- ```ruby
1625
- get '/foo' do
1626
- redirect to('/bar')
1627
- end
1628
- ```
1629
-
1630
- 다른 부가적인 매개변수들은 `halt`에 전달하는 인자들과 비슷합니다.
1631
-
1632
- ```ruby
1633
- redirect to('/bar'), 303
1634
- redirect 'http://www.google.com/', 'wrong place, buddy'
1635
- ```
1636
-
1637
- `redirect back`을 사용하면 쉽게 사용자가 왔던 페이지로 다시 돌아가게
1638
- 할 수 있습니다.
1639
-
1640
- ```ruby
1641
- get '/foo' do
1642
- "<a href='/bar'>do something</a>"
1643
- end
1644
-
1645
- get '/bar' do
1646
- do_something
1647
- redirect back
1648
- end
1649
- ```
1650
-
1651
- 리다이렉트와 함께 인자를 전달하려면, 쿼리로 붙이거나,
1652
-
1653
- ```ruby
1654
- redirect to('/bar?sum=42')
1655
- ```
1656
-
1657
- 세션을 사용하면 됩니다.
1658
-
1659
- ```ruby
1660
- enable :sessions
1661
-
1662
- get '/foo' do
1663
- session['secret'] = 'foo'
1664
- redirect to('/bar')
1665
- end
1666
-
1667
- get '/bar' do
1668
- session['secret']
1669
- end
1670
- ```
1671
-
1672
- ### 캐시 컨트롤(Cache Control)
1673
-
1674
- 헤더를 정확하게 설정하는 것은 적절한 HTTP 캐싱의 기본입니다.
1675
-
1676
- Cache-Control 헤더를 다음과 같이 간단하게 설정할 수 있습니다.
1677
-
1678
- ```ruby
1679
- get '/' do
1680
- cache_control :public
1681
- "cache it!"
1682
- end
1683
- ```
1684
-
1685
- 프로 팁: 캐싱은 사전 필터에서 설정하세요.
1686
-
1687
- ```ruby
1688
- before do
1689
- cache_control :public, :must_revalidate, :max_age => 60
1690
- end
1691
- ```
1692
-
1693
- `expires` 헬퍼를 사용하여 그에 상응하는 헤더를 설정한다면,
1694
- `Cache-Control`이 자동으로 설정됩니다.
1695
-
1696
- ```ruby
1697
- before do
1698
- expires 500, :public, :must_revalidate
1699
- end
1700
- ```
1701
-
1702
- 캐시를 잘 사용하려면, `etag` 또는 `last_modified`을 사용해 보세요.
1703
- 무거운 작업을 하기 *전*에 이들 헬퍼를 호출하길 권장합니다. 이렇게 하면,
1704
- 클라이언트 캐시에 현재 버전이 이미 들어 있을 경우엔 즉각 응답을
1705
- 뿌릴(flush) 것입니다.
1706
-
1707
- ```ruby
1708
- get "/article/:id" do
1709
- @article = Article.find params['id']
1710
- last_modified @article.updated_at
1711
- etag @article.sha1
1712
- erb :article
1713
- end
1714
- ```
1715
-
1716
- [약한 ETag](https://en.wikipedia.org/wiki/HTTP_ETag#Strong_and_weak_validation)를
1717
- 사용할 수 도 있습니다.
1718
-
1719
- ```ruby
1720
- etag @article.sha1, :weak
1721
- ```
1722
-
1723
- 이들 헬퍼는 어떠한 캐싱도 하지 않으며, 대신 캐시에 필요한 정보를 제공합니다.
1724
- 손쉬운 리버스 프록시(reverse-proxy) 캐싱 솔루션을 찾고 있다면,
1725
- [rack-cache](https://github.com/rtomayko/rack-cache)를 써보세요.
1726
-
1727
- ```ruby
1728
- require "rack/cache"
1729
- require "sinatra"
1730
-
1731
- use Rack::Cache
1732
-
1733
- get '/' do
1734
- cache_control :public, :max_age => 36000
1735
- sleep 5
1736
- "hello"
1737
- end
1738
- ```
1739
-
1740
- 정적 파일에 `Cache-Control` 헤더 정보를 추가하려면 `:static_cache_control`
1741
- 설정(아래 참조)을 쓰세요.
1742
-
1743
- RFC 2616에 따르면 If-Match 또는 If-None-Match 헤더가 `*`로 설정된 경우 요청한
1744
- 리소스(resource)가 이미 존재하느냐 여부에 따라 다르게 취급해야 한다고 되어
1745
- 있습니다. Sinatra는 (get 처럼) 안전하거나 (put 처럼) 멱등인 요청에 대한 리소스는
1746
- 이미 존재한다고 가정하지만, 다른 리소스(예를 들면 post 요청 같은)의 경우는
1747
- 새 리소스로 취급합니다. 이 행동은 `:new_resource` 옵션을 전달하여 변경할 수 있습니다.
1748
-
1749
- ```ruby
1750
- get '/create' do
1751
- etag '', :new_resource => true
1752
- Article.create
1753
- erb :new_article
1754
- end
1755
- ```
1756
-
1757
- 약한 ETag를 사용하고자 한다면, `:kind`으로 전달합시다.
1758
-
1759
- ```ruby
1760
- etag '', :new_resource => true, :kind => :weak
1761
- ```
1762
-
1763
- ### 파일 전송하기(Sending Files)
1764
-
1765
- 응답(response)으로 파일의 컨탠츠를 리턴하려면, `send_file` 헬퍼 메서드를 사용하면 됩니다.
1766
-
1767
- ```ruby
1768
- get '/' do
1769
- send_file 'foo.png'
1770
- end
1771
- ```
1772
-
1773
- 이 메서드는 몇 가지 옵션을 받습니다.
1774
-
1775
- ```ruby
1776
- send_file 'foo.png', :type => :jpg
1777
- ```
1778
-
1779
- 옵션들:
1780
-
1781
- <dl>
1782
- <dt>filename</dt>
1783
- <dd>응답에서 사용되는 파일명. 기본값은 실제 파일명.</dd>
1784
-
1785
- <dt>last_modified</dt>
1786
- <dd>Last-Modified 헤더값. 기본값은 파일의 mtime.</dd>
1787
-
1788
- <dt>type</dt>
1789
- <dd>Content-Type 헤더값. 없으면 파일 확장자로부터 유추.</dd>
1790
-
1791
- <dt>disposition</dt>
1792
- <dd>
1793
- Content-Disposition 헤더값. 가능한 값들: <tt>nil</tt> (기본값),
1794
- <tt>:attachment</tt> 및 <tt>:inline</tt>
1795
- </dd>
1796
-
1797
- <dt>length</dt>
1798
- <dd>Content-Length 헤더값, 기본값은 파일 크기.</dd>
1799
-
1800
- <dt>status</dt>
1801
- <dd>
1802
- 전송할 상태 코드. 오류 페이지로 정적 파일을 전송할 경우에 유용.
1803
-
1804
- Rack 핸들러가 지원할 경우, Ruby 프로세스로부터의 스트리밍이 아닌
1805
- 다른 수단이 사용가능함. 이 헬퍼 메서드를 사용하게 되면, Sinatra는
1806
- 자동으로 범위 요청(range request)을 처리함.
1807
- </dd>
1808
- </dl>
1809
-
1810
-
1811
- ### 요청 객체에 접근하기(Accessing the Request Object)
1812
-
1813
- 들어오는 요청 객에는 요청 레벨(필터, 라우터, 오류 핸들러)에서 `request`
1814
- 메서드를 통해 접근 가능합니다.
1815
-
1816
- ```ruby
1817
- # http://example.com/example 상에서 실행 중인 앱
1818
- get '/foo' do
1819
- t = %w[text/css text/html application/javascript]
1820
- request.accept # ['text/html', '*/*']
1821
- request.accept? 'text/xml' # true
1822
- request.preferred_type(t) # 'text/html'
1823
- request.body # 클라이언트로부터 전송된 요청 본문 (아래 참조)
1824
- request.scheme # "http"
1825
- request.script_name # "/example"
1826
- request.path_info # "/foo"
1827
- request.port # 80
1828
- request.request_method # "GET"
1829
- request.query_string # ""
1830
- request.content_length # request.body의 길이
1831
- request.media_type # request.body의 미디어 유형
1832
- request.host # "example.com"
1833
- request.get? # true (다른 동사에 대해 유사한 메서드 있음)
1834
- request.form_data? # false
1835
- request["SOME_HEADER"] # SOME_HEADER 헤더의 값
1836
- request.referrer # 클라이언트의 리퍼러 또는 '/'
1837
- request.user_agent # 사용자 에이전트 (:agent 조건에서 사용됨)
1838
- request.cookies # 브라우저 쿠키의 해시
1839
- request.xhr? # 이게 ajax 요청인가요?
1840
- request.url # "http://example.com/example/foo"
1841
- request.path # "/example/foo"
1842
- request.ip # 클라이언트 IP 주소
1843
- request.secure? # false (ssl 접속인 경우 true)
1844
- request.forwarded? # true (리버스 프록시 하에서 작동 중이라면)
1845
- request.env # Rack에 의해 처리되는 로우(raw) env 해시
1846
- end
1847
- ```
1848
-
1849
- `script_name`, `path_info`같은 일부 옵션들은 이렇게 쓸 수도 있습니다.
1850
-
1851
- ```ruby
1852
- before { request.path_info = "/" }
1853
-
1854
- get "/" do
1855
- "all requests end up here"
1856
- end
1857
- ```
1858
-
1859
- `request.body`는 IO 객체이거나 StringIO 객체입니다.
1860
-
1861
- ```ruby
1862
- post "/api" do
1863
- request.body.rewind # 누군가 이미 읽은 경우
1864
- data = JSON.parse request.body.read
1865
- "Hello #{data['name']}!"
1866
- end
1867
- ```
1868
-
1869
- ### 첨부(Attachments)
1870
-
1871
- `attachment` 헬퍼를 사용하여 응답이 브라우저에 표시하는 대신
1872
- 디스크에 저장되어야 함을 블라우저에게 알릴 수 있습니다.
1873
-
1874
- ```ruby
1875
- get '/' do
1876
- attachment
1877
- "store it!"
1878
- end
1879
- ```
1880
-
1881
- 파일명을 전달할 수도 있습니다.
1882
-
1883
- ```ruby
1884
- get '/' do
1885
- attachment "info.txt"
1886
- "store it!"
1887
- end
1888
- ```
1889
-
1890
- ### 날짜와 시간 다루기
1891
-
1892
- Sinatra는 `time_for_` 헬퍼 메서드를 제공합니다. 이 메서드는
1893
- 주어진 값으로부터 Time 객체를 생성한다. `DateTime`, `Date` 같은
1894
- 비슷한 클래스들도 변환됩니다.
1895
-
1896
- ```ruby
1897
- get '/' do
1898
- pass if Time.now > time_for('Dec 23, 2012')
1899
- "still time"
1900
- end
1901
- ```
1902
-
1903
- 이 메서드는 내부적으로 `expires` 나 `last_modified` 같은 곳에서 사용됩니다.
1904
- 따라서 여러분은 애플리케이션에서 `time_for`를 오버라이딩하여 이들 메서드의
1905
- 동작을 쉽게 확장할 수 있습니다.
1906
-
1907
- ```ruby
1908
- helpers do
1909
- def time_for(value)
1910
- case value
1911
- when :yesterday then Time.now - 24*60*60
1912
- when :tomorrow then Time.now + 24*60*60
1913
- else super
1914
- end
1915
- end
1916
- end
1917
-
1918
- get '/' do
1919
- last_modified :yesterday
1920
- expires :tomorrow
1921
- "hello"
1922
- end
1923
- ```
1924
-
1925
- ### 템플릿 파일 참조하기
1926
-
1927
- `find_template`는 렌더링할 템플릿 파일을 찾는데 사용됩니다.
1928
-
1929
- ```ruby
1930
- find_template settings.views, 'foo', Tilt[:haml] do |file|
1931
- puts "could be #{file}"
1932
- end
1933
- ```
1934
-
1935
- 이것만으로는 그렇게 유용하지는 않습니다만, 이 메서드를 오버라이드하여 여러분만의
1936
- 참조 메커니즘에서 가로채게 하면 유용해집니다. 예를 들어, 하나 이상의 뷰 디렉터리를
1937
- 사용하고자 한다면 이렇게 하세요.
1938
-
1939
- ```ruby
1940
- set :views, ['views', 'templates']
1941
-
1942
- helpers do
1943
- def find_template(views, name, engine, &block)
1944
- Array(views).each { |v| super(v, name, engine, &block) }
1945
- end
1946
- end
1947
- ```
1948
-
1949
- 다른 예제는 각 엔진마다 다른 디렉터리를 사용할 경우입니다.
1950
-
1951
- ```ruby
1952
- set :views, :sass => 'views/sass', :haml => 'templates', :default => 'views'
1953
-
1954
- helpers do
1955
- def find_template(views, name, engine, &block)
1956
- _, folder = views.detect { |k,v| engine == Tilt[k] }
1957
- folder ||= views[:default]
1958
- super(folder, name, engine, &block)
1959
- end
1960
- end
1961
- ```
1962
-
1963
- 여러분은 이것을 간단하게 확장(extension)으로 만들어 다른 사람들과 공유할 수 있다!
1964
-
1965
- `find_template`은 그 파일이 실제 존재하는지 검사하지 않음에 유의합니다.
1966
- 모든 가능한 경로에 대해 주어진 블록을 호출할 뿐입니다. 이것은 성능 문제는
1967
- 되지 않습니다. 왜냐하면 `render`는 파일이 발견되는 즉시 `break`하기 때문입니다.
1968
- 또한, 템플릿 위치(그리고 콘텐츠)는 개발 모드에서 실행 중이 아니라면 캐시될 것입니다.
1969
- 정말로 멋진 메세드를 작성하고 싶다면 이 점을 명심하세요.
1970
-
1971
- ## 설정(Configuration)
1972
-
1973
- 모든 환경에서, 시작될 때, 한번만 실행되게 하려면 이렇게 하면 됩니다.
1974
-
1975
- ```ruby
1976
- configure do
1977
- # 옵션 하나 설정
1978
- set :option, 'value'
1979
-
1980
- # 여러 옵션 설정
1981
- set :a => 1, :b => 2
1982
-
1983
- # `set :option, true`와 동일
1984
- enable :option
1985
-
1986
- # `set :option, false`와 동일
1987
- disable :option
1988
-
1989
- # 블록으로 동적인 설정을 할 수도 있음
1990
- set(:css_dir) { File.join(views, 'css') }
1991
- end
1992
- ```
1993
-
1994
- 환경(APP_ENV 환경 변수)이 `:production`일 때만 실행되게 하려면 이렇게 하면 됩니다.
1995
-
1996
- ```ruby
1997
- configure :production do
1998
- ...
1999
- end
2000
- ```
2001
-
2002
- 환경이 `:production` 또는 `:test`일 때 실행되게 하려면 이렇게 하면 됩니다.
2003
-
2004
- ```ruby
2005
- configure :production, :test do
2006
- ...
2007
- end
2008
- ```
2009
-
2010
- 이 옵션들은 `settings`를 통해 접근 가능합니다.
2011
-
2012
- ```ruby
2013
- configure do
2014
- set :foo, 'bar'
2015
- end
2016
-
2017
- get '/' do
2018
- settings.foo? # => true
2019
- settings.foo # => 'bar'
2020
- ...
2021
- end
2022
- ```
2023
-
2024
- ### 공격 방어 설정하기(Configuring attack protection)
2025
-
2026
- Sinatra는 [Rack::Protection](https://github.com/sinatra/sinatra/tree/master/rack-protection#readme)을 사용하여
2027
- 일반적이고 일어날 수 있는 공격에 대비합니다. 이 모듈은 간단하게 비활성시킬 수 있습니다.
2028
- (하지만 애플리케이션에 엄청나게 많은 취약성을 야기합니다.)
2029
-
2030
- ```ruby
2031
- disable :protection
2032
- ```
2033
-
2034
- 하나의 방어층만 스킵하려면, 옵션 해시에 `protection`을 설정하면 됩니다.
2035
-
2036
- ```ruby
2037
- set :protection, :except => :path_traversal
2038
- ```
2039
-
2040
- 배열로 넘김으로써 방어층 여러 개를 비활성화할 수 있습니다.
2041
-
2042
- ```ruby
2043
- set :protection, :except => [:path_traversal, :session_hijacking]
2044
- ```
2045
-
2046
- 기본적으로 `:sessions`가 활성 중일 때만 Sinatra는 방어층을 설정합니다.
2047
- 때로는 자신만의 세션을 설정할 때도 있습니다. 이런 경우 `:session` 옵션을
2048
- 넘겨줌으로써 세션을 기반으로한 방어층을 설정 할 수 있습니다.
2049
-
2050
- ```ruby
2051
- use Rack::Session::Pool
2052
- set :protection, :session => true
2053
- ```
2054
-
2055
- ### 가능한 설정들(Available Settings)
2056
-
2057
- <dl>
2058
- <dt>absolute_redirects</dt>
2059
- <dd>
2060
- 만약 비활성이면, Sinatra는 상대경로 리다이렉트를 허용할 것이지만,
2061
- 이렇게 되면 Sinatra는 더 이상 오직 절대경로 리다이렉트만 허용하고 있는
2062
- RFC 2616(HTTP 1.1)에 위배됨.
2063
- </dd>
2064
- <dd>
2065
- 적정하게 설정되지 않은 리버스 프록시 하에서 앱을 실행 중이라면 활성화시킬 것.
2066
- <tt>rul</tt> 헬퍼는, 만약 두 번째 매개변수로 <tt>false</tt>를 전달하지만 않는다면,
2067
- 여전히 절대경로 URL을 생성할 것임에 유의.
2068
- </dd>
2069
- <dd>기본값은 비활성.</dd>
2070
-
2071
- <dt>add_charset</dt>
2072
- <dd>
2073
- <tt>content_type</tt>가 문자셋 정보에 자동으로 추가하게 될 마임(mime) 타입.
2074
- 이 옵션은 오버라이딩하지 말고 추가해야 함.
2075
- <tt>settings.add_charset << "application/foobar"</tt>
2076
- </dd>
2077
-
2078
- <dt>app_file</dt>
2079
- <dd>
2080
- 메인 애플리케이션 파일의 경로. 프로젝트 루트, 뷰, public 폴더,
2081
- 인라인 템플릿을 파악할 때 사용됨.
2082
- </dd>
2083
-
2084
- <dt>bind</dt>
2085
- <dd>바인드할 IP 주소(기본값: <tt>0.0.0.0</tt> <em>이나</em>
2086
- `environment`가 개발로 설정 되어있으면 <tt>localhost</tt>). 오직
2087
- 빌트인(built-in) 서버에서만 사용됨.</dd>
2088
-
2089
- <dt>default_encoding</dt>
2090
- <dd>인코딩을 알 수 없을 때 인코딩(기본값은 <tt>"utf-8"</tt>).</dd>
2091
-
2092
- <dt>dump_errors</dt>
2093
- <dd>로그안의 에러 출력.</dd>
2094
-
2095
- <dt>environment</dt>
2096
- <dd>
2097
- 현재 환경, 기본값은 <tt>ENV['APP_ENV']</tt> ENV에 없을 경우엔 "development".
2098
- </dd>
2099
-
2100
- <dt>logging</dt>
2101
- <dd>로거(logger) 사용.</dd>
2102
-
2103
- <dt>lock</dt>
2104
- <dd>
2105
- Ruby 프로세스 당 요청을 동시에 할 경우에만 매 요청에 걸쳐 잠금(lock)을 설정.
2106
- </dd>
2107
- <dd>앱이 스레드에 안전(thread-safe)하지 않으면 활성화시킬 것. 기본값은 비활성.</dd>
2108
-
2109
- <dt>method_override</dt>
2110
- <dd>
2111
- put/delete를 지원하지 않는 브라우저에서 put/delete 폼을 허용하는
2112
- <tt>_method</tt> 꼼수 사용.
2113
- </dd>
2114
-
2115
- <dt>port</dt>
2116
- <dd>접속 포트. 빌트인 서버에서만 사용됨.</dd>
2117
-
2118
- <dt>prefixed_redirects</dt>
2119
- <dd>
2120
- 절대경로가 주어지지 않은 리다이렉트에 <tt>request.script_name</tt>를
2121
- 삽입할지 여부를 결정. 활성화 하면 <tt>redirect '/foo'</tt>는
2122
- <tt>redirect to('/foo')</tt>처럼 동작. 기본값은 비활성.
2123
- </dd>
2124
-
2125
- <dt>protection</dt>
2126
- <dd>웹 공격 방어를 활성화시킬 건지 여부. 위의 보안 섹션 참조.</dd>
2127
-
2128
- <dt>public_dir</dt>
2129
- <dd><tt>public_folder</tt>의 별칭. 밑을 참조.</dd>
2130
-
2131
- <dt>public_folder</dt>
2132
- <dd>
2133
- public 파일이 제공될 폴더의 경로.
2134
- static 파일 제공이 활성화된 경우만 사용됨(아래 <tt>static</tt>참조).
2135
- 만약 설정이 없으면 <tt>app_file</tt>로부터 유추됨.
2136
- </dd>
2137
-
2138
- <dt>reload_templates</dt>
2139
- <dd>
2140
- 요청 간에 템플릿을 리로드(reload)할 건지 여부. 개발 모드에서는 활성됨.
2141
- </dd>
2142
-
2143
- <dt>root</dt>
2144
- <dd>
2145
- 프로젝트 루트 디렉터리 경로. 설정이 없으면 <tt>app_file</tt> 설정으로부터 유추됨.
2146
- </dd>
2147
-
2148
- <dt>raise_errors</dt>
2149
- <dd>
2150
- 예외 발생(애플리케이션은 중단됨).
2151
- 기본값은 <tt>environment</tt>가 <tt>"test"</tt>인 경우는 활성, 그렇지 않으면 비활성.
2152
- </dd>
2153
-
2154
- <dt>run</dt>
2155
- <dd>
2156
- 활성화되면, Sinatra가 웹서버의 시작을 핸들링.
2157
- rackup 또는 다른 도구를 사용하는 경우라면 활성화시키지 말 것.
2158
- </dd>
2159
-
2160
- <dt>running</dt>
2161
- <dd>빌트인 서버가 실행 중인가? 이 설정은 변경하지 말 것!</dd>
2162
-
2163
- <dt>server</dt>
2164
- <dd>
2165
- 빌트인 서버로 사용할 서버 또는 서버 목록.
2166
- 기본값은 루비구현에 따라 다르며 순서는 우선순위를 의미.
2167
- </dd>
2168
-
2169
- <dt>sessions</dt>
2170
- <dd>
2171
- <tt>Rack::Session::Cookie</tt>를 사용한 쿠키 기반 세션 활성화.
2172
- 보다 자세한 정보는 '세션 사용하기' 참조.
2173
- </dd>
2174
-
2175
- <dt>show_exceptions</dt>
2176
- <dd>
2177
- 예외 발생 시에 브라우저에 스택 추적을 보임.
2178
- 기본값은 <tt>environment</tt>가 <tt>"development"</tt>인
2179
- 경우는 활성, 나머지는 비활성.
2180
- </dd>
2181
- <dd>
2182
- <tt>:after_handler</tt>를 설정함으로써 브라우저에서
2183
- 스택 트레이스를 보여주기 전에 앱에 특화된 에러 핸들링을
2184
- 할 수도 있음.
2185
- </dd>
2186
-
2187
- <dt>static</dt>
2188
- <dd>Sinatra가 정적(static) 파일을 핸들링할 지 여부를 설정.</dd>
2189
- <dd>이 기능이 가능한 서버를 사용하는 경우라면 비활성시킬 것.</dd>
2190
- <dd>비활성시키면 성능이 올라감.</dd>
2191
- <dd>
2192
- 기본값은 전통적 방식에서는 활성, 모듈 앱에서는 비활성.
2193
- </dd>
2194
-
2195
- <dt>static_cache_control</dt>
2196
- <dd>
2197
- Sinatra가 정적 파일을 제공하는 경우, 응답에 <tt>Cache-Control</tt> 헤더를
2198
- 추가할 때 설정. <tt>cache_control</tt> 헬퍼를 사용.
2199
- 기본값은 비활성.
2200
- </dd>
2201
- <dd>
2202
- 여러 값을 설정할 경우는 명시적으로 배열을 사용할 것:
2203
- <tt>set :static_cache_control, [:public, :max_age => 300]</tt>
2204
- </dd>
2205
-
2206
- <dt>threaded</dt>
2207
- <dd>
2208
- <tt>true</tt>로 설정하면, Thin이 요청을 처리하는데 있어
2209
- <tt>EventMachine.defer</tt>를 사용하도록 함.
2210
- </dd>
2211
-
2212
- <dt>views</dt>
2213
- <dd>
2214
- 뷰 폴더 경로. 설정하지 않은 경우 <tt>app_file</tt>로부터 유추됨.
2215
- </dd>
2216
-
2217
- <dt>x_cascade</dt>
2218
- <dd>
2219
- 라우트를 찾지못했을 때의 X-Cascade 해더를 설정여부.
2220
- 기본값은 <tt>true</tt>
2221
- </dd>
2222
- </dl>
2223
-
2224
-
2225
- ## 환경(Environments)
2226
-
2227
- 3가지의 미리 정의된 `environments` `"development"`, `"production"`, `"test"`
2228
- 가 있습니다. 환경은 `APP_ENV` 환경 변수를 통해서도 설정됩니다. 기본값은
2229
- `"development"`입니다. `"development"` 모드에서는 모든 템플릿들은 요청 간에
2230
- 리로드됩니다. 또, `"development"` 모드에서는 특별한 `not_found` 와 `error`
2231
- 핸들러가 브라우저에서 스택 트레이스를 볼 수 있게합니다.
2232
- `"production"`과 `"test"`에서는 기본적으로 템플릿은 캐시됩니다.
2233
-
2234
- 다른 환경으로 실행시키려면 `APP_ENV` 환경 변수를 사용하세요.
2235
-
2236
- ```shell
2237
- APP_ENV=production ruby my_app.rb
2238
- ```
2239
-
2240
- 현재 설정된 환경이 무엇인지 검사하기 위해서는 준비된 `development?`, `test?`,
2241
- `production?` 메서드를 사용할 수 있습니다.
2242
-
2243
- ```ruby
2244
- get '/' do
2245
- if settings.development?
2246
- "development!"
2247
- else
2248
- "not development!"
2249
- end
2250
- end
2251
- ```
2252
-
2253
- ## 에러 처리(Error Handling)
2254
-
2255
- 예외 핸들러는 라우터 및 사전 필터와 동일한 맥락에서 실행됩니다.
2256
- 이 말인즉, `haml`, `erb`, `halt`같은 이들이 제공하는 모든 것들을 사용할 수
2257
- 있다는 뜻입니다.
2258
-
2259
- ### 찾을 수 없음(Not Found)
2260
-
2261
- `Sinatra::NotFound` 예외가 발생하거나 또는 응답의 상태 코드가 404라면,
2262
- `not_found` 핸들러가 호출됩니다.
2263
-
2264
- ```ruby
2265
- not_found do
2266
- '아무 곳에도 찾을 수 없습니다.'
2267
- end
2268
- ```
2269
-
2270
- ### 에러
2271
-
2272
- `error` 핸들러는 라우터 또는 필터에서 뭐든 오류가 발생할 경우에 호출됩니다.
2273
- 하지만 개발 환경에서는 예외 확인 옵션을 `:after_handler`로 설정되어 있을 경우에만
2274
- 실행됨을 주의하세요.
2275
-
2276
- ```ruby
2277
- set :show_exceptions, :after_handler
2278
- ```
2279
-
2280
- 예외 객체는 Rack 변수 `sinatra.error`로부터 얻을 수 있습니다.
2281
-
2282
- ```ruby
2283
- error do
2284
- '고약한 오류가 발생했군요 - ' + env['sinatra.error'].message
2285
- end
2286
- ```
2287
-
2288
- 사용자 정의 오류는 이렇게 정의합니다.
2289
-
2290
- ```ruby
2291
- error MyCustomError do
2292
- '무슨 일이 생겼나면요...' + env['sinatra.error'].message
2293
- end
2294
- ```
2295
-
2296
- 그런 다음, 이 오류가 발생하면 이렇게 처리합니다.
2297
-
2298
- ```ruby
2299
- get '/' do
2300
- raise MyCustomError, '안좋은 일'
2301
- end
2302
- ```
2303
-
2304
- 결과는 이렇습니다.
2305
-
2306
- ```
2307
- 무슨 일이 생겼냐면요... 안좋은 일
2308
- ```
2309
-
2310
- 상태 코드에 대해 오류 핸들러를 설치할 수도 있습니다.
2311
-
2312
- ```ruby
2313
- error 403 do
2314
- '액세스가 금지됨'
2315
- end
2316
-
2317
- get '/secret' do
2318
- 403
2319
- end
2320
- ```
2321
-
2322
- 범위로 지정할 수도 있습니다.
2323
-
2324
- ```ruby
2325
- error 400..510 do
2326
- '어이쿠'
2327
- end
2328
- ```
2329
-
2330
- Sinatra는 개발 환경에서 동작할 때 브라우저에 괜찮은 스택 트레이스와 추가적인
2331
- 디버그 정보를 보여주기 위해 특별한 `not_found` 와 `error` 핸들러를 설치합니다.
2332
-
2333
- ## Rack 미들웨어(Middleware)
2334
-
2335
- Sinatra는 [Rack](http://rack.github.io/) 위에서 동작하며, Rack은 루비 웹
2336
- 프레임워크를 위한 최소한의 표준 인터페이스입니다. Rack이 애플리케이션 개발자들에게
2337
- 제공하는 가장 흥미로운 기능은 "미들웨어(middleware)"에 대한 지원입니다.
2338
- 여기서 미들웨어란 서버와 여러분의 애플리케이션 사이에 위치하면서 HTTP 요청/응답을
2339
- 모니터링하거나/조작함으로써 다양한 유형의 공통 기능을 제공하는 컴포넌트입니다.
2340
-
2341
- Sinatra는 톱레벨의 `use` 메서드를 사용하여 Rack 미들웨어의 파이프라인을 만드는 일을
2342
- 식은 죽 먹기로 만듭니다.
2343
-
2344
- ```ruby
2345
- require 'sinatra'
2346
- require 'my_custom_middleware'
2347
-
2348
- use Rack::Lint
2349
- use MyCustomMiddleware
2350
-
2351
- get '/hello' do
2352
- 'Hello World'
2353
- end
2354
- ```
2355
-
2356
- `use`문법은 [Rack::Builder](http://www.rubydoc.info/github/rack/rack/master/Rack/Builder) DSL
2357
- (rackup 파일에서 가장 많이 사용)에서 정의한 것과 동일합니다. 예를 들어, `use` 메서드는
2358
- 블록이나 여러 개의/가변적인 인자도 받을 수 있습니다.
2359
-
2360
- ```ruby
2361
- use Rack::Auth::Basic do |username, password|
2362
- username == 'admin' && password == 'secret'
2363
- end
2364
- ```
2365
-
2366
- Rack은 로깅, 디버깅, URL 라우팅, 인증, 그리고 세센 핸들링을 위한 다양한 표준
2367
- 미들웨어로 분산되어 있습니다. Sinatra는 설정에 기반하여 이들 컴포넌트들 중
2368
- 많은 것들을 자동으로 사용하며, 따라서 여러분은 일반적으로는 `use`를 명시적으로
2369
- 사용할 필요가 없을 것입니다.
2370
-
2371
- [rack](https://github.com/rack/rack/tree/master/lib/rack),
2372
- [rack-contrib](https://github.com/rack/rack-contrib#readme),
2373
- [Rack wiki](https://github.com/rack/rack/wiki/List-of-Middleware)
2374
- 에서 유용한 미들웨어들을 찾을 수 있습니다.
2375
-
2376
- ## 테스팅(Testing)
2377
-
2378
- Sinatra 테스트는 많은 Rack 기반 테스팅 라이브러리, 프레임워크를 사용하여 작성가능합니다.
2379
- 그 중 [Rack::Test](http://www.rubydoc.info/github/brynary/rack-test/master/frames)를 권장합니다.
2380
-
2381
- ```ruby
2382
- require 'my_sinatra_app'
2383
- require 'minitest/autorun'
2384
- require 'rack/test'
2385
-
2386
- class MyAppTest < Minitest::Test
2387
- include Rack::Test::Methods
2388
-
2389
- def app
2390
- Sinatra::Application
2391
- end
2392
-
2393
- def test_my_default
2394
- get '/'
2395
- assert_equal 'Hello World!', last_response.body
2396
- end
2397
-
2398
- def test_with_params
2399
- get '/meet', :name => 'Frank'
2400
- assert_equal 'Hello Frank!', last_response.body
2401
- end
2402
-
2403
- def test_with_user_agent
2404
- get '/', {}, 'HTTP_USER_AGENT' => 'Songbird'
2405
- assert_equal "You're using Songbird!", last_response.body
2406
- end
2407
- end
2408
- ```
2409
-
2410
- 주의: Sinatra를 모듈러 방식으로 사용한다면, `Sinatra::Application`
2411
- 를 앱에서 사용하는 클래스 이름으로 바꾸세요.
2412
-
2413
- ## Sinatra::Base - 미들웨어(Middleware), 라이브러리(Libraries), 그리고 모듈 앱(Modular Apps)
2414
-
2415
- 톱레벨에서 앱을 정의하는 것은 마이크로 앱(micro-app) 수준에서는 잘 동작하지만,
2416
- Rack 미들웨어나, Rails 메탈(metal) 또는 서버 컴포넌트를 갖는 간단한 라이브러리,
2417
- 또는 더 나아가 Sinatra 익스텐션(extension) 같은 재사용 가능한 컴포넌트들을 구축할
2418
- 경우에는 심각한 약점이 있습니다. 톱레벨은 마이크로 앱 스타일의 설정을 가정하는 것
2419
- 입니다. (즉, 하나의 단일 애플리케이션 파일과 `./public` 및 `./views` 디렉터리,
2420
- 로깅, 예외 상세 페이지 등등). 이 곳에서 `Sinatra::Base`가 필요합니다.
2421
-
2422
- ```ruby
2423
- require 'sinatra/base'
2424
-
2425
- class MyApp < Sinatra::Base
2426
- set :sessions, true
2427
- set :foo, 'bar'
2428
-
2429
- get '/' do
2430
- 'Hello world!'
2431
- end
2432
- end
2433
- ```
2434
-
2435
- `Sinatra::Base` 서브클래스에서 사용가능한 메서드들은 톱레벨 DSL로 접근 가능한 것들과
2436
- 동일합니다. 대부분의 톱레벨 앱들은 다음 두 가지만 수정하면 `Sinatra::Base` 컴포넌트로
2437
- 변환 가능합니다.
2438
-
2439
- * 파일은 `sinatra`가 아닌 `sinatra/base`를 require해야 합니다.
2440
- 그렇지 않으면 모든 Sinatra의 DSL 메서드들이 메인 네임스페이스에 불러지게
2441
- 됩니다.
2442
- * 앱의 라우터, 예외 핸들러, 필터, 옵션은 `Sinatra::Base`의 서브클래스에 두어야
2443
- 합니다.
2444
-
2445
- `Sinatra::Base`는 백지상태(blank slate)입니다. 빌트인 서버를 비롯한 대부분의 옵션들이
2446
- 기본값으로 꺼져 있습니다. 가능한 옵션들과 그 작동에 대한 상세는 [옵션과
2447
- 설정](http://www.sinatrarb.com/configuration.html)을 참조하세요.
2448
-
2449
- ### 모듈(Modular) vs. 전통적 방식(Classic Style)
2450
-
2451
- 일반적인 믿음과는 반대로, 전통적 방식에 잘못된 부분은 없습니다. 여러분 애플리케이션에
2452
- 맞다면, 모듈 애플리케이션으로 전환할 필요는 없습니다.
2453
-
2454
- 모듈 방식이 아닌 전통적 방식을 사용할 경우 생기는 주된 단점은 루비 프로세스 당
2455
- 하나의 Sinatra 애플리케이션만 사용할 수 있다는 점입니다. 만약 하나 이상을 사용할
2456
- 계획이라면 모듈 방식으로 전환하세요. 모듈 방식과 전통적 방식을 섞어쓰지 못할
2457
- 이유는 없습니다.
2458
-
2459
- 방식을 전환할 경우에는, 기본값 설정의 미묘한 차이에 유의해야 합니다.
2460
-
2461
- <table>
2462
- <tr>
2463
- <th>설정</th>
2464
- <th>전통적 방식</th>
2465
- <th>모듈</th>
2466
- </tr>
2467
- <tr>
2468
- <td>app_file</td>
2469
- <td>sinatra를 로딩하는 파일</td>
2470
- <td>Sinatra::Base를 서브클래싱한 파일</td>
2471
- </tr>
2472
- <tr>
2473
- <td>run</td>
2474
- <td>$0 == app_file</td>
2475
- <td>false</td>
2476
- </tr>
2477
- <tr>
2478
- <td>logging</td>
2479
- <td> true</td>
2480
- <td>false</td>
2481
- </tr>
2482
- <tr>
2483
- <td>method_override</td>
2484
- <td>true</td>
2485
- <td>false</td>
2486
- </tr>
2487
- <tr>
2488
- <td>inline_templates</td>
2489
- <td>true</td>
2490
- <td>false</td>
2491
- </tr>
2492
- <tr>
2493
- <td>static</td>
2494
- <td>true</td>
2495
- <td>File.exist?(public_folder)</td>
2496
- </tr>
2497
- </table>
2498
-
2499
- ### 모듈 애플리케이션(Modular Application) 제공하기
2500
-
2501
- 모듈 앱을 시작하는 두 가지 일반적인 옵션이 있습니다.
2502
- `run!`으로 능동적으로 시작하는 방법은 이렇습니다.
2503
-
2504
- ```ruby
2505
- # my_app.rb
2506
- require 'sinatra/base'
2507
-
2508
- class MyApp < Sinatra::Base
2509
- # ... 여기에 앱 코드가 온다 ...
2510
-
2511
- # 루비 파일이 직접 실행될 경우에 서버를 시작
2512
- run! if app_file == $0
2513
- end
2514
- ```
2515
-
2516
- 이렇게 시작할 수도 있습니다.
2517
-
2518
- ```shell
2519
- ruby my_app.rb
2520
- ```
2521
-
2522
- `config.ru`와 함께 사용할수도 있습니다. 이 경우는 어떠한 Rack 핸들러도 사용할 수 있도록
2523
- 허용 합다.
2524
-
2525
- ```ruby
2526
- # config.ru
2527
- require './my_app'
2528
- run MyApp
2529
- ```
2530
-
2531
- 실행은 이렇게 합니다.
2532
-
2533
- ```shell
2534
- rackup -p 4567
2535
- ```
2536
-
2537
- ### config.ru로 전통적 방식의 애플리케이션 사용하기
2538
-
2539
- 앱 파일을 다음과 같이 작성합니다.
2540
-
2541
- ```ruby
2542
- # app.rb
2543
- require 'sinatra'
2544
-
2545
- get '/' do
2546
- 'Hello world!'
2547
- end
2548
- ```
2549
-
2550
- 대응하는 `config.ru`는 다음과 같이 작성합니다.
2551
-
2552
- ```ruby
2553
- require './app'
2554
- run Sinatra::Application
2555
- ```
2556
-
2557
- ### 언제 config.ru를 사용할까?
2558
-
2559
- `config.ru`는 다음 경우에 권장 됩니다.
2560
-
2561
- * 다른 Rack 핸들러(Passenger, Unicorn, Heroku, ...)로 배포하고자 할 때.
2562
- * 하나 이상의 `Sinatra::Base` 서브클래스를 사용하고자 할 때.
2563
- * Sinatra를 최종점(endpoint)이 아니라, 오로지 미들웨어로만 사용하고자 할 때.
2564
-
2565
- **모듈 방식으로 전환했다는 이유만으로 `config.ru`로 전환할 필요는 없으며,
2566
- 또한 `config.ru`를 사용한다고 해서 모듈 방식을 사용해야 하는 것도 아닙니다.**
2567
-
2568
- ### Sinatra를 미들웨어로 사용하기
2569
-
2570
- Sinatra에서 다른 Rack 미들웨어를 사용할 수 있을 뿐 아니라,
2571
- 어떤 Sinatra 애플리케이션에서도 순차로 어떠한 Rack 종착점 앞에 미들웨어로
2572
- 추가될 수 있습니다. 이 종착점은 다른 Sinatra 애플리케이션이 될 수도 있고,
2573
- 또는 Rack 기반의 어떠한 애플리케이션(Rails/Ramaze/Camping/...)이 될 수도
2574
- 있습니다.
2575
-
2576
- ```ruby
2577
- require 'sinatra/base'
2578
-
2579
- class LoginScreen < Sinatra::Base
2580
- enable :sessions
2581
-
2582
- get('/login') { haml :login }
2583
-
2584
- post('/login') do
2585
- if params['name'] == 'admin' && params['password'] == 'admin'
2586
- session['user_name'] = params['name']
2587
- else
2588
- redirect '/login'
2589
- end
2590
- end
2591
- end
2592
-
2593
- class MyApp < Sinatra::Base
2594
- # 미들웨어는 사전 필터보다 앞서 실행됨
2595
- use LoginScreen
2596
-
2597
- before do
2598
- unless session['user_name']
2599
- halt "접근 거부됨, <a href='/login'>로그인</a> 하세요."
2600
- end
2601
- end
2602
-
2603
- get('/') { "Hello #{session['user_name']}." }
2604
- end
2605
- ```
2606
-
2607
- ### 동적인 애플리케이션 생성(Dynamic Application Creation)
2608
-
2609
- 어떤 상수에 할당하지 않고 런타임에서 새 애플리케이션들을 생성하려면,
2610
- `Sinatra.new`를 쓰면 됩니다.
2611
-
2612
- ```ruby
2613
- require 'sinatra/base'
2614
- my_app = Sinatra.new { get('/') { "hi" } }
2615
- my_app.run!
2616
- ```
2617
-
2618
- 선택적 인자로 상속할 애플리케이션을 받을 수 있습니다.
2619
-
2620
- ```ruby
2621
- # config.ru
2622
- require 'sinatra/base'
2623
-
2624
- controller = Sinatra.new do
2625
- enable :logging
2626
- helpers MyHelpers
2627
- end
2628
-
2629
- map('/a') do
2630
- run Sinatra.new(controller) { get('/') { 'a' } }
2631
- end
2632
-
2633
- map('/b') do
2634
- run Sinatra.new(controller) { get('/') { 'b' } }
2635
- end
2636
- ```
2637
-
2638
- 이 방법은 Sintra 익스텐션을 테스팅하거나 또는 여러분의 라이브러리에서 Sinatra를
2639
- 사용할 경우에 특히 유용합니다.
2640
-
2641
- 이 방법은 Sinatra를 미들웨어로 사용하는 것을 아주 쉽게 만들어 주기도 합니다.
2642
-
2643
- ```ruby
2644
- require 'sinatra/base'
2645
-
2646
- use Sinatra do
2647
- get('/') { ... }
2648
- end
2649
-
2650
- run RailsProject::Application
2651
- ```
2652
-
2653
- ## 범위(Scopes)와 바인딩(Binding)
2654
-
2655
- 현재 어느 범위에 있느냐가 어떤 메서드와 변수를 사용할 수 있는지를 결정합니다.
2656
-
2657
- ### 애플리케이션/클래스 범위
2658
-
2659
- 모든 Sinatra 애플리케이션은 `Sinatra::Base`의 서브클래스에 대응됩니다.
2660
- 만약 톱레벨 DSL (`require 'sinatra'`)을 사용한다면, 이 클래스는
2661
- `Sinatra::Application`이며, 그렇지 않을 경우라면 여러분이 명시적으로 생성한
2662
- 그 서브클래스가 됩니다. 클래스 레벨에서는 `get` 이나 `before` 같은 메서드들을
2663
- 가지나, `request` 객체나 `session` 에는 접근할 수 없습니다. 왜냐면 모든 요청에
2664
- 대해 애플리케이션 클래스는 오직 하나이기 때문입니다.
2665
-
2666
- `set`으로 생성한 옵션들은 클래스 레벨의 메서드들입니다.
2667
-
2668
- ```ruby
2669
- class MyApp < Sinatra::Base
2670
- # 저기요, 저는 애플리케이션 범위에 있다구요!
2671
- set :foo, 42
2672
- foo # => 42
2673
-
2674
- get '/foo' do
2675
- # 저기요, 전 이제 더 이상 애플리케이션 범위 속에 있지 않아요!
2676
- end
2677
- end
2678
- ```
2679
-
2680
- 애플리케이션 범위에는 이런 것들이 있습니다.
2681
-
2682
- * 애플리케이션 클래스 본문
2683
- * 확장으로 정의된 메서드
2684
- * `helpers`로 전달된 블록
2685
- * `set`의 값으로 사용된 Procs/blocks
2686
- * `Sinatra.new`로 전달된 블록
2687
-
2688
- 범위 객체 (클래스)는 다음과 같이 접근할 수 있습니다.
2689
-
2690
- * configure 블록으로 전달된 객체를 통해(`configure { |c| ... }`)
2691
- * 요청 범위 내에서 `settings`
2692
-
2693
- ### 요청/인스턴스 범위
2694
-
2695
- 매 요청마다, 애플리케이션 클래스의 새 인스턴스가 생성되고 모든 핸들러 블록은
2696
- 그 범위 내에서 실행됩니다. 범위 내에서 여러분은 `request` 와 `session` 객체에
2697
- 접근하거나 `erb` 나 `haml` 같은 렌더링 메서드를 호출할 수 있습니다. 요청 범위
2698
- 내에서 `settings` 헬퍼를 통해 애플리케이션 범위에 접근 가능합니다.
2699
-
2700
- ```ruby
2701
- class MyApp < Sinatra::Base
2702
- # 이봐요, 전 애플리케이션 범위에 있다구요!
2703
- get '/define_route/:name' do
2704
- # '/define_route/:name'의 요청 범위
2705
- @value = 42
2706
-
2707
- settings.get("/#{params['name']}") do
2708
- # "/#{params['name']}"의 요청 범위
2709
- @value # => nil (동일한 요청이 아님)
2710
- end
2711
-
2712
- "라우터가 정의됨!"
2713
- end
2714
- end
2715
- ```
2716
-
2717
- 요청 범위에는 이런 것들이 있습니다.
2718
-
2719
- * get/head/post/put/delete/options 블록
2720
- * before/after 필터
2721
- * 헬퍼(helper) 메서드
2722
- * 템플릿/뷰
2723
-
2724
- ### 위임 범위(Delegation Scope)
2725
-
2726
- 위임 범위(delegation scope)는 메서드를 단순히 클래스 범위로 보냅니다(forward).
2727
- 하지만 클래스 바인딩을 갖지 않기에 완전히 클래스 범위처럼 동작하지는 않습니다.
2728
- 오직 명시적으로 위임(delegation) 표시된 메서드들만 사용 가능하고,
2729
- 또한 클래스 범위와 변수/상태를 공유하지 않습니다 (유의: `self`가 다름).
2730
- `Sinatra::Delegator.delegate :method_name`을 호출하여 메서드 위임을 명시적으로
2731
- 추가할 수 있습니다.
2732
-
2733
- 위임 범위에는 이런 것들이 있습니다.
2734
-
2735
- * 톱레벨 바인딩, `require "sinatra"`를 한 경우
2736
- * `Sinatra::Delegator` 믹스인으로 확장된 객체
2737
-
2738
- 직접 코드를 살펴보길 바랍니다.
2739
- [Sinatra::Delegator 믹스인](https://github.com/sinatra/sinatra/blob/ca06364/lib/sinatra/base.rb#L1609-1633)
2740
- 은 [메인 객체를 확장한 것](https://github.com/sinatra/sinatra/blob/ca06364/lib/sinatra/main.rb#L28-30)입니다.
2741
-
2742
- ## 명령행(Command Line)
2743
-
2744
- Sinatra 애플리케이션은 직접 실행할 수 있습니다.
2745
-
2746
- ```shell
2747
- ruby myapp.rb [-h] [-x] [-e ENVIRONMENT] [-p PORT] [-o HOST] [-s HANDLER]
2748
- ```
2749
-
2750
- 옵션들은 다음과 같습니다.
2751
-
2752
- ```
2753
- -h # 도움말
2754
- -p # 포트 설정 (기본값은 4567)
2755
- -o # 호스트 설정 (기본값은 0.0.0.0)
2756
- -e # 환경 설정 (기본값은 development)
2757
- -s # rack 서버/핸들러 지정 (기본값은 thin)
2758
- -x # mutex 잠금 켜기 (기본값은 off)
2759
- ```
2760
-
2761
- ### 다중 스레드(Multi-threading)
2762
-
2763
- _Konstantin의 [StackOverflow의 답변][so-answer]에서 가져왔습니다_
2764
-
2765
- 시나트라는 동시성 모델을 전혀 사용하지 않지만, Thin, Puma, WEBrick 같은
2766
- 기저의 Rack 핸들러(서버)는 사용합니다. 시나트라 자신은 스레드에 안전하므로
2767
- 랙 핸들러가 동시성 스레드 모델을 사용한다고해도 문제가 되지는 않습니다.
2768
- 이는 서버를 시작할 때, 서버에 따른 정확한 호출 방법을 사용했을 때의
2769
- 이야기입니다. 밑의 예제는 다중 스레드 Thin 서버를 시작하는 방법입니다.
2770
-
2771
- ```ruby
2772
- # app.rb
2773
-
2774
- require 'sinatra/base'
2775
-
2776
- class App < Sinatra::Base
2777
- get '/' do
2778
- "Hello, World"
2779
- end
2780
- end
2781
-
2782
- App.run!
2783
-
2784
- ```
2785
-
2786
- 서버를 시작하는 명령어는 다음과 같습니다.
2787
-
2788
- ```shell
2789
- thin --threaded start
2790
- ```
2791
-
2792
-
2793
- [so-answer]: http://stackoverflow.com/questions/6278817/is-sinatra-multi-threaded/6282999#6282999)
2794
-
2795
- ## 요구사항(Requirement)
2796
-
2797
- 다음의 루비 버전은 공식적으로 지원됩니다.
2798
- <dl>
2799
- <dt> Ruby 1.8.7 </dt>
2800
- <dd>
2801
- 1.8.7은 완전하게 지원되지만, 꼭 그래야할 특별한 이유가 없다면,
2802
- 1.9.2로 업그레이드하거나 또는 JRuby나 Rubinius로 전환할 것을 권장합니다.
2803
- 1.8.7에 대한 지원은 Sinatra 2.0 이전에는 중단되지 않을 것입니다.
2804
- Ruby 1.8.6은 더이상 지원하지 않습니다.
2805
- </dd>
2806
-
2807
- <dt> Ruby 1.9.2 </dt>
2808
- <dd>
2809
- 1.9.2는 완전하게 지원됩니다. 1.9.2p0은, Sinatra를 실행했을 때 세그먼트 오류가
2810
- 발생할수 있으므로 쓰지 마세요. 공식 지원은 Sinatra 1.5 이전에는 중단되지 않을
2811
- 것입니다.
2812
- </dd>
2813
-
2814
- <dt> Ruby 1.9.3 </dt>
2815
- <dd>
2816
- 1.9.3은 완전하게 지원되고 권장합니다. 이전 버전에서 1.9.3으로 전환할 경우 모든
2817
- 세션이 무효화되므로 주의하세요. 1.9.3에 대한 지원은 Sinatra 2.0 이전에는
2818
- 중단되지 않을 것입니다.
2819
- </dd>
2820
-
2821
- <dt>Ruby 2.x</dt>
2822
- <dd>
2823
- 2.x은 완전하게 지원되고 권장합니다. 현재 공식 지원 중지 계획은 없습니다.
2824
- </dd>
2825
-
2826
- <dt>Rubinius</dt>
2827
- <dd>
2828
- Rubinius는 공식적으로 지원됩니다. (Rubinius >= 2.x)
2829
- <tt>gem install puma</tt>를 권장합니다.
2830
- </dd>
2831
-
2832
- <dt>JRuby</dt>
2833
- <dd>
2834
- JRuby의 마지막 안정판은 공식적으로 지원됩니다. C 확장을 JRuby와 사용하는
2835
- 것은 권장되지 않습니다.
2836
- <tt>gem install trinidad</tt>를 권장합니다.
2837
- </dd>
2838
- </dl>
2839
-
2840
- 새로 나오는 루비 버전도 주시하고 있습니다.
2841
-
2842
- 다음 루비 구현체들은 공식적으로 지원하지 않지만
2843
- 여전히 Sinatra를 실행할 수 있는 것으로 알려져 있습니다.
2844
-
2845
- * JRuby와 Rubinius 예전 버전
2846
- * Ruby Enterprise Edition
2847
- * MacRuby, Maglev, IronRuby
2848
- * Ruby 1.9.0 및 1.9.1 (이 버전들은 사용하지 말 것을 권합니다)
2849
-
2850
- 공식적으로 지원하지 않는다는 것의 의미는 무언가가 그 플랫폼에서만 잘못 동작하고,
2851
- 지원되는 플랫폼에서는 정상적으로 동작할 경우, 우리의 문제가 아니라 그 플랫폼의 문제로
2852
- 간주한다는 뜻입니다.
2853
-
2854
- 또한 우리는 CI를 ruby-head (MRI의 이후 릴리즈) 브랜치에 맞춰 실행하지만,
2855
- 계속해서 변하고 있기 때문에 아무 것도 보장할 수는 없습니다.
2856
- 앞으로 나올 2.x가 완전히 지원되길 기대합시다.
2857
-
2858
- Sinatra는 선택한 루비 구현체가 지원하는 어떠한 운영체제에서도 작동해야
2859
- 합니다.
2860
-
2861
- MacRuby를 사용한다면, gem install control_tower 를 실행해 주세요.
2862
-
2863
- 현재 Cardinal, SmallRuby, BlueRuby 또는 1.8.7 이전의 루비 버전에서는
2864
- Sinatra를 실행할 수 없을 것입니다.
2865
-
2866
- ## 최신(The Bleeding Edge)
2867
-
2868
- Sinatra의 가장 최근 코드를 사용하고자 한다면, 애플리케이션을 마스터 브랜치에 맞춰
2869
- 실행하면 되므로 부담가지지 마세요. 하지만 덜 안정적일 것입니다.
2870
-
2871
- 주기적으로 사전배포(prerelease) 젬을 푸시하기 때문에, 최신 기능들을 얻기 위해
2872
- 다음과 같이 할 수도 있습니다.
2873
-
2874
- ```shell
2875
- gem install sinatra --pre
2876
- ```
2877
-
2878
- ### Bundler를 사용하여
2879
-
2880
- 여러분 애플리케이션을 최신 Sinatra로 실행하고자 한다면,
2881
- [Bundler](http://bundler.io)를 사용할 것을 권장합니다.
2882
-
2883
- 우선, 아직 설치하지 않았다면 bundler를 설치합니다.
2884
-
2885
- ```shell
2886
- gem install bundler
2887
- ```
2888
-
2889
- 그런 다음, 프로젝트 디렉터리에서, `Gemfile`을 만듭니다.
2890
-
2891
- ```ruby
2892
- source 'https://rubygems.org'
2893
- gem 'sinatra', :github => "sinatra/sinatra"
2894
-
2895
- # 다른 의존관계들
2896
- gem 'haml' # 예를 들어, haml을 사용한다면
2897
- gem 'activerecord', '~> 3.0' # 아마도 ActiveRecord 3.x도 필요할 것
2898
- ```
2899
-
2900
- `Gemfile`안에 애플리케이션의 모든 의존성을 적어야 합니다.
2901
- 하지만, Sinatra가 직접적인 의존관계에 있는 것들(Rack과 Tilt)은
2902
- Bundler가 자동으로 찾아서 추가할 것입니다.
2903
-
2904
- 이제 앱을 실행할 수 있습니다.
2905
-
2906
- ```shell
2907
- bundle exec ruby myapp.rb
2908
- ```
2909
-
2910
- ### 직접 하기(Roll Your Own)
2911
-
2912
- 로컬 클론(clone)을 생성한 다음 `$LOAD_PATH`에 `sinatra/lib` 디렉터리를 주고
2913
- 여러분 앱을 실행합니다.
2914
-
2915
- ```shell
2916
- cd myapp
2917
- git clone git://github.com/sinatra/sinatra.git
2918
- ruby -I sinatra/lib myapp.rb
2919
- ```
2920
-
2921
- 이후에 Sinatra 소스를 업데이트하려면 이렇게 하세요.
2922
-
2923
- ```shell
2924
- cd myapp/sinatra
2925
- git pull
2926
- ```
2927
-
2928
- ### 전역으로 설치(Install Globally)
2929
-
2930
- 젬을 직접 빌드할 수 있습니다.
2931
-
2932
- ```shell
2933
- git clone git://github.com/sinatra/sinatra.git
2934
- cd sinatra
2935
- rake sinatra.gemspec
2936
- rake install
2937
- ```
2938
-
2939
- 만약 젬을 루트로 설치한다면, 마지막 단계는 다음과 같이 해야 합니다.
2940
-
2941
- ```shell
2942
- sudo rake install
2943
- ```
2944
-
2945
- ## 버저닝(Versioning)
2946
-
2947
- Sinatra는 [시맨틱 버저닝Semantic Versioning](http://semver.org/)
2948
- [(번역)](http://surpreem.com/archives/380)의 SemVer,
2949
- SemVerTag를 준수합니다.
2950
-
2951
- ## 더 읽을 거리(Further Reading)
2952
-
2953
- * [프로젝트 웹사이트](http://www.sinatrarb.com/) - 추가 문서들, 뉴스,
2954
- 그리고 다른 리소스들에 대한 링크.
2955
- * [기여하기](http://www.sinatrarb.com/contributing) - 버그를 찾았나요?
2956
- 도움이 필요한가요? 패치를 하셨나요?
2957
- * [이슈 트래커](https://github.com/sinatra/sinatra/issues)
2958
- * [트위터](https://twitter.com/sinatra)
2959
- * [메일링 리스트](http://groups.google.com/group/sinatrarb/topics)
2960
- * IRC: [#sinatra](irc://chat.freenode.net/#sinatra) http://freenode.net
2961
- * 슬랙의 [Sinatra & Friends](https://sinatrarb.slack.com)입니다.
2962
- [여기](https://sinatra-slack.herokuapp.com/)에서 가입가능합니다.
2963
- * [Sinatra Book](https://github.com/sinatra/sinatra-book/) Cookbook 튜토리얼
2964
- * [Sinatra Recipes](http://recipes.sinatrarb.com/) 커뮤니티가 만드는 레시피
2965
- * http://www.rubydoc.info/에 있는 [최종 릴리스](http://www.rubydoc.info/gems/sinatra)
2966
- 또는 [current HEAD](http://www.rubydoc.info/github/sinatra/sinatra)에 대한 API 문서
2967
- * [CI server](https://travis-ci.org/sinatra/sinatra)