Ruby on Rails ガイド

Railsガイドは Ruby on Rails Guides に基づいた大型リファレンスガイドです。Railsの各機能を体系的に学び、プロダクト開発の生産的を高めたいときに役立ちます。

これからプロダクト開発を学び始める場合はRailsチュートリアルがオススメです。プロダクト開発の流れを掴んだら、より実践的な本ガイドをご活用してください。

気になる文章や間違ったコードを見つけたら GitHub の yasslab/railsguides.jp までお知らせください。本ガイドの品質向上に向けてご協力して頂けると嬉しいです :)

  1. このエントリーをはてなブックマークに追加
  2. Star
このアイコンが付いているガイドは現在作業中 (WIP: Work In Progress) です。作業中のガイドはそれなりに有用ではありますが、不完全な情報やエラーが含まれている可能性があります。

はじめに

Rails をはじめよう

Railsのインストール方法と最初のRailsアプリケーションの作成に必要なすべてを解説します。

モデル

Active Record の基礎

Active Recordの基礎となるモデル、データベースへの永続的な保存、Active Recordパターンとライブラリについて解説します。

Active Record マイグレーション

Active Recordのマイグレーション (migration) を使用して、データベースを構造化された方法で整然と変更する方法について解説します。

Active Record バリデーション

Active Recordのバリデーション機能について解説します。

Active Record コールバック

Active Recordのコールバックについて解説します。

Active Record の関連付け

Active Recordが提供するすべての関連付け機能について解説します。

Active Record クエリインターフェイス

Active Recordが提供するすべてのデータベースクエリインターフェイスについて解説します。

Active Record と PostgreSQL
Work in progress

PostgreSQLに特化したActive Recordの利用法について解説します。

Active Record で複数のデータベース利用
Work in progress

Active Recordでデータベースを複数利用する方法について解説します。

Active Model の基礎
Work in progress

Active Recordを使わずにモデルクラスを扱う方法について解説します。

ビュー

Action View の概要
Work in progress

Action Viewの概要を紹介し、共通のビューヘルパーについてもある程度解説します。

レイアウトとレンダリング

Action ControllerとAction Viewが提供する基本的なレイアウト機能について解説します。画面出力 (レンダリング) とリダイレクト、content_forブロックとパーシャル (部分テンプレート) の使用方法についても解説します。

Action View フォームヘルパー

ビルトインのフォームヘルパーについて解説します。

コントローラ

Action Controller の概要

本ガイドでは、コントローラの動作と、アプリケーションのリクエストサイクルでコントローラがどのように使われるかについて説明します。セッション、フィルタ、cookie、データストリーミング、リクエストによって発生する例外、その他多くの話題を取り扱っています。

Rails のルーティング

Railsのルーティング機能について解説します。Railsアプリケーションで行われているルーティングのしくみについて理解したい場合は、ここからお読みください。

他の構成要素

Active Support コア拡張機能

Active Supportで定義されているRubyのコア拡張機能に関するドキュメントです。

Action Mailer の基礎

Action Mailerを使用してメールを送受信する方法について解説します。

Action Mailbox の基礎
Work in progress

Action Mailboxを使ってメールを受信する方法について解説します。

Action Text の概要
Work in progress

Action Text を使ったリッチテキスト形式のデータの取り扱い方法について解説します。

Active Job の基礎

バックグラウンドで動作するジョブの作成・キュー送信・実行方法に必要なすべてを解説します。

Active Storage の概要

Active Record のモデルにファイルを添付する方法について解説します。

Action Cable の概要

リアルタイム機能を実現するAction Cableの動作と、WebSocketsの利用法について解説します。

Action Text の概要

リッチテキストコンテンツの扱い始めるのに必要なものについて解説します。

高度なトピック

Rails 国際化 (i18n) API

Railsアプリケーションを国際化する方法について解説します。これによりアプリケーションを異なる言語に翻訳することができ、さらに単数形/複数形ルールを変更したり、その国に適した日付フォーマットを設定したりできます。

Rails テスティングガイド

Railsでさまざまなテストを実行するための総合的な解説を行います。「テスティングとは何か」から結合テストまですべてのトピックを扱います。

Rails セキュリティガイド

Webアプリケーション全般におけるセキュリティ問題と、Railsでこれらの問題を回避する方法について解説します。

Rails アプリケーションのデバッグ

Railsアプリケーションのデバッグ方法について解説します。さまざまなデバッグ方法や、作成したコードの舞台裏でどのような動作が行われているかについても解説します。

