Rails のコマンドラインツール

このガイドの内容:

  • Railsアプリケーションを作成する方法
  • モデル、コントローラ、データベースのマイグレーションファイル、および単体テストを作成する方法
  • 開発用サーバーを起動する方法
  • インタラクティブシェルを利用して、オブジェクトを実験する方法

このチュートリアルは、Railsをはじめようで基本的なRailsの知識を身につけていることを前提としています。

1 コマンドラインの基礎

Railsを利用するうえで、きわめて重要なコマンドがいくつかあります。それらを利用頻度順に並べると以下のとおりです。

  • bin/rails console
  • bin/rails server
  • bin/rails test
  • bin/rails generate
  • bin/rails db:migrate
  • bin/rails db:create
  • bin/rails routes
  • bin/rails dbconsole
  • rails new app_name

利用可能なrailsコマンドのリストは、rails --helpで表示できます。利用できるコマンドは現在のディレクトリによって変わることがよくあります。各コマンドの説明で必要なものを探せます。

$ rails --help
Usage: rails COMMAND [ARGS]

The most common rails commands are:
 generate    Generate new code (short-cut alias: "g")
 console     Start the Rails console (short-cut alias: "c")
 server      Start the Rails server (short-cut alias: "s")
 ...

All commands can be run with -h (or --help) for more information.

