Rails – 例題 – コントローラー・ビューを準備する

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

概要

Railsの例題・掲示板の第1段階のためのコントローラーとビューを生成する。

コントローラー・ビューの生成

プロジェクトディレクトリー下で、2つのコントローラー、pagesとusersを生成する。

pagesコントローラーとビュー

生成コマンド

pagesコントローラーには1つのアクションtopを定義する。

rails generate controller pages top

[vagrant@vagrant ex_bbs]$ rails generate controller pages top
Running via Spring preloader in process 793
      create  app/controllers/pages_controller.rb
       route  get 'pages/top'
      invoke  erb
      create    app/views/pages
      create    app/views/pages/top.html.erb
      invoke  test_unit
      create    test/controllers/pages_controller_test.rb
      invoke  helper
      create    app/helpers/pages_helper.rb
      invoke    test_unit
      invoke  assets
      invoke    coffee
      create      app/assets/javascripts/pages.coffee
      invoke    scss
      create      app/assets/stylesheets/pages.scss

[vagrant@vagrant ex_bbs]$ rails generate controller pages top

Running via Spring preloader in process 793

create app/controllers/pages_controller.rb

route get 'pages/top'

invoke erb

create app/views/pages

create app/views/pages/top.html.erb

invoke test_unit

create test/controllers/pages_controller_test.rb

invoke helper

create app/helpers/pages_helper.rb

invoke test_unit

invoke assets

invoke coffee

create app/assets/javascripts/pages.coffee

invoke scss

create app/assets/stylesheets/pages.scss

コントローラー

上のコマンドによって、コントローラーファイルpages_controller.rb、ビューファイルtop.html.erbの2つのファイルが生成される。

app/controllers/pages_controller.rb

topアクションに対応する空のメソッドが定義されている。

class PagesController < ApplicationController
  def top
  end
end

class PagesController < ApplicationController

def top

end

ビュー

app/views/pages/top.html.erb

コントローラーと同名のディレクトリーがviewsディレクトリーに、アクションと同名のビューファイルがそのディレクトリーにつくられる。ビューファイルにはプレースホルダーの表示が書かれている。

<h1>Pages#top</h1>
<p>Find me in app/views/pages/top.html.erb</p>

1 2	<h1>Pages#top</h1> <p>Find me in app/views/pages/top.html.erb</p>

usersコントローラーとビュー

生成コマンド

usersコントローラーには2つのアクションsign_up、sign_inを定義する。

[vagrant@vagrant ex_bbs]$ rails generate controller users sign_up sign_in
Running via Spring preloader in process 825
      create  app/controllers/users_controller.rb
       route  get 'users/sign_in'
       route  get 'users/sign_up'
      invoke  erb
      create    app/views/users
      create    app/views/users/sign_up.html.erb
      create    app/views/users/sign_in.html.erb
      invoke  test_unit
      create    test/controllers/users_controller_test.rb
      invoke  helper
      create    app/helpers/users_helper.rb
      invoke    test_unit
      invoke  assets
      invoke    coffee
      create      app/assets/javascripts/users.coffee
      invoke    scss
      create      app/assets/stylesheets/users.scss

[vagrant@vagrant ex_bbs]$ rails generate controller users sign_up sign_in

Running via Spring preloader in process 825

create app/controllers/users_controller.rb

route get 'users/sign_in'

route get 'users/sign_up'

invoke erb

create app/views/users

create app/views/users/sign_up.html.erb

create app/views/users/sign_in.html.erb

invoke test_unit

create test/controllers/users_controller_test.rb

invoke helper

create app/helpers/users_helper.rb

invoke test_unit

invoke assets

invoke coffee

create app/assets/javascripts/users.coffee

invoke scss

create app/assets/stylesheets/users.scss

コントローラー

上のコマンドの結果、1つのコントローラーファイルusers_controller.rbと2つのビューファイルsign_up.html.erb、sign_in.html.erbが生成される。

app/controllers/users_controller.rb

2つのアクションに対応する空のメソッドが定義されている。

class UsersController < ApplicationController
  def sign_up
  end

  def sign_in
  end
end

class UsersController < ApplicationController

def sign_up

end

def sign_in

end

ビュー

コントローラーと同名(users)のディレクトリーがviewsディレクトリーの下につくられ、2つのビューファイルが生成される。

app/views/users/sign_up.html.erb

<h1>Users#sign_up</h1>
<p>Find me in app/views/users/sign_up.html.erb</p>

1 2	<h1>Users#sign_up</h1> <p>Find me in app/views/users/sign_up.html.erb</p>

app/view/users/sign_in.html.erb

<h1>Users#sign_in</h1>
<p>Find me in app/views/users/sign_in.html.erb</p>

1 2	<h1>Users#sign_in</h1> <p>Find me in app/views/users/sign_in.html.erb</p>

ルーティングの設定

基礎的なルーティングに従ってルーティングを設定していく。

デフォルトの設定

コントローラー・ビュー生成後のルーティングはconfig/routes.rbに書かれている。

Rails.application.routes.draw do
  get 'users/sign_in'

  get 'users/sign_up'

  get 'pages/top'

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

Rails.application.routes.draw do

get 'users/sign_in'

get 'users/sign_up'

get 'pages/top'

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

end

初期状態では、GETメソッドで各ビューファイルがリクエストされたとき、ディレクトリー構成に従ってファイルを探すようルーティングされる。

たとえばブラウザーでhttp://localhost:3000/pages/topと入力するとpagesディレクトリー下のtop.html.erbが表示される。

ルーティングの設定変更

コントローラー生成時のルーティングを変更する。

ビューファイルのディレクトリー構成によらず、URLで/top、/sign_up、/sign_inと指定してアクションが呼ばれるようにする
..._pathのリンク名を定義する

変更後のroutes.rbは以下のとおり。

Rails.application.routes.draw do
  get '/top', to: 'pages#top', as: :top

  get '/sign_up', to: 'users#sign_up', as: :sign_up

  get '/sign_in', to: 'users#sign_in', as: :sign_in
end

Rails.application.routes.draw do

get '/top', to: 'pages#top', as: :top

get '/sign_up', to: 'users#sign_up', as: :sign_up

get '/sign_in', to: 'users#sign_in', as: :sign_in

end

Rails – 例題 – 掲示板

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

概要

Railsの流れを例題にまとめる。

