Rails – モデルによるDB操作の仕組み

2021-03-08 / tau / コメントする

概要

モデルによるデータベース操作を、できるだけ基本的な方法で行うことを試した。

またテーブル構造の変更に対して、マイグレーションを行わずにmysqlコンソールとコントロールファイル編集だけで対応できることを確認した。

モデルとテーブルの生成

モデルの生成

以下の様にモデルを生成する。このモデルは文字列型のフィールドを1つ持っている。

rails generate model record col1:string

[vagrant@localhost migrate]$ rails generate model record col1:string
Running via Spring preloader in process 24431
      invoke  active_record
      create    db/migrate/20210308054636_create_records.rb
      create    app/models/record.rb
      invoke    test_unit
      create      test/models/record_test.rb
      create      test/fixtures/records.yml

[vagrant@localhost migrate]$ rails generate model record col1:string

Running via Spring preloader in process 24431

invoke active_record

create db/migrate/20210308054636_create_records.rb

create app/models/record.rb

invoke test_unit

create test/models/record_test.rb

create test/fixtures/records.yml

app/models/record.rbが作成される。

class Record < ApplicationRecord
end

1 2	class Record < ApplicationRecord end

マイグレーションファイルも作成されていて、string型のフィールドが定義されている。

[vagrant@localhost demo_app]$ cat db/migrate/20210308054636_create_records.rb
class CreateRecords < ActiveRecord::Migration[6.1]
  def change
    create_table :records do |t|
      t.string :col1

      t.timestamps
    end
  end
end

[vagrant@localhost demo_app]$ cat db/migrate/20210308054636_create_records.rb

class CreateRecords < ActiveRecord::Migration[6.1]

def change

create_table :records do |t|

t.string :col1

t.timestamps

end

マイグレーション～テーブル生成

このモデルからマイグレーションによりテーブルを生成する。

rails db:migrate

[vagrant@localhost migrate]$ rails db:migrate
== 20210308054636 CreateRecords: migrating ====================================
-- create_table(:records)
   -> 0.0364s
== 20210308054636 CreateRecords: migrated (0.0365s) ===========================

[vagrant@localhost migrate]$ rails db:migrate

== 20210308054636 CreateRecords: migrating ====================================

-- create_table(:records)

-> 0.0364s

== 20210308054636 CreateRecords: migrated (0.0365s) ===========================

mysqlでテーブルが生成されていることと、そのテーブルの構造が確認できる。

mysql> show tables;
+-----------------------+
| Tables_in_demo_app_db |
+-----------------------+
| ar_internal_metadata  |
| records               |
| schema_migrations     |
+-----------------------+
3 rows in set (0.00 sec)

mysql> desc records;
+------------+--------------+------+-----+---------+----------------+
| Field      | Type         | Null | Key | Default | Extra          |
+------------+--------------+------+-----+---------+----------------+
| id         | bigint       | NO   | PRI | NULL    | auto_increment |
| col1       | varchar(255) | YES  |     | NULL    |                |
| created_at | datetime(6)  | NO   |     | NULL    |                |
| updated_at | datetime(6)  | NO   |     | NULL    |                |
+------------+--------------+------+-----+---------+----------------+
4 rows in set (0.00 sec)

mysql> show tables;

+-----------------------+

| Tables_in_demo_app_db |

+-----------------------+

| ar_internal_metadata |

| records |

| schema_migrations |

+-----------------------+

3 rows in set (0.00 sec)

mysql> desc records;

+------------+--------------+------+-----+---------+----------------+

+------------+--------------+------+-----+---------+----------------+

| id | bigint | NO | PRI | NULL | auto_increment |

| col1 | varchar(255) | YES | | NULL | |

+------------+--------------+------+-----+---------+----------------+

4 rows in set (0.00 sec)

モデルの構造の確認

コントローラーからモデルの内容を出力させる。

class DemoContentsController < ApplicationController
  def top_page
    puts "EXAMPLE"
    record = Record.new
    p record
  end
end

class DemoContentsController < ApplicationController

def top_page

puts "EXAMPLE"

record = Record.new

p record

end

トップページを出力させると、サーバー実行中のコンソールに以下が出力される。

app/controllers/demo_contents_controller.rb:4:in `top_page'
Started GET "/" for 10.0.2.2 at 2021-03-** **:**:** +0900
Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.0/127.255.255.255, ::1
Processing by DemoContentsController#top_page as HTML
EXAMPLE
#<Record id: nil, col1: nil, created_at: nil, updated_at: nil>

app/controllers/demo_contents_controller.rb:4:in `top_page'

Started GET "/" for 10.0.2.2 at 2021-03-** **:**:** +0900

Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.0/127.255.255.255, ::1

Processing by DemoContentsController#top_page as HTML

EXAMPLE

#<Record id: nil, col1: nil, created_at: nil, updated_at: nil>

Railsデフォルトのid、created_at、updated_atに加えてcol1が要素に加わっている。

データの登録確認

トップページアクセス時にレコードを1つ登録する。レコードのフィールドはハッシュで指定する。

lass DemoContentsController < ApplicationController
  def top_page
    puts "EXAMPLE"
    record = Record.new({col1: 'abc'})
    p record
    record.save
  end
end

lass DemoContentsController < ApplicationController

def top_page

puts "EXAMPLE"

record = Record.new({col1: 'abc'})

p record

record.save

end

Railsサーバーのコンソールに以下が出力され、データが生成・登録されていることがわかる。

app/controllers/demo_contents_controller.rb:6:in `top_page'
Started GET "/" for 10.0.2.2 at 2021-03-** **:**:** +0900
Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.0/127.255.255.255, ::1
Processing by DemoContentsController#top_page as HTML
EXAMPLE
#<Record id: nil, col1: "abc", created_at: nil, updated_at: nil>
  TRANSACTION (2.7ms)  BEGIN
  ↳ app/controllers/demo_contents_controller.rb:6:in `top_page'
  Record Create (2.4ms)  INSERT INTO `records` (`col1`, `created_at`, `updated_at`) VALUES ('abc', '2021-03-** **:**:**.501886', '2021-03-** **:**:**.501886')
  ↳ app/controllers/demo_contents_controller.rb:6:in `top_page'
  TRANSACTION (9.4ms)  COMMIT

app/controllers/demo_contents_controller.rb:6:in `top_page'

Started GET "/" for 10.0.2.2 at 2021-03-** **:**:** +0900

Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.0/127.255.255.255, ::1

Processing by DemoContentsController#top_page as HTML

EXAMPLE

#<Record id: nil, col1: "abc", created_at: nil, updated_at: nil>

TRANSACTION (2.7ms) BEGIN

