Ruby on Railsでデータ操作をしてみよう

CRUD

リンクをコピーしました

ActiveRecordは、CRUDの機能を提供します。

CRUDとは、Create（作成）・Read（読み込み）・Update（更新）・Delete（削除）の頭文字を繋げた用語で、データ操作の基本となる４つの処理のことでしたね。

SQLでは、CRUDに対応するデータ操作言語のキーワードとしてINSERT・SELECT・UPDATE・DELETEが用意されており、これらを利用してデータ操作を学習しました。

Railsでは、ActiveRecordによってCRUDに対応する便利なメソッドがたくさん用意されており、これらのメソッドを利用してデータ操作することができます。

ActiveRecordが提供するメソッドやクラスを利用することで「オブジェクトを操作するようにデータ操作できる」と説明しましたね。データ操作のメソッドを学習する前に、イメージとして理解しておきましょう。

オブジェクトを操作するようにデータ操作できる

リンクをコピーしました

ActiveRecordの規約で少し触れましたが、ActiveRecordでは「モデルのクラス」と「データベースのテーブル」が１対１で紐付けられます。

例えば、以下のようにモデルのUserクラスの場合は、データベースのusersテーブルに紐付きます。

1
2
class User < ApplicationRecord
end

ActiveRecordでは「モデル」と「テーブル」だけではなく、「インスタンス」と「レコード」、「プロパティ」と「カラム」も１対１で紐付けられます。

モデルクラスのインスタンスは、テーブルのレコード１件に対応するオブジェクトになり、オブジェクトのプロパティは、テーブルのカラムに対応します。

Rubyのクラスとインスタンスの章で学習しましたが、インスタンスを生成するには、クラスに対して「newメソッド」を呼び出します。

1
クラス名.new

モデルクラスの場合でも、同じように「newメソッド」を呼び出してインスタンスを生成します。しかし、通常のクラスとは違って生成されたインスタンスは、「テーブルのレコード１件」に対応するオブジェクトになります。

1
2
モデルのクラス名.new 
#レコード１件に対応するオブジェクトになる

モデルクラスのインスタンス（オブジェクト）に対して、ActiveRecordが提供するメソッドを利用することで、テーブルにレコードを挿入したり、更新や削除などが行えます。まさにオブジェクトを操作するように、データ操作ができます。

例えば、Userモデルクラスのインスタンスに対して、ActiveRecordが提供するsaveメソッドを呼び出せば、テーブルにデータを挿入することができます。

1
2
3
4
5
# Userモデルのインスタンスをuserに代入する
user = User.new(name: "山田花子", age: 34)

# saveメソッドでインスタンスをデータベースに保存する
user.save

メソッドの箇所で詳しく説明しますが、モデルのクラスに対してnewメソッドを呼び出した時点では、「テーブルのレコード１件」に対応するオブジェクトが生成されただけです。実際にデータベースに保存するのは、saveメソッドが行います。

SQLではINSERT構文を使用して、テーブルに新しいレコードを挿入しましたが、RailsではActiveRecordのお陰で、オブジェクトを操作するようにデータ操作が可能になります。

1
INSERT INTO users(name, age) VALUES('山田花子', 34);

1
2
user = User.new(name: "山田花子", age: 34)
user.save

ちなみにモデルのインスタンスに対してsaveメソッドを呼び出すと、裏側では以下のようなSQL文が発行されます。実際にはINSERT構文を使用して、テーブルにレコードを挿入していることがわかりますね。

1
2
3
4
user = User.new(name: "山田花子", age: 34)

user.save
# INSERT INTO `users` (`name`, `age`, `created_at`, `updated_at`) VALUES ('山田花子', 34, '2023-03-24 07:47', '2023-03-24 07:47'

newメソッドを呼び出した時点で特に指定されてないcreated_atやupdated_atの値は、発行されるSQL文により、「レコード作成時に現在の日時を自動的に設定する」ということを確認できます。

補足説明

メソッドの引数にハッシュを指定する場合は、{}を省略することができます。newメソッドの引数は、実は{ キー: 値 }のハッシュを指定しています。キーがカラム名、値がカラムの値になります。

多くの場合、メソッドの引数のハッシュは{}を省略して記述します。

準備：コンソールを起動しよう

リンクをコピーしました

データ操作は、コンソール上で行います。Railsでは、consoleコマンドでコンソールを起動させて、Railsアプリケーションとコマンドラインでやり取りすることができます。

Webにアクセスすることなく、サーバーのデータを変更するときやメソッドを試すときに便利です。内部ではirbが使われているので、同じように操作を行えます。

1
2
rails console
# rails c でも可能

他にもオプションの-sandboxを付けることで、終了時にコンソールで変更したデータを元に戻すことができます。

1
2
rails console -sandbox
# rails c -s でも可能

上記のコマンドを実行すると、下の画像のようにin sandboxが表示されます。