題材として掲示板を選ぶ。

第1段階

BBSのユーザー登録、サインイン／サインアウト、エラー表示を実装する。

ここでは以下の事項を含む。

プロジェクトの開始、主なファイル配置
基礎的なコントロール、ビュー、ルーティング
データベースの基本操作
フォーム入力、バリデーション、パスワード暗号化
モデルによるデータベースの操作
セッション管理、アクセス制御

第1段階の内容

第2段階

サインインしたユーザーによる、プロフィールページの閲覧・編集、コメントの投稿・削除、画像ファイルの添付を実装する。

ここでは以下の事項を含む。

ユーザーに応じたページの表示・編集
リレーションを持つテーブルの設定・操作
リソースによる操作
画像ファイルのアップロード

第2段階の内容

Rails – form_withとモデルの使い方

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

概要

form系ヘルパーではフォームの入力がparams変数にセットされるが、一般には以下の様な流れで入力パラメーターを利用する。

form_with/form_forで読み込んだパラメーターをモデルにセットする
モデルへのパラメーターのセットは、慣習的にprivateのメソッドを準備して、それを介する
各パラメーターは、モデルインスタンスのプロパティーとして参照・利用

モデルによるフォームデータの取得も参照。

例示

基本構造

流れ

トップページに入力フォームを表示
- /top
- app/controllers/pages_controller#top
- app/views/pages/top.html.erb
フォーム入力をpagesコントローラーのinputアクションへ送信
- app/controllers/pages_controller#input
inputアクションでフォーム入力をUserモデルインスタンスに格納して表示

入力フォーム

form_withによる以下のようなフォームを例にする。フォームビルダーのtext_fieldとpassword_fieldに入力された値が送信される。

<%= form_with(model: @user, url: input_path) do |form| %>
  <%= form.text_field(:name, placeholder: "名前を入力") %>
  <%= form.password_field(:password, placeholder: "パスワードを入力") %>
  <%= form.submit("送信") %>
<% end %>

<%= form_with(model: @user, url: input_path) do |form| %>

<%= form.text_field(:name, placeholder: "名前を入力") %>

<%= form.password_field(:password, placeholder: "パスワードを入力") %>

<%= form.submit("送信") %>

<% end %>

注意点

form_withはデフォルトでajaxによるフォーム送信となり、ページ全体がレンダリングされない。HTMLとして送信してレンダリングするには、パラメーターにlocal: trueを指定する。

<%= form_with(url:/model: ***, local: true) %>

モデルとデータベース

データを扱うモデルは以下で生成し、マイグレートしてテーブルを作成しておく

[vagrant@vagrant testapp]$ rails generate model user name:string password:string

1	[vagrant@vagrant testapp]$ rails generate model user name:string password:string

テーブル

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

mysql> desc users;

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

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

| id | bigint(20) | NO | PRI | NULL | auto_increment |

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

5 rows in set (0.00 sec)

コントローラー

以下の枠組みでコントローラーを生成。ビューのform_withでモデルを使うため、Userインスタンスを生成している。

class PagesController < ApplicationController
  def top
    @user = User.new
  end

  def input
  # 入力時の処理
  end
end

class PagesController < ApplicationController

def top

@user = User.new

end

def input

# 入力時の処理

end

ルーティング

アプリケーション起動時にtopページを表示
入力POST時にinputアクションへルーティング

Rails.application.routes.draw do
  root to: 'pages#top', as: :top
  post 'input', to: 'pages#input', as: :input
end

Rails.application.routes.draw do

root to: 'pages#top', as: :top

post 'input', to: 'pages#input', as: :input

end

入力データのモデルへのセット

コントローラーに以下に様に追記。

class PagesController < ApplicationController
  def top
    @user = User.new
  end

  def input
    puts "---------- form input ----------"
    user = User.new(user_params)
    p user
    p user.name
    p user.password
    redirect_to top_path and return
  end

  private
  def user_params
    params.require(:user).permit(:name, :password)
  end
end

class PagesController < ApplicationController

def top

@user = User.new

end

def input

puts "---------- form input ----------"

user = User.new(user_params)

p user

p user.name

p user.password

redirect_to top_path and return

end

private

def user_params

params.require(:user).permit(:name, :password)

end

要点は次のとおり。

パラメーターを引数にしてモデルインスタンスを与える。

変数 = モデルクラス.new(モデル名_params)

引数はモデルに与えるparamsを返すメソッドで、慣習としてメソッド名の付け方、praivate宣言、requireとpremitによるパラメーター取得が定まっている。

params.require(:モデル名).permit(:要素名, ...)

モデルにパラメーターがセットされた後は、要素名と同じモデルのプロパティーで値を取得。

コンソールの出力部分は以下のとおり

Started POST "/input" for 10.0.2.2 at 2021-03-13 09:47:19 +0900
Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.1, ::1, 127.0.0.0/127.255.255.255
Processing by PagesController#input as JS
  Parameters: {"utf8"=>"✓", "authenticity_token"=>"o3M9kpQpW10kA+lAocHDdvsgFf3BdIgutcqGaapRBVqkuAu3eu0j5k6jhZHEbU44n43Y81cuicBjL0UeuLrFyA==", "user"=>{"name"=>"NAME", "password"=>"[FILTERED]"}, "commit"=>"送信"}
---------- form input ----------
#<User id: nil, name: "NAME", password: "PASSWORD", created_at: nil, updated_at: nil>
"NAME"
"PASSWORD"
Redirected to http://localhost:3000/
Completed 200 OK in 3ms (ActiveRecord: 0.0ms)

Started POST "/input" for 10.0.2.2 at 2021-03-13 09:47:19 +0900

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

Processing by PagesController#input as JS

Parameters: {"utf8"=>"✓", "authenticity_token"=>"o3M9kpQpW10kA+lAocHDdvsgFf3BdIgutcqGaapRBVqkuAu3eu0j5k6jhZHEbU44n43Y81cuicBjL0UeuLrFyA==", "user"=>{"name"=>"NAME", "password"=>"[FILTERED]"}, "commit"=>"送信"}

---------- form input ----------

#<User id: nil, name: "NAME", password: "PASSWORD", created_at: nil, updated_at: nil>

"NAME"

"PASSWORD"

Redirected to http://localhost:3000/

Completed 200 OK in 3ms (ActiveRecord: 0.0ms)

require/permitメソッド