↳ app/controllers/demo_contents_controller.rb:6:in `top_page'

Record Create (2.4ms) INSERT INTO `records` (`col1`, `created_at`, `updated_at`) VALUES ('abc', '2021-03-** **:**:**.501886', '2021-03-** **:**:**.501886')

↳ app/controllers/demo_contents_controller.rb:6:in `top_page'

TRANSACTION (9.4ms) COMMIT

mysqlでもテーブルへの登録状況が確認できる。

mysql> SELECT * FROM records;
+----+------+----------------------------+----------------------------+
| id | col1 | created_at                 | updated_at                 |
+----+------+----------------------------+----------------------------+
|  1 | abc  | 2021-03-** **:**:**.501886 | 2021-03-** **:**:**.501886 |
+----+------+----------------------------+----------------------------+
1 row in set (0.00 sec)

mysql> SELECT * FROM records;

+----+------+----------------------------+----------------------------+

| id | col1 | created_at | updated_at |

+----+------+----------------------------+----------------------------+

| 1 | abc | 2021-03-** **:**:**.501886 | 2021-03-** **:**:**.501886 |

+----+------+----------------------------+----------------------------+

1 row in set (0.00 sec)

データの読み込み確認

トップページ読み込み時にデータベースを読み込んで表示するように変更する。

class DemoContentsController < ApplicationController
  def top_page
    puts "EXAMPLE"
    records = Record.all
    p records
  end
end

class DemoContentsController < ApplicationController

def top_page

puts "EXAMPLE"

records = Record.all

p records

end

出力は以下のとおりで、データベースの内容が読みだされている。

app/controllers/demo_contents_controller.rb:5:in `top_page'
.....
EXAMPLE
  Record Load (2.0ms)  SELECT `records`.* FROM `records` /* loading for inspect */ LIMIT 11
  ↳ app/controllers/demo_contents_controller.rb:5:in `p'
#<ActiveRecord::Relation [#<Record id: 1, col1: "abc", created_at: "2021-03-** **:**:**.501886000 +0000", updated_at: "2021-03-** **:**:**.501886000 +0000">]>

app/controllers/demo_contents_controller.rb:5:in `top_page'

.....

EXAMPLE

Record Load (2.0ms) SELECT `records`.* FROM `records` /* loading for inspect */ LIMIT 11

↳ app/controllers/demo_contents_controller.rb:5:in `p'

#<ActiveRecord::Relation [#<Record id: 1, col1: "abc", created_at: "2021-03-** **:**:**.501886000 +0000", updated_at: "2021-03-** **:**:**.501886000 +0000">]>

MySQLでのテーブル変更

以下の様にmysqlで直接テーブルにフィールドを加える。

mysql> ALTER TABLE records ADD col2 INT;
Query OK, 0 rows affected (0.03 sec)
Records: 0  Duplicates: 0  Warnings: 0

mysql> SELECT * FROM records;
+----+------+----------------------------+----------------------------+------+
| id | col1 | created_at                 | updated_at                 | col2 |
+----+------+----------------------------+----------------------------+------+
|  1 | abc  | 2021-03-** **:**:**.501886 | 2021-03-** **:**:**.501886 | NULL |
+----+------+----------------------------+----------------------------+------+
1 row in set (0.00 sec)

mysql> ALTER TABLE records ADD col2 INT;

Query OK, 0 rows affected (0.03 sec)

Records: 0 Duplicates: 0 Warnings: 0

mysql> SELECT * FROM records;

+----+------+----------------------------+----------------------------+------+

| id | col1 | created_at | updated_at | col2 |

+----+------+----------------------------+----------------------------+------+

| 1 | abc | 2021-03-** **:**:**.501886 | 2021-03-** **:**:**.501886 | NULL |

+----+------+----------------------------+----------------------------+------+

1 row in set (0.00 sec)

Railsで変更後テーブルへの書き込み

トップページアクセス時に、フィールド追加後のテーブルに新たなデータを書き込むように変更。

class DemoContentsController < ApplicationController
  def top_page
    puts "EXAMPLE"
    record = Record.new({col1: 'ABC', col2: 123})
    p record
    record.save
  end
end

class DemoContentsController < ApplicationController

def top_page

puts "EXAMPLE"

record = Record.new({col1: 'ABC', col2: 123})

p record

record.save

end

トップページ表示時にデータが登録され、テーブルは以下の様に更新されている。

mysql> SELECT * FROM records;
+----+------+----------------------------+----------------------------+------+
| id | col1 | created_at                 | updated_at                 | col2 |
+----+------+----------------------------+----------------------------+------+
|  1 | abc  | 2021-03-** **:**:**.501886 | 2021-03-** **:**:**.501886 | NULL |
|  2 | ABC  | 2021-03-** **:**:**.219484 | 2021-03-** **:**:**.219484 |  123 |
+----+------+----------------------------+----------------------------+------+
2 rows in set (0.00 sec)

mysql> SELECT * FROM records;

+----+------+----------------------------+----------------------------+------+

| id | col1 | created_at | updated_at | col2 |

+----+------+----------------------------+----------------------------+------+

| 1 | abc | 2021-03-** **:**:**.501886 | 2021-03-** **:**:**.501886 | NULL |

| 2 | ABC | 2021-03-** **:**:**.219484 | 2021-03-** **:**:**.219484 | 123 |

+----+------+----------------------------+----------------------------+------+

2 rows in set (0.00 sec)

Rails – プロジェクトでのデータベース準備

2021-03-08 / tau / コメントする

概要

Railsでモデルによりフォームやデータベースとのやり取りをする流れ。

プロジェクト生成時にDBMSを指定
database.ymlを編集してデータベースを生成
モデルを生成
マイグレーションでテーブルを生成
モデルでフォームデータを取得
モデルでテーブルを読み書き

プロジェクト生成時

プロジェクト生成時にDBMSを指定する。

Rails2.0.2以降ではデフォルトデータベースがMySQLからSQLiteに変更
MySQLを使う場合、プロジェクト生成時に以下の様に指定

rails generate project_name -d mysql rails generrate project_name --database=mysql

データベースの生成・操作

database.ymlの編集

config/database.ymlファイルの内容を設定・変更

default: &default
  #adapter: sqlite3
  adapter: mysql2 # MySQLを使う設定になっているか確認
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  timeout: 5000
  encoding: utf8
  username: root  # MySQLのユーザー名を確認
  password: ****  # MySQLのパスワードを確認

development:
  <<: *default
  #database: db/development.sqlite3
  database: ****  # 利用するDB名を設定

test:
  <<: *default
  #database: db/test.sqlite3
  database: ****  # 利用するDB名を設定またはコメントアウト