コンソールを終了するには、exitかquitを実行します。

1
2
3
exit
#もしくは、以下を実行する
quit

以下のコマンドを実行して、コンソールを起動してください。

1
cd ~/environment/employee_management

1
rails c

上記のコマンドを実行すると、以下のように表示されます。

Create

リンクをコピーしました

Createは、「テーブルにレコードを挿入する」というデータ操作の基本処理を指します。

Railsの場合は、ActiveRecordが提供するsaveメソッド、createメソッドを利用することで、テーブルにレコードを挿入することができます。

createメソッド

リンクをコピーしました

createメソッドは、モデルのインスタンス生成と同時にデータベースに保存するクラスメソッドです。

Userモデルにnameとageというプロパティがある場合、Userモデルのクラスに対してcreateメソッドを呼び出すと、新しいレコードが１件作成され、データベースに保存されます。

1
モデルのクラス名.create(カラム名1: 値1, カラム名2: 値2)

1
User.create(name: "山田花子", age: 34)

以下をコンソールで実行し、nameカラムの値が"開発"のレコードをdepartmentsテーブルに挿入しましょう。

1
Department.create(name: "開発")

上記を実行すると、以下のように裏側でSQL文が発行されます。SQLの章で学習したようにINSERT構文で、テーブルに新しいレコードを挿入していることがわかりますね。

created_atやupdated_atには、現在の日時が自動的に設定されます。

phpMyAdminで確認すると、以下のようにdepartmentsテーブルにnameカラムの値が開発のレコードが１件挿入されています。また、idも自動的に値が入っていますね。

newメソッド/saveメソッド

リンクをコピーしました

saveメソッドは、モデルのインスタンスをデータベースに保存します。

createメソッドとは違い、saveメソッドはインスタンスを生成しません。そのため、インスタンス生成を行うnewメソッドとセットで利用します。

1
2
3
4
5
 # Userモデルのインスタンスを生成して、userに代入する
user = User.new(name: "山田花子", age: 34)

# saveメソッドでインスタンスをデータベースに保存する
user.save

モデルのクラスに対してnewメソッドを呼び出した時点では、「テーブルのレコード１件」に対応するオブジェクトが生成されただけです。実際にデータベースに保存するのは、saveメソッドが行います。

レコードに挿入する値は、最初のコードのようにnewメソッドの引数にハッシュで一度に指定することもできますし、あとのコードのように指定することもできます。

1
2
user = User.new(name: "山田花子", age: 34)
user.save

1
2
3
4
5
user = User.new

user.name = "山田花子"
user.age = 34
user.save

nameカラムの値が"営業"のレコードをdepartmentsテーブルに挿入してみます。

まずは、newメソッドを利用して、Departmentモデルのインスタンスを生成します。以下のコードをコンソールに記述し、実行しましょう。

1
department = Department.new(name: "営業")

上記を実行すると、以下のようにDepartmentモデルのインスタンスが生成されます。この時点では、newメソッドの引数で指定したname属性のみ値が設定されており、idやcreated_atとupdated_atの属性値は、いずれもnilで値が何も入っていない状態です。

続いて、生成したDepartmentモデルのインスタンスをsaveメソッドでデータベースに保存します。以下のコードをコンソールに記述し、実行しましょう。

1
department.save

上記を実行すると、以下のように裏側でSQL文が発行されます。INSERT構文で、テーブルに新しいレコードを挿入していることがわかりますね。

created_atやupdated_atには、現在の日時が自動的に設定されます。

phpMyAdminで確認すると、以下のようにdepartmentsテーブルにnameカラムの値が営業のレコードが１件挿入されています。また、idも自動的に値が入っていますね。

そして、Departmentモデルのインスタンスが入るdepartmentをコンソールで実行すると、以下のようにnewメソッドを呼び出した時点では、nilだった属性値に値が設定されていることがわかります。

idには2という値が設定され、created_atやupdated_atには、saveメソッドを実行した際の日時、つまりレコードを作成した現在の日時が設定されます。

複数レコードを同時に挿入する

リンクをコピーしました

複数レコードを同時に挿入する方法はいくつかありますが、ここでは配列とハッシュを利用して、createメソッドで一括挿入してみます。

createメソッドでは、１件のレコードをデータベースに挿入することができましたね。

1
モデルのクラス名.create(カラム名1: 値1, カラム名2: 値2)

複数のレコードをデータベースに挿入させるには、配列の要素にハッシュを指定します。

1
2
3
4
5
モデルのクラス名.create([
  { カラム名1: 値1 }, # 1件目のレコード
  { カラム名2: 値2 }, # 2件目のレコード
  { カラム名3: 値3 }  # 3件目のレコード
])

employeesテーブルに挿入するデータは、以下の通りです。