フォームの入力をモデルにセットする際、require～permitでパラメーターを指定している。

たとえば悪意のあるユーザーによってPOSTされる要素が追加された場合でも、必要なパラメーターのみを参照・変更することができる。

そして上述のように、一般的にはrequire～permitのメソッドチェーンをprivateメソッドでラップして使う。

Rails – form関係ヘルパーの基本

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

概要

form系のヘルパーの基本的な機能・挙動について整理してみた。

form系の新旧4つのヘルパーの動作についてまとめた
モデルを介して複数のパラメーターを扱うform_forとform_withのオーソドックスな使い方については、最後の「パラメーターを一括で扱う」にまとめた。

各formヘルパーの関係は

form_tag、form_for、form_withはHTMLのformタグを生成するRailsのヘルパー
Rails 5.1より前はform_tagとform_for
Rails 5.1からform_withが導入され、form_tagとform_forは非推奨に

form_tagとform_forについては

form_tagはブロック内にtext_field_tagなどtag系のヘルパーを持つことを想定
データベースと紐づいたモデルを扱う場合はform_for、モデルを介さずにフォームのデータのみやりとりする場合はform_tagを使用

form_withについては

form_withはform_tagの機能とform_forの機能を1つで使い分け

form_tag

動作

form_tagはフォームブロックの各要素の値を直接ハッシュで取り出すため、モデルは介在しない。

form_tagではアクションへのパスを指定し、アクションで各要素の値を参照する
各要素の値は1次元のハッシュparamsに格納されている
要素の値は要素のname属性をキーとして参照

コード間の流れ

app/views/top.html.erb

form_tagヘルパーの引数に、POSTを送るアクションへのパスを指定
- パス指定にはroutes.rbで設定するエイリアスを使っている
各要素ヘルパーの第1引数でid/name属性の値をシンボルで定義

<%= form_tag(from_form_tag_path) do %>
  <%= text_field_tag(:param_text, nil, placeholder: "テキスト入力") %>
  <%= password_field_tag(:param_pass, nil, placeholder: "パスワード入力") %>
  <%= submit_tag("送信") %>
<% end %>

<%= form_tag(from_form_tag_path) do %>

<%= text_field_tag(:param_text, nil, placeholder: "テキスト入力") %>

<%= password_field_tag(:param_pass, nil, placeholder: "パスワード入力") %>

<%= submit_tag("送信") %>

<% end %>

config/routes.rb

form_tagからのPOSTを受け取るアクションへのルートを設定
URLにエイリアスを使っていて、それをアクションに紐づけている

Rails.application.routes.draw do
  root to: 'pages#top', as: :top
  post 'from_form_tag', to: 'pages#form_tag_process', as: :from_form_tag
end

Rails.application.routes.draw do

root to: 'pages#top', as: :top

post 'from_form_tag', to: 'pages#form_tag_process', as: :from_form_tag

end

app/controllers/pages_controller.rb

ルーティングの結果呼ばれたアクション内で、フォームの要素から送られた値を処理
要素の値はparams[キーのシンボル]で取り出す

class PagesController < ApplicationController
  def top
  end

  def form_tag_process
    puts "----- form_params -----"
    p params
    p params[:param_text]
    p params[:param_pass]
    redirect_to top_path and return
  end
end

class PagesController < ApplicationController

def top

end

def form_tag_process

puts "----- form_params -----"

p params

p params[:param_text]

p params[:param_pass]

redirect_to top_path and return

end

コンソール出力

4行目でPOSTで送られるparams全体が表示されている
6行目でparamsを表示させており、4行目と同じ内容
7～8行目は個別の要素の値をキーを使って参照

Started POST "/from_form_tag" for 10.0.2.2 at 2021-03-10 23:33:14 +0900
Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.1, ::1, 127.0.0.0/127.255.255.255
Processing by PagesController#form_tag_process as HTML
  Parameters: {"utf8"=>"✓", "authenticity_token"=>"r2MLrmxMn/q+ox6XCSu6snB8SMU7qDF9ePvsLcYdNmkVTDt6HQuVnO3ZLRvQXCbhR9TPBIkSHnZzK/841Xf9Bw==", "param_text"=>"TEXT", "param_pass"=>"PASSWORD", "commit"=>"送信"}
----- form_params -----
<ActionController::Parameters {"utf8"=>"✓", "authenticity_token"=>"r2MLrmxMn/q+ox6XCSu6snB8SMU7qDF9ePvsLcYdNmkVTDt6HQuVnO3ZLRvQXCbhR9TPBIkSHnZzK/841Xf9Bw==", "param_text"=>"TEXT", "param_pass"=>"PASSWORD", "commit"=>"送信", "controller"=>"pages", "action"=>"form_tag_process"} permitted: false>
"TEXT"
"PASSWORD"
Redirected to http://localhost:3000/
Completed 302 Found in 1ms (ActiveRecord: 0.0ms)

Started POST "/from_form_tag" for 10.0.2.2 at 2021-03-10 23:33:14 +0900

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

Processing by PagesController#form_tag_process as HTML

Parameters: {"utf8"=>"✓", "authenticity_token"=>"r2MLrmxMn/q+ox6XCSu6snB8SMU7qDF9ePvsLcYdNmkVTDt6HQuVnO3ZLRvQXCbhR9TPBIkSHnZzK/841Xf9Bw==", "param_text"=>"TEXT", "param_pass"=>"PASSWORD", "commit"=>"送信"}

----- form_params -----

<ActionController::Parameters {"utf8"=>"✓", "authenticity_token"=>"r2MLrmxMn/q+ox6XCSu6snB8SMU7qDF9ePvsLcYdNmkVTDt6HQuVnO3ZLRvQXCbhR9TPBIkSHnZzK/841Xf9Bw==", "param_text"=>"TEXT", "param_pass"=>"PASSWORD", "commit"=>"送信", "controller"=>"pages", "action"=>"form_tag_process"} permitted: false>

"TEXT"

"PASSWORD"

Redirected to http://localhost:3000/

Completed 302 Found in 1ms (ActiveRecord: 0.0ms)

form_for

動作

form_forでは第1引数にモデルのインスタンスを指定
- モデルのインスタンスはコントローラーでインスタンス変数として準備
form_forでPOSTされた各要素の値はハッシュparams[モデル名のシンボル]に格納される
- 要素の値を取り出すには以下のハッシュを参照
- params[モデル名のシンボル][要素名のシンボル]
ここでは第2引数のURLでPOST先のアクションを指定している