production:
  <<: *default
  #database: db/production.sqlite3 # 利用するDB名を設定またはコメントアウト

default: &default

#adapter: sqlite3

adapter: mysql2 # MySQLを使う設定になっているか確認

pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>

timeout: 5000

encoding: utf8

username: root # MySQLのユーザー名を確認

password: **** # MySQLのパスワードを確認

development:

<<: *default

#database: db/development.sqlite3

database: **** # 利用するDB名を設定

test:

<<: *default

#database: db/test.sqlite3

database: **** # 利用するDB名を設定またはコメントアウト

production:

<<: *default

#database: db/production.sqlite3 # 利用するDB名を設定またはコメントアウト

データベースの生成

以下のコマンドでdatabase.ymlの設定に従ってデータベースを生成。

rails db:create

データベースの確認

以下のいずれかの方法で、アプリケーションのデータベースを確認できる。

mysql -u user -pを実行してMySQLのコンソールに入る
プロジェクトディレクトリー内でrails dbconsoleを実行して、アプリケーションが使うデータベースをuseした状態でMySQLのコンソールに入る

データベースの削除

以下のコマンドでアプリケーションで使っているデータベースが削除される。有無を言わさずすべてのテーブルごと消えてしまうので注意。

rails db:drop

実行例

database.yml

データベース名を設定する。以下はdemo_appアプリケーションでdemo_app_dbを使う設定。

[vagrant@localhost demo_app]$ cat config/database.yml
.....
default: &default
  adapter: mysql2
  encoding: utf8mb4
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  username: root
  password: vagrant
  socket: /var/lib/mysql/mysql.sock

development:
  <<: *default
  database: demo_app_db
.....

[vagrant@localhost demo_app]$ cat config/database.yml

.....

default: &default

adapter: mysql2

encoding: utf8mb4

pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>

username: root

password: vagrant

socket: /var/lib/mysql/mysql.sock

development:

<<: *default

database: demo_app_db

.....

データベースの生成

rails db:createコマンドでdatabase.ymlの設定を使ってデータベースを作成する。

[vagrant@localhost demo_app]$ rails db:create
Created database 'demo_app_db'

1 2	[vagrant@localhost demo_app]$ rails db:create Created database 'demo_app_db'

rails dbconsoleコマンドでデータベースが作成されたことを確認。

mysql> show databases;
+--------------------+
| Database           |
+--------------------+
| demo_app_db        |
| information_schema |
| mysql              |
| performance_schema |
| sys                |
| testdb             |
+--------------------+
6 rows in set (0.00 sec)

mysql> show databases;

+--------------------+

| Database |

+--------------------+

| demo_app_db |

| information_schema |

| mysql |

| performance_schema |

| sys |

| testdb |

+--------------------+

6 rows in set (0.00 sec)

Rails – ヘルパーメソッド

2021-03-06 / tau / コメントする

主なヘルパーメソッド

link_to

<a>要素を生成する。

基本形

<%= link_to "表示テキスト", URL %>

<a href=URL>表示テキスト</a>を生成
URLは文字列形式のほか、routes.rbでas:指定をしたパス(***_path)を指定可能

属性の追加

<%= link_to text, URL, :attr_name => 'attr_value' %>

たとえばid属性の場合、:id => 'ID'など
複数の属性をカンマで区切って列挙できる

フォーム関係

フォームヘルパー(旧)

Vagrant – コマンド

2021-03-04 / tau / コメントする

Vagrant全般

ヘルプ・コマンド一覧

コマンド全体

vagrant -h
vagrant --help

サブコマンド

vagrant help command

Vagrantのバージョン確認

vagrant -v
vagrant --version

Box関係

Boxの一覧

vagrant box list

Boxの追加・削除

vagrant box add **/**
vagrant box add virtual_name box_name.box
vagrant box remove **/**
vagrant box remove box_name --box-version ****.**
Box削除の前にvagrant destroyで仮想マシンを削除する

Boxの更新

対象の仮想環境のディレクトリー内で実行。

vagrant box update

バックアップ／リストア

vagrant package box_name
→現在の仮想環境をバックアップ
→カレントディレクトリーにpackage.box作成
vagrant package box_name --output buckup_name.box

リストアはaddの後init。

vagrant add box_name backup_name.box
→仮想環境ディレクトリーに移動
→vagrant init box_name

仮想マシン操作

仮想マシン操作は仮想マシンのディレクトリー内で。

仮想環境の一覧・動作状況

vagrant global-status

仮想マシンの初期化～vagrantfile作成

vagrant init box_name

仮想マシンの起動・停止・確認

仮想マシンに関する操作は仮想マシンのディレクトリー内で。

vagrant up
vagrant halt
vagrant restart
vagrant status

仮想マシンへの接続／接続情報確認

vagrant ssh
vagrant ssh-config

仮想マシンの削除

vagrant destroy id
- idはvagrant global-statusで確認
- Boxを削除する前に仮想マシンを削除する

Snapshot～スナップショット

対象の仮想マシンのvagrantfileがあるディレクトリーで実行
vagrant haltで停止しなくても、snapshot実行時に一時仮想マシンを停止して再起動してくれる

スナップショットの保存

vagrant snapshot save snapshot_name

スナップショットの一覧

vagrant snapshot list

スナップショットの復元

vagrant snapshot restore snapshot_name

スナップショットの削除

vagrant snapshot delete snapshot_name

Rails – DB操作～基礎的な読み書き

2021-03-03 / tau / コメントする

概要

Railsでデータベースを操作する場合、フォームの入力～モデル～データベースを自動で関連付ける方法が一般的
ここでは、モデルオブジェクトを直接操作してデータベースとの間での書き込み・読み込み処理を整理する

手順

書き込み

手順は以下の通り。

カラム＝プロパティーを指定してモデルインスタンスを生成
- @model_name = ModelName.new(col1: val1, ...)
インスタンスメソッドsaveでデータベースに書き込み
- @model_name.save
結果として返されるtrue/falseに応じて必要な処理を行う

    @tweet = Tweet.new(name: params[:name], content: params[:tweet])
    if @tweet.save
      redirect_to('/')
    else
      render 'new' and return
    end

@tweet = Tweet.new(name: params[:name], content: params[:tweet])

if @tweet.save

redirect_to('/')

else

render 'new' and return

end

読み込み

全データを読み出す場合、モデルクラスのクラスメソッドallを使う。

@model_names = ModelName.all

この変数をviewなどで利用するときは、各フィールドをプロパティーとして参照する。

@model_names.col1

Rails – モデル生成とマイグレーション

2021-03-03 / tau / コメントする

概要

