/
development_dependencies_install.html
405 lines (374 loc) · 21.7 KB
/
development_dependencies_install.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Development Dependencies Install — Ruby on Rails Guides</title>
<link rel="stylesheet" type="text/css" href="stylesheets/style.css" data-turbolinks-track="reload">
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print">
<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shCore.css" data-turbolinks-track="reload">
<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shThemeRailsGuides.css" data-turbolinks-track="reload">
<link rel="stylesheet" type="text/css" href="stylesheets/fixes.css" data-turbolinks-track="reload">
<link href="images/favicon.ico" rel="shortcut icon" type="image/x-icon" />
<script src="javascripts/syntaxhighlighter.js" data-turbolinks-track="reload"></script>
<script src="javascripts/turbolinks.js" data-turbolinks-track="reload"></script>
<script src="javascripts/guides.js" data-turbolinks-track="reload"></script>
<script src="javascripts/responsive-tables.js" data-turbolinks-track="reload"></script>
</head>
<body class="guide">
<div>
<img src="images/edge_badge.png" alt="edge-badge" id="edge-badge" />
</div>
<div id="topNav">
<div class="wrapper">
<strong class="more-info-label">Veja mais em <a href="http://rubyonrails.org/">rubyonrails.org:</a> </strong>
<span class="red-button more-info-button">
Mais Ruby on Rails
</span>
<ul class="more-info-links s-hidden">
<li class="more-info"><a href="https://weblog.rubyonrails.org/">Blog</a></li>
<li class="more-info"><a href="https://guides.rubyonrails.org/">Guia</a></li>
<li class="more-info"><a href="http://api.rubyonrails.org/">API</a></li>
<li class="more-info"><a href="https://stackoverflow.com/questions/tagged/ruby-on-rails">Pedir ajuda</a></li>
<li class="more-info"><a href="https://github.com/rails/rails">Contribuir no GitHub</a></li>
</ul>
</div>
</div>
<div id="header">
<div class="wrapper clearfix">
<h1><a href="index.html" title="Return to home page">Guides.rubyonrails.org</a></h1>
<ul class="nav">
<li><a class="nav-item" href="index.html">Home</a></li>
<li class="guides-index guides-index-large">
<a href="index.html" id="guidesMenu" class="guides-index-item nav-item">Guias</a>
<div id="guides" class="clearfix" style="display: none;">
<hr />
<div class="guides-section-container">
<div class="guides-section">
<dt>Comece Aqui</dt>
</div>
<div class="guides-section">
<dt>Models</dt>
</div>
<div class="guides-section">
<dt>Views</dt>
</div>
<div class="guides-section">
<dt>Controllers</dt>
</div>
<div class="guides-section">
<dt>Other Components</dt>
</div>
<div class="guides-section">
<dt>Digging Deeper</dt>
</div>
<div class="guides-section">
<dt>Extending Rails</dt>
<dd><a href="rails_on_rack.html">Rails on Rack</a></dd>
<dd><a href="generators.html">Creating and Customizing Rails Generators & Templates</a></dd>
</div>
<div class="guides-section">
<dt>Contributions</dt>
<dd><a href="contributing_to_ruby_on_rails.html">Contributing to Ruby on Rails</a></dd>
<dd><a href="api_documentation_guidelines.html">API Documentation Guidelines</a></dd>
<dd><a href="ruby_on_rails_guides_guidelines.html">Guides Guidelines</a></dd>
</div>
<div class="guides-section">
<dt>Policies</dt>
<dd><a href="maintenance_policy.html">Maintenance Policy</a></dd>
</div>
<div class="guides-section">
<dt>Release Notes</dt>
<dd><a href="upgrading_ruby_on_rails.html">Upgrading Ruby on Rails</a></dd>
<dd><a href="5_2_release_notes.html">Version 5.2 - April 2018</a></dd>
<dd><a href="5_1_release_notes.html">Version 5.1 - April 2017</a></dd>
<dd><a href="5_0_release_notes.html">Version 5.0 - June 2016</a></dd>
<dd><a href="4_2_release_notes.html">Version 4.2 - December 2014</a></dd>
<dd><a href="4_1_release_notes.html">Version 4.1 - April 2014</a></dd>
<dd><a href="4_0_release_notes.html">Version 4.0 - June 2013</a></dd>
<dd><a href="3_2_release_notes.html">Version 3.2 - January 2012</a></dd>
<dd><a href="3_1_release_notes.html">Version 3.1 - August 2011</a></dd>
<dd><a href="3_0_release_notes.html">Version 3.0 - August 2010</a></dd>
<dd><a href="2_3_release_notes.html">Version 2.3 - March 2009</a></dd>
<dd><a href="2_2_release_notes.html">Version 2.2 - November 2008</a></dd>
</div>
</div>
</div>
</li>
<li><a class="nav-item" href="contributing_to_ruby_on_rails.html">Contribua</a></li>
<li class="guides-index guides-index-small">
<select class="guides-index-item nav-item">
<option value="index.html">Guias</option>
<optgroup label="Comece Aqui">
</optgroup>
<optgroup label="Models">
</optgroup>
<optgroup label="Views">
</optgroup>
<optgroup label="Controllers">
</optgroup>
<optgroup label="Other Components">
</optgroup>
<optgroup label="Digging Deeper">
</optgroup>
<optgroup label="Extending Rails">
<option value="rails_on_rack.html">Rails on Rack</option>
<option value="generators.html">Creating and Customizing Rails Generators & Templates</option>
</optgroup>
<optgroup label="Contributions">
<option value="contributing_to_ruby_on_rails.html">Contributing to Ruby on Rails</option>
<option value="api_documentation_guidelines.html">API Documentation Guidelines</option>
<option value="ruby_on_rails_guides_guidelines.html">Guides Guidelines</option>
</optgroup>
<optgroup label="Policies">
<option value="maintenance_policy.html">Maintenance Policy</option>
</optgroup>
<optgroup label="Release Notes">
<option value="upgrading_ruby_on_rails.html">Upgrading Ruby on Rails</option>
<option value="5_2_release_notes.html">Version 5.2 - April 2018</option>
<option value="5_1_release_notes.html">Version 5.1 - April 2017</option>
<option value="5_0_release_notes.html">Version 5.0 - June 2016</option>
<option value="4_2_release_notes.html">Version 4.2 - December 2014</option>
<option value="4_1_release_notes.html">Version 4.1 - April 2014</option>
<option value="4_0_release_notes.html">Version 4.0 - June 2013</option>
<option value="3_2_release_notes.html">Version 3.2 - January 2012</option>
<option value="3_1_release_notes.html">Version 3.1 - August 2011</option>
<option value="3_0_release_notes.html">Version 3.0 - August 2010</option>
<option value="2_3_release_notes.html">Version 2.3 - March 2009</option>
<option value="2_2_release_notes.html">Version 2.2 - November 2008</option>
</optgroup>
</select>
</li>
</ul>
</div>
</div>
<hr class="hide" />
<div id="feature">
<div class="wrapper">
<h2>Development Dependencies Install</h2><p>This guide covers how to setup an environment for Ruby on Rails core development.</p><p>After reading this guide, you will know:</p>
<ul>
<li>How to set up your machine for Rails development</li>
</ul>
<div id="subCol">
<h3 class="chapter"><img src="images/chapters_icon.gif" alt="" />Chapters</h3>
<ol class="chapters">
<li><a href="#the-easy-way">The Easy Way</a></li>
<li>
<a href="#the-hard-way">The Hard Way</a>
<ul>
<li><a href="#install-git">Install Git</a></li>
<li><a href="#clone-the-ruby-on-rails-repository">Clone the Ruby on Rails Repository</a></li>
<li><a href="#install-additional-tools-and-services">Install Additional Tools and Services</a></li>
<li><a href="#database-configuration">Database Configuration</a></li>
<li><a href="#install-javascript-dependencies">Install JavaScript dependencies</a></li>
<li><a href="#install-bundler-gem">Install Bundler gem</a></li>
<li><a href="#contribute-to-rails">Contribute to Rails</a></li>
</ul>
</li>
</ol>
</div>
</div>
</div>
<div id="container">
<div class="wrapper">
<div id="mainCol">
<h3 id="the-easy-way"><a class="anchorlink" href="#the-easy-way">1 The Easy Way</a></h3><p>The easiest and recommended way to get a development environment ready to hack is to use the <a href="https://github.com/rails/rails-dev-box">Rails development box</a>.</p><h3 id="the-hard-way"><a class="anchorlink" href="#the-hard-way">2 The Hard Way</a></h3><p>In case you can't use the Rails development box, see the steps below to manually
build a development box for Ruby on Rails core development.</p><h4 id="install-git"><a class="anchorlink" href="#install-git">2.1 Install Git</a></h4><p>Ruby on Rails uses Git for source code control. The <a href="https://git-scm.com/">Git homepage</a> has installation instructions. There are a variety of resources on the net that will help you get familiar with Git:</p>
<ul>
<li>
<a href="https://try.github.io/">Try Git course</a> is an interactive course that will teach you the basics.</li>
<li>The <a href="https://git-scm.com/documentation">official Documentation</a> is pretty comprehensive and also contains some videos with the basics of Git.</li>
<li>
<a href="https://schacon.github.io/git/everyday.html">Everyday Git</a> will teach you just enough about Git to get by.</li>
<li>
<a href="https://help.github.com/">GitHub</a> offers links to a variety of Git resources.</li>
<li>
<a href="https://git-scm.com/book">Pro Git</a> is an entire book about Git with a Creative Commons license.</li>
</ul>
<h4 id="clone-the-ruby-on-rails-repository"><a class="anchorlink" href="#clone-the-ruby-on-rails-repository">2.2 Clone the Ruby on Rails Repository</a></h4><p>Navigate to the folder where you want the Ruby on Rails source code (it will create its own <code>rails</code> subdirectory) and run:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ git clone https://github.com/rails/rails.git
$ cd rails
</pre>
</div>
<h4 id="install-additional-tools-and-services"><a class="anchorlink" href="#install-additional-tools-and-services">2.3 Install Additional Tools and Services</a></h4><p>Some Rails tests depend on additional tools that you need to install before running those specific tests.</p><p>Here's the list of each gems' additional dependencies:</p>
<ul>
<li>Action Cable depends on Redis</li>
<li>Active Record depends on SQLite3, MySQL and PostgreSQL</li>
<li>Active Storage depends on Yarn (additionally Yarn depends on
<a href="https://nodejs.org/">Node.js</a>), ImageMagick, FFmpeg, muPDF, and on macOS
also XQuartz and Poppler.</li>
<li>Active Support depends on memcached and Redis</li>
<li>Railties depend on a JavaScript runtime environment, such as having
<a href="https://nodejs.org/">Node.js</a> installed.</li>
</ul>
<p>Install all the services you need to properly test the full gem you'll be
making changes to.</p><div class="note"><p>Redis' documentation discourage installations with package managers as those are usually outdated. Installing from source and bringing the server up is straight forward and well documented on <a href="https://redis.io/download#installation">Redis' documentation</a>.</p></div><div class="note"><p>Active Record tests <em>must</em> pass for at least MySQL, PostgreSQL, and SQLite3. Subtle differences between the various adapters have been behind the rejection of many patches that looked OK when tested only against single adapter.</p></div><p>Below you can find instructions on how to install all of the additional
tools for different OSes.</p><h5 id="macos"><a class="anchorlink" href="#macos">2.3.1 macOS</a></h5><p>On macOS you can use <a href="https://brew.sh/">Homebrew</a> to install all of the
additional tools.</p><p>To install all run:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ brew bundle
</pre>
</div>
<p>You'll also need to start each of the installed services. To list all
available services run:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ brew services list
</pre>
</div>
<p>You can then start each of the services one by one like this:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ brew services start mysql
</pre>
</div>
<p>Replace <code>mysql</code> with the name of the service you want to start.</p><h5 id="ubuntu"><a class="anchorlink" href="#ubuntu">2.3.2 Ubuntu</a></h5><p>To install all run:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ sudo apt-get update
$ sudo apt-get install sqlite3 libsqlite3-dev
mysql-server libmysqlclient-dev
postgresql postgresql-client postgresql-contrib libpq-dev
redis-server memcached imagemagick ffmpeg mupdf mupdf-tools
# Install Yarn
$ curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
$ echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
$ sudo apt-get install yarn
</pre>
</div>
<h5 id="fedora-or-centos"><a class="anchorlink" href="#fedora-or-centos">2.3.3 Fedora or CentOS</a></h5><p>To install all run:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ sudo dnf install sqlite-devel sqlite-libs
mysql-server mysql-devel
postgresql-server postgresql-devel
redis memcached imagemagick ffmpeg mupdf
# Install Yarn
# Use this command if you do not have Node.js installed
$ curl --silent --location https://rpm.nodesource.com/setup_8.x | sudo bash -
# If you have Node.js installed, use this command instead
$ curl --silent --location https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo
$ sudo dnf install yarn
</pre>
</div>
<h5 id="arch-linux"><a class="anchorlink" href="#arch-linux">2.3.4 Arch Linux</a></h5><p>To install all run:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ sudo pacman -S sqlite
mariadb libmariadbclient mariadb-clients
postgresql postgresql-libs
redis memcached imagemagick ffmpeg mupdf mupdf-tools poppler
yarn
$ sudo systemctl start redis
</pre>
</div>
<div class="note"><p>If you are running Arch Linux, MySQL isn't supported anymore so you will need to
use MariaDB instead (see <a href="https://www.archlinux.org/news/mariadb-replaces-mysql-in-repositories/">this announcement</a>).</p></div><h5 id="freebsd"><a class="anchorlink" href="#freebsd">2.3.5 FreeBSD</a></h5><p>To install all run:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
# pkg install sqlite3
mysql80-client mysql80-server
postgresql11-client postgresql11-server
memcached imagemagick ffmpeg mupdf
yarn
# portmaster databases/redis
</pre>
</div>
<p>Or install everything through ports (these packages are located under the
<code>databases</code> folder).</p><div class="note"><p>If you run into troubles during the installation of MySQL, please see
<a href="https://dev.mysql.com/doc/refman/8.0/en/freebsd-installation.html">the MySQL documentation</a>.</p></div><h4 id="database-configuration"><a class="anchorlink" href="#database-configuration">2.4 Database Configuration</a></h4><p>There are couple of additional steps required to configure database engines
required for running Active Record tests.</p><p>In order to be able to run the test suite against MySQL you need to create a user named <code>rails</code> with privileges on the test databases:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ mysql -uroot -p
mysql> CREATE USER 'rails'@'localhost';
mysql> GRANT ALL PRIVILEGES ON activerecord_unittest.*
to 'rails'@'localhost';
mysql> GRANT ALL PRIVILEGES ON activerecord_unittest2.*
to 'rails'@'localhost';
mysql> GRANT ALL PRIVILEGES ON inexistent_activerecord_unittest.*
to 'rails'@'localhost';
</pre>
</div>
<p>PostgreSQL's authentication works differently. To setup the development environment
with your development account, on Linux or BSD, you just have to run:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ sudo -u postgres createuser --superuser $USER
</pre>
</div>
<p>and for macOS:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ createuser --superuser $USER
</pre>
</div>
<p>Then, you need to create the test databases for both MySQL and PostgreSQL with:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ cd activerecord
$ bundle exec rake db:create
</pre>
</div>
<div class="note"><p>You'll see the following warning (or localized warning) during activating HStore extension in PostgreSQL 9.1.x or earlier: "WARNING: => is deprecated as an operator".</p></div><p>You can also create test databases for each database engine separately:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ cd activerecord
$ bundle exec rake db:mysql:build
$ bundle exec rake db:postgresql:build
</pre>
</div>
<p>and you can drop the databases using:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ cd activerecord
$ bundle exec rake db:drop
</pre>
</div>
<div class="note"><p>Using the Rake task to create the test databases ensures they have the correct character set and collation.</p></div><p>If you're using another database, check the file <code>activerecord/test/config.yml</code> or <code>activerecord/test/config.example.yml</code> for default connection information. You can edit <code>activerecord/test/config.yml</code> to provide different credentials on your machine if you must, but obviously you should not push any such changes back to Rails.</p><h4 id="install-javascript-dependencies"><a class="anchorlink" href="#install-javascript-dependencies">2.5 Install JavaScript dependencies</a></h4><p>If you installed Yarn, you will need to install the javascript dependencies:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ cd activestorage
$ yarn install
</pre>
</div>
<h4 id="install-bundler-gem"><a class="anchorlink" href="#install-bundler-gem">2.6 Install Bundler gem</a></h4><p>Get a recent version of <a href="https://bundler.io/">Bundler</a></p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ gem install bundler
$ gem update bundler
</pre>
</div>
<p>and run:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ bundle install
</pre>
</div>
<p>or:</p><div class="code_container">
<pre class="brush: plain; gutter: false; toolbar: false">
$ bundle install --without db
</pre>
</div>
<p>if you don't need to run Active Record tests.</p><h4 id="contribute-to-rails"><a class="anchorlink" href="#contribute-to-rails">2.7 Contribute to Rails</a></h4><p>After you've setup everything, read how you can start <a href="contributing_to_ruby_on_rails.html#running-an-application-against-your-local-branch">contributing</a>.</p>
<h3>Feedback</h3>
<p>
You're encouraged to help improve the quality of this guide.
</p>
<p>
Please contribute if you see any typos or factual errors.
To get started, you can read our <a href="https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#contributing-to-the-rails-documentation">documentation contributions</a> section.
</p>
<p>
You may also find incomplete content or stuff that is not up to date.
Please do add any missing documentation for master. Make sure to check
<a href="https://edgeguides.rubyonrails.org">Edge Guides</a> first to verify
if the issues are already fixed or not on the master branch.
Check the <a href="ruby_on_rails_guides_guidelines.html">Ruby on Rails Guides Guidelines</a>
for style and conventions.
</p>
<p>
If for whatever reason you spot something to fix but cannot patch it yourself, please
<a href="https://github.com/rails/rails/issues">open an issue</a>.
</p>
<p>And last but not least, any kind of discussion regarding Ruby on Rails
documentation is very welcome on the <a href="https://groups.google.com/forum/#!forum/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="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International</a> License</p>
<p>"Rails", "Ruby on Rails", and the Rails logo are trademarks of David Heinemeier Hansson. All rights reserved.</p>
</div>
</div>
</body>
</html>