Rusrails: Рекомендации для руководств по Ruby on Rails

Установка зависимостей для разработки

Это руководство раскрывает, как настроить среду для разработки ядра Ruby on Rails.

После прочтения этого руководства, вы узнаете:

Как настроить свою машину для разработки Rails
Как запустить определенную группу юнит-тестов из тестового набора Rails
Как работает часть тестового набора Rails, относящаяся к Active Record

1. Простой способ

Простейшим и рекомендованным способом получить среду разработки, готовую для программирования, является использование Rails development box.

2. Сложный способ

В случае, если вы не можете использовать Rails development box, вот шаги для создания среды разработки для ядра Ruby on Rails.

2.1. Установите Git

Ruby on Rails использует Git для контроля кода. На домашней странице Git есть инструкции по установке. Также в сети есть ряд ресурсов, которые помогут познакомиться с Git:

Курс Try Git — это интерактивный курс, который научит вас основам.
Официальная документация довольно объемная, а также содержит несколько видео с основами Git.
Everyday Git научит вас достаточному, чтобы работать с Git.
GitHub предлагает ссылки на ряд ресурсов по Git.
Pro Git — это целая книга о Git с лицензией Creative Commons.

2.2. Клонируйте репозиторий Ruby on Rails

Перейдите в папку, в которой вы хотите разместить исходный код Ruby on Rails (он создаст свою собственную поддиректорию rails), и запустите:

$ git clone git://github.com/rails/rails.git
$ cd rails

2.3. Настройте и запустите тесты

Тестовый набор должен проходить для любого отправляемого кода. Вне зависимости, пишете ли вы новый код, или проверяете чей-то, вам нужно иметь возможность запускать тесты.

Сначала установите SQLite3 и его файлы для разработки для гема sqlite3. Пользователи macOS это могут сделать так:

$ brew install sqlite3

В Ubuntu это делается так:

$ sudo apt-get install sqlite3 libsqlite3-dev

Если у вас Fedora или CentOS, то так

$ sudo yum install sqlite3 sqlite3-devel

Если у вас Arch Linux, нужно запустить:

$ sudo pacman -S sqlite

Для пользователей FreeBSD, это делается так:

# pkg install sqlite3

Или скомпилируйте порт databases/sqlite3.

Получите последнюю версию Bundler

$ gem install bundler
$ gem update bundler

и запустите:

$ bundle install --without db

Эта команда установит все зависимости, кроме Ruby-драйверов MySQL и PostgreSQL. К ним мы скоро вернемся.

Если вы хотите запустить тесты, использующие memcached, необходимо убедиться, что он у вас установлен и запущен.

Можно использовать Homebrew для установки memcached на OS X:

$ brew install memcached

На Ubuntu можно установить его с помощью apt-get:

$ sudo apt-get install memcached

Или использовать yum на Fedora или CentOS:

$ sudo yum install memcached

Если вы запускаете на Arch Linux:

$ sudo pacman -S memcached

Для пользователей FreeBSD, это делается так:

# pkg install memcached

Альтернативно можно скомпилировать порт databases/memcached.

Теперь, когда установлены зависимости, можно запустить тестовый набор с помощью:

$ bundle exec rake test

Также можно запустить тесты для отдельного компонента, например Action Pack, перейдя в его директорию и запустив ту же самую команду:

$ cd actionpack
$ bundle exec rake test

Если хотите запустить тесты, расположенные в определенной директории, используйте переменную среды TEST_DIR. Например, это запустит тесты только в директории railties/test/generators:

$ cd railties
$ TEST_DIR=generators bundle exec rake test

Можно запустить тесты для определенного файла, используя:

$ cd actionpack
$ bundle exec ruby -Itest test/template/form_helper_test.rb

Или можно запустить отдельный тест в определенном файле:

$ cd actionpack
$ bundle exec ruby -Itest path/to/test.rb -n test_name

2.4. Настройка Railties

Некоторые тесты Railties зависят от окружения JavaScript runtime, такого как Node.js.

2.5. Настройка Active Record

Тестовый набор Active Record запускается три раза: один для SQLite3, один для MySQL, и один для PostgreSQL. Мы собираемся показать, как настроить среду для них.