Railsでは、データベースのテーブルをモデルを通して扱う。そのための開発時点での操作は以下のとおり。

モデルの生成・操作
マイグレーションによるテーブルの生成・操作

モデルの生成・削除

モデルの生成

テーブルに対して1つのモデルを生成する。

基本形は以下のコマンド。

rails generate model model_name

生成時にテーブルのフィールド名とフィールドの型を指定する場合(フィールド指定の間はスペース)。

rails generate model model_name col1:type col2:type ...

フィールドの型

primary_key
binary, boolean
date, datetime, time, timestamp
decimal, float, integer
string, text

生成されるファイル

実行後、モデルクラスとマイグレーションの2つのクラスファイルが生成される。

モデルクラスファイル

app_name/app/models/model_name

ファイルの内容はクラス定義
クラス名はモデル名のパスカルケース(ModelName)
ApplicationRecordを継承

class ModelName < ApplicationRecord
end

1 2	class ModelName < ApplicationRecord end

マイグレーションファイル

app_name/db/migrate/yyyymmddhhmmss_create_model_name.rb

テーブルを扱うマイグレーションクラスが定義される
マイグレーションクラスはActiveRecordモジュールのMigrationクラスを継承している
マイグレーションクラスのクラス名はCreateModelNames
- パスカルケース
- 最後にsがついた複数形
マイグレーションクラスのcreate_tableはDSL(ドメイン固有言語、Railsdoc)
- テーブル名はスネークケースでモデル名の複数形
- 生成時にフィールド名と型を指定した場合、create_tableブロック内でフィールドが定義される

class CreateModelNames < ActiveRecord::Migration[5.1]
  def change
    create_table :model_names do |t|
      t.string :col1
      t.string :col2
      .....

      t.timestamps
    end
  end
end

class CreateModelNames < ActiveRecord::Migration[5.1]

def change

create_table :model_names do |t|

t.string :col1

t.string :col2

.....

t.timestamps

end

モデルの削除

モデルの削除は以下のコマンドで、モデルクラスファイルとマイグレーションファイルが削除される。

rails destroy model model_name

ただしデータベース上のテーブルは削除されない。

テーブルの生成・削除

テーブルの生成

以下のコマンドで、マイグレーションファイルの設定に従ってデータベースにテーブルが生成される。

rails db:migrate

モデル生成時にフィールドを指定しなかった場合やモデル生成後にフィールドを追加する場合は、マイグレーションファイルにフィールドを追加する。

class CreateDemoRecords < ActiveRecord::Migration[6.1]
  def change
    create_table :demo_records do |t|
      t.型 :フィールド名
  
      t.timestamps
    end
  end
end

class CreateDemoRecords < ActiveRecord::Migration[6.1]

def change

create_table :demo_records do |t|

t.型 :フィールド名

t.timestamps

end

一度migrateした後にマイグレーションファイルを修正して再度migrateしても反映されない。一旦rails db:rollbackでテーブル生成前の状態に戻してからマイグレーションファイルを修正して再度実行。

テーブルの削除

ロールバック

rails db:rollbackで直前に生成したテーブルを削除

MySQLでの削除

MySQLのコンソールでDROP TABLEを実行

マイグレーション

model_nameモデルのmodel_namesテーブルを例にとる。

model_nameモデルを削除
- rails destroy model model_name
以下のコマンドでダミーのマイグレーションファイルを生成
- rails generate migration 任意の名前
マイグレーションファイルのdef changeブロックに以下を追加
- drop_table: model_names
rails db:migrationを実行
db/migrate/マイグレーションファイルを削除

実行例

モデルの生成

demo_recordという名前でモデルを生成する。このモデルはname:stringとage:integerの2つのフィールドを持つモデルを生成する。

[vagrant@localhost demo_app]$ rails g model demo_record name:string
Running via Spring preloader in process 24003
      invoke  active_record
      create    db/migrate/20210303061311_create_demo_records.rb
      create    app/models/demo_record.rb
      invoke    test_unit
      create      test/models/demo_record_test.rb
      create      test/fixtures/demo_records.yml

[vagrant@localhost demo_app]$ rails g model demo_record name:string

Running via Spring preloader in process 24003

invoke active_record

create db/migrate/20210303061311_create_demo_records.rb

create app/models/demo_record.rb

invoke test_unit

create test/models/demo_record_test.rb

create test/fixtures/demo_records.yml

モデルファイル

モデルファイルがapp/modelsの下に作成される。モデルファイル名はモデル生成時のモデル名のスネークケースになっている。

[vagrant@localhost demo_app]$ ls app/models/
application_record.rb  concerns  demo_record.rb

1 2	[vagrant@localhost demo_app]$ ls app/models/ application_record.rb concerns demo_record.rb

モデルファイルの内容はモデルクラスの定義で、生成当初は空の定義。モデルクラス名がモデル名のパスカルケースになっている。

class DemoRecord < ApplicationRecord
end

1 2	class DemoRecord < ApplicationRecord end

マイグレーションファイル

マイグレーションファイルがdb/migrateの下に作成される。

[vagrant@localhost demo_app]$ ls db/migrate/
20210303071205_create_demo_records.rb

1 2	[vagrant@localhost demo_app]$ ls db/migrate/ 20210303071205_create_demo_records.rb

マイグレーションファイルの内容はテーブル生成クラスの定義で、create_tableブロックの中でフィールドの名前と型を指定している。

モデル名demo_recordに対して生成されるテーブルクラス名はCreateDemoRecordsで、接頭辞Createにモデル名に複数形のsがついたパスカルケース
create_tableブロックでフィールドの型とフィールド名を定義

class CreateDemoRecords < ActiveRecord::Migration[6.1]
  def change
    create_table :demo_records do |t|
      t.string :name

      t.timestamps
    end
  end
end

class CreateDemoRecords < ActiveRecord::Migration[6.1]

def change

create_table :demo_records do |t|

t.string :name

t.timestamps

end

テーブルの生成～マイグレーション

rails db:migrateコマンドにより、マイグレーションファイルの設定に基づいてテーブルを生成する。

[vagrant@localhost demo_app]$ rails db:migrate
== 20210303063040 CreateDemoRecords: migrating ================================
-- create_table(:demo_records)
   -> 0.0329s
== 20210303063040 CreateDemoRecords: migrated (0.0331s) =======================

[vagrant@localhost demo_app]$ rails db:migrate

== 20210303063040 CreateDemoRecords: migrating ================================

-- create_table(:demo_records)

-> 0.0329s

== 20210303063040 CreateDemoRecords: migrated (0.0331s) =======================

rails dbconsoleでテーブルが生成されていることを確認する。