コード間の流れ

より具体的な実装については、モデルによるフォームデータの取得を参照。

app/views/top.html.erb

form_forの第1引数にモデルのインスタンスを指定
- インスタンスはコントローラーで生成
- 第2に引数のurl:で指定したパスにPOST
form_forの構文は以下のとおり
- form_for(モデル, オプション群) do |フォームビルダー|
各要素の値はtext_fieldなどフォームビルダーのメソッドで要素名を指定して取得する

<%= form_for(@record, url: from_form_for_path) do |form| %>
  <%= form.text_field(:param_text, placeholder: "テキストを入力") %>
  <%= form.password_field(:param_pass, placeholder: "パスワードを入力") %>
  <%= form.submit("送信") %>
<% end %>

<%= form_for(@record, url: from_form_for_path) do |form| %>

<%= form.text_field(:param_text, placeholder: "テキストを入力") %>

<%= form.password_field(:param_pass, placeholder: "パスワードを入力") %>

<%= form.submit("送信") %>

<% end %>

config/routes.rb

form_tagからのPOSTを受け取るアクションへのルートを設定
ここではurl:で指定したエイリアスからアクションに紐づけている

Rails.application.routes.draw do
  root to: 'pages#top', as: :top
  post 'from_form_for', to: 'pages#form_for_process', as: :from_form_for
end

Rails.application.routes.draw do

root to: 'pages#top', as: :top

post 'from_form_for', to: 'pages#form_for_process', as: :from_form_for

end

app/controllers/pages_controller.rb

ルーティングの結果呼ばれたアクション内で、フォームの要素から送られたデータを確認
各要素の値はparams[モデル名のシンボル]にハッシュとしてまとめられている
個別の要素の値はその中で要素名をキーとしてとりだせる
- params[モデル名のシンボル][要素名のシンボル]

class PagesController < ApplicationController
  def top
    @record = Record.new
  end

  def form_for_process
    puts "----- form_params -----"
    p params[:record]
    p params[:record][:param_text]
    p params[:record][:param_pass]
    redirect_to top_path and return
  end
end

class PagesController < ApplicationController

def top

@record = Record.new

end

def form_for_process

puts "----- form_params -----"

p params[:record]

p params[:record][:param_text]

p params[:record][:param_pass]

redirect_to top_path and return

end

なお上の例ではform_forの引数に与えるモデルインスタンス(@user)を最初に生成しているが、コントローラーの中ではこれを使わず、ローカルな変数(user)を使っている。

コンソール出力

4行目中、"record" => {"param_text" => "TEXT", ...}が各要素のデータ
6行目に全要素のハッシュ、7～8行目に個別の要素の値が表示されている

Started POST "/from_form_for" for 10.0.2.2 at 2021-03-10 23:22:22 +0900
Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.1, ::1, 127.0.0.0/127.255.255.255
Processing by PagesController#form_for_process as HTML
  Parameters: {"utf8"=>"✓", "authenticity_token"=>"kxRom4t1qFU20HznmSM8ydT7b9rqD9c9GNclGgakhBopO1hP+jKiM2WqT2tAVKCa41PoG1i1+DYTBzYPFc5PdA==", "record"=>{"param_text"=>"TEXT", "param_pass"=>"PASSWORD"}, "commit"=>"送信"}
----- form_params -----
<ActionController::Parameters {"param_text"=>"TEXT", "param_pass"=>"PASSWORD"} permitted: false>
"TEXT"
"PASSWORD"
Redirected to http://localhost:3000/
Completed 302 Found in 5ms (ActiveRecord: 0.0ms)

Started POST "/from_form_for" for 10.0.2.2 at 2021-03-10 23:22:22 +0900

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

Processing by PagesController#form_for_process as HTML

Parameters: {"utf8"=>"✓", "authenticity_token"=>"kxRom4t1qFU20HznmSM8ydT7b9rqD9c9GNclGgakhBopO1hP+jKiM2WqT2tAVKCa41PoG1i1+DYTBzYPFc5PdA==", "record"=>{"param_text"=>"TEXT", "param_pass"=>"PASSWORD"}, "commit"=>"送信"}

----- form_params -----

<ActionController::Parameters {"param_text"=>"TEXT", "param_pass"=>"PASSWORD"} permitted: false>

"TEXT"

"PASSWORD"

Redirected to http://localhost:3000/

Completed 302 Found in 5ms (ActiveRecord: 0.0ms)

form_with (データベースなし)

動作

動作の内容はform_tagと同じ
そのためビューにおいてform_withの引数としてURLを指定(url: パス)

注意点

<%= form_with(url: 'URL', local: true) do |f| %>

コード間の流れ

ビューでの書き方以外はform_tagと同じ流れ

app/views/top.html.erb

form_withの引数にURLを指定(url: パス)
モデルが介在しないform_tagと同じ動作をさせる書き方
各要素はフォームビルダーのメソッドで書いている

<%= form_with(url: from_form_with_non_db_path) do |form| %>
  <%= form.text_field(:param_text, placeholder: "テキスト入力") %>
  <%= form.password_field(:param_pass, placeholder: "パスワード入力") %>
  <%= form.submit("送信") %>
<% end %>

<%= form_with(url: from_form_with_non_db_path) do |form| %>

<%= form.text_field(:param_text, placeholder: "テキスト入力") %>

<%= form.password_field(:param_pass, placeholder: "パスワード入力") %>

<%= form.submit("送信") %>

<% end %>

config/routes.rb

Rails.application.routes.draw do
  root to: 'pages#top', as: :top
  post 'from_form_with_non_db', to: 'pages#form_with_non_db_process', as: :from_form_with_non_db
end

Rails.application.routes.draw do

root to: 'pages#top', as: :top

post 'from_form_with_non_db', to: 'pages#form_with_non_db_process', as: :from_form_with_non_db

end

app/controllers/pages_controller.rb

class PagesController < ApplicationController
  def top
  end

  def form_with_non_db_process
    puts "----- form_with (non DB) -----"
    p params
    p params[:param_text]
    p params[:param_pass]
    redirect_to top_path and return
  end
end

class PagesController < ApplicationController

def top

end

def form_with_non_db_process

puts "----- form_with (non DB) -----"

p params