employeesテーブルに複数レコードを挿入するために、以下のコードをコンソールに記述し、実行しましょう。

1
2
3
4
5
6
7
8
Employee.create([
  { name: '田中太郎', birthday: '1980-10-22', department_id: 1 },
  { name: '山田花子', birthday: '1983-08-20', department_id: 1 },
  { name: '高橋一朗', birthday: '1986-06-16', department_id: 2 },
  { name: '伊藤晴子', birthday: '1987-10-01', department_id: 1 },
  { name: '鈴木二郎', birthday: '1990-01-17', department_id: 2 },
  { name: '山口冬子', birthday: '1993-05-12', department_id: 2 }
])

上記を実行すると、以下のように裏側でSQL文が発行されます。INSERT構文で、テーブルに新しいレコードを６件挿入していることがわかりますね。

phpMyAdminでemployeesテーブルを表示して、createメソッドで指定した6件のレコードがテーブルに挿入されていることを確認しましょう。

補足説明

createメソッドの引数には、変数を利用して指定することもできます。

Read

リンクをコピーしました

Readは、「テーブルのレコードを抽出する」というデータ操作の基本処理を指します。

Railsの場合は、ActiveRecordが提供するallメソッド、findメソッドなどを利用することで、テーブルのレコードを抽出することができます。

allメソッド

リンクをコピーしました

モデルのクラスに対してallメソッドを呼び出すと、モデルに対応するテーブルのレコードをすべて取得します。

1
モデルのクラス名.all

例えば、usersテーブルのレコードを全て取得する場合はUser.allと記述します。

1
User.all

employeesテーブルの全てのレコードを取得してみます。

以下のコードをコンソールに記述し、実行しましょう。

1
Employee.all

上記を実行すると、以下のように裏側でSQL文が発行されます。SQLの章で学習したようにSELECT構文で、テーブルのすべてのレコードを抽出していることがわかりますね。

戻り値には、employeesテーブルの全てのレコードが設定されています。

findメソッド

リンクをコピーしました

findメソッドは、引数の主キーに対応するレコードを取得するクラスメソッドです。

findメソッドの引数には１つの主キーだけではなく、配列で複数の主キーの値を指定して、レコードを取得することもできます。

1
モデルのクラス名.find(主キー値)

1
モデルのクラス名.find([主キー値1, 主キー値2])

テーブルの主キーは、idというカラム名がデフォルトで使われます。

例えば、以下のようにUser.find(1)と指定する場合、Userモデルに対応するusersテーブルの主キー、つまりidの値が1のレコードを取得します。

1
User.find(1)

以下のように指定すると、idの値が1と2のレコードを取得します。

1
User.find([1,2])

employeesテーブルのidの値が4のレコードを取得してみます。

以下のコードをコンソールに記述し、実行しましょう。

1
Employee.find(4)

上記を実行すると、以下のように裏側でSQL文が発行されます。SELECT構文で、employeesテーブルのidの値が4のレコードを抽出していることがわかりますね。

戻り値は、取得したデータの値がセットされているEmployeeモデルのインスタンスです。

find_byメソッド

リンクをコピーしました

find_byメソッドは、引数の条件に当てはまる最初の１件のレコードを取得するクラスメソッドです。

引数の条件は、ハッシュで指定します。

1
モデルのクラス名.find_by(条件)

1
User.find_by(name: '田中太郎')

employeesテーブルのnameの値が'鈴木二郎'のレコードを取得してみます。

以下のコードをコンソールに記述し、実行しましょう。

1
Employee.find_by(name: '鈴木二郎')

上記を実行すると、以下のように裏側でSQL文が発行されます。SELECT構文で、employeesテーブルのnameの値が'鈴木二郎'のレコードを抽出していることがわかりますね。

戻り値は、取得したデータの値がセットされているEmployeeモデルのインスタンスです。

whereメソッド

リンクをコピーしました

whereメソッドは、引数の条件に当てはまるレコードを全て取得するクラスメソッドです。

1
モデルのクラス名.where(条件)

find_byメソッドの場合は、引数の条件に当てはまる最初のレコードを1件だけ取得しますが、whereメソッドは、条件に当てはまる全てのレコードを取得します。

例えばUser.where(age: 20)とUser.find_by(age: 20)のように、引数に同じ条件を指定しても、取得するレコード数は違います。

1
User.where(age: 20)

1
User.find_by(age: 20)

以下のようにUser.where(age: 20)は、ageが20のレコードを全て取得します。

employeesテーブルのdepartment_idの値が2のレコードをすべて取得してみます。

以下のコードをコンソールに記述し、実行しましょう。

1
Employee.where(department_id: 2)

上記を実行すると、以下のように裏側でSQL文が発行されます。SELECT構文で、employeesテーブルのdepartment_idの値が2のレコードを抽出していることがわかりますね。

戻り値には、条件に当てはまるemployeesテーブルの全てのレコードが設定されています。