mysql> show tables;
+-----------------------+
| Tables_in_demo_app_db |
+-----------------------+
| ar_internal_metadata  |
| demo_records          |
| schema_migrations     |
+-----------------------+
3 rows in set (0.00 sec)

mysql> show tables;

+-----------------------+

| Tables_in_demo_app_db |

+-----------------------+

| ar_internal_metadata |

| demo_records |

| schema_migrations |

+-----------------------+

3 rows in set (0.00 sec)

生成されたテーブルの構成を確認。

mysql> desc demo_records;
+------------+--------------+------+-----+---------+----------------+
| Field      | Type         | Null | Key | Default | Extra          |
+------------+--------------+------+-----+---------+----------------+
| id         | bigint       | NO   | PRI | NULL    | auto_increment |
| name       | varchar(255) | YES  |     | NULL    |                |
| created_at | datetime(6)  | NO   |     | NULL    |                |
| updated_at | datetime(6)  | NO   |     | NULL    |                |
+------------+--------------+------+-----+---------+----------------+
4 rows in set (0.01 sec)

mysql> desc demo_records;

+------------+--------------+------+-----+---------+----------------+

+------------+--------------+------+-----+---------+----------------+

| id | bigint | NO | PRI | NULL | auto_increment |

+------------+--------------+------+-----+---------+----------------+

4 rows in set (0.01 sec)

マイグレーションの状態確認

db:migration:statusでマイグレーションの状況を確認できる。部分的にロールバックした時などの確認に便利。

[vagrant@vagrant ex_bbs]$ rails db:migrate:status

database: ex_bbs_development

 Status   Migration ID    Migration Name
--------------------------------------------------
   up     20210320060906  Create users
   up     20210326083051  Add columuns to users
  down    20210331121751  Create posts
  down    20210331122545  Create post images

[vagrant@vagrant ex_bbs]$ rails db:migrate:status

database: ex_bbs_development

Status Migration ID Migration Name

--------------------------------------------------

up 20210320060906 Create users

up 20210326083051 Add columuns to users

down 20210331121751 Create posts

down 20210331122545 Create post images

ロールバック

すべてロールバック

rails db:rollbackにより、いったんテーブル作成前の状態に戻す。

[vagrant@localhost demo_app]$ rails db:rollback
== 20210303071205 CreateDemoRecords: reverting ================================
-- drop_table(:demo_records)
   -> 0.0209s
== 20210303071205 CreateDemoRecords: reverted (0.0270s) =======================

[vagrant@localhost demo_app]$ rails db:rollback

== 20210303071205 CreateDemoRecords: reverting ================================

-- drop_table(:demo_records)

-> 0.0209s

== 20210303071205 CreateDemoRecords: reverted (0.0270s) =======================

MySQLで確認すると、テーブルはなくなっている。

mysql> show tables;
+-----------------------+
| Tables_in_demo_app_db |
+-----------------------+
| ar_internal_metadata  |
| schema_migrations     |
+-----------------------+
2 rows in set (0.00 sec)

mysql> show tables;

+-----------------------+

| Tables_in_demo_app_db |

+-----------------------+

| ar_internal_metadata |

| schema_migrations |

+-----------------------+

2 rows in set (0.00 sec)

ロールバックステップ指定

rails db:migrate STEP=nでロールバックするステップ数を指定可能。STEPは大文字でないと機能しない。

[vagrant@vagrant ex_bbs]$ rails db:migrate:status

database: ex_bbs_development

 Status   Migration ID    Migration Name
--------------------------------------------------
   up     20210320060906  Create users
   up     20210326083051  Add columuns to users
   up     20210331121751  Create posts
   up     20210331122545  Create post images

[vagrant@vagrant ex_bbs]$ rails db:rollback STEP=2
== 20210331122545 CreatePostImages: reverting =================================
-- drop_table(:post_images)
   -> 0.0027s
== 20210331122545 CreatePostImages: reverted (0.0059s) ========================

== 20210331121751 CreatePosts: reverting ======================================
-- drop_table(:posts)
   -> 0.0019s
== 20210331121751 CreatePosts: reverted (0.0022s) =============================

[vagrant@vagrant ex_bbs]$ rails db:migrate:status

database: ex_bbs_development

 Status   Migration ID    Migration Name
--------------------------------------------------
   up     20210320060906  Create users
   up     20210326083051  Add columuns to users
  down    20210331121751  Create posts
  down    20210331122545  Create post images

[vagrant@vagrant ex_bbs]$ rails db:migrate:status

database: ex_bbs_development

Status Migration ID Migration Name

--------------------------------------------------

up 20210320060906 Create users

up 20210326083051 Add columuns to users

up 20210331121751 Create posts

up 20210331122545 Create post images

[vagrant@vagrant ex_bbs]$ rails db:rollback STEP=2

== 20210331122545 CreatePostImages: reverting =================================

-- drop_table(:post_images)

-> 0.0027s

== 20210331122545 CreatePostImages: reverted (0.0059s) ========================

== 20210331121751 CreatePosts: reverting ======================================

-- drop_table(:posts)

-> 0.0019s

== 20210331121751 CreatePosts: reverted (0.0022s) =============================

[vagrant@vagrant ex_bbs]$ rails db:migrate:status

database: ex_bbs_development

Status Migration ID Migration Name

--------------------------------------------------

up 20210320060906 Create users

up 20210326083051 Add columuns to users

down 20210331121751 Create posts

down 20210331122545 Create post images

マイグレーションファイルへの追記

マイグレーションファイルに新たなフィールドを1行追加する。

class CreateDemoRecords < ActiveRecord::Migration[6.1]
  def change
    create_table :demo_records do |t|
      t.string :name
      t.integer :age

      t.timestamps
    end
  end
end

class CreateDemoRecords < ActiveRecord::Migration[6.1]

def change

create_table :demo_records do |t|

t.string :name

t.integer :age

t.timestamps

end

再度マイグレート。

[vagrant@localhost demo_app]$ rails db:migrate
== 20210303071205 CreateDemoRecords: migrating ================================
-- create_table(:demo_records)
   -> 0.0346s
== 20210303071205 CreateDemoRecords: migrated (0.0348s) =======================

[vagrant@localhost demo_app]$ rails db:migrate

== 20210303071205 CreateDemoRecords: migrating ================================

-- create_table(:demo_records)

-> 0.0346s

== 20210303071205 CreateDemoRecords: migrated (0.0348s) =======================

MySQLで確認すると、テーブルが作成されている。

mysql> show tables;
+-----------------------+
| Tables_in_demo_app_db |
+-----------------------+
| ar_internal_metadata  |
| demo_records          |
| schema_migrations     |
+-----------------------+
3 rows in set (0.00 sec)