Rails アプリケーションを設定する

Railsアプリケーションの基本的な設定方法について解説します。

コマンドラインツール

Railsが提供する各種コマンドラインツールについて解説します。

アセットパイプライン

アセットパイプラインに関するドキュメントです。

Rails で JavaScript を使用する

RailsビルトインのAjax/JavaScriptについて解説します。

Rails の初期化プロセス
Work in progress

Rails 内部の初期化プロセスについて解説します。

定数の自動読み込みと再読み込み

定数の自動読み込みや再読み込みの動作について解説します。

Rails のキャッシュ機構

キャッシュを活用してRailsを高速化する方法について解説します。

Active Support の Instrumentation 機能
Work in progress

RailsなどのRubyコード内のイベント測定に使う、Active Support内のInstrumentation APIについて解説します。

Rails アプリケーションのテンプレート
Work in progress

テンプレートを使って生成/カスタマイズを行う方法や、テンプレートAPIを使って再利用可能なテンプレートを開発する方法について解説します。

Rails による API 専用アプリケーション

JSON APIアプリケーションをRailsで効果的に作成する方法を解説します。

Rails を拡張する

Rails プラグイン作成入門
Work in progress

プラグインを作成してRailsの機能を拡張する方法について解説します。

Rails と Rack

RailsとRackがどのように統合されているか、および他のRackコンポーネントとのインターフェイスについて解説します。

Rails ジェネレータとテンプレート入門

新しいジェネレータを拡張に追加したり、ビルトインのRailsジェネレータの要素に別の要素を提供したりする方法 (scaffoldジェネレータに別のテストスタブを提供するなど) について解説します。

Rails エンジン入門

マウント可能なエンジンの作成方法について解説します。

Rails のスレッドとコード実行
Work in progress

Railsアプリケーションの並行性について考慮すべきことや利用可能なツールについて解説します。

Ruby on Rails に貢献する

Ruby on Rails に貢献する方法

Railsは「どこかで誰かがうまくやってくれているフレームワーク」ではありません。現在も継続しているRailsフレームワーク開発に貢献するさまざまな方法について解説します。

Rails コア開発環境の構築方法

Ruby on Rails自体の開発環境を構築する方法について解説します。

API ドキュメント作成ガイドライン

Ruby on Rails APIドキュメントのガイドラインについて解説します。

Rails ガイドのガイドライン

Ruby on Railsガイド作成方法のガイドラインです。

メンテナンスポリシー

メンテナンスポリシー

現在サポートされているRuby on Railsのバージョンと、次期バージョンのリリース見込み時期について記載されています。

リリースノート

Rails アップグレードガイド

アプリケーションのRuby on Railsを最新バージョンにアップグレードする方法について解説します。

Rails 6.0 - 2019/08

Rails 6.0のリリースノートです。

Rails 5.2 - 2018/04

Rails 5.2のリリースノートです。

Rails 5.1 - 2017/04

Rails 5.1のリリースノートです。

Rails 5.0 - 2016/06

Rails 5.0のリリースノートです。

Rails 4.2 - 2014/12

Rails 4.2のリリースノートです。

Rails 4.1 - 2014/04

Rails 4.1のリリースノートです。

Rails 4.0 - 2013/06

Rails 4.0のリリースノートです。

Rails 3.2 - 2012/01

Rails 3.2のリリースノートです。

Rails 3.1 - 2011/08

Rails 3.1のリリースノートです。

Rails 3.0 - 2010/08

Rails 3.0のリリースノートです。

Rails 2.3 - 2009/03 [未訳]

Rails 2.3のリリースノートです。

Rails 2.2 - 2008/11 [未訳]

Rails 2.2のリリースノートです。

協力者

Railsガイドは、次の方々の支援によって支えられております。

[PR] Railsガイドを、もっと便利に。

Railsガイドをもっと便利に使えるサービスをリリースしました! 本サービスで得られた売上はRailsガイドを継続的に更新・運営するために活用させていただきます。よければぜひご検討ください ;)

Proプラン Teamプラン

フィードバックについて

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

原著における間違いを見つけたら、「Ruby on Rails に貢献する方法」に記されている Rails のドキュメントに貢献するを参考にしながらぜひ Rails コミュニティに貢献してみてください :)

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

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

支援・協賛

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

  1. Takeyuweb: エンジニアリングをもっと自由に楽しく
  1. このエントリーをはてなブックマークに追加
  2. Star