p params[:param_text]

p params[:param_pass]

redirect_to top_path and return

end

コンソール出力

Started POST "/from_form_with_non_db" for 10.0.2.2 at 2021-03-10 23:44:49 +0900
Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.1, ::1, 127.0.0.0/127.255.255.255
Processing by PagesController#form_with_non_db_process as JS
  Parameters: {"utf8"=>"✓", "authenticity_token"=>"lwT+bvSyq9SN/mYrripqw1w5BTs7j41fJAa391FIyHstK866hfWhst6EVad3XfaQa5GC+ok1olQv1qTiQiIDFQ==", "param_text"=>"TEXT", "param_pass"=>"PASSWORD", "commit"=>"送信"}
----- form_with (non DB) -----
<ActionController::Parameters {"utf8"=>"✓", "authenticity_token"=>"lwT+bvSyq9SN/mYrripqw1w5BTs7j41fJAa391FIyHstK866hfWhst6EVad3XfaQa5GC+ok1olQv1qTiQiIDFQ==", "param_text"=>"TEXT", "param_pass"=>"PASSWORD", "commit"=>"送信", "controller"=>"pages", "action"=>"form_with_non_db_process"} permitted: false>
"TEXT"
"PASSWORD"
Redirected to http://localhost:3000/
Completed 200 OK in 3ms (ActiveRecord: 0.0ms)

Started POST "/from_form_with_non_db" for 10.0.2.2 at 2021-03-10 23:44:49 +0900

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

Processing by PagesController#form_with_non_db_process as JS

Parameters: {"utf8"=>"✓", "authenticity_token"=>"lwT+bvSyq9SN/mYrripqw1w5BTs7j41fJAa391FIyHstK866hfWhst6EVad3XfaQa5GC+ok1olQv1qTiQiIDFQ==", "param_text"=>"TEXT", "param_pass"=>"PASSWORD", "commit"=>"送信"}

----- form_with (non DB) -----

<ActionController::Parameters {"utf8"=>"✓", "authenticity_token"=>"lwT+bvSyq9SN/mYrripqw1w5BTs7j41fJAa391FIyHstK866hfWhst6EVad3XfaQa5GC+ok1olQv1qTiQiIDFQ==", "param_text"=>"TEXT", "param_pass"=>"PASSWORD", "commit"=>"送信", "controller"=>"pages", "action"=>"form_with_non_db_process"} permitted: false>

"TEXT"

"PASSWORD"

Redirected to http://localhost:3000/

Completed 200 OK in 3ms (ActiveRecord: 0.0ms)

form_with (データベースあり)

より具体的な実装については、モデルによるフォームデータの取得を参照。

動作

動作の内容はform_forと同じ
そのためにビューにおいて引数にデータベースと紐づいたモデルを指定(model: モデルインスタンス)
ここでは第2引数のURLでPOST先のアクションを指定している

<%= form_with(model: 'model', url: 'URL', local: true) do |f| %>

コード間の流れ

app/views/top.html.erb

form_withの引数にモデルのインスタンスを指定している
- model: モデルインスタンス名で指定
- モデルのインスタンスはコントローラーで生成
モデルを介在したform_withと同じ動作をさせる書き方
各要素はフォームビルダーのメソッドで書いている

<%= form_with(model: @record, url: from_form_with_db_path) do |form| %>
  <%= form.text_field(:param_text, placeholder: "テキストを入力") %>
  <%= form.password_field(:param_pass, placeholder: "パスワードを入力") %>
  <%= form.submit("送信") %>
<% end %>

<%= form_with(model: @record, url: from_form_with_db_path) do |form| %>

<%= form.text_field(:param_text, placeholder: "テキストを入力") %>

<%= form.password_field(:param_pass, placeholder: "パスワードを入力") %>

<%= form.submit("送信") %>

<% end %>

config/routes.rb

Rails.application.routes.draw do
  root to: 'pages#top', as: :top
  post 'from_form_with_db', to: 'pages#form_with_db_process', as: :from_form_with_db
end

Rails.application.routes.draw do

root to: 'pages#top', as: :top

post 'from_form_with_db', to: 'pages#form_with_db_process', as: :from_form_with_db

end

app/controllers/pages_controller.rb

class PagesController < ApplicationController
  def top
    @record = Record.new
  end

  def form_with_db_process
    puts "----- form_with (DB) -----"
    p params[:record]
    p params[:record][:param_text]
    p params[:record][:param_pass]
    redirect_to top_path and return
  end
end

class PagesController < ApplicationController

def top

@record = Record.new

end

def form_with_db_process

puts "----- form_with (DB) -----"

p params[:record]

p params[:record][:param_text]

p params[:record][:param_pass]

redirect_to top_path and return

end

コンソール出力

Started POST "/from_form_with_db" for 10.0.2.2 at 2021-03-10 23:51:21 +0900
Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.1, ::1, 127.0.0.0/127.255.255.255
Processing by PagesController#form_with_db_process as JS
  Parameters: {"utf8"=>"✓", "authenticity_token"=>"JsiSAIuM5phTduwLwkuv5x05G9KyYbHNkeX1WJ5lUYmc56LU+svs/gAM34cbPDO0KpGcEwDbnsaaNeZNjQ+a5w==", "record"=>{"param_text"=>"TEXT", "param_pass"=>"PASSWORD"}, "commit"=>"送信"}
----- form_with (non DB) -----
<ActionController::Parameters {"param_text"=>"TEXT", "param_pass"=>"PASSWORD"} permitted: false>
"TEXT"
"PASSWORD"
Redirected to http://localhost:3000/
Completed 200 OK in 1ms (ActiveRecord: 0.0ms)

Started POST "/from_form_with_db" for 10.0.2.2 at 2021-03-10 23:51:21 +0900

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

Processing by PagesController#form_with_db_process as JS

Parameters: {"utf8"=>"✓", "authenticity_token"=>"JsiSAIuM5phTduwLwkuv5x05G9KyYbHNkeX1WJ5lUYmc56LU+svs/gAM34cbPDO0KpGcEwDbnsaaNeZNjQ+a5w==", "record"=>{"param_text"=>"TEXT", "param_pass"=>"PASSWORD"}, "commit"=>"送信"}

----- form_with (non DB) -----

<ActionController::Parameters {"param_text"=>"TEXT", "param_pass"=>"PASSWORD"} permitted: false>