mysql> show tables;

+-----------------------+

| Tables_in_demo_app_db |

+-----------------------+

| ar_internal_metadata |

| demo_records |

| schema_migrations |

+-----------------------+

3 rows in set (0.00 sec)

新たなフィールドが追加されているのが確認できる。

mysql> desc demo_records;
+------------+--------------+------+-----+---------+----------------+
| Field      | Type         | Null | Key | Default | Extra          |
+------------+--------------+------+-----+---------+----------------+
| id         | bigint       | NO   | PRI | NULL    | auto_increment |
| name       | varchar(255) | YES  |     | NULL    |                |
| age        | int          | YES  |     | NULL    |                |
| created_at | datetime(6)  | NO   |     | NULL    |                |
| updated_at | datetime(6)  | NO   |     | NULL    |                |
+------------+--------------+------+-----+---------+----------------+
5 rows in set (0.00 sec)

mysql> desc demo_records;

+------------+--------------+------+-----+---------+----------------+

+------------+--------------+------+-----+---------+----------------+

| id | bigint | NO | PRI | NULL | auto_increment |

| age | int | YES | | NULL | |

+------------+--------------+------+-----+---------+----------------+

5 rows in set (0.00 sec)

Rails – 基礎的なフォーム

2021-03-02 / tau / コメントする

概要

フォームとのパラメーターのやりとりのみを確認する。

既存のビューにフォーム関係のタグを書き、新たなアクションに送信する
既存のコントローラーにそのアクションを追加し、フォームからのデータをパラメータとして受け取る
受け取ったパラメーターをフォームを書いた既存のビューに渡してレンダリング
フォーム関連のタグをヘルパーに置き換える

元になる枠組み

プロジェクト：demo_app
コントローラー：demo_contents
アクション：top_page
ビュー：top_page.html.erb

STEP-1～form_tag

ビューファイルへのフォームの記述

top_page.html.erbに以下の内容を記述。

<h1>メモパッド</h1>
<%= form_tag("/demo_contents/post_memo") do %>
  <input type="text" name="memo" placeholder="メモを入力" value="">
  <input type="submit" value="書き込み">
<% end %>

<h1>メモパッド</h1>

<%= form_tag("/demo_contents/post_memo") do %>

<% end %>

上記のform_tagは、submitされた内容を指定したアクションにpostするformタグを生成する。

ただし直接formタグを書くと”invalid authenticity token”エラーになる。

コントローラーにアクション追加

フォームからPOSTで送られる内容を受けるアクションを、コントローラにメソッドとして追加する。

class DemoContentsController < ApplicationController
  def top_page
  end

  def post_memo
  end
end

class DemoContentsController < ApplicationController

def top_page

end

def post_memo

end

ルーティングの追加

config/routes.rbファイルに、POSTに対するアクションメソッドへのルーティングを追加する。

Rails.application.routes.draw do
  root to: 'demo_contents#top_page'
  post 'demo_contents/post_memo', to: 'demo_contents#post_memo'
end

Rails.application.routes.draw do

root to: 'demo_contents#top_page'

post 'demo_contents/post_memo', to: 'demo_contents#post_memo'

end

アクションの確認

ルートページにフォームが表示され、テキストボックスにメモを入力して送信ボタンを押すと、Railsサーバーにデータが送られている様子が表示される。

Started POST "/demo_contents/post_memo" for 10.0.2.2 at 2021-03-01 22:28:24 +0900
Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.0/127.255.255.255, ::1
Processing by DemoContentsController#post_memo as HTML
  Parameters: {"authenticity_token"=>"[FILTERED]", "memo"=>"メモ"}
No template found for DemoContentsController#post_memo, rendering head :no_content
Completed 204 No Content in 5ms (Allocations: 1537)

Started POST "/demo_contents/post_memo" for 10.0.2.2 at 2021-03-01 22:28:24 +0900

Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.0/127.255.255.255, ::1

Processing by DemoContentsController#post_memo as HTML

Parameters: {"authenticity_token"=>"[FILTERED]", "memo"=>"メモ"}

No template found for DemoContentsController#post_memo, rendering head :no_content

Completed 204 No Content in 5ms (Allocations: 1537)

STEP-2～params

params変数の確認

フォームからsubmitされたときのフォーム要素の値は、params変数に格納される
params変数はハッシュで、フォーム要素のname属性で指定した内容がキーになる

確認のため、demo_contentsコントローラーのpost_memoアクションに1行追加する。

class DemoContentsController < ApplicationController
  def top_page
  end

  def post_memo
    puts params[:memo]
  end
end

class DemoContentsController < ApplicationController

def top_page

end

def post_memo

puts params[:memo]

end

ここでテキストボックスにメモを入力して送信すると、Railsサーバーにその内容が表示される。

Started POST "/demo_contents/post_memo" for 10.0.2.2 at 2021-03-01 22:46:37 +0900
Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.0/127.255.255.255, ::1
Processing by DemoContentsController#post_memo as HTML
  Parameters: {"authenticity_token"=>"[FILTERED]", "memo"=>"メモ"}
メモ
No template found for DemoContentsController#post_memo, rendering head :no_content
Completed 204 No Content in 1ms (Allocations: 329)

Started POST "/demo_contents/post_memo" for 10.0.2.2 at 2021-03-01 22:46:37 +0900

Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.0/127.255.255.255, ::1

Processing by DemoContentsController#post_memo as HTML

Parameters: {"authenticity_token"=>"[FILTERED]", "memo"=>"メモ"}

メモ

No template found for DemoContentsController#post_memo, rendering head :no_content

Completed 204 No Content in 1ms (Allocations: 329)

params変数のHTMLへの反映

上記のpost_memoアクションの内容を以下の様に変更する。

viewから参照可能な@memoにフォームから受け取ったparams[:memo]の内容をセット
トップページへのレンダリングとreturn

@変数はクラスのインスタンス変数で、これをアクションとビューで共有できる。

class DemoContentsController < ApplicationController
  def top_page
    @memo = ""
  end

  def post_memo
    @memo = params[:memo]
    render "demo_contents/top_page" and return
  end
end

class DemoContentsController < ApplicationController

def top_page

@memo = ""

end

def post_memo

@memo = params[:memo]

render "demo_contents/top_page" and return

end

またビューファイルtop_page.html.erbに以下の様に追記する。コントローラーでセットされた@memoの内容をHTMLで表示させている。

<h1>メモパッド</h1>
<%= form_tag("/demo_contents/post_memo") do %>
  <input type="text" name="memo" placeholder="メモを入力" value="">
  <input type="submit" value="書き込み">
<% end %>