In addition to those commands, there are:
 about                               List versions of all Rails ...
 assets:clean[keep]                  Remove old compiled assets
 assets:clobber                      Remove compiled assets
 assets:environment                  Load asset compile environment
 assets:precompile                   Compile all the assets ...
 ...
 db:fixtures:load                    Loads fixtures into the ...
 db:migrate                          Migrate the database ...
 db:migrate:status                   Display status of migrations
 db:rollback                         Rolls the schema back to ...
 db:schema:cache:clear               Clears a db/schema_cache.yml file
 db:schema:cache:dump                Creates a db/schema_cache.yml file
 db:schema:dump                      Creates a database schema file (either db/schema.rb or db/structure.sql ...
 db:schema:load                      Loads a database schema file (either db/schema.rb or db/structure.sql ...
 db:seed                             Loads the seed data ...
 db:version                          Retrieves the current schema ...
 ...
 restart                             Restart app by touching ...
 tmp:create                          Creates tmp directories ...

簡単なRailsアプリケーションをつくりながら、一つずつコマンドを実行していきましょう。

1.1 rails new

Railsをインストールしたあと、最初にやりたいことはrails newコマンドを実行して、新しいRailsアプリケーションを作成することです。

まだRailsをインストールしていない場合、gem install railsを実行してRailsをインストールできます。

$ rails new commandsapp
     create
     create  README.md
     create  Rakefile
     create  config.ru
     create  .gitignore
     create  Gemfile
     create  app
     ...
     create  tmp/cache
     ...
        run  bundle install

このような短いコマンドを入力するだけで、Railsは非常に多くのものを用意してくれます。たったこれだけで、完璧なRailsのディレクトリ構成と、アプリケーションに必要なコードがすぐ利用できるようになります。

特定のファイルやコンポーネントをスキップして生成しないようにするには、rails newに以下の引数を追加します。

引数 説明
--skip-git .gitignoreファイルをスキップする
--skip-keeps .keepファイル(バージョン管理用)の生成をスキップする
--skip-action-mailer Action Mailerのファイルをスキップする
--skip-action-text Action Text gemをスキップする
--skip-active-record Active Recordのファイルをスキップする
--skip-active-storage Active Storageのファイルをスキップする
--skip-action-cable Action Cableのファイルをスキップする
--skip-sprockets Sprocketsのファイルをスキップする
--skip-javascript JavaScriptのファイルをスキップする
--skip-turbolinks turbolinks gemをスキッpする
--skip-test テストファイルをスキップする
--skip-system-test システムテストファイルをスキップする
--skip-bootsnap bootsnap gemをスキップする

1.2 bin/rails server

bin/rails serverコマンドを実行すると、PumaというWebサーバーが起動します(PumaはRailsに標準でバンドルされます)。Webブラウザからアプリケーションにアクセスしたいときは、このコマンドを使います。

bin/rails serverを実行することで、新しいRailsアプリケーションを作成後すぐにRailsアプリケーションを起動できます。

$ cd commandsapp
$ bin/rails server
=> Booting Puma
=> Rails 6.0.0 application starting in development
=> Run `bin/rails server --help` for more startup options
Puma starting in single mode...
* Version 3.12.1 (ruby 2.5.7-p206), codename: Llamas in Pajamas
* Min threads: 5, max threads: 5
* Environment: development
* Listening on tcp://localhost:3000
Use Ctrl-C to stop

わずか3つのコマンドで、Railsサーバーを3000番ポートで起動しました。ブラウザを立ち上げて、http://localhost:3000を開いてみてください。Railsアプリケーションが動作していることが分かります。

サーバーを起動する際にはbin/rails sのように"s"というエイリアスが使えます。

リッスンするポートは-p オプションで指定できます。-e オプションでサーバーの環境を変更できます。デフォルトではdevelopment(開発)環境で実行されます。

$ bin/rails server -e production -p 4000

-bオプションを使うと、Railsを特定のIPにバインドできます。デフォルトはlocalhostです。-dオプションを使うと、サーバーをデーモンとして起動できます。

1.3 bin/rails generate

bin/rails generateコマンドは、テンプレートを用いてさまざまなものを作成します。bin/rails generateを実行すると、利用可能なジェネレータの一覧が表示されます。

ジェネレータコマンドを実行する際にはbin/rails gのように「g」というエイリアスが使えます。

$ bin/rails generate
Usage: rails generate GENERATOR [args] [options]

...
...

Please choose a generator below.

Rails:
  assets
  channel
  controller
  generator
  ...
  ...

ジェネレータgemをインストールしたり、プラグインに付属しているジェネレータをインストールしたりすることで、ジェネレータを追加できます。自分でジェネレータを開発することもできます。

ジェネレータを使うと、アプリケーションを動かすのに必要な ボイラープレートコードを書かなくて済むため、多くの時間を節約できます。

それではコントローラジェネレータを使って、コントローラを作ってみましょう。どのようなコマンドを使えばよいのでしょうか?ジェネレータに聞いてみましょう。

Railsのすべてのコマンドにはヘルプがついています。多くの *nix(訳注: LinuxやUnix、UnixライクなOSなど)のユーティリティと同じようにコマンドの末尾に--helpもしくは-hオプションを追加します(例: rails server --help)。

$ bin/rails generate controller
Usage: bin/rails generate controller NAME [action action] [options]

...
...

Description:
    ...

    To create a controller within a module, specify the controller name as a path like 'parent_module/controller_name'.

    ...

Example:
    `bin/rails generate controller CreditCards open debit credit close`

    Credit card controller with URLs like /credit_cards/debit.
        Controller: app/controllers/credit_cards_controller.rb
        Test:       test/controllers/credit_cards_controller_test.rb
        Views:      app/views/credit_cards/debit.html.erb [...]
        Helper:     app/helpers/credit_cards_helper.rb

コントローラのジェネレータにはgenerate controller コントローラ名 アクション1 アクション2という形式でパラメータを渡します。helloアクションを実行すると、ちょっとしたメッセージを表示するGreetingsコントローラを作ってみましょう。

$ bin/rails generate controller Greetings hello
     create  app/controllers/greetings_controller.rb
      route  get 'greetings/hello'
     invoke  erb
     create    app/views/greetings
     create    app/views/greetings/hello.html.erb
     invoke  test_unit
     create    test/controllers/greetings_controller_test.rb
     invoke  helper
     create    app/helpers/greetings_helper.rb
     invoke    test_unit

どんなファイルが生成されたのでしょうか?アプリケーションの中にさまざまなディレクトリが作成され、コントローラファイル、ビューファイル、機能テストのファイル、ビューヘルパー、JavaScriptファイル、スタイルシートファイルが作成されました。

生成されたコントローラ(app/controllers/greetings_controller.rb)をエディタで開いて以下のように変更してみましょう。

class GreetingsController < ApplicationController
  def hello
    @message = "こんにちは、ご機嫌いかがですか?"
  end
end

次はビュー(app/views/greetings/hello.html.erb)を編集して、メッセージを表示できるようにします。

<h1>ごあいさつ</h1>
<p><%= @message %></p>

bin/rails serverでサーバーを起動します。

$ bin/rails server
=> Booting Puma...

アクセスするURLはhttp://localhost:3000/greetings/helloです。

通常のRailsアプリケーションでは、URLはhttp://ホスト名/コントローラ名/アクション名というパターンになります。アクション名を指定しないhttp://ホスト名/コントローラ名というパターンのURLは、コントローラのindexアクションにアクセスするURLです。

Railsにはデータモデルを生成するジェネレータもあります。

$ bin/rails generate model
Usage:
  bin/rails generate model NAME [field[:type][:index] field[:type][:index]] [options]

...

ActiveRecord options:
      [--migration], [--no-migration]        # Indicates when to generate migration
                                             # Default: true

...

Description:
    Generates a new model. Pass the model name, either CamelCased or
    under_scored, and an optional list of attribute pairs as arguments.

...

typeパラメータで指定できるフィールド型については、APIドキュメントに記載されている、SchemaStatementsモジュールのadd_columnメソッドの説明を参照してください。indexパラメータを指定すると、カラムに対応するインデックスも生成されます。

ここでは直接モデルを作成する代わりに(モデルの作成は後ほど行います)、scaffoldをセットアップしましょう。Railsにおけるscaffold(足場)とは、「モデル」「モデルのマイグレーションファイル「モデルを操作するコントローラ」「データを操作・表示するビュー」「それぞれのテストファイル」一式をさします。

"HighScore"という名前の単体リソースを準備してみましょう。このリソースの役割はビデオゲームでの最高得点を記録することです。

$ bin/rails generate scaffold HighScore game:string score:integer
    invoke  active_record
    create    db/migrate/20190416145729_create_high_scores.rb
    create    app/models/high_score.rb
    invoke    test_unit
    create      test/models/high_score_test.rb
    create      test/fixtures/high_scores.yml
    invoke  resource_route
     route    resources :high_scores
    invoke  scaffold_controller
    create    app/controllers/high_scores_controller.rb
    invoke    erb
    create      app/views/high_scores
    create      app/views/high_scores/index.html.erb
    create      app/views/high_scores/edit.html.erb
    create      app/views/high_scores/show.html.erb
    create      app/views/high_scores/new.html.erb
    create      app/views/high_scores/_form.html.erb
    invoke    test_unit
    create      test/controllers/high_scores_controller_test.rb
    create      test/system/high_scores_test.rb
    invoke    helper
    create      app/helpers/high_scores_helper.rb
    invoke      test_unit
    invoke    jbuilder
    create      app/views/high_scores/index.json.jbuilder
    create      app/views/high_scores/show.json.jbuilder
    create      app/views/high_scores/_high_score.json.jbuilder

ジェネレータは、「モデル」「コントローラ」「ヘルパー」「レイアウト」「機能テスト」「単体テスト」「スタイルシート用のディレクトリ」が存在することをチェックし、ビュー、コントローラ、モデル、マイグレーション(high_scoresテーブルとフィールドを作成します)を生成し、このリソース用のルーティングを追加します。また、これらのテストも作成します。

scaffold生成の次は、マイグレーション(migration: 移行)を実行する必要があります。マイグレーションを実行するには、データベースのスキーマを変更するRubyのコード(20130717151933_create_high_scores.rbにあるコードのことです)を実行する必要があります。データベースとはどのデータベースでしょうか?bin/rails db:migrateコマンドを実行すると、RailsはSQLite3に新しいデータベースを作ります。このコマンドについて詳しくは後述します。

$ bin/rails db:migrate
==  CreateHighScores: migrating ===============================================
-- create_table(:high_scores)
   -> 0.0017s
==  CreateHighScores: migrated (0.0019s) ======================================

単体テスト(unit test)について説明します。単体テストとは、コードをテストしてアサーション(assertion: コードが期待どおりに動作するかどうかを確認すること)を行うコードです。単体テストでは、モデルのメソッドなどのコードの一部分を取り出して、入力と出力をテストします。単体テストはあなたにとって友人と同じぐらい大切なものです。単体テストをきちんと書いておくと幸せになれるという事実に早いうちに気づいた人は、間違いなく他の人より先に幸せになれるでしょう。単体テストについて詳しくはテスティングガイドを参照してください。

Railsが作ってくれたインターフェースを見てみましょう。

$ bin/rails server

ブラウザでhttp://localhost:3000/high_scoresを開いてみましょう。それではハイスコアを更新するとしましょう(スペースインベーダーで55,160点とかね!)(訳注: 2003年にDonald Hayesがたたき出したスコアです)。

1.4 bin/rails console

consoleコマンドを使うと、コマンドラインでRailsアプリケーションと対話的操作を実行できるようになります。bin/rails consoleは内部でRubyのIRBを使っているので、IRBを使ったことがあれば簡単に扱えます。IRBは、思いついたアイデアを試してみたり、ウェブサイトにアクセスすることなくサーバのデータを変更したりするときに便利です。

コンソールコマンドを実行するときにbin/rails cのように"c"というエイリアスが使えます。

以下のようにconsoleコマンドを実行する環境も指定できます。

$ bin/rails console -e staging

コードを動かしたときにデータが変更されないようにするには、以下のようにbin/rails console --sandboxを実行します。

$ bin/rails console --sandbox
Loading development environment in sandbox (Rails 7.0.0)
Any modifications you make will be rolled back on exit
irb(main):001:0>
1.4.1 appオブジェクトとhelperオブジェクト

bin/rails consoleの実行中、appオブジェクトとhelperオブジェクトにアクセスできます。

appメソッドを使うと、名前付きルーティングヘルパーにアクセスできます。リクエストを投げることもできます。

irb> app.root_path
=> "/"

irb> app.get _
Started GET "/" for 127.0.0.1 at 2014-06-19 10:41:57 -0300
...

helperメソッドを使うと、Railsのアプリケーションヘルパーと自分が実装したヘルパーにアクセスできます。

irb> helper.time_ago_in_words 30.days.ago
=> "about 1 month"

irb> helper.my_custom_helper
=> "my custom helper"

1.5 bin/rails dbconsole

bin/rails dbconsoleコマンドは使っているデータベースを見つけて、適切なデータベースコマンドラインツールを起動します(コマンドラインツールに必要な引数も与えられます)。MySQL(MariaDBも含む)、PostgreSQL、SQLite、そしてSQLite3をサポートしています。

DBコンソールコマンドを実行するときにbin/rails dbのように「db」というエイリアスが使えます。

$ bin/rails dbconsole --database=animals

1.6 bin/rails runner

bin/rails runnerコマンドを使うと、RubyのコードをRailsのコンテキストで非対話的に実行できます。たとえば次のようになります。

$ bin/rails runner "Model.long_running_method"

ランナーコマンドを実行するときにbin/rails rのように"r"というエイリアスが使えます。

-erunnerコマンドを実行する環境を指定できます。

$ bin/rails runner -e staging "Model.long_running_method"

ファイル内のRubyコードをrunnerで実行することもできます。

$ bin/rails runner lib/code_to_be_run.rb

1.7 bin/rails destroy

destroygenerateの逆の操作です。ジェネレータコマンドで生成された内容を調べて、それを取り消します。

bin/rails dのように、「d」というエイリアスでdestroyコマンドを実行することもできます。

$ bin/rails generate model Oops
      invoke  active_record
      create    db/migrate/20120528062523_create_oops.rb
      create    app/models/oops.rb
      invoke    test_unit
      create      test/models/oops_test.rb
      create      test/fixtures/oops.yml

$ bin/rails destroy model Oops
      invoke  active_record
      remove    db/migrate/20120528062523_create_oops.rb
      remove    app/models/oops.rb
      invoke    test_unit
      remove      test/models/oops_test.rb
      remove      test/fixtures/oops.yml

1.8 bin/rails about

bin/rails aboutを実行すると、Ruby、RubyGems、Rails、Railsのサブコンポーネントのバージョン、Railsアプリケーションのフォルダー名、現在のRailsの環境名とデータベースアダプタ、スキーマのバージョンが表示されます。チーム内やフォーラムで質問するときや、セキュリティパッチが自分のアプリケーションに影響するかどうかを確認したいときなど、現在使っているRailsに関する情報が必要なときに使うと便利です。

$ bin/rails about
About your application's environment
Rails version             6.0.0
Ruby version              2.7.0 (x86_64-linux)
RubyGems version          2.7.3
Rack version              2.0.4
JavaScript Runtime        Node.js (V8)
Middleware:               Rack::Sendfile, ActionDispatch::Static, ActionDispatch::Executor, ActiveSupport::Cache::Strategy::LocalCache::Middleware, Rack::Runtime, Rack::MethodOverride, ActionDispatch::RequestId, ActionDispatch::RemoteIp, Sprockets::Rails::QuietAssets, Rails::Rack::Logger, ActionDispatch::ShowExceptions, WebConsole::Middleware, ActionDispatch::DebugExceptions, ActionDispatch::Reloader, ActionDispatch::Callbacks, ActiveRecord::Migration::CheckPending, ActionDispatch::Cookies, ActionDispatch::Session::CookieStore, ActionDispatch::Flash, Rack::Head, Rack::ConditionalGet, Rack::ETag
Application root          /home/foobar/commandsapp
Environment               development
Database adapter          sqlite3
Database schema version   20180205173523

1.9 bin/rails assets

bin/rails assets:precompileを実行すると、app/assets配下のファイルをプリコンパイルできます。bin/rails assets:cleanを実行すると、古くなったコンパイル済みのファイルを削除できます。assets:cleanは、古いアセットへのリンクを維持しながら新しいアセットをビルドして最新の状態にするので、「ローリングデプロイ(rolling deploy)」にも使えます。

public/assetsディレクトリのアセットを完全に削除するにはbin/rails assets:clobberを実行します。

1.10 bin/rails db

bin/railsコマンドのdb:名前空間に属するタスクのうち、最もよく使われるのはmigratecreateです。マイグレーションに関するタスク(up, down, redo, reset)は一度ひととおり試してみることをおすすめします。bin/rails db:versionは、トラブルシューティングで現在のデータベースの状況を調べるときに便利です。

マイグレーションについて詳しくは、Active Recordマイグレーションを参照してください。

1.11 bin/rails notes

bin/rails notesは、特定のキーワードで始まるコードコメントを検索して表示します。bin/rails notes --helpで利用法を表示できます。

デフォルトでは、appconfigdblibtestディレクトリにある、拡張子が .builder.rb.rake.yml.yaml.ruby.css.js.erbのファイルの中から、「FIXME」「OPTIMIZE」「TODO」キーワードで始まるコメントを検索します(訳注: コメントのキーワードを[FIXME]のように[]で囲んでしまうと検索されません)。

$ bin/rails notes
app/controllers/admin/users_controller.rb:
  * [ 20] [TODO] any other way to do this?
  * [132] [FIXME] high priority for next deploy

lib/school.rb:
  * [ 13] [OPTIMIZE] refactor this code to make it faster
  * [ 17] [FIXME]

1.11.1 アノテーション

--annotations引数で特定のアノテーションを指定できます。デフォルトでは「FIXME」「OPTIMIZE」「TODO」を検索します。アノテーションは大文字小文字を区別する点にご注意ください。

$ bin/rails notes --annotations FIXME RELEASE
app/controllers/admin/users_controller.rb:
  * [101] [RELEASE] We need to look at this before next release
  * [132] [FIXME] high priority for next deploy

lib/school.rb:
  * [ 17] [FIXME]

1.11.2 タグ

config.annotations.register_tags設定でデフォルトのタグを追加できます。このオプションにはタグのリストを渡せます。

config.annotations.register_tags("DEPRECATEME", "TESTME")
$ bin/rails notes
app/controllers/admin/users_controller.rb:
  * [ 20] [TODO] do A/B testing on this
  * [ 42] [TESTME] this needs more functional tests
  * [132] [DEPRECATEME] ensure this method is deprecated in next release

1.11.3 ディレクトリ

config.annotations.register_directories設定にデフォルトディレクトリを追加できます。このオプションにはディレクトリ名のリストを渡せます。

config.annotations.register_directories("spec", "vendor")
$ bin/rails notes
app/controllers/admin/users_controller.rb:
  * [ 20] [TODO] any other way to do this?
  * [132] [FIXME] high priority for next deploy

lib/school.rb:
  * [ 13] [OPTIMIZE] Refactor this code to make it faster
  * [ 17] [FIXME]

spec/models/user_spec.rb:
  * [122] [TODO] Verify the user that has a subscription works

vendor/tools.rb:
  * [ 56] [TODO] Get rid of this dependency

1.11.4 拡張子

config.annotations.register_extensions設定にデフォルトのファイル拡張子を追加できます。このオプションにはファイル拡張子のリストと、対応する正規表現を渡せます。

config.annotations.register_extensions("scss", "sass") { |annotation| /\/\/\s*(#{annotation}):?\s*(.*)$/ }
$ bin/rails notes
app/controllers/admin/users_controller.rb:
  * [ 20] [TODO] any other way to do this?
  * [132] [FIXME] high priority for next deploy

app/assets/stylesheets/application.css.sass:
  * [ 34] [TODO] Use pseudo element for this class

app/assets/stylesheets/application.css.scss:
  * [  1] [TODO] Split into multiple components

lib/school.rb:
  * [ 13] [OPTIMIZE] Refactor this code to make it faster
  * [ 17] [FIXME]

spec/models/user_spec.rb:
  * [122] [TODO] Verify the user that has a subscription works

vendor/tools.rb:
  * [ 56] [TODO] Get rid of this dependency

1.12 bin/rails routes

bin/rails routesで、すべての定義済みルーティングテーブルを表示できます。ルーティングの問題を解決するときや、アプリケーションのルーティング全体を理解するときに便利です。

1.13 bin/rails test

Railsでの単体テストについて詳しくは、ガイドのRailsアプリケーションをテストするを参照してください。

Railsにはminitestと呼ばれるテストフレームワークが付属しています。Railsを安定させるには、テストをひととおり書きましょう。test:名前空間で定義されているタスクは、さまざまなテストを書いて実行するときに役立ちます(皆さんがテストを書いてくれますように!)。

1.14 bin/rails tmp

Rails.root/tmpディレクトリには一時ファイルが保存されます(*nix系でいう/tmpディレクトリと同様です)。一時ファイルには、プロセスIDのファイル、アクションキャッシュのファイルなどがあります。

tmp:名前空間には、Rails.root/tmpディレクトリを作成・削除する以下のタスクがあります。

  • bin/rails tmp:cache:clear clears tmp/cache.
  • bin/rails tmp:sockets:clear clears tmp/sockets.
  • bin/rails tmp:screenshots:clear clears tmp/screenshots.
  • bin/rails tmp:clear clears all cache, sockets, and screenshot files.
  • bin/rails tmp:create creates tmp directories for cache, sockets, and pids.

1.15 その他のタスク

  • bin/rails initializers: Railsで呼び出されるすべてのイニシャライザを、実際の呼び出し順で表示します。
  • bin/rails middleware: アプリで有効になっているRackミドルウェアスタックのリストを表示します。
  • rails stats: コード量とテスト量の比率やKLOCs(1000を単位とするコード行数)などのコードに関する統計値を表示します。
  • rails secret: セッションのsecretに用いる擬似乱数を生成します。
  • rails time:zones:all: Railsが扱えるすべてのタイムゾーンを表示します。

1.16 カスタムRakeタスク

独自のRakeタスクの拡張子は.rakeで、 Rails.root/lib/tasks配下に保存します。また、独自のタスクを作成できる bin/rails generate taskというコマンドもあります。

desc "手短でクールなタスクの概要"
task task_name: [:prerequisite_task, :another_task_we_depend_on] do
  # マジックをここに書く
  # 有効なRubyコードなら何でも書ける
end

タスクには以下のように引数を渡します。

task :task_name, [:arg_1] => [:prerequisite_1, :prerequisite_2] do |task, args|
  argument_1 = args.arg_1
end

タスクを名前空間内で定義することで、タスクをグルーピングできます。

namespace :db do
  desc "何もしないタスク"
  task :nothing do
    # 本当に何もしない
  end
end

タスクの呼び出しは以下のように行います。

$ bin/rails task_name
$ bin/rails "task_name[value 1]" # 引数の文字列全体を引用符で囲むこと
$ bin/rails "task_name[value 1, value2, value3]" # 複数の引数はカンマで区切る
$ bin/rails db:nothing

タスク内でアプリケーション内のモデルを使う場合や、データベースに対してクエリを送信する場合は、そのタスクをenvironmentタスクに依存させる必要があります。environmentタスクはアプリケーションのコードを読み込むタスクです。

2 Railsの高度なコマンドライン

コマンドラインを使いこなすようになると、自分のニーズやワークフローにふさわしい便利な(時に驚くような)オプションを見つけられるようになります。ここでは、Railsコマンドラインの裏技をいくつか紹介します。

2.1 Railsのデータベースとバージョン管理

新しいRailsアプリケーションを作成するときに、データベースの種類やバージョン管理の種類(Gitなど)も指定できます。このオプションで、ちょっとした時間と多くのキー入力を節約できます。

それでは--gitオプションと--database=postgresqlオプションの動きを見てみましょう。

$ mkdir gitapp
$ cd gitapp
$ git init
Initialized empty Git repository in .git/
$ rails new . --git --database=postgresql
      exists
      create  app/controllers
      create  app/helpers
...
...
      create  tmp/cache
      create  tmp/pids
      create  Rakefile
add 'Rakefile'
      create  README.md
add 'README.md'
      create  app/controllers/application_controller.rb
add 'app/controllers/application_controller.rb'
      create  app/helpers/application_helper.rb
...
      create  log/test.log
add 'log/test.log'

Railsがリポジトリにファイルを作成する前に、gitappディレクトリを作成して空のgitリポジトリを初期化しておく必要があります。Railsが作成したデータベースの設定ファイルを見てみましょう。

$ cat config/database.yml
# PostgreSQL. Versions 9.3 and up are supported.
#
# Install the pg driver:
#   gem install pg
# On macOS with Homebrew:
#   gem install pg -- --with-pg-config=/usr/local/bin/pg_config
# On macOS with MacPorts:
#   gem install pg -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config
# On Windows:
#   gem install pg
#       Choose the win32 build.
#       Install PostgreSQL and put its /bin directory on your path.
#
# Configure Using Gemfile
# gem 'pg'
#
default: &default
  adapter: postgresql
  encoding: unicode
  # For details on connection pooling, see Rails configuration guide
  # https://guides.rubyonrails.org/configuring.html#database-pooling
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>

development:
  <<: *default
  database: gitapp_development
...
...

Railsは、指定のデータベース(PostgreSQL)に対応するdatabase.ymlを作成します。

バージョン管理システムに関するオプションを使う場合は、最初にアプリケーション用のディレクトリを作り、バージョン管理システムを初期化してから、rails newコマンドを実行するようにしてください。

フィードバックについて

Railsガイドは GitHub の yasslab/railsguides.jp で管理・公開されております。本ガイドを読んで気になる文章や間違ったコードを見かけたら、上記リポジトリにてお気軽に Pull Request を出して頂けると嬉しいです。Pull Request の送り方については GitHub の README をご参照ください。

原著における間違いを見つけたら『Rails のドキュメントに貢献する』を参考にしながらぜひ Rails コミュニティに貢献してみてください 🛠💨✨

本ガイドの品質向上に向けて、皆さまのご協力が得られれば嬉しいです。よろしくお願いします。

YassLab 株式会社
https://yasslab.jp/

支援・協賛

Railsガイドは下記のサポーターから継続的な支援を受けています。Railsガイドへの支援・協賛にご興味あれば info@yasslab.jp までお問い合わせください。

  1. このエントリーをはてなブックマークに追加
  2. Star