"TEXT"

"PASSWORD"

Redirected to http://localhost:3000/

Completed 200 OK in 1ms (ActiveRecord: 0.0ms)

Vagrant/AmazonLinux2 – Railsインストール

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

概要

VagrantのAmazonLinux2仮想環境にrbenv/Rubyをインストール後、Railsをインストールした記録。

ホスト：Windows10
ゲスト：Vagrant + VirtualBox + bento/amazonlinux-2

Railsの最新版ではなく、オリジナルの環境に併せて特定のバージョンを指定してインストールした。

Railsに影響する機能の停止

SELinux

もともとSELinuxは無効状態だった。

[vagrant@vagrant ~]$ getenforce
Disabled

1 2	[vagrant@vagrant ~]$ getenforce Disabled

firewalld

そもそもfirewalldはセットされていなかった。

[vagrant@vagrant ~]$ systemctl status firewalld
Unit firewalld.service could not be found.

1 2	[vagrant@vagrant ~]$ systemctl status firewalld Unit firewalld.service could not be found.

Railsのインストール

一応、gemで使用できるRailsの確認。使用可能なRailsはない。

[vagrant@vagrant ~]$ gem list rails

*** LOCAL GEMS ***

[vagrant@vagrant ~]$ gem list rails

*** LOCAL GEMS ***

gemでRailsのバージョン5.1.7を指定してインストール。

[vagrant@vagrant ~]$ gem i -v 5.1.7
railsFetching concurrent-ruby-1.1.8.gem
Fetching thread_safe-0.3.6.gem
Fetching rack-2.2.3.gem
.....
Done installing documentation for concurrent-ruby, i18n, thread_safe, tzinfo, activesupport, irack, rack-test, racc, nokogiri, crass, loofah, rails-html-sanitizer, rails-dom-testing, builder, erubi, actionview, actionpack, activemodel, arel, activerecord, globalid, activejob, mini_mime, mail, actionmailer, nio4r, websocket-extensions, websocket-driver, actioncable, thor, method_source, railties, sprockets, sprockets-rails, rails after 81 seconds
35 gems installed

[vagrant@vagrant ~]$ gem i -v 5.1.7

railsFetching concurrent-ruby-1.1.8.gem

Fetching thread_safe-0.3.6.gem

Fetching rack-2.2.3.gem

.....

Done installing documentation for concurrent-ruby, i18n, thread_safe, tzinfo, activesupport, irack, rack-test, racc, nokogiri, crass, loofah, rails-html-sanitizer, rails-dom-testing, builder, erubi, actionview, actionpack, activemodel, arel, activerecord, globalid, activejob, mini_mime, mail, actionmailer, nio4r, websocket-extensions, websocket-driver, actioncable, thor, method_source, railties, sprockets, sprockets-rails, rails after 81 seconds

35 gems installed

再度使用可能なRailsを探して、インストールされていることを確認する。

[vagrant@vagrant ~]$ gem list rails

*** LOCAL GEMS ***

rails (5.1.7)
rails-dom-testing (2.0.3)
rails-html-sanitizer (1.3.0)
sprockets-rails (3.2.2)

[vagrant@vagrant ~]$ gem list rails

*** LOCAL GEMS ***

rails (5.1.7)

rails-dom-testing (2.0.3)

rails-html-sanitizer (1.3.0)

sprockets-rails (3.2.2)

Railsサーバーの稼働

エラー～JavaScriptランタイムがない

テスト用のプロジェクトを生成してRailsサーバーを起動しようとしたところ、エラーになった。

[vagrant@vagrant test_app]$ rails s
Traceback (most recent call last):
        36: from bin/rails:3:in `<main>'
        35: from bin/rails:3:in `load'
.....
/home/vagrant/.rbenv/versions/2.6.3/lib/ruby/gems/2.6.0/gems/execjs-2.7.0/lib/execjs/runtimes.rb:58:in `autodetect': Could not find a JavaScript runtime. See https://github.com/rails/execjs for a list of available runtimes. (ExecJS::RuntimeUnavailable)

[vagrant@vagrant test_app]$ rails s

Traceback (most recent call last):

36: from bin/rails:3:in `<main>'

35: from bin/rails:3:in `load'

.....

/home/vagrant/.rbenv/versions/2.6.3/lib/ruby/gems/2.6.0/gems/execjs-2.7.0/lib/execjs/runtimes.rb:58:in `autodetect': Could not find a JavaScript runtime. See https://github.com/rails/execjs for a list of available runtimes. (ExecJS::RuntimeUnavailable)

Node.jsでもよさそうなので、CentOS7と同じ手順でNode.jsをインストール。Rails6では最新安定版のNode.jsだと警告が出たのでダウングレード下が、Rails5では最新版では警告が出なかった。

[vagrant@vagrant test_app]$ nvm install stable
Downloading and installing node v15.11.0...
Downloading https://nodejs.org/dist/v15.11.0/node-v15.11.0-linux-x64.tar.xz...
######################################################################### 100.0%
Computing checksum with sha256sum
Checksums matched!
Now using node v15.11.0 (npm v7.6.0)
Creating default alias: default -> stable (-> v15.11.0)

[vagrant@vagrant test_app]$ nvm install stable

Downloading and installing node v15.11.0...

Downloading https://nodejs.org/dist/v15.11.0/node-v15.11.0-linux-x64.tar.xz...

######################################################################### 100.0%

Computing checksum with sha256sum

Checksums matched!

Now using node v15.11.0 (npm v7.6.0)

Creating default alias: default -> stable (-> v15.11.0)

ここまででrails serverの実行が可能になった。

ホストブラウザーからの接続

vagrantfileに以下の1行を記述

config.vm.network "forwarded_port", guest: 3000, host: 3000

テスト用のプロジェクトを生成してrails sを実行すると、「このサイトにアクセスできません」と弾かれる。

netstatで確認すると、ポート3000は開いている。

[vagrant@vagrant ~]$ netstat -an
Active Internet connections (servers and established)
Proto Recv-Q Send-Q Local Address           Foreign Address         State
tcp        0      0 0.0.0.0:3306            0.0.0.0:*               LISTEN
tcp        0      0 0.0.0.0:111             0.0.0.0:*               LISTEN
tcp        0      0 0.0.0.0:22              0.0.0.0:*               LISTEN
tcp        0      0 127.0.0.1:3000          0.0.0.0:*               LISTEN
.....

