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

概要

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

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

モデルとテーブルの生成

モデルの生成

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

rails generate model record col1:string

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

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

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

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

rails db:migrate

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

モデルの構造の確認

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

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

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

データの登録確認

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

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

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

データの読み込み確認

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

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

MySQLでのテーブル変更

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

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

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

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

 

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

概要

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

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

プロジェクト生成時

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

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

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

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

database.ymlの編集

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

データベースの生成

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

rails db:create

データベースの確認

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

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

データベースの削除

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

rails db:drop

実行例

database.yml

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

データベースの生成

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

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

Rails – ヘルパーメソッド

主なヘルパーメソッド

link_to

<a>要素を生成する。

基本形

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

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

属性の追加

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

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

フォーム関係

Vagrant – コマンド

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
    • idvagrant 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操作~基礎的な読み書き

概要

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

手順

書き込み

手順は以下の通り。

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

読み込み

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

  • @model_names = ModelName.all

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

  • @model_names.col1

 

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

概要

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

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

モデルの生成・削除

モデルの生成

テーブルに対して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を継承

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

app_name/db/migrate/yyyymmddhhmmss_create_model_name.rb

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

モデルの削除

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

rails destroy model model_name

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

テーブルの生成・削除

テーブルの生成

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

rails db:migrate

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

一度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:stringage:integerの2つのフィールドを持つモデルを生成する。

モデルファイル

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

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

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

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

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

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

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

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

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

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

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

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

ロールバック

すべてロールバック

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

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

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

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

 

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

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

再度マイグレート。

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

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

 

Rails – 基礎的なフォーム

概要

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

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

元になる枠組み

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

STEP-1~form_tag

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

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

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

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

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

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

ルーティングの追加

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

アクションの確認

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

STEP-2~params

params変数の確認

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

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

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

params変数のHTMLへの反映

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

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

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

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

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

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

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

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

上記のlabel_tagtext_field_tagsubmit_tagはそれぞれ対応するタグに変換される~フォームヘルパー(旧)

form_tagヘルパーのまとめ

フォーム全体

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

フォーム内のヘルパー

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

受信側での扱い

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

 

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

共通事項

名前の指定

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

text_field_tag(:name)
text_field_tag("name")

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

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

基本系

form_tag

form_tagfomタグを生成する(Railsdoc)。

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

アクションを指定

メソッドを指定

multipart指定

 

submit_tag

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

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

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

無効化

POST中の表示の指定

label_tag

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

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

識別子と内容を指定

テキスト入力系

text_field_tag

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

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

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

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

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

クラス指定

 

Vagrant – Atomを使う

方法1~共有フォルダ-

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

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

方法2~AtomからFTP接続

remote-ftpのインストール

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

手順

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

.ftpconfigファイルの編集

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

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

接続

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

トラブル

ERBファイル

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

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

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

 

Rails – ルーティング

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

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

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

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

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

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

config/routes.rb

ファイルの内容

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

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

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

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

URL指定

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

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

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

ルートページの指定

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

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

基礎的なルーティング

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

基礎的なルーティング

RESTful

今後