Railsで作ったプロジェクトのフォルダ構造

概要

今回のブログではRuby on RailsをインストールしてRuby on Railsを使って新しプロジェクトを生成する方法について確認しました。

MacでRuby on Railsを始める

今回のブログポストでは、新しく生成したRailsのプロジェクトの構造を把握してみようかと思います。

このブログポストはシリーズで作成されてます。詳しく内容は下記のリンクを参考してください。

ここで使ったソースコードはGithubで確認できます。

Github ソースコード

プロジェクトの構造

Ruby on Railsでプロジェクトを生成すると、下記のようなプロジェクトが生成されます。下記の内容は生成されたプロジェクトのフォルダ中で重要な部分だけまとめました。

├── Gemfile
├── Gemfile.lock
├── README.md
├── Rakefile
├── app
│   ├── controllers
│   │   ├── application_controller.rb
│   │   └── concerns
│   ├── models
│   │   ├── application_record.rb
│   │   └── concerns
│   └── views
│       └── layouts
│           ├── application.html.erb
│           ├── mailer.html.erb
│           └── mailer.text.erb
├── babel.config.js
├── bin
├── config
│   ├── locales
│   │   └── en.yml
│   ├── routes.rb
├── config.ru
├── db
│   ├── development.sqlite3
│   └── seeds.rb
├── lib
├── log
│   └── development.log
├── package.json
├── postcss.config.js
├── public
├── storage
├── temp
├── test
├── vendor
└── yarn.lock

Controller関連

Ruby on Railsも他のフレームワークと同じようにMVCパタン(Model-View-Controllerパタン)を使ってます。したがって、Ruby on Railsを使ってModel, View, Controllerを作ることでウェブサービスを作ることができます。

Ruby on RailsでControllerを生成して、下記のようなフォルダ、ファイルを使うことになります。

├── app
│   ├── assets
│   │   ├── stylesheets
│   │   │   ├── home.scss
│   ├── controllers
│   │   ├── home_controller.rb
│   ├── helpers
│   │   ├── home_helper.rb
├── test
│   ├── controllers
│   │   ├── home_controller_test.rb

次のブログポストで紹介しますが、RailsのコマンドでConrollerを生成すると上のようなファイルが生成されます。ここではhome_controllerを生成した例題になります。

Controllerを生成する方法については下記のリンクを参考してください。

Ruby on Railsを使って新しウェブページを作る - Controller

View関連

Ruby on Railsで画面を表示するためにはViewを下記のフォルダに生成することになります。

├── app
│   ├── views
│   │   ├── home

ここでは上と同じようにhome_controllerを生成した後のフォルダの構造です。皆さんはまだ、homeフォルダが見えないと思います。home_controllerをRailsのコマンドで生成すると、そこに必要なViewを保管するhomeフォルダが自動で生成されます。

ControllerとViewを生成する方法については下記のリンクを参考してください。

Ruby on Railsを使って新しウェブページを作る - View

URL関連

RailsはRubyと言う言語を使ってウェブサービスを作るためのフレームワークとなります。ウェブサービスを作るためのフレームワークなので、当たり前ですが、URLを管理する機能を持っています。

RailsでURLはconfigフォルダ中のroutes.rbファイルで管理します。

├── config
│   ├── routes.rb

Railsへ新しURLを追加する方法については下記のリンクを参考してください。

Ruby on Railsを使って新しウェブページを作る - Route

Database

Ruby on RailsでDataを使うためのファイルたちは下記のようです。

├── app
│   ├── models
│   │   ├── post.rb
├── config
│   ├── database.yml
├── db
│   ├── migrate
│   │   ├── 20200313092804_create_posts.rb
├── test
│   ├── fixtures
│   │   ├── posts.yml
│   ├── models
│   │   ├── post_test.rb

config/database.yml: Databaseの連結情報の設定ファイル
app/models/post.rb: 実際テーブルと連動するModel
db/migrate/20200313092804_create_posts.rb: テーブルを生成するためのmigratoinファイル
test/fixtures/posts.yml: テストのためのDummyデータ
test/models/post_test.rb: Modelのユニットテストするためのファイル

データベースを設定して、データを使う方法については下記のブログを参考してください。