[vagrant@vagrant ~]$ netstat -an

Active Internet connections (servers and established)

Proto Recv-Q Send-Q Local Address Foreign Address State

tcp 0 0 0.0.0.0:3306 0.0.0.0:* LISTEN

tcp 0 0 0.0.0.0:111 0.0.0.0:* LISTEN

tcp 0 0 0.0.0.0:22 0.0.0.0:* LISTEN

tcp 0 0 127.0.0.1:3000 0.0.0.0:* LISTEN

.....

サーバー立ち上げのオプションを以下の様にして接続成功。

rails s -b 0.0.0.0

以前参考にしたサイトを再度確認すると、Rails4.2以降ではこの接続方法になるとのこと。オリジナルの環境ではrails sで十ていたが(エイリアス？)。

既存プロジェクトの実行

オリジナルの環境でつくったプロジェクトをダウンロードし、共有フォルダー経由で仮想環境に移して実行したところ、db:createでエラーが出た。

[vagrant@vagrant bbs]$ rails db:create
Could not find minitest-5.14.3 in any of the sources
Run `bundle install` to install missing gems.

[vagrant@vagrant bbs]$ rails db:create

Could not find minitest-5.14.3 in any of the sources

Run `bundle install` to install missing gems.

指示通りにbundle install。

[vagrant@vagrant bbs]$ bundle install
Warning: the running version of Bundler (1.17.2) is older than the version that created the lockfile (1.17.3). We suggest you upgrade to the latest version of Bundler by running `gem install bundler`.
.....
Bundle complete! 16 Gemfile dependencies, 70 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.

[vagrant@vagrant bbs]$ bundle install

Warning: the running version of Bundler (1.17.2) is older than the version that created the lockfile (1.17.3). We suggest you upgrade to the latest version of Bundler by running `gem install bundler`.

.....

Bundle complete! 16 Gemfile dependencies, 70 gems now installed.

Use `bundle info [gemname]` to see where a bundled gem is installed.

この後db:migrationは問題なく、これでアプリケーションがオリジナルの環境通りに実行できるようになった。

一方、仮想環境で作ったプロジェクトをオリジナルの環境にアップロードした場合、オリジナル側でbundle installが必要になったが、これで問題なく実行できた。

Rails – タイムゾーン

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

概要

Railsでモデルのデータをデータベースに保存した時、OSやMySQLのタイムゾーンはJSTなのに、created_atやupdated_atの時刻がUSTで保存されているのに気付いた。

以下の2つの方法があるようだ。

データベースへの登録時刻をJSTにする方法
データベースへの時刻登録はUSTとし、表示をJSTにする方法

日本以外でも利用するデータベースの時刻を統一するにはUSTの方がよさそうなので、ここでは2つ目の方法を用いた。

プロジェクトのconf/application.rbに1行追加
- config.time_zone = ‘Tokyo’
サーバーが実行中の場合は再起動

これでデータベース上はUST、Railsでの扱いはJSTになる。

データベースへの記録はUST

文字列フィールドを1つ持つテスト用のモデルを生成・マイグレートする。

この操作は21時過ぎに実行したが、マイグレーションファイルの時刻が12時台で、9時間遅れているのでUSTとわかる。

なお。CentOSとMySQLのタイムゾーンはTokyoに設定されている。

Running via Spring preloader in process 26713
      invoke  active_record
      create    db/migrate/20210308121236_create_records.rb
      create    app/models/record.rb
      invoke    test_unit
      create      test/models/record_test.rb
      create      test/fixtures/records.yml
[vagrant@localhost demo_app]$ rails db:migrate
== 20210308121236 CreateRecords: migrating ====================================
-- create_table(:records)
   -> 0.0237s
== 20210308121236 CreateRecords: migrated (0.0238s) ===========================

Running via Spring preloader in process 26713

invoke active_record

create db/migrate/20210308121236_create_records.rb

create app/models/record.rb

invoke test_unit

create test/models/record_test.rb

create test/fixtures/records.yml

[vagrant@localhost demo_app]$ rails db:migrate

== 20210308121236 CreateRecords: migrating ====================================

-- create_table(:records)

-> 0.0237s

== 20210308121236 CreateRecords: migrated (0.0238s) ===========================

mysqlにテーブルが作られている。

mysql> show tables;
+-----------------------+
| Tables_in_demo_app_db |
+-----------------------+
| ar_internal_metadata  |
| records               |
| schema_migrations     |
+-----------------------+
3 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)

コントローラーを編集して、トップページ表示時にレコードを保存し、改めて読み込んで表示させる。

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

class DemoContentsController < ApplicationController

def top_page

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

record.save

record = Record.find_by(col1: 'abc')

puts "READ"

p record

end

データベースへの書き込み時と読み込み時の時刻がUSTになっている。

Started GET "/" for 10.0.2.2 at 2021-03-08 21:17:04 +0900
Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.0/127.255.255.255, ::1
   (1.9ms)  SELECT `schema_migrations`.`version` FROM `schema_migrations` ORDER BY `schema_migrations`.`version` ASC
Processing by DemoContentsController#top_page as HTML
  TRANSACTION (1.4ms)  BEGIN
  ↳ app/controllers/demo_contents_controller.rb:4:in `top_page'
  Record Create (1.6ms)  INSERT INTO `records` (`col1`, `created_at`, `updated_at`) VALUES ('abc', '2021-03-08 12:17:04.394262', '2021-03-08 12:17:04.394262')
  ↳ app/controllers/demo_contents_controller.rb:4:in `top_page'
  TRANSACTION (3.4ms)  COMMIT
  ↳ app/controllers/demo_contents_controller.rb:4:in `top_page'
  Record Load (2.3ms)  SELECT `records`.* FROM `records` WHERE `records`.`col1` = 'abc' LIMIT 1
  ↳ app/controllers/demo_contents_controller.rb:5:in `top_page'
READ
#<Record id: 1, col1: "abc", created_at: "2021-03-08 12:17:04.394262000 +0000", updated_at: "2021-03-08 12:17:04.394262000 +0000">
  Rendering layout layouts/application.html.erb
  Rendering demo_contents/top_page.html.erb within layouts/application
  Rendered demo_contents/top_page.html.erb within layouts/application (Duration: 1.8ms | Allocations: 705)