<h2>メモの内容</h2>
<p><%= @memo %></p>

<h1>メモパッド</h1>

<%= form_tag("/demo_contents/post_memo") do %>

<% end %>

<h2>メモの内容</h2>

この結果、送信ボタンを押すと入力したメモの内容がtop_pageに表示されるようになる。

STEP-3～フォームヘルパー

フォーム内の要素を、以下の様にフォームヘルパー関数に書き換える。

さらにformヘルパーはhiddenタイプのinputタグを追加するが、これはCSRF対策のため。

<h1>メモパッド</h1>
<%= form_tag("/demo_contents/post_memo") do %>
  <%= label_tag(:memo, "メモ:") %>
  <%= text_field_tag(:memo, nil, placeholder: "メモの内容") %>
  <%= submit_tag("書き込み") %>
<% end %>

<h2>メモの内容</h2>
<p><%= @memo %></p>

<h1>メモパッド</h1>

<%= form_tag("/demo_contents/post_memo") do %>

<%= label_tag(:memo, "メモ:") %>

<%= text_field_tag(:memo, nil, placeholder: "メモの内容") %>

<%= submit_tag("書き込み") %>

<% end %>

<h2>メモの内容</h2>

上記のlabel_tag、text_field_tag、submit_tagはそれぞれ対応するタグに変換される～フォームヘルパー(旧)。

<%= label_tag(:memo, "メモ:") %>
↓
<label for="memo">メモ:</label>

<%= text_field_tag(:memo, nil, placeholder: "メモの内容") %>
↓
<input id="memo" name="memo" type="text" placeholder="メモの内容">

<%= submit_tag("書き込み") %>
↓
<input name="commit" type="submit" value="書き込み" />

<%= label_tag(:memo, "メモ:") %>

↓

<%= text_field_tag(:memo, nil, placeholder: "メモの内容") %>

↓

<%= submit_tag("書き込み") %>

↓

form_tagヘルパーのまとめ

フォーム全体

form_tag…endヘルパーでフォーム全体を囲む
form_tagではポスト先のURLを指定する
ポスト先のURLはroutes.rbでポスト先アクションにルーティングしておく

<%= form_tag("URL") do %>
.....
<% end %>

<%= form_tag("URL") do %>

.....

<% end %>

フォーム内のヘルパー

label、inputタグに置き換えられるヘルパーの多くは、第1引数にname属性に対応する引数をとる
この名前引数には、一般にシンボルがあてられる

label_tag(:user_name, "入力してください")
text_field_tag(:user_name)
↓
<label for="user_name">入力してください</label>
<input type="text" id="user_name" name="name>

label_tag(:user_name, "入力してください")

text_field_tag(:user_name)

↓

<label for="user_name">入力してください</label>

受信側での扱い

受信側ではparamsというハッシュにフォームからの受信結果が入れられる
受信のためにルーティングされたアクション内で、このparamsを参照する
paramsのキーに、フォームでname属性に指定したシンボルを使って値を読み出す

class DemoContentsController < ApplicationController
  .....

  def post_process
    puts params[:user_name]
  end
end

class DemoContentsController < ApplicationController

.....

def post_process

puts params[:user_name]

end

Rails – フォームヘルパー(旧)

2021-03-02 / tau / コメントする

共通事項

名前の指定

タグのid/nameやラベルのforに指定する識別子の指定方法に、文字列とシンボルの2種類がある。

text_field_tag(:name) text_field_tag("name")

いずれも生成されるタグはid/nameに文字列が設定される。

<input type="text" id="name" name="name">

基本系

form_tag

form_tagはfomタグを生成する(Railsdoc)。

form_tag(action [option/HTML_attr/event]) do
end

アクションを指定

<%= form_tag('/users') do %>
<% end %>
↓
<form action="users" method="post">
</form>

<%= form_tag('/users') do %>

<% end %>

↓

</form>

メソッドを指定

<%= form_tag('/users', method: :put) do %>
<% end %>
↓
<form action="users" method="put">
</form>

<%= form_tag('/users', method: :put) do %>

<% end %>

↓

</form>

multipart指定

<%= form_tag('/users', multipart: true) do %>
<% end %>
↓
<form action="users" method="post" enctype="multipart/form-data">
</form>

<%= form_tag('/users', multipart: true) do %>

<% end %>

↓

</form>

submit_tag

submit_tagはinputタグのtype="submit"を生成する(Railsdoc)。

submit_tag([button_name , option/HTML_attr/event])

ボタン名を指定：第1引数はボタン名

<%= submit_tag("送信") %>
<input type="submit" name="commit" value="送信" data-disable-with="送信">

1 2	<%= submit_tag("送信") %> <input type="submit" name="commit" value="送信" data-disable-with="送信">

無効化

submit_tag("送信", disabled: true)
<input disabled="disabled" name="commit" data-disable-with="送信" type="submit" value="送信">

1 2	submit_tag("送信", disabled: true) <input disabled="disabled" name="commit" data-disable-with="送信" type="submit" value="送信">

POST中の表示の指定

submit_tag "送信", data: { disable_with: "送信中..." }
<input name="commit" data-disable-with="送信中..." type="submit" value="送信">

1 2	submit_tag "送信", data: { disable_with: "送信中..." } <input name="commit" data-disable-with="送信中..." type="submit" value="送信">

label_tag

label_tagはフォーム要素と関連付けられたラベルタグを生成する(Railsdoc)。