Update

リンクをコピーしました

Updateは、「テーブルのレコードを更新する」というデータ操作の基本処理を指します。

Railsの場合は、ActiveRecordが提供するupdateメソッドなどを利用することで、テーブルのレコードを更新することができます。

saveメソッド

リンクをコピーしました

更新対象のオブジェクトを取得すると、オブジェクトのプロパティを変更し、その結果をデータベースに保存できるようになります。

例えば、以下のようにfind_byメソッドで更新対象のオブジェクトを取得し、nameプロパティ値を'田中太郎'から'田中航太郎'に変更します。変更後、saveメソッドを呼び出して、データベースに保存します。

1
2
3
user = User.find_by(name: '田中太郎') #更新対象のオブジェクトを取得
user.name = '田中航太郎' #プロパティを変更
user.save #データベースに保存する

updateメソッド

リンクをコピーしました

updateメソッドを利用する場合も、あらかじめfindメソッドやfind_byメソッドなどで、オブジェクトを取得してから更新処理を行います。

updateメソッドの引数にプロパティ名と設定したい値をハッシュで対応付けます。

1
更新対象のオブジェクト.update(プロパティ名: 値)

先ほどのsaveメソッドと同様に'田中太郎'を'田中航太郎'に更新する場合は、更新対象のオブジェクトを取得後、以下のようにupdateメソッドの引数を指定します。

updateメソッドを呼び出すと、更新対象のオブジェクトのプロパティを引数の値に更新し、その結果をデータベースに保存します。

1
2
user = User.find_by(name: '田中太郎')
user.update(name: '田中航太郎')

employeesテーブルにある山口冬子さんの生年月日、birthdayの値を1993-05-12から1993-12-12に更新してみます。

以下のコードをコンソールに記述し、実行しましょう。

1
2
employee = Employee.find_by(name: '山口冬子')
employee.update(birthday: '1993-12-12')

上記を実行すると、以下のように裏側でSQL文が発行されます。SQLの章で学習したように、既存のレコードのカラムを新しい値に更新するには、UPDATE構文が使用されます。

SET句には変更するカラム名と新しい値、WHERE句にはどのレコードを更新するかを識別する条件が指定されており、idが6のレコードのbirthdayを'1993-12-12'に更新していることがわかりますね。

また、レコードの更新時に現在の日時を設定するupdated_atの値も自動的に更新されます。データが更新されると、戻り値としてtrueを返します。

オブジェクトのプロパティ値が更新されていることを確認してみましょう。更新対象のオブジェクトを保持するemployeeをコンソールに記述し、実行しましょう。

1
employee

上記を実行すると、以下のように更新後のbirthdayのプロパティ値は、更新前と比べてupdateメソッドに指定した値に変更されていることがわかりますね。

phpMyAdminを再読み込みして、employeesテーブル内の山口冬子さんのbirthdayが1993-05-12から1993-12-12に更新されていることを確認しましょう。

また、updated_atの値も更新した日時に変更されたかを確かめてみてください。

Delete

リンクをコピーしました

Deleteは、「テーブルのレコードを削除する」というデータ操作の基本処理を指します。

Railsの場合は、ActiveRecordが提供するdestroyメソッド、destroy_allメソッドなどを利用することで、テーブルのレコードを削除することができます。

destroyメソッド

リンクをコピーしました

destroyメソッドを利用する場合、あらかじめfindメソッドやfind_byメソッドなどで、オブジェクトを取得してから削除処理を行います。

削除対象のオブジェクトに対して、destroyメソッドを呼び出します。

1
削除対象のオブジェクト.destroy

例えば、usersテーブルのnameカラムの値が'田中太郎'のレコードを削除するには、以下のように、まずオブジェクトを取得します。そして、取得したオブジェクトに対してdestroyメソッドを呼び出し、データベースからレコードを削除します。

1
2
user = User.find_by(name: '田中太郎')　#削除対象のオブジェクトを取得する
user.destroy #レコードを削除する

employeesテーブルにあるnameカラムの値が'山口冬子'のレコードを削除してみます。

以下のコードをコンソールに記述し、実行しましょう。

1
2
employee = Employee.find_by(name: '山口冬子')
employee. destroy

上記を実行すると、以下のように裏側でSQL文が発行されます。SQLの章で学習したように、テーブル内の既存のレコードを削除するには、DELETE構文が使用されます。

phpMyAdminを再読み込みして、employeesテーブルにあるnameの値が'山口冬子'のレコードが削除されていることを確かめてみましょう。

destroy_allメソッド

リンクをコピーしました

モデルのクラスに対してdestroy_allメソッドを呼び出すと、モデルに対応するテーブルのレコードをすべて削除します。

1
モデルのクラス名.destroy_all

usersテーブルのレコードを全て削除する場合は、User.destroy_allと記述します。