[Webpacker] Everything's up-to-date. Nothing to do
  Rendered layout layouts/application.html.erb (Duration: 16.2ms | Allocations: 6563)
Completed 200 OK in 79ms (Views: 20.0ms | ActiveRecord: 13.7ms | Allocations: 16960)

Started GET "/" for 10.0.2.2 at 2021-03-08 21:17:04 +0900

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

(1.9ms) SELECT `schema_migrations`.`version` FROM `schema_migrations` ORDER BY `schema_migrations`.`version` ASC

Processing by DemoContentsController#top_page as HTML

TRANSACTION (1.4ms) BEGIN

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

Record Create (1.6ms) INSERT INTO `records` (`col1`, `created_at`, `updated_at`) VALUES ('abc', '2021-03-08 12:17:04.394262', '2021-03-08 12:17:04.394262')

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

TRANSACTION (3.4ms) COMMIT

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

Record Load (2.3ms) SELECT `records`.* FROM `records` WHERE `records`.`col1` = 'abc' LIMIT 1

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

READ

#<Record id: 1, col1: "abc", created_at: "2021-03-08 12:17:04.394262000 +0000", updated_at: "2021-03-08 12:17:04.394262000 +0000">

Rendering layout layouts/application.html.erb

Rendering demo_contents/top_page.html.erb within layouts/application

Rendered demo_contents/top_page.html.erb within layouts/application (Duration: 1.8ms | Allocations: 705)

[Webpacker] Everything's up-to-date. Nothing to do

Rendered layout layouts/application.html.erb (Duration: 16.2ms | Allocations: 6563)

Completed 200 OK in 79ms (Views: 20.0ms | ActiveRecord: 13.7ms | Allocations: 16960)

mysqlで登録されたレコードを確認すると、USTで保存されている。

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

mysql> SELECT * FROM records;

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

| id | col1 | created_at | updated_at |

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

| 1 | abc | 2021-03-08 12:17:04.394262 | 2021-03-08 12:17:04.394262 |

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

1 row in set (0.00 sec)

application.rbでタイムゾーンを設定

プロジェクトのconfig/aplication.rbに以下の1行を追加。

config.time_zone = 'Tokyo'

1	config.time_zone = 'Tokyo'

Railsサーバーを立ち上げなおして実行すると、表示がJSTになっている。

Started GET "/" for 10.0.2.2 at 2021-03-08 21:27:43 +0900
Cannot render console from 10.0.2.2! Allowed networks: 127.0.0.0/127.255.255.255, ::1
   (1.7ms)  SELECT `schema_migrations`.`version` FROM `schema_migrations` ORDER BY `schema_migrations`.`version` ASC
Processing by DemoContentsController#top_page as HTML
  Record Load (2.3ms)  SELECT `records`.* FROM `records` WHERE `records`.`col1` = 'abc' LIMIT 1
  ↳ app/controllers/demo_contents_controller.rb:5:in `top_page'
READ
#<Record id: 1, col1: "abc", created_at: "2021-03-08 21:17:04.394262000 +0900", updated_at: "2021-03-08 21:17:04.394262000 +0900">
  Rendering layout layouts/application.html.erb
  Rendering demo_contents/top_page.html.erb within layouts/application
  Rendered demo_contents/top_page.html.erb within layouts/application (Duration: 4.0ms | Allocations: 705)
[Webpacker] Everything's up-to-date. Nothing to do
  Rendered layout layouts/application.html.erb (Duration: 24.3ms | Allocations: 6563)
Completed 200 OK in 96ms (Views: 31.1ms | ActiveRecord: 13.3ms | Allocations: 14376)

Started GET "/" for 10.0.2.2 at 2021-03-08 21:27:43 +0900

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

(1.7ms) SELECT `schema_migrations`.`version` FROM `schema_migrations` ORDER BY `schema_migrations`.`version` ASC

Processing by DemoContentsController#top_page as HTML

Record Load (2.3ms) SELECT `records`.* FROM `records` WHERE `records`.`col1` = 'abc' LIMIT 1

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

READ

#<Record id: 1, col1: "abc", created_at: "2021-03-08 21:17:04.394262000 +0900", updated_at: "2021-03-08 21:17:04.394262000 +0900">

Rendering layout layouts/application.html.erb

Rendering demo_contents/top_page.html.erb within layouts/application

Rendered demo_contents/top_page.html.erb within layouts/application (Duration: 4.0ms | Allocations: 705)

[Webpacker] Everything's up-to-date. Nothing to do

Rendered layout layouts/application.html.erb (Duration: 24.3ms | Allocations: 6563)

Completed 200 OK in 96ms (Views: 31.1ms | ActiveRecord: 13.3ms | Allocations: 14376)

Rails – formヘルパーとCSRF対策

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

formヘルパーから生成されるタグ

たとえばfomr_tagヘルパーがレンダリングされると、formタグとhidden属性のinputタグが生成される。

<%= form_tag("/demo_contents/post_memo") do %>
↓
<form action="/demo_contents/post_memo" accept-charset="UTF-8" method="post">
<input type="hidden" name="authenticity_token" value="dN3WEdFwc6ZkCbiW_kMxFNPC_Ajz1BhnydL9kPbCcy3ZrcppdSYNHjitGKaRbvNuAQGxH_ihxcc6EjrK2AAUSA" />

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

↓

CSRF対策

form系のヘルパーで生成されるhiddenタイプのinputタグは、authenticity_tokenという名前でランダム文字列を値に持つ。

これはフォームに対する送信を確認するもので、Railsから送ったフォーム以外からの送信を排除するための仕掛け。

CSRF(Cross Site Request Forgeries)は、攻撃者のサイトへのリンクをクリックした場合に、そのサイトから意図しない送信が送られてしまうもの。

Railsではformヘルパーで生成されたトークンとサーバー内に持っているトークンが符合すれば、意図したフォームからの投稿と判断される。このためのメソッドがprotect_from_forgery。

Rails 5.2より前は、ApplicationControllerにprotect_from_forgeryが自動的に記述される。

class ApplicationController < ActionController::Base
  protect_from_forgery with: :exception
end

class ApplicationController < ActionController::Base

protect_from_forgery with: :exception

end

Rails 5.2以降はActionController::Baseで有効になっていて、追加記述の必要はない。

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'など
複数の属性をカンマで区切って列挙できる

フォーム関係

フォームヘルパー(旧)