This repository has been archived by the owner on Jan 7, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
rails_application_templates.html
437 lines (398 loc) · 19.7 KB
/
rails_application_templates.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>Ruby on Rails Guides: 레일즈 어플리케이션 템플릿</title>
<link rel="stylesheet" type="text/css" href="stylesheets/style.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shCore.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shThemeRailsGuides.css" />
</head>
<body class="guide">
<div id="topNav">
<div class="wrapper">
<strong>More at <a href="http://rubyonrails.org/">rubyonrails.org:</a> </strong>
<a href="http://rubyonrails.org/">Overview</a> |
<a href="http://rubyonrails.org/download">Download</a> |
<a href="http://rubyonrails.org/deploy">Deploy</a> |
<a href="http://rails.lighthouseapp.com/projects/8994-ruby-on-rails/overview">Code</a> |
<a href="http://rubyonrails.org/screencasts">Screencasts</a> |
<a href="http://rubyonrails.org/documentation">Documentation</a> |
<a href="http://rubyonrails.org/ecosystem">Ecosystem</a> |
<a href="http://rubyonrails.org/community">Community</a> |
<a href="http://weblog.rubyonrails.org/">Blog</a>
</div>
</div>
<div id="header">
<div class="wrapper clearfix">
<h1><a href="index.html" title="Return to home page">Guides.rubyonrails.org</a></h1>
<p class="hide"><a href="#mainCol">Skip navigation</a>.</p>
<ul class="nav">
<li><a href="index.html">홈</a></li>
<li class="index"><a href="index.html" onclick="guideMenu(); return false;" id="guidesMenu">목차</a>
<div id="guides" class="clearfix" style="display: none;">
<hr />
<dl class="L">
<dt>시작</dt>
<dd><a href="getting_started.html">레일즈 시작하기</a></dd>
<dt>모델(Models)</dt>
<dd><a href="migrations.html">레일즈 데이터베이스 마이그레이션</a></dd>
<dd><a href="active_record_validations_callbacks.html">액티브 레코드 데이터 검증(Validation)과 Callback(콜백)</a></dd>
<dd><a href="association_basics.html">액티브 레코드 Association(관계)</a></dd>
<dd><a href="active_record_querying.html">액티브 레코드 쿼리 인터페이스</a></dd>
<dt>뷰(Views)</dt>
<dd><a href="layouts_and_rendering.html">레이아웃(Layouts)과 렌더링(Rendering)</a></dd>
<dd><a href="form_helpers.html">액션 뷰 폼 핼퍼(Action View Form Helpers)</a></dd>
<dt>컨트롤러(Controllers)</dt>
<dd><a href="action_controller_overview.html">액션 컨트롤러 둘러보기</a></dd>
<dd><a href="routing.html">외부 요청에 대한 레일즈 라우팅</a></dd>
</dl>
<dl class="R">
<dt>심화내용</dt>
<dd><a href="active_support_core_extensions.html">액티브 서포트(Active Support) 확장(Core Extensions)</a></dd>
<dd><a href="i18n.html">레일즈 국제화I(nternationalization) API</a></dd>
<dd><a href="action_mailer_basics.html">액션 메일러의 기본</a></dd>
<dd><a href="testing.html">레일즈 어플리케이션 테스트하기</a></dd>
<dd><a href="security.html">레일즈 어플리케이션의 보안</a></dd>
<dd><a href="debugging_rails_applications.html">레일즈 어플리케이션 디버깅</a></dd>
<dd><a href="performance_testing.html">레일즈 어플리케이션 성능 테스트하기</a></dd>
<dd><a href="configuring.html">레일즈 어플리케이션 설정</a></dd>
<dd><a href="command_line.html">레일즈 커멘드라인 도구와 Rake 테스크</a></dd>
<dd><a href="caching_with_rails.html">레일즈를 이용한 캐싱</a></dd>
<dt>레일즈 확장하기(Extending Rails)</dt>
<dd><a href="plugins.html">레일즈 플러그인 작성의 기본</a></dd>
<dd><a href="rails_on_rack.html">렉 위의 레일즈(Rails on Rack)</a></dd>
<dd><a href="generators.html">레일즈 제너레이터(Generator) 제작과 수정</a></dd>
<dt>루비 온 레이즈에 기여하기</dt>
<dd><a href="contributing_to_ruby_on_rails.html">루비 온 레이즈에 기여하기</a></dd>
<dd><a href="api_documentation_guidelines.html">API 문서 가이드라인</a></dd>
<dd><a href="ruby_on_rails_guides_guidelines.html">루비 온 레일즈 가이드에 대한 가이드라인</a></dd>
<dt>Release Notes</dt>
<dd><a href="3_0_release_notes.html">Ruby on Rails 3.0 Release Notes</a></dd>
<dd><a href="2_3_release_notes.html">Ruby on Rails 2.3 Release Notes</a></dd>
<dd><a href="2_2_release_notes.html">Ruby on Rails 2.2 Release Notes</a></dd>
</dl>
</div>
</li>
<li><a href="contribute.html">기여하기</a></li>
<li><a href="credits.html">수고하신 분들</a></li>
</ul>
</div>
</div>
<hr class="hide" />
<div id="feature">
<div class="wrapper">
<h2>레일즈 어플리케이션 템플릿</h2>
<p>어플리케이션 템플릿은 새 레일즈 프로젝트(또는 이미 생성된 레일즈 프로젝트)에 plugin/gems/initializer 등을 추가하기 위한 <span class="caps">DSL</span> 을 포함한 간단한 루비 파일들입니다.</p>
<p>이 가이드를 통해서 다음과 같은 것을 익히실 수 있습니다 :</p>
<ul>
<li>레일즈 어플리케이션을 생성/커스터마이즈 하기 위한 템플릿을 사용할 수 있습니다.</li>
<li>레일즈 템플릿 <span class="caps">API</span> 를 이용하여 자신만의 재사용 가능한 어플리케이션 템플릿을 작성할 수 있습니다.</li>
</ul>
<div id="subCol">
<h3 class="chapter"><img src="images/chapters_icon.gif" alt="" />Chapters</h3>
<ol class="chapters">
<li><a href="#usage">사용법</a></li><li><a href="#template-api">템플릿 <span class="caps">API</span></a><ul><li><a href="#gem-name-options">gem(name, options = {})</a></li> <li><a href="#add_source-source-options">add_source(source, options = {})</a></li> <li><a href="#plugin-name-options">plugin(name, options = {})</a></li> <li><a href="#vendor-lib-file-initializer-filename-data-nil-block">vendor/lib/file/initializer(filename, data = nil, &block)</a></li> <li><a href="#rakefile-filename-data-nil-block">rakefile(filename, data = nil, &block)</a></li> <li><a href="#generate-what-args">generate(what, args)</a></li> <li><a href="#run-command">run(command)</a></li> <li><a href="#rake-command-options">rake(command, options = {})</a></li> <li><a href="#route-routing_code">route(routing_code)</a></li> <li><a href="#inside-dir">inside(dir)</a></li> <li><a href="#ask-question">ask(question)</a></li> <li><a href="#yes-question-no-question">yes?(question) 혹은 no?(question)</a></li> <li><a href="#git-must-a-love">git(:must => “-a love”)</a></li></ul></li><li><a href="#changelog">Changelog</a></li></ol></div>
</div>
</div>
<div id="container">
<div class="wrapper">
<div id="mainCol">
<h3 id="usage">1 사용법</h3>
<p>템플릿을 적용하려면, -m 옵션을 이용하여 적용할 템플릿의 위치를 레일즈 제너레이터에 알려줘야 합니다 :</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ rails new blog -m ~/template.rb
</pre>
</div>
</notextile>
<p><span class="caps">URL</span> 을 이용하여 템플릿을 적용하는 것도 가능합니다 :</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ rails new blog -m https://gist.github.com/755496.txt
</pre>
</div>
</notextile>
<p>또한 이미 생성된 레일즈 어플리케이션의 경우, <tt>rails:template</tt> rake 태스크를 이용할 수 있습니다 :</p>
<notextile>
<div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ rake rails:template LOCATION=~/template.rb
</pre>
</div>
</notextile>
<h3 id="template-api">2 템플릿 <span class="caps">API</span></h3>
<p>레일즈 템플릿 <span class="caps">API</span> 는 매우 직관적이고 이해하기 쉽습니다. 일반적인 레일즈 템플릿의 예는 다음과 같습니다 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
# template.rb
run "rm public/index.html"
generate(:scaffold, "person name:string")
route "root :to => 'people#index'"
rake("db:migrate")
git :init
git :add => "."
git :commit => "-a -m 'Initial commit'"
</pre>
</div>
</notextile>
<p>다음 절에서는 <span class="caps">API</span> 에서 제공하는 주요 메소드의 개요를 설명합니다 :</p>
<h4 id="gem-name-options">2.1 gem(name, options = {})</h4>
<p>생성된 어플리케이션의 <tt>Gemfile</tt> 에 <tt>gem</tt> 항목을 추가합니다.</p>
<p>만약 어플리케이션이 <tt>bj</tt> 와 <tt>nokogiri</tt> gem 에 의존하고 있다면 다음과 같이 사용합니다 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
gem "bj"
gem "nokogiri"
</pre>
</div>
</notextile>
<p>이 메소드는 gem 을 설치하지 않는다는 것에 주의하세요. 그렇게 때문에 <tt>rake gems:install</tt> 태스크를 수행하고 싶을지도 모릅니다 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
rake "gems:install"
</pre>
</div>
</notextile>
<p>그러면 설치가 되지 않은 필요한 젬이 있다면 레일즈가 설치를 합니다.</p>
<h4 id="add_source-source-options">2.2 add_source(source, options = {})</h4>
<p>생성된 어플리케이션의 <tt>Gemfile</tt> 에 주어진 source 를 추가합니다.</p>
<p>예를들어 만약 “http://code.whytheluckystiff.net” 에서 gem 을 받아오고 싶다면 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
add_source "http://code.whytheluckystiff.net"
</pre>
</div>
</notextile>
<h4 id="plugin-name-options">2.3 plugin(name, options = {})</h4>
<p>생성된 어플리케이션에 플러그인을 설치합니다.</p>
<p>Git 으로부터 플러그인을 설치합니다 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
plugin 'authentication', :git => 'git://github.com/foor/bar.git'
</pre>
</div>
</notextile>
<p>git 서브모듈을 통해 플러그인을 설치하는 것도 가능합니다.</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
plugin 'authentication', :git => 'git://github.com/foor/bar.git',
:submodule => true
</pre>
</div>
</notextile>
<p>서브모듈로 플러그인을 설치하기 전에 <tt>git :init</tt> 을 해야합니다.</p>
<p>혹은 <span class="caps">SVN</span> 을 이용할 수도 있습니다 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
plugin 'usingsvn', :svn => 'svn://example.com/usingsvn/trunk'
</pre>
</div>
</notextile>
<h4 id="vendor-lib-file-initializer-filename-data-nil-block">2.4 vendor/lib/file/initializer(filename, data = nil, &block)</h4>
<p><tt>config/initializer</tt> 디렉토리에 initializer 를 추가합니다.</p>
<p><tt>Object#not_nil?</tt> 와 <tt>Object#not_blank?</tt> 를 사용하고 싶다고 가정합시다 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
initializer 'bloatlol.rb', <<-CODE
class Object
def not_nil?
!nil?
end
def not_blank?
!blank?
end
end
CODE
</pre>
</div>
</notextile>
<p>비슷하게 <tt>lib()</tt> 은 <tt>lib/</tt> 디렉토리에 파일을 만들고, <tt>vendor()</tt> 는 <tt>vendor/</tt> 디렉토리에 파일을 만듭니다.</p>
<p>심지어 <tt>file()</tt> 도 있어서, <tt>Rails.root</tt> 로 부터의 상대경로에 필요한 디렉토리/파일을 만들 수 있습니다 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
file 'app/components/foo.rb', <<-CODE
class Foo
end
CODE
</pre>
</div>
</notextile>
<p>이렇게 하면 <tt>app/components</tt> 디렉토리를 만들고 그 안에 <tt>foo.rb</tt> 를 넣습니다.</p>
<h4 id="rakefile-filename-data-nil-block">2.5 rakefile(filename, data = nil, &block)</h4>
<p><tt>lib/tasks</tt> 에 주어진 태스크를 포함한 새 rake 파일을 생성합니다 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
rakefile("bootstrap.rake") do
<<-TASK
namespace :boot do
task :strap do
puts "i like boots!"
end
end
TASK
end
</pre>
</div>
</notextile>
<p>위 코드는 <tt>boot:strap</tt> rake 태스크를 포함한 <tt>lib/tasks/bootstrap.rake</tt> 를 생성합니다.</p>
<h4 id="generate-what-args">2.6 generate(what, args)</h4>
<p>주어진 인자로 레일즈 제너레이터를 실행시킵니다. 예를 들어, 레일즈를 가지고 놀 때마다 발판 코드를 만들기를 원한다면 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
generate(:scaffold, "person", "name:string", "address:text", "age:number")
</pre>
</div>
</notextile>
<h4 id="run-command">2.7 run(command)</h4>
<p>임의의 명령어를 수행합니다. backtick(`) 과 비슷합니다. <tt>public/index.html</tt> 파일을 지우길 원한다면 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
run "rm public/index.html"
</pre>
</div>
</notextile>
<h4 id="rake-command-options">2.8 rake(command, options = {})</h4>
<p>레일즈 어플리케이션의 Rake 태스크를 실행합니다. 데이터베이스를 마이그레이션하고 싶다면 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
rake "db:migrate"
</pre>
</div>
</notextile>
<p>또한 다른 레일즈 환경의 rake 태스크를 실행할 수 있습니다 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
rake "db:migrate", :env => 'production'
</pre>
</div>
</notextile>
<p>sudo 를 사용할 수도 있습니다 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
rake "gems:install", :sudo => true
</pre>
</div>
</notextile>
<h4 id="route-routing_code">2.9 route(routing_code)</h4>
<p><tt>config/routes.rb</tt> 파일에 라우팅 항목을 추가합니다. 아래와 같이 하면, person 발판 코드(scaffold)를 생성하고 <tt>public/index.html</tt> 도 삭제해 줍니다. 그러면 <tt>PeopleController#index</tt> 가 어플리케이션의 기본 페이지가 됩니다.</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
route "root :to => 'person#index'"
</pre>
</div>
</notextile>
<h4 id="inside-dir">2.10 inside(dir)</h4>
<p>주어진 디렉토리에서 명령어를 수행할 수 있게 합니다. 예를 들어, 만약 edge rails 의 사본을 새로운 어플리케이션에 복사하고 싶다면, 아래와 같이 합니다:</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
inside('vendor') do
run "ln -s ~/commit-rails/rails rails"
end
</pre>
</div>
</notextile>
<h4 id="ask-question">2.11 ask(question)</h4>
<p><tt>ask()</tt> 는 사용자로부터 피드백을 받고 템플릿 내에서 사용할 수 있게 합니다. 사용자에게 당신이 추가하고 있는 새로운 라이브러리의 이름을 짓게 하고 싶다면 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
lib_name = ask("What do you want to call the shiny library ?")
lib_name << ".rb" unless lib_name.index(".rb")
lib lib_name, <<-CODE
class Shiny
end
CODE
</pre>
</div>
</notextile>
<h4 id="yes-question-no-question">2.12 yes?(question) 혹은 no?(question)</h4>
<p>이 메소드들은 템플릿에서 사용자의 답변에 따른 흐름을 결정할 수 있게 해 줍니다. 만약 사용자가 원할때만 레일즈를 freeze 시키기를 원한다면 :</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
rake("rails:freeze:gems") if yes?("Freeze rails gems ?")
no?(question) acts just the opposite.
</pre>
</div>
</notextile>
<h4 id="git-must-a-love">2.13 git(:must => “-a love”)</h4>
<p>레일즈 템플릿은 모든 git 명령어를 수행할 수 있습니다.</p>
<notextile>
<div class="code_container">
<pre class="brush: ruby; gutter: false; toolbar: false">
git :init
git :add => "."
git :commit => "-a -m 'Initial commit'"
</pre>
</div>
</notextile>
<h3 id="changelog">3 Changelog</h3>
<ul>
<li>April 29, 2009: Initial version by <a href="credits.html#lifo">Pratik</a></li>
</ul>
<h3>Feedback</h3>
<p>
You're encouraged to help in keeping the quality of this guide.
</p>
<p>
If you see any typos or factual errors you are confident to
patch, please clone <a href="https://github.com/lifo/docrails">docrails</a>
and push the change yourself. That branch of Rails has public write access.
Commits are still reviewed, but that happens after you've submitted your
contribution. <a href="https://github.com/lifo/docrails">docrails</a> is
cross-merged with master periodically.
</p>
<p>
You may also find incomplete content, or stuff that is not up to date.
Please do add any missing documentation for master. Check the
<a href="ruby_on_rails_guides_guidelines.html">Ruby on Rails Guides Guidelines</a>
for style and conventions.
</p>
<p>
Issues may also be reported in <a href="https://github.com/lifo/docrails/issues">Github</a>.
</p>
<p>And last but not least, any kind of discussion regarding Ruby on Rails
documentation is very welcome in the <a href="http://groups.google.com/group/rubyonrails-docs">rubyonrails-docs mailing list</a>.
</p>
</div>
</div>
</div>
<hr class="hide" />
<div id="footer">
<div class="wrapper">
<p>This work is licensed under a <a href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-Share Alike 3.0</a> License</p>
<p>"Rails", "Ruby on Rails", and the Rails logo are trademarks of David Heinemeier Hansson. All rights reserved.</p>
</div>
</div>
<script type="text/javascript" src="javascripts/guides.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shCore.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushRuby.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushXml.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushSql.js"></script>
<script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushPlain.js"></script>
<script type="text/javascript">
SyntaxHighlighter.all()
</script>
</body>
</html>