1
User.destroy_all

以下のコードを上から順番にコンソールで実行し、employeesテーブルのレコードから削除するようにしましょう。

1
Employee.destroy_all

1
Department.destroy_all

phpMyAdminを再読み込みして、departmentsテーブルとemployeesテーブル内のレコードが全て削除されたかを確認しましょう。

バリデーション（検証）

リンクをコピーしました

バリデーション（validation）とは、入力されたデータが有効であるかを検証する仕組みのことです。Webアプリケーションでは、さまざまな場所からデータを受け取りますが、バリデーションはデータベースに書き込む前に「データが有効かどうか」を検証します。

例えば、お問い合わせフォームの必須項目に対して、データの存在性（データがあるべき箇所に存在しているか）を検証することができます。１項目でも未入力があった場合は、以下のように送信されず、データベースに保存されません。

このような検証処理を１から実装するのは大変です。Active Recordのバリデーション機能を利用することで、シンプルなコードで検証を定義することができます。

Active Recordのバリデーション機能

リンクをコピーしました

CRUDで学習しましたが、RailsではActiveRecordが提供するメソッドを利用することで、オブジェクトを操作するようにデータ操作が可能でしたよね。

1
INSERT INTO users(name, age) VALUES('山田花子', 34);

1
2
user = User.new(name: "山田花子", age: 34)
user.save

saveメソッドは、モデルのインスタンスをデータベースに保存するメソッドですが、以下のようにActive Recordのバリデーション機能を利用すると、モデルのインスタンスがデータベースに書き込まれる前に、インスタンスの状態を検証することができます。

saveメソッドを実行する際に、自動的にインスタンスの状態が検証されて、インスタンスが有効な場合のみデータベースに保存されます。

例えば、Userモデルクラスのname属性とage属性に対して「値が空ではないか」という存在性のバリデーションを設定した場合でみてみましょう。

saveメソッドを実行する際、以下のようにインスタンスの状態が検証されます。インスタンスのname属性とage属性の値が空ではない場合、インスタンスが有効となり、データベースに保存されます。

インスタンスのname属性とage属性の値が空の場合、バリデーションは失敗となり、インスタンスは無効となります。無効なインスタンスは、データベースに保存されません。

例えば、インスタンス生成時にname属性とage属性に対して、空であるnilをセットした場合は、以下のようにデータベースにインスタンスは保存されません。

バリデーションが設定される場合は、saveメソッドを実行する際に自動的にインスタンスの状態が検証されます。saveメソッドの他にも、createメソッドやupdateメソッドを実行する際に行われます。

バリデーションの定義

リンクをコピーしました

バリデーションは、モデルのクラスに定義します。

モデルクラス内にvalidatesメソッドを利用して、検証対象の属性と検証内容を設定することができます。

1
2
3
class クラス名 < ApplicationRecord
  validates(:属性名, 検証名: true)
end

validatesメソッドの検証名: trueのように、メソッドの最後の引数がハッシュの場合は、括弧を付けなくても問題ありません。

多くの場合は、以下のように括弧を外して記述します。

1
2
3
class クラス名 < ApplicationRecord
  validates :属性名, 検証名: true
end

先ほどの具体例のように、Userモデルのname属性とage属性に対して「値が空ではないか」という存在性（presence）の検証を行う場合は、以下のように定義します。

1
2
3
4
class User < ApplicationRecord
  validates :name, presence: true
  validates :age, presence: true
end

上記のバリデーションをUserモデルのクラスに定義すると、以下のようにsaveメソッドを実行する際、自動的にインスタンスのname属性とage属性の値が空ではないか検証を行うことができます。

Userモデルのクラスに存在性のバリデーションを定義していない場合、saveメソッドを実行したとしても、インスタンスの属性に対して値が空ではないかの検証は行われません。

1
2
class User < ApplicationRecord
end

存在性の検証

リンクをコピーしました

存在性（presence）は、指定した属性の値が空ではないことを検証します。
Departmentモデルのname属性、Employeeモデルのname属性に設定してみます。

属性には、以下のいずれかの値がセットされる場合にインスタンスが無効になります。

• nil
• 空文字（''）
• 空白文字（' '）

以下のコマンドを実行して、コンソールを起動してください。

1
cd ~/environment/employee_management

1
rails c

上記のコマンドを実行すると、以下のように表示されます。

Departmentモデルにバリデーションを設定する前でも、name属性にnilをセットした場合、データベースに保存されません。

以下のコードをコンソールに記述し、実行しましょう。

1
2
department = Department.new(name: nil)
department.save

上記を実行すると、以下のようなエラーが発生します。

departmentsテーブルのnameカラムには「非NULL制約」が設定されるので、そもそもNULLを格納することができません。

以下のコードをコンソールに記述し、実行しましょう。

1
2
department = Department.new(name: "     ")
department.save