Если вы работаете с кодом, вы обязаны убедиться, что тесты проходят как минимум для MySQL, PostgreSQL и SQLite3. Тонкости в различии между различными адаптерами лежали в основе отклонения многих изменений, которые выглядели хорошо, когда их тестировали только на MySQL.

2.5.1. Конфигурация базы данных

Тестовый набор Active Record требует пользовательский файл настроек: activerecord/test/config.yml. Пример представлен в activerecord/test/config.example.yml, который можно скопировать и использовать в своей среде.

2.5.2. MySQL и PostgreSQL

Чтобы запускать набор для MySQL и PostgreSQL, нам нужны их гемы. Сначала установите серверы, их клиентские библиотеки и их файлы для разработки.

На OS X можно выполнить:

$ brew install mysql
$ brew install postgresql

Чтобы их запустить, следуйте инструкциям Homebrew.

В Ubuntu просто запустите:

$ sudo apt-get install mysql-server libmysqlclient-dev
$ sudo apt-get install postgresql postgresql-client postgresql-contrib libpq-dev

На Fedora или CentOS просто запустите:

$ sudo yum install mysql-server mysql-devel
$ sudo yum install postgresql-server postgresql-devel

Если вы запускаете на Arch Linux, MySQL больше не поддерживается, поэтому вам нужно вместо него использовать MariaDB (смотрите этот анонс):

$ sudo pacman -S mariadb libmariadbclient mariadb-clients
$ sudo pacman -S postgresql postgresql-libs

Пользователи FreeBSD должны запустить следующее:

# pkg install mysql56-client mysql56-server
# pkg install postgresql94-client postgresql94-server

Или установить их с помощью портов (они расположены в папке databases). Если у вас затруднения при установке MySQL, обратитесь к документации MySQL.

После этого запустите:

$ rm .bundle/config
$ bundle install

Сперва нам нужно удалить .bundle/config, так как Bundler запоминает, что мы не хотели устанавливать группу "db" (альтернативно вы можете отредактировать этот файл).

Чтобы было можно запускать тесты на MySQL, необходимо создать пользователя с именем rails с привилегиями на тестовые базы данных:

$ 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';

и создать тестовые базы данных:

$ cd activerecord
$ bundle exec rake db:mysql:build

Аутентификация PostgreSQL работает по-другому. Чтобы настроить среду разработки для своего аккаунта на Linux или BSD, просто запустите:

$ sudo -u postgres createuser --superuser $USER

и для OS X:

$ createuser --superuser $USER

Затем нужно создать тестовые базы данных с помощью

$ cd activerecord
$ bundle exec rake db:postgresql:build

Можно создать базы данных для обоих PostgreSQL и MySQL с помощью

$ cd activerecord
$ bundle exec rake db:create

Можно очистить базы данных с помощью

$ cd activerecord
$ bundle exec rake db:drop

Использование задачи rake для создания тестовых баз данных позволяет убедиться, что они имеют правильные кодировки и сортировки.

Вы увидите следующее предупреждение (или локализованное предупреждение) при активации расширения HStore в PostgreSQL 9.1.x или ранее: "WARNING: => is deprecated as an operator".

Если вы используете другую базу данных, ищите в файле activerecord/test/config.yml или activerecord/test/config.example.yml информацию по соединению по умолчанию. Можно отредактировать activerecord/test/config.yml, чтобы представить другие учетные данные для вашей машины, если необходимо, но, очевидно, вы не должны отправлять такие изменения обратно в Rails.

2.6. Настройка Action Cable

Action Cable использует Redis в качестве адаптера подписки по умолчанию (подробнее). Таким образом, чтобы тесты Action Cable проходили, необходимо установить и запустить Redis.

2.6.1. Установка Redis из исходников

Документация Redis отговаривает от установки с помощью пакетных менеджеров, так как они обычно устаревшие. Установка из исходников и запуск сервера просто и хорошо документированы в документации Redis.

2.6.2. Установка Redis из пакетного менеджера

В OS X можно запустить:

$ brew install redis

Следуйте инструкциям Homebrew чтобы его запустить.