label_tag(id&name [, contents [, HTML_attr or event])

識別子と内容を指定

label_tag(:name, "入力してください")
text_field_tag(:name)
↓
<label for="name">入力してください</label>
<input type="text" id="name" name="name>

label_tag(:name, "入力してください")

text_field_tag(:name)

↓

<label for="name">入力してください</label>

テキスト入力系

text_field_tag

text_field_tagはinputタグのtype="text"を生成する(Railsdoc)。

text_field_tag(id&name [, value, option/HTML_attr/event])

識別子のみ指定：第1引数がidとnameにセットされる

text_field_tag(:name)
<input id="name" name="name" type="text">

1 2	text_field_tag(:name) <input id="name" name="name" type="text">

値を指定：第2引数がvalueの値になる

text_field_tag(:name, "initial value")
<input id="name" name="name" type="text" value="initial value">

1 2	text_field_tag(:name, "initial value") <input id="name" name="name" type="text" value="initial value">

識別子とプレースホルダーを指定

text_field_tag(:name, nil, placeholder: "Input here')
<input id="name" name="name" type="text" placeholder="Input here">

1 2	text_field_tag(:name, nil, placeholder: "Input here') <input id="name" name="name" type="text" placeholder="Input here">

クラス指定

text_field_tag(:name, nil, class: "class_name")
<input id="name" name="name" type="text" class="class_name">

1 2	text_field_tag(:name, nil, class: "class_name") <input id="name" name="name" type="text" class="class_name">

Vagrant – Atomを使う

2021-03-01 / tau / コメントする

方法1～共有フォルダ－

共有フォルダにあるファイルをホスト側のAtomで開く。

ただし、Railsのファイルを編集している場合、いったんRailsサーバーを立ち上げなおさないと内容が反映されないという症状が出た。

方法2～AtomからFTP接続

remote-ftpのインストール

AtomにFTP接続用のパッケージをインストールして接続する。

手順

File → Settings→Installからremote-ftpを検索してインストール
AtomからホストのVirtualBoxの仮想マシンフォルダーを開く(C:\vagrant\centos7)
Packages→Remote FTP → Create SFTP config file
Atomで開いた.ftpconfigファイルの内容を編集

.ftpconfigファイルの編集

.ftpconfigファイルの編集に必要な情報は、コンソールからvagrant ssh-configコマンドで表示させる。

C:\vagrant\centos7>vagrant ssh-config
Host default
  HostName 127.0.0.1
  User vagrant
  Port 2222
  UserKnownHostsFile /dev/null
  StrictHostKeyChecking no
  PasswordAuthentication no
  IdentityFile C:/vagrant/centos7/.vagrant/machines/default/virtualbox/private_key
  IdentitiesOnly yes
  LogLevel FATAL

C:\vagrant\centos7>vagrant ssh-config

Host default

HostName 127.0.0.1

User vagrant

Port 2222

UserKnownHostsFile /dev/null

StrictHostKeyChecking no

PasswordAuthentication no

IdentityFile C:/vagrant/centos7/.vagrant/machines/default/virtualbox/private_key

IdentitiesOnly yes

LogLevel FATAL

この情報に基づいて.ftpconfigを編集。

{
    "protocol": "sftp",
    "host": "127.0.0.1",
    "port": 2222,
    "user": "vagrant",
    "pass": "",
    "promptForPass": false,
    "remote": "/home/vagrant",
    "local": "",
    "agent": "",
    "privatekey": "C:/vagrant/centos7/.vagrant/machines/default/virtualbox/private_key",
    "passphrase": "",
    "hosthash": "",
    "ignorehost": true,
    "connTimeout": 10000,
    "keepalive": 10000,
    "keyboardInteractive": false,
    "keyboardInteractiveForPass": false,
    "remoteCommand": "",
    "remoteShell": "",
    "watch": [],
    "watchTimeout": 500
}

{

"protocol": "sftp",

"host": "127.0.0.1",

"port": 2222,

"user": "vagrant",

"pass": "",

"promptForPass": false,

"remote": "/home/vagrant",

"local": "",

"agent": "",

"privatekey": "C:/vagrant/centos7/.vagrant/machines/default/virtualbox/private_key",

"passphrase": "",

"hosthash": "",

"ignorehost": true,

"connTimeout": 10000,

"keepalive": 10000,

"keyboardInteractive": false,

"keyboardInteractiveForPass": false,

"remoteCommand": "",

"remoteShell": "",

"watch": [],

"watchTimeout": 500

}

接続

Packages→RemoteFTP→Toggle
Remoteタブ表示
Connectボタンをクリック

トラブル

ERBファイル

Railsのerbファイルに色がつかない。config.csonを編集してみたが効果がなかった。

原因はtree-sitter parserのバグが考えられ、以下で対処。

Settings→Coreの”Use Tree Sitter Parsers”のチェックを外す
再起動→チェックが外れているという警告は無視

Rails – ルーティング

2021-03-01 / tau / コメントする

ルーティングファイルの役割

RailsがユーザーのブラウザーからGETやPOSTなどのリクエストを受け取ると、まずルーティングファイルを参照する。

ルーティングファイルには、リクエストの種類、リクエストのターゲットURL、ターゲットURLに対応するコントローラーとアクションが記述されている。

その内容に従って必要なコントローラーが呼び出されて処理を行った後、ユーザー側へレンダリングされた内容が返される。

ファイルの位置とファイル名

ルーティングファイル(routes.rb)は、プロジェクト生成時にconfigディレクトリー下に生成される。

config/routes.rb

ファイルの内容

アクションを指定してコントローラーを生成すると、routes.rbにそのアクションへのルーティングを記述した1行が追加される。

たとえばコントローラーとしてdemo_contents、そのアクションとしてtop_pageを指定して生成すると以下のような内容でルーティングの記述が追加される。

Rails.application.routes.draw do
  get 'demo_contents/top_page'
  # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
end

Rails.application.routes.draw do

get 'demo_contents/top_page'

# For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html

end

一方、アクションを指定せずにコントローラーだけ指定して生成すると、route.rbへの追加は行われない。

Rails.application.routes.draw do
  # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
end

Rails.application.routes.draw do

# For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html

end

基本的なルーティングの書き方

URL指定

以下の3つの記述は全て等価で、ブラウザーからURLをlocalhost:3000/demo_contents/top_pageと指定してGETリクエストしたとき、demo_contentsコントローラーのtop_pageアクションが実行される。

  get 'demo_contents/top_page'
  get 'demo_contents/top_page' => 'demo_contents#top_page'
  get 'demo_contents/top_page', to: 'demo_contents#top_page'

get 'demo_contents/top_page'

get 'demo_contents/top_page' => 'demo_contents#top_page'

get 'demo_contents/top_page', to: 'demo_contents#top_page'

2つ目と3つ目の記述法では、URLに他の表現を設定することが可能。

以下の例ではlocalhost:3000/fooを指定した時に、demo_contentsコントローラーのtop_pageアクションが実行される。

  get 'foo', to: 'demo_contents#top_page'
  get 'foo', controller: 'demo_contents', action: 'top_page'

1 2	get 'foo', to: 'demo_contents#top_page' get 'foo', controller: 'demo_contents', action: 'top_page'

ルートページの指定

ルートページとして特定のコントローラー・アクションを設定するときは、以下の様に記述する。

  root 'demo_contents#top_page'
  root :to  => 'demo_contents#top_page'
  root to: 'demo_contents#top_page'

root 'demo_contents#top_page'

root :to => 'demo_contents#top_page'

root to: 'demo_contents#top_page'

項設定すると、localhost:3000のようにブラウザーからリクエストするとdemo_contentsのtop_pageアクションが実行される。

基礎的なルーティング

rails routesによるルーティングの確認、to:によるURLの置き換え、as:による名前付けなどの基礎的な事項は以下にまとめた。

基礎的なルーティング

RESTful

今後