上記を実行すると、以下のようにINSERT操作が行われてtrueが返ります。

phpMyAdminを再読み込みして、departmentsテーブルにnameカラムの値が空白文字のレコードが１件挿入されていることを確認しましょう。

空文字や空白文字もデータベースに保存できないように、Departmentモデルのname属性にpresence: trueを設定しましょう。

1
2
3
class Department < ApplicationRecord
  validates :name, presence: true
end

コンソールを立ち上げている最中にモデルの内容を変更した場合、コンソールにはすぐに反映されません。コンソールにreload!と打ち込むことで、再起動せずに最新のモデル情報を反映させることができます。

コンソールにreload!と打ち込み、実行しましょう。

1
reload! 

以下のようにtrueを返せば、再読み込みできています。

以下のコードをコンソールに記述し、実行しましょう。

1
2
department = Department.new(name: "     ")
department.save

上記を実行すると、以下のようにINSERT操作が行われず、falseが返ります。

Departmentモデルのname属性にpresence: trueを設定したことで、saveメソッドが実行される際に自動でインスタンスのname属性の値が空ではないかを検証します。

name属性には空白文字をセットしたので、インスタンスは無効となり、データベースに保存されません。

1
2
3
class Employee < ApplicationRecord
  validates :name, presence: true
end

起動中のコンソールにEmployeeモデルの最新情報を反映させるために、reload!と打ち込み、実行しましょう。

1
reload! 

以下のコードをコンソールに記述し、実行しましょう。

1
2
employee = Employee.new(name: '')
employee.save

Employeeモデルのインスタンスには、name属性の値を空文字（''）でセットしたので、インスタンスは無効となり、INSERT操作が行われずfalseが返ります。

一意性の検証

リンクをコピーしました

一意性（uniqueness）は、指定した属性の値が一意で重複しないことを検証します。このバリデーションは、「指定した属性と同じ値を持つ既存のレコード」がモデルに対応するテーブルにあるかどうかを調べてくれます。

一意性の検証は、validatesメソッドの引数にuniqueness: trueを指定します。

1
2
3
class クラス名 < ApplicationRecord
  validates :属性名, uniqueness: true
end

まずは、以下のコードをコンソールで実行し、部署名が'営業'の新しいレコードをdepartmentsテーブルに挿入しましょう。

1
2
department = Department.new(name: '営業')
department.save

次にDepartmentモデルのname属性にuniqueness: trueを追加し、一意性の検証が行われるように設定しましょう。

1
2
3
class Department < ApplicationRecord
  validates :name, presence: true, uniqueness: true
end

起動中のコンソールにDepartmentモデルの最新情報を反映させるために、reload!と打ち込み、実行しましょう。

1
reload! 

最後に部署名の一意性の検証が行われるか確認してみます。

departmentsテーブルには、部署名が'営業'のレコードがすでに存在するので、同じ値を保存しようとすると、一意性の検証により、インスタンスは無効になり、データベースには保存されないはずです。

以下のコードを実行し、一意性の検証が行われるか確かめてみましょう。

1
2
department = Department.new(name: '営業')
department.save

上記を実行すると、以下のように裏側では「departmentsテーブルに同じ値を持つレコードがあるかどうか」を調べるSQL文が発行されます。

すでに'営業'を持つレコードは存在しているので、インスタンスは無効となり、データベースに保存されずに、falseを返します。

長さの検証

リンクをコピーしました

長さ（length）の検証は、指定した属性の値の長さを検証します。

長さの検証は、validatesメソッドの引数にlength: {オプション}を指定します。

1
2
3
class クラス名 < ApplicationRecord
  validates :属性名, length: { オプション }
end

オプションは、長さの制限を設けることができます。

departmentsテーブルとemployeesテーブルのnameカラムには、文字列の最大幅として30が指定されています。各モデルのname属性にlength: { maximum: 30 }を追加し、長さの検証が行われるように設定してみます。

Departmentモデルのname属性にlength: { maximum: 30 }を追加し、長さの検証が行われるように設定しましょう。

1
2
3
class Department < ApplicationRecord
  validates :name, presence: true, uniqueness: true, length: { maximum: 30 }
end

起動中のコンソールにDepartmentモデルの最新情報を反映させるため、reload!と打ち込み、実行しましょう。

1
reload! 

31文字の文字列は、'a' * 31で作成します。

lengthメソッドを呼び出して、'a' * 31が31文字の文字列を作ることを確認してみます。コンソールで以下のコードを記述し、実行しましょう。

1
2
'a' * 31
('a' * 31).length

上記を実行すると、以下のように'a' * 31が31文字の文字列の長さであることが確認できます。

Departmentモデルのインスタンスに対して、name属性の値を31文字の文字列をセットして、検証してみましょう。

コンソールで以下のコードを記述し、実行しましょう。

1
2
3
exceed_max_validation_length = 'a' * 31
department = Department.new(name: exceed_max_validation_length)
department.save

上記を実行すると、31文字の部署の名前が長すぎることが検証されます。インスタンスは無効となり、データベースに保存されずに、falseを返します。

Employeeモデルのname属性にもlength: { maximum: 30 }を追加し、長さの検証が行われるように設定しましょう。

1
2
3
class Employee < ApplicationRecord
  validates :name, presence: true, length: { maximum: 30 }
end

Employeeモデルの最新情報を反映させるため、コンソールにreload!と打ち込み、実行しましょう。

1
reload! 

Employeeモデルのインスタンスに対して、name属性の値を31文字の文字列をセットして、検証してみましょう。

コンソールで以下のコードを実行し、falseを返すことを確かめましょう。

1
2
3
exceed_max_validation_length = 'a' * 31
employee = Employee.new(name: exceed_max_validation_length)
employee.save

エラーメッセージ

リンクをコピーしました

バリデーションが行われた後にerrorsメソッドを利用すると、検証エラーに関する情報を取得することができます。

バリデーションが行われてインスタンスが無効だった場合、そのモデルのインスタンスに対してerrors.full_messagesメソッドを呼び出すと、全てのエラーメッセージを配列で取得できます。

1
モデルクラスのインスタンス.errors.full_messages

例えば、Userモデルのname属性とage属性に「値が空ではないか」という存在性の検証を定義していたとします。

1
2
3
4
5
class User < ApplicationRecord
  #name属性とage属性の値が空ではないか検証するように設定
  validates :name, presence: true
  validates :age, presence: true
end

Userモデルのインスタンスに対して、name属性とage属性の値をnilにセットし、saveメソッドを呼び出すとバリデーションが自動で実行されてfalseを返します。

インスタンスは無効なので、以下のようにerrors.full_messagesメソッドを呼び出すと、エラーメッセージを取得できます。

1
2
3
4
5
6
user = User.new(name: nil, age: nil) #nilでインスタンスを生成する
user.save #バリデーションが自動で実行される
=> false #インスタンスが無効なので、エラーメッセージが追加される

user.errors.full_messages #エラーメッセージを取得する
=> ["Name can't be blank", "Age can't be blank"]

有効なインスタンスに対してerrors.full_messagesメソッドを呼び出した場合、以下のようにエラーメッセージがない空の配列（[]）を返します。

1
2
3
4
5
6
user = User.new(name: '山田花子', age: 34)
user.save #バリデーションが自動で実行される
=> true #インスタンスは有効

user.errors.full_messages #エラーメッセージを取得する
=> [] #インスタンスは有効なので、空配列が返る

Departmentモデルのname属性では、以下のバリデーションを設定していましたね。

1
2
3
class Department < ApplicationRecord
  validates :name, presence: true, uniqueness: true, length: { maximum: 30 }
end

まずは、有効になるインスタンスをデータベースに保存し、エラーメッセージが[]を返すことを確認しましょう。

以下のコードをコンソールで実行してください。

1
2
3
department = Department.new(name: '開発')
department.save
department.errors.full_messages

上記のdepartmentは有効なのでdepartment.saveを実行すると、以下のようにtrueを返します。有効なインスタンスでは、エラーメッセージがなく[]を返します。

無効なインスタンスに対してerrors.full_messagesメソッドを呼び出した場合、エラーメッセージを含む配列を返します。

以下のコードをコンソールで実行して、エラーメッセージを取得しましょう。

1
2
3
department = Department.new(name: nil)
department.save
department.errors.full_messages

上記のdepartmentのname属性はnilで、インスタンスは無効です。department.saveを実行すると、以下のようにfalseを返します。無効なインスタンスでは、エラーメッセージを含む配列を返します。

アソシエーション（関連付け）

リンクをコピーしました

Active Recordには、「アソシエーション」と呼ばれる機能があります。アソシエーションとは、モデル同士の関連付けを行う機能のことです。

テーブル同士の関連付けは「外部キー制約」の設定によって、すでに定義されています。

このデータベース側のテーブル同士の関連付けは、Railsのモデル側には対応していません。

テーブル同士の関連付けだけではなく、アソシエーションでモデル同士の関連付けまで行うと、複数のテーブルにまたがる操作が直感的なコードで記述できるようになります。

開発の部署に所属している社員の情報を取得する場合で比較してみます。

アソシエーションでモデル同士の関連付けは行わず、テーブル同士の関連付けだけの場合は、以下のようにdepartmentsテーブルに対応するDepartmentモデルでfindメソッドを利用して、idが1の開発のレコードを取得します。

department.idは、開発のレコードの主キーの値（1）を取得できます。whereメソッドに外部キーを指定してidが1の開発部に属している社員を取得します。

1
2
department = Department.find(1)
employees = Employee.where(department_id: department.id)

アソシエーションでモデル同士の関連付けを行うと、以下のように外部キーを機にすることなくdepartment.employeesだけで、開発の部署に所属している社員を全て取得することができます。

1
2
department = Department.find(1)
employees = department.employees

アソシエーションの定義

リンクをコピーしました

アソシエーションは、モデルのクラスに定義します。モデル同士の関連付けの種類はいくつかありますが、belongs_toとhas_manyがよく使われます。

has_manyの場合、:関連モデル名は複数形にします。

1
2
3
class クラス名 < ApplicationRecord
  belongs_to :関連モデル名
end

1
2
3
class クラス名 < ApplicationRecord
  has_many :関連モデル名
end

アソシエーションを定義する場合、テーブル同士の関係性を整理しておく必要があります。

belongs_toの関係性

リンクをコピーしました

employeesテーブルとdepartmentsテーブルの関係性は、以下のように複数の社員が各部署に必ず属しています。社員は部署がなければ存在しません。

社員は必ずどれか１つの部署に属している（Employee belongs to a Department）関係性です。このような関係性の場合、Employeeモデルのクラスにbelongs_toを使います。belong toは「〜に属する」という意味です。

Employeeモデルは、Departmentモデルに属す関係です。この関係性でモデル同士を関連付けるには、Employeeモデルのクラスにbelongs_to :departmentを指定します。

Employeeモデルのクラスにbelongs_to :departmentを追加しましょう。

1
2
3
4
class Employee < ApplicationRecord
  belongs_to :department
  validates :name, presence: true, length: { maximum: 30 }
end

has_manyの関係性

リンクをコピーしました

belongs_toのときは、複数の社員は１つの部署に属すという関係でしたが、部署側からはどのようにみえるでしょうか。

部署側側から社員をみると、１つの部署は複数の社員を持つ（Department has many Employees）関係性です。このような関係を1:nと呼びます。部署1つに対して社員は0以上あるので、nと表現しています。

1:nの関係性の場合、Departmentモデルのクラスにhas_manyを使います。

１つのDepartmentモデルは複数のEmployeeモデルを持つ関係です。この関係性でモデル同士を関連付けは、Departmentモデルのクラスにhas_many :employeesを指定します。

Departmentモデルのクラスにhas_many :employeesを追加しましょう。

1
2
3
4
class Department < ApplicationRecord
  has_many :employees
  validates :name, presence: true, uniqueness: true, length: { maximum: 30 }
end

has_manyの関連モデル名は、複数形になるので注意してください。

Departmentモデル経由でEmployeeモデルの情報を取得

リンクをコピーしました

アソシエーションで、DepartmentモデルとEmployeeモデルの関連付けをしたことで、Departmentモデル経由でEmployeeモデルの情報を取得することができます。

1
2
3
4
5
6
7
class Department < ApplicationRecord
  has_many :employees
end

class Employee < ApplicationRecord
  belongs_to :department
end

ターミナルで以下のコマンドを実行して、テーブルを作り直しましょう。
※ rails cで起動したコンソールではなく、ターミナルで実行します。

1
cd ~/environment/employee_management

1
rails db:migrate:reset

上記を実行すると、以下のようにデータベースの削除、作成、マイグレーション実行までされます。

コンソールに最新情報を反映させるため、起動中のコンソールにreload!と打ち込み、実行しましょう。

※ターミナルではなく、rails cコマンドで起動させたコンソールで行います。

1
reload! 

departmentsテーブルに挿入するデータは、以下の通りです。

まずは、以下のコードをコンソールで実行し、departmentsテーブルに上記のレコードを挿入しましょう。

※ターミナルではなく、rails cコマンドで起動させたコンソールで行います。

1
2
3
4
Department.create([
  { name: '開発' },
  { name: '営業' }
])

employeesテーブルに挿入するデータは、以下の通りです。

employeesテーブルに複数レコードを挿入するために、以下のコードをコンソールに記述し、実行しましょう。

1
2
3
4
5
6
7
8
Employee.create([
  { name: '田中太郎', birthday: '1980-10-22', department_id: 1 },
  { name: '山田花子', birthday: '1983-08-20', department_id: 1 },
  { name: '高橋一朗', birthday: '1986-06-16', department_id: 2 },
  { name: '伊藤晴子', birthday: '1987-10-01', department_id: 1 },
  { name: '鈴木二郎', birthday: '1990-01-17', department_id: 2 },
  { name: '山口冬子', birthday: '1993-05-12', department_id: 2 }
])

コンソールで以下のコードを実行し、Employeeモデルの情報を取得しましょう。

1
2
department = Department.find(1)
department.employees

上記を実行すると、以下のように開発に所属する社員の情報が取得することができます。

開発に所属する社員は、以下のように田中太郎さん、山田花子さん、伊藤晴子さんです。